diff --git a/.gitignore b/.gitignore index f8259272bd92..528ca8843cb1 100644 --- a/.gitignore +++ b/.gitignore @@ -59,7 +59,9 @@ Network Trash Folder Temporary Items .apdisk +# npm node_modules +package-lock.json #### JetBrains .idea diff --git a/.travis.yml b/.travis.yml index 4b6d1f4718ab..150072325a2a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,67 +6,48 @@ services: env: matrix: - MODE=branchStrategy - - MODE=syntax - - MODE=python - - MODE=node - - MODE=ruby - - MODE=java - - MODE=go - - MODE=semantic PR_ONLY=true + - MODE=syntax CHECK_NAME="Syntax Validator" + - MODE=python CHECK_NAME="SDK Generation - Python" + - MODE=node CHECK_NAME="SDK Generation - Node" + - MODE=ruby CHECK_NAME="SDK Generation - Ruby" + - MODE=java CHECK_NAME="SDK Generation - Java" + - MODE=go CHECK_NAME="SDK Generation - Go" + - MODE=semantic PR_ONLY=true CHECK_NAME="Semantic Validator" - MODE=semantic PR_ONLY=false - - MODE=model PR_ONLY=false - - MODE=linter PR_ONLY=true - - MODE=model PR_ONLY=true - - MODE=BreakingChange PR_ONLY=true - - MODE=azurebot PR_ONLY=true - - MODE=liveValidation PR_ONLY=true + - MODE=model PR_ONLY=true CHECK_NAME="Model Validator" + - MODE=BreakingChange PR_ONLY=true CHECK_NAME="Breaking Changes" + - MODE=lintdiff PR_ONLY=true CHECK_NAME="Linter Diff" matrix: fast_finish: true allow_failures: + - env: MODE=node CHECK_NAME="SDK Generation - Node" + - env: MODE=ruby CHECK_NAME="SDK Generation - Ruby" + - env: MODE=java CHECK_NAME="SDK Generation - Java" + - env: MODE=go CHECK_NAME="SDK Generation - Go" - env: MODE=semantic PR_ONLY=false - - env: MODE=model PR_ONLY=false - - env: MODE=linter PR_ONLY=true - - env: MODE=model PR_ONLY=true - - env: MODE=BreakingChange PR_ONLY=true - - env: MODE=azurebot PR_ONLY=true - - env: MODE=liveValidation PR_ONLY=true - - env: MODE=java - - env: MODE=ruby - - env: MODE=go - - env: MODE=node -before_install: - - docker pull lmazuel/swagger-to-sdk - - python -c "import os; print('\n'.join(v for v in os.environ.keys() if v.startswith('TRAVIS')))" > /tmp/env_file - # Required for installing dotnet 2.0.0 according to https://www.microsoft.com/net/core#linuxubuntu - - curl https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > microsoft.gpg - - sudo mv microsoft.gpg /etc/apt/trusted.gpg.d/microsoft.gpg - - sudo sh -c 'echo "deb [arch=amd64] https://packages.microsoft.com/repos/microsoft-ubuntu-trusty-prod trusty main" > /etc/apt/sources.list.d/dotnetdev.list' - - sudo apt-get update - - sudo apt-get install libunwind8 libicu52 -y - - sudo apt-get install dotnet-sdk-2.0.0 -y -install: - - npm install + - env: MODE=model PR_ONLY=true CHECK_NAME="Model Validator" + - env: MODE=BreakingChange PR_ONLY=true CHECK_NAME="Breaking Changes" +install: true script: - - DOCKER_CMD="docker run --rm --env-file /tmp/env_file -e GH_TOKEN -v $PWD:/git-restapi/ lmazuel/swagger-to-sdk" - >- if [[ $MODE == 'python' ]]; then - $DOCKER_CMD Azure/azure-sdk-for-python -v + travis_wait 30 scripts/swagger-to-sdk.sh Azure/azure-sdk-for-python -v fi - >- if [[ $MODE == 'node' ]]; then - travis_wait 30 $DOCKER_CMD Azure/azure-sdk-for-node -v + travis_wait 30 scripts/swagger-to-sdk.sh Azure/azure-sdk-for-node -v fi - >- if [[ $MODE == 'ruby' ]]; then - $DOCKER_CMD Azure/azure-sdk-for-ruby -v + travis_wait 30 scripts/swagger-to-sdk.sh Azure/azure-sdk-for-ruby -v fi - >- if [[ $MODE == 'go' ]]; then - $DOCKER_CMD Azure/azure-sdk-for-go -o latest -v + travis_wait 30 scripts/swagger-to-sdk.sh Azure/azure-sdk-for-go -o latest -v fi - >- if [[ $MODE == 'java' ]]; then - $DOCKER_CMD Azure/azure-libraries-for-java -v + travis_wait 30 scripts/swagger-to-sdk.sh Azure/azure-libraries-for-java -v fi - >- if [[ $MODE == 'branchStrategy' ]]; then @@ -75,29 +56,29 @@ script: fi - >- if [[ $MODE == 'syntax' ]]; then + npm install npm test -- test/syntax.js fi - - >- - if [[ $MODE == 'linter' ]]; then - npm test -- test/linter.js - fi - >- if [[ $MODE == 'semantic' ]]; then + npm install npm test -- test/semantic.js fi - >- if [[ $MODE == 'model' ]]; then - npm test -- test/model.js + npm install + node scripts/modelValidation.js fi - >- if [[ $MODE == 'BreakingChange' ]]; then + scripts/install-dotnet.sh + npm install node -- scripts/breaking-change.js fi - >- - if [[ $MODE == 'azurebot' ]]; then + if [[ $MODE == 'lintdiff' ]]; then + scripts/install-dotnet.sh + npm install node scripts/momentOfTruth.js - fi - - >- - if [[ $MODE == 'liveValidation' ]]; then - node -- scripts/liveValidation.js; + node scripts/momentOfTruthPostProcessing.js fi diff --git a/CODEOWNERS b/CODEOWNERS index f634e6215756..4f115624e00a 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -10,7 +10,7 @@ /specification/billing/ @wilcobmsft /specification/cdn/ @csmengwan @injyzarif @prakharsharma10 /specification/cognitiveservices/ @davidlicig @felixwa -/specification/compute/ @gatneil @huangpf @hyonholee +/specification/compute/ @huangpf @hyonholee /specification/consumption/ @kjeur @panda-wang /specification/containerinstance/ @samkreter /specification/containerregistry/ @djyou diff --git a/README.md b/README.md index 39463e726b81..bee32b5b9506 100644 --- a/README.md +++ b/README.md @@ -6,22 +6,10 @@ This repository is the canonical source for REST API specifications for Microsoft Azure. -## News - -While you're away for the holiday season, we're going to be making a few improvements to the Azure REST API Specs repository: - - - We will stop merging PRs until the new year starting on **6:00 p.m. December 20th, 2017**. - - Starting on **December 21st, 2017**, we will be restoring `master` as the default branch for this repository. - - All open PRs will automatically be updated to target `master` instead of `current`. - - We will stop accepting contributions to the `current` branch. - - On **December 21st, 2017**, we will merge a refactoring of this repository where we introduce `preview` and `stable` directories to differentiate Swaggers and services that are ready for General Availability and those that are not yet. - - Beginning **December 21st, 2017**, the `master` branch in the private repository will become a read-only copy of the `master` branch in the public repository. - -For more information about this project, please see our wiki: -[December 2017 Refactoring](https://github.com/Azure/azure-rest-api-specs/wiki/December-2017-Refactoring) - ## Basics -If you're a spec author looking for information about all of of the repositories and steps in the pipeline, go to the [adx-documentation-pr](https://github.com/Azure/adx-documentation-pr) repository. Make sure to [join the Github Azure organization](http://aka.ms/azuregithub) to get access to that repo. +If you're a spec author looking for information about all of of the repositories and steps in the pipeline, go to the [adx-documentation-pr](https://github.com/Azure/adx-documentation-pr) repository. Make sure to [join the Github Azure organization](http://aka.ms/azuregithub) to get access to that repo. + +Please check the [announcements page](https://github.com/Azure/azure-rest-api-specs/wiki/Announcements) for any new updates since your last visit. ## Getting started - Our [Contribution guidelines](./.github/CONTRIBUTING.md) walks you through the process of contributing to this repository. diff --git a/documentation/openapi-authoring-automated-guidelines.md b/documentation/openapi-authoring-automated-guidelines.md index 957f4a412627..df327d99f689 100644 --- a/documentation/openapi-authoring-automated-guidelines.md +++ b/documentation/openapi-authoring-automated-guidelines.md @@ -9,12 +9,14 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an ## Index * [Error vs. Warning](#error-vs-warning) * [Automated Rules](#automated-rules) - * [RPC Violations](#rpc-violations) - * [RPC Errors](#rpc-errors) - * [RPC Warnings](#rpc-warnings) + * [ARM Violations](#arm-violations) + * [ARM Errors](#arm-errors) + * [ARM Warnings](#arm-warnings) * [SDK Violations](#sdk-violations) * [SDK Errors](#sdk-errors) * [SDK Warnings](#sdk-warnings) + * [Documentation](#documentation) + * [Documentation Errors](#documentation-errors) * [Rule Descriptions](#rule-descriptions) ## Error vs Warning @@ -24,9 +26,9 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an ## Automated Rules -### RPC Violations +### ARM Violations -#### RPC Errors +#### ARM Errors | Id | Rule Name | Applies to | | --- | --- | --- | @@ -49,7 +51,7 @@ 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 | -#### RPC Warnings +#### ARM Warnings | Id | Rule Name | Applies to | | --- | --- | --- | @@ -86,7 +88,6 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an | [R2054](#R2054) | [SecurityDefinitionsStructure](#R2054) | ARM OpenAPI(swagger) specs | | [R2006](#R2006) | [ControlCharactersNotAllowed](#R2006) | ARM and Data plane OpenAPI(swagger) specs | | [R2009](#R2009) | [ArraySchemaMustHaveItems](#R2009) | ARM and Data plane OpenAPI(swagger) specs | -| [R2022](#R2022) | [XmsExamplesRequired](#R2022) | ARM and Data plane OpenAPI(swagger) specs | | [R3013](#R3013) | [DeleteMustNotHaveRequestBody](#R3013) | ARM and Data plane OpenAPI(swagger) specs | #### SDK Warnings @@ -116,10 +117,18 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an | [R2064](#R2064) | [LROStatusCodesReturnTypeSchema](#R2064) | ARM and Data plane OpenAPI(swagger) specs | | [R2023](#R2023) | [SummaryAndDescriptionMustNotBeSame](#R2023) | ARM and Data plane OpenAPI(swagger) specs | +### Documentation + +#### Documentation Errors + +| Id | Rule Name | Applies to | +| --- | --- | --- | +| [D5001](#D5001) | [XmsExamplesRequired](#D5001) | ARM and Data plane OpenAPI(swagger) specs | + ## Rule Descriptions ### R3012 APIVersionPattern -**Category** : Error +**Category** : ARM Error **Applies to**: ARM OpenAPI(swagger) specs @@ -152,11 +161,13 @@ The date MAY optionally be followed by one of: * 2016-07-04-publicpreview - Use "-preview" to indicate a public preview * 2016-07-04-rc0 - Just use "rc", not "rc" + number -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R3014 BodyPropertiesNamesCamelCase + Please refer to [R3016](#R3016) + ### R3016 DefinitionsPropertiesNamesCamelCase -**Category** : Error +**Category** : ARM Error **Applies to** : ARM and Data Plane OpenAPI(swagger) specs @@ -192,10 +203,10 @@ For more capitalization guidance, see: [https://msdn.microsoft.com/en-us/library * alllowercase - If there are multiple words, please capitalize starting with the second word * miXeDcApItAlIzAtIoN - Please capitalize the first letter of each word (and not seemingly random letters) -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R3025 TrackedResourceGetOperation -**Category** : Error +**Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -213,10 +224,10 @@ If the resource pointed by the rule is not a tracked resource, this warning may **Examples**: N/A -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R3026 TrackedResourcePatchOperation -**Category** : Error +**Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -234,10 +245,10 @@ If the resource pointed by the rule is not a tracked resource, this warning may **Examples**: N/A -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) ### R3027 TrackedResourceListByResourceGroup -**Category** : Error +**Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -255,10 +266,10 @@ If the resource pointed by the rule is not a tracked resource or the operation t **Examples**: N/A -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) ### R3028 TrackedResourceListBySubscription -**Category** : Error +**Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -276,10 +287,10 @@ If the resource pointed by the rule is not a tracked resource or the operation t **Examples**: N/A -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R3010 TrackedResourceListByImmediateParent -**Category** : Warning +**Category** : ARM Warning **Applies to** : ARM OpenAPI(swagger) specs @@ -297,10 +308,10 @@ If the resource pointed by the rule is not a tracked resource this warning may b **Examples**: N/A -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R3018 EnumInsteadOfBoolean -**Category** : Warning +**Category** : ARM Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -316,7 +327,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Examples**: N/A -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R4002 LocationMustHaveXmsMutability **Category** : SDK Warning @@ -339,7 +350,7 @@ For example: } ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2028 NonEmptyClientName **Category** : SDK Error @@ -363,7 +374,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul ... ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2066 PostOperationIdContainsUrlVerb **Category** : SDK Warning @@ -388,7 +399,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Impact on generated code**: Method generated for the POST operation will be named as indicated after the '__underscore__'. For eg., OperationId *SomeResourceTypes_ActivateResource* will generate a method named *ActivateResource* -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2009 ArraySchemaMustHaveItems **Category** : SDK Error @@ -423,7 +434,7 @@ Example with object reference type } ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2012 XmsClientNameParameter **Category** : SDK Error @@ -465,7 +476,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul } ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2013 XmsClientNameProperty **Category** : SDK Error @@ -498,7 +509,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul } ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R1010 AvoidMsdnReferences **Category** : SDK Warning @@ -517,7 +528,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Examples**: N/A. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R1009 DeleteInOperationName **Category** : SDK Warning @@ -540,7 +551,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul * StorageAccounts_delete * delete -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R1005 GetInOperationName **Category** : SDK Warning @@ -563,7 +574,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul * Get * List -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R1003 ListInOperationName **Category** : SDK Warning @@ -585,7 +596,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul * Resources_ListBySubscriptions * List -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R1006 PutInOperationName **Category** : SDK Warning @@ -607,7 +618,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul * Resources_CreateOrUpdate * Create -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R1007 PatchInOperationName **Category** : SDK Warning @@ -628,10 +639,10 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul * Resources_Update * Update -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R3017 GuidUsage -**Category** : Warning +**Category** : ARM Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -647,7 +658,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Examples**: N/A -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R1011 HttpsSupportedScheme **Category** : SDK Warning @@ -671,10 +682,10 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul ] ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2004 NonApplicationJsonType -**Category** : RPC Warning +**Category** : ARM Warning **Applies to** : ARM OpenAPI(swagger) specs @@ -688,10 +699,10 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Examples**: N/A -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2059 UniqueResourcePaths -**Category** : Error +**Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -744,7 +755,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul .... ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2006 ControlCharactersNotAllowed **Category** : SDK Error @@ -762,7 +773,7 @@ Control characters are not allowed in a specification. **Examples**: A list of control characters in unicode can be found [here](https://unicode-table.com/en/). -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2008 MutabilityWithReadOnly **Category** : SDK Error @@ -794,7 +805,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul } ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2058 XmsPathsMustOverloadPaths **Category** : SDK Error @@ -836,7 +847,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul } ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2001 AvoidNestedProperties **Category** : SDK Warning @@ -851,10 +862,10 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Either eliminate nesting or use the `x-ms-client-flatten` property for a better user experience. More details about the extension can be found [here](https://github.com/Azure/azure-rest-api-specs/blob/dce4da0d748565efd2ab97a43d0683c2979a974a/documentation/swagger-extensions.md#x-ms-client-flatten). -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R3008 CollectionObjectPropertiesNaming -**Category** : Error +**Category** : ARM Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -866,10 +877,10 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure that the response object has a property named `value` of `array` type. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2027 DefaultMustBeInEnum -**Category** : Error +**Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -895,7 +906,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul } ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2047 NamePropertyDefinitionInParameter **Category** : SDK Error @@ -929,7 +940,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul } ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R1001 OperationIdNounVerb **Category** : SDK Error @@ -954,7 +965,7 @@ CertificateActivate Certificate_Activate ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2055 OneUnderscoreInOperationId **Category** : SDK Error @@ -978,10 +989,10 @@ Activate_Primary_Certificate PrimaryCertificate_Activate ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R3023 OperationsAPIImplementation -**Category** : Error +**Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -1074,7 +1085,7 @@ A typical `OperationsList` and `Operation` model would look like ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2015 ParameterNotDefinedInGlobalParameters **Category** : SDK Warning @@ -1091,10 +1102,10 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure `subscriptionId` and `api-version` are declared in the global parameters section of the document. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2020 RequiredPropertiesMissingInResourceModel -**Category** : Error +**Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -1106,7 +1117,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure the `Resource` type model has the properties `name`, `type` and `id` and they are marked as `readOnly:true`. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2056 RequiredReadOnlyProperties **Category** : SDK Error @@ -1135,7 +1146,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul } ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2014 SubscriptionIdParameterInOperations **Category** : SDK Error @@ -1150,7 +1161,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Remove `subscriptionId` from the operation parameters and add it to the global parameters section if it doesn't exist there. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2003 ValidFormats **Category** : SDK Error @@ -1165,10 +1176,10 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure format defined for property is valid. Please refer [here](https://github.com/Azure/autorest/blob/81d4d31d06637f4f9ef042d7f2ec64cfea29892f/docs/developer/validation-rules/valid-formats.md) for allowed types in OpenAPI. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) -### R2022 XmsExamplesRequired -**Category** : SDK Error +### D5001 XmsExamplesRequired +**Category** : Documentation Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1184,7 +1195,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Examples**: Please refer the documentation of [x-ms-examples](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/x-ms-examples.md#why-x-ms-examples). -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2065 LicenseHeaderMustNotBeSpecified **Category** : SDK Warning @@ -1197,7 +1208,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure the `x-ms-code-generation-settings` section does not have `header` property. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2025 NextLinkPropertyMustExist **Category** : SDK Error @@ -1216,7 +1227,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Examples**: Please refer the documentation of [x-ms-pageable](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-pageable) and [examples](https://github.com/Azure/azure-rest-api-specs/tree/master/documentation/x-ms-pageable). -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2060 PageableRequires200Response **Category** : SDK Error @@ -1235,9 +1246,23 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Examples**: Please refer the documentation of [x-ms-pageable](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-pageable). -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2024 AnonymousBodyParameter +**Category** : SDK Error + +**Applies to** : ARM specs + +**Output Message**: Inline/anonymous models must not be used, instead define a schema with a model name in the "definitions" section and refer to it. This allows operations to share the models. + +**Description**: This rule appears if in the parameter definition you have anonymous types. + +**Why the rule is important**: Anonymous parameters will be autogenerated as non-descriptive parameters which the client will not be able to share across operations or provide good documentation for, thereby resulting in poor user experience. + +**How to fix the violation**: Move the schema to the definitions section and reference it using $ref. + +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) + ### R2026 AvoidAnonymousTypes **Category** : SDK Error @@ -1312,10 +1337,10 @@ public class FooCreationSettings { **Examples**: N/A. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R3019 ArmResourcePropertiesBag -**Category** : Error +**Category** : ARM Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1367,10 +1392,10 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul "x-ms-azure-resource": true } ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R3006 BodyTopLevelProperties -**Category** : Error +**Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -1419,10 +1444,10 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul ] } ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2057 InvalidSkuModel -**Category** : Warning +**Category** : ARM Warning **Applies to** : ARM OpenAPI(swagger) specs @@ -1436,7 +1461,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Examples**: N/A -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2018 XmsEnumValidation **Category** : SDK Warning @@ -1453,7 +1478,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Examples**: Please refer to [x-ms-enum extension](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-enum). -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2063 OperationIdNounConflictingModelNames **Category** : SDK Warning @@ -1468,7 +1493,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure operation Ids are named in such a way that the `Noun` in `Noun_Verb` is of the plural form and does not conflict with the names of any models in the definitions section of the spec. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2054 SecurityDefinitionsStructure **Category** : SDK Error @@ -1483,7 +1508,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure that the document has a security definition section as described [here](https://github.com/Azure/autorest/tree/master/docs/developer/validation-rules/security-definitions-structure-validation.md) -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2019 ResourceHasXMsResourceEnabled **Category** : SDK Error @@ -1498,7 +1523,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure that the 'Resource' definition has x-ms-azure-resource extension enabled and set to true. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2017 PutRequestResponseScheme **Category** : SDK Warning @@ -1513,7 +1538,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure the request & reponse('200') schema of the PUT operation must be same. This might involve a service side change which will result cause a breaking change in the generated SDK. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2005 LongRunningResponseStatusCode **Category** : SDK Error @@ -1528,10 +1553,10 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure that the DELETE/POST/PUT operations have the allowed response codes. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2044 InvalidVerbUsed -**Category** : Error +**Category** : ARM Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1543,10 +1568,10 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Provide a correct HTTP verb. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R3007 PutGetPatchResponseSchema -**Category** : Error +**Category** : ARM Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1558,7 +1583,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure that, for a given path with PUT, GET and PATCH operations, the schema of the response is same. This might involve a service side change which will result in a breaking change in the generated SDK. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R3013 DeleteMustNotHaveRequestBody **Category** : SDK Error @@ -1573,10 +1598,10 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure that the request body of the delete operation is empty. This may involve a service side change and may cause a breaking change in the generated SDK. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2062 XmsResourceInPutResponse -**Category** : Error +**Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -1588,7 +1613,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure that the 200 response model for an ARM PUT operation must have x-ms-azure-resource extension set to true in its hierarchy. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R3060 XmsPageableListByRGAndSubscriptions **Category** : SDK Warning @@ -1603,7 +1628,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure that when a tracked resource has list by resource group and subscription operations, the x-ms-pageable extension values are same for both operations. This might involve a service side change which will result in a breaking change in the generated SDK. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2064 LROStatusCodesReturnTypeSchema **Category** : SDK Warning @@ -1618,10 +1643,10 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure that the '200'/'201' responses of the long running operation has a schema definition. This might involve a service side change which will result in a breaking change in the generated SDK. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2016 PatchBodyParametersSchema -**Category** : Error +**Category** : ARM Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1633,7 +1658,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure that the request parameter of the Patch Operation does not have a required/default value. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R4000 ParameterDescriptionRequired **Category** : SDK Warning @@ -1648,7 +1673,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: For each parameter, provide a 'description' property. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R4000 DescriptiveDescriptionRequired **Category** : SDK Warning @@ -1663,7 +1688,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: For each 'description' property, provide a detailed description value. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R4000 DescriptionAndTitleMissing **Category** : SDK Warning @@ -1678,7 +1703,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: For each definition, provide atleast one of the properties - description/title. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R4000 OperationDescriptionOrSummaryRequired **Category** : SDK Warning @@ -1693,7 +1718,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: For each operation, provide atleast one of the property - description/summary. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R2023 SummaryAndDescriptionMustNotBeSame **Category** : SDK Warning @@ -1736,10 +1761,10 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul ...... ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +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) ### R3011 DescriptionMustNotBeNodeName -**Category** : Error +**Category** : ARM Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1751,4 +1776,4 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Provide detailed description of the node in the description section. -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [RPC](#rpc-violations): [Errors](#rpc-errors) or [Warnings](#rpc-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) +Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) diff --git a/package-lock.json b/package-lock.json deleted file mode 100644 index 568f4b8e5b33..000000000000 --- a/package-lock.json +++ /dev/null @@ -1,3651 +0,0 @@ -{ - "name": "azure-rest-api-specs-tests", - "version": "0.1.0", - "lockfileVersion": 1, - "requires": true, - "dependencies": { - "@microsoft.azure/async-io": { - "version": "1.0.24", - "resolved": "https://registry.npmjs.org/@microsoft.azure/async-io/-/async-io-1.0.24.tgz", - "integrity": "sha1-PpYUp5Ixe3IwIC3ALytLuNjFALk=", - "dev": true, - "requires": { - "@microsoft.azure/polyfill": "1.0.19", - "file-url": "2.0.2", - "get-uri": "2.0.1", - "pify": "2.3.0", - "proper-lockfile": "2.0.1", - "urijs": "1.18.12" - } - }, - "@microsoft.azure/autorest-extension-base": { - "version": "1.0.13", - "resolved": "https://registry.npmjs.org/@microsoft.azure/autorest-extension-base/-/autorest-extension-base-1.0.13.tgz", - "integrity": "sha1-/VobUj8CzK3525vK8Jez/5mSgeY=", - "dev": true, - "requires": { - "vscode-jsonrpc": "3.6.0" - }, - "dependencies": { - "vscode-jsonrpc": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-3.6.0.tgz", - "integrity": "sha512-PqHHjuTlz3ks0vyZv3IkdduJReA/lqe6OP5zRl5nXn2ptMLW++fBotNyayyZEQLIF6nNrx/Rn6WhMSHElf02Yw==", - "dev": true - } - } - }, - "@microsoft.azure/console": { - "version": "1.0.33", - "resolved": "https://registry.npmjs.org/@microsoft.azure/console/-/console-1.0.33.tgz", - "integrity": "sha1-cq7ytSwmDeoNQDvwHMSTuOS4oI8=", - "dev": true, - "requires": { - "@microsoft.azure/polyfill": "1.0.19", - "chalk": "1.1.3", - "marked": "0.3.17", - "marked-terminal": "2.0.0", - "memorystream": "0.3.1", - "moment": "2.21.0", - "yargs": "8.0.2" - } - }, - "@microsoft.azure/eventing": { - "version": "1.0.18", - "resolved": "https://registry.npmjs.org/@microsoft.azure/eventing/-/eventing-1.0.18.tgz", - "integrity": "sha1-UhBn6KPaNpuuF2K2OdZec8FKePA=", - "dev": true, - "requires": { - "@microsoft.azure/polyfill": "1.0.19" - } - }, - "@microsoft.azure/literate": { - "version": "1.0.25", - "resolved": "https://registry.npmjs.org/@microsoft.azure/literate/-/literate-1.0.25.tgz", - "integrity": "sha1-DvyxRHQOOmNrg2j88r0Buiri2eQ=", - "dev": true, - "requires": { - "@microsoft.azure/async-io": "1.0.24", - "@microsoft.azure/console": "1.0.33", - "@microsoft.azure/eventing": "1.0.18", - "@microsoft.azure/polyfill": "1.0.19", - "commonmark": "0.27.0", - "jsonpath": "0.2.12", - "linq-es2015": "2.4.31", - "safe-eval": "0.3.0", - "source-map": "0.5.7", - "vscode-jsonrpc": "3.3.1", - "yaml-ast-parser": "https://github.com/olydis/yaml-ast-parser/releases/download/0.0.34/yaml-ast-parser-0.0.34.tgz", - "yargs": "8.0.2" - } - }, - "@microsoft.azure/polyfill": { - "version": "1.0.19", - "resolved": "https://registry.npmjs.org/@microsoft.azure/polyfill/-/polyfill-1.0.19.tgz", - "integrity": "sha1-F3KY21VdYMdTs6I8eZpcKjbK6zc=", - "dev": true, - "requires": { - "source-map-support": "0.4.18" - } - }, - "@types/caseless": { - "version": "0.12.1", - "resolved": "https://registry.npmjs.org/@types/caseless/-/caseless-0.12.1.tgz", - "integrity": "sha512-FhlMa34NHp9K5MY1Uz8yb+ZvuX0pnvn3jScRSNAb75KHGB8d3rEU6hqMs3Z2vjuytcMfRg6c5CHMc3wtYyD2/A==", - "dev": true - }, - "@types/form-data": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/@types/form-data/-/form-data-2.2.1.tgz", - "integrity": "sha512-JAMFhOaHIciYVh8fb5/83nmuO/AHwmto+Hq7a9y8FzLDcC1KCU344XDOMEmahnrTFlHjgh4L0WJFczNIX2GxnQ==", - "dev": true, - "requires": { - "@types/node": "8.9.4" - } - }, - "@types/node": { - "version": "8.9.4", - "resolved": "https://registry.npmjs.org/@types/node/-/node-8.9.4.tgz", - "integrity": "sha512-dSvD36qnQs78G1BPsrZFdPpvLgMW/dnvr5+nTW2csMs5TiP9MOXrjUbnMZOEwnIuBklXtn7b6TPA2Cuq07bDHA==", - "dev": true - }, - "@types/request": { - "version": "2.47.0", - "resolved": "https://registry.npmjs.org/@types/request/-/request-2.47.0.tgz", - "integrity": "sha512-/KXM5oev+nNCLIgBjkwbk8VqxmzI56woD4VUxn95O+YeQ8hJzcSmIZ1IN3WexiqBb6srzDo2bdMbsXxgXNkz5Q==", - "dev": true, - "requires": { - "@types/caseless": "0.12.1", - "@types/form-data": "2.2.1", - "@types/node": "8.9.4", - "@types/tough-cookie": "2.3.2" - } - }, - "@types/tough-cookie": { - "version": "2.3.2", - "resolved": "https://registry.npmjs.org/@types/tough-cookie/-/tough-cookie-2.3.2.tgz", - "integrity": "sha512-vOVmaruQG5EatOU/jM6yU2uCp3Lz6mK1P5Ztu4iJjfM4SVHU9XYktPUQtKlIXuahqXHdEyUarMrBEwg5Cwu+bA==", - "dev": true - }, - "@types/uuid": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-3.4.3.tgz", - "integrity": "sha512-5fRLCYhLtDb3hMWqQyH10qtF+Ud2JnNCXTCZ+9ktNdCcgslcuXkDTkFcJNk++MT29yDntDnlF1+jD+uVGumsbw==", - "dev": true, - "requires": { - "@types/node": "8.9.4" - } - }, - "JSONSelect": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/JSONSelect/-/JSONSelect-0.4.0.tgz", - "integrity": "sha1-oI7cxn6z/L6Z7WMIVTRKDPKCu40=", - "dev": true - }, - "adal-node": { - "version": "0.1.28", - "resolved": "https://registry.npmjs.org/adal-node/-/adal-node-0.1.28.tgz", - "integrity": "sha1-RoxLs+u9lrEnBmn0ucuk4AZepIU=", - "dev": true, - "requires": { - "@types/node": "8.9.4", - "async": "1.0.0", - "date-utils": "1.2.21", - "jws": "3.1.4", - "request": "2.83.0", - "underscore": "1.7.0", - "uuid": "3.2.1", - "xmldom": "0.1.27", - "xpath.js": "1.1.0" - } - }, - "ajv": { - "version": "5.5.2", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-5.5.2.tgz", - "integrity": "sha1-c7Xuyj+rZT49P5Qis0GtQiBdyWU=", - "dev": true, - "requires": { - "co": "4.6.0", - "fast-deep-equal": "1.1.0", - "fast-json-stable-stringify": "2.0.0", - "json-schema-traverse": "0.3.1" - } - }, - "ansi-regex": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", - "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", - "dev": true - }, - "ansi-styles": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-2.2.1.tgz", - "integrity": "sha1-tDLdM1i2NM914eRmQ2gkBTPB3b4=", - "dev": true - }, - "ansicolors": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/ansicolors/-/ansicolors-0.2.1.tgz", - "integrity": "sha1-vgiVmQl7dKXJxKhKDNvNtivYeu8=", - "dev": true - }, - "append-field": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/append-field/-/append-field-0.1.0.tgz", - "integrity": "sha1-bdxY+gg8e8VF08WZWygwzCNm1Eo=", - "dev": true - }, - "argparse": { - "version": "1.0.10", - "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", - "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", - "dev": true, - "requires": { - "sprintf-js": "1.0.3" - } - }, - "asn1": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/asn1/-/asn1-0.2.3.tgz", - "integrity": "sha1-2sh4dxPJlmhJ/IGAd36+nB3fO4Y=", - "dev": true - }, - "assert-plus": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", - "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", - "dev": true - }, - "async": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/async/-/async-1.0.0.tgz", - "integrity": "sha1-+PwEyjoTeErenhZBr5hXjPvWR6k=", - "dev": true - }, - "asynckit": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", - "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=", - "dev": true - }, - "autorest": { - "version": "2.0.4245", - "resolved": "https://registry.npmjs.org/autorest/-/autorest-2.0.4245.tgz", - "integrity": "sha512-CRxb97Ib3b6GWpF2bE37Vvqtd5KfsZ912OBWe0k92Zvk8LxY4WcQu4C6F4Numm78m8FdIWTAH4u9uT91riVdxQ==", - "dev": true - }, - "aws-sign2": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz", - "integrity": "sha1-tG6JCTSpWR8tL2+G1+ap8bP+dqg=", - "dev": true - }, - "aws4": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.6.0.tgz", - "integrity": "sha1-g+9cqGCysy5KDe7e6MdxudtXRx4=", - "dev": true - }, - "azure-arm-resource": { - "version": "2.0.0-preview", - "resolved": "https://registry.npmjs.org/azure-arm-resource/-/azure-arm-resource-2.0.0-preview.tgz", - "integrity": "sha1-lYAQoY+V/4LpqZU3E7oMydJxEks=", - "dev": true, - "requires": { - "ms-rest": "2.3.1", - "ms-rest-azure": "2.5.4" - } - }, - "balanced-match": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", - "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=", - "dev": true - }, - "base64url": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/base64url/-/base64url-2.0.0.tgz", - "integrity": "sha1-6sFuA+oUOO/5Qj1puqNiYu0fcLs=", - "dev": true - }, - "bcrypt-pbkdf": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.1.tgz", - "integrity": "sha1-Y7xdy2EzG5K8Bf1SiVPDNGKgb40=", - "dev": true, - "optional": true, - "requires": { - "tweetnacl": "0.14.5" - } - }, - "body-parser": { - "version": "1.18.2", - "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.18.2.tgz", - "integrity": "sha1-h2eKGdhLR9hZuDGZvVm84iKxBFQ=", - "dev": true, - "requires": { - "bytes": "3.0.0", - "content-type": "1.0.4", - "debug": "2.6.9", - "depd": "1.1.2", - "http-errors": "1.6.2", - "iconv-lite": "0.4.19", - "on-finished": "2.3.0", - "qs": "6.5.1", - "raw-body": "2.3.2", - "type-is": "1.6.16" - } - }, - "boom": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/boom/-/boom-4.3.1.tgz", - "integrity": "sha1-T4owBctKfjiJ90kDD9JbluAdLjE=", - "dev": true, - "requires": { - "hoek": "4.2.1" - } - }, - "brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, - "requires": { - "balanced-match": "1.0.0", - "concat-map": "0.0.1" - } - }, - "browser-stdout": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/browser-stdout/-/browser-stdout-1.3.1.tgz", - "integrity": "sha512-qhAVI1+Av2X7qelOfAIYwXONood6XlZE/fXaBSmW/T5SzLAmCgzi+eiWE7fUvbHaeNBQH13UftjpXxsfLkMpgw==", - "dev": true - }, - "buffer-equal-constant-time": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/buffer-equal-constant-time/-/buffer-equal-constant-time-1.0.1.tgz", - "integrity": "sha1-+OcRMvf/5uAaXJaXpMbz5I1cyBk=", - "dev": true - }, - "builtin-modules": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-1.1.1.tgz", - "integrity": "sha1-Jw8HbFpywC9bZaR9+Uxf46J4iS8=", - "dev": true - }, - "busboy": { - "version": "0.2.14", - "resolved": "https://registry.npmjs.org/busboy/-/busboy-0.2.14.tgz", - "integrity": "sha1-bCpiLvz0fFe7vh4qnDetNseSVFM=", - "dev": true, - "requires": { - "dicer": "0.2.5", - "readable-stream": "1.1.14" - }, - "dependencies": { - "readable-stream": { - "version": "1.1.14", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-1.1.14.tgz", - "integrity": "sha1-fPTFTvZI44EwhMY23SB54WbAgdk=", - "dev": true, - "requires": { - "core-util-is": "1.0.2", - "inherits": "2.0.3", - "isarray": "0.0.1", - "string_decoder": "0.10.31" - } - } - } - }, - "bytes": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.0.0.tgz", - "integrity": "sha1-0ygVQE1olpn4Wk6k+odV3ROpYEg=", - "dev": true - }, - "call-me-maybe": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.1.tgz", - "integrity": "sha1-JtII6onje1y95gJQoV8DHBak1ms=", - "dev": true - }, - "camelcase": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-4.1.0.tgz", - "integrity": "sha1-1UVjW+HjPFQmScaRc+Xeas+uNN0=", - "dev": true - }, - "cardinal": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/cardinal/-/cardinal-1.0.0.tgz", - "integrity": "sha1-UOIcGwqjdyn5N33vGWtanOyTLuk=", - "dev": true, - "requires": { - "ansicolors": "0.2.1", - "redeyed": "1.0.1" - } - }, - "caseless": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", - "integrity": "sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw=", - "dev": true - }, - "chalk": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-1.1.3.tgz", - "integrity": "sha1-qBFcVeSnAv5NFQq9OHKCKn4J/Jg=", - "dev": true, - "requires": { - "ansi-styles": "2.2.1", - "escape-string-regexp": "1.0.5", - "has-ansi": "2.0.0", - "strip-ansi": "3.0.1", - "supports-color": "2.0.0" - } - }, - "cjson": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/cjson/-/cjson-0.2.1.tgz", - "integrity": "sha1-c82KrWXZ4VBfmvF0TTt5wVJ2gqU=", - "dev": true - }, - "cli-table": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/cli-table/-/cli-table-0.3.1.tgz", - "integrity": "sha1-9TsFJmqLGguTSz0IIebi3FkUriM=", - "dev": true, - "requires": { - "colors": "1.0.3" - } - }, - "cliui": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-3.2.0.tgz", - "integrity": "sha1-EgYBU3qRbSmUD5NNo7SNWFo5IT0=", - "dev": true, - "requires": { - "string-width": "1.0.2", - "strip-ansi": "3.0.1", - "wrap-ansi": "2.1.0" - }, - "dependencies": { - "string-width": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", - "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", - "dev": true, - "requires": { - "code-point-at": "1.1.0", - "is-fullwidth-code-point": "1.0.0", - "strip-ansi": "3.0.1" - } - } - } - }, - "co": { - "version": "4.6.0", - "resolved": "https://registry.npmjs.org/co/-/co-4.6.0.tgz", - "integrity": "sha1-bqa989hTrlTMuOR7+gvz+QMfsYQ=", - "dev": true - }, - "code-point-at": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/code-point-at/-/code-point-at-1.1.0.tgz", - "integrity": "sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=", - "dev": true - }, - "color": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/color/-/color-2.0.1.tgz", - "integrity": "sha512-ubUCVVKfT7r2w2D3qtHakj8mbmKms+tThR8gI8zEYCbUBl8/voqFGt3kgBqGwXAopgXybnkuOq+qMYCRrp4cXw==", - "dev": true, - "requires": { - "color-convert": "1.9.1", - "color-string": "1.5.2" - } - }, - "color-convert": { - "version": "1.9.1", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.1.tgz", - "integrity": "sha512-mjGanIiwQJskCC18rPR6OmrZ6fm2Lc7PeGFYwCmy5J34wC6F1PzdGL6xeMfmgicfYcNLGuVFA3WzXtIDCQSZxQ==", - "dev": true, - "requires": { - "color-name": "1.1.3" - } - }, - "color-name": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", - "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", - "dev": true - }, - "color-string": { - "version": "1.5.2", - "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.5.2.tgz", - "integrity": "sha1-JuRYFLw8mny9Z1FkikFDRRSnc6k=", - "dev": true, - "requires": { - "color-name": "1.1.3", - "simple-swizzle": "0.2.2" - } - }, - "colors": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/colors/-/colors-1.0.3.tgz", - "integrity": "sha1-BDP0TYCWgP3rYO0mDxsMJi6CpAs=", - "dev": true - }, - "combined-stream": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.6.tgz", - "integrity": "sha1-cj599ugBrFYTETp+RFqbactjKBg=", - "dev": true, - "requires": { - "delayed-stream": "1.0.0" - } - }, - "commander": { - "version": "2.15.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.15.0.tgz", - "integrity": "sha512-7B1ilBwtYSbetCgTY1NJFg+gVpestg0fdA1MhC1Vs4ssyfSXnCAjFr+QcQM9/RedXC0EaUx1sG8Smgw2VfgKEg==", - "dev": true - }, - "commonmark": { - "version": "0.27.0", - "resolved": "https://registry.npmjs.org/commonmark/-/commonmark-0.27.0.tgz", - "integrity": "sha1-2GwmK5YoIelIPGnFR7xYhAwEezQ=", - "dev": true, - "requires": { - "entities": "1.1.1", - "mdurl": "1.0.1", - "minimist": "1.2.0", - "string.prototype.repeat": "0.2.0" - } - }, - "component-emitter": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.2.1.tgz", - "integrity": "sha1-E3kY1teCg/ffemt8WmPhQOaUJeY=", - "dev": true - }, - "concat-map": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", - "dev": true - }, - "concat-stream": { - "version": "1.6.1", - "resolved": "https://registry.npmjs.org/concat-stream/-/concat-stream-1.6.1.tgz", - "integrity": "sha512-gslSSJx03QKa59cIKqeJO9HQ/WZMotvYJCuaUULrLpjj8oG40kV2Z+gz82pVxlTkOADi4PJxQPPfhl1ELYrrXw==", - "dev": true, - "requires": { - "inherits": "2.0.3", - "readable-stream": "2.3.5", - "typedarray": "0.0.6" - } - }, - "content-type": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.4.tgz", - "integrity": "sha512-hIP3EEPs8tB9AT1L+NUqtwOAps4mk2Zob89MWXMHjHWg9milF/j4osnnQLXBCBFBk/tvIG/tUc9mOUJiPBhPXA==", - "dev": true - }, - "cookiejar": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/cookiejar/-/cookiejar-2.1.1.tgz", - "integrity": "sha1-Qa1XsbVVlR7BcUEqgZQrHoIA00o=", - "dev": true - }, - "core-util-is": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", - "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=", - "dev": true - }, - "cross-spawn": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-5.1.0.tgz", - "integrity": "sha1-6L0O/uWPz/b4+UUQoKVUu/ojVEk=", - "dev": true, - "requires": { - "lru-cache": "4.1.2", - "shebang-command": "1.2.0", - "which": "1.3.0" - } - }, - "cryptiles": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/cryptiles/-/cryptiles-3.1.2.tgz", - "integrity": "sha1-qJ+7Ig9c4l7FboxKqKT9e1sNKf4=", - "dev": true, - "requires": { - "boom": "5.2.0" - }, - "dependencies": { - "boom": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/boom/-/boom-5.2.0.tgz", - "integrity": "sha512-Z5BTk6ZRe4tXXQlkqftmsAUANpXmuwlsF5Oov8ThoMbQRzdGTA1ngYRW160GexgOgjsFOKJz0LYhoNi+2AMBUw==", - "dev": true, - "requires": { - "hoek": "4.2.1" - } - } - } - }, - "cycle": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/cycle/-/cycle-1.0.3.tgz", - "integrity": "sha1-IegLK+hYD5i0aPN5QwZisEbDStI=", - "dev": true - }, - "dashdash": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", - "integrity": "sha1-hTz6D3y+L+1d4gMmuN1YEDX24vA=", - "dev": true, - "requires": { - "assert-plus": "1.0.0" - } - }, - "data-uri-to-buffer": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-1.2.0.tgz", - "integrity": "sha512-vKQ9DTQPN1FLYiiEEOQ6IBGFqvjCa5rSK3cWMy/Nespm5d/x3dGFT9UBZnkLxCwua/IXBi2TYnwTEpsOvhC4UQ==", - "dev": true - }, - "date-utils": { - "version": "1.2.21", - "resolved": "https://registry.npmjs.org/date-utils/-/date-utils-1.2.21.tgz", - "integrity": "sha1-YfsWzcEnSzyayq/+n8ad+HIKK2Q=", - "dev": true - }, - "debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - }, - "decamelize": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", - "integrity": "sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=", - "dev": true - }, - "deep-extend": { - "version": "0.5.0", - "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.5.0.tgz", - "integrity": "sha1-bvSgmwX5iw41jW2T1Mo8rsZnKAM=", - "dev": true - }, - "delayed-stream": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", - "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk=", - "dev": true - }, - "depd": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.2.tgz", - "integrity": "sha1-m81S4UwJd2PnSbJ0xDRu0uVgtak=", - "dev": true - }, - "deref": { - "version": "0.7.3", - "resolved": "https://registry.npmjs.org/deref/-/deref-0.7.3.tgz", - "integrity": "sha512-9ROdWS8nWgz/uJxYWIDZyEAP+oANSl/pNQO27GFJWptVVocqBQ95iKmcboxjvjPQ0rn3IpJcA450hIJpznzVLg==", - "dev": true, - "requires": { - "deep-extend": "0.5.0" - } - }, - "destroy": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.0.4.tgz", - "integrity": "sha1-l4hXRCxEdJ5CBmE+N5RiBYJqvYA=", - "dev": true - }, - "dicer": { - "version": "0.2.5", - "resolved": "https://registry.npmjs.org/dicer/-/dicer-0.2.5.tgz", - "integrity": "sha1-WZbAhrszIYyBLAkL3cCc0S+stw8=", - "dev": true, - "requires": { - "readable-stream": "1.1.14", - "streamsearch": "0.1.2" - }, - "dependencies": { - "readable-stream": { - "version": "1.1.14", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-1.1.14.tgz", - "integrity": "sha1-fPTFTvZI44EwhMY23SB54WbAgdk=", - "dev": true, - "requires": { - "core-util-is": "1.0.2", - "inherits": "2.0.3", - "isarray": "0.0.1", - "string_decoder": "0.10.31" - } - } - } - }, - "diff": { - "version": "3.5.0", - "resolved": "https://registry.npmjs.org/diff/-/diff-3.5.0.tgz", - "integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==", - "dev": true - }, - "drange": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/drange/-/drange-1.0.1.tgz", - "integrity": "sha512-PVkrAwra9MnIY6QIa9YMlEHkfbcikjK+W/X/O0BNXG14y3O8vqGhzvP8TKlu4sFCJn7V2raugY8SOjDXVHti0g==", - "dev": true - }, - "duplexer": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/duplexer/-/duplexer-0.1.1.tgz", - "integrity": "sha1-rOb/gIwc5mtX0ev5eXessCM0z8E=", - "dev": true - }, - "ebnf-parser": { - "version": "0.1.10", - "resolved": "https://registry.npmjs.org/ebnf-parser/-/ebnf-parser-0.1.10.tgz", - "integrity": "sha1-zR9rpHfFY4xAyX7ZtXLbW6tdgzE=", - "dev": true - }, - "ecc-jsbn": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.1.tgz", - "integrity": "sha1-D8c6ntXw1Tw4GTOYUj735UN3dQU=", - "dev": true, - "optional": true, - "requires": { - "jsbn": "0.1.1" - } - }, - "ecdsa-sig-formatter": { - "version": "1.0.9", - "resolved": "https://registry.npmjs.org/ecdsa-sig-formatter/-/ecdsa-sig-formatter-1.0.9.tgz", - "integrity": "sha1-S8kmJ07Dtau1AW5+HWCSGsJisqE=", - "dev": true, - "requires": { - "base64url": "2.0.0", - "safe-buffer": "5.1.1" - } - }, - "ee-first": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", - "integrity": "sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0=", - "dev": true - }, - "encodeurl": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-1.0.2.tgz", - "integrity": "sha1-rT/0yG7C0CkyL1oCw6mmBslbP1k=", - "dev": true - }, - "entities": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/entities/-/entities-1.1.1.tgz", - "integrity": "sha1-blwtClYhtdra7O+AuQ7ftc13cvA=", - "dev": true - }, - "error-ex": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.1.tgz", - "integrity": "sha1-+FWobOYa3E6GIcPNoh56dhLDqNw=", - "dev": true, - "requires": { - "is-arrayish": "0.2.1" - } - }, - "es6-promise": { - "version": "4.2.4", - "resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-4.2.4.tgz", - "integrity": "sha512-/NdNZVJg+uZgtm9eS3O6lrOLYmQag2DjdEXuPaHlZ6RuVqgqaVZfgYCepEIKsLqwdQArOPtC3XzRLqGGfT8KQQ==", - "dev": true - }, - "escape-html": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", - "integrity": "sha1-Aljq5NPQwJdN4cFpGI7wBR0dGYg=", - "dev": true - }, - "escape-string-regexp": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", - "dev": true - }, - "escodegen": { - "version": "0.0.21", - "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-0.0.21.tgz", - "integrity": "sha1-U9ZSz6EDA4gnlFilJmxf/HCcY8M=", - "dev": true, - "requires": { - "esprima": "1.0.4", - "estraverse": "0.0.4", - "source-map": "0.5.7" - }, - "dependencies": { - "esprima": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-1.0.4.tgz", - "integrity": "sha1-n1V+CPw7TSbs6d00+Pv0drYlha0=", - "dev": true - } - } - }, - "esprima": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-3.0.0.tgz", - "integrity": "sha1-U88kes2ncxPlUcOqLnM0LT+099k=", - "dev": true - }, - "estraverse": { - "version": "0.0.4", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-0.0.4.tgz", - "integrity": "sha1-AaCTLf7ldGhKWYr1pnw7+bZCjbI=", - "dev": true - }, - "etag": { - "version": "1.8.1", - "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", - "integrity": "sha1-Qa4u62XvpiJorr/qg6x9eSmbCIc=", - "dev": true - }, - "execa": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/execa/-/execa-0.7.0.tgz", - "integrity": "sha1-lEvs00zEHuMqY6n68nrVpl/Fl3c=", - "dev": true, - "requires": { - "cross-spawn": "5.1.0", - "get-stream": "3.0.0", - "is-stream": "1.1.0", - "npm-run-path": "2.0.2", - "p-finally": "1.0.0", - "signal-exit": "3.0.2", - "strip-eof": "1.0.0" - } - }, - "extend": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.1.tgz", - "integrity": "sha1-p1Xqe8Gt/MWjHOfnYtuq3F5jZEQ=", - "dev": true - }, - "extsprintf": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/extsprintf/-/extsprintf-1.3.0.tgz", - "integrity": "sha1-lpGEQOMEGnpBT4xS48V06zw+HgU=", - "dev": true - }, - "eyes": { - "version": "0.1.8", - "resolved": "https://registry.npmjs.org/eyes/-/eyes-0.1.8.tgz", - "integrity": "sha1-Ys8SAjTGg3hdkCNIqADvPgzCC8A=", - "dev": true - }, - "faker": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/faker/-/faker-4.1.0.tgz", - "integrity": "sha1-HkW7vsxndLPBlfrSg1EJxtdIzD8=", - "dev": true - }, - "fast-deep-equal": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-1.1.0.tgz", - "integrity": "sha1-wFNHeBfIa1HaqFPIHgWbcz0CNhQ=", - "dev": true - }, - "fast-json-stable-stringify": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.0.0.tgz", - "integrity": "sha1-1RQsDK7msRifh9OnYREGT4bIu/I=", - "dev": true - }, - "file-uri-to-path": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/file-uri-to-path/-/file-uri-to-path-1.0.0.tgz", - "integrity": "sha512-0Zt+s3L7Vf1biwWZ29aARiVYLx7iMGnEUl9x33fbB/j3jR81u/O2LbqK+Bm1CDSNDKVtJ/YjwY7TUd5SkeLQLw==", - "dev": true - }, - "file-url": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/file-url/-/file-url-2.0.2.tgz", - "integrity": "sha1-6VF4TXkJUSfTcTApqwY/QIGMoq4=", - "dev": true - }, - "find-up": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", - "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", - "dev": true, - "requires": { - "locate-path": "2.0.0" - } - }, - "foreach": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/foreach/-/foreach-2.0.5.tgz", - "integrity": "sha1-C+4AUBiusmDQo6865ljdATbsG5k=", - "dev": true - }, - "forever-agent": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/forever-agent/-/forever-agent-0.6.1.tgz", - "integrity": "sha1-+8cfDEGt6zf5bFd60e1C2P2sypE=", - "dev": true - }, - "form-data": { - "version": "2.3.2", - "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.3.2.tgz", - "integrity": "sha1-SXBJi+YEwgwAXU9cI67NIda0kJk=", - "dev": true, - "requires": { - "asynckit": "0.4.0", - "combined-stream": "1.0.6", - "mime-types": "2.1.18" - } - }, - "format-util": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/format-util/-/format-util-1.0.3.tgz", - "integrity": "sha1-Ay3KShFiYqEsQ/TD7IVmQWxbLZU=", - "dev": true - }, - "formidable": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/formidable/-/formidable-1.2.0.tgz", - "integrity": "sha512-hr9aT30rAi7kf8Q2aaTpSP7xGMhlJ+MdrUDVZs3rxbD3L/K46A86s2VY7qC2D2kGYGBtiT/3j6wTx1eeUq5xAQ==", - "dev": true - }, - "fresh": { - "version": "0.5.2", - "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", - "integrity": "sha1-PYyt2Q2XZWn6g1qx+OSyOhBWBac=", - "dev": true - }, - "fs-extra": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-3.0.1.tgz", - "integrity": "sha1-N5TzeMWLNC6n27sjCVEJxLO2IpE=", - "dev": true, - "requires": { - "graceful-fs": "4.1.11", - "jsonfile": "3.0.1", - "universalify": "0.1.1" - } - }, - "fs.realpath": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", - "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", - "dev": true - }, - "ftp": { - "version": "0.3.10", - "resolved": "https://registry.npmjs.org/ftp/-/ftp-0.3.10.tgz", - "integrity": "sha1-kZfYYa2BQvPmPVqDv+TFn3MwiF0=", - "dev": true, - "requires": { - "readable-stream": "1.1.14", - "xregexp": "2.0.0" - }, - "dependencies": { - "readable-stream": { - "version": "1.1.14", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-1.1.14.tgz", - "integrity": "sha1-fPTFTvZI44EwhMY23SB54WbAgdk=", - "dev": true, - "requires": { - "core-util-is": "1.0.2", - "inherits": "2.0.3", - "isarray": "0.0.1", - "string_decoder": "0.10.31" - } - } - } - }, - "get-caller-file": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-1.0.2.tgz", - "integrity": "sha1-9wLmMSfn4jHBYKgMFVSstw1QR+U=", - "dev": true - }, - "get-stream": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-3.0.0.tgz", - "integrity": "sha1-jpQ9E1jcN1VQVOy+LtsFqhdO3hQ=", - "dev": true - }, - "get-uri": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/get-uri/-/get-uri-2.0.1.tgz", - "integrity": "sha512-7aelVrYqCLuVjq2kEKRTH8fXPTC0xKTkM+G7UlFkEwCXY3sFbSxvY375JoFowOAYbkaU47SrBvOefUlLZZ+6QA==", - "dev": true, - "requires": { - "data-uri-to-buffer": "1.2.0", - "debug": "2.6.9", - "extend": "3.0.1", - "file-uri-to-path": "1.0.0", - "ftp": "0.3.10", - "readable-stream": "2.3.5" - } - }, - "getpass": { - "version": "0.1.7", - "resolved": "https://registry.npmjs.org/getpass/-/getpass-0.1.7.tgz", - "integrity": "sha1-Xv+OPmhNVprkyysSgmBOi6YhSfo=", - "dev": true, - "requires": { - "assert-plus": "1.0.0" - } - }, - "glob": { - "version": "5.0.15", - "resolved": "https://registry.npmjs.org/glob/-/glob-5.0.15.tgz", - "integrity": "sha1-G8k2ueAvSmA/zCIuz3Yz0wuLk7E=", - "dev": true, - "requires": { - "inflight": "1.0.6", - "inherits": "2.0.3", - "minimatch": "3.0.4", - "once": "1.4.0", - "path-is-absolute": "1.0.1" - } - }, - "graceful-fs": { - "version": "4.1.11", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.1.11.tgz", - "integrity": "sha1-Dovf5NHduIVNZOBOp8AOKgJuVlg=", - "dev": true - }, - "graphlib": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/graphlib/-/graphlib-2.1.5.tgz", - "integrity": "sha512-XvtbqCcw+EM5SqQrIetIKKD+uZVNQtDPD1goIg7K73RuRZtVI5rYMdcCVSHm/AS1sCBZ7vt0p5WgXouucHQaOA==", - "dev": true, - "requires": { - "lodash": "4.17.5" - } - }, - "growl": { - "version": "1.10.3", - "resolved": "https://registry.npmjs.org/growl/-/growl-1.10.3.tgz", - "integrity": "sha512-hKlsbA5Vu3xsh1Cg3J7jSmX/WaW6A5oBeqzM88oNbCRQFz+zUaXm6yxS4RVytp1scBoJzSYl4YAEOQIt6O8V1Q==", - "dev": true - }, - "har-schema": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz", - "integrity": "sha1-qUwiJOvKwEeCoNkDVSHyRzW37JI=", - "dev": true - }, - "har-validator": { - "version": "5.0.3", - "resolved": "https://registry.npmjs.org/har-validator/-/har-validator-5.0.3.tgz", - "integrity": "sha1-ukAsJmGU8VlW7xXg/PJCmT9qff0=", - "dev": true, - "requires": { - "ajv": "5.5.2", - "har-schema": "2.0.0" - } - }, - "has-ansi": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/has-ansi/-/has-ansi-2.0.0.tgz", - "integrity": "sha1-NPUEnOHs3ysGSa8+8k5F7TVBbZE=", - "dev": true, - "requires": { - "ansi-regex": "2.1.1" - } - }, - "has-flag": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-2.0.0.tgz", - "integrity": "sha1-6CB68cx7MNRGzHC3NLXovhj4jVE=", - "dev": true - }, - "hawk": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/hawk/-/hawk-6.0.2.tgz", - "integrity": "sha512-miowhl2+U7Qle4vdLqDdPt9m09K6yZhkLDTWGoUiUzrQCn+mHHSmfJgAyGaLRZbPmTqfFFjRV1QWCW0VWUJBbQ==", - "dev": true, - "requires": { - "boom": "4.3.1", - "cryptiles": "3.1.2", - "hoek": "4.2.1", - "sntp": "2.1.0" - } - }, - "he": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/he/-/he-1.1.1.tgz", - "integrity": "sha1-k0EP0hsAlzUVH4howvJx80J+I/0=", - "dev": true - }, - "hoek": { - "version": "4.2.1", - "resolved": "https://registry.npmjs.org/hoek/-/hoek-4.2.1.tgz", - "integrity": "sha512-QLg82fGkfnJ/4iy1xZ81/9SIJiq1NGFUMGs6ParyjBZr6jW2Ufj/snDqTHixNlHdPNwN2RLVD0Pi3igeK9+JfA==", - "dev": true - }, - "hosted-git-info": { - "version": "2.6.0", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.6.0.tgz", - "integrity": "sha512-lIbgIIQA3lz5XaB6vxakj6sDHADJiZadYEJB+FgA+C4nubM1NwcuvUr9EJPmnH1skZqpqUzWborWo8EIUi0Sdw==", - "dev": true - }, - "http-errors": { - "version": "1.6.2", - "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-1.6.2.tgz", - "integrity": "sha1-CgAsyFcHGSp+eUbO7cERVfYOxzY=", - "dev": true, - "requires": { - "depd": "1.1.1", - "inherits": "2.0.3", - "setprototypeof": "1.0.3", - "statuses": "1.4.0" - }, - "dependencies": { - "depd": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/depd/-/depd-1.1.1.tgz", - "integrity": "sha1-V4O04cRZ8G+lyif5kfPQbnoxA1k=", - "dev": true - } - } - }, - "http-signature": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz", - "integrity": "sha1-muzZJRFHcvPZW2WmCruPfBj7rOE=", - "dev": true, - "requires": { - "assert-plus": "1.0.0", - "jsprim": "1.4.1", - "sshpk": "1.13.1" - } - }, - "iconv-lite": { - "version": "0.4.19", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.19.tgz", - "integrity": "sha512-oTZqweIP51xaGPI4uPa56/Pri/480R+mo7SeU+YETByQNhDG55ycFyNLIgta9vXhILrxXDmF7ZGhqZIcuN0gJQ==", - "dev": true - }, - "inflight": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", - "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", - "dev": true, - "requires": { - "once": "1.4.0", - "wrappy": "1.0.2" - } - }, - "inherits": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", - "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=", - "dev": true - }, - "invert-kv": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/invert-kv/-/invert-kv-1.0.0.tgz", - "integrity": "sha1-EEqOSqym09jNFXqO+L+rLXo//bY=", - "dev": true - }, - "is-arrayish": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", - "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=", - "dev": true - }, - "is-buffer": { - "version": "1.1.6", - "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-1.1.6.tgz", - "integrity": "sha512-NcdALwpXkTm5Zvvbk7owOUSvVvBKDgKP5/ewfXEznmQFfs4ZRmanOeKBTjRVjka3QFoN6XJ+9F3USqfHqTaU5w==", - "dev": true - }, - "is-builtin-module": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-builtin-module/-/is-builtin-module-1.0.0.tgz", - "integrity": "sha1-VAVy0096wxGfj3bDDLwbHgN6/74=", - "dev": true, - "requires": { - "builtin-modules": "1.1.1" - } - }, - "is-fullwidth-code-point": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", - "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=", - "dev": true, - "requires": { - "number-is-nan": "1.0.1" - } - }, - "is-stream": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz", - "integrity": "sha1-EtSj3U5o4Lec6428hBc66A2RykQ=", - "dev": true - }, - "is-typedarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", - "integrity": "sha1-5HnICFjfDBsR3dppQPlgEfzaSpo=", - "dev": true - }, - "is-utf8": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/is-utf8/-/is-utf8-0.2.1.tgz", - "integrity": "sha1-Sw2hRCEE0bM2NA6AeX6GXPOffXI=", - "dev": true - }, - "isarray": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", - "dev": true - }, - "isexe": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", - "dev": true - }, - "isstream": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz", - "integrity": "sha1-R+Y/evVa+m+S4VAOaQ64uFKcCZo=", - "dev": true - }, - "jison": { - "version": "0.4.13", - "resolved": "https://registry.npmjs.org/jison/-/jison-0.4.13.tgz", - "integrity": "sha1-kEFwfWIkE2f1iDRTK58ZwsNvrHg=", - "dev": true, - "requires": { - "JSONSelect": "0.4.0", - "cjson": "0.2.1", - "ebnf-parser": "0.1.10", - "escodegen": "0.0.21", - "esprima": "1.0.4", - "jison-lex": "0.2.1", - "lex-parser": "0.1.4", - "nomnom": "1.5.2" - }, - "dependencies": { - "esprima": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-1.0.4.tgz", - "integrity": "sha1-n1V+CPw7TSbs6d00+Pv0drYlha0=", - "dev": true - } - } - }, - "jison-lex": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/jison-lex/-/jison-lex-0.2.1.tgz", - "integrity": "sha1-rEuBXozOUTLrErXfz+jXB7iETf4=", - "dev": true, - "requires": { - "lex-parser": "0.1.4", - "nomnom": "1.5.2" - } - }, - "js-base64": { - "version": "2.4.3", - "resolved": "https://registry.npmjs.org/js-base64/-/js-base64-2.4.3.tgz", - "integrity": "sha512-H7ErYLM34CvDMto3GbD6xD0JLUGYXR3QTcH6B/tr4Hi/QpSThnCsIp+Sy5FRTw3B0d6py4HcNkW7nO/wdtGWEw==", - "dev": true - }, - "js-yaml": { - "version": "3.11.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.11.0.tgz", - "integrity": "sha512-saJstZWv7oNeOyBh3+Dx1qWzhW0+e6/8eDzo7p5rDFqxntSztloLtuKu+Ejhtq82jsilwOIZYsCz+lIjthg1Hw==", - "dev": true, - "requires": { - "argparse": "1.0.10", - "esprima": "4.0.0" - }, - "dependencies": { - "esprima": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.0.tgz", - "integrity": "sha512-oftTcaMu/EGrEIu904mWteKIv8vMuOgGYo7EhVJJN00R/EED9DCua/xxHRdYnKtcECzVg7xOWhflvJMnqcFZjw==", - "dev": true - } - } - }, - "jsbn": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz", - "integrity": "sha1-peZUwuWi3rXyAdls77yoDA7y9RM=", - "dev": true, - "optional": true - }, - "json-pointer": { - "version": "0.6.0", - "resolved": "https://registry.npmjs.org/json-pointer/-/json-pointer-0.6.0.tgz", - "integrity": "sha1-jlAFUKaqxUZKRzN32leqbMIoKNc=", - "dev": true, - "requires": { - "foreach": "2.0.5" - } - }, - "json-refs": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/json-refs/-/json-refs-3.0.4.tgz", - "integrity": "sha512-UFnB5j1C7XrUWQIlFGrjerFVuc04TZAyoEavfb0VofdjguWWN97aCtWsv1uX6pXylJiLw+agsyTPCnNjL6W4ag==", - "dev": true, - "requires": { - "commander": "2.11.0", - "graphlib": "2.1.5", - "js-yaml": "3.11.0", - "lodash": "4.17.5", - "native-promise-only": "0.8.1", - "path-loader": "1.0.4", - "slash": "1.0.0", - "uri-js": "3.0.2" - }, - "dependencies": { - "commander": { - "version": "2.11.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.11.0.tgz", - "integrity": "sha512-b0553uYA5YAEGgyYIGYROzKQ7X5RAqedkfjiZxwi0kL1g3bOaBNNZfYkzt/CL0umgD5wc9Jec2FbB98CjkMRvQ==", - "dev": true - } - } - }, - "json-schema": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.2.3.tgz", - "integrity": "sha1-tIDIkuWaLwWVTOcnvT8qTogvnhM=", - "dev": true - }, - "json-schema-faker": { - "version": "0.5.0-rc9", - "resolved": "https://registry.npmjs.org/json-schema-faker/-/json-schema-faker-0.5.0-rc9.tgz", - "integrity": "sha1-yv8wpFX0+LJnxZdGuzqXVBQIfBE=", - "dev": true, - "requires": { - "deref": "0.7.3", - "json-schema-ref-parser": "3.3.1", - "randexp": "0.4.9", - "tslib": "1.9.0" - } - }, - "json-schema-ref-parser": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/json-schema-ref-parser/-/json-schema-ref-parser-3.3.1.tgz", - "integrity": "sha512-stQTMhec2R/p2L9dH4XXRlpNCP0mY8QrLd/9Kl+8SHJQmwHtE1nDfXH4wbsSM+GkJMl8t92yZbI0OIol432CIQ==", - "dev": true, - "requires": { - "call-me-maybe": "1.0.1", - "debug": "3.1.0", - "es6-promise": "4.2.4", - "js-yaml": "3.11.0", - "ono": "4.0.3", - "z-schema": "3.19.1" - }, - "dependencies": { - "debug": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", - "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - } - } - }, - "json-schema-traverse": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.3.1.tgz", - "integrity": "sha1-NJptRMU6Ud6JtAgFxdXlm0F9M0A=", - "dev": true - }, - "json-stringify-safe": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz", - "integrity": "sha1-Epai1Y/UXxmg9s4B1lcB4sc1tus=", - "dev": true - }, - "jsonfile": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-3.0.1.tgz", - "integrity": "sha1-pezG9l9T9mLEQVx2daAzHQmS7GY=", - "dev": true, - "requires": { - "graceful-fs": "4.1.11" - } - }, - "jsonpath": { - "version": "0.2.12", - "resolved": "https://registry.npmjs.org/jsonpath/-/jsonpath-0.2.12.tgz", - "integrity": "sha1-W/nZEftGFsHjNwvs658NskrjTNI=", - "dev": true, - "requires": { - "esprima": "1.2.2", - "jison": "0.4.13", - "static-eval": "0.2.3", - "underscore": "1.7.0" - }, - "dependencies": { - "esprima": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-1.2.2.tgz", - "integrity": "sha1-dqD9Zvz+FU/SkmZ9wmQBl1CxZXs=", - "dev": true - } - } - }, - "jsprim": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.1.tgz", - "integrity": "sha1-MT5mvB5cwG5Di8G3SZwuXFastqI=", - "dev": true, - "requires": { - "assert-plus": "1.0.0", - "extsprintf": "1.3.0", - "json-schema": "0.2.3", - "verror": "1.10.0" - } - }, - "jwa": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/jwa/-/jwa-1.1.5.tgz", - "integrity": "sha1-oFUs4CIHQs1S4VN3SjKQXDDnVuU=", - "dev": true, - "requires": { - "base64url": "2.0.0", - "buffer-equal-constant-time": "1.0.1", - "ecdsa-sig-formatter": "1.0.9", - "safe-buffer": "5.1.1" - } - }, - "jws": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/jws/-/jws-3.1.4.tgz", - "integrity": "sha1-+ei5M46KhHJ31kRLFGT2GIDgUKI=", - "dev": true, - "requires": { - "base64url": "2.0.0", - "jwa": "1.1.5", - "safe-buffer": "5.1.1" - } - }, - "lcid": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/lcid/-/lcid-1.0.0.tgz", - "integrity": "sha1-MIrMr6C8SDo4Z7S28rlQYlHRuDU=", - "dev": true, - "requires": { - "invert-kv": "1.0.0" - } - }, - "lex-parser": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/lex-parser/-/lex-parser-0.1.4.tgz", - "integrity": "sha1-ZMTwJfF/1Tv7RXY/rrFvAVp0dVA=", - "dev": true - }, - "linq": { - "version": "3.0.9", - "resolved": "https://registry.npmjs.org/linq/-/linq-3.0.9.tgz", - "integrity": "sha512-9kDSW2s4sjajLcGN4f+pRiwYZrbqmwDibQyysEgRSvA8dgHmqEEruYQX4GNBQAiOYcMv8IdUbCWgDq6eUidkKQ==", - "dev": true - }, - "linq-es2015": { - "version": "2.4.31", - "resolved": "https://registry.npmjs.org/linq-es2015/-/linq-es2015-2.4.31.tgz", - "integrity": "sha1-ojefUjrJVW3O6uppnChfEWokg68=", - "dev": true, - "requires": { - "mocha-lcov-reporter": "1.3.0" - } - }, - "load-json-file": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-2.0.0.tgz", - "integrity": "sha1-eUfkIUmvgNaWy/eXvKq8/h/inKg=", - "dev": true, - "requires": { - "graceful-fs": "4.1.11", - "parse-json": "2.2.0", - "pify": "2.3.0", - "strip-bom": "3.0.0" - } - }, - "locate-path": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", - "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", - "dev": true, - "requires": { - "p-locate": "2.0.0", - "path-exists": "3.0.0" - } - }, - "lodash": { - "version": "4.17.5", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.5.tgz", - "integrity": "sha512-svL3uiZf1RwhH+cWrfZn3A4+U58wbP0tGVTLQPbjplZxZ8ROD9VLuNgsRniTlLe7OlSqR79RUehXgpBW/s0IQw==", - "dev": true - }, - "lodash._arraypool": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._arraypool/-/lodash._arraypool-2.4.1.tgz", - "integrity": "sha1-6I7suS4ruEyQZWEv2VigcZzUf5Q=", - "dev": true - }, - "lodash._basebind": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._basebind/-/lodash._basebind-2.4.1.tgz", - "integrity": "sha1-6UC5690nwyfgqNqxtVkWxTQelXU=", - "dev": true, - "requires": { - "lodash._basecreate": "2.4.1", - "lodash._setbinddata": "2.4.1", - "lodash._slice": "2.4.1", - "lodash.isobject": "2.4.1" - } - }, - "lodash._baseclone": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._baseclone/-/lodash._baseclone-2.4.1.tgz", - "integrity": "sha1-MPgj5X4X43NdODvWK2Czh1Q7QYY=", - "dev": true, - "requires": { - "lodash._getarray": "2.4.1", - "lodash._releasearray": "2.4.1", - "lodash._slice": "2.4.1", - "lodash.assign": "2.4.1", - "lodash.foreach": "2.4.1", - "lodash.forown": "2.4.1", - "lodash.isarray": "2.4.1", - "lodash.isobject": "2.4.1" - }, - "dependencies": { - "lodash.assign": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash.assign/-/lodash.assign-2.4.1.tgz", - "integrity": "sha1-hMOVlt1xGBqXsGUpE6fJZ15Jsao=", - "dev": true, - "requires": { - "lodash._basecreatecallback": "2.4.1", - "lodash._objecttypes": "2.4.1", - "lodash.keys": "2.4.1" - } - } - } - }, - "lodash._basecreate": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._basecreate/-/lodash._basecreate-2.4.1.tgz", - "integrity": "sha1-+Ob1tXip405UEXm1a47uv0oofgg=", - "dev": true, - "requires": { - "lodash._isnative": "2.4.1", - "lodash.isobject": "2.4.1", - "lodash.noop": "2.4.1" - } - }, - "lodash._basecreatecallback": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._basecreatecallback/-/lodash._basecreatecallback-2.4.1.tgz", - "integrity": "sha1-fQsmdknLKeehOdAQO3wR+uhOSFE=", - "dev": true, - "requires": { - "lodash._setbinddata": "2.4.1", - "lodash.bind": "2.4.1", - "lodash.identity": "2.4.1", - "lodash.support": "2.4.1" - } - }, - "lodash._basecreatewrapper": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._basecreatewrapper/-/lodash._basecreatewrapper-2.4.1.tgz", - "integrity": "sha1-TTHy595+E0+/KAN2K4FQsyUZZm8=", - "dev": true, - "requires": { - "lodash._basecreate": "2.4.1", - "lodash._setbinddata": "2.4.1", - "lodash._slice": "2.4.1", - "lodash.isobject": "2.4.1" - } - }, - "lodash._createwrapper": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._createwrapper/-/lodash._createwrapper-2.4.1.tgz", - "integrity": "sha1-UdaVeXPaTtVW43KQ2MGhjFPeFgc=", - "dev": true, - "requires": { - "lodash._basebind": "2.4.1", - "lodash._basecreatewrapper": "2.4.1", - "lodash._slice": "2.4.1", - "lodash.isfunction": "2.4.1" - } - }, - "lodash._getarray": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._getarray/-/lodash._getarray-2.4.1.tgz", - "integrity": "sha1-+vH3+BD6mFolHCGHQESBCUg55e4=", - "dev": true, - "requires": { - "lodash._arraypool": "2.4.1" - } - }, - "lodash._isnative": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._isnative/-/lodash._isnative-2.4.1.tgz", - "integrity": "sha1-PqZAS3hKe+g2x7V1gOHN95sUgyw=", - "dev": true - }, - "lodash._maxpoolsize": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._maxpoolsize/-/lodash._maxpoolsize-2.4.1.tgz", - "integrity": "sha1-nUgvRjuOZq++WcLBTtsRcGAXIzQ=", - "dev": true - }, - "lodash._objecttypes": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._objecttypes/-/lodash._objecttypes-2.4.1.tgz", - "integrity": "sha1-fAt/admKH3ZSn4kLDNsbTf7BHBE=", - "dev": true - }, - "lodash._releasearray": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._releasearray/-/lodash._releasearray-2.4.1.tgz", - "integrity": "sha1-phOWMNdtFTawfdyAliiJsIL2pkE=", - "dev": true, - "requires": { - "lodash._arraypool": "2.4.1", - "lodash._maxpoolsize": "2.4.1" - } - }, - "lodash._setbinddata": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._setbinddata/-/lodash._setbinddata-2.4.1.tgz", - "integrity": "sha1-98IAzRuS7yNrOZ7s9zxkjReqlNI=", - "dev": true, - "requires": { - "lodash._isnative": "2.4.1", - "lodash.noop": "2.4.1" - } - }, - "lodash._shimkeys": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._shimkeys/-/lodash._shimkeys-2.4.1.tgz", - "integrity": "sha1-bpzJZm/wgfC1psl4uD4kLmlJ0gM=", - "dev": true, - "requires": { - "lodash._objecttypes": "2.4.1" - } - }, - "lodash._slice": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash._slice/-/lodash._slice-2.4.1.tgz", - "integrity": "sha1-dFz0GlNZexj2iImFREBe+isG2Q8=", - "dev": true - }, - "lodash.assign": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/lodash.assign/-/lodash.assign-4.2.0.tgz", - "integrity": "sha1-DZnzzNem0mHRm9rrkkUAXShYCOc=", - "dev": true - }, - "lodash.bind": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash.bind/-/lodash.bind-2.4.1.tgz", - "integrity": "sha1-XRn6AFyMTSNvr0dCx7eh/Kvikmc=", - "dev": true, - "requires": { - "lodash._createwrapper": "2.4.1", - "lodash._slice": "2.4.1" - } - }, - "lodash.clonedeep": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash.clonedeep/-/lodash.clonedeep-2.4.1.tgz", - "integrity": "sha1-8pIDtAsS/uCkXTYxZIJZvrq8eGg=", - "dev": true, - "requires": { - "lodash._baseclone": "2.4.1", - "lodash._basecreatecallback": "2.4.1" - } - }, - "lodash.foreach": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash.foreach/-/lodash.foreach-2.4.1.tgz", - "integrity": "sha1-/j/Do0yGyUyrb5UiVgKCdB4BYwk=", - "dev": true, - "requires": { - "lodash._basecreatecallback": "2.4.1", - "lodash.forown": "2.4.1" - } - }, - "lodash.forown": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash.forown/-/lodash.forown-2.4.1.tgz", - "integrity": "sha1-eLQer+FAX6lmRZ6kGT/VAtCEUks=", - "dev": true, - "requires": { - "lodash._basecreatecallback": "2.4.1", - "lodash._objecttypes": "2.4.1", - "lodash.keys": "2.4.1" - } - }, - "lodash.get": { - "version": "4.4.2", - "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", - "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=", - "dev": true - }, - "lodash.identity": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash.identity/-/lodash.identity-2.4.1.tgz", - "integrity": "sha1-ZpTP+mX++TH3wxzobHRZfPVg9PE=", - "dev": true - }, - "lodash.isarray": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash.isarray/-/lodash.isarray-2.4.1.tgz", - "integrity": "sha1-tSoybB9i9tfac6MdVAHfbvRPD6E=", - "dev": true, - "requires": { - "lodash._isnative": "2.4.1" - } - }, - "lodash.isequal": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", - "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA=", - "dev": true - }, - "lodash.isfunction": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash.isfunction/-/lodash.isfunction-2.4.1.tgz", - "integrity": "sha1-LP1XXHPkmKtX4xm3f6Aq3vE6lNE=", - "dev": true - }, - "lodash.isobject": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash.isobject/-/lodash.isobject-2.4.1.tgz", - "integrity": "sha1-Wi5H/mmVPx7mMafrof5k0tBlWPU=", - "dev": true, - "requires": { - "lodash._objecttypes": "2.4.1" - } - }, - "lodash.keys": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash.keys/-/lodash.keys-2.4.1.tgz", - "integrity": "sha1-SN6kbfj/djKxDXBrissmWR4rNyc=", - "dev": true, - "requires": { - "lodash._isnative": "2.4.1", - "lodash._shimkeys": "2.4.1", - "lodash.isobject": "2.4.1" - } - }, - "lodash.noop": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash.noop/-/lodash.noop-2.4.1.tgz", - "integrity": "sha1-T7VPgWZS5a4Q6PcvcXo4jHMmU4o=", - "dev": true - }, - "lodash.support": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/lodash.support/-/lodash.support-2.4.1.tgz", - "integrity": "sha1-Mg4LZwMWc8KNeiu12eAzGkUkBRU=", - "dev": true, - "requires": { - "lodash._isnative": "2.4.1" - } - }, - "lodash.toarray": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/lodash.toarray/-/lodash.toarray-4.4.0.tgz", - "integrity": "sha1-JMS/zWsvuji/0FlNsRedjptlZWE=", - "dev": true - }, - "lru-cache": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-4.1.2.tgz", - "integrity": "sha512-wgeVXhrDwAWnIF/yZARsFnMBtdFXOg1b8RIrhilp+0iDYN4mdQcNZElDZ0e4B64BhaxeQ5zN7PMyvu7we1kPeQ==", - "dev": true, - "requires": { - "pseudomap": "1.0.2", - "yallist": "2.1.2" - } - }, - "marked": { - "version": "0.3.17", - "resolved": "https://registry.npmjs.org/marked/-/marked-0.3.17.tgz", - "integrity": "sha512-+AKbNsjZl6jFfLPwHhWmGTqE009wTKn3RTmn9K8oUKHrX/abPJjtcRtXpYB/FFrwPJRUA86LX/de3T0knkPCmQ==", - "dev": true - }, - "marked-terminal": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/marked-terminal/-/marked-terminal-2.0.0.tgz", - "integrity": "sha1-Xq9Wi+ZvaGVBr6UqVYKAMQox3i0=", - "dev": true, - "requires": { - "cardinal": "1.0.0", - "chalk": "1.1.3", - "cli-table": "0.3.1", - "lodash.assign": "4.2.0", - "node-emoji": "1.8.1" - } - }, - "mdurl": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", - "integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4=", - "dev": true - }, - "media-typer": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", - "integrity": "sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=", - "dev": true - }, - "mem": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/mem/-/mem-1.1.0.tgz", - "integrity": "sha1-Xt1StIXKHZAP5kiVUFOZoN+kX3Y=", - "dev": true, - "requires": { - "mimic-fn": "1.2.0" - } - }, - "memorystream": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/memorystream/-/memorystream-0.3.1.tgz", - "integrity": "sha1-htcJCzDORV1j+64S3aUaR93K+bI=", - "dev": true - }, - "methods": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", - "integrity": "sha1-VSmk1nZUE07cxSZmVoNbD4Ua/O4=", - "dev": true - }, - "mime": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", - "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", - "dev": true - }, - "mime-db": { - "version": "1.33.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.33.0.tgz", - "integrity": "sha512-BHJ/EKruNIqJf/QahvxwQZXKygOQ256myeN/Ew+THcAa5q+PjyTTMMeNQC4DZw5AwfvelsUrA6B67NKMqXDbzQ==", - "dev": true - }, - "mime-types": { - "version": "2.1.18", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.18.tgz", - "integrity": "sha512-lc/aahn+t4/SWV/qcmumYjymLsWfN3ELhpmVuUFjgsORruuZPVSwAQryq+HHGvO/SI2KVX26bx+En+zhM8g8hQ==", - "dev": true, - "requires": { - "mime-db": "1.33.0" - } - }, - "mimic-fn": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-1.2.0.tgz", - "integrity": "sha512-jf84uxzwiuiIVKiOLpfYk7N46TSy8ubTonmneY9vrpHNAnp0QBt2BxWV9dO3/j+BoVAb+a5G6YDPW3M5HOdMWQ==", - "dev": true - }, - "minimatch": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", - "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", - "dev": true, - "requires": { - "brace-expansion": "1.1.11" - } - }, - "minimist": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.0.tgz", - "integrity": "sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ=", - "dev": true - }, - "mkdirp": { - "version": "0.5.1", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz", - "integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=", - "dev": true, - "requires": { - "minimist": "0.0.8" - }, - "dependencies": { - "minimist": { - "version": "0.0.8", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.8.tgz", - "integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0=", - "dev": true - } - } - }, - "mocha": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/mocha/-/mocha-5.0.4.tgz", - "integrity": "sha512-nMOpAPFosU1B4Ix1jdhx5e3q7XO55ic5a8cgYvW27CequcEY+BabS0kUVL1Cw1V5PuVHZWeNRWFLmEPexo79VA==", - "dev": true, - "requires": { - "browser-stdout": "1.3.1", - "commander": "2.11.0", - "debug": "3.1.0", - "diff": "3.5.0", - "escape-string-regexp": "1.0.5", - "glob": "7.1.2", - "growl": "1.10.3", - "he": "1.1.1", - "mkdirp": "0.5.1", - "supports-color": "4.4.0" - }, - "dependencies": { - "commander": { - "version": "2.11.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.11.0.tgz", - "integrity": "sha512-b0553uYA5YAEGgyYIGYROzKQ7X5RAqedkfjiZxwi0kL1g3bOaBNNZfYkzt/CL0umgD5wc9Jec2FbB98CjkMRvQ==", - "dev": true - }, - "debug": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", - "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - }, - "glob": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.2.tgz", - "integrity": "sha512-MJTUg1kjuLeQCJ+ccE4Vpa6kKVXkPYJ2mOCQyUuKLcLQsdrMCpBPUi8qVE6+YuaJkozeA9NusTAw3hLr8Xe5EQ==", - "dev": true, - "requires": { - "fs.realpath": "1.0.0", - "inflight": "1.0.6", - "inherits": "2.0.3", - "minimatch": "3.0.4", - "once": "1.4.0", - "path-is-absolute": "1.0.1" - } - }, - "supports-color": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-4.4.0.tgz", - "integrity": "sha512-rKC3+DyXWgK0ZLKwmRsrkyHVZAjNkfzeehuFWdGGcqGDTZFH73+RH6S/RDAAxl9GusSjZSUWYLmT9N5pzXFOXQ==", - "dev": true, - "requires": { - "has-flag": "2.0.0" - } - } - } - }, - "mocha-lcov-reporter": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/mocha-lcov-reporter/-/mocha-lcov-reporter-1.3.0.tgz", - "integrity": "sha1-Rpve9PivyaEWBW8HnfYYLQr7A4Q=", - "dev": true - }, - "moment": { - "version": "2.21.0", - "resolved": "https://registry.npmjs.org/moment/-/moment-2.21.0.tgz", - "integrity": "sha512-TCZ36BjURTeFTM/CwRcViQlfkMvL1/vFISuNLO5GkcVm1+QHfbSiNqZuWeMFjj1/3+uAjXswgRk30j1kkLYJBQ==", - "dev": true - }, - "ms": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=", - "dev": true - }, - "ms-rest": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/ms-rest/-/ms-rest-2.3.1.tgz", - "integrity": "sha512-NfDgGr8dzkwOUKUdGLugfm8aiMTGVeObM6Y8m6oTGut/6lfmTxi7zsKr7E5blFJhrX7IcWKfNbEYTBFp1M/YyQ==", - "dev": true, - "requires": { - "@types/node": "8.9.4", - "@types/request": "2.47.0", - "@types/uuid": "3.4.3", - "duplexer": "0.1.1", - "is-buffer": "1.1.6", - "is-stream": "1.1.0", - "moment": "2.21.0", - "request": "2.83.0", - "through": "2.3.8", - "tunnel": "0.0.5", - "uuid": "3.2.1" - } - }, - "ms-rest-azure": { - "version": "2.5.4", - "resolved": "https://registry.npmjs.org/ms-rest-azure/-/ms-rest-azure-2.5.4.tgz", - "integrity": "sha512-SwycoZsBWpqxk9TvvzsoZ0/RQyT3c8lxBJmP7eXSBaG+pm9AmlRrkJwqCqNmAU1H/zcRMqhLFci276Sh4bmdCA==", - "dev": true, - "requires": { - "@types/node": "9.4.6", - "@types/uuid": "3.4.3", - "adal-node": "0.1.28", - "async": "2.6.0", - "moment": "2.21.0", - "ms-rest": "2.3.1", - "uuid": "3.2.1" - }, - "dependencies": { - "@types/node": { - "version": "9.4.6", - "resolved": "https://registry.npmjs.org/@types/node/-/node-9.4.6.tgz", - "integrity": "sha512-CTUtLb6WqCCgp6P59QintjHWqzf4VL1uPA27bipLAPxFqrtK1gEYllePzTICGqQ8rYsCbpnsNypXjjDzGAAjEQ==", - "dev": true - }, - "async": { - "version": "2.6.0", - "resolved": "https://registry.npmjs.org/async/-/async-2.6.0.tgz", - "integrity": "sha512-xAfGg1/NTLBBKlHFmnd7PlmUW9KhVQIUuSrYem9xzFUZy13ScvtyGGejaae9iAVRiRq9+Cx7DPFaAAhCpyxyPw==", - "dev": true, - "requires": { - "lodash": "4.17.5" - } - } - } - }, - "multer": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/multer/-/multer-1.3.0.tgz", - "integrity": "sha1-CSsmcPaEb6SRSWXvyM+Uwg/sbNI=", - "dev": true, - "requires": { - "append-field": "0.1.0", - "busboy": "0.2.14", - "concat-stream": "1.6.1", - "mkdirp": "0.5.1", - "object-assign": "3.0.0", - "on-finished": "2.3.0", - "type-is": "1.6.16", - "xtend": "4.0.1" - } - }, - "native-promise-only": { - "version": "0.8.1", - "resolved": "https://registry.npmjs.org/native-promise-only/-/native-promise-only-0.8.1.tgz", - "integrity": "sha1-IKMYwwy0X3H+et+/eyHJnBRy7xE=", - "dev": true - }, - "node-emoji": { - "version": "1.8.1", - "resolved": "https://registry.npmjs.org/node-emoji/-/node-emoji-1.8.1.tgz", - "integrity": "sha512-+ktMAh1Jwas+TnGodfCfjUbJKoANqPaJFN0z0iqh41eqD8dvguNzcitVSBSVK1pidz0AqGbLKcoVuVLRVZ/aVg==", - "dev": true, - "requires": { - "lodash.toarray": "4.4.0" - } - }, - "nomnom": { - "version": "1.5.2", - "resolved": "https://registry.npmjs.org/nomnom/-/nomnom-1.5.2.tgz", - "integrity": "sha1-9DRUSKhTz71cDSYyDyR3qwUm/i8=", - "dev": true, - "requires": { - "colors": "0.5.1", - "underscore": "1.1.7" - }, - "dependencies": { - "colors": { - "version": "0.5.1", - "resolved": "https://registry.npmjs.org/colors/-/colors-0.5.1.tgz", - "integrity": "sha1-fQAj6usVTo7p/Oddy5I9DtFmd3Q=", - "dev": true - }, - "underscore": { - "version": "1.1.7", - "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.1.7.tgz", - "integrity": "sha1-QLq4S60Z0jAJbo1u9ii/8FXYPbA=", - "dev": true - } - } - }, - "normalize-package-data": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-2.4.0.tgz", - "integrity": "sha512-9jjUFbTPfEy3R/ad/2oNbKtW9Hgovl5O1FvFWKkKblNXoN/Oou6+9+KKohPK13Yc3/TyunyWhJp6gvRNR/PPAw==", - "dev": true, - "requires": { - "hosted-git-info": "2.6.0", - "is-builtin-module": "1.0.0", - "semver": "5.5.0", - "validate-npm-package-license": "3.0.3" - } - }, - "npm-run-path": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-2.0.2.tgz", - "integrity": "sha1-NakjLfo11wZ7TLLd8jV7GHFTbF8=", - "dev": true, - "requires": { - "path-key": "2.0.1" - } - }, - "number-is-nan": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/number-is-nan/-/number-is-nan-1.0.1.tgz", - "integrity": "sha1-CXtgK1NCKlIsGvuHkDGDNpQaAR0=", - "dev": true - }, - "oad": { - "version": "0.1.9", - "resolved": "https://registry.npmjs.org/oad/-/oad-0.1.9.tgz", - "integrity": "sha512-S2PkVuMbSHqiPTzJTqQJkbtBHxfc0yvi7oGqpw2R7yUby0A9PDehBphduTBNat5cMuCWIsiauVArbjhcNq9lIQ==", - "dev": true, - "requires": { - "autorest": "2.0.4245", - "glob": "5.0.15", - "js-yaml": "3.11.0", - "json-pointer": "0.6.0", - "request": "2.83.0", - "winston": "2.4.0", - "yargs": "6.6.0" - }, - "dependencies": { - "camelcase": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-3.0.0.tgz", - "integrity": "sha1-MvxLn82vhF/N9+c7uXysImHwqwo=", - "dev": true - }, - "find-up": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-1.1.2.tgz", - "integrity": "sha1-ay6YIrGizgpgq2TWEOzK1TyyTQ8=", - "dev": true, - "requires": { - "path-exists": "2.1.0", - "pinkie-promise": "2.0.1" - } - }, - "load-json-file": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-1.1.0.tgz", - "integrity": "sha1-lWkFcI1YtLq0wiYbBPWfMcmTdMA=", - "dev": true, - "requires": { - "graceful-fs": "4.1.11", - "parse-json": "2.2.0", - "pify": "2.3.0", - "pinkie-promise": "2.0.1", - "strip-bom": "2.0.0" - } - }, - "os-locale": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/os-locale/-/os-locale-1.4.0.tgz", - "integrity": "sha1-IPnxeuKe00XoveWDsT0gCYA8FNk=", - "dev": true, - "requires": { - "lcid": "1.0.0" - } - }, - "path-exists": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-2.1.0.tgz", - "integrity": "sha1-D+tsZPD8UY2adU3V77YscCJ2H0s=", - "dev": true, - "requires": { - "pinkie-promise": "2.0.1" - } - }, - "path-type": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-1.1.0.tgz", - "integrity": "sha1-WcRPfuSR2nBNpBXaWkBwuk+P5EE=", - "dev": true, - "requires": { - "graceful-fs": "4.1.11", - "pify": "2.3.0", - "pinkie-promise": "2.0.1" - } - }, - "read-pkg": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-1.1.0.tgz", - "integrity": "sha1-9f+qXs0pyzHAR0vKfXVra7KePyg=", - "dev": true, - "requires": { - "load-json-file": "1.1.0", - "normalize-package-data": "2.4.0", - "path-type": "1.1.0" - } - }, - "read-pkg-up": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-1.0.1.tgz", - "integrity": "sha1-nWPBMnbAZZGNV/ACpX9AobZD+wI=", - "dev": true, - "requires": { - "find-up": "1.1.2", - "read-pkg": "1.1.0" - } - }, - "string-width": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", - "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", - "dev": true, - "requires": { - "code-point-at": "1.1.0", - "is-fullwidth-code-point": "1.0.0", - "strip-ansi": "3.0.1" - } - }, - "strip-bom": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-2.0.0.tgz", - "integrity": "sha1-YhmoVhZSBJHzV4i9vxRHqZx+aw4=", - "dev": true, - "requires": { - "is-utf8": "0.2.1" - } - }, - "which-module": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/which-module/-/which-module-1.0.0.tgz", - "integrity": "sha1-u6Y8qGGUiZT/MHc2CJ47lgJsKk8=", - "dev": true - }, - "yargs": { - "version": "6.6.0", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-6.6.0.tgz", - "integrity": "sha1-eC7CHvQDNF+DCoCMo9UTr1YGUgg=", - "dev": true, - "requires": { - "camelcase": "3.0.0", - "cliui": "3.2.0", - "decamelize": "1.2.0", - "get-caller-file": "1.0.2", - "os-locale": "1.4.0", - "read-pkg-up": "1.0.1", - "require-directory": "2.1.1", - "require-main-filename": "1.0.1", - "set-blocking": "2.0.0", - "string-width": "1.0.2", - "which-module": "1.0.0", - "y18n": "3.2.1", - "yargs-parser": "4.2.1" - } - }, - "yargs-parser": { - "version": "4.2.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-4.2.1.tgz", - "integrity": "sha1-KczqwNxPA8bIe0qfIX3RjJ90hxw=", - "dev": true, - "requires": { - "camelcase": "3.0.0" - } - } - } - }, - "oauth-sign": { - "version": "0.8.2", - "resolved": "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.8.2.tgz", - "integrity": "sha1-Rqarfwrq2N6unsBWV4C31O/rnUM=", - "dev": true - }, - "oav": { - "version": "0.4.34", - "resolved": "https://registry.npmjs.org/oav/-/oav-0.4.34.tgz", - "integrity": "sha1-1xFWYKPUqfkzEfC7qmX5q3mpAvU=", - "dev": true, - "requires": { - "@microsoft.azure/autorest-extension-base": "1.0.13", - "azure-arm-resource": "2.0.0-preview", - "glob": "5.0.15", - "js-yaml": "3.11.0", - "json-pointer": "0.6.0", - "jsonpath": "0.2.12", - "linq": "3.0.9", - "lodash": "4.17.5", - "moment": "2.21.0", - "ms-rest": "2.3.1", - "ms-rest-azure": "2.5.4", - "recursive-readdir": "2.2.2", - "request": "2.83.0", - "swagger-parser": "3.4.2", - "swagger-tools": "0.10.3", - "sway": "github:amarzavery/sway#21d2160311380134e31e252a7e1ce1268441c8c3", - "uuid": "3.2.1", - "vscode-jsonrpc": "3.3.1", - "winston": "2.4.0", - "yargs": "6.6.0", - "yuml2svg": "3.1.0" - }, - "dependencies": { - "camelcase": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-3.0.0.tgz", - "integrity": "sha1-MvxLn82vhF/N9+c7uXysImHwqwo=", - "dev": true - }, - "find-up": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-1.1.2.tgz", - "integrity": "sha1-ay6YIrGizgpgq2TWEOzK1TyyTQ8=", - "dev": true, - "requires": { - "path-exists": "2.1.0", - "pinkie-promise": "2.0.1" - } - }, - "load-json-file": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-1.1.0.tgz", - "integrity": "sha1-lWkFcI1YtLq0wiYbBPWfMcmTdMA=", - "dev": true, - "requires": { - "graceful-fs": "4.1.11", - "parse-json": "2.2.0", - "pify": "2.3.0", - "pinkie-promise": "2.0.1", - "strip-bom": "2.0.0" - } - }, - "os-locale": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/os-locale/-/os-locale-1.4.0.tgz", - "integrity": "sha1-IPnxeuKe00XoveWDsT0gCYA8FNk=", - "dev": true, - "requires": { - "lcid": "1.0.0" - } - }, - "path-exists": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-2.1.0.tgz", - "integrity": "sha1-D+tsZPD8UY2adU3V77YscCJ2H0s=", - "dev": true, - "requires": { - "pinkie-promise": "2.0.1" - } - }, - "path-type": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-1.1.0.tgz", - "integrity": "sha1-WcRPfuSR2nBNpBXaWkBwuk+P5EE=", - "dev": true, - "requires": { - "graceful-fs": "4.1.11", - "pify": "2.3.0", - "pinkie-promise": "2.0.1" - } - }, - "read-pkg": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-1.1.0.tgz", - "integrity": "sha1-9f+qXs0pyzHAR0vKfXVra7KePyg=", - "dev": true, - "requires": { - "load-json-file": "1.1.0", - "normalize-package-data": "2.4.0", - "path-type": "1.1.0" - } - }, - "read-pkg-up": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-1.0.1.tgz", - "integrity": "sha1-nWPBMnbAZZGNV/ACpX9AobZD+wI=", - "dev": true, - "requires": { - "find-up": "1.1.2", - "read-pkg": "1.1.0" - } - }, - "string-width": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", - "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", - "dev": true, - "requires": { - "code-point-at": "1.1.0", - "is-fullwidth-code-point": "1.0.0", - "strip-ansi": "3.0.1" - } - }, - "strip-bom": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-2.0.0.tgz", - "integrity": "sha1-YhmoVhZSBJHzV4i9vxRHqZx+aw4=", - "dev": true, - "requires": { - "is-utf8": "0.2.1" - } - }, - "which-module": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/which-module/-/which-module-1.0.0.tgz", - "integrity": "sha1-u6Y8qGGUiZT/MHc2CJ47lgJsKk8=", - "dev": true - }, - "yargs": { - "version": "6.6.0", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-6.6.0.tgz", - "integrity": "sha1-eC7CHvQDNF+DCoCMo9UTr1YGUgg=", - "dev": true, - "requires": { - "camelcase": "3.0.0", - "cliui": "3.2.0", - "decamelize": "1.2.0", - "get-caller-file": "1.0.2", - "os-locale": "1.4.0", - "read-pkg-up": "1.0.1", - "require-directory": "2.1.1", - "require-main-filename": "1.0.1", - "set-blocking": "2.0.0", - "string-width": "1.0.2", - "which-module": "1.0.0", - "y18n": "3.2.1", - "yargs-parser": "4.2.1" - } - }, - "yargs-parser": { - "version": "4.2.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-4.2.1.tgz", - "integrity": "sha1-KczqwNxPA8bIe0qfIX3RjJ90hxw=", - "dev": true, - "requires": { - "camelcase": "3.0.0" - } - } - } - }, - "object-assign": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-3.0.0.tgz", - "integrity": "sha1-m+3VygiXlJvKR+f/QIBi1Un1h/I=", - "dev": true - }, - "on-finished": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.3.0.tgz", - "integrity": "sha1-IPEzZIGwg811M3mSoWlxqi2QaUc=", - "dev": true, - "requires": { - "ee-first": "1.1.1" - } - }, - "once": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", - "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", - "dev": true, - "requires": { - "wrappy": "1.0.2" - } - }, - "ono": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/ono/-/ono-4.0.3.tgz", - "integrity": "sha512-7QIxG4UB00H7CR7fhXC/U7VhB5DK9wsYLwaYBui1JmQoXtLkhIBn3fbuk6FgAP+ctWeBsWVTM+R/bThvUZN+ww==", - "dev": true, - "requires": { - "format-util": "1.0.3" - } - }, - "os-locale": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/os-locale/-/os-locale-2.1.0.tgz", - "integrity": "sha512-3sslG3zJbEYcaC4YVAvDorjGxc7tv6KVATnLPZONiljsUncvihe9BQoVCEs0RZ1kmf4Hk9OBqlZfJZWI4GanKA==", - "dev": true, - "requires": { - "execa": "0.7.0", - "lcid": "1.0.0", - "mem": "1.1.0" - } - }, - "p-finally": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz", - "integrity": "sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4=", - "dev": true - }, - "p-limit": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.2.0.tgz", - "integrity": "sha512-Y/OtIaXtUPr4/YpMv1pCL5L5ed0rumAaAeBSj12F+bSlMdys7i8oQF/GUJmfpTS/QoaRrS/k6pma29haJpsMng==", - "dev": true, - "requires": { - "p-try": "1.0.0" - } - }, - "p-locate": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", - "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", - "dev": true, - "requires": { - "p-limit": "1.2.0" - } - }, - "p-try": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", - "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", - "dev": true - }, - "parse-json": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-2.2.0.tgz", - "integrity": "sha1-9ID0BDTvgHQfhGkJn43qGPVaTck=", - "dev": true, - "requires": { - "error-ex": "1.3.1" - } - }, - "parseurl": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.2.tgz", - "integrity": "sha1-/CidTtiZMRlGDBViUyYs3I3mW/M=", - "dev": true - }, - "path-exists": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", - "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", - "dev": true - }, - "path-is-absolute": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", - "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", - "dev": true - }, - "path-key": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-2.0.1.tgz", - "integrity": "sha1-QRyttXTFoUDTpLGRDUDYDMn0C0A=", - "dev": true - }, - "path-loader": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/path-loader/-/path-loader-1.0.4.tgz", - "integrity": "sha512-k/IPo9OWyofATP5gwIehHHQoFShS37zsSIsejKe6fjI+tqK+FnRpiSg4ZfWUpxb0g2PfCreWPqBD4ayjqjqkdQ==", - "dev": true, - "requires": { - "native-promise-only": "0.8.1", - "superagent": "3.8.2" - } - }, - "path-to-regexp": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-2.2.0.tgz", - "integrity": "sha512-zJcOPeBsraLjWXwUzFMPzH3QO2CmO1yRggtADPJjOTyCF5csQxfUGJL+CbyyRvIS09wOipi4F/fgRhdmVGSwxQ==", - "dev": true - }, - "path-type": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-2.0.0.tgz", - "integrity": "sha1-8BLMuEFbcJb8LaoQVMPXI4lZTHM=", - "dev": true, - "requires": { - "pify": "2.3.0" - } - }, - "performance-now": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz", - "integrity": "sha1-Ywn04OX6kT7BxpMHrjZLSzd8nns=", - "dev": true - }, - "pify": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/pify/-/pify-2.3.0.tgz", - "integrity": "sha1-7RQaasBDqEnqWISY59yosVMw6Qw=", - "dev": true - }, - "pinkie": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/pinkie/-/pinkie-2.0.4.tgz", - "integrity": "sha1-clVrgM+g1IqXToDnckjoDtT3+HA=", - "dev": true - }, - "pinkie-promise": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/pinkie-promise/-/pinkie-promise-2.0.1.tgz", - "integrity": "sha1-ITXW36ejWMBprJsXh3YogihFD/o=", - "dev": true, - "requires": { - "pinkie": "2.0.4" - } - }, - "process-nextick-args": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.0.tgz", - "integrity": "sha512-MtEC1TqN0EU5nephaJ4rAtThHtC86dNN9qCuEhtshvpVBkAW5ZO7BASN9REnF9eoXGcRub+pFuKEpOHE+HbEMw==", - "dev": true - }, - "proper-lockfile": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/proper-lockfile/-/proper-lockfile-2.0.1.tgz", - "integrity": "sha1-FZ+wYZPTIAP0s2kd0uwaY0qoDR0=", - "dev": true, - "requires": { - "graceful-fs": "4.1.11", - "retry": "0.10.1" - } - }, - "pseudomap": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/pseudomap/-/pseudomap-1.0.2.tgz", - "integrity": "sha1-8FKijacOYYkX7wqKw0wa5aaChrM=", - "dev": true - }, - "punycode": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-1.4.1.tgz", - "integrity": "sha1-wNWmOycYgArY4esPpSachN1BhF4=", - "dev": true - }, - "qs": { - "version": "6.5.1", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.1.tgz", - "integrity": "sha512-eRzhrN1WSINYCDCbrz796z37LOe3m5tmW7RQf6oBntukAG1nmovJvhnwHHRMAfeoItc1m2Hk02WER2aQ/iqs+A==", - "dev": true - }, - "randexp": { - "version": "0.4.9", - "resolved": "https://registry.npmjs.org/randexp/-/randexp-0.4.9.tgz", - "integrity": "sha512-maAX1cnBkzIZ89O4tSQUOF098xjGMC8N+9vuY/WfHwg87THw6odD2Br35donlj5e6KnB1SB0QBHhTQhhDHuTPQ==", - "dev": true, - "requires": { - "drange": "1.0.1", - "ret": "0.2.2" - } - }, - "range-parser": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.0.tgz", - "integrity": "sha1-9JvmtIeJTdxA3MlKMi9hEJLgDV4=", - "dev": true - }, - "raw-body": { - "version": "2.3.2", - "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.3.2.tgz", - "integrity": "sha1-vNYMd9Prk83gBQKVw/N5OJvIj4k=", - "dev": true, - "requires": { - "bytes": "3.0.0", - "http-errors": "1.6.2", - "iconv-lite": "0.4.19", - "unpipe": "1.0.0" - } - }, - "read-pkg": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-2.0.0.tgz", - "integrity": "sha1-jvHAYjxqbbDcZxPEv6xGMysjaPg=", - "dev": true, - "requires": { - "load-json-file": "2.0.0", - "normalize-package-data": "2.4.0", - "path-type": "2.0.0" - } - }, - "read-pkg-up": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-2.0.0.tgz", - "integrity": "sha1-a3KoBImE4MQeeVEP1en6mbO1Sb4=", - "dev": true, - "requires": { - "find-up": "2.1.0", - "read-pkg": "2.0.0" - } - }, - "readable-stream": { - "version": "2.3.5", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.5.tgz", - "integrity": "sha512-tK0yDhrkygt/knjowCUiWP9YdV7c5R+8cR0r/kt9ZhBU906Fs6RpQJCEilamRJj1Nx2rWI6LkW9gKqjTkshhEw==", - "dev": true, - "requires": { - "core-util-is": "1.0.2", - "inherits": "2.0.3", - "isarray": "1.0.0", - "process-nextick-args": "2.0.0", - "safe-buffer": "5.1.1", - "string_decoder": "1.0.3", - "util-deprecate": "1.0.2" - }, - "dependencies": { - "isarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", - "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=", - "dev": true - }, - "string_decoder": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.0.3.tgz", - "integrity": "sha512-4AH6Z5fzNNBcH+6XDMfA/BTt87skxqJlO0lAh3Dker5zThcAxG6mKz+iGu308UKoPPQ8Dcqx/4JhujzltRa+hQ==", - "dev": true, - "requires": { - "safe-buffer": "5.1.1" - } - } - } - }, - "recursive-readdir": { - "version": "2.2.2", - "resolved": "https://registry.npmjs.org/recursive-readdir/-/recursive-readdir-2.2.2.tgz", - "integrity": "sha512-nRCcW9Sj7NuZwa2XvH9co8NPeXUBhZP7CRKJtU+cS6PW9FpCIFoI5ib0NT1ZrbNuPoRy0ylyCaUL8Gih4LSyFg==", - "dev": true, - "requires": { - "minimatch": "3.0.4" - } - }, - "redeyed": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/redeyed/-/redeyed-1.0.1.tgz", - "integrity": "sha1-6WwZO0DAgWsArshCaY5hGF5VSYo=", - "dev": true, - "requires": { - "esprima": "3.0.0" - } - }, - "request": { - "version": "2.83.0", - "resolved": "https://registry.npmjs.org/request/-/request-2.83.0.tgz", - "integrity": "sha512-lR3gD69osqm6EYLk9wB/G1W/laGWjzH90t1vEa2xuxHD5KUrSzp9pUSfTm+YC5Nxt2T8nMPEvKlhbQayU7bgFw==", - "dev": true, - "requires": { - "aws-sign2": "0.7.0", - "aws4": "1.6.0", - "caseless": "0.12.0", - "combined-stream": "1.0.6", - "extend": "3.0.1", - "forever-agent": "0.6.1", - "form-data": "2.3.2", - "har-validator": "5.0.3", - "hawk": "6.0.2", - "http-signature": "1.2.0", - "is-typedarray": "1.0.0", - "isstream": "0.1.2", - "json-stringify-safe": "5.0.1", - "mime-types": "2.1.18", - "oauth-sign": "0.8.2", - "performance-now": "2.1.0", - "qs": "6.5.1", - "safe-buffer": "5.1.1", - "stringstream": "0.0.5", - "tough-cookie": "2.3.4", - "tunnel-agent": "0.6.0", - "uuid": "3.2.1" - } - }, - "request-promise-core": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/request-promise-core/-/request-promise-core-1.1.1.tgz", - "integrity": "sha1-Pu4AssWqgyOc+wTFcA2jb4HNCLY=", - "dev": true, - "requires": { - "lodash": "4.17.5" - } - }, - "request-promise-native": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/request-promise-native/-/request-promise-native-1.0.5.tgz", - "integrity": "sha1-UoF3D2jgyXGeUWP9P6tIIhX0/aU=", - "dev": true, - "requires": { - "request-promise-core": "1.1.1", - "stealthy-require": "1.1.1", - "tough-cookie": "2.3.4" - } - }, - "require-directory": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", - "integrity": "sha1-jGStX9MNqxyXbiNE/+f3kqam30I=", - "dev": true - }, - "require-main-filename": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-1.0.1.tgz", - "integrity": "sha1-l/cXtp1IeE9fUmpsWqj/3aBVpNE=", - "dev": true - }, - "ret": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/ret/-/ret-0.2.2.tgz", - "integrity": "sha512-M0b3YWQs7R3Z917WRQy1HHA7Ba7D8hvZg6UE5mLykJxQVE2ju0IXbGlaHPPlkY+WN7wFP+wUMXmBFA0aV6vYGQ==", - "dev": true - }, - "retry": { - "version": "0.10.1", - "resolved": "https://registry.npmjs.org/retry/-/retry-0.10.1.tgz", - "integrity": "sha1-52OI0heZLCUnUCQdPTlW/tmNj/Q=", - "dev": true - }, - "safe-buffer": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.1.tgz", - "integrity": "sha512-kKvNJn6Mm93gAczWVJg7wH+wGYWNrDHdWvpUmHyEsgCtIwwo3bqPtV4tR5tuPaUhTOo/kvhVwd8XwwOllGYkbg==", - "dev": true - }, - "safe-eval": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/safe-eval/-/safe-eval-0.3.0.tgz", - "integrity": "sha1-Bs4RHuvZwYWrr/AI7A/P/Fxb4Aw=", - "dev": true - }, - "semver": { - "version": "5.5.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.5.0.tgz", - "integrity": "sha512-4SJ3dm0WAwWy/NVeioZh5AntkdJoWKxHxcmyP622fOkgHa4z3R0TdBJICINyaSDE6uNwVc8gZr+ZinwZAH4xIA==", - "dev": true - }, - "send": { - "version": "0.16.2", - "resolved": "https://registry.npmjs.org/send/-/send-0.16.2.tgz", - "integrity": "sha512-E64YFPUssFHEFBvpbbjr44NCLtI1AohxQ8ZSiJjQLskAdKuriYEP6VyGEsRDH8ScozGpkaX1BGvhanqCwkcEZw==", - "dev": true, - "requires": { - "debug": "2.6.9", - "depd": "1.1.2", - "destroy": "1.0.4", - "encodeurl": "1.0.2", - "escape-html": "1.0.3", - "etag": "1.8.1", - "fresh": "0.5.2", - "http-errors": "1.6.2", - "mime": "1.4.1", - "ms": "2.0.0", - "on-finished": "2.3.0", - "range-parser": "1.2.0", - "statuses": "1.4.0" - }, - "dependencies": { - "mime": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/mime/-/mime-1.4.1.tgz", - "integrity": "sha512-KI1+qOZu5DcW6wayYHSzR/tXKCDC5Om4s1z2QJjDULzLcmf3DvzS7oluY4HCTrc+9FiKmWUgeNLg7W3uIQvxtQ==", - "dev": true - } - } - }, - "serve-static": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.13.2.tgz", - "integrity": "sha512-p/tdJrO4U387R9oMjb1oj7qSMaMfmOyd4j9hOFoxZe2baQszgHcSWjuya/CiT5kgZZKRudHNOA0pYXOl8rQ5nw==", - "dev": true, - "requires": { - "encodeurl": "1.0.2", - "escape-html": "1.0.3", - "parseurl": "1.3.2", - "send": "0.16.2" - } - }, - "set-blocking": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", - "integrity": "sha1-BF+XgtARrppoA93TgrJDkrPYkPc=", - "dev": true - }, - "setprototypeof": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.0.3.tgz", - "integrity": "sha1-ZlZ+NwQ+608E2RvWWMDL77VbjgQ=", - "dev": true - }, - "shebang-command": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz", - "integrity": "sha1-RKrGW2lbAzmJaMOfNj/uXer98eo=", - "dev": true, - "requires": { - "shebang-regex": "1.0.0" - } - }, - "shebang-regex": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-1.0.0.tgz", - "integrity": "sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=", - "dev": true - }, - "signal-exit": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.2.tgz", - "integrity": "sha1-tf3AjxKH6hF4Yo5BXiUTK3NkbG0=", - "dev": true - }, - "simple-swizzle": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.2.tgz", - "integrity": "sha1-pNprY1/8zMoz9w0Xy5JZLeleVXo=", - "dev": true, - "requires": { - "is-arrayish": "0.3.1" - }, - "dependencies": { - "is-arrayish": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.1.tgz", - "integrity": "sha1-wt/DhquqDD4zxI2z/ocFnmkGXv0=", - "dev": true - } - } - }, - "slash": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/slash/-/slash-1.0.0.tgz", - "integrity": "sha1-xB8vbDn8FtHNF61LXYlhFK5HDVU=", - "dev": true - }, - "sntp": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/sntp/-/sntp-2.1.0.tgz", - "integrity": "sha512-FL1b58BDrqS3A11lJ0zEdnJ3UOKqVxawAkF3k7F0CVN7VQ34aZrV+G8BZ1WC9ZL7NyrwsW0oviwsWDgRuVYtJg==", - "dev": true, - "requires": { - "hoek": "4.2.1" - } - }, - "source-map": { - "version": "0.5.7", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.5.7.tgz", - "integrity": "sha1-igOdLRAh0i0eoUyA2OpGi6LvP8w=", - "dev": true - }, - "source-map-support": { - "version": "0.4.18", - "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.4.18.tgz", - "integrity": "sha512-try0/JqxPLF9nOjvSta7tVondkP5dwgyLDjVoyMDlmjugT2lRZ1OfsrYTkCd2hkDnJTKRbO/Rl3orm8vlsUzbA==", - "dev": true, - "requires": { - "source-map": "0.5.7" - } - }, - "spark-md5": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/spark-md5/-/spark-md5-3.0.0.tgz", - "integrity": "sha1-NyIifFTi+vJLHcbZM8wUTm9xv+8=", - "dev": true - }, - "spdx-correct": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.0.0.tgz", - "integrity": "sha512-N19o9z5cEyc8yQQPukRCZ9EUmb4HUpnrmaL/fxS2pBo2jbfcFRVuFZ/oFC+vZz0MNNk0h80iMn5/S6qGZOL5+g==", - "dev": true, - "requires": { - "spdx-expression-parse": "3.0.0", - "spdx-license-ids": "3.0.0" - } - }, - "spdx-exceptions": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.1.0.tgz", - "integrity": "sha512-4K1NsmrlCU1JJgUrtgEeTVyfx8VaYea9J9LvARxhbHtVtohPs/gFGG5yy49beySjlIMhhXZ4QqujIZEfS4l6Cg==", - "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==", - "dev": true, - "requires": { - "spdx-exceptions": "2.1.0", - "spdx-license-ids": "3.0.0" - } - }, - "spdx-license-ids": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.0.tgz", - "integrity": "sha512-2+EPwgbnmOIl8HjGBXXMd9NAu02vLjOO1nWw4kmeRDFyHn+M/ETfHxQUK0oXg8ctgVnl9t3rosNVsZ1jG61nDA==", - "dev": true - }, - "sprintf-js": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", - "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", - "dev": true - }, - "sshpk": { - "version": "1.13.1", - "resolved": "https://registry.npmjs.org/sshpk/-/sshpk-1.13.1.tgz", - "integrity": "sha1-US322mKHFEMW3EwY/hzx2UBzm+M=", - "dev": true, - "requires": { - "asn1": "0.2.3", - "assert-plus": "1.0.0", - "bcrypt-pbkdf": "1.0.1", - "dashdash": "1.14.1", - "ecc-jsbn": "0.1.1", - "getpass": "0.1.7", - "jsbn": "0.1.1", - "tweetnacl": "0.14.5" - } - }, - "stack-trace": { - "version": "0.0.10", - "resolved": "https://registry.npmjs.org/stack-trace/-/stack-trace-0.0.10.tgz", - "integrity": "sha1-VHxws0fo0ytOEI6hoqFZ5f3eGcA=", - "dev": true - }, - "static-eval": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/static-eval/-/static-eval-0.2.3.tgz", - "integrity": "sha1-Aj8XrJ/uQm6niMEuo5IG3Bdfiyo=", - "dev": true, - "requires": { - "escodegen": "0.0.28" - }, - "dependencies": { - "escodegen": { - "version": "0.0.28", - "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-0.0.28.tgz", - "integrity": "sha1-Dk/xcV8yh3XWyrUaxEpAbNer/9M=", - "dev": true, - "requires": { - "esprima": "1.0.4", - "estraverse": "1.3.2", - "source-map": "0.5.7" - } - }, - "esprima": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-1.0.4.tgz", - "integrity": "sha1-n1V+CPw7TSbs6d00+Pv0drYlha0=", - "dev": true - }, - "estraverse": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-1.3.2.tgz", - "integrity": "sha1-N8K4k+8T1yPydth41g2FNRUqbEI=", - "dev": true - } - } - }, - "statuses": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.4.0.tgz", - "integrity": "sha512-zhSCtt8v2NDrRlPQpCNtw/heZLtfUDqxBM1udqikb/Hbk52LK4nQSwr10u77iopCW5LsyHpuXS0GnEc48mLeew==", - "dev": true - }, - "stealthy-require": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/stealthy-require/-/stealthy-require-1.1.1.tgz", - "integrity": "sha1-NbCYdbT/SfJqd35QmzCQoyJr8ks=", - "dev": true - }, - "streamsearch": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/streamsearch/-/streamsearch-0.1.2.tgz", - "integrity": "sha1-gIudDlb8Jz2Am6VzOOkpkZoanxo=", - "dev": true - }, - "string": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/string/-/string-3.3.3.tgz", - "integrity": "sha1-XqIRzZLSKOGEKUmQpsyXs2anfLA=", - "dev": true - }, - "string-width": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", - "integrity": "sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw==", - "dev": true, - "requires": { - "is-fullwidth-code-point": "2.0.0", - "strip-ansi": "4.0.0" - }, - "dependencies": { - "ansi-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", - "integrity": "sha1-7QMXwyIGT3lGbAKWa922Bas32Zg=", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", - "dev": true - }, - "strip-ansi": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", - "integrity": "sha1-qEeQIusaw2iocTibY1JixQXuNo8=", - "dev": true, - "requires": { - "ansi-regex": "3.0.0" - } - } - } - }, - "string.prototype.repeat": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/string.prototype.repeat/-/string.prototype.repeat-0.2.0.tgz", - "integrity": "sha1-q6Nt4I3O5qWjN9SbLqHaGyj8Ds8=", - "dev": true - }, - "string_decoder": { - "version": "0.10.31", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz", - "integrity": "sha1-YuIDvEF2bGwoyfyEMB2rHFMQ+pQ=", - "dev": true - }, - "stringstream": { - "version": "0.0.5", - "resolved": "https://registry.npmjs.org/stringstream/-/stringstream-0.0.5.tgz", - "integrity": "sha1-TkhM1N5aC7vuGORjB3EKioFiGHg=", - "dev": true - }, - "strip-ansi": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", - "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", - "dev": true, - "requires": { - "ansi-regex": "2.1.1" - } - }, - "strip-bom": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", - "integrity": "sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM=", - "dev": true - }, - "strip-eof": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz", - "integrity": "sha1-u0P/VZim6wXYm1n80SnJgzE2Br8=", - "dev": true - }, - "superagent": { - "version": "3.8.2", - "resolved": "https://registry.npmjs.org/superagent/-/superagent-3.8.2.tgz", - "integrity": "sha512-gVH4QfYHcY3P0f/BZzavLreHW3T1v7hG9B+hpMQotGQqurOvhv87GcMCd6LWySmBuf+BDR44TQd0aISjVHLeNQ==", - "dev": true, - "requires": { - "component-emitter": "1.2.1", - "cookiejar": "2.1.1", - "debug": "3.1.0", - "extend": "3.0.1", - "form-data": "2.3.2", - "formidable": "1.2.0", - "methods": "1.1.2", - "mime": "1.6.0", - "qs": "6.5.1", - "readable-stream": "2.3.5" - }, - "dependencies": { - "debug": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", - "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - } - } - }, - "supports-color": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-2.0.0.tgz", - "integrity": "sha1-U10EXOa2Nj+kARcIRimZXp3zJMc=", - "dev": true - }, - "swagger-converter": { - "version": "0.1.7", - "resolved": "https://registry.npmjs.org/swagger-converter/-/swagger-converter-0.1.7.tgz", - "integrity": "sha1-oJdRnG8e5N1n4wjZtT3cnCslf5c=", - "dev": true, - "requires": { - "lodash.clonedeep": "2.4.1" - } - }, - "swagger-methods": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/swagger-methods/-/swagger-methods-1.0.4.tgz", - "integrity": "sha512-xrKFLbrZ6VxRsg+M3uJozJtsEpNI/aPfZsOkoEjXw8vhAqdMIqwTYGj1f4dmUgvJvCdZhV5iArgtqXgs403ltg==", - "dev": true - }, - "swagger-parser": { - "version": "3.4.2", - "resolved": "https://registry.npmjs.org/swagger-parser/-/swagger-parser-3.4.2.tgz", - "integrity": "sha512-himpIkA50AjTvrgtz0PPbzwWoTjj3F3ye/y1PcW/514YEp1A3IhAcJFkkEu7b1zHnSIthnzxC8aTy+XZG0D+iA==", - "dev": true, - "requires": { - "call-me-maybe": "1.0.1", - "debug": "3.1.0", - "es6-promise": "4.2.4", - "json-schema-ref-parser": "1.4.1", - "ono": "4.0.3", - "swagger-methods": "1.0.4", - "swagger-schema-official": "2.0.0-bab6bed", - "z-schema": "3.19.1" - }, - "dependencies": { - "debug": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", - "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - }, - "json-schema-ref-parser": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/json-schema-ref-parser/-/json-schema-ref-parser-1.4.1.tgz", - "integrity": "sha1-wMLkOL8HlnI7AkUbrovH3Qs3/tA=", - "dev": true, - "requires": { - "call-me-maybe": "1.0.1", - "debug": "2.6.9", - "es6-promise": "3.3.1", - "js-yaml": "3.11.0", - "ono": "2.2.5" - }, - "dependencies": { - "debug": { - "version": "2.6.9", - "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", - "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - }, - "es6-promise": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-3.3.1.tgz", - "integrity": "sha1-oIzd6EzNvzTQJ6FFG8kdS80ophM=", - "dev": true - }, - "ono": { - "version": "2.2.5", - "resolved": "https://registry.npmjs.org/ono/-/ono-2.2.5.tgz", - "integrity": "sha1-2vCUiLURdNp6fkJ136sxtDj/oOM=", - "dev": true - } - } - } - } - }, - "swagger-schema-official": { - "version": "2.0.0-bab6bed", - "resolved": "https://registry.npmjs.org/swagger-schema-official/-/swagger-schema-official-2.0.0-bab6bed.tgz", - "integrity": "sha1-cAcEaNbSl3ylI3suUZyn0Gouo/0=", - "dev": true - }, - "swagger-tools": { - "version": "0.10.3", - "resolved": "https://registry.npmjs.org/swagger-tools/-/swagger-tools-0.10.3.tgz", - "integrity": "sha512-2eepnAxniKB/oejo4pz4wGnN9hoXfLzs6ChVluDRCVzu98F7HDSRw0C+DwmiarXD5i1rjXK8yLvUuxQxOOKOJg==", - "dev": true, - "requires": { - "async": "2.6.0", - "body-parser": "1.18.2", - "commander": "2.15.0", - "debug": "3.1.0", - "js-yaml": "3.11.0", - "json-refs": "3.0.4", - "lodash": "4.17.5", - "multer": "1.3.0", - "parseurl": "1.3.2", - "path-to-regexp": "2.2.0", - "qs": "6.5.1", - "serve-static": "1.13.2", - "spark-md5": "3.0.0", - "string": "3.3.3", - "superagent": "3.8.2", - "swagger-converter": "0.1.7", - "traverse": "0.6.6", - "z-schema": "3.19.1" - }, - "dependencies": { - "async": { - "version": "2.6.0", - "resolved": "https://registry.npmjs.org/async/-/async-2.6.0.tgz", - "integrity": "sha512-xAfGg1/NTLBBKlHFmnd7PlmUW9KhVQIUuSrYem9xzFUZy13ScvtyGGejaae9iAVRiRq9+Cx7DPFaAAhCpyxyPw==", - "dev": true, - "requires": { - "lodash": "4.17.5" - } - }, - "debug": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", - "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - } - } - }, - "sway": { - "version": "github:amarzavery/sway#21d2160311380134e31e252a7e1ce1268441c8c3", - "dev": true, - "requires": { - "debug": "3.1.0", - "faker": "4.1.0", - "js-base64": "2.4.3", - "js-yaml": "3.11.0", - "json-refs": "3.0.4", - "json-schema-faker": "0.5.0-rc9", - "lodash": "4.17.5", - "native-promise-only": "0.8.1", - "path-to-regexp": "1.7.0", - "swagger-methods": "1.0.4", - "swagger-schema-official": "2.0.0-bab6bed", - "z-schema": "3.19.1" - }, - "dependencies": { - "debug": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", - "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==", - "dev": true, - "requires": { - "ms": "2.0.0" - } - }, - "path-to-regexp": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.7.0.tgz", - "integrity": "sha1-Wf3g9DW62suhA6hOnTvGTpa5k30=", - "dev": true, - "requires": { - "isarray": "0.0.1" - } - } - } - }, - "through": { - "version": "2.3.8", - "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", - "integrity": "sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU=", - "dev": true - }, - "tough-cookie": { - "version": "2.3.4", - "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-2.3.4.tgz", - "integrity": "sha512-TZ6TTfI5NtZnuyy/Kecv+CnoROnyXn2DN97LontgQpCwsX2XyLYCC0ENhYkehSOwAp8rTQKc/NUIF7BkQ5rKLA==", - "dev": true, - "requires": { - "punycode": "1.4.1" - } - }, - "traverse": { - "version": "0.6.6", - "resolved": "https://registry.npmjs.org/traverse/-/traverse-0.6.6.tgz", - "integrity": "sha1-y99WD9e5r2MlAv7UD5GMFX6pcTc=", - "dev": true - }, - "tslib": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.9.0.tgz", - "integrity": "sha512-f/qGG2tUkrISBlQZEjEqoZ3B2+npJjIf04H1wuAv9iA8i04Icp+61KRXxFdha22670NJopsZCIjhC3SnjPRKrQ==", - "dev": true - }, - "tunnel": { - "version": "0.0.5", - "resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.5.tgz", - "integrity": "sha512-gj5sdqherx4VZKMcBA4vewER7zdK25Td+z1npBqpbDys4eJrLx+SlYjJvq1bDXs2irkuJM5pf8ktaEQVipkrbA==", - "dev": true - }, - "tunnel-agent": { - "version": "0.6.0", - "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", - "integrity": "sha1-J6XeoGs2sEoKmWZ3SykIaPD8QP0=", - "dev": true, - "requires": { - "safe-buffer": "5.1.1" - } - }, - "tweetnacl": { - "version": "0.14.5", - "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz", - "integrity": "sha1-WuaBd/GS1EViadEIr6k/+HQ/T2Q=", - "dev": true, - "optional": true - }, - "type-is": { - "version": "1.6.16", - "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.16.tgz", - "integrity": "sha512-HRkVv/5qY2G6I8iab9cI7v1bOIdhm94dVjQCPFElW9W+3GeDOSHmy2EBYe4VTApuzolPcmgFTN3ftVJRKR2J9Q==", - "dev": true, - "requires": { - "media-typer": "0.3.0", - "mime-types": "2.1.18" - } - }, - "typedarray": { - "version": "0.0.6", - "resolved": "https://registry.npmjs.org/typedarray/-/typedarray-0.0.6.tgz", - "integrity": "sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=", - "dev": true - }, - "underscore": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.7.0.tgz", - "integrity": "sha1-a7rwh3UA02vjTsqlhODbn+8DUgk=", - "dev": true - }, - "universalify": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.1.tgz", - "integrity": "sha1-+nG63UQ3r0wUiEHjs7Fl+enlkLc=", - "dev": true - }, - "unpipe": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", - "integrity": "sha1-sr9O6FFKrmFltIF4KdIbLvSZBOw=", - "dev": true - }, - "uri-js": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-3.0.2.tgz", - "integrity": "sha1-+QuFhQf4HepNz7s8TD2/orVX+qo=", - "dev": true, - "requires": { - "punycode": "2.1.0" - }, - "dependencies": { - "punycode": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.0.tgz", - "integrity": "sha1-X4Y+3Im5bbCQdLrXlHvwkFbKTn0=", - "dev": true - } - } - }, - "urijs": { - "version": "1.18.12", - "resolved": "https://registry.npmjs.org/urijs/-/urijs-1.18.12.tgz", - "integrity": "sha512-WlvUkocbQ+GYhi8zkcbecbGYq7YLSd2I3InxAfqeh6mWvWalBE7bISDHcAL3J7STrWFfizuJ709srHD+RuABPQ==", - "dev": true - }, - "util-deprecate": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", - "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=", - "dev": true - }, - "uuid": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.2.1.tgz", - "integrity": "sha512-jZnMwlb9Iku/O3smGWvZhauCf6cvvpKi4BKRiliS3cxnI+Gz9j5MEpTz2UFuXiKPJocb7gnsLHwiS05ige5BEA==", - "dev": true - }, - "validate-npm-package-license": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.3.tgz", - "integrity": "sha512-63ZOUnL4SIXj4L0NixR3L1lcjO38crAbgrTpl28t8jjrfuiOBL5Iygm+60qPs/KsZGzPNg6Smnc/oY16QTjF0g==", - "dev": true, - "requires": { - "spdx-correct": "3.0.0", - "spdx-expression-parse": "3.0.0" - } - }, - "validator": { - "version": "9.4.1", - "resolved": "https://registry.npmjs.org/validator/-/validator-9.4.1.tgz", - "integrity": "sha512-YV5KjzvRmSyJ1ee/Dm5UED0G+1L4GZnLN3w6/T+zZm8scVua4sOhYKWTUrKa0H/tMiJyO9QLHMPN+9mB/aMunA==", - "dev": true - }, - "verror": { - "version": "1.10.0", - "resolved": "https://registry.npmjs.org/verror/-/verror-1.10.0.tgz", - "integrity": "sha1-OhBcoXBTr1XW4nDB+CiGguGNpAA=", - "dev": true, - "requires": { - "assert-plus": "1.0.0", - "core-util-is": "1.0.2", - "extsprintf": "1.3.0" - } - }, - "viz.js": { - "version": "1.8.1", - "resolved": "https://registry.npmjs.org/viz.js/-/viz.js-1.8.1.tgz", - "integrity": "sha512-KrSNgnIxec+JCAqDPliO6xYA69ToH2WTYB2Kbt8Bp/XRUvm23rTyfffFi4rvQLFkIRNUz/xCnnqhh/gChhsgGA==", - "dev": true - }, - "vscode-jsonrpc": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-3.3.1.tgz", - "integrity": "sha512-iLlG27498AJF0j4GJ4yua7Z9bpJfLfwpAaAA9mihe6VDoYHwK8TyFgnpXdgjoTb8X9/DnzimQeg0bjIWINvPWw==", - "dev": true - }, - "which": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/which/-/which-1.3.0.tgz", - "integrity": "sha512-xcJpopdamTuY5duC/KnTTNBraPK54YwpenP4lzxU8H91GudWpFv38u0CKjclE1Wi2EH2EDz5LRcHcKbCIzqGyg==", - "dev": true, - "requires": { - "isexe": "2.0.0" - } - }, - "which-module": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz", - "integrity": "sha1-2e8H3Od7mQK4o6j6SzHD4/fm6Ho=", - "dev": true - }, - "winston": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/winston/-/winston-2.4.0.tgz", - "integrity": "sha1-gIBQuT1SZh7Z+2wms/DIJnCLCu4=", - "dev": true, - "requires": { - "async": "1.0.0", - "colors": "1.0.3", - "cycle": "1.0.3", - "eyes": "0.1.8", - "isstream": "0.1.2", - "stack-trace": "0.0.10" - } - }, - "wrap-ansi": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-2.1.0.tgz", - "integrity": "sha1-2Pw9KE3QV5T+hJc8rs3Rz4JP3YU=", - "dev": true, - "requires": { - "string-width": "1.0.2", - "strip-ansi": "3.0.1" - }, - "dependencies": { - "string-width": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", - "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", - "dev": true, - "requires": { - "code-point-at": "1.1.0", - "is-fullwidth-code-point": "1.0.0", - "strip-ansi": "3.0.1" - } - } - } - }, - "wrappy": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", - "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", - "dev": true - }, - "xmldom": { - "version": "0.1.27", - "resolved": "https://registry.npmjs.org/xmldom/-/xmldom-0.1.27.tgz", - "integrity": "sha1-1QH5ezvbQDr4757MIFcxh6rawOk=", - "dev": true - }, - "xpath.js": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/xpath.js/-/xpath.js-1.1.0.tgz", - "integrity": "sha512-jg+qkfS4K8E7965sqaUl8mRngXiKb3WZGfONgE18pr03FUQiuSV6G+Ej4tS55B+rIQSFEIw3phdVAQ4pPqNWfQ==", - "dev": true - }, - "xregexp": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/xregexp/-/xregexp-2.0.0.tgz", - "integrity": "sha1-UqY+VsoLhKfzpfPWGHLxJq16WUM=", - "dev": true - }, - "xtend": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.1.tgz", - "integrity": "sha1-pcbVMr5lbiPbgg77lDofBJmNY68=", - "dev": true - }, - "y18n": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/y18n/-/y18n-3.2.1.tgz", - "integrity": "sha1-bRX7qITAhnnA136I53WegR4H+kE=", - "dev": true - }, - "yallist": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-2.1.2.tgz", - "integrity": "sha1-HBH5IY8HYImkfdUS+TxmmaaoHVI=", - "dev": true - }, - "yaml-ast-parser": { - "version": "https://github.com/olydis/yaml-ast-parser/releases/download/0.0.34/yaml-ast-parser-0.0.34.tgz", - "integrity": "sha512-vot4C2kw9u2dgbXE6sOMt7t4B+snvgFovW9lJCsIkgXwKycyFdAjsBFuTa8DdmFpXe+mcMxkoHWZX0K4BZbegw==", - "dev": true - }, - "yargs": { - "version": "8.0.2", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-8.0.2.tgz", - "integrity": "sha1-YpmpBVsc78lp/355wdkY3Osiw2A=", - "dev": true, - "requires": { - "camelcase": "4.1.0", - "cliui": "3.2.0", - "decamelize": "1.2.0", - "get-caller-file": "1.0.2", - "os-locale": "2.1.0", - "read-pkg-up": "2.0.0", - "require-directory": "2.1.1", - "require-main-filename": "1.0.1", - "set-blocking": "2.0.0", - "string-width": "2.1.1", - "which-module": "2.0.0", - "y18n": "3.2.1", - "yargs-parser": "7.0.0" - } - }, - "yargs-parser": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-7.0.0.tgz", - "integrity": "sha1-jQrELxbqVd69MyyvTEA4s+P139k=", - "dev": true, - "requires": { - "camelcase": "4.1.0" - } - }, - "yuml2svg": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/yuml2svg/-/yuml2svg-3.1.0.tgz", - "integrity": "sha512-gTGq+637C+ZdURr9yyjiAKw4JcL15ZvSiifOEtvSQ1cU1FDOlC6P2+bMnlo6mwkSJaATuKwCOjYjvBRVGkA5Rw==", - "dev": true, - "requires": { - "color": "2.0.1", - "viz.js": "1.8.1" - } - }, - "z-schema": { - "version": "3.19.1", - "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-3.19.1.tgz", - "integrity": "sha512-jPNzqmOu3+AGbb4krDODqo4QBzwUGDVzyfGyy1HtWaUnafltQotatSpxxWd6Mp0iSZOUwHU5sqKYi+U8HsHMkg==", - "dev": true, - "requires": { - "commander": "2.15.0", - "lodash.get": "4.4.2", - "lodash.isequal": "4.5.0", - "validator": "9.4.1" - } - } - } -} diff --git a/package.json b/package.json index 9c1d3a990897..00d83d53243a 100644 --- a/package.json +++ b/package.json @@ -18,12 +18,15 @@ "js-yaml": "^3.8.2", "json-schema-ref-parser": "^3.1.2", "mocha": "*", - "oad": "^0.1.9", - "oav": "^0.4.34", + "oad": "^0.1.11", + "oav": "^0.4.57", "request": "^2.61.0", "request-promise-native": "^1.0.5", "z-schema": "^3.16.1" }, + "dependencies": { + "@octokit/rest": "^15.2.6" + }, "homepage": "https://github.com/azure/azure-rest-api-specs", "repository": { "type": "git", diff --git a/profile/2017-03-09-profile.json b/profile/2017-03-09-profile.json new file mode 100644 index 000000000000..1a0be606024a --- /dev/null +++ b/profile/2017-03-09-profile.json @@ -0,0 +1,118 @@ +{ + "info":{ + "name":"2017-03-09-profile", + "description":"Profile definition targeted for hybrid applications that could run on azure stack general avaialbility version and azure cloud" + }, + "resource-manager": { + "microsoft.authorization": { + "2015-01-01": [ + "locks" + ], + "2015-07-01": [ + "operations", + "permissions", + "roleAssignments", + "roleDefinitions" + ], + "2015-10-01-preview": [ + "policyAssignments", + "policyDefinitions" + ], + "2015-07-01-preview": [ + "providerOperations" + ] + }, + "microsoft.compute": { + "2016-03-30": [ + "availabilitySets", + "locations", + "locations/publishers", + "locations/operations", + "locations/usages", + "locations/vmSizes", + "operations", + "virtualMachines", + "virtualMachines/extensions", + "virtualMachineScaleSets", + "virtualMachineScaleSets/extensions", + "virtualMachineScaleSets/networkInterfaces", + "virtualMachineScaleSets/virtualMachines", + "virtualMachineScaleSets/virtualMachines/networkInterfaces" + ] + }, + "microsoft.keyvault": { + "2016-10-01": [ + "operations", + "vaults", + "vaults/accessPolicies", + "vaults/secrets" + ] + }, + "microsoft.network": { + "2015-06-15": [ + "connections", + "loadBalancers", + "localNetworkGateways", + "locations", + "locations/operationResults", + "locations/operations", + "locations/usages", + "networkInterfaces", + "networkSecurityGroups", + "operations", + "publicIpAddresses", + "routeTables", + "virtualNetworkGateways", + "virtualNetworks" + ], + "2016-04-01": [ + "dnsZones" + ] + }, + "microsoft.resources": { + "2016-02-01": [ + "deployments", + "deployments/operations", + "links", + "locations", + "operations", + "providers", + "resourceGroups", + "resources", + "tenants" + ], + "2016-09-01": [ + "links" + ], + "2016-06-01": [ + "subscriptions", + "subscriptions/locations", + "subscriptions/operationresults", + "subscriptions/providers", + "subscriptions/resourceGroups", + "subscriptions/resourceGroups/resources", + "subscriptions/resources", + "subscriptions/tagNames", + "subscriptions/tagNames/tagValues" + ] + }, + "microsoft.storage": { + "2016-01-01":[ + "checkNameAvailability", + "locations", + "locations/quotas", + "operations", + "storageAccounts", + "usages" + ] + } + }, + "data-plane": { + "microsoft.keyvault": { + "2016-10-01":[] + }, + "microsoft.storage": { + "2015-04-05":[] + } + } +} diff --git a/profile/2018-03-01-hybrid.json b/profile/2018-03-01-hybrid.json new file mode 100644 index 000000000000..41101fc9bc6b --- /dev/null +++ b/profile/2018-03-01-hybrid.json @@ -0,0 +1,158 @@ +{ + "info":{ + "name":"2018-03-01-profile", + "description":"Profile definition targeted for hybrid applications that could run on azure stack 1807 version and azure cloud" + }, + "resource-manager": { + "microsoft.authorization": { + "2016-09-01": [ + "locks" + ], + "2015-07-01": [ + "operations", + "permissions", + "roleAssignments", + "roleDefinitions" + ], + "2016-12-01": [ + "policyAssignments", + "policyDefinitions" + ] + }, + "microsoft.compute": { + "2017-03-30": [ + "availabilitySets", + "locations", + "disks", + "diskoperations", + "locations/diskoperations", + "locations/publishers", + "locations/operations", + "locations/usages", + "locations/vmSizes", + "operations", + "snapshots", + "virtualMachines", + "virtualMachines/extensions", + "virtualMachineScaleSets", + "virtualMachineScaleSets/extensions", + "virtualMachineScaleSets/networkInterfaces", + "virtualMachineScaleSets/virtualMachines", + "virtualMachineScaleSets/virtualMachines/networkInterfaces" + ] + }, + "microsoft.keyvault": { + "2016-10-01": [ + "operations", + "vaults", + "vaults/accessPolicies", + "vaults/secrets" + ] + }, + "microsoft.network": { + "2017-10-01": [ + "connections", + "loadBalancers", + "localNetworkGateways", + "locations", + "locations/operationResults", + "locations/operations", + "locations/usages", + "networkInterfaces", + "networkSecurityGroups", + "operations", + "publicIpAddresses", + "routeTables", + "virtualNetworkGateways", + "virtualNetworks" + ], + "2016-04-01": [ + "dnsZones" + ] + }, + "microsoft.resources": { + "2016-06-01": [ + "subscriptions", + "subscriptions/locations", + "tenants" + ], + "2018-02-01": [ + "deployments", + "deployments/operations", + "links", + "locations", + "operations", + "providers", + "resourceGroups", + "resources", + "subscriptions/operationresults", + "subscriptions/providers", + "subscriptions/resourceGroups", + "subscriptions/resourceGroups/resources", + "subscriptions/resources", + "subscriptions/tagNames", + "subscriptions/tagNames/tagValues", + ] + }, + "microsoft.storage": { + "2016-01-01":[ + "checkNameAvailability", + "locations", + "locations/quotas", + "operations", + "storageAccounts", + "usages" + ] + }, + "microsoft.web": { + "2016-03-01":[ + "certificates", + "deploymentLocations", + "georegions", + "operations", + "recommendations", + "runtimes", + "validate" + ], + "2016-08-01":[ + "availableStacks", + "checknameavailability", + "ishostnameavailable", + "isusernameavailable", + "metadata", + "publishingUsers", + "sourceControls", + "sites", + "sites/domainOwnershipIdentifiers", + "sites/extensions", + "sites/hostNameBindings", + "sites/instances", + "sites/instances/extensions", + "sites/metrics", + "sites/metricDefinitions", + "sites/recommendations", + "sites/slots", + "sites/slots/extensions", + "sites/slots/hostNameBindings", + "sites/slots/instances", + "sites/slots/instances/extensions", + "sites/slots/metrics", + "sites/slots/metricDefinitions" + ], + "2016-09-01":[ + "serverFarms", + "serverFarms/metrics", + "serverFarms/metricDefinitions", + "serverFarms/usages" + ] + } + }, + "data-plane": { + "microsoft.keyvault": { + "2016-10-01":[] + }, + "microsoft.storage": { + "2017-04-17":[] + } + } +} \ No newline at end of file diff --git a/profile/readme.md b/profile/readme.md new file mode 100644 index 000000000000..3eb0ddc690e4 --- /dev/null +++ b/profile/readme.md @@ -0,0 +1,62 @@ +# API Profile + +## Description + +The files in the folder describe the map of each resource provider's resource types and their supported api versions in the api profile. + +## Basics +An API profile represents a map of resource provider namespaces and their API versions. It is a representation of an Azure Platform declaring a set of APIs to be supported across all our clouds.Instead of specifying individual api-versions for each resource type across each namespace, the developer can just align the application to a profile and the tools/SDKs will themselves select the right api-versions as directed by the profile. With API Profiles developers can specify a profile version that applies to an entire template and, at runtime, ARM will pick the right versions of the resources. This way, the customers don’t have to worry about which are the right resource versions to specific clouds. + +https://docs.microsoft.com/en-us/azure/azure-stack/user/azure-stack-version-profiles + +## File Structure +The profile is a one to one map. The api version specified is a single version for the resource type, although the reource type could support other older api versions as well. + +1. **Resource manager map**: The top level node `resource-manager` defines the map for the management plane of the resource provider and api version of the resource type + +1. **Data plane map**: The top level node `data-plane` defines the map for the data plane of the resource provider and api version of the resource type + +1. **Resource provider namespace **: Each RP will have a node under the top level nodes. If an RP is not specified in the profile, it means that the profile does not support the RP. Only the supported RP will have an entry in the profile. + - Under the namespace, all the supported api versions for the namespace is specified + - The api version should have a array value of all the resource types belong to that api version + - The array value is empty for the data plane, as they do not have the concept of clearly defined resource types + - The name should match the resource type name mentioned in the resource provider manifest and in the REST API spec. + + +The structure should appear like below: +```bash +{ ++---"info":{ +| | "name":"xxxx-xx-xx-profile", +| | "description":"description of profile" +\----}, ++---"resource-manager": { +| +---"rp-namespace1": { +| | +---"api-version1":[ +| | +---"resourcetype1", +| | +---"resourcetype2" +| | ], +| | +---"api-version1":[ +| | +---"resourcetype3", +| | +---"resourcetype4" +| | ] +| \---}, +| +---"rp-namespace2": { +| | +---"api-version1":[ +| | +---"resourcetype1", +| | +---"resourcetype2", +| | +---"resourcetype3" +| | ], +| \---}, +\---}, +| + +| + +| + ++---"data-plane": { +| ----"rp-namespace1": { +| | +---"api-version1":[] +| | \---}, +| \---}, +\---} +} +``` \ No newline at end of file diff --git a/profiles/ResourceSchemas.md b/profiles/ResourceSchemas.md index 98ab01583349..62b171d9776f 100644 --- a/profiles/ResourceSchemas.md +++ b/profiles/ResourceSchemas.md @@ -108,6 +108,7 @@ batch: - ../specification/datamigration/resource-manager/Microsoft.DataMigration/2017-11-15-preview/datamigration.json - ../specification/datamigration/resource-manager/Microsoft.DataMigration/2018-03-15-preview/datamigration.json - ../specification/datamigration/resource-manager/Microsoft.DataMigration/2018-03-31-preview/datamigration.json + - ../specification/datamigration/resource-manager/Microsoft.DataMigration/2018-04-19/datamigration.json - ../specification/devtestlabs/resource-manager/Microsoft.DevTestLab/2015-05-21-preview/DTL.json - ../specification/devtestlabs/resource-manager/Microsoft.DevTestLab/2016-05-15/DTL.json - ../specification/dns/resource-manager/Microsoft.Network/2015-05-04-preview/dns.json diff --git a/scripts/breaking-change.js b/scripts/breaking-change.js index 286bff8f146a..67c44fc4463d 100644 --- a/scripts/breaking-change.js +++ b/scripts/breaking-change.js @@ -6,7 +6,6 @@ var utils = require('../test/util/utils'), path = require('path'), fs = require('fs'), os = require('os'), - exec = require('child_process').exec, execSync = require('child_process').execSync, oad = require('oad'); @@ -14,7 +13,32 @@ var utils = require('../test/util/utils'), var resolvedMapForNewSpecs = {}; let outputFolder = path.join(os.tmpdir(), "resolved"); // Used to enable running script outside TravisCI for debugging -let isRunningInTraviCI = process.env.MODE === 'BreakingChange' && process.env.PR_ONLY === 'true'; +let isRunningInTravisCI = process.env.TRAVIS === 'true'; + +const headerText = ` +| | Rule | File | Message | Location | +|-|------|------|---------| -------- | +`; + +function iconFor(type) { + if (type === 'Error') { + return ':x:'; + } else if (type === 'Warning') { + return ':warning:'; + } else if (type === 'Info') { + return ':speech_balloon:'; + } else { + return ''; + } +} + +function tableLine(filePath, diff) { + return `|${iconFor(diff['type'])}|**${diff['type']} [${diff['id']} - ${diff['code']}](https://github.com/Azure/openapi-diff/blob/master/docs/rules/${diff['id']}.md)**|[${path.basename(filePath)}](${blobHref(filePath)} "${filePath}")|${diff['message']}|
JSONPath\`${diff['json-path']}\`
|\n`; +} + +function blobHref(file) { + return `https://github.com/${process.env.TRAVIS_PULL_REQUEST_SLUG}/blob/${process.env.TRAVIS_PULL_REQUEST_SHA}/${file}`; +} /** * Compares old and new specifications for breaking change detection. @@ -23,13 +47,13 @@ let isRunningInTraviCI = process.env.MODE === 'BreakingChange' && process.env.PR * * @param {string} newSpec Path to the new swagger specification file. */ -function runOad(oldSpec, newSpec) { +async function runOad(oldSpec, newSpec) { if (oldSpec === null || oldSpec === undefined || typeof oldSpec.valueOf() !== 'string' || !oldSpec.trim().length) { - return Promise.reject(new Error('oldSpec is a required parameter of type "string" and it cannot be an empty string.')); + throw new Error('oldSpec is a required parameter of type "string" and it cannot be an empty string.'); } if (newSpec === null || newSpec === undefined || typeof newSpec.valueOf() !== 'string' || !newSpec.trim().length) { - return Promise.reject(new Error('newSpec is a required parameter of type "string" and it cannot be an empty string.')); + throw new Error('newSpec is a required parameter of type "string" and it cannot be an empty string.'); } console.log(`>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>`); @@ -37,17 +61,14 @@ function runOad(oldSpec, newSpec) { console.log(`New Spec: "${newSpec}"`); console.log(`>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>`); - return oad.compare(oldSpec, newSpec, { consoleLogLevel: 'warn', json: true }).then((result) => { - console.log(result); - if (result !== undefined && typeof result.valueOf() === 'string' && result.indexOf(`"type": "Error"`) > -1) { - console.log(`There are potential breaking changes in this PR. Please review before moving forward. Thanks!`); - process.exitCode = 1; - } - return Promise.resolve(); - }).catch(err => { - console.log(err); - process.exitCode = 1; - }); + const result = await oad.compare(oldSpec, newSpec, { consoleLogLevel: 'warn', json: true }); + console.log(result); + + if (!result) { + return; + } + + return JSON.parse(result); } /** @@ -81,45 +102,98 @@ function processViaAutoRest(swaggerPath) { //main function async function runScript() { // See whether script is in Travis CI context - console.log(`isRunningInTraviCI: ${isRunningInTraviCI}`); + console.log(`isRunningInTravisCI: ${isRunningInTravisCI}`); // Create directory to store the processed & resolved swaggers if (!fs.existsSync(outputFolder)) { fs.mkdirSync(outputFolder); } + let targetBranch = utils.getTargetBranch(); let swaggersToProcess = utils.getFilesChangedInPR(); - // For debugging in your repo, please uncomment following section and update swaggersToProcess array for the desired swaggers - // if (!isRunningInTraviCI) { - // swaggersToProcess = [ '/Users/vishrut/git-repos/azure-rest-api-specs/specification/storage/resource-manager/Microsoft.Storage/2017-06-01/storage.json', - // '/Users/vishrut/git-repos/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/2017-06-01/applicationGateway.json' ]; - // } + console.log('Processing swaggers:'); console.log(swaggersToProcess); for (const swagger of swaggersToProcess) { await processViaAutoRest(swagger); } - if (isRunningInTraviCI) { - utils.checkoutTargetBranch(); + let newSwaggers = []; + if (isRunningInTravisCI && swaggersToProcess.length > 0) { + newSwaggers = await utils.doOnBranch(utils.getTargetBranch(), async () => { + return swaggersToProcess.filter(s => !fs.existsSync(s)) + }); } console.log(`Resolved map for the new specification is:`); console.dir(resolvedMapForNewSpecs); + let errors = 0, warnings = 0; + const diffFiles = []; + const newFiles = []; + for (const swagger of swaggersToProcess) { // If file does not exists in the previous commits then we ignore it as it's new file - if (!fs.existsSync(swagger)) { + if (newSwaggers.includes(swagger)) { console.log(`File: "${swagger}" looks to be newly added in this PR.`); + newFiles.push(swagger); continue; } let outputFileNameWithExt = path.basename(swagger); console.log(outputFileNameWithExt); if (resolvedMapForNewSpecs[outputFileNameWithExt]) { - await runOad(swagger, resolvedMapForNewSpecs[outputFileNameWithExt]); + const diff = await runOad(swagger, resolvedMapForNewSpecs[outputFileNameWithExt]); + if (diff) { + diffFiles.push([swagger, diff]); + if (diff['type'] === 'Error') { + if (errors === 0) { + console.log(`There are potential breaking changes in this PR. Please review before moving forward. Thanks!`); + process.exitCode = 1; + } + errors += 1; + } else if (diff['type'] === 'Warning') { + warnings += 1; + } + } + } + } + + if (isRunningInTravisCI) { + let summary = ''; + if (errors > 0) { + summary += '**There are potential breaking changes in this PR. Please review before moving forward. Thanks!**\n\n'; + } + summary += `Compared to the target branch (**${targetBranch}**), this pull request introduces:\n\n`; + summary += `   ${errors > 0 ? iconFor('Error') : ':white_check_mark:'}   **${errors}** new error${errors !== 1 ? 's' : ''}\n\n`; + summary += `   ${warnings > 0 ? iconFor('Warning') : ':white_check_mark:'}   **${warnings}** new warning${warnings !== 1 ? 's' : ''}\n\n`; + + let message = ''; + if (newFiles.length > 0) { + message += 'The following files look to be newly added in this PR:\n'; + newFiles.forEach(f => message += `* [${f}](${blobHref(f)})\n`); + message += '

\n'; } + + if (diffFiles.length > 0) { + message += headerText; + diffFiles.forEach(([swagger, diff]) => message += tableLine(swagger, diff)); + } else { + message += '**There were no files containing new errors or warnings.**\n'; + } + + message += '\n

\nThanks for using breaking change tool to review.\nIf you encounter any issue(s), please open issue(s) at https://github.com/Azure/openapi-diff/issues.'; + + const output = { + title: `${errors === 0 ? 'No' : errors} potential breaking change${errors !== 1 ? 's' : ''}`, + summary, + text: message + }; + + console.log('---output'); + console.log(JSON.stringify(output)); + console.log('---'); } } diff --git a/scripts/install-dotnet.sh b/scripts/install-dotnet.sh new file mode 100755 index 000000000000..6d8d31fe1c1e --- /dev/null +++ b/scripts/install-dotnet.sh @@ -0,0 +1,9 @@ +#!/bin/sh + +# From https://www.microsoft.com/net/download/linux-package-manager/ubuntu14-04/sdk-2.0.0 + +wget -q https://packages.microsoft.com/config/ubuntu/14.04/packages-microsoft-prod.deb +sudo dpkg -i packages-microsoft-prod.deb +sudo apt-get install apt-transport-https -y +sudo apt-get update +sudo apt-get install dotnet-sdk-2.0.0 -y \ No newline at end of file diff --git a/scripts/liveValidation.js b/scripts/liveValidation.js deleted file mode 100644 index 4b472adc3155..000000000000 --- a/scripts/liveValidation.js +++ /dev/null @@ -1,157 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License in the project root for license information. - -'use strict'; - -const utils = require('../test/util/utils'), - request = require('request-promise-native'), - zlib = require('zlib'); - -const repoUrl = utils.getSourceRepoUrl(), - validationService = "https://app.azure-devex-tools.com/api/validations", - branch = utils.getSourceBranch(), - processingDelay = 20, - isRunningInTravisCI = process.env.MODE === 'liveValidation' && process.env.PR_ONLY === 'true', - specsPaths = utils.getFilesChangedInPR(), - regex = /resource-manager[\\|\/](.*?)[\\|\/].*?[\\|\/](.*?)[\\|\/]/, - successThreshold = 90, - validationModels = new Map(); - -let durationInSeconds = parseInt(process.env.LIVE_VALIDATION_DURATION_IN_MINUTES) * 60; -if (isNaN(durationInSeconds)) { - durationInSeconds = 180; -} - -async function runScript() { - // See whether script is in Travis CI context - console.log(`isRunningInTraviSCI: ${isRunningInTravisCI}`); - for (const specPath of specsPaths) { - let matchResult = specPath.match(regex); - - if (matchResult === null) { - continue; - } - - let resourceProvider = matchResult[1]; - let apiVersion = matchResult[2]; - - if (!validationModels.has(resourceProvider)) { - validationModels.set(resourceProvider, new Set()); - } - - validationModels.get(resourceProvider).add(apiVersion); - } - - if (validationModels.size === 0) { - console.log("Change didn't affect any swagger specs. No validation to be done."); - return; - } else if (validationModels.size > 1) { - console.log("WARNING: Multiple resource provider have changes, only the first one will be validated."); - } - - let resourceProvider = validationModels.keys().next().value; - - if (validationModels.get(resourceProvider).size > 1) { - console.log("WARNING: Multiple api versions have changes, only the first one will be validated."); - } - - let apiVersion = validationModels.get(resourceProvider).values().next().value; - - console.log(`Changes detected in a swagger spec.`); - console.log(`RP is: ${resourceProvider}`); - console.log(`ApiVersion is: ${apiVersion}`); - console.log(`Source repo is: ${repoUrl}`); - console.log(`Branch is: ${branch}`); - - console.log(`Making the request to the validation service...`); - - let response = await request.post(validationService).form({ - repoUrl: repoUrl, - branch: branch, - resourceProvider: resourceProvider, - apiVersion: apiVersion, - duration: durationInSeconds - }); - let validationId = JSON.parse(response).validationId; - - let validationResultUrl = `${validationService}/${validationId}`; - console.log(`Request done, results will be available in ${durationInSeconds} seconds...`); - - await timeout((durationInSeconds + processingDelay) * 1000); - let validationResult = JSON.parse(await request(validationResultUrl)); - - console.log(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"); - console.log(`Results of validation ${validationId}:`); - - let analyticsUrl = await createAnalyticsLink(validationId); - - let failingOperations = []; - let noTrafficOperations = []; - for (const [operationId, operationResult] of Object.entries(validationResult.operationResults)) { - - if (operationResult.operationCount === 0) { - noTrafficOperations.push(operationResult.operationId) - } else if (operationResult.successRate < successThreshold) { - failingOperations.push(operationResult.operationId); - } - - console.log(JSON.stringify(operationResult)); - } - - console.log(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"); - if (validationResult.totalOperationCount === 0) { - console.log(`There was no traffic detected for the provided RP and API version:${resourceProvider}-${apiVersion}. Please make sure there is traffic so the changes can be validated.`); - process.exitCode = 1; - } else if (failingOperations.length > 0 || noTrafficOperations.length > 0) { - console.log(`The changes in the specs introduced by this PR potentially do not reflect the Service API.`); - - console.log(`Active traffic and success rate > ${successThreshold}% FOR EACH OPERATION is required. Please review the following operations before moving forward.`); - console.log(`SUCCESS RATE < ${successThreshold}%: - ${JSON.stringify(failingOperations)}`); - - if (noTrafficOperations.length > 0) { - console.log(`NO TRAFFIC: - ${JSON.stringify(noTrafficOperations)} - `); - } - console.log(`To inspect the individual failures go to the url (add '| where customDimensions.operationId == ""' to filter for individual operations.): - ${analyticsUrl} - `); - process.exitCode = 1; - } else { - console.log(`SUCCESS RATE: ${validationResult.successRate} > ${successThreshold}. You can move forward.`); - } -} - -function timeout(ms) { - return new Promise(resolve => setTimeout(resolve, ms)); -} - -function createAnalyticsLink(validationId) { - return new Promise(resolve => { - const query = ` -traces -| where customDimensions.validationId == "${validationId}" -| where customDimensions.logType == "data" -| where customDimensions.isSuccess == "false" -| project timestamp, message, customDimensions -`; - - zlib.deflate(query, (err, buffer) => { - if (!err) { - let queryParams = buffer.toString('base64'); - let analyticsLink = `https://analytics.applicationinsights.io/subscriptions/6b085460-5f21-477e-ba44-1035046e9101/resourcegroups/openapi-platform-logs/components/openapiAI?q=${queryParams}&apptype=Node.JS×pan=P1D`; - resolve(analyticsLink); - } - }); - }); -} - -runScript().then(success => { - console.log(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"); - console.log(`Thanks for using live validation.`); - console.log(`If you encounter any issue(s), please open issue(s) at https://github.com/Azure/openapi-platform/issues .`); -}).catch(err => { - console.log(err); - process.exitCode = 1; -}); diff --git a/scripts/modelValidation.js b/scripts/modelValidation.js new file mode 100644 index 000000000000..7cc0dc62611d --- /dev/null +++ b/scripts/modelValidation.js @@ -0,0 +1,20 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License in the project root for license information. +'use strict'; + +const utils = require('../test/util/utils') +const oav = require('oav'); + +async function main() { + const swaggersToProcess = utils.getFilesChangedInPR(); + // Useful when debugging a test for a particular swagger. + // Just update the regex. That will return an array of filtered items. + // swaggersToProcess = swaggersToProcess.filter(function(item) { + // return (item.match(/.*Microsoft.Logic.*2016-06-01.*/ig) !== null); + // }); + for (const swagger of swaggersToProcess) { + await oav.validateExamples(swagger, null, {consoleLogLevel: 'error', pretty: true}); + } +} + +main() \ No newline at end of file diff --git a/scripts/momentOfTruth.js b/scripts/momentOfTruth.js index 8aba5d8bc0f9..bfe3113bf505 100644 --- a/scripts/momentOfTruth.js +++ b/scripts/momentOfTruth.js @@ -4,22 +4,14 @@ 'use strict'; const exec = require('child_process').exec, - execSync = require('child_process').execSync, path = require('path'), - util = require('util'), utils = require('../test/util/utils'), - fs = require('fs'), - request = require('request'); + fs = require('fs'); -// let blobService = azure.createBlobService(); let configsToProcess = utils.getConfigFilesChangedInPR(); -let targetBranch = utils.getTargetBranch(); -let sourceBranch = utils.getSourceBranch(); let pullRequestNumber = utils.getPullRequestNumber(); let linterCmd = `npx autorest@2.0.4152 --validation --azure-validator --message-format=json `; -let gitCheckoutCmd = `git checkout ${targetBranch}`; -let gitLogCmd = `git log -3`; -var filename = `${pullRequestNumber}_${utils.getTimeStamp()}.json`; +var filename = `${pullRequestNumber}.json`; var logFilepath = path.join(getLogDir(), filename); var finalResult = {}; finalResult["pullRequest"] = pullRequestNumber; @@ -85,20 +77,6 @@ async function getLinterResult(swaggerPath) { return []; }; -// Uploads the result file to Azure Blob Storage -async function uploadToAzureStorage(json) { - console.log(`Uploading data...`); - - const { error, response, body } = await new Promise(res => request({ - url: "http://az-bot.azurewebsites.net/process", - method: "POST", - json: true, - body: json - }, (error, response, body) => res({ error: error, response: response, body: body }))); - - console.log(body); -} - // Run linter tool async function runTools(swagger, beforeOrAfter) { console.log(`Processing "${swagger}":`); @@ -120,33 +98,29 @@ async function updateResult(spec, errors, beforeOrAfter) { //main function async function runScript() { - // Useful when debugging a test for a particular swagger. - // Just update the regex. That will return an array of filtered items. - // configsToProcess = ['/Users/vishrut/git-repos/azure-rest-api-specs/specification/storage/resource-manager/readme.md', - // '/Users/vishrut/git-repos/azure-rest-api-specs/specification/web/resource-manager/readme.md']; - configsToProcess = configsToProcess.filter(function (configFile) { - return configFile.indexOf('.md') != -1; - }); + console.log('Processing configs:'); console.log(configsToProcess); createLogFile(); console.log(`The results will be logged here: "${logFilepath}".`) - for (const configFile of configsToProcess) { - await runTools(configFile, 'after'); - } - - utils.checkoutTargetBranch(); + if (configsToProcess.length > 0) { + for (const configFile of configsToProcess) { + await runTools(configFile, 'after'); + } - for (const configFile of configsToProcess) { - await runTools(configFile, 'before'); + await utils.doOnBranch(utils.getTargetBranch(), async () => { + for (const configFile of configsToProcess) { + await runTools(configFile, 'before'); + } + }); } + writeContent(JSON.stringify(finalResult, null, 2)); - await uploadToAzureStorage(finalResult); } // magic starts here -runScript().then(success => { +runScript().then(_ => { process.exit(0); -}).catch(err => { +}).catch(_ => { process.exit(1); }) diff --git a/scripts/momentOfTruthPostProcessing.js b/scripts/momentOfTruthPostProcessing.js new file mode 100644 index 000000000000..73ff70f2dee6 --- /dev/null +++ b/scripts/momentOfTruthPostProcessing.js @@ -0,0 +1,292 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. See License.txt in the project root for license information. + +'use strict'; + +const fs = require('fs'), + crypto = require('crypto'), + utils = require('../test/util/utils'), + path = require('path'); + +let pullRequestNumber = utils.getPullRequestNumber(); +let targetBranch = utils.getTargetBranch(); +let filename = `${pullRequestNumber}.json`; +let logFilepath = path.join(getLogDir(), filename); + +function getLogDir() { + let logDir = path.join(__dirname, '../', 'output'); + return logDir; +} + +let githubTemplate = ` +

+ AutoRest linter results for {title} +

+ +{contact_message} + +{file_summaries} +`; + +let githubFooter = ` +[AutoRest Linter Guidelines](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md) | [AutoRest Linter Issues](https://github.com/Azure/azure-openapi-validator/issues) | Send
feedback + +Thanks for your co-operation. +`; + +let fileSummaryTemplate = ` + +**File**: [{file_name}]({file_href}) + +
+ :warning:{new_warnings} new Warnings ({total_warnings} total) + {potential_new_warnings} +
+ +
+ :x:{new_errors} new Errors ({total_errors} total) + {potential_new_errors} +
+ +`; + +let potentialNewWarningErrorSummaryHeader = ` +
+| Code | Id | Source | Message | +|------|----|--------|---------| +{list_of_new_warnings_errors} +`; + +let potentialNewWarningErrorSummary = `| {warning_error_code} | {warning_error_id} | [Link]({warning_error_source}) | {warning_error_message} | +`; + +let sdkContactMessage = "These errors are reported by the SDK team's validation tools, reachout to [ADX Swagger Reviewers](mailto:adxsr@microsoft.com) directly for any questions or concerns.";; +let armContactMessage = "These errors are reported by the ARM team's validation tools, reachout to [ARM RP API Review](mailto:armrpapireview@microsoft.com) directly for any questions or concerns."; +let sdkFileSummaries = '', armFileSummaries = ''; + +let data = fs.readFileSync(logFilepath, 'utf8'); +let jsonData = JSON.parse(data); + +function compareJsonRef(beforeJsonRef, afterJsonRef) { + return (beforeJsonRef.replace(/json:\d+:\d+/, '') == afterJsonRef.replace(/json:\d+:\d+/, '')); +} + +function getOutputMessages(newSDKErrorsCount, newARMErrorsCount, newSDKWarningsCount, newARMWarningsCount) { + const totalNewErrors = newSDKErrorsCount + newARMErrorsCount; + const totalNewWarnings = newSDKWarningsCount + newARMWarningsCount; + const pluralize = (word, num) => num !== 1 ? `${word}s` : word; + const iconFor = (type, num) => num > 0 ? (type === 'error' ? ':x:' : ':warning:') : ':white_check_mark:'; + + const title = `${totalNewErrors} new ${pluralize('error', totalNewErrors)} / ${totalNewWarnings} new ${pluralize('warning', totalNewWarnings)}`; + let summary = `Compared to the target branch (**${targetBranch}**), this pull request introduces:\n\n`; + summary += `   ${iconFor('error', newSDKErrorsCount)}   **${newSDKErrorsCount}** new SDK ${pluralize('error', newSDKErrorsCount)}\n\n`; + summary += `   ${iconFor('error', newARMErrorsCount)}   **${newARMErrorsCount}** new ARM ${pluralize('error', newARMErrorsCount)}\n\n`; + summary += `   ${iconFor('warning', newSDKWarningsCount)}   **${newSDKWarningsCount}** new SDK ${pluralize('warning', newSDKWarningsCount)}\n\n`; + summary += `   ${iconFor('warning', newARMWarningsCount)}   **${newARMWarningsCount}** new ARM ${pluralize('warning', newARMWarningsCount)}\n\n`; + + return [title, summary]; +} + +function getSummaryBlock(summaryTitle, fileSummaries, contactMessage) { + let githubTemplateCopy = githubTemplate; + githubTemplateCopy = githubTemplateCopy.replace("{title}", summaryTitle); + githubTemplateCopy = githubTemplateCopy.replace("{file_summaries}", fileSummaries !== '' ? fileSummaries : `**There were no files containing new ${summaryTitle}.**`); + githubTemplateCopy = githubTemplateCopy.replace("{contact_message}", contactMessage); + return githubTemplateCopy; +} + +function compareBeforeAfterArrays(afterArray, beforeArray, newArray) { + if(afterArray.length > beforeArray.length){ + afterArray.forEach(afterValue => { + let errorFound = false; + beforeArray.forEach(beforeValue => { + if( + beforeValue.type == afterValue.type && + beforeValue.code == afterValue.code && + beforeValue.message == afterValue.message && + beforeValue.id == afterValue.id && + beforeValue.validationCategory == afterValue.validationCategory && + beforeValue.providerNamespace == afterValue.providerNamespace && + beforeValue.resourceType == afterValue.resourceType && + beforeValue.sources.length == afterValue.sources.length && + compareJsonRef(beforeValue.jsonref, afterValue.jsonref) + ) { + errorFound = true; + } + }); + if(!errorFound) { + newArray.push(afterValue); + } + }); + } +} + +function getLink(jsonRef, prNumber){ + let line = "1"; + + try { + line = jsonRef.substr(jsonRef.indexOf(".json:") + 6).split(':')[0]; + } catch(error) { + line = "1"; + } + + let fileName = jsonRef.substr(jsonRef.indexOf("specification"), (jsonRef.indexOf(".json") + 5) - jsonRef.indexOf("specification")); + let md5 = crypto.createHash('md5').update(fileName).digest("hex"); + + let link = "https://github.com/" + process.env.TRAVIS_REPO_SLUG + "/pull/" + + prNumber + + "/files?diff=unified#diff-" + + md5 + "R" + line; + + return link; +} + +function blobHref(file) { + return `https://github.com/${process.env.TRAVIS_PULL_REQUEST_SLUG}/blob/${process.env.TRAVIS_PULL_REQUEST_SHA}/${file}`; +} + +function getFileSummary(fileName, beforeWarningsArray, afterWarningsArray, beforeErrorsArray, afterErrorsArray, newWarnings, newErrors, prNumber) { + let fileSummaryCopy = fileSummaryTemplate; + fileSummaryCopy = fileSummaryCopy.replace("{file_name}", fileName); + fileSummaryCopy = fileSummaryCopy.replace("{file_href}", blobHref(fileName)); + fileSummaryCopy = fileSummaryCopy.replace("{before_warnings}", beforeWarningsArray.length); + fileSummaryCopy = fileSummaryCopy.replace("{after_warnings}", afterWarningsArray.length); + fileSummaryCopy = fileSummaryCopy.replace("{before_errors}", beforeErrorsArray.length); + fileSummaryCopy = fileSummaryCopy.replace("{after_errors}", afterErrorsArray.length); + + + fileSummaryCopy = fileSummaryCopy.replace("{new_warnings}", newWarnings.length); + fileSummaryCopy = fileSummaryCopy.replace("{new_errors}", newErrors.length); + fileSummaryCopy = fileSummaryCopy.replace("{total_warnings}", afterWarningsArray.length); + fileSummaryCopy = fileSummaryCopy.replace("{total_errors}", afterErrorsArray.length); + + if(newWarnings.length > 0){ + let potentialNewWarnings = ''; + newWarnings.forEach(function(newWarning) { + let potentialNewWarningErrorSummaryCopy = potentialNewWarningErrorSummary; + potentialNewWarningErrorSummaryCopy = potentialNewWarningErrorSummaryCopy.replace("{warning_error_code}", newWarning.code); + potentialNewWarningErrorSummaryCopy = potentialNewWarningErrorSummaryCopy.replace("{warning_error_message}", newWarning.message); + potentialNewWarningErrorSummaryCopy = potentialNewWarningErrorSummaryCopy.replace("{warning_error_id}", newWarning.id); + potentialNewWarningErrorSummaryCopy = potentialNewWarningErrorSummaryCopy.replace("{warning_error_source}", getLink(newWarning.jsonref, prNumber)); + potentialNewWarnings = potentialNewWarnings.concat(potentialNewWarningErrorSummaryCopy); + }); + fileSummaryCopy = fileSummaryCopy.replace("{potential_new_warnings}", potentialNewWarningErrorSummaryHeader.replace("{list_of_new_warnings_errors}", potentialNewWarnings).replace("{table_title}", "Potential New Warnings")) + } else { + fileSummaryCopy = fileSummaryCopy.replace("{potential_new_warnings}", ""); + } + + if(newErrors.length > 0){ + let potentialNewErrors = ''; + newErrors.forEach(function(newError) { + let potentialNewWarningErrorSummaryCopy = potentialNewWarningErrorSummary; + potentialNewWarningErrorSummaryCopy = potentialNewWarningErrorSummaryCopy.replace("{warning_error_code}", newError.code); + potentialNewWarningErrorSummaryCopy = potentialNewWarningErrorSummaryCopy.replace("{warning_error_message}", newError.message); + potentialNewWarningErrorSummaryCopy = potentialNewWarningErrorSummaryCopy.replace("{warning_error_id}", newError.id); + potentialNewWarningErrorSummaryCopy = potentialNewWarningErrorSummaryCopy.replace("{warning_error_source}", getLink(newError.jsonref, prNumber)); + potentialNewErrors = potentialNewErrors.concat(potentialNewWarningErrorSummaryCopy); + }); + fileSummaryCopy = fileSummaryCopy.replace("{potential_new_errors}", potentialNewWarningErrorSummaryHeader.replace("{list_of_new_warnings_errors}", potentialNewErrors).replace("{table_title}", "Potential New Errors")) + } else { + fileSummaryCopy = fileSummaryCopy.replace("{potential_new_errors}", ""); + } + + return fileSummaryCopy; +} + +function postProcessing() { + let newSDKErrorsCount = 0, newARMErrorsCount = 0, newSDKWarningsCount = 0, newARMWarningsCount = 0; + + for(var fileName in jsonData['files']) { + let beforeErrorsSDKArray = [], beforeWarningsSDKArray = [], beforeErrorsARMArray = [], beforeWarningsARMArray = []; + let afterErrorsSDKArray = [], afterWarningsSDKArray = [], afterErrorsARMArray = [], afterWarningsARMArray = []; + let newSDKErrors = [], newSDKWarnings = [], newARMErrors = [], newARMWarnings = []; + + let beforeErrorsAndWarningsArray = jsonData['files'][fileName]['before']; + beforeErrorsAndWarningsArray.forEach(beforeErrorOrWarning => { + if(beforeErrorOrWarning.type.toLowerCase() == 'warning'){ + if(beforeErrorOrWarning.validationCategory.toLowerCase() == 'sdkviolation') { + beforeWarningsSDKArray.push(beforeErrorOrWarning); + } else { + beforeWarningsARMArray.push(beforeErrorOrWarning); + } + } + + if(beforeErrorOrWarning.type.toLowerCase() == 'error'){ + if(beforeErrorOrWarning.validationCategory.toLowerCase() == 'sdkviolation') { + beforeErrorsSDKArray.push(beforeErrorOrWarning); + } else { + beforeErrorsARMArray.push(beforeErrorOrWarning); + } + } + }); + + let afterErrorsAndWarningsArray = jsonData['files'][fileName]['after']; + afterErrorsAndWarningsArray.forEach(afterErrorOrWarning => { + if(afterErrorOrWarning.type.toLowerCase() == 'warning'){ + if(afterErrorOrWarning.validationCategory.toLowerCase() == 'sdkviolation') { + afterWarningsSDKArray.push(afterErrorOrWarning); + } else { + afterWarningsARMArray.push(afterErrorOrWarning); + } + } + + if(afterErrorOrWarning.type.toLowerCase() == 'error'){ + if(afterErrorOrWarning.validationCategory.toLowerCase() == 'sdkviolation') { + afterErrorsSDKArray.push(afterErrorOrWarning); + } else { + afterErrorsARMArray.push(afterErrorOrWarning); + } + } + }); + + compareBeforeAfterArrays(afterErrorsARMArray, beforeErrorsARMArray, newARMErrors); + compareBeforeAfterArrays(afterErrorsSDKArray, beforeErrorsSDKArray, newSDKErrors); + compareBeforeAfterArrays(afterWarningsARMArray, beforeWarningsARMArray, newARMWarnings); + compareBeforeAfterArrays(afterWarningsSDKArray, beforeWarningsSDKArray, newSDKWarnings); + + console.log("SDK Errors/Warnings"); + console.log("==================="); + console.log("Errors: Before: ", beforeErrorsSDKArray.length, " - After: ", afterErrorsSDKArray.length); + console.log("Warnings: Before: ", beforeWarningsSDKArray.length, " - After: ", afterWarningsSDKArray.length); + console.log("New SDK Errors: ", newSDKErrors.length); + console.log("New SDK Warnings: ", newSDKWarnings.length); + console.log(); + console.log("ARM Errors/Warnings"); + console.log("==================="); + console.log("Errors: Before: ", beforeErrorsARMArray.length, " - After: ", afterErrorsARMArray.length); + console.log("Warnings: Before: ", beforeWarningsARMArray.length, " - After: ", afterWarningsARMArray.length); + console.log("New ARM Errors: ", newARMErrors.length); + console.log("New ARM Warnings: ", newARMWarnings.length); + console.log(); + + newSDKErrorsCount += newSDKErrors.length; + newARMErrorsCount += newARMErrors.length; + newSDKWarningsCount += newSDKWarnings.length; + newARMWarningsCount += newARMWarnings.length; + + let fileSummaryCopy = getFileSummary(fileName, beforeWarningsSDKArray, afterWarningsSDKArray, beforeErrorsSDKArray, afterErrorsSDKArray, newSDKWarnings, newSDKErrors, pullRequestNumber); + sdkFileSummaries = sdkFileSummaries.concat(fileSummaryCopy); + fileSummaryCopy = getFileSummary(fileName, beforeWarningsARMArray, afterWarningsARMArray, beforeErrorsARMArray, afterErrorsARMArray, newARMWarnings, newARMErrors, pullRequestNumber); + armFileSummaries = armFileSummaries.concat(fileSummaryCopy); + } + + const sdkSummary = getSummaryBlock("SDK-related validation Errors / Warnings", sdkFileSummaries, sdkContactMessage); + const armSummary = getSummaryBlock("ARM-related validation Errors / Warnings", armFileSummaries, armContactMessage); + + const [title, summary] = getOutputMessages(newSDKErrorsCount, newARMErrorsCount, newSDKWarningsCount, newARMWarningsCount); + const output = { + title, + summary, + text: `${sdkSummary}\n

\n${armSummary}\n

\n${githubFooter}` + } + + console.log("---output"); + console.log(JSON.stringify(output)); + console.log("---"); + + if (newSDKErrorsCount > 0 || newARMErrorsCount > 0) { + process.exitCode = 1; + } +} + +postProcessing(); diff --git a/scripts/swagger-to-sdk.sh b/scripts/swagger-to-sdk.sh new file mode 100755 index 000000000000..ef8923dbe856 --- /dev/null +++ b/scripts/swagger-to-sdk.sh @@ -0,0 +1,5 @@ +#!/bin/sh + +python -c "import os; print('\n'.join(v for v in os.environ.keys() if v.startswith('TRAVIS')))" > /tmp/env_file +docker pull lmazuel/swagger-to-sdk +docker run --rm --env-file /tmp/env_file -e GH_TOKEN -v $PWD:/git-restapi/ lmazuel/swagger-to-sdk "$@" \ No newline at end of file diff --git a/specification/addons/resource-manager/readme.md b/specification/addons/resource-manager/readme.md index 9710c5af42a7..0cd20a268d8e 100644 --- a/specification/addons/resource-manager/readme.md +++ b/specification/addons/resource-manager/readme.md @@ -120,7 +120,7 @@ These settings apply only when `--tag=package-2018-03 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2018-03' && $(go) -output-folder: $(go-sdk-folder)/services/addons/mgmt/2018-03-01/addons +output-folder: $(go-sdk-folder)/services/preview/addons/mgmt/2018-03-01/addons ``` ### Tag: package-2017-05 and go @@ -129,7 +129,7 @@ These settings apply only when `--tag=package-2017-05 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2017-05' && $(go) -output-folder: $(go-sdk-folder)/services/addons/mgmt/2017-05-15/addons +output-folder: $(go-sdk-folder)/services/preview/addons/mgmt/2017-05-15/addons ``` ## Java @@ -138,11 +138,46 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.addons +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-addons +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-03 + - tag: package-2017-05 +``` + +### Tag: package-2018-03 and java + +These settings apply only when `--tag=package-2018-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-03' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.addons - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-addons -``` \ No newline at end of file + namespace: com.microsoft.azure.management.addons.v2018_03_01 + output-folder: $(azure-libraries-for-java-folder)/addons/resource-manager/v2018_03_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-05 and java + +These settings apply only when `--tag=package-2017-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.addons.v2017_05_15 + output-folder: $(azure-libraries-for-java-folder)/addons/resource-manager/v2017_05_15 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json new file mode 100644 index 000000000000..4bccf7719005 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json @@ -0,0 +1,6371 @@ +{ + "swagger": "2.0", + "info": { + "version": "2014-01-01", + "title": "ADHybridHealthService", + "description": "REST APIs for Azure Active Drectory Connect Health" + }, + "host": "management.azure.com", + "schemes": [ "https" ], + "consumes": [ "application/json" ], + "produces": [ "application/json" ], + "paths": { + "/providers/Microsoft.ADHybridHealthService/addsservices": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.", + "operationId": "addsServices_list", + "x-ms-examples": { + "addsServices_list": { + "$ref": "./examples/Services.json" + } + }, + "parameters": [ + { + "name": "$filter", + "in": "query", + "description": "The service property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceType", + "in": "query", + "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", + "required": false, + "type": "string" + }, + { + "name": "skipCount", + "in": "query", + "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", + "required": false, + "type": "integer" + }, + { + "name": "takeCount", + "in": "query", + "description": "The take count , which specifies the number of elements that can be returned from a sequence.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": " The list of Active Directory Domain Controller services.", + "schema": { + "$ref": "#/definitions/Services" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + }, + "post": { + "tags": [ "Adds" ], + "description": "Onboards a service for a given tenant in Azure Active Directory Connect Health.", + "operationId": "addsServices_add", + "x-ms-examples": { + "addsServices_add": { + "$ref": "./examples/AddService.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "service", + "in": "body", + "description": "The service object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + ], + "responses": { + "200": { + "description": "Adds the Active Directory Domain Controller Services.", + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}": { + "get": { + "tags": [ "Services" ], + "description": "Gets the details of an Active Directory Domain Service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServices_get": { + "$ref": "./examples/Service.json" + } + }, + "operationId": "addsServices_get", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Active Directory Domain Controller service as specified by the serviceName property. ", + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + } + }, + "delete": { + "tags": [ "Services" ], + "description": "Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServices_delete": { + "$ref": "./examples/DeleteService.json" + } + }, + "operationId": "addsServices_delete", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service which needs to be deleted.", + "required": true, + "type": "string" + }, + { + "name": "confirm", + "in": "query", + "description": "Indicates if the service will be permanently deleted or disabled. True indicates that the service will be permanently deleted and False indicates that the service will be marked disabled and then deleted after 30 days, if it is not re-registered.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Successfully deleted the service." + } + } + }, + "patch": { + "tags": [ "Services" ], + "description": "Updates an Active Directory Domain Service properties of an onboarded service.", + "x-ms-examples": { + "addsServices_update": { + "$ref": "./examples/UpdateService.json" + } + }, + "operationId": "addsServices_update", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service which needs to be deleted.", + "required": true, + "type": "string" + }, + { + "name": "service", + "in": "body", + "description": "The service object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Sucessfully updated service.", + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the alerts for a given Active Directory Domain Service.", + "x-ms-examples": { + "alerts_listAddsAlerts": { + "$ref": "./examples/Alerts.json" + } + }, + "operationId": "alerts_listAddsAlerts", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The alert property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "state", + "in": "query", + "description": "The alert state to query for.", + "required": false, + "type": "string" + }, + { + "name": "from", + "in": "query", + "description": "The start date to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "to", + "in": "query", + "description": "The end date till when to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of alerts for the given service.", + "schema": { + "$ref": "#/definitions/Alerts" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the service configurations.", + "x-ms-examples": { + "configuration_listAddsConfigurations": { + "$ref": "./examples/AddsConfiguration.json" + } + }, + "operationId": "configuration_listAddsConfigurations", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "grouping", + "in": "query", + "description": "The grouping for configurations.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The Active Directory Domain Controller service configuration. ", + "schema": { + "$ref": "#/definitions/AddsConfiguration" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/dimensions/{dimension}": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the dimensions for a given dimension type in a server.", + "x-ms-examples": { + "dimensions_listAddsDimensions": { + "$ref": "./examples/Dimensions.json" + } + }, + "operationId": "dimensions_listAddsDimensions", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "dimension", + "in": "path", + "description": "The dimension type.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of dimensions for a server. ", + "schema": { + "$ref": "#/definitions/Dimensions" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the details of the Active Directory Domain servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServiceMembers_list": { + "$ref": "./examples/AddsServiceMembers.json" + } + }, + "operationId": "addsServiceMembers_list", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The server property filter to apply.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Active Directory Domain Servers. ", + "schema": { + "$ref": "#/definitions/AddsServiceMembers" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addomainservicemembers": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the details of the servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "adDomainServiceMembers_list": { + "$ref": "./examples/AddomainServiceMembers.json" + } + }, + "operationId": "adDomainServiceMembers_list", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The server property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "isGroupbySite", + "in": "query", + "description": "Indicates if the result should be grouped by site or not.", + "required": true, + "type": "boolean" + }, + { + "name": "query", + "in": "query", + "description": "The custom query.", + "required": false, + "type": "string" + }, + { + "name": "nextPartitionKey", + "in": "query", + "description": "The next partition key to query for.", + "required": true, + "type": "string", + "enum": [ " " ], + "x-ms-enum": { + "name": "nextPartitionKey", + "modelAsString": true + } + }, + { + "name": "nextRowKey", + "in": "query", + "description": "The next row key to query for.", + "required": true, + "type": "string", + "enum": [ " " ], + "x-ms-enum": { + "name": "nextRowKey", + "modelAsString": true + } + }, + { + "name": "takeCount", + "in": "query", + "description": "The take count , which specifies the number of elements that can be returned from a sequence.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Active Directory Domain Servers.", + "schema": { + "$ref": "#/definitions/AddsServiceMembers" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the user preferences for a given feature.", + "x-ms-examples": { + "addsServicesUserPreference_get": { + "$ref": "./examples/UserPreference.json" + } + }, + "operationId": "addsServicesUserPreference_get", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "featureName", + "in": "path", + "description": "The name of the feature.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The user preference settings. ", + "schema": { + "$ref": "#/definitions/UserPreference" + } + } + } + }, + "delete": { + "tags": [ "Adds" ], + "description": "Deletes the user preferences for a given feature.", + "x-ms-examples": { + "addsServicesUserPreference_delete": { + "$ref": "./examples/DeleteUserPreference.json" + } + }, + "operationId": "addsServicesUserPreference_delete", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "featureName", + "in": "path", + "description": "The name of the feature.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the user preference settings. " + } + } + }, + "post": { + "tags": [ "Adds" ], + "description": "Adds the user preferences for a given feature.", + "x-ms-examples": { + "addsServicesUserPreference_add": { + "$ref": "./examples/AddUserPreference.json" + } + }, + "operationId": "addsServicesUserPreference_add", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "featureName", + "in": "path", + "description": "The name of the feature.", + "required": true, + "type": "string" + }, + { + "name": "setting", + "in": "body", + "description": "The user preference setting.", + "required": true, + "schema": { + "$ref": "#/definitions/UserPreference" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": " Successfully added the user preference settings. " + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/forestsummary": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServices_getForestSummary": { + "$ref": "./examples/ForestSummary.json" + } + }, + "operationId": "addsServices_getForestSummary", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of forest summary for the service. ", + "schema": { + "$ref": "#/definitions/ForestSummary" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the server related metrics for a given metric and group combination.", + "x-ms-examples": { + "addsService_getMetrics": { + "$ref": "./examples/Service_MetricSets.json" + } + }, + "operationId": "addsService_getMetrics", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "name": "groupKey", + "in": "query", + "description": "The group key", + "required": false, + "type": "string" + }, + { + "name": "fromDate", + "in": "query", + "description": "The start date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "toDate", + "in": "query", + "description": "The end date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric sets for the service. ", + "schema": { + "$ref": "#/definitions/MetricSets" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/average": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the average of the metric values for a given metric and group combination.", + "x-ms-examples": { + "addsServices_listMetricsAverage": { + "$ref": "./examples/Metrics.json" + } + }, + "operationId": "addsServices_listMetricsAverage", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of metrics. ", + "schema": { + "$ref": "#/definitions/Metrics" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/sum": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the sum of the metric values for a given metric and group combination.", + "x-ms-examples": { + "addsServices_listMetricsSum": { + "$ref": "./examples/Metrics.json" + } + }, + "operationId": "addsServices_listMetricsSum", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of aum of the metric values for a given service. ", + "schema": { + "$ref": "#/definitions/Metrics" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the service related metrics information.", + "x-ms-examples": { + "addsServices_listMetricMetadata": { + "$ref": "./examples/MetricMetadataList.json" + } + }, + "operationId": "addsServices_listMetricMetadata", + "parameters": [ + { + "name": "$filter", + "in": "query", + "description": "The metric metadata property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "perfCounter", + "in": "query", + "description": "Indicates if only performance counter metrics are requested.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of metric metadata for a service. ", + "schema": { + "$ref": "#/definitions/MetricMetadataList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the service related metric information.", + "x-ms-examples": { + "addsServices_getMetricMetadata": { + "$ref": "./examples/MetricMetadata.json" + } + }, + "operationId": "addsServices_getMetricMetadata", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": " The metric metadata for the service.", + "schema": { + "$ref": "#/definitions/MetricMetadata" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}/groups/{groupName}": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the service related metrics for a given metric and group combination.", + "x-ms-examples": { + "addsServices_getMetricMetadataForGroup": { + "$ref": "./examples/MetricSets.json" + } + }, + "operationId": "addsServices_getMetricMetadataForGroup", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "name": "groupKey", + "in": "query", + "description": "The group key", + "required": false, + "type": "string" + }, + { + "name": "fromDate", + "in": "query", + "description": "The start date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "toDate", + "in": "query", + "description": "The end date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric sets for a given service and group. ", + "schema": { + "$ref": "#/definitions/MetricSets" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationdetails": { + "get": { + "tags": [ "Adds" ], + "description": "Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServices_listReplicationDetails": { + "$ref": "./examples/ReplicationDetails.json" + } + }, + "operationId": "addsServices_listReplicationDetails", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The server property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "withDetails", + "in": "query", + "description": "Indicates if InboundReplicationNeighbor details are required or not.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of replication details for a service. ", + "schema": { + "$ref": "#/definitions/ReplicationDetailsList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationstatus": { + "get": { + "tags": [ "Adds" ], + "description": "Gets Replication status for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServicesReplicationStatus_get": { + "$ref": "./examples/ReplicationStatus.json" + } + }, + "operationId": "addsServicesReplicationStatus_get", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The replication status for a service. ", + "schema": { + "$ref": "#/definitions/ReplicationStatus" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationsummary": { + "get": { + "tags": [ "Adds" ], + "description": "Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServices_listReplicationSummary": { + "$ref": "./examples/ReplicationSummary.json" + } + }, + "operationId": "addsServices_listReplicationSummary", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The server property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "isGroupbySite", + "in": "query", + "description": "Indicates if the result should be grouped by site or not.", + "required": true, + "type": "boolean" + }, + { + "name": "query", + "in": "query", + "description": "The custom query.", + "required": true, + "type": "string" + }, + { + "name": "nextPartitionKey", + "in": "query", + "description": "The next partition key to query for.", + "required": true, + "type": "string", + "enum": [ " " ], + "x-ms-enum": { + "name": "nextPartitionKey", + "modelAsString": true + } + }, + { + "name": "nextRowKey", + "in": "query", + "description": "The next row key to query for.", + "required": true, + "type": "string", + "enum": [ " " ], + "x-ms-enum": { + "name": "nextRowKey", + "modelAsString": true + } + }, + { + "name": "takeCount", + "in": "query", + "description": "The take count , which specifies the number of elements that can be returned from a sequence.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of replication summary for a service. ", + "schema": { + "$ref": "#/definitions/ReplicationSummaryList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the details of the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "addsServicesServiceMembers_list": { + "$ref": "./examples/ServiceMembers.json" + } + }, + "operationId": "addsServicesServiceMembers_list", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The server property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "dimensionType", + "in": "query", + "description": "The server specific dimension.", + "required": false, + "type": "string" + }, + { + "name": "dimensionSignature", + "in": "query", + "description": "The value of the dimension.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of service members for a given service.", + "schema": { + "$ref": "#/definitions/ServiceMembers" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + }, + "post": { + "tags": [ "Adds" ], + "description": "Onboards a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "addsServicesServiceMembers_add": { + "$ref": "./examples/AddServiceMembers.json" + } + }, + "operationId": "addsServicesServiceMembers_add", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service under which the server is to be onboarded.", + "required": true, + "type": "string" + }, + { + "name": "serviceMember", + "in": "body", + "description": "The server object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceMember" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully added the service member.", + "schema": { + "$ref": "#/definitions/ServiceMember" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the details of a server, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "addsServiceMembers_get": { + "$ref": "./examples/ServiceMember.json" + } + }, + "operationId": "addsServiceMembers_get", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The service member details for a given service. ", + "schema": { + "$ref": "#/definitions/ServiceMember" + } + } + } + }, + "delete": { + "tags": [ "Adds" ], + "description": "Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "addsServiceMembers_delete": { + "$ref": "./examples/DeleteServer.json" + } + }, + "operationId": "addsServiceMembers_delete", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "confirm", + "in": "query", + "description": "Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the service member." + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/alerts": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the details of an alert for a given Active Directory Domain Controller service and server combination.", + "x-ms-examples": { + "addsServices_listServerAlerts": { + "$ref": "./examples/Server_Alerts.json" + } + }, + "operationId": "addsServices_listServerAlerts", + "parameters": [ + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id for which the alert details needs to be queried.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The alert property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "state", + "in": "query", + "description": "The alert state to query for.", + "required": false, + "type": "string" + }, + { + "name": "from", + "in": "query", + "description": "The start date to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "to", + "in": "query", + "description": "The end date till when to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of server alerts.", + "schema": { + "$ref": "#/definitions/Alerts" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/credentials": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "addsServiceMembers_listCredentials": { + "$ref": "./examples/Credentials.json" + } + }, + "operationId": "addsServiceMembers_listCredentials", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of server credentials.", + "schema": { + "$ref": "#/definitions/Credentials" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/premiumCheck": { + "get": { + "tags": [ "Services" ], + "description": "Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServices_listPremiumServices": { + "$ref": "./examples/Services.json" + } + }, + "operationId": "addsServices_listPremiumServices", + "parameters": [ + { + "name": "$filter", + "in": "query", + "description": "The service property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceType", + "in": "query", + "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", + "required": false, + "type": "string" + }, + { + "name": "skipCount", + "in": "query", + "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", + "required": false, + "type": "integer" + }, + { + "name": "takeCount", + "in": "query", + "description": "The take count , which specifies the number of elements that can be returned from a sequence.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of premium services.", + "schema": { + "$ref": "#/definitions/Services" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/operations": { + "get": { + "tags": [ + "operations" + ], + "x-ms-examples": { + "operations_list": { + "$ref": "./examples/OperationList.json" + } + }, + "operationId": "operations_list", + "description": "Lists the available Azure Data Factory API operations.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of operations.", + "schema": { + "$ref": "#/definitions/OperationListResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/configuration": { + "post": { + "tags": [ "Configuration" ], + "description": "Onboards a tenant in Azure Active Directory Connect Health.", + "x-ms-examples": { + "configuration_add": { + "$ref": "./examples/Tenant.json" + } + }, + "operationId": "configuration_add", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully added the tenant.", + "schema": { + "$ref": "#/definitions/Tenant" + } + } + } + }, + "get": { + "tags": [ "Configuration" ], + "description": "Gets the details of a tenant onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "configuration_get": { + "$ref": "./examples/Tenant.json" + } + }, + "operationId": "configuration_get", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The tenant details.", + "schema": { + "$ref": "#/definitions/Tenant" + } + } + } + }, + "patch": { + "tags": [ "Configuration" ], + "description": "Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "configuration_update": { + "$ref": "./examples/PatchTenant.json" + } + }, + "operationId": "configuration_update", + "parameters": [ + { + "name": "tenant", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Tenant" + }, + "description": "The tenant object with the properties set to the updated value." + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the tenant.", + "schema": { + "$ref": "#/definitions/Tenant" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/reports/DevOps/IsDevOps": { + "get": { + "tags": [ "DevOps" ], + "description": "Checks if the user is enabled for Dev Ops access.", + "x-ms-examples": { + "reports_getDevOps": { + "$ref": "./examples/DevOps.json" + } + }, + "operationId": "reports_getDevOps", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Indicates if the user is Dev Ops or not.", + "schema": { + "$ref": "#/definitions/Result" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services": { + "get": { + "tags": [ "Services" ], + "description": "Gets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "services_list": { + "$ref": "./examples/Services.json" + } + }, + "operationId": "services_list", + "parameters": [ + { + "name": "$filter", + "in": "query", + "description": "The service property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceType", + "in": "query", + "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", + "required": false, + "type": "string" + }, + { + "name": "skipCount", + "in": "query", + "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", + "required": false, + "type": "integer" + }, + { + "name": "takeCount", + "in": "query", + "description": "The take count , which specifies the number of elements that can be returned from a sequence.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of services.", + "schema": { + "$ref": "#/definitions/Services" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + }, + "post": { + "tags": [ "Services" ], + "description": "Onboards a service for a given tenant in Azure Active Directory Connect Health.", + "x-ms-examples": { + "services_add": { + "$ref": "./examples/AddService.json" + } + }, + "operationId": "services_add", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "service", + "in": "body", + "description": "The service object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + ], + "responses": { + "200": { + "description": "Successfully added the service.", + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/premiumCheck": { + "get": { + "tags": [ "Services" ], + "description": "Gets the details of services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "services_listPremium": { + "$ref": "./examples/Services.json" + } + }, + "operationId": "services_listPremium", + "parameters": [ + { + "name": "$filter", + "in": "query", + "description": "The service property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceType", + "in": "query", + "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", + "required": false, + "type": "string" + }, + { + "name": "skipCount", + "in": "query", + "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", + "required": false, + "type": "integer" + }, + { + "name": "takeCount", + "in": "query", + "description": "The take count , which specifies the number of elements that can be returned from a sequence.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of premium services.", + "schema": { + "$ref": "#/definitions/Services" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}": { + "get": { + "tags": [ "Services" ], + "description": "Gets the details of a service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "services_get": { + "$ref": "./examples/Service.json" + } + }, + "operationId": "services_get", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of services.", + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + } + }, + "delete": { + "tags": [ "Services" ], + "description": "Deletes a service which is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "services_delete": { + "$ref": "./examples/DeleteService.json" + } + }, + "operationId": "services_delete", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service which needs to be deleted.", + "required": true, + "type": "string" + }, + { + "name": "confirm", + "in": "query", + "description": "Indicates if the service will be permanently deleted or disabled. True indicates that the service will be permanently deleted and False indicates that the service will be marked disabled and then deleted after 30 days, if it is not re-registered.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Successfully deleted the service." + } + } + }, + "patch": { + "tags": [ "Services" ], + "description": "Updates the service properties of an onboarded service.", + "x-ms-examples": { + "services_update": { + "$ref": "./examples/UpdateService.json" + } + }, + "operationId": "services_update", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service which needs to be deleted.", + "required": true, + "type": "string" + }, + { + "name": "service", + "in": "body", + "description": "The service object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the service.", + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/alerts": { + "get": { + "tags": [ "Alerts" ], + "description": "Gets the alerts for a given service.", + "x-ms-examples": { + "services_listAlerts": { + "$ref": "./examples/Alerts.json" + } + }, + "operationId": "services_listAlerts", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The alert property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "state", + "in": "query", + "description": "The alert state to query for.", + "required": false, + "type": "string" + }, + { + "name": "from", + "in": "query", + "description": "The start date to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "to", + "in": "query", + "description": "The end date till when to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of alerts.", + "schema": { + "$ref": "#/definitions/Alerts" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/checkServiceFeatureAvailibility/{featureName}": { + "get": { + "tags": [ "Services" ], + "description": "Checks if the service has all the pre-requisites met to use a feature.", + "x-ms-examples": { + "services_getFeatureAvailibility": { + "$ref": "./examples/CheckFeatureAvailibility.json" + } + }, + "operationId": "services_getFeatureAvailibility", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "featureName", + "in": "path", + "description": "The name of the feature.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Indicates if the feature is available or not.", + "schema": { + "$ref": "#/definitions/Result" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/counts": { + "get": { + "tags": [ "Services" ], + "description": "Gets the count of latest AAD export errors.", + "x-ms-examples": { + "services_listExportErrors": { + "$ref": "./examples/ErrorCounts.json" + } + }, + "operationId": "services_listExportErrors", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of export errors.", + "schema": { + "$ref": "#/definitions/ErrorCounts" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/listV2": { + "get": { + "tags": [ "Services" ], + "description": " Gets the categorized export errors.", + "x-ms-examples": { + "services_listExportErrorsV2": { + "$ref": "./examples/MergedExportErrors.json" + } + }, + "operationId": "services_listExportErrorsV2", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "errorBucket", + "in": "query", + "description": "The error category to query for.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of merged export errors.", + "schema": { + "$ref": "#/definitions/MergedExportErrors" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exportstatus": { + "get": { + "tags": [ "Services" ], + "description": "Gets the export status.", + "x-ms-examples": { + "services_listExportStatus": { + "$ref": "./examples/ExportStatus.json" + } + }, + "operationId": "services_listExportStatus", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of export statuses.", + "schema": { + "$ref": "#/definitions/ExportStatuses" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/feedback": { + "post": { + "tags": [ "Feedback" ], + "description": "Adds an alert feedback submitted by customer.", + "x-ms-examples": { + "services_addAlertFeedback": { + "$ref": "./examples/AddAlertFeedback.json" + } + }, + "operationId": "services_addAlertFeedback", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "alertFeedback", + "in": "body", + "description": "The alert feedback.", + "required": true, + "schema": { + "$ref": "#/definitions/AlertFeedback" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully added alert feedback.", + "schema": { + "$ref": "#/definitions/AlertFeedback" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/{shortName}/alertfeedback": { + "get": { + "tags": [ "Feedback" ], + "description": "Gets a list of all alert feedback for a given tenant and alert type.", + "x-ms-examples": { + "services_listAlertFeedback": { + "$ref": "./examples/GetAlertFeedback.json" + } + }, + "operationId": "services_listAlertFeedback", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "shortName", + "in": "path", + "description": "The name of the alert.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of alert feedback.", + "schema": { + "$ref": "#/definitions/AlertFeedbacks" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}": { + "get": { + "tags": [ "Metrics" ], + "description": "Gets the server related metrics for a given metric and group combination.", + "x-ms-examples": { + "service_getMetrics": { + "$ref": "./examples/Service_MetricSets.json" + } + }, + "operationId": "service_getMetrics", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "name": "groupKey", + "in": "query", + "description": "The group key", + "required": false, + "type": "string" + }, + { + "name": "fromDate", + "in": "query", + "description": "The start date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "toDate", + "in": "query", + "description": "The end date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric sets for a given service.", + "schema": { + "$ref": "#/definitions/MetricSets" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/average": { + "get": { + "tags": [ "Metrics" ], + "description": "Gets the average of the metric values for a given metric and group combination.", + "x-ms-examples": { + "services_listMetricsAverage": { + "$ref": "./examples/Metrics.json" + } + }, + "operationId": "services_listMetricsAverage", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of average metrics for a given service.", + "schema": { + "$ref": "#/definitions/Metrics" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/sum": { + "get": { + "tags": [ "Metrics" ], + "description": "Gets the sum of the metric values for a given metric and group combination.", + "x-ms-examples": { + "services_listMetricsSum": { + "$ref": "./examples/Metrics.json" + } + }, + "operationId": "services_listMetricsSum", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of metrics for a given service.", + "schema": { + "$ref": "#/definitions/Metrics" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata": { + "get": { + "tags": [ "Metrics" ], + "description": "Gets the service related metrics information.", + "x-ms-examples": { + "services_listMetricMetadata": { + "$ref": "./examples/MetricMetadataList.json" + } + }, + "operationId": "services_listMetricMetadata", + "parameters": [ + { + "name": "$filter", + "in": "query", + "description": "The metric metadata property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "perfCounter", + "in": "query", + "description": "Indicates if only performance counter metrics are requested.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of metric metadata for a given service.", + "schema": { + "$ref": "#/definitions/MetricMetadataList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}": { + "get": { + "tags": [ "Metrics" ], + "description": "Gets the service related metrics information.", + "x-ms-examples": { + "services_getMetricMetadata": { + "$ref": "./examples/MetricMetadata.json" + } + }, + "operationId": "services_getMetricMetadata", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric metadata for a given metric.", + "schema": { + "$ref": "#/definitions/MetricMetadata" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}/groups/{groupName}": { + "get": { + "tags": [ "Metrics" ], + "description": "Gets the service related metrics for a given metric and group combination.", + "x-ms-examples": { + "services_getMetricMetadataForGroup": { + "$ref": "./examples/MetricSets.json" + } + }, + "operationId": "services_getMetricMetadataForGroup", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "name": "groupKey", + "in": "query", + "description": "The group key", + "required": false, + "type": "string" + }, + { + "name": "fromDate", + "in": "query", + "description": "The start date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "toDate", + "in": "query", + "description": "The end date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric sets for a given service and group.", + "schema": { + "$ref": "#/definitions/MetricSets" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfiguration": { + "patch": { + "tags": [ "Services" ], + "description": "Updates the service level monitoring configuration.", + "x-ms-examples": { + "services_updateMonitoringConfiguration": { + "$ref": "./examples/PatchMonitoringConfiguration.json" + } + }, + "operationId": "services_updateMonitoringConfiguration", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "configurationSetting", + "in": "body", + "description": "The monitoring configuration to update", + "required": true, + "schema": { + "$ref": "#/definitions/Item" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the monitoring configuration." + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfigurations": { + "get": { + "tags": [ "Services" ], + "description": "Gets the service level monitoring configurations.", + "x-ms-examples": { + "services_listMonitoringConfigurations": { + "$ref": "./examples/MonitoringConfigurations.json" + } + }, + "operationId": "services_listMonitoringConfigurations", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of monitoring configurations.", + "schema": { + "$ref": "#/definitions/Items" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/badpassword/details/user": { + "get": { + "tags": [ "Reports" ], + "description": "Gets the bad password login attempt report for an user", + "x-ms-examples": { + "services_listUserBadPasswordReport": { + "$ref": "./examples/BadPasswordDetails.json" + } + }, + "operationId": "services_listUserBadPasswordReport", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "dataSource", + "in": "query", + "description": "The source of data, if its test data or customer data.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of bad password login attempts.", + "schema": { + "$ref": "#/definitions/ErrorReportUsersEntries" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the details of the servers, for a given service, that are onboarded to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "serviceMembers_list": { + "$ref": "./examples/ServiceMembers.json" + } + }, + "operationId": "serviceMembers_list", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The server property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "dimensionType", + "in": "query", + "description": "The server specific dimension.", + "required": false, + "type": "string" + }, + { + "name": "dimensionSignature", + "in": "query", + "description": "The value of the dimension.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of service members.", + "schema": { + "$ref": "#/definitions/ServiceMembers" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + }, + "post": { + "tags": [ "ServiceMembers" ], + "description": "Onboards a server, for a given service, to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "serviceMembers_add": { + "$ref": "./examples/AddServiceMembers.json" + } + }, + "operationId": "serviceMembers_add", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service under which the server is to be onboarded.", + "required": true, + "type": "string" + }, + { + "name": "serviceMember", + "in": "body", + "description": "The server object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceMember" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully added the service member.", + "schema": { + "$ref": "#/definitions/ServiceMember" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the details of a server, for a given service, that are onboarded to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "serviceMembers_get": { + "$ref": "./examples/ServiceMember.json" + } + }, + "operationId": "serviceMembers_get", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The specific service member.", + "schema": { + "$ref": "#/definitions/ServiceMember" + } + } + } + }, + "delete": { + "tags": [ "ServiceMembers" ], + "description": "Deletes a server that has been onboarded to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "serviceMembers_delete": { + "$ref": "./examples/DeleteServer.json" + } + }, + "operationId": "serviceMembers_delete", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "confirm", + "in": "query", + "description": "Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the service member." + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/alerts": { + "get": { + "tags": [ "Alerts" ], + "description": "Gets the details of an alert for a given service and server combination.", + "x-ms-examples": { + "serviceMembers_listAlerts": { + "$ref": "./examples/Server_Alerts.json" + } + }, + "operationId": "serviceMembers_listAlerts", + "parameters": [ + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id for which the laert details needs to be queried.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The alert property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "state", + "in": "query", + "description": "The alert state to query for.", + "required": false, + "type": "string" + }, + { + "name": "from", + "in": "query", + "description": "The start date to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "to", + "in": "query", + "description": "The end date till when to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of alerts.", + "schema": { + "$ref": "#/definitions/Alerts" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/service/{serviceName}/servicemembers/{serviceMemberId}/connectors": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the connector details for a service.", + "x-ms-examples": { + "serviceMembers_listConnectors": { + "$ref": "./examples/Connectors.json" + } + }, + "operationId": "serviceMembers_listConnectors", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of connector details.", + "schema": { + "$ref": "#/definitions/Connectors" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/credentials": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "serviceMembers_listCredentials": { + "$ref": "./examples/Credentials.json" + } + }, + "operationId": "serviceMembers_listCredentials", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of service member credentials.", + "schema": { + "$ref": "#/definitions/Credentials" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/data": { + "delete": { + "tags": [ "ServiceMembers" ], + "description": "Deletes the data uploaded by the server to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "serviceMembers_deleteData": { + "$ref": "./examples/DeleteServer.json" + } + }, + "operationId": "serviceMembers_deleteData", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the service member." + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/datafreshness": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the last time when the server uploaded data to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "serviceMembers_listDataFreshness": { + "$ref": "./examples/Datafreshness.json" + } + }, + "operationId": "serviceMembers_listDataFreshness", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of datafreshness details for a server.", + "schema": { + "$ref": "#/definitions/DataFreshnessDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/exportstatus": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the export status.", + "x-ms-examples": { + "serviceMembers_listExportStatus": { + "$ref": "./examples/Server_ExportStatus.json" + } + }, + "operationId": "serviceMembers_listExportStatus", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of export statuses.", + "schema": { + "$ref": "#/definitions/ExportStatuses" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/globalconfiguration": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the global configuration.", + "x-ms-examples": { + "serviceMembers_listGlobalConfiguration": { + "$ref": "./examples/GlobalConfiguration.json" + } + }, + "operationId": "serviceMembers_listGlobalConfiguration", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of global configurations.", + "schema": { + "$ref": "#/definitions/GlobalConfigurations" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}/groups/{groupName}": { + "get": { + "tags": [ "Metrics" ], + "description": "Gets the server related metrics for a given metric and group combination.", + "x-ms-examples": { + "serviceMembers_getMetrics": { + "$ref": "./examples/Server_MetricSets.json" + } + }, + "operationId": "serviceMembers_getMetrics", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "groupKey", + "in": "query", + "description": "The group key", + "required": false, + "type": "string" + }, + { + "name": "fromDate", + "in": "query", + "description": "The start date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "toDate", + "in": "query", + "description": "The end date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of metric sets for a given metric.", + "schema": { + "$ref": "#/definitions/MetricSets" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/serviceconfiguration": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the service configuration.", + "x-ms-examples": { + "serviceMembers_getServiceConfiguration": { + "$ref": "./examples/ServiceConfiguration.json" + } + }, + "operationId": "serviceMembers_getServiceConfiguration", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The service configuration.", + "schema": { + "$ref": "#/definitions/ServiceConfiguration" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/TenantWhitelisting/{featureName}": { + "get": { + "tags": [ "Services" ], + "description": "Checks if the tenant, to which a service is registered, is whitelisted to use a feature.", + "x-ms-examples": { + "services_getTenantWhitelisting": { + "$ref": "./examples/TenantWhitelisting.json" + } + }, + "operationId": "services_getTenantWhitelisting", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "featureName", + "in": "path", + "description": "The name of the feature.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Indicates if a tenant is whitelisted for a feature or not.", + "schema": { + "$ref": "#/definitions/Result" + } + } + } + } + } + }, + "definitions": { + "AddsConfiguration": { + "description": "The list of key value properties.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "totalCount": { + "description": "The total count of configuration.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "AdditionalInformation": { + "description": "The addtional information for a property.", + "type": "object", + "properties": { + "titleName": { + "description": "The title name for the property.", + "type": "string" + }, + "titleValue": { + "description": "The title value for the property.", + "type": "string" + }, + "properties": { + "description": "The list of properties which are included in the aditional information.", + "type": "object", + "items": { + "$ref": "#/definitions/Item" + } + }, + "hasProperties": { + "description": "Indicates if properties are present or not.", + "type": "boolean" + } + } + }, + "AddsServiceMember": { + "description": "The server details for ADDS service.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name.", + "type": "string" + }, + "siteName": { + "description": "The site name.", + "type": "string" + }, + "addsRoles": { + "description": "The list of ADDS roles.", + "type": "array", + "items": { + "type": "string" + } + }, + "gcReachable": { + "description": "Indicates if the global catalog for this domain is reachable or not.", + "type": "boolean" + }, + "isAdvertising": { + "description": "Indicates if the Dc is advertising or not.", + "type": "boolean" + }, + "pdcReachable": { + "description": "Indicates if the primary domain controller is reachable or not.", + "type": "boolean" + }, + "sysvolState": { + "description": "Indicates if the SYSVOL state is healthy or not.", + "type": "boolean" + }, + "dcTypes": { + "description": "The list of domain controller types.", + "type": "array", + "items": { + "type": "string" + } + }, + "serviceMemberId": { + "description": "The id of the server.", + "type": "string" + }, + "serviceId": { + "description": "The service id to whom this server belongs.", + "type": "string" + }, + "tenantId": { + "description": "The tenant id to whom this server belongs.", + "type": "string" + }, + "activeAlerts": { + "description": "The total number of alerts that are currently active for the server.", + "type": "integer" + }, + "additionalInformation": { + "description": "The additional information, if any, for the server.", + "type": "string" + }, + "createdDate": { + "description": "The date time , in UTC, when the server was onboaraded to Azure Active Directory Connect Health.", + "type": "string", + "format": "date-time" + }, + "dimensions": { + "description": "The server specific configuration related dimensions.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "disabled": { + "description": "Indicates if the server is disabled or not. ", + "type": "boolean" + }, + "disabledReason": { + "description": "The reason for disabling the server.", + "type": "integer" + }, + "installedQfes": { + "description": "The list of installed QFEs for the server.", + "type": "array", + "items": { + "$ref": "#/definitions/Hotfix" + } + }, + "lastDisabled": { + "description": "The date and time , in UTC, when the server was last disabled.", + "type": "string", + "format": "date-time" + }, + "lastReboot": { + "description": "The date and time, in UTC, when the server was last rebooted.", + "type": "string", + "format": "date-time" + }, + "lastServerReportedMonitoringLevelChange": { + "description": "The date and time, in UTC, when the server's data monitoring configuration was last changed.", + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "description": "The date and time, in UTC, when the server proeprties were last updated.", + "type": "string", + "format": "date-time" + }, + "machineId": { + "description": "The id of the machine.", + "type": "string" + }, + "machineName": { + "description": "The name of the server.", + "type": "string" + }, + "monitoringConfigurationsComputed": { + "description": "The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "monitoringConfigurationsCustomized": { + "description": "The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "osName": { + "description": "The name of the operating system installed in the machine.", + "type": "string" + }, + "osVersion": { + "description": "The version of the operating system installed in the machine.", + "type": "string" + }, + "properties": { + "description": "Server specific properties.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "recommendedQfes": { + "description": "The list of recommended hotfixes for the server.", + "type": "array", + "items": { + "$ref": "#/definitions/Hotfix" + } + }, + "resolvedAlerts": { + "description": "The total count of alerts that are resolved for this server.", + "type": "integer" + }, + "role": { + "description": "The service role that is being monitored in the server.", + "type": "string" + }, + "serverReportedMonitoringLevel": { + "description": "The monitoring level reported by the server.", + "type": "string", + "enum": [ + "Partial", + "Full", + "Off" + ], + "x-ms-enum": { + "name": "MonitoringLevel", + "modelAsString": false + } + }, + "status": { + "description": "The health status of the server.", + "type": "string" + } + } + }, + "AddsServiceMembers": { + "description": "The list of ADDS service members.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/AddsServiceMember" + } + }, + "totalCount": { + "description": "The total count of service members.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "Agent": { + "description": "The agent details.", + "type": "object", + "properties": { + "tenantId": { + "description": "The tenant Id.", + "type": "string" + }, + "machineId": { + "description": "The machine Id.", + "type": "string" + }, + "credential": { + "description": "The agent credential details.", + "type": "object", + "items": { + "$ref": "#/definitions/Credential" + } + }, + "machineName": { + "description": "The machine name.", + "type": "string" + }, + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "createdDate": { + "description": "The date and time, in UTC, when the agent was created.", + "type": "string", + "format": "date-time" + }, + "key": { + "description": " The connector hash key.", + "type": "string" + } + } + }, + "Alert": { + "description": " The alert details indicating an issue with service or server.", + "type": "object", + "properties": { + "alertId": { + "description": "The alert Id.", + "type": "string", + "format": "uuid" + }, + "level": { + "description": "The alert level which indicates the severity of the alert.", + "type": "string", + "enum": [ + "Warning", + "Error", + "PreWarning" + ], + "x-ms-enum": { + "name": "Level", + "modelAsString": true + } + }, + "state": { + "description": "The alert state which can be either active or resolved with multile resolution types.", + "type": "string", + "enum": [ + "Active", + "ResolvedByPositiveResult", + "ResolvedManually", + "ResolvedByTimer", + "ResolvedByStateChange" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true + } + }, + "shortName": { + "description": "The alert short name.", + "type": "string" + }, + "displayName": { + "description": "The display name for the alert.", + "type": "string" + }, + "description": { + "description": "The alert description.", + "type": "string" + }, + "remediation": { + "description": "The alert remediation.", + "type": "string" + }, + "relatedLinks": { + "description": "The help links to get more information related to the alert.", + "type": "array", + "items": { + "$ref": "#/definitions/HelpLink" + } + }, + "scope": { + "description": "The scope of the alert. Indicates if it is a service or a server related alert.", + "type": "string" + }, + "additionalInformation": { + "description": "Additional information related to the alert.", + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalInformation" + } + }, + "createdDate": { + "description": "The date and time,in UTC,when the alert was created.", + "type": "string", + "format": "date-time" + }, + "resolvedDate": { + "description": "The date and time, in UTC, when the alert was resolved.", + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "description": "The date and time, in UTC, when the alert was last updated.", + "type": "string", + "format": "date-time" + }, + "monitorRoleType": { + "description": "The monitoring role type for which the alert was raised.", + "type": "string" + }, + "activeAlertProperties": { + "description": "The active alert properties.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "resolvedAlertProperties": { + "description": "The resolved alert properties.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "tenantId": { + "description": "The tenant Id.", + "type": "string", + "format": "uuid" + }, + "serviceId": { + "description": "The service Id.", + "type": "string", + "format": "uuid" + }, + "serviceMemberId": { + "description": "The server Id.", + "type": "string", + "format": "uuid" + } + } + }, + "AlertFeedback": { + "description": "The alert feedback details.", + "type": "object", + "properties": { + "level": { + "description": "The alert level which indicates the severity of the alert.", + "type": "string" + }, + "state": { + "description": "The alert state which can be either active or resolved with multile resolution types.", + "type": "string" + }, + "shortName": { + "description": "The alert short name.", + "type": "string" + }, + "feedback": { + "description": "The feedback for the alert which indicates if the customer likes or dislikes the alert.", + "type": "string" + }, + "comment": { + "description": "Additional comments related to the alert.", + "type": "string" + }, + "consentedToShare": { + "description": "Indicates if the alert feedback can be shared from product team.", + "type": "boolean" + }, + "serviceMemberId": { + "description": "The server Id of the alert.", + "type": "string" + }, + "createdDate": { + "description": "The date and time,in UTC,when the alert was created.", + "type": "string", + "format": "date-time" + } + } + }, + "AlertFeedbacks": { + "description": "The list of alert feedback.", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "The value returned by the operation.", + "items": { + "$ref": "#/definitions/AlertFeedback" + } + } + } + }, + "Alerts": { + "description": "The list of alerts for a service.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Alert" + } + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "totalCount": { + "description": "The total count of alert elements.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "AssociatedObject": { + "description": "Object that hold sync object details.", + "type": "object", + "properties": { + "displayName": { + "description": "The display name of the object.", + "type": "string" + }, + "distinguishedName": { + "description": "The distinguished name of the object.", + "type": "string" + }, + "lastDirSyncTime": { + "description": "The last dirSync time.", + "type": "string", + "format": "date-time" + }, + "mail": { + "description": "The email of the object.", + "type": "string" + }, + "objectGuid": { + "description": "The object guid.", + "type": "string" + }, + "objectType": { + "description": "The object type.", + "type": "string" + }, + "onpremisesUserPrincipalName": { + "description": "The On-premises UPN.", + "type": "string" + }, + "proxyAddresses": { + "description": "The proxy addresses.", + "type": "string" + }, + "sourceAnchor": { + "description": "The source anchor.", + "type": "string" + }, + "sourceOfAuthority": { + "description": "The source of authority.", + "type": "string" + }, + "timeOccurred": { + "description": " The time of the error.", + "type": "string", + "format": "date-time" + }, + "userPrincipalName": { + "description": " The UPN.", + "type": "string" + } + } + }, + "AttributeDelta": { + "description": "The delta attributes.", + "type": "object", + "properties": { + "values": { + "description": "The delta values.", + "type": "array", + "items": { + "$ref": "#/definitions/ValueDelta" + } + }, + "name": { + "description": "The name of the attribute delta.", + "type": "string" + }, + "operationType": { + "description": "The attribute delta operation type.", + "type": "string", + "enum": [ + "Undefined", + "Add", + "Replace", + "Update", + "Delete" + ], + "x-ms-enum": { + "name": "AttributeDeltaOperationType", + "modelAsString": true + } + }, + "valueType": { + "description": "The value type.", + "type": "string", + "enum": [ + "Undefined", + "Dn", + "Binary", + "String", + "Integer", + "Boolean" + ], + "x-ms-enum": { + "name": "ValueType", + "modelAsString": true + } + }, + "multiValued": { + "description": "Indicates if the attribute delta is multivalued or not.", + "type": "boolean" + } + } + }, + "AttributeMapping": { + "description": "The attribute mapping details.", + "type": "object", + "properties": { + "mappingSource": { + "description": "The mapping source.", + "$ref": "#/definitions/AttributeMppingSource" + }, + "type": { + "description": "The attribute mapping type.", + "type": "string", + "enum": [ + "Constant", + "Direct", + "DnPart", + "Script" + ], + "x-ms-enum": { + "name": "AttributeMappingType", + "modelAsString": true + } + }, + "destinationAttribute": { + "description": "The destination attribute.", + "type": "string" + }, + "contextId": { + "description": "The context Id.", + "type": "string" + } + } + }, + "AttributeMppingSource": { + "description": "The attribute mapping source.", + "type": "object", + "properties": { + "sourceAttribute": { + "description": "The source attribute.", + "type": "array", + "items": { + "type": "string" + } + }, + "dnPart": { + "description": "The value for dn part.", + "type": "integer" + }, + "scriptContext": { + "description": "The script context.", + "type": "string" + }, + "constantValue": { + "description": "The constant value.", + "type": "string" + } + } + }, + "ChangeNotReimported": { + "description": "The changes which are not re-imported.", + "type": "object", + "properties": { + "delta": { + "description": "The delta changes that is not re-imported.", + "$ref": "#/definitions/ChangeNotReimportedDelta" + }, + "entry": { + "description": "The object entry in a change that is not re-imported.", + "$ref": "#/definitions/ChangeNotReimportedEntry" + } + } + }, + "ChangeNotReimportedDelta": { + "description": "The delta in a change that is not re-imported.", + "type": "object", + "properties": { + "anchor": { + "description": "The anchor.", + "type": "string" + }, + "dnAttributes": { + "description": "The delta attributes for distinguished names.", + "type": "array", + "items": { + "$ref": "#/definitions/AttributeDelta" + } + }, + "attributes": { + "description": "The attributes.", + "type": "array", + "items": { + "$ref": "#/definitions/AttributeDelta" + } + }, + "operationType": { + "description": "The operation type.", + "type": "string", + "enum": [ + "Undefined", + "None", + "Add", + "Replace", + "Update", + "Delete", + "Obsolete", + "DeletAdd" + ], + "x-ms-enum": { + "name": "DeltaOperationType", + "modelAsString": true + } + } + } + }, + "ChangeNotReimportedEntry": { + "description": "The object entry in a change that is not re-imported.", + "type": "object", + "properties": { + "anchor": { + "description": "The anchor.", + "type": "string" + }, + "parentAnchor": { + "description": "The parent anchor.", + "type": "string" + }, + "primaryObjectClass": { + "description": "The primary object class.", + "type": "string" + }, + "objectClasses": { + "description": "The olist of object classes.", + "type": "array", + "items": { + "type": "string" + } + }, + "dnAttributes": { + "description": "The delta attributes for distinguished names.", + "type": "array", + "items": { + "$ref": "#/definitions/AttributeDelta" + } + }, + "attributes": { + "description": "The attributes.", + "type": "array", + "items": { + "$ref": "#/definitions/AttributeDelta" + } + }, + "dn": { + "description": "The distinguished name.", + "type": "string" + } + } + }, + "Connector": { + "description": "The connect details.", + "type": "object", + "properties": { + "connectorId": { + "description": "The connector Id.", + "type": "string" + }, + "id": { + "description": "The connector Id.", + "type": "string" + }, + "name": { + "description": "The connector name.", + "type": "string" + }, + "version": { + "description": "The connector version", + "type": "integer" + }, + "type": { + "description": "The connector type.", + "type": "string" + }, + "description": { + "description": "The connector description.", + "type": "string" + }, + "schemaXml": { + "description": "The schema xml for the connector.", + "type": "string" + }, + "passwordManagementSettings": { + "description": "The password management settings of the connector.", + "type": "object", + "items": { + "$ref": "#/definitions/PasswordManagementSettings" + } + }, + "passwordHashSyncConfiguration": { + "description": "The password hash synchronization configuration of the connector.", + "type": "object", + "items": { + "$ref": "#/definitions/PasswordHashSyncConfiguration" + } + }, + "timeCreated": { + "description": "The date and time when this connector was created.", + "type": "string", + "format": "date-time" + }, + "timeLastModified": { + "description": "The date and time when this connector was last modified.", + "type": "string", + "format": "date-time" + }, + "partitions": { + "description": "The partitions of the connector.", + "type": "array", + "items": { + "$ref": "#/definitions/Partition" + } + }, + "runProfiles": { + "description": "The run profiles of the connector.", + "type": "array", + "items": { + "$ref": "#/definitions/RunProfile" + } + }, + "classesIncluded": { + "description": "The class inclusion list of the connector.", + "type": "array", + "items": { + "type": "string" + } + }, + "attributesIncluded": { + "description": "The attribute inclusion list of the connector.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Connectors": { + "description": "The list of connects for a service.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Connector" + } + } + } + }, + "ConnectorConnectionError": { + "description": "The connector connection error.", + "type": "object", + "properties": { + "id": { + "description": "The error Id.", + "type": "string" + }, + "runStepResultId": { + "description": "The run step result Id.", + "type": "string" + }, + "connectorId": { + "description": "The connector Id.", + "type": "string" + }, + "type": { + "description": "The type of error.", + "type": "string" + }, + "errorCode": { + "description": "The error code.", + "type": "string" + }, + "message": { + "description": "The message for the connection error.", + "type": "string" + }, + "timeOccured": { + "description": "The time when the connection error occured.", + "type": "string", + "format": "date-time" + }, + "server": { + "description": "The server where the connection error happened.", + "type": "string" + } + } + }, + "ConnectorConnectionErrors": { + "description": "The list of connector connection errors.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectorConnectionError" + } + } + } + }, + "ConnectorObjectError": { + "description": "The connector object error.", + "type": "object", + "properties": { + "id": { + "description": "The error Id.", + "type": "string" + }, + "runStepResultId": { + "description": "The run step result Id.", + "type": "string" + }, + "connectorId": { + "description": "The connector Id.", + "type": "string" + }, + "type": { + "description": "The type of error.", + "type": "string" + }, + "errorCode": { + "description": "The error code.", + "type": "string" + }, + "message": { + "description": "The message for the object error.", + "type": "string" + }, + "entryNumber": { + "description": "The entry number for object error occured.", + "type": "integer" + }, + "lineNumber": { + "description": "The line number for the object error.", + "type": "integer" + }, + "columnNumber": { + "description": "The column number for the object error.", + "type": "integer" + }, + "dn": { + "description": "The distingished name of the object.", + "type": "string" + }, + "anchor": { + "description": "The name for the anchor of the object.", + "type": "string" + }, + "attributeName": { + "description": "The attribute name of the object.", + "type": "string" + }, + "serverErrorDetail": { + "description": "The server side error details.", + "type": "string" + }, + "values": { + "description": "The value corresponding to attribute name.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ConnectorObjectErrors": { + "description": "The list of connector object errors.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectorObjectError" + } + } + } + }, + "Credential": { + "description": "The credential for a given server.", + "type": "object", + "properties": { + "identifier": { + "description": "The credential identifier.", + "type": "string" + }, + "type": { + "description": "The type of credential.", + "type": "string" + }, + "credentialData": { + "description": "The credential data.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Credentials": { + "description": "The list of agent credentials.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Credential" + } + } + } + }, + "DataFreshnessDetails": { + "description": "The data freshness details for the server.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + } + } + }, + "Dimension": { + "description": "The connector object error.", + "type": "object", + "properties": { + "health": { + "description": "The health status for the domain controller.", + "type": "string", + "enum": [ + "Healthy", + "Warning", + "Error", + "NotMonitored", + "Missing" + ], + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": true + } + }, + "simpleProperties": { + "description": "List of service specific configuration properties.", + "type": "object", + "items": { + "$ref": "#/definitions/Item" + } + }, + "activeAlerts": { + "description": "The count of alerts that are currently active for the service.", + "type": "integer" + }, + "additionalInformation": { + "description": "The additional information related to the service.", + "type": "string" + }, + "lastUpdated": { + "description": "The date or time , in UTC, when the service properties were last updated.", + "type": "string", + "format": "date-time" + }, + "displayName": { + "description": "The display name of the service.", + "type": "string" + }, + "resolvedAlerts": { + "description": "The total count of alerts that has been resolved for the service.", + "type": "integer" + }, + "signature": { + "description": "The signature of the service.", + "type": "string" + }, + "type": { + "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", + "type": "string" + } + } + }, + "Dimensions": { + "description": "The list of dimensions.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + }, + "totalCount": { + "description": "The total count of dimensions.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "Display": { + "description": "Displays the details related to operations supported by Azure Active Directory Connect Health.", + "type": "object", + "properties": { + "description": { + "description": " The description for the operation.", + "type": "string" + }, + "operation": { + "description": "The details of the operation.", + "type": "string" + }, + "provider": { + "description": "The provider name.", + "type": "string" + } + } + }, + "ErrorCount": { + "description": "The error count details.", + "type": "object", + "properties": { + "errorBucket": { + "description": "The error bucket.", + "type": "string" + }, + "count": { + "description": "The error count.", + "type": "integer" + }, + "truncated": { + "description": "Indicates if the error count is truncated or not.", + "type": "boolean" + } + } + }, + "ErrorCounts": { + "description": "The list of error counts.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorCount" + } + } + } + }, + "ErrorDetail": { + "description": "The error details.", + "type": "object", + "properties": { + "description": { + "description": "The error description.", + "type": "string" + }, + "kbUrl": { + "description": "The knowledge base article url which contains more information about the error.", + "type": "string" + }, + "detail": { + "description": "Additional details related to the error.", + "type": "string" + }, + "objectsWithSyncError": { + "description": "The list of objects with sync errors.", + "$ref": "#/definitions/ObjectWithSyncError" + }, + "objectWithSyncError": { + "description": " The object with sync error.", + "$ref": "#/definitions/MergedExportError" + } + } + }, + "ExportError": { + "description": "The export error details.", + "type": "object", + "properties": { + "id": { + "description": "The error Id.", + "type": "string" + }, + "runStepResultId": { + "description": "The run step result Id.", + "type": "string" + }, + "connectorId": { + "description": "The connector Id.", + "type": "string" + }, + "type": { + "description": "The type of error.", + "type": "string" + }, + "errorCode": { + "description": "The error code.", + "type": "string" + }, + "message": { + "description": "The export error message.", + "type": "string" + }, + "serverErrorDetail": { + "description": "The server error detail.", + "type": "string" + }, + "timeFirstOccured": { + "description": "The date and time when the export error first occured.", + "type": "string", + "format": "date-time" + }, + "retryCount": { + "description": "The retry count.", + "type": "integer" + }, + "csObjectId": { + "description": "The cloud object Id.", + "type": "string" + }, + "dn": { + "description": "The distinguished name.", + "type": "string" + }, + "minLimit": { + "description": "The minimum limit.", + "type": "string" + }, + "maxLimit": { + "description": "The maximum limit.", + "type": "string" + }, + "cloudAnchor": { + "description": "The name of the cloud anchor.", + "type": "string" + }, + "attributeName": { + "description": "The attribute name.", + "type": "string" + }, + "attributeValue": { + "description": "The attribute value.", + "type": "string" + }, + "attributeMultiValue": { + "description": "Indicates if the attribute is multi valued or not.", + "type": "boolean" + }, + "objectIdConflict": { + "description": "The object Id with which there was an attribute conflict.", + "type": "string" + }, + "samAccountName": { + "description": "The SAM account name.", + "type": "string" + }, + "adObjectType": { + "description": "The AD object type", + "type": "string" + }, + "adObjectGuid": { + "description": "The AD object guid.", + "type": "string" + }, + "adDisplayName": { + "description": "The display name for the AD object.", + "type": "string" + }, + "adSourceOfAuthority": { + "description": "The source of authority for the AD object.", + "type": "string" + }, + "adSourceAnchor": { + "description": "The AD source anchor.", + "type": "string" + }, + "adUserPrincipalName": { + "description": "The user principal name for the AD object.", + "type": "string" + }, + "adDistinguishedName": { + "description": "The distinguished name for the AD object.", + "type": "string" + }, + "adMail": { + "description": "The email for the AD object.", + "type": "string" + }, + "timeOccured": { + "description": "The date and time of occurance.", + "type": "string", + "format": "date-time" + }, + "aadObjectType": { + "description": "The AAD side object type.", + "type": "string" + }, + "aadObjectGuid": { + "description": "The AAD side object guid.", + "type": "string" + }, + "aadDisplayName": { + "description": "The AAD side display name", + "type": "string" + }, + "aadSourceOfAuthority": { + "description": "The AAD side source of authority for the object.", + "type": "string" + }, + "aadUserPrincipalName": { + "description": "The AAD side user principal name.", + "type": "string" + }, + "aadDistringuishedName": { + "description": "The AAD side distinguished name for the object.", + "type": "string" + }, + "aadMail": { + "description": "The AAD side email for the object.", + "type": "string" + }, + "lastDirSyncTime": { + "description": "The date and time of last sync run.", + "type": "string", + "format": "date-time" + }, + "modifiedAttributeValue": { + "description": "The modified atttribute value.", + "type": "string" + } + } + }, + "ExportErrors": { + "description": "The list of export errors.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ExportError" + } + } + } + }, + "ErrorReportUsersEntry": { + "description": "The bad password login attempt details.", + "type": "object", + "properties": { + "userId": { + "description": "The user ID value.", + "type": "string" + }, + "ipAddress": { + "description": "The Ip address corresponding to the last error event.", + "type": "string" + }, + "lastUpdated": { + "description": "The date and time when the last error event was logged.", + "type": "string", + "format": "date-time" + }, + "uniqueIpAddresses": { + "description": "The list of unique IP addresses.", + "type": "string" + }, + "totalErrorAttempts": { + "description": "The total count of specific error events.", + "type": "integer" + } + } + }, + "ErrorReportUsersEntries": { + "description": "The list of bad password log in attempt entries.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorReportUsersEntry" + } + } + } + }, + "ExportStatus": { + "description": "The details of the export status.", + "type": "object", + "properties": { + "serviceId": { + "description": "The id of the service for whom the export status is being reported.", + "type": "string", + "format": "uuid" + }, + "serviceMemberId": { + "description": "The server Id for whom the export status is being reported.", + "type": "string", + "format": "uuid" + }, + "endTime": { + "description": "The date and time when the export ended.", + "type": "string", + "format": "date-time" + }, + "runStepResultId": { + "description": "The run step result Id.", + "type": "string" + } + } + }, + "ExportStatuses": { + "description": "The list of export statuses.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ExportStatus" + } + }, + "totalCount": { + "description": "The total count of service elements.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "ExtensionErrorInfo": { + "description": "The extension error details.", + "type": "object", + "properties": { + "extensionName": { + "description": "The extension name.", + "type": "string" + }, + "extensionContext": { + "description": "The extension context.", + "type": "string" + }, + "callStack": { + "description": "The call stack for the error.", + "type": "string" + } + } + }, + "ForestSummary": { + "description": "The forest summary for an ADDS domain.", + "type": "object", + "properties": { + "forestName": { + "description": "The forest name.", + "type": "string" + }, + "domainCount": { + "description": "The domain count.", + "type": "integer" + }, + "siteCount": { + "description": "The site count.", + "type": "integer" + }, + "monitoredDcCount": { + "description": "The number of domain controllers that are monitored by Azure Active Directory Connect Health.", + "type": "integer" + }, + "totalDcCount": { + "description": "The total domain controllers.", + "type": "integer" + }, + "domains": { + "description": "The list of domain controller names.", + "type": "array", + "items": { + "type": "string" + } + }, + "sites": { + "description": "The list of site names.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GlobalConfiguration": { + "description": "The global configuration settings.", + "type": "object", + "properties": { + "version": { + "description": "The version for the global configuration.", + "type": "integer" + }, + "schemaXml": { + "description": "The schema for the configuration.", + "type": "string" + }, + "passwordSyncEnabled": { + "description": "Indicates if password sync is enabled or not.", + "type": "boolean" + }, + "numSavedPwdEvent": { + "description": "The number of saved password events.", + "type": "integer" + }, + "featureSet": { + "description": "The list of additional feature sets.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + } + } + }, + "GlobalConfigurations": { + "description": "The list of global configurations.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/GlobalConfiguration" + } + } + } + }, + "HelpLink": { + "description": "The help link which contains more information related to an alert.", + "type": "object", + "properties": { + "title": { + "description": "The title for the link.", + "type": "string" + }, + "url": { + "description": "The url for the help document.", + "type": "string" + } + } + }, + "Hotfix": { + "description": "The details of the hotfix installed in the server.", + "type": "object", + "properties": { + "kbName": { + "description": "The name of the hotfix KB.", + "type": "string" + }, + "link": { + "description": "The link to the KB Article.", + "type": "string" + }, + "installedDate": { + "description": "The date and time, in UTC, when the KB was installed in the server.", + "type": "string", + "format": "date-time" + } + } + }, + "Hotfixes": { + "description": "The list of hotfixes installed in the server.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Hotfix" + } + } + } + }, + "ImportErrors": { + "description": "The list of import errors.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ImportError" + } + } + } + }, + "ImportError": { + "description": "The import error details.", + "type": "object", + "properties": { + "id": { + "description": "The error Id.", + "type": "string" + }, + "runStepResultId": { + "description": "The run step result Id.", + "type": "string" + }, + "connectorId": { + "description": "The connector Id.", + "type": "string" + }, + "type": { + "description": "The type of error.", + "type": "string" + }, + "timeOccurred": { + "description": "The time when the import error occurred.", + "type": "string", + "format": "date-time" + }, + "timeFirstOccurred": { + "description": "The time when the import error first occurred.", + "type": "string", + "format": "date-time" + }, + "retryCount": { + "description": "The retry count.", + "type": "integer" + }, + "algorithmStepType": { + "description": "The operation type specific to error reporting.", + "type": "string", + "enum": [ + "Undefined", + "Staging", + "ConnectorFilter", + "Join", + "Projection", + "ImportFlow", + "Provisioning", + "ValidateConnectorFilter", + "Deprovisioning", + "ExportFlow", + "MvDeletion", + "Recall", + "MvObjectTypeChange" + ], + "x-ms-enum": { + "name": "AlgorithmStepType", + "modelAsString": true + } + }, + "changeNotReimported": { + "description": "The change details that is not re-imported.", + "$ref": "#/definitions/ChangeNotReimported" + }, + "extensionErrorInfo": { + "description": "The extension error information.", + "$ref": "#/definitions/ExtensionErrorInfo" + }, + "ruleErrorInfo": { + "description": "The error details in legacy rule processing.", + "$ref": "#/definitions/RuleErrorInfo" + }, + "csObjectId": { + "description": "The object Id.", + "type": "string" + }, + "dn": { + "description": "The distinguished name.", + "type": "string" + } + } + }, + "InboundReplicationNeighbor": { + "description": "The replication summary for the domain controller inbound neighbor.", + "type": "object", + "properties": { + "sourceDomainController": { + "description": "The name of the source domain controller.", + "type": "string" + }, + "consecutiveFailureCount": { + "description": "The number of consecutive faulire counts.", + "type": "integer" + }, + "namingContext": { + "description": "The naming context.", + "type": "string" + }, + "status": { + "description": "The health status for the domain controller", + "type": "integer" + }, + "lastAttemptedSync": { + "description": "The last time a sync was attempted on the domain controller.", + "type": "string", + "format": "date-time" + }, + "lastSuccessfulSync": { + "description": "The last time when a successful sync happened.", + "type": "string", + "format": "date-time" + }, + "lastErrorCode": { + "description": "The last error code.", + "type": "integer" + }, + "lastErrorMessage": { + "description": "The error message of the last error.", + "type": "string" + }, + "errorTitle": { + "description": "The error title.", + "type": "string" + }, + "errorDescription": { + "description": "The error description.", + "type": "string" + }, + "fixLink": { + "description": "The link for the fix of the error.", + "type": "string" + }, + "fixDetails": { + "description": "The details of the fix.", + "type": "string" + }, + "additionalInfo": { + "description": "The additional details.", + "type": "string" + } + } + }, + "InboundReplicationNeighbors": { + "description": "The list of replication summary for the domain controller inbound neighbor.", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "The details of inbound replication neighbors.", + "items": { + "$ref": "#/definitions/InboundReplicationNeighbor" + } + } + } + }, + "Item": { + "description": "The key value pair for properties.", + "type": "object", + "properties": { + "key": { + "description": "The key for the property.", + "type": "string" + }, + "value": { + "description": "The value for the key.", + "type": "string" + } + } + }, + "Items": { + "description": "The list of key value properties.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + } + } + }, + "MergedExportError": { + "description": "The merged export error.", + "type": "object", + "properties": { + "id": { + "description": "The error Id.", + "type": "string" + }, + "incomingObjectDisplayName": { + "description": "The incoming object display name.", + "type": "string" + }, + "incomingObjectType": { + "description": "The incoming object type.", + "type": "string" + }, + "userPrincipalName": { + "description": "The user principal name", + "type": "string" + }, + "type": { + "description": "The type of the error.", + "type": "string" + }, + "attributeName": { + "description": "The attribute name.", + "type": "string" + }, + "attributeValue": { + "description": "The attribute value.", + "type": "string" + }, + "timeOccurred": { + "description": "The date and time when the error occurred.", + "type": "string", + "format": "date-time" + }, + "timeFirstOccurred": { + "description": "The time when the error first occurred.", + "type": "string", + "format": "date-time" + }, + "csObjectId": { + "description": " the cs object Id.", + "type": "string" + }, + "dn": { + "description": "the DN of the object.", + "type": "string" + }, + "incomingObject": { + "description": "The incoming object details.", + "$ref": "#/definitions/AssociatedObject" + }, + "existingObject": { + "description": "The existing object", + "$ref": "#/definitions/AssociatedObject" + }, + "modifiedOrRemovedAttributeValue": { + "description": "The modified or removed attribute vlaue.", + "type": "string" + }, + "runStepResultId": { + "description": "The run step result Id.", + "type": "string", + "format": "uuid" + }, + "samAccountName": { + "description": "The sam account name.", + "type": "string" + }, + "serverErrorDetail": { + "description": "The server error details.", + "type": "string" + }, + "serviceId": { + "description": "The service Id.", + "type": "string", + "format": "uuid" + }, + "serviceMemberId": { + "description": "The server Id.", + "type": "string", + "format": "uuid" + }, + "mergedEntityId": { + "description": "The merged entity Id.", + "type": "string", + "format": "uuid" + }, + "createdDate": { + "description": "The date and time, in UTC, when the error was created.", + "type": "string", + "format": "date-time" + }, + "exportErrorStatus": { + "description": "The export error status.", + "type": "integer" + } + } + }, + "MergedExportErrors": { + "description": "The list of export errors.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MergedExportError" + } + } + } + }, + "MetricGroup": { + "description": " The metric group details.", + "type": "object", + "properties": { + "key": { + "description": "The key for the group.", + "type": "string" + }, + "displayName": { + "description": "The display name for the group.", + "type": "string" + }, + "invisibleForUi": { + "description": "indicates if the metric group is displayed in Azure Active Directory Connect Health UI.", + "type": "boolean" + } + } + }, + "Metrics": { + "description": "The list of metric items.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "totalCount": { + "description": "The total count of metrics.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "MetricMetadata": { + "description": "The metric meta data", + "type": "object", + "properties": { + "metricsProcessorClassName": { + "description": "The name of the class which retrieve and process the metric.", + "type": "string" + }, + "metricName": { + "description": "The metric name", + "type": "string" + }, + "groupings": { + "description": "The groupings for the metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricGroup" + } + }, + "displayName": { + "description": "The display name for the metric.", + "type": "string" + }, + "valueKind": { + "description": "Indicates if the metrics is a rate,value, percent or duration type.", + "type": "string" + }, + "minValue": { + "description": "The minimun value.", + "type": "integer" + }, + "maxValue": { + "description": "The maximum value.", + "type": "integer" + }, + "kind": { + "description": "Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart.", + "type": "string" + }, + "isDefault": { + "description": "Indicates if the metric is a default metric or not.", + "type": "boolean" + }, + "isPerfCounter": { + "description": "Indicates if the metric is a performance counter metric or not.", + "type": "boolean" + }, + "isDevOps": { + "description": "Indicates if the metric is visible to DevOps or not.", + "type": "boolean" + } + } + }, + "MetricMetadataList": { + "description": "The list of metric metadata.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricMetadata" + } + }, + "totalCount": { + "description": "The total count of service elements.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "MetricSet": { + "description": " The set of metric values. Example of a MetricSet are Values of token requests for a Server1 or RelyingParty1.", + "type": "object", + "properties": { + "setName": { + "description": "The name of the set.", + "type": "string" + }, + "values": { + "description": "The list of the metric values.", + "type": "array", + "items": { + "type": "integer" + } + } + } + }, + "MetricSets": { + "description": "The metrics data represented set.", + "type": "object", + "properties": { + "sets": { + "description": "The list of metric set.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSet" + } + }, + "timeStamps": { + "description": "The list of timestamps for each metric in the metric set.", + "type": "array", + "items": { + "type": "string", + "format": "date-time" + } + } + } + }, + "ModuleConfiguration": { + "description": "The module configuration as required by the Agent service.", + "type": "object", + "properties": { + "agentService": { + "description": "The name of agent service.", + "type": "string" + }, + "moduleName": { + "description": "The name of the module for which the configuration is applicable.", + "type": "string" + }, + "properties": { + "description": "The key value pairs of properties required for configuration.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ModuleConfigurations": { + "description": "The list of module configurations.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ModuleConfiguration" + } + } + } + }, + "ObjectWithSyncError": { + "description": "The objects withg sync errors.", + "type": "object", + "properties": { + "sourceOfAuthority": { + "description": "The source of authority.", + "type": "string" + }, + "displayName": { + "description": "The display name.", + "type": "string" + }, + "objectType": { + "description": "The object type.", + "type": "string" + }, + "attributeName": { + "description": "The attribute name.", + "type": "string" + }, + "attributeValue": { + "description": "The attribute value.", + "type": "string" + }, + "modififedValue": { + "description": "The modified value.", + "type": "string" + }, + "userPrincipalName": { + "description": "The user principal name.", + "type": "string" + }, + "objectGuid": { + "description": "The object guid.", + "type": "string" + }, + "attributeMultiValues": { + "description": "Indicates if the atttibute is multi-valued or not.", + "type": "boolean" + }, + "minLimit": { + "description": "The minimum limit.", + "type": "string" + }, + "maxLimit": { + "description": "The maximum limit.", + "type": "string" + }, + "distinguishedName": { + "description": "The distinguished name.", + "type": "string" + }, + "mail": { + "description": "The email.", + "type": "string" + }, + "timeOccured": { + "description": "The date and time of occurance.", + "type": "string", + "format": "date-time" + }, + "errorType": { + "description": "The error type.", + "type": "string" + }, + "sourceAnchor": { + "description": "The source anchor.", + "type": "string" + } + } + }, + "Operation": { + "description": "The details of the operation.", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation.", + "type": "string" + }, + "display": { + "description": "The display details for the operation.", + "type": "object", + "items": { + "$ref": "#/definitions/Display" + } + } + } + }, + "OperationListResponse": { + "description": "Lists all of the available REST API operations for Azure Active Directory Connect Health.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "List of operations supported by the Microsoft.ADHybridhHealthService resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "totalCount": { + "description": "The total count of opertaions.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token to get next set of operations.", + "type": "string" + } + + } + }, + "Partition": { + "description": "Describes the partition in Synchronization service.", + "type": "object", + "properties": { + "id": { + "description": "The partition Id.", + "type": "string" + }, + "dn": { + "description": "The distinguished name for the partition.", + "type": "string" + }, + "enabled": { + "description": "Indicates if the partition object is selected or not.", + "type": "boolean" + }, + "timeCreated": { + "description": "The date and time when the partition is created.", + "type": "string", + "format": "date-time" + }, + "timeLastModified": { + "description": "The time and date when the partition was last modified.", + "type": "string", + "format": "date-time" + }, + "partitionScope": { + "description": "The scope of the partition.", + "$ref": "#/definitions/PartitionScope" + }, + "name": { + "description": "The name of the partition.", + "type": "string" + }, + "isDomain": { + "description": "Indicates if the partition is a domain or not.", + "type": "boolean" + }, + "type": { + "description": "The partition type.", + "type": "string" + } + } + + }, + "PartitionScope": { + "description": "The connector partition scope.", + "type": "object", + "properties": { + "isDefault": { + "description": "Indicates if the partition scope is default or not.", + "type": "boolean" + }, + "objectClasses": { + "description": "The in-scope object classes.", + "type": "array", + "items": { + "type": "string" + } + }, + "containersIncluded": { + "description": "The list of containers included.", + "type": "array", + "items": { + "type": "string" + } + }, + "containersExcluded": { + "description": "The list of containers excluded.", + "type": "array", + "items": { + "type": "string" + } + } + } + + }, + "PasswordManagementSettings": { + "description": "The password management settings.", + "type": "object", + "properties": { + "enabled": { + "description": "Indicates if the password extension is enabled.", + "type": "boolean" + }, + "extensionFilePath": { + "description": "The file path of the password management extension.", + "type": "string" + }, + "connectTo": { + "description": "Connection point of password management.", + "type": "string" + }, + "connectionTimeout": { + "description": "Connection timeoit for password extension.", + "type": "integer" + }, + "user": { + "description": "User to execute password extension.", + "type": "string" + }, + "supportedPasswordOperations": { + "description": "The supported password operations.", + "type": "string", + "enum": [ + "Undefined", + "Set", + "Change" + ], + "x-ms-enum": { + "name": "PasswordOperationTypes", + "modelAsString": true + } + }, + "maximumRetryCount": { + "description": "The maximum number of retries.", + "type": "integer" + }, + "retryIntervalInSeconds": { + "description": "The time between retries.", + "type": "integer" + }, + "requiresSecureConnection": { + "description": "Indicates if a secure connection is required for password management.", + "type": "boolean" + }, + "unlockAccount": { + "description": "Indicates if accounts should be unloacked when resetting password.", + "type": "boolean" + } + } + }, + "PasswordHashSyncConfiguration": { + "description": "The password has synchronization configuration settings.", + "type": "object", + "properties": { + "enabled": { + "description": "Indicates if the password hash synchronization configuration settings is enabled.", + "type": "boolean" + }, + "target": { + "description": "The target.", + "type": "string" + } + } + }, + "ReplicationDetailsList": { + "description": "The list of replication details.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationSummary" + } + }, + "totalCount": { + "description": "The total count of replication detail elements.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + } + }, + "ReplicationStatus": { + "description": " Replication summary for a domain controller.", + "type": "object", + "properties": { + "forestName": { + "description": "The forest name.", + "type": "string" + }, + "totalDcCount": { + "description": "The total numbe of domain controllers for a given forest.", + "type": "integer" + }, + "errorDcCount": { + "description": "The total number of domain controllers with error in a given forest.", + "type": "integer" + } + } + }, + "ReplicationSummary": { + "description": "The replication summary for a domain controller.", + "type": "object", + "properties": { + "targetServer": { + "description": "The domain controller name.", + "type": "string" + }, + "site": { + "description": "The site name for a given domain controller.", + "type": "string" + }, + "domain": { + "description": "The domain name for a given domain controller.", + "type": "string" + }, + "status": { + "description": "The health status for a domain controller.", + "type": "integer" + }, + "lastAttemptedSync": { + "description": "The last time when a sync was attempted for a given domain controller.", + "type": "string", + "format": "date-time" + }, + "lastSuccessfulSync": { + "description": "The time when the last successful sync happened for a given domain controller.", + "type": "string", + "format": "date-time" + }, + "inboundNeighborCollection": { + "description": "List of individual domain controller neighbor's inbound replication status.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundReplicationNeighbor" + } + } + } + }, + "ReplicationSummaryList": { + "description": "The list of replication summary details.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationSummary" + } + } + } + }, + "Result": { + "description": "The result for an operation.", + "type": "object", + "properties": { + "value": { + "description": "The value.", + "type": "boolean" + } + } + }, + "RuleErrorInfo": { + "description": "The error details in legacy rule processing.", + "type": "object", + "properties": { + "attributeMapping": { + "description": "The attribute mapping details.", + "$ref": "#/definitions/AttributeMapping" + }, + "connectorId": { + "description": "The connector Id.", + "type": "string" + }, + "connectorName": { + "description": "The connector name.", + "type": "string" + }, + "csObjectId": { + "description": "The object Id.", + "type": "string" + }, + "dn": { + "description": "The distinguished name.", + "type": "string" + } + } + }, + "RunStep": { + "description": "The run step for a run profile.", + "type": "object", + "properties": { + "batchSize": { + "description": "The batch size used by the run step.", + "type": "integer" + }, + "objectProcessLimit": { + "description": "The obect processing limit.", + "type": "integer" + }, + "objectDeleteLimit": { + "description": "The object deletion limit.", + "type": "integer" + }, + "pageSize": { + "description": "The page size of the run step.", + "type": "integer" + }, + "partitionId": { + "description": "The Id of the partition that a current run setp operation is executing.", + "type": "string" + }, + "operationType": { + "description": "The run step operation types.", + "type": "integer" + }, + "timeout": { + "description": "The operation timeout.", + "type": "integer" + } + } + }, + "RunProfile": { + "description": "Describes the run profile.", + "type": "object", + "properties": { + "id": { + "description": "The run profile Id.", + "type": "string" + }, + "name": { + "description": "The run profile name", + "type": "string" + }, + "runSteps": { + "description": "The run steps of the run profile.", + "type": "array", + "items": { + "$ref": "#/definitions/RunStep" + } + } + } + }, + "RunProfiles": { + "description": "The list of run profiles.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/RunProfile" + } + } + } + }, + "ServiceConfiguration": { + "description": "The service configuration", + "type": "object", + "properties": { + "version": { + "description": "The version of the sync service.", + "type": "string" + }, + "serviceType": { + "description": "The service type of the server.", + "type": "integer" + }, + "serviceAccount": { + "description": "The service account.", + "type": "string" + }, + "sqlServer": { + "description": "The SQL server information.", + "type": "string" + }, + "sqlVersion": { + "description": "The SQL version.", + "type": "string" + }, + "sqlEdition": { + "description": "The SQL edition", + "type": "string" + }, + "sqlInstance": { + "description": "The SQL instance details.", + "type": "string" + }, + "sqlDatabaseName": { + "description": "The SQL database.", + "type": "string" + }, + "sqlDatabaseSize": { + "description": "The SQL database size.", + "type": "integer" + } + } + }, + "ServiceProperties": { + "description": "The service properties for a given service.", + "type": "object", + "properties": { + "id": { + "description": "The id of the service.", + "type": "string" + }, + "activeAlerts": { + "description": "The count of alerts that are currently active for the service.", + "type": "integer" + }, + "additionalInformation": { + "description": "The additional information related to the service.", + "type": "string" + }, + "createdDate": { + "description": "The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health.", + "type": "string", + "format": "date-time" + }, + "customNotificationEmails": { + "description": "The list of additional emails that are configured to recieve notifications about the service.", + "type": "array", + "items": { + "type": "string" + } + }, + "disabled": { + "description": "Indicates if the service is disabled or not.", + "type": "boolean" + }, + "displayName": { + "description": "The display name of the service.", + "type": "string" + }, + "health": { + "description": "The health of the service.", + "type": "string" + }, + "lastDisabled": { + "description": "The date and time, in UTC, when the service was last disabled.", + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "description": "The date or time , in UTC, when the service properties were last updated.", + "type": "string", + "format": "date-time" + }, + "monitoringConfigurationsComputed": { + "description": "The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health.", + "type": "object", + "items": { + "$ref": "#/definitions/Items" + } + }, + "monitoringConfigurationsCustomized": { + "description": "The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health.", + "type": "object", + "items": { + "$ref": "#/definitions/Items" + } + }, + "notificationEmailEnabled": { + "description": "Indicates if email notification is enabled or not.", + "type": "boolean" + }, + "notificationEmailEnabledForGlobalAdmins": { + "description": "Indicates if email notification is enabled for global administrators of the tenant.", + "type": "boolean" + }, + "notificationEmailsEnabledForGlobalAdmins": { + "description": "Indicates if email notification is enabled for global administrators of the tenant.", + "type": "boolean" + }, + "notificationEmails": { + "description": "The list of emails to whom service notifications will be sent.", + "type": "array", + "items": { + "type": "string" + } + }, + "originalDisabledState": { + "description": "Gets the original disable state.", + "type": "boolean" + }, + "resolvedAlerts": { + "description": "The total count of alerts that has been resolved for the service.", + "type": "integer" + }, + "serviceId": { + "description": "The id of the service.", + "type": "string" + }, + "serviceName": { + "description": "The name of the service.", + "type": "string" + }, + "signature": { + "description": "The signature of the service.", + "type": "string" + }, + "simpleProperties": { + "description": "List of service specific configuration properties.", + "type": "object", + "items": { + "$ref": "#/definitions/Items" + } + }, + "tenantId": { + "description": "The id of the tenant to which the service is registered to.", + "type": "string" + }, + "type": { + "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", + "type": "string" + } + } + }, + "Services": { + "description": "The list of services for a given onboarded tenant.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceProperties" + } + }, + "totalCount": { + "description": "The total count of service elements.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "ServiceMember": { + "description": "The server properties for a given service.", + "type": "object", + "properties": { + "serviceMemberId": { + "description": "The id of the server.", + "type": "string" + }, + "serviceId": { + "description": "The service id to whom this server belongs.", + "type": "string" + }, + "tenantId": { + "description": "The tenant id to whom this server belongs.", + "type": "string" + }, + "activeAlerts": { + "description": "The total number of alerts that are currently active for the server.", + "type": "integer" + }, + "additionalInformation": { + "description": "The additional information, if any, for the server.", + "type": "string" + }, + "createdDate": { + "description": "The date time , in UTC, when the server was onboaraded to Azure Active Directory Connect Health.", + "type": "string", + "format": "date-time" + }, + "dimensions": { + "description": "The server specific configuration related dimensions.", + "type": "object", + "items": { + "$ref": "#/definitions/Item" + } + }, + "disabled": { + "description": "Indicates if the server is disabled or not. ", + "type": "boolean" + }, + "disabledReason": { + "description": "The reason for disabling the server.", + "type": "integer" + }, + "installedQfes": { + "description": "The list of installed QFEs for the server.", + "type": "object", + "items": { + "$ref": "#/definitions/Hotfix" + } + }, + "lastDisabled": { + "description": "The date and time , in UTC, when the server was last disabled.", + "type": "string", + "format": "date-time" + }, + "lastReboot": { + "description": "The date and time, in UTC, when the server was last rebooted.", + "type": "string", + "format": "date-time" + }, + "lastServerReportedMonitoringLevelChange": { + "description": "The date and time, in UTC, when the server's data monitoring configuration was last changed.", + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "description": "The date and time, in UTC, when the server proeprties were last updated.", + "type": "string", + "format": "date-time" + }, + "machineId": { + "description": "The id of the machine.", + "type": "string" + }, + "machineName": { + "description": "The name of the server.", + "type": "string" + }, + "monitoringConfigurationsComputed": { + "description": "The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", + "type": "object", + "items": { + "$ref": "#/definitions/Item" + } + }, + "monitoringConfigurationsCustomized": { + "description": "The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", + "type": "object", + "items": { + "$ref": "#/definitions/Item" + } + }, + "osName": { + "description": "The name of the operating system installed in the machine.", + "type": "string" + }, + "osVersion": { + "description": "The version of the operating system installed in the machine.", + "type": "string" + }, + "properties": { + "description": "Server specific properties.", + "type": "object", + "items": { + "$ref": "#/definitions/Item" + } + }, + "recommendedQfes": { + "description": "The list of recommended hotfixes for the server.", + "type": "object", + "items": { + "$ref": "#/definitions/Hotfix" + } + }, + "resolvedAlerts": { + "description": "The total count of alerts that are resolved for this server.", + "type": "integer" + }, + "role": { + "description": "The service role that is being monitored in the server.", + "type": "string" + }, + "serverReportedMonitoringLevel": { + "description": "The monitoring level reported by the server.", + "type": "string", + "enum": [ + "Partial", + "Full", + "Off" + ], + "x-ms-enum": { + "name": "MonitoringLevel", + "modelAsString": false + } + }, + "status": { + "description": "The health status of the server.", + "type": "string" + } + } + }, + "ServiceMembers": { + "description": "The list of servers that are onboarded for a given service.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceMember" + } + }, + "totalCount": { + "description": "The total count of service elements.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "TabularExportError": { + "description": "The details for export error.", + "type": "object", + "properties": { + "serviceId": { + "description": "The service Id.", + "type": "string", + "format": "uuid" + }, + "serviceMemberId": { + "description": "The server Id.", + "type": "string", + "format": "uuid" + }, + "mergedEntityId": { + "description": "The merged entity Id.", + "type": "string", + "format": "uuid" + }, + "tabularExportErrorData": { + "description": "The export error data.", + "type": "string" + } + } + }, + "Tenant": { + "description": "The details of the onboarded tenant.", + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "The Id of the tenant." + }, + "aadLicense": { + "type": "string", + "description": "The Azure Active Directory license of the tenant." + }, + "aadPremium": { + "type": "boolean", + "description": "Indicate if the tenant has Azure Active Directory Premium license or not." + }, + "agentAutoUpdate": { + "type": "boolean", + "description": "Indicates if the tenant is configured to automatically receive updates for Azure Active Directory Connect Health client side features." + }, + "alertSuppressionTimeInMins": { + "type": "integer", + "description": "The time in minutues after which an alert will be autosupressed." + }, + "consentedToMicrosoftDevOps": { + "type": "boolean", + "description": "Indicates if the tenant data can be seen by Microsoft through Azure portal." + }, + "countryLetterCode": { + "type": "string", + "description": "The country letter code of the tenant." + }, + "createdDate": { + "type": "string", + "format": "date-time", + "description": "The date, in UTC, when the tenant was onboarded to Azure Active Directory Connect Health." + }, + "devOpsTtl": { + "type": "string", + "format": "date-time", + "description": "The date and time, in UTC, till when the tenant data can be seen by Microsoft through Azure portal." + }, + "disabled": { + "type": "boolean", + "description": "Indicates if the tenant is disabled in Azure Active Directory Connect Health." + }, + "disabledReason": { + "type": "integer", + "description": "The reason due to which the tenant was disabled in Azure Active Directory Connect Health." + }, + "globalAdminsEmail": { + "type": "object", + "items": { + "type": "string" + }, + "description": "The list of golbal administrators for the tenant." + }, + "initialDomain": { + "type": "string", + "description": "The initial domain of the tenant." + }, + "lastDisabled": { + "type": "string", + "format": "date-time", + "description": "The date and time, in UTC, when the tenant was last disabled in Azure Active Directory Connect Health." + }, + "lastVerified": { + "type": "string", + "format": "date-time", + "description": "The date and time, in UTC, when the tenant onboarding status in Azure Active Directory Connect Health was last verified." + }, + "onboardingAllowed": { + "type": "boolean", + "description": "Indicates if the tenant is allowed to onboard to Azure Active Directory Connect Health." + }, + "onboarded": { + "type": "boolean", + "description": "Indicates if the tenant is already onboarded to Azure Active Directory Connect Health." + }, + "pksCertificate": { + "type": "object", + "description": "The certificate associated with the tenant to onboard data to Azure Active Directory Connect Health." + }, + "privatePreviewTenant": { + "type": "boolean", + "description": "Indicates if the tenant has signed up for private preview of Azure Active Directory Connect Health features." + }, + "tenantInQuarantine": { + "type": "boolean", + "description": "Indicates if data collection for this tenant is disabled or not." + }, + "tenantName": { + "type": "string", + "description": "The name of the tenant." + } + } + }, + "TenantOnboardingDetails": { + "description": "The tenant onboarding details.", + "type": "object", + "properties": { + "tenantOnboarded": { + "description": "Indicates if the tenant is onboarded to Azure Active Directory Connect Health or not.", + "type": "boolean" + }, + "onboardingDisplayUrl": { + "description": "The display url, to help tenant navigate or onboard to Azure Active Directory Connect Health blade, based on tenant onboarding status.", + "type": "string" + } + } + }, + "UserPreference": { + "description": " The user preference for a given feature.", + "type": "object", + "properties": { + "metricNames": { + "description": "The name of the metric.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ValueDelta": { + "description": "The value of the delta.", + "type": "object", + "properties": { + "operationType": { + "description": "The operation type.", + "type": "string", + "enum": [ + "Undefined", + "Add", + "Update", + "Delete" + ], + "x-ms-enum": { + "name": "ValueDeltaOperationType", + "modelAsString": true + } + }, + "value": { + "description": "The value of the delta.", + "type": "string" + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The version of the API to be used with the client request.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ "user_impersonation" ] + } + ] +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddAlertFeedback.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddAlertFeedback.json new file mode 100644 index 000000000000..b573322a2610 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddAlertFeedback.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "alertFeedback": [ + { + "level": "Error", + "state": "Active", + "shortName": "AlertShortName", + "feeback": "Like", + "comment": "SampleComment", + "consentedToShare": false, + "serviceMemberId": "SampleServiceMemberId" + } + ] , + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "level": "Error", + "state": "Active", + "createdDate": "2018-04-30T23:28:19.6001893Z", + "shortName": "AlertShortName", + "feedback": "Like", + "comment": "SampleComment", + "consentedToShare": false, + "serviceMemberId": null + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddService.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddService.json new file mode 100644 index 000000000000..3ec7d3509e4c --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddService.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "service": { + "activeAlerts": 0, + "additionalInformation": "SampleAdditionalInformation", + "createdDate": "2017-04-07T16:03:06.9053139Z", + "customNotificationEmails": [ + "email1", + "email2" + ], + "disabled": false, + "displayName": "sample display name", + "health": "Healthy", + "lastDisabled": "2017-05-07T16:03:06.9053139Z", + "lastUpdated": "2018-04-30T00:55:33.5799677Z", + "monitoringConfigurationsComputed": "samplemonitoringConfig", + "monitoringConfigurationsCustomized": "samplemonitoringConfig", + "notificationEmailEnabled": true, + "notificationEmailEnabledForGlobalAdmins": true, + "notificationEmails": [ + "email3", + "email4" + ], + "notificationEmailsEnabledForGlobalAdmins": false, + "resolvedAlerts": 0, + "serviceId": "12345678-1234-1234-1234-123456789000", + "serviceName": "sampleServiceName", + "signature": "SampleSignature", + "simpleProperties": null, + "tenantId": "12345678-1234-1234-1234-123456789000", + "type": "AadSyncService", + "originalDisabledState": false, + "id": "ServiceId" + }, + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "activeAlerts": 0, + "additionalInformation": "SampleAdditionalInformation", + "createdDate": "2017-04-07T16:03:06.9053139Z", + "customNotificationEmails": [ + "email1", + "email2" + ], + "disabled": false, + "displayName": "sample display name", + "health": "Healthy", + "lastDisabled": "2017-05-07T16:03:06.9053139Z", + "lastUpdated": "2018-04-30T00:55:33.5799677Z", + "monitoringConfigurationsComputed": "samplemonitoringConfig", + "monitoringConfigurationsCustomized": "samplemonitoringConfig", + "notificationEmailEnabled": true, + "notificationEmailEnabledForGlobalAdmins": true, + "notificationEmails": [ + "email3", + "email4" + ], + "notificationEmailsEnabledForGlobalAdmins": false, + "resolvedAlerts": 0, + "serviceId": "12345678-1234-1234-1234-123456789000", + "serviceName": "sampleServiceName", + "signature": "SampleSignature", + "simpleProperties": null, + "tenantId": "12345678-1234-1234-1234-123456789000", + "type": "AadSyncService", + "originalDisabledState": false, + "id": "ServiceId" + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddServiceMembers.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddServiceMembers.json new file mode 100644 index 000000000000..152248f39c5c --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddServiceMembers.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMember": { + "lastReboot": "2018-04-28T11:33:07.484Z", + "lastDisabled": "2018-04-28T23:17:00.511864Z", + "lastUpdated": "2018-05-01T00:15:32.5476494Z", + "activeAlerts": 0, + "resolvedAlerts": 0, + "createdDate": "2018-04-28T23:17:00.511864Z", + "disabled": false, + "dimensions": [ + { + "key": "key1", + "value": "value1" + } + ], + "additionalInformation": "SampleAdditionalInformation", + "tenantId": "SampleTenantId", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId", + "machineId": "SampleMachineId", + "machineName": "SampleMachineName", + "role": "AdfsServer_30", + "status": "Healthy", + "properties": [ + { + "key": "key1", + "value": "value1" + } + ], + "installedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "recommendedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "monitoringConfigurationsComputed": [ + { + "key": "key1", + "value": "value1" + } + ], + "monitoringConfigurationsCustomized": [ + { + "key": "key1", + "value": "value1" + } + ], + "osVersion": "osVersion", + "osName": "osName", + "disabledReason": 0, + "serverReportedMonitoringLevel": "Off", + "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" + }, + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "lastReboot": "2018-04-28T11:33:07.484Z", + "lastDisabled": "2018-04-28T23:17:00.511864Z", + "lastUpdated": "2018-05-01T00:15:32.5476494Z", + "activeAlerts": 0, + "resolvedAlerts": 0, + "createdDate": "2018-04-28T23:17:00.511864Z", + "disabled": false, + "dimensions": [ + { + "key": "key1", + "value": "value1" + } + ], + "additionalInformation": "SampleAdditionalInformation", + "tenantId": "SampleTenantId", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId", + "machineId": "SampleMachineId", + "machineName": "SampleMachineName", + "role": "AdfsServer_30", + "status": "Healthy", + "properties": [ + { + "key": "key1", + "value": "value1" + } + ], + "installedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "recommendedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "monitoringConfigurationsComputed": [ + { + "key": "key1", + "value": "value1" + } + ], + "monitoringConfigurationsCustomized": [ + { + "key": "key1", + "value": "value1" + } + ], + "osVersion": "osVersion", + "osName": "osName", + "disabledReason": 0, + "serverReportedMonitoringLevel": "Off", + "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddUserPreference.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddUserPreference.json new file mode 100644 index 000000000000..24fcb7eeba6f --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddUserPreference.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "featureName": "SampleFeatureName", + "setting": [ + { + "metricNames": [ + "UserPreference1", + "UserPreference2" + ] + } + ], + "api-version": "2014-01-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddomainServiceMembers.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddomainServiceMembers.json new file mode 100644 index 000000000000..c48d90f0e049 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddomainServiceMembers.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "isGroupbySite": true, + "takeCount": "1", + "nextPartitionKey": " ", + "nextRowKey": " ", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "domainName": "sampleDomainName", + "siteName": "Default-First-Site-Name", + "addsRoles": [ + "sampleRole" + ], + "gcReachable": true, + "isAdvertising": true, + "pdcReachable": true, + "sysvolState": true, + "dcTypes": [ + "GC" + ], + "lastReboot": "2018-04-28T23:17:00.511864Z", + "lastDisabled": "2018-04-28T23:17:00.511864Z", + "lastUpdated": "2018-04-30T18:00:41.6956022Z", + "activeAlerts": 0, + "resolvedAlerts": 0, + "createdDate": "2018-04-28T23:17:00.511864Z", + "disabled": false, + "dimensions": [ + { + "key": "key1", + "value": "value1" + } + ], + "additionalInformation": "SampleAdditionalInformation", + "tenantId": "00000000-0000-0000-0000-000000000000", + "serviceId": "serviceIdGuid", + "serviceMemberId": "ServiceMemberIdGuid", + "machineId": "machineIdGuid", + "machineName": "sampleMachineName", + "role": "SampleRole", + "status": "Healthy", + "properties": [ + { + "key": "key1", + "value": "value1" + } + ], + "installedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "recommendedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "monitoringConfigurationsComputed": [ + { + "key": "key1", + "value": "value1" + } + ], + "monitoringConfigurationsCustomized": [ + { + "key": "key1", + "value": "value1" + } + ], + "osVersion": "osVersion", + "osName": "osName", + "disabledReason": 0, + "serverReportedMonitoringLevel": "Off", + "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddsConfiguration.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddsConfiguration.json new file mode 100644 index 000000000000..bd7df1660aa4 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddsConfiguration.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "SampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "Forest name", + "value": "SampleForestName" + }, + { + "key": "Functional Level", + "value": "Sample Functional Level." + } + ], + "nextLink": null, + "totalCount": 1, + "continuationToken": null + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddsServiceMembers.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddsServiceMembers.json new file mode 100644 index 000000000000..979c896780ee --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddsServiceMembers.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "domainName": "sampleDomainName", + "siteName": "Default-First-Site-Name", + "addsRoles": [ + "sampleRole" + ], + "gcReachable": true, + "isAdvertising": true, + "pdcReachable": true, + "sysvolState": true, + "dcTypes": [ + "GC" + ], + "lastReboot": "2018-04-28T23:17:00.511864Z", + "lastDisabled": "2018-04-28T23:17:00.511864Z", + "lastUpdated": "2018-04-30T18:00:41.6956022Z", + "activeAlerts": 0, + "resolvedAlerts": 0, + "createdDate": "2018-04-28T11:33:07.484Z", + "disabled": false, + "dimensions": [ + { + "key": "key1", + "value": "value1" + } + ], + "additionalInformation": "SampleAdditionalInformation", + "tenantId": "00000000-0000-0000-0000-000000000000", + "serviceId": "serviceIdGuid", + "serviceMemberId": "ServiceMemberIdGuid", + "machineId": "machineIdGuid", + "machineName": "sampleMachineName", + "role": "SampleRole", + "status": "Healthy", + "properties": [ + { + "key": "key1", + "value": "value1" + } + ], + "installedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "recommendedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "monitoringConfigurationsComputed": [ + { + "key": "key1", + "value": "value1" + } + ], + "monitoringConfigurationsCustomized": [ + { + "key": "key1", + "value": "value1" + } + ], + "osVersion": "osVersion", + "osName": "osName", + "disabledReason": 0, + "serverReportedMonitoringLevel": "Off", + "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Alerts.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Alerts.json new file mode 100644 index 000000000000..416e472d17bb --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Alerts.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "state": "Active", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "alertId": "SampleAlertId", + "level": "Error", + "state": "Active", + "shortName": "SampleAlertName", + "displayName": "SampleAlertDisplayName", + "description": "SampleAlertDescription", + "remediation": "SampleAlertRemediation", + "relatedLinks": [ + { + "title": "SampleTitle1", + "url": "SampleUrl1" + }, + { + "title": "SampleTilte2", + "url": "SampleUrl2" + } + ], + "scope": "SampleScope", + "additionalInformation": [ + { + "titleName": "SampleAdditionalInfo", + "titleValue": "SampleTitle", + "properties": [ + { + "key": "Property1", + "value": "Value1" + }, + { + "key": "Property2", + "value": "Value2" + } + ], + "hasProperties": true + } + ], + "createdDate": "2018-04-10T03:12:23.4408944Z", + "resolvedDate": "2018-04-10T03:12:23.4408944Z", + "lastUpdated": "2018-04-30T19:24:42.1946017Z", + "monitorRoleType": "SampleRole", + "activeAlertProperties": [ + { + "key": "ActiveProperty1", + "value": "Value1" + } + ], + "resolvedAlertProperties": [ + { + "key": "ResolvedProperty1", + "value": "Value1" + } + ], + "tenantId": "SampleTenantId", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/BadPasswordDetails.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/BadPasswordDetails.json new file mode 100644 index 000000000000..9fef3b89e159 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/BadPasswordDetails.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "userId": "SampleUser1", + "ipAddress": "SampleIPAddress", + "lastUpdated": "2018-04-25T14:39:18.3555285Z", + "uniqueIpAddresses": "SampleUniqueIPAddresses", + "totalErrorAttempts": 10 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/CheckFeatureAvailibility.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/CheckFeatureAvailibility.json new file mode 100644 index 000000000000..0ce1a40c049c --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/CheckFeatureAvailibility.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "featureName": "SampleFeatureName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": true + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Connectors.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Connectors.json new file mode 100644 index 000000000000..4ee3d644e30c --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Connectors.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "SampleId", + "name": "SampleName", + "version": 12418, + "type": "SampleType", + "description": "SampleDescription", + "schemaXml": "SampleSchema", + "passwordManagementSettings": { + "enabled": true, + "extensionFilePath": "SampleFilePath", + "connectTo": "SampleConnectTo", + "connectionTimeout": 24, + "user": "SampleUser", + "supportedPasswordOperations": "Undefined", + "maximumRetryCount": 10, + "retryIntervalInSeconds": 20, + "requiresSecureConnection": true, + "unlockAccount": true + }, + "passwordHashSyncConfiguration": { + "enabled": true, + "target": "SampleTarget" + }, + "timeCreated": "2017-08-04T19:07:02.957Z", + "timeLastModified": "2018-05-03T23:08:25.273Z", + "partitions": [ + { + "id": "SampleId", + "dn": "SampleDN", + "enabled": false, + "timeCreated": "2017-08-04T19:07:34.903Z", + "timeLastModified": "2018-05-03T23:08:25.273+00:00", + "partitionScope": { + "isDefault": false, + "objectClasses": [ + "SampleClass" + ], + "containersIncluded": [ + "SampleContainer" + ], + "containersExcluded": [ + "SampleContainer1" + ] + }, + "name": "SampleName", + "isDomain": true, + "type": "AD" + }, + { + "id": "SampleId2", + "dn": "SampleDN", + "enabled": true, + "timeCreated": "2017-08-04T19:07:34.97Z", + "timeLastModified": "2018-05-03T23:08:25.273+00:00", + "partitionScope": { + "isDefault": false, + "objectClasses": [ + "sampleClass" + ], + "containersIncluded": [ + "SampleContainer" + ], + "containersExcluded": [ + "SampleContainer1" + ] + }, + "name": "SampleName", + "isDomain": true, + "type": "AD" + } + ], + "runProfiles": [ + { + "id": "SampleId", + "name": "Full Import", + "runSteps": [ + { + "batchSize": 50, + "objectProcessLimit": 0, + "objectDeleteLimit": 0, + "pageSize": 500, + "partitionId": "SamplePartitionId", + "operationType": 1, + "timeout": 120 + } + ] + } + ], + "connectorId": "SampleConnectorId" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Credentials.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Credentials.json new file mode 100644 index 000000000000..1c6ba5ad14f4 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Credentials.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "credentialData": [ + "SampleCredentialData", + "SampleCredentialData1" + ], + "identifier": "SampleIdentifier", + "type": "SampleType" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Datafreshness.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Datafreshness.json new file mode 100644 index 000000000000..1ad2374a08ba --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Datafreshness.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "DataFreshnessKeyName", + "value": "2015-03-06T17:41:34.305Z" + } + ] + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteServer.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteServer.json new file mode 100644 index 000000000000..bbb11ed8bc78 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteServer.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "serviceName": "SampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteService.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteService.json new file mode 100644 index 000000000000..f5e15734edb6 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteService.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "serviceName": "SampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteUserPreference.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteUserPreference.json new file mode 100644 index 000000000000..cea5b2d2a2bc --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteUserPreference.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "featureName": "SampleFeatureName", + "api-version": "2014-01-01" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DevOps.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DevOps.json new file mode 100644 index 000000000000..1e16d8dd32e7 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DevOps.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": true + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Dimensions.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Dimensions.json new file mode 100644 index 000000000000..5cea123a3b1d --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Dimensions.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "dimension": "SmapleDimension", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "displayName": "sampleDisplayName", + "signature": "sampleSignature", + "type": "addsdomain", + "health": "Healthy", + "activeAlerts": 0, + "resolvedAlerts": 0, + "lastUpdated": "2018-04-09T23:55:51.0067357Z", + "simpleProperties": [ + { + "key": "Domain Functional Level", + "value": "Value1" + }, + { + "key": "Forest", + "value": "Value1" + }, + { + "key": "Infrastructure Master", + "value": "Value1" + }, + { + "key": "PDC", + "value": "Value1" + }, + { + "key": "RID Master", + "value": "Value1" + } + ], + "additionalInformation": "AdditionInformation1" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ErrorCounts.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ErrorCounts.json new file mode 100644 index 000000000000..47ce1fdb5b5a --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ErrorCounts.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "serviceName": "SampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "errorBucket": "DuplicateAttributeError", + "count": 49, + "truncated": false + }, + { + "errorBucket": "DataMismatch", + "count": 0, + "truncated": false + }, + { + "errorBucket": "DataValidationError", + "count": 0, + "truncated": false + }, + { + "errorBucket": "LargeAttribute", + "count": 0, + "truncated": false + }, + { + "errorBucket": "FederatedDomainChange", + "count": 0, + "truncated": false + }, + { + "errorBucket": "Others", + "count": 0, + "truncated": false + }, + { + "errorBucket": "All", + "count": 49, + "truncated": false + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ExportErrors.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ExportErrors.json new file mode 100644 index 000000000000..61442ed7c22b --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ExportErrors.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "runstepresultid": "SampleRunStepResultId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "errorbucket": "SampleErrorBucket", + "count": 10, + "truncated": true + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ExportStatus.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ExportStatus.json new file mode 100644 index 000000000000..8cfaec524971 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ExportStatus.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "serviceId": "sampleServiceId", + "serviceMemberId": "SampleServiceMemberId", + "endTime": "2018-04-30T23:04:37.647Z", + "runStepResultId": "SampleRunStepId" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ForestSummary.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ForestSummary.json new file mode 100644 index 000000000000..6249725dabe0 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ForestSummary.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "forestName": "sampleForestName", + "domainCount": 1, + "siteCount": 1, + "monitoredDcCount": 1, + "totalDcCount": 1, + "domains": [ + "sampledomain" + ], + "sites": [ + "Default-First-Site-Name" + ] + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/GetAlertFeedback.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/GetAlertFeedback.json new file mode 100644 index 000000000000..3daf3db02e56 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/GetAlertFeedback.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "shortName": "AlertShortName" , + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "level": "Error", + "state": "Active", + "createdDate": "2018-04-30T23:28:19.6001893Z", + "shortName": "AlertShortName", + "feedback": "Like", + "comment": "SampleComment", + "consentedToShare": false, + "serviceMemberId": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/GlobalConfiguration.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/GlobalConfiguration.json new file mode 100644 index 000000000000..0638dea4eb87 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/GlobalConfiguration.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "featureSet": [ + { + "key": "faturekey1", + "value": "value1" + } + ], + "numSavedPwdEvent": 0, + "passwordSyncEnabled": false, + "schemaXml": "SampleSchemaXML", + "version": 12 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MergedExportErrors.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MergedExportErrors.json new file mode 100644 index 000000000000..ede4242bd447 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MergedExportErrors.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "serviceName": "SampleName", + "errorBucket": "SampleErrorBucket", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "incomingObjectDisplayName": "SampleIncomingDisplayName", + "incomingObjectType": "user", + "userPrincipalName": "SampleUPN", + "type": "AttributeValueMustBeUnique", + "attributeName": "OnPremiseSecurityIdentifier", + "attributeValue": "System.Byte[]", + "timeOccurred": "2018-04-30T22:04:36.043Z", + "timeFirstOccurred": "2017-07-11T18:36:15.843Z", + "csObjectId": "SampleObjectId", + "dn": "CN=SampleDN", + "incomingObject": { + "displayName": "SampleDisplayName", + "distinguishedName": "SampelDN", + "lastDirSyncTime": "2016-06-02T18:41:59Z", + "mail": "SampleMail", + "objectGuid": "SampleObjectGuid", + "objectType": "user", + "onpremisesUserPrincipalName": "SampleUPN1", + "proxyAddresses": "SampleProxyAddress", + "sourceAnchor": "SampleSourceAnchor", + "sourceOfAuthority": "Unknown", + "timeOccurred": "2018-04-30T22:04:36.043Z", + "userPrincipalName": "SampleUPN" + }, + "existingObject": { + "displayName": "SampleDisplayName", + "distinguishedName": "SampleDistinguishedName", + "lastDirSyncTime": "2016-06-02T18:41:59Z", + "mail": "SampleEmail", + "objectGuid": "SampleObjectGuid", + "objectType": "User", + "onpremisesUserPrincipalName": "OnPremUPN", + "proxyAddresses": "SampleProxyAddress", + "sourceAnchor": "SampleSourceAnchor", + "sourceOfAuthority": "Active Directory", + "timeOccurred": "0001-01-01T00:00:00Z", + "userPrincipalName": "SampleUPN" + }, + "modifiedOrRemovedAttributeValue": "SampleValue", + "runStepResultId": "SampleRunStepId", + "samAccountName": "SampleSAMAccountName", + "serverErrorDetail": "SampleErrorDetails", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId", + "id": "SampleMergedExportErrorId", + "mergedEntityId": "SampleMergedEntityId", + "createdDate": "2018-04-30T22:13:47.6380995Z", + "exportErrorStatus": 1 + } + ] + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricMetadata.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricMetadata.json new file mode 100644 index 000000000000..e061ed80aac4 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricMetadata.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "SampleName", + "metricName": "SampleMetricName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "metricsProcessorClassName": "SampleMetricsProcessorClassName1", + "metricName": "SampleMetricName", + "groupings": [ + { + "key": "SampleKey", + "displayName": "SampleDisplayName", + "invisibleForUi": false + } + ], + "displayName": "SampleDisplayName", + "valueKind": "Value", + "minValue": 0, + "maxValue": 0, + "kind": "Line", + "isDefault": false, + "isPerfCounter": false, + "isDevOps": false + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricMetadataList.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricMetadataList.json new file mode 100644 index 000000000000..6cf99c1fc013 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricMetadataList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "SampleName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricsProcessorClassName": "SampleMetricsProcessorClassName1", + "metricName": "SampleMetricName", + "groupings": [ + { + "key": "SampleKey", + "displayName": "SampleDisplayName", + "invisibleForUi": false + } + ], + "displayName": "SampleDisplayName", + "valueKind": "Value", + "minValue": 0, + "maxValue": 0, + "kind": "Line", + "isDefault": false, + "isPerfCounter": false, + "isDevOps": false + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricSets.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricSets.json new file mode 100644 index 000000000000..c253c6f6adf6 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricSets.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "serviceName": "SampleName", + "groupName": "SampleGroupName", + "metricName": "SamplemetricName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "sets": [ + { + "setName": "SampleSetName", + "values": [ + null, + null, + null, + null, + null, + null, + null, + null, + null, + null, + 5.0, + 8.0, + 3.0, + 3.0, + 12.0, + 7.0, + 7.0, + 10.0, + null, + 1.0, + 1.0, + 2.0, + 2.0, + null + ] + } + ], + "timeStamps": [ + "2018-04-29T22:00:00Z", + "2018-04-29T23:00:00Z", + "2018-04-30T00:00:00Z", + "2018-04-30T01:00:00Z", + "2018-04-30T02:00:00Z", + "2018-04-30T03:00:00Z", + "2018-04-30T04:00:00Z", + "2018-04-30T05:00:00Z", + "2018-04-30T06:00:00Z", + "2018-04-30T07:00:00Z", + "2018-04-30T08:00:00Z", + "2018-04-30T09:00:00Z", + "2018-04-30T10:00:00Z", + "2018-04-30T11:00:00Z", + "2018-04-30T12:00:00Z", + "2018-04-30T13:00:00Z", + "2018-04-30T14:00:00Z", + "2018-04-30T15:00:00Z", + "2018-04-30T16:00:00Z", + "2018-04-30T17:00:00Z", + "2018-04-30T18:00:00Z", + "2018-04-30T19:00:00Z", + "2018-04-30T20:00:00Z", + "2018-04-30T21:00:00Z" + ] + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Metrics.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Metrics.json new file mode 100644 index 000000000000..0a9d5653b524 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Metrics.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "SampleName", + "metricName": "SampleMetricName", + "groupName": "SampleGroupName", + "metricsName": "SampleMetricName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "Key1", + "value": "Value1" + }, + { + "key": "Key2", + "value": "Value2" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } + } + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MonitoringConfigurations.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MonitoringConfigurations.json new file mode 100644 index 000000000000..ad283c422a0d --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MonitoringConfigurations.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "SampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "MonitoringLevel", + "value": "Partial" + }, + { + "key": "StagingMode", + "value": "" + }, + { + "key": "ConfigurationUploadInterval", + "value": "240" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/OperationList.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/OperationList.json new file mode 100644 index 000000000000..4dbc1b4eecf7 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/OperationList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ADHybridHealthService_Sample_Operation", + "display": { + "description": "Sample description", + "operation": "Sample operation", + "provider": "Microsoft ADHybridHealthService", + "resource": "Sample Resource" + } + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/PatchMonitoringConfiguration.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/PatchMonitoringConfiguration.json new file mode 100644 index 000000000000..733e515c3fad --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/PatchMonitoringConfiguration.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "serviceName": "SampleServiceName", + "configurationSetting": { + "key": "key1", + "value": "Value1" + }, + "api-version": "2014-01-01" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/PatchTenant.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/PatchTenant.json new file mode 100644 index 000000000000..371ade172f52 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/PatchTenant.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "tenant": [ + { + "agentAutoUpdate": false + } + ], + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "tenantId": "sampleTenantId", + "tenantName": "SampleTenantName", + "initialDomain": "tenantInitialDomain", + "devOpsTtl": "0001-01-01T00:00:00Z", + "countryLetterCode": "tenantCountryLetterCode", + "createdDate": "2015-03-06T20:35:04.0018068Z", + "pksCertificate": "SamplePKSCertificate", + "disabled": false, + "lastDisabled": "0001-01-01T00:00:00Z", + "lastVerified": "0001-01-01T00:00:00Z", + "aadLicense": "Premium", + "onboardingAllowed": true, + "onboarded": true, + "privatePreviewTenant": false, + "consentedToMicrosoftDevOps": true, + "alertSuppressionTimeInMins": 4320, + "aadPremium": true, + "globalAdminsEmail": [ + "email1", + "email2" + ], + "agentAutoUpdate": true, + "disabledReason": 0, + "tenantInQuarantine": false + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationDetails.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationDetails.json new file mode 100644 index 000000000000..36568b3b4bc3 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationDetails.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "SampleName", + "query": "SampleQuery", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "targetServer": "SampleTargetServerName", + "site": "Domain-Controllers", + "domain": "SampleDomainName", + "status": 0, + "lastAttemptedSync": "2018-04-30T21:40:10Z", + "lastSuccessfulSync": "2018-04-30T21:40:10Z", + "inboundNeighborCollection": [ + { + "sourceDomainController": "SampleSourceDomainName", + "consecutiveFailureCount": 0, + "namingContext": "SampleNamingContext", + "status": 0, + "lastAttemptedSync": "2018-04-30T21:39:45+00:00", + "lastSuccessfulSync": "2018-04-30T21:39:45+00:00", + "lastErrorCode": 0, + "lastErrorMessage": "The operation completed successfully.\r\n", + "errorTitle": "SampleErrorTitle", + "errorDescription": "SampleErrorDescription", + "fixLink": "SampleFixLink", + "fixDetails": "SampleFixDescription", + "additionalInfo": "SampleAdditionalInformation" + } + ] + } + ], + "nextLink": null, + "totalCount": 1, + "continuationToken": null + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationStatus.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationStatus.json new file mode 100644 index 000000000000..51c8c2bb3665 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationStatus.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "SampleName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "forestName": "SampleForestName", + "totalDcCount": 6, + "errorDcCount": 0 + } + } + } + } + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationSummary.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationSummary.json new file mode 100644 index 000000000000..d82d6bb2c00c --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationSummary.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "SampleName", + "isGroupbySite": true, + "query": "SampleQuery", + "nextPartitionKey": " ", + "nextRowKey":" ", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "targetServer": "SampleTargetServerName", + "site": "Domain-Controllers", + "domain": "SampleDomainName", + "status": 0, + "lastAttemptedSync": "2018-04-30T21:40:10Z", + "lastSuccessfulSync": "2018-04-30T21:40:10Z", + "inboundNeighborCollection": [ + { + "sourceDomainController": "SampleSourceDomainName", + "consecutiveFailureCount": 0, + "namingContext": "SampleNamingContext", + "status": 0, + "lastAttemptedSync": "2018-04-30T21:39:45+00:00", + "lastSuccessfulSync": "2018-04-30T21:39:45+00:00", + "lastErrorCode": 0, + "lastErrorMessage": "The operation completed successfully.\r\n", + "errorTitle": "SampleErrorTitle", + "errorDescription": "SampleErrorDescription", + "fixLink": "SampleFixLink", + "fixDetails": "SampleFixDescription", + "additionalInfo": "SampleAdditionalInformation" + } + ] + } + ] + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_Alerts.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_Alerts.json new file mode 100644 index 000000000000..a2836858b7bb --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_Alerts.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "state": "Active", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "alertId": "SampleAlertId", + "level": "Error", + "state": "Active", + "shortName": "SampleAlertName", + "displayName": "SampleAlertDisplayName", + "description": "SampleAlertDescription", + "remediation": "SampleAlertRemediation", + "relatedLinks": [ + { + "title": "SampleTitle1", + "url": "SampleUrl1" + }, + { + "title": "SampleTilte2", + "url": "SampleUrl2" + } + ], + "scope": "SampleScope", + "additionalInformation": [ + { + "titleName": "SampleAdditionalInfo", + "titleValue": "SampleTitle", + "properties": [ + { + "key": "Property1", + "value": "Value1" + }, + { + "key": "Property2", + "value": "Value2" + } + ], + "hasProperties": true + } + ], + "createdDate": "2018-04-10T03:12:23.4408944Z", + "resolvedDate": "2018-04-10T03:12:23.4408944Z", + "lastUpdated": "2018-04-30T19:24:42.1945017Z", + "monitorRoleType": "SampleRole", + "activeAlertProperties": [ + { + "key": "ActiveProperty1", + "value": "Value1" + } + ], + "resolvedAlertProperties": [ + { + "key": "ActiveProperty1", + "value": "Value1" + } + ], + "tenantId": "SampleTenantId", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_ExportStatus.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_ExportStatus.json new file mode 100644 index 000000000000..3cbfd9b38dcf --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_ExportStatus.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "serviceId": "sampleServiceId", + "serviceMemberId": "SampleServiceMemberId", + "endTime": "2018-04-30T23:04:37.647Z", + "runStepResultId": "SampleRunStepId" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_MetricSets.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_MetricSets.json new file mode 100644 index 000000000000..75cff508869c --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_MetricSets.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "serviceName": "SampleName", + "groupName": "SampleGroupName", + "metricName": "SamplemetricName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "sets": [ + { + "setName": "SampleSetName", + "values": [ + null, + null, + null, + null, + null, + null, + null, + null, + null, + null, + 5.0, + 8.0, + 3.0, + 3.0, + 12.0, + 7.0, + 7.0, + 10.0, + null, + 1.0, + 1.0, + 2.0, + 2.0, + null + ] + } + ], + "timeStamps": [ + "2018-04-29T22:00:00Z", + "2018-04-29T23:00:00Z", + "2018-04-30T00:00:00Z", + "2018-04-30T01:00:00Z", + "2018-04-30T02:00:00Z", + "2018-04-30T03:00:00Z", + "2018-04-30T04:00:00Z", + "2018-04-30T05:00:00Z", + "2018-04-30T06:00:00Z", + "2018-04-30T07:00:00Z", + "2018-04-30T08:00:00Z", + "2018-04-30T09:00:00Z", + "2018-04-30T10:00:00Z", + "2018-04-30T11:00:00Z", + "2018-04-30T12:00:00Z", + "2018-04-30T13:00:00Z", + "2018-04-30T14:00:00Z", + "2018-04-30T15:00:00Z", + "2018-04-30T16:00:00Z", + "2018-04-30T17:00:00Z", + "2018-04-30T18:00:00Z", + "2018-04-30T19:00:00Z", + "2018-04-30T20:00:00Z", + "2018-04-30T21:00:00Z" + ] + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Service.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Service.json new file mode 100644 index 000000000000..1204d27e1ff5 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Service.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "activeAlerts": 0, + "additionalInformation": "SampleAdditionalInformation", + "createdDate": "2017-04-07T16:03:06.9053139Z", + "customNotificationEmails": [ + "email1", + "email2" + ], + "disabled": false, + "displayName": "sample display name", + "health": "Healthy", + "lastDisabled": "2017-05-07T16:03:06.9053139Z", + "lastUpdated": "2018-04-30T00:55:33.5799677Z", + "monitoringConfigurationsComputed": "samplemonitoringConfig", + "monitoringConfigurationsCustomized": "samplemonitoringConfig", + "notificationEmailEnabled": true, + "notificationEmailEnabledForGlobalAdmins": true, + "notificationEmails": [ + "email3", + "email4" + ], + "notificationEmailsEnabledForGlobalAdmins": false, + "resolvedAlerts": 0, + "serviceId": "12345678-1234-1234-1234-123456789000", + "serviceName": "sampleServiceName", + "signature": "SampleSignature", + "simpleProperties": null, + "tenantId": "12345678-1234-1234-1234-123456789000", + "type": "AadSyncService", + "originalDisabledState": false, + "id": "ServiceId" + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceConfiguration.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceConfiguration.json new file mode 100644 index 000000000000..2f24f3d25b5a --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceConfiguration.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "version": "1.1.750.0", + "serviceType": 1, + "serviceAccount": "SampleServiceAccount", + "sqlServer": "SQLServerName", + "sqlVersion": "unknown", + "sqlEdition": "unknown", + "sqlInstance": "", + "sqlDatabaseName": "SQLDBName", + "sqlDatabaseSize": 0 + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceMember.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceMember.json new file mode 100644 index 000000000000..e9400c120928 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceMember.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "lastReboot": "2018-04-28T11:33:07.484Z", + "lastDisabled": "2018-04-28T23:17:00.511864Z", + "lastUpdated": "2018-05-01T00:15:32.5476494Z", + "activeAlerts": 0, + "resolvedAlerts": 0, + "createdDate": "2018-04-28T11:33:07.484Z", + "disabled": false, + "dimensions": [ + { + "key": "key1", + "value": "value1" + } + ], + "additionalInformation": "SampleAdditionalInformation", + "tenantId": "SampleTenantId", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId", + "machineId": "SampleMachineId", + "machineName": "SampleMachineName", + "role": "AdfsServer_30", + "status": "Healthy", + "properties": [ + { + "key": "key1", + "value": "value1" + } + ], + "installedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "recommendedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "monitoringConfigurationsComputed": [ + { + "key": "key1", + "value": "value1" + } + ], + "monitoringConfigurationsCustomized": [ + { + "key": "key1", + "value": "value1" + } + ], + "osVersion": "SampleOSVersion", + "osName": "SampleOSName", + "disabledReason": 0, + "serverReportedMonitoringLevel": "Off", + "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceMembers.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceMembers.json new file mode 100644 index 000000000000..c5f1b176845f --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceMembers.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "lastReboot": "2018-04-28T11:33:07.484Z", + "lastDisabled": "2018-04-28T23:17:00.511864Z", + "lastUpdated": "2018-05-01T00:15:32.5476494Z", + "activeAlerts": 0, + "resolvedAlerts": 0, + "createdDate": "2018-04-28T11:33:07.484Z", + "disabled": false, + "dimensions": [ + { + "key": "key1", + "value": "value1" + } + ], + "additionalInformation": "SampleAdditionalInformation", + "tenantId": "SampleTenantId", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId", + "machineId": "SampleMachineId", + "machineName": "SampleMachineName", + "role": "AdfsServer_30", + "status": "Healthy", + "properties": [ + { + "key": "key1", + "value": "value1" + } + ], + "installedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "recommendedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "monitoringConfigurationsComputed": [ + { + "key": "key1", + "value": "value1" + } + ], + "monitoringConfigurationsCustomized": [ + { + "key": "key1", + "value": "value1" + } + ], + "osVersion": "SampleOSVersion", + "osName": "SampleOSName", + "disabledReason": 0, + "serverReportedMonitoringLevel": "Off", + "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Service_MetricSets.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Service_MetricSets.json new file mode 100644 index 000000000000..75cff508869c --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Service_MetricSets.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "serviceName": "SampleName", + "groupName": "SampleGroupName", + "metricName": "SamplemetricName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "sets": [ + { + "setName": "SampleSetName", + "values": [ + null, + null, + null, + null, + null, + null, + null, + null, + null, + null, + 5.0, + 8.0, + 3.0, + 3.0, + 12.0, + 7.0, + 7.0, + 10.0, + null, + 1.0, + 1.0, + 2.0, + 2.0, + null + ] + } + ], + "timeStamps": [ + "2018-04-29T22:00:00Z", + "2018-04-29T23:00:00Z", + "2018-04-30T00:00:00Z", + "2018-04-30T01:00:00Z", + "2018-04-30T02:00:00Z", + "2018-04-30T03:00:00Z", + "2018-04-30T04:00:00Z", + "2018-04-30T05:00:00Z", + "2018-04-30T06:00:00Z", + "2018-04-30T07:00:00Z", + "2018-04-30T08:00:00Z", + "2018-04-30T09:00:00Z", + "2018-04-30T10:00:00Z", + "2018-04-30T11:00:00Z", + "2018-04-30T12:00:00Z", + "2018-04-30T13:00:00Z", + "2018-04-30T14:00:00Z", + "2018-04-30T15:00:00Z", + "2018-04-30T16:00:00Z", + "2018-04-30T17:00:00Z", + "2018-04-30T18:00:00Z", + "2018-04-30T19:00:00Z", + "2018-04-30T20:00:00Z", + "2018-04-30T21:00:00Z" + ] + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Services.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Services.json new file mode 100644 index 000000000000..ba2b4e9e83aa --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Services.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "activeAlerts": 0, + "additionalInformation": "SampleAdditionalInformation", + "createdDate": "2017-04-07T16:03:06.9053139Z", + "customNotificationEmails": [ + "email1", + "email2" + ], + "disabled": false, + "displayName": "sample display name", + "health": "Healthy", + "lastDisabled": "2017-05-07T16:03:06.9053139Z", + "lastUpdated": "2018-04-30T00:55:33.5799677Z", + "monitoringConfigurationsComputed": "samplemonitoringConfig", + "monitoringConfigurationsCustomized": "samplemonitoringConfig", + "notificationEmailEnabled": true, + "notificationEmailEnabledForGlobalAdmins": true, + "notificationEmails": [ + "email3", + "email4" + ], + "notificationEmailsEnabledForGlobalAdmins": false, + "resolvedAlerts": 0, + "serviceId": "12345678-1234-1234-1234-123456789000", + "serviceName": "sampleServiceName", + "signature": "SampleSignature", + "simpleProperties": null, + "tenantId": "12345678-1234-1234-1234-123456789000", + "type": "AadSyncService", + "originalDisabledState": false, + "id": "/providers/Microsoft.ADHybridHealthService/services/GetServices/PremiumCheck" + } + ], + "nextLink": null, + "totalCount": 1, + "continuationToken": null + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Tenant.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Tenant.json new file mode 100644 index 000000000000..04c2d1147186 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Tenant.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "tenantId": "sampleTenantId", + "tenantName": "SampleTenantName", + "initialDomain": "tenantInitialDomain", + "devOpsTtl": "0001-01-01T00:00:00Z", + "countryLetterCode": "tenantCountryLetterCode", + "createdDate": "2015-03-06T20:35:04.0018068Z", + "pksCertificate": "SamplePKSCertificate", + "disabled": false, + "lastDisabled": "0001-01-01T00:00:00Z", + "lastVerified": "0001-01-01T00:00:00Z", + "aadLicense": "Premium", + "onboardingAllowed": true, + "onboarded": true, + "privatePreviewTenant": false, + "consentedToMicrosoftDevOps": true, + "alertSuppressionTimeInMins": 4320, + "aadPremium": true, + "globalAdminsEmail": [ + "email1", + "email2" + ], + "agentAutoUpdate": true, + "disabledReason": 0, + "tenantInQuarantine": false + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/TenantWhitelisting.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/TenantWhitelisting.json new file mode 100644 index 000000000000..0ce1a40c049c --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/TenantWhitelisting.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "featureName": "SampleFeatureName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": true + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UpdateService.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UpdateService.json new file mode 100644 index 000000000000..5c74b064819b --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UpdateService.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "service": [ + { + "notificationEmailEnabled": true, + "notificationEmailEnabledForGlobalADmins": true + } + ], + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "activeAlerts": 0, + "additionalInformation": "SampleAdditionalInformation", + "createdDate": "2017-04-07T16:03:06.9053139Z", + "customNotificationEmails": [ + "email1", + "email2" + ], + "disabled": false, + "displayName": "sample display name", + "health": "Healthy", + "lastDisabled": "2017-05-07T16:03:06.9053139Z", + "lastUpdated": "2018-04-30T00:55:33.5799677Z", + "monitoringConfigurationsComputed": "samplemonitoringConfig", + "monitoringConfigurationsCustomized": "samplemonitoringConfig", + "notificationEmailEnabled": true, + "notificationEmailEnabledForGlobalAdmins": true, + "notificationEmails": [ + "email3", + "email4" + ], + "notificationEmailsEnabledForGlobalAdmins": false, + "resolvedAlerts": 0, + "serviceId": "12345678-1234-1234-1234-123456789000", + "serviceName": "sampleServiceName", + "signature": "SampleSignature", + "simpleProperties": null, + "tenantId": "12345678-1234-1234-1234-123456789000", + "type": "AadSyncService", + "originalDisabledState": false, + "id": "/providers/Microsoft.ADHybridHealthService/services/GetServices/PremiumCheck/sampleServiceName" + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UpdateTenant.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UpdateTenant.json new file mode 100644 index 000000000000..d662a3048e8c --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UpdateTenant.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "tenantId": "sampleTenantId", + "tenantName": "SampleTenantName", + "initialDomain": "tenantInitialDomain", + "devOpsTtl": "0001-01-01T00:00:00Z", + "countryLetterCode": "tenantCountryLetterCode", + "createdDate": "2015-03-06T20:35:04.0018068Z", + "pksCertificate": "SamplePKSCertificate", + "disabled": false, + "lastDisabled": "0001-01-01T00:00:00Z", + "lastVerified": "0001-01-01T00:00:00Z", + "aadLicense": "Premium", + "onboardingAllowed": true, + "onboarded": true, + "privatePreviewTenant": false, + "consentedToMicrosoftDevOps": true, + "alertSuppressionTimeInMins": 4320, + "aadPremium": true, + "globalAdminsEmail": [ + "email1", + "email2" + ], + "agentAutoUpdate": true, + "disabledReason": 0, + "tenantInQuarantine": false + } + }, + "404": {} + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UserPreference.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UserPreference.json new file mode 100644 index 000000000000..b71769319512 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UserPreference.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "sampleServiceName", + "featureName": "SampleFeatureName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "metricNames": [ + "UserPreference1", + "UserPreference2" + ] + } + } + } +} \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/readme.md b/specification/adhybridhealthservice/resource-manager/readme.md new file mode 100644 index 000000000000..0894fbe80bdd --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/readme.md @@ -0,0 +1,129 @@ +# ADHybridHealthService + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for ADHybridHealthService. + + + +--- +## Getting Started +To build the SDK for ADHybridHealthService, 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 ADHybridHealthService API. + +``` yaml +openapi-type: arm +tag: package-2014-01 +``` + + +### Tag: package-2014-01 + +These settings apply only when `--tag=package-2014-01` is specified on the command line. + +``` yaml $(tag) == 'package-2014-01' +input-file: +- Microsoft.ADHybridHealthService\stable\2014-01-01\ADHybridHealthService.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-node +``` + + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.adhybridhealthservice + package-name: azure-mgmt-adhybridhealthservice + package-version: 1.0.1 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-adhybridhealthservice/azure/mgmt/adhybridhealthservice +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-adhybridhealthservice +``` + + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: adhybridhealthservice + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2014-01 +``` + +### Tag: package-2014-01 and go + +These settings apply only when `--tag=package-2014-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2014-01' && $(go) +output-folder: $(go-sdk-folder)/services/adhybridhealthservice/mgmt/2014-01-01/adhybridhealthservice +``` + + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.adhybridhealthservice +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-adhybridhealthservice +``` diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/advisor.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/advisor.json index 7152849a9018..4cf32f6e6803 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/advisor.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/advisor.json @@ -256,8 +256,7 @@ "CreateSuppression": { "$ref": "./examples/EmptyResponse.json" } - }, - "x-ms-long-running-operation": true + } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Advisor/recommendations": { diff --git a/specification/advisor/resource-manager/readme.md b/specification/advisor/resource-manager/readme.md index 9f259ac365d2..63eeaa356fa3 100644 --- a/specification/advisor/resource-manager/readme.md +++ b/specification/advisor/resource-manager/readme.md @@ -70,7 +70,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node ``` @@ -105,6 +105,22 @@ python: ``` +## 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 + payload-flattening-threshold: 1 + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Advisor + output-folder: $(csharp-sdks-folder)/Advisor/Management.Advisor/Generated + clear-output-folder: true +``` + + ## Go These settings apply only when `--go` is specified on the command line. @@ -149,7 +165,7 @@ These settings apply only when `--tag=package-2016-07-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2016-07-preview' && $(go) -output-folder: $(go-sdk-folder)/services/advisor/mgmt/2016-07-12-preview/advisor +output-folder: $(go-sdk-folder)/services/preview/advisor/mgmt/2016-07-12-preview/advisor ``` @@ -159,11 +175,60 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.advisor +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-advisor +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-03 + - tag: package-2017-04 + - tag: package-2016-07-preview +``` + +### Tag: package-2017-03 and java + +These settings apply only when `--tag=package-2017-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-03' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.advisor - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-advisor -``` \ No newline at end of file + namespace: com.microsoft.azure.management.advisor.v2017_03_31 + output-folder: $(azure-libraries-for-java-folder)/advisor/resource-manager/v2017_03_31 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.advisor.v2017_04_19 + output-folder: $(azure-libraries-for-java-folder)/advisor/resource-manager/v2017_04_19 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-07-preview and java + +These settings apply only when `--tag=package-2016-07-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-07-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.advisor.v2016_07_12_preview + output-folder: $(azure-libraries-for-java-folder)/advisor/resource-manager/v2016_07_12_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json new file mode 100644 index 000000000000..b57a92105dc9 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json @@ -0,0 +1,1589 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-05-05-preview", + "title": "Azure Alerts Management Service Resource Provider", + "description": "REST APIs for Azure Alerts Management Service." + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.AlertsManagement/operations": { + "get": { + "operationId": "Operations_List", + "description": "List all operations available through Azure Alerts Management Resource Provider.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK. Succesfully retrieved operations list.", + "schema": { + "$ref": "#/definitions/operationsList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts": { + "get": { + "operationId": "Alerts_GetAll", + "description": "List all the existing alerts, where the results can be selective by passing multiple filter parameters including time range and sorted on specific fields. ", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/targetResource" + }, + { + "$ref": "#/parameters/targetResourceGroup" + }, + { + "$ref": "#/parameters/targetResourceType" + }, + { + "$ref": "#/parameters/monitorService" + }, + { + "$ref": "#/parameters/monitorCondition" + }, + { + "$ref": "#/parameters/severity" + }, + { + "$ref": "#/parameters/alertState" + }, + { + "$ref": "#/parameters/smartGroupIdFilter" + }, + { + "$ref": "#/parameters/includePayload" + }, + { + "$ref": "#/parameters/pageCount" + }, + { + "$ref": "#/parameters/alertsSortBy" + }, + { + "$ref": "#/parameters/sortOrder" + }, + { + "$ref": "#/parameters/timeRange" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK. Succesfully listed alert objects.", + "schema": { + "$ref": "#/definitions/alertsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListAlerts": { + "$ref": "./examples/Alerts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}": { + "get": { + "operationId": "Alerts_GetById", + "summary": "Get a specific alert.", + "description": "Get information related to a specific alert", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/alertId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. Returns the alert with the specified ID.", + "schema": { + "$ref": "#/definitions/alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "GetById": { + "$ref": "./examples/Alerts_GetbyId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate": { + "post": { + "operationId": "Alerts_ChangeState", + "description": "Change the state of the alert.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/alertId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/newState" + } + ], + "responses": { + "200": { + "description": "OK. Alert state updated.", + "schema": { + "$ref": "#/definitions/alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "Resolve": { + "$ref": "./examples/Alerts_ChangeState.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history": { + "get": { + "operationId": "Alerts_GetHistory", + "description": "Get the history of the changes of an alert.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/alertId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. Returns the list of changes of alert.", + "schema": { + "$ref": "#/definitions/alertModification" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "Resolve": { + "$ref": "./examples/Alerts_History.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alertsSummary": { + "get": { + "operationId": "Alerts_GetSummary", + "description": "Summary of alerts with the count each severity.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/targetResourceGroup" + }, + { + "$ref": "#/parameters/timeRange" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. Alert state updated.", + "schema": { + "$ref": "#/definitions/alertsSummary" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "Summary": { + "$ref": "./examples/Alerts_Summary.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups": { + "get": { + "operationId": "SmartGroups_GetAll", + "summary": "Get all smartGroups within the subscription", + "description": "List all the smartGroups within the specified subscription. ", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/targetResource" + }, + { + "$ref": "#/parameters/targetResourceGroup" + }, + { + "$ref": "#/parameters/targetResourceType" + }, + { + "$ref": "#/parameters/monitorService" + }, + { + "$ref": "#/parameters/monitorCondition" + }, + { + "$ref": "#/parameters/severity" + }, + { + "$ref": "#/parameters/smartGroupState" + }, + { + "$ref": "#/parameters/timeRange" + }, + { + "$ref": "#/parameters/pageCount" + }, + { + "$ref": "#/parameters/smartGroupsSortBy" + }, + { + "$ref": "#/parameters/sortOrder" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK. Returns list of all smartGroups.", + "schema": { + "$ref": "#/definitions/smartGroupsList", + "description": "List of smart groups in value property." + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "List": { + "$ref": "./examples/SmartGroups_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}": { + "get": { + "operationId": "SmartGroups_GetById", + "summary": "Get information of smart alerts group.", + "description": "Get details of smart group.", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/smartGroupId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. Returns the group with the specified smart group Id.", + "headers": { + "x-ms-request-id": { + "type": "string", + "description": "Service generated Request ID." + } + }, + "schema": { + "$ref": "#/definitions/smartGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "Get": { + "$ref": "./examples/SmartGroups_GetbyId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/changeState": { + "post": { + "operationId": "SmartGroups_ChangeState", + "description": "Change the state from unresolved to resolved and all the alerts within the smart group will also be resolved.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/smartGroupId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/newState" + } + ], + "responses": { + "200": { + "description": "OK. Alert state updated.", + "headers": { + "x-ms-request-id": { + "type": "string", + "description": "Service generated Request ID." + } + }, + "schema": { + "$ref": "#/definitions/smartGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "changestate": { + "$ref": "./examples/SmartGroups_ChangeState.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/history": { + "get": { + "operationId": "SmartGroups_GetHistory", + "description": "Get the history of the changes of smart group.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/smartGroupId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. Returns the list of changes of smart group.", + "schema": { + "$ref": "#/definitions/smartGroupModification" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + }, + "x-ms-examples": { + "Resolve": { + "$ref": "./examples/SmartGroups_History.json" + } + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "description": "subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "type": "string", + "in": "path", + "required": true + }, + "api-version": { + "name": "api-version", + "description": "client API version", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "2017-11-15-privatepreview", + "2018-05-05-preview" + ], + "x-ms-enum": { + "name": "api-version", + "modelAsString": true + } + }, + "alertId": { + "name": "alertId", + "description": "Unique ID of an alert object.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "targetResourceGroup": { + "description": "filter by target resource group name", + "name": "targetResourceGroup", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "targetResource": { + "description": "filter by target resource", + "name": "targetResource", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "targetResourceType": { + "description": "filter by target resource type", + "name": "targetResourceType", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "monitorService": { + "description": "filter by monitor service which is the source of the alert object.", + "name": "monitorService", + "type": "string", + "in": "query", + "required": false, + "enum": [ + "Platform", + "Application Insights", + "Log Analytics", + "Zabbix", + "SCOM", + "Nagios", + "Infrastructure Insights", + "ActivityLog Administrative", + "ActivityLog Security", + "ActivityLog Recommendation", + "ActivityLog Policy", + "ActivityLog Autoscale", + "ServiceHealth", + "SmartDetector" + ], + "x-ms-enum": { + "name": "MonitorService", + "modelAsString": true + } + }, + "severity": { + "description": "filter by severity", + "name": "severity", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "Sev0", + "Sev1", + "Sev2", + "Sev3", + "Sev4" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "smartGroupIdFilter": { + "description": "filter by smart Group Id", + "name": "smartGroupId", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "smartGroupId": { + "description": "Smart Group Id", + "name": "smartGroupId", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "newState": { + "description": "filter by state", + "name": "newState", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "enum": [ + "New", + "Acknowledged", + "Closed" + ], + "x-ms-enum": { + "name": "AlertState", + "modelAsString": true + } + }, + "alertState": { + "description": "filter by state", + "name": "alertState", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "New", + "Acknowledged", + "Closed" + ], + "x-ms-enum": { + "name": "AlertState", + "modelAsString": true + } + }, + "smartGroupState": { + "description": "filter by state", + "name": "smartGroupState", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "New", + "Acknowledged", + "Closed" + ], + "x-ms-enum": { + "name": "AlertState", + "modelAsString": true + } + }, + "monitorCondition": { + "description": "filter by monitor condition which is the state of the alert at monitor service", + "name": "monitorCondition", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "Fired", + "Resolved" + ], + "x-ms-enum": { + "name": "MonitorCondition", + "modelAsString": true + } + }, + "timeRange": { + "description": "filter by time range, default value is 1 day", + "name": "timeRange", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "1h", + "1d", + "7d", + "30d" + ], + "x-ms-enum": { + "name": "TimeRange", + "modelAsString": true + } + }, + "includePayload": { + "description": "include payload field content, default value is 'false'.", + "name": "includePayload", + "type": "boolean", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "pageCount": { + "description": "number of items per page, default value is '25'.", + "name": "pageCount", + "type": "integer", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "alertsSortBy": { + "description": "sort the query results by input field, default value is 'lastModifiedDateTime'.", + "name": "sortBy", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "name", + "severity", + "alertState", + "monitorCondition", + "targetResource", + "targetResourceName", + "targetResourceGroup", + "targetResourceType", + "startDateTime", + "lastModifiedDateTime" + ], + "x-ms-enum": { + "name": "AlertsSortByFields", + "modelAsString": true + } + }, + "smartGroupsSortBy": { + "description": "sort the query results by input field, default value is 'lastModifiedDateTime'.", + "name": "sortBy", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "alertsCount", + "state", + "severity", + "startDateTime", + "lastModifiedDateTime" + ], + "x-ms-enum": { + "name": "SmartGroupsSortByFields", + "modelAsString": true + } + }, + "sortOrder": { + "description": "sort the query results order in either ascending or descending, default value is 'desc' for time fields and 'asc' for others.", + "name": "sortOrder", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "enum": [ + "asc", + "desc" + ] + } + }, + "definitions": { + "operation": { + "description": "Operation provided by provider", + "properties": { + "name": { + "type": "string", + "description": "Name of the operation" + }, + "display": { + "type": "object", + "description": "Properties of the operation", + "properties": { + "provider": { + "type": "string", + "description": "Provider name" + }, + "resource": { + "type": "string", + "description": "Resource name" + }, + "operation": { + "type": "string", + "description": "Operation name" + }, + "description": { + "type": "string", + "description": "Description of the operation" + } + } + } + } + }, + "operationsList": { + "description": "Lists the operations available in the AlertsManagement RP.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of alerts.", + "type": "string" + }, + "value": { + "description": "Array of operations", + "type": "array", + "items": { + "$ref": "#/definitions/operation" + } + } + }, + "required": [ + "value" + ] + }, + "errorResponse": { + "description": "An error response from the service.", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/errorResponseBody" + } + } + }, + "errorResponseBody": { + "description": "Details of error response.", + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "Error code, intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "Description of the error, intended for display in user interface." + }, + "target": { + "type": "string", + "description": "Target of the particular error, for example name of the property." + }, + "details": { + "type": "array", + "description": "A list of additional details about the error.", + "items": { + "$ref": "#/definitions/errorResponseBody" + } + } + } + }, + "Resource": { + "x-ms-azure-resource": true, + "description": "An azure resource object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name" + } + } + }, + "alert": { + "description": "An alert created in alert management service.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/alertProperties", + "x-ms-client-flatten": true + } + } + }, + "alertsList": { + "description": "List the alerts.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of alerts.", + "type": "string" + }, + "value": { + "description": "List of alerts", + "type": "array", + "items": { + "$ref": "#/definitions/alert" + } + } + } + }, + "alertProperties": { + "type": "object", + "description": "An alert created in alert management service.", + "properties": { + "severity": { + "type": "string", + "description": "Severity of alert Sev1 being highest and Sev3 being lowest.", + "readOnly": true, + "enum": [ + "Sev0", + "Sev1", + "Sev2", + "Sev3", + "Sev4" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "signalType": { + "type": "string", + "description": "Log based alert or metric based alert", + "readOnly": true, + "enum": [ + "Metric", + "Log", + "Unknown" + ], + "x-ms-enum": { + "name": "SignalType", + "modelAsString": true + } + }, + "alertState": { + "type": "string", + "description": "Alert object state", + "readOnly": true, + "enum": [ + "New", + "Acknowledged", + "Closed" + ], + "x-ms-enum": { + "name": "AlertState", + "modelAsString": true + } + }, + "monitorCondition": { + "type": "string", + "description": "Condition of the rule at the monitor service", + "readOnly": true, + "enum": [ + "Fired", + "Resolved" + ], + "x-ms-enum": { + "name": "MonitorCondition", + "modelAsString": true + } + }, + "targetResource": { + "type": "string", + "description": "Target ARM resource, on which alert got created." + }, + "targetResourceName": { + "type": "string", + "description": "Target ARM resource name, on which alert got created." + }, + "targetResourceGroup": { + "type": "string", + "description": "Resource group of target ARM resource." + }, + "targetResourceType": { + "type": "string", + "description": "Resource type of target ARM resource" + }, + "monitorService": { + "type": "string", + "description": "Monitor service which is the source of the alert object.", + "readOnly": true, + "enum": [ + "Platform", + "Application Insights", + "Log Analytics", + "Infrastructure Insights", + "ActivityLog Administrative", + "ActivityLog Security", + "ActivityLog Recommendation", + "ActivityLog Policy", + "ActivityLog Autoscale", + "ServiceHealth", + "SmartDetector", + "Zabbix", + "SCOM", + "Nagios" + ], + "x-ms-enum": { + "name": "MonitorService", + "modelAsString": true + } + }, + "sourceCreatedId": { + "type": "string", + "description": "Unique Id created by monitor service", + "readOnly": true + }, + "smartGroupId": { + "type": "string", + "description": "Unique Id of the smart group", + "readOnly": true + }, + "smartGroupingReason": { + "type": "string", + "description": "Reason for addition to a smart group", + "readOnly": true + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Creation time(ISO-8601 format).", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "Last modification time(ISO-8601 format).", + "readOnly": true + }, + "lastModifiedUserName": { + "type": "string", + "description": "User who last modified the alert.", + "readOnly": true + }, + "payload": { + "type": "object", + "description": "More details which are contextual to the monitor service.", + "readOnly": true + } + } + }, + "alertModification": { + "description": "Alert Modification details", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/alertModificationProperties" + } + } + }, + "alertModificationProperties": { + "type": "object", + "description": "Properties of the alert modification item.", + "properties": { + "alertId": { + "type": "string", + "description": "Unique Id of the alert for which the history is being retrieved", + "readOnly": true + }, + "modifications": { + "type": "array", + "description": "Modification details", + "items": { + "$ref": "#/definitions/alertModificationItem" + } + } + } + }, + "alertModificationItem": { + "description": "Alert modification item.", + "properties": { + "modificationEvent": { + "type": "string", + "description": "Reason for the modification", + "enum": [ + "AlertCreated", + "StateChange", + "MonitorConditionChange" + ], + "x-ms-enum": { + "name": "AlertModificationEvent" + } + }, + "oldValue": { + "type": "string", + "description": "Old value" + }, + "newValue": { + "type": "string", + "description": "New value" + }, + "modifiedAt": { + "type": "string", + "description": "Modified date and time" + }, + "modifiedBy": { + "type": "string", + "description": "Modified user details (Principal client name)" + }, + "comments": { + "type": "string", + "description": "Modification comments" + }, + "description": { + "type": "string", + "description": "Description of the modification" + } + } + }, + "smartGroupModification": { + "description": "Alert Modification details", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/smartGroupModificationProperties" + } + } + }, + "smartGroupModificationProperties": { + "description": "Properties of the smartGroup modification item.", + "properties": { + "smartGroupId": { + "type": "string", + "description": "Unique Id of the smartGroup for which the history is being retrieved", + "readOnly": true + }, + "modifications": { + "type": "array", + "description": "Modification details", + "items": { + "$ref": "#/definitions/smartGroupModificationItem" + } + }, + "nextLink": { + "description": "URL to fetch the next set of results.", + "type": "string" + } + } + }, + "smartGroupModificationItem": { + "description": "smartGroup modification item.", + "properties": { + "modificationEvent": { + "type": "string", + "description": "Reason for the modification", + "enum": [ + "SmartGroupCreated", + "StateChange", + "AlertAdded", + "AlertRemoved" + ], + "x-ms-enum": { + "name": "SmartGroupModificationEvent" + } + }, + "oldValue": { + "type": "string", + "description": "Old value" + }, + "newValue": { + "type": "string", + "description": "New value" + }, + "modifiedAt": { + "type": "string", + "description": "Modified date and time" + }, + "modifiedBy": { + "type": "string", + "description": "Modified user details (Principal client name)" + }, + "comments": { + "type": "string", + "description": "Modification comments" + }, + "description": { + "type": "string", + "description": "Description of the modification" + } + } + }, + "alertsSummary": { + "description": "Summary of the alerts.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/alertsSummaryProperties", + "x-ms-client-flatten": true + } + } + }, + "alertsSummaryProperties": { + "type": "object", + "description": "Summary of the alerts", + "properties": { + "total": { + "type": "integer", + "description": "Total number of alerts." + }, + "smartGroupsCount": { + "type": "integer", + "description": "Total number of smart groups." + }, + "summaryByState": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByState" + } + ], + "type": "object", + "description": "Summary of alerts by state" + }, + "summaryBySeverity": { + "type": "object", + "description": "Summary of alerts by severity", + "properties": { + "sev0": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByState" + } + ], + "type": "object", + "description": "Summary of alerts by severity 'Sev0'" + }, + "sev1": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByState" + } + ], + "type": "object", + "description": "Summary of alerts by severity 'Sev1'" + }, + "sev2": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByState" + } + ], + "type": "object", + "description": "Summary of alerts by severity 'Sev2'" + }, + "sev3": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByState" + } + ], + "type": "object", + "description": "Summary of alerts by severity 'Sev3'" + }, + "sev4": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByState" + } + ], + "type": "object", + "description": "Summary of alerts by severity 'Sev4'" + } + } + }, + "summaryBySeverityAndMonitorCondition": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryBySeverityAndMonitorCondition" + } + ], + "type": "object", + "description": "Summary of alerts by severity and monitor condition" + }, + "summaryByMonitorService": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByMonitorService" + } + ], + "type": "object", + "description": "Summary of alerts by severity" + }, + "nextLink": { + "description": "URL to fetch the next set of results.", + "type": "string" + } + } + }, + "alertsSummaryByState": { + "type": "object", + "description": "Summary of alerts by state", + "properties": { + "new": { + "type": "integer", + "description": "Count of alerts with state 'New'" + }, + "acknowledged": { + "type": "integer", + "description": "Count of alerts with state 'Acknowledged'" + }, + "closed": { + "type": "integer", + "description": "Count of alerts with state 'Closed'" + } + } + }, + "alertsSummaryBySeverityAndMonitorCondition": { + "type": "object", + "description": "Summary of the alerts by severity and monitor condition", + "properties": { + "sev0": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByMonitorCondition" + } + ], + "description": "Summary of alerts by monitor condition with severity 'Sev0'" + }, + "sev1": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByMonitorCondition" + } + ], + "description": "Summary of alerts by monitor condition with severity 'Sev1'" + }, + "sev2": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByMonitorCondition" + } + ], + "description": "Summary of alerts by monitor condition with severity 'Sev2'" + }, + "sev3": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByMonitorCondition" + } + ], + "description": "Summary of alerts by monitor condition with severity 'Sev3'" + }, + "sev4": { + "allOf": [ + { + "$ref": "#/definitions/alertsSummaryByMonitorCondition" + } + ], + "description": "Summary of alerts by monitor condition with severity 'Sev4'" + } + } + }, + "alertsSummaryByMonitorCondition": { + "type": "object", + "description": "Summary of the alerts by monitor condition", + "properties": { + "fired": { + "type": "integer", + "description": "Count of alerts with monitorCondition 'Fired'" + }, + "resolved": { + "type": "integer", + "description": "Count of alerts with monitorCondition 'Resolved'" + } + } + }, + "alertsSummaryByMonitorService": { + "type": "object", + "description": "Summary of the alerts by monitor service", + "properties": { + "platform": { + "type": "integer", + "description": "Count of alerts of \"Platform\"" + }, + "application Insights": { + "type": "integer", + "description": "Count of alerts of \"Application Insights\"" + }, + "log Analytics": { + "type": "integer", + "description": "Count of alerts of \"Log Analytics\"" + }, + "zabbix": { + "type": "integer", + "description": "Count of alerts of \"Zabbix\"" + }, + "scom": { + "type": "integer", + "description": "Count of alerts of \"SCOM\"" + }, + "nagios": { + "type": "integer", + "description": "Count of alerts of \"Nagios\"" + }, + "infrastructure Insights": { + "type": "integer", + "description": "Count of alerts of \"Infrastructure Insights\"" + }, + "activityLog Administrative": { + "type": "integer", + "description": "Count of alerts of \"ActivityLog Administrative\"" + }, + "activityLog Security": { + "type": "integer", + "description": "Count of alerts of \"ActivityLog Security\"" + }, + "activityLog Recommendation": { + "type": "integer", + "description": "Count of alerts of \"ActivityLog Recommendation\"" + }, + "activityLog Policy": { + "type": "integer", + "description": "Count of alerts of \"ActivityLog Policy\"" + }, + "activityLog Autoscale": { + "type": "integer", + "description": "Count of alerts of \"ActivityLog Autoscale\"" + }, + "serviceHealth": { + "type": "integer", + "description": "Count of alerts of \"ServiceHealth\"" + }, + "smartDetector": { + "type": "integer", + "description": "Count of alerts of \"Smart Detector\"" + } + } + }, + "smartGroupsList": { + "description": "List the alerts.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of alerts.", + "type": "string" + }, + "value": { + "description": "List of alerts", + "type": "array", + "items": { + "$ref": "#/definitions/smartGroup" + } + } + } + }, + "smartGroup": { + "description": "Set of related alerts grouped together smartly by AMS.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/smartGroupProperties" + } + } + }, + "smartGroupProperties": { + "type": "object", + "description": "Properties of smart group.", + "properties": { + "alertsCount": { + "type": "integer", + "description": "Total number of alerts in smart group" + }, + "smartGroupState": { + "type": "string", + "description": "Smart group state", + "readOnly": true, + "enum": [ + "New", + "Acknowledged", + "Closed" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true + } + }, + "severity": { + "type": "string", + "description": "Severity of smart group is the highest(Sev0 >... > Sev4) severity of all the alerts in the group.", + "readOnly": true, + "enum": [ + "Sev0", + "Sev1", + "Sev2", + "Sev3", + "Sev4" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Creation time of smart group. Date-Time in ISO-8601 format.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "Last updated time of smart group. Date-Time in ISO-8601 format.", + "readOnly": true + }, + "lastModifiedUserName": { + "type": "string", + "description": "Last modified by user name.", + "readOnly": true + }, + "resources": { + "items": { + "$ref": "#/definitions/smartGroupAggregatedProperty" + }, + "type": "array", + "description": "Summary of target resources in the smart group" + }, + "resourceTypes": { + "items": { + "$ref": "#/definitions/smartGroupAggregatedProperty" + }, + "type": "array", + "description": "Summary of target resource types in the smart group" + }, + "resourceGroups": { + "items": { + "$ref": "#/definitions/smartGroupAggregatedProperty" + }, + "type": "array", + "description": "Summary of target resource groups in the smart group" + }, + "monitorServices": { + "items": { + "$ref": "#/definitions/smartGroupAggregatedProperty" + }, + "type": "array", + "description": "Summary of monitorServices in the smart group" + }, + "monitorConditions": { + "items": { + "$ref": "#/definitions/smartGroupAggregatedProperty" + }, + "type": "array", + "description": "Summary of monitorConditions in the smart group" + }, + "alertStates": { + "items": { + "$ref": "#/definitions/smartGroupAggregatedProperty" + }, + "type": "array", + "description": "Summary of alertStates in the smart group" + }, + "alertSeverities": { + "items": { + "$ref": "#/definitions/smartGroupAggregatedProperty" + }, + "type": "array", + "description": "Summary of alertSeverities in the smart group" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of alerts. Call ListNext() with this URI to fetch the next page alerts." + } + } + }, + "smartGroupAggregatedProperty": { + "type": "object", + "description": "Aggregated property of each type", + "properties": { + "name": { + "type": "string", + "description": "Name of the type." + }, + "count": { + "type": "integer", + "description": "Total number of items of type." + } + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_ChangeState.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_ChangeState.json new file mode 100644 index 000000000000..b77a6029fb67 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_ChangeState.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "9e261de7-c804-4b9d-9ebf-6f50fe350a9a", + "alertId": "66114d64-d9d9-478b-95c9-b789d6502100", + "newState": "Acknowledged", + "body":{ + "comments" : "Acknowledging alert" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "severity":"Sev3", + "signalType":"Log", + "alertState":"New", + "monitorCondition":"Fired", + "monitorService":"Application Insights", + "targetResourceName":"alertscorrelationworkerrole_int", + "targetResourceGroup":"alertscorrelationrg", + "targetResource":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", + "targetResourceType":"components", + "sourceCreatedId":"57c049b5-9654-4bb4-a443-3bac3f725d34", + "smartGroupId":"a808445e-bb38-4751-85c2-1b109ccc1059", + "smartGroupingReason":"Alerts that frequently occur together have been grouped.", + "startDateTime":"2018-06-12T22:05:09Z", + "lastModifiedDateTime":"2018-06-12T22:05:09Z", + "lastModifiedUserName":"vikramm@microsoft.com", + "payload":{} + }, + "id":"/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100", + "type":"Microsoft.AlertsManagement/alerts", + "name":"cpu alert" + } + } + } +} diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_GetbyId.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_GetbyId.json new file mode 100644 index 000000000000..aad3d0031733 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_GetbyId.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "9e261de7-c804-4b9d-9ebf-6f50fe350a9a", + "alertId": "66114d64-d9d9-478b-95c9-b789d6502100" + }, + "responses": { + "200": { + "body": { + + "properties":{ + "severity":"Sev3", + "signalType":"Log", + "alertState":"New", + "monitorCondition":"Fired", + "monitorService":"Application Insights", + "targetResourceName":"alertscorrelationworkerrole_int", + "targetResourceGroup":"alertscorrelationrg", + "targetResource":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", + "targetResourceType":"components", + "sourceCreatedId":"57c049b5-9654-4bb4-a443-3bac3f725d34", + "smartGroupId":"a808445e-bb38-4751-85c2-1b109ccc1059", + "smartGroupingReason":"Alerts that frequently occur together have been grouped.", + "startDateTime":"2018-06-12T22:05:09Z", + "lastModifiedDateTime":"2018-06-12T22:05:09Z", + "lastModifiedUserName":"System", + "payload":{} + }, + "id":"/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100", + "type":"Microsoft.AlertsManagement/alerts", + "name":"cpu alert" + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_History.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_History.json new file mode 100644 index 000000000000..2305f2aa9598 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_History.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "9e261de7-c804-4b9d-9ebf-6f50fe350a9a", + "alertId": "66114d64-d9d9-478b-95c9-b789d6502100" + }, + "responses": { + "200": { + "body": { + "properties":{ + "alertId":"66114d64-d9d9-478b-95c9-b789d6502100", + "modifications":[ + { + "modificationEvent":"StateChange", + "oldValue":"New", + "newValue":"Acknowledged", + "modifiedAt":"2018-06-13T06:14:15.7378737Z", + "modifiedBy":"vikramm@microsoft.com", + "comments":"Acknowledging alert", + "description":"State changed from 'New' to 'Acknowledged'" + }, + { + "modificationEvent":"AlertCreated", + "oldValue":"", + "newValue":"", + "modifiedAt":"2018-06-13T06:09:01Z", + "modifiedBy":"System", + "comments":"", + "description":"New Alert Object is created" + } + ] + }, + "id":"/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100/history/default", + "type":"Microsoft.AlertsManagement/alerts", + "name":"CPU Alert" + } + } + } +} + diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_List.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_List.json new file mode 100644 index 000000000000..1e299af0a821 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_List.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "1e3ff1c0-771a-4119-a03b-be82a51e232d" + }, + "responses": { + "200": { + "body": { + "nextLink":"https://management.azure.com:443/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts?api-version=2018-05-05-preview&timeRange=1d&ctoken=%2bRID%3aPlwOAPHEGwB9UwEAAAAgCw%3d%3d%23RT%3a2%23TRC%3a500%23RTD%3aqtQyMDE4LTA2LTEyVDE1OjEyOjE1", + "value": [ + { + "properties":{ + "severity":"Sev3", + "signalType":"Log", + "alertState":"New", + "monitorCondition":"Fired", + "monitorService":"Application Insights", + "targetResourceName":"alertscorrelationworkerrole_int", + "targetResourceGroup":"alertscorrelationrg", + "targetResource":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", + "targetResourceType":"components", + "sourceCreatedId":"57c049b5-9654-4bb4-a443-3bac3f725d34", + "smartGroupId":"a808445e-bb38-4751-85c2-1b109ccc1059", + "smartGroupingReason":"Alerts that frequently occur together have been grouped.", + "startDateTime":"2018-06-12T22:05:09Z", + "lastModifiedDateTime":"2018-06-12T22:05:09Z", + "lastModifiedUserName":"System", + "payload":{} + }, + "id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100", + "type":"Microsoft.AlertsManagement/alerts", + "name":"cpu alert" + }, + { + "properties":{ + "severity":"Sev3", + "signalType":"Log", + "alertState":"New", + "monitorCondition":"Fired", + "monitorService":"Application Insights", + "targetResourceName":"alertscorrelationworkerrole_int", + "targetResourceGroup":"alertscorrelationrg", + "targetResource":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", + "targetResourceType":"components", + "sourceCreatedId":"e1c5c974-b796-46a1-bb59-740eeca48c15", + "smartGroupId":"a808445e-bb38-4751-85c2-1b109ccc1059", + "smartGroupingReason":"Alerts that frequently occur together have been grouped.", + "startDateTime":"2018-06-12T21:40:09Z", + "lastModifiedDateTime":"2018-06-12T21:40:09Z", + "lastModifiedUserName":"System", + "payload":{} + }, + "id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts/239f0e9f-9871-4c8b-a6a2-b893853d1066", + "type":"Microsoft.AlertsManagement/alerts", + "name":"cpu alert" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_Summary.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_Summary.json new file mode 100644 index 000000000000..54c6c6e73a8f --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_Summary.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "1e3ff1c0-771a-4119-a03b-be82a51e232d" + }, + "responses": { + "200": { + "body": { + "properties":{ + "total":885, + "smartGroupsCount":2, + "summaryByState":{ + "new":884, + "acknowledged":1, + "closed":0 + }, + "summaryBySeverity":{ + "sev0":{ + "new":286, + "acknowledged":0, + "closed":0 + }, + "sev1":{ + "new":309, + "acknowledged":0, + "closed":0 + }, + "sev2":{ + "new":0, + "acknowledged":0, + "closed":0 + }, + "sev3":{ + "new":289, + "acknowledged":1, + "closed":0 + }, + "sev4":{ + "new":0, + "acknowledged":0, + "closed":0 + } + }, + "summaryBySeverityAndMonitorCondition":{ + "sev0":{ + "fired":286, + "resolved":0 + }, + "sev1":{ + "fired":309, + "resolved":0 + }, + "sev2":{ + "fired":0, + "resolved":0 + }, + "sev3":{ + "fired":290, + "resolved":0 + }, + "sev4":{ + "fired":0, + "resolved":0 + } + }, + "summaryByMonitorService":{ + "platform":0, + "application Insights":290, + "log Analytics":595, + "zabbix":0, + "scom":0, + "nagios":0, + "infrastructure Insights":0, + "activityLog Administrative":0, + "activityLog Security":0, + "activityLog Recommendation":0, + "activityLog Policy":0, + "activityLog Autoscale":0, + "serviceHealth":0, + "smartDetector":0 + } + }, + "id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alertsSummary/current", + "type":"Microsoft.AlertsManagement/alertsSummary", + "name":"current" + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_ChangeState.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_ChangeState.json new file mode 100644 index 000000000000..9d5acd7f3fb0 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_ChangeState.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "dd91de05-d791-4ceb-b6dc-988682dc7d72", + "smartGroupId": "a808445e-bb38-4751-85c2-1b109ccc1059", + "newState": "Acknowledged", + "body":{ + "comments" : "Acknowledging smart group" + } + }, + "responses": { + "200": { + "body": { + "properties":{ + "alertsCount":1942, + "smartGroupState":"Acknowledged", + "severity":"Sev3", + "startDateTime":"2018-06-06T12:35:09Z", + "lastModifiedDateTime":"2018-06-13T06:30:09Z", + "lastModifiedUserName":"System", + "resources":[ + { + "name":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", + "count":1942 + } + ], + "resourceTypes":[ + { + "name":"components", + "count":1942 + } + ], + "resourceGroups":[ + { + "name":"alertscorrelationrg", + "count":1942 + } + ], + "monitorServices":[ + { + "name":"Application Insights", + "count":1942 + } + ], + "monitorConditions":[ + { + "name":"Fired", + "count":1942 + } + ], + "alertStates":[ + { + "name":"New", + "count":1941 + }, + { + "name":"Acknowledged", + "count":1 + } + ], + "alertSeverities":[ + { + "name":"Sev3", + "count":1942 + } + ] + }, + "id":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059", + "type":"Microsoft.AlertsManagement/smartGroups", + "name":"cpu alert" + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_GetbyId.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_GetbyId.json new file mode 100644 index 000000000000..3fdbc04189b1 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_GetbyId.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "9e261de7-c804-4b9d-9ebf-6f50fe350a9a", + "smartGroupId": "603675da-9851-4b26-854a-49fc53d32715" + }, + "responses": { + "200": { + "body": { + "properties":{ + "alertsCount":1942, + "smartGroupState":"New", + "severity":"Sev3", + "startDateTime":"2018-06-06T12:35:09Z", + "lastModifiedDateTime":"2018-06-13T06:30:09Z", + "lastModifiedUserName":"System", + "resources":[ + { + "name":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", + "count":1942 + } + ], + "resourceTypes":[ + { + "name":"components", + "count":1942 + } + ], + "resourceGroups":[ + { + "name":"alertscorrelationrg", + "count":1942 + } + ], + "monitorServices":[ + { + "name":"Application Insights", + "count":1942 + } + ], + "monitorConditions":[ + { + "name":"Fired", + "count":1942 + } + ], + "alertStates":[ + { + "name":"New", + "count":1941 + }, + { + "name":"Acknowledged", + "count":1 + } + ], + "alertSeverities":[ + { + "name":"Sev3", + "count":1942 + } + ] + }, + "id":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059", + "type":"Microsoft.AlertsManagement/smartGroups", + "name":"cpu alert" + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_History.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_History.json new file mode 100644 index 000000000000..d4a2671b3808 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_History.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "9e261de7-c804-4b9d-9ebf-6f50fe350a9a", + "smartGroupId": "a808445e-bb38-4751-85c2-1b109ccc1059" + }, + "responses": { + "200": { + "body": { + "properties":{ + "smartGroupId":"a808445e-bb38-4751-85c2-1b109ccc1059", + "modifications":[ + { + "modificationEvent":"SmartGroupCreated", + "oldValue":"", + "newValue":"", + "modifiedAt":"2018-06-06T12:35:09Z", + "modifiedBy":"System", + "comments":"", + "description":"New Smart Group is created" + } + ] + }, + "id":"/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059/history/default", + "type":"Microsoft.AlertsManagement/alerts", + "name":"cpu alert" + } + } + } +} diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_List.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_List.json new file mode 100644 index 000000000000..46c24ed19a12 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_List.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2018-05-05-preview", + "subscriptionId": "dd91de05-d791-4ceb-b6dc-988682dc7d72" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "properties":{ + "alertsCount":1942, + "smartGroupState":"New", + "severity":"Sev3", + "startDateTime":"2018-06-06T12:35:09Z", + "lastModifiedDateTime":"2018-06-13T06:30:09Z", + "lastModifiedUserName":"System", + "resources":[ + { + "name":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", + "count":1942 + } + ], + "resourceTypes":[ + { + "name":"components", + "count":1942 + } + ], + "resourceGroups":[ + { + "name":"alertscorrelationrg", + "count":1942 + } + ], + "monitorServices":[ + { + "name":"Application Insights", + "count":1942 + } + ], + "monitorConditions":[ + { + "name":"Fired", + "count":1942 + } + ], + "alertStates":[ + { + "name":"New", + "count":1941 + }, + { + "name":"Acknowledged", + "count":1 + } + ], + "alertSeverities":[ + { + "name":"Sev3", + "count":1942 + } + ] + }, + "id":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059", + "type":"Microsoft.AlertsManagement/smartGroups", + "name":"cpu alert" + }, + { + "properties":{ + "alertsCount":15374, + "smartGroupState":"Acknowledged", + "severity":"Sev0", + "startDateTime":"2018-05-17T10:18:44.2020997Z", + "lastModifiedDateTime":"2018-06-13T06:29:01Z", + "lastModifiedUserName":"System", + "resources":[ + { + "name":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/mms-eus/providers/microsoft.operationalinsights/workspaces/alertsint", + "count":15374 + } + ], + "resourceTypes":[ + { + "name":"microsoft.operationalinsights/workspaces", + "count":6912 + }, + { + "name":"workspaces", + "count":8462 + } + ], + "resourceGroups":[ + { + "name":"mms-eus", + "count":15374 + } + ], + "monitorServices":[ + { + "name":"Log Analytics", + "count":13911 + } + ], + "monitorConditions":[ + { + "name":"Fired", + "count":15374 + } + ], + "alertStates":[ + { + "name":"New", + "count":15358 + }, + { + "name":"Acknowledged", + "count":12 + }, + { + "name":"Closed", + "count":4 + } + ], + "alertSeverities":[ + { + "name":"Sev0", + "count":6984 + }, + { + "name":"Sev1", + "count":6927 + } + ] + }, + "id":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/01114c7c-769f-4fd4-b6fa-ab77693b83cd", + "type":"Microsoft.AlertsManagement/smartGroups", + "name":"CPU Alert" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/readme.md b/specification/alertsmanagement/resource-manager/readme.md new file mode 100644 index 000000000000..9b0e0ad651dd --- /dev/null +++ b/specification/alertsmanagement/resource-manager/readme.md @@ -0,0 +1,139 @@ +# AlertsManagement + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for AlerManagement. + + +--- +## Getting Started +To build the SDK for AlertManagement, 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 AlertManagement API. + +``` yaml +title: AlertsManagementClient +description: AlertsManagement Client +openapi-type: arm +tag: package-2018-05-preview +``` + +### Tag: package-2018-05-preview + +These settings apply only when `--tag=package-2018-05` is specified on the command line. + +``` yaml $(tag) == 'package-2018-05-preview' +input-file: +- Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.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-libraries-for-java + - repo: azure-sdk-for-go +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.AlertsManagement + output-folder: $(csharp-sdks-folder)/AlertsManagement/Management.AlertsManagement/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.alertsmanagement + package-name: azure-mgmt-alertsmanagement + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-alertsmanagement/azure/mgmt/alertsmanagement +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-alertsmanagement +``` + + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: alertsmanagement + clear-output-folder: true +``` + +### Go multi-api +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-05-preview +``` + +### Tag: package-2018-05-preview and go + +These settings apply only when `--tag=package-2018-05-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-05-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-05-05-preview/$(namespace) +``` + +## 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 + fluent: true + namespace: com.microsoft.azure.management.alertsmanagement + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-alertsmanagement +``` + + diff --git a/specification/analysisservices/resource-manager/readme.md b/specification/analysisservices/resource-manager/readme.md index e82bcdf1cea1..5e96e69f552b 100644 --- a/specification/analysisservices/resource-manager/readme.md +++ b/specification/analysisservices/resource-manager/readme.md @@ -79,6 +79,9 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_analysis_services'] ``` @@ -133,7 +136,7 @@ These settings apply only when `--tag=package-2017-08-beta --go` is specifined o Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-08-beta' && $(go) -output-folder: $(go-sdk-folder)/services/analysisservices/mgmt/2017-08-01-beta/analysisservices +output-folder: $(go-sdk-folder)/services/preview/analysisservices/preview/mgmt/2017-08-01-beta/analysisservices ``` ### Tag: package-2017-07 and go @@ -161,11 +164,74 @@ 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 - fluent: true - namespace: com.microsoft.azure.management.analysisservices - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-analysisservices +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.analysisservices +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-analysisservices ``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-05 + - tag: package-2017-07 + - tag: package-2017-08 + - tag: package-2017-08-beta +``` + +### Tag: package-2016-05 and java + +These settings apply only when `--tag=package-2016-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.analysisservices.v2016_05_16 + output-folder: $(azure-libraries-for-java-folder)/analysisservices/resource-manager/v2016_05_16 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-07 and java + +These settings apply only when `--tag=package-2017-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.analysisservices.v2017_07_14 + output-folder: $(azure-libraries-for-java-folder)/analysisservices/resource-manager/v2017_07_14 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-08 and java + +These settings apply only when `--tag=package-2017-08 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-08' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.analysisservices.v2017_08_01 + output-folder: $(azure-libraries-for-java-folder)/analysisservices/resource-manager/v2017_08_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-08-beta and java + +These settings apply only when `--tag=package-2017-08-beta --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-08-beta' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.analysisservices.v2017_08_01_beta + output-folder: $(azure-libraries-for-java-folder)/analysisservices/resource-manager/v2017_08_01_beta +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/analysisservices/resource-manager/readme.ruby.md b/specification/analysisservices/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..63599066eb96 --- /dev/null +++ b/specification/analysisservices/resource-manager/readme.ruby.md @@ -0,0 +1,59 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_analysis_services +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2017-08 + - tag: package-2017-08-beta + - tag: package-2017-07 + - tag: package-2016-05 +``` + +### Tag: package-2017-08 and ruby + +These settings apply only when `--tag=package-2017-08 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-08' && $(ruby) +namespace: "Azure::AnalysisServices::Mgmt::V2017_08_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_analysis_services/lib +``` + +### Tag: package-2017-08-beta and ruby + +These settings apply only when `--tag=package-2017-08-beta --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-08-beta' && $(ruby) +namespace: "Azure::AnalysisServices::Mgmt::V2017_08_01_beta" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_analysis_services/lib +``` + +### Tag: package-2017-07 and ruby + +These settings apply only when `--tag=package-2017-07 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-07' && $(ruby) +namespace: "Azure::AnalysisServices::Mgmt::V2017_07_14" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_analysis_services/lib +``` + +### Tag: package-2016-05 and ruby + +These settings apply only when `--tag=package-2016-05 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-05' && $(ruby) +namespace: "Azure::AnalysisServices::Mgmt::V2016_05_16" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_analysis_services/lib +``` diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimanagement.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimanagement.json index 516b9bea1e92..fbd19af1e87a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimanagement.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimanagement.json @@ -402,6 +402,16 @@ "description": "Error Field contract." }, "ErrorResponse": { + "properties": { + "error" : { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ErrorResponseBody", + "description": "Properties of the Error Response." + } + }, + "description": "Error Response." + }, + "ErrorResponseBody": { "properties": { "code": { "type": "string", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimapis.json index c98344beb821..c5074d3c172a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimapis.json @@ -160,6 +160,9 @@ "x-ms-examples": { "ApiManagementGetApiContract": { "$ref": "./examples/ApiManagementGetApiContract.json" + }, + "ApiManagementGetApiRevisionContract": { + "$ref": "./examples/ApiManagementGetApiRevision.json" } }, "produces": [ @@ -2686,7 +2689,7 @@ "tags": [ "ApiIssues" ], - "operationId": "ApiIssue_Head", + "operationId": "ApiIssue_GetEntityTag", "description": "Gets the entity state (Etag) version of the Issue for an API specified by its identifier.", "x-ms-examples": { "ApiManagementHeadApiIssue": { @@ -2890,6 +2893,9 @@ } ], "responses": { + "200": { + "description": "The Issue was successfully deleted." + }, "204": { "description": "The Issue was successfully deleted." }, @@ -2972,7 +2978,7 @@ "tags": [ "ApiIssueComments" ], - "operationId": "ApiIssueComment_Head", + "operationId": "ApiIssueComment_GetEntityTag", "description": "Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.", "x-ms-examples": { "ApiManagementHeadApiIssueComment": { @@ -3188,6 +3194,9 @@ } ], "responses": { + "200": { + "description": "The issue Comment was successfully deleted." + }, "204": { "description": "The issue Comment was successfully deleted." }, @@ -3270,7 +3279,7 @@ "tags": [ "ApiIssueAttachments" ], - "operationId": "ApiIssueAttachment_Head", + "operationId": "ApiIssueAttachment_GetEntityTag", "description": "Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.", "x-ms-examples": { "ApiManagementHeadApiIssueAttachment": { @@ -3486,6 +3495,9 @@ } ], "responses": { + "200": { + "description": "The issue Attachment was successfully deleted." + }, "204": { "description": "The issue Attachment was successfully deleted." }, @@ -3891,6 +3903,16 @@ "description": "Indicates if API revision is accessible via the gateway.", "readOnly": true }, + "apiRevisionDescription": { + "type": "string", + "description": "Description of the Api Revision.", + "maxLength": 256 + }, + "apiVersionDescription": { + "type": "string", + "description": "Description of the Api Version.", + "maxLength": 256 + }, "apiVersionSetId": { "type": "string", "description": "A resource identifier for the related ApiVersionSet." diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimportalsettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimportalsettings.json index c74048fb541e..86bd39436d2d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimportalsettings.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimportalsettings.json @@ -86,7 +86,7 @@ "description": "Get Sign-In settings.", "x-ms-examples": { "ApiManagementPortalSettingsGetSignIn": { - "$ref": "examples/ApiManagementPortalSettingsGetSignIn.json" + "$ref": "./examples/ApiManagementPortalSettingsGetSignIn.json" } }, "parameters": [ @@ -126,7 +126,7 @@ "description": "Update Sign-In settings.", "x-ms-examples": { "ApiManagementPortalSettingsUpdateSignIn": { - "$ref": "examples/ApiManagementPortalSettingsUpdateSignIn.json" + "$ref": "./examples/ApiManagementPortalSettingsUpdateSignIn.json" } }, "parameters": [ @@ -175,7 +175,7 @@ "description": "Create or Update Sign-In settings.", "x-ms-examples": { "ApiManagementPortalSettingsUpdateSignIn": { - "$ref": "examples/ApiManagementPortalSettingsPutSignIn.json" + "$ref": "./examples/ApiManagementPortalSettingsPutSignIn.json" } }, "parameters": [ @@ -269,7 +269,7 @@ "description": "Get Sign-Up settings.", "x-ms-examples": { "ApiManagementPortalSettingsGetSignUp": { - "$ref": "examples/ApiManagementPortalSettingsGetSignUp.json" + "$ref": "./examples/ApiManagementPortalSettingsGetSignUp.json" } }, "parameters": [ @@ -309,7 +309,7 @@ "description": "Update Sign-Up settings.", "x-ms-examples": { "ApiManagementPortalSettingsUpdateSignUp": { - "$ref": "examples/ApiManagementPortalSettingsUpdateSignUp.json" + "$ref": "./examples/ApiManagementPortalSettingsUpdateSignUp.json" } }, "parameters": [ @@ -358,7 +358,7 @@ "description": "Create or Update Sign-Up settings.", "x-ms-examples": { "ApiManagementPortalSettingsUpdateSignUp": { - "$ref": "examples/ApiManagementPortalSettingsPutSignUp.json" + "$ref": "./examples/ApiManagementPortalSettingsPutSignUp.json" } }, "parameters": [ @@ -452,7 +452,7 @@ "description": "Get Delegation settings.", "x-ms-examples": { "ApiManagementPortalSettingsGetDelegation": { - "$ref": "examples/ApiManagementPortalSettingsGetDelegation.json" + "$ref": "./examples/ApiManagementPortalSettingsGetDelegation.json" } }, "parameters": [ @@ -492,7 +492,7 @@ "description": "Update Delegation settings.", "x-ms-examples": { "ApiManagementPortalSettingsUpdateDelegation": { - "$ref": "examples/ApiManagementPortalSettingsUpdateDelegation.json" + "$ref": "./examples/ApiManagementPortalSettingsUpdateDelegation.json" } }, "parameters": [ @@ -541,7 +541,7 @@ "description": "Create or Update Delegation settings.", "x-ms-examples": { "ApiManagementPortalSettingsUpdateDelegation": { - "$ref": "examples/ApiManagementPortalSettingsPutDelegation.json" + "$ref": "./examples/ApiManagementPortalSettingsPutDelegation.json" } }, "parameters": [ diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimproducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimproducts.json index c4945c5006b2..0be80fe4fa76 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimproducts.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimproducts.json @@ -448,7 +448,7 @@ "$ref": "#/parameters/ProductIdParameter" }, { - "$ref": "./apimapis.json#/parameters/ApiIdParameter" + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -494,7 +494,7 @@ "$ref": "#/parameters/ProductIdParameter" }, { - "$ref": "./apimapis.json#/parameters/ApiIdParameter" + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -546,7 +546,7 @@ "$ref": "#/parameters/ProductIdParameter" }, { - "$ref": "./apimapis.json#/parameters/ApiIdParameter" + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimtenant.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimtenant.json index e4c1d7bca08a..92c495e33a0a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimtenant.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimtenant.json @@ -654,7 +654,7 @@ "description": "Optional result info." }, "error": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse", + "$ref": "./apimanagement.json#/definitions/ErrorResponseBody", "description": "Error Body Contract" }, "actionLog": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiRevision.json index 92edb681e566..cb3e6d083c6a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiRevision.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiRevision.json @@ -4,12 +4,12 @@ "resourceGroupName": "rg1", "api-version": "2018-01-01", "subscriptionId": "subid", - "apiId": "5a838fd48f33670ed070d77c;rev=4", + "apiId": "echo-api;rev=4", "parameters": { "properties": { - "displayName": "Swagger Petstore V2", + "displayName": "Echo API", "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "serviceUrl": "http://petstore.swagger.io/v4", + "serviceUrl": "http://petstore.swagger.io/v5", "path": "petstore2", "protocols": [ "https" @@ -18,21 +18,22 @@ "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" }, - "isCurrent": false + "isCurrent": false, + "apiRevisionDescription": "moved to swagger petstore backend" } } }, "responses": { "201": { "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a838fd48f33670ed070d77c;rev=4", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=4", "type": "Microsoft.ApiManagement/service/apis", - "name": "5a838fd48f33670ed070d77c;rev=4", + "name": "echo-api;rev=4", "properties": { - "displayName": "Swagger Petstore 2", + "displayName": "Echo API", "apiRevision": "4", "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "serviceUrl": "http://petstore.swagger.io/v4", + "serviceUrl": "http://petstore.swagger.io/v5", "path": "petstore2", "protocols": [ "https" @@ -40,20 +41,21 @@ "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - } + }, + "apiRevisionDescription": "moved to swagger petstore backend" } } }, "200": { "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a838fd48f33670ed070d77c;rev=4", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=4", "type": "Microsoft.ApiManagement/service/apis", - "name": "5a838fd48f33670ed070d77c;rev=4", + "name": "echo-api;rev=4", "properties": { - "displayName": "Swagger Petstore 2", + "displayName": "Echo API", "apiRevision": "4", "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "serviceUrl": "http://petstore.swagger.io/v4", + "serviceUrl": "http://petstore.swagger.io/v5", "path": "petstore2", "protocols": [ "https" @@ -61,7 +63,8 @@ "subscriptionKeyParameterNames": { "header": "Ocp-Apim-Subscription-Key", "query": "subscription-key" - } + }, + "apiRevisionDescription": "moved to swagger petstore backend" } } } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssue.json index 55c9d8f87e1c..3e2ead481521 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssue.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssue.json @@ -9,6 +9,7 @@ "If-Match": "*" }, "responses": { + "200": {}, "204": {} } } \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssueAttachment.json index 065a4fd4c822..9a43f099a422 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssueAttachment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssueAttachment.json @@ -10,6 +10,7 @@ "If-Match": "*" }, "responses": { + "200": {}, "204": {} } } \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssueComment.json index 20e805694db9..813ce534e9af 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssueComment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssueComment.json @@ -10,6 +10,7 @@ "If-Match": "*" }, "responses": { + "200": {}, "204": {} } } \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiRevision.json new file mode 100644 index 000000000000..81167d6c4767 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiRevision.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-01-01", + "subscriptionId": "subid", + "apiId": "echo-api;rev=3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api;rev=3", + "properties": { + "displayName": "Service", + "apiRevision": "3", + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "path": "schulte", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "apiRevisionDescription": "fixed bug in contract" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetNetworkStatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetNetworkStatus.json index 3390543e35cd..fc0fb1304d1d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetNetworkStatus.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetNetworkStatus.json @@ -3,80 +3,104 @@ "serviceName": "apimService1", "resourceGroupName": "rg1", "api-version": "2018-01-01", - "subscriptionId": "subid", - "locationName": "East Asia" + "subscriptionId": "subid" }, "responses": { "200": { "body": [ { - "location": "Central US", + "location": "North Central US", "networkStatus": { "dnsServers": [ - "10.20.37.126", - "10.20.244.38" + "100.78.90.70" ], "connectivityStatus": [ { - "name": "ap********.blob.core.windows.net", + "name": "apimgmtst6mtxxxxxxxx.blob.core.windows.net", "status": "success", "error": "", - "lastUpdated": "2017-06-28T23:37:35.1518379Z", - "lastStatusChange": "2017-06-28T23:17:34.9009011Z" + "lastUpdated": "2018-06-13T22:31:07.3274887Z", + "lastStatusChange": "2018-06-13T20:31:06.6590782Z" }, { - "name": "ap********.file.core.windows.net", + "name": "apimgmtst6mtxxxxxxxx.file.core.windows.net", "status": "success", "error": "", - "lastUpdated": "2017-06-28T23:37:35.9161347Z", - "lastStatusChange": "2017-06-28T23:17:35.2579713Z" + "lastUpdated": "2018-06-13T22:31:08.54627Z", + "lastStatusChange": "2018-06-13T20:31:06.8934611Z" }, { - "name": "e*****.database.windows.net", + "name": "apimgmtst6mtxxxxxxxx.table.core.windows.net", "status": "success", "error": "", - "lastUpdated": "2017-06-28T23:37:35.2130114Z", - "lastStatusChange": "2017-06-28T23:17:35.0079651Z" + "lastUpdated": "2018-06-13T22:31:08.6556497Z", + "lastStatusChange": "2018-06-13T20:31:06.7529128Z" + }, + { + "name": "https://prod3.metrics.nsatc.net:1886/RecoveryService", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:31:08.5618943Z", + "lastStatusChange": "2018-06-13T20:31:07.1125257Z" + }, + { + "name": "n20fxxxxxxxx.database.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:31:09.3275394Z", + "lastStatusChange": "2018-06-13T20:31:07.0968711Z" }, { "name": "Scm", "status": "success", "error": "", - "lastUpdated": "2017-06-28T23:37:37.4401208Z", - "lastStatusChange": "2017-06-28T23:27:36.8198739Z" + "lastUpdated": "2018-06-13T22:31:28.0942291Z", + "lastStatusChange": "2018-06-13T20:41:09.8627827Z" } ] } }, { - "location": "West US", + "location": "South Central US", "networkStatus": { "dnsServers": [ - "10.64.3.87", - "10.64.5.29", - "10.20.32.105" + "100.92.34.14" ], "connectivityStatus": [ { - "name": "ap********.file.core.windows.net", + "name": "apimgmtst6mtxxxxxxxx.file.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:36:26.6522053Z", + "lastStatusChange": "2018-06-13T21:36:24.6042279Z" + }, + { + "name": "apimgmtst6mtxxxxxxxx.table.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:36:25.9959344Z", + "lastStatusChange": "2018-06-13T21:36:24.1587528Z" + }, + { + "name": "apimgmtstufddxxxxxxxx.blob.core.windows.net", "status": "success", "error": "", - "lastUpdated": "2017-06-28T23:37:07.1803004Z", - "lastStatusChange": "2017-06-28T23:17:06.4831818Z" + "lastUpdated": "2018-06-13T22:36:25.0115192Z", + "lastStatusChange": "2018-06-13T21:36:24.5104599Z" }, { - "name": "bb******.blob.core.windows.net", + "name": "https://prod2.metrics.nsatc.net:1886/RecoveryService", "status": "success", "error": "", - "lastUpdated": "2017-06-28T23:37:05.9303015Z", - "lastStatusChange": "2017-06-28T23:17:05.7332755Z" + "lastUpdated": "2018-06-13T22:36:26.042817Z", + "lastStatusChange": "2018-06-13T21:36:24.0962419Z" }, { - "name": "e******.database.windows.net", + "name": "n20fxxxxxxxx.database.windows.net", "status": "success", "error": "", - "lastUpdated": "2017-06-28T23:37:07.1178113Z", - "lastStatusChange": "2017-06-28T23:17:06.1237965Z" + "lastUpdated": "2018-06-13T22:36:26.7615872Z", + "lastStatusChange": "2018-06-13T21:36:24.80737Z" } ] } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json index adc34b627fdb..f0a9b125ff0c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json @@ -4,43 +4,56 @@ "resourceGroupName": "rg1", "api-version": "2018-01-01", "subscriptionId": "subid", - "locationName": "East Asia" + "locationName": "North Central US" }, "responses": { "200": { "body": { "dnsServers": [ - "10.20.32.69", - "10.20.237.143" + "100.78.90.70" ], "connectivityStatus": [ { - "name": "apimgmtstxaleb7*******.blob.core.windows.net", + "name": "apimgmtst6mtxxxxxxxx.blob.core.windows.net", "status": "success", "error": "", - "lastUpdated": "2017-06-01T23:13:07.9054516Z", - "lastStatusChange": "2017-04-13T19:39:53.5543347Z" + "lastUpdated": "2018-06-13T22:41:07.3844516Z", + "lastStatusChange": "2018-06-13T20:31:06.6590782Z" }, { - "name": "apimgmtstxaleb7*******.file.core.windows.net", + "name": "apimgmtst6mtxxxxxxxx.file.core.windows.net", "status": "success", "error": "", - "lastUpdated": "2017-06-01T23:13:08.1242042Z", - "lastStatusChange": "2017-04-13T19:39:53.7262408Z" + "lastUpdated": "2018-06-13T22:41:08.6657305Z", + "lastStatusChange": "2018-06-13T20:31:06.8934611Z" }, { - "name": "Scm", + "name": "apimgmtst6mtxxxxxxxx.table.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:41:08.7594708Z", + "lastStatusChange": "2018-06-13T20:31:06.7529128Z" + }, + { + "name": "https://prod3.metrics.nsatc.net:1886/RecoveryService", "status": "success", "error": "", - "lastUpdated": "2017-06-01T23:08:22.9140197Z", - "lastStatusChange": "2017-05-27T17:52:41.3592337Z" + "lastUpdated": "2018-06-13T22:41:08.6969746Z", + "lastStatusChange": "2018-06-13T20:31:07.1125257Z" }, { - "name": "****seqi.database.windows.net", + "name": "n20fxxx.database.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:41:09.5094848Z", + "lastStatusChange": "2018-06-13T20:31:07.0968711Z" + }, + { + "name": "Scm", "status": "success", "error": "", - "lastUpdated": "2017-06-01T23:13:08.0617078Z", - "lastStatusChange": "2017-04-13T19:39:53.5543347Z" + "lastUpdated": "2018-06-13T22:41:29.4358865Z", + "lastStatusChange": "2018-06-13T20:41:09.8627827Z" } ] } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimanagement.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimanagement.json new file mode 100644 index 000000000000..b7ed07c87ee6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimanagement.json @@ -0,0 +1,694 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on entities like API, Product, and Subscription associated with your Azure API Management deployment.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies": { + "get": { + "tags": [ + "Policy" + ], + "operationId": "Policy_ListByService", + "description": "Lists all the Global Policy definitions of the Api Management service.", + "x-ms-examples": { + "ApiManagementListPolicies": { + "$ref": "./examples/ApiManagementListPolicies.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "scope", + "in": "query", + "required": false, + "type": "string", + "description": "Policy scope.", + "enum": [ + "Tenant", + "Product", + "Api", + "Operation", + "All" + ], + "x-ms-enum": { + "name": "PolicyScopeContract", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns an array of Policy Contracts.", + "schema": { + "$ref": "#/definitions/PolicyCollection" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}": { + "head": { + "tags": [ + "Policy" + ], + "operationId": "Policy_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Global policy definition in the Api Management service.", + "x-ms-examples": { + "ApiManagementHeadPolicy": { + "$ref": "./examples/ApiManagementHeadPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/PolicyIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Policy" + ], + "operationId": "Policy_Get", + "description": "Get the Global policy definition of the Api Management service.", + "x-ms-examples": { + "ApiManagementGetPolicy": { + "$ref": "./examples/ApiManagementGetPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/PolicyIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns the Policy Contracts.", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Policy" + ], + "operationId": "Policy_CreateOrUpdate", + "description": "Creates or updates the global policy configuration of the Api Management service.", + "x-ms-examples": { + "ApiManagementCreatePolicy": { + "$ref": "./examples/ApiManagementCreatePolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/PolicyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/PolicyContract" + }, + "required": true, + "description": "The policy contents to apply." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Global policy configuration was successfully created.", + "schema": { + "$ref": "#/definitions/PolicyContract" + } + }, + "200": { + "description": "Global policy configuration of the Api Management service was successfully updated.", + "schema": { + "$ref": "#/definitions/PolicyContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Policy" + ], + "operationId": "Policy_Delete", + "description": "Deletes the global policy configuration of the Api Management Service.", + "x-ms-examples": { + "ApiManagementDeletePolicy": { + "$ref": "./examples/ApiManagementDeletePolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/PolicyIdParameter" + }, + { + "$ref": "#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the policy configuration at the Global level." + }, + "204": { + "description": "Successfully deleted the policy configuration at the Global level." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policySnippets": { + "get": { + "tags": [ + "PolicySnippets" + ], + "operationId": "PolicySnippets_ListByService", + "description": "Lists all policy snippets.", + "x-ms-examples": { + "ApiManagementListPolicySnippets": { + "$ref": "./examples/ApiManagementListPolicySnippets.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "name": "scope", + "in": "query", + "required": false, + "type": "string", + "description": "Policy scope.", + "enum": [ + "Tenant", + "Product", + "Api", + "Operation", + "All" + ], + "x-ms-enum": { + "name": "PolicyScopeContract", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns an array of Policy Contracts.", + "schema": { + "$ref": "#/definitions/PolicySnippetsCollection" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Regions_ListByService", + "description": "Lists all azure regions in which the service exists.", + "x-ms-examples": { + "ApiManagementListRegions": { + "$ref": "./examples/ApiManagementListRegions.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists of Regions in which the service is deployed.", + "schema": { + "$ref": "#/definitions/RegionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ErrorFieldContract": { + "properties": { + "code": { + "type": "string", + "description": "Property level error code." + }, + "message": { + "type": "string", + "description": "Human-readable representation of property-level error." + }, + "target": { + "type": "string", + "description": "Property name." + } + }, + "description": "Error Field contract." + }, + "ErrorResponse": { + "properties": { + "error" : { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ErrorResponseBody", + "description": "Properties of the Error Response." + } + }, + "description": "Error Response." + }, + "ErrorResponseBody": { + "properties": { + "code": { + "type": "string", + "description": "Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response." + }, + "message": { + "type": "string", + "description": "Human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorFieldContract" + }, + "description": "The list of invalid fields send in request, in case of validation error." + } + }, + "description": "Error Body contract." + }, + "PolicyCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyContract" + }, + "description": "Policy Contract value." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "The response of the list policy operation." + }, + "PolicyContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PolicyContractProperties", + "description": "Properties of the Policy." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Policy Contract details." + }, + "PolicyContractProperties": { + "properties": { + "policyContent": { + "type": "string", + "description": "Json escaped Xml Encoded contents of the Policy." + }, + "contentFormat": { + "type": "string", + "description": "Format of the policyContent.", + "enum": [ + "xml", + "xml-link", + "rawxml", + "rawxml-link" + ], + "x-ms-enum": { + "name": "PolicyContentFormat", + "modelAsString": true, + "values": [ + { + "value": "xml", + "description": "The contents are inline and Content type is an XML document." + }, + { + "value": "xml-link", + "description": "The policy XML document is hosted on a http endpoint accessible from the API Management service." + }, + { + "value": "rawxml", + "description": "The contents are inline and Content type is a non XML encoded policy document." + }, + { + "value": "rawxml-link", + "description": "The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service." + } + ] + }, + "default": "xml" + } + }, + "required": [ + "policyContent" + ], + "description": "Policy contract Properties." + }, + "PolicySnippetsCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicySnippetContract" + }, + "description": "Policy snippet value." + } + }, + "description": "The response of the list policy snippets operation." + }, + "PolicySnippetContract": { + "properties": { + "name": { + "type": "string", + "description": "Snippet name.", + "readOnly": true + }, + "content": { + "type": "string", + "description": "Snippet content.", + "readOnly": true + }, + "toolTip": { + "type": "string", + "description": "Snippet toolTip.", + "readOnly": true + }, + "scope": { + "type": "integer", + "description": "Binary OR value of the Snippet scope.", + "readOnly": true + } + }, + "description": "Policy snippet." + }, + "RegionContract": { + "properties": { + "name": { + "type": "string", + "description": "Region name.", + "readOnly": true + }, + "isMasterRegion": { + "description": "whether Region is the master region.", + "type": "boolean" + }, + "isDeleted": { + "description": "whether Region is deleted.", + "type": "boolean" + } + }, + "description": "Region profile." + }, + "RegionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RegionContract" + }, + "description": "Lists of Regions." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Lists Regions operation response details." + }, + "Resource": { + "description": "The Resource definition.", + "x-ms-azure-resource": true, + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "type": "string", + "description": "Resource name.", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type for API Management resource." + } + } + } + }, + "parameters": { + "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", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ServiceNameParameter": { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the API Management service.", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$", + "x-ms-parameter-location": "method" + }, + "SkipQueryParameter": { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of records to skip.", + "minimum": 0, + "x-ms-parameter-location": "method" + }, + "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." + }, + "TopQueryParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of records to return.", + "minimum": 1, + "x-ms-parameter-location": "method" + }, + "PolicyIdParameter": { + "name": "policyId", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "policy" + ], + "description": "The identifier of the Policy.", + "x-ms-enum": { + "modelAsString": true, + "name": "PolicyIdName" + }, + "x-ms-parameter-location": "method" + }, + "IfMatchRequiredParameter": { + "name": "If-Match", + "in": "header", + "required": true, + "description": "ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "IfMatchOptionalParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json new file mode 100644 index 000000000000..b641dc887fe5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json @@ -0,0 +1,4552 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on API entity and their Operations associated with your Azure API Management deployment.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis": { + "get": { + "tags": [ + "Apis" + ], + "operationId": "Api_ListByService", + "description": "Lists all APIs of the API Management service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-apis" + }, + "x-ms-examples": { + "ApiManagementListApis": { + "$ref": "./examples/ApiManagementListApis.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| serviceUrl | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| path | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "expandApiVersionSet", + "in": "query", + "type": "boolean", + "required": false, + "default": false, + "description": "Include full ApiVersionSet resource in response" + } + ], + "responses": { + "200": { + "description": "Paged Result response of Apis.", + "schema": { + "$ref": "#/definitions/ApiCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ApiContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}": { + "head": { + "tags": [ + "Apis" + ], + "operationId": "Api_GetEntityTag", + "description": "Gets the entity state (Etag) version of the API specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApi": { + "$ref": "./examples/ApiManagementHeadApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified API entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Apis" + ], + "operationId": "Api_Get", + "description": "Gets the details of the API specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiContract": { + "$ref": "./examples/ApiManagementGetApiContract.json" + }, + "ApiManagementGetApiRevisionContract": { + "$ref": "./examples/ApiManagementGetApiRevision.json" + } + }, + "produces": [ + "application/json", + "application/vnd.sun.wadl+xml", + "application/vnd.swagger.doc+json", + "application/wsdl+xml" + ], + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified API entity.", + "schema": { + "$ref": "#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Apis" + ], + "operationId": "Api_CreateOrUpdate", + "description": "Creates new or updates existing specified API of the API Management service instance.", + "x-ms-examples": { + "ApiManagementCreateApiUsingSwaggerImport": { + "$ref": "./examples/ApiManagementCreateApiUsingSwaggerImport.json" + }, + "ApiManagementCreateApiUsingWadlImport": { + "$ref": "./examples/ApiManagementCreateApiUsingWadlImport.json" + }, + "ApiManagementCreateSoapToRestApiUsingWsdlImport": { + "$ref": "./examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json" + }, + "ApiManagementCreateSoapPassThroughApiUsingWsdlImport": { + "$ref": "./examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json" + }, + "ApiManagementCreateApi": { + "$ref": "./examples/ApiManagementCreateApi.json" + }, + "ApiManagementCreateApiRevision": { + "$ref": "./examples/ApiManagementCreateApiRevision.json" + } + }, + "consumes": [ + "application/json", + "application/vnd.sun.wadl+xml", + "application/vnd.swagger.doc+json", + "application/wsdl+xml" + ], + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiCreateOrUpdateParameter" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "API was successfully created.", + "schema": { + "$ref": "#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "200": { + "description": "API was successfully updated.", + "schema": { + "$ref": "#/definitions/ApiContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Apis" + ], + "operationId": "Api_Update", + "description": "Updates the specified API of the API Management service instance.", + "x-ms-examples": { + "ApiManagementUpdateApi.json": { + "$ref": "./examples/ApiManagementUpdateApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiUpdateContract" + }, + "description": "API Update Contract parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The API was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Apis" + ], + "operationId": "Api_Delete", + "description": "Deletes the specified API of the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteApi.json": { + "$ref": "./examples/ApiManagementDeleteApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "name": "deleteRevisions", + "in": "query", + "required": false, + "type": "boolean", + "description": "Delete all revisions of the Api." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The API was successfully deleted." + }, + "204": { + "description": "The API was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/revisions": { + "get": { + "tags": [ + "Revisions" + ], + "operationId": "ApiRevisions_List", + "description": "Lists all revisions of an API.", + "x-ms-examples": { + "ApiManagementListApiRevisions": { + "$ref": "./examples/ApiManagementListApiRevisions.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n\r\n|apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a list of revision details.", + "schema": { + "$ref": "#/definitions/ApiRevisionCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ApiRevisionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases": { + "get": { + "tags": [ + "Releases" + ], + "operationId": "ApiRelease_List", + "description": "Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.", + "x-ms-examples": { + "ApiManagementListApiReleases": { + "$ref": "./examples/ApiManagementListApiReleases.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n|notes|ge le eq ne gt lt|substringof contains startswith endswith|" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a list of API Releases.", + "schema": { + "$ref": "#/definitions/ApiReleaseCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ApiReleaseContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}": { + "head": { + "tags": [ + "Releases" + ], + "operationId": "ApiRelease_GetEntityTag", + "description": "Returns the etag of an API release.", + "x-ms-examples": { + "ApiManagementHeadApiRelease": { + "$ref": "./examples/ApiManagementHeadApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/ReleaseIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns the details of an API Release.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Releases" + ], + "operationId": "ApiRelease_Get", + "description": "Returns the details of an API release.", + "x-ms-examples": { + "ApiManagementGetApiRelease": { + "$ref": "./examples/ApiManagementGetApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/ReleaseIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns the details of an API Release.", + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Releases" + ], + "operationId": "ApiRelease_Create", + "description": "Creates a new Release for the API.", + "x-ms-examples": { + "ApiManagementCreateApiRelease": { + "$ref": "./examples/ApiManagementCreateApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/ReleaseIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + }, + "description": "Create parameters." + } + ], + "responses": { + "201": { + "description": "Release was successfully created.", + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + } + }, + "200": { + "description": "Release was successfully updated.", + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + } + }, + "default": { + "description": "Error response describing why the release failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Releases" + ], + "operationId": "ApiRelease_Update", + "description": "Updates the details of the release of the API specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateApiRelease": { + "$ref": "./examples/ApiManagementUpdateApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/ReleaseIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiReleaseContract" + }, + "description": "API Release Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + } + ], + "responses": { + "204": { + "description": "The operation was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Releases" + ], + "operationId": "ApiRelease_Delete", + "description": "Deletes the specified release in the API.", + "x-ms-examples": { + "ApiManagementDeleteApiRelease": { + "$ref": "./examples/ApiManagementDeleteApiRelease.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/ReleaseIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + } + ], + "responses": { + "200": { + "description": "The release was successfully deleted." + }, + "204": { + "description": "The release was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "ApiOperation_ListByApi", + "description": "Lists a collection of the operations for the specified API.", + "x-ms-examples": { + "ApiManagementListApiOperations": { + "$ref": "./examples/ApiManagementListApiOperations.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A collection of operation summary entities at the API level.", + "schema": { + "$ref": "#/definitions/OperationCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/OperationContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}": { + "head": { + "tags": [ + "Operations" + ], + "operationId": "ApiOperation_GetEntityTag", + "description": "Gets the entity state (Etag) version of the API operation specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiOperation": { + "$ref": "./examples/ApiManagementHeadApiOperation.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified API operation entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Operations" + ], + "operationId": "ApiOperation_Get", + "description": "Gets the details of the API Operation specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiOperation": { + "$ref": "./examples/ApiManagementGetApiOperation.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Operation entity.", + "schema": { + "$ref": "#/definitions/OperationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Operations" + ], + "operationId": "ApiOperation_CreateOrUpdate", + "description": "Creates a new operation in the API or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateApiOperation": { + "$ref": "./examples/ApiManagementCreateApiOperation.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OperationContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Operation was successfully created.", + "schema": { + "$ref": "#/definitions/OperationContract" + } + }, + "200": { + "description": "Operation was successfully updated.", + "schema": { + "$ref": "#/definitions/OperationContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Operations" + ], + "operationId": "ApiOperation_Update", + "description": "Updates the details of the operation in the API specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateApiOperation": { + "$ref": "./examples/ApiManagementUpdateApiOperation.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OperationUpdateContract" + }, + "description": "API Operation Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The operation was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Operations" + ], + "operationId": "ApiOperation_Delete", + "description": "Deletes the specified operation in the API.", + "x-ms-examples": { + "ApiManagementDeleteApiOperation": { + "$ref": "./examples/ApiManagementDeleteApiOperation.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successfully deleted." + }, + "204": { + "description": "The operation was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies": { + "get": { + "tags": [ + "ApiOperationPolicies" + ], + "operationId": "ApiOperationPolicy_ListByOperation", + "description": "Get the list of policy configuration at the API Operation level.", + "x-ms-examples": { + "ApiManagementListApiOperationPolicies": { + "$ref": "./examples/ApiManagementListApiOperationPolicies.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Operations Policy Collection.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/{policyId}": { + "head": { + "tags": [ + "ApiOperationPolicies" + ], + "operationId": "ApiOperationPolicy_GetEntityTag", + "description": "Gets the entity state (Etag) version of the API operation policy specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiOperationPolicy": { + "$ref": "./examples/ApiManagementHeadApiOperationPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified API operation policy entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiOperationPolicies" + ], + "operationId": "ApiOperationPolicy_Get", + "description": "Get the policy configuration at the API Operation level.", + "x-ms-examples": { + "ApiManagementGetApiOperationPolicy": { + "$ref": "./examples/ApiManagementGetApiOperationPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Operation Policy information.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiOperationPolicies" + ], + "operationId": "ApiOperationPolicy_CreateOrUpdate", + "description": "Creates or updates policy configuration for the API Operation level.", + "x-ms-examples": { + "ApiManagementCreateApiOperationPolicy": { + "$ref": "./examples/ApiManagementCreateApiOperationPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + }, + "required": true, + "description": "The policy contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Api Operation policy configuration was successfully created.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + } + }, + "200": { + "description": "Api Operation policy configuration of the tenant was successfully updated.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiOperationPolicies" + ], + "operationId": "ApiOperationPolicy_Delete", + "description": "Deletes the policy configuration at the Api Operation.", + "x-ms-examples": { + "ApiManagementDeleteOperationPolicy": { + "$ref": "./examples/ApiManagementDeleteOperationPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the policy configuration at the API Operation level." + }, + "204": { + "description": "Successfully deleted the policy configuration at the API Operation level." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products": { + "get": { + "tags": [ + "ApiProduct" + ], + "operationId": "ApiProduct_ListByApis", + "description": "Lists all Products, which the API is part of.", + "x-ms-examples": { + "ApiManagementGetProductsForApi": { + "$ref": "./examples/ApiManagementGetProductsForApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of products which have the Api entity.", + "schema": { + "$ref": "./apimproducts.json#/definitions/ProductCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimproducts.json#/definitions/ProductContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies": { + "get": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_ListByApi", + "description": "Get the policy configuration at the API level.", + "x-ms-examples": { + "ApiManagementListApiPolicies": { + "$ref": "./examples/ApiManagementListApiPolicies.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Apis Policy Collection.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyCollection" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}": { + "head": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_GetEntityTag", + "description": "Gets the entity state (Etag) version of the API policy specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiPolicy": { + "$ref": "./examples/ApiManagementHeadApiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified API Policy entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_Get", + "description": "Get the policy configuration at the API level.", + "x-ms-examples": { + "ApiManagementGetApiPolicy": { + "$ref": "./examples/ApiManagementGetApiPolicy.json" + } + }, + "produces": [ + "application/json", + "application/vnd.ms-azure-apim.policy+xml", + "application/vnd.ms-azure-apim.policy.raw+xml" + ], + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Policy information.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_CreateOrUpdate", + "description": "Creates or updates policy configuration for the API.", + "x-ms-examples": { + "ApiManagementCreateApiPolicy": { + "$ref": "./examples/ApiManagementCreateApiPolicy.json" + }, + "ApiManagementCreateApiPolicyNonXmlEncoded": { + "$ref": "./examples/ApiManagementCreateApiPolicyNonXmlEncoded.json" + } + }, + "consumes": [ + "application/json", + "application/vnd.ms-azure-apim.policy+xml", + "application/vnd.ms-azure-apim.policy.raw+xml" + ], + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + }, + "required": true, + "description": "The policy contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Api policy configuration was successfully created.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + } + }, + "200": { + "description": "Api policy configuration of the tenant was successfully updated.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_Delete", + "description": "Deletes the policy configuration at the Api.", + "x-ms-examples": { + "ApiManagementDeleteApiPolicy": { + "$ref": "./examples/ApiManagementDeleteApiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the policy configuration at the API level." + }, + "204": { + "description": "Successfully deleted the policy configuration at the API level." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas": { + "get": { + "tags": [ + "ApiSchema" + ], + "operationId": "ApiSchema_ListByApi", + "description": "Get the schema configuration at the API level.", + "x-ms-examples": { + "ApiManagementListApiSchemas": { + "$ref": "./examples/ApiManagementListApiSchemas.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Apis Schema Collection.", + "schema": { + "$ref": "#/definitions/SchemaCollection" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}": { + "head": { + "tags": [ + "ApiSchema" + ], + "operationId": "ApiSchema_GetEntityTag", + "description": "Gets the entity state (Etag) version of the schema specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiSchema": { + "$ref": "./examples/ApiManagementHeadApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/SchemaIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified schema entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiSchema" + ], + "operationId": "ApiSchema_Get", + "description": "Get the schema configuration at the API level.", + "x-ms-examples": { + "ApiManagementGetApiSchema": { + "$ref": "./examples/ApiManagementGetApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/SchemaIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Schema information.", + "schema": { + "$ref": "#/definitions/SchemaContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiSchema" + ], + "operationId": "ApiSchema_CreateOrUpdate", + "description": "Creates or updates schema configuration for the API.", + "x-ms-examples": { + "ApiManagementCreateApiSchema": { + "$ref": "./examples/ApiManagementCreateApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/SchemaIdParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/SchemaContract" + }, + "required": true, + "description": "The schema contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Api schema configuration was successfully created.", + "schema": { + "$ref": "#/definitions/SchemaContract" + } + }, + "200": { + "description": "Api schema configuration of the tenant was successfully updated.", + "schema": { + "$ref": "#/definitions/SchemaContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiSchema" + ], + "operationId": "ApiSchema_Delete", + "description": "Deletes the schema configuration at the Api.", + "x-ms-examples": { + "ApiManagementDeleteApiSchema": { + "$ref": "./examples/ApiManagementDeleteApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/SchemaIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the schema configuration at the API level." + }, + "204": { + "description": "Successfully deleted the schema configuration at the API level." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags": { + "get": { + "tags": [ + "ApisByTags" + ], + "operationId": "Api_ListByTags", + "description": "Lists a collection of apis associated with tags.", + "x-ms-examples": { + "ApiManagementListApisByTags": { + "$ref": "./examples/ApiManagementListApisByTags.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| aid | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| isCurrent | eq | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TagResource entities.", + "schema": { + "$ref": "./apimtagresources.json#/definitions/TagResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimtagresources.json#/definitions/TagResourceContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics": { + "get": { + "tags": [ + "ApiDiagnostics" + ], + "operationId": "ApiDiagnostic_ListByService", + "description": "Lists all diagnostics of an API.", + "x-ms-examples": { + "ApiManagementListApiDiagnostics": { + "$ref": "./examples/ApiManagementListApiDiagnostics.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result reponse of diagnostics for an API.", + "schema": { + "$ref": "./apimdiagnostics.json#/definitions/DiagnosticCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimdiagnostics.json#/definitions/DiagnosticContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}": { + "head": { + "tags": [ + "ApiDiagnostics" + ], + "operationId": "ApiDiagnostic_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiDiagnostic": { + "$ref": "./examples/ApiManagementHeadApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimdiagnostics.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiDiagnostics" + ], + "operationId": "ApiDiagnostic_Get", + "description": "Gets the details of the Diagnostic for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiDiagnostic": { + "$ref": "./examples/ApiManagementGetApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimdiagnostics.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Diagnostic entity.", + "schema": { + "$ref": "./apimdiagnostics.json#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiDiagnostics" + ], + "operationId": "ApiDiagnostic_CreateOrUpdate", + "description": "Creates a new Diagnostic for an API or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateApiDiagnostic": { + "$ref": "./examples/ApiManagementCreateApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimdiagnostics.json#/parameters/DiagnosticIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./apimdiagnostics.json#/definitions/DiagnosticContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Diagnostic was successfully created.", + "schema": { + "$ref": "./apimdiagnostics.json#/definitions/DiagnosticContract" + } + }, + "200": { + "description": "Diagnostic was successfully updated.", + "schema": { + "$ref": "./apimdiagnostics.json#/definitions/DiagnosticContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ApiDiagnostics" + ], + "operationId": "ApiDiagnostic_Update", + "description": "Updates the details of the Diagnostic for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateApiDiagnostic": { + "$ref": "./examples/ApiManagementUpdateApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimdiagnostics.json#/parameters/DiagnosticIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./apimdiagnostics.json#/definitions/DiagnosticContract" + }, + "description": "Diagnostic Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The Diagnostic was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiDiagnostics" + ], + "operationId": "ApiDiagnostic_Delete", + "description": "Deletes the specified Diagnostic from an API.", + "x-ms-examples": { + "ApiManagementDeleteApiDiagnostic": { + "$ref": "./examples/ApiManagementDeleteApiDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimdiagnostics.json#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Diagnostic was successfully deleted." + }, + "204": { + "description": "The Diagnostic was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues": { + "get": { + "tags": [ + "ApiIssues" + ], + "operationId": "ApiIssue_ListByService", + "description": "Lists all issues assosiated with the specified API.", + "x-ms-examples": { + "ApiManagementListApiIssues": { + "$ref": "./examples/ApiManagementListApiIssues.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| state | eq | |\n| userId | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result reponse of issues for the API.", + "schema": { + "$ref": "#/definitions/IssueCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/IssueContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}": { + "head": { + "tags": [ + "ApiIssues" + ], + "operationId": "ApiIssue_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Issue for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiIssue": { + "$ref": "./examples/ApiManagementHeadApiIssue.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiIssues" + ], + "operationId": "ApiIssue_Get", + "description": "Gets the details of the Issue for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiIssue": { + "$ref": "./examples/ApiManagementGetApiIssue.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Issue entity.", + "schema": { + "$ref": "#/definitions/IssueContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiIssues" + ], + "operationId": "ApiIssue_CreateOrUpdate", + "description": "Creates a new Issue for an API or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateApiIssue": { + "$ref": "./examples/ApiManagementCreateApiIssue.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IssueContract" + }, + "description": "Create parameters." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "description": "ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Issue was successfully created.", + "schema": { + "$ref": "#/definitions/IssueContract" + } + }, + "200": { + "description": "Issue was successfully updated.", + "schema": { + "$ref": "#/definitions/IssueContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiIssues" + ], + "operationId": "ApiIssue_Delete", + "description": "Deletes the specified Issue from an API.", + "x-ms-examples": { + "ApiManagementDeleteApiIssue": { + "$ref": "./examples/ApiManagementDeleteApiIssue.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "description": "ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Issue was successfully deleted." + }, + "204": { + "description": "The Issue was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments": { + "get": { + "tags": [ + "ApiIssueComments" + ], + "operationId": "ApiIssueComment_ListByService", + "description": "Lists all comments for the Issue assosiated with the specified API.", + "x-ms-examples": { + "ApiManagementListApiIssueComments": { + "$ref": "./examples/ApiManagementListApiIssueComments.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| userId | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result reponse of issue comments for the API.", + "schema": { + "$ref": "#/definitions/IssueCommentCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/IssueCommentContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}": { + "head": { + "tags": [ + "ApiIssueComments" + ], + "operationId": "ApiIssueComment_GetEntityTag", + "description": "Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiIssueComment": { + "$ref": "./examples/ApiManagementHeadApiIssueComment.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "$ref": "#/parameters/CommentIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiIssueComments" + ], + "operationId": "ApiIssueComment_Get", + "description": "Gets the details of the issue Comment for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiIssueComment": { + "$ref": "./examples/ApiManagementGetApiIssueComment.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "$ref": "#/parameters/CommentIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified issue Comment entity.", + "schema": { + "$ref": "#/definitions/IssueCommentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiIssueComments" + ], + "operationId": "ApiIssueComment_CreateOrUpdate", + "description": "Creates a new Comment for the Issue in an API or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateApiIssueComment": { + "$ref": "./examples/ApiManagementCreateApiIssueComment.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "$ref": "#/parameters/CommentIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IssueCommentContract" + }, + "description": "Create parameters." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "description": "ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Issue Comment was successfully created.", + "schema": { + "$ref": "#/definitions/IssueCommentContract" + } + }, + "200": { + "description": "Issue Comment was successfully updated.", + "schema": { + "$ref": "#/definitions/IssueCommentContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiIssueComments" + ], + "operationId": "ApiIssueComment_Delete", + "description": "Deletes the specified comment from an Issue.", + "x-ms-examples": { + "ApiManagementDeleteApiIssueComment": { + "$ref": "./examples/ApiManagementDeleteApiIssueComment.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "$ref": "#/parameters/CommentIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "description": "ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The issue Comment was successfully deleted." + }, + "204": { + "description": "The issue Comment was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments": { + "get": { + "tags": [ + "ApiIssueAttachments" + ], + "operationId": "ApiIssueAttachment_ListByService", + "description": "Lists all comments for the Issue assosiated with the specified API.", + "x-ms-examples": { + "ApiManagementListApiIssueAttachments": { + "$ref": "./examples/ApiManagementListApiIssueAttachments.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| userId | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result reponse of issue comments for the API.", + "schema": { + "$ref": "#/definitions/IssueAttachmentCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/IssueAttachmentContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments/{attachmentId}": { + "head": { + "tags": [ + "ApiIssueAttachments" + ], + "operationId": "ApiIssueAttachment_GetEntityTag", + "description": "Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiIssueAttachment": { + "$ref": "./examples/ApiManagementHeadApiIssueAttachment.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "$ref": "#/parameters/AttachmentIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiIssueAttachments" + ], + "operationId": "ApiIssueAttachment_Get", + "description": "Gets the details of the issue Attachment for an API specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiIssueAttachment": { + "$ref": "./examples/ApiManagementGetApiIssueAttachment.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "$ref": "#/parameters/AttachmentIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified issue Attachment entity.", + "schema": { + "$ref": "#/definitions/IssueAttachmentContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiIssueAttachments" + ], + "operationId": "ApiIssueAttachment_CreateOrUpdate", + "description": "Creates a new Attachment for the Issue in an API or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateApiIssueAttachment": { + "$ref": "./examples/ApiManagementCreateApiIssueAttachment.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "$ref": "#/parameters/AttachmentIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IssueAttachmentContract" + }, + "description": "Create parameters." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "description": "ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Issue Attachment was successfully created.", + "schema": { + "$ref": "#/definitions/IssueAttachmentContract" + } + }, + "200": { + "description": "Issue Attachment was successfully updated.", + "schema": { + "$ref": "#/definitions/IssueAttachmentContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiIssueAttachments" + ], + "operationId": "ApiIssueAttachment_Delete", + "description": "Deletes the specified comment from an Issue.", + "x-ms-examples": { + "ApiManagementDeleteApiIssueAttachment": { + "$ref": "./examples/ApiManagementDeleteApiIssueAttachment.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "$ref": "#/parameters/AttachmentIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "description": "ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The issue Attachment was successfully deleted." + }, + "204": { + "description": "The issue Attachment was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "x-ms-paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?export=true": { + "get": { + "tags": [ + "Apis" + ], + "operationId": "ApiExport_Get", + "description": "Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.", + "x-ms-examples": { + "ApiManagementGetApiExportInOpenApi2dot0": { + "$ref": "./examples/ApiManagementGetApiExportInOpenApi2dot0.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" + }, + { + "name": "format", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "swagger-link", + "wadl-link", + "wsdl-link" + ], + "x-ms-enum": { + "name": "ExportFormat", + "modelAsString": true, + "values": [ + { + "value": "swagger-link", + "description": "Export the Api Definition in OpenApi Specification 2.0 format to the Storage Blob.", + "name": "Swagger" + }, + { + "value": "wsdl-link", + "description": "Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type `soap`", + "name": "Wsdl" + }, + { + "value": "wadl-link", + "description": "Export the Api Definition in WADL Schema to Storage Blob.", + "name": "Wadl" + } + ] + }, + "description": "Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes." + }, + { + "name": "export", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "true" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ExportApi" + }, + "description": "Query parameter required to export the API details." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response contains a stream with a full set of API metadata and includes API entity with an embedded array of operation entities.", + "schema": { + "$ref": "#/definitions/ApiExportResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ApiExportResult": { + "properties": { + "link": { + "type": "string", + "description": "Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes." + } + }, + "description": "API Export result Blob Uri." + }, + "ApiCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiContract" + }, + "description": "Page values.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Api list representation." + }, + "ApiContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiContractProperties", + "description": "Api entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "API details." + }, + "ApiCreateOrUpdateParameter": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiCreateOrUpdateProperties", + "description": "Api entity create of update properties." + } + }, + "description": "API Create or Update Parameters." + }, + "ApiCreateOrUpdateProperties": { + "properties": { + "contentValue": { + "type": "string", + "description": "Content value when Importing an API." + }, + "contentFormat": { + "type": "string", + "description": "Format of the Content in which the API is getting imported.", + "enum": [ + "wadl-xml", + "wadl-link-json", + "swagger-json", + "swagger-link-json", + "wsdl", + "wsdl-link" + ], + "x-ms-enum": { + "name": "ContentFormat", + "modelAsString": true, + "values": [ + { + "value": "wadl-xml", + "description": "The contents are inline and Content type is a WADL document." + }, + { + "value": "wadl-link-json", + "description": "The WADL document is hosted on a publicly accessible internet address." + }, + { + "value": "swagger-json", + "description": "The contents are inline and Content Type is a OpenApi 2.0 Document." + }, + { + "value": "swagger-link-json", + "description": "The Open Api 2.0 document is hosted on a publicly accessible internet address." + }, + { + "value": "wsdl", + "description": "The contents are inline and the document is a WSDL/Soap document." + }, + { + "value": "wsdl-link", + "description": "The WSDL document is hosted on a publicly accessible internet address." + } + ] + } + }, + "wsdlSelector": { + "type": "object", + "description": "Criteria to limit import of WSDL to a subset of the document.", + "properties": { + "wsdlServiceName": { + "type": "string", + "description": "Name of service to import from WSDL" + }, + "wsdlEndpointName": { + "type": "string", + "description": "Name of endpoint(port) to import from WSDL" + } + } + }, + "apiType": { + "type": "string", + "description": "Type of Api to create. \n * `http` creates a SOAP to REST API \n * `soap` creates a SOAP pass-through API .", + "enum": [ + "http", + "soap" + ], + "x-ms-client-name": "SoapApiType", + "x-ms-enum": { + "name": "SoapApiType", + "modelAsString": true, + "values": [ + { + "value": "http", + "description": "Imports a SOAP API having a RESTful front end.", + "name": "SoapToRest" + }, + { + "value": "soap", + "description": "Imports the Soap API having a SOAP front end.", + "name": "SoapPassThrough" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiContractProperties" + } + ], + "description": "Api Create or Update Properties." + }, + "ApiContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "API name.", + "minLength": 1, + "maxLength": 300 + }, + "serviceUrl": { + "type": "string", + "description": "Absolute URL of the backend service implementing this API.", + "minLength": 0, + "maxLength": 2000 + }, + "path": { + "type": "string", + "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.", + "minLength": 0, + "maxLength": 400 + }, + "protocols": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "http", + "https" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": false + } + }, + "description": "Describes on which protocols the operations in this API can be invoked." + }, + "apiVersionSet": { + "$ref": "#/definitions/ApiVersionSetContractDetails" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiEntityBaseContract" + } + ], + "required": [ + "path" + ], + "description": "Api Entity Properties" + }, + "ApiUpdateContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiContractUpdateProperties", + "description": "Properties of the API entity that can be updated." + } + }, + "description": "API update contract details." + }, + "ApiContractUpdateProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "API name.", + "minLength": 1, + "maxLength": 300 + }, + "serviceUrl": { + "type": "string", + "description": "Absolute URL of the backend service implementing this API.", + "minLength": 1, + "maxLength": 2000 + }, + "path": { + "type": "string", + "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.", + "minLength": 0, + "maxLength": 400 + }, + "protocols": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "http", + "https" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": false + } + }, + "description": "Describes on which protocols the operations in this API can be invoked." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiEntityBaseContract" + } + ], + "description": "API update contract properties." + }, + "ApiEntityBaseContract": { + "properties": { + "description": { + "type": "string", + "description": "Description of the API. May include HTML formatting tags." + }, + "authenticationSettings": { + "$ref": "#/definitions/AuthenticationSettingsContract", + "description": "Collection of authentication settings included into this API." + }, + "subscriptionKeyParameterNames": { + "$ref": "#/definitions/SubscriptionKeyParameterNamesContract", + "description": "Protocols over which API is made available." + }, + "type": { + "type": "string", + "description": "Type of API.", + "enum": [ + "http", + "soap" + ], + "x-ms-client-name": "ApiType", + "x-ms-enum": { + "name": "ApiType", + "modelAsString": true + } + }, + "apiRevision": { + "type": "string", + "description": "Describes the Revision of the Api. If no value is provided, default revision 1 is created", + "minLength": 1, + "maxLength": 100 + }, + "apiVersion": { + "type": "string", + "description": "Indicates the Version identifier of the API if the API is versioned", + "maxLength": 100 + }, + "isCurrent": { + "type": "boolean", + "description": "Indicates if API revision is current api revision.", + "readOnly": true + }, + "isOnline": { + "type": "boolean", + "description": "Indicates if API revision is accessible via the gateway.", + "readOnly": true + }, + "apiRevisionDescription": { + "type": "string", + "description": "Description of the Api Revision.", + "maxLength": 256 + }, + "apiVersionDescription": { + "type": "string", + "description": "Description of the Api Version.", + "maxLength": 256 + }, + "apiVersionSetId": { + "type": "string", + "description": "A resource identifier for the related ApiVersionSet." + } + }, + "description": "API base contract details." + }, + "ApiRevisionCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiRevisionContract" + }, + "description": "Page values.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Api Revision list representation." + }, + "ApiRevisionContract": { + "properties": { + "apiId": { + "type": "string", + "readOnly": true, + "description": "Identifier of the API Revision." + }, + "apiRevision": { + "type": "string", + "minLength": 1, + "maxLength": 100, + "readOnly": true, + "description": "Revision number of API." + }, + "createdDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time the API Revision was created. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." + }, + "updatedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time the API Revision were updated. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." + }, + "description": { + "type": "string", + "readOnly": true, + "maxLength": 256, + "description": "Description of the API Revision." + }, + "privateUrl": { + "type": "string", + "readOnly": true, + "description": "Gateway URL for accessing the non-current API Revision." + }, + "isOnline": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if API revision is the current api revision." + }, + "isCurrent": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if API revision is accessible via the gateway." + } + }, + "description": "Summary of revision metadata." + }, + "ApiRevisionInfoContract": { + "description": "Object used to create an API Revision or Version based on an existing API Revision", + "properties": { + "sourceApiId": { + "type": "string", + "description": "Resource identifier of API to be used to create the revision from." + }, + "apiVersionName": { + "type": "string", + "maxLength": 100, + "description": "Version identifier for the new API Version." + }, + "apiRevisionDescription": { + "type": "string", + "maxLength": 256, + "description": "Description of new API Revision." + }, + "apiVersionSet": { + "description": "Version set details", + "$ref": "#/definitions/ApiVersionSetContractDetails" + } + } + }, + "ApiVersionSetContractDetails": { + "description": "An API Version Set contains the common configuration for a set of API Versions relating ", + "properties": { + "id": { + "type": "string", + "description": "Identifier for existing API Version Set. Omit this value to create a new Version Set." + }, + "description": { + "type": "string", + "description": "Description of API Version Set." + }, + "versioningScheme": { + "type": "string", + "description": "An value that determines where the API Version identifer will be located in a HTTP request.", + "enum": [ + "Segment", + "Query", + "Header" + ] + }, + "versionQueryName": { + "type": "string", + "description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`." + }, + "versionHeaderName": { + "type": "string", + "description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`." + } + } + }, + "ApiReleaseCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiReleaseContract" + }, + "description": "Page values.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Api Revision list representation." + }, + "ApiReleaseContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiReleaseContractProperties", + "description": "Properties of the Api Release Contract." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Api Release details." + }, + "ApiReleaseContractProperties": { + "description": "API Release details", + "properties": { + "apiId": { + "type": "string", + "description": "Identifier of the API the release belongs to." + }, + "createdDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard." + }, + "updatedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time the API release was updated." + }, + "notes": { + "type": "string", + "description": "Release Notes" + } + } + }, + "AuthenticationSettingsContract": { + "properties": { + "oAuth2": { + "$ref": "#/definitions/OAuth2AuthenticationSettingsContract", + "description": "OAuth2 Authentication settings" + } + }, + "description": "API Authentication Settings." + }, + "OAuth2AuthenticationSettingsContract": { + "properties": { + "authorizationServerId": { + "type": "string", + "description": "OAuth authorization server identifier." + }, + "scope": { + "type": "string", + "description": "operations scope." + } + }, + "description": "API OAuth2 Authentication settings details." + }, + "OperationCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OperationContract" + }, + "description": "Page values.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Operation list representation." + }, + "OperationContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationContractProperties", + "description": "Properties of the Operation Contract." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Api Operation details." + }, + "OperationContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Operation Name.", + "minLength": 1, + "maxLength": 300 + }, + "method": { + "type": "string", + "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.", + "externalDocs": { + "description": "As defined by RFC.", + "url": "http://www.rfc-editor.org/rfc/rfc7230.txt" + } + }, + "urlTemplate": { + "type": "string", + "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", + "minLength": 1, + "maxLength": 1000 + } + }, + "allOf": [ + { + "$ref": "#/definitions/OperationEntityBaseContract" + } + ], + "required": [ + "displayName", + "method", + "urlTemplate" + ], + "description": "Operation Contract Properties" + }, + "OperationUpdateContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Operation Name.", + "minLength": 1, + "maxLength": 300 + }, + "method": { + "type": "string", + "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.", + "externalDocs": { + "description": "As defined by RFC.", + "url": "http://www.rfc-editor.org/rfc/rfc7230.txt" + } + }, + "urlTemplate": { + "type": "string", + "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", + "minLength": 1, + "maxLength": 1000 + } + }, + "allOf": [ + { + "$ref": "#/definitions/OperationEntityBaseContract" + } + ], + "description": "Operation Update Contract Properties." + }, + "OperationEntityBaseContract": { + "properties": { + "templateParameters": { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "description": "Collection of URL template parameters." + }, + "description": { + "type": "string", + "description": "Description of the operation. May include HTML formatting tags.", + "maxLength": 1000 + }, + "request": { + "$ref": "#/definitions/RequestContract", + "description": "An entity containing request details." + }, + "responses": { + "type": "array", + "items": { + "$ref": "#/definitions/ResponseContract" + }, + "description": "Array of Operation responses." + }, + "policies": { + "type": "string", + "description": "Operation Policies" + } + }, + "description": "Api Operation Entity Base Contract details." + }, + "OperationUpdateContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationUpdateContractProperties", + "description": "Properties of the API Operation entity that can be updated." + } + }, + "description": "Api Operation Update Contract details." + }, + "ParameterContract": { + "properties": { + "name": { + "type": "string", + "description": "Parameter name." + }, + "description": { + "type": "string", + "description": "Parameter description." + }, + "type": { + "type": "string", + "description": "Parameter type." + }, + "defaultValue": { + "type": "string", + "description": "Default parameter value." + }, + "required": { + "type": "boolean", + "description": "whether parameter is required or not." + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Parameter values." + } + }, + "required": [ + "name", + "type" + ], + "description": "Operation parameters details." + }, + "RepresentationContract": { + "properties": { + "contentType": { + "type": "string", + "description": "Specifies a registered or custom content type for this representation, e.g. application/xml." + }, + "sample": { + "type": "string", + "description": "An example of the representation." + }, + "schemaId": { + "type": "string", + "description": "Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." + }, + "typeName": { + "type": "string", + "description": "Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." + }, + "formParameters": { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "description": "Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.." + } + }, + "required": [ + "contentType" + ], + "description": "Operation request/response representation details." + }, + "RequestContract": { + "properties": { + "description": { + "type": "string", + "description": "Operation request description." + }, + "queryParameters": { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "description": "Collection of operation request query parameters." + }, + "headers": { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "description": "Collection of operation request headers." + }, + "representations": { + "type": "array", + "items": { + "$ref": "#/definitions/RepresentationContract" + }, + "description": "Collection of operation request representations." + } + }, + "description": "Operation request details." + }, + "ResponseContract": { + "properties": { + "statusCode": { + "type": "integer", + "format": "int32", + "description": "Operation response HTTP status code." + }, + "description": { + "type": "string", + "description": "Operation response description." + }, + "representations": { + "type": "array", + "items": { + "$ref": "#/definitions/RepresentationContract" + }, + "description": "Collection of operation response representations." + }, + "headers": { + "type": "array", + "items": { + "$ref": "#/definitions/ParameterContract" + }, + "description": "Collection of operation response headers." + } + }, + "required": [ + "statusCode" + ], + "description": "Operation response details." + }, + "SubscriptionKeyParameterNamesContract": { + "properties": { + "header": { + "type": "string", + "description": "Subscription key header name." + }, + "query": { + "type": "string", + "description": "Subscription key query string parameter name." + } + }, + "description": "Subscription key parameter names details.", + "example": { + "subscriptionKeyParameterNames": { + "query": "customQueryParameterName", + "header": "customHeaderParameterName" + } + } + }, + "SchemaCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SchemaContract" + }, + "description": "Api Schema Contract value.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "The response of the list schema operation." + }, + "SchemaContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SchemaContractProperties", + "description": "Properties of the Schema." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Schema Contract details." + }, + "SchemaContractProperties": { + "properties": { + "contentType": { + "type": "string", + "description": "Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml)." + }, + "document": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SchemaDocumentProperties", + "description": "Properties of the Schema Document." + } + }, + "required": [ + "contentType" + ], + "description": "Schema contract Properties." + }, + "SchemaDocumentProperties": { + "properties": { + "value": { + "type": "string", + "description": "Json escaped string defining the document representing the Schema." + } + }, + "description": "Schema Document Properties." + }, + "IssueCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IssueContract" + }, + "description": "Issue values.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Issue list representation." + }, + "IssueContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IssueContractProperties", + "description": "Properties of the Issue." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Issue Contract details." + }, + "IssueContractProperties": { + "properties": { + "title": { + "type": "string", + "description": "The issue title." + }, + "description": { + "type": "string", + "description": "Text describing the issue." + }, + "createdDate": { + "type":"string", + "format": "date-time", + "description": "Date and time when the issue was created." + }, + "state": { + "type": "string", + "description": "Status of the issue.", + "enum": [ + "proposed", + "open", + "removed", + "resolved", + "closed" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true, + "values": [ + { + "value": "proposed", + "description": "The issue is proposed." + }, + { + "value": "open", + "description": "The issue is opened." + }, + { + "value": "removed", + "description": "The issue was removed." + }, + { + "value": "resolved", + "description": "The issue is now resolved." + }, + { + "value": "closed", + "description": "The issue was closed." + } + ] + } + }, + "userId": { + "type": "string", + "description": "A resource identifier for the user created the issue." + }, + "apiId": { + "type": "string", + "description": "A resource identifier for the API the issue was created for." + } + }, + "required": [ + "title", + "description", + "userId" + ], + "description": "Issue contract Properties." + }, + "IssueCommentCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IssueCommentContract" + }, + "description": "Issue Comment values.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Issue Comment list representation." + }, + "IssueCommentContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IssueCommentContractProperties", + "description": "Properties of the Issue Comment." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Issue Comment Contract details." + }, + "IssueCommentContractProperties": { + "properties": { + "text": { + "type": "string", + "description": "Comment text." + }, + "createdDate": { + "type":"string", + "format": "date-time", + "description": "Date and time when the comment was created." + }, + "userId": { + "type": "string", + "description": "A resource identifier for the user who left the comment." + } + }, + "required": [ + "text", + "userId" + ], + "description": "Issue Comment contract Properties." + }, + "IssueAttachmentCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IssueAttachmentContract" + }, + "description": "Issue Attachment values.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Next page link if any.", + "readOnly": true + } + }, + "description": "Paged Issue Attachment list representation." + }, + "IssueAttachmentContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IssueAttachmentContractProperties", + "description": "Properties of the Issue Attachment." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Issue Attachment Contract details." + }, + "IssueAttachmentContractProperties": { + "properties": { + "title": { + "type": "string", + "description": "Filename by which the binary data will be saved." + }, + "contentFormat": { + "type":"string", + "description": "Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property." + }, + "content": { + "type": "string", + "description": "An HTTP link or Base64-encoded binary data." + } + }, + "required": [ + "title", + "contentFormat", + "content" + ], + "description": "Issue Attachment contract Properties." + } + }, + "parameters": { + "ApiIdParameter": { + "name": "apiId", + "in": "path", + "required": true, + "type": "string", + "description": "API identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + }, + "ApiIdRevParameter": { + "name": "apiId", + "in": "path", + "required": true, + "type": "string", + "description": "API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation identifier within an API. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + }, + "SchemaIdParameter": { + "name": "schemaId", + "in": "path", + "required": true, + "type": "string", + "description": "Schema identifier within an API. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + }, + "ReleaseIdParameter": { + "name": "releaseId", + "in": "path", + "required": true, + "type": "string", + "description": "Release identifier within an API. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + }, + "IssueIdParameter": { + "name": "issueId", + "in": "path", + "required": true, + "type": "string", + "description": "Issue identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "CommentIdParameter": { + "name": "commentId", + "in": "path", + "required": true, + "type": "string", + "description": "Comment identifier within an Issue. Must be unique in the current Issue.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + }, + "AttachmentIdParameter": { + "name": "attachmentId", + "in": "path", + "required": true, + "type": "string", + "description": "Attachment identifier within an Issue. Must be unique in the current Issue.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimauthorizationservers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimauthorizationservers.json new file mode 100644 index 000000000000..2693ed6cf265 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimauthorizationservers.json @@ -0,0 +1,682 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for managing OAuth2 servers configuration in your Azure API Management deployment. OAuth 2.0 can be used to authorize developer accounts for Azure API Management. For more information refer to [How to OAuth2](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-oauth2).", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers": { + "get": { + "tags": [ + "AuthorizationServers" + ], + "operationId": "AuthorizationServer_ListByService", + "description": "Lists a collection of authorization servers defined within a service instance.", + "x-ms-examples": { + "ApiManagementListAuthorizationServers": { + "$ref": "./examples/ApiManagementListAuthorizationServers.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Authorization Server entities for the specified API Management service instance.", + "schema": { + "$ref": "#/definitions/AuthorizationServerCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/AuthorizationServerContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}": { + "head": { + "tags": [ + "AuthorizationServers" + ], + "operationId": "AuthorizationServer_GetEntityTag", + "description": "Gets the entity state (Etag) version of the authorizationServer specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadAuthorizationServer": { + "$ref": "./examples/ApiManagementHeadAuthorizationServer.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AuthenticationServerIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified authorization server entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "AuthorizationServers" + ], + "operationId": "AuthorizationServer_Get", + "description": "Gets the details of the authorization server specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetAuthorizationServer": { + "$ref": "./examples/ApiManagementGetAuthorizationServer.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AuthenticationServerIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the details of the specified authorization server.", + "schema": { + "$ref": "#/definitions/AuthorizationServerContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AuthorizationServers" + ], + "operationId": "AuthorizationServer_CreateOrUpdate", + "description": "Creates new authorization server or updates an existing authorization server.", + "x-ms-examples": { + "ApiManagementCreateAuthorizationServer": { + "$ref": "./examples/ApiManagementCreateAuthorizationServer.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AuthenticationServerIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorizationServerContract" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Authorization server was successfully registered.", + "schema": { + "$ref": "#/definitions/AuthorizationServerContract" + } + }, + "200": { + "description": "Authorization server is already registered.", + "schema": { + "$ref": "#/definitions/AuthorizationServerContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "AuthorizationServers" + ], + "operationId": "AuthorizationServer_Update", + "description": "Updates the details of the authorization server specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateAuthorizationServer": { + "$ref": "./examples/ApiManagementUpdateAuthorizationServer.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AuthenticationServerIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AuthorizationServerUpdateContract" + }, + "description": "OAuth2 Server settings Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The authorization server settings were successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "AuthorizationServers" + ], + "operationId": "AuthorizationServer_Delete", + "description": "Deletes specific authorization server instance.", + "x-ms-examples": { + "ApiManagementDeleteAuthorizationServer": { + "$ref": "./examples/ApiManagementDeleteAuthorizationServer.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AuthenticationServerIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The authorization server settings were successfully deleted." + }, + "204": { + "description": "The authorization server settings were successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AuthorizationServerCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AuthorizationServerContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged OAuth2 Authorization Servers list representation." + }, + "AuthorizationServerContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AuthorizationServerContractProperties", + "description": "Properties of the External OAuth authorization server Contract." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "External OAuth authorization server settings." + }, + "AuthorizationServerContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "User-friendly authorization server name.", + "minLength": 1, + "maxLength": 50 + }, + "clientRegistrationEndpoint": { + "type": "string", + "description": "Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced." + }, + "authorizationEndpoint": { + "type": "string", + "description": "OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2." + }, + "grantTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "authorizationCode", + "implicit", + "resourceOwnerPassword", + "clientCredentials" + ], + "x-ms-enum": { + "name": "GrantType", + "modelAsString": true, + "values": [ + { + "value": "authorizationCode", + "description": "Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1." + }, + { + "value": "implicit", + "description": "Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2." + }, + { + "value": "resourceOwnerPassword", + "description": "Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3." + }, + { + "value": "clientCredentials", + "description": "Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4." + } + ] + } + }, + "description": "Form of an authorization grant, which the client uses to request the access token.", + "externalDocs": { + "url": "http://tools.ietf.org/html/rfc6749#section-4" + } + }, + "clientId": { + "type": "string", + "description": "Client or app id registered with this authorization server." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AuthorizationServerContractBaseProperties" + } + ], + "required": [ + "displayName", + "clientRegistrationEndpoint", + "authorizationEndpoint", + "clientId", + "grantTypes" + ], + "description": "External OAuth authorization server settings Properties." + }, + "AuthorizationServerUpdateContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AuthorizationServerUpdateContractProperties", + "description": "Properties of the External OAuth authorization server update Contract." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "External OAuth authorization server settings." + }, + "AuthorizationServerUpdateContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "User-friendly authorization server name.", + "minLength": 1, + "maxLength": 50 + }, + "clientRegistrationEndpoint": { + "type": "string", + "description": "Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced." + }, + "authorizationEndpoint": { + "type": "string", + "description": "OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2." + }, + "grantTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "authorizationCode", + "implicit", + "resourceOwnerPassword", + "clientCredentials" + ], + "x-ms-enum": { + "name": "GrantType", + "modelAsString": true, + "values": [ + { + "value": "authorizationCode", + "description": "Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1." + }, + { + "value": "implicit", + "description": "Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2." + }, + { + "value": "resourceOwnerPassword", + "description": "Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3." + }, + { + "value": "clientCredentials", + "description": "Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4." + } + ] + } + }, + "description": "Form of an authorization grant, which the client uses to request the access token.", + "externalDocs": { + "url": "http://tools.ietf.org/html/rfc6749#section-4" + } + }, + "clientId": { + "type": "string", + "description": "Client or app id registered with this authorization server." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AuthorizationServerContractBaseProperties" + } + ], + "description": "External OAuth authorization server Update settings contract." + }, + "AuthorizationServerContractBaseProperties": { + "properties": { + "description": { + "type": "string", + "description": "Description of the authorization server. Can contain HTML formatting tags." + }, + "authorizationMethods": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "HEAD", + "OPTIONS", + "TRACE", + "GET", + "POST", + "PUT", + "PATCH", + "DELETE" + ], + "x-ms-enum": { + "name": "AuthorizationMethod", + "modelAsString": false + } + }, + "description": "HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional." + }, + "clientAuthenticationMethod": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Basic", + "Body" + ], + "x-ms-enum": { + "name": "ClientAuthenticationMethod", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "Basic Client Authentication method." + }, + { + "value": "Body", + "description": "Body based Authentication method." + } + ] + } + }, + "description": "Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format." + }, + "tokenBodyParameters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenBodyParameterContract" + }, + "description": "Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {\"name\" : \"name value\", \"value\": \"a value\"}." + }, + "tokenEndpoint": { + "type": "string", + "description": "OAuth token endpoint. Contains absolute URI to entity being referenced.", + "externalDocs": { + "url": "http://tools.ietf.org/html/rfc6749#section-3.1" + } + }, + "supportState": { + "type": "boolean", + "description": "If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.", + "externalDocs": { + "url": "http://tools.ietf.org/html/rfc6749#section-3.1" + } + }, + "defaultScope": { + "type": "string", + "description": "Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.", + "externalDocs": { + "url": "http://tools.ietf.org/html/rfc6749#section-3.3" + } + }, + "bearerTokenSendingMethods": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "authorizationHeader", + "query" + ], + "x-ms-enum": { + "name": "BearerTokenSendingMethod", + "modelAsString": true + } + }, + "description": "Specifies the mechanism by which access token is passed to the API. ", + "externalDocs": { + "url": "http://tools.ietf.org/html/rfc6749#section-4" + } + }, + "clientSecret": { + "type": "string", + "description": "Client or app secret registered with this authorization server." + }, + "resourceOwnerUsername": { + "type": "string", + "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username." + }, + "resourceOwnerPassword": { + "type": "string", + "description": "Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password." + } + }, + "description": "External OAuth authorization server Update settings contract." + }, + "TokenBodyParameterContract": { + "properties": { + "name": { + "type": "string", + "description": "body parameter name." + }, + "value": { + "type": "string", + "description": "body parameter value." + } + }, + "required": [ + "name", + "value" + ], + "description": "OAuth acquire token request body parameter (www-url-form-encoded)." + } + }, + "parameters": { + "AuthenticationServerIdParameter": { + "name": "authsid", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the authorization server.", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimbackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimbackends.json new file mode 100644 index 000000000000..442b78e9219d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimbackends.json @@ -0,0 +1,770 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Backend entity in Azure API Management deployment. The Backend entity in API Management represents a backend service that is configured to skip certification chain validation when using a self-signed certificate to test mutual certificate authentication.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends": { + "get": { + "tags": [ + "Backends" + ], + "operationId": "Backend_ListByService", + "description": "Lists a collection of backends in the specified service instance.", + "x-ms-examples": { + "ApiManagementListBackends": { + "$ref": "./examples/ApiManagementListBackends.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| host | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Backend entities.", + "schema": { + "$ref": "#/definitions/BackendCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/BackendContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendid}": { + "head": { + "tags": [ + "Backends" + ], + "operationId": "Backend_GetEntityTag", + "description": "Gets the entity state (Etag) version of the backend specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadBackend": { + "$ref": "./examples/ApiManagementHeadBackend.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BackendIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified backend entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Backends" + ], + "operationId": "Backend_Get", + "description": "Gets the details of the backend specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetBackend": { + "$ref": "./examples/ApiManagementGetBackend.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BackendIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Backend entity.", + "schema": { + "$ref": "#/definitions/BackendContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Backends" + ], + "operationId": "Backend_CreateOrUpdate", + "description": "Creates or Updates a backend.", + "x-ms-examples": { + "ApiManagementCreateBackendServiceFabric": { + "$ref": "./examples/ApiManagementCreateBackendServiceFabric.json" + }, + "ApiManagementCreateBackendProxyBackend": { + "$ref": "./examples/ApiManagementCreateBackendProxyBackend.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BackendIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BackendContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Backend was successfully created.", + "schema": { + "$ref": "#/definitions/BackendContract" + } + }, + "200": { + "description": "The existing backend was successfully updated.", + "schema": { + "$ref": "#/definitions/BackendContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Backends" + ], + "operationId": "Backend_Update", + "description": "Updates an existing backend.", + "x-ms-examples": { + "ApiManagementUpdateBackend": { + "$ref": "./examples/ApiManagementUpdateBackend.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BackendIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BackendUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The existing backend was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Backends" + ], + "operationId": "Backend_Delete", + "x-ms-examples": { + "ApiManagementDeleteBackend": { + "$ref": "./examples/ApiManagementDeleteBackend.json" + } + }, + "description": "Deletes the specified backend.", + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BackendIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The backend was successfully deleted." + }, + "204": { + "description": "The backend was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendid}/reconnect": { + "post": { + "tags": [ + "Backends" + ], + "operationId": "Backend_Reconnect", + "description": "Notifies the APIM proxy to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.", + "x-ms-examples": { + "ApiManagementBackendReconnect": { + "$ref": "./examples/ApiManagementBackendReconnect.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/BackendIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/BackendReconnectContract" + }, + "description": "Reconnect request parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Reconnect request accepted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "BackendAuthorizationHeaderCredentials": { + "properties": { + "scheme": { + "type": "string", + "description": "Authentication Scheme name.", + "minLength": 1, + "maxLength": 100 + }, + "parameter": { + "type": "string", + "description": "Authentication Parameter value.", + "minLength": 1, + "maxLength": 300 + } + }, + "required": [ + "scheme", + "parameter" + ], + "description": "Authorization header information." + }, + "BackendBaseParameters": { + "properties": { + "title": { + "type": "string", + "description": "Backend Title.", + "minLength": 1, + "maxLength": 300 + }, + "description": { + "type": "string", + "description": "Backend Description.", + "minLength": 1, + "maxLength": 2000 + }, + "resourceId": { + "type": "string", + "description": "Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.", + "minLength": 1, + "maxLength": 2000 + }, + "properties": { + "$ref": "#/definitions/BackendProperties", + "description": "Backend Properties contract" + }, + "credentials": { + "$ref": "#/definitions/BackendCredentialsContract", + "description": "Backend Credentials Contract Properties" + }, + "proxy": { + "$ref": "#/definitions/BackendProxyContract", + "description": "Backend Proxy Contract Properties" + }, + "tls": { + "$ref": "#/definitions/BackendTlsProperties", + "description": "Backend TLS Properties" + } + }, + "description": "Backend entity base Parameter set." + }, + "BackendCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BackendContract" + }, + "description": "Backend values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Backend list representation." + }, + "BackendContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BackendContractProperties", + "description": "Backend entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Backend details." + }, + "BackendContractProperties": { + "properties": { + "url": { + "type": "string", + "description": "Runtime Url of the Backend.", + "minLength": 1, + "maxLength": 2000 + }, + "protocol": { + "type": "string", + "enum": [ + "http", + "soap" + ], + "x-ms-enum": { + "name": "BackendProtocol", + "modelAsString": true, + "values": [ + { + "value": "http", + "description": "The Backend is a RESTful service." + }, + { + "value": "soap", + "description": "The Backend is a SOAP service." + } + ] + }, + "description": "Backend communication protocol." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BackendBaseParameters" + } + ], + "required": [ + "url", + "protocol" + ], + "description": "Parameters supplied to the Create Backend operation." + }, + "BackendCredentialsContract": { + "properties": { + "certificate": { + "type": "array", + "items": { + "type": "string" + }, + "maxItems": 32, + "description": "List of Client Certificate Thumbprint." + }, + "query": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Query Parameter description." + }, + "header": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Header Parameter description." + }, + "authorization": { + "description": "Authorization header authentication", + "$ref": "#/definitions/BackendAuthorizationHeaderCredentials" + } + }, + "description": "Details of the Credentials used to connect to Backend." + }, + "BackendProperties": { + "properties": { + "serviceFabricCluster": { + "$ref": "#/definitions/BackendServiceFabricClusterProperties", + "description": "Backend Service Fabric Cluster Properties" + } + }, + "description": "Properties specific to the Backend Type." + }, + "BackendServiceFabricClusterProperties": { + "properties": { + "clientCertificatethumbprint": { + "description": "The client certificate thumbprint for the management endpoint.", + "type": "string" + }, + "maxPartitionResolutionRetries": { + "description": "Maximum number of retries while attempting resolve the parition.", + "format": "int32", + "type": "integer" + }, + "managementEndpoints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The cluster management endpoint." + }, + "serverCertificateThumbprints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Thumbprints of certificates cluster management service uses for tls communication" + }, + "serverX509Names": { + "type": "array", + "items": { + "$ref": "#/definitions/X509CertificateName" + }, + "description": "Server X509 Certificate Names Collection" + } + }, + "required": [ + "managementEndpoints", + "clientCertificatethumbprint" + ], + "description": "Properties of the Service Fabric Type Backend." + }, + "X509CertificateName": { + "properties": { + "name": { + "description": "Common Name of the Certificate.", + "type": "string" + }, + "issuerCertificateThumbprint": { + "description": "Thumbprint for the Issuer of the Certificate.", + "type": "string" + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-windows-cluster-x509-security" + }, + "description": "Properties of server X509Names." + }, + "BackendTlsProperties": { + "properties": { + "validateCertificateChain": { + "description": "Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.", + "type": "boolean", + "default": true + }, + "validateCertificateName": { + "description": "Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.", + "type": "boolean", + "default": true + } + }, + "description": "Properties controlling TLS Certificate Validation." + }, + "BackendProxyContract": { + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/system.net.webproxy(v=vs.110).aspx", + "description": "Backend entity uses these details to connect to a WebProxy." + }, + "properties": { + "url": { + "type": "string", + "description": "WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.", + "minLength": 1, + "maxLength": 2000 + }, + "username": { + "type": "string", + "description": "Username to connect to the WebProxy server" + }, + "password": { + "type": "string", + "description": "Password to connect to the WebProxy Server" + } + }, + "required": [ + "url" + ], + "description": "Details of the Backend WebProxy Server to use in the Request to Backend." + }, + "BackendUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BackendUpdateParameterProperties", + "description": "Backend entity update contract properties." + } + }, + "description": "Backend update parameters." + }, + "BackendUpdateParameterProperties": { + "properties": { + "url": { + "type": "string", + "description": "Runtime Url of the Backend.", + "minLength": 1, + "maxLength": 2000 + }, + "protocol": { + "type": "string", + "enum": [ + "http", + "soap" + ], + "x-ms-enum": { + "name": "BackendProtocol", + "modelAsString": true, + "values": [ + { + "value": "http", + "description": "The Backend is a RESTful service." + }, + { + "value": "soap", + "description": "The Backend is a SOAP service." + } + ] + }, + "description": "Backend communication protocol." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BackendBaseParameters" + } + ], + "description": "Parameters supplied to the Update Backend operation." + }, + "BackendReconnectContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BackendReconnectProperties", + "description": "Reconnect request properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Reconnect request parameters." + }, + "BackendReconnectProperties": { + "properties": { + "after": { + "type": "string", + "format": "duration", + "description": "Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconect is PT2M." + } + }, + "description": "Properties to control reconnect requests." + } + }, + "parameters": { + "BackendIdParameter": { + "name": "backendid", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the Backend entity. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimcertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimcertificates.json new file mode 100644 index 000000000000..f545727ba475 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimcertificates.json @@ -0,0 +1,401 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Certificate entity in your Azure API Management deployment. Certificates can be used to setup mutual authentication with your Backend in API Management. For more information refer to [How to secure backend using Mutual Auth Certificate](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-mutual-certificates).", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates": { + "get": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_ListByService", + "description": "Lists a collection of all certificates in the specified service instance.", + "x-ms-examples": { + "ApiManagementListCertificates": { + "$ref": "./examples/ApiManagementListCertificates.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|----------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| subject | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| thumbprint | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| expirationDate | ge, le, eq, ne, gt, lt | N/A |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns a collection of Certificate entity.", + "schema": { + "$ref": "#/definitions/CertificateCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/CertificateContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}": { + "head": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_GetEntityTag", + "description": "Gets the entity state (Etag) version of the certificate specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadCertificate": { + "$ref": "./examples/ApiManagementHeadCertificate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/CertificateIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified certificate entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_Get", + "description": "Gets the details of the certificate specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetCertificate": { + "$ref": "./examples/ApiManagementGetCertificate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/CertificateIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Certificate entity.", + "schema": { + "$ref": "#/definitions/CertificateContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_CreateOrUpdate", + "description": "Creates or updates the certificate being used for authentication with the backend.", + "externalDocs": { + "description": "How to secure back-end services using client certificate authentication in Azure API Management", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/" + }, + "x-ms-examples": { + "ApiManagementCreateCertificate": { + "$ref": "./examples/ApiManagementCreateCertificate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/CertificateIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateCreateOrUpdateParameters" + }, + "description": "Create or Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new certificate was successfully added.", + "schema": { + "$ref": "#/definitions/CertificateContract" + } + }, + "200": { + "description": "The certificate details were successfully updated.", + "schema": { + "$ref": "#/definitions/CertificateContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_Delete", + "description": "Deletes specific certificate.", + "x-ms-examples": { + "ApiManagementDeleteCertificate": { + "$ref": "./examples/ApiManagementDeleteCertificate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/CertificateIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The certificate was successfully deleted." + }, + "204": { + "description": "The certificate was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "CertificateCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Certificates list representation." + }, + "CertificateContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CertificateContractProperties", + "description": "Certificate properties details." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Certificate details." + }, + "CertificateContractProperties": { + "properties": { + "subject": { + "type": "string", + "description": "Subject attribute of the certificate." + }, + "thumbprint": { + "type": "string", + "description": "Thumbprint of the certificate." + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + } + }, + "required": [ + "subject", + "thumbprint", + "expirationDate" + ], + "description": "Properties of the Certificate contract." + }, + "CertificateCreateOrUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CertificateCreateOrUpdateProperties", + "description": "Certificate create or update properties details." + } + }, + "description": "Certificate create or update details." + }, + "CertificateCreateOrUpdateProperties": { + "properties": { + "data": { + "type": "string", + "description": "Base 64 encoded certificate using the application/x-pkcs12 representation." + }, + "password": { + "type": "string", + "description": "Password for the Certificate" + } + }, + "required": [ + "data", + "password" + ], + "description": "Parameters supplied to the CreateOrUpdate certificate operation." + } + }, + "parameters": { + "CertificateIdParameter": { + "name": "certificateId", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json new file mode 100644 index 000000000000..9ffca9a104d3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json @@ -0,0 +1,1420 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs to manage Azure API Management deployment.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ApiManagement/operations": { + "get": { + "tags": [ + "ApiManagementOperations" + ], + "description": "Lists all of the available REST API operations of the Microsoft.ApiManagement provider.", + "operationId": "ApiManagementOperations_List", + "x-ms-examples": { + "ApiManagementListOperations": { + "$ref": "./examples/ApiManagementListOperations.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_Restore", + "description": "Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementRestoreService": { + "$ref": "./examples/ApiManagementRestoreService.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceBackupRestoreParameters" + }, + "description": "Parameters supplied to the Restore API Management service from backup operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully restored the backup onto the API Management service.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_Backup", + "description": "Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementCreateBackup": { + "$ref": "./examples/ApiManagementCreateBackup.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceBackupRestoreParameters" + }, + "description": "Parameters supplied to the ApiManagementService_Backup operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully backed up the API Management service to the storage account.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}": { + "put": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_CreateOrUpdate", + "description": "Creates or updates an API Management service. This is long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementCreateService": { + "$ref": "./examples/ApiManagementCreateService.json" + }, + "ApiManagementCreateMultiRegionServiceWithCustomHostname": { + "$ref": "./examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json" + }, + "ApiManagementCreateServiceHavingMsi": { + "$ref": "./examples/ApiManagementCreateServiceHavingMsi.json" + }, + "ApiManagementCreateServiceWithSystemCertificates": { + "$ref": "./examples/ApiManagementCreateServiceWithSystemCertificates.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + }, + "description": "Parameters supplied to the CreateOrUpdate API Management service operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The service was successfully set up.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "Accepted the configuration change when updating the service.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_Update", + "description": "Updates an existing API Management service.", + "x-ms-examples": { + "ApiManagementUpdateServiceDisableTls10": { + "$ref": "./examples/ApiManagementUpdateServiceDisableTls10.json" + }, + "ApiManagementUpdateServicePublisherDetails": { + "$ref": "./examples/ApiManagementUpdateServicePublisherDetails.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceUpdateParameters" + }, + "description": "Parameters supplied to the CreateOrUpdate API Management service operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The service was successfully updated.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "The service update request was Accepted." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_Get", + "description": "Gets an API Management service resource description.", + "x-ms-examples": { + "ApiManagementServiceGetService": { + "$ref": "./examples/ApiManagementServiceGetService.json" + }, + "ApiManagementServiceGetServiceHavingMsi": { + "$ref": "./examples/ApiManagementServiceGetServiceHavingMsi.json" + }, + "ApiManagementServiceGetMultiRegionInternalVnet": { + "$ref": "./examples/ApiManagementServiceGetMultiRegionInternalVnet.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully got the API Management Service Resource.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + } + } + }, + "delete": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_Delete", + "description": "Deletes an existing API Management service.", + "x-ms-examples": { + "ApiManagementServiceDeleteService": { + "$ref": "./examples/ApiManagementServiceDeleteService.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Service was successfully deleted." + }, + "204": { + "description": "Service is already deleted." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service": { + "get": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_ListByResourceGroup", + "description": "List all API Management services within a resource group.", + "x-ms-examples": { + "ApiManagementListServiceBySubscriptionAndResourceGroup": { + "$ref": "./examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The API Management service list.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/service": { + "get": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_List", + "description": "Lists all API Management services within an Azure subscription.", + "x-ms-examples": { + "ApiManagementListServiceBySubscription": { + "$ref": "./examples/ApiManagementListServiceBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The API Management service list.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/getssotoken": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_GetSsoToken", + "description": "Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.", + "x-ms-examples": { + "ApiManagementServiceGetSsoToken": { + "$ref": "./examples/ApiManagementServiceGetSsoToken.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK if successful with the SSO Redirect URI.", + "schema": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiManagementServiceGetSsoTokenResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/checkNameAvailability": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_CheckNameAvailability", + "description": "Checks availability and correctness of a name for an API Management service.", + "x-ms-examples": { + "ApiManagementServiceCheckNameAvailability": { + "$ref": "./examples/ApiManagementServiceCheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceCheckNameAvailabilityParameters" + }, + "description": "Parameters supplied to the CheckNameAvailability operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The result of check name availability.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceNameAvailabilityResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_ApplyNetworkConfigurationUpdates", + "description": "Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated network settings.", + "x-ms-examples": { + "ApiManagementApplyNetworkConfigurationUpdates": { + "$ref": "./examples/ApiManagementApplyNetworkConfigurationUpdates.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApiManagementServiceApplyNetworkConfigurationParameters" + }, + "description": "Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." + }, + "200": { + "description": "Network configuration updates were successfully applied on the Api Management service.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/updatecertificate": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_UploadCertificate", + "description": "Upload Custom Domain SSL certificate for an API Management service. This operation will be deprecated in future releases.", + "x-ms-examples": { + "ApiManagementServiceUploadProxyCertificate": { + "$ref": "./examples/ApiManagementServiceUploadProxyCertificate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceUploadCertificateParameters" + }, + "description": "Parameters supplied to the Upload SSL certificate for an API Management service operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully uploaded certificate to the API Management Service.", + "schema": { + "$ref": "#/definitions/CertificateInformation" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/updatehostname": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementService_UpdateHostname", + "description": "Creates, updates, or deletes the custom hostnames for an API Management service. The custom hostname can be applied to the Proxy and Portal endpoint. This is a long running operation and could take several minutes to complete. This operation will be deprecated in the next version update.", + "x-ms-examples": { + "ApiManagementServiceUpdateHostName": { + "$ref": "./examples/ApiManagementServiceUpdateHostName.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceUpdateHostnameParameters" + }, + "description": "Parameters supplied to the UpdateHostname operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Service was successfully updated with desired hostnames.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "Accepted. The location header contains the URL where the status of the long running operation can be checked. The response also includes the unmodified ApiManagementServiceResource.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "CertificateInformation": { + "properties": { + "expiry": { + "type": "string", + "format": "date-time", + "description": "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "thumbprint": { + "type": "string", + "description": "Thumbprint of the certificate." + }, + "subject": { + "type": "string", + "description": "Subject of the certificate." + } + }, + "required": [ + "expiry", + "thumbprint", + "subject" + ], + "description": "SSL certificate information." + }, + "CertificateConfiguration": { + "properties": { + "encodedCertificate": { + "type": "string", + "description": "Base64 Encoded certificate." + }, + "certificatePassword": { + "type": "string", + "description": "Certificate Password." + }, + "storeName": { + "description": "The System.Security.Cryptography.x509certificates.Storename certificate store location. Only Root and CertificateAuthority are valid locations.", + "type": "string", + "enum": [ + "CertificateAuthority", + "Root" + ] + }, + "certificate": { + "$ref": "#/definitions/CertificateInformation", + "description": "Certificate information.", + "readOnly": true + } + }, + "required": [ + "storeName" + ], + "description": "Certificate configuration which consist of non-trusted intermediates and root certificates." + }, + "HostnameConfiguration": { + "properties": { + "type": { + "type": "string", + "description": "Hostname type.", + "enum": [ + "Proxy", + "Portal", + "Management", + "Scm" + ], + "x-ms-enum": { + "name": "HostnameType", + "modelAsString": false + } + }, + "hostName": { + "type": "string", + "description": "Hostname to configure on the Api Management service." + }, + "keyVaultId": { + "type": "string", + "description": "Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with MSI. The secret should be of type *application/x-pkcs12*" + }, + "encodedCertificate": { + "type": "string", + "description": "Base64 Encoded certificate." + }, + "certificatePassword": { + "type": "string", + "description": "Certificate Password." + }, + "defaultSslBinding": { + "type": "boolean", + "description": "Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.", + "default": false + }, + "negotiateClientCertificate": { + "type": "boolean", + "description": "Specify true to always negotiate client certificate on the hostname. Default Value is false.", + "default": false + }, + "certificate": { + "$ref": "#/definitions/CertificateInformation", + "description": "Certificate information.", + "readOnly": true + } + }, + "required": [ + "type", + "hostName" + ], + "description": "Custom hostname configuration." + }, + "VirtualNetworkConfiguration": { + "properties": { + "vnetid": { + "readOnly": true, + "type": "string", + "description": "The virtual network ID. This is typically a GUID. Expect a null GUID by default." + }, + "subnetname": { + "readOnly": true, + "type": "string", + "description": "The name of the subnet." + }, + "subnetResourceId": { + "type": "string", + "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$", + "description": "The full resource ID of a subnet in a virtual network to deploy the API Management service in." + } + }, + "description": "Configuration of a virtual network to which API Management service is deployed." + }, + "AdditionalLocation": { + "properties": { + "location": { + "type": "string", + "description": "The location name of the additional region among Azure Data center regions." + }, + "sku": { + "$ref": "#/definitions/ApiManagementServiceSkuProperties", + "description": "SKU properties of the API Management service." + }, + "publicIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU." + }, + "privateIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard and Premium SKU." + }, + "virtualNetworkConfiguration": { + "$ref": "#/definitions/VirtualNetworkConfiguration", + "description": "Virtual network configuration for the location." + }, + "gatewayRegionalUrl": { + "type": "string", + "description": "Gateway URL of the API Management service in the Region.", + "readOnly": true + } + }, + "required": [ + "location", + "sku" + ], + "description": "Description of an additional API Management resource location." + }, + "ApiManagementServiceBackupRestoreParameters": { + "properties": { + "storageAccount": { + "type": "string", + "description": "Azure Cloud Storage account (used to place/retrieve the backup) name." + }, + "accessKey": { + "type": "string", + "description": "Azure Cloud Storage account (used to place/retrieve the backup) access key." + }, + "containerName": { + "type": "string", + "description": "Azure Cloud Storage blob container name used to place/retrieve the backup." + }, + "backupName": { + "type": "string", + "description": "The name of the backup file to create." + } + }, + "required": [ + "storageAccount", + "accessKey", + "containerName", + "backupName" + ], + "description": "Parameters supplied to the Backup/Restore of an API Management service operation." + }, + "ApiManagementServiceProperties": { + "properties": { + "publisherEmail": { + "type": "string", + "description": "Publisher email.", + "maxLength": 100 + }, + "publisherName": { + "type": "string", + "description": "Publisher name.", + "maxLength": 100 + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiManagementServiceBaseProperties" + } + ], + "required": [ + "publisherEmail", + "publisherName" + ], + "description": "Properties of an API Management service resource description." + }, + "ApiManagementServiceUpdateProperties": { + "properties": { + "publisherEmail": { + "type": "string", + "description": "Publisher email.", + "maxLength": 100 + }, + "publisherName": { + "type": "string", + "description": "Publisher name.", + "maxLength": 100 + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiManagementServiceBaseProperties" + } + ], + "description": "Properties of an API Management service resource description." + }, + "ApiManagementServiceBaseProperties": { + "properties": { + "notificationSenderEmail": { + "type": "string", + "description": "Email address from which the notification will be sent.", + "maxLength": 100 + }, + "provisioningState": { + "type": "string", + "description": "The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.", + "readOnly": true + }, + "targetProvisioningState": { + "type": "string", + "description": "The provisioning state of the API Management service, which is targeted by the long running operation started on the service.", + "readOnly": true + }, + "createdAtUtc": { + "type": "string", + "format": "date-time", + "description": "Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.", + "readOnly": true + }, + "gatewayUrl": { + "type": "string", + "description": "Gateway URL of the API Management service.", + "readOnly": true + }, + "gatewayRegionalUrl": { + "type": "string", + "description": "Gateway URL of the API Management service in the Default Region.", + "readOnly": true + }, + "portalUrl": { + "type": "string", + "description": "Publisher portal endpoint Url of the API Management service.", + "readOnly": true + }, + "managementApiUrl": { + "type": "string", + "description": "Management API endpoint URL of the API Management service.", + "readOnly": true + }, + "scmUrl": { + "type": "string", + "description": "SCM endpoint URL of the API Management service.", + "readOnly": true + }, + "hostnameConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/HostnameConfiguration" + }, + "description": "Custom hostname configuration of the API Management service." + }, + "publicIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU." + }, + "privateIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU." + }, + "virtualNetworkConfiguration": { + "$ref": "#/definitions/VirtualNetworkConfiguration", + "description": "Virtual network configuration of the API Management service." + }, + "additionalLocations": { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalLocation" + }, + "description": "Additional datacenter locations of the API Management service." + }, + "customProperties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Custom properties of the API Management service. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1 and setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service." + }, + "certificates": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateConfiguration" + }, + "description": "List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10." + }, + "virtualNetworkType": { + "type": "string", + "description": "The type of VPN in which API Managemet service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", + "default": "None", + "enum": [ + "None", + "External", + "Internal" + ], + "x-ms-enum": { + "name": "VirtualNetworkType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "The service is not part of any Virtual Network." + }, + { + "value": "External", + "description": "The service is part of Virtual Network and it is accessible from Internet." + }, + { + "value": "Internal", + "description": "The service is part of Virtual Network and it is only accessible from within the virtual network." + } + ] + } + } + }, + "description": "Base Properties of an API Management service resource description." + }, + "ApiManagementServiceSkuProperties": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Sku.", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" + }, + "enum": [ + "Developer", + "Standard", + "Premium", + "Basic" + ], + "x-ms-enum": { + "name": "SkuType", + "modelAsString": true, + "values": [ + { + "value": "Developer", + "description": "Developer SKU of Api Management." + }, + { + "value": "Standard", + "description": "Standard SKU of Api Management." + }, + { + "value": "Premium", + "description": "Premium SKU of Api Management." + }, + { + "value": "Basic", + "description": "Basic SKU of Api Management." + } + ] + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Capacity of the SKU (number of deployed units of the SKU). The default value is 1.", + "default": 1 + } + }, + "required": [ + "name" + ], + "description": "API Management service resource SKU properties." + }, + "ApiManagementServiceResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiManagementServiceProperties", + "description": "Properties of the API Management service." + }, + "sku": { + "$ref": "#/definitions/ApiManagementServiceSkuProperties", + "description": "SKU properties of the API Management service." + }, + "identity": { + "$ref": "#/definitions/ApiManagementServiceIdentity", + "description": "Managed service identity of the Api Management service." + }, + "location": { + "type": "string", + "description": "Resource location.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "etag": { + "type": "string", + "description": "ETag of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApimResource" + } + ], + "required": [ + "location", + "sku", + "properties" + ], + "description": "A single API Management service resource in List or Get response." + }, + "ApimResource": { + "description": "The Resource definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "type": "string", + "description": "Resource name.", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type for API Management resource is set to Microsoft.ApiManagement." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "x-ms-azure-resource": true + }, + "ApiManagementServiceUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiManagementServiceUpdateProperties", + "description": "Properties of the API Management service." + }, + "sku": { + "$ref": "#/definitions/ApiManagementServiceSkuProperties", + "description": "SKU properties of the API Management service." + }, + "identity": { + "$ref": "#/definitions/ApiManagementServiceIdentity", + "description": "Managed service identity of the Api Management service." + }, + "etag": { + "type": "string", + "description": "ETag of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApimResource" + } + ], + "description": "Parameter supplied to Update Api Management Service." + }, + "ApiManagementServiceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiManagementServiceResource" + }, + "description": "Result of the List API Management services operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." + } + }, + "required": [ + "value" + ], + "description": "The response of the List API Management services operation." + }, + "ApiManagementServiceGetSsoTokenResult": { + "properties": { + "redirectUri": { + "type": "string", + "description": "Redirect URL to the Publisher Portal containing the SSO token." + } + }, + "description": "The response of the GetSsoToken operation." + }, + "ApiManagementServiceCheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "The name to check for availability." + } + }, + "required": [ + "name" + ], + "description": "Parameters supplied to the CheckNameAvailability operation." + }, + "ApiManagementServiceNameAvailabilityResult": { + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "True if the name is available and can be used to create a new API Management service; otherwise false.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name.", + "readOnly": true + }, + "reason": { + "type": "string", + "description": "Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.", + "enum": [ + "Valid", + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "NameAvailabilityReason", + "modelAsString": false + } + } + }, + "description": "Response of the CheckNameAvailability operation." + }, + "ApiManagementServiceApplyNetworkConfigurationParameters": { + "properties": { + "location": { + "type": "string", + "description": "Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required." + } + }, + "description": "Parameter supplied to the Apply Network configuration operation." + }, + "ApiManagementServiceUploadCertificateParameters": { + "properties": { + "type": { + "type": "string", + "description": "Hostname type.", + "enum": [ + "Proxy", + "Portal", + "Management", + "Scm" + ], + "x-ms-enum": { + "name": "HostnameType", + "modelAsString": false + } + }, + "certificate": { + "type": "string", + "description": "Base64 Encoded certificate." + }, + "certificate_password": { + "type": "string", + "description": "Certificate password." + } + }, + "required": [ + "type", + "certificate", + "certificate_password" + ], + "description": "Parameters supplied to the Upload SSL certificate for an API Management service operation." + }, + "ApiManagementServiceIdentity": { + "description": "Identity properties of the Api Management service resource.", + "properties": { + "type": { + "type": "string", + "description": "The identity type. Currently the only supported type is 'SystemAssigned'.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "ApimIdentityType", + "modelAsString": true + } + }, + "principalId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "The principal id of the identity." + }, + "tenantId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "The client tenant id of the identity." + } + }, + "required": [ + "type" + ] + }, + "HostnameConfigurationOld": { + "properties": { + "type": { + "type": "string", + "description": "Hostname type.", + "enum": [ + "Proxy", + "Portal", + "Management", + "Scm" + ], + "x-ms-enum": { + "name": "HostnameType", + "modelAsString": false + } + }, + "hostname": { + "type": "string", + "description": "Hostname to configure." + }, + "certificate": { + "$ref": "#/definitions/CertificateInformation", + "description": "Certificate information." + } + }, + "required": [ + "type", + "hostname", + "certificate" + ], + "description": "Custom hostname configuration." + }, + "ApiManagementServiceUpdateHostnameParameters": { + "properties": { + "update": { + "type": "array", + "items": { + "$ref": "#/definitions/HostnameConfigurationOld" + }, + "description": "Hostnames to create or update." + }, + "delete": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Proxy", + "Portal", + "Management", + "Scm" + ], + "x-ms-enum": { + "name": "HostnameType", + "modelAsString": false + } + }, + "description": "Hostnames types to delete." + } + }, + "description": "Parameters supplied to the UpdateHostname operation." + }, + "Operation": { + "description": "REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that describes the operation.", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "operation": { + "description": "Operation type: read, write, delete, listKeys/action, etc.", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "description": "Friendly name of the operation", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The operation origin." + }, + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The operation properties." + } + } + }, + "OperationListResult": { + "description": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of operations supported by the resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + } + }, + "parameters": {} +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdiagnostics.json new file mode 100644 index 000000000000..396d6a0f5903 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdiagnostics.json @@ -0,0 +1,509 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Diagnostic entity associated with your Azure API Management deployment. Diagnostics are used to log requests/responses in the APIM proxy.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics": { + "get": { + "tags": [ + "Diagnostics" + ], + "operationId": "Diagnostic_ListByService", + "description": "Lists all diagnostics of the API Management service instance.", + "x-ms-examples": { + "ApiManagementListDiagnostics": { + "$ref": "./examples/ApiManagementListDiagnostics.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + } + ], + "responses": { + "200": { + "description": "Paged Result reponse of diagnostics.", + "schema": { + "$ref": "#/definitions/DiagnosticCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DiagnosticContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}": { + "head": { + "tags": [ + "Diagnostics" + ], + "operationId": "Diagnostic_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Diagnostic specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadDiagnostic": { + "$ref": "./examples/ApiManagementHeadDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Diagnostics" + ], + "operationId": "Diagnostic_Get", + "description": "Gets the details of the Diagnostic specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetDiagnostic": { + "$ref": "./examples/ApiManagementGetDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Diagnostic entity.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Diagnostics" + ], + "operationId": "Diagnostic_CreateOrUpdate", + "description": "Creates a new Diagnostic or updates an existing one.", + "x-ms-examples": { + "ApiManagementCreateDiagnostic": { + "$ref": "./examples/ApiManagementCreateDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/DiagnosticIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Diagnostic was successfully created.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + } + }, + "200": { + "description": "Diagnostic was successfully updated.", + "schema": { + "$ref": "#/definitions/DiagnosticContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Diagnostics" + ], + "operationId": "Diagnostic_Update", + "description": "Updates the details of the Diagnostic specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateDiagnostic": { + "$ref": "./examples/ApiManagementUpdateDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/DiagnosticIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiagnosticContract" + }, + "description": "Diagnostic Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The Diagnostic was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Diagnostics" + ], + "operationId": "Diagnostic_Delete", + "description": "Deletes the specified Diagnostic.", + "x-ms-examples": { + "ApiManagementDeleteDiagnostic": { + "$ref": "./examples/ApiManagementDeleteDiagnostic.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/DiagnosticIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Diagnostic was successfully deleted." + }, + "204": { + "description": "The Diagnostic was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "DiagnosticCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Diagnostic list representation." + }, + "DiagnosticContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiagnosticContractProperties", + "description": "Diagnostic entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Diagnostic details." + }, + "SamplingSettings": { + "properties": { + "samplingType": { + "type": "string", + "description": "Sampling type.", + "enum": [ + "fixed" + ], + "x-ms-enum": { + "name": "SamplingType", + "modelAsString": true, + "values": [ + { + "value": "fixed", + "description": "Fixed-rate sampling." + } + ] + } + }, + "percentage": { + "type": "number", + "format": "double", + "minimum": 0, + "maximum": 100, + "description": "Rate of sampling for fixed-rate sampling." + } + }, + "description": "Sampling settings for Diagnostic." + }, + "PipelineDiagnosticSettings": { + "properties": { + "request": { + "$ref": "#/definitions/HttpMessageDiagnostic", + "description": "Diagnostic settings for request." + }, + "response": { + "$ref": "#/definitions/HttpMessageDiagnostic", + "description": "Diagnostic settings for response." + } + }, + "description": "Diagnostic settings for incoming/outcoming HTTP messages to the Gateway." + }, + "HttpMessageDiagnostic": { + "properties": { + "headers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of HTTP Headers to log." + }, + "body": { + "$ref": "#/definitions/BodyDiagnosticSettings", + "description": "Body logging settings." + } + }, + "description": "Http message diagnostic settings." + }, + "BodyDiagnosticSettings": { + "properties": { + "bytes": { + "type": "integer", + "format": "int32", + "maximum": 8192, + "description": "Number of request body bytes to log." + } + }, + "description": "Body logging settings." + }, + "DiagnosticContractProperties": { + "properties": { + "alwaysLog": { + "type": "string", + "enum": [ + "allErrors" + ], + "x-ms-enum": { + "name": "AlwaysLog", + "modelAsString": true, + "values": [ + { + "value": "allErrors", + "description": "Always log all erroneous request regardless of sampling settings." + } + ] + }, + "description": "Specifies for what type of messages sampling settings should not apply." + }, + "loggerId": { + "type": "string", + "description": "Resource Id of a target logger." + }, + "sampling": { + "$ref": "#/definitions/SamplingSettings", + "description": "Sampling settings for Diagnostic." + }, + "frontend": { + "$ref": "#/definitions/PipelineDiagnosticSettings", + "description": "Diagnostic settings for incoming/outcoming HTTP messages to the Gateway." + }, + "backend": { + "$ref": "#/definitions/PipelineDiagnosticSettings", + "description": "Diagnostic settings for incoming/outcoming HTTP messages to the Backend" + } + }, + "required": [ + "loggerId" + ], + "description": "Diagnostic Entity Properties" + } + }, + "parameters": { + "DiagnosticIdParameter": { + "name": "diagnosticId", + "in": "path", + "required": true, + "type": "string", + "description": "Diagnostic identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimemailtemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimemailtemplate.json new file mode 100644 index 000000000000..474c5fe667b6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimemailtemplate.json @@ -0,0 +1,505 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Email Templates associated with your Azure API Management deployment.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates": { + "get": { + "tags": [ + "EmailTemplate" + ], + "operationId": "EmailTemplate_ListByService", + "description": "Lists a collection of properties defined within a service instance.", + "x-ms-examples": { + "ApiManagementListEmailTemplates": { + "$ref": "./examples/ApiManagementListEmailTemplates.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Email Template for the specified API Management service instance.", + "schema": { + "$ref": "#/definitions/EmailTemplateCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/templates/{templateName}": { + "head": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_GetEntityTag", + "description": "Gets the entity state (Etag) version of the email template specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadEmailTemplate": { + "$ref": "./examples/ApiManagementHeadEmailTemplate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TemplateNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified email template entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_Get", + "description": "Gets the details of the email template specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetEmailTemplate": { + "$ref": "./examples/ApiManagementGetEmailTemplate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TemplateNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Email template.", + "schema": { + "$ref": "#/definitions/EmailTemplateContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_CreateOrUpdate", + "description": "Updates an Email Template.", + "x-ms-examples": { + "ApiManagementCreateEmailTemplate": { + "$ref": "./examples/ApiManagementCreateEmailTemplate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TemplateNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EmailTemplateUpdateParameters" + }, + "description": "Email Template update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Email Template was successfully updated.", + "schema": { + "$ref": "#/definitions/EmailTemplateContract" + } + }, + "200": { + "description": "Email Template was successfully updated.", + "schema": { + "$ref": "#/definitions/EmailTemplateContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_Update", + "description": "Updates the specific Email Template.", + "x-ms-examples": { + "ApiManagementUpdateEmailTemplate": { + "$ref": "./examples/ApiManagementUpdateEmailTemplate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TemplateNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EmailTemplateUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Email Template was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "EmailTemplates" + ], + "operationId": "EmailTemplate_Delete", + "description": "Reset the Email Template to default template provided by the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteEmailTemplate": { + "$ref": "./examples/ApiManagementDeleteEmailTemplate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TemplateNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Email Template was successfully reset to default." + }, + "204": { + "description": "Email Template was successfully reset to default." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "EmailTemplateCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EmailTemplateContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged email template list representation." + }, + "EmailTemplateContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EmailTemplateContractProperties", + "description": "Email Template entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Email Template details." + }, + "EmailTemplateContractProperties": { + "properties": { + "subject": { + "type": "string", + "description": "Subject of the Template.", + "minLength": 1, + "maxLength": 1000 + }, + "body": { + "type": "string", + "description": "Email Template Body. This should be a valid XDocument", + "minLength": 1 + }, + "title": { + "type": "string", + "description": "Title of the Template." + }, + "description": { + "type": "string", + "description": "Description of the Email Template." + }, + "isDefault": { + "type": "boolean", + "description": "Whether the template is the default template provided by Api Management or has been edited.", + "readOnly": true + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/EmailTemplateParametersContractProperties" + }, + "description": "Email Template Parameter values." + } + }, + "required": [ + "body", + "subject" + ], + "description": "Email Template Contract properties." + }, + "EmailTemplateUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EmailTemplateUpdateParameterProperties", + "description": "Email Template Update contract properties." + } + }, + "description": "Email Template update Parameters." + }, + "EmailTemplateUpdateParameterProperties": { + "properties": { + "subject": { + "type": "string", + "description": "Subject of the Template.", + "minLength": 1, + "maxLength": 1000 + }, + "title": { + "type": "string", + "description": "Title of the Template." + }, + "description": { + "type": "string", + "description": "Description of the Email Template." + }, + "body": { + "type": "string", + "description": "Email Template Body. This should be a valid XDocument", + "minLength": 1 + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/EmailTemplateParametersContractProperties" + }, + "description": "Email Template Parameter values." + } + }, + "description": "Email Template Update Contract properties." + }, + "EmailTemplateParametersContractProperties": { + "properties": { + "name": { + "type": "string", + "description": "Template parameter name.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-._]+$" + }, + "title": { + "type": "string", + "description": "Template parameter title.", + "minLength": 1, + "maxLength": 4096 + }, + "description": { + "type": "string", + "description": "Template parameter description.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-._]+$" + } + }, + "description": "Email Template Parameter contract." + } + }, + "parameters": { + "TemplateNameParameter": { + "name": "templateName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "applicationApprovedNotificationMessage", + "accountClosedDeveloper", + "quotaLimitApproachingDeveloperNotificationMessage", + "newDeveloperNotificationMessage", + "emailChangeIdentityDefault", + "inviteUserNotificationMessage", + "newCommentNotificationMessage", + "confirmSignUpIdentityDefault", + "newIssueNotificationMessage", + "purchaseDeveloperNotificationMessage", + "passwordResetIdentityDefault", + "passwordResetByAdminNotificationMessage", + "rejectDeveloperNotificationMessage", + "requestDeveloperNotificationMessage" + ], + "x-ms-enum": { + "name": "TemplateName", + "modelAsString": true + }, + "description": "Email Template Name Identifier.", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimgroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimgroups.json new file mode 100644 index 000000000000..1a30970c4bc3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimgroups.json @@ -0,0 +1,735 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Group entity in your Azure API Management deployment. Groups are used to manage the visibility of products to developers. Each API Management service instance comes with the following immutable system groups whose membership is automatically managed by API Management. - **Administrators** - Azure subscription administrators are members of this group. - **Developers** - Authenticated developer portal users fall into this group. - **Guests** - Unauthenticated developer portal users are placed into this group. In addition to these system groups, administrators can create custom groups or [leverage external groups in associated Azure Active Directory tenants](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-aad#how-to-add-an-external-azure-active-directory-group). Custom and external groups can be used alongside system groups in giving developers visibility and access to API products. For example, you could create one custom group for developers affiliated with a specific partner organization and allow them access to the APIs from a product containing relevant APIs only. A user can be a member of more than one group.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups": { + "get": { + "tags": [ + "Groups" + ], + "operationId": "Group_ListByService", + "description": "Lists a collection of groups defined within a service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-groups" + }, + "x-ms-examples": { + "ApiManagementListGroups": { + "$ref": "./examples/ApiManagementListGroups.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| type | eq, ne | N/A |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Group entities.", + "schema": { + "$ref": "#/definitions/GroupCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/GroupContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}": { + "head": { + "tags": [ + "Groups" + ], + "operationId": "Group_GetEntityTag", + "description": "Gets the entity state (Etag) version of the group specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadGroup": { + "$ref": "./examples/ApiManagementHeadGroup.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified group entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Groups" + ], + "operationId": "Group_Get", + "description": "Gets the details of the group specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetGroup": { + "$ref": "./examples/ApiManagementGetGroup.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Group entity.", + "schema": { + "$ref": "#/definitions/GroupContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Groups" + ], + "operationId": "Group_CreateOrUpdate", + "description": "Creates or Updates a group.", + "x-ms-examples": { + "ApiManagementCreateGroup": { + "$ref": "./examples/ApiManagementCreateGroup.json" + }, + "ApiManagementCreateGroupExternal": { + "$ref": "./examples/ApiManagementCreateGroupExternal.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GroupCreateParameters" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Group was created succesfully.", + "schema": { + "$ref": "#/definitions/GroupContract" + } + }, + "200": { + "description": "Group already exists.", + "schema": { + "$ref": "#/definitions/GroupContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Groups" + ], + "operationId": "Group_Update", + "description": "Updates the details of the group specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateGroup": { + "$ref": "./examples/ApiManagementUpdateGroup.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GroupUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The group details were successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Groups" + ], + "operationId": "Group_Delete", + "description": "Deletes specific group of the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteGroup": { + "$ref": "./examples/ApiManagementDeleteGroup.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The group was successfully deleted." + }, + "204": { + "description": "The group was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users": { + "get": { + "tags": [ + "GroupUsers" + ], + "operationId": "GroupUser_List", + "description": "Lists a collection of the members of the group, specified by its identifier.", + "x-ms-examples": { + "ApiManagementListGroupUsers": { + "$ref": "./examples/ApiManagementListGroupUsers.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|------------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | N/A |\n| registrationDate | ge, le, eq, ne, gt, lt | N/A |\n| note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of user entities associated with the group.", + "schema": { + "$ref": "./apimusers.json#/definitions/UserCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimusers.json#/definitions/UserContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{uid}": { + "head": { + "tags": [ + "GroupUsers" + ], + "operationId": "GroupUser_CheckEntityExists", + "description": "Checks that user entity specified by identifier is associated with the group entity.", + "x-ms-examples": { + "ApiManagementHeadGroupUser": { + "$ref": "./examples/ApiManagementHeadGroupUser.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimusers.json#/parameters/UserIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Entity exists" + }, + "404" : { + "description": "Entity does not exists." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "GroupUsers" + ], + "operationId": "GroupUser_Create", + "description": "Adds a user to the specified group.", + "x-ms-examples": { + "ApiManagementCreateGroupUser": { + "$ref": "./examples/ApiManagementCreateGroupUser.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimusers.json#/parameters/UserIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The user was successfully added to the group.", + "schema": { + "$ref": "./apimusers.json#/definitions/UserContract" + } + }, + "200": { + "description": "The specified user is already a member of the specified group.", + "schema": { + "$ref": "./apimusers.json#/definitions/UserContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "GroupUsers" + ], + "operationId": "GroupUser_Delete", + "description": "Remove existing user from existing group.", + "x-ms-examples": { + "ApiManagementDeleteGroupUser": { + "$ref": "./examples/ApiManagementDeleteGroupUser.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimusers.json#/parameters/UserIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The user was successfully removed from the group." + }, + "204": { + "description": "The user was successfully removed from the group." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "GroupCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GroupContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Group list representation." + }, + "GroupContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GroupContractProperties", + "description": "Group entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Contract details." + }, + "GroupContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Group name.", + "maxLength": 300, + "minLength": 1 + }, + "description": { + "type": "string", + "description": "Group description. Can contain HTML formatting tags.", + "maxLength": 1000 + }, + "builtIn": { + "readOnly": true, + "type": "boolean", + "description": "true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false." + }, + "type": { + "type": "string", + "description": "Group type.", + "enum": [ + "custom", + "system", + "external" + ], + "x-ms-enum": { + "name": "GroupType", + "modelAsString": false + } + }, + "externalId": { + "type": "string", + "description": "For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://.onmicrosoft.com/groups/; otherwise the value is null." + } + }, + "required": [ + "displayName" + ], + "description": "Group contract Properties." + }, + "GroupCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GroupCreateParametersProperties", + "description": "Properties supplied to Create Group operation." + } + }, + "description": "Parameters supplied to the Create Group operation." + }, + "GroupCreateParametersProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Group name.", + "maxLength": 300, + "minLength": 1 + }, + "description": { + "type": "string", + "description": "Group description." + }, + "type": { + "type": "string", + "description": "Group type.", + "enum": [ + "custom", + "system", + "external" + ], + "x-ms-enum": { + "name": "GroupType", + "modelAsString": false + } + }, + "externalId": { + "type": "string", + "description": "Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://.onmicrosoft.com/groups/; otherwise the value is null." + } + }, + "required": [ + "displayName" + ], + "description": "Parameters supplied to the Create Group operation." + }, + "GroupUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GroupUpdateParametersProperties", + "description": "Group entity update contract properties." + } + }, + "description": "Parameters supplied to the Update Group operation." + }, + "GroupUpdateParametersProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Group name.", + "maxLength": 300, + "minLength": 1 + }, + "description": { + "type": "string", + "description": "Group description." + }, + "type": { + "type": "string", + "description": "Group type.", + "enum": [ + "custom", + "system", + "external" + ], + "x-ms-enum": { + "name": "GroupType", + "modelAsString": false + } + }, + "externalId": { + "type": "string", + "description": "Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://.onmicrosoft.com/groups/; otherwise the value is null." + } + }, + "description": "Parameters supplied to the Update Group operation." + } + }, + "parameters": { + "GroupIdParameter": { + "name": "groupId", + "in": "path", + "required": true, + "type": "string", + "description": "Group identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimidentityprovider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimidentityprovider.json new file mode 100644 index 000000000000..65c6a9c7caf0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimidentityprovider.json @@ -0,0 +1,552 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Identity Provider entity associated with your Azure API Management deployment. Setting up an external Identity Provider for authentication can help you manage the developer portal logins using the OAuth2 flow.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders": { + "get": { + "tags": [ + "IdentityProvider" + ], + "operationId": "IdentityProvider_ListByService", + "description": "Lists a collection of Identity Provider configured in the specified service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-aad#how-to-authorize-developer-accounts-using-azure-active-directory" + }, + "x-ms-examples": { + "ApiManagementListIdentityProviders": { + "$ref": "./examples/ApiManagementListIdentityProviders.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Lists a collection of Identity Providers.", + "schema": { + "$ref": "#/definitions/IdentityProviderList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}": { + "head": { + "tags": [ + "IdentityProvider" + ], + "operationId": "IdentityProvider_GetEntityTag", + "description": "Gets the entity state (Etag) version of the identityProvider specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadIdentityProvider": { + "$ref": "./examples/ApiManagementHeadIdentityProvider.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/IdentityProviderNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Specified identity provider entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "IdentityProvider" + ], + "operationId": "IdentityProvider_Get", + "description": "Gets the configuration details of the identity Provider configured in specified service instance.", + "x-ms-examples": { + "ApiManagementGetIdentityProvider": { + "$ref": "./examples/ApiManagementGetIdentityProvider.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/IdentityProviderNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified IdentityProvider entity configuration details.", + "schema": { + "$ref": "#/definitions/IdentityProviderContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "IdentityProvider" + ], + "operationId": "IdentityProvider_CreateOrUpdate", + "description": "Creates or Updates the IdentityProvider configuration.", + "x-ms-examples": { + "ApiManagementCreateIdentityProvider": { + "$ref": "./examples/ApiManagementCreateIdentityProvider.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/IdentityProviderNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IdentityProviderContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "IdentityProvider configuration were successfully created.", + "schema": { + "$ref": "#/definitions/IdentityProviderContract" + } + }, + "200": { + "description": "The existing Identity Provider was successfully updated.", + "schema": { + "$ref": "#/definitions/IdentityProviderContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "IdentityProviders" + ], + "operationId": "IdentityProvider_Update", + "description": "Updates an existing IdentityProvider configuration.", + "x-ms-examples": { + "ApiManagementUpdateIdentityProvider": { + "$ref": "./examples/ApiManagementUpdateIdentityProvider.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/IdentityProviderNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IdentityProviderUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The existing identity provider configuration was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "IdentityProvider" + ], + "operationId": "IdentityProvider_Delete", + "description": "Deletes the specified identity provider configuration.", + "x-ms-examples": { + "ApiManagementDeleteIdentityProvider": { + "$ref": "./examples/ApiManagementDeleteIdentityProvider.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/IdentityProviderNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The identity provider configuration was successfully deleted." + }, + "204": { + "description": "The identity provider configuration was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "IdentityProviderContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IdentityProviderContractProperties", + "description": "Identity Provider contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Identity Provider details." + }, + "IdentityProviderContractProperties": { + "properties": { + "clientId": { + "type": "string", + "description": "Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.", + "minLength": 1 + }, + "clientSecret": { + "type": "string", + "description": "Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.", + "minLength": 1 + } + }, + "allOf": [ + { + "$ref": "#/definitions/IdentityProviderBaseParameters" + } + ], + "required": [ + "clientId", + "clientSecret" + ], + "description": "The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users." + }, + "IdentityProviderList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IdentityProviderContract" + }, + "description": "Identity Provider configuration values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "List of all the Identity Providers configured on the service instance." + }, + "IdentityProviderUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IdentityProviderUpdateProperties", + "description": "Identity Provider update properties." + } + }, + "description": "Parameters supplied to update Identity Provider" + }, + "IdentityProviderUpdateProperties": { + "properties": { + "clientId": { + "type": "string", + "description": "Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.", + "minLength": 1 + }, + "clientSecret": { + "type": "string", + "description": "Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.", + "minLength": 1 + } + }, + "allOf": [ + { + "$ref": "#/definitions/IdentityProviderBaseParameters" + } + ], + "description": "Parameters supplied to the Update Identity Provider operation." + }, + "IdentityProviderBaseParameters": { + "properties": { + "type": { + "type": "string", + "enum": [ + "facebook", + "google", + "microsoft", + "twitter", + "aad", + "aadB2C" + ], + "x-ms-enum": { + "name": "IdentityProviderType", + "modelAsString": true, + "values": [ + { + "value": "facebook", + "description": "Facebook as Identity provider." + }, + { + "value": "google", + "description": "Google as Identity provider." + }, + { + "value": "microsoft", + "description": "Microsoft Live as Identity provider." + }, + { + "value": "twitter", + "description": "Twitter as Identity provider." + }, + { + "value": "aad", + "description": "Azure Active Directory as Identity provider." + }, + { + "value": "aadB2C", + "description": "Azure Active Directory B2C as Identity provider." + } + ] + }, + "description": "Identity Provider Type identifier." + }, + "allowedTenants": { + "type": "array", + "items": { + "type": "string" + }, + "maxItems": 32, + "description": "List of Allowed Tenants when configuring Azure Active Directory login." + }, + "signupPolicyName": { + "type": "string", + "description": "Signup Policy Name. Only applies to AAD B2C Identity Provider.", + "minLength": 1 + }, + "signinPolicyName": { + "type": "string", + "description": "Signin Policy Name. Only applies to AAD B2C Identity Provider.", + "minLength": 1 + }, + "profileEditingPolicyName": { + "type": "string", + "description": "Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.", + "minLength": 1 + }, + "passwordResetPolicyName": { + "type": "string", + "description": "Password Reset Policy Name. Only applies to AAD B2C Identity Provider.", + "minLength": 1 + } + }, + "description": "Identity Provider Base Parameter Properties." + } + }, + "parameters": { + "IdentityProviderNameParameter": { + "name": "identityProviderName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "facebook", + "google", + "microsoft", + "twitter", + "aad", + "aadB2C" + ], + "x-ms-enum": { + "name": "IdentityProviderType", + "modelAsString": true, + "values": [ + { + "value": "facebook", + "description": "Facebook as Identity provider." + }, + { + "value": "google", + "description": "Google as Identity provider." + }, + { + "value": "microsoft", + "description": "Microsoft Live as Identity provider." + }, + { + "value": "twitter", + "description": "Twitter as Identity provider." + }, + { + "value": "aad", + "description": "Azure Active Directory as Identity provider." + }, + { + "value": "aadB2C", + "description": "Azure Active Directory B2C as Identity provider." + } + ] + }, + "description": "Identity Provider Type identifier.", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimissues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimissues.json new file mode 100644 index 000000000000..1d945725f8c0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimissues.json @@ -0,0 +1,97 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use this REST API to get all the issues across an Azure Api Management service.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues": { + "get": { + "tags": [ + "Issues" + ], + "operationId": "Issue_ListByService", + "description": "Lists a collection of issues in the specified service instance.", + "x-ms-examples": { + "ApiManagementListLoggers": { + "$ref": "./examples/ApiManagementListIssues.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |\n| state | eq | |\n| userId | ge, le, eq, ne, gt, lt | substringof, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Issue entities.", + "schema": { + "$ref": "./apimapis.json#/definitions/IssueCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimapis.json#/definitions/IssueContract" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimloggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimloggers.json new file mode 100644 index 000000000000..260f0e4506d2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimloggers.json @@ -0,0 +1,516 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on logger entity Azure API Management deployment.The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure EventHub.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers": { + "get": { + "tags": [ + "Loggers" + ], + "operationId": "Logger_ListByService", + "description": "Lists a collection of loggers in the specified service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-log-event-hubs" + }, + "x-ms-examples": { + "ApiManagementListLoggers": { + "$ref": "./examples/ApiManagementListLoggers.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| type | eq | |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Logger entities.", + "schema": { + "$ref": "#/definitions/LoggerCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/LoggerContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerid}": { + "head": { + "tags": [ + "Loggers" + ], + "operationId": "Logger_GetEntityTag", + "description": "Gets the entity state (Etag) version of the logger specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadLogger": { + "$ref": "./examples/ApiManagementHeadLogger.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/LoggerIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified logger entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Loggers" + ], + "operationId": "Logger_Get", + "description": "Gets the details of the logger specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetLogger": { + "$ref": "./examples/ApiManagementGetLogger.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/LoggerIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Logger entity.", + "schema": { + "$ref": "#/definitions/LoggerContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Loggers" + ], + "operationId": "Logger_CreateOrUpdate", + "description": "Creates or Updates a logger.", + "x-ms-examples": { + "ApiManagementCreateEHLogger": { + "$ref": "./examples/ApiManagementCreateEHLogger.json" + }, + "ApiManagementCreateAILogger": { + "$ref": "./examples/ApiManagementCreateAILogger.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/LoggerIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LoggerContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Logger was successfully created.", + "schema": { + "$ref": "#/definitions/LoggerContract" + } + }, + "200": { + "description": "The existing logger was successfully updated.", + "schema": { + "$ref": "#/definitions/LoggerContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Loggers" + ], + "operationId": "Logger_Update", + "description": "Updates an existing logger.", + "x-ms-examples": { + "ApiManagementUpdateLogger": { + "$ref": "./examples/ApiManagementUpdateLogger.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/LoggerIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LoggerUpdateContract" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The existing logger was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Loggers" + ], + "operationId": "Logger_Delete", + "description": "Deletes the specified logger.", + "x-ms-examples": { + "ApiManagementDeleteLogger": { + "$ref": "./examples/ApiManagementDeleteLogger.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/LoggerIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The logger was successfully deleted." + }, + "204": { + "description": "The logger was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "LoggerCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LoggerContract" + }, + "description": "Logger values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Logger list representation." + }, + "LoggerContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LoggerContractProperties", + "description": "Logger entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Logger details." + }, + "LoggerContractProperties": { + "properties": { + "loggerType": { + "type": "string", + "description": "Logger type.", + "enum": [ + "azureEventHub", + "applicationInsights" + ], + "x-ms-enum": { + "name": "LoggerType", + "modelAsString": true, + "values": [ + { + "value": "azureEventHub", + "description": "Azure Event Hub as log destination." + }, + { + "value": "applicationInsights", + "description": "Azure Application Insights as log destination." + } + ] + } + }, + "description": { + "type": "string", + "description": "Logger description.", + "maxLength": 256 + }, + "credentials": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The name and SendRule connection string of the event hub for azureEventHub logger.\nInstrumentation key for applicationInsights logger.", + "example": { + "name": "apim", + "connectionString": "Endpoint=sb://contoso-ns.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=..." + } + }, + "isBuffered": { + "type": "boolean", + "description": "Whether records are buffered in the logger before publishing. Default is assumed to be true." + }, + "resourceId": { + "type": "string", + "description": "Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource)." + } + }, + "required": [ + "loggerType", + "credentials" + ], + "description": "The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs." + }, + "LoggerUpdateContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LoggerUpdateParameters", + "description": "Logger entity update contract properties." + } + }, + "description": "Logger update contract." + }, + "LoggerUpdateParameters": { + "properties": { + "loggerType": { + "type": "string", + "description": "Logger type.", + "enum": [ + "azureEventHub", + "applicationInsights" + ], + "x-ms-enum": { + "name": "LoggerType", + "modelAsString": true, + "values": [ + { + "value": "azureEventHub", + "description": "Azure Event Hub as log destination." + }, + { + "value": "applicationInsights", + "description": "Azure Application Insights as log destination." + } + ] + } + }, + "description": { + "type": "string", + "description": "Logger description." + }, + "credentials": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Logger credentials." + }, + "isBuffered": { + "type": "boolean", + "description": "Whether records are buffered in the logger before publishing. Default is assumed to be true." + } + }, + "description": "Parameters supplied to the Update Logger operation." + } + }, + "parameters": { + "LoggerIdParameter": { + "name": "loggerid", + "in": "path", + "required": true, + "type": "string", + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "description": "Logger identifier. Must be unique in the API Management service instance.", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimnetworkstatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimnetworkstatus.json new file mode 100644 index 000000000000..7a5f342cfa43 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimnetworkstatus.json @@ -0,0 +1,222 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for getting the network connectivity status of your Azure API Management deployment. When the API Management service is deployed inside a Virtual Network, it needs to have access to other Azure resources it depends on. This also gives details about the DNS Servers visible to Azure API Management deployment.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/networkstatus": { + "get": { + "tags": [ + "NetworkStatus" + ], + "operationId": "NetworkStatus_ListByService", + "description": "Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.", + "x-ms-examples": { + "ApiManagementServiceGetNetworkStatus": { + "$ref": "./examples/ApiManagementServiceGetNetworkStatus.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Gets the list Network status details for all regions in which service is deployed.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkStatusContractByLocation" + }, + "description": "List of Network Status values." + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/locations/{locationName}/networkstatus": { + "get": { + "tags": [ + "NetworkStatus" + ], + "operationId": "NetworkStatus_ListByLocation", + "description": "Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.", + "x-ms-examples": { + "ApiManagementServiceGetNetworkStatusByLocation": { + "$ref": "./examples/ApiManagementServiceGetNetworkStatusByLocation.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/LocationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Gets the Network status details.", + "schema": { + "$ref": "#/definitions/NetworkStatusContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ConnectivityStatusContract": { + "properties": { + "name": { + "type": "string", + "description": "The hostname of the resource which the service depends on. This can be the database, storage or any other azure resource on which the service depends upon.", + "minLength": 1 + }, + "status": { + "type": "string", + "enum": [ + "initializing", + "success", + "failure" + ], + "x-ms-enum": { + "name": "ConnectivityStatusType", + "modelAsString": true + }, + "description": "Resource Connectivity Status Type identifier." + }, + "error": { + "type": "string", + "description": "Error details of the connectivity to the resource." + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "The date when the resource connectivity status was last updated. This status should be updated every 15 minutes. If this status has not been updated, then it means that the service has lost network connectivity to the resource, from inside the Virtual Network.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "lastStatusChange": { + "type": "string", + "format": "date-time", + "description": "The date when the resource connectivity status last Changed from success to failure or vice-versa. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + } + }, + "required": [ + "name", + "status", + "lastUpdated", + "lastStatusChange" + ], + "description": "Details about connectivity to a resource." + }, + "NetworkStatusContractByLocation": { + "properties": { + "location": { + "type": "string", + "description": "Location of service", + "minLength": 1 + }, + "networkStatus": { + "$ref": "#/definitions/NetworkStatusContract", + "description": "Network status in Location" + } + }, + "description": "Network Status in the Location" + }, + "NetworkStatusContract": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets the list of DNS servers IPV4 addresses." + }, + "connectivityStatus": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectivityStatusContract" + }, + "description": "Gets the list of Connectivity Status to the Resources on which the service depends upon." + } + }, + "required": [ + "dnsServers", + "connectivityStatus" + ], + "description": "Network Status details." + } + }, + "parameters": { + "LocationNameParameter": { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "Location in which the API Management service is deployed. This is one of the Azure Regions like West US, East US, South Central US.", + "minLength": 1, + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimnotifications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimnotifications.json new file mode 100644 index 000000000000..62ae4c6dac5c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimnotifications.json @@ -0,0 +1,771 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on who is going to receive notifications associated with your Azure API Management deployment.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications": { + "get": { + "tags": [ + "Notification" + ], + "operationId": "Notification_ListByService", + "description": "Lists a collection of properties defined within a service instance.", + "x-ms-examples": { + "ApiManagementListNotification": { + "$ref": "./examples/ApiManagementListNotifications.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Notification for the specified API Management service instance.", + "schema": { + "$ref": "#/definitions/NotificationCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}": { + "get": { + "tags": [ + "Notification" + ], + "operationId": "Notification_Get", + "description": "Gets the details of the Notification specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetNotification": { + "$ref": "./examples/ApiManagementGetNotification.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Notification.", + "schema": { + "$ref": "#/definitions/NotificationContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Notification" + ], + "operationId": "Notification_CreateOrUpdate", + "description": "Updates an Notification.", + "x-ms-examples": { + "ApiManagementGetNotification": { + "$ref": "./examples/ApiManagementGetNotification.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Notification was successfully updated.", + "schema": { + "$ref": "#/definitions/NotificationContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers": { + "get": { + "tags": [ + "Notification" + ], + "operationId": "NotificationRecipientUser_ListByNotification", + "description": "Gets the list of the Notification Recipient User subscribed to the notification.", + "x-ms-examples": { + "ApiManagementListNotificationRecipientUser": { + "$ref": "./examples/ApiManagementListNotificationRecipientUser.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the Recipient User collection for the notification.", + "schema": { + "$ref": "#/definitions/RecipientUserCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientUsers/{uid}": { + "head": { + "tags": [ + "NotificationRecipientUser" + ], + "operationId": "NotificationRecipientUser_CheckEntityExists", + "description": "Determine if the Notification Recipient User is subscribed to the notification.", + "x-ms-examples": { + "ApiManagementHeadNotificationRecipientUser": { + "$ref": "./examples/ApiManagementHeadNotificationRecipientUser.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimusers.json#/parameters/UserIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The User is subscribed to receive the notification." + }, + "404" : { + "description": "Entity does not exists." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "NotificationRecipientUser" + ], + "operationId": "NotificationRecipientUser_CreateOrUpdate", + "description": "Adds the API Management User to the list of Recipients for the Notification.", + "x-ms-examples": { + "ApiManagementCreateRecipientUser": { + "$ref": "./examples/ApiManagementCreateRecipientUser.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimusers.json#/parameters/UserIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Recipient User was successfully added to the notification list.", + "schema": { + "$ref": "#/definitions/RecipientUserContract" + } + }, + "200": { + "description": "Recipient User is already part of the notification list.", + "schema": { + "$ref": "#/definitions/RecipientUserContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "NotificationRecipientUser" + ], + "operationId": "NotificationRecipientUser_Delete", + "description": "Removes the API Management user from the list of Notification.", + "x-ms-examples": { + "ApiManagementDeleteNotificationRecipientUser": { + "$ref": "./examples/ApiManagementDeleteNotificationRecipientUser.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimusers.json#/parameters/UserIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Recipient User was successfully removed from the notification list." + }, + "204": { + "description": "Recipient User was successfully removed from the notification list." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails": { + "get": { + "tags": [ + "NotificationRecipientEmail" + ], + "operationId": "NotificationRecipientEmail_ListByNotification", + "description": "Gets the list of the Notification Recipient Emails subscribed to a notification.", + "x-ms-examples": { + "ApiManagementListNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementListNotificationRecipientEmail.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/NotificationNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the Recipient Email collection subscribed to the notification.", + "schema": { + "$ref": "#/definitions/RecipientEmailCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/notifications/{notificationName}/recipientEmails/{email}": { + "head": { + "tags": [ + "NotificationRecipientEmail" + ], + "operationId": "NotificationRecipientEmail_CheckEntityExists", + "description": "Determine if Notification Recipient Email subscribed to the notification.", + "x-ms-examples": { + "ApiManagementHeadNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementHeadNotificationRecipientEmail.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/NotificationNameParameter" + }, + { + "$ref": "#/parameters/EmailParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The Users is subscribed to receive the notification." + }, + "404" : { + "description": "The Users is not subscribed to receive the notification." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "NotificationRecipientEmail" + ], + "operationId": "NotificationRecipientEmail_CreateOrUpdate", + "description": "Adds the Email address to the list of Recipients for the Notification.", + "x-ms-examples": { + "ApiManagementCreateRecipientEmail": { + "$ref": "./examples/ApiManagementCreateRecipientEmail.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/NotificationNameParameter" + }, + { + "$ref": "#/parameters/EmailParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Recipient Email was successfully added to the notification list.", + "schema": { + "$ref": "#/definitions/RecipientEmailContract" + } + }, + "200": { + "description": "Recipient Email is already part of the notification list.", + "schema": { + "$ref": "#/definitions/RecipientEmailContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "NotificationRecipientEmail" + ], + "operationId": "NotificationRecipientEmail_Delete", + "description": "Removes the email from the list of Notification.", + "x-ms-examples": { + "ApiManagementDeleteNotificationRecipientEmail": { + "$ref": "./examples/ApiManagementDeleteNotificationRecipientEmail.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/NotificationNameParameter" + }, + { + "$ref": "#/parameters/EmailParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Recipient Email was successfully removed to the notification list." + }, + "204": { + "description": "Recipient Email was successfully removed to the notification list." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "NotificationCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NotificationContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Notification list representation." + }, + "NotificationContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NotificationContractProperties", + "description": "Notification entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Notification details." + }, + "NotificationContractProperties": { + "properties": { + "title": { + "type": "string", + "description": "Title of the Notification.", + "minLength": 1, + "maxLength": 1000 + }, + "description": { + "type": "string", + "description": "Description of the Notification." + }, + "recipients": { + "$ref": "#/definitions/RecipientsContractProperties", + "description": "Recipient Parameter values." + } + }, + "required": [ + "title" + ], + "description": "Notification Contract properties." + }, + "RecipientsContractProperties": { + "properties": { + "emails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Emails subscribed for the notification." + }, + "users": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Users subscribed for the notification." + } + }, + "description": "Notification Parameter contract." + }, + "RecipientUserCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RecipientUserContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Recipient User list representation." + }, + "RecipientUserContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RecipientUsersContractProperties", + "description": "Recipient User entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Recipient User details." + }, + "RecipientUsersContractProperties": { + "properties": { + "userId": { + "type": "string", + "description": "API Management UserId subscribed to notification." + } + }, + "description": "Recipient User Contract Properties." + }, + "RecipientEmailCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RecipientEmailContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Recipient User list representation." + }, + "RecipientEmailContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RecipientEmailContractProperties", + "description": "Recipient Email contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Recipient Email details." + }, + "RecipientEmailContractProperties": { + "properties": { + "email": { + "type": "string", + "description": "User Email subscribed to notification." + } + }, + "description": "Recipient Email Contract Properties." + } + }, + "parameters": { + "NotificationNameParameter": { + "name": "notificationName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "RequestPublisherNotificationMessage", + "PurchasePublisherNotificationMessage", + "NewApplicationNotificationMessage", + "BCC", + "NewIssuePublisherNotificationMessage", + "AccountClosedPublisher", + "QuotaLimitApproachingPublisherNotificationMessage" + ], + "x-ms-enum": { + "name": "NotificationName", + "modelAsString": true, + "values": [ + { + "value": "RequestPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval." + }, + { + "value": "PurchasePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions." + }, + { + "value": "NewApplicationNotificationMessage", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery." + }, + { + "value": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers." + }, + { + "value": "NewIssuePublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal." + }, + { + "value": "AccountClosedPublisher", + "description": "The following email recipients and users will receive email notifications when developer closes his account." + }, + { + "value": "QuotaLimitApproachingPublisherNotificationMessage", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota." + } + ] + }, + "description": "Notification Name Identifier.", + "x-ms-parameter-location": "method" + }, + "EmailParameter": { + "name": "email", + "in": "path", + "required": true, + "type": "string", + "description": "Email identifier.", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimopenidconnectproviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimopenidconnectproviders.json new file mode 100644 index 000000000000..3ac00661e497 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimopenidconnectproviders.json @@ -0,0 +1,459 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on OpenId Connect Provider entity associated with your Azure API Management deployment. API Management allows you to access APIs secured with token from [OpenID Connect Provider ](http://openid.net/connect/) to be accessed from the Developer Console.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders": { + "get": { + "tags": [ + "OpenIdConnectProviders" + ], + "operationId": "OpenIdConnectProvider_ListByService", + "description": "Lists all OpenID Connect Providers.", + "x-ms-examples": { + "ApiManagementListOpenIdConnectProviders": { + "$ref": "./examples/ApiManagementListOpenIdConnectProviders.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists of all the OpenId Connect Providers.", + "schema": { + "$ref": "#/definitions/OpenIdConnectProviderCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/OpenidConnectProviderContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}": { + "head": { + "tags": [ + "OpenIdConnectProviders" + ], + "operationId": "OpenIdConnectProvider_GetEntityTag", + "description": "Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementHeadOpenIdConnectProvider.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/OpenIdConnectIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified openidConnectProvider entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "OpenIdConnectProviders" + ], + "operationId": "OpenIdConnectProvider_Get", + "description": "Gets specific OpenID Connect Provider.", + "x-ms-examples": { + "ApiManagementGetOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementGetOpenIdConnectProvider.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/OpenIdConnectIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified OpenId Connect Provider entity.", + "schema": { + "$ref": "#/definitions/OpenidConnectProviderContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "OpenIdConnectProviders" + ], + "operationId": "OpenIdConnectProvider_CreateOrUpdate", + "description": "Creates or updates the OpenID Connect Provider.", + "x-ms-examples": { + "ApiManagementCreateOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementCreateOpenIdConnectProvider.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/OpenIdConnectIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OpenidConnectProviderContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "OpenIdConnect Provider was successfully created.", + "schema": { + "$ref": "#/definitions/OpenidConnectProviderContract" + } + }, + "200": { + "description": "OpenIdConnect Provider was successfully updated.", + "schema": { + "$ref": "#/definitions/OpenidConnectProviderContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "OpenIdConnectProviders" + ], + "operationId": "OpenIdConnectProvider_Update", + "description": "Updates the specific OpenID Connect Provider.", + "x-ms-examples": { + "ApiManagementUpdateOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementUpdateOpenIdConnectProvider.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/OpenIdConnectIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OpenidConnectProviderUpdateContract" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "OpenId Connect Provider was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "OpenIdConnectProviders" + ], + "operationId": "OpenIdConnectProvider_Delete", + "description": "Deletes specific OpenID Connect Provider of the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteOpenIdConnectProvider": { + "$ref": "./examples/ApiManagementDeleteOpenIdConnectProvider.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/OpenIdConnectIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OpenId Connect Provider was successfully deleted." + }, + "204": { + "description": "OpenId Connect Provider was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "OpenIdConnectProviderCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OpenidConnectProviderContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged OpenIdProviders list representation." + }, + "OpenidConnectProviderContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OpenidConnectProviderContractProperties", + "description": "OpenId Connect Provider contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "OpenId Connect Provider details." + }, + "OpenidConnectProviderContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "User-friendly OpenID Connect Provider name.", + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "User-friendly description of OpenID Connect Provider." + }, + "metadataEndpoint": { + "type": "string", + "description": "Metadata endpoint URI." + }, + "clientId": { + "type": "string", + "description": "Client ID of developer console which is the client application." + }, + "clientSecret": { + "type": "string", + "description": "Client Secret of developer console which is the client application." + } + }, + "required": [ + "displayName", + "metadataEndpoint", + "clientId" + ], + "description": "OpenID Connect Providers Contract." + }, + "OpenidConnectProviderUpdateContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OpenidConnectProviderUpdateContractProperties", + "description": "OpenId Connect Provider Update contract properties." + } + }, + "description": "Parameters supplied to the Update OpenID Connect Provider operation." + }, + "OpenidConnectProviderUpdateContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "User-friendly OpenID Connect Provider name.", + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "User-friendly description of OpenID Connect Provider." + }, + "metadataEndpoint": { + "type": "string", + "description": "Metadata endpoint URI." + }, + "clientId": { + "type": "string", + "description": "Client ID of developer console which is the client application." + }, + "clientSecret": { + "type": "string", + "description": "Client Secret of developer console which is the client application." + } + }, + "description": "Parameters supplied to the Update OpenID Connect Provider operation." + } + }, + "parameters": { + "OpenIdConnectIdParameter": { + "name": "opid", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the OpenID Connect Provider.", + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimportalsettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimportalsettings.json new file mode 100644 index 000000000000..eeeb2fd7b637 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimportalsettings.json @@ -0,0 +1,713 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on PortalSettings entity associated with your Azure API Management deployment. Using this entity you can manage settings for a Developer Portal.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signin": { + "head": { + "tags": [ + "SignInSettings" + ], + "operationId": "SignInSettings_GetEntityTag", + "description": "Gets the entity state (Etag) version of the SignInSettings.", + "x-ms-examples": { + "ApiManagementHeadSignInSettings": { + "$ref": "./examples/ApiManagementHeadSignInSettings.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "SignInSettings" + ], + "operationId": "SignInSettings_Get", + "description": "Get Sign-In settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsGetSignIn": { + "$ref": "./examples/ApiManagementPortalSettingsGetSignIn.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Sign-In settings.", + "schema": { + "$ref": "#/definitions/PortalSigninSettings" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + } + } + }, + "patch": { + "tags": [ + "SignInSettings" + ], + "operationId": "SignInSettings_Update", + "description": "Update Sign-In settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateSignIn": { + "$ref": "./examples/ApiManagementPortalSettingsUpdateSignIn.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PortalSigninSettings" + }, + "description": "Update Sign-In settings." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Sign-In settings was updated successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "SignInSettings" + ], + "operationId": "SignInSettings_CreateOrUpdate", + "description": "Create or Update Sign-In settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateSignIn": { + "$ref": "./examples/ApiManagementPortalSettingsPutSignIn.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PortalSigninSettings" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Sign-In settings was successfully updated.", + "schema": { + "$ref": "#/definitions/PortalSigninSettings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signup": { + "head": { + "tags": [ + "SignUpSettings" + ], + "operationId": "SignUpSettings_GetEntityTag", + "description": "Gets the entity state (Etag) version of the SignUpSettings.", + "x-ms-examples": { + "ApiManagementHeadSignUpSettings": { + "$ref": "./examples/ApiManagementHeadSignUpSettings.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "SignUpSettings" + ], + "operationId": "SignUpSettings_Get", + "description": "Get Sign-Up settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsGetSignUp": { + "$ref": "./examples/ApiManagementPortalSettingsGetSignUp.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Sign-Up settings.", + "schema": { + "$ref": "#/definitions/PortalSignupSettings" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + } + } + }, + "patch": { + "tags": [ + "SignUpSettings" + ], + "operationId": "SignUpSettings_Update", + "description": "Update Sign-Up settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateSignUp": { + "$ref": "./examples/ApiManagementPortalSettingsUpdateSignUp.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PortalSignupSettings" + }, + "description": "Update Sign-Up settings." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Sign-Up settings was updated successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "SignUpSettings" + ], + "operationId": "SignUpSettings_CreateOrUpdate", + "description": "Create or Update Sign-Up settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateSignUp": { + "$ref": "./examples/ApiManagementPortalSettingsPutSignUp.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PortalSignupSettings" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Sign-Up settings was successfully updated.", + "schema": { + "$ref": "#/definitions/PortalSignupSettings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/delegation": { + "head": { + "tags": [ + "DelegationSettings" + ], + "operationId": "DelegationSettings_GetEntityTag", + "description": "Gets the entity state (Etag) version of the DelegationSettings.", + "x-ms-examples": { + "ApiManagementHeadDelegationSettings": { + "$ref": "./examples/ApiManagementHeadDelegationSettings.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "DelegationSettings" + ], + "operationId": "DelegationSettings_Get", + "description": "Get Delegation settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsGetDelegation": { + "$ref": "./examples/ApiManagementPortalSettingsGetDelegation.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delegation settings.", + "schema": { + "$ref": "#/definitions/PortalDelegationSettings" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + } + } + }, + "patch": { + "tags": [ + "DelegationSettings" + ], + "operationId": "DelegationSettings_Update", + "description": "Update Delegation settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateDelegation": { + "$ref": "./examples/ApiManagementPortalSettingsUpdateDelegation.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PortalDelegationSettings" + }, + "description": "Update Delegation settings." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delegation settings was updated successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "DelegationSettings" + ], + "operationId": "DelegationSettings_CreateOrUpdate", + "description": "Create or Update Delegation settings.", + "x-ms-examples": { + "ApiManagementPortalSettingsUpdateDelegation": { + "$ref": "./examples/ApiManagementPortalSettingsPutDelegation.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PortalDelegationSettings" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delegation settings was successfully updated.", + "schema": { + "$ref": "#/definitions/PortalDelegationSettings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "PortalSigninSettings": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PortalSigninSettingProperties", + "description": "Sign-in settings contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Sign-In settings for the Developer Portal." + }, + "PortalSigninSettingProperties": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Redirect Anonymous users to the Sign-In page." + } + }, + "description": "Sign-in settings contract properties." + }, + "PortalSignupSettings": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PortalSignupSettingsProperties", + "description": "Sign-up settings contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Sign-Up settings for a developer portal." + }, + "PortalSignupSettingsProperties": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Allow users to sign up on a developer portal." + }, + "termsOfService": { + "type": "object", + "$ref": "#/definitions/TermsOfServiceProperties", + "description": "Terms of service contract properties." + } + }, + "description": "Sign-up settings contract properties." + }, + "TermsOfServiceProperties": { + "properties": { + "text": { + "type": "string", + "description": "A terms of service text." + }, + "enabled": { + "type": "boolean", + "description": "Display terms of service during a sign-up process." + }, + "consentRequired": { + "type": "boolean", + "description": "Ask user for consent to the terms of service." + } + }, + "description": "Terms of service contract properties." + }, + "PortalDelegationSettings": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PortalDelegationSettingsProperties", + "description": "Delegation settings contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Delegation settings for a developer portal." + }, + "PortalDelegationSettingsProperties": { + "properties": { + "url": { + "type": "string", + "description": "A delegation Url." + }, + "validationKey": { + "type": "string", + "description": "A base64-encoded validation key to validate, that a request is coming from Azure API Management." + }, + "subscriptions": { + "$ref": "#/definitions/SubscriptionsDelegationSettingsProperties", + "description": "Subscriptions delegation settings." + }, + "userRegistration": { + "$ref": "#/definitions/RegistrationDelegationSettingsProperties", + "description": "User registration delegation settings." + } + }, + "description": "Delegation settings contract properties." + }, + "SubscriptionsDelegationSettingsProperties": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable or disable delegation for subscriptions." + } + }, + "description": "Subscriptions delegation settings properties." + }, + "RegistrationDelegationSettingsProperties": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable or disable delegation for user registration." + } + }, + "description": "User registration delegation settings properties." + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproducts.json new file mode 100644 index 000000000000..37a2ef0f9277 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproducts.json @@ -0,0 +1,1243 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Product entity associated with your Azure API Management deployment. The Product entity represents a product in API Management. Products include one or more APIs and their associated terms of use. Once a product is published, developers can subscribe to the product and begin to use the product’s APIs.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products": { + "get": { + "tags": [ + "Products" + ], + "operationId": "Product_ListByService", + "description": "Lists a collection of products in the specified service instance.", + "x-ms-examples": { + "ApiManagementListProducts": { + "$ref": "./examples/ApiManagementListProducts.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| terms | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "expandGroups", + "in": "query", + "required": false, + "type": "boolean", + "description": "When set to true, the response contains an array of groups that have visibility to the product. The default is false." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Product entities for the specified API Management service instance.", + "schema": { + "$ref": "#/definitions/ProductCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ProductContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}": { + "head": { + "tags": [ + "Products" + ], + "operationId": "Product_GetEntityTag", + "description": "Gets the entity state (Etag) version of the product specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadProduct": { + "$ref": "./examples/ApiManagementHeadProduct.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Product entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Products" + ], + "operationId": "Product_Get", + "description": "Gets the details of the product specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetProduct": { + "$ref": "./examples/ApiManagementGetProduct.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Product entity.", + "schema": { + "$ref": "#/definitions/ProductContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Products" + ], + "operationId": "Product_CreateOrUpdate", + "description": "Creates or Updates a product.", + "x-ms-examples": { + "ApiManagementCreateProductBasic": { + "$ref": "./examples/ApiManagementCreateProductBasic.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProductContract" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Product was successfully created.", + "schema": { + "$ref": "#/definitions/ProductContract" + } + }, + "200": { + "description": "Product was successfully updated.", + "schema": { + "$ref": "#/definitions/ProductContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Products" + ], + "operationId": "Product_Update", + "description": "Update product.", + "x-ms-examples": { + "ApiManagementUpdateProductBasic": { + "$ref": "./examples/ApiManagementUpdateProductBasic.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProductUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content in case of Update Successfull." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Products" + ], + "operationId": "Product_Delete", + "description": "Delete product.", + "x-ms-examples": { + "ApiManagementDeleteProduct": { + "$ref": "./examples/ApiManagementDeleteProduct.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "name": "deleteSubscriptions", + "in": "query", + "required": false, + "type": "boolean", + "description": "Delete existing subscriptions associated with the product or not." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The product was successfully deleted." + }, + "204": { + "description": "The product was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis": { + "get": { + "tags": [ + "ProductApis" + ], + "operationId": "ProductApi_ListByProduct", + "description": "Lists a collection of the APIs associated with a product.", + "x-ms-examples": { + "ApiManagementListProductApis": { + "$ref": "./examples/ApiManagementListProductApis.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains a collection of Api entities in the product.", + "schema": { + "$ref": "./apimapis.json#/definitions/ApiCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimapis.json#/definitions/ApiContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}": { + "head": { + "tags": [ + "ProductApis" + ], + "operationId": "ProductApi_CheckEntityExists", + "description": "Checks that API entity specified by identifier is associated with the Product entity.", + "x-ms-examples": { + "ApiManagementHeadProductApi": { + "$ref": "./examples/ApiManagementHeadProductApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Entity exists" + }, + "404": { + "description": "API is not associated with the product." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductApis" + ], + "operationId": "ProductApi_CreateOrUpdate", + "description": "Adds an API to the specified product.", + "x-ms-examples": { + "ApiManagementCreateProductApi": { + "$ref": "./examples/ApiManagementCreateProductApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The API was successfully added to the product.", + "schema": { + "$ref": "./apimapis.json#/definitions/ApiContract" + } + }, + "200": { + "description": "The specified API is already added to the product.", + "schema": { + "$ref": "./apimapis.json#/definitions/ApiContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductApis" + ], + "operationId": "ProductApi_Delete", + "description": "Deletes the specified API from the specified product.", + "x-ms-examples": { + "ApiManagementDeleteProductApi": { + "$ref": "./examples/ApiManagementDeleteProductApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The API was successfully removed from the product." + }, + "204": { + "description": "The API was successfully removed from the product." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups": { + "get": { + "tags": [ + "ProductGroups" + ], + "operationId": "ProductGroup_ListByProduct", + "description": "Lists the collection of developer groups associated with the specified product.", + "x-ms-examples": { + "ApiManagementListProductGroups": { + "$ref": "./examples/ApiManagementListProductGroups.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| type | eq, ne | N/A |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Group entities.", + "schema": { + "$ref": "./apimgroups.json#/definitions/GroupCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimgroups.json#/definitions/GroupContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}": { + "head": { + "tags": [ + "ProductGroups" + ], + "operationId": "ProductGroup_CheckEntityExists", + "description": "Checks that Group entity specified by identifier is associated with the Product entity.", + "x-ms-examples": { + "ApiManagementHeadProductGroup": { + "$ref": "./examples/ApiManagementHeadProductGroup.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimgroups.json#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The Group is associated with the Product." + }, + "404": { + "description": "The Group entity is not associated with the Product." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductGroups" + ], + "operationId": "ProductGroup_CreateOrUpdate", + "description": "Adds the association between the specified developer group with the specified product.", + "x-ms-examples": { + "ApiManagementCreateProductGroup": { + "$ref": "./examples/ApiManagementCreateProductGroup.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimgroups.json#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The group was successfully associated with the product.", + "schema": { + "$ref": "./apimgroups.json#/definitions/GroupContract" + } + }, + "200": { + "description": "The specified group is already associated with the product.", + "schema": { + "$ref": "./apimgroups.json#/definitions/GroupContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductGroups" + ], + "operationId": "ProductGroup_Delete", + "description": "Deletes the association between the specified group and product.", + "x-ms-examples": { + "ApiManagementDeleteProductGroup": { + "$ref": "./examples/ApiManagementDeleteProductGroup.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimgroups.json#/parameters/GroupIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The group was successfully disassociated with the product." + }, + "204": { + "description": "The group was successfully disassociated with the product." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions": { + "get": { + "tags": [ + "ProductSubscriptions" + ], + "operationId": "ProductSubscriptions_List", + "description": "Lists the collection of subscriptions to the specified product.", + "x-ms-examples": { + "ApiManagementListProductSubscriptions": { + "$ref": "./examples/ApiManagementListProductSubscriptions.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|--------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of subscription entities.", + "schema": { + "$ref": "./apimsubscriptions.json#/definitions/SubscriptionCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimsubscriptions.json#/definitions/SubscriptionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies": { + "get": { + "tags": [ + "ProductPolicy" + ], + "operationId": "ProductPolicy_ListByProduct", + "description": "Get the policy configuration at the Product level.", + "x-ms-examples": { + "ApiManagementListProductPolicy": { + "$ref": "./examples/ApiManagementListProductPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + } + ], + "responses": { + "200": { + "description": "Product Policy information.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyCollection" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}": { + "head": { + "tags": [ + "ProductPolicy" + ], + "operationId": "ProductPolicy_GetEntityTag", + "description": "Get the ETag of the policy configuration at the Product level.", + "x-ms-examples": { + "ApiManagementHeadProductPolicy": { + "$ref": "./examples/ApiManagementHeadProductPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + } + ], + "responses": { + "200": { + "description": "Product Policy Etag information.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ProductPolicy" + ], + "operationId": "ProductPolicy_Get", + "description": "Get the policy configuration at the Product level.", + "x-ms-examples": { + "ApiManagementGetProductPolicy": { + "$ref": "./examples/ApiManagementGetProductPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + } + ], + "responses": { + "200": { + "description": "Product Policy information.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductPolicy" + ], + "operationId": "ProductPolicy_CreateOrUpdate", + "description": "Creates or updates policy configuration for the Product.", + "x-ms-examples": { + "ApiManagementCreateProductPolicy": { + "$ref": "./examples/ApiManagementCreateProductPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + }, + "required": true, + "description": "The policy contents to apply." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Product policy configuration was successfully created.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + } + }, + "200": { + "description": "Product policy configuration of the tenant was successfully updated.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductPolicy" + ], + "operationId": "ProductPolicy_Delete", + "description": "Deletes the policy configuration at the Product.", + "x-ms-examples": { + "ApiManagementDeleteProductPolicy": { + "$ref": "./examples/ApiManagementDeleteProductPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the policy configuration at the Product level." + }, + "204": { + "description": "Successfully deleted the policy configuration at the Product level." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ProductCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProductContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Products list representation." + }, + "ProductContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProductContractProperties", + "description": "Product entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Product details." + }, + "ProductContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Product name.", + "minLength": 1, + "maxLength": 300 + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProductEntityBaseParameters" + } + ], + "required": [ + "displayName" + ], + "description": "Product profile." + }, + "ProductEntityBaseParameters": { + "properties": { + "description": { + "type": "string", + "description": "Product description. May include HTML formatting tags.", + "minLength": 1, + "maxLength": 1000 + }, + "terms": { + "type": "string", + "description": "Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process." + }, + "subscriptionRequired": { + "description": "Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as \"protected\" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as \"open\" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.", + "type": "boolean" + }, + "approvalRequired": { + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.", + "type": "boolean" + }, + "subscriptionsLimit": { + "type": "integer", + "format": "int32", + "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + }, + "state": { + "type": "string", + "description": "whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.", + "enum": [ + "notPublished", + "published" + ], + "x-ms-enum": { + "name": "ProductState", + "modelAsString": false + } + } + }, + "description": "Product Entity Base Parameters" + }, + "ProductUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProductUpdateProperties", + "description": "Product entity Update contract properties." + } + }, + "description": "Product Update parameters." + }, + "ProductUpdateProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Product name.", + "maxLength": 300, + "minLength": 1 + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProductEntityBaseParameters" + } + ], + "description": "Parameters supplied to the Update Product operation." + } + }, + "parameters": { + "ProductIdParameter": { + "name": "productId", + "in": "path", + "required": true, + "type": "string", + "description": "Product identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproperties.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproperties.json new file mode 100644 index 000000000000..1be0bf615e9f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproperties.json @@ -0,0 +1,472 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Property entity associated with your Azure API Management deployment. API Management policies are a powerful capability of the system that allow the publisher to change the behavior of the API through configuration. Policies are a collection of statements that are executed sequentially on the request or response of an API. Policy statements can be constructed using literal text values, policy expressions, and properties. Each API Management service instance has a properties collection of key/value pairs that are global to the service instance. These properties can be used to manage constant string values across all API configuration and policies.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties": { + "get": { + "tags": [ + "Property" + ], + "operationId": "Property_ListByService", + "description": "Lists a collection of properties defined within a service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties" + }, + "x-ms-examples": { + "ApiManagementListProperties": { + "$ref": "./examples/ApiManagementListProperties.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|-------------------------------------------------------|\n| tags | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A Collection of the Property entities for the specified API Management service instance.", + "schema": { + "$ref": "#/definitions/PropertyCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/PropertyContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties/{propId}": { + "head": { + "tags": [ + "Property" + ], + "operationId": "Property_GetEntityTag", + "description": "Gets the entity state (Etag) version of the property specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadProperty": { + "$ref": "./examples/ApiManagementHeadProperty.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/PropertyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Property entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Property" + ], + "operationId": "Property_Get", + "description": "Gets the details of the property specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetProperty": { + "$ref": "./examples/ApiManagementGetProperty.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/PropertyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Property entity.", + "schema": { + "$ref": "#/definitions/PropertyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Property" + ], + "operationId": "Property_CreateOrUpdate", + "description": "Creates or updates a property.", + "x-ms-examples": { + "ApiManagementCreateProperty": { + "$ref": "./examples/ApiManagementCreateProperty.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/PropertyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PropertyContract" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Property was successfully created.", + "schema": { + "$ref": "#/definitions/PropertyContract" + } + }, + "200": { + "description": "Property was successfully updated.", + "schema": { + "$ref": "#/definitions/PropertyContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Property" + ], + "operationId": "Property_Update", + "description": "Updates the specific property.", + "x-ms-examples": { + "ApiManagementUpdateProperty": { + "$ref": "./examples/ApiManagementUpdateProperty.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/PropertyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PropertyUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Property was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Property" + ], + "operationId": "Property_Delete", + "description": "Deletes specific property from the the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteProperty": { + "$ref": "./examples/ApiManagementDeleteProperty.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/PropertyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Property was successfully deleted." + }, + "204": { + "description": "Property was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "PropertyCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PropertyContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Property list representation." + }, + "PropertyContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PropertyContractProperties", + "description": "Property entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Property details." + }, + "PropertyContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-._]+$" + }, + "value": { + "type": "string", + "description": "Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.", + "minLength": 1, + "maxLength": 4096 + } + }, + "allOf": [ + { + "$ref": "#/definitions/PropertyEntityBaseParameters" + } + ], + "required": [ + "displayName", + "value" + ], + "description": "Property Contract properties." + }, + "PropertyUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PropertyUpdateParameterProperties", + "description": "Property entity Update contract properties." + } + }, + "description": "Property update Parameters." + }, + "PropertyUpdateParameterProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[A-Za-z0-9-._]+$" + }, + "value": { + "type": "string", + "description": "Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.", + "minLength": 1, + "maxLength": 4096 + } + }, + "allOf": [ + { + "$ref": "#/definitions/PropertyEntityBaseParameters" + } + ], + "description": "Property Contract properties." + }, + "PropertyEntityBaseParameters": { + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "maxItems": 32, + "description": "Optional tags that when provided can be used to filter the property list." + }, + "secret": { + "description": "Determines whether the value is a secret and should be encrypted or not. Default value is false.", + "type": "boolean" + } + }, + "description": "Property Entity Base Parameters set." + } + }, + "parameters": { + "PropertyIdParameter": { + "name": "propId", + "in": "path", + "required": true, + "type": "string", + "description": "Identifier of the property.", + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimquotas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimquotas.json new file mode 100644 index 000000000000..320f2834ae6d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimquotas.json @@ -0,0 +1,341 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Quota entity associated with your Azure API Management deployment. To configure call rate limit and quota policies refer to [how to configure call rate limit and quota](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies).", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}": { + "get": { + "tags": [ + "QuotaByCounterKeys" + ], + "operationId": "QuotaByCounterKeys_ListByService", + "description": "Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies", + "description": "Document describing how to configure the quota policies." + }, + "x-ms-examples": { + "ApiManagementGetQuotaCounteryKeys": { + "$ref": "./examples/ApiManagementGetQuotaCounteryKeys.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/QuotaCounterKeyParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of the quota counter values.", + "schema": { + "$ref": "#/definitions/QuotaCounterCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "QuotaByCounterKeys" + ], + "operationId": "QuotaByCounterKeys_Update", + "description": "Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values.", + "x-ms-examples": { + "ApiManagementUpdateQuotaCounterKey": { + "$ref": "./examples/ApiManagementUpdateQuotaCounterKey.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/QuotaCounterKeyParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaCounterValueContractProperties" + }, + "description": "The value of the quota counter to be applied to all quota counter periods." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Quota counter period was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/periods/{quotaPeriodKey}": { + "get": { + "tags": [ + "QuotaByPeriodKeys" + ], + "operationId": "QuotaByPeriodKeys_Get", + "description": "Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-product-with-rules#a-namepolicies-ato-configure-call-rate-limit-and-quota-policies", + "description": "Document describing how to configure the quota policies." + }, + "x-ms-examples": { + "ApiManagementGetQuotaCounteryKeysByQuotaPeriod": { + "$ref": "./examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/QuotaCounterKeyParameter" + }, + { + "$ref": "#/parameters/QuotaPeriodKeyParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the Quota counter details for the specified period.", + "schema": { + "$ref": "#/definitions/QuotaCounterContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "QuotaByPeriodKeys" + ], + "operationId": "QuotaByPeriodKeys_Update", + "description": "Updates an existing quota counter value in the specified service instance.", + "x-ms-examples": { + "ApiManagementUpdateQuotaCounterKeyByQuotaPeriod": { + "$ref": "./examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/QuotaCounterKeyParameter" + }, + { + "$ref": "#/parameters/QuotaPeriodKeyParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaCounterValueContractProperties" + }, + "description": "The value of the Quota counter to be applied on the specified period." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The quota counter value was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "QuotaCounterCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/QuotaCounterContract" + }, + "description": "Quota counter values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Quota Counter list representation." + }, + "QuotaCounterContract": { + "properties": { + "counterKey": { + "type": "string", + "description": "The Key value of the Counter. Must not be empty.", + "minLength": 1 + }, + "periodKey": { + "type": "string", + "description": "Identifier of the Period for which the counter was collected. Must not be empty.", + "minLength": 1 + }, + "periodStartTime": { + "type": "string", + "format": "date-time", + "description": "The date of the start of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "periodEndTime": { + "type": "string", + "format": "date-time", + "description": "The date of the end of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "value": { + "$ref": "#/definitions/QuotaCounterValueContractProperties", + "description": "Quota Value Properties" + } + }, + "required": [ + "counterKey", + "periodKey", + "periodStartTime", + "periodEndTime" + ], + "description": "Quota counter details." + }, + "QuotaCounterValueContract": { + "properties": { + "value": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuotaCounterValueContractProperties", + "description": "Quota counter Value Properties." + } + }, + "description": "Quota counter value details." + }, + "QuotaCounterValueContractProperties": { + "properties": { + "callsCount": { + "type": "integer", + "format": "int32", + "description": "Number of times Counter was called." + }, + "kbTransferred": { + "type": "number", + "format": "double", + "description": "Data Transferred in KiloBytes." + } + }, + "description": "Quota counter value details." + } + }, + "parameters": { + "QuotaCounterKeyParameter": { + "name": "quotaCounterKey", + "in": "path", + "required": true, + "type": "string", + "description": "Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key=\"boo\" in the policy, then it’s accessible by \"boo\" counter key. But if it’s defined as counter-key=\"@(\"b\"+\"a\")\" then it will be accessible by \"ba\" key", + "x-ms-parameter-location": "method" + }, + "QuotaPeriodKeyParameter": { + "name": "quotaPeriodKey", + "in": "path", + "required": true, + "type": "string", + "description": "Quota period key identifier.", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimreports.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimreports.json new file mode 100644 index 000000000000..52508cc6115c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimreports.json @@ -0,0 +1,722 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs to get the analytics reports associated with your Azure API Management deployment.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byApi": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListByApi", + "description": "Lists report records by API.", + "x-ms-examples": { + "ApiManagementGetReportsByApi": { + "$ref": "./examples/ApiManagementGetReportsByApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "#/definitions/ReportCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ReportRecordContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byUser": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListByUser", + "description": "Lists report records by User.", + "x-ms-examples": { + "ApiManagementGetReportsByUser": { + "$ref": "./examples/ApiManagementGetReportsByUser.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "#/definitions/ReportCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ReportRecordContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byOperation": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListByOperation", + "description": "Lists report records by API Operations.", + "x-ms-examples": { + "ApiManagementGetReportsByOperation": { + "$ref": "./examples/ApiManagementGetReportsByOperation.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "#/definitions/ReportCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ReportRecordContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byProduct": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListByProduct", + "description": "Lists report records by Product.", + "x-ms-examples": { + "ApiManagementGetReportsByProduct": { + "$ref": "./examples/ApiManagementGetReportsByProduct.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "#/definitions/ReportCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ReportRecordContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byGeo": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListByGeo", + "description": "Lists report records by GeoGraphy.", + "x-ms-examples": { + "ApiManagementGetReportsByGeo": { + "$ref": "./examples/ApiManagementGetReportsByGeo.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "#/definitions/ReportCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ReportRecordContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/bySubscription": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListBySubscription", + "description": "Lists report records by subscription.", + "x-ms-examples": { + "ApiManagementGetReportsBySubscription": { + "$ref": "./examples/ApiManagementGetReportsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "#/definitions/ReportCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ReportRecordContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byTime": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListByTime", + "description": "Lists report records by Time.", + "x-ms-examples": { + "ApiManagementGetReportsByTime": { + "$ref": "./examples/ApiManagementGetReportsByTime.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "name": "interval", + "in": "query", + "required": true, + "type": "string", + "format": "duration", + "description": "By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, secconds))" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "#/definitions/ReportCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ReportRecordContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/byRequest": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "Reports_ListByRequest", + "description": "Lists report records by Request.", + "x-ms-examples": { + "ApiManagementGetReportsByRequest": { + "$ref": "./examples/ApiManagementGetReportsByRequest.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Report record.", + "schema": { + "$ref": "#/definitions/RequestReportCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-odata": "#/definitions/RequestReportRecordContract" + } + } + }, + "definitions": { + "ReportCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ReportRecordContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Report records list representation." + }, + "ReportRecordContract": { + "properties": { + "name": { + "type": "string", + "description": "Name depending on report endpoint specifies product, API, operation or developer name." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "interval": { + "type": "string", + "description": "Length of agregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations)." + }, + "country": { + "type": "string", + "description": "Country to which this record data is related." + }, + "region": { + "type": "string", + "description": "Country region to which this record data is related." + }, + "zip": { + "type": "string", + "description": "Zip code to which this record data is related." + }, + "userId": { + "readOnly": true, + "type": "string", + "description": "User identifier path. /users/{userId}" + }, + "productId": { + "readOnly": true, + "type": "string", + "description": "Product identifier path. /products/{productId}" + }, + "apiId": { + "type": "string", + "description": "API identifier path. /apis/{apiId}" + }, + "operationId": { + "type": "string", + "description": "Operation identifier path. /apis/{apiId}/operations/{operationId}" + }, + "apiRegion": { + "type": "string", + "description": "API region identifier." + }, + "subscriptionId": { + "type": "string", + "description": "Subscription identifier path. /subscriptions/{subscriptionId}" + }, + "callCountSuccess": { + "type": "integer", + "format": "int32", + "description": "Number of succesful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" + }, + "callCountBlocked": { + "type": "integer", + "format": "int32", + "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorize and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" + }, + "callCountFailed": { + "type": "integer", + "format": "int32", + "description": "Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600" + }, + "callCountOther": { + "type": "integer", + "format": "int32", + "description": "Number of other calls." + }, + "callCountTotal": { + "type": "integer", + "format": "int32", + "description": "Total number of calls." + }, + "bandwidth": { + "type": "integer", + "format": "int64", + "description": "Bandwidth consumed." + }, + "cacheHitCount": { + "type": "integer", + "format": "int32", + "description": "Number of times when content was served from cache policy." + }, + "cacheMissCount": { + "type": "integer", + "format": "int32", + "description": "Number of times content was fetched from backend." + }, + "apiTimeAvg": { + "type": "number", + "format": "double", + "description": "Average time it took to process request." + }, + "apiTimeMin": { + "type": "number", + "format": "double", + "description": "Minimum time it took to process request." + }, + "apiTimeMax": { + "type": "number", + "format": "double", + "description": "Maximum time it took to process request." + }, + "serviceTimeAvg": { + "type": "number", + "format": "double", + "description": "Average time it took to process request on backend." + }, + "serviceTimeMin": { + "type": "number", + "format": "double", + "description": "Minimum time it took to process request on backend." + }, + "serviceTimeMax": { + "type": "number", + "format": "double", + "description": "Maximum time it took to process request on backend." + } + }, + "description": "Report data." + }, + "RequestReportCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RequestReportRecordContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + } + }, + "description": "Paged Report records list representation." + }, + "RequestReportRecordContract": { + "properties": { + "apiId": { + "type": "string", + "description": "API identifier path. /apis/{apiId}" + }, + "operationId": { + "type": "string", + "description": "Operation identifier path. /apis/{apiId}/operations/{operationId}" + }, + "productId": { + "readOnly": true, + "type": "string", + "description": "Product identifier path. /products/{productId}" + }, + "userId": { + "readOnly": true, + "type": "string", + "description": "User identifier path. /users/{userId}" + }, + "method": { + "type": "string", + "description": "The HTTP method associated with this request.." + }, + "url": { + "type": "string", + "description": "The full URL associated with this request." + }, + "ipAddress": { + "type": "string", + "description": "The client IP address associated with this request." + }, + "backendResponseCode": { + "type": "string", + "description": "The HTTP status code received by the gateway as a result of forwarding this request to the backend." + }, + "responseCode": { + "type": "integer", + "format": "int32", + "description": "The HTTP status code returned by the gateway." + }, + "responseSize": { + "type": "integer", + "format": "int32", + "description": "The size of the response returned by the gateway." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when this request was received by the gateway in ISO 8601 format." + }, + "cache": { + "type": "string", + "description": "Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fullfilled by the backend." + }, + "apiTime": { + "type": "number", + "format": "double", + "description": "The total time it took to process this request." + }, + "serviceTime": { + "type": "number", + "format": "double", + "description": "he time it took to forward this request to the backend and get the response back." + }, + "apiRegion": { + "type": "string", + "description": "Azure region where the gateway that processed this request is located." + }, + "subscriptionId": { + "type": "string", + "description": "Subscription identifier path. /subscriptions/{subscriptionId}" + }, + "requestId": { + "type": "string", + "description": "Request Identifier." + }, + "requestSize": { + "type": "integer", + "format": "int32", + "description": "The size of this request.." + } + }, + "description": "Request Report data." + } + }, + "parameters": {} +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimsubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimsubscriptions.json new file mode 100644 index 000000000000..5678906edde7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimsubscriptions.json @@ -0,0 +1,706 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Subscription entity associated with your Azure API Management deployment. The Subscription entity represents the association between a user and a product in API Management. Products contain one or more APIs, and once a product is published, developers can subscribe to the product and begin to use the product’s APIs.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions": { + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscription_List", + "description": "Lists all subscriptions of the API Management service instance.", + "x-ms-examples": { + "ApiManagementListSubscriptions": { + "$ref": "./examples/ApiManagementListSubscriptions.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|--------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A collection of the Subscription entities for the specified API Management service instance.", + "schema": { + "$ref": "#/definitions/SubscriptionCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/SubscriptionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}": { + "head": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscription_GetEntityTag", + "description": "Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadSubscription": { + "$ref": "./examples/ApiManagementHeadSubscription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified apimanagement subscription entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscription_Get", + "description": "Gets the specified Subscription entity.", + "x-ms-examples": { + "ApiManagementGetSubscription": { + "$ref": "./examples/ApiManagementGetSubscription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Subscription entity.", + "schema": { + "$ref": "#/definitions/SubscriptionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscription_CreateOrUpdate", + "description": "Creates or updates the subscription of specified user to the specified product.", + "x-ms-examples": { + "ApiManagementCreateSubscription": { + "$ref": "./examples/ApiManagementCreateSubscription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionEntityIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SubscriptionCreateParameters" + }, + "description": "Create parameters." + }, + { + "$ref": "#/parameters/NotifySubscriptionStateChangeParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The user was successfully subscribed to the product.", + "schema": { + "$ref": "#/definitions/SubscriptionContract" + } + }, + "200": { + "description": "The user already subscribed to the product.", + "schema": { + "$ref": "#/definitions/SubscriptionContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscription_Update", + "description": "Updates the details of a subscription specificied by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateSubscription": { + "$ref": "./examples/ApiManagementUpdateSubscription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionEntityIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SubscriptionUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "#/parameters/NotifySubscriptionStateChangeParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The subscription details were successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscription_Delete", + "description": "Deletes the specified subscription.", + "x-ms-examples": { + "ApiManagementDeleteSubscription": { + "$ref": "./examples/ApiManagementDeleteSubscription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The subscription details were successfully deleted." + }, + "204": { + "description": "The subscription details were successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regeneratePrimaryKey": { + "post": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscription_RegeneratePrimaryKey", + "description": "Regenerates primary key of existing subscription of the API Management service instance.", + "x-ms-examples": { + "ApiManagementSubscriptionRegenerateKey": { + "$ref": "./examples/ApiManagementSubscriptionRegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The primary key was successfully regenerated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regenerateSecondaryKey": { + "post": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscription_RegenerateSecondaryKey", + "description": "Regenerates secondary key of existing subscription of the API Management service instance.", + "x-ms-examples": { + "ApiManagementSubscriptionRegenerateKey": { + "$ref": "./examples/ApiManagementSubscriptionRegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionEntityIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The secondary key was successfully regenerated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SubscriptionCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Subscriptions list representation." + }, + "SubscriptionContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubscriptionContractProperties", + "description": "Subscription contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Subscription details." + }, + "SubscriptionContractProperties": { + "properties": { + "userId": { + "type": "string", + "description": "The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier." + }, + "productId": { + "type": "string", + "description": "The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier." + }, + "displayName": { + "type": "string", + "description": "The name of the subscription, or null if the subscription has no name.", + "minLength": 0, + "maxLength": 100 + }, + "state": { + "type": "string", + "description": "Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.", + "enum": [ + "suspended", + "active", + "expired", + "submitted", + "rejected", + "cancelled" + ], + "x-ms-enum": { + "name": "SubscriptionState", + "modelAsString": false + } + }, + "createdDate": { + "type": "string", + "format": "date-time", + "description": "Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n", + "readOnly": true + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "endDate": { + "type": "string", + "format": "date-time", + "description": "Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "notificationDate": { + "type": "string", + "format": "date-time", + "description": "Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "primaryKey": { + "type": "string", + "description": "Subscription primary key.", + "minLength": 1, + "maxLength": 256 + }, + "secondaryKey": { + "type": "string", + "description": "Subscription secondary key.", + "minLength": 1, + "maxLength": 256 + }, + "stateComment": { + "type": "string", + "description": "Optional subscription comment added by an administrator." + } + }, + "required": [ + "userId", + "productId", + "state", + "primaryKey", + "secondaryKey" + ], + "description": "Subscription details." + }, + "SubscriptionCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubscriptionCreateParameterProperties", + "description": "Subscription contract properties." + } + }, + "description": "Subscription create details." + }, + "SubscriptionCreateParameterProperties": { + "properties": { + "userId": { + "type": "string", + "description": "User (user id path) for whom subscription is being created in form /users/{uid}" + }, + "productId": { + "type": "string", + "description": "Product (product id path) for which subscription is being created in form /products/{productid}" + }, + "displayName": { + "type": "string", + "description": "Subscription name.", + "minLength": 1, + "maxLength": 100 + }, + "primaryKey": { + "type": "string", + "description": "Primary subscription key. If not specified during request key will be generated automatically.", + "minLength": 1, + "maxLength": 256 + }, + "secondaryKey": { + "type": "string", + "description": "Secondary subscription key. If not specified during request key will be generated automatically.", + "minLength": 1, + "maxLength": 256 + }, + "state": { + "type": "string", + "description": "Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.", + "enum": [ + "suspended", + "active", + "expired", + "submitted", + "rejected", + "cancelled" + ], + "x-ms-enum": { + "name": "SubscriptionState", + "modelAsString": false + } + } + }, + "required": [ + "userId", + "productId", + "displayName" + ], + "description": "Parameters supplied to the Create subscription operation." + }, + "SubscriptionUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubscriptionUpdateParameterProperties", + "description": "Subscription Update contract properties." + } + }, + "description": "Subscription update details." + }, + "SubscriptionUpdateParameterProperties": { + "properties": { + "userId": { + "type": "string", + "description": "User identifier path: /users/{uid}" + }, + "productId": { + "type": "string", + "description": "Product identifier path: /products/{productId}" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "displayName": { + "type": "string", + "description": "Subscription name." + }, + "primaryKey": { + "type": "string", + "description": "Primary subscription key.", + "minLength": 1, + "maxLength": 256 + }, + "secondaryKey": { + "type": "string", + "description": "Secondary subscription key.", + "minLength": 1, + "maxLength": 256 + }, + "state": { + "type": "string", + "description": "Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.", + "enum": [ + "suspended", + "active", + "expired", + "submitted", + "rejected", + "cancelled" + ], + "x-ms-enum": { + "name": "SubscriptionState", + "modelAsString": false + } + }, + "stateComment": { + "type": "string", + "description": "Comments describing subscription state change by the administrator." + } + }, + "description": "Parameters supplied to the Update subscription operation." + } + }, + "parameters": { + "SubscriptionEntityIdParameter": { + "name": "sid", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription entity Identifier. The entity represents the association between a user and a product in API Management.", + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + }, + "NotifySubscriptionStateChangeParameter": { + "name": "notify", + "in": "query", + "required": false, + "type": "boolean", + "description": "Notify change in Subscription State. \n - If false, do not send any email notification for change of state of subscription \n - If true, send email notification of change of state of subscription ", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtagresources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtagresources.json new file mode 100644 index 000000000000..ef1f457b198c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtagresources.json @@ -0,0 +1,270 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for queuering APIs. Operations and Products by tags in your Azure API Management deployment.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [], + "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.ApiManagement/service/{serviceName}/tagResources": { + "get": { + "tags": [ + "TagResources" + ], + "operationId": "TagResource_ListByService", + "description": "Lists a collection of resources associated with tags.", + "x-ms-examples": { + "ApiManagementListTagResources": { + "$ref": "./examples/ApiManagementListTagResources.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| aid | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| terms | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| isCurrent | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TagResource entities.", + "schema": { + "$ref": "#/definitions/TagResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/TagResourceContract" + } + } + }, + "definitions": { + "TagResourceCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagResourceContract" + }, + "description": "Page values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Tag list representation." + }, + "TagResourceContract": { + "properties": { + "tag": { + "$ref": "#/definitions/TagTagResourceContractProperties", + "description": "Tag associated with the resource." + }, + "api": { + "$ref": "#/definitions/ApiTagResourceContractProperties", + "description": "Api associated with the tag." + }, + "operation": { + "$ref": "#/definitions/OperationTagResourceContractProperties", + "description": "Operation associated with the tag." + }, + "product": { + "$ref": "#/definitions/ProductTagResourceContractProperties", + "description": "Product associated with the tag." + } + }, + "required": [ + "tag" + ], + "description": "TagResource contract properties." + }, + "TagTagResourceContractProperties": { + "properties": { + "id": { + "type": "string", + "description": "Tag identifier" + }, + "name": { + "type": "string", + "description": "Tag Name", + "minLength": 1, + "maxLength": 160 + } + }, + "description": "Contract defining the Tag property in the Tag Resource Contract" + }, + "ApiTagResourceContractProperties": { + "properties": { + "id": { + "type": "string", + "description": "API identifier in the form /apis/{apiId}." + }, + "name": { + "type": "string", + "description": "API name.", + "minLength": 1, + "maxLength": 300 + }, + "serviceUrl": { + "type": "string", + "description": "Absolute URL of the backend service implementing this API.", + "minLength": 1, + "maxLength": 2000 + }, + "path": { + "type": "string", + "description": "Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.", + "minLength": 0, + "maxLength": 400 + }, + "protocols": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "http", + "https" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": false + } + }, + "description": "Describes on which protocols the operations in this API can be invoked." + } + }, + "allOf": [ + { + "$ref": "./apimapis.json#/definitions/ApiEntityBaseContract" + } + ], + "description": "API contract properties for the Tag Resources." + }, + "ProductTagResourceContractProperties": { + "properties": { + "id": { + "type": "string", + "description": "Identifier of the product in the form of /products/{productId}" + }, + "name": { + "type": "string", + "description": "Product name.", + "minLength": 1, + "maxLength": 300 + } + }, + "allOf": [ + { + "$ref": "./apimproducts.json#/definitions/ProductEntityBaseParameters" + } + ], + "required": [ + "name" + ], + "description": "Product profile." + }, + "OperationTagResourceContractProperties": { + "properties": { + "id": { + "type": "string", + "description": "Identifier of the operation in form /operations/{operationId}." + }, + "name": { + "type": "string", + "description": "Operation name.", + "readOnly": true + }, + "apiName": { + "type": "string", + "description": "Api Name.", + "readOnly": true + }, + "apiRevision": { + "type": "string", + "description": "Api Revision.", + "readOnly": true + }, + "apiVersion": { + "type": "string", + "description": "Api Version.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Operation Description.", + "readOnly": true + }, + "method": { + "type": "string", + "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.", + "externalDocs": { + "description": "As defined by RFC.", + "url": "http://www.rfc-editor.org/rfc/rfc7230.txt" + }, + "readOnly": true + }, + "urlTemplate": { + "type": "string", + "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", + "readOnly": true + } + }, + "description": "Operation Entity contract Properties." + } + }, + "parameters": {} +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtags.json new file mode 100644 index 000000000000..912e889100ec --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtags.json @@ -0,0 +1,1645 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Tag entity in your Azure API Management deployment. Tags can be assigned to APIs, Operations and Products.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags": { + "get": { + "tags": [ + "Tags" + ], + "operationId": "Tag_ListByService", + "description": "Lists a collection of tags defined within a service instance.", + "x-ms-examples": { + "ApiManagementListTags": { + "$ref": "./examples/ApiManagementListTags.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Tag entities.", + "schema": { + "$ref": "#/definitions/TagCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}": { + "head": { + "tags": [ + "Tags" + ], + "operationId": "Tag_GetEntityState", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetTag": { + "$ref": "./examples/ApiManagementHeadTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Tags" + ], + "operationId": "Tag_Get", + "description": "Gets the details of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetTag": { + "$ref": "./examples/ApiManagementGetTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Tag entity.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Tags" + ], + "operationId": "Tag_CreateOrUpdate", + "description": "Creates a tag.", + "x-ms-examples": { + "ApiManagementCreateTag": { + "$ref": "./examples/ApiManagementCreateTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagCreateUpdateParameters" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was created succesfully.", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "200": { + "description": "Tag already exists.", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Tags" + ], + "operationId": "Tag_Update", + "description": "Updates the details of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateTag": { + "$ref": "./examples/ApiManagementUpdateTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagCreateUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The tag details were successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Tags" + ], + "operationId": "Tag_Delete", + "description": "Deletes specific tag of the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteTag": { + "$ref": "./examples/ApiManagementDeleteTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The tag was successfully deleted." + }, + "204": { + "description": "The tag was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags": { + "get": { + "tags": [ + "ApiTags" + ], + "operationId": "Tag_ListByApi", + "description": "Lists all Tags associated with the API.", + "x-ms-examples": { + "ApiManagementGetTagsForApi": { + "$ref": "./examples/ApiManagementGetTagsForApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tags associated with the Api entity.", + "schema": { + "$ref": "#/definitions/TagCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}": { + "head": { + "tags": [ + "ApiTags" + ], + "operationId": "Tag_GetEntityStateByApi", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiTag": { + "$ref": "./examples/ApiManagementHeadApiTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiTags" + ], + "operationId": "Tag_GetByApi", + "description": "Get tag associated with the API.", + "x-ms-examples": { + "ApiManagementGetApiTag": { + "$ref": "./examples/ApiManagementGetApiTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the details of the tag specified by its identifier.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiTags" + ], + "operationId": "Tag_AssignToApi", + "description": "Assign tag to the Api.", + "x-ms-examples": { + "ApiManagementCreateApiTag": { + "$ref": "./examples/ApiManagementCreateApiTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was assigned to the Api.", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "200": { + "description": "Tag is already assigned to the Api.", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiTags" + ], + "operationId": "Tag_DetachFromApi", + "description": "Detach the tag from the Api.", + "x-ms-examples": { + "ApiManagementDeleteApiTag": { + "$ref": "./examples/ApiManagementDeleteApiTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully detached the tag from the Api." + }, + "204": { + "description": "Successfully detached the tag from the Api." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions": { + "get": { + "tags": [ + "ApiTagDescriptions" + ], + "operationId": "TagDescription_ListByApi", + "description": "Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations", + "x-ms-examples": { + "ApiManagementGetTagDescriptionsForApi": { + "$ref": "./examples/ApiManagementGetTagDescriptionsForApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tagDescriptions associated with the Api entity.", + "schema": { + "$ref": "#/definitions/TagDescriptionCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/TagDescriptionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagId}": { + "head": { + "tags": [ + "ApiTagDescriptions" + ], + "operationId": "TagDescription_GetEntityState", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiTagDescription": { + "$ref": "./examples/ApiManagementHeadApiTagDescription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiTagDescriptions" + ], + "operationId": "TagDescription_Get", + "description": "Get tag associated with the API.", + "x-ms-examples": { + "ApiManagementGetApiTagDescription": { + "$ref": "./examples/ApiManagementGetApiTagDescription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the description of the tag specified by its identifier in scope if the Api.", + "schema": { + "$ref": "#/definitions/TagDescriptionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiTagDescriptions" + ], + "operationId": "TagDescription_CreateOrUpdate", + "description": "Create/Update tag fescription in scope of the Api.", + "x-ms-examples": { + "ApiManagementCreateApiTagDescription": { + "$ref": "./examples/ApiManagementCreateApiTagDescription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagDescriptionCreateParameters" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag Description was created for the Api.", + "schema": { + "$ref": "#/definitions/TagDescriptionContract" + } + }, + "200": { + "description": "Tag Description was updated for the Api.", + "schema": { + "$ref": "#/definitions/TagDescriptionContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiTagDescriptions" + ], + "operationId": "TagDescription_Delete", + "description": "Delete tag description for the Api.", + "x-ms-examples": { + "ApiManagementDeleteApiTagDescription": { + "$ref": "./examples/ApiManagementDeleteApiTagDescription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted tag description for the Api." + }, + "204": { + "description": "Successfully deleted tag description for the Api." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags": { + "get": { + "tags": [ + "OperationTags" + ], + "operationId": "Tag_ListByOperation", + "description": "Lists all Tags associated with the Operation.", + "x-ms-examples": { + "ApiManagementGetTagsForOperation": { + "$ref": "./examples/ApiManagementGetTagsForOperation.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimapis.json#/parameters/OperationIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tags associated with the Operation entity.", + "schema": { + "$ref": "#/definitions/TagCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}": { + "head": { + "tags": [ + "OperationTags" + ], + "operationId": "Tag_GetEntityStateByOperation", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadOperationTag": { + "$ref": "./examples/ApiManagementHeadOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimapis.json#/parameters/OperationIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "OperationTags" + ], + "operationId": "Tag_GetByOperation", + "description": "Get tag associated with the Operation.", + "x-ms-examples": { + "ApiManagementGetOperationTag": { + "$ref": "./examples/ApiManagementGetOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimapis.json#/parameters/OperationIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the details of the tag specified by its identifier.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "OperationTags" + ], + "operationId": "Tag_AssignToOperation", + "description": "Assign tag to the Operation.", + "x-ms-examples": { + "ApiManagementCreateOperationTag": { + "$ref": "./examples/ApiManagementCreateOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimapis.json#/parameters/OperationIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was assigned to the Operation.", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "200": { + "description": "Tag is already assigned to the Operation.", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "OperationTags" + ], + "operationId": "Tag_DetachFromOperation", + "description": "Detach the tag from the Operation.", + "x-ms-examples": { + "ApiManagementDeleteOperationTag": { + "$ref": "./examples/ApiManagementDeleteOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "$ref": "./apimapis.json#/parameters/OperationIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully detached the tag from the Operation." + }, + "204": { + "description": "Successfully detached the tag from the Operation." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags": { + "get": { + "tags": [ + "OperationsByTags" + ], + "operationId": "Operation_ListByTags", + "description": "Lists a collection of operations associated with tags.", + "x-ms-examples": { + "ApiManagementListOperationsByTags": { + "$ref": "./examples/ApiManagementListOperationsByTags.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdRevParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TagResource entities.", + "schema": { + "$ref": "./apimtagresources.json#/definitions/TagResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimtagresources.json#/definitions/TagResourceContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags": { + "get": { + "tags": [ + "ProductTags" + ], + "operationId": "Tag_ListByProduct", + "description": "Lists all Tags associated with the Product.", + "x-ms-examples": { + "ApiManagementGetTagsForProduct": { + "$ref": "./examples/ApiManagementGetTagsForProduct.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimproducts.json#/parameters/ProductIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tags associated with the Product entity.", + "schema": { + "$ref": "./apimtags.json#/definitions/TagCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimtags.json#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}": { + "head": { + "tags": [ + "ProductTags" + ], + "operationId": "Tag_GetEntityStateByProduct", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadProductTag": { + "$ref": "./examples/ApiManagementHeadProductTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimproducts.json#/parameters/ProductIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ProductTags" + ], + "operationId": "Tag_GetByProduct", + "description": "Get tag associated with the Product.", + "x-ms-examples": { + "ApiManagementGetProductTag": { + "$ref": "./examples/ApiManagementGetProductTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimproducts.json#/parameters/ProductIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the details of the tag specified by its identifier.", + "schema": { + "$ref": "./apimtags.json#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductTags" + ], + "operationId": "Tag_AssignToProduct", + "description": "Assign tag to the Product.", + "x-ms-examples": { + "ApiManagementCreateProductTag": { + "$ref": "./examples/ApiManagementCreateProductTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimproducts.json#/parameters/ProductIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was assigned to the Product.", + "schema": { + "$ref": "./apimtags.json#/definitions/TagContract" + } + }, + "200": { + "description": "Tag is already assigned to the Product.", + "schema": { + "$ref": "./apimtags.json#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductTags" + ], + "operationId": "Tag_DetachFromProduct", + "description": "Detach the tag from the Product.", + "x-ms-examples": { + "ApiManagementDeleteProductTag": { + "$ref": "./examples/ApiManagementDeleteProductTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimproducts.json#/parameters/ProductIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully detached the tag from the Product." + }, + "204": { + "description": "Successfully detached the tag from the Product." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "TagCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Tag list representation." + }, + "TagContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagContractProperties", + "description": "Tag entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Tag Contract details." + }, + "TagContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Tag name.", + "maxLength": 160, + "minLength": 1 + } + }, + "required": [ + "displayName" + ], + "description": "Tag contract Properties." + }, + "TagCreateUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagContractProperties", + "description": "Properties supplied to Create Tag operation." + } + }, + "description": "Parameters supplied to Create/Update Tag operations." + }, + "TagDescriptionCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagDescriptionContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged TagDescription list representation." + }, + "TagDescriptionContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagDescriptionContractProperties", + "description": "TagDescription entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Contract details." + }, + "TagDescriptionContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Tag name.", + "maxLength": 160, + "minLength": 1 + } + }, + "allOf": [ + { + "$ref": "#/definitions/TagDescriptionBaseProperties" + } + ], + "description": "TagDescription contract Properties." + }, + "TagDescriptionCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagDescriptionBaseProperties", + "description": "Properties supplied to Create TagDescription operation." + } + }, + "description": "Parameters supplied to the Create TagDescription operation." + }, + "TagDescriptionBaseProperties": { + "properties": { + "description": { + "type": "string", + "description": "Description of the Tag." + }, + "externalDocsUrl": { + "type": "string", + "description": "Absolute URL of external resources describing the tag.", + "maxLength": 2000 + }, + "externalDocsDescription": { + "type": "string", + "description": "Description of the external resources describing the tag." + } + }, + "description": "Parameters supplied to the Create TagDescription operation." + } + }, + "parameters": { + "TagIdParameter": { + "name": "tagId", + "in": "path", + "required": true, + "type": "string", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtenant.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtenant.json new file mode 100644 index 000000000000..dc300339823a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtenant.json @@ -0,0 +1,772 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on tenant entity associated with your Azure API Management deployment. Using this entity you can manage properties and configuration that apply to the entire API Management service instance.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}": { + "get": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_Get", + "description": "Get tenant access information details.", + "x-ms-examples": { + "ApiManagementGetTenantAccess": { + "$ref": "./examples/ApiManagementGetTenantAccess.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccessParameter" + } + ], + "responses": { + "200": { + "description": "Tenant Access information.", + "schema": { + "$ref": "#/definitions/AccessInformationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + } + } + }, + "patch": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_Update", + "description": "Update tenant access information details.", + "x-ms-examples": { + "ApiManagementUpdateTenantAccess": { + "$ref": "./examples/ApiManagementUpdateTenantAccess.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccessInformationUpdateParameters" + }, + "description": "Parameters supplied to retrieve the Tenant Access Information." + }, + { + "$ref": "#/parameters/AccessParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Tenant's access information updated successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/regeneratePrimaryKey": { + "post": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_RegeneratePrimaryKey", + "description": "Regenerate primary access key.", + "x-ms-examples": { + "ApiManagementTenantAccessRegenerateKey": { + "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccessParameter" + } + ], + "responses": { + "204": { + "description": "The primary key was successfully regenerated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/regenerateSecondaryKey": { + "post": { + "tags": [ + "TenantAccess" + ], + "operationId": "TenantAccess_RegenerateSecondaryKey", + "description": "Regenerate secondary access key.", + "x-ms-examples": { + "ApiManagementTenantAccessRegenerateKey": { + "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccessParameter" + } + ], + "responses": { + "204": { + "description": "The secondary key was successfully regenerated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/git": { + "get": { + "tags": [ + "TenantAccessGit" + ], + "operationId": "TenantAccessGit_Get", + "description": "Gets the Git access configuration for the tenant.", + "x-ms-examples": { + "ApiManagementGetTenantAccess": { + "$ref": "./examples/ApiManagementGetTenantAccess.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccessParameter" + } + ], + "responses": { + "200": { + "description": "Git Access Information for the Service.", + "schema": { + "$ref": "#/definitions/AccessInformationContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/git/regeneratePrimaryKey": { + "post": { + "tags": [ + "TenantAccessGit" + ], + "operationId": "TenantAccessGit_RegeneratePrimaryKey", + "description": "Regenerate primary access key for GIT.", + "x-ms-examples": { + "ApiManagementTenantAccessRegenerateKey": { + "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccessParameter" + } + ], + "responses": { + "204": { + "description": "The primary key was successfully regenerated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/git/regenerateSecondaryKey": { + "post": { + "tags": [ + "TenantAccessGit" + ], + "operationId": "TenantAccessGit_RegenerateSecondaryKey", + "description": "Regenerate secondary access key for GIT.", + "x-ms-examples": { + "ApiManagementTenantAccessRegenerateKey": { + "$ref": "./examples/ApiManagementTenantAccessRegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccessParameter" + } + ], + "responses": { + "204": { + "description": "The secondary key was successfully regenerated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/deploy": { + "post": { + "tags": [ + "TenantConfiguration" + ], + "operationId": "TenantConfiguration_Deploy", + "description": "This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.", + "externalDocs": { + "description": "To deploy any service configuration changes to the API Management service instance", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-configuration-repository-git/#to-deploy-any-service-configuration-changes-to-the-api-management-service-instance" + }, + "x-ms-examples": { + "ApiManagementTenantConfigurationDeploy": { + "$ref": "./examples/ApiManagementTenantConfigurationDeploy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DeployConfigurationParameters" + }, + "description": "Deploy Configuration parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ConfigurationParameter" + } + ], + "responses": { + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." + }, + "200": { + "description": "Result of appplying changes from Git branch to database.", + "schema": { + "$ref": "#/definitions/OperationResultContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/save": { + "post": { + "tags": [ + "TenantConfiguration" + ], + "operationId": "TenantConfiguration_Save", + "description": "This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.", + "externalDocs": { + "description": "To save the service configuration to the Git repository", + "url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-configuration-repository-git/#to-save-the-service-configuration-to-the-git-repository" + }, + "x-ms-examples": { + "ApiManagementTenantConfigurationSave": { + "$ref": "./examples/ApiManagementTenantConfigurationSave.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SaveConfigurationParameter" + }, + "description": "Save Configuration parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ConfigurationParameter" + } + ], + "responses": { + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." + }, + "200": { + "description": "Result of creating a commit in the repository.", + "schema": { + "$ref": "#/definitions/OperationResultContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/validate": { + "post": { + "tags": [ + "TenantConfiguration" + ], + "operationId": "TenantConfiguration_Validate", + "description": "This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementTenantConfigurationValidate": { + "$ref": "./examples/ApiManagementTenantConfigurationValidate.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DeployConfigurationParameters" + }, + "description": "Validate Configuration parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ConfigurationParameter" + } + ], + "responses": { + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." + }, + "200": { + "description": "Result of validating the changes in the specified Git branch.", + "schema": { + "$ref": "#/definitions/OperationResultContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/syncState": { + "get": { + "tags": [ + "TenantConfigurationSyncState" + ], + "operationId": "TenantConfiguration_GetSyncState", + "description": "Gets the status of the most recent synchronization between the configuration database and the Git repository.", + "x-ms-examples": { + "ApiManagementTenantAccessSyncState": { + "$ref": "./examples/ApiManagementTenantAccessSyncState.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ConfigurationParameter" + } + ], + "responses": { + "200": { + "description": "Sync state result.", + "schema": { + "$ref": "#/definitions/TenantConfigurationSyncStateContract" + } + } + } + } + } + }, + "definitions": { + "AccessInformationContract": { + "properties": { + "id": { + "type": "string", + "description": "Identifier." + }, + "primaryKey": { + "type": "string", + "description": "Primary access key." + }, + "secondaryKey": { + "type": "string", + "description": "Secondary access key." + }, + "enabled": { + "type": "boolean", + "description": "Tenant access information of the API Management service." + } + }, + "description": "Tenant access information contract of the API Management service." + }, + "AccessInformationUpdateParameters": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Tenant access information of the API Management service." + } + }, + "description": "Tenant access information update parameters of the API Management service." + }, + "DeployConfigurationParameters": { + "properties": { + "branch": { + "type": "string", + "description": "The name of the Git branch from which the configuration is to be deployed to the configuration database." + }, + "force": { + "type": "boolean", + "description": "The value enforcing deleting subscriptions to products that are deleted in this update." + } + }, + "required": [ + "branch" + ], + "description": "Parameters supplied to the Deploy Configuration operation." + }, + "OperationResultContract": { + "properties": { + "id": { + "type": "string", + "description": "Operation result identifier." + }, + "status": { + "type": "string", + "description": "Status of an async operation.", + "enum": [ + "Started", + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "AsyncOperationStatus", + "modelAsString": false + } + }, + "started": { + "type": "string", + "format": "date-time", + "description": "Start time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "updated": { + "type": "string", + "format": "date-time", + "description": "Last update time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "resultInfo": { + "type": "string", + "description": "Optional result info." + }, + "error": { + "$ref": "./apimanagement.json#/definitions/ErrorResponseBody", + "description": "Error Body Contract" + }, + "actionLog": { + "type": "array", + "items": { + "$ref": "#/definitions/OperationResultLogItemContract" + }, + "readOnly": true, + "description": "This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation." + } + }, + "description": "Operation Result." + }, + "OperationResultLogItemContract": { + "properties": { + "objectType": { + "type": "string", + "description": "The type of entity contract." + }, + "action": { + "type": "string", + "description": "Action like create/update/delete." + }, + "objectKey": { + "type": "string", + "description": "Identifier of the entity being created/updated/deleted." + } + }, + "description": "Log of the entity being created, updated or deleted." + }, + "SaveConfigurationParameter": { + "properties": { + "branch": { + "type": "string", + "description": "The name of the Git branch in which to commit the current configuration snapshot." + }, + "force": { + "type": "boolean", + "description": "The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten." + } + }, + "required": [ + "branch" + ], + "description": "Parameters supplied to the Save Tenant Configuration operation." + }, + "TenantConfigurationSyncStateContract": { + "properties": { + "branch": { + "type": "string", + "description": "The name of Git branch." + }, + "commitId": { + "type": "string", + "description": "The latest commit Id." + }, + "isExport": { + "type": "boolean", + "description": "value indicating if last sync was save (true) or deploy (false) operation." + }, + "isSynced": { + "type": "boolean", + "description": "value indicating if last synchronization was later than the configuration change." + }, + "isGitEnabled": { + "type": "boolean", + "description": "value indicating whether Git configuration access is enabled." + }, + "syncDate": { + "type": "string", + "format": "date-time", + "description": "The date of the latest synchronization. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "configurationChangeDate": { + "type": "string", + "format": "date-time", + "description": "The date of the latest configuration change. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + } + }, + "description": "Tenant Configuration Synchronization State." + } + }, + "parameters": { + "AccessParameter": { + "name": "accessName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "access" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AccessIdName" + }, + "description": "The identifier of the Access configuration.", + "x-ms-parameter-location": "method" + }, + "ConfigurationParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "configuration" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "configurationIdName" + }, + "description": "The identifier of the Git Configuration Operation.", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimusers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimusers.json new file mode 100644 index 000000000000..2fbd739e4896 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimusers.json @@ -0,0 +1,961 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on User entity in Azure API Management deployment. The User entity in API Management represents the developers that call the APIs of the products to which they are subscribed.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users": { + "get": { + "tags": [ + "Users" + ], + "operationId": "User_ListByService", + "description": "Lists a collection of registered users in the specified service instance.", + "x-ms-examples": { + "ApiManagementListUsers": { + "$ref": "./examples/ApiManagementListUsers.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|------------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | N/A |\n| registrationDate | ge, le, eq, ne, gt, lt | N/A |\n| note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of User entities.", + "schema": { + "$ref": "#/definitions/UserCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/UserContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}": { + "head": { + "tags": [ + "Users" + ], + "operationId": "User_GetEntityTag", + "description": "Gets the entity state (Etag) version of the user specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadUser": { + "$ref": "./examples/ApiManagementHeadUser.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified user entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Users" + ], + "operationId": "User_Get", + "description": "Gets the details of the user specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetUser": { + "$ref": "./examples/ApiManagementGetUser.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the specified user entity.", + "schema": { + "$ref": "#/definitions/UserContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Users" + ], + "operationId": "User_CreateOrUpdate", + "description": "Creates or Updates a user.", + "x-ms-examples": { + "ApiManagementCreateUserBasic": { + "$ref": "./examples/ApiManagementCreateUserBasic.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UserCreateParameters" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "User was successfully created.", + "schema": { + "$ref": "#/definitions/UserContract" + } + }, + "200": { + "description": "User was successfully updated.", + "schema": { + "$ref": "#/definitions/UserContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Users" + ], + "operationId": "User_Update", + "description": "Updates the details of the user specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateUserBasic": { + "$ref": "./examples/ApiManagementUpdateUserBasic.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UserUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The user details were successfully updated." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 405 Administrator user cannot be modified\n\n * 4XX Error response giving details why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Users" + ], + "operationId": "User_Delete", + "description": "Deletes specific user.", + "x-ms-examples": { + "ApiManagementDeleteUser": { + "$ref": "./examples/ApiManagementDeleteUser.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "name": "deleteSubscriptions", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to delete user's subscription or not." + }, + { + "name": "notify", + "in": "query", + "required": false, + "type": "boolean", + "description": "Send an Account Closed Email notification to the User." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The user details were successfully deleted." + }, + "204": { + "description": "The user details were successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/generateSsoUrl": { + "post": { + "tags": [ + "Users" + ], + "operationId": "User_GenerateSsoUrl", + "description": "Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.", + "x-ms-examples": { + "ApiManagementUsersGenerateSsoUrl": { + "$ref": "./examples/ApiManagementUsersGenerateSsoUrl.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the single sign-on URL.", + "schema": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenerateSsoUrlResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/groups": { + "get": { + "tags": [ + "UserGroups" + ], + "operationId": "UserGroup_List", + "description": "Lists all user groups.", + "x-ms-examples": { + "ApiManagementListUserGroups": { + "$ref": "./examples/ApiManagementListUserGroups.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Group entities.", + "schema": { + "$ref": "./apimgroups.json#/definitions/GroupCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimgroups.json#/definitions/GroupContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/subscriptions": { + "get": { + "tags": [ + "UserSubscriptions" + ], + "operationId": "UserSubscription_List", + "description": "Lists the collection of subscriptions of the specified user.", + "x-ms-examples": { + "ApiManagementListUserSubscriptions": { + "$ref": "./examples/ApiManagementListUserSubscriptions.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|--------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Subscription entities.", + "schema": { + "$ref": "./apimsubscriptions.json#/definitions/SubscriptionCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimsubscriptions.json#/definitions/SubscriptionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/identities": { + "get": { + "tags": [ + "UserIdentities" + ], + "operationId": "UserIdentities_List", + "description": "Lists all user identities.", + "x-ms-examples": { + "ApiManagementListUsersIdentities": { + "$ref": "./examples/ApiManagementListUsersIdentities.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Lists of User Identities.", + "schema": { + "$ref": "#/definitions/UserIdentityCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/token": { + "post": { + "tags": [ + "Users" + ], + "operationId": "User_GetSharedAccessToken", + "description": "Gets the Shared Access Authorization Token for the User.", + "x-ms-examples": { + "ApiManagementUsersGetToken": { + "$ref": "./examples/ApiManagementUsersGetToken.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UserTokenParameters" + }, + "description": "Create Authorization Token parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the authorization token for the user.", + "schema": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserTokenResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "GenerateSsoUrlResult": { + "properties": { + "value": { + "type": "string", + "description": "Redirect Url containing the SSO URL value." + } + }, + "description": "Generate SSO Url operations response details." + }, + "UserCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UserContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Users list representation." + }, + "UserContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserContractProperties", + "description": "User entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "User details." + }, + "UserContractProperties": { + "properties": { + "firstName": { + "type": "string", + "description": "First name." + }, + "lastName": { + "type": "string", + "description": "Last name." + }, + "email": { + "type": "string", + "description": "Email address." + }, + "registrationDate": { + "type": "string", + "format": "date-time", + "description": "Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + }, + "groups": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./apimgroups.json#/definitions/GroupContractProperties" + }, + "description": "Collection of groups user is part of." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UserEntityBaseParameters" + } + ], + "description": "User profile." + }, + "UserCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserCreateParameterProperties", + "description": "User entity create contract properties." + } + }, + "description": "User create details." + }, + "UserCreateParameterProperties": { + "properties": { + "email": { + "type": "string", + "description": "Email address. Must not be empty and must be unique within the service instance.", + "minLength": 1, + "maxLength": 254 + }, + "firstName": { + "type": "string", + "description": "First name.", + "minLength": 1, + "maxLength": 100 + }, + "lastName": { + "type": "string", + "description": "Last name.", + "minLength": 1, + "maxLength": 100 + }, + "password": { + "type": "string", + "description": "User Password. If no value is provided, a default password is generated." + }, + "confirmation": { + "type": "string", + "description": "Determines the type of confirmation e-mail that will be sent to the newly created user.", + "enum": [ + "signup", + "invite" + ], + "x-ms-enum": { + "name": "Confirmation", + "modelAsString": true, + "values": [ + { + "value": "signup", + "description": "Send an e-mail to the user confirming they have successfully signed up." + }, + { + "value": "invite", + "description": "Send an e-mail inviting the user to sign-up and complete registration." + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/UserEntityBaseParameters" + } + ], + "required": [ + "email", + "firstName", + "lastName" + ], + "description": "Parameters supplied to the Create User operation." + }, + "UserEntityBaseParameters": { + "properties": { + "state": { + "type": "string", + "description": "Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.", + "enum": [ + "active", + "blocked", + "pending", + "deleted" + ], + "default": "active", + "x-ms-enum": { + "name": "UserState", + "modelAsString": true, + "values": [ + { + "value": "active", + "description": "User state is active." + }, + { + "value": "blocked", + "description": "User is blocked. Blocked users cannot authenticate at developer portal or call API." + }, + { + "value": "pending", + "description": "User account is pending. Requires identity confirmation before it can be made active." + }, + { + "value": "deleted", + "description": "User account is closed. All identities and related entities are removed." + } + ] + } + }, + "note": { + "type": "string", + "description": "Optional note about a user set by the administrator." + }, + "identities": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/UserIdentityContract" + }, + "description": "Collection of user identities." + } + }, + "description": "User Entity Base Parameters set." + }, + "UserIdentityCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UserIdentityContract" + }, + "description": "User Identity values." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Total record count number across all pages." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "List of Users Identity list representation." + }, + "UserIdentityContract": { + "properties": { + "provider": { + "type": "string", + "description": "Identity provider name." + }, + "id": { + "type": "string", + "description": "Identifier value within provider." + } + }, + "description": "User identity details." + }, + "UserTokenParameters": { + "properties": { + "keyType": { + "type": "string", + "description": "The Key to be used to generate token for user.", + "enum": [ + "primary", + "secondary" + ], + "default": "primary", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "expiry": { + "type": "string", + "format": "date-time", + "description": "The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" + } + }, + "required": [ + "keyType", + "expiry" + ], + "description": "Parameters supplied to the Get User Token operation." + }, + "UserTokenResult": { + "properties": { + "value": { + "type": "string", + "description": "Shared Access Authorization token for the User." + } + }, + "description": "Get User Token response details." + }, + "UserUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserUpdateParametersProperties", + "description": "User entity update contract properties." + } + }, + "description": "User update parameters." + }, + "UserUpdateParametersProperties": { + "properties": { + "email": { + "type": "string", + "description": "Email address. Must not be empty and must be unique within the service instance.", + "minLength": 1, + "maxLength": 254 + }, + "password": { + "type": "string", + "description": "User Password." + }, + "firstName": { + "type": "string", + "description": "First name.", + "minLength": 1, + "maxLength": 100 + }, + "lastName": { + "type": "string", + "description": "Last name.", + "minLength": 1, + "maxLength": 100 + } + }, + "allOf": [ + { + "$ref": "#/definitions/UserEntityBaseParameters" + } + ], + "description": "Parameters supplied to the Update User operation." + } + }, + "parameters": { + "UserIdParameter": { + "name": "uid", + "in": "path", + "required": true, + "type": "string", + "description": "User identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimversionsets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimversionsets.json new file mode 100644 index 000000000000..f8e57f7942c7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimversionsets.json @@ -0,0 +1,520 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on the ApiVersionSet entity associated with your Azure API Management deployment. Using this entity you create and manage API Version Sets that are used to group APIs for consistent versioning.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/api-version-sets": { + "get": { + "tags": [ + "ApiVersionSets" + ], + "operationId": "ApiVersionSet_ListByService", + "description": "Lists a collection of API Version Sets in the specified service instance.", + "x-ms-examples": { + "ApiManagementListApiVersionSets": { + "$ref": "./examples/ApiManagementListApiVersionSets.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|------------------|------------------------|-----------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | eq | N/A |\n| registrationDate | ge, le, eq, ne, gt, lt | N/A |\n| note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Api Version Set entities.", + "schema": { + "$ref": "#/definitions/ApiVersionSetCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ApiVersionSetContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/api-version-sets/{versionSetId}": { + "head": { + "tags": [ + "ApiVersionSets" + ], + "operationId": "ApiVersionSet_GetEntityTag", + "description": "Gets the entity state (Etag) version of the Api Version Set specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiVersionSet": { + "$ref": "./examples/ApiManagementHeadApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionSetIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified Api Version Set entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiVersionSets" + ], + "operationId": "ApiVersionSet_Get", + "description": "Gets the details of the Api Version Set specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetApiVersionSet": { + "$ref": "./examples/ApiManagementGetApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionSetIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the specified Api Version Set entity.", + "schema": { + "$ref": "#/definitions/ApiVersionSetContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiVersionSets" + ], + "operationId": "ApiVersionSet_CreateOrUpdate", + "description": "Creates or Updates a Api Version Set.", + "x-ms-examples": { + "ApiManagementCreateApiVersionSet": { + "$ref": "./examples/ApiManagementCreateApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionSetIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiVersionSetContract" + }, + "description": "Create or update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter" + } + ], + "responses": { + "200": { + "description": "Api Version Set was successfully updated.", + "schema": { + "$ref": "#/definitions/ApiVersionSetContract" + } + }, + "201": { + "description": "Api Version Set was successfully created.", + "schema": { + "$ref": "#/definitions/ApiVersionSetContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ApiVersionSets" + ], + "operationId": "ApiVersionSet_Update", + "description": "Updates the details of the Api VersionSet specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateApiVersionSet": { + "$ref": "./examples/ApiManagementUpdateApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionSetIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiVersionSetUpdateParameters" + }, + "description": "Update parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + } + ], + "responses": { + "204": { + "description": "The Api Version Set details were successfully updated." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 4XX Error response giving details why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiVersionSets" + ], + "operationId": "ApiVersionSet_Delete", + "description": "Deletes specific Api Version Set.", + "x-ms-examples": { + "ApiManagementDeleteApiVersionSet": { + "$ref": "./examples/ApiManagementDeleteApiVersionSet.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionSetIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter" + } + ], + "responses": { + "200": { + "description": "The ApiVersion Set details were successfully deleted." + }, + "204": { + "description": "The ApiVersion Set details were successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ApiVersionSetCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiVersionSetContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Api Version Set list representation." + }, + "ApiVersionSetEntityBase": { + "properties": { + "description": { + "type": "string", + "description": "Description of API Version Set." + }, + "versionQueryName": { + "type": "string", + "description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`.", + "minLength": 1, + "maxLength": 100 + }, + "versionHeaderName": { + "type": "string", + "description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.", + "minLength": 1, + "maxLength": 100 + } + }, + "description": "Api Version set base parameters" + }, + "ApiVersionSetContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Name of API Version Set", + "minLength": 1, + "maxLength": 100 + }, + "versioningScheme": { + "type": "string", + "description": "An value that determines where the API Version identifer will be located in a HTTP request.", + "enum": [ + "Segment", + "Query", + "Header" + ], + "x-ms-enum": { + "name": "versioningScheme", + "modelAsString": true, + "values": [ + { + "value": "Segment", + "description": "The API Version is passed in a path segment." + }, + { + "value": "Query", + "description": "The API Version is passed in a query parameter." + }, + { + "value": "Header", + "description": "The API Version is passed in a HTTP header." + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiVersionSetEntityBase" + } + ], + "required": [ + "displayName", + "versioningScheme" + ], + "description": "Properties of an API Version Set." + }, + "ApiVersionSetContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiVersionSetContractProperties", + "description": "Api VersionSet contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Api Version Set Contract details." + }, + "ApiVersionSetUpdateParametersProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Name of API Version Set", + "minLength": 1, + "maxLength": 100 + }, + "versioningScheme": { + "type": "string", + "description": "An value that determines where the API Version identifer will be located in a HTTP request.", + "enum": [ + "Segment", + "Query", + "Header" + ], + "x-ms-enum": { + "name": "versioningScheme", + "modelAsString": true, + "values": [ + { + "value": "Segment", + "description": "The API Version is passed in a path segment." + }, + { + "value": "Query", + "description": "The API Version is passed in a query parameter." + }, + { + "value": "Header", + "description": "The API Version is passed in a HTTP header." + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ApiVersionSetEntityBase" + } + ], + "description": "Properties used to create or update an API Version Set." + }, + "ApiVersionSetUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiVersionSetUpdateParametersProperties", + "description": "Parameters to update or create an Api Version Set Contract." + } + }, + "description": "Parameters to update or create an Api Version Set Contract." + } + }, + "parameters": { + "ApiVersionSetIdParameter": { + "name": "versionSetId", + "in": "path", + "required": true, + "type": "string", + "description": "Api Version Set identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 80, + "pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementApplyNetworkConfigurationUpdates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementApplyNetworkConfigurationUpdates.json new file mode 100644 index 000000000000..37b43fe49ed7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementApplyNetworkConfigurationUpdates.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "location": "west us" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2018-06-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "UID": "52ed5986-717b-45b4-b17c-3df8db372cff" + }, + "location": "East Asia", + "etag": "AAAAAAAXX6Y=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "Contoso", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2015-09-22T01:50:34.7921566Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "207.46.155.24" + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/eastUsVirtualNetwork/subnets/apimSubnet" + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementBackendReconnect.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementBackendReconnect.json new file mode 100644 index 000000000000..033d4a5c5d61 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementBackendReconnect.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "backendid": "proxybackend", + "parameters": { + "properties": { + "after" : "PT3S" + } + } + }, + "responses": { + "202": {} + } + } \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateAILogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateAILogger.json new file mode 100644 index 000000000000..3853b4421cf9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateAILogger.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "loggerid": "loggerId", + "parameters": { + "properties": { + "loggerType": "applicationInsights", + "description": "adding a new logger", + "credentials": { + "instrumentationKey": "11................a1" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "loggerId", + "properties": { + "loggerType": "applicationInsights", + "description": null, + "credentials": { + "instrumentationKey": "{{5a.......2a}}" + }, + "isBuffered": false, + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/microsoft.insights/components/airesource" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "loggerId", + "properties": { + "loggerType": "applicationInsights", + "description": null, + "credentials": { + "instrumentationKey": "{{5a.......2a}}" + }, + "isBuffered": false + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApi.json new file mode 100644 index 000000000000..a8293a7df6c3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApi.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "tempgroup", + "parameters": { + "properties": { + "description": "apidescription5200", + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "displayName": "apiname1463", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "https", + "http" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "http", + "https" + ], + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "isCurrent": true, + "isOnline": true + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "http", + "https" + ], + "authenticationSettings": { + "oAuth2": { + "authorizationServerId": "authorizationServerId2283", + "scope": "oauth2scope2580" + } + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "isCurrent": true, + "isOnline": true + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiDiagnostic.json new file mode 100644 index 000000000000..39d95c5664d2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiDiagnostic.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "diagnosticId": "applicationinsights", + "apiId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiIssue.json new file mode 100644 index 000000000000..c3924f239769 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiIssue.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + } + } + } \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiIssueAttachment.json new file mode 100644 index 000000000000..37cf9b88b6b8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiIssueAttachment.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "attachmentId": "57d2ef278aa04f0888cba3f3", + "parameters": { + "properties": { + "title": "Issue attachment.", + "contentFormat": "image/jpeg", + "content": "IEJhc2U2NA==" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "name": "57d2ef278aa04f0888cba3f3", + "properties": { + "title": "Issue attachment.", + "contentFormat": "link", + "content": "https://.../image.jpg" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "name": "57d2ef278aa04f0888cba3f3", + "properties": { + "title": "Issue attachment.", + "contentFormat": "link", + "content": "https://.../image.jpg" + } + } + } + } + } \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiIssueComment.json new file mode 100644 index 000000000000..50f4ff76747a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiIssueComment.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "commentId": "599e29ab193c3c0bd0b3e2fb", + "parameters": { + "properties": { + "text": "Issue comment.", + "createdDate": "2018-02-01T22:21:20.467Z", + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "name": "599e29ab193c3c0bd0b3e2fb", + "properties": { + "text": "Issue comment.", + "createdDate": "2018-02-01T22:21:20.467Z", + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "name": "599e29ab193c3c0bd0b3e2fb", + "properties": { + "text": "Issue comment.", + "createdDate": "2018-02-01T22:21:20.467Z", + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + } + } + } \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiOperation.json new file mode 100644 index 000000000000..73319696eaf1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiOperation.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "PetStoreTemplate2", + "operationId":"newoperations", + "parameters": { + "name": "newoperation", + "properties": { + "displayName": "createUser2", + "method": "POST", + "urlTemplate": "/user1", + "templateParameters": [], + "description": "This can only be done by the logged in user.", + "request": { + "description": "Created user object", + "queryParameters": [], + "headers": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "successful operation", + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "headers": [] + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "newoperations", + "properties": { + "displayName": "createUser2", + "method": "POST", + "urlTemplate": "/user1", + "templateParameters": [], + "description": "This can only be done by the logged in user.", + "request": { + "description": "Created user object", + "queryParameters": [], + "headers": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "successful operation", + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "headers": [] + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/PetStoreTemplate2/operations/newoperations", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "newoperations", + "properties": { + "displayName": "createUser2", + "method": "POST", + "urlTemplate": "/user1", + "templateParameters": [], + "description": "This can only be done by the logged in user.", + "request": { + "description": "Created user object", + "queryParameters": [], + "headers": [], + "representations": [ + { + "contentType": "application/json", + "schemaId": "592f6c1d0af5840ca8897f0c", + "typeName": "User" + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "successful operation", + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "headers": [] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiOperationPolicy.json new file mode 100644 index 000000000000..96490b6c51a1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiOperationPolicy.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "5600b57e7e8880006a040001", + "operationId": "5600b57e7e8880006a080001", + "policyId": "policy", + "If-Match": "*", + "parameters": { + "properties": { + "contentFormat": "xml", + "policyContent": " " + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiPolicy.json new file mode 100644 index 000000000000..a5194d28c623 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiPolicy.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "5600b57e7e8880006a040001", + "policyId": "policy", + "If-Match":"*", + "parameters": { + "properties": { + "contentFormat": "xml", + "policyContent": " " + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json new file mode 100644 index 000000000000..5e74a5b09f10 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "5600b57e7e8880006a040001", + "policyId": "policy", + "If-Match": "*", + "parameters": { + "properties": { + "policyContent": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n ", + "contentFormat": "rawxml" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/4c1a3bc6-89f9-46fe-a175-5d8984b25095/resourcegroups/Api-DF-West-US/providers/Microsoft.ApiManagement/service/samirmsiservice2/apis/echo-api/operations/create-resource/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/4c1a3bc6-89f9-46fe-a175-5d8984b25095/resourcegroups/Api-DF-West-US/providers/Microsoft.ApiManagement/service/samirmsiservice2/apis/echo-api/operations/create-resource/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n \r\n \r\n \r\n \"@(context.Request.Headers.FirstOrDefault(h => h.Ke==\"Via\"))\" \r\n \r\n \r\n" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiRelease.json new file mode 100644 index 000000000000..175fe1991e77 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiRelease.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "a1", + "releaseId": "testrev", + "parameters": { + "properties": { + "apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "notes": "yahooagain" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev", + "type": "Microsoft.ApiManagement/service/apis/releases", + "name": "testrev", + "properties": { + "apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "createdDateTime": "2018-02-08T20:52:00.65Z", + "updatedDateTime": "2018-02-08T20:52:00.65Z", + "notes": "yahooagain" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev", + "type": "Microsoft.ApiManagement/service/apis/releases", + "name": "testrev", + "properties": { + "apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "createdDateTime": "2018-02-08T20:52:00.65Z", + "updatedDateTime": "2018-02-08T20:52:00.65Z", + "notes": "yahooagain" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiRevision.json new file mode 100644 index 000000000000..6dc22817f714 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiRevision.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "echo-api;rev=4", + "parameters": { + "properties": { + "displayName": "Echo API", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "serviceUrl": "http://petstore.swagger.io/v5", + "path": "petstore2", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": false, + "apiRevisionDescription": "moved to swagger petstore backend" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=4", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api;rev=4", + "properties": { + "displayName": "Echo API", + "apiRevision": "4", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "serviceUrl": "http://petstore.swagger.io/v5", + "path": "petstore2", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "apiRevisionDescription": "moved to swagger petstore backend" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=4", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api;rev=4", + "properties": { + "displayName": "Echo API", + "apiRevision": "4", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "serviceUrl": "http://petstore.swagger.io/v5", + "path": "petstore2", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "apiRevisionDescription": "moved to swagger petstore backend" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiSchema.json new file mode 100644 index 000000000000..80832e09182e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiSchema.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "parameters": { + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiTag.json new file mode 100644 index 000000000000..aad825037a64 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiTag.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "5931a75ae4bbd512a88c680b", + "tagId": "tagId1" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiTagDescription.json new file mode 100644 index 000000000000..c770f79ccc7b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiTagDescription.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "5931a75ae4bbd512a88c680b", + "tagId": "tagId1", + "parameters": { + "properties": { + "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API", + "externalDocsUrl": "http://some.url/additionaldoc", + "externalDocsDescription": "Description of the external docs resource" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1", + "description": null, + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1", + "description": null, + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiUsingSwaggerImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiUsingSwaggerImport.json new file mode 100644 index 000000000000..a63fae62b14d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiUsingSwaggerImport.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "petstore", + "parameters": { + "properties": { + "contentFormat": "swagger-link-json", + "contentValue": "http://petstore.swagger.io/v2/swagger.json", + "path": "petstore" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "petstoreapi", + "properties": { + "displayName": "Swagger Petstore", + "apiRevision": "1", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "serviceUrl": "http://petstore.swagger.io/v2", + "path": "petstore", + "protocols": [ + "http" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "petstoreapi", + "properties": { + "displayName": "Swagger Petstore", + "apiRevision": "1", + "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", + "serviceUrl": "http://petstore.swagger.io/v2", + "path": "petstore", + "protocols": [ + "http" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiUsingWadlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiUsingWadlImport.json new file mode 100644 index 000000000000..baa00d1e3c3a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiUsingWadlImport.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "petstore", + "parameters": { + "properties": { + "contentFormat": "wadl-link-json", + "contentValue": "https://developer.cisco.com/media/wae-release-6-2-api-reference/wae-collector-rest-api/application.wadl", + "path": "collector" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/collectorwadl", + "type": "Microsoft.ApiManagement/service/apis", + "name": "collectorwadl", + "properties": { + "displayName": "http://localhost:8080/collector-northbound", + "apiRevision": "1", + "description": "", + "serviceUrl": "http://localhost:8080/collector-northbound", + "path": "collector", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/collectorwadl", + "type": "Microsoft.ApiManagement/service/apis", + "name": "collectorwadl", + "properties": { + "displayName": "http://localhost:8080/collector-northbound", + "apiRevision": "1", + "description": "", + "serviceUrl": "http://localhost:8080/collector-northbound", + "path": "collector", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiVersionSet.json new file mode 100644 index 000000000000..9a46b73c7a27 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiVersionSet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "versionSetId": "api1", + "parameters": { + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/api-version-sets/api1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "name": "api1", + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/api-version-sets/api1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "name": "api1", + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateAuthorizationServer.json new file mode 100644 index 000000000000..3b0c8002bab6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateAuthorizationServer.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "authsid": "newauthServer", + "parameters": { + "properties": { + "displayName": "test2", + "description": "test server", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "supportState": true, + "defaultScope": "read write", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "clientSecret": "2", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "name": "newauthServer", + "properties": { + "displayName": "test2", + "description": "test server", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "supportState": true, + "defaultScope": "read write", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "clientSecret": "2", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "name": "newauthServer", + "properties": { + "displayName": "test2", + "description": "test server", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "supportState": true, + "defaultScope": "read write", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "clientSecret": "2", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateBackendProxyBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateBackendProxyBackend.json new file mode 100644 index 000000000000..68b0f617dbae --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateBackendProxyBackend.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "backendid": "proxybackend", + "parameters": { + "properties": { + "description": "description5308", + "url": "https://backendname2644/", + "protocol": "http", + "tls": { + "validateCertificateChain": true, + "validateCertificateName": true + }, + "proxy": { + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin", + "password": "opensesame" + }, + "credentials": { + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "authorization": { + "scheme": "Basic", + "parameter": "opensesma" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "proxybackend", + "properties": { + "description": "description5308", + "url": "https://backendname2644/", + "protocol": "http", + "credentials": { + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "authorization": { + "scheme": "Basic", + "parameter": "opensesma" + } + }, + "proxy": { + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin", + "password": "opensesame" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "proxybackend", + "properties": { + "description": "description5308", + "url": "https://backendname2644/", + "protocol": "http", + "credentials": { + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "authorization": { + "scheme": "Basic", + "parameter": "opensesma" + } + }, + "proxy": { + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin", + "password": "opensesame" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateBackendServiceFabric.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateBackendServiceFabric.json new file mode 100644 index 000000000000..335dedb49b0e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateBackendServiceFabric.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "backendid": "sfbackend", + "parameters": { + "properties": { + "description": "Service Fabric Test App 1", + "protocol": "http", + "url": "fabric:/mytestapp/mytestservice", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificatethumbprint": "EBA029198AA3E76EF0D70482626E5BCF148594A6", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificatethumbprint": "EBA029198AA3E76EF0D70482626E5BCF148594A6", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificatethumbprint": "EBA029198AA3E76EF0D70482626E5BCF148594A6", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateBackup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateBackup.json new file mode 100644 index 000000000000..9e2db72b9f62 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateBackup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "storageAccount": "teststorageaccount", + "accessKey": "**************************************************", + "containerName": "backupContainer", + "backupName": "apimService1backup_2017_03_19" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2018-06-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "UID": "52ed5986-717b-45b4-b17c-3df8db372cff" + }, + "location": "East Asia", + "etag": "AAAAAAAXX6Y=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "Contoso", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2015-09-22T01:50:34.7921566Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "207.46.155.24" + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateCertificate.json new file mode 100644 index 000000000000..a7e38807c60b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateCertificate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "certificateId":"tempcert", + "parameters": { + "properties": { + "data": "****************Base 64 Encoded Certificate *******************************", + "password": "****Certificate Password******" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "tempcert", + "properties": { + "subject": "CN=contoso.com", + "thumbprint": "*******************3", + "expirationDate": "2018-03-17T21:55:07+00:00" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "tempcert", + "properties": { + "subject": "CN=contoso.com", + "thumbprint": "*******************3", + "expirationDate": "2018-03-17T21:55:07+00:00" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateDiagnostic.json new file mode 100644 index 000000000000..2be5b18c9c14 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateDiagnostic.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "diagnosticId": "applicationinsights", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/azuremonitor", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/azuremonitor", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateEHLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateEHLogger.json new file mode 100644 index 000000000000..bee1eb647ba8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateEHLogger.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "loggerid": "loggerId", + "parameters": { + "properties": { + "loggerType": "azureEventHub", + "description": "adding a new logger", + "credentials": { + "name": "hydraeventhub", + "connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********=" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "loggerId", + "properties": { + "loggerType": "azureEventHub", + "description": "adding a new logger", + "credentials": { + "name": "hydraeventhub", + "connectionString": "{{59544ef2e4bbd50d9468c617}}" + }, + "isBuffered": true, + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/hydraeventhub-ns" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "loggerId", + "properties": { + "loggerType": "azureEventHub", + "description": "adding a new logger", + "credentials": { + "name": "hydraeventhub", + "connectionString": "{{59544ef2e4bbd50d9468c617}}" + }, + "isBuffered": true, + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/hydraeventhub-ns" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateEmailTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateEmailTemplate.json new file mode 100644 index 000000000000..becb54ac9a5c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateEmailTemplate.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "templateName": "newIssueNotificationMessage", + "parameters": { + "properties": { + "subject": "Your request for $IssueName was successfully received." + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "name": "NewIssueNotificationMessage", + "properties": { + "subject": "Your request for $IssueName was successfully received.", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "title": "New issue received", + "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "isDefault": false, + "parameters": [ + { + "name": "DevFirstName", + "title": "Developer first name" + }, + { + "name": "DevLastName", + "title": "Developer last name" + }, + { + "name": "IssueId", + "title": "Issue id" + }, + { + "name": "IssueName", + "title": "Issue name" + }, + { + "name": "OrganizationName", + "title": "Organization name" + }, + { + "name": "DevPortalUrl", + "title": "Developer portal URL" + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "name": "NewIssueNotificationMessage", + "properties": { + "subject": "Your request for $IssueName was successfully received.", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "title": "New issue received", + "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "isDefault": false, + "parameters": [ + { + "name": "DevFirstName", + "title": "Developer first name" + }, + { + "name": "DevLastName", + "title": "Developer last name" + }, + { + "name": "IssueId", + "title": "Issue id" + }, + { + "name": "IssueName", + "title": "Issue name" + }, + { + "name": "OrganizationName", + "title": "Organization name" + }, + { + "name": "DevPortalUrl", + "title": "Developer portal URL" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateGroup.json new file mode 100644 index 000000000000..3984255ca65f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "groupId": "tempgroup", + "parameters": { + "properties": { + "displayName": "temp group" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup", + "type": "Microsoft.ApiManagement/service/groups", + "name": "tempgroup", + "properties": { + "displayName": "temp group", + "type": "custom" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup", + "type": "Microsoft.ApiManagement/service/groups", + "name": "tempgroup", + "properties": { + "displayName": "temp group", + "type": "custom" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateGroupExternal.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateGroupExternal.json new file mode 100644 index 000000000000..e25eb7d53d6f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateGroupExternal.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "groupId":"aadGroup", + "parameters": { + "properties": { + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "description": "new group to test", + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup", + "type": "Microsoft.ApiManagement/service/groups", + "name": "aadGroup", + "properties": { + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "description": "new group to test", + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup", + "type": "Microsoft.ApiManagement/service/groups", + "name": "aadGroup", + "properties": { + "displayName": "NewGroup (samiraad.onmicrosoft.com)", + "description": "new group to test", + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateGroupUser.json new file mode 100644 index 000000000000..003e5ee544e7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateGroupUser.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "groupId": "tempgroup", + "uid": "59307d350af58404d8a26300" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/59307d350af58404d8a26300", + "type": "Microsoft.ApiManagement/service/groups/users", + "name": "59307d350af58404d8a26300", + "properties": { + "firstName": "test", + "lastName": "user", + "email": "testuser1@live.com", + "state": "active", + "registrationDate": "2017-06-01T20:46:45.437Z", + "groups": [], + "identities": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/59307d350af58404d8a26300", + "type": "Microsoft.ApiManagement/service/groups/users", + "name": "59307d350af58404d8a26300", + "properties": { + "firstName": "test", + "lastName": "user", + "email": "testuser1@live.com", + "state": "active", + "registrationDate": "2017-06-01T20:46:45.437Z", + "groups": [], + "identities": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateIdentityProvider.json new file mode 100644 index 000000000000..004479876992 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateIdentityProvider.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "identityProviderName": "facebook", + "parameters": { + "properties": { + "clientId": "facebookid", + "clientSecret": "facebookapplicationsecret" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook", + "type": "Microsoft.ApiManagement/service/identityProviders", + "name": "Facebook", + "properties": { + "clientId": "facebookid", + "clientSecret": "facebookapplicationsecret", + "type": "facebook" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook", + "type": "Microsoft.ApiManagement/service/identityProviders", + "name": "Facebook", + "properties": { + "clientId": "facebookid", + "clientSecret": "facebookapplicationsecret", + "type": "facebook" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json new file mode 100644 index 000000000000..821e6b5a0d16 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json @@ -0,0 +1,290 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "location": "Central US", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "contoso", + "additionalLocations": [ + { + "location": "West US", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/apimSubnet" + } + } + ], + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "proxyhostname1.contoso.com", + "encodedCertificate": "************Base 64 Encoded Pfx Certificate************************", + "certificatePassword": "**************Password of the Certificate************************************************" + }, + { + "type": "Proxy", + "hostName": "proxyhostname2.contoso.com", + "encodedCertificate": "************Base 64 Encoded Pfx Certificate************************", + "certificatePassword": "**************Password of the Certificate************************************************", + "negotiateClientCertificate": true + }, + { + "type": "Portal", + "hostName": "portalhostname1.contoso.com", + "encodedCertificate": "************Base 64 Encoded Pfx Certificate************************", + "certificatePassword": "**************Password of the Certificate************************************************" + } + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/centralUsVirtualNetwork/subnets/apimSubnet" + }, + "virtualNetworkType": "External" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2018-06-01-preview" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "Central US", + "etag": "AAAAAAAXXpw=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "contoso", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2017-05-30T18:06:23.0096164Z", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "proxyhostname1.contoso.com", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=proxyhostname1.contoso.com" + } + }, + { + "type": "Proxy", + "hostName": "proxyhostname2.contoso.com", + "negotiateClientCertificate": true, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=proxyhostname2.contoso.com" + } + }, + { + "type": "Portal", + "hostName": "portalhostname1.contoso.com", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=portalhostname1.contoso.com" + } + } + ], + "publicIPAddresses": [], + "additionalLocations": [ + { + "location": "West US", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "publicIPAddresses": [], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/apimSubnet" + } + } + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/centralUsVirtualNetwork/subnets/apimSubnet" + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "Central US", + "etag": "AAAAAAAXXwI=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "contoso", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-05-30T19:00:47.1121713Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "proxyhostname1.contoso.com", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=proxyhostname1.contoso.com" + } + }, + { + "type": "Proxy", + "hostName": "proxyhostname2.contoso.com", + "negotiateClientCertificate": true, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=proxyhostname2.contoso.com" + } + }, + { + "type": "Portal", + "hostName": "portalhostname1.contoso.com", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=portalhostname1.contoso.com" + } + } + ], + "publicIPAddresses": [ + "52.xxx.xxx.207" + ], + "additionalLocations": [ + { + "location": "West US", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "publicIPAddresses": [ + "104.210.41.234" + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/apimSubnet" + } + } + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/centralUsVirtualNetwork/subnets/apimSubnet" + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "Central US", + "etag": "AAAAAAAXXwI=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "contoso", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-05-30T19:00:47.1121713Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "proxyhostname1.contoso.com", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=proxyhostname1.contoso.com" + } + }, + { + "type": "Proxy", + "hostName": "proxyhostname2.contoso.com", + "negotiateClientCertificate": true, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=proxyhostname2.contoso.com" + } + }, + { + "type": "Portal", + "hostName": "portalhostname1.contoso.com", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=portalhostname1.contoso.com" + } + } + ], + "publicIPAddresses": [ + "52.xxx.xxx.207" + ], + "additionalLocations": [ + { + "location": "West US", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "publicIPAddresses": [ + "104.210.41.234" + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/apimSubnet" + } + } + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/centralUsVirtualNetwork/subnets/apimSubnet" + }, + "virtualNetworkType": "External" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json new file mode 100644 index 000000000000..15b4e47130a2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "opid": "templateOpenIdConnect3", + "parameters": { + "properties": { + "displayName": "templateoidprovider3", + "metadataEndpoint": "https://oidprovider-template3.net", + "clientId": "oidprovidertemplate3" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "name": "templateOpenIdConnect3", + "properties": { + "displayName": "templateoidprovider3", + "metadataEndpoint": "https://oidprovider-template3.net", + "clientId": "oidprovidertemplate3" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "name": "templateOpenIdConnect3", + "properties": { + "displayName": "templateoidprovider3", + "metadataEndpoint": "https://oidprovider-template3.net", + "clientId": "oidprovidertemplate3" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateOperationTag.json new file mode 100644 index 000000000000..3bfc89662000 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateOperationTag.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "5931a75ae4bbd512a88c680b", + "operationId": "5931a75ae4bbd512a88c680a", + "tagId": "tagId1" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreatePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreatePolicy.json new file mode 100644 index 000000000000..a4de9124cdf9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreatePolicy.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "policyId": "policy", + "parameters": { + "properties": { + "contentFormat": "xml", + "policyContent": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "type": "Microsoft.ApiManagement/service/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "type": "Microsoft.ApiManagement/service/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductApi.json new file mode 100644 index 000000000000..7c56953a1c07 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductApi.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "testproduct", + "apiId": "echo-api" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/apis", + "name": "5931a75ae4bbd512a88c680b", + "properties": { + "displayName": "EchoApi", + "apiRevision": "1", + "serviceUrl": "https://contoso.com/apis/echo", + "path": "", + "protocols": [ + "http", + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/apis", + "name": "5931a75ae4bbd512a88c680b", + "properties": { + "displayName": "EchoApi", + "apiRevision": "1", + "serviceUrl": "https://contoso.com/apis/echo", + "path": "", + "protocols": [ + "http", + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductBasic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductBasic.json new file mode 100644 index 000000000000..a6c036530f54 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductBasic.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "testproduct", + "parameters": { + "properties": { + "displayName": "Test Template ProductName 4" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct", + "type": "Microsoft.ApiManagement/service/products", + "name": "testproduct", + "properties": { + "displayName": "Test Template ProductName 4", + "subscriptionRequired": true, + "approvalRequired": false, + "state": "notPublished" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct", + "type": "Microsoft.ApiManagement/service/products", + "name": "testproduct", + "properties": { + "displayName": "Test Template ProductName 4", + "subscriptionRequired": true, + "approvalRequired": false, + "state": "notPublished" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductGroup.json new file mode 100644 index 000000000000..3ffe9a66f46d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "testproduct", + "groupId": "templateGroup" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup", + "type": "Microsoft.ApiManagement/service/products/groups", + "name": "templateGroup", + "properties": { + "displayName": "Template Group", + "description": "group created via Template", + "builtIn": false, + "type": "custom" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup", + "type": "Microsoft.ApiManagement/service/products/groups", + "name": "templateGroup", + "properties": { + "displayName": "Template Group", + "description": "group created via Template", + "builtIn": false, + "type": "custom" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductPolicy.json new file mode 100644 index 000000000000..729d30a1171d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductPolicy.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "5702e97e5157a50f48dce801", + "policyId": "policy", + "parameters": { + "properties": { + "contentFormat": "xml", + "policyContent": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5702e97e5157a50f48dce801/policies/policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5702e97e5157a50f48dce801/policies/policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n \r\n \r\n \r\n @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductTag.json new file mode 100644 index 000000000000..200524cacd34 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProductTag.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "5931a75ae4bbd512a88c680b", + "tagId": "tagId1" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProperty.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProperty.json new file mode 100644 index 000000000000..0dedc9900225 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateProperty.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "propId": "testprop2", + "parameters": { + "properties": { + "displayName": "prop3name", + "value": "propValue", + "tags": [ + "foo", + "bar" + ], + "secret": true + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/properties/testprop2", + "type": "Microsoft.ApiManagement/service/properties", + "name": "testprop2", + "properties": { + "displayName": "prop3name", + "value": "propValue", + "tags": [ + "foo", + "bar" + ], + "secret": true + } + } + }, + "200": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/properties/testprop2", + "type": "Microsoft.ApiManagement/service/properties", + "name": "testprop2", + "properties": { + "displayName": "prop3name", + "value": "propValue", + "tags": [ + "foo", + "bar" + ], + "secret": true + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateRecipientEmail.json new file mode 100644 index 000000000000..2e9b568dfa5c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateRecipientEmail.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "notificationName": "RequestPublisherNotificationMessage", + "email": "foobar@live.com" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "name": "foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "name": "foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateRecipientUser.json new file mode 100644 index 000000000000..20a53868f771 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateRecipientUser.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "notificationName": "RequestPublisherNotificationMessage", + "uid": "576823d0a40f7e74ec07d642" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", + "name": "576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", + "name": "576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateService.json new file mode 100644 index 000000000000..02ae66c1d3bf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateService.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "location": "West US", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "contoso" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2018-06-01-preview" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/testdemo", + "name": "testdemo", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "West US", + "etag": "AAAAAAAcyE0=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "contoso", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2018-01-18T05:24:31.3459297Z", + "hostnameConfigurations": [], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "location": "West US", + "etag": "AAAAAAAcof0=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "contoso", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2018-01-18T05:24:31.3459297Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "207.xx.155.24" + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "location": "West US", + "etag": "AAAAAAAcof0=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "contoso", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2018-01-18T05:24:31.3459297Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "207.xx.155.24" + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateServiceHavingMsi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateServiceHavingMsi.json new file mode 100644 index 000000000000..6ba248e808ad --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateServiceHavingMsi.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "location": "Japan East", + "properties": { + "publisherEmail": "admin@contoso.com", + "publisherName": "Contoso" + }, + "sku": { + "name": "Developer" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2018-06-01-preview" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "location": "Japan East", + "etag": "AAAAAAC268k=", + "properties": { + "publisherEmail": "admin@contoso.com", + "publisherName": "Contoso", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2017-10-27T23:41:41.7231779Z" + }, + "sku": { + "name": "Developer", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned", + "principalId": "f4b0f1c2-xxxx-43db-xxxx-ccd99e1afd22", + "tenantId": "72f988bf-xxxx-41af-xxxx-2d7cd011db47" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "Japan East", + "etag": "AAAAAAC268s=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "Contoso", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-10-28T01:52:02.4307221Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "publicIPAddresses": [ + "xx.xx.250.222" + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Developer", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned", + "principalId": "f4b0f1c2-xxxx-43db-xxxx-ccd99e1afd22", + "tenantId": "72f988bf-xxxx-41af-xxxx-2d7cd011db47" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "Japan East", + "etag": "AAAAAAC268s=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "Contoso", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-10-28T01:52:02.4307221Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "publicIPAddresses": [ + "xx.xx.250.222" + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Developer", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned", + "principalId": "f4b0f1c2-xxxx-43db-xxxx-ccd99e1afd22", + "tenantId": "72f988bf-xxxx-41af-xxxx-2d7cd011db47" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateServiceWithSystemCertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateServiceWithSystemCertificates.json new file mode 100644 index 000000000000..5c0506b43d73 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateServiceWithSystemCertificates.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "location": "Central US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "sku": { + "name": "Basic", + "capacity": 1 + }, + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "certificates": [ + { + "encodedCertificate": "************Base 64 Encoded Pfx Certificate************************", + "certificatePassword": "**************Password of the Certificate************************************************", + "storeName": "CertificateAuthority" + } + ] + } + } + }, + "responses": { + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2018-06-01-preview" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "Central US", + "etag": "AAAAAADauaY=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Created", + "targetProvisioningState": "Activating", + "createdAtUtc": "2018-02-19T16:42:47.362368Z", + "hostnameConfigurations": [], + "virtualNetworkType": "None", + "certificates": [ + { + "storeName": "CertificateAuthority", + "certificate": { + "expiry": "2035-12-31T23:00:00-08:00", + "thumbprint": "8E989652XXXXXXXXXXXXXXXDB3A2", + "subject": "CN=*.msitesting.net" + } + } + ] + }, + "sku": { + "name": "Basic", + "capacity": 1 + } + } + }, + "200": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "Central US", + "etag": "AAAAAADauqg=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2018-02-19T16:42:47.362368Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-centralus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "40.69.153.91" + ], + "virtualNetworkType": "None", + "certificates": [ + { + "storeName": "CertificateAuthority", + "certificate": { + "expiry": "2035-12-31T23:00:00-08:00", + "thumbprint": "8E989652XXXXXXXXXXXXXXXDB3A2", + "subject": "CN=*.msitesting.net" + } + } + ] + }, + "sku": { + "name": "Basic", + "capacity": 1 + } + }, + "202": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "location": "Central US", + "etag": "AAAAAADauqg=", + "properties": { + "publisherEmail": "apim@autorestsdk.com", + "publisherName": "autorestsdk", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2018-02-19T16:42:47.362368Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-centralus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "40.69.153.91" + ], + "virtualNetworkType": "None", + "certificates": [ + { + "storeName": "CertificateAuthority", + "certificate": { + "expiry": "2035-12-31T23:00:00-08:00", + "thumbprint": "8E989652XXXXXXXXXXXXXXXDB3A2", + "subject": "CN=*.msitesting.net" + } + } + ] + }, + "sku": { + "name": "Basic", + "capacity": 1 + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json new file mode 100644 index 000000000000..56cf214f7662 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "soapApi", + "parameters": { + "properties": { + "contentFormat": "wsdl-link", + "contentValue": "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL", + "path": "currency", + "apiType": "soap", + "wsdlSelector": { + "wsdlServiceName": "CurrencyConvertor", + "wsdlEndpointName": "CurrencyConvertorSoap" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "soapApi", + "properties": { + "displayName": "CurrencyConvertor", + "apiRevision": "1", + "serviceUrl": "http://www.webservicex.net", + "path": "currency", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "type": "soap", + "isCurrent": true + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "soapApi", + "properties": { + "displayName": "CurrencyConvertor", + "apiRevision": "1", + "serviceUrl": "http://www.webservicex.net", + "path": "currency", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "type": "soap", + "isCurrent": true + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json new file mode 100644 index 000000000000..41e55a449d73 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "soapApi", + "parameters": { + "properties": { + "contentFormat": "wsdl-link", + "contentValue": "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL", + "path": "currency", + "wsdlSelector": { + "wsdlServiceName": "CurrencyConvertor", + "wsdlEndpointName": "CurrencyConvertorSoap" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "soapApi", + "properties": { + "displayName": "CurrencyConvertor", + "apiRevision": "1", + "serviceUrl": "http://www.webservicex.net", + "path": "currency", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "soapApi", + "properties": { + "displayName": "CurrencyConvertor", + "apiRevision": "1", + "serviceUrl": "http://www.webservicex.net", + "path": "currency", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateSubscription.json new file mode 100644 index 000000000000..11aad2b12cf7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateSubscription.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "sid": "testsub", + "parameters": { + "properties": { + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "productId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "displayName": "testsub" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub", + "type": "Microsoft.ApiManagement/service/subscriptions", + "name": "testsub", + "properties": { + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "productId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "displayName": "testsub", + "state": "submitted", + "createdDate": "2017-06-02T23:34:03.1055076Z", + "primaryKey": "06c34e1a9d394412b292e0611e73d417", + "secondaryKey": "1e756a7705364c529e8d1760190f47b3" + } + } + }, + "200": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub", + "type": "Microsoft.ApiManagement/service/subscriptions", + "name": "testsub", + "properties": { + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7", + "productId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "displayName": "testsub", + "state": "submitted", + "createdDate": "2017-06-02T23:34:03.1055076Z", + "primaryKey": "06c34e1a9d394412b292e0611e73d417", + "secondaryKey": "1e756a7705364c529e8d1760190f47b3" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateTag.json new file mode 100644 index 000000000000..2ebc8372dff1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateTag.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "tagId": "tagId1", + "parameters": { + "properties": { + "displayName": "tag1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateUserBasic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateUserBasic.json new file mode 100644 index 000000000000..4538b0e8ab27 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateUserBasic.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "5931a75ae4bbd512288c680b", + "parameters": { + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foobar@outlook.com", + "confirmation": "signup" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b", + "type": "Microsoft.ApiManagement/service/users", + "name": "5931a75ae4bbd512288c680b", + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foobar@outlook.com", + "state": "active", + "registrationDate": "2018-01-07T21:21:29.16Z", + "groups": [], + "identities": [ + { + "provider": "Basic", + "id": "foobar@outlook.com" + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b", + "type": "Microsoft.ApiManagement/service/users", + "name": "5931a75ae4bbd512288c680b", + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foobar@outlook.com", + "state": "active", + "registrationDate": "2018-01-07T21:21:29.16Z", + "groups": [], + "identities": [ + { + "provider": "Basic", + "id": "foobar@outlook.com" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApi.json new file mode 100644 index 000000000000..4f2bada7acac --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApi.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "echo-api", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiDiagnostic.json new file mode 100644 index 000000000000..5563f361d4ef --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiDiagnostic.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "diagnosticId": "applicationinsights", + "apiId": "57d1f7558aa04f15146d9d8a", + "If-Match": "*" + }, + "responses": { + "204": {}, + "200":{} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiIssue.json new file mode 100644 index 000000000000..3e2ead481521 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiIssue.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiIssueAttachment.json new file mode 100644 index 000000000000..9a43f099a422 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiIssueAttachment.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "attachmentId": "57d2ef278aa04f0888cba3f3", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiIssueComment.json new file mode 100644 index 000000000000..813ce534e9af --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiIssueComment.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "commentId": "599e29ab193c3c0bd0b3e2fb", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiOperation.json new file mode 100644 index 000000000000..eb02721c4f6d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiOperation.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3", + "operationId": "57d2ef278aa04f0ad01d6cdc", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiPolicy.json new file mode 100644 index 000000000000..bae94de0e8a2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiPolicy.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "loggerId", + "policyId": "policy", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiRelease.json new file mode 100644 index 000000000000..1ab4e240fb72 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiRelease.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "5a5fcc09124a7fa9b89f2f1d", + "releaseId": "testrev", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": { } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiSchema.json new file mode 100644 index 000000000000..2ad46307bdf9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiSchema.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "59d5b28d1f7fab116c282650", + "schemaId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiTag.json new file mode 100644 index 000000000000..b2930b1b9a47 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiTag.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "59d5b28d1f7fab116c282650", + "tagId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiTagDescription.json new file mode 100644 index 000000000000..b2930b1b9a47 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiTagDescription.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "59d5b28d1f7fab116c282650", + "tagId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiVersionSet.json new file mode 100644 index 000000000000..f6fb773adf05 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteApiVersionSet.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "versionSetId": "a1", + "If-Match": "*" + }, + "responses": { + "204": { + }, + "200":{ + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteAuthorizationServer.json new file mode 100644 index 000000000000..edfae3845b66 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteAuthorizationServer.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "authsid": "newauthServer2", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": { } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteBackend.json new file mode 100644 index 000000000000..98ba03d7966b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteBackend.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "backendid": "sfbackend", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteCertificate.json new file mode 100644 index 000000000000..d91019036638 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteCertificate.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "certificateId": "tempcert", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteDiagnostic.json new file mode 100644 index 000000000000..e1c28b143ad9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteDiagnostic.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "diagnosticId": "applicationinsights", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteEmailTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteEmailTemplate.json new file mode 100644 index 000000000000..8dec3744af11 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteEmailTemplate.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "templateName": "newIssueNotificationMessage", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteGroup.json new file mode 100644 index 000000000000..edeb1a70e435 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteGroup.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "groupId": "aadGroup", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteGroupUser.json new file mode 100644 index 000000000000..2ba0fa218ed0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteGroupUser.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "groupId": "templategroup", + "uid": "59307d350af58404d8a26300", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteIdentityProvider.json new file mode 100644 index 000000000000..e7f9fcc096cd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteIdentityProvider.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "identityProviderName": "aad", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteLogger.json new file mode 100644 index 000000000000..53cd67ee6cd8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteLogger.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "loggerid": "loggerId", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteNotificationRecipientEmail.json new file mode 100644 index 000000000000..59063a0102ba --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteNotificationRecipientEmail.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "notificationName": "RequestPublisherNotificationMessage", + "email": "contoso@live.com" + }, + "responses": { + "200": {}, + "204": { } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteNotificationRecipientUser.json new file mode 100644 index 000000000000..4840cb658fc7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteNotificationRecipientUser.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "notificationName": "RequestPublisherNotificationMessage", + "uid": "576823d0a40f7e74ec07d642" + }, + "responses": { + "200": {}, + "204": { } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteOpenIdConnectProvider.json new file mode 100644 index 000000000000..0d195cfd64ee --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteOpenIdConnectProvider.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "opid": "templateOpenIdConnect3", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteOperationPolicy.json new file mode 100644 index 000000000000..8790fb955f6f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteOperationPolicy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "testapi", + "operationId": "testoperation", + "policyId": "policy", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteOperationTag.json new file mode 100644 index 000000000000..7dcfb35dae64 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteOperationTag.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "59d5b28d1f7fab116c282650", + "operationId": "59d5b28d1f7fab116c282651", + "tagId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeletePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeletePolicy.json new file mode 100644 index 000000000000..908891ec6025 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeletePolicy.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "policyId": "policy", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": { } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProduct.json new file mode 100644 index 000000000000..3a5c1f9ebf88 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProduct.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "testproduct", + "deleteSubscriptions": true, + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProductApi.json new file mode 100644 index 000000000000..99018f52fcc7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProductApi.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "testproduct", + "apiId": "echo-api", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProductGroup.json new file mode 100644 index 000000000000..bd40ba24a78f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProductGroup.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "testproduct", + "groupId": "templateGroup", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProductPolicy.json new file mode 100644 index 000000000000..eb17176420bd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProductPolicy.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "testproduct", + "policyId": "policy", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProductTag.json new file mode 100644 index 000000000000..0102c298b033 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProductTag.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "59d5b28d1f7fab116c282650", + "tagId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProperty.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProperty.json new file mode 100644 index 000000000000..d6a9ace04cc9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteProperty.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "propId": "testprop2", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteSubscription.json new file mode 100644 index 000000000000..413f98a58a51 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteSubscription.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "sid": "testsub", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": { } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteTag.json new file mode 100644 index 000000000000..a466a8e75880 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteTag.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "tagId": "tagId1", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteUser.json new file mode 100644 index 000000000000..ece32aadc6c4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementDeleteUser.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "5931a75ae4bbd512288c680b", + "If-Match": "*" + }, + "responses": { + "200": {}, + "204": { } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiContract.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiContract.json new file mode 100644 index 000000000000..33d6a29db38f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiContract.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a", + "type": "Microsoft.ApiManagement/service/apis", + "name": "57d1f7558aa04f15146d9d8a", + "properties": { + "displayName": "Service", + "apiRevision": "1", + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "path": "schulte", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "type": "soap", + "isCurrent": true, + "isOnline": true + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiDiagnostic.json new file mode 100644 index 000000000000..68d550ed09a5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiDiagnostic.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "diagnosticId": "applicationinsights", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiExportInOpenApi2dot0.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiExportInOpenApi2dot0.json new file mode 100644 index 000000000000..b57f8f513550 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiExportInOpenApi2dot0.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "echo-api", + "format": "swagger-link", + "export": "true" + }, + "responses": { + "200": { + "body": { + "link": "https://apimgmtstaobxxxxxxx.blob.core.windows.net/api-export/Echo API.json?sv=2015-07-08&sr=b&sig=xxxxxxxxxx%3D&se=2017-09-08T21:54:08Z&sp=r" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiIssue.json new file mode 100644 index 000000000000..a00f0919fe35 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiIssue.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "apiId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiIssueAttachment.json new file mode 100644 index 000000000000..9ad3a14f64a2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiIssueAttachment.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "attachmentId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "name": "57d2ef278aa04f0888cba3f3", + "properties": { + "title": "Issue attachment.", + "contentFormat": "link", + "content": "https://.../image.jpg" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiIssueComment.json new file mode 100644 index 000000000000..92952716046c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiIssueComment.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "commentId": "599e29ab193c3c0bd0b3e2fb" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "name": "599e29ab193c3c0bd0b3e2fb", + "properties": { + "text": "Issue comment.", + "createdDate": "2018-02-01T22:21:20.467Z", + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiOperation.json new file mode 100644 index 000000000000..6a22b5876579 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiOperation.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3", + "operationId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "displayName": "CancelOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder", + "templateParameters": [], + "request": { + "description": "IFazioService_CancelOrder_InputMessage", + "queryParameters": [], + "headers": [], + "representations": [ + { + "contentType": "text/xml", + "sample": "\r\n\r\n \r\n \r\n 1\r\n \r\n \r\n", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrder" + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "IFazioService_CancelOrder_OutputMessage", + "representations": [ + { + "contentType": "text/xml", + "sample": "\r\n\r\n \r\n \r\n 1\r\n \r\n \r\n", + "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8", + "typeName": "CancelOrderResponse" + } + ], + "headers": [] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiOperationPolicy.json new file mode 100644 index 000000000000..eeff1e933c0e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiOperationPolicy.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "5600b539c53f5b0062040001", + "operationId": "5600b53ac53f5b0062080006", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/operations/5600b53ac53f5b0062080006/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n This is a sample\r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiPolicy.json new file mode 100644 index 000000000000..f02d59d54f76 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiPolicy.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "5600b59475ff190048040001", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b59475ff190048040001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiRelease.json new file mode 100644 index 000000000000..b89feab83967 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiRelease.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "a1", + "releaseId": "5a7cb545298324c53224a799" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/apis/releases", + "name": "5a7cb545298324c53224a799", + "properties": { + "apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "createdDateTime": "2018-02-08T20:38:29.173Z", + "updatedDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiRevision.json new file mode 100644 index 000000000000..5a1ada142d29 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiRevision.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "echo-api;rev=3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api;rev=3", + "properties": { + "displayName": "Service", + "apiRevision": "3", + "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx", + "path": "schulte", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "apiRevisionDescription": "fixed bug in contract" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiSchema.json new file mode 100644 index 000000000000..a466ce876304 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiSchema.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/schemas/ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "name": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1", + "properties": { + "contentType": "application/vnd.ms-azure-apim.xsd+xml", + "document": { + "value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiTag.json new file mode 100644 index 000000000000..dadcf818d4da --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiTag.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiTagDescription.json new file mode 100644 index 000000000000..38a5b4d5b2c4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiTagDescription.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1", + "description": null, + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiVersionSet.json new file mode 100644 index 000000000000..87fef449eb0c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiVersionSet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "versionSetId": "vs1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/api-version-sets/vs1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "name": "vs1", + "properties": { + "displayName" : "Version Set 1", + "versioningScheme" : "Segment", + "description" : "Version configuration" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetAuthorizationServer.json new file mode 100644 index 000000000000..9a7aeb6f031c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetAuthorizationServer.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "authsid": "newauthServer2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer2", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "name": "newauthServer2", + "properties": { + "displayName": "test3", + "description": "test server", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "clientAuthenticationMethod": [ + "Basic" + ], + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "supportState": true, + "defaultScope": "read write", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "clientSecret": "2", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetBackend.json new file mode 100644 index 000000000000..b2d90dde4ccd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetBackend.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "backendid": "sfbackend" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificatethumbprint": "EBA029198AA3E76EF0D70482626E5BCF148594A6", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetCertificate.json new file mode 100644 index 000000000000..b43845c82186 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetCertificate.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "certificateId": "templateCert1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCert1", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "templateCert1", + "properties": { + "subject": "CN=mutual-authcert", + "thumbprint": "EBA**********************8594A6", + "expirationDate": "2017-04-23T17:03:41Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetDiagnostic.json new file mode 100644 index 000000000000..5ee5a7f02197 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetDiagnostic.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "diagnosticId": "applicationinsights" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetEmailTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetEmailTemplate.json new file mode 100644 index 000000000000..2aae0287e19a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetEmailTemplate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "templateName": "newIssueNotificationMessage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/NewIssueNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "name": "NewIssueNotificationMessage", + "properties": { + "subject": "Your request $IssueName was received", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

Thank you for contacting us. Our API team will review your issue and get back to you soon.

\r\n

\r\n Click this link to view or edit your request.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "title": "New issue received", + "description": "This email is sent to developers after they create a new topic on the Issues page of the developer portal.", + "isDefault": true, + "parameters": [ + { + "name": "DevFirstName", + "title": "Developer first name" + }, + { + "name": "DevLastName", + "title": "Developer last name" + }, + { + "name": "IssueId", + "title": "Issue id" + }, + { + "name": "IssueName", + "title": "Issue name" + }, + { + "name": "OrganizationName", + "title": "Organization name" + }, + { + "name": "DevPortalUrl", + "title": "Developer portal URL" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetGroup.json new file mode 100644 index 000000000000..8875d5df3262 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetGroup.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "groupId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/groups", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "description": "awesome group of people", + "builtIn": false, + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetIdentityProvider.json new file mode 100644 index 000000000000..009ed0e86455 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetIdentityProvider.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "identityProviderName": "aadB2C" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/aadB2C", + "type": "Microsoft.ApiManagement/service/identityProviders", + "name": "aadB2C", + "properties": { + "clientId": "315c8e2b-29fc-413d-822f-4efab7f43c42", + "clientSecret": "SnE4laLjmxc2QKWTPoRxOiwvSnnwMCFN+jLYDpBCUXw=", + "type": "aadB2C", + "allowedTenants": [ + "samirtestbc.onmicrosoft.com" + ], + "signupPolicyName": "B2C_1_Signup_Default", + "signinPolicyName": "B2C_1_signup-policy" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetLogger.json new file mode 100644 index 000000000000..93d7a7e0a009 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetLogger.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "loggerid": "templateLogger" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/kloudapilogger1", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "kloudapilogger1", + "properties": { + "loggerType": "azureEventHub", + "description": "testeventhub3again", + "credentials": { + "name": "testeventhub4", + "connectionString": "Endpoint=sb://eventhubapim.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=************" + }, + "isBuffered": true, + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/eventhubapim" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetNotification.json new file mode 100644 index 000000000000..b544b5e3769e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetNotification.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "notificationName": "RequestPublisherNotificationMessage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "RequestPublisherNotificationMessage", + "properties": { + "title": "Subscription requests (requiring approval)", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/contoso@live.com", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar!live", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json new file mode 100644 index 000000000000..d6475a1f8120 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "opid": "templateOpenIdConnect2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "name": "templateOpenIdConnect2", + "properties": { + "displayName": "templateoidprovider2", + "description": "open id provider template2", + "metadataEndpoint": "https://oidprovider-template2.net", + "clientId": "oidprovidertemplate2", + "clientSecret": "oidsecretproviderTemplate2" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetOperationTag.json new file mode 100644 index 000000000000..95a96cb7cb58 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetOperationTag.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "operationId": "59d6bb8f1f7fab13dc67ec9a", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetPolicy.json new file mode 100644 index 000000000000..370368926847 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetPolicy.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "type": "Microsoft.ApiManagement/service/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProduct.json new file mode 100644 index 000000000000..b85f7c19e2f3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProduct.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "unlimited" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited", + "type": "Microsoft.ApiManagement/service/products", + "name": "unlimited", + "properties": { + "displayName": "Unlimited", + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "subscriptionRequired": true, + "approvalRequired": true, + "subscriptionsLimit": 1, + "state": "published" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProductPolicy.json new file mode 100644 index 000000000000..10193e4f77ce --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProductPolicy.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "kjoshiarmTemplateProduct4", + "policyId": "policy" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmTemplateProduct4/policies/policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProductTag.json new file mode 100644 index 000000000000..f2d97070847f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProductTag.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProductsForApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProductsForApi.json new file mode 100644 index 000000000000..77898b4184a9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProductsForApi.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/apis/products", + "name": "5600b539c53f5b0062060002", + "properties": { + "displayName": "Unlimited", + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "subscriptionRequired": true, + "approvalRequired": true, + "subscriptionsLimit": 1, + "state": "published" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProperty.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProperty.json new file mode 100644 index 000000000000..1c35fdcbb98f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetProperty.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "propId": "testarmTemplateproperties2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/properties/testarmTemplateproperties2", + "type": "Microsoft.ApiManagement/service/properties", + "name": "testarmTemplateproperties2", + "properties": { + "displayName": "propName", + "value": "propValue", + "tags": [ + "foo", + "bar" + ], + "secret": false + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetQuotaCounteryKeys.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetQuotaCounteryKeys.json new file mode 100644 index 000000000000..3376d53a572c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetQuotaCounteryKeys.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "quotaCounterKey": "ba" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "counterKey": "ba", + "periodKey": "0_P3Y6M4DT12H30M5S", + "periodStartTime": "2014-08-04T04:24:35Z", + "periodEndTime": "2018-02-08T16:54:40Z", + "value": { + "callsCount": 5, + "kbTransferred": 2.5830078125 + } + } + ], + "count": 1, + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json new file mode 100644 index 000000000000..acb3b99c9db8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "quotaCounterKey": "ba", + "quotaPeriodKey": "0_P3Y6M4DT12H30M5S" + }, + "responses": { + "200": { + "body": { + "counterKey": "ba", + "periodKey": "0_P3Y6M4DT12H30M5S", + "periodStartTime": "2014-08-04T04:24:35Z", + "periodEndTime": "2018-02-08T16:54:40Z", + "value": { + "callsCount": 0, + "kbTransferred": 2.5625 + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByApi.json new file mode 100644 index 000000000000..e5591cd4964e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByApi.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Echo API", + "apiId": "/apis/5600b59475ff190048040001", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "httpbin", + "apiId": "/apis/57a03a13e4bbd5119c8b19e9", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + } + ], + "count": 2, + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByGeo.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByGeo.json new file mode 100644 index 000000000000..86a505ef99c0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByGeo.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "country": "US", + "region": "WA", + "zip": "98052", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + } + ], + "count": 1, + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByOperation.json new file mode 100644 index 000000000000..ca8c415b9afd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByOperation.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "get", + "apiId": "/apis/57a03a13e4bbd5119c8b19e9", + "operationId": "/apis/57a03a13e4bbd5119c8b19e9/operations/57a03a1dd8d14f0a780d7d14", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + }, + { + "name": "GetWeatherInformation", + "apiId": "/apis/57c999d1e4bbd50c988cb2c3", + "operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93e", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "GetCityForecastByZIP", + "apiId": "/apis/57c999d1e4bbd50c988cb2c3", + "operationId": "/apis/57c999d1e4bbd50c988cb2c3/operations/57c999d1e4bbd50df889c93f", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + } + ], + "count": 3, + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByProduct.json new file mode 100644 index 000000000000..6a92c3a4f031 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByProduct.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Starter", + "productId": "/products/5600b59475ff190048060001", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "Unlimited", + "productId": "/products/5600b59475ff190048060002", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + } + ], + "count": 2, + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByRequest.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByRequest.json new file mode 100644 index 000000000000..ddc41cb6ddd3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByRequest.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "apiId": "/apis/5931a75ae4bbd512a88c680b", + "operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-", + "productId": "/products/-", + "userId": "/users/1", + "method": "GET", + "url": "https://apimService1.azure-api.net/echo/resource?param1=sample", + "ipAddress": "207.xx.155.xx", + "responseCode": 404, + "responseSize": 405, + "timestamp": "2017-06-03T00:17:00.1649134Z", + "cache": "none", + "apiTime": 221.1544, + "serviceTime": 0.0, + "apiRegion": "East Asia", + "subscriptionId": "/subscriptions/5600b59475ff190048070002", + "requestId": "63e7119c-26aa-433c-96d7-f6f3267ff52f", + "requestSize": 0 + }, + { + "apiId": "/apis/5931a75ae4bbd512a88c680b", + "operationId": "/apis/5931a75ae4bbd512a88c680b/operations/-", + "productId": "/products/-", + "userId": "/users/1", + "method": "POST", + "url": "https://apimService1.azure-api.net/echo/resource", + "ipAddress": "207.xx.155.xx", + "responseCode": 404, + "responseSize": 403, + "timestamp": "2017-06-03T00:17:20.5255131Z", + "cache": "none", + "apiTime": 6.6754000000000007, + "serviceTime": 0.0, + "apiRegion": "East Asia", + "subscriptionId": "/subscriptions/5600b59475ff190048070002", + "requestId": "e581b7f7-c9ec-4fc6-8ab9-3855d9b00b04", + "requestSize": 0 + } + ], + "count": 2 + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsBySubscription.json new file mode 100644 index 000000000000..d11542d7cbe4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsBySubscription.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "", + "userId": "/users/1", + "productId": "/products/5600b59475ff190048060001", + "subscriptionId": "/subscriptions/5600b59475ff190048070001", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "", + "userId": "/users/1", + "productId": "/products/5600b59475ff190048060002", + "subscriptionId": "/subscriptions/5600b59475ff190048070002", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + }, + { + "name": "", + "userId": "/users/1", + "productId": "/products/5702e97e5157a50f48dce801", + "subscriptionId": "/subscriptions/5702e97e5157a50a9c733303", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + } + ], + "count": 3, + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByTime.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByTime.json new file mode 100644 index 000000000000..11a12bb4c352 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByTime.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'", + "interval": "PT15M" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timestamp": "2017-06-03T00:15:00Z", + "interval": "PT15M", + "callCountSuccess": 4, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 4, + "bandwidth": 3243, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1337.46335, + "apiTimeMin": 885.0839000000001, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 1255.917425, + "serviceTimeMin": 882.8264, + "serviceTimeMax": 1697.3612 + }, + { + "timestamp": "2017-06-03T00:30:00Z", + "interval": "PT15M", + "callCountSuccess": 9, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 10, + "bandwidth": 7776, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 872.7818777777778, + "apiTimeMin": 330.3206, + "apiTimeMax": 1093.8407, + "serviceTimeAvg": 824.2847111111112, + "serviceTimeMin": 215.24, + "serviceTimeMax": 973.2262000000001 + } + ], + "count": 2, + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByUser.json new file mode 100644 index 000000000000..c5fa0a494182 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetReportsByUser.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "$filter": "timestamp ge datetime'2017-06-01T00:00:00' and timestamp le datetime'2017-06-04T00:00:00'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Administrator", + "userId": "/users/1", + "callCountSuccess": 13, + "callCountBlocked": 1, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 14, + "bandwidth": 11019, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 1015.7607923076923, + "apiTimeMin": 330.3206, + "apiTimeMax": 1819.2173, + "serviceTimeAvg": 957.094776923077, + "serviceTimeMin": 215.24, + "serviceTimeMax": 1697.3612 + }, + { + "name": "Samir Solanki", + "userId": "/users/56eaec62baf08b06e46d27fd", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + }, + { + "name": "Anonymous", + "userId": "/users/54c800b332965a0035030000", + "callCountSuccess": 0, + "callCountBlocked": 0, + "callCountFailed": 0, + "callCountOther": 0, + "callCountTotal": 0, + "bandwidth": 0, + "cacheHitCount": 0, + "cacheMissCount": 0, + "apiTimeAvg": 0, + "apiTimeMin": 0, + "apiTimeMax": 0, + "serviceTimeAvg": 0, + "serviceTimeMin": 0, + "serviceTimeMax": 0 + } + ], + "count": 3, + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetSubscription.json new file mode 100644 index 000000000000..6f0fb6229b94 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetSubscription.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "sid": "5931a769d8d14f0ad8ce13b8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/subscriptions", + "name": "5931a769d8d14f0ad8ce13b8", + "properties": { + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "productId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "displayName": "Unlimited", + "state": "submitted", + "createdDate": "2017-06-02T17:59:06.223Z", + "primaryKey": "6de0a3b2da204e459148d2f6785873f0", + "secondaryKey": "c6de00b451f64ea780db1eb8dcf30b62" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTag.json new file mode 100644 index 000000000000..135027691a2f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTag.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTagDescriptionsForApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTagDescriptionsForApi.json new file mode 100644 index 000000000000..6da2c01f227e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTagDescriptionsForApi.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1", + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTagsForApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTagsForApi.json new file mode 100644 index 000000000000..c0a8e977f48e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTagsForApi.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTagsForOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTagsForOperation.json new file mode 100644 index 000000000000..51139d8b3923 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTagsForOperation.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3", + "operationId": "57d2ef278aa04f0888cba3f6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTagsForProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTagsForProduct.json new file mode 100644 index 000000000000..2ad37158e198 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTagsForProduct.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "57d2ef278aa04f0888cba3f1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTenantAccess.json new file mode 100644 index 000000000000..2444f0d15ce3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetTenantAccess.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "accessName": "access" + }, + "responses": { + "200": { + "body": { + "id": "5600b59375ff190048030003", + "primaryKey": "qr5nbjNoZkgtLojXgU+OA/ntYMgko3XPSVyt+ObwR1sqp2ZkM9tGhwxkeEz7bfAuPS5ss61b2S3ZrZmqa9v3Mw==", + "secondaryKey": "2dCJv1CasJl286SZiKxyBFDiIYCUdbwM1YrFNDcFMXCjCKbFzomrGkv+exAbnV5E3DEk91VP4jbeJ2eV/qtejA==", + "enabled": true + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetUser.json new file mode 100644 index 000000000000..5416f88063d3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetUser.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "5931a75ae4bbd512a88c680b" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/users", + "name": "5931a75ae4bbd512a88c680b", + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foobar@outlook.com", + "state": "active", + "registrationDate": "2017-06-02T17:58:50.357Z", + "identities": [ + { + "provider": "Microsoft", + "id": "*************" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApi.json new file mode 100644 index 000000000000..e7e5c74704cd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApi.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiDiagnostic.json new file mode 100644 index 000000000000..fc7307762cd2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiDiagnostic.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "diagnosticId": "applicationinsights", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiIssue.json new file mode 100644 index 000000000000..9570771b1278 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiIssue.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiIssueAttachment.json new file mode 100644 index 000000000000..990bf33e30c5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiIssueAttachment.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "attachmentId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiIssueComment.json new file mode 100644 index 000000000000..5474d13ceabb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiIssueComment.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "commentId": "599e29ab193c3c0bd0b3e2fb" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiOperation.json new file mode 100644 index 000000000000..dff9ac493180 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiOperation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3", + "operationId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiOperationPolicy.json new file mode 100644 index 000000000000..aa5fdacafce3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiOperationPolicy.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "5600b539c53f5b0062040001", + "operationId": "5600b53ac53f5b0062080006", + "policyId": "policy" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiPolicy.json new file mode 100644 index 000000000000..d1123d0531bd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiPolicy.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "57d1f7558aa04f15146d9d8a", + "policyId": "policy" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiRelease.json new file mode 100644 index 000000000000..9a183cfbe1dd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiRelease.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "a1", + "releaseId": "5a7cb545298324c53224a799" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiSchema.json new file mode 100644 index 000000000000..6b52bebfc4a7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiSchema.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "57d1f7558aa04f15146d9d8a", + "schemaId": "ec12520d-9d48-4e7b-8f39-698ca2ac63f1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiTag.json new file mode 100644 index 000000000000..c9a854957fa9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiTag.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiTagDescription.json new file mode 100644 index 000000000000..c9a854957fa9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiTagDescription.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiVersionSet.json new file mode 100644 index 000000000000..3993aa51de92 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadApiVersionSet.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "versionSetId": "vs1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadAuthorizationServer.json new file mode 100644 index 000000000000..a1220ef6f03c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadAuthorizationServer.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "authsid": "newauthServer2" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadBackend.json new file mode 100644 index 000000000000..6ebc4d63da0a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadBackend.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "backendid": "sfbackend" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadCertificate.json new file mode 100644 index 000000000000..7d9162b43f5a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadCertificate.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "certificateId": "templateCert1" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadDelegationSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadDelegationSettings.json new file mode 100644 index 000000000000..eaa776723f51 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadDelegationSettings.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadDiagnostic.json new file mode 100644 index 000000000000..f16360a82939 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadDiagnostic.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "diagnosticId": "applicationinsights" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadEmailTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadEmailTemplate.json new file mode 100644 index 000000000000..79370fa1a798 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadEmailTemplate.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "templateName": "newIssueNotificationMessage" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadGroup.json new file mode 100644 index 000000000000..cc59973303de --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadGroup.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "groupId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadGroupUser.json new file mode 100644 index 000000000000..9d347f5e2563 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadGroupUser.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "groupId": "59306a29e4bbd510dc24e5f9", + "uid": "5931a75ae4bbd512a88c680b" + }, + "responses": { + "204": {}, + "404": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadIdentityProvider.json new file mode 100644 index 000000000000..4a27c1afefc5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadIdentityProvider.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "identityProviderName": "aadB2C" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadLogger.json new file mode 100644 index 000000000000..44d0d50e146f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadLogger.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "loggerid": "templateLogger" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadNotificationRecipientEmail.json new file mode 100644 index 000000000000..b617415db68c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadNotificationRecipientEmail.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "notificationName": "RequestPublisherNotificationMessage", + "email": "contoso@live.com" + }, + "responses": { + "204": {}, + "404": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadNotificationRecipientUser.json new file mode 100644 index 000000000000..cc7cbb457780 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadNotificationRecipientUser.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "notificationName": "RequestPublisherNotificationMessage", + "uid": "576823d0a40f7e74ec07d642" + }, + "responses": { + "204": {}, + "404": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadOpenIdConnectProvider.json new file mode 100644 index 000000000000..469eca3b01e0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadOpenIdConnectProvider.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "opid": "templateOpenIdConnect2" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadOperationTag.json new file mode 100644 index 000000000000..cb550dfc6bf8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadOperationTag.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "operationId": "59d6bb8f1f7fab13dc67ec9a", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadPolicy.json new file mode 100644 index 000000000000..369708c82c32 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadPolicy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "policyId": "policy" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProduct.json new file mode 100644 index 000000000000..aa66246c488f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProduct.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "unlimited" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProductApi.json new file mode 100644 index 000000000000..28ac1e4770b1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProductApi.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "5931a75ae4bbd512a88c680b", + "apiId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "204": {}, + "404": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProductGroup.json new file mode 100644 index 000000000000..1bc525476c20 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProductGroup.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "5931a75ae4bbd512a88c680b", + "groupId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "204": {}, + "404": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProductPolicy.json new file mode 100644 index 000000000000..e06f180be4e6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProductPolicy.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "unlimited", + "policyId": "policy" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProductTag.json new file mode 100644 index 000000000000..430fb575754d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProductTag.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "59306a29e4bbd510dc24e5f8", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProperty.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProperty.json new file mode 100644 index 000000000000..4b3491c9af19 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadProperty.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "propId": "testarmTemplateproperties2" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadSignInSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadSignInSettings.json new file mode 100644 index 000000000000..eaa776723f51 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadSignInSettings.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadSignUpSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadSignUpSettings.json new file mode 100644 index 000000000000..eaa776723f51 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadSignUpSettings.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadSubscription.json new file mode 100644 index 000000000000..7bc9b4ba85c9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadSubscription.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "sid": "5931a769d8d14f0ad8ce13b8" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadTag.json new file mode 100644 index 000000000000..5c62213ccedf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadTag.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadUser.json new file mode 100644 index 000000000000..453a65a79ce6 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementHeadUser.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "5931a75ae4bbd512a88c680b" + }, + "responses": { + "200": { + "headers": { + "etag": "AAAAAAAAAAa=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiDiagnostics.json new file mode 100644 index 000000000000..48e3108e13fd --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiDiagnostics.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/apis/diagnostics", + "name": "default", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiIssueAttachments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiIssueAttachments.json new file mode 100644 index 000000000000..ec594c46fa6b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiIssueAttachments.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "57d1f7558aa04f15146d9d8a", + "issueId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3", + "type": "Microsoft.ApiManagement/service/apis/issues/attachments", + "name": "57d2ef278aa04f0888cba3f3", + "properties": { + "title": "Issue attachment.", + "contentFormat": "link", + "content": "https://.../image.jpg" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiIssueComments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiIssueComments.json new file mode 100644 index 000000000000..41b8390c985d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiIssueComments.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "57d1f7558aa04f15146d9d8a", + "issueId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb", + "type": "Microsoft.ApiManagement/service/apis/issues/comments", + "name": "599e29ab193c3c0bd0b3e2fb", + "properties": { + "text": "Issue comment.", + "createdDate": "2018-02-01T22:21:20.467Z", + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiIssues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiIssues.json new file mode 100644 index 000000000000..c330abfb911c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiIssues.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "57d1f7558aa04f15146d9d8a" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/issues", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "apiId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiOperationPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiOperationPolicies.json new file mode 100644 index 000000000000..8794bdbc844b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiOperationPolicies.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "599e2953193c3c0bd0b3e2fa", + "operationId": "599e29ab193c3c0bd0b3e2fb" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/599e2953193c3c0bd0b3e2fa/operations/599e29ab193c3c0bd0b3e2fb/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/operations/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n\r\n \r\n \r\n \r\n \r\n xxx\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiOperations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiOperations.json new file mode 100644 index 000000000000..8f49113dc33c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiOperations.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3", + "operationId": "57d2ef278aa04f0ad01d6cdc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "displayName": "CancelOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "57d2ef278aa04f0ad01d6cda", + "properties": { + "displayName": "GetMostRecentOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetMostRecentOrder" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "57d2ef278aa04f0ad01d6cd9", + "properties": { + "displayName": "GetOpenOrders", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOpenOrders" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "57d2ef278aa04f0ad01d6cdb", + "properties": { + "displayName": "GetOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOrder" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "57d2ef278aa04f0ad01d6cd8", + "properties": { + "displayName": "submitOrder", + "method": "POST", + "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/submitOrder" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiPolicies.json new file mode 100644 index 000000000000..9258e5ff1253 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiPolicies.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "5600b59475ff190048040001" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b59475ff190048040001/policies/policy", + "type": "Microsoft.ApiManagement/service/apis/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \"; \r\n return string.Join(\",\", DateTime.UtcNow, new string(\r\n Enumerable.Repeat(Chars, Random.Next(2150400))\r\n .Select(s => s[Random.Next(s.Length)])\r\n .ToArray()));\r\n } \r\n \r\n \r\n \r\n" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiReleases.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiReleases.json new file mode 100644 index 000000000000..94cd5c9dbfc0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiReleases.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "a1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/5a7cb545298324c53224a799", + "type": "Microsoft.ApiManagement/service/apis/releases", + "name": "5a7cb545298324c53224a799", + "properties": { + "createdDateTime": "2018-02-08T20:38:29.173Z", + "updatedDateTime": "2018-02-08T20:38:29.173Z", + "notes": "yahoo" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiRevisions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiRevisions.json new file mode 100644 index 000000000000..67b9c59478d5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiRevisions.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1;rev=1", + "apiRevision": "1", + "createdDateTime": "2018-02-01T22:21:20.467Z", + "updatedDateTime": "2018-02-01T22:21:20.467Z", + "isOnline": true, + "isCurrent": true + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiSchemas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiSchemas.json new file mode 100644 index 000000000000..a42f674e7c58 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiSchemas.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "59d5b28d1f7fab116c282650" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d5b28d1f7fab116c282650/schemas/59d5b28e1f7fab116402044e", + "type": "Microsoft.ApiManagement/service/apis/schemas", + "name": "59d5b28e1f7fab116402044e", + "properties": { + "contentType": "application/vnd.ms-azure-apim.swagger.definitions+json" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiVersionSets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiVersionSets.json new file mode 100644 index 000000000000..475cc3788aaa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApiVersionSets.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/api-version-sets/vs1", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "name": "vs1", + "properties": { + "displayName": "api set 1", + "versioningScheme": "Segment", + "description": "Version configuration" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/api-version-sets/vs2", + "type": "Microsoft.ApiManagement/service/api-version-sets", + "name": "vs2", + "properties": { + "displayName": "api set 2", + "versioningScheme": "Query", + "description": "Version configuration 2" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApis.json new file mode 100644 index 000000000000..c3eb8039cc7a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApis.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "type": "Microsoft.ApiManagement/service/apis", + "name": "a1", + "properties": { + "displayName": "api1", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "api1", + "protocols": [ + "https" + ], + "isCurrent": true, + "apiVersionSetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/api-version-sets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a73933b8f27f7cc82a2d533", + "type": "Microsoft.ApiManagement/service/apis", + "name": "5a73933b8f27f7cc82a2d533", + "properties": { + "displayName": "api1", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "api1", + "protocols": [ + "https" + ], + "isCurrent": true, + "apiVersion": "v1", + "apiVersionSetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/api-version-sets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api", + "properties": { + "displayName": "Echo API", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo", + "protocols": [ + "https" + ], + "isCurrent": true + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a7390baa5816a110435aee0", + "type": "Microsoft.ApiManagement/service/apis", + "name": "5a7390baa5816a110435aee0", + "properties": { + "displayName": "Swagger Petstore Extensive", + "apiRevision": "1", + "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", + "serviceUrl": "http://petstore.swagger.wordnik.com/api", + "path": "vvv", + "protocols": [ + "https" + ], + "isCurrent": true + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApisByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApisByTags.json new file mode 100644 index 000000000000..c1aede0791dc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListApisByTags.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tag": { + "id": "/tags/apitag123", + "name": "awesomeTag" + }, + "api": { + "id": "/apis/echo-api", + "name": "Echo API", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo", + "isCurrent": true + } + } + ], + "count": 1 + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListAuthorizationServers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListAuthorizationServers.json new file mode 100644 index 000000000000..dfed4755514b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListAuthorizationServers.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "name": "newauthServer", + "properties": { + "displayName": "test2", + "description": "test server", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "supportState": true, + "defaultScope": "read write", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "clientSecret": "2", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer2", + "type": "Microsoft.ApiManagement/service/authorizationServers", + "name": "newauthServer2", + "properties": { + "displayName": "test3", + "description": "test server", + "clientRegistrationEndpoint": "https://www.contoso.com/apps", + "authorizationEndpoint": "https://www.contoso.com/oauth2/auth", + "authorizationMethods": [ + "GET" + ], + "clientAuthenticationMethod": [ + "Basic" + ], + "tokenEndpoint": "https://www.contoso.com/oauth2/token", + "supportState": true, + "defaultScope": "read write", + "grantTypes": [ + "authorizationCode", + "implicit" + ], + "bearerTokenSendingMethods": [ + "authorizationHeader" + ], + "clientId": "1", + "clientSecret": "2", + "resourceOwnerUsername": "un", + "resourceOwnerPassword": "pwd" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListBackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListBackends.json new file mode 100644 index 000000000000..f94e2f216613 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListBackends.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "proxybackend", + "properties": { + "description": "description5308", + "url": "https://backendname2644/", + "protocol": "http", + "credentials": { + "query": { + "sv": [ + "xx", + "bb", + "cc" + ] + }, + "header": { + "x-my-1": [ + "val1", + "val2" + ] + }, + "authorization": { + "scheme": "Basic", + "parameter": "opensesma" + } + }, + "proxy": { + "url": "http://192.168.1.1:8080", + "username": "Contoso\\admin", + "password": "opensesame" + }, + "tls": { + "validateCertificateChain": false, + "validateCertificateName": false + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend", + "type": "Microsoft.ApiManagement/service/backends", + "name": "sfbackend", + "properties": { + "description": "Service Fabric Test App 1", + "url": "fabric:/mytestapp/mytestservice", + "protocol": "http", + "properties": { + "serviceFabricCluster": { + "managementEndpoints": [ + "https://somecluster.com" + ], + "clientCertificatethumbprint": "EBA029198AA3E76EF0D70482626E5BCF148594A6", + "serverX509Names": [ + { + "name": "ServerCommonName1", + "issuerCertificateThumbprint": "IssuerCertificateThumbprint1" + } + ], + "maxPartitionResolutionRetries": 5 + } + } + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListCertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListCertificates.json new file mode 100644 index 000000000000..c49a0881650f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListCertificates.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/kjoshiarmtemplateCert1", + "type": "Microsoft.ApiManagement/service/certificates", + "name": "templateCert1", + "properties": { + "subject": "CN=mutual-authcert", + "thumbprint": "EBA************************48594A6", + "expirationDate": "2017-04-23T17:03:41Z" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListDiagnostics.json new file mode 100644 index 000000000000..1ea1ecdbb7ea --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListDiagnostics.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights", + "type": "Microsoft.ApiManagement/service/diagnostics", + "name": "applicationinsights", + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListEmailTemplates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListEmailTemplates.json new file mode 100644 index 000000000000..d81611051391 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListEmailTemplates.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/templates/ApplicationApprovedNotificationMessage", + "type": "Microsoft.ApiManagement/service/templates", + "name": "ApplicationApprovedNotificationMessage", + "properties": { + "subject": "Your application $AppName is published in the application gallery", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

\r\n We are happy to let you know that your request to publish the $AppName application in the application gallery has been approved. Your application has been published and can be viewed here.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n", + "title": "Application gallery submission approved", + "description": "Developers who submitted their application for publication in the application gallery on the developer portal receive this email after their submission is approved.", + "isDefault": true, + "parameters": [ + { + "name": "AppId", + "title": "Application id" + }, + { + "name": "AppName", + "title": "Application name" + }, + { + "name": "DevFirstName", + "title": "Developer first name" + }, + { + "name": "DevLastName", + "title": "Developer last name" + }, + { + "name": "OrganizationName", + "title": "Organization name" + }, + { + "name": "DevPortalUrl", + "title": "Developer portal URL" + } + ] + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListGroupUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListGroupUsers.json new file mode 100644 index 000000000000..5c6c2a8f01c2 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListGroupUsers.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "groupId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/kjoshiarmTemplateUser1", + "type": "Microsoft.ApiManagement/service/groups/users", + "name": "armTemplateUser1", + "properties": { + "firstName": "user1", + "lastName": "lastname1", + "email": "user1@live.com", + "state": "active", + "registrationDate": "2017-05-31T18:54:41.447Z", + "note": "note for user 1", + "identities": [ + { + "provider": "Basic", + "id": "user1@live.com" + } + ] + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListGroups.json new file mode 100644 index 000000000000..53b925e01b9a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListGroups.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/groups", + "name": "5600b59375ff190048020001", + "properties": { + "displayName": "Administrators", + "description": "Administrators is a built-in group. Its membership is managed by the system. Microsoft Azure subscription administrators fall into this group.", + "builtIn": true, + "type": "system" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/groups", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)", + "description": "awesome group of people", + "builtIn": false, + "type": "external", + "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/groups", + "name": "5600b59375ff190048020002", + "properties": { + "displayName": "Developers", + "description": "Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.", + "builtIn": true, + "type": "system" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020003", + "type": "Microsoft.ApiManagement/service/groups", + "name": "5600b59375ff190048020003", + "properties": { + "displayName": "Guests", + "description": "Guests is a built-in group. Its membership is managed by the system. Unauthenticated users visiting the developer portal fall into this group.", + "builtIn": true, + "type": "system" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListIdentityProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListIdentityProviders.json new file mode 100644 index 000000000000..8474ce1afa0f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListIdentityProviders.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Google", + "type": "Microsoft.ApiManagement/service/identityProviders", + "name": "Google", + "properties": { + "clientId": "googleId", + "clientSecret": "googlesecret", + "type": "google" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Aad", + "type": "Microsoft.ApiManagement/service/identityProviders", + "name": "Aad", + "properties": { + "clientId": "aadapplicationid", + "clientSecret": "aadapplicationkey", + "type": "aad", + "allowedTenants": [ + "samiraad.onmicrosoft.com" + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C", + "type": "Microsoft.ApiManagement/service/identityProviders", + "name": "AadB2C", + "properties": { + "clientId": "aadb2clientId", + "clientSecret": "aadb2cClientKey", + "type": "aadB2C", + "allowedTenants": [ + "samirtestbc.onmicrosoft.com" + ], + "signupPolicyName": "B2C_1_Signup_Default", + "signinPolicyName": "B2C_1_Signin_Default" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListIssues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListIssues.json new file mode 100644 index 000000000000..6a2d429f5834 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListIssues.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues/57d2ef278aa04f0ad01d6cdc", + "type": "Microsoft.ApiManagement/service/issues", + "name": "57d2ef278aa04f0ad01d6cdc", + "properties": { + "title": "New API issue", + "description": "New API issue description", + "createdDate": "2018-02-01T22:21:20.467Z", + "state": "open", + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "apiId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListLoggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListLoggers.json new file mode 100644 index 000000000000..398790694736 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListLoggers.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/buffered111", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "buffered111", + "properties": { + "loggerType": "azureEventHub", + "description": "Sample description", + "credentials": { + "connectionString": "Endpoint=sb://apimaccounts.servicebus.windows.net/;SharedAccessKeyName=Send;SharedAccessKey=*******************h=****" + }, + "isBuffered": true, + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/apimaccounts" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId", + "type": "Microsoft.ApiManagement/service/loggers", + "name": "loggerId", + "properties": { + "loggerType": "azureEventHub", + "description": "adding a new logger", + "credentials": { + "name": "hydraeventhub", + "connectionString": "{{Logger-Credentials-59544ef2e4bbd50d9468c618}}" + }, + "isBuffered": true, + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/hydraeventhub-ns" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListNotificationRecipientEmail.json new file mode 100644 index 000000000000..27049e2efe25 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListNotificationRecipientEmail.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "notificationName": "RequestPublisherNotificationMessage" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "name": "contoso@live.com", + "properties": { + "email": "contoso@live.com" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "name": "foobar!live", + "properties": { + "email": "foobar!live" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com", + "type": "Microsoft.ApiManagement/service/notifications/recipientEmails", + "name": "foobar@live.com", + "properties": { + "email": "foobar@live.com" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListNotificationRecipientUser.json new file mode 100644 index 000000000000..68b9dcb3890a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListNotificationRecipientUser.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "notificationName": "RequestPublisherNotificationMessage" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientUsers/576823d0a40f7e74ec07d642", + "type": "Microsoft.ApiManagement/service/notifications/recipientUsers", + "name": "576823d0a40f7e74ec07d642", + "properties": { + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListNotifications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListNotifications.json new file mode 100644 index 000000000000..61060ccf4464 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListNotifications.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "RequestPublisherNotificationMessage", + "properties": { + "title": "Subscription requests (requiring approval)", + "description": "The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.", + "recipients": { + "emails": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar!live", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/foobar@live.com" + ], + "users": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/576823d0a40f7e74ec07d642" + ] + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/PurchasePublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "PurchasePublisherNotificationMessage", + "properties": { + "title": "New subscriptions", + "description": "The following email recipients and users will receive email notifications about new API product subscriptions.", + "recipients": { + "emails": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com" + ], + "users": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + ] + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewApplicationNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "NewApplicationNotificationMessage", + "properties": { + "title": "Application gallery requests", + "description": "The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.", + "recipients": { + "emails": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com" + ], + "users": [] + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/BCC", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "BCC", + "properties": { + "title": "BCC", + "description": "The following recipients will receive blind carbon copies of all emails sent to developers.", + "recipients": { + "emails": [], + "users": [] + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/NewIssuePublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "NewIssuePublisherNotificationMessage", + "properties": { + "title": "New issue or comment", + "description": "The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.", + "recipients": { + "emails": [], + "users": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + ] + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/AccountClosedPublisher", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "AccountClosedPublisher", + "properties": { + "title": "Close account message", + "description": "The following email recipients and users will receive email notifications when developer closes his account", + "recipients": { + "emails": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/RequestPublisherNotificationMessage/recipientEmails/contoso@live.com" + ], + "users": [] + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/notifications/QuotaLimitApproachingPublisherNotificationMessage", + "type": "Microsoft.ApiManagement/service/notifications", + "name": "QuotaLimitApproachingPublisherNotificationMessage", + "properties": { + "title": "Approaching subscription quota limit", + "description": "The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.", + "recipients": { + "emails": [], + "users": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1" + ] + } + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListOpenIdConnectProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListOpenIdConnectProviders.json new file mode 100644 index 000000000000..b7814c75a7a0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListOpenIdConnectProviders.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2", + "type": "Microsoft.ApiManagement/service/openidconnectproviders", + "name": "templateOpenIdConnect2", + "properties": { + "displayName": "templateoidprovider2", + "description": "open id provider template2", + "metadataEndpoint": "https://oidprovider-template2.net", + "clientId": "oidprovidertemplate2", + "clientSecret": "oidsecretproviderTemplate2" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListOperations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListOperations.json new file mode 100644 index 000000000000..9fb4700027fb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListOperations.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ApiManagement/service/write", + "display": { + "provider": "Microsoft API Management", + "resource": "Service", + "operation": "Create a new instance of API Management Service", + "description": "Create a new instance of API Management Service" + } + }, + { + "name": "Microsoft.ApiManagement/service/read", + "display": { + "provider": "Microsoft API Management", + "resource": "Service", + "operation": "Read metadata for an API Management Service instance", + "description": "Read metadata for an API Management Service instance" + } + }, + { + "name": "Microsoft.ApiManagement/service/delete", + "display": { + "provider": "Microsoft API Management", + "resource": "Service", + "operation": "Delete API Management Service instance", + "description": "Delete API Management Service instance" + } + }, + { + "origin": "system", + "name": "Microsoft.ApiManagement/service/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft API Management", + "resource": "Service", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for API Management service" + } + }, + { + "name": "Microsoft.ApiManagement/service/tenant/operationResults/read", + "display": { + "provider": "Microsoft API Management", + "resource": "Results of async operations", + "operation": "Get operation results or Get operation result", + "description": "Get list of operation results or Get result of a specific operation" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListOperationsByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListOperationsByTags.json new file mode 100644 index 000000000000..fb79ab0fe4e4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListOperationsByTags.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "a1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tag": { + "id": "/tags/apitag123", + "name": "awesomeTag" + }, + "operation": { + "id": "/apis/echo-api/operations/create-resource", + "apiName": "Echo API", + "apiRevision": "1", + "name": "Create resource", + "method": "POST", + "urlTemplate": "/resource", + "description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend." + } + } + ], + "count": 1 + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListPolicies.json new file mode 100644 index 000000000000..1d0531ff13d4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListPolicies.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy", + "type": "Microsoft.ApiManagement/service/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListPolicySnippets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListPolicySnippets.json new file mode 100644 index 000000000000..54f9527cefa7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListPolicySnippets.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "scope":"Api" + }, + "responses": { + "200": { + "body": [ + { + "name": "Authenticate with Basic", + "content": "", + "toolTip": "Authenticate with the backend service using Basic authentication. Use in the inbound section at API scope.", + "scope": 268435471 + } + ] + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProductApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProductApis.json new file mode 100644 index 000000000000..89f928008cd7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProductApis.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "5768181ea40f7eb6c49f6ac7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7/apis/57681820a40f7eb6c49f6aca", + "type": "Microsoft.ApiManagement/service/products/apis", + "name": "57681820a40f7eb6c49f6aca", + "properties": { + "displayName": "api_57681820a40f7eb6c49f6acb", + "apiRevision": "1", + "description": "description_57681820a40f7eb6c49f6acc", + "serviceUrl": "http://contoso/57681820a40f7eb6c49f6acd", + "path": "suffix_57681820a40f7eb6c49f6ace", + "protocols": [ + "https" + ], + "isCurrent": true + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProductGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProductGroups.json new file mode 100644 index 000000000000..fc25a3a70716 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProductGroups.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "5600b57e7e8880006a060002" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020001", + "type": "Microsoft.ApiManagement/service/products/groups", + "name": "5600b57e7e8880006a020001", + "properties": { + "displayName": "Administrators", + "description": "Administrators is a built-in group. Its membership is managed by the system. Microsoft Azure subscription administrators fall into this group.", + "builtIn": true, + "type": "system" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020002", + "type": "Microsoft.ApiManagement/service/products/groups", + "name": "5600b57e7e8880006a020002", + "properties": { + "displayName": "Developers", + "description": "Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.", + "builtIn": true, + "type": "system" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020003", + "type": "Microsoft.ApiManagement/service/products/groups", + "name": "5600b57e7e8880006a020003", + "properties": { + "displayName": "Guests", + "description": "Guests is a built-in group. Its membership is managed by the system. Unauthenticated users visiting the developer portal fall into this group.", + "builtIn": true, + "type": "system" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProductPolicy.json new file mode 100644 index 000000000000..fa5ece42d171 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProductPolicy.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "armTemplateProduct4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/armTemplateProduct4/policies/policy", + "type": "Microsoft.ApiManagement/service/products/policies", + "name": "policy", + "properties": { + "policyContent": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProductSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProductSubscriptions.json new file mode 100644 index 000000000000..e1a16c925aa5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProductSubscriptions.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "5600b57e7e8880006a060002" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/subscriptions/5600b57e7e8880006a070002", + "type": "Microsoft.ApiManagement/service/products/subscriptions", + "name": "5600b57e7e8880006a070002", + "properties": { + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "productId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002", + "state": "active", + "createdDate": "2015-09-22T01:57:18.723Z", + "primaryKey": "ba95768e868648848e215f0290eec023", + "secondaryKey": "140f866def81419b9bb9732d05d24535" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProducts.json new file mode 100644 index 000000000000..a35ce162df62 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProducts.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmtemplateCert1", + "type": "Microsoft.ApiManagement/service/products", + "name": "kjoshiarmtemplateCert1", + "properties": { + "displayName": "Dev", + "description": "Development Product", + "subscriptionRequired": false, + "state": "published" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter", + "type": "Microsoft.ApiManagement/service/products", + "name": "starter", + "properties": { + "displayName": "Starter", + "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", + "terms": "", + "subscriptionRequired": true, + "approvalRequired": false, + "subscriptionsLimit": 1, + "state": "published" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited", + "type": "Microsoft.ApiManagement/service/products", + "name": "unlimited", + "properties": { + "displayName": "Unlimited", + "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.", + "subscriptionRequired": true, + "approvalRequired": true, + "subscriptionsLimit": 1, + "state": "published" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProperties.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProperties.json new file mode 100644 index 000000000000..9c32e1dae552 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListProperties.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/properties/592f1174cc83890dc4f32686", + "type": "Microsoft.ApiManagement/service/properties", + "name": "592f1174cc83890dc4f32686", + "properties": { + "displayName": "Logger-Credentials-592f1174cc83890dc4f32687", + "value": "Endpoint=sb://testtemplatetesteh.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=...", + "secret": true + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/properties/testarmTemplateproperties2", + "type": "Microsoft.ApiManagement/service/properties", + "name": "testarmTemplateproperties2", + "properties": { + "displayName": "propName", + "value": "propValue", + "tags": [ + "foo", + "bar" + ], + "secret": false + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListRegions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListRegions.json new file mode 100644 index 000000000000..e95a5bf6d1fe --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListRegions.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "West US", + "isMasterRegion": true, + "isDeleted": false + } + ], + "count": 1, + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListServiceBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListServiceBySubscription.json new file mode 100644 index 000000000000..499fe7d76c25 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListServiceBySubscription.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3", + "name": "apimService3", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "West US", + "etag": "AAAAAAAXXAQ=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "contoso", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-05-27T15:33:55.5426123Z", + "gatewayUrl": "https://apimService3.azure-api.net", + "portalUrl": "https://apimService3.portal.azure-api.net", + "managementApiUrl": "https://apimService3.management.azure-api.net", + "scmUrl": "https://apimService3.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "13.88.16.64" + ], + "additionalLocations": [ + { + "location": "West Europe", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "publicIPAddresses": [ + "52.233.184.197" + ] + } + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.ApiManagement/service/apimService2", + "name": "apimService2", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "West US", + "etag": "AAAAAAAXW4U=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "MS", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-05-26T23:55:31.1405115Z", + "gatewayUrl": "https://apimService2.azure-api.net", + "portalUrl": "https://apimService2.portal.azure-api.net", + "managementApiUrl": "https://apimService2.management.azure-api.net", + "scmUrl": "https://apimService2.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "13.64.237.151" + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Developer", + "capacity": 1 + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService5", + "name": "apimService5", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "West US", + "etag": "AAAAAAAXW5c=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "contoso", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-05-26T18:13:02.0196315Z", + "gatewayUrl": "https://apimService5.azure-api.net", + "portalUrl": "https://apimService5.portal.azure-api.net", + "managementApiUrl": "https://apimService5.management.azure-api.net", + "scmUrl": "https://apimService5.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "proxytemplatehostname1.contoso.com", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "DE57B67BA63D21E925DA8BEFA436E6B7553A4C19", + "subject": "CN=proxytemplatehostname1.contoso.com" + } + }, + { + "type": "Proxy", + "hostName": "proxytemplatehostname2.contoso.com", + "negotiateClientCertificate": true, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "DE57B67BA63D21E925DA8BEFA436E6B7553A4C19", + "subject": "CN=proxytemplatehostname2.contoso.com" + } + }, + { + "type": "Proxy", + "hostName": "proxytemplatehostname3.azure-api.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=proxytemplatehostname3.contoso.com" + } + }, + { + "type": "Proxy", + "hostName": "proxytemplatehostname4.azure-api.net", + "negotiateClientCertificate": true, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=proxytemplatehostname4.contoso.com" + } + }, + { + "type": "Portal", + "hostName": "portaltemplatehostname1.contoso.com", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "DE57B67BA63D21E925DA8BEFA436E6B7553A4C19", + "subject": "CN=portaltemplatehostname1.contoso.com" + } + } + ], + "publicIPAddresses": [ + "13.93.167.166" + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json new file mode 100644 index 000000000000..f49dc57a9640 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3", + "name": "apimService3", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "West US", + "etag": "AAAAAAAXXAQ=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "contoso", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-05-27T15:33:55.5426123Z", + "gatewayUrl": "https://apimService3.azure-api.net", + "portalUrl": "https://apimService3.portal.azure-api.net", + "managementApiUrl": "https://apimService3.management.azure-api.net", + "scmUrl": "https://apimService3.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "13.88.16.64" + ], + "additionalLocations": [ + { + "location": "West Europe", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "publicIPAddresses": [ + "52.233.184.197" + ] + } + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService2", + "name": "apimService2", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "West US", + "etag": "AAAAAAAXW4U=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "MS", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-05-26T23:55:31.1405115Z", + "gatewayUrl": "https://apimService2.azure-api.net", + "portalUrl": "https://apimService2.portal.azure-api.net", + "managementApiUrl": "https://apimService2.management.azure-api.net", + "scmUrl": "https://apimService2.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "13.64.237.151" + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Developer", + "capacity": 1 + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService5", + "name": "apimService5", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "West US", + "etag": "AAAAAAAXW5c=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "contoso", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-05-26T18:13:02.0196315Z", + "gatewayUrl": "https://apimService5.azure-api.net", + "portalUrl": "https://apimService5.portal.azure-api.net", + "managementApiUrl": "https://apimService5.management.azure-api.net", + "scmUrl": "https://apimService5.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "proxytemplatehostname1.contoso.com", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "DE57B67BA63D21E925DA8BEFA436E6B7553A4C19", + "subject": "CN=proxytemplatehostname1.contoso.com" + } + }, + { + "type": "Proxy", + "hostName": "proxytemplatehostname2.contoso.com", + "negotiateClientCertificate": true, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "DE57B67BA63D21E925DA8BEFA436E6B7553A4C19", + "subject": "CN=proxytemplatehostname2.contoso.com" + } + }, + { + "type": "Proxy", + "hostName": "proxytemplatehostname3.azure-api.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=proxytemplatehostname3.contoso.com" + } + }, + { + "type": "Proxy", + "hostName": "proxytemplatehostname4.azure-api.net", + "negotiateClientCertificate": true, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=proxytemplatehostname4.contoso.com" + } + }, + { + "type": "Portal", + "hostName": "portaltemplatehostname1.contoso.com", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "DE57B67BA63D21E925DA8BEFA436E6B7553A4C19", + "subject": "CN=portaltemplatehostname1.contoso.com" + } + } + ], + "publicIPAddresses": [ + "13.93.167.166" + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListSubscriptions.json new file mode 100644 index 000000000000..476913247542 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListSubscriptions.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5600b59475ff190048070001", + "type": "Microsoft.ApiManagement/service/subscriptions", + "name": "5600b59475ff190048070001", + "properties": { + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "productId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001", + "state": "active", + "createdDate": "2015-09-22T01:57:40.3Z", + "primaryKey": "a24782fc06f648cbb1c3406c41dc9a3a", + "secondaryKey": "b366198986614a7497a5a68fae19119d" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/56eaed3dbaf08b06e46d27fe", + "type": "Microsoft.ApiManagement/service/subscriptions", + "name": "56eaed3dbaf08b06e46d27fe", + "properties": { + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd", + "productId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001", + "displayName": "Starter", + "state": "active", + "createdDate": "2016-03-17T17:45:33.837Z", + "startDate": "2016-03-17T00:00:00Z", + "expirationDate": "2016-04-01T00:00:00Z", + "notificationDate": "2016-03-20T00:00:00Z", + "primaryKey": "77708695e79a495bb99b95f32adfa1f0", + "secondaryKey": "12e2e4ba857e420b88450dc8fe2a6cf9" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8", + "type": "Microsoft.ApiManagement/service/subscriptions", + "name": "5931a769d8d14f0ad8ce13b8", + "properties": { + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "productId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002", + "displayName": "Unlimited", + "state": "submitted", + "createdDate": "2017-06-02T17:59:06.223Z", + "primaryKey": "6de0a3b2da204e459148d2f6785873f0", + "secondaryKey": "c6de00b451f64ea780db1eb8dcf30b62" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListTagResources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListTagResources.json new file mode 100644 index 000000000000..11c8b9780acb --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListTagResources.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tag": { + "id": "/tags/apitag123", + "name": "awesomeTag" + }, + "operation": { + "id": "/apis/echo-api/operations/create-resource", + "apiName": "Echo API", + "apiRevision": "1", + "name": "Create resource", + "method": "POST", + "urlTemplate": "/resource", + "description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend." + } + }, + { + "tag": { + "id": "/tags/apitag123", + "name": "awesomeTag" + }, + "api": { + "id": "/apis/echo-api", + "name": "Echo API", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo", + "isCurrent": true + } + }, + { + "tag": { + "id": "/tags/apitag123", + "name": "awesomeTag" + }, + "product": { + "id": "/products/starter", + "name": "Starter", + "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", + "terms": "", + "subscriptionRequired": true, + "approvalRequired": false, + "subscriptionsLimit": 1, + "state": "published" + } + } + ], + "count": 3 + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListTags.json new file mode 100644 index 000000000000..a8de2300e652 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListTags.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020001", + "properties": { + "displayName": "tag1" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020002", + "properties": { + "displayName": "tag2" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListUserGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListUserGroups.json new file mode 100644 index 000000000000..edd012c34ccc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListUserGroups.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "57681833a40f7eb6c49f6acf" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/groups/5600b57e7e8880006a020002", + "type": "Microsoft.ApiManagement/service/users/groups", + "name": "5600b57e7e8880006a020002", + "properties": { + "displayName": "Developers", + "description": "Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.", + "builtIn": true, + "type": "system" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListUserSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListUserSubscriptions.json new file mode 100644 index 000000000000..53b4edf7f983 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListUserSubscriptions.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "57681833a40f7eb6c49f6acf" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6ae3", + "type": "Microsoft.ApiManagement/service/users/subscriptions", + "name": "57681850a40f7eb6c49f6ae3", + "properties": { + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf", + "productId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7", + "displayName": "57681850a40f7eb6c49f6ae5", + "state": "active", + "createdDate": "2016-06-20T16:22:39.547Z", + "startDate": "2016-06-20T00:00:00Z", + "primaryKey": "57681850a40f7eb6c49f6ae4", + "secondaryKey": "bbd884a96b3c41b49f34422dac74b345" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6b2b", + "type": "Microsoft.ApiManagement/service/users/subscriptions", + "name": "57681850a40f7eb6c49f6b2b", + "properties": { + "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf", + "productId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7", + "displayName": "57681850a40f7eb6c49f6b2d", + "state": "active", + "createdDate": "2016-06-20T16:22:41.103Z", + "startDate": "2016-06-20T00:00:00Z", + "primaryKey": "57681850a40f7eb6c49f6b2c", + "secondaryKey": "125f565d276647dc825d7f25ea40ee57" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListUsers.json new file mode 100644 index 000000000000..4c6445001ae7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListUsers.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1", + "type": "Microsoft.ApiManagement/service/users", + "name": "1", + "properties": { + "firstName": "Administrator", + "lastName": "", + "email": "admin@live.com", + "state": "active", + "registrationDate": "2015-09-22T01:57:39.677Z", + "identities": [ + { + "provider": "Azure", + "id": "admin@live.com" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd", + "type": "Microsoft.ApiManagement/service/users", + "name": "56eaec62baf08b06e46d27fd", + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foo.bar.83@gmail.com", + "state": "active", + "registrationDate": "2016-03-17T17:41:56.327Z", + "identities": [ + { + "provider": "Basic", + "id": "foo.bar.83@gmail.com" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b", + "type": "Microsoft.ApiManagement/service/users", + "name": "5931a75ae4bbd512a88c680b", + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foobar@outlook.com", + "state": "active", + "registrationDate": "2017-06-02T17:58:50.357Z", + "identities": [ + { + "provider": "Microsoft", + "id": "*************" + } + ] + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListUsersIdentities.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListUsersIdentities.json new file mode 100644 index 000000000000..d57c487a3955 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListUsersIdentities.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "57f2af53bb17172280f44057" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "provider": "Microsoft", + "id": "086cf9********55ab" + } + ], + "count": 1, + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsGetDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsGetDelegation.json new file mode 100644 index 000000000000..00b57df099b4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsGetDelegation.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "delegation", + "properties": { + "url": "http://contoso.com/delegation", + "validationKey": "nVF7aKIvr9mV/RM5lOD0sYoi8ThXTRHQP7o66hvUmjCDkPKR3qxPu/otJcNciz2aQdqPuzJH3ECG4TU2yZjQ7Q==", + "subscriptions": { + "enabled": true + }, + "userRegistration": { + "enabled": true + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsGetSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsGetSignIn.json new file mode 100644 index 000000000000..12488dfa8a31 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsGetSignIn.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "signin", + "properties": { + "enabled": true + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsGetSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsGetSignUp.json new file mode 100644 index 000000000000..8d842a61e3fa --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsGetSignUp.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "signup", + "properties": { + "enabled": true, + "termsOfService": { + "text": "Terms of service text.", + "enabled": true, + "consentRequired": true + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsPutDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsPutDelegation.json new file mode 100644 index 000000000000..f12c48435929 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsPutDelegation.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "5931a75ae4bbd512288c680b", + "If-Match": "*", + "parameters": { + "properties": { + "url": "http://contoso.com/delegation", + "validationKey": "nVF7aKIvr9mV/RM5lOD0sYoi8ThXTRHQP7o66hvUmjCDkPKR3qxPu/otJcNciz2aQdqPuzJH3ECG4TU2yZjQ7Q==", + "subscriptions": { + "enabled": true + }, + "userRegistration": { + "enabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "delegation", + "properties": { + "url": "http://contoso.com/delegation", + "validationKey": "nVF7aKIvr9mV/RM5lOD0sYoi8ThXTRHQP7o66hvUmjCDkPKR3qxPu/otJcNciz2aQdqPuzJH3ECG4TU2yZjQ7Q==", + "subscriptions": { + "enabled": true + }, + "userRegistration": { + "enabled": true + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsPutSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsPutSignIn.json new file mode 100644 index 000000000000..9860b7d886d9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsPutSignIn.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "5931a75ae4bbd512288c680b", + "If-Match": "*", + "parameters": { + "properties": { + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signin", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "signin", + "properties": { + "enabled": true + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsPutSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsPutSignUp.json new file mode 100644 index 000000000000..01fc2da2a495 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsPutSignUp.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "5931a75ae4bbd512288c680b", + "If-Match": "*", + "parameters": { + "properties": { + "enabled": true, + "termsOfService": { + "enabled": true, + "text": "Terms of service text.", + "consentRequired": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup", + "type": "Microsoft.ApiManagement/service/portalsettings", + "name": "signup", + "properties": { + "enabled": true, + "termsOfService": { + "text": "Terms of service text.", + "enabled": true, + "consentRequired": true + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsUpdateDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsUpdateDelegation.json new file mode 100644 index 000000000000..d56da4116e68 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsUpdateDelegation.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "5931a75ae4bbd512288c680b", + "If-Match": "*", + "parameters": { + "properties": { + "url": "http://contoso.com/delegation", + "validationKey": "nVF7aKIvr9mV/RM5lOD0sYoi8ThXTRHQP7o66hvUmjCDkPKR3qxPu/otJcNciz2aQdqPuzJH3ECG4TU2yZjQ7Q==", + "subscriptions": { + "enabled": true + }, + "userRegistration": { + "enabled": true + } + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsUpdateSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsUpdateSignIn.json new file mode 100644 index 000000000000..16bcb93ec845 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsUpdateSignIn.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "5931a75ae4bbd512288c680b", + "If-Match": "*", + "parameters": { + "properties": { + "enabled": true + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsUpdateSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsUpdateSignUp.json new file mode 100644 index 000000000000..70e5b6e61066 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementPortalSettingsUpdateSignUp.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "5931a75ae4bbd512288c680b", + "If-Match": "*", + "parameters": { + "properties": { + "enabled": true, + "termsOfService": { + "enabled": true, + "text": "Terms of service text.", + "consentRequired": true + } + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementRestoreService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementRestoreService.json new file mode 100644 index 000000000000..d8b18a9ad78e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementRestoreService.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "storageAccount": "teststorageaccount", + "accessKey": "**************************************************", + "containerName": "backupContainer", + "backupName": "apimService1backup_2017_03_19" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2018-06-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "UID": "52ed5986-717b-45b4-b17c-3df8db372cff" + }, + "location": "East Asia", + "etag": "AAAAAAAXX6Y=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "Contoso", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2015-09-22T01:50:34.7921566Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "207.46.155.24" + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceCheckNameAvailability.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceCheckNameAvailability.json new file mode 100644 index 000000000000..3e7233f6c0b9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceCheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "name" : "apimService1" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "Valid", + "message": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceDeleteService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceDeleteService.json new file mode 100644 index 000000000000..bd25f95cc9ba --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceDeleteService.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetMultiRegionInternalVnet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetMultiRegionInternalVnet.json new file mode 100644 index 000000000000..f9f0002195df --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetMultiRegionInternalVnet.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1", + "name": "apimservice1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "West US", + "etag": "AAAAAADqC0c=", + "properties": { + "publisherEmail": "abcs@contoso.com", + "publisherName": "contoso publisher", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2018-02-02T01:42:09.1268424Z", + "gatewayUrl": "https://apimservice1.azure-api.net", + "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net", + "portalUrl": "https://apimservice1.portal.azure-api.net", + "managementApiUrl": "https://apimservice1.management.azure-api.net", + "scmUrl": "https://apimservice1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "apimgatewaytest.preview.net", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2019-08-16T16:51:34+00:00", + "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476", + "subject": "CN=*.preview.net" + }, + "defaultSslBinding": true + } + ], + "publicIPAddresses": [ + "137.XXX.11.74" + ], + "privateIPAddresses": [ + "172.XX.0.5" + ], + "additionalLocations": [ + { + "location": "West US 2", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "publicIPAddresses": [ + "40.XXX.79.187" + ], + "privateIPAddresses": [ + "10.0.X.6" + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub" + }, + "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net" + } + ], + "virtualNetworkConfiguration": { + "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet" + }, + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True", + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False" + }, + "virtualNetworkType": "Internal" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetNetworkStatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetNetworkStatus.json new file mode 100644 index 000000000000..dd4f1a5223d0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetNetworkStatus.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "location": "North Central US", + "networkStatus": { + "dnsServers": [ + "100.78.90.70" + ], + "connectivityStatus": [ + { + "name": "apimgmtst6mtxxxxxxxx.blob.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:31:07.3274887Z", + "lastStatusChange": "2018-06-13T20:31:06.6590782Z" + }, + { + "name": "apimgmtst6mtxxxxxxxx.file.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:31:08.54627Z", + "lastStatusChange": "2018-06-13T20:31:06.8934611Z" + }, + { + "name": "apimgmtst6mtxxxxxxxx.table.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:31:08.6556497Z", + "lastStatusChange": "2018-06-13T20:31:06.7529128Z" + }, + { + "name": "https://prod3.metrics.nsatc.net:1886/RecoveryService", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:31:08.5618943Z", + "lastStatusChange": "2018-06-13T20:31:07.1125257Z" + }, + { + "name": "n20fxxxxxxxx.database.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:31:09.3275394Z", + "lastStatusChange": "2018-06-13T20:31:07.0968711Z" + }, + { + "name": "Scm", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:31:28.0942291Z", + "lastStatusChange": "2018-06-13T20:41:09.8627827Z" + } + ] + } + }, + { + "location": "South Central US", + "networkStatus": { + "dnsServers": [ + "100.92.34.14" + ], + "connectivityStatus": [ + { + "name": "apimgmtst6mtxxxxxxxx.file.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:36:26.6522053Z", + "lastStatusChange": "2018-06-13T21:36:24.6042279Z" + }, + { + "name": "apimgmtst6mtxxxxxxxx.table.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:36:25.9959344Z", + "lastStatusChange": "2018-06-13T21:36:24.1587528Z" + }, + { + "name": "apimgmtstufddxxxxxxxx.blob.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:36:25.0115192Z", + "lastStatusChange": "2018-06-13T21:36:24.5104599Z" + }, + { + "name": "https://prod2.metrics.nsatc.net:1886/RecoveryService", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:36:26.042817Z", + "lastStatusChange": "2018-06-13T21:36:24.0962419Z" + }, + { + "name": "n20fxxxxxxxx.database.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:36:26.7615872Z", + "lastStatusChange": "2018-06-13T21:36:24.80737Z" + } + ] + } + } + ] + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetNetworkStatusByLocation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetNetworkStatusByLocation.json new file mode 100644 index 000000000000..c95a69cc53d9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetNetworkStatusByLocation.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "locationName": "North Central US" + }, + "responses": { + "200": { + "body": { + "dnsServers": [ + "100.78.90.70" + ], + "connectivityStatus": [ + { + "name": "apimgmtst6mtxxxxxxxx.blob.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:41:07.3844516Z", + "lastStatusChange": "2018-06-13T20:31:06.6590782Z" + }, + { + "name": "apimgmtst6mtxxxxxxxx.file.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:41:08.6657305Z", + "lastStatusChange": "2018-06-13T20:31:06.8934611Z" + }, + { + "name": "apimgmtst6mtxxxxxxxx.table.core.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:41:08.7594708Z", + "lastStatusChange": "2018-06-13T20:31:06.7529128Z" + }, + { + "name": "https://prod3.metrics.nsatc.net:1886/RecoveryService", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:41:08.6969746Z", + "lastStatusChange": "2018-06-13T20:31:07.1125257Z" + }, + { + "name": "n20fxxx.database.windows.net", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:41:09.5094848Z", + "lastStatusChange": "2018-06-13T20:31:07.0968711Z" + }, + { + "name": "Scm", + "status": "success", + "error": "", + "lastUpdated": "2018-06-13T22:41:29.4358865Z", + "lastStatusChange": "2018-06-13T20:41:09.8627827Z" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetService.json new file mode 100644 index 000000000000..ff2b9adb9ed7 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetService.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "Central US", + "etag": "AAAAAAAYP5M=", + "properties": { + "publisherEmail": "contoso@microsoft.com", + "publisherName": "admin", + "notificationSenderEmail": "contoso@live.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-06-28T23:01:33.0667959Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-centralus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "proxyhostname4.contoso.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=*.contoso.net" + } + }, + { + "type": "Proxy", + "hostName": "proxyhostname9.contoso.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=*.contoso.net" + } + }, + { + "type": "Portal", + "hostName": "portalhostname2.contoso.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "918D7785B926AC5AEE66322778A147BCE7237CF3", + "subject": "CN=*.contoso.net" + } + } + ], + "publicIPAddresses": [ + "52.173.22.222" + ], + "additionalLocations": [ + { + "location": "West US", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "publicIPAddresses": [ + "40.78.99.244" + ], + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net" + } + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetServiceHavingMsi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetServiceHavingMsi.json new file mode 100644 index 000000000000..015950500622 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetServiceHavingMsi.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "West US", + "etag": "AAAAAAC2jkE=", + "properties": { + "publisherEmail": "admin@contoso.com", + "publisherName": "Contoso", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "createdAtUtc": "2017-10-13T16:56:47.0174063Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "foobar.msitesting.net", + "keyVaultId": "https://constoso-msi-keyvault.vault.azure.net/secrets/msitestingCert", + "negotiateClientCertificate": false, + "certificate": { + "expiry": "2036-01-01T07:00:00+00:00", + "thumbprint": "8E98XXX52CAXXXXXXX2C91F1D174FDB3A2", + "subject": "CN=*.msitesting.net" + }, + "defaultSslBinding": true + } + ], + "publicIPAddresses": [ + "13.xx.76.xxx" + ] + }, + "sku": { + "name": "Developer", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned", + "principalId": "ae7d906a-xxx-408a-xxxx-6b9d60e5756b", + "tenantId": "72f988bf-xxx-41af-xxxx-2d7cd011db47" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetSsoToken.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetSsoToken.json new file mode 100644 index 000000000000..e0d5698b2458 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceGetSsoToken.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "redirectUri": "https://apimService1.portal.azure-api.net:443/signin-sso?token=1%26201705301929%26eIkr3%2fnfaLs1GVJ0OVbzkJjAcwPFkEZAPM8VUXvXPf7cJ6lWsB9oUwsk2zln9x0KLkn21txCPJWWheSPq7SNeA%3d%3d" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceUpdateHostName.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceUpdateHostName.json new file mode 100644 index 000000000000..39963987ce5b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceUpdateHostName.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "update": [ + { + "type": "Proxy", + "hostname": "internalproxy2.contoso.com", + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "subject": "CN=*.contoso.com" + } + }, + { + "type": "Portal", + "hostname": "internalportal2.contoso.com", + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "subject": "CN=*.contoso.com" + } + }, + { + "type": "Management", + "hostname": "internalmgmt2.contoso.com", + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "subject": "CN=*.contoso.com" + } + }, + { + "type": "Scm", + "hostname": "internalscm2.contoso.com", + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "subject": "CN=*.contoso.com" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2016-10-10" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "Central US", + "etag": "AAAAAAAYP5M=", + "properties": { + "publisherEmail": "contoso@microsoft.com", + "publisherName": "admin", + "notificationSenderEmail": "contoso@live.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-06-28T23:01:33.0667959Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "publicIPAddresses": [ + "52.173.22.222" + ], + "additionalLocations": [ + { + "location": "West US", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "publicIPAddresses": [ + "40.78.99.244" + ] + } + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": {}, + "location": "Central US", + "etag": "AAAAAAAYP5M=", + "properties": { + "publisherEmail": "contoso@microsoft.com", + "publisherName": "admin", + "notificationSenderEmail": "contoso@live.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-06-28T23:01:33.0667959Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [ + { + "type": "Proxy", + "hostName": "internalproxy2.contoso.net", + "negotiateClientCertificate": false, + "defaultSslBinding": true, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "subject": "CN=*.contoso.net" + } + }, + { + "type": "Portal", + "hostName": "internalportal2.contoso.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "subject": "CN=*.contoso.net" + } + }, + { + "type": "Management", + "hostName": "internalmgmt2.contoso.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "subject": "CN=*.contoso.net" + } + }, + { + "type": "Scm", + "hostName": "internalscm2.contoso.net", + "negotiateClientCertificate": false, + "defaultSslBinding": false, + "certificate": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "subject": "CN=*.contoso.net" + } + } + ], + "publicIPAddresses": [ + "52.173.22.222" + ], + "additionalLocations": [ + { + "location": "West US", + "sku": { + "name": "Premium", + "capacity": 1 + }, + "publicIPAddresses": [ + "40.78.99.244" + ] + } + ], + "virtualNetworkType": "None" + }, + "sku": { + "name": "Premium", + "capacity": 1 + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceUploadProxyCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceUploadProxyCertificate.json new file mode 100644 index 000000000000..daef165cb6b5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementServiceUploadProxyCertificate.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "type" : "Proxy", + "certificate" : "MIIZ7wI************************************************************", + "certificate_password": "******" + } + }, + "responses": { + "200": { + "body": { + "expiry": "2018-03-17T21:55:07+00:00", + "thumbprint": "DE57B************************", + "subject": "CN=*.contoso.com" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementSubscriptionRegenerateKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementSubscriptionRegenerateKey.json new file mode 100644 index 000000000000..ee96523a6f05 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementSubscriptionRegenerateKey.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "sid": "testsub" + }, + "responses": { + "204": { } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantAccessRegenerateKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantAccessRegenerateKey.json new file mode 100644 index 000000000000..cd6b957e675e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantAccessRegenerateKey.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "accessName": "access" + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantAccessSyncState.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantAccessSyncState.json new file mode 100644 index 000000000000..21c3079b56d4 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantAccessSyncState.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "configurationName": "configuration" + }, + "responses": { + "200": { + "body": { + "branch": "master", + "commitId": "44c29c27a876372e2ea18d9c381cc493a6a89fc5", + "isExport": true, + "isSynced": false, + "isGitEnabled": true, + "syncDate": "2016-10-24T19:17:14.3641403Z", + "configurationChangeDate": "2017-06-03T00:41:30.9670873Z" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantConfigurationDeploy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantConfigurationDeploy.json new file mode 100644 index 000000000000..1ddd943f3348 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantConfigurationDeploy.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "configurationName": "configuration", + "parameters": { + "branch": "master" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af4ae2a6d2e0b688d7517?api-version=2018-06-01-preview" + } + }, + "200": { + "body": { + "id": "5a1af4ae2a6d2e0b688d7517", + "status": "Failed", + "started": "2017-11-26T17:06:54.303Z", + "updated": "2017-11-26T17:07:21.777Z", + "error": { + "code": "ValidationError", + "message": "File not found: 'api-management/configuration.json'" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantConfigurationSave.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantConfigurationSave.json new file mode 100644 index 000000000000..b1a6240dd34c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantConfigurationSave.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "configurationName": "configuration", + "parameters": { + "branch": "master" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af57d2a6d2e0b688d751b?api-version=2018-06-01-preview" + } + }, + "200": { + "body": { + "id": "5a1af57d2a6d2e0b688d751b", + "status": "Succeeded", + "started": "2017-11-26T17:10:21.957Z", + "updated": "2017-11-26T17:10:36.06Z", + "resultInfo": "The configuration was successfully saved to master as commit cdb6878db80159cc0e9a53f5ad38581883882974.", + "actionLog": [] + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantConfigurationValidate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantConfigurationValidate.json new file mode 100644 index 000000000000..34bc6b27215b --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementTenantConfigurationValidate.json @@ -0,0 +1,170 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "configurationName": "configuration", + "parameters": { + "branch": "master" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af64e2a6d2e0b688d751e?api-version=2018-06-01-preview" + } + }, + "200": { + "body": { + "id": "5a1af64e2a6d2e0b688d751e", + "status": "Succeeded", + "started": "2017-11-26T17:13:50.787Z", + "updated": "2017-11-26T17:13:59.723Z", + "resultInfo": "Validation is successfull", + "actionLog": [ + { + "objectType": "ApiSpecificationContract", + "action": "Updated", + "objectKey": "57914cb351f68a16889be190;rev=1" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "5768181ea40f7eb6c49f6ac7" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "576819c9a40f7e86289fb3e3" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "576819f1a40f7e86289fb6de" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681a67a40f7e72b4132522" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681a73a40f7e72b413281d" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681a7ea40f7e72b4132b18" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681b88a40f7ea0f017f099" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681b9fa40f7ea0f017f682" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681bb5a40f7ea0f017fc6b" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681bcaa40f7ea0f0180254" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681bdfa40f7ea0f018083d" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681bf5a40f7ea0f0180e26" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681c0ea40f7ea0f018140f" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681c26a40f7ea0f01819f8" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681c83a40f7e85f44db237" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681cb2a40f7e85f44dbcd0" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681ce3a40f7e85f44dc769" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681d1fa40f7e85f44dd202" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681d60a40f7e85f44ddc9b" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681db4a40f7e85f44de735" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681e11a40f7e85f44df1ce" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681e73a40f7e85f44dfc67" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "57681f06a40f7e74ec07785c" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "5768211fa40f7e74ec07a74a" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "576823cfa40f7e74ec07d63a" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "5600b57e7e8880006a060001" + }, + { + "objectType": "ProductSpecificationContract", + "action": "Updated", + "objectKey": "5600b57e7e8880006a060002" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApi.json new file mode 100644 index 000000000000..fa4d6ca2942c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApi.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "echo-api", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "Echo API New", + "serviceUrl": "http://echoapi.cloudapp.net/api2", + "path": "newecho" + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiDiagnostic.json new file mode 100644 index 000000000000..af8ef02ea3f3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiDiagnostic.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "diagnosticId": "applicationinsights", + "apiId": "57d1f7558aa04f15146d9d8a", + "If-Match": "*", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiOperation.json new file mode 100644 index 000000000000..9f58164d18fc --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiOperation.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "echo-api", + "operationId":"operationId", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "Retrieve resource", + "method": "GET", + "urlTemplate": "/resource", + "templateParameters": [], + "request": { + "queryParameters": [ + { + "name": "param1", + "description": "A sample parameter that is required and has a default value of \"sample\".", + "type": "string", + "defaultValue": "sample", + "required": true, + "values": [ + "sample" + ] + } + ] + }, + "responses": [ + { + "statusCode": 200, + "description": "Returned in all cases.", + "representations": [], + "headers": [] + }, + { + "statusCode": 500, + "description": "Server Error.", + "representations": [], + "headers": [] + } + ] + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiRelease.json new file mode 100644 index 000000000000..b70872fa4f36 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiRelease.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "a1", + "releaseId": "testrev", + "If-Match": "*", + "parameters": { + "properties": { + "apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1", + "notes": "yahooagain" + } + } + }, + "responses": { + "204": { } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiVersionSet.json new file mode 100644 index 000000000000..e619eefef9bf --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiVersionSet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "versionSetId": "api1", + "If-Match":"*", + "parameters": { + "properties": { + "displayName" : "api set 1", + "versioningScheme" : "Segment", + "description" : "Version configuration" + } + } + }, + "responses": { + "204": { } + } + } \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateAuthorizationServer.json new file mode 100644 index 000000000000..52a5f0c5985f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateAuthorizationServer.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "authsid": "newauthServer", + "If-Match": "*", + "parameters": { + "properties": { + "clientId": "update", + "clientSecret": "updated" + } + } + }, + "responses": { + "204": { } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateBackend.json new file mode 100644 index 000000000000..180640c2efc5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateBackend.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "backendid": "proxybackend", + "If-Match": "*", + "parameters": { + "properties": { + "description": "description5308", + "tls": { + "validateCertificateChain": false, + "validateCertificateName": true + } + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateDiagnostic.json new file mode 100644 index 000000000000..43101dbb0f12 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateDiagnostic.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "diagnosticId": "applicationinsights", + "If-Match": "*", + "parameters": { + "properties": { + "alwaysLog": "allErrors", + "loggerId": "/loggers/applicationinsights", + "sampling": { + "samplingType": "fixed", + "percentage": 50 + }, + "frontend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + }, + "backend": { + "request": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + }, + "response": { + "headers": [ + "Content-type" + ], + "body": { + "bytes": 512 + } + } + } + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateEmailTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateEmailTemplate.json new file mode 100644 index 000000000000..ae63f7d0a089 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateEmailTemplate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "templateName": "applicationApprovedNotificationMessage", + "If-Match": "*", + "parameters": { + "properties": { + "subject": "Your application $AppName is published in the gallery", + "body": "\r\n\r\n \r\n \r\n

Dear $DevFirstName $DevLastName,

\r\n

\r\n We are happy to let you know that your request to publish the $AppName application in the gallery has been approved. Your application has been published and can be viewed here.\r\n

\r\n

Best,

\r\n

The $OrganizationName API Team

\r\n \r\n" + } + } + }, + "responses": { + "204": { } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateGroup.json new file mode 100644 index 000000000000..8a5e0e85ee85 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateGroup.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "groupId": "tempgroup", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "temp group" + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateIdentityProvider.json new file mode 100644 index 000000000000..2177eeeb6198 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateIdentityProvider.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "identityProviderName": "facebook", + "If-Match": "*", + "parameters": { + "properties": { + "clientId": "updatedfacebookid", + "clientSecret": "updatedfacebooksecret" + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateLogger.json new file mode 100644 index 000000000000..c76cacf02a59 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateLogger.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "loggerid": "loggerId", + "If-Match": "*", + "parameters": { + "properties": { + "credentials": { + "name": "hydraeventhub", + "connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********=" + } + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json new file mode 100644 index 000000000000..68957114c82f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "opid": "templateOpenIdConnect2", + "If-Match": "*", + "parameters": { + "properties": { + "clientSecret": "updatedsecret" + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateProductBasic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateProductBasic.json new file mode 100644 index 000000000000..8e1fe288bf05 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateProductBasic.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "productId": "testproduct", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "Test Template ProductName 4" + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateProperty.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateProperty.json new file mode 100644 index 000000000000..aba9892e4632 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateProperty.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "propId": "testprop2", + "If-Match": "*", + "parameters": { + "properties": { + "tags": [ + "foo", + "bar2" + ], + "secret": true + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateQuotaCounterKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateQuotaCounterKey.json new file mode 100644 index 000000000000..b79f476e2115 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateQuotaCounterKey.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "quotaCounterKey": "ba", + "parameters": { + "callsCount": 0, + "kbTransferred": 2.5630078125 + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json new file mode 100644 index 000000000000..f90a752a1c71 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "quotaCounterKey": "ba", + "quotaPeriodKey": "0_P3Y6M4DT12H30M5S", + "parameters": { + "callsCount": 0, + "kbTransferred": 0 + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateServiceDisableTls10.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateServiceDisableTls10.json new file mode 100644 index 000000000000..5f15a08043d0 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateServiceDisableTls10.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false" + } + } + } + }, + "responses": { + "202": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT" + }, + "location": "West US", + "etag": "AAAAAAAYRPs=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "Contoso", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-06-29T17:50:42.3191122Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "40.86.176.232" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False" + }, + "virtualNetworkType": "None" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + }, + "200": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "Owner": "sasolank", + "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3", + "Reserved": "", + "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT", + "Pool": "Manual", + "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT" + }, + "location": "West US", + "etag": "AAAAAAAYRPs=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "Contoso", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-06-29T17:50:42.3191122Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "40.86.176.232" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False" + }, + "virtualNetworkType": "None" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateServicePublisherDetails.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateServicePublisherDetails.json new file mode 100644 index 000000000000..59083597a22e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateServicePublisherDetails.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "publisherEmail": "foobar@live.com", + "publisherName": "Contoso Vnext" + } + } + }, + "responses": { + "202": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT" + }, + "location": "West US", + "etag": "AAAAAAAYRPs=", + "properties": { + "publisherEmail": "admin@live.com", + "publisherName": "Contoso", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-06-29T17:50:42.3191122Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "40.86.176.232" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False" + }, + "virtualNetworkType": "None" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + }, + "200": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1", + "name": "apimService1", + "type": "Microsoft.ApiManagement/service", + "tags": { + "Owner": "sasolank", + "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3", + "Reserved": "", + "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT", + "Pool": "Manual", + "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT" + }, + "location": "West US", + "etag": "AAAAAAAYRPs=", + "properties": { + "publisherEmail": "foobar@live.com", + "publisherName": "Contoso Vnext", + "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com", + "provisioningState": "Succeeded", + "targetProvisioningState": "", + "createdAtUtc": "2017-06-29T17:50:42.3191122Z", + "gatewayUrl": "https://apimService1.azure-api.net", + "portalUrl": "https://apimService1.portal.azure-api.net", + "managementApiUrl": "https://apimService1.management.azure-api.net", + "scmUrl": "https://apimService1.scm.azure-api.net", + "hostnameConfigurations": [], + "publicIPAddresses": [ + "40.86.176.232" + ], + "customProperties": { + "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False" + }, + "virtualNetworkType": "None" + }, + "sku": { + "name": "Standard", + "capacity": 1 + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateSubscription.json new file mode 100644 index 000000000000..f508e0617011 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateSubscription.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "sid": "testsub", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "testsub" + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateTag.json new file mode 100644 index 000000000000..55dfaa9b7bad --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateTag.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "tagId": "temptag", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "temp tag" + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateTenantAccess.json new file mode 100644 index 000000000000..8181090e0b4a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateTenantAccess.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "If-Match": "*", + "accessName": "access", + "parameters": { + "enabled": true + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateUserBasic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateUserBasic.json new file mode 100644 index 000000000000..9306019ad112 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateUserBasic.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "5931a75ae4bbd512288c680b", + "If-Match": "*", + "parameters": { + "properties": { + "firstName": "foo", + "lastName": "bar", + "email": "foobar@outlook.com" + } + } + }, + "responses": { + "204": { } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUsersGenerateSsoUrl.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUsersGenerateSsoUrl.json new file mode 100644 index 000000000000..0e4716db7944 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUsersGenerateSsoUrl.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "57127d485157a511ace86ae7" + }, + "responses": { + "200": { + "body": { + "value": "https://apimService1.portal.azure-api.net/signin-sso?token=57127d485157a511ace86ae7%26201706051624%267VY18MlwAom***********2bYr2bDQHg21OzQsNakExQ%3d%3d" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUsersGetToken.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUsersGetToken.json new file mode 100644 index 000000000000..129d654555e9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUsersGetToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "uid": "57f2af53bb17172280f44057", + "parameters": { + "keyType": "primary", + "expiry": "2017-05-13T10:39:35Z" + } + }, + "responses": { + "200": { + "body": { + "value": "57f2af53bb17172280f44057&201705131039&***************************/tJVExvjA==" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/readme.md b/specification/apimanagement/resource-manager/readme.md index a78524c09bed..5a480ea350a8 100644 --- a/specification/apimanagement/resource-manager/readme.md +++ b/specification/apimanagement/resource-manager/readme.md @@ -28,7 +28,51 @@ These are the global settings for the ApiManagement API. title: ApiManagementClient description: ApiManagement Client openapi-type: arm -tag: package-2018-01 +tag: package-2018-06-preview +``` + +### Tag: package-2018-06-preview + +These settings apply only when `--tag=package-2018-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06-preview' +input-file: +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimanagement.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimauthorizationservers.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimbackends.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimcertificates.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimdiagnostics.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimemailtemplate.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimgroups.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimidentityprovider.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimloggers.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimnotifications.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimnetworkstatus.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimopenidconnectproviders.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimportalsettings.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimproducts.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimproperties.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimquotas.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimreports.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimsubscriptions.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimtagresources.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimtags.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimtenant.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimusers.json +- Microsoft.ApiManagement/preview/2018-06-01-preview/apimversionsets.json +``` + +## Suppression +``` yaml +directive: + - suppress: R3016 + reason: existing properties, can't be changed without breaking API. + #where: + # - $.definitions.ApiManagementServiceUploadCertificateParameters.properties.certificate_password + # - $.definitions.QuotaCounterContract.properties.Value + ``` ### Tag: package-2018-01 @@ -161,6 +205,9 @@ swagger-to-sdk: - repo: azure-sdk-for-node autorest_options: use: "@microsoft.azure/autorest.python@~3.0" + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_api_management'] ``` @@ -197,12 +244,22 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-06-preview - tag: package-2018-01 - tag: package-2017-03 - tag: package-2016-10 - tag: package-2016-07 ``` +### Tag: package-2018-06-preview and go + +These settings apply only when `--tag=package-2018-06-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-06-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/apimanagement/mgmt/2018-06-01-preview/apimanagement +``` + ### Tag: package-2018-01 and go These settings apply only when `--tag=package-2018-01 --go` is specified on the command line. @@ -246,11 +303,74 @@ 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 - fluent: true - namespace: com.microsoft.azure.management.apimanagement - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-apimanagement +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.apimanagement +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-apimanagement ``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-07 + - tag: package-2016-10 + - tag: package-2018-01 + - tag: package-2017-03 +``` + +### Tag: package-2016-07 and java + +These settings apply only when `--tag=package-2016-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.apimanagement.v2016_07_07 + output-folder: $(azure-libraries-for-java-folder)/apimanagement/resource-manager/v2016_07_07 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-10 and java + +These settings apply only when `--tag=package-2016-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.apimanagement.v2016_10_10 + output-folder: $(azure-libraries-for-java-folder)/apimanagement/resource-manager/v2016_10_10 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-01 and java + +These settings apply only when `--tag=package-2018-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.apimanagement.v2018_01_01 + output-folder: $(azure-libraries-for-java-folder)/apimanagement/resource-manager/v2018_01_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-03 and java + +These settings apply only when `--tag=package-2017-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.apimanagement.v2017_03_01 + output-folder: $(azure-libraries-for-java-folder)/apimanagement/resource-manager/v2017_03_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/apimanagement/resource-manager/readme.ruby.md b/specification/apimanagement/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..07f0e7de0d02 --- /dev/null +++ b/specification/apimanagement/resource-manager/readme.ruby.md @@ -0,0 +1,48 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_api_management +package-version: "0.17.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-01 + - tag: package-2016-10 + - tag: package-2016-07 +``` + +### Tag: package-2018-01 and ruby + +These settings apply only when `--tag=package-2018-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-01' && $(ruby) +namespace: "Azure::ApiManagement::Mgmt::V2018_01_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_api_management/lib +``` + +### Tag: package-2016-10 and ruby + +These settings apply only when `--tag=package-2016-10 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-10' && $(ruby) +namespace: "Azure::ApiManagement::Mgmt::V2016_10_10" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_api_management/lib +``` + +### Tag: package-2016-07 and ruby + +These settings apply only when `--tag=package-2016-07 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-07' && $(ruby) +namespace: "Azure::ApiManagement::Mgmt::V2016_07_07" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_api_management/lib +``` diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-by-id.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-by-id.json new file mode 100644 index 000000000000..7ba2c1b9cfff --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-by-id.json @@ -0,0 +1,70 @@ +{ + "title": "Get A Specific Events By Type & ID", + "description": "Gets a specific event by type and id.", + "parameters": { + "subscriptionId": "c512b59c-4005-40e2-b13d-ac29cfb46af4", + "resourceGroupName": "test-rg", + "applicationName": "azure-insights", + "apiVersion": "2018-04-20", + "eventType": "traces", + "eventId": "dc76df01-0141-11e8-9894-e3e7c1eeabad" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://api.applicationinsights.io/v1/apps/DEMO_APP/events/traces/$metadata#traces", + "value": [ + { + "id": "dc76df01-0141-11e8-9894-e3e7c1eeabad", + "type": "trace", + "count": 1, + "timestamp": "2018-01-24T20:04:32.243Z", + "customDimensions": null, + "customMeasurements": null, + "operation": { + "name": "GET /FabrikamProd/Employees/Create", + "id": "HPFy1bNlyQ0=", + "parentId": "|HPFy1bNlyQ0=.c642e1f1_", + "syntheticSource": "Application Insights Availability Monitoring" + }, + "session": { + "id": "97915c9e-2ba3-4258-82f5-84233de21127" + }, + "user": { + "id": "emea-ru-msa-edge_97915c9e-2ba3-4258-82f5-84233de21127", + "accountId": null, + "authenticatedId": null + }, + "cloud": { + "roleName": null, + "roleInstance": "AIConnect2" + }, + "ai": { + "iKey": "5a2e4e0c-e136-4a15-9824-90ba859b0a89", + "appName": "fabrikamprod", + "appId": "cf58dcfd-0683-487c-bc84-048789bca8e5", + "sdkVersion": "sd:2.4.1-442" + }, + "trace": { + "message": "New Request Received", + "severityLevel": 0 + }, + "application": { + "version": null + }, + "client": { + "model": null, + "os": null, + "type": "PC", + "browser": null, + "ip": "51.140.105.0", + "city": "London", + "stateOrProvince": "England", + "countryOrRegion": "United Kingdom" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-by-type.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-by-type.json new file mode 100644 index 000000000000..86739d4064d5 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-by-type.json @@ -0,0 +1,272 @@ +{ + "title": "Get Events By Type", + "description": "Gets events of a specific type", + "parameters": { + "subscriptionId": "c512b59c-4005-40e2-b13d-ac29cfb46af4", + "resourceGroupName": "test-rg", + "applicationName": "azure-insights", + "apiVersion": "2018-04-20", + "eventType": "traces", + "event-top": 5 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://api.applicationinsights.io/v1/apps/DEMO_APP/events/$metadata#traces", + "@ai.messages": [ + { + "code": "AddedLimitToQuery", + "message": "The query was limited to last 12 hours, since no other limit for timestamp field was specified" + } + ], + "value": [ + { + "id": "dc76df01-0141-11e8-9894-e3e7c1eeabad", + "type": "trace", + "count": 1, + "timestamp": "2018-01-24T20:04:32.243Z", + "customDimensions": null, + "customMeasurements": null, + "operation": { + "name": "GET /FabrikamProd/Employees/Create", + "id": "HPFy1bNlyQ0=", + "parentId": "|HPFy1bNlyQ0=.c642e1f1_", + "syntheticSource": "Application Insights Availability Monitoring" + }, + "session": { + "id": "97915c9e-2ba3-4258-82f5-84233de21127" + }, + "user": { + "id": "emea-ru-msa-edge_97915c9e-2ba3-4258-82f5-84233de21127", + "accountId": null, + "authenticatedId": null + }, + "cloud": { + "roleName": "", + "roleInstance": "AIConnect2" + }, + "ai": { + "iKey": "5a2e4e0c-e136-4a15-9824-90ba859b0a89", + "appName": "fabrikamprod", + "appId": "cf58dcfd-0683-487c-bc84-048789bca8e5", + "sdkVersion": "sd:2.4.1-442" + }, + "trace": { + "message": "New Request Received", + "severityLevel": 0 + }, + "application": { + "version": "" + }, + "client": { + "model": null, + "os": null, + "type": "PC", + "browser": null, + "ip": "51.140.105.0", + "city": "London", + "stateOrProvince": "England", + "countryOrRegion": "United Kingdom" + } + }, + { + "id": "ca54b09b-0141-11e8-8c76-4de3c2c29f12", + "type": "trace", + "count": 1, + "timestamp": "2018-01-24T20:04:22.799Z", + "customDimensions": null, + "customMeasurements": null, + "operation": { + "name": "GET /FabrikamProd/Employees/Create", + "id": "fYhtYFzAYv4=", + "parentId": "|fYhtYFzAYv4=.c642e1f0_", + "syntheticSource": "Application Insights Availability Monitoring" + }, + "session": { + "id": "e0aca036-2ef0-4c41-adb9-5875625901ee" + }, + "user": { + "id": "us-fl-mia-edge_e0aca036-2ef0-4c41-adb9-5875625901ee", + "accountId": null, + "authenticatedId": null + }, + "cloud": { + "roleName": "", + "roleInstance": "AIConnect2" + }, + "ai": { + "iKey": "5a2e4e0c-e136-4a15-9824-90ba859b0a89", + "appName": "fabrikamprod", + "appId": "cf58dcfd-0683-487c-bc84-048789bca8e5", + "sdkVersion": "sd:2.4.1-442" + }, + "trace": { + "message": "New Request Received", + "severityLevel": 0 + }, + "application": { + "version": "" + }, + "client": { + "model": null, + "os": null, + "type": "PC", + "browser": null, + "ip": "52.173.244.0", + "city": "Des Moines", + "stateOrProvince": "Iowa", + "countryOrRegion": "United States" + } + }, + { + "id": "caf07b61-0141-11e8-bb21-bb0d564a046f", + "type": "trace", + "count": 1, + "timestamp": "2018-01-24T20:04:02.106Z", + "customDimensions": null, + "customMeasurements": null, + "operation": { + "name": "GET /", + "id": "EfIqgW6eLWQ=", + "parentId": "|EfIqgW6eLWQ=.1eb73a79_", + "syntheticSource": "Application Insights Availability Monitoring" + }, + "session": { + "id": "323ab959-4c64-4de4-95e9-04334fbd7749" + }, + "user": { + "id": "apac-hk-hkn-azr_323ab959-4c64-4de4-95e9-04334fbd7749", + "accountId": null, + "authenticatedId": null + }, + "cloud": { + "roleName": "fabrikamfiberapp", + "roleInstance": "RD00155D467E8D" + }, + "ai": { + "iKey": "5a2e4e0c-e136-4a15-9824-90ba859b0a89", + "appName": "fabrikamprod", + "appId": "cf58dcfd-0683-487c-bc84-048789bca8e5", + "sdkVersion": "sd:2.4.1-442" + }, + "trace": { + "message": "New Request Received", + "severityLevel": 0 + }, + "application": { + "version": "AutoGen_49c3aea0-4641-4675-93b5-55f7a62d22d3" + }, + "client": { + "model": null, + "os": null, + "type": "PC", + "browser": null, + "ip": "52.175.39.0", + "city": "Hong Kong", + "stateOrProvince": "Central and Western District", + "countryOrRegion": "Hong Kong" + } + }, + { + "id": "b8599222-0141-11e8-99cf-07437267f251", + "type": "trace", + "count": 1, + "timestamp": "2018-01-24T20:03:55.554Z", + "customDimensions": null, + "customMeasurements": null, + "operation": { + "name": "GET /", + "id": "7j5dSPYFB5A=", + "parentId": "|7j5dSPYFB5A=.1eb73a78_", + "syntheticSource": "Application Insights Availability Monitoring" + }, + "session": { + "id": "b82a2630-5598-4291-a3db-976117f07490" + }, + "user": { + "id": "us-il-ch1-azr_b82a2630-5598-4291-a3db-976117f07490", + "accountId": null, + "authenticatedId": null + }, + "cloud": { + "roleName": "fabrikamfiberapp", + "roleInstance": "RD00155D467E8D" + }, + "ai": { + "iKey": "5a2e4e0c-e136-4a15-9824-90ba859b0a89", + "appName": "fabrikamprod", + "appId": "cf58dcfd-0683-487c-bc84-048789bca8e5", + "sdkVersion": "sd:2.4.1-442" + }, + "trace": { + "message": "New Request Received", + "severityLevel": 0 + }, + "application": { + "version": "AutoGen_49c3aea0-4641-4675-93b5-55f7a62d22d3" + }, + "client": { + "model": null, + "os": null, + "type": "PC", + "browser": null, + "ip": "52.237.156.0", + "city": "Chicago", + "stateOrProvince": "Illinois", + "countryOrRegion": "United States" + } + }, + { + "id": "b8599221-0141-11e8-99cf-07437267f251", + "type": "trace", + "count": 1, + "timestamp": "2018-01-24T20:03:37.437Z", + "customDimensions": null, + "customMeasurements": null, + "operation": { + "name": "GET /", + "id": "xoAJ+fhhQQE=", + "parentId": "|xoAJ+fhhQQE=.1eb73a77_", + "syntheticSource": "Application Insights Availability Monitoring" + }, + "session": { + "id": "b2066202-e8cd-47de-8c4c-d4d55f3653a4" + }, + "user": { + "id": "emea-ru-msa-edge_b2066202-e8cd-47de-8c4c-d4d55f3653a4", + "accountId": null, + "authenticatedId": null + }, + "cloud": { + "roleName": "fabrikamfiberapp", + "roleInstance": "RD00155D467E8D" + }, + "ai": { + "iKey": "5a2e4e0c-e136-4a15-9824-90ba859b0a89", + "appName": "fabrikamprod", + "appId": "cf58dcfd-0683-487c-bc84-048789bca8e5", + "sdkVersion": "sd:2.4.1-442" + }, + "trace": { + "message": "New Request Received", + "severityLevel": 0 + }, + "application": { + "version": "AutoGen_49c3aea0-4641-4675-93b5-55f7a62d22d3" + }, + "client": { + "model": null, + "os": null, + "type": "PC", + "browser": null, + "ip": "51.140.79.0", + "city": "London", + "stateOrProvince": "England", + "countryOrRegion": "United Kingdom" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-metadata.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-metadata.json new file mode 100644 index 000000000000..a8626e5a3887 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-metadata.json @@ -0,0 +1,18 @@ +{ + "title": "Get Events Metadata", + "description": "Gets event metadata", + "parameters": { + "subscriptionId": "c512b59c-4005-40e2-b13d-ac29cfb46af4", + "resourceGroupName": "test-rg", + "applicationName": "azure-insights", + "apiVersion": "2018-04-20" + }, + "responses": { + "200": { + "headers": { + "content-type": "application/xml;charset=utf-8" + }, + "body": " " + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get-full.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get-full.json new file mode 100644 index 000000000000..6660ee6ac295 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get-full.json @@ -0,0 +1,47 @@ +{ + "title": "Get intervaled request count", + "description": "Gets intervaled request count metric", + "parameters": { + "subscriptionId": "c512b59c-4005-40e2-b13d-ac29cfb46af4", + "resourceGroupName": "test-rg", + "applicationName": "azure-insights", + "apiVersion": "2018-04-20", + "metricId": "requests%2Fcount", + "timespan": "P2D", + "interval": "P1D" + }, + "responses": { + "200": { + "body": { + "value": { + "start": "2018-02-04T10:01:35.086Z", + "end": "2018-02-06T10:01:35.086Z", + "interval": "P1D", + "segments": [ + { + "start": "2018-02-04T10:01:35.086Z", + "end": "2018-02-05T00:00:00.000Z", + "requests/count": { + "sum": 4927 + } + }, + { + "start": "2018-02-05T00:00:00.000Z", + "end": "2018-02-06T00:00:00.000Z", + "requests/count": { + "sum": 8460 + } + }, + { + "start": "2018-02-06T00:00:00.000Z", + "end": "2018-02-06T10:01:35.086Z", + "requests/count": { + "sum": 3743 + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get.json new file mode 100644 index 000000000000..ebd9fb550908 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get.json @@ -0,0 +1,24 @@ +{ + "title": "Get Request Count", + "description": "Gets request count metric", + "parameters": { + "subscriptionId": "c512b59c-4005-40e2-b13d-ac29cfb46af4", + "resourceGroupName": "test-rg", + "applicationName": "azure-insights", + "apiVersion": "2018-04-20", + "metricId": "requests%2Fcount" + }, + "responses": { + "200": { + "body": { + "value": { + "start": "2016-01-01T02:00:00.000Z", + "end": "2016-01-03T02:00:00.000Z", + "requests/count": { + "sum": 23 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-post.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-post.json new file mode 100644 index 000000000000..8f9a9c6bcaae --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-post.json @@ -0,0 +1,102 @@ +{ + "title": "Post Metric", + "description": "Posts data for a metric.", + "parameters": { + "subscriptionId": "c512b59c-4005-40e2-b13d-ac29cfb46af4", + "resourceGroupName": "test-rg", + "applicationName": "azure-insights", + "apiVersion": "2018-04-20", + "body": [ + { + "id": "failed", + "parameters": { + "metricId": "requests/failed", + "timespan": "P2D", + "interval": "P1D" + } + }, + { + "id": "count", + "parameters": { + "metricId": "requests/count", + "timespan": "P2D", + "interval": "P1D" + } + } + ] + }, + "responses": { + "200": { + "body": [ + { + "id": "failed", + "status": 200, + "body": { + "value": { + "start": "2018-01-22T19:59:12.488Z", + "end": "2018-01-24T19:59:12.488Z", + "interval": "P1D", + "segments": [ + { + "start": "2018-01-22T19:59:12.488Z", + "end": "2018-01-23T00:00:00.000Z", + "requests/failed": { + "sum": 277 + } + }, + { + "start": "2018-01-23T00:00:00.000Z", + "end": "2018-01-24T00:00:00.000Z", + "requests/failed": { + "sum": 1599 + } + }, + { + "start": "2018-01-24T00:00:00.000Z", + "end": "2018-01-24T19:59:12.488Z", + "requests/failed": { + "sum": 1392 + } + } + ] + } + } + }, + { + "id": "count", + "status": 200, + "body": { + "value": { + "start": "2018-01-22T19:59:12.488Z", + "end": "2018-01-24T19:59:12.488Z", + "interval": "P1D", + "segments": [ + { + "start": "2018-01-22T19:59:12.488Z", + "end": "2018-01-23T00:00:00.000Z", + "requests/count": { + "sum": 1225 + } + }, + { + "start": "2018-01-23T00:00:00.000Z", + "end": "2018-01-24T00:00:00.000Z", + "requests/count": { + "sum": 7382 + } + }, + { + "start": "2018-01-24T00:00:00.000Z", + "end": "2018-01-24T19:59:12.488Z", + "requests/count": { + "sum": 6674 + } + } + ] + } + } + } + ] + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metrics-get-metadata.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metrics-get-metadata.json new file mode 100644 index 000000000000..1d9fbcc0dc0f --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metrics-get-metadata.json @@ -0,0 +1,2830 @@ +{ + "title": "Get Metric Metadata", + "description": "Gets metadata data for metrics.", + "parameters": { + "subscriptionId": "c512b59c-4005-40e2-b13d-ac29cfb46af4", + "resourceGroupName": "test-rg", + "applicationName": "azure-insights", + "apiVersion": "2018-04-20" + }, + "responses": { + "200": { + "body": { + "metrics": { + "requests/count": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Server requests", + "supportedGroupBy": { + "all": [ + "request/source", + "request/name", + "request/urlHost", + "request/urlPath", + "request/success", + "request/resultCode", + "request/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/_MS.ProcessedByMetricExtractors", + "customDimensions/DeveloperMode" + ] + }, + "defaultAggregation": "sum" + }, + "requests/duration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Server response time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "request/source", + "request/name", + "request/urlHost", + "request/urlPath", + "request/success", + "request/resultCode", + "request/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/_MS.ProcessedByMetricExtractors", + "customDimensions/DeveloperMode" + ] + }, + "defaultAggregation": "avg" + }, + "requests/failed": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Failed requests", + "supportedGroupBy": { + "all": [ + "request/source", + "request/name", + "request/urlHost", + "request/urlPath", + "request/success", + "request/resultCode", + "request/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/_MS.ProcessedByMetricExtractors", + "customDimensions/DeveloperMode" + ] + }, + "defaultAggregation": "sum" + }, + "pageViews/count": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Page views", + "supportedGroupBy": { + "all": [ + "pageView/name", + "pageView/urlPath", + "pageView/urlHost", + "pageView/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "sum" + }, + "pageViews/duration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Page view load time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "pageView/name", + "pageView/urlPath", + "pageView/urlHost", + "pageView/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "avg" + }, + "browserTimings/networkDuration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Page load network connect time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "avg" + }, + "browserTimings/sendDuration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Send request time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "avg" + }, + "browserTimings/receiveDuration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Receiving response time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "avg" + }, + "browserTimings/processingDuration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Client processing time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "avg" + }, + "browserTimings/totalDuration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Browser page load time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "avg" + }, + "users/count": { + "supportedAggregations": [ + "unique" + ], + "displayName": "Users", + "supportedGroupBy": { + "all": [ + "trace/severityLevel", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "type", + "customDimensions/AgentSession", + "customDimensions/AgentVersion", + "customDimensions/MachineName", + "customDimensions/RunningMode", + "customDimensions/Source", + "customDimensions/AgentAssemblyVersion", + "customDimensions/AgentProcessSession", + "customDimensions/HashedMachineName", + "customDimensions/DataCube", + "customDimensions/DeveloperMode", + "request/source", + "request/name", + "request/urlHost", + "request/urlPath", + "request/success", + "request/resultCode", + "request/performanceBucket", + "user/authenticated", + "customDimensions/_MS.ProcessedByMetricExtractors", + "pageView/name", + "pageView/urlPath", + "pageView/urlHost", + "pageView/performanceBucket", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance", + "dependency/target", + "dependency/type", + "dependency/name", + "dependency/success", + "dependency/resultCode", + "dependency/performanceBucket", + "customDimensions/Container", + "customDimensions/Blob", + "customDimensions/ErrorMessage", + "customEvent/name", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName", + "availabilityResult/name", + "availabilityResult/location", + "availabilityResult/success", + "customDimensions/FullTestResultAvailable", + "exception/problemId", + "exception/handledAt", + "exception/type", + "exception/assembly", + "exception/method", + "exception/severityLevel", + "customDimensions/url", + "customDimensions/ai.snapshot.stampid", + "customDimensions/ai.snapshot.id", + "customDimensions/ai.snapshot.version", + "customDimensions/ai.snapshot.planid", + "customDimensions/_MS.Example", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type", + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket" + ] + }, + "defaultAggregation": "unique" + }, + "users/authenticated": { + "supportedAggregations": [ + "unique" + ], + "displayName": "Users, authenticated", + "supportedGroupBy": { + "all": [ + "trace/severityLevel", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "type", + "customDimensions/AgentSession", + "customDimensions/AgentVersion", + "customDimensions/MachineName", + "customDimensions/RunningMode", + "customDimensions/Source", + "customDimensions/AgentAssemblyVersion", + "customDimensions/AgentProcessSession", + "customDimensions/HashedMachineName", + "customDimensions/DataCube", + "customDimensions/DeveloperMode", + "request/source", + "request/name", + "request/urlHost", + "request/urlPath", + "request/success", + "request/resultCode", + "request/performanceBucket", + "user/authenticated", + "customDimensions/_MS.ProcessedByMetricExtractors", + "pageView/name", + "pageView/urlPath", + "pageView/urlHost", + "pageView/performanceBucket", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance", + "dependency/target", + "dependency/type", + "dependency/name", + "dependency/success", + "dependency/resultCode", + "dependency/performanceBucket", + "customDimensions/Container", + "customDimensions/Blob", + "customDimensions/ErrorMessage", + "customEvent/name", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName", + "availabilityResult/name", + "availabilityResult/location", + "availabilityResult/success", + "customDimensions/FullTestResultAvailable", + "exception/problemId", + "exception/handledAt", + "exception/type", + "exception/assembly", + "exception/method", + "exception/severityLevel", + "customDimensions/url", + "customDimensions/ai.snapshot.stampid", + "customDimensions/ai.snapshot.id", + "customDimensions/ai.snapshot.version", + "customDimensions/ai.snapshot.planid", + "customDimensions/_MS.Example", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type", + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket" + ] + }, + "defaultAggregation": "unique" + }, + "sessions/count": { + "supportedAggregations": [ + "unique" + ], + "displayName": "Sessions", + "supportedGroupBy": { + "all": [ + "trace/severityLevel", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "type", + "customDimensions/AgentSession", + "customDimensions/AgentVersion", + "customDimensions/MachineName", + "customDimensions/RunningMode", + "customDimensions/Source", + "customDimensions/AgentAssemblyVersion", + "customDimensions/AgentProcessSession", + "customDimensions/HashedMachineName", + "customDimensions/DataCube", + "customDimensions/DeveloperMode", + "request/source", + "request/name", + "request/urlHost", + "request/urlPath", + "request/success", + "request/resultCode", + "request/performanceBucket", + "user/authenticated", + "customDimensions/_MS.ProcessedByMetricExtractors", + "pageView/name", + "pageView/urlPath", + "pageView/urlHost", + "pageView/performanceBucket", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance", + "dependency/target", + "dependency/type", + "dependency/name", + "dependency/success", + "dependency/resultCode", + "dependency/performanceBucket", + "customDimensions/Container", + "customDimensions/Blob", + "customDimensions/ErrorMessage", + "customEvent/name", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName", + "availabilityResult/name", + "availabilityResult/location", + "availabilityResult/success", + "customDimensions/FullTestResultAvailable", + "exception/problemId", + "exception/handledAt", + "exception/type", + "exception/assembly", + "exception/method", + "exception/severityLevel", + "customDimensions/url", + "customDimensions/ai.snapshot.stampid", + "customDimensions/ai.snapshot.id", + "customDimensions/ai.snapshot.version", + "customDimensions/ai.snapshot.planid", + "customDimensions/_MS.Example", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type", + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket" + ] + }, + "defaultAggregation": "unique" + }, + "customEvents/count": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Events", + "supportedGroupBy": { + "all": [ + "customEvent/name", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/DeveloperMode", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName" + ] + }, + "defaultAggregation": "sum" + }, + "dependencies/count": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Dependency calls", + "supportedGroupBy": { + "all": [ + "dependency/target", + "dependency/type", + "dependency/name", + "dependency/success", + "dependency/resultCode", + "dependency/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/Container", + "customDimensions/_MS.ProcessedByMetricExtractors", + "customDimensions/Blob", + "customDimensions/ErrorMessage", + "customDimensions/DeveloperMode", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "sum" + }, + "dependencies/failed": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Dependency failures", + "supportedGroupBy": { + "all": [ + "dependency/target", + "dependency/type", + "dependency/name", + "dependency/success", + "dependency/resultCode", + "dependency/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/Container", + "customDimensions/_MS.ProcessedByMetricExtractors", + "customDimensions/Blob", + "customDimensions/ErrorMessage", + "customDimensions/DeveloperMode", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "sum" + }, + "dependencies/duration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Dependency duration", + "units": "ms", + "supportedGroupBy": { + "all": [ + "dependency/target", + "dependency/type", + "dependency/name", + "dependency/success", + "dependency/resultCode", + "dependency/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/Container", + "customDimensions/_MS.ProcessedByMetricExtractors", + "customDimensions/Blob", + "customDimensions/ErrorMessage", + "customDimensions/DeveloperMode", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "avg" + }, + "exceptions/count": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Exceptions", + "supportedGroupBy": { + "all": [ + "exception/problemId", + "exception/handledAt", + "exception/type", + "exception/assembly", + "exception/method", + "exception/severityLevel", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/url", + "customDimensions/ai.snapshot.stampid", + "customDimensions/ai.snapshot.id", + "customDimensions/ai.snapshot.version", + "customDimensions/DeveloperMode", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance", + "customDimensions/ai.snapshot.planid", + "customDimensions/_MS.Example", + "customDimensions/_MS.ProcessedByMetricExtractors" + ] + }, + "defaultAggregation": "sum" + }, + "exceptions/browser": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Browser exceptions", + "supportedGroupBy": { + "all": [ + "exception/problemId", + "exception/handledAt", + "exception/type", + "exception/assembly", + "exception/method", + "exception/severityLevel", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/url", + "customDimensions/ai.snapshot.stampid", + "customDimensions/ai.snapshot.id", + "customDimensions/ai.snapshot.version", + "customDimensions/DeveloperMode", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance", + "customDimensions/ai.snapshot.planid", + "customDimensions/_MS.Example", + "customDimensions/_MS.ProcessedByMetricExtractors" + ] + }, + "defaultAggregation": "sum" + }, + "exceptions/server": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Server exceptions", + "supportedGroupBy": { + "all": [ + "exception/problemId", + "exception/handledAt", + "exception/type", + "exception/assembly", + "exception/method", + "exception/severityLevel", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/url", + "customDimensions/ai.snapshot.stampid", + "customDimensions/ai.snapshot.id", + "customDimensions/ai.snapshot.version", + "customDimensions/DeveloperMode", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance", + "customDimensions/ai.snapshot.planid", + "customDimensions/_MS.Example", + "customDimensions/_MS.ProcessedByMetricExtractors" + ] + }, + "defaultAggregation": "sum" + }, + "availabilityResults/count": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Availability test results count", + "supportedGroupBy": { + "all": [ + "availabilityResult/name", + "availabilityResult/location", + "availabilityResult/success", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/FullTestResultAvailable" + ] + }, + "defaultAggregation": "sum" + }, + "availabilityResults/duration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Test duration", + "units": "ms", + "supportedGroupBy": { + "all": [ + "availabilityResult/name", + "availabilityResult/location", + "availabilityResult/success", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/FullTestResultAvailable" + ] + }, + "defaultAggregation": "avg" + }, + "availabilityResults/availabilityPercentage": { + "supportedAggregations": [ + "avg", + "count" + ], + "displayName": "Availability", + "units": "percent", + "supportedGroupBy": { + "all": [ + "availabilityResult/name", + "availabilityResult/location", + "availabilityResult/success", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/FullTestResultAvailable" + ] + }, + "defaultAggregation": "avg" + }, + "billingMeters/telemetryCount": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Data point count", + "supportedGroupBy": { + "all": [ + "billing/telemetryItemSource", + "billing/telemetryItemType" + ] + }, + "defaultAggregation": "sum" + }, + "billingMeters/telemetrySize": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Data point volume", + "units": "bytes", + "supportedGroupBy": { + "all": [ + "billing/telemetryItemSource", + "billing/telemetryItemType" + ] + }, + "defaultAggregation": "sum" + }, + "performanceCounters/requestExecutionTime": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "ASP.NET request execution time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/requestsPerSecond": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "ASP.NET request rate", + "units": "perSec", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/requestsInQueue": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "ASP.NET requests in application queue", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/memoryAvailableBytes": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "Available memory", + "units": "bytes", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/exceptionsPerSecond": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "Exception rate", + "units": "perSec", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/processCpuPercentage": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "Process CPU", + "units": "percent", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/processCpuPercentageTotal": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "Process CPU (all cores)", + "units": "percent", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/processIOBytesPerSecond": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "Process IO rate", + "units": "bytesPerSec", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/processPrivateBytes": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "Process private bytes", + "units": "bytes", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/processorCpuPercentage": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "Processor time", + "units": "percent", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "traces/count": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Traces", + "supportedGroupBy": { + "all": [ + "trace/severityLevel", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/AgentSession", + "customDimensions/AgentVersion", + "customDimensions/MachineName", + "customDimensions/RunningMode", + "customDimensions/Source", + "customDimensions/AgentAssemblyVersion", + "customDimensions/AgentProcessSession", + "customDimensions/HashedMachineName", + "customDimensions/DataCube", + "customDimensions/DeveloperMode" + ] + }, + "defaultAggregation": "sum" + }, + "customMetrics/Dependency duration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "Dependency duration", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/Exceptions thrown": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "Exceptions thrown", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/Server response time": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "Server response time", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/AzureDependencyFailureRate5Min": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "AzureDependencyFailureRate5Min", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/AzureBlobSuccessRate": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "AzureBlobSuccessRate", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/Customer Lead Time": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "Customer Lead Time", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/ChrisRequestDuration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "ChrisRequestDuration", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/AvgResponseTime": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "AvgResponseTime", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/CriticalOperationFailureRate": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "CriticalOperationFailureRate", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/CritFailureRate2": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "CritFailureRate2", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/Blah": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "Blah", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/SyntheticExceptions": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "SyntheticExceptions", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/test01": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "test01", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/PredictedPerformanceOnNextHour": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "PredictedPerformanceOnNextHour", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/HeartbeatState": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "HeartbeatState", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customEvents/custom/ProcessPagedMemoryInMB": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "ProcessPagedMemoryInMB", + "supportedGroupBy": { + "all": [ + "customEvent/name", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/DeveloperMode", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName" + ] + }, + "defaultAggregation": "avg" + }, + "customEvents/custom/ProcessWorkingSetInMB": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "ProcessWorkingSetInMB", + "supportedGroupBy": { + "all": [ + "customEvent/name", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/DeveloperMode", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName" + ] + }, + "defaultAggregation": "avg" + }, + "customEvents/custom/DurationInSeconds": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "DurationInSeconds", + "supportedGroupBy": { + "all": [ + "customEvent/name", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/DeveloperMode", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName" + ] + }, + "defaultAggregation": "avg" + }, + "customEvents/custom/sizeInMB": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "sizeInMB", + "supportedGroupBy": { + "all": [ + "customEvent/name", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/DeveloperMode", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName" + ] + }, + "defaultAggregation": "avg" + }, + "customEvents/custom/Completion Time": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "Completion Time", + "supportedGroupBy": { + "all": [ + "customEvent/name", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/DeveloperMode", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/\\Process(??APP_WIN32_PROC??)\\% Processor Time Normalized": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "\\Process(??APP_WIN32_PROC??)\\% Processor Time Normalized", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/% Processor Time Normalized": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "% Processor Time Normalized", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + } + }, + "dimensions": { + "request/source": { + "displayName": "Request source" + }, + "request/name": { + "displayName": "Request name" + }, + "request/urlHost": { + "displayName": "Request URL host" + }, + "request/urlPath": { + "displayName": "Request URL path" + }, + "request/success": { + "displayName": "Successful request" + }, + "request/resultCode": { + "displayName": "Response code" + }, + "request/performanceBucket": { + "displayName": "Performance" + }, + "operation/name": { + "displayName": "Operation name" + }, + "operation/synthetic": { + "displayName": "Real or synthetic traffic" + }, + "operation/syntheticSource": { + "displayName": "Source of synthetic traffic" + }, + "user/authenticated": { + "displayName": "Authenticated user" + }, + "application/version": { + "displayName": "Application version" + }, + "client/type": { + "displayName": "Device type" + }, + "client/model": { + "displayName": "Device model" + }, + "client/os": { + "displayName": "Operating system" + }, + "client/city": { + "displayName": "City" + }, + "client/stateOrProvince": { + "displayName": "State or province" + }, + "client/countryOrRegion": { + "displayName": "Country or region" + }, + "client/browser": { + "displayName": "Browser version" + }, + "cloud/roleName": { + "displayName": "Cloud role name" + }, + "cloud/roleInstance": { + "displayName": "Cloud role instance" + }, + "customDimensions/_MS.ProcessedByMetricExtractors": { + "displayName": "_MS.ProcessedByMetricExtractors" + }, + "customDimensions/DeveloperMode": { + "displayName": "DeveloperMode" + }, + "pageView/name": { + "displayName": "View page name" + }, + "pageView/urlPath": { + "displayName": "Page view URL path" + }, + "pageView/urlHost": { + "displayName": "Page view URL host" + }, + "pageView/performanceBucket": { + "displayName": "Performance" + }, + "customDimensions/IbizaSessionId": { + "displayName": "IbizaSessionId" + }, + "customDimensions/PartInstance": { + "displayName": "PartInstance" + }, + "browserTiming/name": { + "displayName": "Name" + }, + "browserTiming/urlHost": { + "displayName": "Url host" + }, + "browserTiming/urlPath": { + "displayName": "Url path" + }, + "browserTiming/performanceBucket": { + "displayName": "Performance Bucket" + }, + "trace/severityLevel": { + "displayName": "Severity level" + }, + "type": { + "displayName": "Telemetry type" + }, + "customDimensions/AgentSession": { + "displayName": "AgentSession" + }, + "customDimensions/AgentVersion": { + "displayName": "AgentVersion" + }, + "customDimensions/MachineName": { + "displayName": "MachineName" + }, + "customDimensions/RunningMode": { + "displayName": "RunningMode" + }, + "customDimensions/Source": { + "displayName": "Source" + }, + "customDimensions/AgentAssemblyVersion": { + "displayName": "AgentAssemblyVersion" + }, + "customDimensions/AgentProcessSession": { + "displayName": "AgentProcessSession" + }, + "customDimensions/HashedMachineName": { + "displayName": "HashedMachineName" + }, + "customDimensions/DataCube": { + "displayName": "DataCube" + }, + "dependency/target": { + "displayName": "Base name" + }, + "dependency/type": { + "displayName": "Dependency type" + }, + "dependency/name": { + "displayName": "Remote dependency name" + }, + "dependency/success": { + "displayName": "Dependency call status" + }, + "dependency/resultCode": { + "displayName": "Result code" + }, + "dependency/performanceBucket": { + "displayName": "Performance" + }, + "customDimensions/Container": { + "displayName": "Container" + }, + "customDimensions/Blob": { + "displayName": "Blob" + }, + "customDimensions/ErrorMessage": { + "displayName": "ErrorMessage" + }, + "customEvent/name": { + "displayName": "Event name" + }, + "customDimensions/EventName": { + "displayName": "EventName" + }, + "customDimensions/Page Title": { + "displayName": "Page Title" + }, + "customDimensions/ServiceProfilerContent": { + "displayName": "ServiceProfilerContent" + }, + "customDimensions/ExecutingAssemblyFileVersion": { + "displayName": "ExecutingAssemblyFileVersion" + }, + "customDimensions/ServiceProfilerVersion": { + "displayName": "ServiceProfilerVersion" + }, + "customDimensions/ProcessId": { + "displayName": "ProcessId" + }, + "customDimensions/RequestId": { + "displayName": "RequestId" + }, + "customDimensions/RunningSession": { + "displayName": "RunningSession" + }, + "customDimensions/ProblemId": { + "displayName": "ProblemId" + }, + "customDimensions/SnapshotContext": { + "displayName": "SnapshotContext" + }, + "customDimensions/SnapshotVersion": { + "displayName": "SnapshotVersion" + }, + "customDimensions/Duration": { + "displayName": "Duration" + }, + "customDimensions/SnapshotId": { + "displayName": "SnapshotId" + }, + "customDimensions/StampId": { + "displayName": "StampId" + }, + "customDimensions/DeOptimizationId": { + "displayName": "DeOptimizationId" + }, + "customDimensions/Method": { + "displayName": "Method" + }, + "customDimensions/parentProcessId": { + "displayName": "parentProcessId" + }, + "customDimensions/Section": { + "displayName": "Section" + }, + "customDimensions/Configuration": { + "displayName": "Configuration" + }, + "customDimensions/dumpFolder": { + "displayName": "dumpFolder" + }, + "customDimensions/Reason": { + "displayName": "Reason" + }, + "customDimensions/ExtensionVersion": { + "displayName": "ExtensionVersion" + }, + "customDimensions/SiteName": { + "displayName": "SiteName" + }, + "availabilityResult/name": { + "displayName": "Test name" + }, + "availabilityResult/location": { + "displayName": "Run location" + }, + "availabilityResult/success": { + "displayName": "Test result" + }, + "customDimensions/FullTestResultAvailable": { + "displayName": "FullTestResultAvailable" + }, + "exception/problemId": { + "displayName": "Problem Id" + }, + "exception/handledAt": { + "displayName": "Handled at" + }, + "exception/type": { + "displayName": "Exception type" + }, + "exception/assembly": { + "displayName": "Assembly" + }, + "exception/method": { + "displayName": "Failed method" + }, + "exception/severityLevel": { + "displayName": "Severity level" + }, + "customDimensions/url": { + "displayName": "url" + }, + "customDimensions/ai.snapshot.stampid": { + "displayName": "ai.snapshot.stampid" + }, + "customDimensions/ai.snapshot.id": { + "displayName": "ai.snapshot.id" + }, + "customDimensions/ai.snapshot.version": { + "displayName": "ai.snapshot.version" + }, + "customDimensions/ai.snapshot.planid": { + "displayName": "ai.snapshot.planid" + }, + "customDimensions/_MS.Example": { + "displayName": "_MS.Example" + }, + "customDimensions/SA_OriginAppId": { + "displayName": "SA_OriginAppId" + }, + "customDimensions/baseSdkTargetFramework": { + "displayName": "baseSdkTargetFramework" + }, + "customDimensions/runtimeFramework": { + "displayName": "runtimeFramework" + }, + "customDimensions/_MS.AggregationIntervalMs": { + "displayName": "_MS.AggregationIntervalMs" + }, + "customDimensions/problemId": { + "displayName": "problemId" + }, + "customDimensions/operationName": { + "displayName": "operationName" + }, + "customDimensions/Request.Success": { + "displayName": "Request.Success" + }, + "customDimensions/_MS.MetricId": { + "displayName": "_MS.MetricId" + }, + "customDimensions/Dependency.Success": { + "displayName": "Dependency.Success" + }, + "customDimensions/_MS.IsAutocollected": { + "displayName": "_MS.IsAutocollected" + }, + "customDimensions/Dependency.Type": { + "displayName": "Dependency.Type" + }, + "billing/telemetryItemSource": { + "displayName": "Telemetry item source" + }, + "billing/telemetryItemType": { + "displayName": "Telemetry item type" + }, + "performanceCounter/name": { + "displayName": "Name" + }, + "performanceCounter/category": { + "displayName": "Category name" + }, + "performanceCounter/counter": { + "displayName": "Counter" + }, + "performanceCounter/instance": { + "displayName": "Instance name" + }, + "customDimensions/CounterInstanceName": { + "displayName": "CounterInstanceName" + }, + "customDimensions/CustomPerfCounter": { + "displayName": "CustomPerfCounter" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/query-post.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/query-post.json new file mode 100644 index 000000000000..bee47d4abfa2 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/query-post.json @@ -0,0 +1,93 @@ +{ + "title": "Post Query", + "description": "A simple query that returns query results.", + "parameters": { + "subscriptionId": "c512b59c-4005-40e2-b13d-ac29cfb46af4", + "resourceGroupName": "test-rg", + "applicationName": "azure-insights", + "apiVersion": "2018-04-20", + "body": { + "timespan": "PT12H", + "query": "requests | summarize count() by bin(timestamp, 1h)" + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "58a37988-2c05-427a-891f-5e0e1266fcc5", + "x-ms-correlation-request-id": "58a37988-2c05-427a-891f-5e0e1266fcc5" + }, + "body": { + "tables": [ + { + "name": "PrimaryResult", + "columns": [ + { + "name": "timestamp", + "type": "datetime" + }, + { + "name": "count_", + "type": "long" + } + ], + "rows": [ + [ + "2018-02-02T05:00:00Z", + "255" + ], + [ + "2018-02-01T17:00:00Z", + "148" + ], + [ + "2018-02-01T18:00:00Z", + "453" + ], + [ + "2018-02-01T19:00:00Z", + "404" + ], + [ + "2018-02-01T20:00:00Z", + "403" + ], + [ + "2018-02-01T21:00:00Z", + "405" + ], + [ + "2018-02-01T22:00:00Z", + "438" + ], + [ + "2018-02-01T23:00:00Z", + "403" + ], + [ + "2018-02-02T00:00:00Z", + "423" + ], + [ + "2018-02-02T01:00:00Z", + "403" + ], + [ + "2018-02-02T02:00:00Z", + "425" + ], + [ + "2018-02-02T03:00:00Z", + "437" + ], + [ + "2018-02-02T04:00:00Z", + "420" + ] + ] + } + ] + } + } + } +} \ No newline at end of file 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 new file mode 100644 index 000000000000..724e5e9f8dec --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/swagger.json @@ -0,0 +1,2060 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-04-20", + "title": "Application Insights Data Plane", + "description": "This API exposes AI metric & event information and associated metadata", + "termsOfService": "https://dev.applicationinsights.io/tos", + "contact": { + "name": "AIAPI Team", + "url": "https://dev.applicationinsights.io/support", + "email": "aiapi@microsoft.com" + }, + "license": { + "name": "Microsoft", + "url": "https://dev.applicationinsights.io/license" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/query": { + "post": { + "operationId": "Query_Execute", + "summary": "Execute an Analytics query", + "description": "Executes an Analytics query for data. [Here](https://dev.applicationinsights.io/documentation/Using-the-API/Query) is an example for using POST with an Analytics query.", + "x-ms-examples": { + "queryPost": { + "$ref": "examples/query-post.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/queryBody" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/queryResults" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/metrics/{metricId}": { + "get": { + "operationId": "Metrics_Get", + "summary": "Retrieve metric data", + "description": "Gets metric values for a single metric", + "x-ms-examples": { + "simpleMetric": { + "$ref": "examples/metric-get.json" + }, + "intervaledMetric": { + "$ref": "examples/metric-get-full.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/metricId" + }, + { + "$ref": "#/parameters/metricsTimespan" + }, + { + "$ref": "#/parameters/metricsInterval" + }, + { + "$ref": "#/parameters/metricsAggregation" + }, + { + "$ref": "#/parameters/metricsSegment" + }, + { + "$ref": "#/parameters/metricsTop" + }, + { + "$ref": "#/parameters/metricsOrderBy" + }, + { + "$ref": "#/parameters/metricsFilter" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/metricsResult" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/metrics/metadata": { + "get": { + "operationId": "Metrics_GetMetadata", + "summary": "Retrieve metric metatadata", + "description": "Gets metadata describing the available metrics", + "x-ms-examples": { + "metricMetadata": { + "$ref": "examples/metrics-get-metadata.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successful responses", + "schema": { + "type": "object" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/events/{eventType}": { + "get": { + "operationId": "Events_GetByType", + "summary": "Execute OData query", + "description": "Executes an OData query for events", + "x-ms-examples": { + "eventByType": { + "$ref": "examples/events-get-by-type.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/eventType" + }, + { + "$ref": "#/parameters/eventsTimespan" + }, + { + "$ref": "#/parameters/eventsFilter" + }, + { + "$ref": "#/parameters/eventsSearch" + }, + { + "$ref": "#/parameters/eventsOrderBy" + }, + { + "$ref": "#/parameters/eventsSelect" + }, + { + "$ref": "#/parameters/eventsSkip" + }, + { + "$ref": "#/parameters/eventsTop" + }, + { + "$ref": "#/parameters/eventsFormat" + }, + { + "$ref": "#/parameters/eventsCount" + }, + { + "$ref": "#/parameters/eventsApply" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/eventsResults" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/events/{eventType}/{eventId}": { + "get": { + "operationId": "Events_Get", + "summary": "Get an event", + "description": "Gets the data for a single event", + "x-ms-examples": { + "eventById": { + "$ref": "examples/events-get-by-id.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/eventType" + }, + { + "$ref": "#/parameters/eventsTimespan" + }, + { + "$ref": "#/parameters/eventId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/eventsResults" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/events/$metadata": { + "get": { + "operationId": "Events_GetOdataMetadata", + "summary": "Get OData metadata", + "description": "Gets OData EDMX metadata describing the event data model", + "x-ms-examples": { + "eventMetadata": { + "$ref": "examples/events-get-metadata.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "produces": [ + "application/xml;charset=utf-8" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "object" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + } + }, + "parameters": { + "appId": { + "name": "appId", + "description": "ID of the application. This is Application ID from the API Access settings blade in the Azure portal.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "metricId": { + "name": "metricId", + "in": "path", + "required": true, + "x-ms-parameter-location": "method", + "description": "ID of the metric. This is either a standard AI metric, or an application-specific custom metric.", + "type": "string", + "enum": [ + "requests/count", + "requests/duration", + "requests/failed", + "users/count", + "users/authenticated", + "pageViews/count", + "pageViews/duration", + "client/processingDuration", + "client/receiveDuration", + "client/networkDuration", + "client/sendDuration", + "client/totalDuration", + "dependencies/count", + "dependencies/failed", + "dependencies/duration", + "exceptions/count", + "exceptions/browser", + "exceptions/server", + "sessions/count", + "performanceCounters/requestExecutionTime", + "performanceCounters/requestsPerSecond", + "performanceCounters/requestsInQueue", + "performanceCounters/memoryAvailableBytes", + "performanceCounters/exceptionsPerSecond", + "performanceCounters/processCpuPercentage", + "performanceCounters/processIOBytesPerSecond", + "performanceCounters/processPrivateBytes", + "performanceCounters/processorCpuPercentage", + "availabilityResults/availabilityPercentage", + "availabilityResults/duration", + "billing/telemetryCount", + "customEvents/count" + ], + "x-ms-enum": { + "name": "MetricId", + "modelAsString": true + } + }, + "metricsTimespan": { + "name": "timespan", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "description": "The timespan over which to retrieve metric values. This is an ISO8601 time period value. If timespan is omitted, a default time range of `PT12H` (\"last 12 hours\") is used. The actual timespan that is queried may be adjusted by the server based. In all cases, the actual time span used for the query is included in the response.", + "type": "string" + }, + "metricsAggregation": { + "name": "aggregation", + "in": "query", + "collectionFormat": "csv", + "x-ms-parameter-location": "method", + "description": "The aggregation to use when computing the metric values. To retrieve more than one aggregation at a time, separate them with a comma. If no aggregation is specified, then the default aggregation for the metric is used.", + "type": "array", + "minItems": 1, + "items": { + "type": "string", + "enum": [ + "min", + "max", + "avg", + "sum", + "count", + "unique" + ], + "x-ms-enum": { + "name": "MetricsAggregation", + "modelAsString": false + } + } + }, + "metricsInterval": { + "name": "interval", + "in": "query", + "x-ms-parameter-location": "method", + "description": "The time interval to use when retrieving metric values. This is an ISO8601 duration. If interval is omitted, the metric value is aggregated across the entire timespan. If interval is supplied, the server may adjust the interval to a more appropriate size based on the timespan used for the query. In all cases, the actual interval used for the query is included in the response.", + "type": "string", + "format": "duration" + }, + "metricsSegment": { + "name": "segment", + "in": "query", + "collectionFormat": "csv", + "x-ms-parameter-location": "method", + "description": "The name of the dimension to segment the metric values by. This dimension must be applicable to the metric you are retrieving. To segment by more than one dimension at a time, separate them with a comma (,). In this case, the metric data will be segmented in the order the dimensions are listed in the parameter.", + "type": "array", + "minItems": 1, + "items": { + "type": "string", + "enum": [ + "applicationBuild", + "applicationVersion", + "authenticatedOrAnonymousTraffic", + "browser", + "browserVersion", + "city", + "cloudRoleName", + "cloudServiceName", + "continent", + "countryOrRegion", + "deploymentId", + "deploymentUnit", + "deviceType", + "environment", + "hostingLocation", + "instanceName" + ], + "x-ms-enum": { + "name": "MetricsSegment", + "modelAsString": true + } + } + }, + "metricsTop": { + "name": "top", + "in": "query", + "x-ms-parameter-location": "method", + "description": "The number of segments to return. This value is only valid when segment is specified.", + "type": "integer", + "format": "int32" + }, + "metricsOrderBy": { + "name": "orderby", + "in": "query", + "x-ms-parameter-location": "method", + "description": "The aggregation function and direction to sort the segments by. This value is only valid when segment is specified.", + "type": "string" + }, + "metricsFilter": { + "name": "filter", + "in": "query", + "x-ms-parameter-location": "method", + "description": "An expression used to filter the results. This value should be a valid OData filter expression where the keys of each clause should be applicable dimensions for the metric you are retrieving.", + "type": "string" + }, + "metricsPostBody": { + "name": "body", + "description": "The batched metrics query.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/metricsPostBody" + }, + "x-ms-parameter-location": "method" + }, + "eventType": { + "name": "eventType", + "in": "path", + "required": true, + "x-ms-parameter-location": "method", + "description": "The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types.", + "type": "string", + "enum": [ + "$all", + "traces", + "customEvents", + "pageViews", + "browserTimings", + "requests", + "dependencies", + "exceptions", + "availabilityResults", + "performanceCounters", + "customMetrics" + ], + "x-ms-enum": { + "name": "EventType", + "modelAsString": true + } + }, + "eventId": { + "name": "eventId", + "in": "path", + "required": true, + "x-ms-parameter-location": "method", + "description": "ID of event.", + "type": "string" + }, + "eventsTimespan": { + "name": "timespan", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "description": "Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression.", + "type": "string" + }, + "eventsFilter": { + "name": "$filter", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "description": "An expression used to filter the returned events", + "type": "string" + }, + "eventsSearch": { + "name": "$search", + "in": "query", + "x-ms-parameter-location": "method", + "description": "A free-text search expression to match for whether a particular event should be returned", + "type": "string" + }, + "eventsOrderBy": { + "name": "$orderby", + "in": "query", + "x-ms-parameter-location": "method", + "description": "A comma-separated list of properties with \\\"asc\\\" (the default) or \\\"desc\\\" to control the order of returned events", + "type": "string" + }, + "eventsSelect": { + "name": "$select", + "in": "query", + "x-ms-parameter-location": "method", + "description": "Limits the properties to just those requested on each returned event", + "type": "string" + }, + "eventsSkip": { + "name": "$skip", + "in": "query", + "x-ms-parameter-location": "method", + "description": "The number of items to skip over before returning events", + "type": "integer", + "format": "int32" + }, + "eventsTop": { + "name": "$top", + "in": "query", + "x-ms-parameter-location": "method", + "description": "The number of events to return", + "type": "integer", + "format": "int32" + }, + "eventsFormat": { + "name": "$format", + "in": "query", + "x-ms-parameter-location": "method", + "description": "Format for the returned events", + "type": "string" + }, + "eventsCount": { + "name": "$count", + "in": "query", + "x-ms-parameter-location": "method", + "description": "Request a count of matching items included with the returned events", + "type": "boolean" + }, + "eventsApply": { + "name": "$apply", + "in": "query", + "x-ms-parameter-location": "method", + "description": "An expression used for aggregation over returned events", + "type": "string" + }, + "applicationsParam": { + "description": "A list of applications over which to query.", + "name": "applications", + "in": "query", + "collectionFormat": "csv", + "required": false, + "default": "", + "x-ms-parameter-location": "method", + "type": "string" + }, + "queryTimespan": { + "name": "timespan", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "description": "Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.", + "type": "string" + }, + "queryParam": { + "name": "query", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "type": "string" + }, + "queryBody": { + "name": "body", + "in": "body", + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "required": true, + "schema": { + "$ref": "#/definitions/queryBody" + }, + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "apiVersion", + "description": "Client API version.", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "description": "The name of the resource group to get. The name is case insensitive.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "applicationName": { + "name": "applicationName", + "description": "Name of the Application Insights application.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "metricId": { + "description": "ID of the metric. This is either a standard AI metric, or an application-specific custom metric.", + "type": "string", + "enum": [ + "requests/count", + "requests/duration", + "requests/failed", + "users/count", + "users/authenticated", + "pageViews/count", + "pageViews/duration", + "client/processingDuration", + "client/receiveDuration", + "client/networkDuration", + "client/sendDuration", + "client/totalDuration", + "dependencies/count", + "dependencies/failed", + "dependencies/duration", + "exceptions/count", + "exceptions/browser", + "exceptions/server", + "sessions/count", + "performanceCounters/requestExecutionTime", + "performanceCounters/requestsPerSecond", + "performanceCounters/requestsInQueue", + "performanceCounters/memoryAvailableBytes", + "performanceCounters/exceptionsPerSecond", + "performanceCounters/processCpuPercentage", + "performanceCounters/processIOBytesPerSecond", + "performanceCounters/processPrivateBytes", + "performanceCounters/processorCpuPercentage", + "availabilityResults/availabilityPercentage", + "availabilityResults/duration", + "billing/telemetryCount", + "customEvents/count" + ], + "x-ms-enum": { + "name": "MetricId", + "modelAsString": true + } + }, + "metricsTimespan": { + "description": "The timespan over which to retrieve metric values. This is an ISO8601 time period value. If timespan is omitted, a default time range of `PT12H` (\"last 12 hours\") is used. The actual timespan that is queried may be adjusted by the server based. In all cases, the actual time span used for the query is included in the response.", + "type": "string" + }, + "metricsAggregation": { + "description": "The aggregation to use when computing the metric values. To retrieve more than one aggregation at a time, separate them with a comma. If no aggregation is specified, then the default aggregation for the metric is used.", + "type": "array", + "minItems": 1, + "items": { + "type": "string", + "enum": [ + "min", + "max", + "avg", + "sum", + "count", + "unique" + ], + "x-ms-enum": { + "name": "MetricsAggregation", + "modelAsString": false + } + } + }, + "metricsInterval": { + "description": "The time interval to use when retrieving metric values. This is an ISO8601 duration. If interval is omitted, the metric value is aggregated across the entire timespan. If interval is supplied, the server may adjust the interval to a more appropriate size based on the timespan used for the query. In all cases, the actual interval used for the query is included in the response.", + "type": "string", + "format": "duration" + }, + "metricsSegment": { + "description": "The name of the dimension to segment the metric values by. This dimension must be applicable to the metric you are retrieving. To segment by more than one dimension at a time, separate them with a comma (,). In this case, the metric data will be segmented in the order the dimensions are listed in the parameter.", + "type": "array", + "minItems": 1, + "items": { + "type": "string", + "enum": [ + "applicationBuild", + "applicationVersion", + "authenticatedOrAnonymousTraffic", + "browser", + "browserVersion", + "city", + "cloudRoleName", + "cloudServiceName", + "continent", + "countryOrRegion", + "deploymentId", + "deploymentUnit", + "deviceType", + "environment", + "hostingLocation", + "instanceName" + ], + "x-ms-enum": { + "name": "MetricsSegment", + "modelAsString": true + } + } + }, + "metricsTop": { + "description": "The number of segments to return. This value is only valid when segment is specified.", + "type": "integer", + "format": "int32" + }, + "metricsOrderBy": { + "description": "The aggregation function and direction to sort the segments by. This value is only valid when segment is specified.", + "type": "string" + }, + "metricsFilter": { + "description": "An expression used to filter the results. This value should be a valid OData filter expression where the keys of each clause should be applicable dimensions for the metric you are retrieving.", + "type": "string" + }, + "metricsPostBody": { + "description": "Metrics request body", + "type": "array", + "items": { + "$ref": "#/definitions/metricsPostBodySchema" + } + }, + "metricsPostBodySchema": { + "description": "A metric request", + "properties": { + "id": { + "type": "string", + "description": "An identifier for this query. Must be unique within the post body of the request. This identifier will be the 'id' property of the response object representing this query." + }, + "parameters": { + "type": "object", + "description": "The parameters for a single metrics query", + "properties": { + "metricId": { + "$ref": "#/definitions/metricId" + }, + "timespan": { + "$ref": "#/definitions/metricsTimespan" + }, + "aggregation": { + "$ref": "#/definitions/metricsAggregation" + }, + "interval": { + "$ref": "#/definitions/metricsInterval" + }, + "segment": { + "$ref": "#/definitions/metricsSegment" + }, + "top": { + "$ref": "#/definitions/metricsTop" + }, + "orderby": { + "$ref": "#/definitions/metricsOrderBy" + }, + "filter": { + "$ref": "#/definitions/metricsFilter" + } + }, + "required": [ + "metricId" + ] + } + }, + "required": [ + "id", + "parameters" + ] + }, + "metricsResults": { + "description": "A set of metric results.", + "type": "array", + "items": { + "properties": { + "id": { + "description": "The specified ID for this metric.", + "type": "string" + }, + "status": { + "description": "The HTTP status code of this metric query.", + "type": "integer", + "format": "int32" + }, + "body": { + "description": "The results of this metric query.", + "$ref": "#/definitions/metricsResult" + } + }, + "required": [ + "id", + "status", + "body" + ] + } + }, + "metricsResult": { + "description": "A metric result.", + "properties": { + "value": { + "$ref": "#/definitions/metricsResultInfo" + } + } + }, + "metricsResultInfo": { + "description": "A metric result data.", + "type": "object", + "properties": { + "start": { + "description": "Start time of the metric.", + "type": "string", + "format": "date_time" + }, + "end": { + "description": "Start time of the metric.", + "type": "string", + "format": "date_time" + }, + "interval": { + "description": "The interval used to segment the metric data.", + "type": "string", + "format": "duration" + }, + "segments": { + "description": "Segmented metric data (if segmented).", + "type": "array", + "items": { + "$ref": "#/definitions/metricsSegmentInfo" + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "metricsSegmentInfo": { + "description": "A metric segment", + "type": "object", + "properties": { + "start": { + "description": "Start time of the metric segment (only when an interval was specified).", + "type": "string", + "format": "date_time" + }, + "end": { + "description": "Start time of the metric segment (only when an interval was specified).", + "type": "string", + "format": "date_time" + }, + "segments": { + "description": "Segmented metric data (if further segmented).", + "type": "array", + "items": { + "$ref": "#/definitions/metricsSegmentInfo" + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "eventType": { + "description": "The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types.", + "type": "string", + "enum": [ + "$all", + "traces", + "customEvents", + "pageViews", + "browserTimings", + "requests", + "dependencies", + "exceptions", + "availabilityResults", + "performanceCounters", + "customMetrics" + ], + "x-ms-enum": { + "name": "EventType", + "modelAsString": true + } + }, + "eventId": { + "description": "ID of event.", + "type": "string" + }, + "eventsTimespan": { + "description": "Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression.", + "type": "string" + }, + "eventsFilter": { + "description": "An expression used to filter the returned events", + "type": "string" + }, + "eventsSearch": { + "description": "A free-text search expression to match for whether a particular event should be returned", + "type": "string" + }, + "eventsOrderBy": { + "description": "A comma-separated list of properties with \\\"asc\\\" (the default) or \\\"desc\\\" to control the order of returned events", + "type": "string" + }, + "eventsSelect": { + "description": "Limits the properties to just those requested on each returned event", + "type": "string" + }, + "eventsSkip": { + "description": "The number of items to skip over before returning events", + "type": "integer", + "format": "int32" + }, + "eventsTop": { + "description": "The number of events to return", + "type": "integer", + "format": "int32" + }, + "eventsFormat": { + "description": "Format for the returned events", + "type": "string" + }, + "eventsCount": { + "description": "Request a count of matching items included with the returned events", + "type": "boolean" + }, + "eventsApply": { + "description": "An expression used for aggregation over returned events", + "type": "string" + }, + "eventsResults": { + "description": "An events query result.", + "type": "object", + "properties": { + "@odata.context": { + "description": "OData context metadata endpoint for this response", + "type": "string" + }, + "@ai.messages": { + "description": "OData messages for this response.", + "type": "array", + "items": { + "$ref": "#/definitions/errorInfo" + } + }, + "value": { + "description": "Contents of the events query result.", + "type": "array", + "items": { + "$ref": "#/definitions/eventsResultData" + } + } + } + }, + "eventsResult": { + "description": "An event query result.", + "type": "object", + "properties": { + "@ai.messages": { + "description": "OData messages for this response.", + "type": "array", + "items": { + "$ref": "#/definitions/errorInfo" + } + }, + "value": { + "$ref": "#/definitions/eventsResultData" + } + } + }, + "eventsResultData": { + "description": "Events query result data.", + "type": "object", + "discriminator": "type", + "properties": { + "id": { + "description": "The unique ID for this event.", + "type": "string" + }, + "type": { + "description": "The type of event.", + "$ref": "#/definitions/eventType" + }, + "count": { + "description": "Count of the event", + "type": "integer", + "format": "int64" + }, + "timestamp": { + "description": "Timestamp of the event", + "type": "string", + "format": "date-time" + }, + "customDimensions": { + "description": "Custom dimensions of the event", + "type": "object", + "properties": { + "additionalProperties": { + "type": "object" + } + } + }, + "customMeasurements": { + "description": "Custom measurements of the event", + "type": "object", + "properties": { + "additionalProperties": { + "type": "object" + } + } + }, + "operation": { + "description": "Operation info of the event", + "$ref": "#/definitions/eventsOperationInfo" + }, + "session": { + "description": "Session info of the event", + "$ref": "#/definitions/eventsSessionInfo" + }, + "user": { + "description": "User info of the event", + "$ref": "#/definitions/eventsUserInfo" + }, + "cloud": { + "description": "Cloud info of the event", + "$ref": "#/definitions/eventsCloudInfo" + }, + "ai": { + "description": "AI info of the event", + "$ref": "#/definitions/eventsAiInfo" + }, + "application": { + "description": "Application info of the event", + "$ref": "#/definitions/eventsApplicationInfo" + }, + "client": { + "description": "Client info of the event", + "$ref": "#/definitions/eventsClientInfo" + } + } + }, + "eventsTraceResult": { + "x-ms-discriminator-value": "trace", + "description": "A trace result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "trace": { + "$ref": "#/definitions/eventsTraceInfo" + } + } + } + ] + }, + "eventsTraceInfo": { + "description": "The trace information", + "type": "object", + "properties": { + "message": { + "description": "The trace message", + "type": "string" + }, + "severityLevel": { + "description": "The trace severity level", + "type": "integer" + } + } + }, + "eventsCustomEventResult": { + "x-ms-discriminator-value": "customEvent", + "description": "A custom event result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "customEvent": { + "$ref": "#/definitions/eventsCustomEventInfo" + } + } + } + ] + }, + "eventsCustomEventInfo": { + "description": "The custom event information", + "type": "object", + "properties": { + "name": { + "description": "The name of the custom event", + "type": "string" + } + } + }, + "eventsPageViewResult": { + "x-ms-discriminator-value": "pageView", + "description": "A page view result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "pageView": { + "$ref": "#/definitions/eventsPageViewInfo" + } + } + } + ] + }, + "eventsPageViewInfo": { + "description": "The page view information", + "type": "object", + "properties": { + "name": { + "description": "The name of the page", + "type": "string" + }, + "url": { + "description": "The URL of the page", + "type": "string" + }, + "duration": { + "description": "The duration of the page view", + "type": "string" + }, + "performanceBucket": { + "description": "The performance bucket of the page view", + "type": "string" + } + } + }, + "eventsBrowserTimingResult": { + "x-ms-discriminator-value": "browserTiming", + "description": "A browser timing result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "browserTiming": { + "$ref": "#/definitions/eventsBrowserTimingInfo" + }, + "clientPerformance": { + "$ref": "#/definitions/eventsClientPerformanceInfo" + } + } + } + ] + }, + "eventsBrowserTimingInfo": { + "description": "The browser timing information", + "type": "object", + "properties": { + "urlPath": { + "description": "The path of the URL", + "type": "string" + }, + "urlHost": { + "description": "The host of the URL", + "type": "string" + }, + "name": { + "description": "The name of the page", + "type": "string" + }, + "url": { + "description": "The url of the page", + "type": "string" + }, + "totalDuration": { + "description": "The total duration of the load", + "type": "integer", + "format": "int64" + }, + "performanceBucket": { + "description": "The performance bucket of the load", + "type": "string" + }, + "networkDuration": { + "description": "The network duration of the load", + "type": "integer", + "format": "int64" + }, + "sendDuration": { + "description": "The send duration of the load", + "type": "integer", + "format": "int64" + }, + "receiveDuration": { + "description": "The receive duration of the load", + "type": "integer", + "format": "int64" + }, + "processingDuration": { + "description": "The processing duration of the load", + "type": "integer", + "format": "int64" + } + } + }, + "eventsClientPerformanceInfo": { + "description": "Client performance information", + "type": "object", + "properties": { + "name": { + "description": "The name of the client performance", + "type": "string" + } + } + }, + "eventsRequestResult": { + "x-ms-discriminator-value": "request", + "description": "A request result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/eventsRequestInfo" + } + } + } + ] + }, + "eventsRequestInfo": { + "description": "The request info", + "type": "object", + "properties": { + "name": { + "description": "The name of the request", + "type": "string" + }, + "url": { + "description": "The URL of the request", + "type": "string" + }, + "success": { + "description": "Indicates if the request was successful", + "type": "string" + }, + "duration": { + "description": "The duration of the request", + "type": "number", + "format": "double" + }, + "performanceBucket": { + "description": "The performance bucket of the request", + "type": "string" + }, + "resultCode": { + "description": "The result code of the request", + "type": "string" + }, + "source": { + "description": "The source of the request", + "type": "string" + }, + "id": { + "description": "The ID of the request", + "type": "string" + } + } + }, + "eventsDependencyResult": { + "x-ms-discriminator-value": "dependency", + "description": "A dependency result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "dependency": { + "$ref": "#/definitions/eventsDependencyInfo" + } + } + } + ] + }, + "eventsDependencyInfo": { + "description": "The dependency info", + "type": "object", + "properties": { + "target": { + "description": "The target of the dependency", + "type": "string" + }, + "data": { + "description": "The data of the dependency", + "type": "string" + }, + "success": { + "description": "Indicates if the dependency was successful", + "type": "string" + }, + "duration": { + "description": "The duration of the dependency", + "type": "integer", + "format": "int64" + }, + "performanceBucket": { + "description": "The performance bucket of the dependency", + "type": "string" + }, + "resultCode": { + "description": "The result code of the dependency", + "type": "string" + }, + "type": { + "description": "The type of the dependency", + "type": "string" + }, + "name": { + "description": "The name of the dependency", + "type": "string" + }, + "id": { + "description": "The ID of the dependency", + "type": "string" + } + } + }, + "eventsExceptionResult": { + "x-ms-discriminator-value": "exception", + "description": "An exception result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "exception": { + "$ref": "#/definitions/eventsExceptionInfo" + } + } + } + ] + }, + "eventsExceptionInfo": { + "description": "The exception info", + "type": "object", + "properties": { + "severityLevel": { + "description": "The severity level of the exception", + "type": "integer" + }, + "problemId": { + "description": "The problem ID of the exception", + "type": "string" + }, + "handledAt": { + "description": "Indicates where the exception was handled at", + "type": "string" + }, + "assembly": { + "description": "The assembly which threw the exception", + "type": "string" + }, + "method": { + "description": "The method that threw the exception", + "type": "string" + }, + "message": { + "description": "The message of the exception", + "type": "string" + }, + "type": { + "description": "The type of the exception", + "type": "string" + }, + "outerType": { + "description": "The outer type of the exception", + "type": "string" + }, + "outerMethod": { + "description": "The outer method of the exception", + "type": "string" + }, + "outerAssembly": { + "description": "The outer assmebly of the exception", + "type": "string" + }, + "outerMessage": { + "description": "The outer message of the exception", + "type": "string" + }, + "innermostType": { + "description": "The inner most type of the exception", + "type": "string" + }, + "innermostMessage": { + "description": "The inner most message of the exception", + "type": "string" + }, + "innermostMethod": { + "description": "The inner most method of the exception", + "type": "string" + }, + "innermostAssembly": { + "description": "The inner most assembly of the exception", + "type": "string" + }, + "details": { + "description": "The details of the exception", + "type": "array", + "items": { + "$ref": "#/definitions/eventsExceptionDetail" + } + } + } + }, + "eventsExceptionDetail": { + "description": "Exception details", + "type": "object", + "properties": { + "severityLevel": { + "description": "The severity level of the exception detail", + "type": "string" + }, + "outerId": { + "description": "The outer ID of the exception detail", + "type": "string" + }, + "message": { + "description": "The message of the exception detail", + "type": "string" + }, + "type": { + "description": "The type of the exception detail", + "type": "string" + }, + "id": { + "description": "The ID of the exception detail", + "type": "string" + }, + "parsedStack": { + "description": "The parsed stack", + "type": "array", + "items": { + "$ref": "#/definitions/eventsExceptionDetailsParsedStack" + } + } + } + }, + "eventsExceptionDetailsParsedStack": { + "description": "A parsed stack entry", + "type": "object", + "properties": { + "assembly": { + "description": "The assembly of the stack entry", + "type": "string" + }, + "method": { + "description": "The method of the stack entry", + "type": "string" + }, + "level": { + "description": "The level of the stack entry", + "type": "integer", + "format": "int64" + }, + "line": { + "description": "The line of the stack entry", + "type": "integer", + "format": "int64" + } + } + }, + "eventsAvailabilityResultResult": { + "x-ms-discriminator-value": "availabilityResult", + "description": "An availability result result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "availabilityResult": { + "$ref": "#/definitions/eventsAvailabilityResultInfo" + } + } + } + ] + }, + "eventsAvailabilityResultInfo": { + "description": "The availability result info", + "type": "object", + "properties": { + "name": { + "description": "The name of the availability result", + "type": "string" + }, + "success": { + "description": "Indicates if the availability result was successful", + "type": "string" + }, + "duration": { + "description": "The duration of the availability result", + "type": "integer", + "format": "int64" + }, + "performanceBucket": { + "description": "The performance bucket of the availability result", + "type": "string" + }, + "message": { + "description": "The message of the availability result", + "type": "string" + }, + "location": { + "description": "The location of the availability result", + "type": "string" + }, + "id": { + "description": "The ID of the availability result", + "type": "string" + }, + "size": { + "description": "The size of the availability result", + "type": "string" + } + } + }, + "eventsPerformanceCounterResult": { + "x-ms-discriminator-value": "performanceCounter", + "description": "A performance counter result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "performanceCounter": { + "$ref": "#/definitions/eventsPerformanceCounterInfo" + } + } + } + ] + }, + "eventsPerformanceCounterInfo": { + "description": "The performance counter info", + "type": "object", + "properties": { + "value": { + "description": "The value of the performance counter", + "type": "number", + "format": "double" + }, + "name": { + "description": "The name of the performance counter", + "type": "string" + }, + "category": { + "description": "The category of the performance counter", + "type": "string" + }, + "counter": { + "description": "The counter of the performance counter", + "type": "string" + }, + "instanceName": { + "description": "The instance name of the performance counter", + "type": "string" + }, + "instance": { + "description": "The instance of the performance counter", + "type": "string" + } + } + }, + "eventsCustomMetricResult": { + "x-ms-discriminator-value": "customMetric", + "description": "A custom metric result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "customMetric": { + "$ref": "#/definitions/eventsCustomMetricInfo" + } + } + } + ] + }, + "eventsCustomMetricInfo": { + "description": "The custom metric info", + "type": "object", + "properties": { + "name": { + "description": "The name of the custom metric", + "type": "string" + }, + "value": { + "description": "The value of the custom metric", + "type": "number", + "format": "double" + }, + "valueSum": { + "description": "The sum of the custom metric", + "type": "number", + "format": "double" + }, + "valueCount": { + "description": "The count of the custom metric", + "type": "integer", + "format": "int32" + }, + "valueMin": { + "description": "The minimum value of the custom metric", + "type": "number", + "format": "double" + }, + "valueMax": { + "description": "The maximum value of the custom metric", + "type": "number", + "format": "double" + }, + "valueStdDev": { + "description": "The standard deviation of the custom metric", + "type": "number", + "format": "double" + } + } + }, + "eventsOperationInfo": { + "description": "Operation info for an event result", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "id": { + "description": "ID of the operation", + "type": "string" + }, + "parentId": { + "description": "Parent ID of the operation", + "type": "string" + }, + "syntheticSource": { + "description": "Synthetic source of the operation", + "type": "string" + } + } + }, + "eventsSessionInfo": { + "description": "Session info for an event result", + "type": "object", + "properties": { + "id": { + "description": "ID of the session", + "type": "string" + } + } + }, + "eventsUserInfo": { + "description": "User info for an event result", + "type": "object", + "properties": { + "id": { + "description": "ID of the user", + "type": "string" + }, + "accountId": { + "description": "Account ID of the user", + "type": "string" + }, + "authenticatedId": { + "description": "Authenticated ID of the user", + "type": "string" + } + } + }, + "eventsCloudInfo": { + "description": "Cloud info for an event result", + "type": "object", + "properties": { + "roleName": { + "description": "Role name of the cloud", + "type": "string" + }, + "roleInstance": { + "description": "Role instance of the cloud", + "type": "string" + } + } + }, + "eventsAiInfo": { + "description": "AI related application info for an event result", + "type": "object", + "properties": { + "iKey": { + "description": "iKey of the app", + "type": "string" + }, + "appName": { + "description": "Name of the application", + "type": "string" + }, + "appId": { + "description": "ID of the application", + "type": "string" + }, + "sdkVersion": { + "description": "SDK version of the application", + "type": "string" + } + } + }, + "eventsApplicationInfo": { + "description": "Application info for an event result", + "type": "object", + "properties": { + "version": { + "description": "Version of the application", + "type": "string" + } + } + }, + "eventsClientInfo": { + "description": "Client info for an event result", + "type": "object", + "properties": { + "model": { + "description": "Model of the client", + "type": "string" + }, + "os": { + "description": "Operating system of the client", + "type": "string" + }, + "type": { + "description": "Type of the client", + "type": "string" + }, + "browser": { + "description": "Browser of the client", + "type": "string" + }, + "ip": { + "description": "IP address of the client", + "type": "string" + }, + "city": { + "description": "City of the client", + "type": "string" + }, + "stateOrProvince": { + "description": "State or province of the client", + "type": "string" + }, + "countryOrRegion": { + "description": "Country or region of the client", + "type": "string" + } + } + }, + "queryParam": { + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "type": "string" + }, + "queryTimespan": { + "description": "Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.", + "type": "string" + }, + "applicationsParam": { + "description": "Application IDs to include in cross-application queries.", + "type": "array", + "items": { + "type": "string" + } + }, + "queryBody": { + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "type": "object", + "properties": { + "query": { + "description": "The query to execute.", + "$ref": "#/definitions/queryParam" + }, + "timespan": { + "description": "Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.", + "$ref": "#/definitions/queryTimespan" + }, + "applications": { + "description": "A list of Application IDs for cross-application queries.", + "$ref": "#/definitions/applicationsParam" + } + }, + "required": [ + "query" + ] + }, + "queryResults": { + "title": "A query response.", + "description": "Contains the tables, columns & rows resulting from a query.", + "type": "object", + "properties": { + "tables": { + "description": "The list of tables, columns and rows.", + "type": "array", + "items": { + "$ref": "#/definitions/table" + } + } + }, + "required": [ + "tables" + ] + }, + "table": { + "title": "A query response table.", + "description": "Contains the columns and rows for one table in a query response.", + "type": "object", + "properties": { + "name": { + "description": "The name of the table.", + "type": "string" + }, + "columns": { + "description": "The list of columns in this table.", + "type": "array", + "items": { + "$ref": "#/definitions/column" + } + }, + "rows": { + "description": "The resulting rows from this query.", + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "required": [ + "name", + "columns", + "rows" + ] + }, + "column": { + "title": "A table column.", + "description": "A column in a table.", + "type": "object", + "properties": { + "name": { + "description": "The name of this column.", + "type": "string" + }, + "type": { + "description": "The data type of this column.", + "type": "string" + } + } + }, + "errorDetail": { + "title": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error's code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "target": { + "description": "Indicates which property in the request is responsible for the error.", + "type": "string" + }, + "value": { + "description": "Indicates which value in 'target' is responsible for the error.", + "type": "string" + }, + "resources": { + "description": "Indicates resources which were responsible for the error.", + "type": "array", + "items": { + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "required": [ + "code", + "message" + ] + }, + "errorInfo": { + "title": "The code and message for an error.", + "type": "object", + "properties": { + "code": { + "description": "A machine readable error code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "details": { + "description": "error details.", + "type": "array", + "items": { + "$ref": "#/definitions/errorDetail" + } + }, + "innererror": { + "description": "Inner error details if they exist.", + "$ref": "#/definitions/errorInfo" + }, + "additionalProperties": { + "type": "object" + } + }, + "required": [ + "code", + "message" + ] + }, + "errorResponse": { + "title": "Error details.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "#/definitions/errorInfo" + } + }, + "required": [ + "error" + ] + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/AppInsights.json similarity index 93% rename from specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json rename to specification/applicationinsights/data-plane/microsoft.insights/preview/v1/AppInsights.json index c0cac579e3bc..caa9e3846e63 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/AppInsights.json @@ -47,9 +47,9 @@ "paths": { "/apps/{appId}/metrics/{metricId}": { "get": { - "operationId": "GetMetric", + "operationId": "Metrics_Get", "summary": "Retrieve metric data", - "description": "Gets data for a single metric.", + "description": "Gets metric values for a single metric", "x-ms-examples": { "simpleMetric": { "$ref": "examples/metric-get.json" @@ -105,7 +105,7 @@ }, "/apps/{appId}/metrics": { "post": { - "operationId": "GetMetrics", + "operationId": "Metrics_GetMultiple", "summary": "Retrieve metric data", "description": "Gets metric values for multiple metrics", "x-ms-examples": { @@ -139,7 +139,7 @@ }, "/apps/{appId}/metrics/metadata": { "get": { - "operationId": "GetMetricsMetadata", + "operationId": "Metrics_GetMetadata", "summary": "Retrieve metric metatadata", "description": "Gets metadata describing the available metrics", "x-ms-examples": { @@ -154,7 +154,7 @@ ], "responses": { "200": { - "description": "Successful response", + "description": "Successful responses", "schema": { "type": "object" } @@ -170,7 +170,7 @@ }, "/apps/{appId}/events/{eventType}": { "get": { - "operationId": "GetEvents", + "operationId": "Events_GetByType", "summary": "Execute OData query", "description": "Executes an OData query for events", "x-ms-examples": { @@ -216,11 +216,6 @@ "$ref": "#/parameters/eventsApply" } ], - "produces": [ - "application/json;odata=none", - "application/json;odata=minimal", - "application/json;odata=full" - ], "responses": { "200": { "description": "Successful response", @@ -239,7 +234,7 @@ }, "/apps/{appId}/events/{eventType}/{eventId}": { "get": { - "operationId": "GetEvent", + "operationId": "Events_Get", "summary": "Get an event", "description": "Gets the data for a single event", "x-ms-examples": { @@ -261,12 +256,6 @@ "$ref": "#/parameters/eventId" } ], - "produces": [ - "application/json", - "application/json;odata=none", - "application/json;odata=minimal", - "application/json;odata=full" - ], "responses": { "200": { "description": "Successful response", @@ -285,7 +274,7 @@ }, "/apps/{appId}/events/$metadata": { "get": { - "operationId": "GetEventsMetadataOData", + "operationId": "Events_GetOdataMetadata", "summary": "Get OData metadata", "description": "Gets OData EDMX metadata describing the event data model", "x-ms-examples": { @@ -318,45 +307,10 @@ } }, "/apps/{appId}/query": { - "get": { - "operationId": "GetQuery", - "summary": "Execute an Analytics query", - "description": "Executes an Analytics query for data", - "x-ms-examples": { - "queryGet": { - "$ref": "examples/query-get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/appId" - }, - { - "$ref": "#/parameters/queryParam" - }, - { - "$ref": "#/parameters/queryTimespan" - } - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/queryResults" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/errorResponse" - } - } - } - }, "post": { - "operationId": "Query", + "operationId": "Query_Execute", "summary": "Execute an Analytics query", - "description": "Executes an Analytics query for data. [Here](/documentation/2-Using-the-API/Query) is an example for using POST with an Analytics query.", + "description": "Executes an Analytics query for data. [Here](https://dev.applicationinsights.io/documentation/Using-the-API/Query) is an example for using POST with an Analytics query.", "x-ms-examples": { "queryPost": { "$ref": "examples/query-post.json" @@ -368,9 +322,6 @@ }, { "$ref": "#/parameters/queryBody" - }, - { - "$ref": "#/parameters/queryTimespan" } ], "responses": { @@ -388,37 +339,6 @@ } } } - }, - "/apps/{appId}/query/schema": { - "get": { - "operationId": "GetQuerySchema", - "summary": "Get Analytics query metadata", - "description": "Gets Analytics query schema describing the data model", - "x-ms-examples": { - "querySchema": { - "$ref": "examples/query-schema.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/appId" - } - ], - "responses": { - "200": { - "description": "Successful responses", - "schema": { - "$ref": "#/definitions/queryResults" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/errorResponse" - } - } - } - } } }, "parameters": { @@ -428,7 +348,7 @@ "in": "path", "required": true, "type": "string", - "x-ms-parameter-location": "client" + "x-ms-parameter-location": "method" }, "metricId": { "name": "metricId", @@ -470,7 +390,11 @@ "availabilityResults/duration", "billing/telemetryCount", "customEvents/count" - ] + ], + "x-ms-enum": { + "name": "MetricId", + "modelAsString": true + } }, "metricsTimespan": { "name": "timespan", @@ -478,8 +402,7 @@ "required": false, "x-ms-parameter-location": "method", "description": "The timespan over which to retrieve metric values. This is an ISO8601 time period value. If timespan is omitted, a default time range of `PT12H` (\"last 12 hours\") is used. The actual timespan that is queried may be adjusted by the server based. In all cases, the actual time span used for the query is included in the response.", - "type": "string", - "format": "duration" + "type": "string" }, "metricsAggregation": { "name": "aggregation", @@ -496,8 +419,13 @@ "max", "avg", "sum", - "count" - ] + "count", + "unique" + ], + "x-ms-enum": { + "name": "MetricsAggregation", + "modelAsString": false + } } }, "metricsInterval": { @@ -535,7 +463,11 @@ "environment", "hostingLocation", "instanceName" - ] + ], + "x-ms-enum": { + "name": "MetricsSegment", + "modelAsString": true + } } }, "metricsTop": { @@ -592,7 +524,7 @@ ], "x-ms-enum": { "name": "EventType", - "modelAsString": false + "modelAsString": true } }, "eventId": { @@ -609,8 +541,7 @@ "required": false, "x-ms-parameter-location": "method", "description": "Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression.", - "type": "string", - "format": "duration" + "type": "string" }, "eventsFilter": { "name": "$filter", @@ -678,14 +609,23 @@ "description": "An expression used for aggregation over returned events", "type": "string" }, + "applicationsParam": { + "description": "A list of applications over which to query.", + "name": "applications", + "in": "query", + "collectionFormat": "csv", + "required": false, + "default": "", + "x-ms-parameter-location": "method", + "type": "string" + }, "queryTimespan": { "name": "timespan", "in": "query", "required": false, "x-ms-parameter-location": "method", "description": "Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.", - "type": "string", - "format": "duration" + "type": "string" }, "queryParam": { "name": "query", @@ -743,12 +683,15 @@ "availabilityResults/duration", "billing/telemetryCount", "customEvents/count" - ] + ], + "x-ms-enum": { + "name": "MetricId", + "modelAsString": true + } }, "metricsTimespan": { "description": "The timespan over which to retrieve metric values. This is an ISO8601 time period value. If timespan is omitted, a default time range of `PT12H` (\"last 12 hours\") is used. The actual timespan that is queried may be adjusted by the server based. In all cases, the actual time span used for the query is included in the response.", - "type": "string", - "format": "duration" + "type": "string" }, "metricsAggregation": { "description": "The aggregation to use when computing the metric values. To retrieve more than one aggregation at a time, separate them with a comma. If no aggregation is specified, then the default aggregation for the metric is used.", @@ -761,8 +704,13 @@ "max", "avg", "sum", - "count" - ] + "count", + "unique" + ], + "x-ms-enum": { + "name": "MetricsAggregation", + "modelAsString": false + } } }, "metricsInterval": { @@ -793,7 +741,11 @@ "environment", "hostingLocation", "instanceName" - ] + ], + "x-ms-enum": { + "name": "MetricsSegment", + "modelAsString": true + } } }, "metricsTop": { @@ -971,7 +923,7 @@ ], "x-ms-enum": { "name": "EventType", - "modelAsString": false + "modelAsString": true } }, "eventId": { @@ -980,8 +932,7 @@ }, "eventsTimespan": { "description": "Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression.", - "type": "string", - "format": "duration" + "type": "string" }, "eventsFilter": { "description": "An expression used to filter the returned events", @@ -1072,43 +1023,7 @@ }, "type": { "description": "The type of event.", - "type": "string", - "x-ms-enum": { - "name": "EventType", - "modelAsString": true, - "values": [ - { - "value": "trace" - }, - { - "value": "customEvent" - }, - { - "value": "pageView" - }, - { - "value": "browserTiming" - }, - { - "value": "request" - }, - { - "value": "dependency" - }, - { - "value": "exception" - }, - { - "value": "availabilityResult" - }, - { - "value": "performanceCounter" - }, - { - "value": "customMetric" - } - ] - } + "$ref": "#/definitions/eventType" }, "count": { "description": "Count of the event", @@ -1688,8 +1603,8 @@ "properties": { "value": { "description": "The value of the performance counter", - "type": "integer", - "format": "int64" + "type": "number", + "format": "double" }, "name": { "description": "The name of the performance counter", @@ -1750,8 +1665,8 @@ }, "valueCount": { "description": "The count of the custom metric", - "type": "number", - "format": "double" + "type": "integer", + "format": "int32" }, "valueMin": { "description": "The minimum value of the custom metric", @@ -1910,8 +1825,7 @@ }, "queryTimespan": { "description": "Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.", - "type": "string", - "format": "duration" + "type": "string" }, "applicationsParam": { "description": "Application IDs to include in cross-application queries.", @@ -1921,7 +1835,7 @@ } }, "queryBody": { - "description": "Query request body", + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", "type": "object", "properties": { "query": { @@ -1933,7 +1847,7 @@ "$ref": "#/definitions/queryTimespan" }, "applications": { - "description": "A list of applications that are included in the query.", + "description": "A list of Application IDs for cross-application queries.", "$ref": "#/definitions/applicationsParam" } }, diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-id.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/events-get-by-id.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-id.json rename to specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/events-get-by-id.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-type.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/events-get-by-type.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-type.json rename to specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/events-get-by-type.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-metadata.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/events-get-metadata.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-metadata.json rename to specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/events-get-metadata.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get-custom.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get-custom.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get-custom.json rename to specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get-custom.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get-full.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get-full.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get-full.json rename to specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get-full.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get.json rename to specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-post.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-post.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-post.json rename to specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-post.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metrics-get-metadata.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metrics-get-metadata.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metrics-get-metadata.json rename to specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metrics-get-metadata.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-get.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-get.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-get.json rename to specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-get.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-post.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-post.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-post.json rename to specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-post.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-schema.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-schema.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-schema.json rename to specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-schema.json diff --git a/specification/applicationinsights/data-plane/readme.md b/specification/applicationinsights/data-plane/readme.md index 65d902137b0f..1fff33e50dd3 100644 --- a/specification/applicationinsights/data-plane/readme.md +++ b/specification/applicationinsights/data-plane/readme.md @@ -37,11 +37,32 @@ These settings apply only when `--tag=v1` is specified on the command line. ``` yaml $(tag) == 'v1' input-file: -- microsoft.insights/v1/AppInsights.json +- microsoft.insights/preview/v1/AppInsights.json +directive: + - reason: Don't expose the GET endpoint since it's behavior is more limited than POST + remove-operation: Query_Get +``` + +``` yaml $(tag) == '20180420' +input-file: +- microsoft.insights/preview/2018-04-20/swagger.json +directive: + - reason: Don't expose the GET endpoint since it's behavior is more limited than POST + remove-operation: Query_Get ``` # 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 +``` + ## C# These settings apply only when `--csharp` is specified on the command line. @@ -51,12 +72,37 @@ Please also specify `--csharp-sdks-folder=", - "value": 1000 - }, - { - "column": "timestamp", - "operator": ">=", "value": "2017-09-01T00:00:00" - }, - { - "column": "application_Version", - "operator": "in", - "value": ["Draft_master_20171018.2", "Draft_master_2017024.1"] } ] } }, "responses": { "202": { + "headers": { + "x-ms-status-location": "https://management.azure.com/subscriptions/b96161de-b34a-480f-7343-59b099299283/resourceGroups/example/providers/microsoft.insights/components/test/operations/purge-970318e7-b859-4edb-8903-83b1b54d0b74?api-version=2015-05-01" + }, "body": { "operationId": "7d7cf277-9113-4ab3-8359-d0364b74d01d" } - }, - "200": { - "body": { - "status": "Completed" - } } } } diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsPurgeStatus.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsPurgeStatus.json new file mode 100644 index 000000000000..4416c0cf1431 --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsPurgeStatus.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName":"OIAutoRest5123", + "resourceName":"aztest5048", + "api-version":"2015-05-01", + "subscriptionId":"00000000-0000-0000-0000-00000000000", + "purgeId": "purge-970318e7-b859-4edb-8903-83b1b54d0b74" + }, + "responses": { + "200": { + "body": { + "status": "completed" + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WebTestListByComponent.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WebTestListByComponent.json new file mode 100644 index 000000000000..6ae800e333df --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WebTestListByComponent.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2015-05-01", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "componentName": "my-component" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/webtests/my-webtest-my-component", + "name": "my-webtest-my-component", + "type": "Microsoft.Insights/webtests", + "location": "southcentralus", + "tags": { + "hidden-link:/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component": "Resource", + "hidden-link:/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Web/sites/mytestwebapp": "Resource" + }, + "kind": "ping", + "properties": { + "SyntheticMonitorId": "my-webtest-my-component", + "Name": "my-webtest", + "Description": "", + "Enabled": false, + "Frequency": 900, + "Timeout": 120, + "Kind": "ping", + "RetryEnabled": true, + "Locations": [ + { + "Id": "apac-hk-hkn-azr" + } + ], + "Configuration": { + "WebTest": "" + }, + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbookDelete.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbookDelete.json index 55e211e37569..c9fc249f8b4c 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbookDelete.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbookDelete.json @@ -3,7 +3,6 @@ "api-version": "2015-05-01", "subscriptionId": "subid", "resourceGroupName": "my-resource-group", - "location": "west us", "resourceName": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2" }, "responses": { diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbookGet.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbookGet.json index f291a5d5b94b..2ca735abb836 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbookGet.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbookGet.json @@ -3,7 +3,6 @@ "api-version": "2015-05-01", "subscriptionId": "6b643656-33eb-422f-aee8-3ac145d124af", "resourceGroupName": "my-resource-group", - "location": "west us", "resourceName": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2" }, "responses": { diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbooksList.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbooksList.json index c1b1214d103c..f9ed6a892437 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbooksList.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbooksList.json @@ -3,7 +3,6 @@ "api-version": "2015-05-01", "subscriptionId": "6b643656-33eb-422f-aee8-3ac145d124af", "resourceGroupName": "my-resource-group", - "location": "west us", "category": "workbook" }, "responses": { diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbooksListBySourceId.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbooksListBySourceId.json deleted file mode 100644 index 2482bbab334f..000000000000 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WorkbooksListBySourceId.json +++ /dev/null @@ -1,51 +0,0 @@ -{ - "parameters": { - "api-version": "2015-05-01", - "subscriptionId": "6b643656-33eb-422f-aee8-3ac145d124af", - "resourceGroupName": "my-resource-group", - "category": "workbook", - "sourceId": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup/providers/Microsoft.Web/sites/MyTestApp-CodeLens", - "canFetchWorkbook": true, - "tags": [] - }, - "responses": { - "200": { - "body": [ - { - "id": "c0deea5e-3344-40f2-96f8-6f8e1c3b5722", - "type": "", - "location": "westus", - "name": "deadb33f-8bee-4d3b-a059-9be8dac93960", - "tags": [], - "properties": { - "name": "My Workbook 1", - "userId": "userId", - "serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}", - "version": "ME", - "workbookId": "deadb33f-8bee-4d3b-a059-9be8dac93960", - "kind": "shared", - "category": "workbook", - "timeModified": null - } - }, - { - "id": "c0deea5e-3344-40f2-96f8-6f8e1c3b5722", - "type": "", - "location": "westus", - "name": "deadb33f-8bee-4d3b-a059-9be8dac93960", - "tags": ["SampleTag01", "SampleTag2"], - "properties": { - "name": "My Workbook 2", - "userId": "userId", - "serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}", - "version": "ME", - "workbookId": "deadb33f-8bee-4d3b-a059-9be8dac93960", - "kind": "shared", - "category": "workbook", - "timeModified": null - } - } - ] - } - } -} \ No newline at end of file diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/favorites_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/favorites_API.json index 3ed275e160aa..326b26c0aae5 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/favorites_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/favorites_API.json @@ -85,7 +85,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/favorites/{favoriteId}": { "get": { "description": "Get a single favorite by its FavoriteId, defined within an Application Insights component.", - "operationId": "Favorite_Get", + "operationId": "Favorites_Get", "parameters": [ { "$ref": "#/parameters/ResourceGroupNameParameter" @@ -119,7 +119,7 @@ }, "put": { "description": "Adds a new favorites to an Application Insights component.", - "operationId": "Favorite_Add", + "operationId": "Favorites_Add", "parameters": [ { "$ref": "#/parameters/ResourceGroupNameParameter" @@ -162,7 +162,7 @@ }, "patch": { "description": "Updates a favorite that has already been added to an Application Insights component.", - "operationId": "Favorite_Update", + "operationId": "Favorites_Update", "parameters": [ { "$ref": "#/parameters/ResourceGroupNameParameter" @@ -205,7 +205,7 @@ }, "delete": { "description": "Remove a favorite that is associated to an Application Insights component.", - "operationId": "Favorite_Delete", + "operationId": "Favorites_Delete", "parameters": [ { "$ref": "#/parameters/ResourceGroupNameParameter" diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/webTests_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/webTests_API.json index 1836f46b2876..56a30eaf078e 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/webTests_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/webTests_API.json @@ -243,10 +243,46 @@ "nextLinkName": "nextLink" } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{componentName}/webtests": { + "get": { + "description": "Get all Application Insights web tests defined for the specified component.", + "operationId": "WebTests_ListByComponent", + "parameters": [ + { + "$ref": "#/parameters/ComponentNameParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more web test definitions.", + "schema": { + "$ref": "#/definitions/webTestListResult" + } + } + }, + "x-ms-examples": { + "webTestListByComponent": { + "$ref": "./examples/WebTestListByComponent.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } } }, "definitions": { - "Resource": { + "WebtestsResource": { "properties": { "id": { "type": "string", @@ -318,7 +354,7 @@ "description": "An Application Insights web test definition.", "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "#/definitions/WebtestsResource" } ], "properties": { @@ -457,6 +493,14 @@ "description": "The name of the resource group.", "x-ms-parameter-location": "method" }, + "ComponentNameParameter": { + "name": "componentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Application Insights component resource.", + "x-ms-parameter-location": "method" + }, "WebTestNameParameter": { "name": "webTestName", "in": "path", diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/workbooks_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/workbooks_API.json index 4ad3bd1f42cb..60b4f9f28063 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/workbooks_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/workbooks_API.json @@ -45,9 +45,6 @@ { "$ref": "#/parameters/ResourceGroupNameParameter" }, - { - "$ref": "#/parameters/LocationParameter" - }, { "$ref": "#/parameters/CategoryParameter" }, @@ -65,7 +62,7 @@ "200": { "description": "A list containing 0 or more workbook definitions.", "schema": { - "$ref": "#/definitions/Workbooks" + "$ref": "#/definitions/WorkbooksListResult" } }, "default": { @@ -75,6 +72,9 @@ } } }, + "x-ms-pageable": { + "nextLinkName": null + }, "x-ms-examples": { "WorkbooksList": { "$ref": "./examples/WorkbooksList.json" @@ -83,9 +83,46 @@ } }, "/subscriptions/{subscriptionId}/resourceGroup/{resourceGroupName}/providers/microsoft.insights/workbooks/{resourceName}": { + "get": { + "description": "Get a single workbook by its resourceName.", + "operationId": "Workbooks_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkbookResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A workbook definition.", + "schema": { + "$ref": "#/definitions/Workbook" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/WorkbookError" + } + } + }, + "x-ms-examples": { + "WorkbookGet": { + "$ref": "./examples/WorkbookGet.json" + } + } + }, "delete": { "description": "Delete a workbook.", - "operationId": "Workbook_Delete", + "operationId": "Workbooks_Delete", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -96,9 +133,6 @@ { "$ref": "#/parameters/WorkbookResourceNameParameter" }, - { - "$ref": "#/parameters/LocationParameter" - }, { "$ref": "#/parameters/ApiVersionParameter" } @@ -125,7 +159,7 @@ }, "put": { "description": "Create a new workbook.", - "operationId": "Workbook_CreateOrUpdate", + "operationId": "Workbooks_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -177,7 +211,7 @@ }, "patch": { "description": "Updates a workbook that has already been added.", - "operationId": "Workbook_Update", + "operationId": "Workbooks_Update", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -221,97 +255,10 @@ } } } - }, - "/subscriptions/{subscriptionId}/providers/microsoft.insights/workbooks/{resourceName}": { - "get": { - "description": "Get a single workbook by its resourceName.", - "operationId": "Workbook_Get", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/WorkbookResourceNameParameter" - }, - { - "$ref": "#/parameters/LocationParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A workbook definition.", - "schema": { - "$ref": "#/definitions/Workbook" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/WorkbookError" - } - } - }, - "x-ms-examples": { - "WorkbookGet": { - "$ref": "./examples/WorkbookGet.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/microsoft.insights/workbooks": { - "get": { - "description": "Gets a list of workbooks by sourceId.", - "operationId": "Workbook_List", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/SourceIdParameter" - }, - { - "$ref": "#/parameters/CategoryParameter" - }, - { - "$ref": "#/parameters/TagsParameter" - }, - { - "$ref": "#/parameters/CanFetchWorkbookContentParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "A list containing 0 or more workbook definitions.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Workbook" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/WorkbookError" - } - } - }, - "x-ms-examples": { - "WorkbooksListLink": { - "$ref": "./examples/WorkbooksListBySourceId.json" - } - } - } } }, "definitions": { - "Resource": { + "WorkbookResource": { "properties": { "id": { "type": "string", @@ -346,10 +293,11 @@ "x-ms-azure-resource": true, "description": "An azure resource object" }, - "Workbooks": { + "WorkbooksListResult": { "properties": { "value": { "type": "array", + "readOnly": true, "items": { "$ref": "#/definitions/Workbook" }, @@ -362,7 +310,7 @@ "description": "An Application Insights workbook definition.", "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "#/definitions/WorkbookResource" } ], "properties": { @@ -538,14 +486,6 @@ "description": "The name of the Application Insights component resource.", "x-ms-parameter-location": "method" }, - "LocationParameter": { - "name": "location", - "in": "query", - "required": true, - "type": "string", - "description": "The name of location where workbook is stored.", - "x-ms-parameter-location": "method" - }, "CategoryParameter": { "name": "category", "in": "query", diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/stable/2015-05-01/analyticsItems_API.json b/specification/applicationinsights/resource-manager/microsoft.insights/stable/2015-05-01/analyticsItems_API.json index 650fde28d3fe..3dc461ce9927 100644 --- a/specification/applicationinsights/resource-manager/microsoft.insights/stable/2015-05-01/analyticsItems_API.json +++ b/specification/applicationinsights/resource-manager/microsoft.insights/stable/2015-05-01/analyticsItems_API.json @@ -37,7 +37,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/components/{resourceName}/{scopePath}": { "get": { "description": "Gets a list of Analytics Items defined within an Application Insights component.", - "operationId": "AnalyticsItem_List", + "operationId": "AnalyticsItems_List", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -85,7 +85,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/components/{resourceName}/{scopePath}/item": { "get": { "description": "Gets a specific Analytics Items defined within an Application Insights component.", - "operationId": "AnalyticsItem_Get", + "operationId": "AnalyticsItems_Get", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -125,7 +125,7 @@ }, "put": { "description": "Adds or Updates a specific Analytics Item within an Application Insights component.", - "operationId": "AnalyticsItem_Put", + "operationId": "AnalyticsItems_Put", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -171,7 +171,7 @@ }, "delete": { "description": "Deletes a specific Analytics Items defined within an Application Insights component.", - "operationId": "AnalyticsItem_Delete", + "operationId": "AnalyticsItems_Delete", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" diff --git a/specification/applicationinsights/resource-manager/readme.md b/specification/applicationinsights/resource-manager/readme.md index 1367e03a92b5..45c4fd90e929 100644 --- a/specification/applicationinsights/resource-manager/readme.md +++ b/specification/applicationinsights/resource-manager/readme.md @@ -268,6 +268,14 @@ input-file: - Microsoft.Insights/preview/2017-10-01/componentFeaturesAndPricing_API.json ``` +### Tag: package-2018-06-17-preview + +These settings apply only when `--tag=package-2018-06-17-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06-17-preview' +input-file: +- Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json +``` --- # Code Generation @@ -280,7 +288,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node ``` @@ -356,22 +364,6 @@ Please also specify `--go-sdk-folder=`. - -``` yaml $(java) -java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.applicationinsights - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-applicationinsights -``` - ### Tag: schema-2015-05-preview These settings apply only when `--tag=schema-2015-05-01` is specified on the @@ -391,4 +383,47 @@ input-file: override-info: title: ApplicationInsightsManagementClient +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) + azure-arm: true + fluent: true + namespace: com.microsoft.azure.management.applicationinsights + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-applicationinsights +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-05 +``` + +### Tag: package-2015-05 and java + +These settings apply only when `--tag=package-2015-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.applicationinsights.v2015_05_01 + output-folder: $(azure-libraries-for-java-folder)/applicationinsights/resource-manager/v2015_05_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: schema-2018-06-17-preview + +These settings apply only when `--tag=schema-2018-06-17-preview` is specified on the command line. + +``` yaml $(tag) == 'schema-2018-06-17-preview' +input-file: +- Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json ``` \ No newline at end of file diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization-ClassicAdminCalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization-ClassicAdminCalls.json new file mode 100644 index 000000000000..cae32139704f --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization-ClassicAdminCalls.json @@ -0,0 +1,145 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2015-07-01", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/classicAdministrators": { + "get": { + "tags": [ + "ClassicAdministrators" + ], + "operationId": "ClassicAdministrators_List", + "description": "Gets service administrator, account administrator, and co-administrators for the subscription.", + "parameters": [ + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns an array of administrators.", + "schema": { + "$ref": "#/definitions/ClassicAdministratorListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetClassicAdministrators.json" + } + } + } + } + }, + "definitions": { + "ClassicAdministratorProperties": { + "properties": { + "emailAddress": { + "type": "string", + "description": "The email address of the administrator." + }, + "role": { + "type": "string", + "description": "The role of the administrator." + } + }, + "description": "Classic Administrator properties." + }, + "ClassicAdministrator": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the administrator." + }, + "name": { + "type": "string", + "description": "The name of the administrator." + }, + "type": { + "type": "string", + "description": "The type of the administrator." + }, + "properties": { + "$ref": "#/definitions/ClassicAdministratorProperties", + "description": "Properties for the classic administrator." + } + }, + "description": "Classic Administrators" + }, + "ClassicAdministratorListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ClassicAdministrator" + }, + "description": "An array of administrators." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "ClassicAdministrator list result information." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + } + } +} \ No newline at end of file diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization.json b/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization.json index f6381d8809fa..6db03a407311 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization.json @@ -36,43 +36,6 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/classicAdministrators": { - "get": { - "tags": [ - "ClassicAdministrators" - ], - "operationId": "ClassicAdministrators_List", - "description": "Gets service administrator, account administrator, and co-administrators for the subscription.", - "parameters": [ - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for this operation." - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Returns an array of administrators.", - "schema": { - "$ref": "#/definitions/ClassicAdministratorListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetClassicAdministrators.json" - } - } - } - }, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/permissions": { "get": { "tags": [ @@ -959,56 +922,6 @@ }, "description": "Role Definitions filter" }, - "ClassicAdministratorProperties": { - "properties": { - "emailAddress": { - "type": "string", - "description": "The email address of the administrator." - }, - "role": { - "type": "string", - "description": "The role of the administrator." - } - }, - "description": "Classic Administrator properties." - }, - "ClassicAdministrator": { - "properties": { - "id": { - "type": "string", - "description": "The ID of the administrator." - }, - "name": { - "type": "string", - "description": "The name of the administrator." - }, - "type": { - "type": "string", - "description": "The type of the administrator." - }, - "properties": { - "$ref": "#/definitions/ClassicAdministratorProperties", - "description": "Properties for the classic administrator." - } - }, - "description": "Classic Administrators" - }, - "ClassicAdministratorListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ClassicAdministrator" - }, - "description": "An array of administrators." - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "ClassicAdministrator list result information." - }, "Permission": { "properties": { "actions": { diff --git a/specification/authorization/resource-manager/readme.csharp.md b/specification/authorization/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..610c1dfaa753 --- /dev/null +++ b/specification/authorization/resource-manager/readme.csharp.md @@ -0,0 +1,73 @@ +# C# Authorization + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DNS. + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +## Common C# Settings +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true +``` + +``` yaml $(csharp) && !$(multiApi) +namespace: Microsoft.Azure.Management.Authorization +output-folder: $(csharp-sdks-folder)/Authorization/Management.Authorization/Generated +``` + + + + + + + + + + + +## Batch settings +These settings are for batch mode only: (ie, add `--MultiApi` to the command line ) + +``` yaml $(multiApi) +namespace: Microsoft.Azure.Management.Authorization.$(ApiVersionName) +output-folder: $(csharp-sdks-folder)/$(ApiVersionName)/Generated + +batch: +- tag: package-2015-07-AzStk + ApiVersionName: Api2015_07_01 +#- tag: package-2017-10-AzStk +# ApiVersionName: Api2017_10_01 +``` + +## Tag: Packages for Azure Stack + +### Tag: package-2015-07-AzStk + +These settings apply only when `--tag=package-2015-07-AzStk` is specified on the command line. + +``` yaml $(tag) == 'package-2015-07-AzStk' +input-file: +- Microsoft.Authorization/stable/2015-07-01/authorization.json +#- ../../resources/resource-manager/Microsoft.Authorization/stable/2015-01-01/locks.json +#- ../../resources/resource-manager/Microsoft.Authorization/preview/2015-10-01-preview/policy.json +#override-info: +# title: AuthorizationManagementClient +``` + +### Tag: package-2017-10-AzStk + +These settings apply only when `--tag=package-2017-10-AzStk` is specified on the command line. + +``` yaml $(tag) == 'package-2017-10-AzStk' +input-file: +- Microsoft.Authorization\preview\2017-10-01-preview\authorization-RACalls.json +- ../../resources/resource-manager/Microsoft.Authorization/stable/2016-12-01/policyAssignments.json +- ../../resources/resource-manager/Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json +override-info: + title: AuthorizationManagementClient +``` \ No newline at end of file diff --git a/specification/authorization/resource-manager/readme.md b/specification/authorization/resource-manager/readme.md index cd73fb474cff..2ffeec661fee 100644 --- a/specification/authorization/resource-manager/readme.md +++ b/specification/authorization/resource-manager/readme.md @@ -46,6 +46,52 @@ These settings apply only when `--tag=package-2015-07` is specified on the comma ``` yaml $(tag) == 'package-2015-07' input-file: - Microsoft.Authorization/stable/2015-07-01/authorization.json +- Microsoft.Authorization/stable/2015-07-01/authorization-ClassicAdminCalls.json +``` + +### Tag: package-2015-07-authorization-only + +These settings apply only when `--tag=package-2015-07-authorization-only` is specified on the command line. + +``` yaml $(tag) == 'package-2015-07-authorization-only' +input-file: +- Microsoft.Authorization/stable/2015-07-01/authorization.json +``` + +### Tag: package-2015-06-01-preview + +These settings apply only when `--tag=package-2015-06-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-06-01-preview' +input-file: +- Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json +``` + +### Tag: package-2015-07-01-preview + +These settings apply only when `--tag=package-2015-07-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-07-01-preview' +input-file: +- Microsoft.Authorization/preview/2015-07-01/authorization.json +``` + +### Tag: package-2017-10-01-preview-only + +These settings apply only when `--tag=package-2017-10-01-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-10-01-preview-only' +input-file: +- Microsoft.Authorization/preview/2017-10-01-preview/authorization-RACalls.json +``` + +### Tag: package-2018-01-01-preview-only + +These settings apply only when `--tag=package-2018-01-01-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-01-01-preview-only' +input-file: +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleBasedCalls.json ``` ### Tag: package-2017-10-01-preview @@ -81,52 +127,14 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + after_scripts: + - python ./scripts/multiapi_init_gen.py azure-mgmt-authorization + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Authorization - output-folder: $(csharp-sdks-folder)/Authorization/Management.Authorization/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.authorization - package-name: azure-mgmt-authorization - package-version: 0.40.0 - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-authorization/azure/mgmt/authorization -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-authorization + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_authorization'] ``` ## Go @@ -164,7 +172,7 @@ These settings apply only when `--tag=package-2017-10-01-preview --go` is specif Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-10-01-preview' && $(go) -output-folder: $(go-sdk-folder)/services/authorization/mgmt/2017-10-01-preview/authorization +output-folder: $(go-sdk-folder)/services/preview/authorization/mgmt/2017-10-01-preview/authorization ``` ### Tag: package-2018-01-01-preview and go @@ -173,7 +181,7 @@ These settings apply only when `--tag=package-2018-01-01-preview --go` is specif Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-01-01-preview' && $(go) -output-folder: $(go-sdk-folder)/services/authorization/mgmt/2018-01-01-preview/authorization +output-folder: $(go-sdk-folder)/services/preview/authorization/mgmt/2018-01-01-preview/authorization ``` ## Java @@ -182,11 +190,30 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.authorization +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-authorization +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-07 +``` + +### Tag: package-2015-07 and java + +These settings apply only when `--tag=package-2015-07 --java` is specified on he command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2015-07' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.authorization - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-authorization -``` \ No newline at end of file + namespace: com.microsoft.azure.management.authorization.v2015_07_01 + output-folder: $(azure-libraries-for-java-folder)/authorization/resource-manager/v2015_07_01 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/authorization/resource-manager/readme.python.md b/specification/authorization/resource-manager/readme.python.md new file mode 100644 index 000000000000..58dbdb31c6ff --- /dev/null +++ b/specification/authorization/resource-manager/readme.python.md @@ -0,0 +1,57 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + package-name: azure-mgmt-authorization + clear-output-folder: true + no-namespace-folders: true +``` + +### Python multi-api + +Generate all API versions currently shipped for this package + +```yaml $(python) && $(multiapi) +batch: + - tag: package-2018-01-01-preview-only + - tag: package-2015-07-authorization-only + - tag: package-2015-06-01-preview +``` + +### Tag: package-2018-01-01-preview-only and python + +These settings apply only when `--tag=package-2018-01-01-preview-only --python` is specified on the command line. + +``` yaml $(tag) == 'package-2018-01-01-preview-only' && $(python) +python: + namespace: azure.mgmt.authorization.v2018_01_01_preview + output-folder: $(python-sdks-folder)/azure-mgmt-authorization/azure/mgmt/authorization/v2018_01_01_preview +``` + +### Tag: package-2015-07-authorization-only and python + +These settings apply only when `--tag=package-2015-07-authorization-only --python` is specified on the command line. + +``` yaml $(tag) == 'package-2015-07-authorization-only' && $(python) +python: + namespace: azure.mgmt.authorization.v2015_07_01 + output-folder: $(python-sdks-folder)/azure-mgmt-authorization/azure/mgmt/authorization/v2015_07_01 +``` + +### Tag: 2015-06-01-preview and python + +These settings apply only when `--tag=2015-06-01-preview --python` is specified on the command line. + +``` yaml $(tag) == 'package-2015-06-01-preview' && $(python) +python: + namespace: azure.mgmt.authorization.v2015_06_01 + output-folder: $(python-sdks-folder)/azure-mgmt-authorization/azure/mgmt/authorization/v2015_06_01 +``` diff --git a/specification/authorization/resource-manager/readme.ruby.md b/specification/authorization/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..16581f69d962 --- /dev/null +++ b/specification/authorization/resource-manager/readme.ruby.md @@ -0,0 +1,70 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_authorization +package-version: "0.17.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2015-07 + - tag: package-2015-06-01-preview + - tag: package-2015-07-01-preview + - tag: package-2017-10-01-preview-only + - tag: package-2018-01-01-preview-only +``` + +### Tag: package-2015-07 and ruby + +These settings apply only when `--tag=package-2015-07 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-07' && $(ruby) +namespace: "Azure::Authorization::Mgmt::V2015_07_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_authorization/lib +``` + +### Tag: package-2015-06-01-preview and ruby + +These settings apply only when `--tag=package-2015-06-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-06-01-preview' && $(ruby) +namespace: "Azure::Authorization::Mgmt::V2015_06_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_authorization/lib +``` + +### Tag: package-2015-07-01-preview and ruby + +These settings apply only when `--tag=package-2015-07-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-07-01-preview' && $(ruby) +namespace: "Azure::Authorization::Mgmt::V2015_07_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_authorization/lib +``` + +### Tag: package-2017-10-01-preview-only and ruby + +These settings apply only when `--tag=package-2017-10-01-preview-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-10-01-preview-only' && $(ruby) +namespace: "Azure::Authorization::Mgmt::V2017_10_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_authorization/lib +``` + +### Tag: package-2018-01-01-preview-only and ruby + +These settings apply only when `--tag=package-2018-01-01-preview-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-01-01-preview-only' && $(ruby) +namespace: "Azure::Authorization::Mgmt::V2018_01_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_authorization/lib +``` diff --git a/specification/automation/resource-manager/Microsoft.Automation/common/v1/definitions.json b/specification/automation/resource-manager/Microsoft.Automation/common/v1/definitions.json new file mode 100644 index 000000000000..886b42d66fc2 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/common/v1/definitions.json @@ -0,0 +1,148 @@ +{ + "swagger": "2.0", + "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" + } + } + }, + "info": { + "version": "2018-06-10", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "ErrorResponse": { + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + }, + "description": "Error response of an operation failure" + }, + "Resource": { + "description": "The core properties of ARM resources", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region where the resource lives" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "ARM proxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "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." + }, + "AutomationAccountNameParameter": { + "name": "automationAccountName", + "description": "The name of the automation account.", + "type": "string", + "required": true, + "in": "path", + "x-ms-parameter-location": "method" + }, + "clientRequestId": { + "name": "clientRequestId", + "description": "Identifies this specific client request.", + "type": "string", + "required": false, + "in": "header", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/definitions.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/definitions.json deleted file mode 100644 index c8d4f96729b5..000000000000 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/definitions.json +++ /dev/null @@ -1,1625 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "AutomationManagement", - "version": "2017-05-15-preview", - "x-ms-code-generation-settings": { - "useDateTimeOffset": true - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": {}, - "definitions": { - "AdvancedScheduleMonthlyOccurrence": { - "properties": { - "occurrence": { - "type": "integer", - "format": "int32", - "description": "Occurrence of the week within the month. Must be between 1 and 5" - }, - "day": { - "type": "string", - "description": "Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.", - "enum": [ - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ], - "x-ms-enum": { - "name": "ScheduleDay", - "modelAsString": true - } - } - }, - "description": "The properties of the create advanced schedule monthly occurrence." - }, - "AdvancedSchedule": { - "properties": { - "weekDays": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Days of the week that the job should execute on." - }, - "monthDays": { - "type": "array", - "items": { - "type": "integer", - "format": "int32", - "x-nullable": false - }, - "description": "Days of the month that the job should execute on. Must be between 1 and 31." - }, - "monthlyOccurrences": { - "type": "array", - "items": { - "$ref": "#/definitions/AdvancedScheduleMonthlyOccurrence" - }, - "description": "Occurrences of days within a month." - } - }, - "description": "The properties of the create Advanced Schedule." - }, - "Job": { - "description": "Definition of the job.", - "x-ms-mutability": [ - "read", - "create" - ], - "properties": { - "properties": { - "$ref": "#/definitions/JobProperties", - "x-ms-client-flatten": true, - "description": "The properties of the job." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "JobProperties": { - "properties": { - "runbook": { - "$ref": "#/definitions/RunbookAssociationProperty", - "description": "Gets or sets the runbook." - }, - "startedBy": { - "type": "string", - "description": "Gets or sets the job started by." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." - }, - "jobId": { - "type": "string", - "format": "uuid", - "description": "Gets or sets the id of the job.", - "x-nullable": false - }, - "creationTime": { - "type": "string", - "format": "date-time", - "x-nullable": false, - "description": "Gets or sets the creation time of the job." - }, - "status": { - "type": "string", - "description": "Gets or sets the status of the job.", - "enum": [ - "New", - "Activating", - "Running", - "Completed", - "Failed", - "Stopped", - "Blocked", - "Suspended", - "Disconnected", - "Suspending", - "Stopping", - "Resuming", - "Removing" - ], - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - } - }, - "statusDetails": { - "type": "string", - "description": "Gets or sets the status details of the job." - }, - "startTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "description": "Gets or sets the start time of the job." - }, - "endTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "description": "Gets or sets the end time of the job." - }, - "exception": { - "type": "string", - "description": "Gets or sets the exception of the job." - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "description": "Gets or sets the last modified time of the job." - }, - "lastStatusModifiedTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "description": "Gets or sets the last status modified time of the job." - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the parameters of the job." - }, - "provisioningState": { - "$ref": "#/definitions/JobProvisioningStateProperty", - "description": "The provisioning state of a resource." - } - }, - "description": "Definition of job properties." - }, - "JobCollectionItem": { - "description": "Job collection item properties.", - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Job properties.", - "$ref": "#/definitions/JobCollectionItemProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "required": [ - "properties" - ] - }, - "JobStream": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the id of the resource." - }, - "properties": { - "$ref": "./definitions.json#/definitions/JobStreamProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the id of the job stream." - } - }, - "description": "Definition of the job stream." - }, - "JobStreamProperties": { - "properties": { - "jobStreamId": { - "type": "string", - "description": "Gets or sets the id of the job stream." - }, - "time": { - "type": "string", - "format": "date-time", - "x-nullable": false, - "description": "Gets or sets the creation time of the job." - }, - "streamType": { - "type": "string", - "description": "Gets or sets the stream type.", - "enum": [ - "Progress", - "Output", - "Warning", - "Error", - "Debug", - "Verbose", - "Any" - ], - "x-ms-enum": { - "name": "JobStreamType", - "modelAsString": true - } - }, - "streamText": { - "type": "string", - "description": "Gets or sets the stream text." - }, - "summary": { - "type": "string", - "description": "Gets or sets the summary." - }, - "value": { - "type": "object", - "additionalProperties": { - "type": "object" - }, - "description": "Gets or sets the values of the job stream." - } - }, - "description": "Definition of the job stream." - }, - "JobStreamListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "./definitions.json#/definitions/JobStream" - }, - "description": "A list of job streams." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list job stream operation." - }, - "JobCreateParameters": { - "properties": { - "properties": { - "$ref": "./definitions.json#/definitions/JobCreateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the list of job properties." - } - }, - "required": [ - "properties" - ], - "description": "The parameters supplied to the create job operation." - }, - "RunbookAssociationProperty": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the runbook." - } - }, - "description": "The runbook property associated with the entity." - }, - "JobCollectionItemProperties": { - "description": "Job collection item properties.", - "properties": { - "runbook": { - "$ref": "#/definitions/RunbookAssociationProperty", - "readOnly": true, - "description": "The runbook association." - }, - "jobId": { - "type": "string", - "format": "uuid", - "readOnly": true, - "description": "The id of the job.", - "x-nullable": false - }, - "creationTime": { - "type": "string", - "format": "date-time", - "x-nullable": false, - "readOnly": true, - "description": "The creation time of the job." - }, - "status": { - "type": "string", - "readOnly": true, - "description": "The status of the job.", - "enum": [ - "New", - "Activating", - "Running", - "Completed", - "Failed", - "Stopped", - "Blocked", - "Suspended", - "Disconnected", - "Suspending", - "Stopping", - "Resuming", - "Removing" - ], - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - } - }, - "startTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "readOnly": true, - "description": "The start time of the job." - }, - "endTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "readOnly": true, - "description": "The end time of the job." - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "readOnly": true, - "description": "The last modified time of the job." - }, - "provisioningState": { - "$ref": "#/definitions/JobProvisioningStateProperty", - "description": "The current provisioning state of the job." - } - } - }, - "JobProvisioningStateProperty": { - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state of the resource.", - "enum": [ - "Failed", - "Succeeded", - "Suspended", - "Processing" - ], - "x-ms-enum": { - "name": "JobProvisioningState", - "modelAsString": true - } - } - }, - "description": "The provisioning state property." - }, - "JobListResultV2": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "./definitions.json#/definitions/JobCollectionItem", - "readOnly": true - }, - "description": "List of jobs." - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The link to the next page." - } - }, - "description": "The response model for the list job operation." - }, - "softwareUpdateConfigurationProperties": { - "description": "Software update configuration properties.", - "properties": { - "updateConfiguration": { - "description": "update specific properties for the Software update configuration", - "$ref": "#/definitions/updateConfiguration" - }, - "scheduleInfo": { - "description": "Schedule information for the Software update configuration", - "$ref": "#/definitions/ScheduleProperties" - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state for the software update configuration, which only appears in the response.", - "readOnly": true - }, - "error": { - "description": "detailes of provisioning error", - "$ref": "#/definitions/ErrorResponse" - }, - "creationTime": { - "type": "string", - "description": "Creation time of theresource, which only appears in the response.", - "format": "date-time", - "x-nullable": false, - "readOnly": true - }, - "createdBy": { - "type": "string", - "description": "createdBy property, which only appears in the response.", - "readOnly": true - }, - "lastModifiedTime": { - "type": "string", - "description": "Last time resource was modified, which only appears in the response.", - "format": "date-time", - "x-nullable": false, - "readOnly": true - }, - "lastModifiedBy": { - "type": "string", - "description": "lastModifiedBy property, which only appears in the response.", - "readOnly": true - } - }, - "required": [ - "updateConfiguration", - "scheduleInfo" - ] - }, - "softwareUpdateConfiguration": { - "x-ms-azure-resource": true, - "description": "Software update configuration properties.", - "type": "object", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name." - }, - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "properties": { - "x-ms-client-flatten": true, - "description": "Software update configuration properties.", - "$ref": "#/definitions/softwareUpdateConfigurationProperties" - } - }, - "required": [ - "properties" - ] - }, - "softwareUpdateConfigurationListResult": { - "description": "result of listing all software update configuration", - "properties": { - "value": { - "description": "outer object returned when listing all software update configurations", - "type": "array", - "items": { - "$ref": "./definitions.json#/definitions/softwareUpdateConfigurationCollectionItem" - } - } - } - }, - "collectionItemUpdateConfiguration": { - "description": "object returned when requesting a collection of software update configuration", - "properties": { - "azureVirtualMachines": { - "type": "array", - "description": "List of azure resource Ids for azure virtual machines targeted by the software update configuration.", - "items": { - "type": "string", - "description": "Azure Resource Manager Id for a virtual machine." - } - }, - "duration": { - "type": "string", - "format": "duration", - "description": "Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601" - } - } - }, - "softwareUpdateConfigurationCollectionItem": { - "description": "Software update configuration collection item properties.", - "type": "object", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Name of the software update configuration." - }, - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id of the software update configuration" - }, - "properties": { - "x-ms-client-flatten": true, - "description": "Software update configuration properties.", - "$ref": "#/definitions/softwareUpdateConfigurationCollectionItemProperties" - } - }, - "required": [ - "properties" - ] - }, - "scheduleFrequency": { - "type": "string", - "description": "Gets or sets the frequency of the schedule.", - "enum": [ - "OneTime", - "Day", - "Hour", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "ScheduleFrequency", - "modelAsString": true - } - }, - "softwareUpdateConfigurationCollectionItemProperties": { - "description": "Software update configuration collection item properties.", - "properties": { - "updateConfiguration": { - "description": "Update specific properties of the software update configuration.", - "$ref": "#/definitions/collectionItemUpdateConfiguration" - }, - "frequency": { - "description": "execution frequency of the schedule associated with the software update configuration", - "type": "string", - "$ref": "#/definitions/scheduleFrequency" - }, - "startTime": { - "type": "string", - "format": "date-time", - "x-nullable": false, - "description": "the start time of the update." - }, - "creationTime": { - "type": "string", - "description": "Creation time of the software update configuration, which only appears in the response.", - "format": "date-time", - "x-nullable": false, - "readOnly": true - }, - "lastModifiedTime": { - "type": "string", - "description": "Last time software update configuration was modified, which only appears in the response.", - "format": "date-time", - "x-nullable": false, - "readOnly": true - }, - "provisioningState": { - "type": "string", - "description": "Provisioning state for the software update configuration, which only appears in the response.", - "readOnly": true - }, - "nextRun": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "description": "ext run time of the update." - } - } - }, - "operatingSystemType": { - "type": "string", - "description": "Target operating system for the software update configuration.", - "enum": [ - "Windows", - "Linux" - ], - "x-ms-enum": { - "modelAsString": false, - "name": "OperatingSystemType" - } - }, - "updateConfiguration": { - "type": "object", - "description": "Update specifc properties of the software update configuration.", - "properties": { - "operatingSystem": { - "description": "operating system of target machines", - "$ref": "#/definitions/operatingSystemType" - }, - "windows": { - "description": "Windows specific update configuration.", - "$ref": "#/definitions/WindowsProperties" - }, - "linux": { - "description": "Linux specific update configuration.", - "$ref": "#/definitions/LinuxProperties" - }, - "duration": { - "type": "string", - "format": "duration", - "description": "Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601" - }, - "azureVirtualMachines": { - "type": "array", - "description": "List of azure resource Ids for azure virtual machines targeted by the software update configuration.", - "items": { - "type": "string", - "description": "Azure Resource Manager Id for a virtual machine." - } - }, - "nonAzureComputerNames": { - "type": "array", - "description": "List of names of non-azure machines targeted by the software update configuration.", - "items": { - "type": "string", - "description": "Name of Non-Azure OMS Computer." - } - } - }, - "required": [ - "operatingSystem" - ] - }, - "WindowsProperties": { - "type": "object", - "description": "Windows specific update configuration.", - "properties": { - "includedUpdateClassifications": { - "description": "Update classification included in the software update configuration. A comma separated string with required values", - "type": "string", - "enum": [ - "Unclassified", - "Critical", - "Security", - "UpdateRollup", - "FeaturePack", - "ServicePack", - "Definition", - "Tools", - "Updates" - ], - "x-ms-enum": { - "name": "WindowsUpdateClasses", - "modelAsString": true - } - }, - "excludedKbNumbers": { - "type": "array", - "description": "KB numbers excluded from the software update configuration.", - "items": { - "type": "string" - } - } - } - }, - "LinuxProperties": { - "type": "object", - "description": "Linux specific update configuration.", - "properties": { - "includedPackageClassifications": { - "description": "Update classifications included in the software update configuration.", - "type": "string", - "enum": [ - "Unclassified", - "Critical", - "Security", - "Other" - ], - "x-ms-enum": { - "name": "LinuxUpdateClasses", - "modelAsString": true - } - }, - "excludedPackageNameMasks": { - "type": "array", - "description": "packages excluded from the software update configuration.", - "items": { - "type": "string" - } - } - } - }, - "updateConfigurationNavigation": { - "description": "Software update configuration Run Navigation model.", - "type": "object", - "properties": { - "name": { - "description": "Name of the software update configuration triggered the software update configuration run", - "type": "string", - "readOnly": true - } - } - }, - "jobNavigation": { - "description": "Software update configuration machine run job navigation properties.", - "type": "object", - "properties": { - "id": { - "description": "Id of the job associated with the software update configuration run", - "type": "string", - "readOnly": true - } - } - }, - "Resource": { - "description": "The core properties of ARM resources", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Fully qualified resource Id for the resource" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The name of the resource" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "The type of the resource." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "The resource model definition for a ARM tracked top level resource", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags." - }, - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The Azure Region where the resource lives" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "ProxyResource": { - "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "softwareUpdateConfigurationRunListResult": { - "description": "result of listing all software update configuration runs", - "properties": { - "value": { - "description": "outer object returned when listing all software update configuration runs", - "type": "array", - "items": { - "$ref": "./definitions.json#/definitions/softwareUpdateConfigurationRun" - } - }, - "nextLink": { - "type": "string", - "description": "link to next page of results." - } - } - }, - "softwareUpdateConfigurationRun": { - "description": "Software update configuration Run properties.", - "x-ms-azure-resource": false, - "type": "object", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Name of the software update configuration run." - }, - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id of the software update configuration run" - }, - "properties": { - "x-ms-client-flatten": true, - "description": "Software update configuration Run properties.", - "$ref": "#/definitions/softwareUpdateConfigurationRunProperties" - } - } - }, - "softwareUpdateConfigurationRunProperties": { - "description": "Software update configuration properties.", - "properties": { - "softwareUpdateConfiguration": { - "description": "software update configuration triggered this run", - "$ref": "#/definitions/updateConfigurationNavigation" - }, - "status": { - "type": "string", - "description": "Status of the software update configuration run.", - "readOnly": true - }, - "configuredDuration": { - "type": "string", - "description": "configured duration for the software update configuration run.", - "readOnly": true - }, - "osType": { - "type": "string", - "description": "Operating system target of the software update configuration triggered this run", - "readOnly": true - }, - "startTime": { - "type": "string", - "format": "date-time", - "x-nullable": false, - "description": "Etart time of the software update configuration run.", - "readOnly": true - }, - "endTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "description": "End time of the software update configuration run.", - "readOnly": true - }, - "computerCount": { - "type": "integer", - "description": "Number of computers in the software update configuration run.", - "readOnly": true - }, - "failedCount": { - "type": "integer", - "description": "Number of computers with failed status.", - "readOnly": true - }, - "creationTime": { - "type": "string", - "description": "Creation time of theresource, which only appears in the response.", - "format": "date-time", - "x-nullable": false, - "readOnly": true - }, - "createdBy": { - "type": "string", - "description": "createdBy property, which only appears in the response.", - "readOnly": true - }, - "lastModifiedTime": { - "type": "string", - "description": "Last time resource was modified, which only appears in the response.", - "format": "date-time", - "x-nullable": false, - "readOnly": true - }, - "lastModifiedBy": { - "type": "string", - "description": "lastModifiedBy property, which only appears in the response.", - "readOnly": true - } - } - }, - "softwareUpdateConfigurationMachineRunListResult": { - "description": "result of listing all software update configuration machine runs", - "properties": { - "value": { - "description": "outer object returned when listing all software update configuration machine runs", - "type": "array", - "items": { - "$ref": "./definitions.json#/definitions/softwareUpdateConfigurationMachineRun" - } - }, - "nextLink": { - "type": "string", - "description": "link to next page of results." - } - } - }, - "updateConfigurationMachineRunProperties": { - "description": "Software update configuration machine run properties.", - "properties": { - "targetComputer": { - "type": "string", - "description": "name of the updated computer", - "readOnly": true - }, - "targetComputerType": { - "type": "string", - "description": "type of the updated computer.", - "readOnly": true - }, - "softwareUpdateConfiguration": { - "description": "software update configuration triggered this run", - "$ref": "#/definitions/updateConfigurationNavigation" - }, - "status": { - "type": "string", - "description": "Status of the software update configuration machine run.", - "readOnly": true - }, - "osType": { - "type": "string", - "description": "Operating system target of the software update configuration triggered this run", - "readOnly": true - }, - "correlationId": { - "type": "string", - "format": "uuid", - "description": "correlation id of the software update configuration machine run", - "readOnly": true - }, - "sourceComputerId": { - "type": "string", - "format": "uuid", - "description": "source computer id of the software update configuration machine run", - "readOnly": true - }, - "startTime": { - "type": "string", - "format": "date-time", - "x-nullable": false, - "description": "Start time of the software update configuration machine run.", - "readOnly": true - }, - "endTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "description": "End time of the software update configuration machine run.", - "readOnly": true - }, - "configuredDuration": { - "type": "string", - "description": "configured duration for the software update configuration run.", - "readOnly": true - }, - "job": { - "description": "Job associated with the software update configuration machine run", - "$ref": "#/definitions/jobNavigation" - }, - "creationTime": { - "type": "string", - "description": "Creation time of theresource, which only appears in the response.", - "format": "date-time", - "x-nullable": false, - "readOnly": true - }, - "createdBy": { - "type": "string", - "description": "createdBy property, which only appears in the response.", - "readOnly": true - }, - "lastModifiedTime": { - "type": "string", - "description": "Last time resource was modified, which only appears in the response.", - "format": "date-time", - "x-nullable": false, - "readOnly": true - }, - "lastModifiedBy": { - "type": "string", - "description": "lastModifiedBy property, which only appears in the response.", - "readOnly": true - } - } - }, - "softwareUpdateConfigurationMachineRun": { - "description": "Software update configuration machine run model.", - "x-ms-azure-resource": false, - "type": "object", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Name of the software update configuration machine run" - }, - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id of the software update configuration machine run" - }, - "properties": { - "x-ms-client-flatten": true, - "description": "Software update configuration machine run properties.", - "$ref": "#/definitions/updateConfigurationMachineRunProperties" - } - } - }, - "SourceControlCreateOrUpdateProperties": { - "properties": { - "repoUrl": { - "type": "string", - "maxLength": 2000, - "description": "Gets or sets the repo url of the source control." - }, - "branch": { - "type": "string", - "maxLength": 255, - "description": "Gets or sets the repo branch of the source control. Include branch as empty string for VsoTfvc." - }, - "folderPath": { - "type": "string", - "maxLength": 255, - "description": "Gets or sets the folder path of the source control. Path must be relative." - }, - "autoSync": { - "type": "boolean", - "description": "Gets or sets auto async of the source control. Default is false." - }, - "publishRunbook": { - "type": "boolean", - "description": "Gets or sets the auto publish of the source control. Default is true." - }, - "sourceType": { - "type": "string", - "description": "The source type. Must be one of VsoGit, VsoTfvc, GitHub, case sensitive.", - "enum": [ - "VsoGit", - "VsoTfvc", - "GitHub" - ], - "x-ms-enum": { - "name": "sourceType", - "modelAsString": true - } - }, - "securityToken": { - "type": "string", - "maxLength": 1024, - "description": "Gets or sets the authorization token for the repo of the source control." - }, - "description": { - "type": "string", - "maxLength": 512, - "description": "Gets or sets the user description of the source control." - } - }, - "description": "The properties of the create source control operation." - }, - "SourceControlCreateOrUpdateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/SourceControlCreateOrUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the source control." - } - }, - "required": [ - "properties" - ], - "description": "The parameters supplied to the create or update source control operation." - }, - "SourceControlProperties": { - "properties": { - "repoUrl": { - "type": "string", - "description": "Gets or sets the repo url of the source control." - }, - "branch": { - "type": "string", - "description": "Gets or sets the repo branch of the source control. Include branch as empty string for VsoTfvc." - }, - "folderPath": { - "type": "string", - "description": "Gets or sets the folder path of the source control." - }, - "autoSync": { - "type": "boolean", - "description": "Gets or sets auto async of the source control. Default is false." - }, - "publishRunbook": { - "type": "boolean", - "description": "Gets or sets the auto publish of the source control. Default is true." - }, - "sourceType": { - "type": "string", - "description": "The source type. Must be one of VsoGit, VsoTfvc, GitHub.", - "enum": [ - "VsoGit", - "VsoTfvc", - "GitHub" - ], - "x-ms-enum": { - "name": "sourceType", - "modelAsString": true - } - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "x-nullable": false, - "description": "Gets or sets the creation time." - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "x-nullable": false, - "description": "Gets or sets the last modified time." - } - }, - "description": "Definition of the source control properties" - }, - "SourceControl": { - "x-ms-azure-resource": true, - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name." - }, - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type." - }, - "properties": { - "$ref": "#/definitions/SourceControlProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the source control." - } - }, - "description": "Definition of the source control." - }, - "SourceControlListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SourceControl" - }, - "description": "Gets or sets a list of souce controls." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list source controls operation." - }, - "SourceControlUpdateProperties": { - "properties": { - "branch": { - "type": "string", - "description": "Gets or sets the repo branch of the source control." - }, - "folderPath": { - "type": "string", - "description": "Gets or sets the folder path of the source control. Path must be relative." - }, - "autoSync": { - "type": "boolean", - "description": "Gets or sets auto async of the source control. Default is false." - }, - "publishRunbook": { - "type": "boolean", - "description": "Gets or sets the auto publish of the source control. Default is true." - }, - "securityToken": { - "type": "string", - "description": "Gets or sets the authorization token for the repo of the source control." - }, - "description": { - "type": "string", - "description": "Gets or sets the user description of the source control." - } - }, - "description": "The properties of the update source control" - }, - "SourceControlUpdateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/SourceControlUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the value of the source control." - } - }, - "description": "The parameters supplied to the update source control operation." - }, - "SourceControlSyncJob": { - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type." - }, - "id": { - "readOnly": true, - "type": "string", - "description": "Resource id." - }, - "properties": { - "$ref": "#/definitions/SourceControlSyncJobProperties", - "x-ms-client-flatten": true, - "description": "Gets the properties of the source control sync job." - } - }, - "description": "Definition of the source control sync job." - }, - "SourceControlSyncJobProperties": { - "properties": { - "sourceControlSyncJobId": { - "type": "string", - "description": "Gets the source control sync job id." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "x-nullable": false, - "readOnly": true, - "description": "Gets the creation time of the job." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the job.", - "enum": [ - "Completed", - "Failed", - "Running" - ], - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true - } - }, - "startTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "readOnly": true, - "description": "Gets the start time of the job." - }, - "endTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "readOnly": true, - "description": "Gets the end time of the job." - }, - "startedBy": { - "type": "string", - "description": "Gets the user who started the sync job." - } - }, - "description": "Definition of source control sync job properties." - }, - "SourceControlSyncJobCreateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/SourceControlSyncJobCreateProperties", - "x-ms-client-flatten": true, - "description": "Sets the properties of the source control sync job." - } - }, - "required": [ - "properties" - ], - "description": "The parameters supplied to the create source control sync job operation." - }, - "SourceControlSyncJobCreateProperties": { - "properties": { - "commitId": { - "type": "string", - "description": "Sets the commit id of the source control sync job." - } - }, - "description": "Definition of create source control sync job properties." - }, - "SourceControlSyncJobListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SourceControlSyncJob" - }, - "description": "Gets a list of source control sync jobs." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list source control sync jobs operation." - }, - "SourceControlSyncJobById": { - "properties": { - "id": { - "type": "string", - "description": "Gets the id of the job." - }, - "properties": { - "$ref": "#/definitions/SourceControlSyncJobByIdProperties", - "x-ms-client-flatten": true, - "description": "Gets the properties of the source control sync job." - } - }, - "description": "Definition of the source control sync job." - }, - "SourceControlSyncJobByIdProperties": { - "properties": { - "sourceControlSyncJobId": { - "type": "string", - "description": "Gets the source control sync job id." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "x-nullable": false, - "readOnly": true, - "description": "Gets the creation time of the job." - }, - "provisioningState": { - "type": "string", - "description": "Gets the provisioning state of the job.", - "enum": [ - "Completed", - "Failed", - "Running" - ], - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true - } - }, - "startTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "readOnly": true, - "description": "Gets the start time of the job." - }, - "endTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "readOnly": true, - "description": "Gets the end time of the job." - }, - "startedBy": { - "type": "string", - "description": "Gets the user who started the sync job." - }, - "errors": { - "description": "Error details of the source control sync job.", - "$ref": "#/definitions/SourceControlSyncJobByIdErrors" - } - }, - "description": "Definition of source control sync job properties." - }, - "SourceControlSyncJobByIdErrors": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Gets the error code for the job." - }, - "message": { - "type": "string", - "description": "Gets the error message for the job." - } - }, - "description": "Error details of the source control sync job." - }, - "ErrorResponse": { - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - }, - "description": "Error response of an operation failure" - }, - "ScheduleProperties": { - "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "x-nullable": false, - "description": "Gets or sets the start time of the schedule." - }, - "startTimeOffsetMinutes": { - "readOnly": true, - "type": "number", - "format": "double", - "description": "Gets the start time's offset in minutes.", - "x-nullable": false - }, - "expiryTime": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "description": "Gets or sets the end time of the schedule." - }, - "expiryTimeOffsetMinutes": { - "type": "number", - "format": "double", - "description": "Gets or sets the expiry time's offset in minutes.", - "x-nullable": false - }, - "isEnabled": { - "type": "boolean", - "default": false, - "description": "Gets or sets a value indicating whether this schedule is enabled." - }, - "nextRun": { - "type": "string", - "format": "date-time", - "x-nullable": true, - "description": "Gets or sets the next run time of the schedule." - }, - "nextRunOffsetMinutes": { - "type": "number", - "format": "double", - "description": "Gets or sets the next run time's offset in minutes.", - "x-nullable": false - }, - "interval": { - "type": "integer", - "description": "Gets or sets the interval of the schedule." - }, - "frequency": { - "type": "string", - "description": "Gets or sets the frequency of the schedule.", - "enum": [ - "OneTime", - "Day", - "Hour", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "ScheduleFrequency", - "modelAsString": true - } - }, - "timeZone": { - "type": "string", - "description": "Gets or sets the time zone of the schedule." - }, - "advancedSchedule": { - "$ref": "#/definitions/AdvancedSchedule", - "description": "Gets or sets the advanced schedule." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "x-nullable": false, - "description": "Gets or sets the creation time." - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "x-nullable": false, - "description": "Gets or sets the last modified time." - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - } - }, - "description": "Definition of schedule parameters." - }, - "JobCreateProperties": { - "properties": { - "runbook": { - "$ref": "#/definitions/RunbookAssociationProperty", - "description": "Gets or sets the runbook." - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the parameters of the job." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - }, - "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." - }, - "AutomationAccountNameParameter": { - "name": "automationAccountName", - "description": "The name of the automation account.", - "type": "string", - "required": true, - "in": "path", - "x-ms-parameter-location": "method" - }, - "automationAccountName": { - "name": "automationAccountName", - "description": "The name of the automation account.", - "type": "string", - "required": true, - "in": "path", - "x-ms-parameter-location": "method" - }, - "clientRequestId": { - "name": "clientRequestId", - "description": "Identifies this specific client request.", - "type": "string", - "required": false, - "in": "header", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json index a89a27a84ead..e9221ee9bcc2 100755 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json @@ -15,7 +15,8 @@ "168934", "168973" ], - "includedUpdateClassifications": "Critical" + "includedUpdateClassifications": "Critical", + "rebootSetting": "IfRequired" }, "azureVirtualMachines": [ "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", @@ -136,8 +137,7 @@ "frequency": "Week", "creationTime": "2017-10-19T18:54:50.5233333+00:00", "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00", - "timeZone": "America/Los_Angeles", - "advancedSchedule": null + "timeZone": "America/Los_Angeles" }, "provisioningState": "Provisioning", "error": {}, @@ -146,18 +146,6 @@ "lastModifiedTime": "2017-10-19T18:54:50.68+00:00" } } - }, - "400": { - "code": "BadRequest", - "message": "{\"Message\":\"The request is invalid.\",\"ModelState\":{\"softwareUpdateConfiguration.properties.scheduleInfo\":[\"The scheduleInfo field is required.\"]}}" - }, - "404": { - "code": "NotFound", - "message": "{\"Message\":\"Could not find the account. SubscriptionId: 51766542-3ed7-4a72-a187-0c8ab644ddab AccountName: myaccount\"}" - }, - "409": { - "code": "Conflict", - "message": "\"Software update configuration with the same name already exist.\"" } } -} \ No newline at end of file +} diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/deleteSoftwareUpdateConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/deleteSoftwareUpdateConfiguration.json index c2c96fa8e5d2..5ea15ef58337 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/deleteSoftwareUpdateConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/deleteSoftwareUpdateConfiguration.json @@ -9,10 +9,6 @@ }, "responses": { "200": {}, - "204": {}, - "404": { - "code": "NotFound", - "message": "{\"Message\":\"Could not find the account. SubscriptionId: 51766542-3ed7-4a72-a187-0c8ab644ddab AccountName: myaccount\"}" - } + "204": {} } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json index a56c130e7a99..3b696f9a7712 100755 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json @@ -48,8 +48,7 @@ "frequency": "Week", "creationTime": "2017-10-19T18:54:50.5233333+00:00", "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00", - "timeZone": "America/Los_Angeles", - "advancedSchedule": null + "timeZone": "America/Los_Angeles" }, "provisioningState": "Provisioning", "createdBy": "eve@contoso.com", @@ -59,10 +58,6 @@ "lastModifiedTime": "2017-10-19T18:54:50.68+00:00" } } - }, - "404": { - "code": "NotFound", - "message": "Software update configuration not found" } } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.json index cd091fe83ce6..27d30b99b6e7 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.json @@ -64,10 +64,6 @@ } } ] - }, - "404": { - "code": "NotFound", - "message": "{\"Message\":\"Could not find the account. SubscriptionId: 1a7d4044-286c-4acb-969a-96639265bf2e AccountName: myaccount\"}" } } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurationsByVm.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurationsByVm.json index 8072728be128..d81e1f72aace 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurationsByVm.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurationsByVm.json @@ -65,10 +65,6 @@ } } ] - }, - "404": { - "code": "NotFound", - "message": "Machine is not registered for Update Management. Assure that the machine is registered for Update Management. Machine Name(s) or Id(s): /subscriptions/637d11c3-e6a4-46cb-b32c-ee5b6dd9c68a/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/vm01." } } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/getSoftwareUpdateConfigurationMachineRunById.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/getSoftwareUpdateConfigurationMachineRunById.json index a784f9b76340..75ac22a300b2 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/getSoftwareUpdateConfigurationMachineRunById.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/getSoftwareUpdateConfigurationMachineRunById.json @@ -29,10 +29,6 @@ "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00" } } - }, - "404": { - "code": "NotFound", - "message": "{\"Message\":\"Could not find the account. SubscriptionId: 51766542-3ed7-4a72-a187-0c8ab644ddab AccountName: myaccount\"}" } } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRuns.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRuns.json index 9a0a4af8a531..1225c18f2745 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRuns.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRuns.json @@ -53,10 +53,6 @@ ], "nextLink": "https://management.azure.com:443/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&_=1508725900015&$skip=100" } - }, - "404": { - "code": "NotFound", - "message": "{\"Message\":\"Could not find the account. SubscriptionId: 51766542-3ed7-4a72-a187-0c8ab644ddab AccountName: myaccount\"}" } } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRunsByRun.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRunsByRun.json index 2f658386dc98..21853f34bb82 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRunsByRun.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRunsByRun.json @@ -54,10 +54,6 @@ ], "nextLink": "https://management.azure.com:443/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&_=1508725900015&$skip=100" } - }, - "404": { - "code": "NotFound", - "message": "{\"Message\":\"Could not find the account. SubscriptionId: 51766542-3ed7-4a72-a187-0c8ab644ddab AccountName: myaccount\"}" } } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/getSoftwareUpdateConfigurationRunById.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/getSoftwareUpdateConfigurationRunById.json index 930d7bc1393d..a6cdaee78604 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/getSoftwareUpdateConfigurationRunById.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/getSoftwareUpdateConfigurationRunById.json @@ -26,10 +26,6 @@ "lastModifiedTime": "2017-10-23T02:31:39.3966667+00:00" } } - }, - "404": { - "code": "NotFound", - "message": "Software update configuration run not found" } } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listFailedSoftwareUpdateConfigurationRuns.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listFailedSoftwareUpdateConfigurationRuns.json index 613d7650d803..8bb7f46ba4b8 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listFailedSoftwareUpdateConfigurationRuns.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listFailedSoftwareUpdateConfigurationRuns.json @@ -49,10 +49,6 @@ ], "nextLink": "https://management.azure.com:443/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/stas-wcus/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&_=1508725900015&$skip=100" } - }, - "404": { - "code": "NotFound", - "message": "{\"Message\":\"Could not find the account. SubscriptionId: 51766542-3ed7-4a72-a187-0c8ab644ddab AccountName: myaccount\"}" } } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listSoftwareUpdateConfigurationRuns.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listSoftwareUpdateConfigurationRuns.json index aa3c6f4a453c..e66e2fac6e4c 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listSoftwareUpdateConfigurationRuns.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listSoftwareUpdateConfigurationRuns.json @@ -48,10 +48,6 @@ ], "nextLink": "https://management.azure.com:443/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/stas-wcus/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&_=1508725900015&$skip=100" } - }, - "404": { - "code": "NotFound", - "message": "{\"Message\":\"Could not find the account. SubscriptionId: 51766542-3ed7-4a72-a187-0c8ab644ddab AccountName: myaccount\"}" } } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/createSourceControlSyncJob.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/createSourceControlSyncJob.json index 7b396dcd33fd..90175d63460c 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/createSourceControlSyncJob.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/createSourceControlSyncJob.json @@ -18,12 +18,12 @@ "body": { "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/sourceControls/MySourceControl/sourceControlSyncJobs/ce6fe3e3-9db3-4096-a6b4-82bfb4c10a9a", "properties": { - "sourceControlSyncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a9a", + "syncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a9a", "creationTime": "2017-03-28T23:14:26.903+00:00", "provisioningState": "Completed", "startTime": "2017-03-28T23:14:27.903+00:00", "endTime": "2017-03-28T23:14:28.903+00:00", - "startedBy": "User1" + "startType": "AutoSync" } } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getAllSourceControlSyncJobs.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getAllSourceControlSyncJobs.json index 8c5dd4d1622a..bd96d01f9f63 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getAllSourceControlSyncJobs.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getAllSourceControlSyncJobs.json @@ -14,56 +14,56 @@ { "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/sourceControls/MySourceControl/sourceControlSyncJobs/ce6fe3e3-9db3-4096-a6b4-82bfb4c10a1a", "properties": { - "sourceControlSyncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a1a", + "syncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a1a", "creationTime": "2017-03-28T23:14:26.903+00:00", "provisioningState": "Completed", "startTime": "2017-03-28T23:14:27.903+00:00", "endTime": "2017-03-28T23:14:28.903+00:00", - "startedBy": "User1" + "startType": "AutoSync" } }, { "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/sourceControls/MySourceControl/sourceControlSyncJobs/ce6fe3e3-9db3-4096-a6b4-82bfb4c10a2a", "properties": { - "sourceControlSyncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a2a", + "syncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a2a", "creationTime": "2017-03-28T23:14:26.903+00:00", "provisioningState": "Completed", "startTime": "2017-03-28T23:14:27.903+00:00", "endTime": "2017-03-28T23:14:28.903+00:00", - "startedBy": "User1" + "startType": "AutoSync" } }, { "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/sourceControls/MySourceControl/sourceControlSyncJobs/ce6fe3e3-9db3-4096-a6b4-82bfb4c10a3a", "properties": { - "sourceControlSyncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a3a", + "syncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a3a", "creationTime": "2017-03-28T23:14:26.903+00:00", "provisioningState": "Completed", "startTime": "2017-03-28T23:14:27.903+00:00", "endTime": "2017-03-28T23:14:28.903+00:00", - "startedBy": "User1" + "startType": "AutoSync" } }, { "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/sourceControls/MySourceControl/sourceControlSyncJobs/ce6fe3e3-9db3-4096-a6b4-82bfb4c10a4a", "properties": { - "sourceControlSyncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a4a", + "syncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a4a", "creationTime": "2017-03-28T23:14:26.903+00:00", "provisioningState": "Completed", "startTime": "2017-03-28T23:14:27.903+00:00", "endTime": "2017-03-28T23:14:28.903+00:00", - "startedBy": "User1" + "startType": "AutoSync" } }, { "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/sourceControls/MySourceControl/sourceControlSyncJobs/ce6fe3e3-9db3-4096-a6b4-82bfb4c10a5a", "properties": { - "sourceControlSyncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a5a", + "syncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a5a", "creationTime": "2017-03-28T23:14:26.903+00:00", "provisioningState": "Completed", "startTime": "2017-03-28T23:14:27.903+00:00", "endTime": "2017-03-28T23:14:28.903+00:00", - "startedBy": "User1" + "startType": "AutoSync" } } ] diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getSourceControlSyncJob.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getSourceControlSyncJob.json index 3e66b5911326..8486118c6a79 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getSourceControlSyncJob.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getSourceControlSyncJob.json @@ -13,16 +13,13 @@ "body": { "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/sourceControls/MySourceControl/sourceControlSyncJobs/ce6fe3e3-9db3-4096-a6b4-82bfb4c10a9a", "properties": { - "sourceControlSyncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a9a", + "syncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a9a", "creationTime": "2017-03-28T23:14:26.903+00:00", "provisioningState": "Completed", "startTime": "2017-03-28T23:14:27.903+00:00", "endTime": "2017-03-28T23:14:28.903+00:00", - "startedBy": "User1", - "errors": { - "code": "0", - "message": "" - } + "startType": "AutoSync", + "exception": "" } } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJobStreams/getSourceControlSyncJobStreams.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJobStreams/getSourceControlSyncJobStreams.json new file mode 100644 index 000000000000..9c63cf96795a --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJobStreams/getSourceControlSyncJobStreams.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "sourceControlName": "MySourceControl", + "sourceControlSyncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a2b", + "api-version": "2017-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value" :[ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/sourceControls/MySourceControl/sourceControlSyncJobs/ce6fe3e3-9db3-4096-a6b4-82bfb4c10a2b/streams/b86c5c31-e9fd-4734-8764-ddd6c101e706_00636596855134810785_00000000000000000005", + "properties": { + "syncJobStreamId": "b86c5c31-e9fd-4734-8764-ddd6c101e706_00636596855134810785_00000000000000000005", + "summary": "ForbiddenError: The server failed to authenticate the request. Verify that the certificate is valid and is associated with this subscription.", + "time": "2017-03-28T23:14:26.903+00:00", + "streamType": "Error" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/sourceControls/MySourceControl/sourceControlSyncJobs/ce6fe3e3-9db3-4096-a6b4-82bfb4c10a2b/streams/b86c5c31-e9fd-4734-8764-ddd6c101e706_00636596855136998262_00000000000000000006", + "properties": { + "syncJobStreamId": "b86c5c31-e9fd-4734-8764-ddd6c101e706_00636596855136998262_00000000000000000006", + "summary": "System.Management.Automation.RuntimeException: Cannot index into a null array.\r\n at CallSite.Target(Closure , CallSite , Object , Int32 )\r\n at System.Dynamic.UpdateDelegates.UpdateAndExecute2[T0,T1,TRet](CallSite site, T0 arg0, T1 arg1)\r\n at System.Management.Automation.Interpreter.DynamicInstruction`3.Run(InterpretedFrame frame)\r\n at System.Management.Automation.Interpreter.EnterTryCatchFinallyInstruction.Run(InterpretedFrame frame)", + "time": "2017-03-28T23:14:27.903+00:00", + "streamType": "Error" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/sourceControls/MySourceControl/sourceControlSyncJobs/ce6fe3e3-9db3-4096-a6b4-82bfb4c10a2b/streams/b86c5c31-e9fd-4734-8764-ddd6c101e706_00636596855139029522_00000000000000000007", + "properties": { + "syncJobStreamId": "b86c5c31-e9fd-4734-8764-ddd6c101e706_00636596855139029522_00000000000000000007", + "summary": "System.Management.Automation.ParameterBindingValidationException: Cannot validate argument on parameter 'Location'. The argument is null or empty. Provide an argument that is not null or empty, and then try the command again. ---> System.Management.Automation.ValidationMetadataException: The argument is null or empty. Provide an argument that is not null or empty, and then try the command again.\r\n at System.Management.Automation.ValidateNotNullOrEmptyAttribute.Validate(Object arguments, EngineIntrinsics engineIntrinsics)", + "time": "2017-03-28T23:14:28.903+00:00", + "streamType": "Error" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJobStreams/getSourceControlSyncJobStreamsByStreamId.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJobStreams/getSourceControlSyncJobStreamsByStreamId.json new file mode 100644 index 000000000000..9e246ba197e3 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJobStreams/getSourceControlSyncJobStreamsByStreamId.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "sourceControlName": "MySourceControl", + "sourceControlSyncJobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a2b", + "streamId": "b86c5c31-e9fd-4734-8764-ddd6c101e706_00636596855139029522_00000000000000000007", + "api-version": "2017-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/sourceControls/MySourceControl/sourceControlSyncJobs/ce6fe3e3-9db3-4096-a6b4-82bfb4c10a2b/streams/b86c5c31-e9fd-4734-8764-ddd6c101e706_00636596855139029522_00000000000000000007", + "properties": { + "syncJobStreamId": "b86c5c31-e9fd-4734-8764-ddd6c101e706_00636596855139029522_00000000000000000007", + "summary": "", + "time": "2017-03-28T23:14:26.903+00:00", + "streamType": "Error", + "streamText": "New-AzureAffinityGroup : Cannot validate argument on parameter 'Location'. The argument is null or empty. Provide an \r\nargument that is not null or empty, and then try the command again.\r\nAt DatabaseExportImport1fba401e-0:69 char:69\r\n+ \r\n + CategoryInfo : InvalidData: . . . .", + "value": "{ 'Exception': {'Message':'System.Management.Automation.ParameterBindingValidationException: Cannot validate argument on parameter 'Location'. The argument is null or empty . . .} }" + } + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/job.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/job.json index a8196ea826e3..897304adbe69 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/job.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/job.json @@ -56,13 +56,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobName", @@ -72,23 +72,23 @@ "in": "path" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" } ], "responses": { "200": { "description": "OK", "schema": { - "type": "string" + "type": "file" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -101,9 +101,6 @@ ], "operationId": "Job_GetRunbookContent", "description": "Retrieve the runbook content of the job identified by job name.", - "produces": [ - "text/powershell" - ], "externalDocs": { "url": "http://aka.ms/azureautomationsdk/joboperations" }, @@ -114,13 +111,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobName", @@ -130,23 +127,23 @@ "in": "path" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" } ], "responses": { "200": { "description": "OK", "schema": { - "type": "string" + "type": "file" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -169,13 +166,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobName", @@ -185,10 +182,10 @@ "in": "path" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" } ], "responses": { @@ -198,7 +195,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -221,10 +218,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobName", @@ -234,13 +231,13 @@ "in": "path" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" } ], "responses": { @@ -250,7 +247,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -273,13 +270,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobName", @@ -289,23 +286,23 @@ "in": "path" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Job" + "$ref": "#/definitions/Job" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -326,13 +323,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobName", @@ -346,28 +343,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/JobCreateParameters" + "$ref": "#/definitions/JobCreateParameters" }, "description": "The parameters supplied to the create job operation." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" } ], "responses": { "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/Job" + "$ref": "#/definitions/Job" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -390,10 +387,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "$filter", @@ -403,32 +400,33 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/JobListResultV2" + "$ref": "#/definitions/JobListResultV2" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" - } + }, + "x-ms-odata": "#/definitions/JobCollectionItem" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/resume": { @@ -448,10 +446,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobName", @@ -461,13 +459,13 @@ "in": "path" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" } ], "responses": { @@ -477,7 +475,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -500,13 +498,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobName", @@ -523,23 +521,23 @@ "description": "The job stream id." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/JobStream" + "$ref": "#/definitions/JobStream" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -562,10 +560,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobName", @@ -582,26 +580,26 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/JobStreamListResult" + "$ref": "#/definitions/JobStreamListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -611,6 +609,370 @@ } } }, - "definitions": {}, + "definitions": { + "JobStream": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the id of the resource." + }, + "properties": { + "$ref": "#/definitions/JobStreamProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the id of the job stream." + } + }, + "description": "Definition of the job stream." + }, + "JobStreamProperties": { + "properties": { + "jobStreamId": { + "type": "string", + "description": "Gets or sets the id of the job stream." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the creation time of the job.", + "x-nullable": false + }, + "streamType": { + "type": "string", + "description": "Gets or sets the stream type.", + "enum": [ + "Progress", + "Output", + "Warning", + "Error", + "Debug", + "Verbose", + "Any" + ], + "x-ms-enum": { + "name": "JobStreamType", + "modelAsString": true + } + }, + "streamText": { + "type": "string", + "description": "Gets or sets the stream text." + }, + "summary": { + "type": "string", + "description": "Gets or sets the summary." + }, + "value": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "Gets or sets the values of the job stream." + } + }, + "x-ms-client-flatten": true, + "description": "Definition of the job stream." + }, + "JobStreamListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobStream" + }, + "description": "A list of job streams." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list job stream operation." + }, + "Job": { + "description": "Definition of the job.", + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "x-ms-client-flatten": true, + "description": "The properties of the job." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ] + }, + "JobListResultV2": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobCollectionItem", + "readOnly": true + }, + "description": "List of jobs." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link to the next page." + } + }, + "description": "The response model for the list job operation." + }, + "JobCollectionItem": { + "description": "Job collection item properties.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Job properties.", + "$ref": "#/definitions/JobCollectionItemProperties" + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ] + }, + "JobProperties": { + "properties": { + "runbook": { + "$ref": "#/definitions/RunbookAssociationProperty", + "description": "Gets or sets the runbook." + }, + "startedBy": { + "type": "string", + "description": "Gets or sets the job started by." + }, + "runOn": { + "type": "string", + "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." + }, + "jobId": { + "type": "string", + "format": "uuid", + "description": "Gets or sets the id of the job.", + "x-nullable": false + }, + "creationTime": { + "type": "string", + "format": "date-time", + "x-nullable": false, + "description": "Gets or sets the creation time of the job." + }, + "status": { + "type": "string", + "description": "Gets or sets the status of the job.", + "enum": [ + "New", + "Activating", + "Running", + "Completed", + "Failed", + "Stopped", + "Blocked", + "Suspended", + "Disconnected", + "Suspending", + "Stopping", + "Resuming", + "Removing" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "statusDetails": { + "type": "string", + "description": "Gets or sets the status details of the job." + }, + "startTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "description": "Gets or sets the start time of the job." + }, + "endTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "description": "Gets or sets the end time of the job." + }, + "exception": { + "type": "string", + "description": "Gets or sets the exception of the job." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "description": "Gets or sets the last modified time of the job." + }, + "lastStatusModifiedTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "description": "Gets or sets the last status modified time of the job." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the parameters of the job." + }, + "provisioningState": { + "$ref": "#/definitions/JobProvisioningStateProperty", + "description": "The current provisioning state of the job." + } + }, + "description": "Definition of job properties." + }, + "RunbookAssociationProperty": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the runbook." + } + }, + "description": "The runbook property associated with the entity." + }, + "JobCreateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/JobCreateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the list of job properties." + } + }, + "required": [ + "properties" + ], + "description": "The parameters supplied to the create job operation." + }, + "JobCollectionItemProperties": { + "description": "Job collection item properties.", + "properties": { + "runbook": { + "$ref": "#/definitions/RunbookAssociationProperty", + "readOnly": true, + "description": "The runbook association." + }, + "jobId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "The id of the job.", + "x-nullable": false + }, + "creationTime": { + "type": "string", + "format": "date-time", + "x-nullable": false, + "readOnly": true, + "description": "The creation time of the job." + }, + "status": { + "type": "string", + "readOnly": true, + "description": "The status of the job.", + "enum": [ + "New", + "Activating", + "Running", + "Completed", + "Failed", + "Stopped", + "Blocked", + "Suspended", + "Disconnected", + "Suspending", + "Stopping", + "Resuming", + "Removing" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "startTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "readOnly": true, + "description": "The start time of the job." + }, + "endTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "readOnly": true, + "description": "The end time of the job." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "readOnly": true, + "description": "The last modified time of the job." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of a resource.", + "readOnly": true + }, + "runOn": { + "type": "string", + "description": "Specifies the runOn group name where the job was executed." + } + } + }, + "JobCreateProperties": { + "properties": { + "runbook": { + "$ref": "#/definitions/RunbookAssociationProperty", + "description": "Gets or sets the runbook." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the parameters of the job." + }, + "runOn": { + "type": "string", + "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." + } + } + }, + "JobProvisioningStateProperty": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the resource.", + "enum": [ + "Failed", + "Succeeded", + "Suspended", + "Processing" + ], + "x-ms-enum": { + "name": "JobProvisioningState", + "modelAsString": true + } + } + }, "parameters": {} } diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json index 97a8d76248a3..3c28c7d65766 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json @@ -7,7 +7,7 @@ "name": "Mohamed Enein" }, "version": "2017-05-15-preview", - "x-ms-code-generation-settings": { + "x-ms-code-generation-settings": { "useDateTimeOffset": true } }, @@ -58,26 +58,26 @@ "operationId": "SoftwareUpdateConfigurations_Create", "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "name": "softwareUpdateConfigurationName", + "name": "softwareUpdateConfigurationName", "description": "The name of the software update configuration to be created.", "type": "string", "required": true, "in": "path" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" }, { "name": "parameters", @@ -85,7 +85,7 @@ "required": true, "in": "body", "schema": { - "$ref": "./definitions.json#/definitions/softwareUpdateConfiguration" + "$ref": "#/definitions/softwareUpdateConfiguration" } } ], @@ -93,23 +93,20 @@ "200": { "description": "Software update configuration with the same name and properties already exists.", "schema": { - "$ref": "./definitions.json#/definitions/softwareUpdateConfiguration" + "$ref": "#/definitions/softwareUpdateConfiguration" } }, "201": { "description": "Software update configuration is created.", "schema": { - "$ref": "./definitions.json#/definitions/softwareUpdateConfiguration" + "$ref": "#/definitions/softwareUpdateConfiguration" } }, - "400": { - "description": "Bad request." - }, - "404": { - "description": "Resource group or automation account does not exist." - }, - "409": { - "description": "A software update configuration with different properties and the same name already exist." + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } } } }, @@ -129,37 +126,40 @@ "operationId": "SoftwareUpdateConfigurations_GetByName", "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "name": "softwareUpdateConfigurationName", + "name": "softwareUpdateConfigurationName", "description": "The name of the software update configuration to be created.", "type": "string", "required": true, "in": "path" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" } ], "responses": { "200": { "description": "A single software update configuration.", "schema": { - "$ref": "./definitions.json#/definitions/softwareUpdateConfiguration" + "$ref": "#/definitions/softwareUpdateConfiguration" } }, - "404": { - "description": "Resource group, account, or software update configuration doesn't exist." + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } } } }, @@ -179,26 +179,26 @@ "operationId": "SoftwareUpdateConfigurations_Delete", "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "name": "softwareUpdateConfigurationName", + "name": "softwareUpdateConfigurationName", "description": "The name of the software update configuration to be created.", "type": "string", "required": true, "in": "path" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" } ], "responses": { @@ -208,8 +208,11 @@ "204": { "description": "The software update configuration does not exist." }, - "404": { - "description": "Resource group, account, or software update configuration doesn't exist." + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } } } } @@ -234,19 +237,19 @@ "operationId": "SoftwareUpdateConfigurations_List", "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" }, { "name": "$filter", @@ -260,12 +263,491 @@ "200": { "description": "Return list of software update configurations.", "schema": { - "$ref": "./definitions.json#/definitions/softwareUpdateConfigurationListResult" + "$ref": "#/definitions/softwareUpdateConfigurationListResult" } }, - "404": { - "description": "Resource group, or account doesn't exist." + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "softwareUpdateConfiguration": { + "x-ms-azure-resource": true, + "description": "Software update configuration properties.", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Software update configuration properties.", + "$ref": "#/definitions/softwareUpdateConfigurationProperties" + } + }, + "required": [ + "properties" + ] + }, + "softwareUpdateConfigurationProperties": { + "description": "Software update configuration properties.", + "properties": { + "updateConfiguration": { + "description": "update specific properties for the Software update configuration", + "$ref": "#/definitions/updateConfiguration" + }, + "scheduleInfo": { + "description": "Schedule information for the Software update configuration", + "$ref": "#/definitions/ScheduleProperties" + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state for the software update configuration, which only appears in the response.", + "readOnly": true + }, + "error": { + "description": "detailes of provisioning error", + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + }, + "creationTime": { + "type": "string", + "description": "Creation time of theresource, which only appears in the response.", + "format": "date-time", + "x-nullable": false, + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "createdBy property, which only appears in the response.", + "readOnly": true + }, + "lastModifiedTime": { + "type": "string", + "description": "Last time resource was modified, which only appears in the response.", + "format": "date-time", + "x-nullable": false, + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "lastModifiedBy property, which only appears in the response.", + "readOnly": true + } + }, + "required": [ + "updateConfiguration", + "scheduleInfo" + ] + }, + "WindowsProperties": { + "type": "object", + "description": "Windows specific update configuration.", + "properties": { + "includedUpdateClassifications": { + "description": "Update classification included in the software update configuration. A comma separated string with required values", + "type": "string", + "enum": [ + "Unclassified", + "Critical", + "Security", + "UpdateRollup", + "FeaturePack", + "ServicePack", + "Definition", + "Tools", + "Updates" + ], + "x-ms-enum": { + "name": "WindowsUpdateClasses", + "modelAsString": true + } + }, + "excludedKbNumbers": { + "type": "array", + "description": "KB numbers excluded from the software update configuration.", + "items": { + "type": "string" + } + }, + "includedKbNumbers": { + "type": "array", + "description": "KB numbers included from the software update configuration.", + "items": { + "type": "string" + } + }, + "rebootSetting": { + "description": "Reboot setting for the software update configuration.", + "type": "string" + } + } + }, + "operatingSystemType": { + "type": "string", + "description": "Target operating system for the software update configuration.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "OperatingSystemType" + } + }, + "updateConfiguration": { + "type": "object", + "description": "Update specifc properties of the software update configuration.", + "properties": { + "operatingSystem": { + "description": "operating system of target machines", + "$ref": "#/definitions/operatingSystemType" + }, + "windows": { + "description": "Windows specific update configuration.", + "$ref": "#/definitions/WindowsProperties" + }, + "linux": { + "description": "Linux specific update configuration.", + "$ref": "#/definitions/LinuxProperties" + }, + "duration": { + "type": "string", + "format": "duration", + "description": "Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601" + }, + "azureVirtualMachines": { + "type": "array", + "description": "List of azure resource Ids for azure virtual machines targeted by the software update configuration.", + "items": { + "type": "string", + "description": "Azure Resource Manager Id for a virtual machine." } + }, + "nonAzureComputerNames": { + "type": "array", + "description": "List of names of non-azure machines targeted by the software update configuration.", + "items": { + "type": "string", + "description": "Name of Non-Azure OMS Computer." + } + } + }, + "required": [ + "operatingSystem" + ] + }, + "LinuxProperties": { + "type": "object", + "description": "Linux specific update configuration.", + "properties": { + "includedPackageClassifications": { + "description": "Update classifications included in the software update configuration.", + "type": "string", + "enum": [ + "Unclassified", + "Critical", + "Security", + "Other" + ], + "x-ms-enum": { + "name": "LinuxUpdateClasses", + "modelAsString": true + } + }, + "excludedPackageNameMasks": { + "type": "array", + "description": "packages excluded from the software update configuration.", + "items": { + "type": "string" + } + }, + "includedPackageNameMasks": { + "type": "array", + "description": "packages included from the software update configuration.", + "items": { + "type": "string" + } + }, + "rebootSetting": { + "description": "Reboot setting for the software update configuration.", + "type": "string" + } + } + }, + "ScheduleProperties": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "x-nullable": false, + "description": "Gets or sets the start time of the schedule." + }, + "startTimeOffsetMinutes": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "Gets the start time's offset in minutes.", + "x-nullable": false + }, + "expiryTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "description": "Gets or sets the end time of the schedule." + }, + "expiryTimeOffsetMinutes": { + "type": "number", + "format": "double", + "description": "Gets or sets the expiry time's offset in minutes.", + "x-nullable": false + }, + "isEnabled": { + "type": "boolean", + "default": false, + "description": "Gets or sets a value indicating whether this schedule is enabled." + }, + "nextRun": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "description": "Gets or sets the next run time of the schedule." + }, + "nextRunOffsetMinutes": { + "type": "number", + "format": "double", + "description": "Gets or sets the next run time's offset in minutes.", + "x-nullable": false + }, + "interval": { + "type": "integer", + "description": "Gets or sets the interval of the schedule." + }, + "frequency": { + "type": "string", + "description": "Gets or sets the frequency of the schedule.", + "enum": [ + "OneTime", + "Day", + "Hour", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "ScheduleFrequency", + "modelAsString": true + } + }, + "timeZone": { + "type": "string", + "description": "Gets or sets the time zone of the schedule." + }, + "advancedSchedule": { + "$ref": "#/definitions/AdvancedSchedule", + "description": "Gets or sets the advanced schedule." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "x-nullable": false, + "description": "Gets or sets the creation time." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "x-nullable": false, + "description": "Gets or sets the last modified time." + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + } + }, + "description": "Definition of schedule parameters." + }, + "AdvancedSchedule": { + "properties": { + "weekDays": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Days of the week that the job should execute on." + }, + "monthDays": { + "type": "array", + "items": { + "type": "integer", + "format": "int32", + "x-nullable": false + }, + "description": "Days of the month that the job should execute on. Must be between 1 and 31." + }, + "monthlyOccurrences": { + "type": "array", + "items": { + "$ref": "#/definitions/AdvancedScheduleMonthlyOccurrence" + }, + "description": "Occurrences of days within a month." + } + }, + "description": "The properties of the create Advanced Schedule." + }, + "AdvancedScheduleMonthlyOccurrence": { + "properties": { + "occurrence": { + "type": "integer", + "format": "int32", + "description": "Occurrence of the week within the month. Must be between 1 and 5" + }, + "day": { + "type": "string", + "description": "Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "ScheduleDay", + "modelAsString": true + } + } + }, + "description": "The properties of the create advanced schedule monthly occurrence." + }, + "softwareUpdateConfigurationListResult": { + "description": "result of listing all software update configuration", + "properties": { + "value": { + "description": "outer object returned when listing all software update configurations", + "type": "array", + "items": { + "$ref": "#/definitions/softwareUpdateConfigurationCollectionItem" + } + } + } + }, + "softwareUpdateConfigurationCollectionItem": { + "description": "Software update configuration collection item properties.", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the software update configuration." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id of the software update configuration" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Software update configuration properties.", + "$ref": "#/definitions/softwareUpdateConfigurationCollectionItemProperties" + } + }, + "required": [ + "properties" + ] + }, + "scheduleFrequency": { + "type": "string", + "description": "Gets or sets the frequency of the schedule.", + "enum": [ + "OneTime", + "Day", + "Hour", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "ScheduleFrequency", + "modelAsString": true + } + }, + "collectionItemUpdateConfiguration": { + "description": "object returned when requesting a collection of software update configuration", + "properties": { + "azureVirtualMachines": { + "type": "array", + "description": "List of azure resource Ids for azure virtual machines targeted by the software update configuration.", + "items": { + "type": "string", + "description": "Azure Resource Manager Id for a virtual machine." + } + }, + "duration": { + "type": "string", + "format": "duration", + "description": "Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601" + } + } + }, + "softwareUpdateConfigurationCollectionItemProperties": { + "description": "Software update configuration collection item properties.", + "properties": { + "updateConfiguration": { + "description": "Update specific properties of the software update configuration.", + "$ref": "#/definitions/collectionItemUpdateConfiguration" + }, + "frequency": { + "description": "execution frequency of the schedule associated with the software update configuration", + "type": "string", + "$ref": "#/definitions/scheduleFrequency" + }, + "startTime": { + "type": "string", + "format": "date-time", + "x-nullable": false, + "description": "the start time of the update." + }, + "creationTime": { + "type": "string", + "description": "Creation time of the software update configuration, which only appears in the response.", + "format": "date-time", + "x-nullable": false, + "readOnly": true + }, + "lastModifiedTime": { + "type": "string", + "description": "Last time software update configuration was modified, which only appears in the response.", + "format": "date-time", + "x-nullable": false, + "readOnly": true + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state for the software update configuration, which only appears in the response.", + "readOnly": true + }, + "nextRun": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "description": "ext run time of the update." } } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json index bf174d2466c2..1c0d900ede66 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json @@ -7,7 +7,7 @@ "name": "Mohamed Enein" }, "version": "2017-05-15-preview", - "x-ms-code-generation-settings": { + "x-ms-code-generation-settings": { "useDateTimeOffset": true } }, @@ -58,13 +58,13 @@ "operationId": "SoftwareUpdateConfigurationMachineRuns_GetById", "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "softwareUpdateConfigurationMachineRunId", @@ -75,21 +75,24 @@ "format": "uuid" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" } ], "responses": { "200": { "description": "A single software update configuration machine run.", "schema": { - "$ref": "./definitions.json#/definitions/softwareUpdateConfigurationMachineRun" + "$ref": "#/definitions/softwareUpdateConfigurationMachineRun" } }, - "404": { - "description": "Resource group, account, or software update configuration machine run doesn't exist." + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } } } } @@ -114,19 +117,19 @@ "operationId": "SoftwareUpdateConfigurationMachineRuns_List", "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" }, { "name": "$filter", @@ -154,14 +157,167 @@ "200": { "description": "Return list of software update configuration machine runs.", "schema": { - "$ref": "./definitions.json#/definitions/softwareUpdateConfigurationMachineRunListResult" + "$ref": "#/definitions/softwareUpdateConfigurationMachineRunListResult" } }, - "404": { - "description": "Resource group, or account doesn't exist." + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } } } } } + }, + "definitions": { + "softwareUpdateConfigurationMachineRun": { + "description": "Software update configuration machine run model.", + "x-ms-azure-resource": false, + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the software update configuration machine run" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id of the software update configuration machine run" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Software update configuration machine run properties.", + "$ref": "#/definitions/updateConfigurationMachineRunProperties" + } + } + }, + "softwareUpdateConfigurationMachineRunListResult": { + "description": "result of listing all software update configuration machine runs", + "properties": { + "value": { + "description": "outer object returned when listing all software update configuration machine runs", + "type": "array", + "items": { + "$ref": "#/definitions/softwareUpdateConfigurationMachineRun" + } + }, + "nextLink": { + "type": "string", + "description": "link to next page of results." + } + } + }, + "updateConfigurationMachineRunProperties": { + "description": "Software update configuration machine run properties.", + "properties": { + "targetComputer": { + "type": "string", + "description": "name of the updated computer", + "readOnly": true + }, + "targetComputerType": { + "type": "string", + "description": "type of the updated computer.", + "readOnly": true + }, + "softwareUpdateConfiguration": { + "description": "software update configuration triggered this run", + "$ref": "#/definitions/updateConfigurationNavigation" + }, + "status": { + "type": "string", + "description": "Status of the software update configuration machine run.", + "readOnly": true + }, + "osType": { + "type": "string", + "description": "Operating system target of the software update configuration triggered this run", + "readOnly": true + }, + "correlationId": { + "type": "string", + "format": "uuid", + "description": "correlation id of the software update configuration machine run", + "readOnly": true + }, + "sourceComputerId": { + "type": "string", + "format": "uuid", + "description": "source computer id of the software update configuration machine run", + "readOnly": true + }, + "startTime": { + "type": "string", + "format": "date-time", + "x-nullable": false, + "description": "Start time of the software update configuration machine run.", + "readOnly": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "description": "End time of the software update configuration machine run.", + "readOnly": true + }, + "configuredDuration": { + "type": "string", + "description": "configured duration for the software update configuration run.", + "readOnly": true + }, + "job": { + "description": "Job associated with the software update configuration machine run", + "$ref": "#/definitions/jobNavigation" + }, + "creationTime": { + "type": "string", + "description": "Creation time of theresource, which only appears in the response.", + "format": "date-time", + "x-nullable": false, + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "createdBy property, which only appears in the response.", + "readOnly": true + }, + "lastModifiedTime": { + "type": "string", + "description": "Last time resource was modified, which only appears in the response.", + "format": "date-time", + "x-nullable": false, + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "lastModifiedBy property, which only appears in the response.", + "readOnly": true + } + } + }, + "updateConfigurationNavigation": { + "description": "Software update configuration Run Navigation model.", + "type": "object", + "properties": { + "name": { + "description": "Name of the software update configuration triggered the software update configuration run", + "type": "string", + "readOnly": true + } + } + }, + "jobNavigation": { + "description": "Software update configuration machine run job navigation properties.", + "type": "object", + "properties": { + "id": { + "description": "Id of the job associated with the software update configuration run", + "type": "string", + "readOnly": true + } + } + } } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json index f0f861f9190b..5154a99912ea 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json @@ -58,13 +58,13 @@ "operationId": "SoftwareUpdateConfigurationRuns_GetById", "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "softwareUpdateConfigurationRunId", @@ -75,21 +75,24 @@ "format": "uuid" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" } ], "responses": { "200": { "description": "A single software update configuration Run.", "schema": { - "$ref": "./definitions.json#/definitions/softwareUpdateConfigurationRun" + "$ref": "#/definitions/softwareUpdateConfigurationRun" } }, - "404": { - "description": "Resource group, account, or software update configuration doesn't exist." + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } } } } @@ -114,19 +117,19 @@ "operationId": "SoftwareUpdateConfigurationRuns_List", "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "./definitions.json#/parameters/clientRequestId" + "$ref": "../../common/v1/definitions.json#/parameters/clientRequestId" }, { "name": "$filter", @@ -154,12 +157,138 @@ "200": { "description": "Return list of software update configurations runs.", "schema": { - "$ref": "./definitions.json#/definitions/softwareUpdateConfigurationRunListResult" + "$ref": "#/definitions/softwareUpdateConfigurationRunListResult" } }, - "404": { - "description": "Resource group, or account doesn't exist." + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "softwareUpdateConfigurationRun": { + "description": "Software update configuration Run properties.", + "x-ms-azure-resource": false, + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the software update configuration run." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id of the software update configuration run" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Software update configuration Run properties.", + "$ref": "#/definitions/softwareUpdateConfigurationRunProperties" + } + } + }, + "softwareUpdateConfigurationRunProperties": { + "description": "Software update configuration properties.", + "properties": { + "softwareUpdateConfiguration": { + "description": "software update configuration triggered this run", + "$ref": "#/definitions/updateConfigurationNavigation" + }, + "status": { + "type": "string", + "description": "Status of the software update configuration run.", + "readOnly": true + }, + "configuredDuration": { + "type": "string", + "description": "configured duration for the software update configuration run.", + "readOnly": true + }, + "osType": { + "type": "string", + "description": "Operating system target of the software update configuration triggered this run", + "readOnly": true + }, + "startTime": { + "type": "string", + "format": "date-time", + "x-nullable": false, + "description": "Etart time of the software update configuration run.", + "readOnly": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "description": "End time of the software update configuration run.", + "readOnly": true + }, + "computerCount": { + "type": "integer", + "description": "Number of computers in the software update configuration run.", + "readOnly": true + }, + "failedCount": { + "type": "integer", + "description": "Number of computers with failed status.", + "readOnly": true + }, + "creationTime": { + "type": "string", + "description": "Creation time of theresource, which only appears in the response.", + "format": "date-time", + "x-nullable": false, + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "createdBy property, which only appears in the response.", + "readOnly": true + }, + "lastModifiedTime": { + "type": "string", + "description": "Last time resource was modified, which only appears in the response.", + "format": "date-time", + "x-nullable": false, + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "lastModifiedBy property, which only appears in the response.", + "readOnly": true + } + } + }, + "updateConfigurationNavigation": { + "description": "Software update configuration Run Navigation model.", + "type": "object", + "properties": { + "name": { + "description": "Name of the software update configuration triggered the software update configuration run", + "type": "string", + "readOnly": true + } + } + }, + "softwareUpdateConfigurationRunListResult": { + "description": "result of listing all software update configuration runs", + "properties": { + "value": { + "description": "outer object returned when listing all software update configuration runs", + "type": "array", + "items": { + "$ref": "#/definitions/softwareUpdateConfigurationRun" } + }, + "nextLink": { + "type": "string", + "description": "link to next page of results." } } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json index 82427c6ede57..b903ce1436a7 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json @@ -53,10 +53,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "sourceControlName", @@ -70,34 +70,34 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/SourceControlCreateOrUpdateParameters" + "$ref": "#/definitions/SourceControlCreateOrUpdateParameters" }, "description": "The parameters supplied to the create or update source control operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/SourceControl" + "$ref": "#/definitions/SourceControl" } }, "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/SourceControl" + "$ref": "#/definitions/SourceControl" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -118,10 +118,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "sourceControlName", @@ -135,28 +135,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/SourceControlUpdateParameters" + "$ref": "#/definitions/SourceControlUpdateParameters" }, "description": "The parameters supplied to the update source control operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/SourceControl" + "$ref": "#/definitions/SourceControl" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -177,10 +177,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "sourceControlName", @@ -190,10 +190,10 @@ "description": "The name of source control." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -203,7 +203,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -224,10 +224,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "sourceControlName", @@ -237,23 +237,23 @@ "description": "The name of source control." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/SourceControl" + "$ref": "#/definitions/SourceControl" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -276,10 +276,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "$filter", @@ -289,23 +289,23 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/SourceControlListResult" + "$ref": "#/definitions/SourceControlListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -314,5 +314,195 @@ } } } + }, + "definitions": { + "SourceControlListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SourceControl" + }, + "description": "Gets or sets a list of souce controls." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list source controls operation." + }, + "SourceControlUpdateProperties": { + "properties": { + "branch": { + "type": "string", + "description": "Gets or sets the repo branch of the source control." + }, + "folderPath": { + "type": "string", + "description": "Gets or sets the folder path of the source control. Path must be relative." + }, + "autoSync": { + "type": "boolean", + "description": "Gets or sets auto async of the source control. Default is false." + }, + "publishRunbook": { + "type": "boolean", + "description": "Gets or sets the auto publish of the source control. Default is true." + }, + "securityToken": { + "type": "string", + "description": "Gets or sets the authorization token for the repo of the source control." + }, + "description": { + "type": "string", + "description": "Gets or sets the user description of the source control." + } + }, + "description": "The properties of the update source control" + }, + "SourceControlUpdateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/SourceControlUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the value of the source control." + } + }, + "description": "The parameters supplied to the update source control operation." + }, + "SourceControl": { + "properties": { + "properties": { + "$ref": "#/definitions/SourceControlProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the source control." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Definition of the source control." + }, + "SourceControlProperties": { + "properties": { + "repoUrl": { + "type": "string", + "description": "Gets or sets the repo url of the source control." + }, + "branch": { + "type": "string", + "description": "Gets or sets the repo branch of the source control. Include branch as empty string for VsoTfvc." + }, + "folderPath": { + "type": "string", + "description": "Gets or sets the folder path of the source control." + }, + "autoSync": { + "type": "boolean", + "description": "Gets or sets auto async of the source control. Default is false." + }, + "publishRunbook": { + "type": "boolean", + "description": "Gets or sets the auto publish of the source control. Default is true." + }, + "sourceType": { + "type": "string", + "description": "The source type. Must be one of VsoGit, VsoTfvc, GitHub.", + "enum": [ + "VsoGit", + "VsoTfvc", + "GitHub" + ], + "x-ms-enum": { + "name": "sourceType", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "x-nullable": false, + "description": "Gets or sets the creation time." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "x-nullable": false, + "description": "Gets or sets the last modified time." + } + }, + "description": "Definition of the source control properties" + }, + "SourceControlCreateOrUpdateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/SourceControlCreateOrUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the source control." + } + }, + "required": [ + "properties" + ], + "description": "The parameters supplied to the create or update source control operation." + }, + "SourceControlCreateOrUpdateProperties": { + "properties": { + "repoUrl": { + "type": "string", + "maxLength": 2000, + "description": "Gets or sets the repo url of the source control." + }, + "branch": { + "type": "string", + "maxLength": 255, + "description": "Gets or sets the repo branch of the source control. Include branch as empty string for VsoTfvc." + }, + "folderPath": { + "type": "string", + "maxLength": 255, + "description": "Gets or sets the folder path of the source control. Path must be relative." + }, + "autoSync": { + "type": "boolean", + "description": "Gets or sets auto async of the source control. Default is false." + }, + "publishRunbook": { + "type": "boolean", + "description": "Gets or sets the auto publish of the source control. Default is true." + }, + "sourceType": { + "type": "string", + "description": "The source type. Must be one of VsoGit, VsoTfvc, GitHub, case sensitive.", + "enum": [ + "VsoGit", + "VsoTfvc", + "GitHub" + ], + "x-ms-enum": { + "name": "sourceType", + "modelAsString": true + } + }, + "securityToken": { + "type": "string", + "maxLength": 1024, + "description": "Gets or sets the authorization token for the repo of the source control." + }, + "description": { + "type": "string", + "maxLength": 512, + "description": "Gets or sets the user description of the source control." + } + }, + "description": "The properties of the create source control operation." + } } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json index 260a8a4f8f71..9b0c17794233 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json @@ -3,7 +3,7 @@ "info": { "title": "AutomationManagement", "version": "2017-05-15-preview", - "x-ms-code-generation-settings": { + "x-ms-code-generation-settings": { "useDateTimeOffset": true } }, @@ -53,10 +53,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "sourceControlName", @@ -78,28 +78,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/SourceControlSyncJobCreateParameters" + "$ref": "#/definitions/SourceControlSyncJobCreateParameters" }, "description": "The parameters supplied to the create source control sync job operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/SourceControlSyncJob" + "$ref": "#/definitions/SourceControlSyncJob" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -120,10 +120,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "sourceControlName", @@ -141,23 +141,23 @@ "description": "The source control sync job id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/SourceControlSyncJobById" + "$ref": "#/definitions/SourceControlSyncJobById" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -180,10 +180,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "sourceControlName", @@ -200,23 +200,23 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/SourceControlSyncJobListResult" + "$ref": "#/definitions/SourceControlSyncJobListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -225,5 +225,198 @@ } } } + }, + "definitions": { + "SourceControlSyncJobListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SourceControlSyncJob" + }, + "description": "Gets a list of source control sync jobs." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list source control sync jobs operation." + }, + "SourceControlSyncJobCreateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/SourceControlSyncJobCreateProperties", + "x-ms-client-flatten": true, + "description": "Sets the properties of the source control sync job." + } + }, + "required": [ + "properties" + ], + "description": "The parameters supplied to the create source control sync job operation." + }, + "SourceControlSyncJobCreateProperties": { + "properties": { + "commitId": { + "type": "string", + "description": "Sets the commit id of the source control sync job." + } + }, + "description": "Definition of create source control sync job properties." + }, + "SourceControlSyncJobById": { + "properties": { + "id": { + "type": "string", + "description": "Gets the id of the job." + }, + "properties": { + "$ref": "#/definitions/SourceControlSyncJobByIdProperties", + "x-ms-client-flatten": true, + "description": "Gets the properties of the source control sync job." + } + }, + "description": "Definition of the source control sync job." + }, + "SourceControlSyncJobByIdProperties": { + "properties": { + "syncJobId": { + "type": "string", + "description": "Gets the source control sync job id." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "x-nullable": false, + "readOnly": true, + "description": "Gets the creation time of the job." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the job.", + "enum": [ + "Completed", + "Failed", + "Running" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "startTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "readOnly": true, + "description": "Gets the start time of the job." + }, + "endTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "readOnly": true, + "description": "Gets the end time of the job." + }, + "startType": { + "type": "string", + "description": "Gets the type of start for the sync job.", + "enum": [ + "AutoSync", + "ManualSync" + ], + "x-ms-enum": { + "name": "startType", + "modelAsString": true + } + }, + "exception": { + "type": "string", + "description": "Gets the exceptions that occured while running the sync job." + } + }, + "description": "Definition of source control sync job properties." + }, + "SourceControlSyncJob": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Resource id." + }, + "properties": { + "$ref": "#/definitions/SourceControlSyncJobProperties", + "x-ms-client-flatten": true, + "description": "Gets the properties of the source control sync job." + } + }, + "description": "Definition of the source control sync job." + }, + "SourceControlSyncJobProperties": { + "properties": { + "syncJobId": { + "type": "string", + "description": "Gets the source control sync job id." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "x-nullable": false, + "readOnly": true, + "description": "Gets the creation time of the job." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the job.", + "enum": [ + "Completed", + "Failed", + "Running" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "startTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "readOnly": true, + "description": "Gets the start time of the job." + }, + "endTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "readOnly": true, + "description": "Gets the end time of the job." + }, + "startType": { + "type": "string", + "description": "Gets the type of start for the sync job.", + "enum": [ + "AutoSync", + "ManualSync" + ], + "x-ms-enum": { + "name": "startType", + "modelAsString": true + } + } + }, + "description": "Definition of source control sync job properties." + } } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJobStreams.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJobStreams.json new file mode 100644 index 000000000000..6673f57e315e --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJobStreams.json @@ -0,0 +1,298 @@ +{ + "swagger": "2.0", + "info": { + "title": "AutomationManagement", + "version": "2017-05-15-preview", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "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.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs/{sourceControlSyncJobId}/streams": { + "get": { + "tags": [ + "SourceControlSyncJobStreams" + ], + "operationId": "SourceControlSyncJobStreams_ListBySyncJob", + "description": "Retrieve a list of sync job streams identified by sync job id.", + "externalDocs": { + "url": "http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations" + }, + "x-ms-examples": { + "Get a list of sync job streams identified by sync job id": { + "$ref": "./examples/sourceControlSyncJobStreams/getSourceControlSyncJobStreams.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" + }, + { + "name": "sourceControlName", + "in": "path", + "required": true, + "type": "string", + "description": "The source control name." + }, + { + "name": "sourceControlSyncJobId", + "in": "path", + "required": true, + "format": "uuid", + "type": "string", + "description": "The source control sync job id." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControlSyncJobStreamsListBySyncJob" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs/{sourceControlSyncJobId}/streams/{streamId}": { + "get": { + "tags": [ + "SourceControlSyncJobStreams" + ], + "operationId": "SourceControlSyncJobStreams_Get", + "description": "Retrieve a sync job stream identified by stream id.", + "externalDocs": { + "url": "http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations" + }, + "x-ms-examples": { + "Get a sync job stream identified by sync job stream id.": { + "$ref": "./examples/sourceControlSyncJobStreams/getSourceControlSyncJobStreamsByStreamId.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" + }, + { + "name": "sourceControlName", + "in": "path", + "required": true, + "type": "string", + "description": "The source control name." + }, + { + "name": "sourceControlSyncJobId", + "in": "path", + "required": true, + "format": "uuid", + "type": "string", + "description": "The source control sync job id." + }, + { + "name": "streamId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the sync job stream." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControlSyncJobStreamById" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SourceControlSyncJobStreamsListBySyncJob": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SourceControlSyncJobStream" + }, + "description": "Gets a list of source control sync job streams." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list source control sync job streams operation." + }, + "SourceControlSyncJobStream": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource id." + }, + "properties": { + "$ref": "#/definitions/SourceControlSyncJobStreamProperties", + "x-ms-client-flatten": true, + "description": "Gets the properties of the source control sync job stream." + } + }, + "description": "Definition of the source control sync job stream." + }, + "SourceControlSyncJobStreamProperties": { + "properties": { + "syncJobStreamId": { + "type": "string", + "description": "Gets the sync job stream id." + }, + "summary": { + "type": "string", + "description": "Gets the summary of the sync job stream." + }, + "time": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "readOnly": true, + "description": "Gets the time of the sync job stream." + }, + "streamType": { + "type": "string", + "description": "Gets the type of the sync job stream.", + "enum": [ + "Error", + "Output" + ], + "x-ms-enum": { + "name": "streamType", + "modelAsString": true + } + } + }, + "description": "Definition of source control sync job stream properties." + }, + "SourceControlSyncJobStreamById": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource id." + }, + "properties": { + "$ref": "#/definitions/SourceControlSyncJobStreamByIdProperties", + "x-ms-client-flatten": true, + "description": "Gets the properties of the source control sync job stream." + } + }, + "description": "Definition of the source control sync job stream by id." + }, + "SourceControlSyncJobStreamByIdProperties": { + "properties": { + "syncJobStreamId": { + "type": "string", + "description": "Gets the sync job stream id." + }, + "summary": { + "type": "string", + "description": "Gets the summary of the sync job stream." + }, + "time": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "readOnly": true, + "description": "Gets the time of the sync job stream." + }, + "streamType": { + "type": "string", + "description": "Gets the type of the sync job stream.", + "enum": [ + "Error", + "Output" + ], + "x-ms-enum": { + "name": "streamType", + "modelAsString": true + } + }, + "streamText": { + "type": "string", + "description": "Gets the text of the sync job stream." + }, + "value": { + "type": "string", + "description": "Gets the value of the sync job stream." + } + }, + "description": "Definition of source control sync job stream by id properties." + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/account.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/account.json index 6635d889de8a..be4e0d612ca2 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/account.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/account.json @@ -53,47 +53,38 @@ }, "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._]+$", - "description": "The resource group name." + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "Automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/AutomationAccountUpdateParameters" + "$ref": "#/definitions/AutomationAccountUpdateParameters" }, "description": "Parameters supplied to the update automation account." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/AutomationAccount" + "$ref": "#/definitions/AutomationAccount" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -114,53 +105,44 @@ }, "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._]+$", - "description": "The resource group name." + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "Parameters supplied to the create or update automation account." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/AutomationAccountCreateOrUpdateParameters" + "$ref": "#/definitions/AutomationAccountCreateOrUpdateParameters" }, "description": "Parameters supplied to the create or update automation account." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/AutomationAccount" + "$ref": "#/definitions/AutomationAccount" } }, "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/AutomationAccount" + "$ref": "#/definitions/AutomationAccount" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -181,25 +163,16 @@ }, "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._]+$", - "description": "The resource group name." + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "Automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -212,7 +185,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -233,38 +206,29 @@ }, "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._]+$", - "description": "The resource group name." + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/AutomationAccount" + "$ref": "#/definitions/AutomationAccount" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -287,31 +251,26 @@ }, "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._]+$", - "description": "The resource group name." + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/AutomationAccountListResult" + "$ref": "#/definitions/AutomationAccountListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -329,20 +288,20 @@ "operationId": "Operations_List", "parameters": [ { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/OperationListResult" + "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -366,23 +325,23 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/AutomationAccountListResult" + "$ref": "#/definitions/AutomationAccountListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -408,19 +367,10 @@ }, "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._]+$", - "description": "The resource group name." + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "$filter", @@ -430,23 +380,23 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/StatisticsListResult" + "$ref": "#/definitions/StatisticsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -472,38 +422,29 @@ }, "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._]+$", - "description": "The resource group name." + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/UsageListResult" + "$ref": "#/definitions/UsageListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -520,48 +461,408 @@ "operationId": "Keys_ListByAutomationAccount", "description": "Retrieve the automation keys for an account.", "x-ms-examples": { - "Get usages of an automation account": { + "Get lists of an automation account": { "$ref": "./examples/listAutomationAccountKeys.json" } }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/KeyListResult" + "$ref": "#/definitions/KeyListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } + } + } + } + }, + "definitions": { + "AutomationAccount": { + "properties": { + "properties": { + "$ref": "#/definitions/AutomationAccountProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the automation account properties." }, - "x-ms-pageable": { - "nextLinkName": null + "etag": { + "type": "string", + "description": "Gets or sets the etag of the resource." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Definition of the automation account type." + }, + "AutomationAccountProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU of account." + }, + "lastModifiedBy": { + "type": "string", + "description": "Gets or sets the last modified by." + }, + "state": { + "type": "string", + "readOnly": true, + "description": "Gets status of account.", + "enum": [ + "Ok", + "Unavailable", + "Suspended" + ], + "x-ms-enum": { + "name": "AutomationAccountState", + "modelAsString": true + } + }, + "creationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the creation time.", + "x-nullable": false + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the last modified time.", + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + } + }, + "description": "Definition of the account property." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the SKU name of the account.", + "enum": [ + "Free", + "Basic" + ], + "x-ms-enum": { + "name": "SkuNameEnum", + "modelAsString": true + } + }, + "family": { + "type": "string", + "description": "Gets or sets the SKU family." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the SKU capacity." + } + }, + "required": [ + "name" + ], + "description": "The account SKU." + }, + "AutomationAccountCreateOrUpdateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/AutomationAccountCreateOrUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets account create or update properties." + }, + "name": { + "type": "string", + "description": "Gets or sets name of the resource." + }, + "location": { + "type": "string", + "description": "Gets or sets the location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags attached to the resource." + } + }, + "description": "The parameters supplied to the create or update automation account operation." + }, + "AutomationAccountCreateOrUpdateProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets account SKU." + } + }, + "description": "The parameters supplied to the create or update account properties." + }, + "AutomationAccountListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AutomationAccount" + }, + "description": "Gets or sets list of accounts." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list account operation." + }, + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Automation operations supported by the Automation resource provider." + } + }, + "description": "The response model for the list of Automation operations" + }, + "Operation": { + "description": "Automation REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "properties": { + "provider": { + "description": "Service provider: Microsoft.Automation", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: Runbooks, Jobs etc.", + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + } + }, + "description": "Provider, Resource and Operation values" } } + }, + "Statistics": { + "properties": { + "counterProperty": { + "type": "string", + "readOnly": true, + "description": "Gets the property value of the statistic." + }, + "counterValue": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Gets the value of the statistic." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the startTime of the statistic.", + "x-nullable": false + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the endTime of the statistic.", + "x-nullable": true + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the id." + } + }, + "description": "Definition of the statistic." + }, + "StatisticsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Statistics" + }, + "description": "Gets or sets a list of statistics." + } + }, + "description": "The response model for the list statistics operation." + }, + "Usage": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the id of the resource." + }, + "name": { + "$ref": "#/definitions/UsageCounterName", + "description": "Gets or sets the usage counter name." + }, + "unit": { + "type": "string", + "description": "Gets or sets the usage unit name." + }, + "currentValue": { + "type": "number", + "format": "double", + "description": "Gets or sets the current usage value." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "Gets or sets max limit. -1 for unlimited" + }, + "throttleStatus": { + "type": "string", + "description": "Gets or sets the throttle status." + } + }, + "description": "Definition of Usage." + }, + "UsageCounterName": { + "properties": { + "value": { + "type": "string", + "description": "Gets or sets the usage counter name." + }, + "localizedValue": { + "type": "string", + "description": "Gets or sets the localized usage counter name." + } + }, + "description": "Definition of usage counter name." + }, + "UsageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "Gets or sets usage." + } + }, + "description": "The response model for the get usage operation." + }, + "Key": { + "properties": { + "KeyName": { + "readOnly": true, + "type": "string", + "description": "Automation key name.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "AutomationKeyName", + "modelAsString": true + } + }, + "Permissions": { + "readOnly": true, + "type": "string", + "description": "Automation key permissions.", + "enum": [ + "Read", + "Full" + ], + "x-ms-enum": { + "name": "AutomationKeyPermissions", + "modelAsString": true + } + }, + "Value": { + "readOnly": true, + "type": "string", + "description": "Value of the Automation Key used for registration." + } + }, + "description": "Automation key which is used to register a DSC Node" + }, + "KeyListResult": { + "properties": { + "keys": { + "type": "array", + "items": { + "$ref": "#/definitions/Key" + }, + "description": "Lists the automation keys." + } + } + }, + "AutomationAccountUpdateProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets account SKU." + } + }, + "description": "The parameters supplied to the update account properties." + }, + "AutomationAccountUpdateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/AutomationAccountUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets account update properties." + }, + "name": { + "type": "string", + "description": "Gets or sets the name of the resource." + }, + "location": { + "type": "string", + "description": "Gets or sets the location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags attached to the resource." + } + }, + "description": "The parameters supplied to the update automation account operation." } }, - "definitions": {}, "parameters": {} } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/certificate.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/certificate.json index 48b046e34e27..d6b63aa47b21 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/certificate.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/certificate.json @@ -53,14 +53,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "certificateName", @@ -70,10 +66,10 @@ "description": "The name of certificate." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -83,7 +79,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -104,14 +100,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "certificateName", @@ -121,23 +113,23 @@ "description": "The name of certificate." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Certificate" + "$ref": "#/definitions/Certificate" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -158,14 +150,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "certificateName", @@ -179,34 +167,34 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/CertificateCreateOrUpdateParameters" + "$ref": "#/definitions/CertificateCreateOrUpdateParameters" }, "description": "The parameters supplied to the create or update certificate operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/Certificate" + "$ref": "#/definitions/Certificate" } }, "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Certificate" + "$ref": "#/definitions/Certificate" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -227,14 +215,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "certificateName", @@ -248,28 +232,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/CertificateUpdateParameters" + "$ref": "#/definitions/CertificateUpdateParameters" }, "description": "The parameters supplied to the update certificate operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Certificate" + "$ref": "#/definitions/Certificate" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -292,33 +276,29 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/CertificateListResult" + "$ref": "#/definitions/CertificateListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -328,6 +308,145 @@ } } }, - "definitions": {}, + "definitions": { + "CertificateCreateOrUpdateProperties": { + "properties": { + "base64Value": { + "type": "string", + "description": "Gets or sets the base64 encoded value of the certificate." + }, + "description": { + "type": "string", + "description": "Gets or sets the description of the certificate." + }, + "thumbprint": { + "type": "string", + "description": "Gets or sets the thumbprint of the certificate." + }, + "isExportable": { + "type": "boolean", + "description": "Gets or sets the is exportable flag of the certificate.", + "x-nullable": false + } + }, + "required": [ + "base64Value" + ], + "description": "The properties of the create certificate operation." + }, + "CertificateCreateOrUpdateParameters": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the certificate." + }, + "properties": { + "$ref": "#/definitions/CertificateCreateOrUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the certificate." + } + }, + "required": [ + "name", + "properties" + ], + "description": "The parameters supplied to the create or update or replace certificate operation." + }, + "CertificateProperties": { + "properties": { + "thumbprint": { + "type": "string", + "readOnly": true, + "description": "Gets the thumbprint of the certificate." + }, + "expiryTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the expiry time of the certificate.", + "x-nullable": false + }, + "isExportable": { + "type": "boolean", + "readOnly": true, + "description": "Gets the is exportable flag of the certificate.", + "x-nullable": false + }, + "creationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the creation time.", + "x-nullable": false + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the last modified time.", + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + } + }, + "description": "Properties of the certificate." + }, + "Certificate": { + "properties": { + "properties": { + "$ref": "#/definitions/CertificateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the certificate." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Definition of the certificate." + }, + "CertificateListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + }, + "description": "Gets or sets a list of certificates." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list certificate operation." + }, + "CertificateUpdateProperties": { + "properties": { + "description": { + "type": "string", + "description": "Gets or sets the description of the certificate." + } + }, + "description": "The properties of the update certificate operation" + }, + "CertificateUpdateParameters": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the certificate." + }, + "properties": { + "$ref": "#/definitions/CertificateUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the certificate." + } + }, + "description": "The parameters supplied to the update certificate operation." + } + }, "parameters": {} } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/connection.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/connection.json index 0ebb3e04ea7e..c91fe8946bbb 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/connection.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/connection.json @@ -53,14 +53,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "connectionName", @@ -70,17 +66,17 @@ "description": "The name of connection." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Connection" + "$ref": "#/definitions/Connection" } }, "204": { @@ -89,7 +85,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -110,14 +106,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "connectionName", @@ -127,23 +119,23 @@ "description": "The name of connection." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Connection" + "$ref": "#/definitions/Connection" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -164,14 +156,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "connectionName", @@ -185,34 +173,34 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/ConnectionCreateOrUpdateParameters" + "$ref": "#/definitions/ConnectionCreateOrUpdateParameters" }, "description": "The parameters supplied to the create or update connection operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/Connection" + "$ref": "#/definitions/Connection" } }, "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Connection" + "$ref": "#/definitions/Connection" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -233,14 +221,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "connectionName", @@ -254,28 +238,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/ConnectionUpdateParameters" + "$ref": "#/definitions/ConnectionUpdateParameters" }, "description": "The parameters supplied to the update a connection operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Connection" + "$ref": "#/definitions/Connection" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -301,33 +285,29 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/ConnectionListResult" + "$ref": "#/definitions/ConnectionListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -337,6 +317,153 @@ } } }, - "definitions": {}, + "definitions": { + "ConnectionCreateOrUpdateProperties": { + "properties": { + "description": { + "type": "string", + "description": "Gets or sets the description of the connection." + }, + "connectionType": { + "$ref": "#/definitions/ConnectionTypeAssociationProperty", + "description": "Gets or sets the connectionType of the connection." + }, + "fieldDefinitionValues": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the field definition properties of the connection." + } + }, + "required": [ + "connectionType" + ], + "description": "The properties of the create connection properties" + }, + "ConnectionCreateOrUpdateParameters": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the connection." + }, + "properties": { + "$ref": "#/definitions/ConnectionCreateOrUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the connection." + } + }, + "required": [ + "name", + "properties" + ], + "description": "The parameters supplied to the create or update connection operation." + }, + "ConnectionProperties": { + "properties": { + "connectionType": { + "$ref": "#/definitions/ConnectionTypeAssociationProperty", + "description": "Gets or sets the connectionType of the connection." + }, + "fieldDefinitionValues": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true, + "description": "Gets the field definition values of the connection." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the creation time.", + "x-nullable": false + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the last modified time.", + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + } + }, + "description": "Definition of the connection properties." + }, + "Connection": { + "properties": { + "properties": { + "$ref": "#/definitions/ConnectionProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the connection." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Definition of the connection." + }, + "ConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Connection" + }, + "description": "Gets or sets a list of connection." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list connection operation." + }, + "ConnectionUpdateProperties": { + "properties": { + "description": { + "type": "string", + "description": "Gets or sets the description of the connection." + }, + "fieldDefinitionValues": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the field definition values of the connection." + } + }, + "description": "The properties of the update connection operation." + }, + "ConnectionUpdateParameters": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the connection." + }, + "properties": { + "$ref": "#/definitions/ConnectionUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the connection." + } + }, + "description": "The parameters supplied to the update connection operation." + }, + "ConnectionTypeAssociationProperty": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the connection type." + } + }, + "description": "The connection type property associated with the entity." + } + }, "parameters": {} } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/connectionType.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/connectionType.json index c942e4ca92ad..86ce028c111b 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/connectionType.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/connectionType.json @@ -3,7 +3,7 @@ "info": { "title": "AutomationManagement", "version": "2015-10-31", - "x-ms-code-generation-settings": { + "x-ms-code-generation-settings": { "useDateTimeOffset": true } }, @@ -53,14 +53,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "connectionTypeName", @@ -70,10 +66,10 @@ "description": "The name of connectiontype." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -86,7 +82,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -107,14 +103,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "connectionTypeName", @@ -124,23 +116,23 @@ "description": "The name of connectiontype." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/ConnectionType" + "$ref": "#/definitions/ConnectionType" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -161,14 +153,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "connectionTypeName", @@ -182,34 +170,34 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/ConnectionTypeCreateOrUpdateParameters" + "$ref": "#/definitions/ConnectionTypeCreateOrUpdateParameters" }, "description": "The parameters supplied to the create or update connectiontype operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/ConnectionType" + "$ref": "#/definitions/ConnectionType" } }, "409": { "description": "Conflict", "schema": { - "$ref": "./definitions.json#/definitions/ConnectionType" + "$ref": "#/definitions/ConnectionType" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -235,33 +223,29 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/ConnectionTypeListResult" + "$ref": "#/definitions/ConnectionTypeListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -271,6 +255,139 @@ } } }, - "definitions": {}, + "definitions": { + "FieldDefinition": { + "properties": { + "isEncrypted": { + "type": "boolean", + "description": "Gets or sets the isEncrypted flag of the connection field definition." + }, + "isOptional": { + "type": "boolean", + "description": "Gets or sets the isOptional flag of the connection field definition." + }, + "type": { + "type": "string", + "description": "Gets or sets the type of the connection field definition." + } + }, + "required": [ + "type" + ], + "description": "Definition of the connection fields." + }, + "ConnectionTypeProperties": { + "properties": { + "isGlobal": { + "type": "boolean", + "description": "Gets or sets a Boolean value to indicate if the connection type is global." + }, + "fieldDefinitions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/FieldDefinition" + }, + "readOnly": true, + "description": "Gets the field definitions of the connection type." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the creation time.", + "x-nullable": false + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last modified time.", + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + } + }, + "description": "Properties of the connection type." + }, + "ConnectionType": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the id of the resource." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the name of the connection type." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "$ref": "#/definitions/ConnectionTypeProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the connection type." + } + }, + "description": "Definition of the connection type." + }, + "ConnectionTypeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionType" + }, + "description": "Gets or sets a list of connection types." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list connection type operation." + }, + "ConnectionTypeCreateOrUpdateParameters": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the connection type." + }, + "properties": { + "$ref": "#/definitions/ConnectionTypeCreateOrUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the value of the connection type." + } + }, + "required": [ + "name", + "properties" + ], + "description": "The parameters supplied to the create or update connection type operation." + }, + "ConnectionTypeCreateOrUpdateProperties": { + "properties": { + "isGlobal": { + "type": "boolean", + "description": "Gets or sets a Boolean value to indicate if the connection type is global." + }, + "fieldDefinitions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/FieldDefinition" + }, + "description": "Gets or sets the field definitions of the connection type." + } + }, + "required": [ + "fieldDefinitions" + ], + "description": "The properties of the create connection type." + } + }, "parameters": {} -} +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/credential.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/credential.json index ebe7585730c2..48c5a28eaaf7 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/credential.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/credential.json @@ -53,14 +53,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "credentialName", @@ -70,10 +66,10 @@ "description": "The name of credential." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -83,7 +79,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -104,14 +100,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "credentialName", @@ -121,23 +113,23 @@ "description": "The name of credential." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Credential" + "$ref": "#/definitions/Credential" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -158,14 +150,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "credentialName", @@ -179,34 +167,34 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/CredentialCreateOrUpdateParameters" + "$ref": "#/definitions/CredentialCreateOrUpdateParameters" }, "description": "The parameters supplied to the create or update credential operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/Credential" + "$ref": "#/definitions/Credential" } }, "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Credential" + "$ref": "#/definitions/Credential" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -227,14 +215,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "credentialName", @@ -248,28 +232,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/CredentialUpdateParameters" + "$ref": "#/definitions/CredentialUpdateParameters" }, "description": "The parameters supplied to the Update credential operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Credential" + "$ref": "#/definitions/Credential" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -295,27 +279,23 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/CredentialListResult" + "$ref": "#/definitions/CredentialListResult" } } }, @@ -325,6 +305,136 @@ } } }, - "definitions": {}, + "definitions": { + "CredentialCreateOrUpdateProperties": { + "properties": { + "userName": { + "type": "string", + "description": "Gets or sets the user name of the credential." + }, + "password": { + "type": "string", + "description": "Gets or sets the password of the credential." + }, + "description": { + "type": "string", + "description": "Gets or sets the description of the credential." + } + }, + "required": [ + "userName", + "password" + ], + "description": "The properties of the create cerdential operation." + }, + "CredentialCreateOrUpdateParameters": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the credential." + }, + "properties": { + "$ref": "#/definitions/CredentialCreateOrUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the credential." + } + }, + "required": [ + "name", + "properties" + ], + "description": "The parameters supplied to the create or update credential operation." + }, + "CredentialProperties": { + "properties": { + "userName": { + "type": "string", + "readOnly": true, + "description": "Gets the user name of the credential." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the creation time.", + "x-nullable": false + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the last modified time.", + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + } + }, + "description": "Definition of the credential properties" + }, + "Credential": { + "properties": { + "properties": { + "$ref": "#/definitions/CredentialProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the credential." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Definition of the credential." + }, + "CredentialListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Credential" + }, + "description": "Gets or sets a list of credentials." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list credential operation." + }, + "CredentialUpdateProperties": { + "properties": { + "userName": { + "type": "string", + "description": "Gets or sets the user name of the credential." + }, + "password": { + "type": "string", + "description": "Gets or sets the password of the credential." + }, + "description": { + "type": "string", + "description": "Gets or sets the description of the credential." + } + }, + "description": "The properties of the Update credential" + }, + "CredentialUpdateParameters": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the credential." + }, + "properties": { + "$ref": "#/definitions/CredentialUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the variable." + } + }, + "description": "The parameters supplied to the Update credential operation." + } + }, "parameters": {} } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/definitions.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/definitions.json deleted file mode 100644 index f529e13db4b7..000000000000 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/definitions.json +++ /dev/null @@ -1,3843 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "AutomationManagement", - "version": "2015-10-31", - "x-ms-code-generation-settings": { - "useDateTimeOffset": true - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json", - "text/plain", - "text/powershell", - "application/graph-runbook", - "application/octet-stream" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": {}, - "definitions": { - "ActivityParameter": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the activity parameter." - }, - "type": { - "type": "string", - "description": "Gets or sets the type of the activity parameter." - }, - "isMandatory": { - "type": "boolean", - "description": "Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional." - }, - "isDynamic": { - "type": "boolean", - "description": "Gets or sets a Boolean value that indicates true if the parameter is dynamic." - }, - "position": { - "type": "boolean", - "description": "Gets or sets the position of the activity parameter." - }, - "valueFromPipeline": { - "type": "boolean", - "description": "Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object." - }, - "valueFromPipelineByPropertyName": { - "type": "boolean", - "description": "Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name. " - }, - "valueFromRemainingArguments": { - "type": "boolean", - "description": "Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values." - } - }, - "description": "Definition of the activity parameter." - }, - "ActivityParameterSet": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the activity parameter set." - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/definitions/ActivityParameter" - }, - "description": "Gets or sets the parameters of the activity parameter set." - } - }, - "description": "Definition of the activity parameter set." - }, - "ActivityOutputType": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the activity output type." - }, - "type": { - "type": "string", - "description": "Gets or sets the type of the activity output type." - } - }, - "description": "Definition of the activity output type." - }, - "ActivityProperties": { - "properties": { - "definition": { - "type": "string", - "description": "Gets or sets the user name of the activity." - }, - "parameterSets": { - "type": "array", - "items": { - "$ref": "#/definitions/ActivityParameterSet" - }, - "description": "Gets or sets the parameter sets of the activity." - }, - "outputTypes": { - "type": "array", - "items": { - "$ref": "#/definitions/ActivityOutputType" - }, - "description": "Gets or sets the output types of the activity." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the creation time.", - "x-nullable": false - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last modified time.", - "x-nullable": false - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - } - }, - "description": "Properties of the activity." - }, - "Activity": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the id of the resource." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the name of the activity." - }, - "properties": { - "$ref": "#/definitions/ActivityProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the activity." - } - }, - "description": "Definition of the activity." - }, - "ActivityListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Activity" - }, - "description": "Gets or sets a list of activities." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list activity operation." - }, - "AdvancedScheduleMonthlyOccurrence": { - "properties": { - "occurrence": { - "type": "integer", - "format": "int32", - "description": "Occurrence of the week within the month. Must be between 1 and 5" - }, - "day": { - "type": "string", - "description": "Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.", - "enum": [ - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ], - "x-ms-enum": { - "name": "ScheduleDay", - "modelAsString": true - } - } - }, - "description": "The properties of the create advanced schedule monthly occurrence." - }, - "AdvancedSchedule": { - "properties": { - "weekDays": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Days of the week that the job should execute on." - }, - "monthDays": { - "type": "array", - "items": { - "type": "integer", - "format": "int32", - "x-nullable": false - }, - "description": "Days of the month that the job should execute on. Must be between 1 and 31." - }, - "monthlyOccurrences": { - "type": "array", - "items": { - "$ref": "#/definitions/AdvancedScheduleMonthlyOccurrence" - }, - "description": "Occurrences of days within a month." - } - }, - "description": "The properties of the create Advanced Schedule." - }, - "AgentRegistrationKeys": { - "properties": { - "primary": { - "type": "string", - "description": "Gets or sets the primary key." - }, - "secondary": { - "type": "string", - "description": "Gets or sets the secondary key." - } - }, - "description": "Definition of the agent registration keys." - }, - "AgentRegistration": { - "properties": { - "dscMetaConfiguration": { - "type": "string", - "description": "Gets or sets the dsc meta configuration." - }, - "endpoint": { - "type": "string", - "description": "Gets or sets the dsc server endpoint." - }, - "keys": { - "$ref": "#/definitions/AgentRegistrationKeys", - "description": "Gets or sets the agent registration keys." - }, - "id": { - "type": "string", - "description": "Gets or sets the id." - } - }, - "description": "Definition of the agent registration infomration type." - }, - "AgentRegistrationRegenerateKeyParameter": { - "properties": { - "keyName": { - "type": "string", - "description": "Gets or sets the agent registration key name - primary or secondary.", - "enum": [ - "primary", - "secondary" - ], - "x-ms-enum": { - "name": "AgentRegistrationKeyName", - "modelAsString": true - } - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the resource." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "keyName" - ], - "description": "The parameters supplied to the regenerate keys operation." - }, - "AutomationAccountUpdateProperties": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets account SKU." - } - }, - "description": "The parameters supplied to the update account properties." - }, - "AutomationAccountProperties": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets the SKU of account." - }, - "lastModifiedBy": { - "type": "string", - "description": "Gets or sets the last modified by." - }, - "state": { - "type": "string", - "readOnly": true, - "description": "Gets status of account.", - "enum": [ - "Ok", - "Unavailable", - "Suspended" - ], - "x-ms-enum": { - "name": "AutomationAccountState", - "modelAsString": true - } - }, - "creationTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the creation time.", - "x-nullable": false - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the last modified time.", - "x-nullable": false - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - } - }, - "description": "Definition of the account property." - }, - "AutomationAccountUpdateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/AutomationAccountUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets account update properties." - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the resource." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags attached to the resource." - } - }, - "description": "The parameters supplied to the update automation account operation." - }, - "AutomationAccount": { - "properties": { - "properties": { - "$ref": "#/definitions/AutomationAccountProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the automation account properties." - }, - "etag": { - "type": "string", - "description": "Gets or sets the etag of the resource." - } - }, - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "description": "Definition of the automation account type." - }, - "AutomationAccountCreateOrUpdateProperties": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets account SKU." - } - }, - "description": "The parameters supplied to the create or update account properties." - }, - "AutomationAccountCreateOrUpdateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/AutomationAccountCreateOrUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets account create or update properties." - }, - "name": { - "type": "string", - "description": "Gets or sets name of the resource." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags attached to the resource." - } - }, - "description": "The parameters supplied to the create or update automation account operation." - }, - "AutomationAccountListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AutomationAccount" - }, - "description": "Gets or sets list of accounts." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list account operation." - }, - "CertificateCreateOrUpdateProperties": { - "properties": { - "base64Value": { - "type": "string", - "description": "Gets or sets the base64 encoded value of the certificate." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the certificate." - }, - "thumbprint": { - "type": "string", - "description": "Gets or sets the thumbprint of the certificate." - }, - "isExportable": { - "type": "boolean", - "description": "Gets or sets the is exportable flag of the certificate.", - "x-nullable": false - } - }, - "required": [ - "base64Value" - ], - "description": "The properties of the create certificate operation." - }, - "CertificateCreateOrUpdateParameters": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the certificate." - }, - "properties": { - "$ref": "#/definitions/CertificateCreateOrUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the certificate." - } - }, - "required": [ - "name", - "properties" - ], - "description": "The parameters supplied to the create or update or replace certificate operation." - }, - "CertificateProperties": { - "properties": { - "thumbprint": { - "type": "string", - "readOnly": true, - "description": "Gets the thumbprint of the certificate." - }, - "expiryTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the expiry time of the certificate.", - "x-nullable": false - }, - "isExportable": { - "type": "boolean", - "readOnly": true, - "description": "Gets the is exportable flag of the certificate.", - "x-nullable": false - }, - "creationTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the creation time.", - "x-nullable": false - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the last modified time.", - "x-nullable": false - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - } - }, - "description": "Properties of the certificate." - }, - "Certificate": { - "properties": { - "properties": { - "$ref": "#/definitions/CertificateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the certificate." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "description": "Definition of the certificate." - }, - "CertificateListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Certificate" - }, - "description": "Gets or sets a list of certificates." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list certificate operation." - }, - "CertificateUpdateProperties": { - "properties": { - "description": { - "type": "string", - "description": "Gets or sets the description of the certificate." - } - }, - "description": "The properties of the update certificate operation" - }, - "CertificateUpdateParameters": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the certificate." - }, - "properties": { - "$ref": "#/definitions/CertificateUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the certificate." - } - }, - "description": "The parameters supplied to the update certificate operation." - }, - "ConnectionCreateOrUpdateProperties": { - "properties": { - "description": { - "type": "string", - "description": "Gets or sets the description of the connection." - }, - "connectionType": { - "$ref": "#/definitions/ConnectionTypeAssociationProperty", - "description": "Gets or sets the connectionType of the connection." - }, - "fieldDefinitionValues": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the field definition properties of the connection." - } - }, - "required": [ - "connectionType" - ], - "description": "The properties of the create connection properties" - }, - "ConnectionCreateOrUpdateParameters": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the connection." - }, - "properties": { - "$ref": "#/definitions/ConnectionCreateOrUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the connection." - } - }, - "required": [ - "name", - "properties" - ], - "description": "The parameters supplied to the create or update connection operation." - }, - "ConnectionProperties": { - "properties": { - "connectionType": { - "$ref": "#/definitions/ConnectionTypeAssociationProperty", - "description": "Gets or sets the connectionType of the connection." - }, - "fieldDefinitionValues": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "readOnly": true, - "description": "Gets the field definition values of the connection." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the creation time.", - "x-nullable": false - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the last modified time.", - "x-nullable": false - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - } - }, - "description": "Definition of the connection properties." - }, - "Connection": { - "properties": { - "properties": { - "$ref": "#/definitions/ConnectionProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the connection." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "description": "Definition of the connection." - }, - "ConnectionListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Connection" - }, - "description": "Gets or sets a list of connection." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list connection operation." - }, - "ConnectionUpdateProperties": { - "properties": { - "description": { - "type": "string", - "description": "Gets or sets the description of the connection." - }, - "fieldDefinitionValues": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the field definition values of the connection." - } - }, - "description": "The properties of the update connection operation." - }, - "ConnectionUpdateParameters": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the connection." - }, - "properties": { - "$ref": "#/definitions/ConnectionUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the connection." - } - }, - "description": "The parameters supplied to the update connection operation." - }, - "ConnectionTypeAssociationProperty": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the connection type." - } - }, - "description": "The connection type property associated with the entity." - }, - "ConnectionTypeCreateOrUpdateProperties": { - "properties": { - "isGlobal": { - "type": "boolean", - "description": "Gets or sets a Boolean value to indicate if the connection type is global." - }, - "fieldDefinitions": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/FieldDefinition" - }, - "description": "Gets or sets the field definitions of the connection type." - } - }, - "required": [ - "fieldDefinitions" - ], - "description": "The properties of the create connection type." - }, - "ConnectionTypeCreateOrUpdateParameters": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the connection type." - }, - "properties": { - "$ref": "#/definitions/ConnectionTypeCreateOrUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the value of the connection type." - } - }, - "required": [ - "name", - "properties" - ], - "description": "The parameters supplied to the create or update connection type operation." - }, - "ConnectionTypeProperties": { - "properties": { - "isGlobal": { - "type": "boolean", - "description": "Gets or sets a Boolean value to indicate if the connection type is global." - }, - "fieldDefinitions": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/FieldDefinition" - }, - "readOnly": true, - "description": "Gets the field definitions of the connection type." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the creation time.", - "x-nullable": false - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last modified time.", - "x-nullable": false - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - } - }, - "description": "Properties of the connection type." - }, - "ConnectionType": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the id of the resource." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the name of the connection type." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - }, - "properties": { - "$ref": "#/definitions/ConnectionTypeProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the connection type." - } - }, - "description": "Definition of the connection type." - }, - "ConnectionTypeListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ConnectionType" - }, - "description": "Gets or sets a list of connection types." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list connection type operation." - }, - "CredentialCreateOrUpdateProperties": { - "properties": { - "userName": { - "type": "string", - "description": "Gets or sets the user name of the credential." - }, - "password": { - "type": "string", - "description": "Gets or sets the password of the credential." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the credential." - } - }, - "required": [ - "userName", - "password" - ], - "description": "The properties of the create cerdential operation." - }, - "CredentialCreateOrUpdateParameters": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the credential." - }, - "properties": { - "$ref": "#/definitions/CredentialCreateOrUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the credential." - } - }, - "required": [ - "name", - "properties" - ], - "description": "The parameters supplied to the create or update credential operation." - }, - "CredentialProperties": { - "properties": { - "userName": { - "type": "string", - "readOnly": true, - "description": "Gets the user name of the credential." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the creation time.", - "x-nullable": false - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the last modified time.", - "x-nullable": false - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - } - }, - "description": "Definition of the credential properties" - }, - "Credential": { - "properties": { - "properties": { - "$ref": "#/definitions/CredentialProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the credential." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "description": "Definition of the credential." - }, - "CredentialListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Credential" - }, - "description": "Gets or sets a list of credentials." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list credential operation." - }, - "CredentialUpdateProperties": { - "properties": { - "userName": { - "type": "string", - "description": "Gets or sets the user name of the credential." - }, - "password": { - "type": "string", - "description": "Gets or sets the password of the credential." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the credential." - } - }, - "description": "The properties of the Update credential" - }, - "CredentialUpdateParameters": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the credential." - }, - "properties": { - "$ref": "#/definitions/CredentialUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the variable." - } - }, - "description": "The parameters supplied to the Update credential operation." - }, - "ContentHash": { - "properties": { - "algorithm": { - "type": "string", - "description": "Gets or sets the content hash algorithm used to hash the content." - }, - "value": { - "type": "string", - "description": "Gets or sets expected hash value of the content." - } - }, - "required": [ - "algorithm", - "value" - ], - "description": "Definition of the runbook property type." - }, - "ContentLink": { - "properties": { - "uri": { - "type": "string", - "description": "Gets or sets the uri of the runbook content." - }, - "contentHash": { - "$ref": "#/definitions/ContentHash", - "description": "Gets or sets the hash." - }, - "version": { - "type": "string", - "description": "Gets or sets the version of the content." - } - }, - "description": "Definition of the content link." - }, - "ContentSource": { - "properties": { - "hash": { - "$ref": "#/definitions/ContentHash", - "description": "Gets or sets the hash." - }, - "type": { - "type": "string", - "description": "Gets or sets the content source type.", - "enum": [ - "embeddedContent", - "uri" - ], - "x-ms-enum": { - "name": "ContentSourceType", - "modelAsString": true - } - }, - "value": { - "type": "string", - "description": "Gets or sets the value of the content. This is based on the content source type." - }, - "version": { - "type": "string", - "description": "Gets or sets the version of the content." - } - }, - "description": "Definition of the content source." - }, - "DscCompilationJobCreateProperties": { - "properties": { - "configuration": { - "$ref": "#/definitions/DscConfigurationAssociationProperty", - "description": "Gets or sets the configuration." - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the parameters of the job." - }, - "newNodeConfigurationBuildVersionRequired": { - "type": "boolean", - "description": "If a new build version of NodeConfiguration is required." - } - }, - "required": [ - "configuration" - ], - "description": "The parameters supplied to the create compilation job operation." - }, - "DscCompilationJobCreateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/DscCompilationJobCreateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the list of compilation job properties." - }, - "name": { - "type": "string", - "description": "Gets or sets name of the resource." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "properties" - ], - "description": "The parameters supplied to the create compilation job operation." - }, - "DscCompilationJobProperties": { - "properties": { - "configuration": { - "$ref": "#/definitions/DscConfigurationAssociationProperty", - "description": "Gets or sets the configuration." - }, - "startedBy": { - "type": "string", - "readOnly": true, - "description": "Gets the compilation job started by." - }, - "jobId": { - "type": "string", - "format": "uuid", - "readOnly": true, - "description": "Gets the id of the job.", - "x-nullable": false - }, - "creationTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the creation time of the job.", - "x-nullable": false - }, - "provisioningState": { - "$ref": "#/definitions/JobProvisioningStateProperty", - "description": "The current provisioning state of the job." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." - }, - "status": { - "type": "string", - "description": "Gets or sets the status of the job.", - "enum": [ - "New", - "Activating", - "Running", - "Completed", - "Failed", - "Stopped", - "Blocked", - "Suspended", - "Disconnected", - "Suspending", - "Stopping", - "Resuming", - "Removing" - ], - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - } - }, - "statusDetails": { - "type": "string", - "description": "Gets or sets the status details of the job." - }, - "startTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the start time of the job.", - "x-nullable": true - }, - "endTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the end time of the job.", - "x-nullable": true - }, - "exception": { - "type": "string", - "readOnly": true, - "description": "Gets the exception of the job." - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the last modified time of the job.", - "x-nullable": false - }, - "lastStatusModifiedTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the last status modified time of the job.", - "x-nullable": true - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the parameters of the job." - } - }, - "description": "Definition of Dsc Compilation job properties." - }, - "DscCompilationJob": { - "properties": { - "properties": { - "$ref": "#/definitions/DscCompilationJobProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the Dsc Compilation job." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "description": "Definition of the Dsc Compilation job." - }, - "DscCompilationJobListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DscCompilationJob" - }, - "description": "Gets or sets a list of Dsc Compilation jobs." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list job operation." - }, - "DscConfigurationAssociationProperty": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the Dsc configuration." - } - }, - "description": "The Dsc configuration property associated with the entity." - }, - "DscConfigurationParameter": { - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the type of the parameter." - }, - "isMandatory": { - "type": "boolean", - "description": "Gets or sets a Boolean value to indicate whether the parameter is madatory or not." - }, - "position": { - "type": "integer", - "format": "int32", - "description": "Get or sets the position of the parameter." - }, - "defaultValue": { - "type": "string", - "description": "Gets or sets the default value of parameter." - } - }, - "description": "Definition of the configuration parameter type." - }, - "DscConfigurationProperties": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets or sets the provisioning state of the configuration.", - "enum": [ - "Succeeded" - ], - "x-ms-enum": { - "name": "DscConfigurationProvisioningState", - "modelAsString": false - } - }, - "jobCount": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the job count of the configuration." - }, - "parameters": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/DscConfigurationParameter" - }, - "description": "Gets or sets the configuration parameters." - }, - "source": { - "$ref": "#/definitions/ContentSource", - "description": "Gets or sets the source." - }, - "state": { - "type": "string", - "description": "Gets or sets the state of the configuration.", - "enum": [ - "New", - "Edit", - "Published" - ], - "x-ms-enum": { - "name": "DscConfigurationState", - "modelAsString": true - } - }, - "logVerbose": { - "type": "boolean", - "description": "Gets or sets verbose log option." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the creation time.", - "x-nullable": false - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last modified time.", - "x-nullable": false - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - } - }, - "description": "Definition of the configuration property type." - }, - "DscConfiguration": { - "type": "object", - "properties": { - "properties": { - "$ref": "#/definitions/DscConfigurationProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the configuration properties." - }, - "etag": { - "type": "string", - "description": "Gets or sets the etag of the resource." - } - }, - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "description": "Definition of the configuration type." - }, - "DscConfigurationListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DscConfiguration" - }, - "description": "Gets or sets a list of configurations." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list configuration operation." - }, - "DscConfigurationCreateOrUpdateProperties": { - "properties": { - "logVerbose": { - "type": "boolean", - "description": "Gets or sets verbose log option." - }, - "logProgress": { - "type": "boolean", - "description": "Gets or sets progress log option." - }, - "source": { - "$ref": "#/definitions/ContentSource", - "description": "Gets or sets the source." - }, - "parameters": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/DscConfigurationParameter" - }, - "description": "Gets or sets the configuration parameters." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the configuration." - } - }, - "required": [ - "source" - ], - "description": "The properties to create or update configuration." - }, - "DscConfigurationCreateOrUpdateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/DscConfigurationCreateOrUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets configuration create or update properties." - }, - "name": { - "type": "string", - "description": "Gets or sets name of the resource." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "properties" - ], - "description": "The parameters supplied to the create or update configuration operation." - }, - "DscConfigurationUpdateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/DscConfigurationCreateOrUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets configuration create or update properties." - }, - "name": { - "type": "string", - "description": "Gets or sets name of the resource." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags attached to the resource." - } - }, - "description": "The parameters supplied to the create or update configuration operation." - }, - "DscMetaConfiguration": { - "properties": { - "configurationModeFrequencyMins": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the ConfigurationModeFrequencyMins value of the meta configuration." - }, - "rebootNodeIfNeeded": { - "type": "boolean", - "description": "Gets or sets the RebootNodeIfNeeded value of the meta configuration." - }, - "configurationMode": { - "type": "string", - "description": "Gets or sets the ConfigurationMode value of the meta configuration." - }, - "actionAfterReboot": { - "type": "string", - "description": "Gets or sets the ActionAfterReboot value of the meta configuration." - }, - "certificateId": { - "type": "string", - "description": "Gets or sets the CertificateId value of the meta configuration." - }, - "refreshFrequencyMins": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the RefreshFrequencyMins value of the meta configuration." - }, - "allowModuleOverwrite": { - "type": "boolean", - "description": "Gets or sets the AllowModuleOverwrite value of the meta configuration." - } - }, - "description": "Definition of the DSC Meta Configuration." - }, - "DscNodeConfigurationCreateOrUpdateParameters": { - "properties": { - "source": { - "$ref": "#/definitions/ContentSource", - "description": "Gets or sets the source." - }, - "name": { - "type": "string", - "description": "Name of the node configuration." - }, - "configuration": { - "$ref": "#/definitions/DscConfigurationAssociationProperty", - "description": "Gets or sets the configuration of the node." - }, - "newNodeConfigurationBuildVersionRequired": { - "type": "boolean", - "description": "If a new build version of NodeConfiguration is required." - } - }, - "required": [ - "source", - "name", - "configuration" - ], - "description": "The parameters supplied to the create or update node configuration operation." - }, - "DscNodeConfigurationAssociationProperty": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the dsc nodeconfiguration." - } - }, - "description": "The dsc nodeconfiguration property associated with the entity." - }, - "DscNodeExtensionHandlerAssociationProperty": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the extension handler." - }, - "version": { - "type": "string", - "description": "Gets or sets the version of the extension handler." - } - }, - "description": "The dsc extensionHandler property associated with the node" - }, - "DscNodeUpdateParameters": { - "properties": { - "nodeId": { - "type": "string", - "description": "Gets or sets the id of the dsc node." - }, - "nodeConfiguration": { - "$ref": "#/definitions/DscNodeConfigurationAssociationProperty", - "description": "Gets or sets the configuration of the node." - } - }, - "description": "The parameters supplied to the update dsc node operation." - }, - "DscNodeReport": { - "properties": { - "endTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the end time of the node report.", - "x-nullable": true - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the lastModifiedTime of the node report.", - "x-nullable": false - }, - "startTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the start time of the node report.", - "x-nullable": true - }, - "type": { - "type": "string", - "description": "Gets or sets the type of the node report." - }, - "reportId": { - "type": "string", - "description": "Gets or sets the id of the node report." - }, - "status": { - "type": "string", - "description": "Gets or sets the status of the node report." - }, - "refreshMode": { - "type": "string", - "description": "Gets or sets the refreshMode of the node report." - }, - "rebootRequested": { - "type": "string", - "description": "Gets or sets the rebootRequested of the node report." - }, - "reportFormatVersion": { - "type": "string", - "description": "Gets or sets the reportFormatVersion of the node report." - }, - "configurationVersion": { - "type": "string", - "description": "Gets or sets the configurationVersion of the node report." - }, - "id": { - "type": "string", - "description": "Gets or sets the id." - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/DscReportError" - }, - "description": "Gets or sets the errors for the node report." - }, - "resources": { - "type": "array", - "items": { - "$ref": "#/definitions/DscReportResource" - }, - "description": "Gets or sets the resource for the node report." - }, - "metaConfiguration": { - "$ref": "#/definitions/DscMetaConfiguration", - "description": "Gets or sets the metaConfiguration of the node at the time of the report." - }, - "hostName": { - "type": "string", - "description": "Gets or sets the hostname of the node that sent the report." - }, - "iPV4Addresses": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets or sets the IPv4 address of the node that sent the report." - }, - "iPV6Addresses": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets or sets the IPv6 address of the node that sent the report." - }, - "numberOfResources": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the number of resource in the node report." - }, - "rawErrors": { - "type": "string", - "description": "Gets or sets the unparsed errors for the node report." - } - }, - "description": "Definition of the dsc node report type." - }, - "DscNodeReportListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DscNodeReport" - }, - "description": "Gets or sets a list of dsc node reports." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list dsc nodes operation." - }, - "DscReportError": { - "properties": { - "errorSource": { - "type": "string", - "description": "Gets or sets the source of the error." - }, - "resourceId": { - "type": "string", - "description": "Gets or sets the resource ID which generated the error." - }, - "errorCode": { - "type": "string", - "description": "Gets or sets the error code." - }, - "errorMessage": { - "type": "string", - "description": "Gets or sets the error message." - }, - "locale": { - "type": "string", - "description": "Gets or sets the locale of the error." - }, - "errorDetails": { - "type": "string", - "description": "Gets or sets the error details." - } - }, - "description": "Definition of the dsc node report error type." - }, - "DscReportResource": { - "properties": { - "resourceId": { - "type": "string", - "description": "Gets or sets the ID of the resource." - }, - "sourceInfo": { - "type": "string", - "description": "Gets or sets the source info of the resource." - }, - "dependsOn": { - "type": "array", - "items": { - "$ref": "#/definitions/DscReportResourceNavigation" - }, - "description": "Gets or sets the Resource Navigation values for resources the resource depends on." - }, - "moduleName": { - "type": "string", - "description": "Gets or sets the module name of the resource." - }, - "moduleVersion": { - "type": "string", - "description": "Gets or sets the module version of the resource." - }, - "resourceName": { - "type": "string", - "description": "Gets or sets the name of the resource." - }, - "error": { - "type": "string", - "description": "Gets or sets the error of the resource." - }, - "status": { - "type": "string", - "description": "Gets or sets the status of the resource." - }, - "durationInSeconds": { - "type": "number", - "format": "double", - "description": "Gets or sets the duration in seconds for the resource." - }, - "startDate": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the start date of the resource.", - "x-nullable": false - } - }, - "description": "Definition of the DSC Report Resource." - }, - "DscReportResourceNavigation": { - "properties": { - "resourceId": { - "type": "string", - "description": "Gets or sets the ID of the resource to navigate to." - } - }, - "description": "Navigation for DSC Report Resource." - }, - "ErrorResponse": { - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - }, - "description": "Error response of an operation failure" - }, - "FieldDefinition": { - "properties": { - "isEncrypted": { - "type": "boolean", - "description": "Gets or sets the isEncrypted flag of the connection field definition." - }, - "isOptional": { - "type": "boolean", - "description": "Gets or sets the isOptional flag of the connection field definition." - }, - "type": { - "type": "string", - "description": "Gets or sets the type of the connection field definition." - } - }, - "required": [ - "type" - ], - "description": "Definition of the connection fields." - }, - "HybridRunbookWorker": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the worker machine name." - }, - "ip": { - "type": "string", - "description": "Gets or sets the assigned machine IP address." - }, - "registrationTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the registration time of the worker machine.", - "x-nullable": false - } - }, - "description": "Definition of hybrid runbook worker." - }, - "HybridRunbookWorkerGroup": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the id of the resource." - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the group." - }, - "hybridRunbookWorkers": { - "type": "array", - "items": { - "$ref": "#/definitions/HybridRunbookWorker" - }, - "description": "Gets or sets the list of hybrid runbook workers." - }, - "credential": { - "$ref": "#/definitions/RunAsCredentialAssociationProperty", - "description": "Sets the credential of a worker group." - } - }, - "description": "Definition of hybrid runbook worker group." - }, - "HybridRunbookWorkerGroupsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/HybridRunbookWorkerGroup" - }, - "description": "Gets or sets a list of hybrid runbook worker groups." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list hybrid runbook worker groups." - }, - "HybridRunbookWorkerGroupUpdateParameters": { - "properties": { - "credential": { - "$ref": "#/definitions/RunAsCredentialAssociationProperty", - "description": "Sets the credential of a worker group." - } - }, - "description": "Parameters supplied to the update operation." - }, - "Job": { - "properties": { - "id": { - "type": "string", - "description": "Id of the resource." - }, - "properties": { - "$ref": "./definitions.json#/definitions/JobProperties", - "x-ms-client-flatten": true, - "description": "The properties of the job." - } - }, - "description": "Definition of the job." - }, - "JobCreateProperties": { - "properties": { - "runbook": { - "$ref": "./definitions.json#/definitions/RunbookAssociationProperty", - "description": "Gets or sets the runbook." - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the parameters of the job." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." - } - }, - "required": [ - "runbook" - ], - "description": "The parameters supplied to the create job operation." - }, - "JobCreateParameters": { - "properties": { - "properties": { - "$ref": "./definitions.json#/definitions/JobCreateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the list of job properties." - } - }, - "required": [ - "properties" - ], - "description": "The parameters supplied to the create job operation." - }, - "JobListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "./definitions.json#/definitions/Job" - }, - "description": "Gets or sets a list of jobs." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list job operation." - }, - "JobScheduleCreateProperties": { - "properties": { - "schedule": { - "$ref": "#/definitions/ScheduleAssociationProperty", - "description": "Gets or sets the schedule." - }, - "runbook": { - "$ref": "#/definitions/RunbookAssociationProperty", - "description": "Gets or sets the runbook." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the hybrid worker group that the scheduled job should run on." - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets a list of job properties." - } - }, - "required": [ - "schedule", - "runbook" - ], - "description": "The parameters supplied to the create job schedule operation." - }, - "JobScheduleCreateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/JobScheduleCreateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the list of job schedule properties." - } - }, - "required": [ - "properties" - ], - "description": "The parameters supplied to the create job schedule operation." - }, - "JobScheduleProperties": { - "properties": { - "jobScheduleId": { - "type": "string", - "description": "Gets or sets the id of job schedule." - }, - "schedule": { - "$ref": "#/definitions/ScheduleAssociationProperty", - "description": "Gets or sets the schedule." - }, - "runbook": { - "$ref": "#/definitions/RunbookAssociationProperty", - "description": "Gets or sets the runbook." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the hybrid worker group that the scheduled job should run on." - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the parameters of the job schedule." - } - }, - "description": "Definition of job schedule parameters." - }, - "JobSchedule": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the id of the resource." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the name of the variable." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - }, - "properties": { - "$ref": "#/definitions/JobScheduleProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the job schedule." - } - }, - "description": "Definition of the job schedule." - }, - "JobScheduleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/JobSchedule" - }, - "description": "Gets or sets a list of job schedules." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list job schedule operation." - }, - "JobStream": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the id of the resource." - }, - "properties": { - "$ref": "./definitions.json#/definitions/JobStreamProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the id of the job stream." - } - }, - "description": "Definition of the job stream." - }, - "JobStreamListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "./definitions.json#/definitions/JobStream" - }, - "description": "A list of job streams." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list job stream operation." - }, - "JobProperties": { - "properties": { - "runbook": { - "$ref": "./definitions.json#/definitions/RunbookAssociationProperty", - "description": "Gets or sets the runbook." - }, - "startedBy": { - "type": "string", - "description": "Gets or sets the job started by." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." - }, - "jobId": { - "type": "string", - "format": "uuid", - "description": "Gets or sets the id of the job.", - "x-nullable": false - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the creation time of the job.", - "x-nullable": false - }, - "status": { - "type": "string", - "description": "Gets or sets the status of the job.", - "enum": [ - "New", - "Activating", - "Running", - "Completed", - "Failed", - "Stopped", - "Blocked", - "Suspended", - "Disconnected", - "Suspending", - "Stopping", - "Resuming", - "Removing" - ], - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - } - }, - "statusDetails": { - "type": "string", - "description": "Gets or sets the status details of the job." - }, - "startTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the start time of the job.", - "x-nullable": true - }, - "endTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the end time of the job.", - "x-nullable": true - }, - "exception": { - "type": "string", - "description": "Gets or sets the exception of the job." - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last modified time of the job.", - "x-nullable": true - }, - "lastStatusModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last status modified time of the job.", - "x-nullable": true - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the parameters of the job." - }, - "provisioningState": { - "$ref": "#/definitions/JobProvisioningStateProperty", - "description": "The provisioning state of a resource." - } - }, - "description": "Definition of job properties." - }, - "JobStreamProperties": { - "properties": { - "jobStreamId": { - "type": "string", - "description": "Gets or sets the id of the job stream." - }, - "time": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the creation time of the job.", - "x-nullable": false - }, - "streamType": { - "type": "string", - "description": "Gets or sets the stream type.", - "enum": [ - "Progress", - "Output", - "Warning", - "Error", - "Debug", - "Verbose", - "Any" - ], - "x-ms-enum": { - "name": "JobStreamType", - "modelAsString": true - } - }, - "streamText": { - "type": "string", - "description": "Gets or sets the stream text." - }, - "summary": { - "type": "string", - "description": "Gets or sets the summary." - }, - "value": { - "type": "object", - "additionalProperties": { - "type": "object" - }, - "description": "Gets or sets the values of the job stream." - } - }, - "x-ms-client-flatten": true, - "description": "Definition of the job stream." - }, - "Key":{ - "properties": { - "keyName": { - "type": "string", - "description": "Automation key name.", - "enum": [ - "primary", - "secondary" - ], - "x-ms-enum": { - "name": "AutomationKeyName", - "modelAsString": true - } - }, - "permissions": { - "type": "string", - "description": "Automation key permissions.", - "enum": [ - "Full" - ], - "x-ms-enum": { - "name": "AutomationKeyPermissions", - "modelAsString": true - } - }, - "value": { - "type": "string", - "description": "Value of the Automation Key used for registration." - } - }, - "description": "Automation key which is used to register a DSC Node" - }, - "KeyListResult":{ - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Key" - }, - "description": "Lists the automation keys." - } - } - }, - "LinkedWorkspace": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the id of the linked workspace." - } - }, - "description": "Definition of the linked workspace." - }, - "ModuleCreateOrUpdateProperties": { - "properties": { - "contentLink": { - "$ref": "#/definitions/ContentLink", - "description": "Gets or sets the module content link." - } - }, - "required": [ - "contentLink" - ], - "description": "The parameters supplied to the create or update module properties." - }, - "ModuleCreateOrUpdateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/ModuleCreateOrUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the module create properties." - }, - "name": { - "type": "string", - "description": "Gets or sets name of the resource." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "properties" - ], - "description": "The parameters supplied to the create or update module operation." - }, - "ModuleErrorInfo": { - "properties": { - "code": { - "type": "string", - "description": "Gets or sets the error code." - }, - "message": { - "type": "string", - "description": "Gets or sets the error message." - } - }, - "description": "Definition of the module error info type." - }, - "ModuleProperties": { - "properties": { - "isGlobal": { - "type": "boolean", - "description": "Gets or sets the isGlobal flag of the module." - }, - "version": { - "type": "string", - "description": "Gets or sets the version of the module." - }, - "sizeInBytes": { - "type": "integer", - "format": "int64", - "description": "Gets or sets the size in bytes of the module." - }, - "activityCount": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the activity count of the module." - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets the provisioning state of the module.", - "enum": [ - "Created", - "Creating", - "StartingImportModuleRunbook", - "RunningImportModuleRunbook", - "ContentRetrieved", - "ContentDownloaded", - "ContentValidated", - "ConnectionTypeImported", - "ContentStored", - "ModuleDataStored", - "ActivitiesStored", - "ModuleImportRunbookComplete", - "Succeeded", - "Failed", - "Cancelled", - "Updating" - ], - "x-ms-enum": { - "name": "ModuleProvisioningState", - "modelAsString": false - } - }, - "contentLink": { - "$ref": "#/definitions/ContentLink", - "description": "Gets or sets the contentLink of the module." - }, - "error": { - "$ref": "#/definitions/ModuleErrorInfo", - "description": "Gets or sets the error info of the module." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the creation time.", - "x-nullable": false - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last modified time.", - "x-nullable": false - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - } - }, - "description": "Definition of the module property type." - }, - "Module": { - "properties": { - "properties": { - "$ref": "#/definitions/ModuleProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the module properties." - }, - "etag": { - "type": "string", - "description": "Gets or sets the etag of the resource." - } - }, - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "description": "Definition of the module type." - }, - "ModuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Module" - }, - "description": "Gets or sets a list of modules." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list module operation." - }, - "ModuleUpdateProperties": { - "properties": { - "contentLink": { - "$ref": "#/definitions/ContentLink", - "description": "Gets or sets the module content link." - } - }, - "description": "The parameters supplied to the update properties." - }, - "ModuleUpdateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/ModuleUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the module update properties." - }, - "name": { - "type": "string", - "description": "Gets or sets name of the resource." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags attached to the resource." - } - }, - "description": "The parameters supplied to the update module operation." - }, - "OperationListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "description": "List of Automation operations supported by the Automation resource provider." - } - }, - "description": "The response model for the list of Automation operations" - }, - "Operation": { - "description": "Automation REST API operation", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "properties": { - "provider": { - "description": "Service provider: Microsoft.Automation", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed: Runbooks, Jobs etc.", - "type": "string" - }, - "operation": { - "description": "Operation type: Read, write, delete, etc.", - "type": "string" - } - }, - "description": "Provider, Resource and Operation values" - } - } - }, - "Resource": { - "description": "The core properties of ARM resources", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Fully qualified resource Id for the resource" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The name of the resource" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "The type of the resource." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "The resource model definition for a ARM tracked top level resource", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags." - }, - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The Azure Region where the resource lives" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "ProxyResource": { - "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "JobProvisioningStateProperty": { - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state of the resource.", - "enum": [ - "Failed", - "Succeeded", - "Suspended", - "Processing" - ], - "x-ms-enum": { - "name": "JobProvisioningState", - "modelAsString": true - } - } - }, - "description": "The provisioning state property." - }, - "RunAsCredentialAssociationProperty": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the credential." - } - }, - "description": "Definition of runas credential to use for hybrid worker." - }, - "RunbookParameter": { - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the type of the parameter." - }, - "isMandatory": { - "type": "boolean", - "description": "Gets or sets a Boolean value to indicate whether the parameter is madatory or not." - }, - "position": { - "type": "integer", - "format": "int32", - "description": "Get or sets the position of the parameter." - }, - "defaultValue": { - "type": "string", - "description": "Gets or sets the default value of parameter." - } - }, - "description": "Definition of the runbook parameter type." - }, - "RunbookDraft": { - "properties": { - "inEdit": { - "type": "boolean", - "description": "Gets or sets whether runbook is in edit mode." - }, - "draftContentLink": { - "$ref": "#/definitions/ContentLink", - "description": "Gets or sets the draft runbook content link." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the creation time of the runbook draft.", - "x-nullable": false - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last modified time of the runbook draft.", - "x-nullable": false - }, - "parameters": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/RunbookParameter" - }, - "description": "Gets or sets the runbook draft parameters." - }, - "outputTypes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets or sets the runbook output types." - } - }, - "description": "Definition of the runbook type." - }, - "RunbookDraftUndoEditResult": { - "properties": { - "statusCode": { - "type": "string", - "enum": [ - "Continue", - "SwitchingProtocols", - "OK", - "Created", - "Accepted", - "NonAuthoritativeInformation", - "NoContent", - "ResetContent", - "PartialContent", - "MultipleChoices", - "Ambiguous", - "MovedPermanently", - "Moved", - "Found", - "Redirect", - "SeeOther", - "RedirectMethod", - "NotModified", - "UseProxy", - "Unused", - "TemporaryRedirect", - "RedirectKeepVerb", - "BadRequest", - "Unauthorized", - "PaymentRequired", - "Forbidden", - "NotFound", - "MethodNotAllowed", - "NotAcceptable", - "ProxyAuthenticationRequired", - "RequestTimeout", - "Conflict", - "Gone", - "LengthRequired", - "PreconditionFailed", - "RequestEntityTooLarge", - "RequestUriTooLong", - "UnsupportedMediaType", - "RequestedRangeNotSatisfiable", - "ExpectationFailed", - "UpgradeRequired", - "InternalServerError", - "NotImplemented", - "BadGateway", - "ServiceUnavailable", - "GatewayTimeout", - "HttpVersionNotSupported" - ], - "x-ms-enum": { - "name": "HttpStatusCode", - "modelAsString": false - } - }, - "requestId": { - "type": "string" - } - }, - "description": "The response model for the undoedit runbook operation." - }, - "RunbookCreateOrUpdateProperties": { - "properties": { - "logVerbose": { - "type": "boolean", - "description": "Gets or sets verbose log option." - }, - "logProgress": { - "type": "boolean", - "description": "Gets or sets progress log option." - }, - "runbookType": { - "type": "string", - "description": "Gets or sets the type of the runbook.", - "enum": [ - "Script", - "Graph", - "PowerShellWorkflow", - "PowerShell", - "GraphPowerShellWorkflow", - "GraphPowerShell" - ], - "x-ms-enum": { - "name": "RunbookTypeEnum", - "modelAsString": true - } - }, - "draft": { - "$ref": "#/definitions/RunbookDraft", - "description": "Gets or sets the draft runbook properties." - }, - "publishContentLink": { - "$ref": "#/definitions/ContentLink", - "description": "Gets or sets the published runbook content link." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the runbook." - }, - "logActivityTrace": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the activity-level tracing options of the runbook." - } - }, - "required": [ - "runbookType" - ], - "description": "The parameters supplied to the create or update runbook properties." - }, - "RunbookCreateOrUpdateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/RunbookCreateOrUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets runbook create or update properties." - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the resource." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags attached to the resource." - } - }, - "required": [ - "properties" - ], - "description": "The parameters supplied to the create or update runbook operation." - }, - "RunbookCreateOrUpdateDraftProperties": { - "properties": { - "logVerbose": { - "type": "boolean", - "description": "Gets or sets verbose log option." - }, - "logProgress": { - "type": "boolean", - "description": "Gets or sets progress log option." - }, - "runbookType": { - "type": "string", - "description": "Gets or sets the type of the runbook.", - "enum": [ - "Script", - "Graph", - "PowerShellWorkflow", - "PowerShell", - "GraphPowerShellWorkflow", - "GraphPowerShell" - ], - "x-ms-enum": { - "name": "RunbookTypeEnum", - "modelAsString": true - } - }, - "draft": { - "$ref": "#/definitions/RunbookDraft", - "description": "Gets or sets the draft runbook properties." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the runbook." - }, - "logActivityTrace": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the activity-level tracing options of the runbook." - } - }, - "required": [ - "runbookType", - "draft" - ], - "description": "The parameters supplied to the create or update dratft runbook properties." - }, - "RunbookCreateOrUpdateDraftParameters": { - "properties": { - "runbookContent": { - "type": "string", - "description": "Content of the Runbook." - } - }, - "x-ms-client-flatten": true, - "required": [ - "runbookContent" - ], - "description": "The parameters supplied to the create or update runbook operation." - }, - "RunbookUpdateProperties": { - "properties": { - "description": { - "type": "string", - "description": "Gets or sets the description of the runbook." - }, - "logVerbose": { - "type": "boolean", - "description": "Gets or sets verbose log option." - }, - "logProgress": { - "type": "boolean", - "description": "Gets or sets progress log option." - }, - "logActivityTrace": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the activity-level tracing options of the runbook." - } - }, - "description": "The parameters supplied to the update runbook properties." - }, - "RunbookUpdateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/RunbookUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the runbook update properties." - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the resource." - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags attached to the resource." - } - }, - "description": "The parameters supplied to the update runbook operation." - }, - "RunbookProperties": { - "properties": { - "runbookType": { - "type": "string", - "description": "Gets or sets the type of the runbook.", - "enum": [ - "Script", - "Graph", - "PowerShellWorkflow", - "PowerShell", - "GraphPowerShellWorkflow", - "GraphPowerShell" - ], - "x-ms-enum": { - "name": "RunbookTypeEnum", - "modelAsString": true - } - }, - "publishContentLink": { - "$ref": "#/definitions/ContentLink", - "description": "Gets or sets the published runbook content link." - }, - "state": { - "type": "string", - "description": "Gets or sets the state of the runbook.", - "enum": [ - "New", - "Edit", - "Published" - ], - "x-ms-enum": { - "name": "RunbookState", - "modelAsString": true - } - }, - "logVerbose": { - "type": "boolean", - "description": "Gets or sets verbose log option." - }, - "logProgress": { - "type": "boolean", - "description": "Gets or sets progress log option." - }, - "logActivityTrace": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the option to log activity trace of the runbook." - }, - "jobCount": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the job count of the runbook." - }, - "parameters": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/RunbookParameter" - }, - "description": "Gets or sets the runbook parameters." - }, - "outputTypes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets or sets the runbook output types." - }, - "draft": { - "$ref": "#/definitions/RunbookDraft", - "description": "Gets or sets the draft runbook properties." - }, - "provisioningState": { - "type": "string", - "description": "Gets or sets the provisioning state of the runbook.", - "enum": [ - "Succeeded" - ], - "x-ms-enum": { - "name": "RunbookProvisioningState", - "modelAsString": false - } - }, - "lastModifiedBy": { - "type": "string", - "description": "Gets or sets the last modified by." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the creation time.", - "x-nullable": false - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last modified time.", - "x-nullable": false - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - } - }, - "description": "Definition of the runbook property type." - }, - "Runbook": { - "properties": { - "properties": { - "$ref": "#/definitions/RunbookProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the runbook properties." - }, - "etag": { - "type": "string", - "description": "Gets or sets the etag of the resource." - } - }, - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "description": "Definition of the runbook type." - }, - "RunbookListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Runbook" - }, - "description": "Gets or sets a list of runbooks." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list runbook operation." - }, - "RunbookAssociationProperty": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the runbook." - } - }, - "description": "The runbook property associated with the entity." - }, - "scheduleFrequency": { - "type": "string", - "description": "Gets or sets the frequency of the schedule.", - "enum": [ - "OneTime", - "Day", - "Hour", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "ScheduleFrequency", - "modelAsString": true - } - }, - "ScheduleCreateOrUpdateProperties": { - "properties": { - "description": { - "type": "string", - "description": "Gets or sets the description of the schedule." - }, - "startTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the start time of the schedule.", - "x-nullable": false - }, - "expiryTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the end time of the schedule.", - "x-nullable": true - }, - "interval": { - "description": "Gets or sets the interval of the schedule." - }, - "frequency": { - "type": "string", - "$ref": "#/definitions/scheduleFrequency" - }, - "timeZone": { - "type": "string", - "description": "Gets or sets the time zone of the schedule." - }, - "advancedSchedule": { - "$ref": "#/definitions/AdvancedSchedule", - "description": "Gets or sets the AdvancedSchedule." - } - }, - "required": [ - "startTime", - "frequency" - ], - "description": "The parameters supplied to the create or update schedule operation." - }, - "ScheduleCreateOrUpdateParameters": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the schedule." - }, - "properties": { - "$ref": "#/definitions/ScheduleCreateOrUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the list of schedule properties." - } - }, - "required": [ - "name", - "properties" - ], - "description": "The parameters supplied to the create or update schedule operation." - }, - "ScheduleProperties": { - "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the start time of the schedule.", - "x-nullable": false - }, - "startTimeOffsetMinutes": { - "readOnly": true, - "type": "number", - "format": "double", - "description": "Gets the start time's offset in minutes.", - "x-nullable": false - }, - "expiryTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the end time of the schedule.", - "x-nullable": true - }, - "expiryTimeOffsetMinutes": { - "type": "number", - "format": "double", - "description": "Gets or sets the expiry time's offset in minutes.", - "x-nullable": false - }, - "isEnabled": { - "type": "boolean", - "default": false, - "description": "Gets or sets a value indicating whether this schedule is enabled." - }, - "nextRun": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the next run time of the schedule.", - "x-nullable": true - }, - "nextRunOffsetMinutes": { - "type": "number", - "format": "double", - "description": "Gets or sets the next run time's offset in minutes.", - "x-nullable": false - }, - "interval": { - "description": "Gets or sets the interval of the schedule." - }, - "frequency": { - "type": "string", - "description": "Gets or sets the frequency of the schedule.", - "enum": [ - "OneTime", - "Day", - "Hour", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "ScheduleFrequency", - "modelAsString": true - } - }, - "timeZone": { - "type": "string", - "description": "Gets or sets the time zone of the schedule." - }, - "advancedSchedule": { - "$ref": "#/definitions/AdvancedSchedule", - "description": "Gets or sets the advanced schedule." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the creation time.", - "x-nullable": false - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last modified time.", - "x-nullable": false - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - } - }, - "description": "Definition of schedule parameters." - }, - "Schedule": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the id of the resource." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets name of the schedule." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - }, - "properties": { - "$ref": "#/definitions/ScheduleProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the schedule." - } - }, - "description": "Definition of the schedule." - }, - "ScheduleUpdateProperties": { - "properties": { - "description": { - "type": "string", - "description": "Gets or sets the description of the schedule." - }, - "isEnabled": { - "type": "boolean", - "description": "Gets or sets a value indicating whether this schedule is enabled." - } - }, - "description": "The parameters supplied to the update schedule operation." - }, - "ScheduleUpdateParameters": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the schedule." - }, - "properties": { - "$ref": "#/definitions/ScheduleUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the list of schedule properties." - } - }, - "description": "The parameters supplied to the update schedule operation." - }, - "ScheduleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Schedule" - }, - "description": "Gets or sets a list of schedules." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list schedule operation." - }, - "ScheduleAssociationProperty": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the schedule." - } - }, - "description": "The schedule property associated with the entity." - }, - "Sku": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the SKU name of the account.", - "enum": [ - "Free", - "Basic" - ], - "x-ms-enum": { - "name": "SkuNameEnum", - "modelAsString": true - } - }, - "family": { - "type": "string", - "description": "Gets or sets the SKU family." - }, - "capacity": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the SKU capacity." - } - }, - "required": [ - "name" - ], - "description": "The account SKU." - }, - "Statistics": { - "properties": { - "counterProperty": { - "type": "string", - "readOnly": true, - "description": "Gets the property value of the statistic." - }, - "counterValue": { - "type": "integer", - "format": "int64", - "readOnly": true, - "description": "Gets the value of the statistic." - }, - "startTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the startTime of the statistic.", - "x-nullable": false - }, - "endTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the endTime of the statistic.", - "x-nullable": true - }, - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the id." - } - }, - "description": "Definition of the statistic." - }, - "StatisticsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Statistics" - }, - "description": "Gets or sets a list of statistics." - } - }, - "description": "The response model for the list statistics operation." - }, - "SubResource": { - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "description": "The Sub Resource definition.", - "x-ms-azure-resource": true - }, - "TestJobCreateParameters": { - "properties": { - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the parameters of the test job." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." - } - }, - "description": "The parameters supplied to the create test job operation." - }, - "TestJob": { - "x-ms-mutability": [ - "read", - "create" - ], - "properties": { - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the creation time of the test job.", - "x-nullable": false - }, - "status": { - "type": "string", - "description": "Gets or sets the status of the test job." - }, - "statusDetails": { - "type": "string", - "description": "Gets or sets the status details of the test job." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." - }, - "startTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the start time of the test job.", - "x-nullable": true - }, - "endTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the end time of the test job.", - "x-nullable": true - }, - "exception": { - "type": "string", - "description": "Gets or sets the exception of the test job." - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last modified time of the test job.", - "x-nullable": false - }, - "lastStatusModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last status modified time of the test job.", - "x-nullable": true - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the parameters of the test job." - }, - "logActivityTrace": { - "type": "integer", - "format": "int32", - "description": "The activity-level tracing options of the runbook." - } - }, - "description": "Definition of the test job." - }, - "TypeField": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the field." - }, - "type": { - "type": "string", - "description": "Gets or sets the type of the field." - } - }, - "description": "Information about a field of a type." - }, - "TypeFieldListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TypeField" - }, - "description": "Gets or sets a list of fields." - } - }, - "description": "The response model for the list fields operation." - }, - "Usage": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the id of the resource." - }, - "name": { - "$ref": "#/definitions/UsageCounterName", - "description": "Gets or sets the usage counter name." - }, - "unit": { - "type": "string", - "description": "Gets or sets the usage unit name." - }, - "currentValue": { - "type": "number", - "format": "double", - "description": "Gets or sets the current usage value." - }, - "limit": { - "type": "integer", - "format": "int64", - "description": "Gets or sets max limit. -1 for unlimited" - }, - "throttleStatus": { - "type": "string", - "description": "Gets or sets the throttle status." - } - }, - "description": "Definition of Usage." - }, - "UsageCounterName": { - "properties": { - "value": { - "type": "string", - "description": "Gets or sets the usage counter name." - }, - "localizedValue": { - "type": "string", - "description": "Gets or sets the localized usage counter name." - } - }, - "description": "Definition of usage counter name." - }, - "UsageListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Usage" - }, - "description": "Gets or sets usage." - } - }, - "description": "The response model for the get usage operation." - }, - "VariableCreateOrUpdateProperties": { - "properties": { - "value": { - "type": "string", - "description": "Gets or sets the value of the variable." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the variable." - }, - "isEncrypted": { - "type": "boolean", - "description": "Gets or sets the encrypted flag of the variable." - } - }, - "description": "The properties of the create variable operation." - }, - "VariableCreateOrUpdateParameters": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the variable." - }, - "properties": { - "$ref": "#/definitions/VariableCreateOrUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the variable." - } - }, - "required": [ - "name", - "properties" - ], - "description": "The parameters supplied to the create or update variable operation." - }, - "VariableProperties": { - "properties": { - "value": { - "type": "string", - "description": "Gets or sets the value of the variable." - }, - "isEncrypted": { - "type": "boolean", - "description": "Gets or sets the encrypted flag of the variable.", - "x-nullable": true - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the creation time.", - "x-nullable": false - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last modified time.", - "x-nullable": false - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - } - }, - "description": "Definition of the varible properties" - }, - "Variable": { - "properties": { - "properties": { - "$ref": "#/definitions/VariableProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the variable." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "description": "Definition of the varible." - }, - "VariableListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Variable" - }, - "description": "Gets or sets a list of variables." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list variables operation." - }, - "VariableUpdateProperties": { - "properties": { - "value": { - "type": "string", - "description": "Gets or sets the value of the variable." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the variable." - } - }, - "description": "The properties of the update variable" - }, - "VariableUpdateParameters": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the variable." - }, - "properties": { - "$ref": "#/definitions/VariableUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the value of the variable." - } - }, - "description": "The parameters supplied to the update variable operation." - }, - "WebhookCreateOrUpdateProperties": { - "properties": { - "isEnabled": { - "type": "boolean", - "description": "Gets or sets the value of the enabled flag of webhook." - }, - "uri": { - "type": "string", - "description": "Gets or sets the uri." - }, - "expiryTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the expiry time.", - "x-nullable": false - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the parameters of the job." - }, - "runbook": { - "$ref": "#/definitions/RunbookAssociationProperty", - "description": "Gets or sets the runbook." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the name of the hybrid worker group the webhook job will run on." - } - }, - "description": "The properties of the create webhook operation." - }, - "WebhookCreateOrUpdateParameters": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the webhook." - }, - "properties": { - "$ref": "#/definitions/WebhookCreateOrUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the properties of the webhook." - } - }, - "required": [ - "name", - "properties" - ], - "description": "The parameters supplied to the create or update webhook operation." - }, - "WebhookProperties": { - "properties": { - "isEnabled": { - "type": "boolean", - "default": false, - "description": "Gets or sets the value of the enabled flag of the webhook." - }, - "uri": { - "type": "string", - "description": "Gets or sets the webhook uri." - }, - "expiryTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the expiry time.", - "x-nullable": false - }, - "lastInvokedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last invoked time.", - "x-nullable": true - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with." - }, - "runbook": { - "$ref": "#/definitions/RunbookAssociationProperty", - "description": "Gets or sets the runbook the webhook is associated with." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the name of the hybrid worker group the webhook job will run on." - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the creation time.", - "x-nullable": false - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the last modified time.", - "x-nullable": false - }, - "description": { - "type": "string", - "description": "Gets or sets the description." - } - }, - "description": "Definition of the webhook properties" - }, - "Webhook": { - "properties": { - "properties": { - "$ref": "#/definitions/WebhookProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the webhook properties." - } - }, - "description": "Definition of the webhook type.", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "WebhookListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Webhook" - }, - "description": "Gets or sets a list of webhooks." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the next link." - } - }, - "description": "The response model for the list webhook operation." - }, - "WebhookUpdateProperties": { - "properties": { - "isEnabled": { - "type": "boolean", - "description": "Gets or sets the value of the enabled flag of webhook." - }, - "runOn": { - "type": "string", - "description": "Gets or sets the name of the hybrid worker group the webhook job will run on." - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the parameters of the job." - }, - "description": { - "type": "string", - "description": "Gets or sets the description of the webhook." - } - }, - "description": "The properties of the update webhook." - }, - "WebhookUpdateParameters": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the webhook." - }, - "properties": { - "$ref": "#/definitions/WebhookUpdateProperties", - "x-ms-client-flatten": true, - "description": "Gets or sets the value of the webhook." - } - }, - "description": "The parameters supplied to the update webhook operation." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - }, - "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." - } - } -} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscCompilationJob.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscCompilationJob.json index ed729ccda50c..9f31e4e1091a 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscCompilationJob.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscCompilationJob.json @@ -53,14 +53,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "compilationJobId", @@ -75,28 +71,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/DscCompilationJobCreateParameters" + "$ref": "#/definitions/DscCompilationJobCreateParameters" }, "description": "The parameters supplied to the create compilation job operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/DscCompilationJob" + "$ref": "#/definitions/DscCompilationJob" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -117,14 +113,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "compilationJobId", @@ -135,23 +127,23 @@ "description": "The Dsc configuration compilation job id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/DscCompilationJob" + "$ref": "#/definitions/DscCompilationJob" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -174,14 +166,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "$filter", @@ -191,23 +179,23 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/DscCompilationJobListResult" + "$ref": "#/definitions/DscCompilationJobListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -233,14 +221,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobId", @@ -251,23 +235,23 @@ "description": "The job id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/JobStreamListResult" + "$ref": "./job.json#/definitions/JobStreamListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -290,14 +274,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobId", @@ -315,29 +295,239 @@ "description": "The job stream id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/JobStream" + "$ref": "./job.json#/definitions/JobStream" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } } } }, - "definitions": {}, + "definitions": { + "DscCompilationJobCreateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/DscCompilationJobCreateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the list of compilation job properties." + }, + "name": { + "type": "string", + "description": "Gets or sets name of the resource." + }, + "location": { + "type": "string", + "description": "Gets or sets the location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags attached to the resource." + } + }, + "required": [ + "properties" + ], + "description": "The parameters supplied to the create compilation job operation." + }, + "DscConfigurationAssociationProperty": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the Dsc configuration." + } + }, + "description": "The Dsc configuration property associated with the entity." + }, + "DscCompilationJobCreateProperties": { + "properties": { + "configuration": { + "$ref": "#/definitions/DscConfigurationAssociationProperty", + "description": "Gets or sets the configuration." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the parameters of the job." + }, + "incrementNodeConfigurationBuild": { + "type": "boolean", + "description": "If a new build version of NodeConfiguration is required." + } + }, + "required": [ + "configuration" + ], + "description": "The parameters supplied to the create compilation job operation." + }, + "DscCompilationJobProperties": { + "properties": { + "configuration": { + "$ref": "#/definitions/DscConfigurationAssociationProperty", + "description": "Gets or sets the configuration." + }, + "startedBy": { + "type": "string", + "readOnly": true, + "description": "Gets the compilation job started by." + }, + "jobId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "Gets the id of the job.", + "x-nullable": false + }, + "creationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the creation time of the job.", + "x-nullable": false + }, + "provisioningState": { + "$ref": "#/definitions/JobProvisioningStateProperty", + "description": "The current provisioning state of the job." + }, + "runOn": { + "type": "string", + "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." + }, + "status": { + "type": "string", + "description": "Gets or sets the status of the job.", + "enum": [ + "New", + "Activating", + "Running", + "Completed", + "Failed", + "Stopped", + "Blocked", + "Suspended", + "Disconnected", + "Suspending", + "Stopping", + "Resuming", + "Removing" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "statusDetails": { + "type": "string", + "description": "Gets or sets the status details of the job." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the start time of the job.", + "x-nullable": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the end time of the job.", + "x-nullable": true + }, + "exception": { + "type": "string", + "readOnly": true, + "description": "Gets the exception of the job." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the last modified time of the job.", + "x-nullable": false + }, + "lastStatusModifiedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the last status modified time of the job.", + "x-nullable": true + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the parameters of the job." + } + }, + "description": "Definition of Dsc Compilation job properties." + }, + "JobProvisioningStateProperty": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the resource.", + "enum": [ + "Failed", + "Succeeded", + "Suspended", + "Processing" + ], + "x-ms-enum": { + "name": "JobProvisioningState", + "modelAsString": true + } + }, + "DscCompilationJob": { + "properties": { + "properties": { + "$ref": "#/definitions/DscCompilationJobProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the Dsc Compilation job." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Definition of the Dsc Compilation job." + }, + "DscCompilationJobListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DscCompilationJob" + }, + "description": "Gets or sets a list of Dsc Compilation jobs." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list job operation." + } + }, "parameters": {} } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscConfiguration.json index 591e51adef14..a54096f05cee 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscConfiguration.json @@ -3,7 +3,7 @@ "info": { "title": "AutomationManagement", "version": "2015-10-31", - "x-ms-code-generation-settings": { + "x-ms-code-generation-settings": { "useDateTimeOffset": true } }, @@ -55,14 +55,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "configurationName", @@ -72,10 +68,10 @@ "description": "The configuration name." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -88,7 +84,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -109,14 +105,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "configurationName", @@ -126,23 +118,23 @@ "description": "The configuration name." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/DscConfiguration" + "$ref": "#/definitions/DscConfiguration" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -163,14 +155,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "configurationName", @@ -184,34 +172,34 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/DscConfigurationCreateOrUpdateParameters" + "$ref": "#/definitions/DscConfigurationCreateOrUpdateParameters" }, "description": "The create or update parameters for configuration." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/DscConfiguration" + "$ref": "#/definitions/DscConfiguration" } }, "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/DscConfiguration" + "$ref": "#/definitions/DscConfiguration" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -232,14 +220,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "configurationName", @@ -252,28 +236,28 @@ "name": "parameters", "in": "body", "schema": { - "$ref": "./definitions.json#/definitions/DscConfigurationUpdateParameters" + "$ref": "#/definitions/DscConfigurationUpdateParameters" }, "description": "The create or update parameters for configuration." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/DscConfiguration" + "$ref": "#/definitions/DscConfiguration" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -296,14 +280,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "configurationName", @@ -313,10 +293,10 @@ "description": "The configuration name." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -329,7 +309,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -348,46 +328,336 @@ "x-ms-examples": { "Get DSC Configuration": { "$ref": "./examples/getAllDscConfigurations.json" + }, + "List Paged DSC Configurations with no filter": { + "$ref": "./examples/getPagedDscConfigurationsWithNoFilter.json" + }, + "List Paged DSC Configurations with name filter": { + "$ref": "./examples/getPagedlDscConfigurationsWithNameFilter.json" } }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, "type": "string", - "description": "The automation account name." + "description": "The filter to apply on the operation." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "The number of rows to skip." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "The the number of rows to take." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "name": "$inlinecount", + "in": "query", + "required": false, + "type": "string", + "description": "Return total rows." } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/DscConfigurationListResult" + "$ref": "#/definitions/DscConfigurationListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" - } + }, + "x-ms-odata": "#/definitions/DscConfiguration" } } }, - "definitions": {}, + "definitions": { + "ContentHash": { + "properties": { + "algorithm": { + "type": "string", + "description": "Gets or sets the content hash algorithm used to hash the content." + }, + "value": { + "type": "string", + "description": "Gets or sets expected hash value of the content." + } + }, + "required": [ + "algorithm", + "value" + ], + "description": "Definition of the runbook property type." + }, + "ContentSource": { + "properties": { + "hash": { + "$ref": "#/definitions/ContentHash", + "description": "Gets or sets the hash." + }, + "type": { + "type": "string", + "description": "Gets or sets the content source type.", + "enum": [ + "embeddedContent", + "uri" + ], + "x-ms-enum": { + "name": "ContentSourceType", + "modelAsString": true + } + }, + "value": { + "type": "string", + "description": "Gets or sets the value of the content. This is based on the content source type." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the content." + } + }, + "description": "Definition of the content source." + }, + "DscConfigurationCreateOrUpdateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/DscConfigurationCreateOrUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets configuration create or update properties." + }, + "name": { + "type": "string", + "description": "Gets or sets name of the resource." + }, + "location": { + "type": "string", + "description": "Gets or sets the location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags attached to the resource." + } + }, + "required": [ + "properties" + ], + "description": "The parameters supplied to the create or update configuration operation." + }, + "DscConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DscConfiguration" + }, + "description": "Gets or sets a list of configurations." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + }, + "totalCount": { + "type": "integer", + "description": "Gets the total number of configurations matching filter criteria." + } + }, + "description": "The response model for the list configuration operation." + }, + "DscConfigurationCreateOrUpdateProperties": { + "properties": { + "logVerbose": { + "type": "boolean", + "description": "Gets or sets verbose log option." + }, + "logProgress": { + "type": "boolean", + "description": "Gets or sets progress log option." + }, + "source": { + "$ref": "#/definitions/ContentSource", + "description": "Gets or sets the source." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DscConfigurationParameter" + }, + "description": "Gets or sets the configuration parameters." + }, + "description": { + "type": "string", + "description": "Gets or sets the description of the configuration." + } + }, + "required": [ + "source" + ], + "description": "The properties to create or update configuration." + }, + "DscConfigurationParameter": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the type of the parameter." + }, + "isMandatory": { + "type": "boolean", + "description": "Gets or sets a Boolean value to indicate whether the parameter is madatory or not." + }, + "position": { + "type": "integer", + "format": "int32", + "description": "Get or sets the position of the parameter." + }, + "defaultValue": { + "type": "string", + "description": "Gets or sets the default value of parameter." + } + }, + "description": "Definition of the configuration parameter type." + }, + "DscConfigurationUpdateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/DscConfigurationCreateOrUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets configuration create or update properties." + }, + "name": { + "type": "string", + "description": "Gets or sets name of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags attached to the resource." + } + }, + "description": "The parameters supplied to the create or update configuration operation." + }, + "DscConfigurationProperties": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets or sets the provisioning state of the configuration.", + "enum": [ + "Succeeded" + ], + "x-ms-enum": { + "name": "DscConfigurationProvisioningState", + "modelAsString": false + } + }, + "jobCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the job count of the configuration." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DscConfigurationParameter" + }, + "description": "Gets or sets the configuration parameters." + }, + "source": { + "$ref": "#/definitions/ContentSource", + "description": "Gets or sets the source." + }, + "state": { + "type": "string", + "description": "Gets or sets the state of the configuration.", + "enum": [ + "New", + "Edit", + "Published" + ], + "x-ms-enum": { + "name": "DscConfigurationState", + "modelAsString": true + } + }, + "logVerbose": { + "type": "boolean", + "description": "Gets or sets verbose log option." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the creation time.", + "x-nullable": false + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last modified time.", + "x-nullable": false + }, + "nodeConfigurationCount": { + "type": "integer", + "description": "Gets the number of compiled node configurations.", + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + } + }, + "description": "Definition of the configuration property type." + }, + "DscConfiguration": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DscConfigurationProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the configuration properties." + }, + "etag": { + "type": "string", + "description": "Gets or sets the etag of the resource." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Definition of the configuration type." + } + }, "parameters": {} } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscNode.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscNode.json index 9e444fcd66cd..c00713074db4 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscNode.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscNode.json @@ -53,33 +53,29 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/AgentRegistration" + "$ref": "#/definitions/AgentRegistration" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -102,42 +98,38 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/AgentRegistrationRegenerateKeyParameter" + "$ref": "#/definitions/AgentRegistrationRegenerateKeyParameter" }, "description": "The name of the agent registration key to be regenerated" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/AgentRegistration" + "$ref": "#/definitions/AgentRegistration" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -160,14 +152,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "Automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeId", @@ -177,10 +165,10 @@ "description": "The node id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -193,7 +181,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -214,14 +202,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeId", @@ -231,10 +215,10 @@ "description": "The node id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -247,7 +231,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -268,14 +252,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeId", @@ -289,15 +269,15 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/DscNodeUpdateParameters" + "$ref": "#/definitions/DscNodeUpdateParameters" }, "description": "Parameters supplied to the update dsc node." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -310,7 +290,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -333,14 +313,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "$filter", @@ -350,10 +326,10 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -366,7 +342,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -392,14 +368,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeId", @@ -416,23 +388,23 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/DscNodeReportListResult" + "$ref": "#/definitions/DscNodeReportListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -458,14 +430,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeId", @@ -482,23 +450,23 @@ "description": "The report id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/DscNodeReport" + "$ref": "#/definitions/DscNodeReport" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -521,14 +489,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeId", @@ -545,10 +509,10 @@ "description": "The report id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -561,7 +525,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -569,6 +533,338 @@ } }, "definitions": { + "AgentRegistrationRegenerateKeyParameter": { + "properties": { + "keyName": { + "type": "string", + "description": "Gets or sets the agent registration key name - primary or secondary.", + "enum": [ + "primary", + "secondary" + ], + "x-ms-enum": { + "name": "AgentRegistrationKeyName", + "modelAsString": true + } + }, + "name": { + "type": "string", + "description": "Gets or sets the name of the resource." + }, + "location": { + "type": "string", + "description": "Gets or sets the location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags attached to the resource." + } + }, + "required": [ + "keyName" + ], + "description": "The parameters supplied to the regenerate keys operation." + }, + "AgentRegistrationKeys": { + "properties": { + "primary": { + "type": "string", + "description": "Gets or sets the primary key." + }, + "secondary": { + "type": "string", + "description": "Gets or sets the secondary key." + } + }, + "description": "Definition of the agent registration keys." + }, + "DscNodeUpdateParameters": { + "properties": { + "nodeId": { + "type": "string", + "description": "Gets or sets the id of the dsc node." + }, + "nodeConfiguration": { + "$ref": "#/definitions/DscNodeConfigurationAssociationProperty", + "description": "Gets or sets the configuration of the node." + } + }, + "description": "The parameters supplied to the update dsc node operation." + }, + + "DscNodeConfigurationAssociationProperty": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the dsc nodeconfiguration." + } + }, + "description": "The dsc nodeconfiguration property associated with the entity." + }, + "DscNodeReportListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DscNodeReport" + }, + "description": "Gets or sets a list of dsc node reports." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list dsc nodes operation." + }, + "DscNodeReport": { + "properties": { + "endTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time of the node report.", + "x-nullable": true + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the lastModifiedTime of the node report.", + "x-nullable": false + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time of the node report.", + "x-nullable": true + }, + "type": { + "type": "string", + "description": "Gets or sets the type of the node report." + }, + "reportId": { + "type": "string", + "description": "Gets or sets the id of the node report." + }, + "status": { + "type": "string", + "description": "Gets or sets the status of the node report." + }, + "refreshMode": { + "type": "string", + "description": "Gets or sets the refreshMode of the node report." + }, + "rebootRequested": { + "type": "string", + "description": "Gets or sets the rebootRequested of the node report." + }, + "reportFormatVersion": { + "type": "string", + "description": "Gets or sets the reportFormatVersion of the node report." + }, + "configurationVersion": { + "type": "string", + "description": "Gets or sets the configurationVersion of the node report." + }, + "id": { + "type": "string", + "description": "Gets or sets the id." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/DscReportError" + }, + "description": "Gets or sets the errors for the node report." + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/DscReportResource" + }, + "description": "Gets or sets the resource for the node report." + }, + "metaConfiguration": { + "$ref": "#/definitions/DscMetaConfiguration", + "description": "Gets or sets the metaConfiguration of the node at the time of the report." + }, + "hostName": { + "type": "string", + "description": "Gets or sets the hostname of the node that sent the report." + }, + "iPV4Addresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the IPv4 address of the node that sent the report." + }, + "iPV6Addresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the IPv6 address of the node that sent the report." + }, + "numberOfResources": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of resource in the node report." + }, + "rawErrors": { + "type": "string", + "description": "Gets or sets the unparsed errors for the node report." + } + }, + "description": "Definition of the dsc node report type." + }, + "DscReportResourceNavigation": { + "properties": { + "resourceId": { + "type": "string", + "description": "Gets or sets the ID of the resource to navigate to." + } + }, + "description": "Navigation for DSC Report Resource." + }, + "DscReportError": { + "properties": { + "errorSource": { + "type": "string", + "description": "Gets or sets the source of the error." + }, + "resourceId": { + "type": "string", + "description": "Gets or sets the resource ID which generated the error." + }, + "errorCode": { + "type": "string", + "description": "Gets or sets the error code." + }, + "errorMessage": { + "type": "string", + "description": "Gets or sets the error message." + }, + "locale": { + "type": "string", + "description": "Gets or sets the locale of the error." + }, + "errorDetails": { + "type": "string", + "description": "Gets or sets the error details." + } + }, + "description": "Definition of the dsc node report error type." + }, + "DscReportResource": { + "properties": { + "resourceId": { + "type": "string", + "description": "Gets or sets the ID of the resource." + }, + "sourceInfo": { + "type": "string", + "description": "Gets or sets the source info of the resource." + }, + "dependsOn": { + "type": "array", + "items": { + "$ref": "#/definitions/DscReportResourceNavigation" + }, + "description": "Gets or sets the Resource Navigation values for resources the resource depends on." + }, + "moduleName": { + "type": "string", + "description": "Gets or sets the module name of the resource." + }, + "moduleVersion": { + "type": "string", + "description": "Gets or sets the module version of the resource." + }, + "resourceName": { + "type": "string", + "description": "Gets or sets the name of the resource." + }, + "error": { + "type": "string", + "description": "Gets or sets the error of the resource." + }, + "status": { + "type": "string", + "description": "Gets or sets the status of the resource." + }, + "durationInSeconds": { + "type": "number", + "format": "double", + "description": "Gets or sets the duration in seconds for the resource." + }, + "startDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start date of the resource.", + "x-nullable": false + } + }, + "description": "Definition of the DSC Report Resource." + }, + "DscMetaConfiguration": { + "properties": { + "configurationModeFrequencyMins": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the ConfigurationModeFrequencyMins value of the meta configuration." + }, + "rebootNodeIfNeeded": { + "type": "boolean", + "description": "Gets or sets the RebootNodeIfNeeded value of the meta configuration." + }, + "configurationMode": { + "type": "string", + "description": "Gets or sets the ConfigurationMode value of the meta configuration." + }, + "actionAfterReboot": { + "type": "string", + "description": "Gets or sets the ActionAfterReboot value of the meta configuration." + }, + "certificateId": { + "type": "string", + "description": "Gets or sets the CertificateId value of the meta configuration." + }, + "refreshFrequencyMins": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the RefreshFrequencyMins value of the meta configuration." + }, + "allowModuleOverwrite": { + "type": "boolean", + "description": "Gets or sets the AllowModuleOverwrite value of the meta configuration." + } + }, + "description": "Definition of the DSC Meta Configuration." + }, + "AgentRegistration": { + "properties": { + "dscMetaConfiguration": { + "type": "string", + "description": "Gets or sets the dsc meta configuration." + }, + "endpoint": { + "type": "string", + "description": "Gets or sets the dsc server endpoint." + }, + "keys": { + "$ref": "#/definitions/AgentRegistrationKeys", + "description": "Gets or sets the agent registration keys." + }, + "id": { + "type": "string", + "description": "Gets or sets the id." + } + }, + "description": "Definition of the agent registration infomration type." + }, "DscNode": { "properties": { "lastSeen": { @@ -592,7 +888,7 @@ "description": "Gets or sets the account id of the node." }, "nodeConfiguration": { - "$ref": "./definitions.json#/definitions/DscNodeConfigurationAssociationProperty", + "$ref": "#/definitions/DscNodeConfigurationAssociationProperty", "description": "Gets or sets the configuration of the node." }, "status": { @@ -611,17 +907,30 @@ "type": "array", "description": "Gets or sets the list of extensionHandler properties for a Node.", "items": { - "$ref": "./definitions.json#/definitions/DscNodeExtensionHandlerAssociationProperty" + "$ref": "#/definitions/DscNodeExtensionHandlerAssociationProperty" } } }, "allOf": [ { - "$ref": "./definitions.json#/definitions/ProxyResource" + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" } ], "description": "Definition of the dsc node type." }, + "DscNodeExtensionHandlerAssociationProperty": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the extension handler." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the extension handler." + } + }, + "description": "The dsc extensionHandler property associated with the node" + }, "DscNodeListResult": { "properties": { "value": { @@ -637,6 +946,15 @@ } }, "description": "The response model for the list dsc nodes operation." + }, + "DscConfigurationAssociationProperty": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the Dsc configuration." + } + }, + "description": "The Dsc configuration property associated with the entity." } }, "parameters": {} diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscNodeConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscNodeConfiguration.json index 3fb7502d0b2c..675d958d7154 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscNodeConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscNodeConfiguration.json @@ -53,14 +53,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeConfigurationName", @@ -70,10 +66,10 @@ "description": "The Dsc node configuration name." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -83,7 +79,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -104,14 +100,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeConfigurationName", @@ -121,10 +113,10 @@ "description": "The Dsc node configuration name." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -137,7 +129,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -158,14 +150,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeConfigurationName", @@ -179,15 +167,15 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/DscNodeConfigurationCreateOrUpdateParameters" + "$ref": "#/definitions/DscNodeConfigurationCreateOrUpdateParameters" }, "description": "The create or update parameters for configuration." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -200,7 +188,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -223,14 +211,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "$filter", @@ -240,10 +224,10 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -256,7 +240,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -282,17 +266,89 @@ "x-nullable": false }, "configuration": { - "$ref": "./definitions.json#/definitions/DscConfigurationAssociationProperty", + "$ref": "#/definitions/DscConfigurationAssociationProperty", "description": "Gets or sets the configuration of the node." } }, "allOf": [ { - "$ref": "./definitions.json#/definitions/ProxyResource" + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" } ], "description": "Definition of the dsc node configuration." }, + "ContentSource": { + "properties": { + "hash": { + "$ref": "#/definitions/ContentHash", + "description": "Gets or sets the hash." + }, + "type": { + "type": "string", + "description": "Gets or sets the content source type.", + "enum": [ + "embeddedContent", + "uri" + ], + "x-ms-enum": { + "name": "ContentSourceType", + "modelAsString": true + } + }, + "value": { + "type": "string", + "description": "Gets or sets the value of the content. This is based on the content source type." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the content." + } + }, + "description": "Definition of the content source." + }, + "ContentHash": { + "properties": { + "algorithm": { + "type": "string", + "description": "Gets or sets the content hash algorithm used to hash the content." + }, + "value": { + "type": "string", + "description": "Gets or sets expected hash value of the content." + } + }, + "required": [ + "algorithm", + "value" + ], + "description": "Definition of the runbook property type." + }, + "DscNodeConfigurationCreateOrUpdateParameters": { + "properties": { + "source": { + "$ref": "#/definitions/ContentSource", + "description": "Gets or sets the source." + }, + "name": { + "type": "string", + "description": "Name of the node configuration." + }, + "configuration": { + "$ref": "#/definitions/DscConfigurationAssociationProperty", + "description": "Gets or sets the configuration of the node." + }, + "incrementNodeConfigurationBuild": { + "type": "boolean", + "description": "If a new build version of NodeConfiguration is required." + } + }, + "required": [ + "source", + "name", + "configuration" + ], + "description": "The parameters supplied to the create or update node configuration operation." + }, "DscNodeConfigurationListResult": { "properties": { "value": { @@ -308,6 +364,15 @@ } }, "description": "The response model for the list job operation." + }, + "DscConfigurationAssociationProperty": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the Dsc configuration." + } + }, + "description": "The Dsc configuration property associated with the entity." } }, "parameters": {} diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createJob.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createJob.json index 44e5e3948899..af6e3b0dccdd 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createJob.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createJob.json @@ -14,12 +14,6 @@ "tag01": "value01", "tag02": "value02" } - }, - "name": "TestRunbook", - "location": "East US 2", - "tags": { - "jobTags01": "jobTagsValue01", - "jobTags02": "value02" } } }, diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateDscNodeConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateDscNodeConfiguration.json index f44418b4ec69..e5e0be31ef97 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateDscNodeConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateDscNodeConfiguration.json @@ -16,7 +16,7 @@ "value": "\r\ninstance of MSFT_RoleResource as $MSFT_RoleResource1ref\r\n{\r\nResourceID = \"[WindowsFeature]IIS\";\r\n Ensure = \"Present\";\r\n SourceInfo = \"::3::32::WindowsFeature\";\r\n Name = \"Web-Server\";\r\n ModuleName = \"PsDesiredStateConfiguration\";\r\n\r\nModuleVersion = \"1.0\";\r\r\n ConfigurationName = \"configName\";\r\r\n};\r\ninstance of OMI_ConfigurationDocument\r\n\r\r\n {\r\n Version=\"2.0.0\";\r\n \r\r\n MinimumCompatibleVersion = \"1.0.0\";\r\n \r\r\n CompatibleVersionAdditionalProperties= {\"Omi_BaseResource:ConfigurationName\"};\r\n \r\r\n Author=\"weijiel\";\r\n \r\r\n GenerationDate=\"03/30/2017 13:40:25\";\r\n \r\r\n GenerationHost=\"TEST-BACKEND\";\r\n \r\r\n Name=\"configName\";\r\n\r\r\n };\r\n", "version": "1.0" }, - "newNodeConfigurationBuildVersionRequired": true, + "incrementNodeConfigurationBuild": true, "name": "configName.nodeConfigName", "configuration": { "name": "configName" diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateModule.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateModule.json index 5206e85304bd..ca45683fed14 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateModule.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateModule.json @@ -39,7 +39,8 @@ "code": null, "message": null }, - "provisioningState": "Creating" + "provisioningState": "Creating", + "isComposite": false } } }, @@ -63,7 +64,8 @@ "code": null, "message": null }, - "provisioningState": "Creating" + "provisioningState": "Creating", + "isComposite": false } } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateSchedule.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateSchedule.json index 78a9ff0b5d44..680bc81d56fb 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateSchedule.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateSchedule.json @@ -36,8 +36,29 @@ "frequency": "Hour", "creationTime": "2017-03-27T16:59:22.697+00:00", "lastModifiedTime": "2017-03-27T16:59:22.697+00:00", - "timeZone": "UTC", - "advancedSchedule": null + "timeZone": "UTC" + } + } + }, + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/schedules/mySchedule", + "name": "mySchedule", + "properties": { + "description": "my description of schedule goes here", + "startTime": "2017-03-27T17:28:00+00:00", + "startTimeOffsetMinutes": 0.0, + "expiryTime": "2017-04-01T17:28:00+00:00", + "expiryTimeOffsetMinutes": 0.0, + "isEnabled": true, + "nextRun": "2017-03-27T17:28:00+00:00", + "nextRunOffsetMinutes": 0.0, + "interval": 1, + "frequency": "Hour", + "creationTime": "2017-03-27T16:59:22.697+00:00", + "lastModifiedTime": "2017-03-27T16:59:22.697+00:00", + "timeZone": "UTC" } } }, diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateWatcher.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateWatcher.json new file mode 100644 index 000000000000..26955c7e9986 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/createOrUpdateWatcher.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "MyTestAutomationAccount", + "watcherName": "MyTestWatcher", + "api-version": "2015-10-31", + "parameters": { + "name":"MyTestWatcher", + "type":null, + "location":null, + "tags":{ }, + "etag":null, + "properties":{ + "executionFrequencyInSeconds":60, + "scriptName":"MyTestWatcherRunbook", + "scriptParameters":null, + "description":"This is a test watcher.", + "scriptRunOn":"MyTestHybridWorkerGroup", + "creationTime":"2016-11-01T04:22:47.7333333-07:00", + "lastModifiedBy":null, + "lastModifiedTime":"2016-11-01T04:22:47.7333333-07:00" + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "id":"/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyTestAutomationAccount/watchers/MyTestWatcher", + "name":"MyTestWatcher", + "type":null, + "location":null, + "tags":{ }, + "etag":null, + "properties":{ + "executionFrequencyInSeconds":60, + "scriptName":"MyTestWatcherRunbook", + "scriptParameters":null, + "description":"This is a test watcher.", + "status":"New", + "scriptRunOn":"MyTestHybridWorkerGroup", + "creationTime":"2018-05-14T21:14:09.607+00:00", + "lastModifiedBy":null, + "lastModifiedTime":"2018-05-14T21:14:09.607+00:00" + } + } + }, + "200": { + "headers": {}, + "body": { + "id":"/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyTestAutomationAccount/watchers/MyTestWatcher", + "name":"MyTestWatcher", + "type":null, + "location":null, + "tags":{ }, + "etag":null, + "properties":{ + "executionFrequencyInSeconds":60, + "scriptName":"MyTestWatcherRunbook", + "scriptParameters":null, + "description":"This is a test watcher.", + "status":"New", + "scriptRunOn":"MyTestHybridWorkerGroup", + "creationTime":"2018-05-14T21:14:09.607+00:00", + "lastModifiedBy":null, + "lastModifiedTime":"2018-05-14T21:14:09.607+00:00" + } + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/deleteCredentialExisting.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/deleteCredentialExisting.json index a472a99a7e2f..fce2d60f8941 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/deleteCredentialExisting.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/deleteCredentialExisting.json @@ -3,7 +3,7 @@ "subscriptionId": "subid", "resourceGroupName": "rg", "automationAccountName": "myAutomationAccount20", - "nodeConfigurationName": "SetupServer.localhost", + "credentialName": "myCredential", "api-version": "2015-10-31" }, "responses": { diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/deleteSchedule.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/deleteSchedule.json index e9905656e5a0..c4074436a301 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/deleteSchedule.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/deleteSchedule.json @@ -7,7 +7,6 @@ "api-version": "2015-10-31" }, "responses": { - "200": {}, - "404": {} + "200": {} } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/deleteWatcher.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/deleteWatcher.json new file mode 100644 index 000000000000..0c510b2bc574 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/deleteWatcher.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "MyTestAutomationAccount", + "watcherName": "MyTestWatcher", + "api-version": "2015-10-31" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getActivityInAModule.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getActivityInAModule.json index f4e09b2f842d..0c81f3c2c539 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getActivityInAModule.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getActivityInAModule.json @@ -28,7 +28,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "AccountId", @@ -38,7 +40,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "ApplicationId", @@ -48,7 +52,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "CertificateThumbprint", @@ -58,7 +64,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "Credential", @@ -68,7 +76,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "Environment", @@ -78,7 +88,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "EnvironmentName", @@ -88,7 +100,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "SubscriptionId", @@ -98,7 +112,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": true, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "TenantId", @@ -108,7 +124,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] } ] }, @@ -123,7 +141,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "Environment", @@ -133,7 +153,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "EnvironmentName", @@ -143,7 +165,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "ServicePrincipal", @@ -153,7 +177,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "SubscriptionId", @@ -163,7 +189,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": true, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "SubscriptionName", @@ -173,7 +201,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": true, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "TenantId", @@ -183,7 +213,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] } ] }, @@ -198,7 +230,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "AccountId", @@ -208,7 +242,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "ApplicationId", @@ -218,7 +254,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "CertificateThumbprint", @@ -228,7 +266,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "Credential", @@ -238,7 +278,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "Environment", @@ -248,7 +290,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "EnvironmentName", @@ -258,7 +302,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "SubscriptionName", @@ -268,7 +314,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": true, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "TenantId", @@ -278,7 +326,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] } ] }, @@ -293,7 +343,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "Environment", @@ -303,7 +355,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "EnvironmentName", @@ -313,7 +367,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "TenantId", @@ -323,7 +379,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] } ] }, @@ -338,7 +396,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "AccountId", @@ -348,7 +408,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "Environment", @@ -358,7 +420,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "EnvironmentName", @@ -368,7 +432,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "TenantId", @@ -378,7 +444,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] } ] }, @@ -393,7 +461,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "CertificateThumbprint", @@ -403,7 +473,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "Environment", @@ -413,7 +485,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "EnvironmentName", @@ -423,7 +497,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "ServicePrincipal", @@ -433,7 +509,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] }, { "name": "TenantId", @@ -443,7 +521,9 @@ "position": -2147483648, "valueFromPipeline": false, "valueFromPipelineByPropertyName": false, - "valueFromRemainingArguments": false + "valueFromRemainingArguments": false, + "description": "Specify the feature description", + "validationSet": [] } ] } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getModule.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getModule.json index ab440423c835..4fc63ebeeb68 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getModule.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getModule.json @@ -27,7 +27,8 @@ "code": null, "message": "" }, - "provisioningState": "Creating" + "provisioningState": "Creating", + "isComposite": true } } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getPagedDscConfigurationsWithNoFilter.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getPagedDscConfigurationsWithNoFilter.json new file mode 100644 index 000000000000..d29706d11cfa --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getPagedDscConfigurationsWithNoFilter.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "api-version": "2015-10-31", + "$skip": 0, + "$top": 3, + "$inlinecount": "allpages" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/SqlServerBig", + "location": "East US 2", + "name": "SqlServerBig", + "type": "Microsoft.Automation/AutomationAccounts/Configurations", + "properties": { + "state": "Published", + "creationTime": "2017-03-28T18:53:24.997+00:00", + "lastModifiedTime": "2017-03-28T18:53:24.997+00:00", + "nodeConfigurationCount": 1 + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/SqlServerLittle", + "location": "East US 2", + "name": "SqlServerLittle", + "type": "Microsoft.Automation/AutomationAccounts/Configurations", + "properties": { + "state": "Published", + "creationTime": "2017-03-28T18:53:24.997+00:00", + "lastModifiedTime": "2017-03-28T18:53:24.997+00:00", + "nodeConfigurationCount": 1 + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/SetupServer", + "location": "East US 2", + "name": "SetupServer", + "type": "Microsoft.Automation/AutomationAccounts/Configurations", + "properties": { + "state": "Published", + "creationTime": "2017-03-28T18:53:24.997+00:00", + "lastModifiedTime": "2017-03-28T18:53:24.997+00:00", + "nodeConfigurationCount": 1 + } + } + ], + "totalCount": 12 + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getPagedlDscConfigurationsWithNameFilter.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getPagedlDscConfigurationsWithNameFilter.json new file mode 100644 index 000000000000..b439d5b5cd55 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getPagedlDscConfigurationsWithNameFilter.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "api-version": "2015-10-31", + "$skip": 0, + "$top": 2, + "$inlinecount": "allpages", + "$filter": "contains(name,'server')" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/SqlServerBig", + "location": "East US 2", + "name": "SqlServerBig", + "type": "Microsoft.Automation/AutomationAccounts/Configurations", + "properties": { + "state": "Published", + "creationTime": "2017-03-28T18:53:24.997+00:00", + "lastModifiedTime": "2017-03-28T18:53:24.997+00:00", + "nodeConfigurationCount": 1 + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/SqlServerLittle", + "location": "East US 2", + "name": "SqlServerLittle", + "type": "Microsoft.Automation/AutomationAccounts/Configurations", + "properties": { + "state": "Published", + "creationTime": "2017-03-28T18:53:24.997+00:00", + "lastModifiedTime": "2017-03-28T18:53:24.997+00:00", + "nodeConfigurationCount": 1 + } + } + ], + "totalCount": 4 + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getSchedule.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getSchedule.json index a7e9188d74c6..191825a0b741 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getSchedule.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getSchedule.json @@ -25,8 +25,7 @@ "frequency": "Hour", "creationTime": "2017-03-27T16:59:22.697+00:00", "lastModifiedTime": "2017-03-27T16:59:22.697+00:00", - "timeZone": "UTC", - "advancedSchedule": null + "timeZone": "UTC" } } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getWatcher.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getWatcher.json new file mode 100644 index 000000000000..c5bbbc7a0e99 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/getWatcher.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "MyTestAutomationAccount", + "watcherName": "MyTestWatcher", + "api-version": "2015-10-31" + }, + "responses":{ + "200": { + "headers": {}, + "body": { + "id":"/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyTestAutomationAccount/watchers/MyTestWatcher", + "name":"MyTestWatcher", + "type":null, + "location":null, + "tags":{ }, + "etag":null, + "properties":{ + "executionFrequencyInSeconds":60, + "scriptName":"MyTestWatcherRunbook", + "scriptParameters":{ }, + "description":"", + "status":"Running", + "scriptRunOn":"MyTestHybridWorkerGroup", + "creationTime":"2017-11-30T18:50:17.163+00:00", + "lastModifiedBy":null, + "lastModifiedTime":"2017-11-30T18:50:17.163+00:00" + } + } + } + } +} diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listWatchersByAutomationAccount.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listWatchersByAutomationAccount.json new file mode 100644 index 000000000000..09c9d19cfae5 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listWatchersByAutomationAccount.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "MyTestAutomationAccount", + "api-version": "2015-10-31" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyTestAutomationAccount/watchers/MyTestWatcher", + "name":"MyTestWatcher", + "properties":{ + "executionFrequencyInSeconds":60, + "scriptName":"MyTestWatcher", + "scriptParameters":null, + "description":"This is a test watcher.", + "status":null, + "scriptRunOn":"MyTestHybridWorkerGroup", + "creationTime":"2016-12-20T21:36:48.597+00:00", + "lastModifiedBy":null, + "lastModifiedTime":"2016-12-20T21:36:48.597+00:00" + } + }, + { + "id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyTestAutomationAccount/watchers/MyTestWatcher01", + "name":"MyTestWatcher01", + "properties":{ + "executionFrequencyInSeconds":60, + "scriptName":"MyTestWatcher", + "scriptParameters":null, + "description":"This is a test watcher.", + "status":null, + "scriptRunOn":"MyTestHybridWorkerGroup", + "creationTime":"2016-12-20T20:47:24.697+00:00", + "lastModifiedBy":null, + "lastModifiedTime":"2016-12-20T20:47:24.697+00:00" + } + }, + { + "id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyTestAutomationAccount/watchers/MyTestWatcher02", + "name":"MyTestWatcher02", + "properties":{ + "executionFrequencyInSeconds":60, + "scriptName":"MyTestWatcher", + "scriptParameters":null, + "description":"This is a test watcher.", + "status":null, + "scriptRunOn":"MyTestHybridWorkerGroup", + "creationTime":"2016-12-20T21:26:35.647+00:00", + "lastModifiedBy":null, + "lastModifiedTime":"2016-12-20T21:26:35.647+00:00" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/startWatcher.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/startWatcher.json new file mode 100644 index 000000000000..0c510b2bc574 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/startWatcher.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "MyTestAutomationAccount", + "watcherName": "MyTestWatcher", + "api-version": "2015-10-31" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/stopWatcher.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/stopWatcher.json new file mode 100644 index 000000000000..b59357966da8 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/stopWatcher.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "MyTestAutomationAccount", + "watcherName": "MyTestWatcher", + "api-version": "2018-01-15" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateModule.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateModule.json index b46a459d1792..0dc642463be0 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateModule.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateModule.json @@ -39,7 +39,8 @@ "code": null, "message": null }, - "provisioningState": "Creating" + "provisioningState": "Creating", + "isComposite": false } } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateSchedule.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateSchedule.json index 5f5d1317ee6b..b6e2361715ed 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateSchedule.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateSchedule.json @@ -32,8 +32,7 @@ "frequency": "Hour", "creationTime": "2017-03-27T16:59:22.697+00:00", "lastModifiedTime": "2017-03-27T16:59:22.697+00:00", - "timeZone": "UTC", - "advancedSchedule": null + "timeZone": "UTC" } } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateWatcher.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateWatcher.json new file mode 100644 index 000000000000..85604e0a7eff --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/updateWatcher.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "MyTestAutomationAccount", + "watcherName": "MyTestWatcher", + "parameters": { + "name":"MyTestWatcher", + "properties":{ + "executionFrequencyInSeconds":600 + } + }, + "api-version": "2015-10-31" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id":"/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyTestAutomationAccount/watchers/MyTestWatcher", + "name":"MyTestWatcher", + "type":null, + "location":null, + "tags":{}, + "etag":null, + "properties":{ + "executionFrequencyInSeconds":600, + "scriptName":"MyTestWatcherRunbook", + "scriptParameters":{}, + "description":"This is a test watcher.", + "status":"New", + "scriptRunOn":"MyTestHybridWorkerGroup", + "creationTime":"2018-05-14T21:33:02.197+00:00", + "lastModifiedBy":null, + "lastModifiedTime":"2018-05-14T22:29:57.65+00:00" + } + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json index 4b517a3aee80..258cff1dad94 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json @@ -53,14 +53,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "Automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "hybridRunbookWorkerGroupName", @@ -70,10 +66,10 @@ "description": "The hybrid runbook worker group name" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -83,7 +79,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -104,14 +100,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "hybridRunbookWorkerGroupName", @@ -121,23 +113,23 @@ "description": "The hybrid runbook worker group name" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/HybridRunbookWorkerGroup" + "$ref": "#/definitions/HybridRunbookWorkerGroup" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -158,14 +150,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "hybridRunbookWorkerGroupName", @@ -179,28 +167,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/HybridRunbookWorkerGroupUpdateParameters" + "$ref": "#/definitions/HybridRunbookWorkerGroupUpdateParameters" }, "description": "The hybrid runbook worker group" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/HybridRunbookWorkerGroup" + "$ref": "#/definitions/HybridRunbookWorkerGroup" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -223,42 +211,142 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, "type": "string", - "description": "The automation account name." + "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/HybridRunbookWorkerGroupsListResult" + "$ref": "#/definitions/HybridRunbookWorkerGroupsListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" - } + }, + "x-ms-odata": "#/definitions/HybridRunbookWorkerGroup" } } }, - "definitions": {}, + "definitions": { + "RunAsCredentialAssociationProperty": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the credential." + } + }, + "description": "Definition of runas credential to use for hybrid worker." + }, + "HybridRunbookWorker": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the worker machine name." + }, + "ip": { + "type": "string", + "description": "Gets or sets the assigned machine IP address." + }, + "registrationTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the registration time of the worker machine.", + "x-nullable": false + }, + "lastSeenDateTime": { + "type": "string", + "format": "date-time", + "description": "Last Heartbeat from the Worker", + "x-nullable": false + } + }, + "description": "Definition of hybrid runbook worker." + }, + "HybridRunbookWorkerGroup": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the id of the resource." + }, + "name": { + "type": "string", + "description": "Gets or sets the name of the group." + }, + "hybridRunbookWorkers": { + "type": "array", + "items": { + "$ref": "#/definitions/HybridRunbookWorker" + }, + "description": "Gets or sets the list of hybrid runbook workers." + }, + "credential": { + "$ref": "#/definitions/RunAsCredentialAssociationProperty", + "description": "Sets the credential of a worker group." + }, + "groupType": { + "type": "string", + "description": "Type of the HybridWorkerGroup.", + "enum": [ + "User", + "System" + ], + "x-ms-enum": { + "name": "GroupTypeEnum", + "modelAsString": true + } + } + }, + "description": "Definition of hybrid runbook worker group." + }, + "HybridRunbookWorkerGroupsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/HybridRunbookWorkerGroup" + }, + "description": "Gets or sets a list of hybrid runbook worker groups." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list hybrid runbook worker groups." + }, + "HybridRunbookWorkerGroupUpdateParameters": { + "properties": { + "credential": { + "$ref": "#/definitions/RunAsCredentialAssociationProperty", + "description": "Sets the credential of a worker group." + } + }, + "description": "Parameters supplied to the update operation." + } + }, "parameters": {} } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/job.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/job.json index b7f13d811c8d..d38887a37458 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/job.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/job.json @@ -53,14 +53,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobId", @@ -70,10 +66,10 @@ "description": "The job id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -86,7 +82,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -104,14 +100,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobId", @@ -121,10 +113,10 @@ "description": "The job id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -137,7 +129,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -160,14 +152,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobId", @@ -178,10 +166,10 @@ "description": "The job id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -191,7 +179,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -214,14 +202,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobId", @@ -232,10 +216,10 @@ "description": "The job id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -245,7 +229,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -263,14 +247,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobId", @@ -281,23 +261,23 @@ "description": "The job id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Job" + "$ref": "#/definitions/Job" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -318,14 +298,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobId", @@ -340,28 +316,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/JobCreateParameters" + "$ref": "#/definitions/JobCreateParameters" }, "description": "The parameters supplied to the create job operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/Job" + "$ref": "#/definitions/Job" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -384,14 +360,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "$filter", @@ -401,23 +373,23 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/JobListResult" + "$ref": "#/definitions/JobListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -443,14 +415,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobId", @@ -461,10 +429,10 @@ "description": "The job id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -474,7 +442,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -492,14 +460,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobId", @@ -516,23 +480,23 @@ "description": "The job stream id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/JobStream" + "$ref": "#/definitions/JobStream" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -550,14 +514,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobId", @@ -574,23 +534,23 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/JobStreamListResult" + "$ref": "#/definitions/JobStreamListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -600,6 +560,287 @@ } } }, - "definitions": {}, + "definitions": { + "Job": { + "properties": { + "id": { + "type": "string", + "description": "Id of the resource." + }, + "properties": { + "$ref": "#/definitions/JobProperties", + "x-ms-client-flatten": true, + "description": "The properties of the job." + } + }, + "description": "Definition of the job." + }, + "JobListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Job" + }, + "description": "Gets or sets a list of jobs." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list job operation." + }, + "JobProperties": { + "properties": { + "runbook": { + "$ref": "#/definitions/RunbookAssociationProperty", + "description": "Gets or sets the runbook." + }, + "startedBy": { + "type": "string", + "description": "Gets or sets the job started by." + }, + "runOn": { + "type": "string", + "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." + }, + "jobId": { + "type": "string", + "format": "uuid", + "description": "Gets or sets the id of the job.", + "x-nullable": false + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the creation time of the job.", + "x-nullable": false + }, + "status": { + "type": "string", + "description": "Gets or sets the status of the job.", + "enum": [ + "New", + "Activating", + "Running", + "Completed", + "Failed", + "Stopped", + "Blocked", + "Suspended", + "Disconnected", + "Suspending", + "Stopping", + "Resuming", + "Removing" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "statusDetails": { + "type": "string", + "description": "Gets or sets the status details of the job." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time of the job.", + "x-nullable": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time of the job.", + "x-nullable": true + }, + "exception": { + "type": "string", + "description": "Gets or sets the exception of the job." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last modified time of the job.", + "x-nullable": true + }, + "lastStatusModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last status modified time of the job.", + "x-nullable": true + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the parameters of the job." + }, + "provisioningState": { + "$ref": "#/definitions/JobProvisioningStateProperty", + "description": "The provisioning state of a resource." + }, + "jobScheduleId": { + "type": "string", + "description": "Gets or sets the id of job schedule." + }, + "schedule": { + "$ref": "#/definitions/ScheduleAssociationProperty", + "description": "Gets or sets the runbook." + } + }, + "description": "Definition of job properties." + }, + "ScheduleAssociationProperty": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the Schedule." + } + }, + "description": "The schedule property associated with the entity." + }, + "RunbookAssociationProperty": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the runbook." + } + }, + "description": "The runbook property associated with the entity." + }, + "JobProvisioningStateProperty": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the resource.", + "enum": [ + "Failed", + "Succeeded", + "Suspended", + "Processing" + ], + "x-ms-enum": { + "name": "JobProvisioningState", + "modelAsString": true + } + }, + "JobCreateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/JobCreateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the list of job properties." + } + }, + "required": [ + "properties" + ], + "description": "The parameters supplied to the create job operation." + }, + "JobCreateProperties": { + "properties": { + "runbook": { + "$ref": "#/definitions/RunbookAssociationProperty", + "description": "Gets or sets the runbook." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the parameters of the job." + }, + "runOn": { + "type": "string", + "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." + } + }, + "required": [ + "runbook" + ], + "description": "The parameters supplied to the create job operation." + }, + "JobStream": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the id of the resource." + }, + "properties": { + "$ref": "#/definitions/JobStreamProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the id of the job stream." + } + }, + "description": "Definition of the job stream." + }, + "JobStreamProperties": { + "properties": { + "jobStreamId": { + "type": "string", + "description": "Gets or sets the id of the job stream." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the creation time of the job.", + "x-nullable": false + }, + "streamType": { + "type": "string", + "description": "Gets or sets the stream type.", + "enum": [ + "Progress", + "Output", + "Warning", + "Error", + "Debug", + "Verbose", + "Any" + ], + "x-ms-enum": { + "name": "JobStreamType", + "modelAsString": true + } + }, + "streamText": { + "type": "string", + "description": "Gets or sets the stream text." + }, + "summary": { + "type": "string", + "description": "Gets or sets the summary." + }, + "value": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "Gets or sets the values of the job stream." + } + }, + "x-ms-client-flatten": true, + "description": "Definition of the job stream." + }, + "JobStreamListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobStream" + }, + "description": "A list of job streams." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list job stream operation." + } + }, "parameters": {} } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/jobSchedule.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/jobSchedule.json index df5354979724..47a014a4d328 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/jobSchedule.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/jobSchedule.json @@ -53,14 +53,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobScheduleId", @@ -71,10 +67,10 @@ "description": "The job schedule name." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -84,7 +80,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -105,14 +101,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobScheduleId", @@ -123,23 +115,23 @@ "description": "The job schedule name." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/JobSchedule" + "$ref": "#/definitions/JobSchedule" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -160,14 +152,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobScheduleId", @@ -182,28 +170,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/JobScheduleCreateParameters" + "$ref": "#/definitions/JobScheduleCreateParameters" }, "description": "The parameters supplied to the create job schedule operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/JobSchedule" + "$ref": "#/definitions/JobSchedule" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -226,42 +214,175 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, "type": "string", - "description": "The automation account name." + "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/JobScheduleListResult" + "$ref": "#/definitions/JobScheduleListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" - } + }, + "x-ms-odata": "#/definitions/JobSchedule" } } }, - "definitions": {}, + "definitions": { + "JobScheduleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobSchedule" + }, + "description": "Gets or sets a list of job schedules." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list job schedule operation." + }, + "JobSchedule": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the id of the resource." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the name of the variable." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "$ref": "#/definitions/JobScheduleProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the job schedule." + } + }, + "description": "Definition of the job schedule." + }, + "ScheduleAssociationProperty": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the Schedule." + } + }, + "description": "The schedule property associated with the entity." + }, + "RunbookAssociationProperty": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the runbook." + } + }, + "description": "The runbook property associated with the entity." + }, + "JobScheduleProperties": { + "properties": { + "jobScheduleId": { + "type": "string", + "description": "Gets or sets the id of job schedule." + }, + "schedule": { + "$ref": "#/definitions/ScheduleAssociationProperty", + "description": "Gets or sets the schedule." + }, + "runbook": { + "$ref": "#/definitions/RunbookAssociationProperty", + "description": "Gets or sets the runbook." + }, + "runOn": { + "type": "string", + "description": "Gets or sets the hybrid worker group that the scheduled job should run on." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the parameters of the job schedule." + } + }, + "description": "Definition of job schedule parameters." + }, + "JobScheduleCreateProperties": { + "properties": { + "schedule": { + "$ref": "#/definitions/ScheduleAssociationProperty", + "description": "Gets or sets the schedule." + }, + "runbook": { + "$ref": "#/definitions/RunbookAssociationProperty", + "description": "Gets or sets the runbook." + }, + "runOn": { + "type": "string", + "description": "Gets or sets the hybrid worker group that the scheduled job should run on." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets a list of job properties." + } + }, + "required": [ + "schedule", + "runbook" + ], + "description": "The parameters supplied to the create job schedule operation." + }, + "JobScheduleCreateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/JobScheduleCreateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the list of job schedule properties." + } + }, + "required": [ + "properties" + ], + "description": "The parameters supplied to the create job schedule operation." + } + }, "parameters": {} } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/linkedWorkspace.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/linkedWorkspace.json index 503fa041b5c0..400b515979a5 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/linkedWorkspace.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/linkedWorkspace.json @@ -53,39 +53,46 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/LinkedWorkspace" + "$ref": "#/definitions/LinkedWorkspace" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } } } }, - "definitions": {}, + "definitions": { + "LinkedWorkspace": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the id of the linked workspace." + } + }, + "description": "Definition of the linked workspace." + } + }, "parameters": {} } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/module.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/module.json index 56cced0356ab..5c99b4e0eeeb 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/module.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/module.json @@ -53,14 +53,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "moduleName", @@ -77,23 +73,23 @@ "description": "The name of activity." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Activity" + "$ref": "#/definitions/Activity" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -116,14 +112,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "moduleName", @@ -133,23 +125,23 @@ "description": "The name of module." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/ActivityListResult" + "$ref": "#/definitions/ActivityListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -175,14 +167,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "moduleName", @@ -192,10 +180,10 @@ "description": "The module name." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -205,7 +193,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -226,14 +214,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "moduleName", @@ -243,23 +227,23 @@ "description": "The module name." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Module" + "$ref": "#/definitions/Module" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -280,14 +264,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "moduleName", @@ -301,34 +281,34 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/ModuleCreateOrUpdateParameters" + "$ref": "#/definitions/ModuleCreateOrUpdateParameters" }, "description": "The create or update parameters for module." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/Module" + "$ref": "#/definitions/Module" } }, "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Module" + "$ref": "#/definitions/Module" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -349,14 +329,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "moduleName", @@ -370,28 +346,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/ModuleUpdateParameters" + "$ref": "#/definitions/ModuleUpdateParameters" }, "description": "The update parameters for module." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Module" + "$ref": "#/definitions/Module" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -414,33 +390,29 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/ModuleListResult" + "$ref": "#/definitions/ModuleListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -466,14 +438,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "moduleName", @@ -490,23 +458,23 @@ "description": "The name of type." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/TypeFieldListResult" + "$ref": "#/definitions/TypeFieldListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -532,14 +500,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "typeName", @@ -549,23 +513,23 @@ "description": "The name of type." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/TypeFieldListResult" + "$ref": "#/definitions/TypeFieldListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -591,14 +555,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "moduleName", @@ -615,23 +575,23 @@ "description": "The name of type." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/TypeFieldListResult" + "$ref": "#/definitions/TypeFieldListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -641,6 +601,426 @@ } } }, - "definitions": {}, + "definitions": { + "ActivityParameter": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the activity parameter." + }, + "type": { + "type": "string", + "description": "Gets or sets the type of the activity parameter." + }, + "isMandatory": { + "type": "boolean", + "description": "Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional." + }, + "isDynamic": { + "type": "boolean", + "description": "Gets or sets a Boolean value that indicates true if the parameter is dynamic." + }, + "position": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the position of the activity parameter." + }, + "valueFromPipeline": { + "type": "boolean", + "description": "Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object." + }, + "valueFromPipelineByPropertyName": { + "type": "boolean", + "description": "Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name. " + }, + "valueFromRemainingArguments": { + "type": "boolean", + "description": "Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values." + }, + "description": { + "type": "string", + "description": "Gets or sets the description of the activity parameter." + }, + "validationSet": { + "type": "array", + "items": { + "$ref": "#/definitions/ActivityParameterValidationSet" + }, + "description": "Gets or sets the validation set of activity parameter." + } + }, + "description": "Definition of the activity parameter." + }, + "ActivityParameterSet": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the activity parameter set." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/ActivityParameter" + }, + "description": "Gets or sets the parameters of the activity parameter set." + } + }, + "description": "Definition of the activity parameter set." + }, + "ActivityParameterValidationSet": { + "properties": { + "memberValue": { + "type": "string", + "description": "Gets or sets the name of the activity parameter validation set member." + } + }, + "description": "Definition of the activity parameter validation set." + }, + "ActivityOutputType": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the activity output type." + }, + "type": { + "type": "string", + "description": "Gets or sets the type of the activity output type." + } + }, + "description": "Definition of the activity output type." + }, + "ActivityProperties": { + "properties": { + "definition": { + "type": "string", + "description": "Gets or sets the user name of the activity." + }, + "parameterSets": { + "type": "array", + "items": { + "$ref": "#/definitions/ActivityParameterSet" + }, + "description": "Gets or sets the parameter sets of the activity." + }, + "outputTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/ActivityOutputType" + }, + "description": "Gets or sets the output types of the activity." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the creation time.", + "x-nullable": false + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last modified time.", + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + } + }, + "description": "Properties of the activity." + }, + "Activity": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the id of the resource." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the name of the activity." + }, + "properties": { + "$ref": "#/definitions/ActivityProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the activity." + } + }, + "description": "Definition of the activity." + }, + "ActivityListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Activity" + }, + "description": "Gets or sets a list of activities." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list activity operation." + }, + "ModuleErrorInfo": { + "properties": { + "code": { + "type": "string", + "description": "Gets or sets the error code." + }, + "message": { + "type": "string", + "description": "Gets or sets the error message." + } + }, + "description": "Definition of the module error info type." + }, + "ModuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Module" + }, + "description": "Gets or sets a list of modules." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list module operation." + }, + "ContentHash": { + "properties": { + "algorithm": { + "type": "string", + "description": "Gets or sets the content hash algorithm used to hash the content." + }, + "value": { + "type": "string", + "description": "Gets or sets expected hash value of the content." + } + }, + "required": [ + "algorithm", + "value" + ], + "description": "Definition of the runbook property type." + }, + "ContentLink": { + "properties": { + "uri": { + "type": "string", + "description": "Gets or sets the uri of the runbook content." + }, + "contentHash": { + "$ref": "#/definitions/ContentHash", + "description": "Gets or sets the hash." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the content." + } + }, + "description": "Definition of the content link." + }, + "ModuleCreateOrUpdateProperties": { + "properties": { + "contentLink": { + "$ref": "#/definitions/ContentLink", + "description": "Gets or sets the module content link." + } + }, + "required": [ + "contentLink" + ], + "description": "The parameters supplied to the create or update module properties." + }, + "ModuleCreateOrUpdateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/ModuleCreateOrUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the module create properties." + }, + "name": { + "type": "string", + "description": "Gets or sets name of the resource." + }, + "location": { + "type": "string", + "description": "Gets or sets the location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags attached to the resource." + } + }, + "required": [ + "properties" + ], + "description": "The parameters supplied to the create or update module operation." + }, + "ModuleProperties": { + "properties": { + "isGlobal": { + "type": "boolean", + "description": "Gets or sets the isGlobal flag of the module." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the module." + }, + "sizeInBytes": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the size in bytes of the module." + }, + "activityCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the activity count of the module." + }, + "provisioningState": { + "type": "string", + "description": "Gets or sets the provisioning state of the module.", + "enum": [ + "Created", + "Creating", + "StartingImportModuleRunbook", + "RunningImportModuleRunbook", + "ContentRetrieved", + "ContentDownloaded", + "ContentValidated", + "ConnectionTypeImported", + "ContentStored", + "ModuleDataStored", + "ActivitiesStored", + "ModuleImportRunbookComplete", + "Succeeded", + "Failed", + "Cancelled", + "Updating" + ], + "x-ms-enum": { + "name": "ModuleProvisioningState", + "modelAsString": false + } + }, + "contentLink": { + "$ref": "#/definitions/ContentLink", + "description": "Gets or sets the contentLink of the module." + }, + "error": { + "$ref": "#/definitions/ModuleErrorInfo", + "description": "Gets or sets the error info of the module." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the creation time.", + "x-nullable": false + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last modified time.", + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + }, + "isComposite": { + "type": "boolean", + "description": "Gets or sets type of module, if its composite or not." + } + }, + "description": "Definition of the module property type." + }, + "ModuleUpdateProperties": { + "properties": { + "contentLink": { + "$ref": "#/definitions/ContentLink", + "description": "Gets or sets the module content link." + } + }, + "description": "The parameters supplied to the update properties." + }, + "ModuleUpdateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/ModuleUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the module update properties." + }, + "name": { + "type": "string", + "description": "Gets or sets name of the resource." + }, + "location": { + "type": "string", + "description": "Gets or sets the location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags attached to the resource." + } + }, + "description": "The parameters supplied to the update module operation." + }, + "Module": { + "properties": { + "properties": { + "$ref": "#/definitions/ModuleProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the module properties." + }, + "etag": { + "type": "string", + "description": "Gets or sets the etag of the resource." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Definition of the module type." + }, + "TypeField": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the field." + }, + "type": { + "type": "string", + "description": "Gets or sets the type of the field." + } + }, + "description": "Information about a field of a type." + }, + "TypeFieldListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TypeField" + }, + "description": "Gets or sets a list of fields." + } + }, + "description": "The response model for the list fields operation." + } + }, "parameters": {} } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/runbook.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/runbook.json index 7f2d17c6528c..247c2a567486 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/runbook.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/runbook.json @@ -1,9 +1,10 @@ + { "swagger": "2.0", "info": { "title": "AutomationManagement", "version": "2015-10-31", - "x-ms-code-generation-settings": { + "x-ms-code-generation-settings": { "useDateTimeOffset": true } }, @@ -56,17 +57,13 @@ ], "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -74,22 +71,22 @@ "required": true, "type": "string", "description": "The runbook name." - }, + }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "OK", + "description": "OK", "schema": { - "type": "string" + "type": "file" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -113,17 +110,13 @@ ], "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -137,19 +130,20 @@ "in": "body", "required": true, "schema": { - "type": "string" + "type": "object", + "format": "file" }, - "description": "The runbook draft content." + "description": "The runbook draft content." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { + "200": { "description": "OK", "schema": { - "type": "string" + "type": "file" } }, "202": { @@ -164,7 +158,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -188,17 +182,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -206,22 +196,22 @@ "required": true, "type": "string", "description": "The runbook name." - }, + }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/RunbookDraft" + "$ref": "#/definitions/RunbookDraft" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -244,17 +234,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -262,18 +248,12 @@ "required": true, "type": "string", "description": "The parameters supplied to the publish runbook operation." - }, + }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { - "description": "OK", - "schema": { - "type": "string" - } - }, "202": { "description": "Accepted and the operation will complete asynchronously.", "headers": { @@ -286,7 +266,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -310,17 +290,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -328,22 +304,22 @@ "required": true, "type": "string", "description": "The runbook name." - }, + }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/RunbookDraftUndoEditResult" + "$ref": "#/definitions/RunbookDraftUndoEditResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -369,17 +345,13 @@ ], "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -387,22 +359,22 @@ "required": true, "type": "string", "description": "The runbook name." - }, + }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { - "200": { + "200": { "description": "OK", "schema": { - "type": "string" + "type": "file" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -423,19 +395,15 @@ "$ref": "./examples/getRunbook.json" } }, - "parameters": [ + "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -445,20 +413,20 @@ "description": "The runbook name." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Runbook" + "$ref": "#/definitions/Runbook" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -478,21 +446,17 @@ }, "Create runbook as draft": { "$ref": "./examples/createRunbookAsDraft.json" - } + } }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -506,25 +470,25 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/RunbookCreateOrUpdateParameters" + "$ref": "#/definitions/RunbookCreateOrUpdateParameters" }, "description": "The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both." - }, + }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Runbook" + "$ref": "#/definitions/Runbook" } }, "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/Runbook" + "$ref": "#/definitions/Runbook" } }, "400": { @@ -533,7 +497,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -554,17 +518,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -578,25 +538,25 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/RunbookUpdateParameters" + "$ref": "#/definitions/RunbookUpdateParameters" }, "description": "The update parameters for runbook." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Runbook" + "$ref": "#/definitions/Runbook" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -617,17 +577,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -637,7 +593,7 @@ "description": "The runbook name." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -650,7 +606,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -673,33 +629,29 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/RunbookListResult" + "$ref": "#/definitions/RunbookListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -725,17 +677,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -752,20 +700,20 @@ "description": "The job stream id." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/JobStream" + "$ref": "./job.json#/definitions/JobStream" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -788,17 +736,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -813,22 +757,22 @@ "required": false, "type": "string", "description": "The filter to apply on the operation." - }, + }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/JobStreamListResult" + "$ref": "./job.json#/definitions/JobStreamListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -854,17 +798,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -878,25 +818,25 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/TestJobCreateParameters" + "$ref": "#/definitions/TestJobCreateParameters" }, "description": "The parameters supplied to the create test job operation." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/TestJob" + "$ref": "#/definitions/TestJob" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -917,17 +857,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -937,20 +873,20 @@ "description": "The runbook name." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/TestJob" + "$ref": "#/definitions/TestJob" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -973,17 +909,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -993,7 +925,7 @@ "description": "The runbook name." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -1003,7 +935,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -1026,17 +958,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -1046,7 +974,7 @@ "description": "The runbook name." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -1056,7 +984,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -1079,17 +1007,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "runbookName", @@ -1099,7 +1023,7 @@ "description": "The runbook name." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -1109,13 +1033,578 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } } } }, - "definitions": {}, + "definitions": { + "ContentHash": { + "properties": { + "algorithm": { + "type": "string", + "description": "Gets or sets the content hash algorithm used to hash the content." + }, + "value": { + "type": "string", + "description": "Gets or sets expected hash value of the content." + } + }, + "required": [ + "algorithm", + "value" + ], + "description": "Definition of the runbook property type." + }, + "ContentLink": { + "properties": { + "uri": { + "type": "string", + "description": "Gets or sets the uri of the runbook content." + }, + "contentHash": { + "$ref": "#/definitions/ContentHash", + "description": "Gets or sets the hash." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the content." + } + }, + "description": "Definition of the content link." + }, + "RunbookProperties": { + "properties": { + "runbookType": { + "type": "string", + "description": "Gets or sets the type of the runbook.", + "enum": [ + "Script", + "Graph", + "PowerShellWorkflow", + "PowerShell", + "GraphPowerShellWorkflow", + "GraphPowerShell" + ], + "x-ms-enum": { + "name": "RunbookTypeEnum", + "modelAsString": true + } + }, + "publishContentLink": { + "$ref": "#/definitions/ContentLink", + "description": "Gets or sets the published runbook content link." + }, + "state": { + "type": "string", + "description": "Gets or sets the state of the runbook.", + "enum": [ + "New", + "Edit", + "Published" + ], + "x-ms-enum": { + "name": "RunbookState", + "modelAsString": true + } + }, + "logVerbose": { + "type": "boolean", + "description": "Gets or sets verbose log option." + }, + "logProgress": { + "type": "boolean", + "description": "Gets or sets progress log option." + }, + "logActivityTrace": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the option to log activity trace of the runbook." + }, + "jobCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the job count of the runbook." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/RunbookParameter" + }, + "description": "Gets or sets the runbook parameters." + }, + "outputTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the runbook output types." + }, + "draft": { + "$ref": "#/definitions/RunbookDraft", + "description": "Gets or sets the draft runbook properties." + }, + "provisioningState": { + "type": "string", + "description": "Gets or sets the provisioning state of the runbook.", + "enum": [ + "Succeeded" + ], + "x-ms-enum": { + "name": "RunbookProvisioningState", + "modelAsString": false + } + }, + "lastModifiedBy": { + "type": "string", + "description": "Gets or sets the last modified by." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the creation time.", + "x-nullable": false + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last modified time.", + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + } + }, + "description": "Definition of the runbook property type." + }, + "Runbook": { + "properties": { + "properties": { + "$ref": "#/definitions/RunbookProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the runbook properties." + }, + "etag": { + "type": "string", + "description": "Gets or sets the etag of the resource." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Definition of the runbook type." + }, + "RunbookListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Runbook" + }, + "description": "Gets or sets a list of runbooks." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list runbook operation." + }, + "RunbookCreateOrUpdateProperties": { + "properties": { + "logVerbose": { + "type": "boolean", + "description": "Gets or sets verbose log option." + }, + "logProgress": { + "type": "boolean", + "description": "Gets or sets progress log option." + }, + "runbookType": { + "type": "string", + "description": "Gets or sets the type of the runbook.", + "enum": [ + "Script", + "Graph", + "PowerShellWorkflow", + "PowerShell", + "GraphPowerShellWorkflow", + "GraphPowerShell" + ], + "x-ms-enum": { + "name": "RunbookTypeEnum", + "modelAsString": true + } + }, + "draft": { + "$ref": "#/definitions/RunbookDraft", + "description": "Gets or sets the draft runbook properties." + }, + "publishContentLink": { + "$ref": "#/definitions/ContentLink", + "description": "Gets or sets the published runbook content link." + }, + "description": { + "type": "string", + "description": "Gets or sets the description of the runbook." + }, + "logActivityTrace": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the activity-level tracing options of the runbook." + } + }, + "required": [ + "runbookType" + ], + "description": "The parameters supplied to the create or update runbook properties." + }, + "RunbookCreateOrUpdateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/RunbookCreateOrUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets runbook create or update properties." + }, + "name": { + "type": "string", + "description": "Gets or sets the name of the resource." + }, + "location": { + "type": "string", + "description": "Gets or sets the location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags attached to the resource." + } + }, + "required": [ + "properties" + ], + "description": "The parameters supplied to the create or update runbook operation." + }, + "RunbookUpdateProperties": { + "properties": { + "description": { + "type": "string", + "description": "Gets or sets the description of the runbook." + }, + "logVerbose": { + "type": "boolean", + "description": "Gets or sets verbose log option." + }, + "logProgress": { + "type": "boolean", + "description": "Gets or sets progress log option." + }, + "logActivityTrace": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the activity-level tracing options of the runbook." + } + }, + "description": "The parameters supplied to the update runbook properties." + }, + "RunbookUpdateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/RunbookUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the runbook update properties." + }, + "name": { + "type": "string", + "description": "Gets or sets the name of the resource." + }, + "location": { + "type": "string", + "description": "Gets or sets the location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags attached to the resource." + } + }, + "description": "The parameters supplied to the update runbook operation." + }, + "RunbookDraftUndoEditResult": { + "properties": { + "statusCode": { + "type": "string", + "enum": [ + "Continue", + "SwitchingProtocols", + "OK", + "Created", + "Accepted", + "NonAuthoritativeInformation", + "NoContent", + "ResetContent", + "PartialContent", + "MultipleChoices", + "Ambiguous", + "MovedPermanently", + "Moved", + "Found", + "Redirect", + "SeeOther", + "RedirectMethod", + "NotModified", + "UseProxy", + "Unused", + "TemporaryRedirect", + "RedirectKeepVerb", + "BadRequest", + "Unauthorized", + "PaymentRequired", + "Forbidden", + "NotFound", + "MethodNotAllowed", + "NotAcceptable", + "ProxyAuthenticationRequired", + "RequestTimeout", + "Conflict", + "Gone", + "LengthRequired", + "PreconditionFailed", + "RequestEntityTooLarge", + "RequestUriTooLong", + "UnsupportedMediaType", + "RequestedRangeNotSatisfiable", + "ExpectationFailed", + "UpgradeRequired", + "InternalServerError", + "NotImplemented", + "BadGateway", + "ServiceUnavailable", + "GatewayTimeout", + "HttpVersionNotSupported" + ], + "x-ms-enum": { + "name": "HttpStatusCode", + "modelAsString": false + } + }, + "requestId": { + "type": "string" + } + }, + "description": "The response model for the undoedit runbook operation." + }, + "RunbookDraft": { + "properties": { + "inEdit": { + "type": "boolean", + "description": "Gets or sets whether runbook is in edit mode." + }, + "draftContentLink": { + "$ref": "#/definitions/ContentLink", + "description": "Gets or sets the draft runbook content link." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the creation time of the runbook draft.", + "x-nullable": false + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last modified time of the runbook draft.", + "x-nullable": false + }, + "parameters": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/RunbookParameter" + }, + "description": "Gets or sets the runbook draft parameters." + }, + "outputTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the runbook output types." + } + } + }, + "RunbookParameter": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the type of the parameter." + }, + "isMandatory": { + "type": "boolean", + "description": "Gets or sets a Boolean value to indicate whether the parameter is madatory or not." + }, + "position": { + "type": "integer", + "format": "int32", + "description": "Get or sets the position of the parameter." + }, + "defaultValue": { + "type": "string", + "description": "Gets or sets the default value of parameter." + } + }, + "description": "Definition of the runbook parameter type." + }, + "TestJobCreateParameters": { + "properties": { + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the parameters of the test job." + }, + "runOn": { + "type": "string", + "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." + } + }, + "description": "The parameters supplied to the create test job operation." + }, + "TestJob": { + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the creation time of the test job.", + "x-nullable": false + }, + "status": { + "type": "string", + "description": "Gets or sets the status of the test job." + }, + "statusDetails": { + "type": "string", + "description": "Gets or sets the status details of the test job." + }, + "runOn": { + "type": "string", + "description": "Gets or sets the runOn which specifies the group name where the job is to be executed." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time of the test job.", + "x-nullable": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time of the test job.", + "x-nullable": true + }, + "exception": { + "type": "string", + "description": "Gets or sets the exception of the test job." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last modified time of the test job.", + "x-nullable": false + }, + "lastStatusModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last status modified time of the test job.", + "x-nullable": true + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the parameters of the test job." + }, + "logActivityTrace": { + "type": "integer", + "format": "int32", + "description": "The activity-level tracing options of the runbook." + } + }, + "description": "Definition of the test job." + }, + "RunbookCreateOrUpdateDraftProperties": { + "properties": { + "logVerbose": { + "type": "boolean", + "description": "Gets or sets verbose log option." + }, + "logProgress": { + "type": "boolean", + "description": "Gets or sets progress log option." + }, + "runbookType": { + "type": "string", + "description": "Gets or sets the type of the runbook.", + "enum": [ + "Script", + "Graph", + "PowerShellWorkflow", + "PowerShell", + "GraphPowerShellWorkflow", + "GraphPowerShell" + ], + "x-ms-enum": { + "name": "RunbookTypeEnum", + "modelAsString": true + } + }, + "draft": { + "$ref": "#/definitions/RunbookDraft", + "description": "Gets or sets the draft runbook properties." + }, + "description": { + "type": "string", + "description": "Gets or sets the description of the runbook." + }, + "logActivityTrace": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the activity-level tracing options of the runbook." + } + }, + "required": [ + "runbookType", + "draft" + ], + "description": "The parameters supplied to the create or update dratft runbook properties." + }, + "RunbookCreateOrUpdateDraftParameters": { + "properties": { + "runbookContent": { + "type": "string", + "description": "Content of the Runbook." + } + }, + "x-ms-client-flatten": true, + "required": [ + "runbookContent" + ], + "description": "The parameters supplied to the create or update runbook operation." + } + }, "parameters": {} -} +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/schedule.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/schedule.json index 927eeaf20039..05496b8a525a 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/schedule.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/schedule.json @@ -3,7 +3,7 @@ "info": { "title": "AutomationManagement", "version": "2015-10-31", - "x-ms-code-generation-settings": { + "x-ms-code-generation-settings": { "useDateTimeOffset": true } }, @@ -53,14 +53,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "scheduleName", @@ -74,22 +70,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/ScheduleCreateOrUpdateParameters" + "$ref": "#/definitions/ScheduleCreateOrUpdateParameters" }, "description": "The parameters supplied to the create or update schedule operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/Schedule" + "$ref": "#/definitions/Schedule" + } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Schedule" } }, "409": { @@ -98,7 +100,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -119,14 +121,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "scheduleName", @@ -140,28 +138,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/ScheduleUpdateParameters" + "$ref": "#/definitions/ScheduleUpdateParameters" }, "description": "The parameters supplied to the update schedule operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Schedule" + "$ref": "#/definitions/Schedule" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -182,14 +180,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "scheduleName", @@ -199,23 +193,23 @@ "description": "The schedule name." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Schedule" + "$ref": "#/definitions/Schedule" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -236,14 +230,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "scheduleName", @@ -253,23 +243,20 @@ "description": "The schedule name." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK" }, - "404": { - "description": "Not Found" - }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -295,33 +282,29 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/ScheduleListResult" + "$ref": "#/definitions/ScheduleListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -331,6 +314,282 @@ } } }, - "definitions": {}, + "definitions": { + "AdvancedSchedule": { + "properties": { + "weekDays": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Days of the week that the job should execute on." + }, + "monthDays": { + "type": "array", + "items": { + "type": "integer", + "format": "int32", + "x-nullable": false + }, + "description": "Days of the month that the job should execute on. Must be between 1 and 31." + }, + "monthlyOccurrences": { + "type": "array", + "items": { + "$ref": "#/definitions/AdvancedScheduleMonthlyOccurrence" + }, + "description": "Occurrences of days within a month." + } + }, + "description": "The properties of the create Advanced Schedule." + }, + "AdvancedScheduleMonthlyOccurrence": { + "properties": { + "occurrence": { + "type": "integer", + "format": "int32", + "description": "Occurrence of the week within the month. Must be between 1 and 5" + }, + "day": { + "type": "string", + "description": "Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "ScheduleDay", + "modelAsString": true + } + } + }, + "description": "The properties of the create advanced schedule monthly occurrence." + }, + "ScheduleCreateOrUpdateProperties": { + "properties": { + "description": { + "type": "string", + "description": "Gets or sets the description of the schedule." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time of the schedule.", + "x-nullable": false + }, + "expiryTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time of the schedule.", + "x-nullable": true + }, + "interval": { + "description": "Gets or sets the interval of the schedule." + }, + "frequency": { + "type": "string", + "$ref": "#/definitions/scheduleFrequency" + }, + "timeZone": { + "type": "string", + "description": "Gets or sets the time zone of the schedule." + }, + "advancedSchedule": { + "$ref": "#/definitions/AdvancedSchedule", + "description": "Gets or sets the AdvancedSchedule." + } + }, + "required": [ + "startTime", + "frequency" + ], + "description": "The parameters supplied to the create or update schedule operation." + }, + "scheduleFrequency": { + "type": "string", + "description": "Gets or sets the frequency of the schedule.", + "enum": [ + "OneTime", + "Day", + "Hour", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "ScheduleFrequency", + "modelAsString": true + } + }, + "ScheduleCreateOrUpdateParameters": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the Schedule." + }, + "properties": { + "$ref": "#/definitions/ScheduleCreateOrUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the list of schedule properties." + } + }, + "required": [ + "name", + "properties" + ], + "description": "The parameters supplied to the create or update schedule operation." + }, + "Schedule": { + "properties": { + "properties": { + "$ref": "#/definitions/ScheduleProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the schedule." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Definition of the schedule." + }, + "ScheduleProperties": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time of the schedule.", + "x-nullable": false + }, + "startTimeOffsetMinutes": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "Gets the start time's offset in minutes.", + "x-nullable": false + }, + "expiryTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time of the schedule.", + "x-nullable": true + }, + "expiryTimeOffsetMinutes": { + "type": "number", + "format": "double", + "description": "Gets or sets the expiry time's offset in minutes.", + "x-nullable": false + }, + "isEnabled": { + "type": "boolean", + "default": false, + "description": "Gets or sets a value indicating whether this schedule is enabled." + }, + "nextRun": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the next run time of the schedule.", + "x-nullable": true + }, + "nextRunOffsetMinutes": { + "type": "number", + "format": "double", + "description": "Gets or sets the next run time's offset in minutes.", + "x-nullable": false + }, + "interval": { + "description": "Gets or sets the interval of the schedule." + }, + "frequency": { + "type": "string", + "description": "Gets or sets the frequency of the schedule.", + "enum": [ + "OneTime", + "Day", + "Hour", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "ScheduleFrequency", + "modelAsString": true + } + }, + "timeZone": { + "type": "string", + "description": "Gets or sets the time zone of the schedule." + }, + "advancedSchedule": { + "$ref": "#/definitions/AdvancedSchedule", + "description": "Gets or sets the advanced schedule." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the creation time.", + "x-nullable": false + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last modified time.", + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + } + }, + "description": "Definition of schedule parameters." + }, + "ScheduleUpdateProperties": { + "properties": { + "description": { + "type": "string", + "description": "Gets or sets the description of the schedule." + }, + "isEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether this schedule is enabled." + } + }, + "description": "The parameters supplied to the update schedule operation." + }, + "ScheduleUpdateParameters": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the Schedule." + }, + "properties": { + "$ref": "#/definitions/ScheduleUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the list of schedule properties." + } + }, + "description": "The parameters supplied to the update schedule operation." + }, + "ScheduleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Schedule" + }, + "description": "Gets or sets a list of schedules." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list schedule operation." + } + }, "parameters": {} -} +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/variable.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/variable.json index ca1a7fdb0935..29c3074579ee 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/variable.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/variable.json @@ -53,14 +53,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "variableName", @@ -74,34 +70,34 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/VariableCreateOrUpdateParameters" + "$ref": "#/definitions/VariableCreateOrUpdateParameters" }, "description": "The parameters supplied to the create or update variable operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Variable" + "$ref": "#/definitions/Variable" } }, "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/Variable" + "$ref": "#/definitions/Variable" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -122,14 +118,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "variableName", @@ -143,28 +135,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/VariableUpdateParameters" + "$ref": "#/definitions/VariableUpdateParameters" }, "description": "The parameters supplied to the update variable operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Variable" + "$ref": "#/definitions/Variable" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -185,14 +177,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "variableName", @@ -202,10 +190,10 @@ "description": "The name of variable." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -215,7 +203,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -236,14 +224,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "variableName", @@ -253,23 +237,23 @@ "description": "The name of variable." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Variable" + "$ref": "#/definitions/Variable" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -295,33 +279,29 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/VariableListResult" + "$ref": "#/definitions/VariableListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -331,6 +311,130 @@ } } }, - "definitions": {}, + "definitions": { + "VariableCreateOrUpdateParameters": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the variable." + }, + "properties": { + "$ref": "#/definitions/VariableCreateOrUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the variable." + } + }, + "required": [ + "name", + "properties" + ], + "description": "The parameters supplied to the create or update variable operation." + }, + "VariableCreateOrUpdateProperties": { + "properties": { + "value": { + "type": "string", + "description": "Gets or sets the value of the variable." + }, + "description": { + "type": "string", + "description": "Gets or sets the description of the variable." + }, + "isEncrypted": { + "type": "boolean", + "description": "Gets or sets the encrypted flag of the variable." + } + }, + "description": "The properties of the create variable operation." + }, + "Variable": { + "properties": { + "properties": { + "$ref": "#/definitions/VariableProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the variable." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Definition of the varible." + }, + "VariableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Variable" + }, + "description": "Gets or sets a list of variables." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list variables operation." + }, + "VariableUpdateParameters": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the variable." + }, + "properties": { + "$ref": "#/definitions/VariableUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the value of the variable." + } + }, + "description": "The parameters supplied to the update variable operation." + }, + "VariableUpdateProperties": { + "properties": { + "value": { + "type": "string", + "description": "Gets or sets the value of the variable." + }, + "description": { + "type": "string", + "description": "Gets or sets the description of the variable." + } + }, + "description": "The properties of the update variable" + }, + "VariableProperties": { + "properties": { + "value": { + "type": "string", + "description": "Gets or sets the value of the variable." + }, + "isEncrypted": { + "type": "boolean", + "description": "Gets or sets the encrypted flag of the variable.", + "x-nullable": true + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the creation time.", + "x-nullable": false + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last modified time.", + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + } + }, + "description": "Definition of the varible properties" + } + }, "parameters": {} } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/watcher.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/watcher.json new file mode 100644 index 000000000000..4b23c4859aaf --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/watcher.json @@ -0,0 +1,531 @@ +{ + "swagger": "2.0", + "info": { + "title": "AutomationManagement", + "version": "2015-10-31", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "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.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}": { + "put": { + "tags": [ + "Watcher" + ], + "operationId": "Watcher_CreateOrUpdate", + "description": "Create the watcher identified by watcher name.", + "externalDocs": { + "url": "http://aka.ms/azureautomationsdk/watcheroperations" + }, + "x-ms-examples": { + "Create or update watcher": { + "$ref": "./examples/createOrUpdateWatcher.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" + }, + { + "name": "watcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The watcher name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Watcher" + }, + "description": "The create or update parameters for watcher." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Watcher" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Watcher" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Watcher" + ], + "operationId": "Watcher_Get", + "description": "Retrieve the watcher identified by watcher name.", + "externalDocs": { + "url": "http://aka.ms/azureautomationsdk/watcheroperations" + }, + "x-ms-examples": { + "Get watcher": { + "$ref": "./examples/getWatcher.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" + }, + { + "name": "watcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The watcher name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Watcher" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Watcher" + ], + "operationId": "Watcher_Update", + "description": "Update the watcher identified by watcher name.", + "externalDocs": { + "url": "http://aka.ms/azureautomationsdk/watcheroperations" + }, + "x-ms-examples": { + "Update watcher": { + "$ref": "./examples/updateWatcher.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" + }, + { + "name": "watcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The watcher name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WatcherUpdateParameters" + }, + "description": "The update parameters for watcher." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Watcher" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Watcher" + ], + "operationId": "Watcher_Delete", + "description": "Delete the watcher by name.", + "externalDocs": { + "url": "http://aka.ms/azureautomationsdk/watcheroperations" + }, + "x-ms-examples": { + "Delete watcher": { + "$ref": "./examples/deleteWatcher.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" + }, + { + "name": "watcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The watcher name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}/start": { + "post": { + "tags": [ + "Watcher" + ], + "operationId": "Watcher_Start", + "description": "Resume the watcher identified by watcher name.", + "externalDocs": { + "url": "http://aka.ms/azureautomationsdk/watcheroperations" + }, + "x-ms-examples": { + "Start Watcher": { + "$ref": "./examples/startWatcher.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" + }, + { + "name": "watcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The watcher name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}/stop": { + "post": { + "tags": [ + "Watcher" + ], + "operationId": "Watcher_Stop", + "description": "Resume the watcher identified by watcher name.", + "externalDocs": { + "url": "http://aka.ms/azureautomationsdk/watcheroperations" + }, + "x-ms-examples": { + "Start Watcher": { + "$ref": "./examples/stopWatcher.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" + }, + { + "name": "watcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The watcher name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers": { + "get": { + "tags": [ + "Watcher" + ], + "operationId": "Watcher_ListByAutomationAccount", + "description": "Retrieve a list of watchers.", + "externalDocs": { + "url": "http://aka.ms/azureautomationsdk/watcheroperations" + }, + "x-ms-examples": { + "List watchers by Automation Account": { + "$ref": "./examples/listWatchersByAutomationAccount.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WatcherListResult" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/Watcher" + } + } + }, + "definitions": { + "Watcher": { + "properties": { + "properties": { + "$ref": "#/definitions/WatcherProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the watcher properties." + }, + "etag": { + "type": "string", + "description": "Gets or sets the etag of the resource." + } + }, + "description": "Definition of the watcher type.", + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ] + }, + "WatcherProperties": { + "properties": { + "executionFrequencyInSeconds": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the frequency at which the watcher is invoked." + }, + "scriptName": { + "type": "string", + "description": "Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook." + }, + "scriptParameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the parameters of the script." + }, + "scriptRunOn": { + "type": "string", + "description": "Gets or sets the name of the hybrid worker group the watcher will run on." + }, + "status": { + "type": "string", + "readOnly": true, + "description": "Gets the current status of the watcher." + }, + "creationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Gets or sets the creation time.", + "x-nullable": false + }, + "lastModifiedTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Gets or sets the last modified time.", + "x-nullable": false + }, + "lastModifiedBy": { + "type": "string", + "readOnly": true, + "description": "Details of the user who last modified the watcher." + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + } + }, + "description": "Definition of the watcher properties" + }, + "WatcherUpdateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/WatcherUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the watcher update properties." + }, + "name": { + "type": "string", + "description": "Gets or sets the name of the resource." + } + } + }, + "WatcherUpdateProperties": { + "properties": { + "executionFrequencyInSeconds": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the frequency at which the watcher is invoked." + } + }, + "description": "The properties of the update watcher operation." + }, + "WatcherListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Watcher" + }, + "description": "Gets or sets a list of watchers." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list watcher operation." + } + }, + "parameters": {} +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/webhook.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/webhook.json index 0ff6b2512f5b..d4c205bf3718 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/webhook.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/webhook.json @@ -3,7 +3,7 @@ "info": { "title": "AutomationManagementClient", "version": "2015-10-31", - "x-ms-code-generation-settings": { + "x-ms-code-generation-settings": { "useDateTimeOffset": true } }, @@ -53,20 +53,16 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -79,7 +75,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -102,14 +98,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "webhookName", @@ -119,10 +111,10 @@ "description": "The webhook name." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -132,7 +124,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -153,14 +145,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "webhookName", @@ -170,23 +158,23 @@ "description": "The webhook name." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Webhook" + "$ref": "#/definitions/Webhook" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -207,14 +195,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "webhookName", @@ -228,34 +212,34 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/WebhookCreateOrUpdateParameters" + "$ref": "#/definitions/WebhookCreateOrUpdateParameters" }, "description": "The create or update parameters for webhook." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Webhook" + "$ref": "#/definitions/Webhook" } }, "201": { "description": "Created", "schema": { - "$ref": "./definitions.json#/definitions/Webhook" + "$ref": "#/definitions/Webhook" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -276,14 +260,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "webhookName", @@ -297,28 +277,28 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/WebhookUpdateParameters" + "$ref": "#/definitions/WebhookUpdateParameters" }, "description": "The update parameters for webhook." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/Webhook" + "$ref": "#/definitions/Webhook" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -341,14 +321,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "name": "automationAccountName", - "in": "path", - "required": true, - "type": "string", - "description": "The automation account name." + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "$filter", @@ -358,32 +334,225 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "./definitions.json#/definitions/WebhookListResult" + "$ref": "#/definitions/WebhookListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" - } + }, + "x-ms-odata": "#/definitions/Webhook" } } }, - "definitions": {}, + "definitions": { + "WebhookProperties": { + "properties": { + "isEnabled": { + "type": "boolean", + "default": false, + "description": "Gets or sets the value of the enabled flag of the webhook." + }, + "uri": { + "type": "string", + "description": "Gets or sets the webhook uri." + }, + "expiryTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the expiry time.", + "x-nullable": false + }, + "lastInvokedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last invoked time.", + "x-nullable": true + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with." + }, + "runbook": { + "$ref": "#/definitions/RunbookAssociationProperty", + "description": "Gets or sets the runbook the webhook is associated with." + }, + "runOn": { + "type": "string", + "description": "Gets or sets the name of the hybrid worker group the webhook job will run on." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the creation time.", + "x-nullable": false + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last modified time.", + "x-nullable": false + }, + "lastModifiedBy": { + "type": "string", + "description": "Details of the user who last modified the Webhook" + }, + "description": { + "type": "string", + "description": "Gets or sets the description." + } + }, + "description": "Definition of the webhook properties" + }, + "Webhook": { + "properties": { + "properties": { + "$ref": "#/definitions/WebhookProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the webhook properties." + } + }, + "description": "Definition of the webhook type.", + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ] + }, + "WebhookListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Webhook" + }, + "description": "Gets or sets a list of webhooks." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the next link." + } + }, + "description": "The response model for the list webhook operation." + }, + "WebhookUpdateProperties": { + "properties": { + "isEnabled": { + "type": "boolean", + "description": "Gets or sets the value of the enabled flag of webhook." + }, + "runOn": { + "type": "string", + "description": "Gets or sets the name of the hybrid worker group the webhook job will run on." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the parameters of the job." + }, + "description": { + "type": "string", + "description": "Gets or sets the description of the webhook." + } + }, + "description": "The properties of the update webhook." + }, + "WebhookUpdateParameters": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the webhook." + }, + "properties": { + "$ref": "#/definitions/WebhookUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the value of the webhook." + } + }, + "description": "The parameters supplied to the update webhook operation." + }, + "RunbookAssociationProperty": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the runbook." + } + }, + "description": "The runbook property associated with the entity." + }, + "WebhookCreateOrUpdateParameters": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the webhook." + }, + "properties": { + "$ref": "#/definitions/WebhookCreateOrUpdateProperties", + "x-ms-client-flatten": true, + "description": "Gets or sets the properties of the webhook." + } + }, + "required": [ + "name", + "properties" + ], + "description": "The parameters supplied to the create or update webhook operation." + }, + "WebhookCreateOrUpdateProperties": { + "properties": { + "isEnabled": { + "type": "boolean", + "description": "Gets or sets the value of the enabled flag of webhook." + }, + "uri": { + "type": "string", + "description": "Gets or sets the uri." + }, + "expiryTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the expiry time.", + "x-nullable": false + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the parameters of the job." + }, + "runbook": { + "$ref": "#/definitions/RunbookAssociationProperty", + "description": "Gets or sets the runbook." + }, + "runOn": { + "type": "string", + "description": "Gets or sets the name of the hybrid worker group the webhook job will run on." + } + }, + "description": "The properties of the create webhook operation." + } + }, "parameters": {} -} +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/definitions.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/definitions.json deleted file mode 100644 index 9edd1bc6458d..000000000000 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/definitions.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "AutomationManagement", - "version": "2018-01-15", - "x-ms-code-generation-settings": { - "useDateTimeOffset": true - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": {}, - "definitions": { - "ErrorResponse": { - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - }, - "description": "Error response of an operation failure" - }, - "Resource": { - "description": "The core properties of ARM resources", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Fully qualified resource Id for the resource" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The name of the resource" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "The type of the resource." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "The resource model definition for a ARM tracked top level resource", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags." - }, - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The Azure Region where the resource lives" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "ProxyResource": { - "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - }, - "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." - }, - "AutomationAccountNameParameter": { - "name": "automationAccountName", - "description": "The name of the automation account.", - "type": "string", - "required": true, - "in": "path", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscCompilationJob.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscCompilationJob.json index 7bee84851d42..f64b0d34c175 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscCompilationJob.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscCompilationJob.json @@ -54,10 +54,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "compilationJobName", @@ -76,10 +76,10 @@ "description": "The parameters supplied to the create compilation job operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -92,7 +92,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -113,10 +113,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "compilationJobName", @@ -126,10 +126,10 @@ "description": "The the DSC configuration Id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -142,7 +142,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -165,10 +165,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "$filter", @@ -178,10 +178,10 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -194,7 +194,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -221,10 +221,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobId", @@ -235,10 +235,10 @@ "description": "The job id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -251,7 +251,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -274,10 +274,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "jobId", @@ -295,10 +295,10 @@ "description": "The job stream id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -311,7 +311,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -329,7 +329,7 @@ }, "allOf": [ { - "$ref": "./definitions.json#/definitions/ProxyResource" + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" } ], "description": "Definition of the Dsc Compilation job." @@ -347,7 +347,7 @@ }, "description": "Gets or sets the parameters of the job." }, - "newNodeConfigurationBuildVersionRequired": { + "incrementNodeConfigurationBuild": { "type": "boolean", "description": "If a new build version of NodeConfiguration is required." } @@ -588,27 +588,23 @@ "description": "Gets or sets the values of the job stream." } }, + "x-ms-client-flatten": true, "description": "Definition of the job stream." }, "JobProvisioningStateProperty": { - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state of the resource.", - "enum": [ - "Failed", - "Succeeded", - "Suspended", - "Processing" - ], - "x-ms-enum": { - "name": "JobProvisioningState", - "modelAsString": true - } - } - }, - "description": "The provisioning state property." + "readOnly": true, + "type": "string", + "description": "The provisioning state of the resource.", + "enum": [ + "Failed", + "Succeeded", + "Suspended", + "Processing" + ], + "x-ms-enum": { + "name": "JobProvisioningState", + "modelAsString": true + } } }, "parameters": {} diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNode.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNode.json index 741f3fd8f6e2..a569b4507507 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNode.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNode.json @@ -54,16 +54,16 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -76,7 +76,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -99,13 +99,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "parameters", @@ -117,7 +117,7 @@ "description": "The name of the agent registration key to be regenerated" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -130,7 +130,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -153,10 +153,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeId", @@ -166,10 +166,10 @@ "description": "The node id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -182,7 +182,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -203,10 +203,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeId", @@ -216,10 +216,10 @@ "description": "The node id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -232,7 +232,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -253,10 +253,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeId", @@ -275,10 +275,10 @@ "description": "Parameters supplied to the update dsc node." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -291,7 +291,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -310,14 +310,35 @@ "x-ms-examples": { "List DSC nodes by Automation Account": { "$ref": "./examples/listAllDscNodesByAutomationAccount.json" + }, + "List Paged DSC nodes by Automation Account with no filters": { + "$ref": "./examples/listPagedDscNodesByAutomationAccountWithNoFilter.json" + }, + "List Paged DSC nodes by Automation Account with name filter": { + "$ref": "./examples/listPagedDscNodesByAutomationAccountWithNameFilter.json" + }, + "List Paged DSC nodes by Automation Account with node status filter": { + "$ref": "./examples/listPagedDscNodesByAutomationAccountWithStatusFilter.json" + }, + "List Paged DSC nodes by Automation Account with Node Configuration Custom filter": { + "$ref": "./examples/listPagedDscNodesByAutomationAccountWithNodeConfigurationCustomFilter.json" + }, + "List Paged DSC nodes by Automation Account where Node Configurations are not assigned filter": { + "$ref": "./examples/listPagedDscNodesByAutomationAccountWithNodeConfigurationNotAssignedFilter.json" + }, + "List Paged DSC nodes by Automation Account with version filter": { + "$ref": "./examples/listPagedDscNodesByAutomationAccountWithVersionFilter.json" + }, + "List Paged DSC nodes with filters separated by 'and'": { + "$ref": "./examples/listPagedDscNodesByAutomationAccountWithCompositeFilter.json" } }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "$filter", @@ -327,10 +348,31 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "The number of rows to skip." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "The the number of rows to take." + }, + { + "name": "$inlinecount", + "in": "query", + "required": false, + "type": "string", + "description": "Return total rows." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -343,7 +385,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -370,10 +412,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeId", @@ -390,10 +432,10 @@ "description": "The filter to apply on the operation." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -406,7 +448,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -433,10 +475,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeId", @@ -453,10 +495,10 @@ "description": "The report id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -469,7 +511,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -492,10 +534,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeId", @@ -512,10 +554,10 @@ "description": "The report id." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -528,7 +570,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -821,7 +863,7 @@ }, "allOf": [ { - "$ref": "./definitions.json#/definitions/ProxyResource" + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" } ] }, @@ -849,6 +891,7 @@ "description": "Gets or sets the account id of the node." }, "nodeConfiguration": { + "x-nullable": true, "x-ms-client-flatten": true, "$ref": "#/definitions/DscNodeConfigurationAssociationProperty", "description": "Gets or sets the configuration of the node." @@ -865,6 +908,10 @@ "type": "string", "description": "Gets or sets the etag of the resource." }, + "totalCount": { + "type": "integer", + "description": "Gets the total number of records matching filter criteria." + }, "extensionHandler": { "type": "array", "description": "Gets or sets the list of extensionHandler properties for a Node.", @@ -945,6 +992,10 @@ "nextLink": { "type": "string", "description": "Gets or sets the next link." + }, + "totalCount": { + "type": "integer", + "description": "Gets the total number of nodes matching filter criteria." } }, "description": "The response model for the list dsc nodes operation." diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json index 7807397278bf..f81a73b5f6fb 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json @@ -53,13 +53,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeConfigurationName", @@ -69,7 +69,7 @@ "description": "The Dsc node configuration name." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -79,7 +79,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -100,13 +100,13 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeConfigurationName", @@ -116,7 +116,7 @@ "description": "The Dsc node configuration name." }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -129,7 +129,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -151,10 +151,10 @@ }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { "name": "nodeConfigurationName", @@ -173,10 +173,10 @@ "description": "The create or update parameters for configuration." }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -192,7 +192,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -211,20 +211,26 @@ "x-ms-examples": { "List DSC node configurations by Automation Account": { "$ref": "./examples/listDscNodeConfigurations.json" + }, + "List Paged DSC node configurations by Automation Account with no filter": { + "$ref": "./examples/listPagedDscNodeConfigurationsWithNoFilter.json" + }, + "List Paged DSC node configurations by Automation Account with name filter": { + "$ref": "./examples/listPagedDscNodeConfigurationsWithNameFilter.json" } }, "parameters": [ { - "$ref": "./definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "./definitions.json#/parameters/AutomationAccountNameParameter" + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" }, { - "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "./definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "name": "$filter", @@ -232,6 +238,27 @@ "required": false, "type": "string", "description": "The filter to apply on the operation." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "The number of rows to skip." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "The the number of rows to take." + }, + { + "name": "$inlinecount", + "in": "query", + "required": false, + "type": "string", + "description": "Return total rows." } ], "responses": { @@ -244,7 +271,7 @@ "default": { "description": "Automation error response describing why the operation failed.", "schema": { - "$ref": "./definitions.json#/definitions/ErrorResponse" + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -313,7 +340,7 @@ }, "allOf": [ { - "$ref": "./definitions.json#/definitions/ProxyResource" + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" } ], "description": "Definition of the dsc node configuration." @@ -364,6 +391,10 @@ "nextLink": { "type": "string", "description": "Gets or sets the next link." + }, + "totalCount": { + "type": "integer", + "description": "Gets or sets the total rows in query." } }, "description": "The response model for the list job operation." @@ -382,6 +413,7 @@ "description": "The dsc extensionHandler property associated with the node" }, "DscNodeConfigurationCreateOrUpdateParameters": { + "description": "The parameters supplied to the create or update node configuration operation.", "properties": { "properties": { "$ref": "#/definitions/DscNodeConfigurationCreateOrUpdateParametersProperties", @@ -407,10 +439,6 @@ "$ref": "#/definitions/ContentSource", "description": "Gets or sets the source." }, - "name": { - "type": "string", - "description": "Gets or sets the type of the parameter." - }, "configuration": { "$ref": "#/definitions/DscConfigurationAssociationProperty", "description": "Gets or sets the configuration of the node." @@ -422,10 +450,9 @@ }, "required": [ "source", - "name", "configuration" ], - "description": "The parameters supplied to the create or update node configuration operation." + "description": "The parameter properties supplied to the create or update node configuration operation." }, "DscConfigurationAssociationProperty": { "properties": { diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeCounts.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeCounts.json new file mode 100644 index 000000000000..735cee8df939 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeCounts.json @@ -0,0 +1,147 @@ +{ + "swagger": "2.0", + "info": { + "title": "AutomationManagement", + "version": "2018-01-15", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "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.Automation/automationAccounts/{automationAccountName}/nodecounts/{countType}": { + "get": { + "tags": [ + "NodeCountInformation" + ], + "operationId": "NodeCountInformation_Get", + "description": "Retrieve counts for Dsc Nodes.", + "externalDocs": { + "url": "http://aka.ms/azureautomationsdk/nodecounts" + }, + "x-ms-examples": { + "Get node's status counts": { + "$ref": "./examples/listPagedDscNodeStatusCounts.json" + }, + "Get node's node configuration counts": { + "$ref": "./examples/listPagedDscNodeConfigurationCounts.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/AutomationAccountNameParameter" + }, + { + "$ref": "#/parameters/CountTypeParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NodeCounts" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "NodeCounts": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeCount" + }, + "description": "Gets an array of counts" + }, + "totalCount": { + "type": "integer", + "description": "Gets the total number of records matching countType criteria." + } + }, + "description": "Gets the count of nodes by count type" + }, + "NodeCount": { + "description": "Number of nodes based on the Filter", + "properties": { + "name": { + "description": "Gets the name of a count type", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/NodeCountProperties" + } + } + }, + "NodeCountProperties": { + "properties": { + "count": { + "description": "Gets the count for the name", + "type": "integer" + } + } + } + }, + "parameters": { + "CountTypeParameter": { + "name": "countType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of counts to retrieve", + "enum": [ + "status", + "nodeconfiguration" + ], + "x-ms-enum": { + "name": "CountType", + "modelAsString": true + }, + "x-ms-parameter-location":"client" + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/createOrUpdateDscNodeConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/createOrUpdateDscNodeConfiguration.json index fd1fc0bc04ce..dba9edaf7e53 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/createOrUpdateDscNodeConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/createOrUpdateDscNodeConfiguration.json @@ -3,7 +3,6 @@ "subscriptionId": "subid", "resourceGroupName": "rg", "automationAccountName": "myAutomationAccount20", - "credentialName": "myCredential", "api-version": "2018-01-15", "nodeConfigurationName": "configName.nodeConfigName", "parameters": { @@ -19,7 +18,6 @@ "version": "1.0" }, "incrementNodeConfigurationBuild": true, - "name": "configName.nodeConfigName", "configuration": { "name": "configName" } diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeConfigurationCounts.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeConfigurationCounts.json new file mode 100644 index 000000000000..b1c05e9c00ca --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeConfigurationCounts.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "countType": "nodeconfiguration", + "api-version": "2018-01-15", + "$skip": 0, + "$top": 2, + "$inlinecount": "allpages" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "client.localhost", + "properties": { + "count": 24 + } + }, + { + "name": "server.localhost", + "properties": { + "count": 3 + } + } + ], + "totalCount": 16 + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeConfigurationsWithNameFilter.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeConfigurationsWithNameFilter.json new file mode 100644 index 000000000000..28514b23fcb0 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeConfigurationsWithNameFilter.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "api-version": "2018-01-15", + "$skip": 0, + "$top": 2, + "$inlinecount": "allpages", + "$filter": "contains('.localhost',name)" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupServer.localhost", + "type": "Microsoft.Automation/AutomationAccounts/nodeConfigurations", + "name": "server.localhost", + "properties": { + "configuration": { + "name": "SetupServer" + }, + "creationTime": "2017-03-28T23:17:06.8901968+00:00", + "lastModifiedTime": "2017-03-28T23:17:06.8901968+00:00", + "nodeCount": 2 + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupClient.localhost", + "type": "Microsoft.Automation/AutomationAccounts/nodeConfigurations", + "name": "SetupClient.localhost", + "properties": { + "configuration": { + "name": "SetupClient" + }, + "creationTime": "2017-03-28T23:17:06.8901968+00:00", + "lastModifiedTime": "2017-03-28T23:17:06.8901968+00:00", + "nodeCount": 6 + } + } + ], + "totalCount": 6 + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeConfigurationsWithNoFilter.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeConfigurationsWithNoFilter.json new file mode 100644 index 000000000000..753bbbca7276 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeConfigurationsWithNoFilter.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "api-version": "2018-01-15", + "$skip": 0, + "$top": 4, + "$inlinecount": "allpages" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupServer.localhost", + "type": "Microsoft.Automation/AutomationAccounts/nodeConfigurations", + "name": "server.localhost", + "properties": { + "configuration": { + "name": "SetupServer" + }, + "creationTime": "2017-03-28T23:17:06.8901968+00:00", + "lastModifiedTime": "2017-03-28T23:17:06.8901968+00:00", + "nodeCount": 2 + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SetupClient.localhost", + "type": "Microsoft.Automation/AutomationAccounts/nodeConfigurations", + "name": "SetupClient.localhost", + "properties": { + "configuration": { + "name": "SetupClient" + }, + "creationTime": "2017-03-28T23:17:06.8901968+00:00", + "lastModifiedTime": "2017-03-28T23:17:06.8901968+00:00", + "nodeCount": 6 + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/webServer.localhost", + "type": "Microsoft.Automation/AutomationAccounts/nodeConfigurations", + "name": "webServer.localhost", + "properties": { + "configuration": { + "name": "webServer" + }, + "creationTime": "2017-03-28T23:17:06.8901968+00:00", + "lastModifiedTime": "2017-03-28T23:17:06.8901968+00:00", + "nodeCount": 5 + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodeConfigurations/SqlServer.localhost", + "type": "Microsoft.Automation/AutomationAccounts/nodeConfigurations", + "name": "SqlServer.localhost", + "properties": { + "configuration": { + "name": "SqlServer" + }, + "creationTime": "2017-03-28T23:17:06.8901968+00:00", + "lastModifiedTime": "2017-03-28T23:17:06.8901968+00:00", + "nodeCount": 1 + } + } + ], + "totalCount": 12 + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeReportsByNode.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeReportsByNode.json new file mode 100644 index 000000000000..72002d34a646 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeReportsByNode.json @@ -0,0 +1,253 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "nodeId": "nodeId", + "reportId": "903a5ead-140c-11e7-a943-000d3a6140c9", + "api-version": "2018-01-15" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/903a5ead-140c-11e7-a943-000d3a6140c9", + "reportId": "903a5ead-140c-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T23:16:27.587+00:00", + "endTime": "2017-03-28T23:16:27.587+00:00", + "lastModifiedTime": "2017-03-28T23:16:29.4440401+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/903a5eac-140c-11e7-a943-000d3a6140c9", + "reportId": "903a5eac-140c-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T23:16:26.015+00:00", + "endTime": "2017-03-28T23:16:27.015+00:00", + "lastModifiedTime": "2017-03-28T23:16:28.3813034+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/77c280c2-140a-11e7-a943-000d3a6140c9", + "reportId": "77c280c2-140a-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T23:01:25.986+00:00", + "endTime": "2017-03-28T23:01:26.986+00:00", + "lastModifiedTime": "2017-03-28T23:01:28.216963+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/5f4f5382-1408-11e7-a943-000d3a6140c9", + "reportId": "5f4f5382-1408-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T22:46:27.668+00:00", + "endTime": "2017-03-28T22:46:28.668+00:00", + "lastModifiedTime": "2017-03-28T22:46:29.0439184+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/5f4f5381-1408-11e7-a943-000d3a6140c9", + "reportId": "5f4f5381-1408-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T22:46:25.957+00:00", + "endTime": "2017-03-28T22:46:26.957+00:00", + "lastModifiedTime": "2017-03-28T22:46:27.9498533+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/46d97d6a-1406-11e7-a943-000d3a6140c9", + "reportId": "46d97d6a-1406-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T22:31:25.941+00:00", + "endTime": "2017-03-28T22:31:26.941+00:00", + "lastModifiedTime": "2017-03-28T22:31:27.6825492+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/48c8e301-1404-11e7-a943-000d3a6140c9", + "reportId": "48c8e301-1404-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T22:17:10.163+00:00", + "endTime": "2017-03-28T22:17:10.163+00:00", + "lastModifiedTime": "2017-03-28T22:17:11.0040472+00:00", + "status": "Failed", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/2e63fdbc-1404-11e7-a943-000d3a6140c9", + "reportId": "2e63fdbc-1404-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T22:16:25.897+00:00", + "endTime": "2017-03-28T22:17:09.897+00:00", + "lastModifiedTime": "2017-03-28T22:16:27.3128731+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/15ee63e4-1402-11e7-a943-000d3a6140c9", + "reportId": "15ee63e4-1402-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T22:01:25.899+00:00", + "endTime": "2017-03-28T22:01:27.899+00:00", + "lastModifiedTime": "2017-03-28T22:01:26.6282252+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/0508f316-1400-11e7-a943-000d3a6140c9", + "reportId": "0508f316-1400-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T21:46:38.511+00:00", + "endTime": "2017-03-28T21:46:39.511+00:00", + "lastModifiedTime": "2017-03-28T21:46:40.577983+00:00", + "status": "Failed", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/fd799a51-13ff-11e7-a943-000d3a6140c9", + "reportId": "fd799a51-13ff-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T21:46:25.843+00:00", + "endTime": "2017-03-28T21:46:37.843+00:00", + "lastModifiedTime": "2017-03-28T21:46:28.4660077+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/e504ae1b-13fd-11e7-a943-000d3a6140c9", + "reportId": "e504ae1b-13fd-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T21:31:25.818+00:00", + "endTime": "2017-03-28T21:31:27.818+00:00", + "lastModifiedTime": "2017-03-28T21:31:28.1503168+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/cd3ed224-13fb-11e7-a943-000d3a6140c9", + "reportId": "cd3ed224-13fb-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T21:16:35.538+00:00", + "endTime": "2017-03-28T21:16:59.538+00:00", + "lastModifiedTime": "2017-03-28T21:16:37.1768158+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/cd3ed223-13fb-11e7-a943-000d3a6140c9", + "reportId": "cd3ed223-13fb-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T21:16:26.956+00:00", + "endTime": "2017-03-28T21:16:34.956+00:00", + "lastModifiedTime": "2017-03-28T21:16:29.2370664+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/b6915efa-13f9-11e7-a943-000d3a6140c9", + "reportId": "b6915efa-13f9-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T21:01:29.916+00:00", + "endTime": "2017-03-28T21:02:02.916+00:00", + "lastModifiedTime": "2017-03-28T21:01:31.875597+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/a3560dca-13f7-11e7-a943-000d3a6140c9", + "reportId": "a3560dca-13f7-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T20:46:38.626+00:00", + "endTime": "2017-03-28T20:46:44.626+00:00", + "lastModifiedTime": "2017-03-28T20:46:39.749649+00:00", + "status": "Failed", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/9b9bb016-13f7-11e7-a943-000d3a6140c9", + "reportId": "9b9bb016-13f7-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T20:46:25.676+00:00", + "endTime": "2017-03-28T20:46:37.676+00:00", + "lastModifiedTime": "2017-03-28T20:46:27.2602881+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId/reports/833bd89b-13f5-11e7-a943-000d3a6140c9", + "reportId": "833bd89b-13f5-11e7-a943-000d3a6140c9", + "type": "Consistency", + "startTime": "2017-03-28T20:31:25.805+00:00", + "endTime": "2017-03-28T20:40:24.805+00:00", + "lastModifiedTime": "2017-03-28T20:31:27.1356547+00:00", + "status": "Compliant", + "configurationVersion": "2.0.0", + "rebootRequested": "False", + "refreshMode": "Pull", + "reportFormatVersion": "2.0" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeStatusCounts.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeStatusCounts.json new file mode 100644 index 000000000000..76b9b893c433 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodeStatusCounts.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "api-version": "2018-01-15", + "$skip": 0, + "$top": 20, + "$inlinecount": "allpages", + "countType": "status" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Compliant", + "properties": { + "count": 10 + } + }, + { + "name": "Failed", + "properties": { + "count": 1 + } + }, + { + "name": "InProgress", + "properties": { + "count": 1 + } + }, + { + "name": "NotCompliant", + "properties": { + "count": 3 + } + }, + { + "name": "Pending", + "properties": { + "count": 0 + } + }, + { + "name": "Unresponsive", + "properties": { + "count": 4 + } + } + ], + "totalCount": 6 + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithCompositeFilter.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithCompositeFilter.json new file mode 100644 index 000000000000..66f1e11caede --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithCompositeFilter.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "api-version": "2018-01-15", + "$skip": 0, + "$top": 10, + "$inlinecount": "allpages", + "$filter": "properties/extensionHandler/any(eh: eh/version gt '2.70') and contains(name,'sql') and contains(properties/nodeConfiguration/name,'$$Not$$Configured$$')" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Sql1", + "name": "Sql1", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "01D64CDE-85DD-4C9B-B8F1-2F725348FDEC", + "status": "Compliant", + "nodeConfiguration": { + "name": "SetupSqlServer.localhost" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.70.0.1" + } + ] + } + } + ], + "totalCount": 1 + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithNameFilter.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithNameFilter.json new file mode 100644 index 000000000000..2d112be9fd62 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithNameFilter.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "api-version": "2018-01-15", + "$skip": 0, + "$top": 6, + "$inlinecount": "allpages", + "$filter": "contains('DSCCOMP',name)" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/DSCCOMP", + "name": "DSCCOMP", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "708D250A-2169-4B54-89FF-76F5F71C252A", + "status": "Compliant", + "nodeConfiguration": { + "name": "SetupServer.localhost" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.75.0.0" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/DSCCOMP2", + "name": "DSCCOMP2", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "3B4BB31A-5132-4669-A15F-A17E234D1634", + "status": "Failed", + "nodeConfiguration": { + "name": "SetupServer.localhost" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.75.0.0" + } + ] + } + } + ], + "totalCount": 2 + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithNoFilter.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithNoFilter.json new file mode 100644 index 000000000000..7f4a0bf15d1b --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithNoFilter.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "api-version": "2018-01-15", + "$skip": 0, + "$top": 2, + "$inlinecount": "allpages" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId", + "name": "DSCCOMP", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "FCC20208-E781-41C4-A757-17AA0429B3A4", + "status": "Pending", + "nodeConfiguration": { + "name": "SetupServer.localhost" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.75.0.0" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId2", + "name": "DSCCOMP2", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "A63C781C-0C50-4825-B295-B7F8ECFD0DBC", + "status": "Pending", + "nodeConfiguration": { + "name": "SetupServer.localhost" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.75.0.0" + } + ] + } + } + ], + "totalCount": 152 + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithNodeConfigurationCustomFilter.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithNodeConfigurationCustomFilter.json new file mode 100644 index 000000000000..1f2dc35f87f3 --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithNodeConfigurationCustomFilter.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "api-version": "2018-01-15", + "$skip": 0, + "$top": 4, + "$inlinecount": "allpages", + "$filter": "contains(properties/nodeConfiguration/name,'SetupServer.localhost,SetupClient.localhost,$$Not$$Configured$$')" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node32", + "name": "Node32", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "477F9596-92F3-479A-82F2-9EE149F2C6B0", + "status": "Compliant", + "nodeConfiguration": { + "name": "" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.75.0.0" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node33", + "name": "Node33", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "E5D5D0B5-400D-48F7-A791-612945DAC5EB", + "status": "Compliant", + "nodeConfiguration": { + "name": "SetupServer.localhost" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.75.0.0" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node34", + "name": "Node34", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "Node34", + "status": "Compliant", + "nodeConfiguration": { + "name": "SetupClient.localhost" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.75.0.0" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node35", + "name": "Node35", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "Node35", + "status": "NotCompliant", + "nodeConfiguration": { + "name": "SetupClient.localhost" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.75.0.0" + } + ] + } + } + ], + "totalCount": 12 + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithNodeConfigurationNotAssignedFilter.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithNodeConfigurationNotAssignedFilter.json new file mode 100644 index 000000000000..fb062228fd8c --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithNodeConfigurationNotAssignedFilter.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "api-version": "2018-01-15", + "$skip": 0, + "$top": 20, + "$inlinecount": "allpages", + "$filter": "properties/nodeConfiguration/name eq ''" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node60", + "name": "Node60", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "477F9596-92F3-479A-82F2-9EE149F2C6B0", + "status": "Compliant", + "nodeConfiguration": { + "name": "" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.75.0.0" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node61", + "name": "Node61", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "E5D5D0B5-400D-48F7-A791-612945DAC5EB", + "status": "Compliant", + "nodeConfiguration": { + "name": "" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.75.0.0" + } + ] + } + } + ], + "totalCount": 2 + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithStatusFilter.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithStatusFilter.json new file mode 100644 index 000000000000..d0332846cd8b --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithStatusFilter.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "api-version": "2018-01-15", + "$skip": 0, + "$top": 4, + "$inlinecount": "allpages", + "$filter": "contains(properties/status,'Compliant,NotCompliant')" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node12", + "name": "Node12", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "01D64CDE-85DD-4C9B-B8F1-2F725348FDEC", + "status": "Compliant", + "nodeConfiguration": { + "name": "SetupServer.localhost" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.75.0.0" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node13", + "name": "Node13", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "E13076D7-A959-4067-B02F-4F014AAD22D7", + "status": "Compliant", + "nodeConfiguration": { + "name": "SetupServer.localhost" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.75.0.0" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node14", + "name": "Node14", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "4289B441-B9A0-4309-93FC-0C5100CFBE46", + "status": "Compliant", + "nodeConfiguration": { + "name": "SetupServer.localhost" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.75.0.0" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node15", + "name": "Node15", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "CBD2212B-8F4C-4049-98E7-1DBCBED7343B", + "status": "NotCompliant", + "nodeConfiguration": { + "name": "SetupServer.localhost" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.75.0.0" + } + ] + } + } + ], + "totalCount": 67 + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithVersionFilter.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithVersionFilter.json new file mode 100644 index 000000000000..a86f8501745d --- /dev/null +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/examples/listPagedDscNodesByAutomationAccountWithVersionFilter.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "myAutomationAccount33", + "api-version": "2018-01-15", + "$skip": 0, + "$top": 4, + "$inlinecount": "allpages", + "$filter": "properties/extensionHandler/any(eh: eh/version le '2.70')" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node62", + "name": "Node62", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "01D64CDE-85DD-4C9B-B8F1-2F725348FDEC", + "status": "Compliant", + "nodeConfiguration": { + "name": "SetupServer.localhost" + }, + "extensionHandler": null + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node63", + "name": "Node63", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "E13076D7-A959-4067-B02F-4F014AAD22D7", + "status": "Compliant", + "nodeConfiguration": { + "name": "SetupServer.localhost" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.70.0.0" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node64", + "name": "Node64", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "4289B441-B9A0-4309-93FC-0C5100CFBE46", + "status": "Compliant", + "nodeConfiguration": { + "name": "SetupServer.localhost" + }, + "extensionHandler": [ + { + "name": "Microsoft.Powershell.DSC", + "version": "2.70.0.0" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/Node65", + "name": "Node65", + "type": "Microsoft.Automation/AutomationAccounts/Nodes", + "properties": { + "lastSeen": "2018-03-22T22:25:39.0963773+00:00", + "registrationTime": "2018-03-10T00:51:12.5393083+00:00", + "ip": "ip", + "nodeId": "CBD2212B-8F4C-4049-98E7-1DBCBED7343B", + "status": "NotCompliant", + "nodeConfiguration": { + "name": "SetupServer.localhost" + }, + "extensionHandler": null + } + } + ], + "totalCount": 7 + } + } + } +} \ No newline at end of file diff --git a/specification/automation/resource-manager/readme.md b/specification/automation/resource-manager/readme.md index 0685cbfe3c82..1ca1624af60b 100644 --- a/specification/automation/resource-manager/readme.md +++ b/specification/automation/resource-manager/readme.md @@ -39,7 +39,6 @@ input-file: - Microsoft.Automation/stable/2015-10-31/connection.json - Microsoft.Automation/stable/2015-10-31/connectionType.json - Microsoft.Automation/stable/2015-10-31/credential.json -- Microsoft.Automation/stable/2015-10-31/definitions.json - Microsoft.Automation/stable/2015-10-31/dscCompilationJob.json - Microsoft.Automation/stable/2015-10-31/dscConfiguration.json - Microsoft.Automation/stable/2015-10-31/dscNode.json @@ -67,7 +66,6 @@ input-file: - Microsoft.Automation/stable/2015-10-31/connection.json - Microsoft.Automation/stable/2015-10-31/connectionType.json - Microsoft.Automation/stable/2015-10-31/credential.json -- Microsoft.Automation/stable/2015-10-31/definitions.json - Microsoft.Automation/stable/2015-10-31/dscCompilationJob.json - Microsoft.Automation/stable/2015-10-31/dscConfiguration.json - Microsoft.Automation/stable/2015-10-31/dscNode.json @@ -80,12 +78,12 @@ input-file: - Microsoft.Automation/stable/2015-10-31/schedule.json - Microsoft.Automation/stable/2015-10-31/variable.json - Microsoft.Automation/stable/2015-10-31/webhook.json -- Microsoft.Automation/preview/2017-05-15-preview/definitions.json - Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json - Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json - Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json - Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json - Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json +- Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJobStreams.json - Microsoft.Automation/preview/2017-05-15-preview/job.json ``` @@ -100,7 +98,6 @@ input-file: - Microsoft.Automation/stable/2015-10-31/connection.json - Microsoft.Automation/stable/2015-10-31/connectionType.json - Microsoft.Automation/stable/2015-10-31/credential.json -- Microsoft.Automation/stable/2015-10-31/definitions.json - Microsoft.Automation/stable/2015-10-31/dscConfiguration.json - Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json - Microsoft.Automation/stable/2015-10-31/jobSchedule.json @@ -110,17 +107,18 @@ input-file: - Microsoft.Automation/stable/2015-10-31/schedule.json - Microsoft.Automation/stable/2015-10-31/variable.json - Microsoft.Automation/stable/2015-10-31/webhook.json -- Microsoft.Automation/preview/2017-05-15-preview/definitions.json +- Microsoft.Automation/stable/2015-10-31/watcher.json - Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json - Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json - Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json - Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json - Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json +- Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJobStreams.json - Microsoft.Automation/preview/2017-05-15-preview/job.json -- Microsoft.Automation/stable/2018-01-15/definitions.json - Microsoft.Automation/stable/2018-01-15/dscNode.json - Microsoft.Automation/stable/2018-01-15/dscCompilationJob.json - Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json +- Microsoft.Automation/stable/2018-01-15/dscNodeCounts.json ``` --- @@ -128,11 +126,23 @@ input-file: ``` yaml directive: - suppress: RequiredPropertiesMissingInResourceModel - from: definitions.json + from: runbook.json where: $.definitions.TestJob - suppress: BodyTopLevelProperties - from: definitions.json + from: runbook.json where: $.definitions.TestJob.properties + - suppress: DefinitionsPropertiesNamesCamelCase + from: account.json + where: $.definitions.Key.properties.KeyName + - suppress: DefinitionsPropertiesNamesCamelCase + from: account.json + where: $.definitions.Key.properties.Permissions + - suppress: DefinitionsPropertiesNamesCamelCase + from: account.json + where: $.definitions.Key.properties.Value + - suppress: LongRunningResponseStatusCode + from: runbook.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/publish"].post["x-ms-long-running-operation"] ``` --- @@ -148,6 +158,9 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_automation'] ``` @@ -228,7 +241,16 @@ These settings apply only when `--tag=package-2017-05-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-05-preview' && $(go) -output-folder: $(go-sdk-folder)/services/automation/mgmt/2017-05-15-preview/automation +output-folder: $(go-sdk-folder)/services/preview/automation/mgmt/2017-05-15-preview/automation +``` + +### Tag: package-2018-01-preview and go + +These settings apply only when `--tag=package-2018-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/automation/mgmt/2018-01-preview/automation ``` ## Java @@ -237,11 +259,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.automation +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-automation +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-10 +``` + +### Tag: package-2015-10 and java + +These settings apply only when `--tag=package-2015-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-10' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.automation - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-automation + namespace: com.microsoft.azure.management.automation.v2015_10_31 + output-folder: $(azure-libraries-for-java-folder)/automation/resource-manager/v2015_10_31 +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/automation/resource-manager/readme.ruby.md b/specification/automation/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..c02558e9a0b4 --- /dev/null +++ b/specification/automation/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_automation +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2015-10 +``` + +### Tag: package-2015-10 and ruby + +These settings apply only when `--tag=package-2015-10 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-10' && $(ruby) +namespace: "Azure::Automation::Mgmt::V2015_10_31" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_automation/lib +``` diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/Alert.json b/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/Alert.json deleted file mode 100644 index f7c3247abc14..000000000000 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/Alert.json +++ /dev/null @@ -1,350 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "Alert operation endpoints and objects.", - "title": "InfrastructureInsightsManagementClient", - "version": "2016-05-01" - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/alerts": { - "get": { - "x-ms-examples": { - "List all alerts": { - "$ref": "./examples/Alert/AlertListOperation_example.json" - } - }, - "tags": [ - "Alerts" - ], - "description": "Returns the list of all alerts in a given location.", - "operationId": "Alerts_List", - "parameters": [ - { - "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" - }, - { - "$ref": "InfrastructureInsights.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "InfrastructureInsights.json#/parameters/FilterParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AlertList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/Alert", - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/alerts/{alertName}": { - "get": { - "x-ms-examples": { - "Get an alert": { - "$ref": "./examples/Alert/AlertGetOperation_example.json" - } - }, - "tags": [ - "Alerts" - ], - "description": "Get an alert.", - "operationId": "Alerts_Get", - "parameters": [ - { - "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" - }, - { - "$ref": "#/parameters/AlertNameParameter" - }, - { - "$ref": "InfrastructureInsights.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Alert" - } - } - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ] - }, - "put": { - "x-ms-examples": { - "Close an alert": { - "$ref": "./examples/Alert/AlertCloseOperation_example.json" - } - }, - "tags": [ - "Alerts" - ], - "description": "Close an alert.", - "operationId": "Alerts_Close", - "parameters": [ - { - "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" - }, - { - "$ref": "#/parameters/AlertNameParameter" - }, - { - "$ref": "InfrastructureInsights.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/UserParameter" - }, - { - "$ref": "#/parameters/AlertParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Alert" - } - } - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ] - } - } - }, - "definitions": { - "Alert": { - "description": "This class models an alert resource.", - "properties": { - "properties": { - "description": "Holds all information related to Alerts", - "$ref": "#/definitions/AlertModel", - "x-ms-client-flatten": true - } - }, - "allOf": [ - { - "$ref": "InfrastructureInsights.json#/definitions/Resource" - } - ] - }, - "AlertModel": { - "description": "Holds Alert data", - "properties": { - "closedTimestamp": { - "description": "Gets or sets the closed timestamp of the alert.", - "type": "string" - }, - "createdTimestamp": { - "description": "Gets or sets the created timestamp of the alert.", - "type": "string" - }, - "description": { - "description": "Gets or sets the description of the alert.", - "type": "array", - "items": { - "$ref": "InfrastructureInsights.json#/definitions/Dictionary" - } - }, - "faultId": { - "description": "Gets or sets the fault id of the alert.", - "type": "string" - }, - "alertId": { - "description": "Gets or sets the id of the alert.", - "type": "string" - }, - "faultTypeId": { - "description": "Gets or sets the fault type id of the alert.", - "type": "string" - }, - "lastUpdatedTimestamp": { - "description": "Gets or sets last updated timestamp of the alert.", - "type": "string" - }, - "alertProperties": { - "description": "Gets or sets properties of the alert.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "remediation": { - "description": "Gets or sets the admin friendly remediation instructions for the alert.", - "type": "array", - "items": { - "$ref": "InfrastructureInsights.json#/definitions/Dictionary" - } - }, - "resourceRegistrationId": { - "description": "Gets or sets the registration id of the atomic component the alert belongs to. This is null if not associated with a resource.", - "type": "string" - }, - "resourceProviderRegistrationId": { - "description": "Gets or sets the registration id of the service the alert belongs to.", - "type": "string" - }, - "severity": { - "description": "Gets or sets the severity of the alert.", - "type": "string" - }, - "state": { - "description": "Gets or sets the state of the alert.", - "type": "string" - }, - "title": { - "description": "Gets or sets the ResourceId for the impacted item.", - "type": "string" - }, - "impactedResourceId": { - "description": "Gets or sets the ResourceId for the impacted item.", - "type": "string" - }, - "impactedResourceDisplayName": { - "description": "Gets or sets the display name for the impacted item.", - "type": "string" - }, - "closedByUserAlias": { - "description": "Gets or sets the user alias who closed the alert.", - "type": "string" - } - } - }, - "AlertList": { - "description": "A pageable list of Alerts", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Alert" - }, - "description": "Holds all alerts in this page." - }, - "nextLink": { - "type": "string", - "description": "Points to the next page." - } - } - } - }, - "parameters": { - "AlertNameParameter": { - "name": "alertName", - "description": "Name of the alert.", - "type": "string", - "required": true, - "in": "path", - "x-ms-parameter-location": "method" - }, - "RetentionPeriodInDaysBodyParameter": { - "name": "retentionPeriodInDays", - "description": "How long alerts should exist before deletion.", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true, - "in": "body", - "x-ms-parameter-location": "method" - }, - "ResourceProviderRegistrationIdBodyParameter": { - "description": "A resource provider registration id.", - "name": "resourceProviderRegistrationId", - "schema": { - "type": "string" - }, - "required": true, - "in": "body", - "x-ms-parameter-location": "method" - }, - "ResourceRegistrationIdBodyParameter": { - "description": "A resource provider id.", - "name": "resourceRegistrationId", - "schema": { - "type": "string" - }, - "required": true, - "in": "body", - "x-ms-parameter-location": "method" - }, - "HeartbeatMachineNameBodyParameter": { - "description": "Name of a heartbeat machine.", - "name": "heartbeatMachineName", - "schema": { - "type": "string" - }, - "required": true, - "in": "body", - "x-ms-parameter-location": "method" - }, - "UserParameter": { - "description": "The username used to perform the operation.", - "name": "user", - "type": "string", - "required": true, - "in": "query", - "x-ms-parameter-location": "method" - }, - "AlertParameter": { - "description": "Updated Alert Parameter.", - "name": "alert", - "schema": { - "$ref": "#/definitions/Alert" - }, - "required": true, - "in": "body", - "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" - ] - } - ] -} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/InfrastructureInsights.json b/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/InfrastructureInsights.json deleted file mode 100644 index 5a7a7354e9b3..000000000000 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/InfrastructureInsights.json +++ /dev/null @@ -1,241 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2016-05-01", - "title": "InfrastructureInsightsManagementClient", - "description": "The Admin Infrastructure Insights Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "paths": {}, - "definitions": { - "Dictionary": { - "description": "dictionary", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "BaseHealth": { - "description": "Models the base properties for health resource.", - "properties": { - "alertSummary": { - "description": "Gets or sets the alert summary.", - "$ref": "#/definitions/AlertSummary" - }, - "healthState": { - "description": "Gets or sets the health status.", - "type": "string" - }, - "namespace": { - "description": "Gets or sets the name space.", - "type": "string" - }, - "registrationId": { - "description": "Gets or sets the registration id.", - "type": "string" - }, - "routePrefix": { - "description": "Gets or sets the route prefix.", - "type": "string" - } - } - }, - "Resource": { - "description": "Base Resource Object", - "type": "object", - "properties": { - "id": { - "description": "URI of the resource.", - "type": "string" - }, - "name": { - "readOnly": true, - "description": "Name of the resource.", - "type": "string" - }, - "type": { - "readOnly": true, - "description": "Type of resource.", - "type": "string" - }, - "location": { - "readOnly": true, - "description": "Location where resource is location.", - "type": "string" - }, - "tags": { - "readOnly": true, - "description": "List of key value pairs.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "x-ms-azure-resource": true - }, - "AlertSummary": { - "description": "Summary of the alerts.", - "properties": { - "criticalAlertCount": { - "description": "How many critical alerts this service has.", - "type": "integer" - }, - "warningAlertCount": { - "description": "How many warning alerts this service has.", - "type": "integer" - } - } - }, - "Metrics": { - "description": "Metrics for a source.", - "properties": { - "name": { - "description": "Name of the usage metric.", - "type": "string" - }, - "maCounterName": { - "description": "Name of the usage metric.", - "type": "string" - }, - "observedTimestamp": { - "description": "Name of the usage metric.", - "type": "string", - "format": "date-time" - }, - "sourceType": { - "description": "Name of the usage metric.", - "type": "string" - }, - "sourceName": { - "description": "Source of the metric.", - "$ref": "#/definitions/MetricsSourceType" - }, - "unit": { - "description": "Unit for the metric.", - "$ref": "#/definitions/MetricsUnit" - }, - "value": { - "description": "Name of the usage metric.", - "type": "number", - "format": "double" - } - } - }, - "MetricsSourceType": { - "type": "string", - "description": "What created the metric.", - "enum": [ - "PhysicalNode", - "VirtualMachine", - "ResourceProvider" - ], - "x-ms-enum": { - "name": "MetricsSourceType", - "modelAsString": true - } - }, - "MetricsUnit": { - "type": "string", - "description": "The unit of the metric.", - "enum": [ - "One", - "Percentage", - "B", - "KB", - "MB", - "GB", - "TB" - ], - "x-ms-enum": { - "name": "MetricsUnit", - "modelAsString": true - } - }, - "UsageMetrics": { - "description": "Metrics of resource usage.", - "properties": { - "name": { - "description": "Name of the usage metric.", - "type": "string" - }, - "metricsValue": { - "description": "List of usage metrics.", - "type": "array", - "items": { - "$ref": "#/definitions/Metrics" - } - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.", - "required": true, - "type": "string" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client Api Version.", - "required": true, - "type": "string", - "default": "2016-05-01" - }, - "FilterParameter": { - "description": "OData filter parameter.", - "name": "$filter", - "in": "query", - "type": "string", - "x-ms-parameter-location": "method" - }, - "LocationParameter": { - "description": "Location name.", - "name": "location", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ResourceRegistrationIdParameter": { - "description": "Resource registration id.", - "name": "resourceRegistrationId", - "type": "string", - "required": true, - "in": "path", - "x-ms-parameter-location": "method" - }, - "ServiceRegistrationIdParameter": { - "description": "Service registration id.", - "name": "serviceRegistrationId", - "type": "string", - "required": true, - "in": "path", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/ServiceHealth.json b/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/ServiceHealth.json deleted file mode 100644 index 9d45de31cd3f..000000000000 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/ServiceHealth.json +++ /dev/null @@ -1,185 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "Service health operation endpoints and objects.", - "title": "InfrastructureInsightsManagementClient", - "version": "2016-05-01" - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/serviceHealths": { - "get": { - "x-ms-examples": { - "List all services health": { - "$ref": "./examples/ServiceHealth/ServiceHealthListOperation_example.json" - } - }, - "tags": [ - "ServiceHealths" - ], - "description": "Get a list of all services health", - "operationId": "ServiceHealths_List", - "parameters": [ - { - "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" - }, - { - "$ref": "InfrastructureInsights.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "InfrastructureInsights.json#/parameters/FilterParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceHealthList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/ServiceHealth", - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/serviceHealths/{serviceHealth}": { - "get": { - "x-ms-examples": { - "Get a services health": { - "$ref": "./examples/ServiceHealth/ServiceHealthGetOperation_example.json" - } - }, - "tags": [ - "ServiceHealths" - ], - "description": "Get a services health", - "operationId": "ServiceHealths_Get", - "parameters": [ - { - "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" - }, - { - "$ref": "#/parameters/ServiceHealthParameter" - }, - { - "$ref": "InfrastructureInsights.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceHealth" - } - } - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ] - } - } - }, - "definitions": { - "ServiceHealth": { - "description": "Holds information about a services health.", - "properties": { - "properties": { - "description": "Holds information about a services health.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ServiceHealthModel" - } - }, - "allOf": [ - { - "$ref": "InfrastructureInsights.json#/definitions/Resource" - } - ] - }, - "ServiceHealthModel": { - "description": "Holds information about a services health.", - "properties": { - "displayName": { - "description": "Name of the alert.", - "type": "string" - }, - "serviceLocation": { - "description": "Location of the service.", - "type": "string" - }, - "infraURI": { - "description": "The route prefix to the alert.", - "type": "string" - } - }, - "allOf": [ - { - "$ref": "InfrastructureInsights.json#/definitions/BaseHealth" - } - ] - }, - "ServiceHealthList": { - "description": "Pageable list of service health instances.", - "properties": { - "value": { - "description": "Array of service health instances.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceHealth" - } - }, - "nextLink": { - "description": "URI of the next page.", - "type": "string" - } - } - } - }, - "parameters": { - "ServiceHealthParameter": { - "description": "Service Health name.", - "name": "serviceHealth", - "type": "string", - "required": true, - "in": "path", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/Alert/AlertCloseOperation_example.json b/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/Alert/AlertCloseOperation_example.json deleted file mode 100644 index b4b4cd937e07..000000000000 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/Alert/AlertCloseOperation_example.json +++ /dev/null @@ -1,83 +0,0 @@ -{ - "parameters": { - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "location": "local", - "alertName": "ca55be03-9be9-4deb-8467-e890ab1d116b", - "alert": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/alerts/ca55be03-9be9-4deb-8467-e890ab1d116b", - "name": "ca55be03-9be9-4deb-8467-e890ab1d116b", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/alerts", - "location": "local", - "tags": {}, - "properties": { - "state": "Closed", - "closedByUserAlias": "ciserviceadmin@msazurestack.onmicrosoft.com" - } - }, - "user": "ciserviceadmin@msazurestack.onmicrosoft.com", - "api-version": "2016-05-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/alerts/ca55be03-9be9-4deb-8467-e890ab1d116b", - "name": "ca55be03-9be9-4deb-8467-e890ab1d116b", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/alerts", - "location": "local", - "tags": {}, - "properties": { - "closedTimestamp": "", - "createdTimestamp": "2017-08-12T20:28:56.912712Z", - "description": [ - { - "text": "The infrastructure role Infrastructure management controller is experiencing issues.", - "type": "Text" - } - ], - "faultId": "ServiceFabric:/FabricControllerRing/FabricControllerRing", - "alertId": "ca55be03-9be9-4deb-8467-e890ab1d116b", - "faultTypeId": "ServiceFabricClusterUnhealthy", - "lastUpdatedTimestamp": "2017-08-12T20:28:56.912712Z", - "alertProperties": { - "healthState": "Warning", - "name": "Infrastructure management controller", - "fabricName": "FabricControllerRing", - "description": "", - "serviceType": "FabricControllerRing" - }, - "remediation": [ - { - "text": "Please contact Support. Before you do, start the log file collection process using the guidance from ", - "type": "Text" - }, - { - "linkType": "Uri", - "uri": "https://aka.ms/azurestacklogfiles", - "resourceId": "", - "type": "LinkBegin" - }, - { - "text": "https://aka.ms/azurestacklogfiles", - "type": "Text" - }, - { - "type": "LinkEnd" - }, - { - "text": ".", - "type": "Text" - } - ], - "resourceRegistrationId": "7cd4c25c-e946-4502-926b-e3c32737b116", - "resourceProviderRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "severity": "Warning", - "state": "Closed", - "title": "Infrastructure role is unhealthy", - "impactedResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/FabricControllerRing", - "impactedResourceDisplayName": "Infrastructure management controller", - "closedByUserAlias": "ciserviceadmin@msazurestack.onmicrosoft.com" - } - } - } - } -} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/Alert/AlertGetOperation_example.json b/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/Alert/AlertGetOperation_example.json deleted file mode 100644 index c33dbe10e6aa..000000000000 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/Alert/AlertGetOperation_example.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "parameters": { - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "location": "local", - "alertName": "ca55be03-9be9-4deb-8467-e890ab1d116b", - "api-version": "2016-05-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/alerts/ca55be03-9be9-4deb-8467-e890ab1d116b", - "name": "ca55be03-9be9-4deb-8467-e890ab1d116b", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/alerts", - "location": "local", - "tags": {}, - "properties": { - "closedTimestamp": "", - "createdTimestamp": "2017-08-12T20:28:56.912712Z", - "description": [ - { - "text": "The infrastructure role Infrastructure management controller is experiencing issues.", - "type": "Text" - } - ], - "faultId": "ServiceFabric:/FabricControllerRing/FabricControllerRing", - "alertId": "ca55be03-9be9-4deb-8467-e890ab1d116b", - "faultTypeId": "ServiceFabricClusterUnhealthy", - "lastUpdatedTimestamp": "2017-08-12T20:28:56.912712Z", - "alertProperties": { - "healthState": "Warning", - "name": "Infrastructure management controller", - "fabricName": "FabricControllerRing", - "description": "", - "serviceType": "FabricControllerRing" - }, - "remediation": [ - { - "text": "Please contact Support. Before you do, start the log file collection process using the guidance from ", - "type": "Text" - }, - { - "linkType": "Uri", - "uri": "https://aka.ms/azurestacklogfiles", - "resourceId": "", - "type": "LinkBegin" - }, - { - "text": "https://aka.ms/azurestacklogfiles", - "type": "Text" - }, - { - "type": "LinkEnd" - }, - { - "text": ".", - "type": "Text" - } - ], - "resourceRegistrationId": "7cd4c25c-e946-4502-926b-e3c32737b116", - "resourceProviderRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "severity": "Warning", - "state": "Active", - "title": "Infrastructure role is unhealthy", - "impactedResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/FabricControllerRing", - "impactedResourceDisplayName": "Infrastructure management controller", - "closedByUserAlias": "" - } - } - } - } -} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/Alert/AlertListOperation_example.json b/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/Alert/AlertListOperation_example.json deleted file mode 100644 index 84e9be7df957..000000000000 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/Alert/AlertListOperation_example.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "parameters": { - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "location": "local", - "api-version": "2016-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/alerts/1fcf80bb-f889-44c5-8591-efd191812385", - "name": "1fcf80bb-f889-44c5-8591-efd191812385", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/alerts", - "location": "local", - "tags": {}, - "properties": { - "closedTimestamp": "", - "createdTimestamp": "2017-08-12T20:28:56.897087Z", - "description": [ - { - "text": "The infrastructure role Capacity is experiencing issues.", - "type": "Text" - } - ], - "faultId": "ServiceFabric:/FabricResourceProvider/fabric:/FabricResourceProvider", - "alertId": "1fcf80bb-f889-44c5-8591-efd191812385", - "faultTypeId": "ServiceFabricApplicationUnhealthy", - "lastUpdatedTimestamp": "2017-08-12T20:28:56.897087Z", - "alertProperties": { - "healthState": "Warning", - "name": "Capacity", - "fabricName": "fabric:/FabricResourceProvider", - "description": "", - "serviceType": "FabricResourceProvider" - }, - "remediation": [ - { - "text": "Please contact Support. Before you do, start the log file collection process using the guidance from ", - "type": "Text" - }, - { - "linkType": "Uri", - "uri": "https://aka.ms/azurestacklogfiles", - "resourceId": "", - "type": "LinkBegin" - }, - { - "text": "https://aka.ms/azurestacklogfiles", - "type": "Text" - }, - { - "type": "LinkEnd" - }, - { - "text": ".", - "type": "Text" - } - ], - "resourceRegistrationId": "", - "resourceProviderRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "severity": "Warning", - "state": "Active", - "title": "Infrastructure role is unhealthy", - "impactedResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/FabricResourceProvider", - "impactedResourceDisplayName": "FabricResourceProvider", - "closedByUserAlias": "" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/alerts/ca55be03-9be9-4deb-8467-e890ab1d116b", - "name": "ca55be03-9be9-4deb-8467-e890ab1d116b", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/alerts", - "location": "local", - "tags": {}, - "properties": { - "closedTimestamp": "", - "createdTimestamp": "2017-08-12T20:28:56.912712Z", - "description": [ - { - "text": "The infrastructure role Infrastructure management controller is experiencing issues.", - "type": "Text" - } - ], - "faultId": "ServiceFabric:/FabricControllerRing/FabricControllerRing", - "alertId": "ca55be03-9be9-4deb-8467-e890ab1d116b", - "faultTypeId": "ServiceFabricClusterUnhealthy", - "lastUpdatedTimestamp": "2017-08-12T20:28:56.912712Z", - "alertProperties": { - "healthState": "Warning", - "name": "Infrastructure management controller", - "fabricName": "FabricControllerRing", - "description": "", - "serviceType": "FabricControllerRing" - }, - "remediation": [ - { - "text": "Please contact Support. Before you do, start the log file collection process using the guidance from ", - "type": "Text" - }, - { - "linkType": "Uri", - "uri": "https://aka.ms/azurestacklogfiles", - "resourceId": "", - "type": "LinkBegin" - }, - { - "text": "https://aka.ms/azurestacklogfiles", - "type": "Text" - }, - { - "type": "LinkEnd" - }, - { - "text": ".", - "type": "Text" - } - ], - "resourceRegistrationId": "7cd4c25c-e946-4502-926b-e3c32737b116", - "resourceProviderRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "severity": "Warning", - "state": "Active", - "title": "Infrastructure role is unhealthy", - "impactedResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/FabricControllerRing", - "impactedResourceDisplayName": "Infrastructure management controller", - "closedByUserAlias": "" - } - } - ], - "nextLink": "" - } - } - } -} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/RegionHealth/RegionHealthGetOperation_example.json b/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/RegionHealth/RegionHealthGetOperation_example.json deleted file mode 100644 index 7cbcc3e7f68f..000000000000 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/RegionHealth/RegionHealthGetOperation_example.json +++ /dev/null @@ -1,72 +0,0 @@ -{ - "parameters": { - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "location": "local", - "region" : "local", - "api-version": "2016-05-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local", - "name": "local", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths", - "location": "local", - "tags": {}, - "properties": { - "usageMetrics": [ - { - "name": "Physical memory", - "metricsValue": [ - { - "name": "Used", - "unit": "GB", - "value": 76.249416351318359 - }, - { - "name": "Available", - "unit": "GB", - "value": 181.7333984375 - } - ] - }, - { - "name": "Physical storage", - "metricsValue": [ - { - "name": "Used", - "unit": "TB", - "value": 0.22170669212937355 - }, - { - "name": "Available", - "unit": "TB", - "value": 2.2449070774018764 - } - ] - }, - { - "name": "Public IP address pools", - "metricsValue": [ - { - "name": "Used", - "unit": "One", - "value": 31.0 - }, - { - "name": "Available", - "unit": "One", - "value": 480.0 - } - ] - } - ], - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 2 - } - } - } - } - } -} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/RegionHealth/RegionHealthListOperation_example.json b/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/RegionHealth/RegionHealthListOperation_example.json deleted file mode 100644 index caff96489358..000000000000 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/RegionHealth/RegionHealthListOperation_example.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "parameters": { - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "location": "local", - "api-version": "2016-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local", - "name": "local", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths", - "location": "local", - "tags": {}, - "properties": { - "usageMetrics": [ - { - "name": "Physical memory", - "metricsValue": [ - { - "name": "Used", - "unit": "GB", - "value": 76.249416351318359 - }, - { - "name": "Available", - "unit": "GB", - "value": 181.7333984375 - } - ] - }, - { - "name": "Physical storage", - "metricsValue": [ - { - "name": "Used", - "unit": "TB", - "value": 0.22170669212937355 - }, - { - "name": "Available", - "unit": "TB", - "value": 2.2449070774018764 - } - ] - }, - { - "name": "Public IP address pools", - "metricsValue": [ - { - "name": "Used", - "unit": "One", - "value": 31.0 - }, - { - "name": "Available", - "unit": "One", - "value": 480.0 - } - ] - } - ], - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 2 - } - } - } - ], - "nextLink": "" - } - } - } -} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/ResourceHealth/ResourceHealthGetOperation_example.json b/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/ResourceHealth/ResourceHealthGetOperation_example.json deleted file mode 100644 index 28235242f5c5..000000000000 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/ResourceHealth/ResourceHealthGetOperation_example.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "parameters": { - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "location": "local", - "serviceRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "resourceRegistrationId": "e388fe4c-63a0-4253-9b29-6dd4bf024501", - "api-version": "2016-05-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/e388fe4c-63a0-4253-9b29-6dd4bf024501", - "name": "e388fe4c-63a0-4253-9b29-6dd4bf024501", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "e388fe4c-63a0-4253-9b29-6dd4bf024501", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "NonPrivilegedApplicationGateway", - "resourceDisplayName": "Partition request broker (User)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/NonPrivilegedApplicationGateway", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - } - } - } -} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/ResourceHealth/ResourceHealthListOperation_example.json b/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/ResourceHealth/ResourceHealthListOperation_example.json deleted file mode 100644 index 7286612a5bba..000000000000 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/ResourceHealth/ResourceHealthListOperation_example.json +++ /dev/null @@ -1,905 +0,0 @@ -{ - "parameters": { - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "location": "local", - "serviceRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "api-version": "2016-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/02860753-c35b-4a1d-9d5b-78d51e08616e", - "name": "02860753-c35b-4a1d-9d5b-78d51e08616e", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "02860753-c35b-4a1d-9d5b-78d51e08616e", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "PortalAdmin", - "resourceDisplayName": "Portal (Administrator)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/PortalAdmin", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/03e6f2b8-c4b9-4f13-b381-0365e1c83dbf", - "name": "03e6f2b8-c4b9-4f13-b381-0365e1c83dbf", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "03e6f2b8-c4b9-4f13-b381-0365e1c83dbf", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "SLBMultiplexer", - "resourceDisplayName": "Load balancer multiplexer", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/SLBMultiplexer", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/1c5fb7d8-0c79-4157-ba6b-3cd3316dbbdf", - "name": "1c5fb7d8-0c79-4157-ba6b-3cd3316dbbdf", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "1c5fb7d8-0c79-4157-ba6b-3cd3316dbbdf", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "KeyVaultControlPlane", - "resourceDisplayName": "Key Vault controller (User)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/KeyVaultControlPlane", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/1ee2cdb4-ce31-45d7-890f-3fc3404897a3", - "name": "1ee2cdb4-ce31-45d7-890f-3fc3404897a3", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "1ee2cdb4-ce31-45d7-890f-3fc3404897a3", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "MicrosoftSQLServer", - "resourceDisplayName": "Internal data store", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/MicrosoftSQLServer", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/22e43659-5042-4ffb-896c-83bdd7be7003", - "name": "22e43659-5042-4ffb-896c-83bdd7be7003", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "22e43659-5042-4ffb-896c-83bdd7be7003", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "BackupController", - "resourceDisplayName": "Backup controller", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/BackupController", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/30c69554-bca4-421f-9d70-8c7dc4d9a90a", - "name": "30c69554-bca4-421f-9d70-8c7dc4d9a90a", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "30c69554-bca4-421f-9d70-8c7dc4d9a90a", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "AuthorizationServiceAdmin", - "resourceDisplayName": "Authorization service (Administrator)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/AuthorizationServiceAdmin", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/320279a8-46c2-4551-b739-be1108f07285", - "name": "320279a8-46c2-4551-b739-be1108f07285", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "320279a8-46c2-4551-b739-be1108f07285", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "HealthMonitoring", - "resourceDisplayName": "Health controller", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/HealthMonitoring", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/33651056-1254-41d5-8388-8842a4cb8201", - "name": "33651056-1254-41d5-8388-8842a4cb8201", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "33651056-1254-41d5-8388-8842a4cb8201", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "NetworkController", - "resourceDisplayName": "Network controller", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/NetworkController", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/35348c64-1f2c-453b-8df4-b7cb5827db5d", - "name": "35348c64-1f2c-453b-8df4-b7cb5827db5d", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "35348c64-1f2c-453b-8df4-b7cb5827db5d", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "AuthorizationServiceUser", - "resourceDisplayName": "Authorization service (User)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/AuthorizationServiceUser", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/396efceb-268c-4dfc-80de-d46f67ab9718", - "name": "396efceb-268c-4dfc-80de-d46f67ab9718", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "396efceb-268c-4dfc-80de-d46f67ab9718", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "InsightsServiceAdmin", - "resourceDisplayName": "Insights service (Administrator)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/InsightsServiceAdmin", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/3a13bf18-e3d8-4533-abbd-97c9afc06a58", - "name": "3a13bf18-e3d8-4533-abbd-97c9afc06a58", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "3a13bf18-e3d8-4533-abbd-97c9afc06a58", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "KeyVaultInternalDataPlane", - "resourceDisplayName": "Key Vault service (Administrator)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/KeyVaultInternalDataPlane", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/3a868182-32e4-4b78-af5e-4e30f2bb6140", - "name": "3a868182-32e4-4b78-af5e-4e30f2bb6140", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "3a868182-32e4-4b78-af5e-4e30f2bb6140", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "ActiveDirectoryDomainServices", - "resourceDisplayName": "Directory management", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/ActiveDirectoryDomainServices", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/4a407ec3-4378-491d-a1b4-747e12cc079f", - "name": "4a407ec3-4378-491d-a1b4-747e12cc079f", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "4a407ec3-4378-491d-a1b4-747e12cc079f", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "AzureResourceManagerAdmin", - "resourceDisplayName": "Azure Resource Manager (Administrator)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/AzureResourceManagerAdmin", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/4b809ab1-6dd8-4944-9236-d94975579138", - "name": "4b809ab1-6dd8-4944-9236-d94975579138", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "4b809ab1-6dd8-4944-9236-d94975579138", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "UsageServiceUser", - "resourceDisplayName": "Usage service (User)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/UsageServiceUser", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/4f400548-da5c-4fb4-aa23-f44e68b3a168", - "name": "4f400548-da5c-4fb4-aa23-f44e68b3a168", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "4f400548-da5c-4fb4-aa23-f44e68b3a168", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "KeyVaultInternalControlPlane", - "resourceDisplayName": "Key Vault controller (Administrator)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/KeyVaultInternalControlPlane", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/52115be4-b1f7-4ed2-a8c9-0d93f588ee7f", - "name": "52115be4-b1f7-4ed2-a8c9-0d93f588ee7f", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "52115be4-b1f7-4ed2-a8c9-0d93f588ee7f", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "AzureConsistentStorageRing", - "resourceDisplayName": "Storage services", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/AzureConsistentStorageRing", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/58e5e6cc-e880-4f6a-886b-1819d9672bf8", - "name": "58e5e6cc-e880-4f6a-886b-1819d9672bf8", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "58e5e6cc-e880-4f6a-886b-1819d9672bf8", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "StorageController", - "resourceDisplayName": "Storage controller", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/StorageController", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/596fbaa6-66bd-4eac-b002-9b63a69f0728", - "name": "596fbaa6-66bd-4eac-b002-9b63a69f0728", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "596fbaa6-66bd-4eac-b002-9b63a69f0728", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "AzureBridge", - "resourceDisplayName": "Azure bridge", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/AzureBridge", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/6e65db7d-de20-4ff0-b628-0a8a5839c61d", - "name": "6e65db7d-de20-4ff0-b628-0a8a5839c61d", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "6e65db7d-de20-4ff0-b628-0a8a5839c61d", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "InsightsServiceUser", - "resourceDisplayName": "Insights service (User)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/InsightsServiceUser", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/70bca597-4cda-4b3b-94e2-bda43c7207fb", - "name": "70bca597-4cda-4b3b-94e2-bda43c7207fb", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "70bca597-4cda-4b3b-94e2-bda43c7207fb", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "KeyVaultNamingService", - "resourceDisplayName": "Key Vault name manager", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/KeyVaultNamingService", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/7afd76d2-6f78-464a-aac9-55c24692de31", - "name": "7afd76d2-6f78-464a-aac9-55c24692de31", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "7afd76d2-6f78-464a-aac9-55c24692de31", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "KeyVaultDataPlane", - "resourceDisplayName": "Key Vault service (User)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/KeyVaultDataPlane", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/7cd4c25c-e946-4502-926b-e3c32737b116", - "name": "7cd4c25c-e946-4502-926b-e3c32737b116", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "7cd4c25c-e946-4502-926b-e3c32737b116", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "FabricControllerRing", - "resourceDisplayName": "Infrastructure management controller", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/FabricControllerRing", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 1 - }, - "healthState": "Warning" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/8e829737-813b-4637-97d5-83a1eeaea4fe", - "name": "8e829737-813b-4637-97d5-83a1eeaea4fe", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "8e829737-813b-4637-97d5-83a1eeaea4fe", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "ComputeController", - "resourceDisplayName": "Compute controller", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/ComputeController", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/a979da34-78f0-45e6-8579-9023b7aabbbd", - "name": "a979da34-78f0-45e6-8579-9023b7aabbbd", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "a979da34-78f0-45e6-8579-9023b7aabbbd", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "AzureResourceManagerUser", - "resourceDisplayName": "Azure Resource Manager (User)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/AzureResourceManagerUser", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/ac279697-3e4a-441e-a6ab-8afa589a6bf5", - "name": "ac279697-3e4a-441e-a6ab-8afa589a6bf5", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "ac279697-3e4a-441e-a6ab-8afa589a6bf5", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "ApplicationGateway", - "resourceDisplayName": "Partition request broker (Administrator)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/ApplicationGateway", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/bd90c001-1ddb-470f-9081-4f6bf254d358", - "name": "bd90c001-1ddb-470f-9081-4f6bf254d358", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "bd90c001-1ddb-470f-9081-4f6bf254d358", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "UsageServiceAdmin", - "resourceDisplayName": "Usage service (Administrator)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/UsageServiceAdmin", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/bffdc1b5-2276-43a1-82a4-01e7a0585162", - "name": "bffdc1b5-2276-43a1-82a4-01e7a0585162", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "bffdc1b5-2276-43a1-82a4-01e7a0585162", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "PortalUser", - "resourceDisplayName": "Portal (User)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/PortalUser", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/c5ab5cc3-0e51-43fd-94f2-a999f4ce00d1", - "name": "c5ab5cc3-0e51-43fd-94f2-a999f4ce00d1", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "c5ab5cc3-0e51-43fd-94f2-a999f4ce00d1", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "ActiveDirectoryFederationServices", - "resourceDisplayName": "Active Directory Federation Services", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/ActiveDirectoryFederationServices", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/c634d1c5-1a2d-420d-9c88-8d12535d1870", - "name": "c634d1c5-1a2d-420d-9c88-8d12535d1870", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "c634d1c5-1a2d-420d-9c88-8d12535d1870", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "SubscriptionsServices", - "resourceDisplayName": "Subscriptions service", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/SubscriptionsServices", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/c9694eb8-5c18-47d1-b07d-55dc6ce88145", - "name": "c9694eb8-5c18-47d1-b07d-55dc6ce88145", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "c9694eb8-5c18-47d1-b07d-55dc6ce88145", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "RASGateway", - "resourceDisplayName": "Edge gateway", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/RASGateway", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/cef8ab56-97f5-42ef-a4c5-d63de46f603e", - "name": "cef8ab56-97f5-42ef-a4c5-d63de46f603e", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "cef8ab56-97f5-42ef-a4c5-d63de46f603e", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "ActiveDirectoryCertificateServices", - "resourceDisplayName": "Certificate management", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/ActiveDirectoryCertificateServices", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/d6374306-6c60-4881-94a3-b8d78e54dde1", - "name": "d6374306-6c60-4881-94a3-b8d78e54dde1", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "d6374306-6c60-4881-94a3-b8d78e54dde1", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "SeedRing", - "resourceDisplayName": "Privileged endpoint", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/SeedRing", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/df1a83e9-635b-4ed0-af15-dfdf91ef4631", - "name": "df1a83e9-635b-4ed0-af15-dfdf91ef4631", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "df1a83e9-635b-4ed0-af15-dfdf91ef4631", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "GalleryServiceUser", - "resourceDisplayName": "Gallery service (User)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/GalleryServiceUser", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/e388fe4c-63a0-4253-9b29-6dd4bf024501", - "name": "e388fe4c-63a0-4253-9b29-6dd4bf024501", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "e388fe4c-63a0-4253-9b29-6dd4bf024501", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "NonPrivilegedApplicationGateway", - "resourceDisplayName": "Partition request broker (User)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/NonPrivilegedApplicationGateway", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/e932389e-a9fc-4310-9e69-7451d7b4b878", - "name": "e932389e-a9fc-4310-9e69-7451d7b4b878", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "e932389e-a9fc-4310-9e69-7451d7b4b878", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "EnterpriseCloudEngine", - "resourceDisplayName": "Infrastructure deployment", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/EnterpriseCloudEngine", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/eedbe9cb-8d73-45f3-a1a9-fd8422fbaa99", - "name": "eedbe9cb-8d73-45f3-a1a9-fd8422fbaa99", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "eedbe9cb-8d73-45f3-a1a9-fd8422fbaa99", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "GalleryServiceAdmin", - "resourceDisplayName": "Gallery service (Administrator)", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/GalleryServiceAdmin", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/ffcada0c-9de3-4994-884d-8cf04e3ad0a5", - "name": "ffcada0c-9de3-4994-884d-8cf04e3ad0a5", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "ffcada0c-9de3-4994-884d-8cf04e3ad0a5", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "resourceType": "infraRoles", - "resourceName": "ServicesController", - "resourceDisplayName": "Infrastructure role controller", - "usageMetrics": [], - "resourceLocation": "local", - "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/ServicesController", - "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - } - ], - "nextLink": "" - } - } - } -} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/ServiceHealth/ServiceHealthGetOperation_example.json b/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/ServiceHealth/ServiceHealthGetOperation_example.json deleted file mode 100644 index d5c243cf6593..000000000000 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/ServiceHealth/ServiceHealthGetOperation_example.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "location": "local", - "serviceHealth": "c720a7de-4812-4b58-969d-c2e2a5cd89ec", - "api-version": "2016-05-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/c720a7de-4812-4b58-969d-c2e2a5cd89ec", - "name": "c720a7de-4812-4b58-969d-c2e2a5cd89ec", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "c720a7de-4812-4b58-969d-c2e2a5cd89ec", - "displayName": "Compute", - "namespace": "Microsoft.Compute.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Compute.Admin/", - "serviceLocation": "local", - "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Compute.Admin/infraRoles/Compute", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - } - } - } -} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/ServiceHealth/ServiceHealthListOperation_example.json b/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/ServiceHealth/ServiceHealthListOperation_example.json deleted file mode 100644 index 2e3b9e4bdaa7..000000000000 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/examples/ServiceHealth/ServiceHealthListOperation_example.json +++ /dev/null @@ -1,156 +0,0 @@ -{ - "parameters": { - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "location": "local", - "api-version": "2016-05-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/23c54265-0e65-4d53-abdc-6734bd6a59f6", - "name": "23c54265-0e65-4d53-abdc-6734bd6a59f6", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "23c54265-0e65-4d53-abdc-6734bd6a59f6", - "displayName": "Network", - "namespace": "Microsoft.Network.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Network.Admin/", - "serviceLocation": "local", - "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Network.Admin/infraRoles/Network", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/385a3e01-3685-45ae-a073-f00dda2b1f7d", - "name": "385a3e01-3685-45ae-a073-f00dda2b1f7d", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "385a3e01-3685-45ae-a073-f00dda2b1f7d", - "displayName": "Storage", - "namespace": "Microsoft.Storage.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Storage.Admin/farms/84e1c82f-06e2-4bf7-8a9e-646cfa4e4988", - "serviceLocation": "local", - "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Storage.Admin/farms/84e1c82f-06e2-4bf7-8a9e-646cfa4e4988/infraRoles/Storage", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/9d9bd18c-5f8d-4f3d-b680-7a27161527ca", - "name": "9d9bd18c-5f8d-4f3d-b680-7a27161527ca", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "9d9bd18c-5f8d-4f3d-b680-7a27161527ca", - "displayName": "Key Vault", - "namespace": "Microsoft.KeyVault.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.KeyVault.Admin/locations/local", - "serviceLocation": "local", - "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.KeyVault.Admin/locations/local/infraRoles/Key Vault", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Healthy" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/bb58377f-3d7d-4d7f-b3b3-d433d422bf9e", - "name": "bb58377f-3d7d-4d7f-b3b3-d433d422bf9e", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "bb58377f-3d7d-4d7f-b3b3-d433d422bf9e", - "displayName": "Region Management", - "namespace": "Microsoft.InfrastructureInsights.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local", - "serviceLocation": "local", - "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/infraRoles/Region Management", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/c720a7de-4812-4b58-969d-c2e2a5cd89ec", - "name": "c720a7de-4812-4b58-969d-c2e2a5cd89ec", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "c720a7de-4812-4b58-969d-c2e2a5cd89ec", - "displayName": "Compute", - "namespace": "Microsoft.Compute.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Compute.Admin/", - "serviceLocation": "local", - "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Compute.Admin/infraRoles/Compute", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/ca6d95e7-7fe1-4c10-b0db-ab4cc835a811", - "name": "ca6d95e7-7fe1-4c10-b0db-ab4cc835a811", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "ca6d95e7-7fe1-4c10-b0db-ab4cc835a811", - "displayName": "Updates", - "namespace": "Microsoft.Update.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Update.Admin/updateLocations/local", - "serviceLocation": "local", - "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Update.Admin/updateLocations/local/infraRoles/Updates", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 0 - }, - "healthState": "Unknown" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "name": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", - "location": "local", - "tags": {}, - "properties": { - "registrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", - "displayName": "Capacity", - "namespace": "Microsoft.Fabric.Admin", - "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", - "serviceLocation": "local", - "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/Capacity", - "alertSummary": { - "criticalAlertCount": 0, - "warningAlertCount": 1 - }, - "healthState": "Warning" - } - } - ], - "nextLink": "" - } - } - } -} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/readme.md b/specification/azsadmin/resource-manager/InfrastructureInsights/readme.md deleted file mode 100644 index fdf8fa6891ad..000000000000 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/readme.md +++ /dev/null @@ -1,126 +0,0 @@ -# InfrastructureInsights Admin - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for InfrastructureInsights Admin. - ---- -## Getting Started -To build the SDK for InfrastructureInsights 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 InfrastructureInsights API. - -``` yaml -title: InfrastructureInsightsAdminClient -description: InfrastructureInsights Admin Client -openapi-type: arm -tag: package-2016-05-01 -``` - -### Tag: package-2016-05-01 - -These settings apply only when `--tag=package-2016-05-01` is specified on the command line. - -``` yaml $(tag) == 'package-2016-05-01' -input-file: - - Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/InfrastructureInsights.json - - Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/Alert.json - - Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/RegionHealth.json - - Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/ResourceHealth.json - - Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/ServiceHealth.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-go -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.AzureStack.Management.InfrastructureInsights.Admin - payload-flattening-threshold: 1 - output-folder: $(csharp-sdks-folder)/InfrastructureInsights/InfrastructureInsights.Admin/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. - -``` yaml $(python) -python: - # override the default output folder - output-folder: $(output-folder)/python - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 -``` - -### Tag: package-2016-05-01 and python - -These settings apply only when `--tag=package-2016-05-01 --python` is specified on the command line. - -``` yaml $(tag) == 'package-2016-05-01' && $(python) -namespace: azure.mgmt.infrastructure_insights.admin.v2016_05_01 -``` - -## Go - -These settings apply only when `--go` is specified on the command line. - -``` yaml $(go) -go: - license-header: MICROSOFT_APACHE_NO_VERSION - clear-output-folder: true - namespace: infrastructureinsights -``` - -### Tag: package-2016-05-01 and go - -These settings apply only when `--tag=package-2016-05-01 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag)=='package-2016-05-01' && $(go) -output-folder: $(go-sdk-folder)/services/azsadmin/mgmt/2016-05-01/infrastructureinsights -``` - - -## 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 - fluent: true - namespace: com.microsoft.azure.management.azsadmin.infrastructureinsights - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-azsadmin/infrastructureinsights -``` diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/AzureBridge.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/AzureBridge.json index 6477ee967e6b..149a479032de 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/AzureBridge.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/AzureBridge.json @@ -9,7 +9,38 @@ "schemes": [ "https" ], - "paths": {}, + "paths": { + "/providers/Microsoft.AzureBridge.Admin/operations": { + "get": { + "x-ms-examples": { + "Returns the list of support REST operations.": { + "$ref": "./examples/Operations/List.json" + } + }, + "description": "Returns the list of support REST operations.", + "tags": [ + "AzureBridge" + ], + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, "definitions": { "Resource": { "description": "Base Resource Object", @@ -46,9 +77,67 @@ }, "x-ms-azure-resource": true }, + "Operation": { + "description": "Describes the supported REST operation.", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object. This name should match the name that appears in RBAC or the event service.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "Contains the localized display information for this particular operation / action.", + "$ref": "#/definitions/Display", + "readOnly": true + } + } + }, + "Display": { + "description": "Contains the localized display information for this particular operation / action.", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with \"Microsoft\" for 1st party services. e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute.\"", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized, friendly version of the resource type related to this action or operation; the resource type should match the public documentation for the resource provider.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The localized, friendly name for the operation. Use the name as it will displayed to the user.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The localized, friendly description for the operation. The description will be displayed to the user. It should be thorough and concise for used in both tooltips and detailed views.", + "type": "string", + "readOnly": true + } + } + }, + "OperationList": { + "description": "List of Operations", + "properties": { + "value": { + "description": "Array of operations", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true + }, + "nextLink": { + "description": "URI to the next page of operations.", + "type": "string", + "readOnly": true + } + } + }, "ProvisioningState": { "description": "The provisioning state of the resource.", - "type" : "string", + "type": "string", "enum": [ "Stopped", "Starting", diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Operations/List.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Operations/List.json new file mode 100644 index 000000000000..2e489323cdfd --- /dev/null +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Operations/List.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "api-version": "2016-05-01" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": "" + } + } + } +} diff --git a/specification/azsadmin/resource-manager/backup/Microsoft.Backup.Admin/preview/2016-05-01/BackupLocations.json b/specification/azsadmin/resource-manager/backup/Microsoft.Backup.Admin/preview/2016-05-01/BackupLocations.json index d7957837bb41..a7f7a58c9ba8 100644 --- a/specification/azsadmin/resource-manager/backup/Microsoft.Backup.Admin/preview/2016-05-01/BackupLocations.json +++ b/specification/azsadmin/resource-manager/backup/Microsoft.Backup.Admin/preview/2016-05-01/BackupLocations.json @@ -244,11 +244,13 @@ }, "nextBackupTime": { "description": "The scheduled time of the next backup.", - "type": "string" + "type": "string", + "format": "date-time" }, "lastBackupTime": { "description": "Time of backup.", - "type": "string" + "type": "string", + "format": "date-time" }, "backupRetentionPeriodInDays": { "description": "The retention period, in days, for backs in the storage location.", diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/Alert.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/Alert.json new file mode 100644 index 000000000000..4833a35d70a7 --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/Alert.json @@ -0,0 +1,319 @@ +{ + "swagger": "2.0", + "info": { + "description": "Alert operation endpoints and objects.", + "title": "InfrastructureInsightsManagementClient", + "version": "2016-05-01" + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/alerts": { + "get": { + "x-ms-examples": { + "Returns the list of all alerts in a given region.": { + "$ref": "./examples/Alert/List.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "Returns the list of all alerts in a given region.", + "operationId": "Alerts_List", + "parameters": [ + { + "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/FilterParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/Alert", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/alerts/{alertName}": { + "get": { + "x-ms-examples": { + "Returns the requested an alert.": { + "$ref": "./examples/Alert/Get.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "Returns the requested an alert.", + "operationId": "Alerts_Get", + "parameters": [ + { + "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/AlertNameParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "put": { + "x-ms-examples": { + "Closes the given alert.": { + "$ref": "./examples/Alert/Close.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "Closes the given alert.", + "operationId": "Alerts_Close", + "parameters": [ + { + "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/AlertNameParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserParameter" + }, + { + "$ref": "#/parameters/AlertParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "Alert": { + "description": "This object represents an alert resource.", + "type": "object", + "properties": { + "properties": { + "description": "Contains information related to alerts.", + "$ref": "#/definitions/AlertModel", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "InfrastructureInsights.json#/definitions/TrackedResource" + } + ] + }, + "AlertModel": { + "description": "Contains alert data.", + "properties": { + "closedTimestamp": { + "description": "Timestamp when the alert was closed.", + "type": "string" + }, + "createdTimestamp": { + "description": "Timestamp when the alert was created.", + "type": "string" + }, + "description": { + "description": "Description of the alert.", + "type": "array", + "items": { + "$ref": "InfrastructureInsights.json#/definitions/Dictionary" + } + }, + "faultId": { + "description": "Gets or sets the fault ID of the alert.", + "type": "string" + }, + "alertId": { + "description": "Gets or sets the ID of the alert.", + "type": "string" + }, + "faultTypeId": { + "description": "Gets or sets the fault type ID of the alert.", + "type": "string" + }, + "lastUpdatedTimestamp": { + "description": "Timestamp when the alert was last updated.", + "type": "string" + }, + "alertProperties": { + "description": "Properties of the alert.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "remediation": { + "description": "Gets or sets the admin friendly remediation instructions for the alert.", + "type": "array", + "items": { + "$ref": "InfrastructureInsights.json#/definitions/Dictionary" + } + }, + "resourceRegistrationId": { + "description": "Gets or sets the registration ID of the resource associated with the alert. If the alert is not associated with a resource, the resource registration ID is null.", + "type": "string" + }, + "resourceProviderRegistrationId": { + "description": "Gets or sets the registration ID of the service the alert belongs to.", + "type": "string" + }, + "severity": { + "description": "Severity of the alert.", + "type": "string" + }, + "state": { + "description": "State of the alert.", + "type": "string" + }, + "title": { + "description": "Gets or sets the Resource ID for the impacted item.", + "type": "string" + }, + "impactedResourceId": { + "description": "Gets or sets the Resource ID for the impacted item.", + "type": "string" + }, + "impactedResourceDisplayName": { + "description": "Display name for the impacted item.", + "type": "string" + }, + "closedByUserAlias": { + "description": "User alias who closed the alert.", + "type": "string" + } + } + }, + "AlertList": { + "description": "A pageable list of alerts", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Alert" + }, + "description": "List of alerts." + }, + "nextLink": { + "type": "string", + "description": "URI to the next page." + } + } + } + }, + "parameters": { + "AlertNameParameter": { + "name": "alertName", + "description": "Name of the alert.", + "type": "string", + "required": true, + "in": "path", + "x-ms-parameter-location": "method" + }, + "UserParameter": { + "description": "The username used to perform the operation.", + "name": "user", + "type": "string", + "required": true, + "in": "query", + "x-ms-parameter-location": "method" + }, + "AlertParameter": { + "description": "Updated alert parameter.", + "name": "alert", + "schema": { + "$ref": "#/definitions/Alert" + }, + "required": true, + "in": "body", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/InfrastructureInsights.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/InfrastructureInsights.json new file mode 100644 index 000000000000..7f205e97a213 --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/InfrastructureInsights.json @@ -0,0 +1,353 @@ +{ + "swagger": "2.0", + "info": { + "version": "2016-05-01", + "title": "InfrastructureInsightsManagementClient", + "description": "The Admin Infrastructure Insights Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "paths": { + "/providers/Microsoft.InfrastructureInsights.Admin/operations": { + "get": { + "x-ms-examples": { + "Returns a list of support REST operations.": { + "$ref": "./examples/Operations/List.json" + } + }, + "description": "Returns a list of support REST operations.", + "tags": [ + "InfrastructureInsights" + ], + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "Dictionary": { + "description": "Dictionary of string key-value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "BaseHealth": { + "description": "Models the base properties for health resource.", + "properties": { + "alertSummary": { + "description": "Alert summary.", + "$ref": "#/definitions/AlertSummary" + }, + "healthState": { + "description": "Health state.", + "type": "string" + }, + "namespace": { + "description": "Namespace of the health resource.", + "type": "string" + }, + "registrationId": { + "description": "Registration ID.", + "type": "string" + }, + "routePrefix": { + "description": "Route prefix.", + "type": "string" + } + } + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region where the resource lives" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "AlertSummary": { + "description": "Summary of the alerts.", + "properties": { + "criticalAlertCount": { + "description": "The number of critical alerts for the service.", + "type": "integer" + }, + "warningAlertCount": { + "description": "The number of warning alerts for the service.", + "type": "integer" + } + } + }, + "Metrics": { + "description": "Metrics for a source.", + "properties": { + "name": { + "description": "Name of the usage metric.", + "type": "string" + }, + "maCounterName": { + "description": "Name of the counter.", + "type": "string" + }, + "observedTimestamp": { + "description": "Time counter was observed.", + "type": "string", + "format": "date-time" + }, + "sourceType": { + "description": "Type of the source.", + "type": "string" + }, + "sourceName": { + "description": "Name of the source.", + "$ref": "#/definitions/MetricsSourceType" + }, + "unit": { + "description": "Unit for the metric.", + "$ref": "#/definitions/MetricsUnit" + }, + "value": { + "description": "Name of the usage metric.", + "type": "number", + "format": "double" + } + } + }, + "MetricsSourceType": { + "type": "string", + "description": "The origin of the metric.", + "enum": [ + "PhysicalNode", + "VirtualMachine", + "ResourceProvider" + ], + "x-ms-enum": { + "name": "MetricsSourceType", + "modelAsString": true + } + }, + "MetricsUnit": { + "type": "string", + "description": "The unit of the metric.", + "enum": [ + "One", + "Percentage", + "B", + "KB", + "MB", + "GB", + "TB" + ], + "x-ms-enum": { + "name": "MetricsUnit", + "modelAsString": true + } + }, + "UsageMetrics": { + "description": "Metrics of resource usage.", + "properties": { + "name": { + "description": "Name of the usage metric.", + "type": "string" + }, + "metricsValue": { + "description": "List of usage metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/Metrics" + } + } + } + }, + "Operation": { + "description": "Describes the supported REST operation.", + "properties": { + "name": { + "description": "The name of the operation performed on the object. The name should match the action name that appears in RBAC or the event service.", + "type": "string" + }, + "display": { + "description": "Contains the localized display information for this particular operation or action.", + "$ref": "#/definitions/Display" + } + } + }, + "Display": { + "description": "Contains the localized display information for this particular operation / action.", + "properties": { + "provider": { + "description": "The localized, friendly version of the resource provider name. The provider name is expected to include the name of the publisher or company responsible. The provider name format should use title case and begin with \"Microsoft\" for first-party services. For example, the provider name may be\"Microsoft Monitoring Insights\" or \"Microsoft Compute\".", + "type": "string" + }, + "resource": { + "description": "The localized, friendly version of the resource type related to this action or operation; the resource type should match the public documentation for the resource provider.", + "type": "string" + }, + "operation": { + "description": "The localized, friendly name for the operation. Use the name as it will be displayed to the user.", + "type": "string" + }, + "description": { + "description": "The localized, friendly description for the operation. The description will be displayed to the user. It should be thorough and concise for used in both tooltips and detailed views.", + "type": "string" + } + } + }, + "OperationList": { + "description": "List of Operations", + "properties": { + "value": { + "description": "Array of operations", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URI to the next page of operations.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client API Version.", + "required": true, + "type": "string", + "default": "2016-05-01" + }, + "FilterParameter": { + "description": "OData filter parameter.", + "name": "$filter", + "in": "query", + "type": "string", + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "description": "Name of the region", + "name": "location", + "type": "string", + "required": true, + "in": "path", + "x-ms-parameter-location": "method" + }, + "ResourceGroupParameter": { + "description": "The name of the resource group.", + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceRegistrationIdParameter": { + "description": "Resource registration ID.", + "name": "resourceRegistrationId", + "type": "string", + "required": true, + "in": "path", + "x-ms-parameter-location": "method" + }, + "ServiceRegistrationIdParameter": { + "description": "Service registration ID.", + "name": "serviceRegistrationId", + "type": "string", + "required": true, + "in": "path", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/RegionHealth.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/RegionHealth.json similarity index 78% rename from specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/RegionHealth.json rename to specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/RegionHealth.json index 893c3eed58a9..bd43b521b0f2 100644 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/RegionHealth.json +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/RegionHealth.json @@ -10,24 +10,24 @@ "https" ], "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths": { "get": { "x-ms-examples": { - "Get the list of all health items for the region": { - "$ref": "./examples/RegionHealth/RegionHealthListOperation_example.json" + "Returns the list of all health status for the region.": { + "$ref": "./examples/RegionHealth/List.json" } }, "tags": [ "RegionHealths" ], - "description": "Get the list of all regions health status.", + "description": "Returns the list of all health status for the region.", "operationId": "RegionHealths_List", "parameters": [ { "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" + "$ref": "InfrastructureInsights.json#/parameters/ResourceGroupParameter" }, { "$ref": "InfrastructureInsights.json#/parameters/ApiVersionParameter" @@ -56,27 +56,27 @@ ] } }, - "/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{region}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}": { "get": { "x-ms-examples": { - "Get the health status of a region": { - "$ref": "./examples/RegionHealth/RegionHealthGetOperation_example.json" + "Returns the requested health status of a region.": { + "$ref": "./examples/RegionHealth/Get.json" } }, "tags": [ "RegionHealths" ], - "description": "Get health status of a region.", + "description": "Returns the requested health status of a region.", "operationId": "RegionHealths_Get", "parameters": [ { "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" + "$ref": "InfrastructureInsights.json#/parameters/ResourceGroupParameter" }, { - "$ref": "#/parameters/RegionParameter" + "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" }, { "$ref": "InfrastructureInsights.json#/parameters/ApiVersionParameter" @@ -101,29 +101,29 @@ }, "definitions": { "RegionHealth": { - "description": "Contains information related to a regions health.", + "description": "Contains information related to the health of a region.", "properties": { "properties": { - "description": "Contains information related to a regions health.", + "description": "Contains information related to the health of a region.", "$ref": "#/definitions/RegionHealthModel", "x-ms-client-flatten": true } }, "allOf": [ { - "$ref": "InfrastructureInsights.json#/definitions/Resource" + "$ref": "InfrastructureInsights.json#/definitions/TrackedResource" } ] }, "RegionHealthModel": { - "description": "Contains information related to a regions health.", + "description": "Contains information related to the health of a region.", "properties": { "alertSummary": { "description": "Summary of alerts.", "$ref": "InfrastructureInsights.json#/definitions/AlertSummary" }, "usageMetrics": { - "description": "List of usage metrics for this region.", + "description": "List of usage metrics for the region.", "type": "array", "items": { "$ref": "InfrastructureInsights.json#/definitions/UsageMetrics" @@ -148,22 +148,13 @@ } } }, - "parameters": { - "RegionParameter": { - "description": "Name of the region", - "name": "region", - "type": "string", - "required": true, - "in": "path", - "x-ms-parameter-location": "method" - } - }, + "parameters": {}, "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", "scopes": { "user_impersonation": "impersonate your user account" } @@ -176,4 +167,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/ResourceHealth.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/ResourceHealth.json similarity index 76% rename from specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/ResourceHealth.json rename to specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/ResourceHealth.json index 5dff4125af87..7cb614bd38b9 100644 --- a/specification/azsadmin/resource-manager/InfrastructureInsights/Microsoft.InfrastructureInsights.Admin/stable/2016-05-01/ResourceHealth.json +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/ResourceHealth.json @@ -10,22 +10,25 @@ "https" ], "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/serviceHealths/{serviceRegistrationId}/resourceHealths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/serviceHealths/{serviceRegistrationId}/resourceHealths": { "get": { "x-ms-examples": { - "Get a list of resource health items": { - "$ref": "./examples/ResourceHealth/ResourceHealthListOperation_example.json" + "Returns a list of each resource's health under a service.": { + "$ref": "./examples/ResourceHealth/List.json" } }, "tags": [ "Resources" ], - "description": "Get a list of resources?.", + "description": "Returns a list of each resource's health under a service.", "operationId": "ResourceHealths_List", "parameters": [ { "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" }, + { + "$ref": "InfrastructureInsights.json#/parameters/ResourceGroupParameter" + }, { "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" }, @@ -59,22 +62,25 @@ ] } }, - "/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/serviceHealths/{serviceRegistrationId}/resourceHealths/{resourceRegistrationId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/serviceHealths/{serviceRegistrationId}/resourceHealths/{resourceRegistrationId}": { "get": { "x-ms-examples": { - "Get health information about a resource": { - "$ref": "./examples/ResourceHealth/ResourceHealthGetOperation_example.json" + "Returns the requested health information about a resource.": { + "$ref": "./examples/ResourceHealth/Get.json" } }, "tags": [ "Resources" ], - "description": "Get health information about a resources.", + "description": "Returns the requested health information about a resource.", "operationId": "ResourceHealths_Get", "parameters": [ { "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" }, + { + "$ref": "InfrastructureInsights.json#/parameters/ResourceGroupParameter" + }, { "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" }, @@ -120,7 +126,7 @@ }, "allOf": [ { - "$ref": "InfrastructureInsights.json#/definitions/Resource" + "$ref": "InfrastructureInsights.json#/definitions/TrackedResource" } ] }, @@ -128,31 +134,31 @@ "description": "Health information related to a resource.", "properties": { "resourceLocation": { - "description": "Gets or sets the resource location.", + "description": "Resource location.", "type": "string" }, "resourceName": { - "description": "Gets or sets the resource name.", + "description": "Resource name.", "type": "string" }, "resourceDisplayName": { - "description": "Gets or sets the resource display name.", + "description": "Resource display name.", "type": "string" }, "resourceType": { - "description": "Gets or sets the resource type.", + "description": "Resource type.", "type": "string" }, "resourceURI": { - "description": "Gets or sets the resource uri.", + "description": "Gets or sets the resource URI.", "type": "string" }, "rpRegistrationId": { - "description": "Gets or sets the resource provider registration id.", + "description": "Gets or sets the resource provider registration ID.", "type": "string" }, "usageMetrics": { - "description": "Gets or sets the usage metrics.", + "description": "Usage metrics.", "type": "array", "items": { "$ref": "InfrastructureInsights.json#/definitions/UsageMetrics" @@ -166,10 +172,10 @@ ] }, "ResourceHealthList": { - "description": "Pageable list of resource healths.", + "description": "Pageable list of resource health objects.", "properties": { "value": { - "description": "Array of of resource healths", + "description": "List of resource health objects.", "type": "array", "items": { "$ref": "#/definitions/ResourceHealth" @@ -187,7 +193,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", "scopes": { "user_impersonation": "impersonate your user account" } @@ -200,4 +206,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/ServiceHealth.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/ServiceHealth.json new file mode 100644 index 000000000000..bfc33b474dce --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/ServiceHealth.json @@ -0,0 +1,192 @@ +{ + "swagger": "2.0", + "info": { + "description": "Resource provider health operation endpoints and objects.", + "title": "InfrastructureInsightsManagementClient", + "version": "2016-05-01" + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/serviceHealths": { + "get": { + "x-ms-examples": { + "Returns the list of all resource provider health states.": { + "$ref": "./examples/ServiceHealth/List.json" + } + }, + "tags": [ + "ServiceHealths" + ], + "description": "Returns the list of all resource provider health states.", + "operationId": "ServiceHealths_List", + "parameters": [ + { + "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/FilterParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceHealthList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ServiceHealth", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/serviceHealths/{serviceHealth}": { + "get": { + "x-ms-examples": { + "Returns the requested service health object.": { + "$ref": "./examples/ServiceHealth/Get.json" + } + }, + "tags": [ + "ServiceHealths" + ], + "description": "Returns the requested service health object.", + "operationId": "ServiceHealths_Get", + "parameters": [ + { + "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ServiceHealthParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceHealth" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "ServiceHealth": { + "description": "Holds information about the health of a service.", + "type": "object", + "properties": { + "properties": { + "description": "Holds information about the health of a service.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceHealthModel" + } + }, + "allOf": [ + { + "$ref": "InfrastructureInsights.json#/definitions/TrackedResource" + } + ] + }, + "ServiceHealthModel": { + "description": "Holds information about the health of a service.", + "properties": { + "displayName": { + "description": "Name of the service.", + "type": "string" + }, + "serviceLocation": { + "description": "Location of the service.", + "type": "string" + }, + "infraURI": { + "description": "The route prefix to the service.", + "type": "string" + } + }, + "allOf": [ + { + "$ref": "InfrastructureInsights.json#/definitions/BaseHealth" + } + ] + }, + "ServiceHealthList": { + "description": "Pageable list of service health objects.", + "properties": { + "value": { + "description": "List of service health objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceHealth" + } + }, + "nextLink": { + "description": "URI of the next page.", + "type": "string" + } + } + } + }, + "parameters": { + "ServiceHealthParameter": { + "description": "Service Health name.", + "name": "serviceHealth", + "type": "string", + "required": true, + "in": "path", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Alert/Close.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Alert/Close.json new file mode 100644 index 000000000000..43618f0d7582 --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Alert/Close.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "System.local", + "location": "local", + "alertName": "ca55be03-9be9-4deb-8467-e890ab1d116b", + "alert": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/alerts/ca55be03-9be9-4deb-8467-e890ab1d116b", + "name": "ca55be03-9be9-4deb-8467-e890ab1d116b", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/alerts", + "location": "local", + "tags": {}, + "properties": { + "state": "Closed", + "closedByUserAlias": "ciserviceadmin@msazurestack.onmicrosoft.com" + } + }, + "user": "ciserviceadmin@msazurestack.onmicrosoft.com", + "api-version": "2016-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/alerts/ca55be03-9be9-4deb-8467-e890ab1d116b", + "name": "ca55be03-9be9-4deb-8467-e890ab1d116b", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/alerts", + "location": "local", + "tags": {}, + "properties": { + "closedTimestamp": "", + "createdTimestamp": "2017-08-12T20:28:56.912712Z", + "description": [ + { + "text": "The infrastructure role Infrastructure management controller is experiencing issues.", + "type": "Text" + } + ], + "faultId": "ServiceFabric:/FabricControllerRing/FabricControllerRing", + "alertId": "ca55be03-9be9-4deb-8467-e890ab1d116b", + "faultTypeId": "ServiceFabricClusterUnhealthy", + "lastUpdatedTimestamp": "2017-08-12T20:28:56.912712Z", + "alertProperties": { + "healthState": "Warning", + "name": "Infrastructure management controller", + "fabricName": "FabricControllerRing", + "description": "", + "serviceType": "FabricControllerRing" + }, + "remediation": [ + { + "text": "Please contact Support. Before you do, start the log file collection process using the guidance from ", + "type": "Text" + }, + { + "linkType": "Uri", + "uri": "https://aka.ms/azurestacklogfiles", + "resourceId": "", + "type": "LinkBegin" + }, + { + "text": "https://aka.ms/azurestacklogfiles", + "type": "Text" + }, + { + "type": "LinkEnd" + }, + { + "text": ".", + "type": "Text" + } + ], + "resourceRegistrationId": "7cd4c25c-e946-4502-926b-e3c32737b116", + "resourceProviderRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "severity": "Warning", + "state": "Closed", + "title": "Infrastructure role is unhealthy", + "impactedResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/FabricControllerRing", + "impactedResourceDisplayName": "Infrastructure management controller", + "closedByUserAlias": "ciserviceadmin@msazurestack.onmicrosoft.com" + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Alert/Get.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Alert/Get.json new file mode 100644 index 000000000000..e66b7b008c45 --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Alert/Get.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "System.local", + "location": "local", + "alertName": "ca55be03-9be9-4deb-8467-e890ab1d116b", + "api-version": "2016-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/alerts/ca55be03-9be9-4deb-8467-e890ab1d116b", + "name": "ca55be03-9be9-4deb-8467-e890ab1d116b", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/alerts", + "location": "local", + "tags": {}, + "properties": { + "closedTimestamp": "", + "createdTimestamp": "2017-08-12T20:28:56.912712Z", + "description": [ + { + "text": "The infrastructure role Infrastructure management controller is experiencing issues.", + "type": "Text" + } + ], + "faultId": "ServiceFabric:/FabricControllerRing/FabricControllerRing", + "alertId": "ca55be03-9be9-4deb-8467-e890ab1d116b", + "faultTypeId": "ServiceFabricClusterUnhealthy", + "lastUpdatedTimestamp": "2017-08-12T20:28:56.912712Z", + "alertProperties": { + "healthState": "Warning", + "name": "Infrastructure management controller", + "fabricName": "FabricControllerRing", + "description": "", + "serviceType": "FabricControllerRing" + }, + "remediation": [ + { + "text": "Please contact Support. Before you do, start the log file collection process using the guidance from ", + "type": "Text" + }, + { + "linkType": "Uri", + "uri": "https://aka.ms/azurestacklogfiles", + "resourceId": "", + "type": "LinkBegin" + }, + { + "text": "https://aka.ms/azurestacklogfiles", + "type": "Text" + }, + { + "type": "LinkEnd" + }, + { + "text": ".", + "type": "Text" + } + ], + "resourceRegistrationId": "7cd4c25c-e946-4502-926b-e3c32737b116", + "resourceProviderRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "severity": "Warning", + "state": "Active", + "title": "Infrastructure role is unhealthy", + "impactedResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/FabricControllerRing", + "impactedResourceDisplayName": "Infrastructure management controller", + "closedByUserAlias": "" + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Alert/List.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Alert/List.json new file mode 100644 index 000000000000..820833eca3f7 --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Alert/List.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "System.local", + "location": "local", + "api-version": "2016-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/alerts/1fcf80bb-f889-44c5-8591-efd191812385", + "name": "1fcf80bb-f889-44c5-8591-efd191812385", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/alerts", + "location": "local", + "tags": {}, + "properties": { + "closedTimestamp": "", + "createdTimestamp": "2017-08-12T20:28:56.897087Z", + "description": [ + { + "text": "The infrastructure role Capacity is experiencing issues.", + "type": "Text" + } + ], + "faultId": "ServiceFabric:/FabricResourceProvider/fabric:/FabricResourceProvider", + "alertId": "1fcf80bb-f889-44c5-8591-efd191812385", + "faultTypeId": "ServiceFabricApplicationUnhealthy", + "lastUpdatedTimestamp": "2017-08-12T20:28:56.897087Z", + "alertProperties": { + "healthState": "Warning", + "name": "Capacity", + "fabricName": "fabric:/FabricResourceProvider", + "description": "", + "serviceType": "FabricResourceProvider" + }, + "remediation": [ + { + "text": "Please contact Support. Before you do, start the log file collection process using the guidance from ", + "type": "Text" + }, + { + "linkType": "Uri", + "uri": "https://aka.ms/azurestacklogfiles", + "resourceId": "", + "type": "LinkBegin" + }, + { + "text": "https://aka.ms/azurestacklogfiles", + "type": "Text" + }, + { + "type": "LinkEnd" + }, + { + "text": ".", + "type": "Text" + } + ], + "resourceRegistrationId": "", + "resourceProviderRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "severity": "Warning", + "state": "Active", + "title": "Infrastructure role is unhealthy", + "impactedResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/FabricResourceProvider", + "impactedResourceDisplayName": "FabricResourceProvider", + "closedByUserAlias": "" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/alerts/ca55be03-9be9-4deb-8467-e890ab1d116b", + "name": "ca55be03-9be9-4deb-8467-e890ab1d116b", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/alerts", + "location": "local", + "tags": {}, + "properties": { + "closedTimestamp": "", + "createdTimestamp": "2017-08-12T20:28:56.912712Z", + "description": [ + { + "text": "The infrastructure role Infrastructure management controller is experiencing issues.", + "type": "Text" + } + ], + "faultId": "ServiceFabric:/FabricControllerRing/FabricControllerRing", + "alertId": "ca55be03-9be9-4deb-8467-e890ab1d116b", + "faultTypeId": "ServiceFabricClusterUnhealthy", + "lastUpdatedTimestamp": "2017-08-12T20:28:56.912712Z", + "alertProperties": { + "healthState": "Warning", + "name": "Infrastructure management controller", + "fabricName": "FabricControllerRing", + "description": "", + "serviceType": "FabricControllerRing" + }, + "remediation": [ + { + "text": "Please contact Support. Before you do, start the log file collection process using the guidance from ", + "type": "Text" + }, + { + "linkType": "Uri", + "uri": "https://aka.ms/azurestacklogfiles", + "resourceId": "", + "type": "LinkBegin" + }, + { + "text": "https://aka.ms/azurestacklogfiles", + "type": "Text" + }, + { + "type": "LinkEnd" + }, + { + "text": ".", + "type": "Text" + } + ], + "resourceRegistrationId": "7cd4c25c-e946-4502-926b-e3c32737b116", + "resourceProviderRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "severity": "Warning", + "state": "Active", + "title": "Infrastructure role is unhealthy", + "impactedResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/FabricControllerRing", + "impactedResourceDisplayName": "Infrastructure management controller", + "closedByUserAlias": "" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Operations/List.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Operations/List.json new file mode 100644 index 000000000000..dd71e3a6e9bc --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Operations/List.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "System.local", + "location": "local", + "api-version": "2015-06-01-preview", + "reportedStartTime": "2017-08-01T00:00:00.00Z", + "reportedEndTime": "2017-08-02T00:00:00.00Z", + "aggregationGranularity": "", + "subscriberId": "", + "continuationToken": "" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": "" + } + } + } +} diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/RegionHealth/Get.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/RegionHealth/Get.json new file mode 100644 index 000000000000..ec3442f664c5 --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/RegionHealth/Get.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "System.local", + "location": "local", + "api-version": "2016-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local", + "name": "local", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths", + "location": "local", + "tags": {}, + "properties": { + "usageMetrics": [ + { + "name": "Physical memory", + "metricsValue": [ + { + "name": "Used", + "unit": "GB", + "value": 76.249416351318359 + }, + { + "name": "Available", + "unit": "GB", + "value": 181.7333984375 + } + ] + }, + { + "name": "Physical storage", + "metricsValue": [ + { + "name": "Used", + "unit": "TB", + "value": 0.22170669212937355 + }, + { + "name": "Available", + "unit": "TB", + "value": 2.2449070774018764 + } + ] + }, + { + "name": "Public IP address pools", + "metricsValue": [ + { + "name": "Used", + "unit": "One", + "value": 31.0 + }, + { + "name": "Available", + "unit": "One", + "value": 480.0 + } + ] + } + ], + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 2 + } + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/RegionHealth/List.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/RegionHealth/List.json new file mode 100644 index 000000000000..5dc952e6369f --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/RegionHealth/List.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "System.local", + "api-version": "2016-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local", + "name": "local", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths", + "location": "local", + "tags": {}, + "properties": { + "usageMetrics": [ + { + "name": "Physical memory", + "metricsValue": [ + { + "name": "Used", + "unit": "GB", + "value": 76.249416351318359 + }, + { + "name": "Available", + "unit": "GB", + "value": 181.7333984375 + } + ] + }, + { + "name": "Physical storage", + "metricsValue": [ + { + "name": "Used", + "unit": "TB", + "value": 0.22170669212937355 + }, + { + "name": "Available", + "unit": "TB", + "value": 2.2449070774018764 + } + ] + }, + { + "name": "Public IP address pools", + "metricsValue": [ + { + "name": "Used", + "unit": "One", + "value": 31.0 + }, + { + "name": "Available", + "unit": "One", + "value": 480.0 + } + ] + } + ], + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 2 + } + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/ResourceHealth/Get.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/ResourceHealth/Get.json new file mode 100644 index 000000000000..1db744e75c9f --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/ResourceHealth/Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "System.local", + "location": "local", + "serviceRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "resourceRegistrationId": "e388fe4c-63a0-4253-9b29-6dd4bf024501", + "api-version": "2016-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/e388fe4c-63a0-4253-9b29-6dd4bf024501", + "name": "e388fe4c-63a0-4253-9b29-6dd4bf024501", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "e388fe4c-63a0-4253-9b29-6dd4bf024501", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "NonPrivilegedApplicationGateway", + "resourceDisplayName": "Partition request broker (User)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/NonPrivilegedApplicationGateway", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/ResourceHealth/List.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/ResourceHealth/List.json new file mode 100644 index 000000000000..38f6faa69b4b --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/ResourceHealth/List.json @@ -0,0 +1,906 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "System.local", + "location": "local", + "serviceRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "api-version": "2016-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/02860753-c35b-4a1d-9d5b-78d51e08616e", + "name": "02860753-c35b-4a1d-9d5b-78d51e08616e", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "02860753-c35b-4a1d-9d5b-78d51e08616e", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "PortalAdmin", + "resourceDisplayName": "Portal (Administrator)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/PortalAdmin", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/03e6f2b8-c4b9-4f13-b381-0365e1c83dbf", + "name": "03e6f2b8-c4b9-4f13-b381-0365e1c83dbf", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "03e6f2b8-c4b9-4f13-b381-0365e1c83dbf", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "SLBMultiplexer", + "resourceDisplayName": "Load balancer multiplexer", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/SLBMultiplexer", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/1c5fb7d8-0c79-4157-ba6b-3cd3316dbbdf", + "name": "1c5fb7d8-0c79-4157-ba6b-3cd3316dbbdf", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "1c5fb7d8-0c79-4157-ba6b-3cd3316dbbdf", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "KeyVaultControlPlane", + "resourceDisplayName": "Key Vault controller (User)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/KeyVaultControlPlane", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/1ee2cdb4-ce31-45d7-890f-3fc3404897a3", + "name": "1ee2cdb4-ce31-45d7-890f-3fc3404897a3", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "1ee2cdb4-ce31-45d7-890f-3fc3404897a3", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "MicrosoftSQLServer", + "resourceDisplayName": "Internal data store", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/MicrosoftSQLServer", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/22e43659-5042-4ffb-896c-83bdd7be7003", + "name": "22e43659-5042-4ffb-896c-83bdd7be7003", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "22e43659-5042-4ffb-896c-83bdd7be7003", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "BackupController", + "resourceDisplayName": "Backup controller", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/BackupController", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/30c69554-bca4-421f-9d70-8c7dc4d9a90a", + "name": "30c69554-bca4-421f-9d70-8c7dc4d9a90a", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "30c69554-bca4-421f-9d70-8c7dc4d9a90a", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "AuthorizationServiceAdmin", + "resourceDisplayName": "Authorization service (Administrator)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/AuthorizationServiceAdmin", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/320279a8-46c2-4551-b739-be1108f07285", + "name": "320279a8-46c2-4551-b739-be1108f07285", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "320279a8-46c2-4551-b739-be1108f07285", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "HealthMonitoring", + "resourceDisplayName": "Health controller", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/HealthMonitoring", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/33651056-1254-41d5-8388-8842a4cb8201", + "name": "33651056-1254-41d5-8388-8842a4cb8201", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "33651056-1254-41d5-8388-8842a4cb8201", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "NetworkController", + "resourceDisplayName": "Network controller", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/NetworkController", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/35348c64-1f2c-453b-8df4-b7cb5827db5d", + "name": "35348c64-1f2c-453b-8df4-b7cb5827db5d", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "35348c64-1f2c-453b-8df4-b7cb5827db5d", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "AuthorizationServiceUser", + "resourceDisplayName": "Authorization service (User)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/AuthorizationServiceUser", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/396efceb-268c-4dfc-80de-d46f67ab9718", + "name": "396efceb-268c-4dfc-80de-d46f67ab9718", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "396efceb-268c-4dfc-80de-d46f67ab9718", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "InsightsServiceAdmin", + "resourceDisplayName": "Insights service (Administrator)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/InsightsServiceAdmin", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/3a13bf18-e3d8-4533-abbd-97c9afc06a58", + "name": "3a13bf18-e3d8-4533-abbd-97c9afc06a58", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "3a13bf18-e3d8-4533-abbd-97c9afc06a58", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "KeyVaultInternalDataPlane", + "resourceDisplayName": "Key Vault service (Administrator)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/KeyVaultInternalDataPlane", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/3a868182-32e4-4b78-af5e-4e30f2bb6140", + "name": "3a868182-32e4-4b78-af5e-4e30f2bb6140", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "3a868182-32e4-4b78-af5e-4e30f2bb6140", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "ActiveDirectoryDomainServices", + "resourceDisplayName": "Directory management", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/ActiveDirectoryDomainServices", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/4a407ec3-4378-491d-a1b4-747e12cc079f", + "name": "4a407ec3-4378-491d-a1b4-747e12cc079f", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "4a407ec3-4378-491d-a1b4-747e12cc079f", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "AzureResourceManagerAdmin", + "resourceDisplayName": "Azure Resource Manager (Administrator)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/AzureResourceManagerAdmin", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/4b809ab1-6dd8-4944-9236-d94975579138", + "name": "4b809ab1-6dd8-4944-9236-d94975579138", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "4b809ab1-6dd8-4944-9236-d94975579138", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "UsageServiceUser", + "resourceDisplayName": "Usage service (User)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/UsageServiceUser", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/4f400548-da5c-4fb4-aa23-f44e68b3a168", + "name": "4f400548-da5c-4fb4-aa23-f44e68b3a168", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "4f400548-da5c-4fb4-aa23-f44e68b3a168", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "KeyVaultInternalControlPlane", + "resourceDisplayName": "Key Vault controller (Administrator)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/KeyVaultInternalControlPlane", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/52115be4-b1f7-4ed2-a8c9-0d93f588ee7f", + "name": "52115be4-b1f7-4ed2-a8c9-0d93f588ee7f", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "52115be4-b1f7-4ed2-a8c9-0d93f588ee7f", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "AzureConsistentStorageRing", + "resourceDisplayName": "Storage services", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/AzureConsistentStorageRing", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/58e5e6cc-e880-4f6a-886b-1819d9672bf8", + "name": "58e5e6cc-e880-4f6a-886b-1819d9672bf8", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "58e5e6cc-e880-4f6a-886b-1819d9672bf8", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "StorageController", + "resourceDisplayName": "Storage controller", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/StorageController", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/596fbaa6-66bd-4eac-b002-9b63a69f0728", + "name": "596fbaa6-66bd-4eac-b002-9b63a69f0728", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "596fbaa6-66bd-4eac-b002-9b63a69f0728", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "AzureBridge", + "resourceDisplayName": "Azure bridge", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/AzureBridge", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/6e65db7d-de20-4ff0-b628-0a8a5839c61d", + "name": "6e65db7d-de20-4ff0-b628-0a8a5839c61d", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "6e65db7d-de20-4ff0-b628-0a8a5839c61d", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "InsightsServiceUser", + "resourceDisplayName": "Insights service (User)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/InsightsServiceUser", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/70bca597-4cda-4b3b-94e2-bda43c7207fb", + "name": "70bca597-4cda-4b3b-94e2-bda43c7207fb", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "70bca597-4cda-4b3b-94e2-bda43c7207fb", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "KeyVaultNamingService", + "resourceDisplayName": "Key Vault name manager", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/KeyVaultNamingService", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/7afd76d2-6f78-464a-aac9-55c24692de31", + "name": "7afd76d2-6f78-464a-aac9-55c24692de31", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "7afd76d2-6f78-464a-aac9-55c24692de31", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "KeyVaultDataPlane", + "resourceDisplayName": "Key Vault service (User)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/KeyVaultDataPlane", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/7cd4c25c-e946-4502-926b-e3c32737b116", + "name": "7cd4c25c-e946-4502-926b-e3c32737b116", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "7cd4c25c-e946-4502-926b-e3c32737b116", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "FabricControllerRing", + "resourceDisplayName": "Infrastructure management controller", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/FabricControllerRing", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 1 + }, + "healthState": "Warning" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/8e829737-813b-4637-97d5-83a1eeaea4fe", + "name": "8e829737-813b-4637-97d5-83a1eeaea4fe", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "8e829737-813b-4637-97d5-83a1eeaea4fe", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "ComputeController", + "resourceDisplayName": "Compute controller", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/ComputeController", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/a979da34-78f0-45e6-8579-9023b7aabbbd", + "name": "a979da34-78f0-45e6-8579-9023b7aabbbd", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "a979da34-78f0-45e6-8579-9023b7aabbbd", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "AzureResourceManagerUser", + "resourceDisplayName": "Azure Resource Manager (User)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/AzureResourceManagerUser", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/ac279697-3e4a-441e-a6ab-8afa589a6bf5", + "name": "ac279697-3e4a-441e-a6ab-8afa589a6bf5", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "ac279697-3e4a-441e-a6ab-8afa589a6bf5", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "ApplicationGateway", + "resourceDisplayName": "Partition request broker (Administrator)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/ApplicationGateway", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/bd90c001-1ddb-470f-9081-4f6bf254d358", + "name": "bd90c001-1ddb-470f-9081-4f6bf254d358", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "bd90c001-1ddb-470f-9081-4f6bf254d358", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "UsageServiceAdmin", + "resourceDisplayName": "Usage service (Administrator)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/UsageServiceAdmin", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/bffdc1b5-2276-43a1-82a4-01e7a0585162", + "name": "bffdc1b5-2276-43a1-82a4-01e7a0585162", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "bffdc1b5-2276-43a1-82a4-01e7a0585162", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "PortalUser", + "resourceDisplayName": "Portal (User)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/PortalUser", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/c5ab5cc3-0e51-43fd-94f2-a999f4ce00d1", + "name": "c5ab5cc3-0e51-43fd-94f2-a999f4ce00d1", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "c5ab5cc3-0e51-43fd-94f2-a999f4ce00d1", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "ActiveDirectoryFederationServices", + "resourceDisplayName": "Active Directory Federation Services", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/ActiveDirectoryFederationServices", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/c634d1c5-1a2d-420d-9c88-8d12535d1870", + "name": "c634d1c5-1a2d-420d-9c88-8d12535d1870", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "c634d1c5-1a2d-420d-9c88-8d12535d1870", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "SubscriptionsServices", + "resourceDisplayName": "Subscriptions service", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/SubscriptionsServices", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/c9694eb8-5c18-47d1-b07d-55dc6ce88145", + "name": "c9694eb8-5c18-47d1-b07d-55dc6ce88145", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "c9694eb8-5c18-47d1-b07d-55dc6ce88145", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "RASGateway", + "resourceDisplayName": "Edge gateway", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/RASGateway", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/cef8ab56-97f5-42ef-a4c5-d63de46f603e", + "name": "cef8ab56-97f5-42ef-a4c5-d63de46f603e", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "cef8ab56-97f5-42ef-a4c5-d63de46f603e", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "ActiveDirectoryCertificateServices", + "resourceDisplayName": "Certificate management", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/ActiveDirectoryCertificateServices", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/d6374306-6c60-4881-94a3-b8d78e54dde1", + "name": "d6374306-6c60-4881-94a3-b8d78e54dde1", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "d6374306-6c60-4881-94a3-b8d78e54dde1", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "SeedRing", + "resourceDisplayName": "Privileged endpoint", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/SeedRing", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/df1a83e9-635b-4ed0-af15-dfdf91ef4631", + "name": "df1a83e9-635b-4ed0-af15-dfdf91ef4631", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "df1a83e9-635b-4ed0-af15-dfdf91ef4631", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "GalleryServiceUser", + "resourceDisplayName": "Gallery service (User)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/GalleryServiceUser", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/e388fe4c-63a0-4253-9b29-6dd4bf024501", + "name": "e388fe4c-63a0-4253-9b29-6dd4bf024501", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "e388fe4c-63a0-4253-9b29-6dd4bf024501", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "NonPrivilegedApplicationGateway", + "resourceDisplayName": "Partition request broker (User)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/NonPrivilegedApplicationGateway", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/e932389e-a9fc-4310-9e69-7451d7b4b878", + "name": "e932389e-a9fc-4310-9e69-7451d7b4b878", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "e932389e-a9fc-4310-9e69-7451d7b4b878", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "EnterpriseCloudEngine", + "resourceDisplayName": "Infrastructure deployment", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/EnterpriseCloudEngine", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/eedbe9cb-8d73-45f3-a1a9-fd8422fbaa99", + "name": "eedbe9cb-8d73-45f3-a1a9-fd8422fbaa99", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "eedbe9cb-8d73-45f3-a1a9-fd8422fbaa99", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "GalleryServiceAdmin", + "resourceDisplayName": "Gallery service (Administrator)", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/GalleryServiceAdmin", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c/resourceHealths/ffcada0c-9de3-4994-884d-8cf04e3ad0a5", + "name": "ffcada0c-9de3-4994-884d-8cf04e3ad0a5", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths/resourceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "ffcada0c-9de3-4994-884d-8cf04e3ad0a5", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "resourceType": "infraRoles", + "resourceName": "ServicesController", + "resourceDisplayName": "Infrastructure role controller", + "usageMetrics": [], + "resourceLocation": "local", + "resourceURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/ServicesController", + "rpRegistrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/ServiceHealth/Get.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/ServiceHealth/Get.json new file mode 100644 index 000000000000..627d0fd755b5 --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/ServiceHealth/Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "System.local", + "location": "local", + "serviceHealth": "c720a7de-4812-4b58-969d-c2e2a5cd89ec", + "api-version": "2016-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/c720a7de-4812-4b58-969d-c2e2a5cd89ec", + "name": "c720a7de-4812-4b58-969d-c2e2a5cd89ec", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "c720a7de-4812-4b58-969d-c2e2a5cd89ec", + "displayName": "Compute", + "namespace": "Microsoft.Compute.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Compute.Admin/", + "serviceLocation": "local", + "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Compute.Admin/infraRoles/Compute", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/ServiceHealth/List.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/ServiceHealth/List.json new file mode 100644 index 000000000000..34991f98383e --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/ServiceHealth/List.json @@ -0,0 +1,157 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "System.local", + "location": "local", + "api-version": "2016-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/23c54265-0e65-4d53-abdc-6734bd6a59f6", + "name": "23c54265-0e65-4d53-abdc-6734bd6a59f6", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "23c54265-0e65-4d53-abdc-6734bd6a59f6", + "displayName": "Network", + "namespace": "Microsoft.Network.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Network.Admin/", + "serviceLocation": "local", + "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Network.Admin/infraRoles/Network", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/385a3e01-3685-45ae-a073-f00dda2b1f7d", + "name": "385a3e01-3685-45ae-a073-f00dda2b1f7d", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "385a3e01-3685-45ae-a073-f00dda2b1f7d", + "displayName": "Storage", + "namespace": "Microsoft.Storage.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Storage.Admin/farms/84e1c82f-06e2-4bf7-8a9e-646cfa4e4988", + "serviceLocation": "local", + "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Storage.Admin/farms/84e1c82f-06e2-4bf7-8a9e-646cfa4e4988/infraRoles/Storage", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/9d9bd18c-5f8d-4f3d-b680-7a27161527ca", + "name": "9d9bd18c-5f8d-4f3d-b680-7a27161527ca", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "9d9bd18c-5f8d-4f3d-b680-7a27161527ca", + "displayName": "Key Vault", + "namespace": "Microsoft.KeyVault.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.KeyVault.Admin/locations/local", + "serviceLocation": "local", + "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.KeyVault.Admin/locations/local/infraRoles/Key Vault", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Healthy" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/bb58377f-3d7d-4d7f-b3b3-d433d422bf9e", + "name": "bb58377f-3d7d-4d7f-b3b3-d433d422bf9e", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "bb58377f-3d7d-4d7f-b3b3-d433d422bf9e", + "displayName": "Region Management", + "namespace": "Microsoft.InfrastructureInsights.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local", + "serviceLocation": "local", + "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/infraRoles/Region Management", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/c720a7de-4812-4b58-969d-c2e2a5cd89ec", + "name": "c720a7de-4812-4b58-969d-c2e2a5cd89ec", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "c720a7de-4812-4b58-969d-c2e2a5cd89ec", + "displayName": "Compute", + "namespace": "Microsoft.Compute.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Compute.Admin/", + "serviceLocation": "local", + "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Compute.Admin/infraRoles/Compute", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/ca6d95e7-7fe1-4c10-b0db-ab4cc835a811", + "name": "ca6d95e7-7fe1-4c10-b0db-ab4cc835a811", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "ca6d95e7-7fe1-4c10-b0db-ab4cc835a811", + "displayName": "Updates", + "namespace": "Microsoft.Update.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Update.Admin/updateLocations/local", + "serviceLocation": "local", + "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Update.Admin/updateLocations/local/infraRoles/Updates", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 0 + }, + "healthState": "Unknown" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/local/serviceHealths/e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "name": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "type": "Microsoft.InfrastructureInsights.Admin/regionHealths/serviceHealths", + "location": "local", + "tags": {}, + "properties": { + "registrationId": "e56bc7b8-c8b5-4e25-b00c-4f951effb22c", + "displayName": "Capacity", + "namespace": "Microsoft.Fabric.Admin", + "routePrefix": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local", + "serviceLocation": "local", + "infraURI": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoles/Capacity", + "alertSummary": { + "criticalAlertCount": 0, + "warningAlertCount": 1 + }, + "healthState": "Warning" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/readme.md b/specification/azsadmin/resource-manager/infrastructureinsights/readme.md new file mode 100644 index 000000000000..ee813a7c173d --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/readme.md @@ -0,0 +1,61 @@ +# InfrastructureInsights Admin + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for InfrastructureInsights Admin. + +--- +## Getting Started +To build the SDK for InfrastructureInsights 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 InfrastructureInsights API. + +``` yaml +title: InfrastructureInsightsAdminClient +description: InfrastructureInsights Admin Client +openapi-type: arm +tag: package-2016-05-01 +``` + +### Tag: package-2016-05-01 + +These settings apply only when `--tag=package-2016-05-01` is specified on the command line. + +``` yaml $(tag) == 'package-2016-05-01' +input-file: + - Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/InfrastructureInsights.json + - Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/Alert.json + - Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/RegionHealth.json + - Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/ResourceHealth.json + - Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/ServiceHealth.json +``` + +--- +# Code Generation + +## Swagger to SDK + +## 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.InfrastructureInsights.Admin + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/Generated + clear-output-folder: true +``` diff --git a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/LoadBalancers.json b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/LoadBalancers.json index 446f376bcda9..bc945db7dd54 100644 --- a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/LoadBalancers.json +++ b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/LoadBalancers.json @@ -97,7 +97,10 @@ }, "allOf": [ { - "$ref": "Network.json#/definitions/ResourceTenant" + "$ref": "Network.json#/definitions/ProvisionedResource" + }, + { + "$ref": "Network.json#/definitions/TenantResource" } ] }, diff --git a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/Network.json b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/Network.json index c37f237ad354..ab49f9d8721e 100644 --- a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/Network.json +++ b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/Network.json @@ -45,6 +45,36 @@ } } } + }, + "/providers/Microsoft.Network.Admin/operations": { + "get": { + "x-ms-examples": { + "Returns the list of support REST operations.": { + "$ref": "./examples/Operations/List.json" + } + }, + "description": "Returns the list of support REST operations.", + "tags": [ + "Network" + ], + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } } }, "definitions": { @@ -82,15 +112,79 @@ }, "x-ms-azure-resource": true }, - "ResourceTenant": { - "description": "Base Resource Tenant Object", + "Operation": { + "description": "Describes the supported REST operation.", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object. This name should match the name that appears in RBAC or the event service.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "Contains the localized display information for this particular operation / action.", + "$ref": "#/definitions/Display", + "readOnly": true + } + } + }, + "Display": { + "description": "Contains the localized display information for this particular operation / action.", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with \"Microsoft\" for 1st party services. e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute.\"", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized, friendly version of the resource type related to this action or operation; the resource type should match the public documentation for the resource provider.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The localized, friendly name for the operation. Use the name as it will displayed to the user.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The localized, friendly description for the operation. The description will be displayed to the user. It should be thorough and concise for used in both tooltips and detailed views.", + "type": "string", + "readOnly": true + } + } + }, + "OperationList": { + "description": "List of Operations", + "properties": { + "value": { + "description": "Array of operations", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true + }, + "nextLink": { + "description": "URI to the next page of operations.", + "type": "string", + "readOnly": true + } + } + }, + "ProvisionedResource": { + "description": "Objects which have a provisioning state.", "type": "object", "properties": { "provisioningState": { "description": "The provisioning state.", "type": "string", "readOnly": true - }, + } + } + }, + "TenantResource": { + "description": "These resources are utilized by a single tenant.", + "type": "object", + "properties": { "subscriptionId": { "description": "The subscription ID.", "type": "string", diff --git a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/PublicIpAddresses.json b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/PublicIpAddresses.json index 87466d25e6f6..47e2d1001174 100644 --- a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/PublicIpAddresses.json +++ b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/PublicIpAddresses.json @@ -110,7 +110,10 @@ }, "allOf": [ { - "$ref": "Network.json#/definitions/ResourceTenant" + "$ref": "Network.json#/definitions/ProvisionedResource" + }, + { + "$ref": "Network.json#/definitions/TenantResource" } ] }, 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 c2381b422aa8..05f26771d709 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 @@ -242,7 +242,7 @@ }, "allOf": [ { - "$ref": "Network.json#/definitions/ResourceTenant" + "$ref": "Network.json#/definitions/ProvisionedResource" } ] }, diff --git a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/VirtualNetworks.json b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/VirtualNetworks.json index 527c596d0110..93a4e2cfdd4c 100644 --- a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/VirtualNetworks.json +++ b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/VirtualNetworks.json @@ -94,7 +94,10 @@ }, "allOf": [ { - "$ref": "Network.json#/definitions/ResourceTenant" + "$ref": "Network.json#/definitions/ProvisionedResource" + }, + { + "$ref": "Network.json#/definitions/TenantResource" } ] }, diff --git a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Operations/List.json b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Operations/List.json new file mode 100644 index 000000000000..2e489323cdfd --- /dev/null +++ b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Operations/List.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "api-version": "2016-05-01" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": "" + } + } + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json new file mode 100644 index 000000000000..450e958a171b --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json @@ -0,0 +1,170 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/acquisitions": { + "get": { + "x-ms-examples": { + "Returns a list of page BLOB acquistions.": { + "$ref": "./examples/Acquisitions/List.json" + } + }, + "tags": [ + "Acquisitions" + ], + "operationId": "Acquisitions_List", + "description": "Returns a list of BLOB acquistions.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "storage.json#/parameters/FilterParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of acquisitions has been returned.", + "schema": { + "$ref": "acquisitions.json#/definitions/AcquisitionList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm cannot be found." + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "AcquisitionStatus": { + "description": "The status of page BLOB acquisition.", + "type": "string", + "enum": [ + "InProgress", + "Success", + "Failed" + ], + "x-ms-enum": { + "name": "AcquisitionStatus", + "modelAsString": true + } + }, + "AcquisitionProperties": { + "description": "The Properties of page BLOB acquisition.", + "type": "object", + "properties": { + "filePath": { + "description": "The file path of the page BLOB file on storage cluster.", + "type": "string", + "readOnly": true + }, + "maximumblobsize": { + "description": "The maximum size of the page BLOB.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "status": { + "description": "The status of the page BLOB acquisition.", + "$ref": "acquisitions.json#/definitions/AcquisitionStatus", + "readOnly": true + }, + "susbcriptionid": { + "description": "ID of the subscription associated with the page BLOB.", + "type": "string", + "readOnly": true + }, + "storageaccount": { + "description": "The storage account that holds the page BLOB.", + "type": "string", + "readOnly": true + }, + "container": { + "description": "The container associated with the the page BLOB.", + "type": "string", + "readOnly": true + }, + "blob": { + "description": "The name of the page BLOB.", + "type": "string", + "readOnly": true + }, + "acquisitionid": { + "description": "The ID of page BLOB acquisition.", + "type": "string", + "readOnly": true + } + } + }, + "Acquisition": { + "description": "The acquisition of the page BLOB.", + "type": "object", + "properties": { + "properties": { + "description": "The properties of the page blob acquisition.", + "x-ms-client-flatten": true, + "$ref": "acquisitions.json#/definitions/AcquisitionProperties", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + }, + "AcquisitionList": { + "description": "The list of page BLOB acquisitions.", + "type": "array", + "items": { + "$ref": "acquisitions.json#/definitions/Acquisition" + } + } + }, + "parameters": {}, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/blobServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/blobServices.json new file mode 100644 index 000000000000..377ed7d08f7a --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/blobServices.json @@ -0,0 +1,245 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/blobservices/{serviceType}": { + "get": { + "x-ms-examples": { + "Returns the BLOB service.": { + "$ref": "./examples/BlobService/Get.json" + } + }, + "tags": [ + "BlobServices" + ], + "operationId": "BlobServices_Get", + "description": "Returns the BLOB service.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The BLOB service has been returned.", + "schema": { + "$ref": "blobServices.json#/definitions/BlobService" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/blobservices/{serviceType}/metricdefinitions": { + "get": { + "x-ms-examples": { + "Returns the list of metric definitions for BLOB service.": { + "$ref": "./examples/BlobService/ListMetricDefinitions.json" + } + }, + "tags": [ + "BlobServices" + ], + "operationId": "BlobServices_ListMetricDefinitions", + "description": "Returns the list of metric definitions for BLOB service.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metric definitions for the BLOB service has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricDefinitionList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/blobservices/{serviceType}/metrics": { + "get": { + "x-ms-examples": { + "Returns a list of metrics for BLOB service.": { + "$ref": "./examples/BlobService/ListMetrics.json" + } + }, + "tags": [ + "BlobServices" + ], + "operationId": "BlobServices_ListMetrics", + "description": "Returns a list of metrics for BLOB service.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metrics has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "BlobServiceWritableSettings": { + "description": "Settings of BLOB service.", + "type": "object", + "properties": { + "blobSvcContainerGcInterval": { + "description": "The interval, in seconds, of container garbage collection.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "blobSvcShallowGcInterval": { + "description": "The interval ,in seconds, of shallow garbage collection.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "blobSvcStreamMapMinContainerOccupancyPercent": { + "description": "The minimal container occupancy percent for stream mapping.", + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/WritableServiceSettings" + } + ] + }, + "BlobServiceSettings": { + "description": "Blob service settings.", + "type": "object", + "allOf": [ + { + "$ref": "blobServices.json#/definitions/BlobServiceWritableSettings" + } + ] + }, + "BlobServiceProperties": { + "description": "Blob service properties.", + "type": "object", + "properties": { + "settings": { + "x-ms-client-flatten": true, + "$ref": "blobServices.json#/definitions/BlobServiceSettings", + "description": "Blob service settings.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Service" + } + ] + }, + "BlobService": { + "description": "The BLOB service.", + "type": "object", + "properties": { + "properties": { + "description": "Blob service properties.", + "x-ms-client-flatten": true, + "$ref": "blobServices.json#/definitions/BlobServiceProperties", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + } + }, + "parameters": {}, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/containers.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/containers.json new file mode 100644 index 000000000000..59ba4701c518 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/containers.json @@ -0,0 +1,449 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/operationresults/{operationId}": { + "post": { + "x-ms-examples": { + "Cancel a container migration job.": { + "$ref": "./examples/Containers/CancelMigration.json" + } + }, + "tags": [ + "Containers" + ], + "operationId": "Containers_CancelMigration", + "description": "Cancel a container migration job.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/OperationIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation has been accepted and processed", + "schema": { + "$ref": "containers.json#/definitions/MigrationResult" + } + }, + "202": { + "description": "ACCEPTED - Operation has been accepted will be processed asynchronously", + "schema": { + "$ref": "containers.json#/definitions/MigrationResult" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "x-ms-examples": { + "Returns the status of a container migration job.": { + "$ref": "./examples/Containers/MigrationStatus.json" + } + }, + "tags": [ + "Containers" + ], + "operationId": "Containers_MigrationStatus", + "description": "Returns the status of a container migration job.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/OperationIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation has been accepted and processed", + "schema": { + "$ref": "containers.json#/definitions/MigrationResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/containers": { + "get": { + "x-ms-examples": { + "Returns the list of containers which can be migrated in the specified share.": { + "$ref": "./examples/Containers/List.json" + } + }, + "tags": [ + "Containers" + ], + "operationId": "Containers_List", + "description": "Returns the list of containers which can be migrated in the specified share.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ShareNameParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "containers.json#/parameters/MigrationIntentParameter" + }, + { + "$ref": "containers.json#/parameters/MaxCountParameter" + }, + { + "$ref": "containers.json#/parameters/StartIndexParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of containers has been returned.", + "schema": { + "$ref": "containers.json#/definitions/ContainerList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm or share was not found." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/destinationshares": { + "get": { + "x-ms-examples": { + "Returns a list of destination shares that the system considers as best candidates for migration.": { + "$ref": "./examples/Containers/ListDestinationShares.json" + } + }, + "tags": [ + "Containers" + ], + "operationId": "Containers_ListDestinationShares", + "description": "Returns a list of destination shares that the system considers as best candidates for migration.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ShareNameParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of shares has been returned.", + "schema": { + "$ref": "shares.json#/definitions/ShareList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm or share was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/migrate": { + "post": { + "x-ms-examples": { + "Starts a container migration job to migrate containers to the specified destination share.": { + "$ref": "./examples/Containers/Migrate.json" + } + }, + "tags": [ + "Containers" + ], + "operationId": "Containers_Migrate", + "description": "Starts a container migration job to migrate containers to the specified destination share.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ShareNameParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "containers.json#/parameters/MigrationParameterParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Container has been migrated", + "schema": { + "$ref": "containers.json#/definitions/MigrationResult" + } + }, + "202": { + "description": "ACCEPTED -- Operation accepted and will be performed asynchronously", + "schema": { + "$ref": "containers.json#/definitions/MigrationResult" + } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Container": { + "description": "Container properties.", + "type": "object", + "properties": { + "sharename": { + "description": "The name of the share where the container locates.", + "type": "string", + "readOnly": true + }, + "accountname": { + "description": "The name of storage account where the container locates.", + "type": "string", + "readOnly": true + }, + "containername": { + "description": "Container name.", + "type": "string", + "readOnly": true + }, + "containerid": { + "description": "The container ID.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "accountid": { + "description": "The ID of the storage account.", + "type": "string", + "readOnly": true + }, + "usedBytesInPrimaryVolume": { + "description": "The used space, in bytes, of the container in the primary volume.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "containerState": { + "description": "The current state of the container.", + "type": "string", + "readOnly": true + } + } + }, + "ContainerList": { + "description": "List of containers.", + "type": "array", + "items": { + "$ref": "containers.json#/definitions/Container" + } + }, + "MigrationResult": { + "description": "The result of the container migration.", + "type": "object", + "properties": { + "jobId": { + "description": "The migration job ID.", + "type": "string", + "readOnly": true + }, + "sourceShareName": { + "description": "The name of the source storage share.", + "type": "string", + "readOnly": true + }, + "storageAccountName": { + "description": "The storage account name.", + "type": "string", + "readOnly": true + }, + "containerName": { + "description": "The name of the container to be migrated.", + "type": "string", + "readOnly": true + }, + "destinationShareName": { + "description": "The name of the destination storage share.", + "type": "string", + "readOnly": true + }, + "migrationStatus": { + "description": "The migration status.", + "$ref": "containers.json#/definitions/MigrationState", + "readOnly": true + }, + "subEntitiesCompleted": { + "description": "The number of entities which have been migrated.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "subEntitiesFailed": { + "description": "The number of entities which failed in migration.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "failureReason": { + "description": "The migration failure reason.", + "type": "string", + "readOnly": true + } + } + }, + "MigrationState": { + "type": "string", + "enum": [ + "Active", + "Paused", + "Deleted", + "Rollback", + "Complete", + "Canceled", + "Failed", + "All" + ], + "x-ms-enum": { + "name": "MigrationState", + "modelAsString": true + } + }, + "MigrationParameters": { + "description": "Parameters of container migration job.", + "type": "object", + "properties": { + "storageAccountName": { + "type": "string", + "description": "The name of the storage account where the container locates." + }, + "containerName": { + "type": "string", + "description": "The name of the container to be migrated." + }, + "destinationShareUncPath": { + "type": "string", + "description": "The UNC path of the destination share for migration." + } + }, + "required": [ + "storageAccountName", + "containerName", + "destinationShareUncPath" + ] + } + }, + "parameters": { + "MigrationIntentParameter": { + "description": "The container migration intent.", + "name": "Intent", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MaxCountParameter": { + "description": "The maximum number of containers.", + "name": "MaxCount", + "in": "query", + "type": "integer", + "format": "int32", + "required": false, + "x-ms-parameter-location": "method" + }, + "StartIndexParameter": { + "description": "The starting index the resource provider uses.", + "name": "StartIndex", + "in": "query", + "type": "integer", + "format": "int32", + "required": false, + "x-ms-parameter-location": "method" + }, + "MigrationParameterParameter": { + "description": "The parameters of container migration job.", + "name": "migrationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "containers.json#/definitions/MigrationParameters" + }, + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Acquisitions/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Acquisitions/List.json new file mode 100644 index 000000000000..9cfd2e18dbca --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Acquisitions/List.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": [] + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/Get.json new file mode 100644 index 000000000000..cd8b00ed0af7 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "serviceType": "default", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/blobservices/default", + "name": "3cf03497-c44a-4e51-a56f-3987d88c70af/default", + "type": "Microsoft.Storage.Admin/farms/blobservices", + "location": "local", + "properties": { + "settings": { + "frontEndHttpListenPort": 11000, + "frontEndHttpsListenPort": 11100, + "frontEndCallbackThreadsCount": 1600, + "frontEndCpuBasedKeepAliveThrottlingEnabled": true, + "frontEndCpuBasedKeepAliveThrottlingPercentCpuThreshold": 90.0, + "frontEndCpuBasedKeepAliveThrottlingPercentRequestsToThrottle": 2.0, + "frontEndCpuBasedKeepAliveThrottlingCpuMonitorIntervalInSeconds": 5, + "frontEndMemoryThrottlingEnabled": true, + "frontEndMaxMillisecondsBetweenMemorySamples": 10000, + "frontEndMemoryThrottleThresholdSettings": "5,100,0;7,50,0;10,25,0;15,0,25;", + "frontEndMinThreadPoolThreads": 1850, + "frontEndThreadPoolBasedKeepAliveIOCompletionThreshold": 1500, + "frontEndThreadPoolBasedKeepAliveWorkerThreadThreshold": 1500, + "frontEndThreadPoolBasedKeepAliveMonitorIntervalInSeconds": 30, + "frontEndThreadPoolBasedKeepAlivePercentage": 10.0, + "frontEndUseSlaTimeInAvailability": true, + "blobSvcContainerGcInterval": 3600000, + "blobSvcShallowGcInterval": 3600000, + "blobSvcStreamMapMinContainerOccupancyPercent": 80 + }, + "version": "1.0" + } + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/ListMetricDefinitions.json new file mode 100644 index 000000000000..71a9c9dd5942 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/ListMetricDefinitions.json @@ -0,0 +1,348 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "serviceType": "default", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "End-to-end latency (BlobService)", + "value": "E2ELatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Server latency (BlobService)", + "value": "ServerLatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Availability (BlobService)", + "value": "Availability" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Total successful requests (BlobService)", + "value": "SuccessfulRequests" + }, + "primaryAggregationType": "Total", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Total requests (BlobService)", + "value": "TotalRequests" + }, + "primaryAggregationType": "Total", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Ingress (BlobService)", + "value": "Ingress" + }, + "primaryAggregationType": "Total", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Egress (BlobService)", + "value": "Egress" + }, + "primaryAggregationType": "Total", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Requests per second (BlobFrontEnd)", + "value": "BlobFrontEndRequestsPerSecond" + }, + "primaryAggregationType": "Average", + "unit": "CountPerSecond" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "End-to-end latency (BlobFrontEnd)", + "value": "BlobFrontEndE2ELatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Server latency (BlobFrontEnd)", + "value": "BlobFrontEndServerLatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Concurrent requests (BlobFrontEnd)", + "value": "BlobFrontEndConcurrentRequests" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "The count of pending requests in the request queue (BlobFrontEnd)", + "value": "BlobFrontEndRequestQueueLength" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Processor time percentage (BlobFrontEnd)", + "value": "BlobFrontEndProcessorTime" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Requests per second (BlobServer)", + "value": "BlobServerRequestsPerSecond" + }, + "primaryAggregationType": "Average", + "unit": "CountPerSecond" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Server latency (BlobServer)", + "value": "BlobServerServerLatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + } + ] + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/ListMetrics.json new file mode 100644 index 000000000000..ab0743513128 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/ListMetrics.json @@ -0,0 +1,386 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "serviceType": "default", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "CountPerSecond", + "metricValues": [], + "name": { + "localizedValue": "Requests per second (BlobFrontEnd)", + "value": "BlobFrontEndRequestsPerSecond" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "End-to-end latency (BlobFrontEnd)", + "value": "BlobFrontEndE2ELatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Server latency (BlobFrontEnd)", + "value": "BlobFrontEndServerLatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Concurrent requests (BlobFrontEnd)", + "value": "BlobFrontEndConcurrentRequests" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "The count of pending requests in the request queue (BlobFrontEnd)", + "value": "BlobFrontEndRequestQueueLength" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Processor time percentage (BlobFrontEnd)", + "value": "BlobFrontEndProcessorTime" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "CountPerSecond", + "metricValues": [], + "name": { + "localizedValue": "Requests per second (BlobServer)", + "value": "BlobServerRequestsPerSecond" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Server latency (BlobServer)", + "value": "BlobServerServerLatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 3.37839472205425, + "timeStamp": "2018-01-23T00:00:00Z" + }, + { + "average": 3.23720755548253, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 3.23283110690318, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 3.24997418164272, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 3.25500401782453, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 3.24891968824928, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 3.23743272199632, + "timeStamp": "2018-01-29T00:00:00Z" + } + ], + "name": { + "localizedValue": "End-to-end latency (BlobService)", + "value": "E2ELatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 3.00302941330881, + "timeStamp": "2018-01-23T00:00:00Z" + }, + { + "average": 2.88515644890154, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 2.8953629314371, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 2.90971362786012, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 2.9197896120973, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 2.90887585146789, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 2.89673016247954, + "timeStamp": "2018-01-29T00:00:00Z" + } + ], + "name": { + "localizedValue": "Server latency (BlobService)", + "value": "ServerLatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 100.0, + "timeStamp": "2018-01-23T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-29T00:00:00Z" + } + ], + "name": { + "localizedValue": "Availability (BlobService)", + "value": "Availability" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "Count", + "metricValues": [ + { + "timeStamp": "2018-01-23T00:00:00Z", + "total": 514291.0 + }, + { + "timeStamp": "2018-01-24T00:00:00Z", + "total": 553823.0 + }, + { + "timeStamp": "2018-01-25T00:00:00Z", + "total": 550283.0 + }, + { + "timeStamp": "2018-01-26T00:00:00Z", + "total": 590665.0 + }, + { + "timeStamp": "2018-01-27T00:00:00Z", + "total": 602316.0 + }, + { + "timeStamp": "2018-01-28T00:00:00Z", + "total": 592653.0 + }, + { + "timeStamp": "2018-01-29T00:00:00Z", + "total": 592690.0 + } + ], + "name": { + "localizedValue": "Total successful requests (BlobService)", + "value": "SuccessfulRequests" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "Count", + "metricValues": [ + { + "timeStamp": "2018-01-23T00:00:00Z", + "total": 525915.0 + }, + { + "timeStamp": "2018-01-24T00:00:00Z", + "total": 565447.0 + }, + { + "timeStamp": "2018-01-25T00:00:00Z", + "total": 561886.0 + }, + { + "timeStamp": "2018-01-26T00:00:00Z", + "total": 602269.0 + }, + { + "timeStamp": "2018-01-27T00:00:00Z", + "total": 613916.0 + }, + { + "timeStamp": "2018-01-28T00:00:00Z", + "total": 604253.0 + }, + { + "timeStamp": "2018-01-29T00:00:00Z", + "total": 604290.0 + } + ], + "name": { + "localizedValue": "Total requests (BlobService)", + "value": "TotalRequests" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "Count", + "metricValues": [ + { + "timeStamp": "2018-01-23T00:00:00Z", + "total": 1368310311.0 + }, + { + "timeStamp": "2018-01-24T00:00:00Z", + "total": 1404079959.0 + }, + { + "timeStamp": "2018-01-25T00:00:00Z", + "total": 1400057193.0 + }, + { + "timeStamp": "2018-01-26T00:00:00Z", + "total": 1445879884.0 + }, + { + "timeStamp": "2018-01-27T00:00:00Z", + "total": 1475166639.0 + }, + { + "timeStamp": "2018-01-28T00:00:00Z", + "total": 1463924092.0 + }, + { + "timeStamp": "2018-01-29T00:00:00Z", + "total": 1468371175.0 + } + ], + "name": { + "localizedValue": "Ingress (BlobService)", + "value": "Ingress" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:02.3087124Z", + "metricUnit": "Count", + "metricValues": [ + { + "timeStamp": "2018-01-23T00:00:00Z", + "total": 1042768756.0 + }, + { + "timeStamp": "2018-01-24T00:00:00Z", + "total": 1140164863.0 + }, + { + "timeStamp": "2018-01-25T00:00:00Z", + "total": 902184482.0 + }, + { + "timeStamp": "2018-01-26T00:00:00Z", + "total": 1173363120.0 + }, + { + "timeStamp": "2018-01-27T00:00:00Z", + "total": 1184912696.0 + }, + { + "timeStamp": "2018-01-28T00:00:00Z", + "total": 1175637645.0 + }, + { + "timeStamp": "2018-01-29T00:00:00Z", + "total": 1175858765.0 + } + ], + "name": { + "localizedValue": "Egress (BlobService)", + "value": "Egress" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + } + ] + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/CancelMigration.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/CancelMigration.json new file mode 100644 index 000000000000..cbe333457152 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/CancelMigration.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "share": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "operationId": "3ada6328-89ae-4263-8bfd-b76504a2bf66", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "jobId": "3ada6328-89ae-4263-8bfd-b76504a2bf66", + "sourceShareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "storageAccountName": "StorageAccountName1", + "containerName": "ContainerName1", + "destinationShareName": "\\\\192.168.1.1\\DestinationShare", + "migrationStatus": "Canceled", + "subEntitiesCompleted": 165, + "subEntitiesFailed": 5, + "failureReason": "" + } + }, + "202": { + "body": { + "jobId": "3ada6328-89ae-4263-8bfd-b76504a2bf66", + "sourceShareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "storageAccountName": "StorageAccountName1", + "containerName": "ContainerName1", + "destinationShareName": "\\\\192.168.1.1\\DestinationShare", + "migrationStatus": "Rollback", + "subEntitiesCompleted": 165, + "subEntitiesFailed": 5, + "failureReason": "" + } + } + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/List.json new file mode 100644 index 000000000000..9e3ca5870692 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/List.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "Intent": "Migration", + "StartIndex": "0", + "MaxCount": 1000, + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": [ + { + "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", + "accountname": "srphealthaccount", + "containername": "azurestackhealthrestrequestprocessed", + "containerid": 22, + "accountid": "3fe86317cc0d40e0a0d4833641a64fdb", + "usedBytesInPrimaryVolume": 2551603200, + "containerState": "Active" + }, + { + "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", + "accountname": "srphealthaccount", + "containername": "azurestackhealthrestrequestaccept", + "containerid": 23, + "accountid": "3fe86317cc0d40e0a0d4833641a64fdb", + "usedBytesInPrimaryVolume": 2282553344, + "containerState": "Active" + }, + { + "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", + "accountname": "frphealthaccount", + "containername": "azurestackhealthazssecurity", + "containerid": 6, + "accountid": "0a6b4f6b1de14cc08aa1fefadcc481eb", + "usedBytesInPrimaryVolume": 880074752, + "containerState": "Active" + }, + { + "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", + "accountname": "srphealthaccount", + "containername": "azurestackhealthtsqueueresponse", + "containerid": 30, + "accountid": "3fe86317cc0d40e0a0d4833641a64fdb", + "usedBytesInPrimaryVolume": 560037888, + "containerState": "Active" + }, + { + "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", + "accountname": "srphealthaccount", + "containername": "azurestackhealthtsqueuerequest", + "containerid": 26, + "accountid": "3fe86317cc0d40e0a0d4833641a64fdb", + "usedBytesInPrimaryVolume": 541351936, + "containerState": "Active" + }, + { + "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", + "accountname": "hrphealthaccount", + "containername": "azurestackhealthcentralmaeventtable", + "containerid": 37, + "accountid": "c2a6bdd19e404154afe27e2637e64ee1", + "usedBytesInPrimaryVolume": 456925184, + "containerState": "Active" + }, + { + "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", + "accountname": "srphealthaccount", + "containername": "azurestackhealthblobsvcrpcverbose", + "containerid": 17, + "accountid": "3fe86317cc0d40e0a0d4833641a64fdb", + "usedBytesInPrimaryVolume": 343273472, + "containerState": "Active" + }, + { + "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", + "accountname": "frphealthaccount", + "containername": "azurestackhealthsystemperfcounter60s", + "containerid": 7, + "accountid": "0a6b4f6b1de14cc08aa1fefadcc481eb", + "usedBytesInPrimaryVolume": 208580608, + "containerState": "Active" + }, + { + "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", + "accountname": "srphealthaccount", + "containername": "azurestackhealthtstableresponse", + "containerid": 31, + "accountid": "3fe86317cc0d40e0a0d4833641a64fdb", + "usedBytesInPrimaryVolume": 86974464, + "containerState": "Active" + }, + { + "sharename": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", + "accountname": "srphealthaccount", + "containername": "azurestackhealthtstablerequest", + "containerid": 28, + "accountid": "3fe86317cc0d40e0a0d4833641a64fdb", + "usedBytesInPrimaryVolume": 85082112, + "containerState": "Active" + } + ] + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/ListDestinationShares.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/ListDestinationShares.json new file mode 100644 index 000000000000..fb8ee37f335c --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/ListDestinationShares.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": [] + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/Migrate.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/Migrate.json new file mode 100644 index 000000000000..2212025bfaa3 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/Migrate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "api-version": "2015-12-01-preview", + "migrationParameters": { + "storageAccountName": "StorageAccountName1", + "containerName": "ContainerName1", + "destinationShareUncPath": "\\\\192.168.1.1\\DestinationShare" + } + }, + "responses": { + "200": { + "body": { + "jobId": "3ada6328-89ae-4263-8bfd-b76504a2bf66", + "sourceShareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "storageAccountName": "StorageAccountName1", + "containerName": "ContainerName1", + "destinationShareName": "\\\\192.168.1.1\\DestinationShare", + "migrationStatus": "Complete", + "subEntitiesCompleted": 165, + "subEntitiesFailed": 5, + "failureReason": "" + } + }, + "202": { + "body": { + "jobId": "3ada6328-89ae-4263-8bfd-b76504a2bf66", + "sourceShareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "storageAccountName": "StorageAccountName1", + "containerName": "ContainerName1", + "destinationShareName": "\\\\192.168.1.1\\DestinationShare", + "migrationStatus": "Active", + "subEntitiesCompleted": 165, + "subEntitiesFailed": 5, + "failureReason": "" + } + } + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/MigrationStatus.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/MigrationStatus.json new file mode 100644 index 000000000000..e7c37cd25468 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/MigrationStatus.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "share": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "operationId": "3ada6328-89ae-4263-8bfd-b76504a2bf66", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "jobId": "3ada6328-89ae-4263-8bfd-b76504a2bf66", + "sourceShareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "storageAccountName": "StorageAccountName1", + "containerName": "ContainerName1", + "destinationShareName": "\\192.168.1.1", + "migrationStatus": "Active", + "subEntitiesCompleted": 165, + "subEntitiesFailed": 5, + "failureReason": "" + } + } + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Create.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Create.json new file mode 100644 index 000000000000..d62bdb06a910 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Create.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "api-version": "2015-12-01-preview", + "farmObject": { + "properties": { + "settingAccessString" : "local" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af", + "name": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "type": "Microsoft.Storage.Admin/farms", + "location": "local", + "properties": { + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "version": "2015-12-01-preview", + "settingsStore": "AzS-ACS01.azurestack.local:19000", + "settings": { + "settingsPollingIntervalInSecond": 60, + "retentionPeriodForDeletedStorageAccountsInDays": 0, + "hostStyleHttpPort": 0, + "hostStyleHttpsPort": 0, + "corsAllowedOriginsList": "https://adminportal.local.azurestack.external/;https://adminportal.local.azurestack.external:12649/;https://portal.local.azurestack.external/;https://portal.local.azurestack.external:12649/", + "dataCenterUriHostSuffixes": "local.azurestack.external", + "bandwidthThrottleIsEnabled": false, + "usageCollectionIntervalInSeconds": 10, + "feedbackRefreshIntervalInSeconds": 10, + "numberOfAccountsToSync": 20, + "defaultThrottleProbabilityDecayIntervalInSeconds": 240, + "gracePeriodForFullThrottlingInRefreshIntervals": 3, + "gracePeriodMaxThrottleProbability": 0.9, + "overallRequestThresholdInTps": 10000.0, + "defaultRequestThresholdInTps": 200.0, + "minimumRequestThresholdInTps": 1.0, + "toleranceFactorForTps": 2.0, + "overallIngressThresholdInGbps": 25.0, + "defaultIngressThresholdInGbps": 2.0, + "minimumIngressThresholdInGbps": 0.0008, + "toleranceFactorForIngress": 2.0, + "overallIntranetIngressThresholdInGbps": 25.0, + "defaultIntranetIngressThresholdInGbps": 2.0, + "minimumIntranetIngressThresholdInGbps": 0.0008, + "toleranceFactorForIntranetIngress": 2.0, + "overallEgressThresholdInGbps": 30.0, + "defaultEgressThresholdInGbps": 3.0, + "minimumEgressThresholdInGbps": 0.0008, + "toleranceFactorForEgress": 2.0, + "overallIntranetEgressThresholdInGbps": 30.0, + "defaultIntranetEgressThresholdInGbps": 3.0, + "minimumIntranetEgressThresholdInGbps": 0.0008, + "toleranceFactorForIntranetEgress": 2.0, + "overallTotalIngressThresholdInGbps": 50.0, + "defaultTotalIngressThresholdInGbps": 5.0, + "minimumTotalIngressThresholdInGbps": 0.0008, + "toleranceFactorForTotalIngress": 2.0, + "overallTotalEgressThresholdInGbps": 50.0, + "defaultTotalEgressThresholdInGbps": 5.0, + "minimumTotalEgressThresholdInGbps": 0.0008, + "toleranceFactorForTotalEgress": 2.0 + } + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Get.json new file mode 100644 index 000000000000..db00ebd39623 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Get.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af", + "name": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "type": "Microsoft.Storage.Admin/farms", + "location": "local", + "properties": { + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "version": "2015-12-01-preview", + "settingsStore": "AzS-ACS01.azurestack.local:19000", + "settings": { + "settingsPollingIntervalInSecond": 60, + "retentionPeriodForDeletedStorageAccountsInDays": 0, + "hostStyleHttpPort": 0, + "hostStyleHttpsPort": 0, + "corsAllowedOriginsList": "https://adminportal.local.azurestack.external/;https://adminportal.local.azurestack.external:12649/;https://portal.local.azurestack.external/;https://portal.local.azurestack.external:12649/", + "dataCenterUriHostSuffixes": "local.azurestack.external", + "bandwidthThrottleIsEnabled": false, + "usageCollectionIntervalInSeconds": 10, + "feedbackRefreshIntervalInSeconds": 10, + "numberOfAccountsToSync": 20, + "defaultThrottleProbabilityDecayIntervalInSeconds": 240, + "gracePeriodForFullThrottlingInRefreshIntervals": 3, + "gracePeriodMaxThrottleProbability": 0.9, + "overallRequestThresholdInTps": 10000.0, + "defaultRequestThresholdInTps": 200.0, + "minimumRequestThresholdInTps": 1.0, + "toleranceFactorForTps": 2.0, + "overallIngressThresholdInGbps": 25.0, + "defaultIngressThresholdInGbps": 2.0, + "minimumIngressThresholdInGbps": 0.0008, + "toleranceFactorForIngress": 2.0, + "overallIntranetIngressThresholdInGbps": 25.0, + "defaultIntranetIngressThresholdInGbps": 2.0, + "minimumIntranetIngressThresholdInGbps": 0.0008, + "toleranceFactorForIntranetIngress": 2.0, + "overallEgressThresholdInGbps": 30.0, + "defaultEgressThresholdInGbps": 3.0, + "minimumEgressThresholdInGbps": 0.0008, + "toleranceFactorForEgress": 2.0, + "overallIntranetEgressThresholdInGbps": 30.0, + "defaultIntranetEgressThresholdInGbps": 3.0, + "minimumIntranetEgressThresholdInGbps": 0.0008, + "toleranceFactorForIntranetEgress": 2.0, + "overallTotalIngressThresholdInGbps": 50.0, + "defaultTotalIngressThresholdInGbps": 5.0, + "minimumTotalIngressThresholdInGbps": 0.0008, + "toleranceFactorForTotalIngress": 2.0, + "overallTotalEgressThresholdInGbps": 50.0, + "defaultTotalEgressThresholdInGbps": 5.0, + "minimumTotalEgressThresholdInGbps": 0.0008, + "toleranceFactorForTotalEgress": 2.0 + } + } + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/GetGarbageCollectionState.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/GetGarbageCollectionState.json new file mode 100644 index 000000000000..647b161cb1ce --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/GetGarbageCollectionState.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "operationId": "5ad334a7-4f51-141a-b52f-39a7df8d7033", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": "Failed?" + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/List.json new file mode 100644 index 000000000000..c744b612a843 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/List.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af", + "name": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "type": "Microsoft.Storage.Admin/farms", + "location": "local", + "properties": { + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "version": "2015-12-01-preview", + "settingsStore": "AzS-ACS01.azurestack.local:19000", + "settings": { + "settingsPollingIntervalInSecond": 60, + "retentionPeriodForDeletedStorageAccountsInDays": 0, + "hostStyleHttpPort": 0, + "hostStyleHttpsPort": 0, + "corsAllowedOriginsList": "https://adminportal.local.azurestack.external/;https://adminportal.local.azurestack.external:12649/;https://portal.local.azurestack.external/;https://portal.local.azurestack.external:12649/", + "dataCenterUriHostSuffixes": "local.azurestack.external", + "bandwidthThrottleIsEnabled": false, + "usageCollectionIntervalInSeconds": 10, + "feedbackRefreshIntervalInSeconds": 10, + "numberOfAccountsToSync": 20, + "defaultThrottleProbabilityDecayIntervalInSeconds": 240, + "gracePeriodForFullThrottlingInRefreshIntervals": 3, + "gracePeriodMaxThrottleProbability": 0.9, + "overallRequestThresholdInTps": 10000.0, + "defaultRequestThresholdInTps": 200.0, + "minimumRequestThresholdInTps": 1.0, + "toleranceFactorForTps": 2.0, + "overallIngressThresholdInGbps": 25.0, + "defaultIngressThresholdInGbps": 2.0, + "minimumIngressThresholdInGbps": 0.0008, + "toleranceFactorForIngress": 2.0, + "overallIntranetIngressThresholdInGbps": 25.0, + "defaultIntranetIngressThresholdInGbps": 2.0, + "minimumIntranetIngressThresholdInGbps": 0.0008, + "toleranceFactorForIntranetIngress": 2.0, + "overallEgressThresholdInGbps": 30.0, + "defaultEgressThresholdInGbps": 3.0, + "minimumEgressThresholdInGbps": 0.0008, + "toleranceFactorForEgress": 2.0, + "overallIntranetEgressThresholdInGbps": 30.0, + "defaultIntranetEgressThresholdInGbps": 3.0, + "minimumIntranetEgressThresholdInGbps": 0.0008, + "toleranceFactorForIntranetEgress": 2.0, + "overallTotalIngressThresholdInGbps": 50.0, + "defaultTotalIngressThresholdInGbps": 5.0, + "minimumTotalIngressThresholdInGbps": 0.0008, + "toleranceFactorForTotalIngress": 2.0, + "overallTotalEgressThresholdInGbps": 50.0, + "defaultTotalEgressThresholdInGbps": 5.0, + "minimumTotalEgressThresholdInGbps": 0.0008, + "toleranceFactorForTotalEgress": 2.0 + } + } + } + ] + } + } + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/ListMetricDefinitions.json new file mode 100644 index 000000000000..bf697ca486c1 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/ListMetricDefinitions.json @@ -0,0 +1,151 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Processor time percentage", + "value": "ProcessorTime" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Available memory", + "value": "AvailableMemory" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Total Capacity", + "value": "TotalCapacity" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Used Capacity", + "value": "UsedCapacity" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Free Space", + "value": "FreeSpace" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Used Capacity Percentage", + "value": "UsedCapacityPercentage " + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Free Space Percentage", + "value": "FreeSpacePercentage " + }, + "primaryAggregationType": "Average", + "unit": "Count" + } + ] + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/ListMetrics.json new file mode 100644 index 000000000000..1b1474f4edfa --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/ListMetrics.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "endTime": "2018-01-30T19:31:03.1837713Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Processor time percentage", + "value": "ProcessorTime" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:03.1837713Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Available memory", + "value": "AvailableMemory" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:03.1837713Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 2728176648192.0, + "timeStamp": "2018-01-29T00:00:00Z" + }, + { + "average": 2728176648192.0, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 2728176648192.0, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 2728176648192.0, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 2728176648192.0, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 2728176648192.0, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 2728176648192.0, + "timeStamp": "2018-01-23T00:00:00Z" + } + ], + "name": { + "localizedValue": "Total Capacity", + "value": "TotalCapacity" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:03.1837713Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 389873692672.0, + "timeStamp": "2018-01-29T00:00:00Z" + }, + { + "average": 379637998762.66669, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 369550244352.0, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 359099803818.66669, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 348343386965.33331, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 338910678186.66669, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 330334962346.66669, + "timeStamp": "2018-01-23T00:00:00Z" + } + ], + "name": { + "localizedValue": "Used Capacity", + "value": "UsedCapacity" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:03.1837713Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 2338302955520.0, + "timeStamp": "2018-01-29T00:00:00Z" + }, + { + "average": 2348538649429.3335, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 2358626403840.0, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 2369076844373.3335, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 2379833261226.6665, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 2389265970005.3335, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 2397841685845.3335, + "timeStamp": "2018-01-23T00:00:00Z" + } + ], + "name": { + "localizedValue": "Free Space", + "value": "FreeSpace" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:03.1837713Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 0.14290632277436091, + "timeStamp": "2018-01-29T00:00:00Z" + }, + { + "average": 0.139154478510128, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 0.13545686075603133, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 0.13162630215189586, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 0.12768358940253569, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 0.12422607546738861, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 0.12108268816302059, + "timeStamp": "2018-01-23T00:00:00Z" + } + ], + "name": { + "localizedValue": "Used Capacity Percentage", + "value": "UsedCapacityPercentage " + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:03.1837713Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 0.857093677225639, + "timeStamp": "2018-01-29T00:00:00Z" + }, + { + "average": 0.86084552148987215, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 0.86454313924396864, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 0.86837369784810392, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 0.87231641059746445, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 0.8757739245326116, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 0.87891731183697941, + "timeStamp": "2018-01-23T00:00:00Z" + } + ], + "name": { + "localizedValue": "Free Space Percentage", + "value": "FreeSpacePercentage " + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + } + ] + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/StartGarbageCollection.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/StartGarbageCollection.json new file mode 100644 index 000000000000..1278cbe67f91 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/StartGarbageCollection.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Update.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Update.json new file mode 100644 index 000000000000..3006ccb6e48c --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Update.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "api-version": "2015-12-01-preview", + "farmObject": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af", + "name": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "type": "Microsoft.Storage.Admin/farms", + "location": "local", + "properties": { + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "version": "2015-12-01-preview", + "settingsStore": "AzS-ACS01.azurestack.local:19000", + "settings": { + "settingsPollingIntervalInSecond": 60, + "retentionPeriodForDeletedStorageAccountsInDays": 0, + "hostStyleHttpPort": 0, + "hostStyleHttpsPort": 0, + "corsAllowedOriginsList": "https://adminportal.local.azurestack.external/;https://adminportal.local.azurestack.external:12649/;https://portal.local.azurestack.external/;https://portal.local.azurestack.external:12649/", + "dataCenterUriHostSuffixes": "local.azurestack.external", + "bandwidthThrottleIsEnabled": false, + "usageCollectionIntervalInSeconds": 10, + "feedbackRefreshIntervalInSeconds": 10, + "numberOfAccountsToSync": 20, + "defaultThrottleProbabilityDecayIntervalInSeconds": 240, + "gracePeriodForFullThrottlingInRefreshIntervals": 3, + "gracePeriodMaxThrottleProbability": 0.9, + "overallRequestThresholdInTps": 10000.0, + "defaultRequestThresholdInTps": 200.0, + "minimumRequestThresholdInTps": 1.0, + "toleranceFactorForTps": 2.0, + "overallIngressThresholdInGbps": 25.0, + "defaultIngressThresholdInGbps": 2.0, + "minimumIngressThresholdInGbps": 0.0008, + "toleranceFactorForIngress": 2.0, + "overallIntranetIngressThresholdInGbps": 25.0, + "defaultIntranetIngressThresholdInGbps": 2.0, + "minimumIntranetIngressThresholdInGbps": 0.0008, + "toleranceFactorForIntranetIngress": 2.0, + "overallEgressThresholdInGbps": 30.0, + "defaultEgressThresholdInGbps": 3.0, + "minimumEgressThresholdInGbps": 0.0008, + "toleranceFactorForEgress": 2.0, + "overallIntranetEgressThresholdInGbps": 30.0, + "defaultIntranetEgressThresholdInGbps": 3.0, + "minimumIntranetEgressThresholdInGbps": 0.0008, + "toleranceFactorForIntranetEgress": 2.0, + "overallTotalIngressThresholdInGbps": 50.0, + "defaultTotalIngressThresholdInGbps": 5.0, + "minimumTotalIngressThresholdInGbps": 0.0008, + "toleranceFactorForTotalIngress": 2.0, + "overallTotalEgressThresholdInGbps": 50.0, + "defaultTotalEgressThresholdInGbps": 5.0, + "minimumTotalEgressThresholdInGbps": 0.0008, + "toleranceFactorForTotalEgress": 2.0 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af", + "name": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "type": "Microsoft.Storage.Admin/farms", + "location": "local", + "properties": { + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "version": "2015-12-01-preview", + "settingsStore": "AzS-ACS01.azurestack.local:19000", + "settings": { + "settingsPollingIntervalInSecond": 60, + "retentionPeriodForDeletedStorageAccountsInDays": 0, + "hostStyleHttpPort": 0, + "hostStyleHttpsPort": 0, + "corsAllowedOriginsList": "https://adminportal.local.azurestack.external/;https://adminportal.local.azurestack.external:12649/;https://portal.local.azurestack.external/;https://portal.local.azurestack.external:12649/", + "dataCenterUriHostSuffixes": "local.azurestack.external", + "bandwidthThrottleIsEnabled": false, + "usageCollectionIntervalInSeconds": 10, + "feedbackRefreshIntervalInSeconds": 10, + "numberOfAccountsToSync": 20, + "defaultThrottleProbabilityDecayIntervalInSeconds": 240, + "gracePeriodForFullThrottlingInRefreshIntervals": 3, + "gracePeriodMaxThrottleProbability": 0.9, + "overallRequestThresholdInTps": 10000.0, + "defaultRequestThresholdInTps": 200.0, + "minimumRequestThresholdInTps": 1.0, + "toleranceFactorForTps": 2.0, + "overallIngressThresholdInGbps": 25.0, + "defaultIngressThresholdInGbps": 2.0, + "minimumIngressThresholdInGbps": 0.0008, + "toleranceFactorForIngress": 2.0, + "overallIntranetIngressThresholdInGbps": 25.0, + "defaultIntranetIngressThresholdInGbps": 2.0, + "minimumIntranetIngressThresholdInGbps": 0.0008, + "toleranceFactorForIntranetIngress": 2.0, + "overallEgressThresholdInGbps": 30.0, + "defaultEgressThresholdInGbps": 3.0, + "minimumEgressThresholdInGbps": 0.0008, + "toleranceFactorForEgress": 2.0, + "overallIntranetEgressThresholdInGbps": 30.0, + "defaultIntranetEgressThresholdInGbps": 3.0, + "minimumIntranetEgressThresholdInGbps": 0.0008, + "toleranceFactorForIntranetEgress": 2.0, + "overallTotalIngressThresholdInGbps": 50.0, + "defaultTotalIngressThresholdInGbps": 5.0, + "minimumTotalIngressThresholdInGbps": 0.0008, + "toleranceFactorForTotalIngress": 2.0, + "overallTotalEgressThresholdInGbps": 50.0, + "defaultTotalEgressThresholdInGbps": 5.0, + "minimumTotalEgressThresholdInGbps": 0.0008, + "toleranceFactorForTotalEgress": 2.0 + } + } + } + } + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Operations/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Operations/List.json new file mode 100644 index 000000000000..8fba0ec3fe0e --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Operations/List.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [] + } + } + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/Get.json new file mode 100644 index 000000000000..bf2960541ea1 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "serviceType": "default", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/queueservices/default", + "name": "3cf03497-c44a-4e51-a56f-3987d88c70af/default", + "type": "Microsoft.Storage.Admin/farms/queueservices", + "location": "local", + "properties": { + "settings": { + "frontEndHttpListenPort": 11001, + "frontEndHttpsListenPort": 11101, + "frontEndCallbackThreadsCount": 1600, + "frontEndCpuBasedKeepAliveThrottlingEnabled": true, + "frontEndCpuBasedKeepAliveThrottlingPercentCpuThreshold": 90.0, + "frontEndCpuBasedKeepAliveThrottlingPercentRequestsToThrottle": 2.0, + "frontEndCpuBasedKeepAliveThrottlingCpuMonitorIntervalInSeconds": 5, + "frontEndMemoryThrottlingEnabled": true, + "frontEndMaxMillisecondsBetweenMemorySamples": 10000, + "frontEndMemoryThrottleThresholdSettings": "5,100,0;7,50,0;10,25,0;15,0,25;", + "frontEndMinThreadPoolThreads": 1850, + "frontEndThreadPoolBasedKeepAliveIOCompletionThreshold": 1500, + "frontEndThreadPoolBasedKeepAliveWorkerThreadThreshold": 1500, + "frontEndThreadPoolBasedKeepAliveMonitorIntervalInSeconds": 30, + "frontEndThreadPoolBasedKeepAlivePercentage": 10.0, + "frontEndUseSlaTimeInAvailability": true + }, + "version": "1.0" + } + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/ListMetricDefinitions.json new file mode 100644 index 000000000000..057d38c007c0 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/ListMetricDefinitions.json @@ -0,0 +1,282 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "serviceType": "default", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "End-to-end latency (QueueService)", + "value": "E2ELatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Server latency (QueueService)", + "value": "ServerLatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Availability (QueueService)", + "value": "Availability" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Total requests (QueueService)", + "value": "TotalRequests" + }, + "primaryAggregationType": "Total", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Ingress (QueueService)", + "value": "Ingress" + }, + "primaryAggregationType": "Total", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Egress (QueueService)", + "value": "Egress" + }, + "primaryAggregationType": "Total", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Requests per second (QueueFrontEnd)", + "value": "QueueFrontEndRequestsPerSecond" + }, + "primaryAggregationType": "Average", + "unit": "CountPerSecond" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "End-to-end latency (QueueFrontEnd)", + "value": "QueueFrontEndE2ELatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Server latency (QueueFrontEnd)", + "value": "QueueFrontEndServerLatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Concurrent requests (QueueFrontEnd)", + "value": "QueueFrontEndConcurrentRequests" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "The count of pending requests in the request queue (QueueFrontEnd)", + "value": "QueueFrontEndRequestQueueLength" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Processor time percentage (QueueFrontEnd)", + "value": "QueueFrontEndProcessorTime" + }, + "primaryAggregationType": "Average", + "unit": "Count" + } + ] + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/ListMetrics.json new file mode 100644 index 000000000000..2a381de0c7a4 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/ListMetrics.json @@ -0,0 +1,324 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "serviceType": "default", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "endTime": "2018-01-30T19:31:24.5345914Z", + "metricUnit": "CountPerSecond", + "metricValues": [], + "name": { + "localizedValue": "Requests per second (QueueFrontEnd)", + "value": "QueueFrontEndRequestsPerSecond" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:24.5345914Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "End-to-end latency (QueueFrontEnd)", + "value": "QueueFrontEndE2ELatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:24.5345914Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Server latency (QueueFrontEnd)", + "value": "QueueFrontEndServerLatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:24.5345914Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Concurrent requests (QueueFrontEnd)", + "value": "QueueFrontEndConcurrentRequests" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:24.5345914Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "The count of pending requests in the request queue (QueueFrontEnd)", + "value": "QueueFrontEndRequestQueueLength" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:24.5345914Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Processor time percentage (QueueFrontEnd)", + "value": "QueueFrontEndProcessorTime" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:24.5345914Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 1.88592776264484, + "timeStamp": "2018-01-23T00:00:00Z" + }, + { + "average": 1.85851217466339, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 1.87040051806059, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 1.90624102793048, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 1.93359342860519, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 1.91756062246845, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 1.90350660188966, + "timeStamp": "2018-01-29T00:00:00Z" + } + ], + "name": { + "localizedValue": "End-to-end latency (QueueService)", + "value": "E2ELatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:24.5345914Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 1.81003101711863, + "timeStamp": "2018-01-23T00:00:00Z" + }, + { + "average": 1.78567652998375, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 1.79746391271282, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 1.83270876455636, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 1.85885443391132, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 1.84392369316924, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 1.82936276116956, + "timeStamp": "2018-01-29T00:00:00Z" + } + ], + "name": { + "localizedValue": "Server latency (QueueService)", + "value": "ServerLatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:24.5345914Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 100.0, + "timeStamp": "2018-01-23T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-29T00:00:00Z" + } + ], + "name": { + "localizedValue": "Availability (QueueService)", + "value": "Availability" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:24.5345914Z", + "metricUnit": "Count", + "metricValues": [ + { + "timeStamp": "2018-01-23T00:00:00Z", + "total": 709694.0 + }, + { + "timeStamp": "2018-01-24T00:00:00Z", + "total": 706686.0 + }, + { + "timeStamp": "2018-01-25T00:00:00Z", + "total": 706644.0 + }, + { + "timeStamp": "2018-01-26T00:00:00Z", + "total": 707869.0 + }, + { + "timeStamp": "2018-01-27T00:00:00Z", + "total": 711097.0 + }, + { + "timeStamp": "2018-01-28T00:00:00Z", + "total": 711197.0 + }, + { + "timeStamp": "2018-01-29T00:00:00Z", + "total": 713652.0 + } + ], + "name": { + "localizedValue": "Total requests (QueueService)", + "value": "TotalRequests" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:24.5345914Z", + "metricUnit": "Count", + "metricValues": [ + { + "timeStamp": "2018-01-23T00:00:00Z", + "total": 330187754.0 + }, + { + "timeStamp": "2018-01-24T00:00:00Z", + "total": 328237824.0 + }, + { + "timeStamp": "2018-01-25T00:00:00Z", + "total": 328220543.0 + }, + { + "timeStamp": "2018-01-26T00:00:00Z", + "total": 328897291.0 + }, + { + "timeStamp": "2018-01-27T00:00:00Z", + "total": 330626016.0 + }, + { + "timeStamp": "2018-01-28T00:00:00Z", + "total": 330693320.0 + }, + { + "timeStamp": "2018-01-29T00:00:00Z", + "total": 332315876.0 + } + ], + "name": { + "localizedValue": "Ingress (QueueService)", + "value": "Ingress" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:24.5345914Z", + "metricUnit": "Count", + "metricValues": [ + { + "timeStamp": "2018-01-23T00:00:00Z", + "total": 179169105.0 + }, + { + "timeStamp": "2018-01-24T00:00:00Z", + "total": 178217533.0 + }, + { + "timeStamp": "2018-01-25T00:00:00Z", + "total": 178211569.0 + }, + { + "timeStamp": "2018-01-26T00:00:00Z", + "total": 178640382.0 + }, + { + "timeStamp": "2018-01-27T00:00:00Z", + "total": 179836179.0 + }, + { + "timeStamp": "2018-01-28T00:00:00Z", + "total": 179870886.0 + }, + { + "timeStamp": "2018-01-29T00:00:00Z", + "total": 180647853.0 + } + ], + "name": { + "localizedValue": "Egress (QueueService)", + "value": "Egress" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + } + ] + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/CreateOrUpdate.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/CreateOrUpdate.json new file mode 100644 index 000000000000..e517246f6efb --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/CreateOrUpdate.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "location": "local", + "quotaName": "TestCreateQuota", + "api-version": "2015-12-01-preview", + "quotaObject": { + "properties": { + "numberOfStorageAccounts": 10000, + "capacityInGb": 1000 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.Storage.Admin/locations/local/quotas/TestCreateQuota", + "name": "local/TestCreateQuota", + "type": "Microsoft.Storage.Admin/locations/quotas", + "location": "local", + "properties": { + "numberOfStorageAccounts": 10000, + "capacityInGb": 1000 + } + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/Delete.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/Delete.json new file mode 100644 index 000000000000..ff95aa42890c --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "location": "local", + "quotaName": "TestCreateQuota", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/Get.json new file mode 100644 index 000000000000..7f3b02edfd5a --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "location": "local", + "quotaName": "TestCreateQuota", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.Storage.Admin/locations/local/quotas/TestCreateQuota", + "name": "local/TestCreateQuota", + "type": "Microsoft.Storage.Admin/locations/quotas", + "location": "local", + "properties": { + "numberOfStorageAccounts": -1000000000, + "capacityInGb": -100000000 + } + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/List.json new file mode 100644 index 000000000000..8c35ade928dc --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "location": "local", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/providers/Microsoft.Storage.Admin/locations/local/quotas/TestCreateQuota", + "name": "local/TestCreateQuota", + "type": "Microsoft.Storage.Admin/locations/quotas", + "location": "local", + "properties": { + "numberOfStorageAccounts": -1000000000, + "capacityInGb": -100000000 + } + } + ] + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/Get.json new file mode 100644 index 000000000000..22b923e03388 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/shares/||SU1FileServer.azurestack.local|SU1_ObjStore", + "name": "3cf03497-c44a-4e51-a56f-3987d88c70af/||SU1FileServer.azurestack.local|SU1_ObjStore", + "type": "Microsoft.Storage.Admin/farms/shares", + "location": "local", + "properties": { + "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "uncPath": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", + "totalCapacity": 2728176648192, + "usedCapacity": 400509059072, + "freeCapacity": 2327667589120, + "healthStatus": "Healthy" + } + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/List.json new file mode 100644 index 000000000000..6943387e72da --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/shares/||SU1FileServer.azurestack.local|SU1_ObjStore", + "name": "3cf03497-c44a-4e51-a56f-3987d88c70af/||SU1FileServer.azurestack.local|SU1_ObjStore", + "type": "Microsoft.Storage.Admin/farms/shares", + "location": "local", + "properties": { + "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "uncPath": "\\\\\\\\SU1FileServer.azurestack.local\\\\SU1_ObjStore", + "totalCapacity": 2728176648192, + "usedCapacity": 400509059072, + "freeCapacity": 2327667589120, + "healthStatus": "Healthy" + } + } + ] + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/ListMetricDefinitions.json new file mode 100644 index 000000000000..f75adc8d6035 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/ListMetricDefinitions.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricAvailabilities": [ + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Total Capacity", + "value": "TotalCapacity" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Used Capacity", + "value": "UsedCapacity" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Free Space", + "value": "FreeSpace" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Used Capacity Percentage", + "value": "UsedCapacityPercentage " + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Free Space Percentage", + "value": "FreeSpacePercentage " + }, + "primaryAggregationType": "Average", + "unit": "Count" + } + ] + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/ListMetrics.json new file mode 100644 index 000000000000..74d001dd0003 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/ListMetrics.json @@ -0,0 +1,218 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "shareName": "||SU1FileServer.azurestack.local|SU1_ObjStore", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "endTime": "2018-01-30T19:31:25.5502828Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 2728176648192.0, + "timeStamp": "2018-01-29T00:00:00Z" + }, + { + "average": 2728176648192.0, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 2728176648192.0, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 2728176648192.0, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 2728176648192.0, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 2728176648192.0, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 2728176648192.0, + "timeStamp": "2018-01-23T00:00:00Z" + } + ], + "name": { + "localizedValue": "Total Capacity", + "value": "TotalCapacity" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:25.5502828Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 389873692672.0, + "timeStamp": "2018-01-29T00:00:00Z" + }, + { + "average": 379637998762.66669, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 369550244352.0, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 359099803818.66669, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 348343386965.33331, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 338910678186.66669, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 330334962346.66669, + "timeStamp": "2018-01-23T00:00:00Z" + } + ], + "name": { + "localizedValue": "Used Capacity", + "value": "UsedCapacity" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:25.5502828Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 2338302955520.0, + "timeStamp": "2018-01-29T00:00:00Z" + }, + { + "average": 2348538649429.3335, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 2358626403840.0, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 2369076844373.3335, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 2379833261226.6665, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 2389265970005.3335, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 2397841685845.3335, + "timeStamp": "2018-01-23T00:00:00Z" + } + ], + "name": { + "localizedValue": "Free Space", + "value": "FreeSpace" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:25.5502828Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 0.14290632277436091, + "timeStamp": "2018-01-29T00:00:00Z" + }, + { + "average": 0.139154478510128, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 0.13545686075603133, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 0.13162630215189586, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 0.12768358940253569, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 0.12422607546738861, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 0.12108268816302059, + "timeStamp": "2018-01-23T00:00:00Z" + } + ], + "name": { + "localizedValue": "Used Capacity Percentage", + "value": "UsedCapacityPercentage " + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:25.5502828Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 0.857093677225639, + "timeStamp": "2018-01-29T00:00:00Z" + }, + { + "average": 0.86084552148987215, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 0.86454313924396864, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 0.86837369784810392, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 0.87231641059746445, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 0.8757739245326116, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 0.87891731183697941, + "timeStamp": "2018-01-23T00:00:00Z" + } + ], + "name": { + "localizedValue": "Free Space Percentage", + "value": "FreeSpacePercentage " + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + } + ] + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Get.json new file mode 100644 index 000000000000..5671da1b311c --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "accountId": "f93c9df9e7af487fbda484a9201d9c18", + "api-version": "2015-12-01-preview", + "summary": "false" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/f93c9df9e7af487fbda484a9201d9c18", + "type": "Microsoft.Storage.Admin/storageaccounts", + "name": "f93c9df9e7af487fbda484a9201d9c18", + "location": "local", + "properties": { + "provisioningState": "Succeeded", + "primaryEndpoints": { + "blob": "https://authprod.blob.local.azurestack.external/", + "queue": "https://authprod.queue.local.azurestack.external/", + "table": "https://authprod.table.local.azurestack.external/" + }, + "primaryLocation": "local", + "statusOfPrimary": "Available", + "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local/providers/Microsoft.Storage/storageaccounts/authprod", + "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "tenantStorageAccountName": "authprod", + "tenantResourceGroupName": "system.local", + "currentOperation": "None", + "acquisitionOperationCount": 0, + "accountStatus": "Active", + "permissions": "Full", + "accountId": "f93c9df9e7af487fbda484a9201d9c18", + "wacInternalState": "Active", + "accountType": "Standard_LRS", + "creationTime": "2018-01-17T01:56:30.983" + } + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/List.json new file mode 100644 index 000000000000..eae05a284cb9 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/List.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "api-version": "2015-12-01-preview", + "summary": "false" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/0180624c67694706a4066782d83057a5", + "type": "Microsoft.Storage.Admin/storageaccounts", + "name": "0180624c67694706a4066782d83057a5", + "location": "local", + "properties": { + "provisioningState": "Succeeded", + "primaryEndpoints": { + "blob": "https://adminkvlclproddata004.blob.local.azurestack.external/", + "queue": "https://adminkvlclproddata004.queue.local.azurestack.external/", + "table": "https://adminkvlclproddata004.table.local.azurestack.external/" + }, + "primaryLocation": "local", + "statusOfPrimary": "Available", + "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local.adminkeyvault/providers/Microsoft.Storage/storageaccounts/adminkvlclproddata004", + "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "tenantStorageAccountName": "adminkvlclproddata004", + "tenantResourceGroupName": "system.local.adminkeyvault", + "currentOperation": "None", + "acquisitionOperationCount": 0, + "accountStatus": "Active", + "permissions": "Full", + "accountId": "0180624c67694706a4066782d83057a5", + "wacInternalState": "Active", + "accountType": "Standard_LRS", + "creationTime": "2018-01-17T02:10:27.41" + } + }, + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/04106a84393f4a12ab8efdbc0a69bb65", + "type": "Microsoft.Storage.Admin/storageaccounts", + "name": "04106a84393f4a12ab8efdbc0a69bb65", + "location": "local", + "properties": { + "provisioningState": "Succeeded", + "primaryEndpoints": { + "blob": "https://adminkvlclproddata005.blob.local.azurestack.external/", + "queue": "https://adminkvlclproddata005.queue.local.azurestack.external/", + "table": "https://adminkvlclproddata005.table.local.azurestack.external/" + }, + "primaryLocation": "local", + "statusOfPrimary": "Available", + "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local.adminkeyvault/providers/Microsoft.Storage/storageaccounts/adminkvlclproddata005", + "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "tenantStorageAccountName": "adminkvlclproddata005", + "tenantResourceGroupName": "system.local.adminkeyvault", + "currentOperation": "None", + "acquisitionOperationCount": 0, + "accountStatus": "Active", + "permissions": "Full", + "accountId": "04106a84393f4a12ab8efdbc0a69bb65", + "wacInternalState": "Active", + "accountType": "Standard_LRS", + "creationTime": "2018-01-17T02:10:27.847" + } + }, + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/06e296e00b284f5cb5708dfabd6ad74c", + "type": "Microsoft.Storage.Admin/storageaccounts", + "name": "06e296e00b284f5cb5708dfabd6ad74c", + "location": "local", + "properties": { + "provisioningState": "Succeeded", + "primaryEndpoints": { + "blob": "https://wasphealthaccount.blob.local.azurestack.external/", + "queue": "https://wasphealthaccount.queue.local.azurestack.external/", + "table": "https://wasphealthaccount.table.local.azurestack.external/" + }, + "primaryLocation": "local", + "statusOfPrimary": "Available", + "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local/providers/Microsoft.Storage/storageaccounts/wasphealthaccount", + "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "tenantStorageAccountName": "wasphealthaccount", + "tenantResourceGroupName": "system.local", + "currentOperation": "None", + "acquisitionOperationCount": 0, + "accountStatus": "Active", + "permissions": "Full", + "accountId": "06e296e00b284f5cb5708dfabd6ad74c", + "wacInternalState": "Active", + "accountType": "Standard_LRS", + "creationTime": "2018-01-17T02:10:12.47" + } + }, + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/0a6b4f6b1de14cc08aa1fefadcc481eb", + "type": "Microsoft.Storage.Admin/storageaccounts", + "name": "0a6b4f6b1de14cc08aa1fefadcc481eb", + "location": "local", + "properties": { + "provisioningState": "Succeeded", + "primaryEndpoints": { + "blob": "https://frphealthaccount.blob.local.azurestack.external/", + "queue": "https://frphealthaccount.queue.local.azurestack.external/", + "table": "https://frphealthaccount.table.local.azurestack.external/" + }, + "primaryLocation": "local", + "statusOfPrimary": "Available", + "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local/providers/Microsoft.Storage/storageaccounts/frphealthaccount", + "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "tenantStorageAccountName": "frphealthaccount", + "tenantResourceGroupName": "system.local", + "currentOperation": "None", + "acquisitionOperationCount": 0, + "accountStatus": "Active", + "permissions": "Full", + "accountId": "0a6b4f6b1de14cc08aa1fefadcc481eb", + "wacInternalState": "Active", + "accountType": "Standard_LRS", + "creationTime": "2018-01-17T02:10:02.527" + } + }, + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/0d724e3f75004e48948c1bfa0b4a964a", + "type": "Microsoft.Storage.Admin/storageaccounts", + "name": "0d724e3f75004e48948c1bfa0b4a964a", + "location": "local", + "properties": { + "provisioningState": "Succeeded", + "primaryEndpoints": { + "blob": "https://systemgallery.blob.local.azurestack.external/", + "queue": "https://systemgallery.queue.local.azurestack.external/", + "table": "https://systemgallery.table.local.azurestack.external/" + }, + "primaryLocation": "local", + "statusOfPrimary": "Available", + "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local/providers/Microsoft.Storage/storageaccounts/systemgallery", + "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "tenantStorageAccountName": "systemgallery", + "tenantResourceGroupName": "system.local", + "currentOperation": "None", + "acquisitionOperationCount": 0, + "accountStatus": "Active", + "permissions": "Full", + "accountId": "0d724e3f75004e48948c1bfa0b4a964a", + "wacInternalState": "Active", + "accountType": "Standard_LRS", + "creationTime": "2018-01-17T01:56:29.467" + } + }, + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/0dda0879146341178603ba151d7da010", + "type": "Microsoft.Storage.Admin/storageaccounts", + "name": "0dda0879146341178603ba151d7da010", + "location": "local", + "properties": { + "provisioningState": "Succeeded", + "primaryEndpoints": { + "blob": "https://nrpeventsaccount.blob.local.azurestack.external/", + "queue": "https://nrpeventsaccount.queue.local.azurestack.external/", + "table": "https://nrpeventsaccount.table.local.azurestack.external/" + }, + "primaryLocation": "local", + "statusOfPrimary": "Available", + "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local/providers/Microsoft.Storage/storageaccounts/nrpeventsaccount", + "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "tenantStorageAccountName": "nrpeventsaccount", + "tenantResourceGroupName": "system.local", + "currentOperation": "None", + "acquisitionOperationCount": 0, + "accountStatus": "Active", + "permissions": "Full", + "accountId": "0dda0879146341178603ba151d7da010", + "wacInternalState": "Active", + "accountType": "Standard_LRS", + "creationTime": "2018-01-17T02:10:23.84" + } + }, + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/15612011f6094654abcb6031a4394ef5", + "type": "Microsoft.Storage.Admin/storageaccounts", + "name": "15612011f6094654abcb6031a4394ef5", + "location": "local", + "properties": { + "provisioningState": "Succeeded", + "primaryEndpoints": { + "blob": "https://kvrphealthaccount.blob.local.azurestack.external/", + "queue": "https://kvrphealthaccount.queue.local.azurestack.external/", + "table": "https://kvrphealthaccount.table.local.azurestack.external/" + }, + "primaryLocation": "local", + "statusOfPrimary": "Available", + "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local/providers/Microsoft.Storage/storageaccounts/kvrphealthaccount", + "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "tenantStorageAccountName": "kvrphealthaccount", + "tenantResourceGroupName": "system.local", + "currentOperation": "None", + "acquisitionOperationCount": 0, + "accountStatus": "Active", + "permissions": "Full", + "accountId": "15612011f6094654abcb6031a4394ef5", + "wacInternalState": "Active", + "accountType": "Standard_LRS", + "creationTime": "2018-01-17T02:10:36.193" + } + }, + { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/storageaccounts/17829fa81c154239ad8a6fae05f44793", + "type": "Microsoft.Storage.Admin/storageaccounts", + "name": "17829fa81c154239ad8a6fae05f44793", + "location": "local", + "properties": { + "provisioningState": "Succeeded", + "primaryEndpoints": { + "blob": "https://srpusageaccount.blob.local.azurestack.external/", + "queue": "https://srpusageaccount.queue.local.azurestack.external/", + "table": "https://srpusageaccount.table.local.azurestack.external/" + }, + "primaryLocation": "local", + "statusOfPrimary": "Available", + "tenantViewId": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourcegroups/system.local/providers/Microsoft.Storage/storageaccounts/srpusageaccount", + "tenantSubscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "tenantStorageAccountName": "srpusageaccount", + "tenantResourceGroupName": "system.local", + "currentOperation": "None", + "acquisitionOperationCount": 0, + "accountStatus": "Active", + "permissions": "Full", + "accountId": "17829fa81c154239ad8a6fae05f44793", + "wacInternalState": "Active", + "accountType": "Standard_LRS", + "creationTime": "2018-01-17T02:10:15.38" + } + } + ] + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Synchronize.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Synchronize.json new file mode 100644 index 000000000000..eb639a1b8c68 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Synchronize.json @@ -0,0 +1,6 @@ +{ + "parameters": {}, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/SynchronizeAll.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/SynchronizeAll.json new file mode 100644 index 000000000000..eb639a1b8c68 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/SynchronizeAll.json @@ -0,0 +1,6 @@ +{ + "parameters": {}, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Undelete.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Undelete.json new file mode 100644 index 000000000000..fe8f5618a743 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Undelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "accountId": "f93c9df9e7af487fbda484a9201d9c18", + "api-version": "2015-12-01-preview", + "summary": "false" + }, + "responses": { + "200": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/Get.json new file mode 100644 index 000000000000..0459b8ca8684 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "serviceType": "default", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/9ad61516-995c-4873-a21f-7e44904f0ed2/resourceGroups/System.local/providers/Microsoft.Storage.Admin/farms/3cf03497-c44a-4e51-a56f-3987d88c70af/tableservices/default", + "name": "3cf03497-c44a-4e51-a56f-3987d88c70af/default", + "type": "Microsoft.Storage.Admin/farms/tableservices", + "location": "local", + "properties": { + "settings": { + "frontEndHttpListenPort": 11002, + "frontEndHttpsListenPort": 11102, + "frontEndCallbackThreadsCount": 1600, + "frontEndCpuBasedKeepAliveThrottlingEnabled": true, + "frontEndCpuBasedKeepAliveThrottlingPercentCpuThreshold": 90.0, + "frontEndCpuBasedKeepAliveThrottlingPercentRequestsToThrottle": 2.0, + "frontEndCpuBasedKeepAliveThrottlingCpuMonitorIntervalInSeconds": 5, + "frontEndMemoryThrottlingEnabled": true, + "frontEndMaxMillisecondsBetweenMemorySamples": 10000, + "frontEndMemoryThrottleThresholdSettings": "5,100,0;7,50,0;10,25,0;15,0,25;", + "frontEndMinThreadPoolThreads": 1850, + "frontEndThreadPoolBasedKeepAliveIOCompletionThreshold": 1500, + "frontEndThreadPoolBasedKeepAliveWorkerThreadThreshold": 1500, + "frontEndThreadPoolBasedKeepAliveMonitorIntervalInSeconds": 30, + "frontEndThreadPoolBasedKeepAlivePercentage": 10.0, + "frontEndUseSlaTimeInAvailability": true + }, + "version": "1.0" + } + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/ListMetricDefinitions.json new file mode 100644 index 000000000000..f88bdee55fd4 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/ListMetricDefinitions.json @@ -0,0 +1,502 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "serviceType": "default", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "End-to-end latency (TableService)", + "value": "E2ELatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Server latency (TableService)", + "value": "ServerLatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Availability (TableService)", + "value": "Availability" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Total requests (TableService)", + "value": "TotalRequests" + }, + "primaryAggregationType": "Total", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Ingress (TableService)", + "value": "Ingress" + }, + "primaryAggregationType": "Total", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P1D", + "timeGrain": "PT1M" + }, + { + "retention": "P10D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Egress (TableService)", + "value": "Egress" + }, + "primaryAggregationType": "Total", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Requests per second (TableFrontEnd)", + "value": "TableFrontEndRequestsPerSecond" + }, + "primaryAggregationType": "Average", + "unit": "CountPerSecond" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "End-to-end latency (TableFrontEnd)", + "value": "TableFrontEndE2ELatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Server latency (TableFrontEnd)", + "value": "TableFrontEndServerLatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Concurrent requests (TableFrontEnd)", + "value": "TableFrontEndConcurrentRequests" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "The count of pending requests in the request queue (TableFrontEnd)", + "value": "TableFrontEndRequestQueueLength" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Processor time percentage (TableFrontEnd)", + "value": "TableFrontEndProcessorTime" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Requests per second (TableMaster)", + "value": "TableMasterRequestsPerSecond" + }, + "primaryAggregationType": "Average", + "unit": "CountPerSecond" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Successful requests per second (TableMaster)", + "value": "TableMasterSuccessfulRequestsPerSecond" + }, + "primaryAggregationType": "Average", + "unit": "CountPerSecond" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Failed requests per second (TableMaster)", + "value": "TableMasterFailedRequestsPerSecond" + }, + "primaryAggregationType": "Average", + "unit": "CountPerSecond" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Server latency (TableMaster)", + "value": "TableMasterServerLatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Processor time percentage (TableMaster)", + "value": "TableMasterProcessorTime" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Requests per second (TableServer)", + "value": "TableServerRequestsPerSecond" + }, + "primaryAggregationType": "Average", + "unit": "CountPerSecond" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Successful requests per second (TableServer)", + "value": "TableServerSuccessfulRequestsPerSecond" + }, + "primaryAggregationType": "Average", + "unit": "CountPerSecond" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Failed requests per second (TableServer)", + "value": "TableServerFailedRequestsPerSecond" + }, + "primaryAggregationType": "Average", + "unit": "CountPerSecond" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Server latency (TableServer)", + "value": "TableServerServerLatency" + }, + "primaryAggregationType": "Average", + "unit": "Count" + }, + { + "metricAvailabilities": [ + { + "retention": "P10D", + "timeGrain": "PT1M" + }, + { + "retention": "P30D", + "timeGrain": "PT1H" + }, + { + "retention": "P60D", + "timeGrain": "P1D" + } + ], + "name": { + "localizedValue": "Processor time percentage (TableServer)", + "value": "TableServerProcessorTime" + }, + "primaryAggregationType": "Average", + "unit": "Count" + } + ] + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/ListMetrics.json new file mode 100644 index 000000000000..232ee093f603 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/ListMetrics.json @@ -0,0 +1,434 @@ +{ + "parameters": { + "subscriptionId": "9ad61516-995c-4873-a21f-7e44904f0ed2", + "resourceGroupName": "System.local", + "farmId": "3cf03497-c44a-4e51-a56f-3987d88c70af", + "serviceType": "default", + "api-version": "2015-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "CountPerSecond", + "metricValues": [], + "name": { + "localizedValue": "Requests per second (TableFrontEnd)", + "value": "TableFrontEndRequestsPerSecond" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "End-to-end latency (TableFrontEnd)", + "value": "TableFrontEndE2ELatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Server latency (TableFrontEnd)", + "value": "TableFrontEndServerLatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Concurrent requests (TableFrontEnd)", + "value": "TableFrontEndConcurrentRequests" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "The count of pending requests in the request queue (TableFrontEnd)", + "value": "TableFrontEndRequestQueueLength" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Processor time percentage (TableFrontEnd)", + "value": "TableFrontEndProcessorTime" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "CountPerSecond", + "metricValues": [], + "name": { + "localizedValue": "Requests per second (TableMaster)", + "value": "TableMasterRequestsPerSecond" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "CountPerSecond", + "metricValues": [], + "name": { + "localizedValue": "Successful requests per second (TableMaster)", + "value": "TableMasterSuccessfulRequestsPerSecond" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "CountPerSecond", + "metricValues": [], + "name": { + "localizedValue": "Failed requests per second (TableMaster)", + "value": "TableMasterFailedRequestsPerSecond" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Server latency (TableMaster)", + "value": "TableMasterServerLatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Processor time percentage (TableMaster)", + "value": "TableMasterProcessorTime" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "CountPerSecond", + "metricValues": [], + "name": { + "localizedValue": "Requests per second (TableServer)", + "value": "TableServerRequestsPerSecond" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "CountPerSecond", + "metricValues": [], + "name": { + "localizedValue": "Successful requests per second (TableServer)", + "value": "TableServerSuccessfulRequestsPerSecond" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "CountPerSecond", + "metricValues": [], + "name": { + "localizedValue": "Failed requests per second (TableServer)", + "value": "TableServerFailedRequestsPerSecond" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Server latency (TableServer)", + "value": "TableServerServerLatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [], + "name": { + "localizedValue": "Processor time percentage (TableServer)", + "value": "TableServerProcessorTime" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 7.29314082130133, + "timeStamp": "2018-01-23T00:00:00Z" + }, + { + "average": 7.29242044505202, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 7.45627809068669, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 7.30089294071398, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 7.72399956185191, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 7.60159978218237, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 7.47610318708534, + "timeStamp": "2018-01-29T00:00:00Z" + } + ], + "name": { + "localizedValue": "End-to-end latency (TableService)", + "value": "E2ELatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 6.35217701106319, + "timeStamp": "2018-01-23T00:00:00Z" + }, + { + "average": 6.33429027113238, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 6.48739451176727, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 6.32658791815646, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 6.7042208266394, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 6.63925794831982, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 6.49650197949997, + "timeStamp": "2018-01-29T00:00:00Z" + } + ], + "name": { + "localizedValue": "Server latency (TableService)", + "value": "ServerLatency" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [ + { + "average": 100.0, + "timeStamp": "2018-01-23T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-24T00:00:00Z" + }, + { + "average": 99.9981206752038, + "timeStamp": "2018-01-25T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-26T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-27T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-28T00:00:00Z" + }, + { + "average": 100.0, + "timeStamp": "2018-01-29T00:00:00Z" + } + ], + "name": { + "localizedValue": "Availability (TableService)", + "value": "Availability" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [ + { + "timeStamp": "2018-01-23T00:00:00Z", + "total": 269054.0 + }, + { + "timeStamp": "2018-01-24T00:00:00Z", + "total": 265771.0 + }, + { + "timeStamp": "2018-01-25T00:00:00Z", + "total": 266053.0 + }, + { + "timeStamp": "2018-01-26T00:00:00Z", + "total": 269687.0 + }, + { + "timeStamp": "2018-01-27T00:00:00Z", + "total": 276294.0 + }, + { + "timeStamp": "2018-01-28T00:00:00Z", + "total": 274176.0 + }, + { + "timeStamp": "2018-01-29T00:00:00Z", + "total": 279001.0 + } + ], + "name": { + "localizedValue": "Total requests (TableService)", + "value": "TotalRequests" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [ + { + "timeStamp": "2018-01-23T00:00:00Z", + "total": 511130540.0 + }, + { + "timeStamp": "2018-01-24T00:00:00Z", + "total": 503169523.0 + }, + { + "timeStamp": "2018-01-25T00:00:00Z", + "total": 507168827.0 + }, + { + "timeStamp": "2018-01-26T00:00:00Z", + "total": 568486028.0 + }, + { + "timeStamp": "2018-01-27T00:00:00Z", + "total": 700065592.0 + }, + { + "timeStamp": "2018-01-28T00:00:00Z", + "total": 690837578.0 + }, + { + "timeStamp": "2018-01-29T00:00:00Z", + "total": 695035903.0 + } + ], + "name": { + "localizedValue": "Ingress (TableService)", + "value": "Ingress" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + }, + { + "endTime": "2018-01-30T19:31:22.8313413Z", + "metricUnit": "Count", + "metricValues": [ + { + "timeStamp": "2018-01-23T00:00:00Z", + "total": 6755876285.0 + }, + { + "timeStamp": "2018-01-24T00:00:00Z", + "total": 6754791566.0 + }, + { + "timeStamp": "2018-01-25T00:00:00Z", + "total": 6756295607.0 + }, + { + "timeStamp": "2018-01-26T00:00:00Z", + "total": 6762121121.0 + }, + { + "timeStamp": "2018-01-27T00:00:00Z", + "total": 6787273660.0 + }, + { + "timeStamp": "2018-01-28T00:00:00Z", + "total": 6749797687.0 + }, + { + "timeStamp": "2018-01-29T00:00:00Z", + "total": 6790505524.0 + } + ], + "name": { + "localizedValue": "Egress (TableService)", + "value": "Egress" + }, + "startTime": "2018-01-23T00:00:00Z", + "timeGrain": "P1D" + } + ] + } + }, + "404": {} + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/farms.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/farms.json new file mode 100644 index 000000000000..7159cb373383 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/farms.json @@ -0,0 +1,702 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}": { + "put": { + "x-ms-examples": { + "Create a new storage farm.": { + "$ref": "./examples/Farms/Create.json" + } + }, + "tags": [ + "Farms" + ], + "description": "Create a new storage farm.", + "operationId": "Farms_Create", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "description": "Parameters used to create a farm", + "name": "farmObject", + "in": "body", + "required": true, + "schema": { + "$ref": "farms.json#/definitions/FarmCreationProperties" + } + } + ], + "responses": { + "200": { + "description": "OK -- The new storage farm has been created.", + "schema": { + "$ref": "farms.json#/definitions/Farm" + } + } + } + }, + "get": { + "x-ms-examples": { + "Returns the Storage properties and settings for a specified storage farm.": { + "$ref": "./examples/Farms/Get.json" + } + }, + "tags": [ + "Farms" + ], + "description": "Returns the Storage properties and settings for a specified storage farm.", + "operationId": "Farms_Get", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The farm has been returned.", + "schema": { + "$ref": "farms.json#/definitions/Farm" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + } + }, + "patch": { + "x-ms-examples": { + "Update an existing storage farm.": { + "$ref": "./examples/Farms/Update.json" + } + }, + "tags": [ + "Farms" + ], + "description": "Update an existing storage farm.", + "operationId": "Farms_Update", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "description": "Farm to update.", + "name": "farmObject", + "in": "body", + "required": true, + "schema": { + "$ref": "farms.json#/definitions/Farm" + } + } + ], + "responses": { + "200": { + "description": "OK -- The properties and settings of storage farm have been updated.", + "schema": { + "$ref": "farms.json#/definitions/Farm" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/metricdefinitions": { + "get": { + "x-ms-examples": { + "Returns a list of metric definitions for a storage farm.": { + "$ref": "./examples/Farms/ListMetricDefinitions.json" + } + }, + "tags": [ + "Farms" + ], + "description": "Returns a list of metric definitions for a storage farm.", + "operationId": "Farms_ListMetricDefinitions", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metric definitions has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricDefinitionList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/metrics": { + "get": { + "x-ms-examples": { + "Returns a list of storage farm metrics.": { + "$ref": "./examples/Farms/ListMetrics.json" + } + }, + "tags": [ + "Farms" + ], + "description": "Returns a list of storage farm metrics.", + "operationId": "Farms_ListMetrics", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metrics has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms": { + "get": { + "x-ms-examples": { + "Returns a list of all storage farms.": { + "$ref": "./examples/Farms/List.json" + } + }, + "tags": [ + "Farms" + ], + "description": "Returns a list of all storage farms.", + "operationId": "Farms_List", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of storage farms has been returned.", + "schema": { + "$ref": "farms.json#/definitions/FarmList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/ondemandgc": { + "post": { + "x-ms-examples": { + "Start garbage collection on deleted storage objects.": { + "$ref": "./examples/Farms/StartGarbageCollection.json" + } + }, + "tags": [ + "Farms" + ], + "operationId": "Farms_StartGarbageCollection", + "description": "Start garbage collection on deleted storage objects.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Garbage collection has completed." + }, + "202": { + "description": "ACCEPTED -- Garbage collection has started." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/operationresults/{operationId}": { + "get": { + "x-ms-examples": { + "Returns the state of the garbage collection job.": { + "$ref": "./examples/Farms/GetGarbageCollectionState.json" + } + }, + "tags": [ + "GC" + ], + "operationId": "Farms_GetGarbageCollectionState", + "description": "Returns the state of the garbage collection job.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "storage.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The state of garbage collection has been returned.", + "schema": { + "type": "string" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm or garbage collection job can not be found." + } + } + } + } + }, + "definitions": { + "FarmList": { + "description": "Pageable list of storage farms.", + "type": "object", + "properties": { + "value": { + "description": "List of storage farms.", + "type": "array", + "items": { + "$ref": "farms.json#/definitions/Farm" + } + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string", + "readOnly": true + } + } + }, + "FarmCreationProperties": { + "description": "Storage farm properties.", + "type": "object", + "properties": { + "properties": { + "description": "Storage farm properties.", + "x-ms-client-flatten": true, + "$ref": "farms.json#/definitions/SettingAccessString" + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + }, + "Farm": { + "description": "Storage farm.", + "type": "object", + "properties": { + "properties": { + "description": "Storage farm properties.", + "x-ms-client-flatten": true, + "$ref": "farms.json#/definitions/FarmProperties", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + }, + "FarmSettings": { + "description": "Storage farm settings.", + "type": "object", + "properties": { + "settingsPollingIntervalInSecond": { + "description": "The polling interval (in second).", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "retentionPeriodForDeletedStorageAccountsInDays": { + "description": "The retention period (in days) for deleted storage account.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "hostStyleHttpPort": { + "description": "Host style HTTP port.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "hostStyleHttpsPort": { + "description": "Host style HTTPs port.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "corsAllowedOriginsList": { + "description": "The list of allowed origins.", + "type": "string", + "readOnly": true + }, + "dataCenterUriHostSuffixes": { + "description": "The suffixes of URI of hosts in data center.", + "type": "string", + "readOnly": true + }, + "bandwidthThrottleIsEnabled": { + "description": "Switch of bandwidth throttle enablement.", + "type": "boolean", + "readOnly": true + }, + "usageCollectionIntervalInSeconds": { + "description": "Interval (in seconds) of storage usage collection.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "feedbackRefreshIntervalInSeconds": { + "description": "Interval (in seconds) of feedback refresh.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "numberOfAccountsToSync": { + "description": "Number of accounts to sync.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "defaultThrottleProbabilityDecayIntervalInSeconds": { + "description": "Interval (in seconds) of default throttle probability decay.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "gracePeriodForFullThrottlingInRefreshIntervals": { + "description": "Grace period for full throttling in refresh intervals.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "gracePeriodMaxThrottleProbability": { + "description": "Maximum probability of throttle in grace period.", + "type": "number", + "format": "float", + "readOnly": true + }, + "overallRequestThresholdInTps": { + "description": "Overall request threshold (in TPS).", + "type": "number", + "format": "float", + "readOnly": true + }, + "defaultRequestThresholdInTps": { + "description": "Default request threshold (in TPS).", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimumRequestThresholdInTps": { + "description": "Minimum request threshold (in TPS).", + "type": "number", + "format": "float", + "readOnly": true + }, + "toleranceFactorForTps": { + "description": "Tolerance factor for TPS.", + "type": "number", + "format": "float", + "readOnly": true + }, + "overallIngressThresholdInGbps": { + "description": "Overall ingress threshold (in Gbps)", + "type": "number", + "format": "float", + "readOnly": true + }, + "defaultIngressThresholdInGbps": { + "description": "Default ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimumIngressThresholdInGbps": { + "description": "Minimum ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "toleranceFactorForIngress": { + "description": "Tolerance factor for ingress.", + "type": "number", + "format": "float", + "readOnly": true + }, + "overallIntranetIngressThresholdInGbps": { + "description": "Overall Intranet ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "defaultIntranetIngressThresholdInGbps": { + "description": "Default Intranet ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimumIntranetIngressThresholdInGbps": { + "description": "Minimum Intranet ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "toleranceFactorForIntranetIngress": { + "description": "Tolerance factor for Intranet ingress.", + "type": "number", + "format": "float", + "readOnly": true + }, + "overallEgressThresholdInGbps": { + "description": "Overall egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "defaultEgressThresholdInGbps": { + "description": "Default egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimumEgressThresholdInGbps": { + "description": "Minimum egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "toleranceFactorForEgress": { + "description": "Tolerance factor for egress.", + "type": "number", + "format": "float", + "readOnly": true + }, + "overallIntranetEgressThresholdInGbps": { + "description": "Overall Intranet egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "defaultIntranetEgressThresholdInGbps": { + "description": "Default Intranet egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimumIntranetEgressThresholdInGbps": { + "description": "Minimum Intranet egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "toleranceFactorForIntranetEgress": { + "description": "Tolerance factor for Intranet egress.", + "type": "number", + "format": "float", + "readOnly": true + }, + "overallTotalIngressThresholdInGbps": { + "description": "Overall total ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "defaultTotalIngressThresholdInGbps": { + "description": "Default total ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimumTotalIngressThresholdInGbps": { + "description": "Minimum total ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "toleranceFactorForTotalIngress": { + "description": "Tolerance factor for total ingress.", + "type": "number", + "format": "float", + "readOnly": true + }, + "overallTotalEgressThresholdInGbps": { + "description": "Overall total egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "defaultTotalEgressThresholdInGbps": { + "description": "Default total egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimumTotalEgressThresholdInGbps": { + "description": "Minimum total egress threshold (in Gbp", + "type": "number", + "format": "float", + "readOnly": true + }, + "toleranceFactorForTotalEgress": { + "description": "Tolerance factor for total egress.", + "type": "number", + "format": "float", + "readOnly": true + } + } + }, + "FarmProperties": { + "description": "The properties of storage farm.", + "type": "object", + "properties": { + "farmId": { + "description": "Farm identifier.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "Resource version.", + "type": "string", + "readOnly": true + }, + "settingsStore": { + "description": "The settings of storage farm.", + "type": "string", + "readOnly": true + }, + "settings": { + "description": "The properties of storage farm.", + "x-ms-client-flatten": true, + "$ref": "farms.json#/definitions/FarmSettings", + "readOnly": true + } + } + }, + "SettingAccessString": { + "description": "Setting access string.", + "type": "object", + "properties": { + "settingAccessString": { + "description": "Setting access string.", + "type": "string" + } + } + } + }, + "parameters": {}, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/queueServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/queueServices.json new file mode 100644 index 000000000000..63faf4913473 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/queueServices.json @@ -0,0 +1,207 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/queueservices/{serviceType}": { + "get": { + "x-ms-examples": { + "Returns the queue service.": { + "$ref": "./examples/QueueService/Get.json" + } + }, + "tags": [ + "QueueServices" + ], + "description": "Returns the queue service.", + "operationId": "QueueServices_Get", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Queue service has been returned.", + "schema": { + "$ref": "queueServices.json#/definitions/QueueService" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/queueservices/{serviceType}/metricdefinitions": { + "get": { + "x-ms-examples": { + "Returns a list of metric definitions for queue service.": { + "$ref": "./examples/QueueService/ListMetricDefinitions.json" + } + }, + "tags": [ + "QueueServices" + ], + "description": "Returns a list of metric definitions for queue service.", + "operationId": "QueueServices_ListMetricDefinitions", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metric definitions has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricDefinitionList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/queueservices/{serviceType}/metrics": { + "get": { + "x-ms-examples": { + "Returns a list of metrics for the queue service.": { + "$ref": "./examples/QueueService/ListMetrics.json" + } + }, + "tags": [ + "QueueServices" + ], + "description": "Returns a list of metrics for the queue service.", + "operationId": "QueueServices_ListMetrics", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metrics has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "QueueServiceProperties": { + "description": "Queue service properties.", + "type": "object", + "properties": { + "settings": { + "description": "Queue service settings.", + "x-ms-client-flatten": true, + "$ref": "storage.json#/definitions/WritableServiceSettings", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Service" + } + ] + }, + "QueueService": { + "description": "Queue service.", + "type": "object", + "properties": { + "properties": { + "description": "Queue service properties.", + "x-ms-client-flatten": true, + "$ref": "queueServices.json#/definitions/QueueServiceProperties", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + } + }, + "parameters": {}, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/quotas.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/quotas.json new file mode 100644 index 000000000000..96563f8296ad --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/quotas.json @@ -0,0 +1,263 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/quotas/{quotaName}": { + "put": { + "x-ms-examples": { + "Create or update an existing storage quota.": { + "$ref": "./examples/Quotas/CreateOrUpdate.json" + } + }, + "tags": [ + "StorageQuotas" + ], + "description": "Create or update an existing storage quota.", + "operationId": "StorageQuotas_CreateOrUpdate", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/LocationParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "quotas.json#/parameters/QuotaNameParameter" + }, + { + "$ref": "quotas.json#/parameters/StorgeQuotaParameters" + } + ], + "responses": { + "200": { + "description": "OK -- The storage quota has been created or updated.", + "schema": { + "$ref": "quotas.json#/definitions/StorageQuota" + } + }, + "404": { + "description": "NOT FOUND -- The location or quota was not found." + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an existing storage quota.": { + "$ref": "./examples/Quotas/Delete.json" + } + }, + "tags": [ + "StorageQuotas" + ], + "description": "Delete an existing quota", + "operationId": "StorageQuotas_Delete", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "storage.json#/parameters/LocationParameter" + }, + { + "$ref": "quotas.json#/parameters/QuotaNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The storage quota has been deleted." + }, + "404": { + "description": "NOT FOUND -- The location or storage quota cannot be found." + } + } + }, + "get": { + "x-ms-examples": { + "Returns the specified storage quota.": { + "$ref": "./examples/Quotas/Get.json" + } + }, + "tags": [ + "StorageQuotas" + ], + "description": "Returns the specified storage quota.", + "operationId": "StorageQuotas_Get", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "storage.json#/parameters/LocationParameter" + }, + { + "$ref": "quotas.json#/parameters/QuotaNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The storage quota has been returned.", + "schema": { + "$ref": "quotas.json#/definitions/StorageQuota" + } + }, + "404": { + "description": "NOT FOUND -- The location or storage quota cannot be found." + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/quotas": { + "get": { + "x-ms-examples": { + "Returns a list of storage quotas at the given location.": { + "$ref": "./examples/Quotas/List.json" + } + }, + "tags": [ + "StorageQuotas" + ], + "description": "Returns a list of storage quotas at the given location.", + "operationId": "StorageQuotas_List", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/LocationParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of storage quotas has been returned.", + "schema": { + "$ref": "quotas.json#/definitions/StorageQuotaList" + } + }, + "404": { + "description": "OK -- The location does not exist." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "StorageQuota": { + "description": "Storage quota.", + "type": "object", + "properties": { + "properties": { + "description": "Storage quota properties.", + "x-ms-client-flatten": true, + "$ref": "quotas.json#/definitions/StorageQuotaProperties" + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + }, + "StorageQuotaProperties": { + "description": "Storage quota properties.", + "type": "object", + "properties": { + "numberOfStorageAccounts": { + "description": "Total number of storage accounts.", + "type": "integer", + "format": "int32", + "default": 20 + }, + "capacityInGb": { + "description": "Maxium capacity (GB).", + "type": "integer", + "format": "int32", + "default": 500 + } + } + }, + "StorageQuotaList": { + "description": "Pageable list of storage quotas.", + "type": "object", + "properties": { + "value": { + "description": "List of storage quotas.", + "type": "array", + "items": { + "$ref": "quotas.json#/definitions/StorageQuota" + } + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string" + } + } + } + }, + "parameters": { + "QuotaNameParameter": { + "description": "The name of the storage quota.", + "name": "quotaName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "StorgeQuotaParameters": { + "description": "The properties of quota being created or updated.", + "name": "quotaObject", + "in": "body", + "required": true, + "schema": { + "$ref": "quotas.json#/definitions/StorageQuota" + }, + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/shares.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/shares.json new file mode 100644 index 000000000000..c116c0201495 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/shares.json @@ -0,0 +1,278 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares": { + "get": { + "x-ms-examples": { + "Returns a list of storage shares.": { + "$ref": "./examples/Shares/List.json" + } + }, + "tags": [ + "Shares" + ], + "description": "Returns a list of storage shares.", + "operationId": "Shares_List", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of storage shares has been returned.", + "schema": { + "$ref": "shares.json#/definitions/ShareList" + } + }, + "404": { + "description": "NOT FOUND -- The farm cannot be found." + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/metrics": { + "get": { + "x-ms-examples": { + "Returns a list of metrics for a storage share.": { + "$ref": "./examples/Shares/ListMetrics.json" + } + }, + "tags": [ + "Shares" + ], + "description": "Returns a list of metrics for a storage share.", + "operationId": "Shares_ListMetrics", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ShareNameParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metrics has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricList" + } + }, + "404": { + "description": "NOT FOUND -- The farm or share cannot be found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/metricdefinitions": { + "get": { + "x-ms-examples": { + "Returns a list of metric definitions for a storage share.": { + "$ref": "./examples/Shares/ListMetricDefinitions.json" + } + }, + "tags": [ + "Shares" + ], + "description": "Returns a list of metric definitions for a storage share.", + "operationId": "Shares_ListMetricDefinitions", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ShareNameParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metric definitions has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricDefinitionList" + } + }, + "404": { + "description": "NOT FOUND -- The farm cannot be found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}": { + "get": { + "x-ms-examples": { + "Returns a storage share.": { + "$ref": "./examples/Shares/Get.json" + } + }, + "tags": [ + "Shares" + ], + "description": "Returns a storage share.", + "operationId": "Shares_Get", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ShareNameParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The storage share has been returned.", + "schema": { + "$ref": "shares.json#/definitions/Share" + } + }, + "404": { + "description": "NOT FOUND -- The farm or storage share cannot be found." + } + } + } + } + }, + "definitions": { + "Share": { + "description": "Storage share.", + "type": "object", + "properties": { + "properties": { + "description": "Storage share properties.", + "x-ms-client-flatten": true, + "$ref": "shares.json#/definitions/ShareProperties", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + }, + "ShareList": { + "description": "List of storage shares.", + "type": "array", + "items": { + "$ref": "shares.json#/definitions/Share" + } + }, + "ShareProperties": { + "description": "Storage share properties.", + "type": "object", + "properties": { + "shareName": { + "description": "The name of the storage share.", + "type": "string", + "readOnly": true + }, + "uncPath": { + "description": "The UNC path to the storage share.", + "type": "string", + "readOnly": true + }, + "totalCapacity": { + "description": "The total capacity of the storage share in bytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "usedCapacity": { + "description": "The used capacity of the storage share in bytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "freeCapacity": { + "description": "The free space of the storage share in bytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "healthStatus": { + "description": "The health status of the storage share.", + "$ref": "storage.json#/definitions/HealthStatus", + "readOnly": true + } + } + } + }, + "parameters": {}, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storage.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storage.json new file mode 100644 index 000000000000..374c28032326 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storage.json @@ -0,0 +1,575 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Storage.Admin/operations": { + "get": { + "x-ms-examples": { + "Get the list of support rest operations.": { + "$ref": "./examples/Operations/List.json" + } + }, + "description": "Get the list of support rest operations.", + "tags": [ + "Commerce" + ], + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of operations has been returned.", + "schema": { + "$ref": "storage.json#/definitions/OperationList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "WritableSettings": { + "description": "Storage service settings.", + "type": "object", + "properties": { + "frontEndCallbackThreadsCount": { + "description": "Front end callback threads count.", + "type": "integer", + "format": "int32" + }, + "frontEndCpuBasedKeepAliveThrottlingEnabled": { + "description": "Switch of front end CPU based keep-alive throttling.", + "type": "boolean" + }, + "frontEndCpuBasedKeepAliveThrottlingPercentCpuThreshold": { + "description": "Threshold (% percentage) of front end CPU based keep-alive throttling.", + "type": "number", + "format": "float" + }, + "frontEndCpuBasedKeepAliveThrottlingPercentRequestsToThrottle": { + "description": "Threshold (% percentage) of requests to throttle in front end CPU based keep-alive throttling.", + "type": "number", + "format": "float" + }, + "frontEndCpuBasedKeepAliveThrottlingCpuMonitorIntervalInSeconds": { + "description": "Interval (in second) of CPU monitor for front end CPU based keep-alive throttling.", + "type": "integer", + "format": "int32" + }, + "frontEndMemoryThrottlingEnabled": { + "description": "Switch of front end memory throttling.", + "type": "boolean" + }, + "frontEndMaxMillisecondsBetweenMemorySamples": { + "description": "Maxium interval (in millisecond) between memory samples of front end.", + "type": "integer", + "format": "int32" + }, + "frontEndMemoryThrottleThresholdSettings": { + "description": "Front end memory throttle threshold settings.", + "type": "string" + }, + "frontEndMinThreadPoolThreads": { + "description": "Front end minimum number of threads in thread pool.", + "type": "integer", + "format": "int32" + }, + "frontEndThreadPoolBasedKeepAliveIOCompletionThreshold": { + "description": "Threshold of front end thread pool based keep-alive IO completion.", + "type": "integer", + "format": "int32" + }, + "frontEndThreadPoolBasedKeepAliveWorkerThreadThreshold": { + "description": "Threshold of front end thread pool based keep-alive worker thread.", + "type": "integer", + "format": "int32" + }, + "frontEndThreadPoolBasedKeepAliveMonitorIntervalInSeconds": { + "description": "Monitor interval (in seconds) of front end thread pool based keep-alive monitor.", + "type": "integer", + "format": "int32" + }, + "frontEndThreadPoolBasedKeepAlivePercentage": { + "description": "Percentage (%) of front end thread pool based keep-alive.", + "type": "number", + "format": "float" + }, + "frontEndUseSlaTimeInAvailability": { + "description": "Switch of whether front end uses SLA time in availability.", + "type": "boolean" + } + } + }, + "WritableServiceSettings": { + "description": "Settings of storage services.", + "type": "object", + "properties": { + "frontEndHttpsListenPort": { + "description": "The HTTPs port of the storage service front end.", + "type": "integer", + "format": "int32" + }, + "frontEndHttpListenPort": { + "description": "The HTTP port of the storage service front end.", + "type": "integer", + "format": "int32" + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/WritableSettings" + } + ] + }, + "LocalizableString": { + "description": "Localizable string.", + "type": "object", + "properties": { + "value": { + "description": "Value of the string.", + "type": "string" + }, + "localizedValue": { + "description": "Localized value of the string.", + "type": "string" + } + } + }, + "MetricAvailability": { + "description": "Metric availability.", + "type": "object", + "properties": { + "timeGrain": { + "description": "Time grain.", + "type": "string" + }, + "retention": { + "description": "Retention of metric.", + "type": "string" + } + } + }, + "AggregateType": { + "description": "Aggregate type.", + "readOnly": true, + "type": "string", + "enum": [ + "None", + "Average", + "Total", + "Minimum", + "Maximum", + "Last" + ], + "x-ms-enum": { + "name": "AggregateType", + "modelAsString": true + } + }, + "MetricUnit": { + "description": "Metric unit.", + "type": "string", + "enum": [ + "Count", + "Bytes", + "Seconds", + "CountPerSecond", + "BytesPerSecond" + ], + "x-ms-enum": { + "name": "MetricUnit", + "modelAsString": true + } + }, + "MetricDefinition": { + "description": "Metric definition.", + "type": "object", + "properties": { + "name": { + "description": "Metric name.", + "$ref": "storage.json#/definitions/LocalizableString", + "readOnly": true + }, + "unit": { + "description": "Metric unit.", + "$ref": "storage.json#/definitions/MetricUnit", + "readOnly": true + }, + "primaryAggregationType": { + "description": "Aggregation type of metric.", + "$ref": "storage.json#/definitions/AggregateType", + "readOnly": true + }, + "metricAvailabilities": { + "description": "Metric availabilities.", + "type": "array", + "items": { + "$ref": "storage.json#/definitions/MetricAvailability" + }, + "readOnly": true + } + } + }, + "Metric": { + "description": "Metric information.", + "type": "object", + "properties": { + "name": { + "description": "Metric Name.", + "$ref": "storage.json#/definitions/LocalizableString", + "readOnly": true + }, + "metricUnit": { + "description": "Metric Unit.", + "$ref": "storage.json#/definitions/MetricUnit", + "readOnly": true + }, + "timeGrain": { + "description": "Metric time grain.", + "type": "string", + "readOnly": true + }, + "startTime": { + "description": "Metric start time.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "endTime": { + "description": "Metric end time.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "metricValues": { + "description": "List of metric values.", + "type": "array", + "items": { + "$ref": "storage.json#/definitions/MetricValue" + }, + "readOnly": true + } + } + }, + "MetricDefinitionList": { + "description": "Pageable list of metric definitions.", + "type": "object", + "properties": { + "value": { + "description": "List of metric definitions.", + "type": "array", + "items": { + "$ref": "storage.json#/definitions/MetricDefinition" + }, + "readOnly": true + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string", + "readOnly": true + } + } + }, + "MetricList": { + "description": "Pageable list of metrics.", + "type": "object", + "properties": { + "value": { + "description": "List of metrics.", + "type": "array", + "items": { + "$ref": "storage.json#/definitions/Metric" + }, + "readOnly": true + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string", + "readOnly": true + } + } + }, + "MetricValue": { + "description": "Metric value.", + "properties": { + "timeStamp": { + "description": "Timestamp of metric value.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "average": { + "description": "Average value of metric.", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimum": { + "description": "Minimum value of metric.", + "type": "number", + "format": "float", + "readOnly": true + }, + "maximum": { + "description": "Maximum value of metric.", + "type": "number", + "format": "float", + "readOnly": true + }, + "total": { + "description": "Total value of metric.", + "type": "number", + "format": "float", + "readOnly": true + }, + "count": { + "description": "Count of metric values.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "properties": { + "description": "Metric value properties.", + "type": "string", + "readOnly": true + } + } + }, + "HealthStatus": { + "readOnly": true, + "description": "Current health status.", + "type": "string", + "enum": [ + "Unknown", + "Healthy", + "Warning", + "Critical" + ], + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": true + } + }, + "Resource": { + "description": "Base resource object.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource Name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Resource location.", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "Service": { + "description": "Storage service.", + "properties": { + "version": { + "description": "Storage service version.", + "type": "string" + }, + "healthStatus": { + "description": "Health status of storage service.", + "$ref": "storage.json#/definitions/HealthStatus" + } + } + }, + "Operation": { + "description": "Describes the supported REST operation.", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "Contains the localized display information for this particular operation / action.", + "$ref": "storage.json#/definitions/Display", + "readOnly": true + } + } + }, + "Display": { + "description": "Contains the localized display information for this particular operation / action.", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with \"Microsoft\" for 1st party services. e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute.\"", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation – it should match the public documentation for the resource provider.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The localized friendly name for the operation, as it should be shown to the user.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise – it will be used in tool tips and detailed views.", + "type": "string", + "readOnly": true + } + } + }, + "OperationList": { + "description": "Pageable list of supported operations.", + "properties": { + "value": { + "description": "List of operations", + "type": "array", + "items": { + "$ref": "storage.json#/definitions/Operation" + } + }, + "nextLink": { + "description": "URI to the next page of operations.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ServiceTypeParameter": { + "description": "The service type.", + "name": "serviceType", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ServiceType", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "ShareNameParameter": { + "description": "Share name.", + "name": "shareName", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "FilterParameter": { + "description": "Filter string", + "name": "$filter", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "description": "Resource location.", + "name": "location", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "SubscriptionIdParameter": { + "description": "Subscription Id.", + "name": "subscriptionId", + "type": "string", + "in": "path", + "required": true + }, + "FarmIdParameter": { + "description": "Farm Id.", + "type": "string", + "name": "farmId", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "description": "REST Api Version.", + "name": "api-version", + "type": "string", + "in": "query", + "required": true + }, + "ResourceGroupNameParameter": { + "description": "Resource group name.", + "name": "resourceGroupName", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "description": "Operation Id.", + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storageaccounts.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storageaccounts.json new file mode 100644 index 000000000000..7820cb16398c --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storageaccounts.json @@ -0,0 +1,441 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/storageaccounts": { + "get": { + "x-ms-examples": { + "Returns a list of storage accounts.": { + "$ref": "./examples/StorageAccounts/List.json" + } + }, + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_List", + "description": "Returns a list of storage accounts.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "storageaccounts.json#/parameters/SummaryParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of storage accounts has been returned.", + "schema": { + "$ref": "storageaccounts.json#/definitions/StorageAccountList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/storageaccounts/{accountId}": { + "get": { + "x-ms-examples": { + "Returns the requested storage account.": { + "$ref": "./examples/StorageAccounts/Get.json" + } + }, + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Get", + "description": "Returns the requested storage account.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storageaccounts.json#/parameters/AccountIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The storage account has been returned.", + "schema": { + "$ref": "storageaccounts.json#/definitions/StorageAccount" + } + }, + "404": { + "description": "NOT FOUND -- The storage account or farm was not found." + } + } + }, + "post": { + "x-ms-examples": { + "Undelete a deleted storage account.": { + "$ref": "./examples/StorageAccounts/Undelete.json" + } + }, + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Undelete", + "description": "Undelete a deleted storage account.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storageaccounts.json#/parameters/AccountIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Undelete either has been performed or account was not deleted." + } + } + } + } + }, + "definitions": { + "StorageAccountState": { + "readOnly": true, + "description": "Storage account state.", + "type": "string", + "enum": [ + "Creating", + "Succeeded", + "Suspended" + ], + "x-ms-enum": { + "name": "StorageAccountState", + "modelAsString": true + } + }, + "StorageAccountType": { + "description": "Storage account type.", + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": true + } + }, + "LocationStatus": { + "readOnly": true, + "type": "string", + "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", + "enum": [ + "Available", + "Unavailable" + ], + "x-ms-enum": { + "name": "LocationStatus", + "modelAsString": true + } + }, + "StorageAccountOperation": { + "readOnly": true, + "description": "The permissions of storage account in WAC.", + "type": "string", + "enum": [ + "None", + "Create", + "Update", + "Suspend", + "Delete", + "Undelete" + ], + "x-ms-enum": { + "name": "StorageAccountOperation", + "modelAsString": true + } + }, + "StorageAccountStatus": { + "description": "The state of storage account in WAC.", + "type": "string", + "enum": [ + "Active", + "Deleted", + "OutOfRetentionPeriod", + "Recycled" + ], + "x-ms-enum": { + "name": "StorageAccountStatus", + "modelAsString": true + } + }, + "WacAccountPermissions": { + "description": "Current operation being performed on Storage Account", + "type": "string", + "enum": [ + "Empty", + "None", + "Read", + "Delete", + "Write", + "Full" + ], + "x-ms-enum": { + "name": "WacAccountPermissions", + "modelAsString": true + } + }, + "WacAccountStates": { + "description": "Current operation being performed on Storage Account", + "type": "string", + "enum": [ + "None", + "Active", + "Deleted", + "AboveQuota", + "Suspended", + "All" + ], + "x-ms-enum": { + "name": "WacAccountStates", + "modelAsString": true + } + }, + "StorageAccountProperties": { + "description": "Properties of a storage account.", + "type": "object", + "properties": { + "tenantViewId": { + "description": "Resource URI of storage account from tenant view.", + "type": "string", + "readOnly": true + }, + "accountType": { + "description": "Storage account type.", + "$ref": "storageaccounts.json#/definitions/StorageAccountType", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of storage account.", + "$ref": "storageaccounts.json#/definitions/StorageAccountState", + "readOnly": true + }, + "primaryEndpoints": { + "description": "The URLs that are used to perform a retrieval of a public BLOB, queue, or table object.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "creationTime": { + "description": "The creation date and time of storage account in UTC.", + "type": "string", + "readOnly": true + }, + "alternateName": { + "description": "Alternative storage account name being used during undelete operation.", + "type": "string", + "readOnly": true + }, + "primaryLocation": { + "description": "The primary location for the storage account.", + "type": "string", + "readOnly": true + }, + "statusOfPrimary": { + "description": "The status of primary location of storage account.", + "$ref": "storageaccounts.json#/definitions/LocationStatus", + "readOnly": true + }, + "tenantSubscriptionId": { + "description": "Subscription ID of the subscription under which the storage account locates.", + "type": "string", + "readOnly": true + }, + "tenantStorageAccountName": { + "description": "Storage account name from tenant view.", + "type": "string", + "readOnly": true + }, + "tenantResourceGroupName": { + "description": "The name of resource group under which the storage account locates.", + "type": "string", + "readOnly": true + }, + "currentOperation": { + "description": "Current operation being performed on Storage Account", + "$ref": "storageaccounts.json#/definitions/StorageAccountOperation", + "readOnly": true + }, + "customDomain": { + "description": "The custom domain the user assigned to this storage account.", + "type": "string", + "readOnly": true + }, + "acquisitionOperationCount": { + "description": "The count of acquisitions in the storage account.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "deletedTime": { + "description": "The date-time when the storage account was deleted.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "accountStatus": { + "$ref": "storageaccounts.json#/definitions/StorageAccountStatus", + "description": "The status of storage account." + }, + "recoveredTime": { + "description": "The time when the storage account is undeleted.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "recycledTime": { + "description": "The time when the storage account is physically deleted.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "permissions": { + "description": "The permissions on the storage account.", + "$ref": "storageaccounts.json#/definitions/WacAccountPermissions", + "readOnly": true + }, + "accountId": { + "description": "Internal storage account ID, which is not visible to tenant.", + "type": "string", + "readOnly": true + }, + "wacInternalState": { + "description": "The internal state of storage account in WAC.", + "$ref": "storageaccounts.json#/definitions/WacAccountStates", + "readOnly": true + }, + "resourceAdminApiVersion": { + "description": "Storage admin REST API version.", + "type": "string", + "readOnly": true + } + } + }, + "StorageAccount": { + "description": "Properties of the storage account.", + "type": "object", + "properties": { + "properties": { + "description": "Properties of the storage account.", + "x-ms-client-flatten": true, + "$ref": "storageaccounts.json#/definitions/StorageAccountProperties", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + }, + "StorageAccountList": { + "description": "Pageable list of storage accounts.", + "type": "object", + "properties": { + "value": { + "description": "List of storage accounts.", + "type": "array", + "items": { + "$ref": "storageaccounts.json#/definitions/StorageAccount" + }, + "readOnly": true + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "AccountIdParameter": { + "description": "Internal storage account ID, which is not visible to tenant.", + "name": "accountId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SummaryParameter": { + "description": "Switch for whether summary or detailed information is returned.", + "name": "summary", + "in": "query", + "required": true, + "type": "boolean", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/tableServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/tableServices.json new file mode 100644 index 000000000000..528e83417535 --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/tableServices.json @@ -0,0 +1,207 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/tableservices/{serviceType}": { + "get": { + "x-ms-examples": { + "Returns the table servie.": { + "$ref": "./examples/TableService/Get.json" + } + }, + "tags": [ + "TableServices" + ], + "description": "Returns the table servie.", + "operationId": "TableServices_Get", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Table service has been returned.", + "schema": { + "$ref": "tableServices.json#/definitions/TableService" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/tableservices/{serviceType}/metricdefinitions": { + "get": { + "x-ms-examples": { + "Returns a list of metric definitions for table service.": { + "$ref": "./examples/TableService/ListMetricDefinitions.json" + } + }, + "tags": [ + "TableServices" + ], + "description": "Returns a list of metric definitions for table service.", + "operationId": "TableServices_ListMetricDefinitions", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metric definitions has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricDefinitionList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/tableservices/{serviceType}/metrics": { + "get": { + "x-ms-examples": { + "Returns a list of metrics for table service.": { + "$ref": "./examples/TableService/ListMetrics.json" + } + }, + "tags": [ + "TableServices" + ], + "description": "Returns a list of metrics for table service.", + "operationId": "TableServices_ListMetrics", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metrics has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "TableService": { + "description": "Table service.", + "type": "object", + "properties": { + "properties": { + "description": "Table service properties.", + "x-ms-client-flatten": true, + "$ref": "tableServices.json#/definitions/TableServiceProperties", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + }, + "TableServiceProperties": { + "description": "Table service properties.", + "type": "object", + "properties": { + "settings": { + "description": "Table service settings.", + "x-ms-client-flatten": true, + "$ref": "storage.json#/definitions/WritableServiceSettings", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Service" + } + ] + } + }, + "parameters": {}, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/readme.md b/specification/azsadmin/resource-manager/storage/readme.md new file mode 100644 index 000000000000..7f96b896957e --- /dev/null +++ b/specification/azsadmin/resource-manager/storage/readme.md @@ -0,0 +1,64 @@ +# 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: Storag Admin Client +openapi-type: arm +tag: package-2016-05-01 +``` + +### Tag: package-2016-05-01 + +These settings apply only when `--tag=package-2016-05-01` is specified on the command line. + +``` yaml $(tag) == 'package-2016-05-01' +input-file: + - "Microsoft.Storage.Admin/preview/2016-05-01/storage.json" + - "Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json" + - "Microsoft.Storage.Admin/preview/2016-05-01/blobServices.json" + - "Microsoft.Storage.Admin/preview/2016-05-01/containers.json" + - "Microsoft.Storage.Admin/preview/2016-05-01/farms.json" + - "Microsoft.Storage.Admin/preview/2016-05-01/queueServices.json" + - "Microsoft.Storage.Admin/preview/2016-05-01/quotas.json" + - "Microsoft.Storage.Admin/preview/2016-05-01/shares.json" + - "Microsoft.Storage.Admin/preview/2016-05-01/storageaccounts.json" + - "Microsoft.Storage.Admin/preview/2016-05-01/tableServices.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/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/AcquiredPlan.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/AcquiredPlan.json new file mode 100644 index 000000000000..f7a43d6ecf6f --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/AcquiredPlan.json @@ -0,0 +1,300 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-11-01", + "title": "SubscriptionsManagementClient", + "description": "The Admin Subscriptions Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/subscriptions/{targetSubscriptionId}/acquiredPlans": { + "get": { + "x-ms-examples": { + "Get a collection of all acquired plans that subscription has access to.": { + "$ref": "examples/AcquiredPlan/List.json" + } + }, + "description": "Get a collection of all acquired plans that subscription has access to.", + "tags": [ + "AcquiredPlans" + ], + "operationId": "AcquiredPlans_List", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetSubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PlanAcquisitionList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/subscriptions/{targetSubscriptionId}/acquiredPlans/{planAcquisitionId}": { + "get": { + "x-ms-examples": { + "Gets the specified plan acquired by a subscription consuming the offer": { + "$ref": "examples/AcquiredPlan/Get.json" + } + }, + "tags": [ + "AcquiredPlans" + ], + "description": "Gets the specified plan acquired by a subscription consuming the offer.", + "operationId": "AcquiredPlans_Get", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PlanAcquisitionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PlanAcquisition" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Deletes an acquired plan.": { + "$ref": "./examples/AcquiredPlan/Delete.json" + } + }, + "description": "Deletes an acquired plan.", + "tags": [ + "AcquiredPlans" + ], + "operationId": "AcquiredPlans_Delete", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PlanAcquisitionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates the acquired plan.": { + "$ref": "./examples/AcquiredPlan/Create.json" + } + }, + "tags": [ + "AcquiredPlans" + ], + "description": "Creates an acquired plan.", + "operationId": "AcquiredPlans_Create", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PlanAcquisitionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NewAcquiredPlanParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PlanAcquisition" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PlanAcquisition" + } + } + } + } + } + }, + "definitions": { + "PlanAcquisition": { + "description": "Represents the acquisition of an add-on plan for a subscription.", + "type": "object", + "properties": { + "acquisitionId": { + "description": "Acquisition identifier.", + "type": "string" + }, + "id": { + "description": "Identifier in the tenant subscription context.", + "type": "string" + }, + "planId": { + "description": "Plan identifier in the tenant subscription context.", + "type": "string" + }, + "externalReferenceId": { + "description": "External reference identifier.", + "type": "string" + }, + "provisioningState": { + "description": "State of the provisioning.", + "$ref": "#/definitions/ProvisioningState" + }, + "acquisitionTime": { + "description": "Acquisition time.", + "type": "string", + "format": "date-time" + } + } + }, + "ProvisioningState": { + "description": "Provisioning state for subscriptions service resources, for example, resource provider registration.", + "type": "string", + "enum": [ + "NotSpecified", + "Accepted", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "description": "The provisioning state is not specified.", + "name": "NotSpecified", + "value": "NotSpecified" + }, + { + "description": "The provisioning state is accepted, and indicates provisioning is ongoing.", + "name": "Accepted", + "value": "Accepted" + }, + { + "description": "The provisioning state is failed, and indicates the data is potentially out-of-sync with third parties.", + "name": "Failed", + "value": "Failed" + }, + { + "description": "The provisioning state is succeeded, and indicates the data is in-sync with third-parties.", + "name": "Succeeded", + "value": "Succeeded" + } + ] + } + }, + "PlanAcquisitionList": { + "description": "List of acquired plans.", + "properties": { + "value": { + "description": "List of acquired plans.", + "type": "array", + "items": { + "$ref": "#/definitions/PlanAcquisition" + } + }, + "nextLink": { + "type": "string", + "description": "URI to the next page." + } + } + } + }, + "parameters": { + "TargetSubscriptionIdParameter": { + "name": "targetSubscriptionId", + "in": "path", + "description": "The target subscription ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PlanAcquisitionIdParameter": { + "name": "planAcquisitionId", + "in": "path", + "description": "The plan acquisition Identifier", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "NewAcquiredPlanParameter": { + "name": "newAcquiredPlan", + "in": "body", + "description": "The new acquired plan.", + "required": true, + "schema": { + "$ref": "#/definitions/PlanAcquisition" + }, + "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/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/DelegatedProvider.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/DelegatedProvider.json new file mode 100644 index 000000000000..a69e13942786 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/DelegatedProvider.json @@ -0,0 +1,108 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-11-01", + "title": "SubscriptionsManagementClient", + "description": "The Admin Subscriptions Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/delegatedProviders": { + "get": { + "x-ms-examples": { + "Get the list of delegatedProviders.": { + "$ref": "./examples/DelegatedProvider/List.json" + } + }, + "description": "Get the list of delegatedProviders.", + "tags": [ + "DelegatedProviders" + ], + "operationId": "DelegatedProviders_List", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "Subscriptions.json#/definitions/SubscriptionList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/delegatedProviders/{delegatedProvider}": { + "get": { + "x-ms-examples": { + "Get the specified delegated provider.": { + "$ref": "./examples/DelegatedProvider/Get.json" + } + }, + "description": "Get the specified delegated provider.", + "tags": [ + "DelegatedProviders" + ], + "operationId": "DelegatedProviders_Get", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/DelegatedProviderParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "Subscriptions.json#/definitions/Subscription" + } + } + } + } + } + }, + "definitions": { + }, + "parameters": { + }, + "securityDefinitions": { + "azure_auth": { + "type": "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" + ] + } + ] +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/DelegatedProviderOffer.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/DelegatedProviderOffer.json new file mode 100644 index 000000000000..a28a6af46ad1 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/DelegatedProviderOffer.json @@ -0,0 +1,206 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-11-01", + "title": "SubscriptionsManagementClient", + "description": "The Admin Subscriptions Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/delegatedProviders/{delegatedProviderSubscriptionId}/offers": { + "get": { + "x-ms-examples": { + "Get the list of delegated provider offers.": { + "$ref": "./examples/DelegatedProviderOffer/List.json" + } + }, + "description": "Get the list of delegated provider offers.", + "tags": [ + "DelegatedProviderOffers" + ], + "operationId": "DelegatedProviderOffers_List", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/DelegatedProviderSubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DelegatedProviderOfferList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/delegatedProviders/{delegatedProviderSubscriptionId}/offers/{offer}": { + "get": { + "x-ms-examples": { + "Get the specified delegated provider offer.": { + "$ref": "./examples/DelegatedProviderOffer/Get.json" + } + }, + "description": "Get the specified delegated provider offer.", + "tags": [ + "DelegatedProviderOffers" + ], + "operationId": "DelegatedProviderOffers_Get", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/DelegatedProviderSubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/OfferParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DelegatedProviderOffer" + } + } + } + } + } + }, + "definitions": { + "DelegatedProviderOffer": { + "description": "The delegated provider offer.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties for an delegated provider.", + "$ref": "#/definitions/DelegatedProviderOfferProperties" + } + }, + "allOf": [ + { + "$ref": "Subscriptions.json#/definitions/Resource" + } + ] + }, + "DelegatedProviderOfferProperties": { + "description": "Properties for an delegated provider.", + "type": "object", + "properties": { + "delegatedOfferId": { + "description": "The delegated offer identifier.", + "type": "string" + }, + "displayName": { + "description": "Display name of offer.", + "type": "string" + }, + "description": { + "description": "Description of offer.", + "type": "string" + }, + "externalReferenceId": { + "description": "External reference identifier.", + "type": "string" + }, + "accessibilityState": { + "description": "Offer accessibility state.", + "$ref": "#/definitions/AccessibilityState" + }, + "subscriptionCount": { + "description": "Current subscription count.", + "type": "integer" + } + } + }, + "AccessibilityState": { + "type": "string", + "description": "Represents the state of the offer", + "enum": [ + "Private", + "Public", + "Decommissioned" + ], + "x-ms-enum": { + "name": "AccessibilityState", + "modelAsString": true, + "values": [ + { + "description": "The offer or plan is private. Only an Admin can see and manage it.", + "name": "Private", + "value": "Private" + }, + { + "description": "The offer or plan is public. Users can see and self-subscribe to it.", + "name": "Public", + "value": "Public" + }, + { + "description": "The offer or plan is decommissioned. Current subscriptions can still consume it but new subscriptions cannot.", + "name": "Decommissioned", + "value": "Decommissioned" + } + ] + } + }, + "DelegatedProviderOfferList": { + "description": "List of delegated provider offers.", + "properties": { + "value": { + "description": "Array of delegated provider offers.", + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedProviderOffer" + } + }, + "nextLink": { + "type": "string", + "description": "Continuation token" + } + } + } + }, + "parameters": { + }, + "securityDefinitions": { + "azure_auth": { + "type": "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" + ] + } + ] +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/DirectoryTenant.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/DirectoryTenant.json new file mode 100644 index 000000000000..20ed49bea323 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/DirectoryTenant.json @@ -0,0 +1,252 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-11-01", + "title": "SubscriptionsManagementClient", + "description": "The Admin Subscriptions Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/directoryTenants": { + "get": { + "x-ms-examples": { + "Lists all the directory tenants under the current subscription and given resource group name.": { + "$ref": "./examples/DirectoryTenant/List.json" + } + }, + "tags": [ + "DirectoryTenants" + ], + "description": "Lists all the directory tenants under the current subscription and given resource group name.", + "operationId": "DirectoryTenants_List", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DirectoryTenantList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/directoryTenants/{tenant}": { + "get": { + "x-ms-examples": { + "Get a directory tenant by name.": { + "$ref": "./examples/DirectoryTenant/Get.json" + } + }, + "description": "Get a directory tenant by name.", + "tags": [ + "DirectoryTenants" + ], + "operationId": "DirectoryTenants_Get", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/DirectoryTenantParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DirectoryTenant" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a directory tenant under a resource group.": { + "$ref": "./examples/DirectoryTenant/Delete.json" + } + }, + "description": "Delete a directory tenant under a resource group.", + "tags": [ + "DirectoryTenants" + ], + "operationId": "DirectoryTenants_Delete", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/DirectoryTenantParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "put": { + "x-ms-examples": { + "Create or updates a directory tenant.": { + "$ref": "./examples/DirectoryTenant/Create.json" + } + }, + "description": "Create or updates a directory tenant.", + "tags": [ + "DirectoryTenants" + ], + "operationId": "DirectoryTenants_CreateOrUpdate", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/DirectoryTenantParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NewDirectoryTenantParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DirectoryTenant" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DirectoryTenant" + } + } + } + } + } + }, + "definitions": { + "DirectoryTenant": { + "description": "Directory tenant.", + "type": "object", + "properties": { + "properties": { + "description": "Directory tenant.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DirectoryTenantProperties" + } + }, + "allOf": [ + { + "$ref": "Subscriptions.json#/definitions/Resource" + } + ] + }, + "DirectoryTenantProperties": { + "description": "Directory tenant.", + "type": "object", + "properties": { + "tenantId": { + "description": "Tenant unique identifier.", + "type": "string" + } + } + }, + "DirectoryTenantList": { + "description": "List of directory tenants.", + "type": "object", + "properties": { + "value": { + "description": "List of directory tenants.", + "type": "array", + "items": { + "$ref": "#/definitions/DirectoryTenant" + } + }, + "nextLink": { + "type": "string", + "description": "Continuation token" + } + } + } + }, + "parameters": { + "DirectoryTenantParameter": { + "description": "Directory tenant name.", + "name": "tenant", + "type": "string", + "required": true, + "in": "path", + "x-ms-parameter-location": "method" + }, + "NewDirectoryTenantParameter": { + "description": "New directory tenant properties.", + "name": "newTenant", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/DirectoryTenant" + }, + "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/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Location.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Location.json new file mode 100644 index 000000000000..b007c4d162a5 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Location.json @@ -0,0 +1,225 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-11-01", + "title": "SubscriptionsManagementClient", + "description": "The Admin Subscriptions Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/locations": { + "get": { + "x-ms-examples": { + "Get a list of all AzureStack location.": { + "$ref": "./examples/Location/List.json" + } + }, + "description": "Get a list of all AzureStack location.", + "tags": [ + "Locations" + ], + "operationId": "Locations_List", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LocationList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/locations/{location}": { + "get": { + "x-ms-examples": { + "Get the specified location.": { + "$ref": "./examples/Location/Get.json" + } + }, + "description": "Get the specified location.", + "tags": [ + "Locations" + ], + "operationId": "Locations_Get", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/LocationParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Location" + } + } + } + }, + "put": { + "x-ms-examples": { + "Updates the specified location.": { + "$ref": "./examples/Location/Put.json" + } + }, + "description": "Updates the specified location.", + "tags": [ + "Locations" + ], + "operationId": "Locations_CreateOrUpdate", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/LocationParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NewLocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Location" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Deletes the specified location.": { + "$ref": "./examples/Location/Delete.json" + } + }, + "description": "Deletes the specified location.", + "tags": [ + "Locations" + ], + "operationId": "Locations_Delete", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/LocationParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + } + } + }, + "definitions": { + "Location": { + "description": "Contains information about a geographical location where resource providers can be deployed.", + "type": "object", + "properties": { + "displayName": { + "description": "Display name of the location.", + "type": "string" + }, + "id": { + "description": "Location identifier.", + "type": "string" + }, + "latitude": { + "description": "Latitude of the location.", + "type": "string" + }, + "longitude": { + "description": "Longitude of the location.", + "type": "string" + }, + "name": { + "description": "Location name.", + "type": "string" + } + } + }, + "LocationList": { + "description": "List of locations.", + "properties": { + "value": { + "description": "List of locations.", + "type": "array", + "items": { + "$ref": "#/definitions/Location" + } + }, + "nextLink": { + "description": "URI to next page.", + "type": "string" + } + } + } + }, + "parameters": { + "NewLocationParameter": { + "description": "The new location", + "name": "newLocation", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/Location" + }, + "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" + ] + } + ] +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Offer.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Offer.json new file mode 100644 index 000000000000..0855f57ed9d6 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Offer.json @@ -0,0 +1,550 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-11-01", + "title": "SubscriptionsManagementClient", + "description": "The Admin Subscriptions Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/offers": { + "get": { + "x-ms-examples": { + "Get the list of offers.": { + "$ref": "./examples/Offer/List.json" + } + }, + "description": "Get the list of offers.", + "tags": [ + "Offers" + ], + "operationId": "Offers_ListAll", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/offers": { + "get": { + "x-ms-examples": { + "Get the list of offers under a resource group.": { + "$ref": "./examples/Offer/List.json" + } + }, + "description": "Get the list of offers under a resource group.", + "tags": [ + "Offers" + ], + "operationId": "Offers_List", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/offers/{offer}": { + "get": { + "x-ms-examples": { + "Get the specified offer.": { + "$ref": "./examples/Offer/Get.json" + } + }, + "description": "Get the specified offer.", + "tags": [ + "Offers" + ], + "operationId": "Offers_Get", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/OfferParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Offer" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update the offer.": { + "$ref": "./examples/Offer/Create.json" + } + }, + "description": "Create or update the offer.", + "tags": [ + "Offers" + ], + "operationId": "Offers_CreateOrUpdate", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/OfferParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NewOfferParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Offer" + } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Offer" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the specified offer.": { + "$ref": "./examples/Offer/Delete.json" + } + }, + "description": "Delete the specified offer.", + "tags": [ + "Offers" + ], + "operationId": "Offers_Delete", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/OfferParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/offers/{offer}/Metrics": { + "get": { + "x-ms-examples": { + "Get the offer metrics.": { + "$ref": "./examples/Offer/Metrics.json" + } + }, + "description": "Get the offer metrics.", + "tags": [ + "Offers" + ], + "operationId": "Offers_ListMetrics", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/OfferParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "Subscriptions.json#/definitions/MetricList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/offers/{offer}/MetricDefinitions": { + "get": { + "x-ms-examples": { + "Get the metric definitions.": { + "$ref": "./examples/Offer/MetricDefinitions.json" + } + }, + "description": "Get the metric definitions.", + "tags": [ + "Offers" + ], + "operationId": "Offers_ListMetricDefinitions", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/OfferParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "Subscriptions.json#/definitions/MetricDefinitionList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/offers/{offer}/link": { + "post": { + "x-ms-examples": { + "Links a plan to an offer.": { + "$ref": "./examples/Offer/Link.json" + } + }, + "description": "Links a plan to an offer.", + "tags": [ + "Offers" + ], + "operationId": "Offers_Link", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/OfferParameter" + }, + { + "$ref": "#/parameters/PlanLinkParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Offer" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/offers/{offer}/unlink": { + "post": { + "x-ms-examples": { + "Unlink a plan from an offer.": { + "$ref": "./examples/Offer/Unlink.json" + } + }, + "description": "Unlink a plan from an offer.", + "tags": [ + "Offers" + ], + "operationId": "Offers_Unlink", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/OfferParameter" + }, + { + "$ref": "#/parameters/PlanLinkParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Offer" + } + } + } + } + } + }, + "definitions": { + "Offer": { + "description": "Represents an offering of services against which a subscription can be created.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Represents an offering of services against which a subscription can be created.", + "$ref": "#/definitions/OfferProperties" + } + }, + "allOf": [ + { + "$ref": "Subscriptions.json#/definitions/Resource" + } + ] + }, + "OfferProperties": { + "description": "Represents an offering of services against which a subscription can be created.", + "type": "object", + "properties": { + "name": { + "description": "Name of the Offer.", + "type": "string" + }, + "displayName": { + "description": "Display name of offer.", + "type": "string" + }, + "description": { + "description": "Description of offer.", + "type": "string" + }, + "externalReferenceId": { + "description": "External reference identifier.", + "type": "string" + }, + "state": { + "description": "Offer accessibility state.", + "$ref": "#/definitions/AccessibilityState" + }, + "subscriptionCount": { + "description": "Current subscription count.", + "type": "integer" + }, + "maxSubscriptionsPerAccount": { + "description": "Maximum subscriptions per account.", + "type": "integer" + }, + "basePlanIds": { + "description": "Identifiers of the base plans that become available to the tenant immediately when a tenant subscribes to the offer.", + "type": "array", + "items": { + "type": "string" + } + }, + "addonPlans": { + "description": "References to add-on plans that a tenant can optionally acquire as a part of the offer.", + "type": "array", + "items": { + "$ref": "#/definitions/AddonPlanDefinition" + } + } + } + }, + "AccessibilityState": { + "type": "string", + "description": "Represents the state of the offer", + "enum": [ + "Private", + "Public", + "Decommissioned" + ], + "x-ms-enum": { + "name": "AccessibilityState", + "modelAsString": true, + "values": [ + { + "description": "The offer or plan is private. Only an Admin can see and manage it.", + "name": "Private", + "value": "Private" + }, + { + "description": "The offer or plan is public. Users can see and self-subscribe to it.", + "name": "Public", + "value": "Public" + }, + { + "description": "The offer or plan is decommissioned. Current subscriptions can still consume it but new subscriptions cannot.", + "name": "Decommissioned", + "value": "Decommissioned" + } + ] + } + }, + "AddonPlanDefinition": { + "description": "Contains the name of the desired plan to be linked or unlinked from an offer.", + "type": "object", + "properties": { + "planId": { + "description": "Plan identifier.", + "type": "string" + }, + "maxAcquisitionCount": { + "description": "Maximum number of instances that can be acquired by a single subscription. If not specified, the assumed value is 1.", + "type": "integer" + } + } + }, + "OfferList": { + "description": "List of offers.", + "type": "object", + "properties": { + "value": { + "description": "List of offers.", + "type": "array", + "items": { + "$ref": "#/definitions/Offer" + } + }, + "nextLink": { + "type": "string", + "description": "URI to next page." + } + } + }, + "PlanLinkDefinition": { + "description": "Definition for linking and unlinking plans to offers.", + "type": "object", + "properties": { + "planName": { + "description": "Name of the plan.", + "type": "string" + }, + "planLinkType": { + "description": "Type of the plan link.", + "$ref": "#/definitions/PlanLinkType" + }, + "maxAcquisitionCount": { + "description": "The maximum acquisition count by subscribers", + "type": "integer" + } + } + }, + "PlanLinkType": { + "description": "Plan link type.", + "type": "string", + "enum": [ + "None", + "Base", + "Addon" + ], + "x-ms-enum": { + "name": "PlanLinkType", + "modelAsString": true + } + } + }, + "parameters": { + "NewOfferParameter": { + "description": "New offer.", + "name": "newOffer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Offer" + }, + "x-ms-parameter-location": "method" + }, + "PlanLinkParameter": { + "description": "New plan link.", + "name": "planLink", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PlanLinkDefinition" + }, + "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/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/OfferDelegation.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/OfferDelegation.json new file mode 100644 index 000000000000..f0217c476c3c --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/OfferDelegation.json @@ -0,0 +1,263 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-11-01", + "title": "SubscriptionsManagementClient", + "description": "The Admin Subscriptions Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/offers/{offer}/offerDelegations": { + "get": { + "x-ms-examples": { + "Get the list of offer delegations.": { + "$ref": "./examples/OfferDelegation/List.json" + } + }, + "description": "Get the list of offer delegations.", + "tags": [ + "OfferDelegations" + ], + "operationId": "OfferDelegations_List", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/OfferParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferDelegationList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/offers/{offer}/offerDelegations/{offerDelegationName}": { + "get": { + "x-ms-examples": { + "Get the specified offer delegation.": { + "$ref": "./examples/OfferDelegation/Get.json" + } + }, + "description": "Get the specified offer delegation.", + "tags": [ + "OfferDelegations" + ], + "operationId": "OfferDelegations_Get", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/OfferParameter" + }, + { + "$ref": "#/parameters/OfferDelegationParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferDelegation" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update the offer delegation.": { + "$ref": "./examples/OfferDelegation/Create.json" + } + }, + "description": "Create or update the offer delegation.", + "tags": [ + "OfferDelegations" + ], + "operationId": "OfferDelegations_CreateOrUpdate", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/OfferParameter" + }, + { + "$ref": "#/parameters/OfferDelegationParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NewOfferDelegationParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OfferDelegation" + } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferDelegation" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the specified offer delegation.": { + "$ref": "./examples/OfferDelegation/Delete.json" + } + }, + "description": "Delete the specified offer delegation.", + "tags": [ + "OfferDelegations" + ], + "operationId": "OfferDelegations_Delete", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/OfferParameter" + }, + { + "$ref": "#/parameters/OfferDelegationParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + } + } + }, + "definitions": { + "OfferDelegation": { + "description": "Offer delegation.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties for an offer.", + "$ref": "#/definitions/OfferDelegationProperties" + } + }, + "allOf": [ + { + "$ref": "Subscriptions.json#/definitions/Resource" + } + ] + }, + "OfferDelegationProperties": { + "description": "Properties for an offer delegation.", + "type": "object", + "properties": { + "subscriptionId": { + "description": "Identifier of the subscription receiving the delegated offer.", + "type": "string" + } + } + }, + "OfferDelegationList": { + "description": ".", + "properties": { + "value": { + "description": "Array of usage aggregates.", + "type": "array", + "items": { + "$ref": "#/definitions/OfferDelegation" + } + }, + "nextLink": { + "type": "string", + "description": "Continuation token" + } + } + } + }, + "parameters": { + "OfferDelegationParameter": { + "description": "Name of a offer delegation.", + "name": "offerDelegationName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "NewOfferDelegationParameter": { + "description": "New offer delegation parameter.", + "name": "newOfferDelegation", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OfferDelegation" + }, + "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/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Plan.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Plan.json new file mode 100644 index 000000000000..3d23dfc2e231 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Plan.json @@ -0,0 +1,378 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-11-01", + "title": "SubscriptionsManagementClient", + "description": "The Admin Subscriptions Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/plans": { + "get": { + "x-ms-examples": { + "Get the list of plans.": { + "$ref": "./examples/Plan/ListAll.json" + } + }, + "description": "List all plans across all subscriptions.", + "tags": [ + "Plans" + ], + "operationId": "Plans_ListAll", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PlanList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/plans": { + "get": { + "x-ms-examples": { + "Get the list of plans under a resource group.": { + "$ref": "./examples/Plan/List.json" + } + }, + "description": "Get the list of plans under a resource group.", + "tags": [ + "Plans" + ], + "operationId": "Plans_List", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PlanList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/plans/{plan}": { + "get": { + "x-ms-examples": { + "Get the specified plan.": { + "$ref": "./examples/Plan/Get.json" + } + }, + "description": "Get the specified plan.", + "tags": [ + "Plans" + ], + "operationId": "Plans_Get", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/PlanParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Plan" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update the plan.": { + "$ref": "./examples/Plan/Create.json" + } + }, + "description": "Create or update the plan.", + "tags": [ + "Plans" + ], + "operationId": "Plans_CreateOrUpdate", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/PlanParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NewPlanParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Plan" + } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Plan" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the specified plan.": { + "$ref": "./examples/Plan/Delete.json" + } + }, + "description": "Delete the specified plan.", + "tags": [ + "Plans" + ], + "operationId": "Plans_Delete", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/PlanParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/plans/{plan}/Metrics": { + "get": { + "x-ms-examples": { + "Get the metrics of the specified plan.": { + "$ref": "./examples/Plan/Metrics.json" + } + }, + "description": "Get the metrics of the specified plan.", + "tags": [ + "Plans" + ], + "operationId": "Plans_ListMetrics", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/PlanParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "Subscriptions.json#/definitions/MetricList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/plans/{plan}/MetricDefinitions": { + "get": { + "x-ms-examples": { + "Get the metric definitions of the specified plan.": { + "$ref": "./examples/Plan/MetricDefinitions.json" + } + }, + "description": "Get the metric definitions of the specified plan.", + "tags": [ + "Plans" + ], + "operationId": "Plans_ListMetricDefinitions", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/PlanParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "Subscriptions.json#/definitions/MetricDefinitionList" + } + } + } + } + } + }, + "definitions": { + "Plan": { + "description": "A plan represents a package of quotas and capabilities that are offered tenants. A tenant can acquire this plan through an offer to upgrade his access to underlying cloud services.", + "type": "object", + "properties": { + "properties": { + "description": "Properties of a plan.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PlanProperties" + } + }, + "allOf": [ + { + "$ref": "Subscriptions.json#/definitions/Resource" + } + ] + }, + "PlanProperties": { + "description": "Properties of a plan.", + "type": "object", + "properties": { + "description": { + "description": "Description of the plan.", + "type": "string" + }, + "displayName": { + "description": "Display name.", + "type": "string" + }, + "externalReferenceId": { + "description": "External reference identifier.", + "type": "string" + }, + "quotaIds": { + "description": "Quota identifiers under the plan.", + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "description": "Name of the plan.", + "type": "string" + }, + "subscriptionCount": { + "description": "Subscription count.", + "type": "integer" + }, + "skuIds": { + "description": "SKU identifiers.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PlanList": { + "description": "List of plans", + "properties": { + "value": { + "description": "Array of plans.", + "type": "array", + "items": { + "$ref": "#/definitions/Plan" + } + }, + "nextLink": { + "type": "string", + "description": "Continuation token" + } + } + } + }, + "parameters": { + "NewPlanParameter": { + "description": "New plan.", + "name": "newPlan", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Plan" + }, + "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/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Quota.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Quota.json new file mode 100644 index 000000000000..a6157d0d43bd --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Quota.json @@ -0,0 +1,164 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-11-01", + "title": "SubscriptionsManagementClient", + "description": "The Admin Subscriptions Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/locations/{location}/quotas": { + "get": { + "x-ms-examples": { + "Get the list of quotas at a location.": { + "$ref": "./examples/Quota/List.json" + } + }, + "tags": [ + "Quotas" + ], + "description": "Get the list of quotas at a location.", + "operationId": "Quotas_List", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/LocationParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/QuotaList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/locations/{location}/quotas/{quota}": { + "get": { + "x-ms-examples": { + "Gets a quota by name.": { + "$ref": "./examples/Quota/Get.json" + } + }, + "description": "Gets a quota by name.", + "tags": [ + "Quotas" + ], + "operationId": "Quotas_Get", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/QuotaParameter" + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Quota" + } + } + } + } + } + }, + "definitions": { + "Quota": { + "description": "Quotas for DelegatedProviders.", + "type": "object", + "properties": { + "properties": { + "description": "Quotas for DelegatedProviders.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuotaProperties" + } + }, + "allOf" : [ + { + "$ref" : "Subscriptions.json#/definitions/Resource" + } + ] + }, + "QuotaProperties": { + "description": "Quotas for DelegatedProviders.", + "type": "object", + "properties": { + "allowCustomPortalBranding": { + "description": "Value indicating whether custom portal branding is allowed.", + "type": "boolean" + } + } + }, + "QuotaList": { + "description": "List of quotas.", + "properties": { + "value": { + "description": "List of quotas.", + "type": "array", + "items": { + "$ref": "#/definitions/Quota" + } + }, + "nextLink": { + "type": "string", + "description": "URI to next page." + } + } + } + }, + "parameters": { + "QuotaParameter": { + "name": "quota", + "in": "path", + "description": "Name of the quota.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json new file mode 100644 index 000000000000..a22cc59d65fe --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json @@ -0,0 +1,973 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-11-01", + "title": "SubscriptionsManagementClient", + "description": "The Admin Subscriptions Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Subscriptions.Admin/operations": { + "get": { + "x-ms-examples": { + "Get the list of Operations.": { + "$ref": "./examples/Subscriptions/Operations.json" + } + }, + "description": "Get the list of Operations.", + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/updateEncryption": { + "post": { + "x-ms-examples": { + "Update the encryption settings.": { + "$ref": "./examples/Subscriptions/UpdateEncryption.json" + } + }, + "description": "Update the encryption settings.", + "tags": [ + "Subscriptions" + ], + "operationId": "UpdateEncryption", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/restoreData": { + "post": { + "x-ms-examples": { + "Get the list of subscriptions.": { + "$ref": "./examples/Subscriptions/List.json" + } + }, + "description": "Restores the data", + "tags": [ + "Subscriptions" + ], + "operationId": "RestoreData", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/moveSubscriptions": { + "post": { + "x-ms-examples": { + "Move user subscriptions from the Default Provider to a Delegated Provider.": { + "$ref": "./examples/Subscriptions/MoveSubscriptionsToDelegatedProvider.json" + }, + "Move user subscriptions from a Delegated Provider to the Default Provider.": { + "$ref": "./examples/Subscriptions/MoveSubscriptionsToDefaultProvider.json" + } + }, + "description": "Move subscriptions between delegated provider offers.", + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_MoveSubscriptions", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/MoveSubscriptionsParameter" + } + ], + "responses": { + "204": { + "description": "No Content -- The subscriptions were successfully moved to the target delegated provider offer." + }, + "202": { + "description": "Accepted -- Move subscriptions request accepted; operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/validateMoveSubscriptions": { + "post": { + "x-ms-examples": { + "Validate that user subscriptions can be moved from the Default Provider to a Delegated Provider.": { + "$ref": "./examples/Subscriptions/ValidateMoveSubscriptionsToDelegatedProvider.json" + }, + "Validate that user subscriptions can be moved from a Delegated Provider to the Default Provider.": { + "$ref": "./examples/Subscriptions/ValidateMoveSubscriptionsToDefaultProvider.json" + } + }, + "description": "Validate that user subscriptions can be moved between delegated provider offers.", + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_ValidateMoveSubscriptions", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/MoveSubscriptionsParameter" + } + ], + "responses": { + "204": { + "description": "No Content -- The subscriptions can be moved to the target delegated provider offer." + }, + "202": { + "description": "Accepted -- Validate move subscriptions request accepted; operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/subscriptions": { + "get": { + "x-ms-examples": { + "Get the list of subscriptions.": { + "$ref": "./examples/Subscriptions/List.json" + } + }, + "description": "Get the list of subscriptions.", + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-odata": "#/definitions/Subscription" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/checkNameAvailability": { + "post": { + "x-ms-examples": { + "Checks name availability in the Microsoft.Subscriptions.Admin namespace": { + "$ref": "./examples/Subscriptions/CheckNameAvailability.json" + } + }, + "description": "Get the list of subscriptions.", + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_CheckNameAvailability", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CheckNameAvailabilityParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/subscriptions/{subscription}": { + "get": { + "x-ms-examples": { + "Get a specified subscription.": { + "$ref": "./examples/Subscriptions/Get.json" + } + }, + "description": "Get a specified subscription.", + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SubscriptionParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Subscription" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates the specified subscription.": { + "$ref": "./examples/Subscriptions/Create.json" + } + }, + "description": "Creates or updates the specified subscription.", + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SubscriptionParameter" + }, + { + "$ref": "#/parameters/NewSubscriptionParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Subscription" + } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Subscription" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the specified subscription.": { + "$ref": "./examples/Subscriptions/Delete.json" + } + }, + "description": "Delete the specified subscription.", + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SubscriptionParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + } + } + }, + "definitions": { + "Resource": { + "description": "Base Resource Object", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "description": "URI of the resource.", + "type": "string" + }, + "name": { + "readOnly": true, + "description": "Name of the resource.", + "type": "string" + }, + "type": { + "readOnly": true, + "description": "Type of resource.", + "type": "string" + }, + "location": { + "description": "Location of the resource", + "type": "string" + }, + "tags": { + "readOnly": true, + "description": "List of key-value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "Operation": { + "description": "Supported REST operation.", + "type": "object", + "properties": { + "display": { + "description": "Display information for the operation.", + "type": "object", + "properties": { + "description": { + "description": "Description for the operation.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Display name of the operation.", + "type": "string", + "readOnly": true + }, + "provider": { + "description": "Resource provider display name.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource type display name related to the operation.", + "type": "string", + "readOnly": true + } + } + }, + "name": { + "description": "Name of the operation being performed on an object.", + "type": "string", + "readOnly": true + }, + "origin": { + "description": "Origin for the operation.", + "type": "string", + "readOnly": true + } + } + }, + "OperationList": { + "description": "List of supported operations.", + "type": "object", + "properties": { + "value": { + "description": "List of supported operations.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + } + } + }, + "CheckNameAvailabilityDefinition": { + "description": "The check name availability action definition.", + "type": "object", + "properties": { + "name": { + "description": "The resource name to verify.", + "type": "string" + }, + "resourceType": { + "description": "The resource type to verify.", + "type": "string" + } + } + }, + "CheckNameAvailabilityResponse": { + "description": "The check name availability response definition", + "type": "object", + "properties": { + "nameAvailable": { + "description": "A value indicating whether the name is available.", + "type": "boolean" + }, + "reason": { + "description": "The reason for the unavailability of the name.", + "$ref": "#/definitions/NameUnavailabilityReason" + }, + "message": { + "description": "The message explaining the reason.", + "type": "string" + } + } + }, + "NameUnavailabilityReason": { + "description": "The reason that the name is not available.", + "type": "string", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "NameUnavailabilityReason", + "modelAsString": true + } + }, + "MoveSubscriptionsDefinition": { + "description": "The move subscriptions action definition", + "type": "object", + "required": [ + "resources" + ], + "properties": { + "targetDelegatedProviderOffer": { + "description": "The delegated provider offer identifier (from the Admin context) that the subscriptions to be moved to.", + "type": "string" + }, + "resources": { + "description": "A collection of subscriptions to move to the target delegated provider offer.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Subscription": { + "description": "List of supported operations.", + "type": "object", + "properties": { + "delegatedProviderSubscriptionId": { + "description": "Parent DelegatedProvider subscription identifier.", + "type": "string" + }, + "displayName": { + "description": "Subscription name.", + "type": "string" + }, + "id": { + "description": "Fully qualified identifier.", + "type": "string" + }, + "externalReferenceId": { + "description": "External reference identifier.", + "type": "string" + }, + "offerId": { + "description": "Identifier of the offer under the scope of a delegated provider.", + "type": "string" + }, + "owner": { + "description": "Subscription owner.", + "type": "string" + }, + "routingResourceManagerType": { + "description": "Routing resource manager type.", + "$ref": "#/definitions/ResourceManagerType" + }, + "state": { + "description": "Subscription state.", + "$ref": "#/definitions/SubscriptionState" + }, + "subscriptionId": { + "description": "Subscription identifier.", + "type": "string" + }, + "tenantId": { + "description": "Directory tenant identifier.", + "type": "string" + } + } + }, + "SubscriptionList": { + "description": "List of subscriptions.", + "properties": { + "value": { + "type": "array", + "description": "Subscription definition.", + "items": { + "$ref": "#/definitions/Subscription" + } + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string" + } + } + }, + "ResourceManagerType": { + "description": "Resource manager type.", + "type": "string", + "enum": [ + "Default", + "Admin" + ], + "x-ms-enum": { + "name": "ResourceManagerType", + "modelAsString": true + } + }, + "SubscriptionState": { + "description": "Subscription notification state.", + "type": "string", + "enum": [ + "NotDefined", + "Enabled", + "Warned", + "PastDue", + "Disabled", + "Deleted", + "Deleting", + "PartiallyDeleted" + ], + "x-ms-enum": { + "name": "SubscriptionState", + "modelAsString": true + } + }, + "Metric": { + "description": "The resource metric set that represents the metrics for a particular resource.", + "type": "object", + "properties": { + "metricUnit": { + "description": "Unit of metrics.", + "$ref": "#/definitions/MetricUnit" + }, + "timeGrain": { + "description": "Timespan of the metric.", + "type": "string" + }, + "startTime": { + "description": "Start time of the metric.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "End time of the metric.", + "type": "string", + "format": "date-time" + }, + "metricValues": { + "description": "Collected metric values in the timespan.", + "$ref": "#/definitions/MetricValueList" + } + } + }, + "MetricValue": { + "description": "Metric value", + "type": "object", + "properties": { + "timeStamp": { + "description": "Timestamp of when the metric value was collected.", + "type": "string", + "format": "date-time" + }, + "average": { + "description": "Average value for metric sample period.", + "type": "number", + "format": "double" + }, + "minimum": { + "description": "Minimum value for metric sample period.", + "type": "number", + "format": "double" + }, + "maximum": { + "description": "Maximum value for metric sample period.", + "type": "number", + "format": "double" + }, + "total": { + "description": "Total value for metric sample period.", + "type": "number", + "format": "double" + }, + "count": { + "description": "Number of measurements for metric sample period.", + "type": "integer" + }, + "properties": { + "x-ms-client-name": "extendedProperties", + "description": "Extended properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MetricValueList": { + "description": "List of metric values.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricValue" + } + }, + "MetricDefinition": { + "description": "Metric Definition", + "type": "object", + "properties": { + "name": { + "description": "Metric definition name.", + "type": "string" + }, + "unit": { + "description": "Unit of metrics.", + "$ref": "#/definitions/MetricUnit" + }, + "primaryAggregationType": { + "description": "Type of the primary aggregation.", + "$ref": "#/definitions/MetricPrimaryAggregationType" + }, + "metricAvailabilities": { + "description": "Metric availabilities.", + "$ref": "#/definitions/MetricAvailabilityList" + } + } + }, + "MetricUnit": { + "description": "The resource metric unit.", + "type": "string", + "enum": [ + "Count", + "Bytes", + "Seconds", + "CountPerSecond", + "BytesPerSecond" + ], + "x-ms-enum": { + "name": "MetricUnit", + "modelAsString": true, + "values": [ + { + "description": "The count.", + "name": "Count", + "value": "Count" + }, + { + "description": "The bytes.", + "name": "Bytes", + "value": "Bytes" + }, + { + "description": "The seconds.", + "name": "Seconds", + "value": "Seconds" + }, + { + "description": "The count per second.", + "name": "CountPerSecond", + "value": "CountPerSecond" + }, + { + "description": "The bytes per second.", + "name": "BytesPerSecond", + "value": "BytesPerSecond" + } + ] + } + }, + "MetricPrimaryAggregationType": { + "description": "The primary aggregation type for resource metric.", + "type": "string", + "enum": [ + "None", + "Average", + "Total", + "Minimum", + "Maximum", + "Last" + ], + "x-ms-enum": { + "name": "MetricPrimaryAggregationType", + "modelAsString": true, + "values": [ + { + "description": "No aggregation applied to resource.", + "name": "None", + "value": "None" + }, + { + "description": "The average aggregation type.", + "name": "Average", + "value": "Average" + }, + { + "description": "The total aggregation type.", + "name": "Total", + "value": "Total" + }, + { + "description": "The minimum aggregation type.", + "name": "Minimum", + "value": "Minimum" + }, + { + "description": "The maximum aggregation type.", + "name": "Maximum", + "value": "Maximum" + }, + { + "description": "The last aggregation type.", + "name": "Last", + "value": "Last" + } + ] + } + }, + "MetricAvailability": { + "description": "Metric Definition", + "type": "object", + "properties": { + "timeGrain": { + "description": "The time grain. Metrics will be available for this time grain.", + "type": "string" + }, + "retention": { + "description": "the retention. Metrics may be queried for this interval.", + "type": "string" + } + } + }, + "MetricAvailabilityList": { + "description": "List of metric definitions.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricAvailability" + } + }, + "MetricList": { + "description": "List of metrics.", + "properties": { + "value": { + "description": "List of metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/Metric" + } + }, + "nextLink": { + "type": "string", + "description": "Continuation token" + } + } + }, + "MetricDefinitionList": { + "description": "List of metric definitions.", + "properties": { + "value": { + "description": "Array of metric definitions.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricDefinition" + } + }, + "nextLink": { + "type": "string", + "description": "Continuation token" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string", + "default": "2015-11-01" + }, + "ResourceGroupParameter": { + "description": "The resource group the resource is located under.", + "name": "resourceGroupName", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "description": "The AzureStack location.", + "name": "location", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "SubscriptionParameter": { + "description": "Subscription parameter.", + "name": "subscription", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "NewSubscriptionParameter": { + "description": "Subscription parameter.", + "name": "newSubscription", + "in": "body", + "schema": { + "$ref": "#/definitions/Subscription" + }, + "required": true, + "x-ms-parameter-location": "method" + }, + "OfferParameter": { + "description": "Name of an offer.", + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PlanParameter": { + "description": "Name of the plan.", + "name": "plan", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DelegatedProviderParameter": { + "description": "DelegatedProvider identifier.", + "name": "delegatedProvider", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DelegatedProviderSubscriptionIdParameter": { + "description": "Delegated provider subscription identifier.", + "name": "delegatedProviderSubscriptionId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "CheckNameAvailabilityParameter": { + "description": "Check name availability parameter", + "name": "nameAvailabilityDefinition", + "in": "body", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityDefinition" + }, + "required": true, + "x-ms-parameter-location": "method" + }, + "MoveSubscriptionsParameter": { + "description": "Move subscriptions parameter.", + "name": "moveSubscriptionsDefinition", + "in": "body", + "schema": { + "$ref": "#/definitions/MoveSubscriptionsDefinition" + }, + "required": true, + "x-ms-parameter-location": "method" + }, + "FilterParameter": { + "description": "OData filter parameter.", + "name": "$filter", + "in": "query", + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/AcquiredPlan/Create.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/AcquiredPlan/Create.json new file mode 100644 index 000000000000..60b300c32e31 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/AcquiredPlan/Create.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "8158498d-27b1-4ccf-9aa1-de0f925731e6", + "location": "local", + "api-version": "2015-11-01", + "targetSubscriptionId": "8158498d-27b1-4ccf-9aa1-de0f925731e6", + "planAcquisitionId": "718c7f7c-4868-479a-98ce-5caaa8f158c8", + "newAcquiredPlan": { + "properties": { + "acquisitionId": "718c7f7c-4868-479a-98ce-5caaa8f158c8", + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/acquiredPlans/718c7f7c-4868-479a-98ce-5caaa8f158c8", + "planId": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions/plans/balaplan" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/acquiredPlans/718c7f7c-4868-479a-98ce-5caaa8f158c8", + "acquisitionId": "718c7f7c-4868-479a-98ce-5caaa8f158c8", + "planId": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions/plans/balaplan", + "provisioningState": "Succeeded", + "acquisitionTime": "2018-02-17T05:50:51.48Z" + } + }, + "201": { + "body": { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/acquiredPlans/718c7f7c-4868-479a-98ce-5caaa8f158c8", + "acquisitionId": "718c7f7c-4868-479a-98ce-5caaa8f158c8", + "planId": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions/plans/balaplan", + "provisioningState": "Succeeded", + "acquisitionTime": "2018-02-17T05:50:51.48Z" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/AcquiredPlan/Delete.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/AcquiredPlan/Delete.json new file mode 100644 index 000000000000..d0442af8c74f --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/AcquiredPlan/Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "targetSubscriptionId": "8158498d-27b1-4ccf-9aa1-de0f925731e6", + "planAcquisitionId": "718c7f7c-4868-479a-98ce-5caaa8f158c8" + }, + "responses": { + "200": { + }, + "204":{ + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/AcquiredPlan/Get.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/AcquiredPlan/Get.json new file mode 100644 index 000000000000..2c2078674bfe --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/AcquiredPlan/Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "targetSubscriptionId": "8158498d-27b1-4ccf-9aa1-de0f925731e6", + "planAcquisitionId": "718c7f7c-4868-479a-98ce-5caaa8f158c8", + "newAcquiredPlan": "" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/acquiredPlans/718c7f7c-4868-479a-98ce-5caaa8f158c8", + "acquisitionId": "718c7f7c-4868-479a-98ce-5caaa8f158c8", + "planId": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions/plans/balaplan", + "provisioningState": "Succeeded", + "acquisitionTime": "2018-02-17T05:50:51.48Z" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/AcquiredPlan/List.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/AcquiredPlan/List.json new file mode 100644 index 000000000000..d5c2843740ee --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/AcquiredPlan/List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "targetSubscriptionId": "8158498d-27b1-4ccf-9aa1-de0f925731e6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/acquiredPlans/718c7f7c-4868-479a-98ce-5caaa8f158c8", + "acquisitionId": "718c7f7c-4868-479a-98ce-5caaa8f158c8", + "planId": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions/plans/balaplan", + "provisioningState": "Succeeded", + "acquisitionTime": "2018-02-17T05:50:51.48Z" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DelegatedProvider/Get.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DelegatedProvider/Get.json new file mode 100644 index 000000000000..d67b1f4a10c8 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DelegatedProvider/Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "8ab2551d-41e5-489b-9273-1cdf1cbc7dc6", + "api-version": "2015-11-01", + "delegatedProvider": "ServiceAdmin" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Subscriptions.Admin/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6", + "subscriptionId": "8ab2551d-41e5-489b-9273-1cdf1cbc7dc6", + "delegatedProviderSubscriptionId": "8ab2551d-41e5-489b-9273-1cdf1cbc7dc6", + "displayName": "Default Provider Subscription", + "owner": "admin@contoso.com", + "tenantId": "2b3697e6-a7a2-4cdd-a3d4-f4ef6505cd4f", + "routingResourceManagerType": "Admin", + "offerId": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/system.global/providers/Microsoft.Subscriptions.Admin/offers/5790469D-0852-480D-AF9F-F4CCE1BB8B62", + "state": "Enabled" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DelegatedProvider/List.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DelegatedProvider/List.json new file mode 100644 index 000000000000..35f48ace607a --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DelegatedProvider/List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "8ab2551d-41e5-489b-9273-1cdf1cbc7dc6", + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Subscriptions.Admin/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6", + "subscriptionId": "8ab2551d-41e5-489b-9273-1cdf1cbc7dc6", + "delegatedProviderSubscriptionId": "8ab2551d-41e5-489b-9273-1cdf1cbc7dc6", + "displayName": "Default Provider Subscription", + "owner": "admin@contoso.com", + "tenantId": "2b3697e6-a7a2-4cdd-a3d4-f4ef6505cd4f", + "routingResourceManagerType": "Admin", + "offerId": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/system.global/providers/Microsoft.Subscriptions.Admin/offers/5790469D-0852-480D-AF9F-F4CCE1BB8B62", + "state": "Enabled" + }, + { + "id": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Subscriptions.Admin/subscriptions/5ef8575a-14db-4d02-8313-b9122385722b", + "subscriptionId": "5ef8575a-14db-4d02-8313-b9122385722b", + "delegatedProviderSubscriptionId": "8ab2551d-41e5-489b-9273-1cdf1cbc7dc6", + "displayName": "ResellerSub", + "owner": "tenantadmin1@msazurestack.onmicrosoft.com", + "tenantId": "2b3697e6-a7a2-4cdd-a3d4-f4ef6505cd4f", + "routingResourceManagerType": "Default", + "offerId": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/testrg/providers/Microsoft.Subscriptions.Admin/offers/reselleroffer", + "state": "Enabled" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DelegatedProviderOffer/Get.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DelegatedProviderOffer/Get.json new file mode 100644 index 000000000000..c78c14ea572e --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DelegatedProviderOffer/Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "8ab2551d-41e5-489b-9273-1cdf1cbc7dc6", + "api-version": "2015-11-01", + "delegatedProviderSubscriptionId": "8ab2551d-41e5-489b-9273-1cdf1cbc7dc6", + "offer": "Del1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/36a6bf33-6df4-4acd-a30e-7b92c1c7b322/providers/Microsoft.Subscriptions.Admin/delegatedProviders/8bb14c82-7b09-40f4-ade3-e5c71308cfcd/offers/del1", + "name": "8bb14c82-7b09-40f4-ade3-e5c71308cfcd/del1", + "type": "Microsoft.Subscriptions.Admin/delegatedProviders/offers", + "location": "local", + "properties": { + "delegatedOfferId": "/subscriptions/8bb14c82-7b09-40f4-ade3-e5c71308cfcd/providers/Microsoft.Subscriptions/delegatedOffers/TestOffer-0440a67b-3b55-45aa-8fc4-e3b6246186e7c45bf", + "displayName": "Del1", + "accessibilityState": "Private", + "subscriptionCount": 0 + } + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DelegatedProviderOffer/List.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DelegatedProviderOffer/List.json new file mode 100644 index 000000000000..d499340433a2 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DelegatedProviderOffer/List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "8ab2551d-41e5-489b-9273-1cdf1cbc7dc6", + "api-version": "2015-11-01", + "delegatedProviderSubscriptionId": "8ab2551d-41e5-489b-9273-1cdf1cbc7dc6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/36a6bf33-6df4-4acd-a30e-7b92c1c7b322/providers/Microsoft.Subscriptions.Admin/delegatedProviders/8bb14c82-7b09-40f4-ade3-e5c71308cfcd/offers/del1", + "name": "8bb14c82-7b09-40f4-ade3-e5c71308cfcd/del1", + "type": "Microsoft.Subscriptions.Admin/delegatedProviders/offers", + "location": "local", + "properties": { + "delegatedOfferId": "/subscriptions/8bb14c82-7b09-40f4-ade3-e5c71308cfcd/providers/Microsoft.Subscriptions/delegatedOffers/TestOffer-0440a67b-3b55-45aa-8fc4-e3b6246186e7c45bf", + "displayName": "Del1", + "accessibilityState": "Private", + "subscriptionCount": 0 + } + }, + { + "id": "/subscriptions/36a6bf33-6df4-4acd-a30e-7b92c1c7b322/providers/Microsoft.Subscriptions.Admin/delegatedProviders/8bb14c82-7b09-40f4-ade3-e5c71308cfcd/offers/del2", + "name": "8bb14c82-7b09-40f4-ade3-e5c71308cfcd/del2", + "type": "Microsoft.Subscriptions.Admin/delegatedProviders/offers", + "location": "local", + "properties": { + "delegatedOfferId": "/subscriptions/8bb14c82-7b09-40f4-ade3-e5c71308cfcd/providers/Microsoft.Subscriptions/delegatedOffers/TestOffer-0440a67b-3b55-45aa-8fc4-e3b6246186e7c45be", + "displayName": "Del2", + "accessibilityState": "Private", + "subscriptionCount": 0 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DirectoryTenant/Create.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DirectoryTenant/Create.json new file mode 100644 index 000000000000..fbfe87f366c1 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DirectoryTenant/Create.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "tenant": "azurestackci05.onmicrosoft.in", + "newTenant": "eb90516e-65d7-4bf6-8537-8322e9172832", + "resourceGroupName": "system.local" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/System.local/providers/Microsoft.Subscriptions.Admin/directoryTenants/azurestackci05.onmicrosoft.in", + "name": "azurestackci05.onmicrosoft.in", + "type": "Microsoft.Subscriptions.Admin/directoryTenants", + "location": "local", + "properties": { + "tenantId": "eb90516e-65d7-4bf6-8537-8322e9172832" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/System.local/providers/Microsoft.Subscriptions.Admin/directoryTenants/azurestackci05.onmicrosoft.in", + "name": "azurestackci05.onmicrosoft.in", + "type": "Microsoft.Subscriptions.Admin/directoryTenants", + "location": "local", + "properties": { + "tenantId": "eb90516e-65d7-4bf6-8537-8322e9172832" + } + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DirectoryTenant/Delete.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DirectoryTenant/Delete.json new file mode 100644 index 000000000000..8117d0200ec4 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DirectoryTenant/Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "resourceGroupName": "system.local", + "tenant": "azurestackci07.onmicrosoft.com" + }, + "responses": { + "200": { + }, + "204":{} + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DirectoryTenant/Get.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DirectoryTenant/Get.json new file mode 100644 index 000000000000..37842c4323bf --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DirectoryTenant/Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "resourceGroupName": "system.local", + "tenant": "azurestackci07.onmicrosoft.com" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/System.local/providers/Microsoft.Subscriptions.Admin/directoryTenants/azurestackci07.onmicrosoft.com", + "name": "azurestackci07.onmicrosoft.com", + "type": "Microsoft.Subscriptions.Admin/directoryTenants", + "location": "local", + "properties": { + "tenantId": "2b3697e6-a7a2-4cdd-a3d4-f4ef6505cd4f" + } + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DirectoryTenant/List.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DirectoryTenant/List.json new file mode 100644 index 000000000000..267f912a7b7a --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/DirectoryTenant/List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "resourceGroupName": "system.local" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/System.local/providers/Microsoft.Subscriptions.Admin/directoryTenants/azurestackci07.onmicrosoft.com", + "name": "azurestackci07.onmicrosoft.com", + "type": "Microsoft.Subscriptions.Admin/directoryTenants", + "location": "local", + "properties": { + "tenantId": "2b3697e6-a7a2-4cdd-a3d4-f4ef6505cd4f" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/Delete.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/Delete.json new file mode 100644 index 000000000000..61746f79ff99 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01" + }, + "responses": { + "200": { + }, + "204":{ + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/Get.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/Get.json new file mode 100644 index 000000000000..cc4d7dad0904 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/Get.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Subscriptions.Admin/locations/local", + "name": "local", + "displayName": "local", + "latitude": "", + "longitude": "" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/List.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/List.json new file mode 100644 index 000000000000..11eaf48086fd --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/List.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Subscriptions.Admin/locations/local", + "name": "local", + "displayName": "local", + "latitude": "", + "longitude": "" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/Put.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/Put.json new file mode 100644 index 000000000000..4415f5c3e640 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Location/Put.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "api-version": "2015-11-01", + "location": "local", + "newLocation": { + "name": "local", + "displayName": "local", + "latitude": "56", + "longitude": "65" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Subscriptions.Admin/locations/local", + "name": "local", + "displayName": "local", + "latitude": "", + "longitude": "" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Create.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Create.json new file mode 100644 index 000000000000..716feb23b011 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Create.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "offer": "sampleoffer1", + "resourceGroupName": "RG1", + "newOffer": { + "properties": { + "name": "testOffer1", + "displayName": "Test Offer", + "description": "This is a test Offer", + "state": "Private", + "subscriptionCount": 0, + "maxSubscriptionsPerAccount": 100, + "basePlanIds": [ + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/Plans/providers/Microsoft.Subscriptions.Admin/plans/testplan" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/testrg/providers/Microsoft.Subscriptions.Admin/offers/testOffer1", + "name": "testOffer1", + "type": "Microsoft.Subscriptions.Admin/offers", + "location": "local", + "properties": { + "name": "testOffer1", + "displayName": "Test Offer", + "description": "This is a test Offer", + "state": "Private", + "subscriptionCount": 0, + "maxSubscriptionsPerAccount": 100, + "basePlanIds": [ + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/Plans/providers/Microsoft.Subscriptions.Admin/plans/testplan" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/testrg/providers/Microsoft.Subscriptions.Admin/offers/testOffer1", + "name": "testOffer1", + "type": "Microsoft.Subscriptions.Admin/offers", + "location": "local", + "properties": { + "name": "testOffer1", + "displayName": "Test Offer", + "description": "This is a test Offer", + "state": "Private", + "subscriptionCount": 0, + "maxSubscriptionsPerAccount": 100, + "basePlanIds": [ + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/Plans/providers/Microsoft.Subscriptions.Admin/plans/testplan" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Delete.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Delete.json new file mode 100644 index 000000000000..8bcaf6eb700e --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "name": "sampleoffer1", + "resourceGroupName": "RG1", + "offer": "offername" + }, + "responses": { + "200": { + }, + "204":{} + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Get.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Get.json new file mode 100644 index 000000000000..a924d893bc0e --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "0af9c33b-f7ac-4161-add5-17b2f0b6a669", + "api-version": "2015-11-01", + "offer": "sampleoffer1", + "resourceGroupName": "RG1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0af9c33b-f7ac-4161-add5-17b2f0b6a669/resourceGroups/RG1/providers/Microsoft.Subscriptions.Admin/offers/sampleoffer1", + "name": "sampleoffer1", + "type": "Microsoft.Subscriptions.Admin/offers", + "location": "local", + "properties": { + "name": "sampleoffer1", + "displayName": "SampleOffer1", + "description": "", + "externalReferenceId": "", + "state": "Public", + "subscriptionCount": 1, + "maxSubscriptionsPerAccount": 0, + "basePlanIds": [ + "/subscriptions/0af9c33b-f7ac-4161-add5-17b2f0b6a669/resourceGroups/RG1/providers/Microsoft.Subscriptions.Admin/plans/sampleplan1" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Link.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Link.json new file mode 100644 index 000000000000..ea6e2e179040 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Link.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "offer": "sampleoffer1", + "resourceGroupName": "RG1", + "planLink": { + "properties": { + "planName": "sampleplan1", + "planLinkType": "Addon" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/36a6bf33-6df4-4acd-a30e-7b92c1c7b322/resourceGroups/RG1/providers/Microsoft.Subscriptions.Admin/offers/sampleoffer1", + "name": "sampleoffer1", + "type": "Microsoft.Subscriptions.Admin/offers", + "location": "local", + "tags": {}, + "properties": { + "name": "sampleoffer1", + "displayName": "sampleoffer1", + "state": "Public", + "subscriptionCount": 2, + "maxSubscriptionsPerAccount": 0, + "basePlanIds": [ + "/subscriptions/36a6bf33-6df4-4acd-a30e-7b92c1c7b322/resourceGroups/RG1/providers/Microsoft.Subscriptions.Admin/plans/cnur5364tenantplan110" + ], + "addonPlans": [ + { + "planId": "/subscriptions/36a6bf33-6df4-4acd-a30e-7b92c1c7b322/resourceGroups/TestRG-66c416e8-ad7c-4686-847e-5f84772d3217/providers/Microsoft.Subscriptions.Admin/plans/sampleplan1", + "maxAcquisitionCount": 1 + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/List.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/List.json new file mode 100644 index 000000000000..12d408a6b110 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/List.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "0af9c33b-f7ac-4161-add5-17b2f0b6a669", + "api-version": "2015-11-01", + "resourceGroupName": "RG1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0af9c33b-f7ac-4161-add5-17b2f0b6a669/resourceGroups/RG1/providers/Microsoft.Subscriptions.Admin/offers/sampleoffer1", + "name": "sampleoffer1", + "type": "Microsoft.Subscriptions.Admin/offers", + "location": "local", + "properties": { + "name": "sampleoffer1", + "displayName": "SampleOffer1", + "description": "", + "externalReferenceId": "", + "state": "Public", + "subscriptionCount": 1, + "maxSubscriptionsPerAccount": 0, + "basePlanIds": [ + "/subscriptions/0af9c33b-f7ac-4161-add5-17b2f0b6a669/resourceGroups/RG1/providers/Microsoft.Subscriptions.Admin/plans/sampleplan1" + ] + } + }, + { + "id": "/subscriptions/0af9c33b-f7ac-4161-add5-17b2f0b6a669/resourceGroups/ascansubscrrg479/providers/Microsoft.Subscriptions.Admin/offers/sampleoffer2", + "name": "sampleoffer2", + "type": "Microsoft.Subscriptions.Admin/offers", + "location": "local", + "tags": {}, + "properties": { + "name": "sampleoffer2", + "displayName": "sampleoffer2", + "state": "Public", + "subscriptionCount": 0, + "maxSubscriptionsPerAccount": 0, + "basePlanIds": [ + "/subscriptions/0af9c33b-f7ac-4161-add5-17b2f0b6a669/resourceGroups/ascansubscrrg479/providers/Microsoft.Subscriptions.Admin/plans/sampleoffer2" + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/MetricDefinitions.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/MetricDefinitions.json new file mode 100644 index 000000000000..3718cd2f6009 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/MetricDefinitions.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "offer": "sampleoffer1", + "resourceGroupName": "RG1" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Metrics.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Metrics.json new file mode 100644 index 000000000000..3718cd2f6009 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Metrics.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "offer": "sampleoffer1", + "resourceGroupName": "RG1" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Unlink.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Unlink.json new file mode 100644 index 000000000000..1c89cbcba37f --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Offer/Unlink.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "offer": "sampleoffer1", + "resourceGroupName": "RG1", + "planLink": { + "properties": { + "planName": "SamplePlan", + "planLinkType": "Addon" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/36a6bf33-6df4-4acd-a30e-7b92c1c7b322/resourceGroups/RG1/providers/Microsoft.Subscriptions.Admin/offers/sampleoffer1", + "name": "sampleoffer1", + "type": "Microsoft.Subscriptions.Admin/offers", + "location": "local", + "tags": {}, + "properties": { + "name": "sampleoffer1", + "displayName": "sampleoffer1", + "state": "Public", + "subscriptionCount": 2, + "maxSubscriptionsPerAccount": 0, + "basePlanIds": [ + "/subscriptions/36a6bf33-6df4-4acd-a30e-7b92c1c7b322/resourceGroups/RG1/providers/Microsoft.Subscriptions.Admin/plans/SamplePlan" + ], + "addonPlans": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/OfferDelegation/Create.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/OfferDelegation/Create.json new file mode 100644 index 000000000000..98143a265a09 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/OfferDelegation/Create.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "resourceGroupName": "cnur9852subscrrg374", + "offer": "cnur9852tenantoffer374", + "offerDelegationName": "testOfferDelegation", + "newOfferDelegation": "newDelegationName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2ac7d4ad-fece-4cf0-bc29-e8678897fa75/resourceGroups/cnur9852subscrrg374/providers/Microsoft.Subscriptions.Admin/offers/cnur9852tenantoffer374/offerDelegations/testOfferDelegation", + "name": "cnur9852tenantoffer374/testOfferDelegation", + "type": "Microsoft.Subscriptions.Admin/offers/offerDelegations", + "location": "local", + "properties": { + "subscriptionId": "9e8052f2-70df-44c0-8300-f97949ca75f0" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/2ac7d4ad-fece-4cf0-bc29-e8678897fa75/resourceGroups/cnur9852subscrrg374/providers/Microsoft.Subscriptions.Admin/offers/cnur9852tenantoffer374/offerDelegations/testOfferDelegation", + "name": "cnur9852tenantoffer374/testOfferDelegation", + "type": "Microsoft.Subscriptions.Admin/offers/offerDelegations", + "location": "local", + "properties": { + "subscriptionId": "9e8052f2-70df-44c0-8300-f97949ca75f0" + } + } + } + + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/OfferDelegation/Delete.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/OfferDelegation/Delete.json new file mode 100644 index 000000000000..66dfeed15d43 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/OfferDelegation/Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "resourceGroupName": "cnur9852subscrrg374", + "offer": "cnur9852tenantoffer374", + "offerDelegationName": "testOfferDelegation" + }, + "responses": { + "200": {}, + "204":{} + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/OfferDelegation/Get.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/OfferDelegation/Get.json new file mode 100644 index 000000000000..7b54ad85cab6 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/OfferDelegation/Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "resourceGroupName": "cnur9852subscrrg374", + "offer": "cnur9852tenantoffer374", + "offerDelegationName": "testOfferDelegation" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2ac7d4ad-fece-4cf0-bc29-e8678897fa75/resourceGroups/cnur9852subscrrg374/providers/Microsoft.Subscriptions.Admin/offers/cnur9852tenantoffer374/offerDelegations/testOfferDelegation", + "name": "cnur9852tenantoffer374/testOfferDelegation", + "type": "Microsoft.Subscriptions.Admin/offers/offerDelegations", + "location": "local", + "properties": { + "subscriptionId": "9e8052f2-70df-44c0-8300-f97949ca75f0" + } + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/OfferDelegation/List.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/OfferDelegation/List.json new file mode 100644 index 000000000000..9ebc2cbe4a54 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/OfferDelegation/List.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "resourceGroupName": "RG", + "offer": "Default Offer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2ac7d4ad-fece-4cf0-bc29-e8678897fa75/resourceGroups/cnur9852subscrrg374/providers/Microsoft.Subscriptions.Admin/offers/cnur9852tenantoffer374/offerDelegations/testOfferDelegation", + "name": "cnur9852tenantoffer374/testOfferDelegation", + "type": "Microsoft.Subscriptions.Admin/offers/offerDelegations", + "location": "local", + "properties": { + "subscriptionId": "9e8052f2-70df-44c0-8300-f97949ca75f0" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/Create.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/Create.json new file mode 100644 index 000000000000..0103911d4be6 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/Create.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "resourceGroupName": "plans", + "plan": "testplan", + "newPlan": { + "properties": { + "description": "test plan", + "displayName": "testplans", + "name": "newplan", + "quotaIds": [ + "123", + "abc" + ], + "subscriptionCount": 0 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/testrg/providers/Microsoft.Subscriptions.Admin/plans/testplans", + "name": "testplans", + "type": "Microsoft.Subscriptions.Admin/plans", + "location": "local", + "properties": { + "name": "testplans", + "displayName": "testplans", + "description": "test plan", + "subscriptionCount": 0, + "quotaIds": [ + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/testrg/providers/Microsoft.Subscriptions.Admin/plans/testplans", + "name": "testplans", + "type": "Microsoft.Subscriptions.Admin/plans", + "location": "local", + "properties": { + "name": "testplans", + "displayName": "testplans", + "description": "test plan", + "subscriptionCount": 0, + "quotaIds": [ + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/Delete.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/Delete.json new file mode 100644 index 000000000000..a402c371fe7b --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "resourceGroupName": "plans", + "plan": "testplan" + }, + "responses": { + "200": { + }, + "204":{} + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/Get.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/Get.json new file mode 100644 index 000000000000..ba2c709babc7 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "resourceGroupName": "plans", + "plan": "testplan" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/Plans/providers/Microsoft.Subscriptions.Admin/plans/testplan", + "name": "testplan", + "type": "Microsoft.Subscriptions.Admin/plans", + "location": "local", + "properties": { + "name": "testplan", + "displayName": "TestPlan", + "subscriptionCount": 0, + "quotaIds": [ + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Compute.Admin/locations/local/quotas/Default Quota", + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.KeyVault.Admin/locations/local/quotas/Unlimited", + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Network.Admin/locations/local/quotas/Default Quota", + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Storage.Admin/locations/local/quotas/Default Quota", + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/List.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/List.json new file mode 100644 index 000000000000..c5817d26bd94 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "resourceGroupName": "plans" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/resourceGroups/Plans/providers/Microsoft.Subscriptions.Admin/plans/testplan", + "name": "testplan", + "type": "Microsoft.Subscriptions.Admin/plans", + "location": "local", + "properties": { + "name": "testplan", + "displayName": "TestPlan", + "subscriptionCount": 0, + "quotaIds": [ + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Compute.Admin/locations/local/quotas/Default Quota", + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.KeyVault.Admin/locations/local/quotas/Unlimited", + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Network.Admin/locations/local/quotas/Default Quota", + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Storage.Admin/locations/local/quotas/Default Quota", + "/subscriptions/8ab2551d-41e5-489b-9273-1cdf1cbc7dc6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota" + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/ListAll.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/ListAll.json new file mode 100644 index 000000000000..66e987f94b20 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/ListAll.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/balarg/providers/Microsoft.Subscriptions.Admin/plans/balaplan", + "name": "balaplan", + "type": "Microsoft.Subscriptions.Admin/plans", + "location": "local", + "properties": { + "name": "balaplan", + "displayName": "balaplan", + "subscriptionCount": 0, + "quotaIds": [ + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Compute.Admin/locations/local/quotas/Default Quota" + ] + } + }, + { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/cnur8007subscrrg352/providers/Microsoft.Subscriptions.Admin/plans/cnur8007tenantplan352", + "name": "cnur8007tenantplan352", + "type": "Microsoft.Subscriptions.Admin/plans", + "location": "local", + "tags": {}, + "properties": { + "name": "cnur8007tenantplan352", + "displayName": "cnur8007tenantplan352", + "subscriptionCount": 0, + "quotaIds": [ + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Compute.Admin/locations/local/quotas/ascanarycomputequota", + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.KeyVault.Admin/locations/local/quotas/Unlimited", + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Network.Admin/locations/local/quotas/ascanarynetworkquota", + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Storage.Admin/locations/local/quotas/ascanarystoragequota" + ] + } + }, + { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/cnur8007resellersubscrrg352/providers/Microsoft.Subscriptions.Admin/plans/cnur8007subsvcplan352", + "name": "cnur8007subsvcplan352", + "type": "Microsoft.Subscriptions.Admin/plans", + "location": "local", + "tags": {}, + "properties": { + "name": "cnur8007subsvcplan352", + "displayName": "cnur8007subsvcplan352", + "subscriptionCount": 0, + "quotaIds": [ + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota" + ] + } + }, + { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/TestRG-c895f7cb-18e0-41b4-a4e9-c29131dbbc48/providers/Microsoft.Subscriptions.Admin/plans/TestPlan-f366b2c1-17e9-4522-b162-fb5a016a9f94", + "name": "TestPlan-f366b2c1-17e9-4522-b162-fb5a016a9f94", + "type": "Microsoft.Subscriptions.Admin/plans", + "location": "local", + "tags": {}, + "properties": { + "name": "TestPlan-f366b2c1-17e9-4522-b162-fb5a016a9f94", + "displayName": "TestPlan-f366b2c1-17e9-4522-b162-fb5a016a9f94", + "subscriptionCount": 0, + "quotaIds": [ + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota" + ] + } + }, + { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/balarg/providers/Microsoft.Subscriptions.Admin/plans/balaplan2", + "name": "balaplan2", + "type": "Microsoft.Subscriptions.Admin/plans", + "location": "local", + "properties": { + "name": "balaplan2", + "displayName": "balaplan2", + "subscriptionCount": 0, + "quotaIds": [ + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota" + ] + } + }, + { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/balarg/providers/Microsoft.Subscriptions.Admin/plans/bala2", + "name": "bala2", + "type": "Microsoft.Subscriptions.Admin/plans", + "location": "local", + "tags": {}, + "properties": { + "name": "bala2", + "displayName": "bala2", + "subscriptionCount": 0, + "quotaIds": [ + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota" + ] + } + }, + { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/balarg/providers/Microsoft.Subscriptions.Admin/plans/bala3", + "name": "bala3", + "type": "Microsoft.Subscriptions.Admin/plans", + "location": "local", + "tags": {}, + "properties": { + "name": "bala3", + "displayName": "bala2", + "subscriptionCount": 0, + "quotaIds": [ + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota" + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/MetricDefinitions.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/MetricDefinitions.json new file mode 100644 index 000000000000..e05eea3855d4 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/MetricDefinitions.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "resourceGroupName": "plans", + "plan": "testplan" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/Metrics.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/Metrics.json new file mode 100644 index 000000000000..e05eea3855d4 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Plan/Metrics.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "resourceGroupName": "plans", + "plan": "testplan" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Quota/Create.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Quota/Create.json new file mode 100644 index 000000000000..b6ec89836d95 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Quota/Create.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "reportedStartTime": "2017-08-01T00:00:00.00Z", + "reportedEndTime": "2017-08-02T00:00:00.00Z", + "aggregationGranularity": "", + "subscriberId": "", + "continuationToken": "" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Quota/Delete.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Quota/Delete.json new file mode 100644 index 000000000000..b6ec89836d95 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Quota/Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "reportedStartTime": "2017-08-01T00:00:00.00Z", + "reportedEndTime": "2017-08-02T00:00:00.00Z", + "aggregationGranularity": "", + "subscriberId": "", + "continuationToken": "" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Quota/Get.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Quota/Get.json new file mode 100644 index 000000000000..ec0bd9154ec2 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Quota/Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "quota": "local/delegatedProviderQuota" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota", + "name": "local/delegatedProviderQuota", + "type": "Microsoft.Subscriptions.Admin/locations/quotas", + "location": "local", + "properties": { + "allowCustomPortalBranding": false + } + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Quota/List.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Quota/List.json new file mode 100644 index 000000000000..eb700731e561 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Quota/List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/locations/local/quotas/delegatedProviderQuota", + "name": "local/delegatedProviderQuota", + "type": "Microsoft.Subscriptions.Admin/locations/quotas", + "location": "local", + "properties": { + "allowCustomPortalBranding": false + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/CheckNameAvailability.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/CheckNameAvailability.json new file mode 100644 index 000000000000..71f2aa9939c9 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/CheckNameAvailability.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "name": "subname", + "nameAvailabilityDefinition": { + "properties": { + "name": "subname", + "resourceType": "type" + } + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/Create.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/Create.json new file mode 100644 index 000000000000..1d163401ff60 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/Create.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "subscription": "test", + "newSubscription": { + "properties": { + "delegatedProviderSubscriptionId": "d16dfcf0-44cc-4498-9937-08b94159d27b", + "displayName": "Test Subscription", + "id": "/subscriptions/d16dfcf0-44cc-4498-9937-08b94159d27b/providers/Microsoft.Subscriptions.Admin/subscriptions/c79389af-4480-48cc-8fa2-ee8ced8e843d", + "offerId": "/subscriptions/d16dfcf0-44cc-4498-9937-08b94159d27b/resourceGroups/planrg/providers/Microsoft.Subscriptions.Admin/offers/testoffer", + "owner": "tenantadmin1@msazurestack.onmicrosoft.com", + "routingResourceManagerType": "Default", + "state": "Enabled" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d16dfcf0-44cc-4498-9937-08b94159d27b/providers/Microsoft.Subscriptions.Admin/subscriptions/c79389af-4480-48cc-8fa2-ee8ced8e843d", + "subscriptionId": "c79389af-4480-48cc-8fa2-ee8ced8e843d", + "delegatedProviderSubscriptionId": "d16dfcf0-44cc-4498-9937-08b94159d27b", + "displayName": "Test Subscription", + "owner": "tenantadmin1@msazurestack.onmicrosoft.com", + "tenantId": "104edf09-7fc1-459f-8c4e-b062db480b90", + "routingResourceManagerType": "Default", + "offerId": "/subscriptions/d16dfcf0-44cc-4498-9937-08b94159d27b/resourceGroups/planrg/providers/Microsoft.Subscriptions.Admin/offers/testoffer", + "state": "Enabled" + } + }, + "200": { + "body": { + "id": "/subscriptions/d16dfcf0-44cc-4498-9937-08b94159d27b/providers/Microsoft.Subscriptions.Admin/subscriptions/c79389af-4480-48cc-8fa2-ee8ced8e843d", + "subscriptionId": "c79389af-4480-48cc-8fa2-ee8ced8e843d", + "delegatedProviderSubscriptionId": "d16dfcf0-44cc-4498-9937-08b94159d27b", + "displayName": "Test Subscription", + "owner": "tenantadmin1@msazurestack.onmicrosoft.com", + "tenantId": "104edf09-7fc1-459f-8c4e-b062db480b90", + "routingResourceManagerType": "Default", + "offerId": "/subscriptions/d16dfcf0-44cc-4498-9937-08b94159d27b/resourceGroups/planrg/providers/Microsoft.Subscriptions.Admin/offers/testoffer", + "state": "Enabled" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/Delete.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/Delete.json new file mode 100644 index 000000000000..6c627e6a1d6d --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "subscription": "test" + }, + "responses": { + "200": { + }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/Get.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/Get.json new file mode 100644 index 000000000000..ece931e2937c --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "subscription": "test" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d16dfcf0-44cc-4498-9937-08b94159d27b/providers/Microsoft.Subscriptions.Admin/subscriptions/c79389af-4480-48cc-8fa2-ee8ced8e843d", + "subscriptionId": "c79389af-4480-48cc-8fa2-ee8ced8e843d", + "delegatedProviderSubscriptionId": "d16dfcf0-44cc-4498-9937-08b94159d27b", + "displayName": "Test Subscription", + "owner": "tenantadmin1@msazurestack.onmicrosoft.com", + "tenantId": "104edf09-7fc1-459f-8c4e-b062db480b90", + "routingResourceManagerType": "Default", + "offerId": "/subscriptions/d16dfcf0-44cc-4498-9937-08b94159d27b/resourceGroups/planrg/providers/Microsoft.Subscriptions.Admin/offers/testoffer", + "state": "Enabled" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/List.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/List.json new file mode 100644 index 000000000000..8cc99ef94402 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/List.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/5144634d-7e4d-443b-a304-d27e44220fc6", + "subscriptionId": "5144634d-7e4d-443b-a304-d27e44220fc6", + "delegatedProviderSubscriptionId": "8158498d-27b1-4ccf-9aa1-de0f925731e6", + "displayName": "sfsdf", + "owner": "tenantadmin1@msazurestack.onmicrosoft.com", + "tenantId": "d9b782d5-d098-4374-8f2c-3907cc34611c", + "routingResourceManagerType": "Default", + "offerId": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/balarg/providers/Microsoft.Subscriptions.Admin/offers/balaoffer", + "state": "Enabled" + }, + { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/55049d1c-9727-4f79-95b6-50d1f3ee2b28", + "subscriptionId": "55049d1c-9727-4f79-95b6-50d1f3ee2b28", + "delegatedProviderSubscriptionId": "8158498d-27b1-4ccf-9aa1-de0f925731e6", + "displayName": "Test User-tenantadmin1@msazurestack.onmicrosoft.com", + "owner": "tenantadmin1@msazurestack.onmicrosoft.com", + "tenantId": "d9b782d5-d098-4374-8f2c-3907cc34611c", + "routingResourceManagerType": "Default", + "offerId": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/TestRG-c895f7cb-18e0-41b4-a4e9-c29131dbbc48/providers/Microsoft.Subscriptions.Admin/offers/TestOffer-e9a634c1-8846-49f0-ab49-65d24262dc41", + "state": "Enabled" + }, + { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/ad7e95b8-cb96-472e-b48d-46411ddce350", + "subscriptionId": "ad7e95b8-cb96-472e-b48d-46411ddce350", + "delegatedProviderSubscriptionId": "8158498d-27b1-4ccf-9aa1-de0f925731e6", + "displayName": "cnur8007tenantsubscription352", + "owner": "tenantadmin1@msazurestack.onmicrosoft.com", + "tenantId": "d9b782d5-d098-4374-8f2c-3907cc34611c", + "routingResourceManagerType": "Default", + "offerId": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/cnur8007subscrrg352/providers/Microsoft.Subscriptions.Admin/offers/cnur8007tenantoffer352", + "state": "Enabled" + }, + { + "id": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/c4d75460-5ea2-486a-a87f-85506f55daa6", + "subscriptionId": "c4d75460-5ea2-486a-a87f-85506f55daa6", + "delegatedProviderSubscriptionId": "8158498d-27b1-4ccf-9aa1-de0f925731e6", + "displayName": "cnur8007tenantdefaultsubscription352", + "owner": "tenantadmin1@msazurestack.onmicrosoft.com", + "tenantId": "d9b782d5-d098-4374-8f2c-3907cc34611c", + "routingResourceManagerType": "Default", + "offerId": "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/resourceGroups/cnur8007subscrrg352/providers/Microsoft.Subscriptions.Admin/offers/cnur8007tenantoffer352", + "state": "Enabled" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/MoveSubscriptionsToDefaultProvider.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/MoveSubscriptionsToDefaultProvider.json new file mode 100644 index 000000000000..4d6c4b6827c4 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/MoveSubscriptionsToDefaultProvider.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "api-version": "2015-11-01", + "moveSubscriptionsDefinition": + { + "properties": { + "targetDelegatedProviderOffer": null, + "resources": [ + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/5144634d-7e4d-443b-a304-d27e44220fc6", + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/55049d1c-9727-4f79-95b6-50d1f3ee2b28" + ] + } + } + }, + "responses": { + "204": { + }, + "202": { + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/MoveSubscriptionsToDelegatedProvider.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/MoveSubscriptionsToDelegatedProvider.json new file mode 100644 index 000000000000..50b5dfbf5a42 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/MoveSubscriptionsToDelegatedProvider.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "api-version": "2015-11-01", + "moveSubscriptionsDefinition": + { + "properties": { + "targetDelegatedProviderOffer": "/subscriptions/36a6bf33-6df4-4acd-a30e-7b92c1c7b322/providers/Microsoft.Subscriptions.Admin/delegatedProviders/8bb14c82-7b09-40f4-ade3-e5c71308cfcd/offers/del1", + "resources": [ + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/5144634d-7e4d-443b-a304-d27e44220fc6", + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/55049d1c-9727-4f79-95b6-50d1f3ee2b28" + ] + } + } + }, + "responses": { + "204": { + }, + "202": { + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/Operations.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/Operations.json new file mode 100644 index 000000000000..ff025517c67b --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/Operations.json @@ -0,0 +1,285 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Subscriptions.Admin/directoryTenants/read", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Directory Tenant", + "operation": "Get Directory Tenant", + "description": "Gets or lists directory tenants." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/directoryTenants/write", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Directory Tenant", + "operation": "Create Directory Tenant", + "description": "Creates or updates a directory tenant." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/directoryTenants/delete", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Directory Tenant", + "operation": "Delete Directory Tenant", + "description": "Deletes a directory tenant." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/delegatedProviders/read", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Delegated Provider", + "operation": "Get Delegated Provider", + "description": "Gets or lists delegated providers." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/delegatedProviders/offers/read", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Delegated Provider Offer", + "operation": "Get Delegated Provider Offer", + "description": "Gets or lists delegated provider offers." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/locations/read", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Location", + "operation": "Get Location", + "description": "Gets or lists locations." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/locations/write", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Location", + "operation": "Create Location", + "description": "Creates or updates a location." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/locations/quotas/read", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Quota", + "operation": "Get Quota", + "description": "Gets quota for delegated providers." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/offers/read", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Offer", + "operation": "Get Offer", + "description": "Gets or lists offers." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/offers/write", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Offer", + "operation": "Create Offer", + "description": "Creates or updates an offer." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/offers/delete", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Offer", + "operation": "Delete Offer", + "description": "Deletes an offer." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/offers/link/action", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Offer", + "operation": "Links a base or add-on plan to an offer.", + "description": "Links a plan to an offer." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/offers/unlink/action", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Offer", + "operation": "Unlink Offer", + "description": "Unlinks a base or add-on plan from an offer." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/offers/offerDelegations/read", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Offer Delegation", + "operation": "Get Offer Delegations", + "description": "Gets or lists the delegations of your offer to other delegated providers." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/offers/offerDelegations/write", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Offer Delegation", + "operation": "Create Offer Delegation", + "description": "Creates or updates a delegation of your offer to another delegated provider." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/offers/offerDelegations/delete", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Offer Delegation", + "operation": "Delete Offer Delegation", + "description": "Deletes a delegation of your offer to another delegated provider." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/plans/read", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Plan", + "operation": "Get Plan", + "description": "Gets or lists plans." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/plans/write", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Plan", + "operation": "Create Plan", + "description": "Creates or updates a plan." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/plans/delete", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Plan", + "operation": "Delete Plan", + "description": "Deletes a plan." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/subscriptions/read", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Subscription", + "operation": "Get Subscriptions", + "description": "Gets or lists subscriptions consuming your offers." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/subscriptions/write", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Subscription", + "operation": "Create Subscription", + "description": "Creates or updates a subscription consuming your offer." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/subscriptions/delete", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Subscription", + "operation": "Delete Subscription", + "description": "Deletes a subscription consuming your offer." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/subscriptions/acquiredPlans/read", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Acquired Plan", + "operation": "Get Acquired Plans", + "description": "Gets or lists the plans acquired by a subscription consuming your offer." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/subscriptions/acquiredPlans/write", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Acquired Plan", + "operation": "Create Acquired Plan", + "description": "Creates or updates a plan acquisition by a subscription consuming your offer." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/subscriptions/acquiredPlans/delete", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Acquired Plan", + "operation": "Delete Acquired Plan", + "description": "Deletes a plan acquisition for a subscription consuming your offer." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/operations/read", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Operation", + "operation": "List Operations", + "description": "Lists the supported operations." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/restoreData/action", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Restore Data", + "operation": "Restore Subscriptions Data", + "description": "Restore data from a backup into the current deployment of Subscriptions Service." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/updateEncryption/action", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Update Encryption", + "operation": "Update Encryption", + "description": "Updates encryption of secrets." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/moveSubscriptions/action", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Move Subscriptions", + "operation": "Move Subscriptions", + "description": "Move user subscriptions to a delegated provider offer." + } + }, + { + "name": "Microsoft.Subscriptions.Admin/checkNameAvailability/action", + "display": { + "provider": "Microsoft Subscriptions Administration Service", + "resource": "Check Name Availability", + "operation": "Check Global Name Availability", + "description": "Get the global name availability for resource names requiring global uniqueness." + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/UpdateEncryption.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/UpdateEncryption.json new file mode 100644 index 000000000000..4f69df2ea85d --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/UpdateEncryption.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "reportedStartTime": "2017-08-01T00:00:00.00Z", + "reportedEndTime": "2017-08-02T00:00:00.00Z", + "aggregationGranularity": "", + "subscriberId": "", + "continuationToken": "" + }, + "responses": { + "200": { + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/ValidateMoveSubscriptionsToDefaultProvider.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/ValidateMoveSubscriptionsToDefaultProvider.json new file mode 100644 index 000000000000..4d6c4b6827c4 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/ValidateMoveSubscriptionsToDefaultProvider.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "api-version": "2015-11-01", + "moveSubscriptionsDefinition": + { + "properties": { + "targetDelegatedProviderOffer": null, + "resources": [ + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/5144634d-7e4d-443b-a304-d27e44220fc6", + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/55049d1c-9727-4f79-95b6-50d1f3ee2b28" + ] + } + } + }, + "responses": { + "204": { + }, + "202": { + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/ValidateMoveSubscriptionsToDelegatedProvider.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/ValidateMoveSubscriptionsToDelegatedProvider.json new file mode 100644 index 000000000000..50b5dfbf5a42 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/examples/Subscriptions/ValidateMoveSubscriptionsToDelegatedProvider.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "api-version": "2015-11-01", + "moveSubscriptionsDefinition": + { + "properties": { + "targetDelegatedProviderOffer": "/subscriptions/36a6bf33-6df4-4acd-a30e-7b92c1c7b322/providers/Microsoft.Subscriptions.Admin/delegatedProviders/8bb14c82-7b09-40f4-ade3-e5c71308cfcd/offers/del1", + "resources": [ + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/5144634d-7e4d-443b-a304-d27e44220fc6", + "/subscriptions/8158498d-27b1-4ccf-9aa1-de0f925731e6/providers/Microsoft.Subscriptions.Admin/subscriptions/55049d1c-9727-4f79-95b6-50d1f3ee2b28" + ] + } + } + }, + "responses": { + "204": { + }, + "202": { + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/subscriptions/readme.md b/specification/azsadmin/resource-manager/subscriptions/readme.md new file mode 100644 index 000000000000..cad173328026 --- /dev/null +++ b/specification/azsadmin/resource-manager/subscriptions/readme.md @@ -0,0 +1,100 @@ +# Subscriptions Admin + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Subscriptions Admin. + +--- +## Getting Started +To build the SDK for Subscriptions 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 Subscriptions API. + +``` yaml +title: SubscriptionsAdminClient +description: Subscriptions Admin Client +openapi-type: arm +tag: package-2015-11-01 +``` + + +## Suppression +``` yaml +directive: + - suppress: XmsResourceInPutResponse + reason: Subscription and Location are not modelled as ARM resources in azure for legacy reasons. In Azure stack as well, Subscription and Location are not modelled as ARM resource for azure consistency + where: + - $.paths["/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/subscriptions/{subscription}"].put + - $.paths["/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/subscriptions/{targetSubscriptionId}/acquiredPlans/{planAcquisitionId}"].put + - $.paths["/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/locations/{location}"].put + + - suppress: SubscriptionIdParameterInOperations + reason: Subscription is the main resource in the API spec and it should not be masked in global parameters. + where: + - $.paths[\"/subscriptions/{subscriptionId}\"].get.parameters[0] + - $.paths[\"/subscriptions/{subscriptionId}\"].put.parameters[0] + - $.paths[\"/subscriptions/{subscriptionId}\"].delete.parameters[0] + + - suppress: BodyTopLevelProperties + reason: Subscription is not modelled as ARM resource in azure for legacy reasons. In Azure stack as well, Subscription is not modelled as ARM resource for azure consistency. + where: + - $.definitions.Subscription.properties + - $.definitions.PlanAcquisition.properties + - $.definitions.Location.properties + + - suppress: RequiredPropertiesMissingInResourceModel + reason: Subscription is not modelled as ARM resource in azure for legacy reasons. In Azure stack as well, Subscription is not modelled as ARM resource for azure consistency. + where: + - $.definitions.Subscription + - $.definitions.PlanAcquisition + - $.definitions.Location + + - suppress: OperationIdNounVerb + reason: Subscriptions is both the name of the module and the operation action name. + where: + - $.paths["/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/moveSubscriptions"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/providers/Microsoft.Subscriptions.Admin/validateMoveSubscriptions"].post.operationId +``` + +### Tag: package-2015-11-01 + +These settings apply only when `--tag=package-2015-11-01` is specified on the command line. + +``` yaml $(tag) == 'package-2015-11-01' +input-file: + - Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json + - Microsoft.Subscriptions.Admin/preview/2015-11-01/AcquiredPlan.json + - Microsoft.Subscriptions.Admin/preview/2015-11-01/DelegatedProvider.json + - Microsoft.Subscriptions.Admin/preview/2015-11-01/DelegatedProviderOffer.json + - Microsoft.Subscriptions.Admin/preview/2015-11-01/DirectoryTenant.json + - Microsoft.Subscriptions.Admin/preview/2015-11-01/Location.json + - Microsoft.Subscriptions.Admin/preview/2015-11-01/Offer.json + - Microsoft.Subscriptions.Admin/preview/2015-11-01/OfferDelegation.json + - Microsoft.Subscriptions.Admin/preview/2015-11-01/Plan.json + - Microsoft.Subscriptions.Admin/preview/2015-11-01/Quota.json +``` + +--- +# Code Generation + +## C# + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.AzureStack.Management.Subscriptions.Admin + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/Generated + clear-output-folder: true +``` \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/update/readme.md b/specification/azsadmin/resource-manager/update/readme.md index 8494a12de794..8813bb6a9b29 100644 --- a/specification/azsadmin/resource-manager/update/readme.md +++ b/specification/azsadmin/resource-manager/update/readme.md @@ -33,6 +33,7 @@ These settings apply only when `--tag=package-2016-05-01` is specified on the co ``` yaml $(tag) == 'package-2016-05-01' input-file: + - "Microsoft.Update.Admin/preview/2016-05-01/Update.json" - "Microsoft.Update.Admin/preview/2016-05-01/Updates.json" - "Microsoft.Update.Admin/preview/2016-05-01/UpdateLocations.json" - "Microsoft.Update.Admin/preview/2016-05-01/UpdateRuns.json" diff --git a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Offer.json b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Offer.json new file mode 100644 index 000000000000..4d50a19d307e --- /dev/null +++ b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Offer.json @@ -0,0 +1,193 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-11-01", + "title": "SubscriptionClient", + "description": "The User Subscription Management Client." + }, + "host": "management.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/delegatedProviders/{delegatedProviderId}/offers": { + "get": { + "x-ms-examples": { + "Get the list of offers.": { + "$ref": "./examples/DelegatedProviderOffer/List.json" + } + }, + "description": "Get the list of offers for the specified delegated provider.", + "tags": [ + "DelegatedProviderOffers" + ], + "operationId": "DelegatedProviderOffers_List", + "parameters": [ + { + "name": "delegatedProviderId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the delegated provider." + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferList" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/delegatedProviders/{delegatedProviderId}/offers/{offerName}": { + "get": { + "x-ms-examples": { + "Get the specified offer name.": { + "$ref": "./examples/DelegatedProviderOffer/Get.json" + } + }, + "description": "Get the specified offer for the delegated provider.", + "tags": [ + "DelegatedProviderOffers" + ], + "operationId": "DelegatedProviderOffers_Get", + "parameters": [ + { + "name": "delegatedProviderId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the delegated provider." + }, + { + "name": "offerName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the offer." + }, + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Offer" + } + } + } + } + }, + "/offers": { + "get": { + "x-ms-examples": { + "Get the list of public offers for the root provider.": { + "$ref": "./examples/Offer/List.json" + } + }, + "description": "Get the list of public offers for the root provider.", + "tags": [ + "Offers" + ], + "operationId": "Offers_List", + "parameters": [ + { + "$ref": "Subscriptions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Offer": { + "description": "Represents an offering of services against which a subscription can be created.", + "type": "object", + "properties": { + "displayName": { + "description": "Display name of offer.", + "type": "string" + }, + "description": { + "description": "Description of offer.", + "type": "string" + }, + "name": { + "description": "The name of the offer.", + "type": "string" + }, + "id": { + "description": "The offer ID", + "type": "string" + } + } + }, + "OfferList": { + "description": "List of public offers.", + "type": "object", + "properties": { + "value": { + "description": "List of public offers.", + "type": "array", + "items": { + "$ref": "#/definitions/Offer" + } + }, + "nextLink": { + "type": "string", + "description": "URI to next page." + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "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/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Subscriptions.json b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Subscriptions.json new file mode 100644 index 000000000000..9a37b4ff166f --- /dev/null +++ b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Subscriptions.json @@ -0,0 +1,377 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-11-01", + "title": "SubscriptionClient", + "description": "The User Subscription Management Client." + }, + "host": "management.local.azurestack.external", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/subscriptions": { + "get": { + "x-ms-examples": { + "Get the list of subscriptions.": { + "$ref": "./examples/Subscriptions/List.json" + } + }, + "description": "Get the list of subscriptions.", + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}": { + "get": { + "x-ms-examples": { + "Get the specified subscription.": { + "$ref": "./examples/Subscriptions/Get.json" + } + }, + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_Get", + "description": "Gets details about particular subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Subscription" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or updates a subscription": { + "$ref": "./examples/Subscriptions/Create.json" + } + }, + "description": "Create or updates a subscription.", + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/NewSubscriptionParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Subscription" + } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Subscription" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the specifed subscription": { + "$ref": "./examples/Subscriptions/Delete.json" + } + }, + "description": "Delete the specifed subscription.", + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/providers/Microsoft.Subscriptions/operations": { + "get": { + "x-ms-examples": { + "Get the list of Operations.": { + "$ref": "./examples/Subscriptions/Operations.json" + } + }, + "description": "Get the list of Operations.", + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + } + } + } + } + }, + "definitions": { + "Resource": { + "description": "Base Resource Object", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "description": "URI of the resource.", + "type": "string" + }, + "name": { + "readOnly": true, + "description": "Name of the resource.", + "type": "string" + }, + "type": { + "readOnly": true, + "description": "Type of resource.", + "type": "string" + }, + "location": { + "description": "Location of the resource", + "type": "string" + }, + "tags": { + "readOnly": true, + "description": "List of key-value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "Subscription": { + "description": "List of supported operations.", + "type": "object", + "properties": { + "displayName": { + "description": "Subscription name.", + "type": "string" + }, + "id": { + "description": "Fully qualified identifier.", + "type": "string" + }, + "offerId": { + "description": "Identifier of the offer under the scope of a delegated provider.", + "type": "string" + }, + "state": { + "description": "Subscription state.", + "$ref": "#/definitions/SubscriptionState" + }, + "subscriptionId": { + "description": "Subscription identifier.", + "type": "string" + }, + "tenantId": { + "description": "Directory tenant identifier.", + "type": "string" + } + } + }, + "SubscriptionList": { + "description": "List of subscriptions.", + "properties": { + "value": { + "type": "array", + "description": "Subscription definition.", + "items": { + "$ref": "#/definitions/Subscription" + } + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string" + } + } + }, + "SubscriptionState": { + "description": "Subscription notification state.", + "type": "string", + "enum": [ + "NotDefined", + "Enabled", + "Warned", + "PastDue", + "Disabled", + "Deleted" + ], + "x-ms-enum": { + "name": "SubscriptionState", + "modelAsString": true + } + }, + "Operation": { + "description": "Supported REST operation.", + "type": "object", + "properties": { + "display": { + "description": "Display information for the operation.", + "type": "object", + "properties": { + "description": { + "description": "Description for the operation.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Display name of the operation.", + "type": "string", + "readOnly": true + }, + "provider": { + "description": "Resource provider display name.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource type display name related to the operation.", + "type": "string", + "readOnly": true + } + } + }, + "name": { + "description": "Name of the operation being performed on an object.", + "type": "string", + "readOnly": true + }, + "origin": { + "description": "Origin for the operation.", + "type": "string", + "readOnly": true + } + } + }, + "OperationList": { + "description": "List of supported operations.", + "type": "object", + "properties": { + "value": { + "description": "List of supported operations.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string", + "default": "2015-11-01" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the subscription.", + "x-ms-parameter-location": "method" + }, + "NewSubscriptionParameter": { + "description": "Subscription parameter.", + "name": "newSubscription", + "in": "body", + "schema": { + "$ref": "#/definitions/Subscription" + }, + "required": true, + "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/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/DelegatedProviderOffer/Get.json b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/DelegatedProviderOffer/Get.json new file mode 100644 index 000000000000..7c6b22a981e6 --- /dev/null +++ b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/DelegatedProviderOffer/Get.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "delegatedProviderId": "0af9c33b-f7ac-4161-add5-17b2f0b6a669", + "api-version": "2015-11-01", + "offerName": "TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b" + }, + "responses": { + "200": { + "body": { + "id": "/delegatedProviders/default/offers/TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b", + "name": "TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b", + "displayName": "TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b", + "description": "" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/DelegatedProviderOffer/List.json b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/DelegatedProviderOffer/List.json new file mode 100644 index 000000000000..51815790d72b --- /dev/null +++ b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/DelegatedProviderOffer/List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "delegatedProviderId": "0af9c33b-f7ac-4161-add5-17b2f0b6a669", + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/delegatedProviders/default/offers/TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b", + "name": "TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b", + "displayName": "TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b", + "description": "" + }, + { + "id": "/delegatedProviders/default/offers/TestOffer-c2e9d93a-d8a2-4ec9-970e-3dcd8c47c525", + "name": "TestOffer-c2e9d93a-d8a2-4ec9-970e-3dcd8c47c525", + "displayName": "TestOffer-c2e9d93a-d8a2-4ec9-970e-3dcd8c47c525", + "description": "" + }, + { + "id": "/delegatedProviders/default/offers/TestOffer-37097402-a512-40c2-b779-f0b3a54e5596", + "name": "TestOffer-37097402-a512-40c2-b779-f0b3a54e5596", + "displayName": "TestOffer-37097402-a512-40c2-b779-f0b3a54e5596", + "description": "" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Offer/Get.json b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Offer/Get.json new file mode 100644 index 000000000000..0df2f27e3fde --- /dev/null +++ b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Offer/Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "delegatedProviderId": "0af9c33b-f7ac-4161-add5-17b2f0b6a669", + "api-version": "2015-11-01", + "offerName": "TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/delegatedProviders/default/offers/TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b", + "name": "TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b", + "displayName": "TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b", + "description": "" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Offer/List.json b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Offer/List.json new file mode 100644 index 000000000000..ba63f9221620 --- /dev/null +++ b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Offer/List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/delegatedProviders/default/offers/TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b", + "name": "TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b", + "displayName": "TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b", + "description": "" + }, + { + "id": "/delegatedProviders/default/offers/TestOffer-c2e9d93a-d8a2-4ec9-970e-3dcd8c47c525", + "name": "TestOffer-c2e9d93a-d8a2-4ec9-970e-3dcd8c47c525", + "displayName": "TestOffer-c2e9d93a-d8a2-4ec9-970e-3dcd8c47c525", + "description": "" + }, + { + "id": "/delegatedProviders/default/offers/TestOffer-37097402-a512-40c2-b779-f0b3a54e5596", + "name": "TestOffer-37097402-a512-40c2-b779-f0b3a54e5596", + "displayName": "TestOffer-37097402-a512-40c2-b779-f0b3a54e5596", + "description": "" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Create.json b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Create.json new file mode 100644 index 000000000000..113f1cc7bc50 --- /dev/null +++ b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Create.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "newSubscription": { + "properties": { + "displayName": "Test User-user1@contoso.com", + "id": "", + "offerId": "/delegatedProviders/default/offers/TestOffer-0892f99c-8d1c-48d1-a2b3-128a931afc09", + "state": "Enabled", + "subscriptionId": "a7aeb2dd-1b1d-458c-a3dc-09070c2ece5e", + "tenantId": "" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/a7aeb2dd-1b1d-458c-a3dc-09070c2ece5e", + "subscriptionId": "a7aeb2dd-1b1d-458c-a3dc-09070c2ece5e", + "displayName": "Test User-user1@contoso.com", + "tenantId": "1e64bce5-9f3b-4add-8be8-e550e05014d0", + "offerId": "/delegatedProviders/default/offers/TestOffer-0892f99c-8d1c-48d1-a2b3-128a931afc09", + "state": "Enabled" + } + }, + "200": { + "body": { + "id": "/subscriptions/a7aeb2dd-1b1d-458c-a3dc-09070c2ece5e", + "subscriptionId": "a7aeb2dd-1b1d-458c-a3dc-09070c2ece5e", + "displayName": "Test User-user1@contoso.com", + "tenantId": "1e64bce5-9f3b-4add-8be8-e550e05014d0", + "offerId": "/delegatedProviders/default/offers/TestOffer-0892f99c-8d1c-48d1-a2b3-128a931afc09", + "state": "Enabled" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Delete.json b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Delete.json new file mode 100644 index 000000000000..6c627e6a1d6d --- /dev/null +++ b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01", + "subscription": "test" + }, + "responses": { + "200": { + }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Get.json b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Get.json new file mode 100644 index 000000000000..34fff6be297e --- /dev/null +++ b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Get.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "7d3c5374-0180-4743-b468-d87bec909693", + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": { + "offerId": "/delegatedProviders/default/offers/TestOffer-c2e9d93a-d8a2-4ec9-970e-3dcd8c47c525", + "id": "/subscriptions/7d3c5374-0180-4743-b468-d87bec909693", + "subscriptionId": "7d3c5374-0180-4743-b468-d87bec909693", + "tenantId": "1e64bce5-9f3b-4add-8be8-e550e05014d0", + "displayName": "Test User-user1@msazurestack.onmicrosoft.com", + "state": "Disabled" + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/List.json b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/List.json new file mode 100644 index 000000000000..8228a6fc520d --- /dev/null +++ b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": [ + { + "offerId": "/delegatedProviders/default/offers/TestOffer-def2432b-81ef-4480-9211-c18e808c3d1b", + "id": "/subscriptions/17c22a2f-9a79-4f90-a34c-aa8d9b942071", + "subscriptionId": "17c22a2f-9a79-4f90-a34c-aa8d9b942071", + "tenantId": "1e64bce5-9f3b-4add-8be8-e550e05014d0", + "displayName": "Test User-user1@contoso.com", + "state": "Enabled" + }, + { + "offerId": "/delegatedProviders/default/offers/TestOffer-c2e9d93a-d8a2-4ec9-970e-3dcd8c47c525", + "id": "/subscriptions/7d3c5374-0180-4743-b468-d87bec909693", + "subscriptionId": "7d3c5374-0180-4743-b468-d87bec909693", + "tenantId": "1e64bce5-9f3b-4add-8be8-e550e05014d0", + "displayName": "Test User-user1@contoso.com", + "state": "Disabled" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Operations.json b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Operations.json new file mode 100644 index 000000000000..53f2ca37206c --- /dev/null +++ b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Operations.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "location": "local", + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": { + } + } + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/user-subscriptions/readme.md b/specification/azsadmin/resource-manager/user-subscriptions/readme.md new file mode 100644 index 000000000000..24dd9dfdc541 --- /dev/null +++ b/specification/azsadmin/resource-manager/user-subscriptions/readme.md @@ -0,0 +1,100 @@ +# Subscriptions Admin + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Subscriptions Admin. + +--- +## Getting Started +To build the SDK for Subscriptions 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 Subscriptions API. + +``` yaml +title: SubscriptionClient +description: Subscription Management Client +openapi-type: arm +tag: package-2015-11-01 +``` + +## Suppression +``` yaml +directive: + - suppress: XmsResourceInPutResponse + reason: Subscription is not modelled as ARM resource in azure for legacy reasons. In Azure stack as well, Subscription is not modelled as ARM resource for azure consistency + where: + - $.paths["/subscriptions/{subscriptionId}"].put + + - suppress: SubscriptionIdParameterInOperations + reason: Subscription is the main resource in the API spec and it should not be masked in global parameters. + where: + - $.paths["/subscriptions/{subscriptionId}"].get.parameters[0] + - $.paths["/subscriptions/{subscriptionId}"].put.parameters[0] + - $.paths["/subscriptions/{subscriptionId}"].delete.parameters[0] + + - suppress: BodyTopLevelProperties + reason: Subscription is not modelled as ARM resource in azure for legacy reasons. In Azure stack as well, Subscription is not modelled as ARM resource for azure consistency. + where: + - $.definitions.Subscription.properties + + - suppress: RequiredPropertiesMissingInResourceModel + reason: Subscription is not modelled as ARM resource in azure for legacy reasons. In Azure stack as well, Subscription is not modelled as ARM resource for azure consistency. + where: + - $.definitions.Subscription + +``` + +### Tag: package-2015-11-01 + +These settings apply only when `--tag=package-2015-11-01` is specified on the command line. + +``` yaml $(tag) == 'package-2015-11-01' +input-file: + - Microsoft.Subscriptions/preview/2015-11-01/Subscriptions.json + - Microsoft.Subscriptions/preview/2015-11-01/Offer.json +``` + +--- +# Code Generation + +## C# + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.AzureStack.Management.Subscription + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. + +``` yaml $(python) +python: + # override the default output folder + output-folder: $(output-folder)/python + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 +``` + +### Tag: package-2015-11-01 and python + +These settings apply only when `--tag=package-2015-11-01 --python` is specified on the command line. + +``` yaml $(tag) == 'package-2015-11-01' && $(python) +namespace: azure.mgmt.subscriptions.v2015_06_01_preview +``` diff --git a/specification/azurestack/resource-manager/readme.md b/specification/azurestack/resource-manager/readme.md index 73b67b3de297..515cc54d8cab 100644 --- a/specification/azurestack/resource-manager/readme.md +++ b/specification/azurestack/resource-manager/readme.md @@ -71,7 +71,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go ``` @@ -138,11 +138,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.azurestack +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-azurestack +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-06-01 +``` + +### Tag: package-2017-06-01 and java + +These settings apply only when `--tag=package-2017-06-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-06-01' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.azurestack - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-azurestack + namespace: com.microsoft.azure.management.azurestack.v2017_06_01 + output-folder: $(azure-libraries-for-java-folder)/azurestack/resource-manager/v2017_06_01 +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/BatchService.json index 6cdbb3d1f591..d474f05a9601 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/BatchService.json @@ -650,7 +650,7 @@ "Pool get lifetime statistics": { "$ref": "./examples/PoolGetLifetimeStatistics.json" } }, "summary": "Gets lifetime summary statistics for all of the pools in the specified account.", - "description": "Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.", + "description": "Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.", "x-ms-request-id": "request-id", "parameters": [ { @@ -750,7 +750,7 @@ "Job get lifetime statistics": { "$ref": "./examples/JobGetLifetimeStatistics.json" } }, "summary": "Gets lifetime summary statistics for all of the jobs in the specified account.", - "description": "Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics.", + "description": "Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.", "x-ms-request-id": "request-id", "parameters": [ { @@ -5037,7 +5037,7 @@ "Job terminate": { "$ref": "./examples/JobTerminate.json" } }, "summary": "Terminates the specified job, marking it as completed.", - "description": "When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any active or running tasks associated with the job, and runs any required Job Release tasks. The job then moves into the completed state.", + "description": "When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.", "x-ms-request-id": "request-id", "parameters": [ { @@ -11447,7 +11447,7 @@ } }, "title": "The definition of the user identity under which the task is run.", - "description": "Specify either the userName or autoUser property, but not both." + "description": "Specify either the userName or autoUser property, but not both. On CloudServiceConfiguration pools, this user is logged in with the INTERACTIVE flag. On Windows VirtualMachineConfiguration pools, this user is logged in with the BATCH flag." }, "LinuxUserConfiguration": { "properties": { @@ -11513,7 +11513,7 @@ "type": "integer", "format": "int32", "title": "The maximum number of times the task may be retried. The Batch service retries a task if its exit code is nonzero.", - "description": "Note that this value specifically controls the number of retries. 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." + "description": "Note that this value specifically controls the number of retries for the task executable due to a nonzero exit code. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task after the first attempt. If the maximum retry count is -1, the Batch service retries the task without limit. Resource files and application packages are only downloaded again if the task is retried on a new compute node." } }, "title": "Execution constraints to apply to a task." @@ -11533,7 +11533,7 @@ "commandLine": { "type": "string", "title": "The command line of the Job Manager task.", - "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux." + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." }, "containerSettings": { "$ref": "#/definitions/TaskContainerSettings", @@ -11546,7 +11546,7 @@ "$ref": "#/definitions/ResourceFile" }, "title": "A list of files that the Batch service will download to the compute node before running the command line.", - "description": "Files listed under this element are located in the task's working directory." + "description": "Files listed under this element are located in the task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." }, "outputFiles": { "type": "array", @@ -11598,12 +11598,12 @@ "allowLowPriorityNode": { "type": "boolean", "title": "Whether the Job Manager task may run on a low-priority compute node.", - "description": "The default value is false." + "description": "The default value is true." } }, "required": [ "id", "commandLine" ], "title": "Specifies details of a Job Manager task.", - "description": "The Job Manager task is automatically started when the job is created. The Batch service tries to schedule the Job Manager task before any other tasks in the job. When shrinking a pool, the Batch service tries to preserve compute nodes where Job Manager tasks are running for as long as possible (that is, nodes running 'normal' tasks are removed before nodes running Job Manager tasks). When a Job Manager task fails and needs to be restarted, the system tries to schedule it at the highest priority. If there are no idle nodes available, the system may terminate one of the running tasks in the pool and return it to the queue in order to make room for the Job Manager task to restart. Note that a Job Manager task in one job does not have priority over tasks in other jobs. Across jobs, only job level priorities are observed. For example, if a Job Manager in a priority 0 job needs to be restarted, it will not displace tasks of a priority 1 job." + "description": "The Job Manager task is automatically started when the job is created. The Batch service tries to schedule the Job Manager task before any other tasks in the job. When shrinking a pool, the Batch service tries to preserve compute nodes where Job Manager tasks are running for as long as possible (that is, nodes running 'normal' tasks are removed before nodes running Job Manager tasks). When a Job Manager task fails and needs to be restarted, the system tries to schedule it at the highest priority. If there are no idle nodes available, the system may terminate one of the running tasks in the pool and return it to the queue in order to make room for the Job Manager task to restart. Note that a Job Manager task in one job does not have priority over tasks in other jobs. Across jobs, only job level priorities are observed. For example, if a Job Manager in a priority 0 job needs to be restarted, it will not displace tasks of a priority 1 job. Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing." }, "JobPreparationTask": { "properties": { @@ -11615,7 +11615,7 @@ "commandLine": { "type": "string", "title": "The command line of the Job Preparation task.", - "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux." + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." }, "containerSettings": { "$ref": "#/definitions/TaskContainerSettings", @@ -11628,7 +11628,7 @@ "$ref": "#/definitions/ResourceFile" }, "title": "A list of files that the Batch service will download to the compute node before running the command line.", - "description": "Files listed under this element are located in the task's working directory." + "description": "Files listed under this element are located in the task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." }, "environmentSettings": { "type": "array", @@ -11659,7 +11659,7 @@ }, "required": [ "commandLine" ], "title": "A Job Preparation task to run before any tasks of the job on any given compute node.", - "description": "You can use Job Preparation to prepare a compute node to run tasks for the job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the tasks in the job. The Job Preparation task can download these common resource files to the shared location on the compute node. (AZ_BATCH_NODE_ROOT_DIR\\shared), or starting a local service on the compute node so that all tasks of that job can communicate with it. If the Job Preparation task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run tasks of this job on the compute node. The node remains ineligible to run tasks of this job until it is reimaged. The node remains active and can be used for other jobs. The Job Preparation task can run multiple times on the same compute node. Therefore, you should write the Job Preparation task to handle re-execution. If the compute node is rebooted, the Job Preparation task is run again on the node before scheduling any other task of the job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation task did not previously complete. If the compute node is reimaged, the Job Preparation task is run again before scheduling any task of the job." + "description": "You can use Job Preparation to prepare a compute node to run tasks for the job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the tasks in the job. The Job Preparation task can download these common resource files to the shared location on the compute node. (AZ_BATCH_NODE_ROOT_DIR\\shared), or starting a local service on the compute node so that all tasks of that job can communicate with it. If the Job Preparation task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run tasks of this job on the compute node. The node remains ineligible to run tasks of this job until it is reimaged. The node remains active and can be used for other jobs. The Job Preparation task can run multiple times on the same compute node. Therefore, you should write the Job Preparation task to handle re-execution. If the compute node is rebooted, the Job Preparation task is run again on the node before scheduling any other task of the job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation task did not previously complete. If the compute node is reimaged, the Job Preparation task is run again before scheduling any task of the job. Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing." }, "JobReleaseTask": { "properties": { @@ -11671,7 +11671,7 @@ "commandLine": { "type": "string", "title": "The command line of the Job Release task.", - "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux." + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." }, "containerSettings": { "$ref": "#/definitions/TaskContainerSettings", @@ -11683,7 +11683,7 @@ "items": { "$ref": "#/definitions/ResourceFile" }, - "title": "A list of files that the Batch service will download to the compute node before running the command line.", + "title": "A list of files that the Batch service will download to the compute node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", "description": "Files listed under this element are located in the task's working directory." }, "environmentSettings": { @@ -11747,7 +11747,7 @@ "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." + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." }, "containerSettings": { "$ref": "#/definitions/TaskContainerSettings", @@ -11759,7 +11759,7 @@ "items": { "$ref": "#/definitions/ResourceFile" }, - "title": "A list of files that the Batch service will download to the compute node before running the command line.", + "title": "A list of files that the Batch service will download to the compute node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", "description": "Files listed under this element are located in the task's working directory." }, "environmentSettings": { @@ -11787,7 +11787,8 @@ } }, "required": [ "commandLine" ], - "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." + "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": "Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing." }, "CertificateReference": { "properties": { @@ -11892,7 +11893,7 @@ "vmSize": { "type": "string", "title": "The size of the virtual machines in the pool. All virtual machines in a pool are the same size.", - "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." }, "cloudServiceConfiguration": { "$ref": "#/definitions/CloudServiceConfiguration", @@ -12315,7 +12316,7 @@ }, "stats": { "$ref": "#/definitions/JobScheduleStatistics", - "title": "The lifetime resource usage statistics for the job schedule." + "title": "The lifetime resource usage statistics for the job schedule. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes." } }, "title": "A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job." @@ -12541,7 +12542,7 @@ }, "stats": { "$ref": "#/definitions/JobStatistics", - "title": "Resource usage statistics for the entire lifetime of the job." + "title": "Resource usage statistics for the entire lifetime of the job. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes." } }, "title": "An Azure Batch job." @@ -13361,7 +13362,7 @@ "vmSize": { "type": "string", "title": "The size of virtual machines in the pool. All virtual machines in a pool are the same size.", - "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." }, "cloudServiceConfiguration": { "$ref": "#/definitions/CloudServiceConfiguration", @@ -13490,7 +13491,7 @@ }, "stats": { "$ref": "#/definitions/PoolStatistics", - "title": "Utilization and resource usage statistics for the entire lifetime of the pool." + "title": "Utilization and resource usage statistics for the entire lifetime of the pool. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes." } }, "title": "A pool in the Azure Batch service." @@ -13510,7 +13511,7 @@ "vmSize": { "type": "string", "title": "The size of virtual machines in the pool. All virtual machines in a pool are the same size.", - "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." }, "cloudServiceConfiguration": { "$ref": "#/definitions/CloudServiceConfiguration", @@ -13776,7 +13777,7 @@ "$ref": "#/definitions/ResourceFile" }, "title": "A list of files that the Batch service will download before running the coordination command line.", - "description": "The difference between common resource files and task resource files is that common resource files are downloaded for all subtasks including the primary, whereas task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the task working directory, but instead are downloaded to the task root directory (one directory above the working directory)." + "description": "The difference between common resource files and task resource files is that common resource files are downloaded for all subtasks including the primary, whereas task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the task working directory, but instead are downloaded to the task root directory (one directory above the working directory). There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." } }, "required": [ "coordinationCommandLine" ], @@ -13939,7 +13940,7 @@ "commandLine": { "type": "string", "title": "The command line of the task.", - "description": "For multi-instance tasks, the command line is executed as the primary task, after the primary task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux." + "description": "For multi-instance tasks, the command line is executed as the primary task, after the primary task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." }, "containerSettings": { "$ref": "#/definitions/TaskContainerSettings", @@ -13952,7 +13953,7 @@ "$ref": "#/definitions/ResourceFile" }, "title": "A list of files that the Batch service will download to the compute node before running the command line.", - "description": "For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary task is executed." + "description": "For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." }, "outputFiles": { "type": "array", @@ -14017,7 +14018,8 @@ "$ref": "#/definitions/AuthenticationTokenSettings" } }, - "title": "An Azure Batch task." + "title": "An Azure Batch task.", + "description": "Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing." }, "TaskAddParameter": { "properties": { @@ -14034,7 +14036,7 @@ "commandLine": { "type": "string", "title": "The command line of the task.", - "description": "For multi-instance tasks, the command line is executed as the primary task, after the primary task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux." + "description": "For multi-instance tasks, the command line is executed as the primary task, after the primary task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." }, "containerSettings": { "$ref": "#/definitions/TaskContainerSettings", @@ -14051,7 +14053,7 @@ "$ref": "#/definitions/ResourceFile" }, "title": "A list of files that the Batch service will download to the compute node before running the command line.", - "description": "For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary task is executed." + "description": "For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." }, "outputFiles": { "type": "array", @@ -14106,7 +14108,8 @@ } }, "required": [ "id", "commandLine" ], - "title": "An Azure Batch task to add." + "title": "An Azure Batch task to add.", + "description": "Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing." }, "TaskAddCollectionParameter": { "properties": { @@ -14117,7 +14120,7 @@ }, "maxItems": 100, "title": "The collection of tasks to add.", - "description": "The total serialized size of this collection must be less than 4MB. If it is greater than 4MB (for example if each task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer tasks." + "description": "The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer tasks." } }, "required": [ "value" ], @@ -14553,7 +14556,7 @@ "vmSize": { "type": "string", "title": "The size of the virtual machine hosting the compute node.", - "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." }, "totalTasksRun": { "type": "integer", @@ -15876,6 +15879,11 @@ "format": "int32", "title": "The number of nodes in the startTaskFailed state." }, + "leavingPool": { + "type": "integer", + "format": "int32", + "title": "The number of nodes in the leavingPool state." + }, "unknown": { "type": "integer", "format": "int32", @@ -15907,6 +15915,7 @@ "running", "starting", "startTaskFailed", + "leavingPool", "unknown", "unusable", "waitingForStartTask", diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/examples/AccountListPoolNodeCounts.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/examples/AccountListPoolNodeCounts.json index 2c46d75afdc1..1e7c4371b0bb 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/examples/AccountListPoolNodeCounts.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/examples/AccountListPoolNodeCounts.json @@ -13,6 +13,7 @@ "dedicated": { "creating": 0, "idle": 0, + "leavingpool": 0, "offline": 0, "preempted": 0, "rebooting": 0, @@ -28,6 +29,7 @@ "lowPriority": { "creating": 0, "idle": 0, + "leavingpool": 0, "offline": 0, "preempted": 0, "rebooting": 0, @@ -46,6 +48,7 @@ "dedicated": { "creating": 0, "idle": 1, + "leavingpool": 0, "offline": 3, "preempted": 0, "rebooting": 0, @@ -61,6 +64,7 @@ "lowPriority": { "creating": 0, "idle": 0, + "leavingpool": 0, "offline": 0, "preempted": 0, "rebooting": 0, @@ -79,6 +83,7 @@ "dedicated": { "creating": 0, "idle": 5, + "leavingpool": 0, "offline": 0, "preempted": 0, "rebooting": 0, @@ -94,6 +99,7 @@ "lowPriority": { "creating": 7, "idle": 0, + "leavingpool": 0, "offline": 0, "preempted": 0, "rebooting": 0, diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2017-09-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2017-09-01/BatchManagement.json index 140f574b9aa1..64d3deab5eb2 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/stable/2017-09-01/BatchManagement.json +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2017-09-01/BatchManagement.json @@ -2890,7 +2890,7 @@ "items": { "$ref": "#/definitions/DataDisk" }, - "title": "The configuration for data disks attached to the comptue nodes in the pool.", + "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": { diff --git a/specification/batch/resource-manager/readme.md b/specification/batch/resource-manager/readme.md index 43751c91b87a..4f9f7aa42027 100644 --- a/specification/batch/resource-manager/readme.md +++ b/specification/batch/resource-manager/readme.md @@ -90,9 +90,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_batch'] ``` @@ -203,11 +206,74 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.batch +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-batch +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-12 + - tag: package-2017-09 + - tag: package-2017-01 + - tag: package-2017-05 +``` + +### Tag: package-2015-12 and java + +These settings apply only when `--tag=package-2015-12 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-12' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.batch - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-batch -``` \ No newline at end of file + namespace: com.microsoft.azure.management.batch.v2015_12_01 + output-folder: $(azure-libraries-for-java-folder)/batch/resource-manager/v2015_12_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-09 and java + +These settings apply only when `--tag=package-2017-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.batch.v2017_09_01 + output-folder: $(azure-libraries-for-java-folder)/batch/resource-manager/v2017_09_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-01 and java + +These settings apply only when `--tag=package-2017-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.batch.v2017_01_01 + output-folder: $(azure-libraries-for-java-folder)/batch/resource-manager/v2017_01_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-05 and java + +These settings apply only when `--tag=package-2017-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.batch.v2017_05_01 + output-folder: $(azure-libraries-for-java-folder)/batch/resource-manager/v2017_05_01 +regenerate-manager: true +generate-interface: true +``` + +` diff --git a/specification/batch/resource-manager/readme.ruby.md b/specification/batch/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..eb5052b24524 --- /dev/null +++ b/specification/batch/resource-manager/readme.ruby.md @@ -0,0 +1,59 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_batch +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2017-09 + - tag: package-2017-05 + - tag: package-2017-01 + - tag: package-2015-12 +``` + +### Tag: package-2017-09 and ruby + +These settings apply only when `--tag=package-2017-09 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-09' && $(ruby) +namespace: "Azure::Batch::Mgmt::V2017_09_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_batch/lib +``` + +### Tag: package-2017-05 and ruby + +These settings apply only when `--tag=package-2017-05 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-05' && $(ruby) +namespace: "Azure::Batch::Mgmt::V2017_05_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_batch/lib +``` + +### Tag: package-2017-01 and ruby + +These settings apply only when `--tag=package-2017-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-01' && $(ruby) +namespace: "Azure::Batch::Mgmt::V2017_01_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_batch/lib +``` + +### Tag: package-2015-12 and ruby + +These settings apply only when `--tag=package-2015-12 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-12' && $(ruby) +namespace: "Azure::Batch::Mgmt::V2015_12_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_batch/lib +``` diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/BatchAI.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/BatchAI.json new file mode 100644 index 000000000000..1d9b509e78b9 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/BatchAI.json @@ -0,0 +1,3949 @@ +{ + "swagger": "2.0", + "info": { + "title": "BatchAI", + "description": "The Azure BatchAI Management API.", + "version": "2018-05-01", + "x-ms-code-generation-settings": { + "name": "BatchAIManagementClient" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.BatchAI/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists available operations for the Microsoft.BatchAI provider.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Create or update cluster": { + "$ref": "./examples/ListOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.BatchAI/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usages_List", + "description": "Gets the current usage information as well as limits for Batch AI resources for given subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Create or update cluster": { + "$ref": "./examples/ListUsages.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.BatchAI/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_List", + "description": "Gets a list of Workspaces associated with the given subscription.", + "parameters": [ + { + "$ref": "#/parameters/MaxResultsParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a formatted list of workspaces and their properties.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List file servers": { + "$ref": "./examples/ListWorkspace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_ListByResourceGroup", + "description": "Gets a list of Workspaces within the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MaxResultsParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of workspaces within the resource group.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List workspaces": { + "$ref": "./examples/ListWorkspaceByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}": { + "put": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Create", + "description": "Creates a Workspace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceCreateParameters" + }, + "description": "Workspace creation parameters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the workspace entity.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "The operation will be completed asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a workspace": { + "$ref": "./examples/PutWorkspace.json" + } + } + }, + "patch": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Update", + "description": "Updates properties of a Workspace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceUpdateParameters" + }, + "description": "Additional parameters for workspace update." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Workspace entity.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update workspace tags": { + "$ref": "./examples/PatchWorkspace.json" + } + } + }, + "delete": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Delete", + "description": "Deletes a Workspace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a workspace": { + "$ref": "./examples/DeleteWorkspace.json" + } + } + }, + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Get", + "description": "Gets information about a Workspace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains information about the Workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a workspace information": { + "$ref": "./examples/GetWorkspace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/experiments": { + "get": { + "tags": [ + "Experiment" + ], + "operationId": "Experiments_ListByWorkspace", + "description": "Gets a list of Experiments within the specified Workspace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/MaxResultsParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of experiments within the workspace.", + "schema": { + "$ref": "#/definitions/ExperimentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List experiments": { + "$ref": "./examples/ListExperimentByWorkspace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/experiments/{experimentName}": { + "put": { + "tags": [ + "Experiment" + ], + "operationId": "Experiments_Create", + "description": "Creates an Experiment.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ExperimentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the experiment entity.", + "schema": { + "$ref": "#/definitions/Experiment" + } + }, + "202": { + "description": "The operation will be completed asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create an experiment": { + "$ref": "./examples/PutExperiment.json" + } + } + }, + "delete": { + "tags": [ + "Experiment" + ], + "operationId": "Experiments_Delete", + "description": "Deletes an Experiment.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ExperimentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete an experiment": { + "$ref": "./examples/DeleteExperiment.json" + } + } + }, + "get": { + "tags": [ + "Experiment" + ], + "operationId": "Experiments_Get", + "description": "Gets information about an Experiment.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ExperimentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains information about the experiment.", + "schema": { + "$ref": "#/definitions/Experiment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get an experiment information": { + "$ref": "./examples/GetExperiment.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/experiments/{experimentName}/jobs": { + "get": { + "tags": [ + "Job" + ], + "operationId": "Jobs_ListByExperiment", + "description": "Gets a list of Jobs within the specified Experiment.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ExperimentNameParameter" + }, + { + "$ref": "#/parameters/MaxResultsParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of ExperimentJob entities associated with the experiment.", + "schema": { + "$ref": "#/definitions/JobListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List jobs in an experiment": { + "$ref": "./examples/ListJobByExperiment.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/experiments/{experimentName}/jobs/{jobName}": { + "put": { + "tags": [ + "Job" + ], + "operationId": "Jobs_Create", + "description": "Creates a Job in the given Experiment.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ExperimentNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobCreateParameters" + }, + "description": "The parameters to provide for job creation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the job entity.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "The operation will be completed asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a job": { + "$ref": "./examples/PutJob.json" + } + } + }, + "delete": { + "tags": [ + "Job" + ], + "operationId": "Jobs_Delete", + "description": "Deletes a Job.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ExperimentNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a job": { + "$ref": "./examples/DeleteJob.json" + } + } + }, + "get": { + "tags": [ + "Job" + ], + "operationId": "Jobs_Get", + "description": "Gets information about a Job.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ExperimentNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Job entity.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get job's information": { + "$ref": "./examples/GetJob.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/experiments/{experimentName}/jobs/{jobName}/listOutputFiles": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Jobs_ListOutputFiles", + "description": "List all directories and files inside the given directory of the Job's output directory (if the output directory is on Azure File Share or Azure Storage Container).", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ExperimentNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "#/parameters/OutputDirectoryIdParameter" + }, + { + "$ref": "#/parameters/Directory" + }, + { + "$ref": "#/parameters/DownloadLinkExpiryParameter" + }, + { + "$ref": "#/parameters/MaxResultsParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of files.", + "schema": { + "$ref": "#/definitions/FileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List a job's files": { + "$ref": "./examples/ListOutputFiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/experiments/{experimentName}/jobs/{jobName}/listRemoteLoginInformation": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Jobs_ListRemoteLoginInformation", + "description": "Gets a list of currently existing nodes which were used for the Job execution. The returned information contains the node ID, its public IP and SSH port.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ExperimentNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains compute node remote login information.", + "schema": { + "$ref": "#/definitions/RemoteLoginInformationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get information about nodes which ran a job": { + "$ref": "./examples/JobListRemoteLoginInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/experiments/{experimentName}/jobs/{jobName}/terminate": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Jobs_Terminate", + "description": "Terminates a job.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ExperimentNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Terminate a job": { + "$ref": "./examples/TerminateJob.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/fileServers/{fileServerName}": { + "put": { + "tags": [ + "FileServer" + ], + "operationId": "FileServers_Create", + "description": "Creates a File Server in the given workspace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/FileServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FileServerCreateParameters" + }, + "description": "The parameters to provide for File Server creation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the file server entity.", + "schema": { + "$ref": "#/definitions/FileServer" + } + }, + "202": { + "description": "The operation will be completed asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a file server": { + "$ref": "./examples/PutFileServer.json" + } + } + }, + "delete": { + "tags": [ + "FileServer" + ], + "operationId": "FileServers_Delete", + "description": "Deletes a File Server.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/FileServerNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a file server": { + "$ref": "./examples/DeleteFileServer.json" + } + } + }, + "get": { + "tags": [ + "FileServer" + ], + "operationId": "FileServers_Get", + "description": "Gets information about a File Server.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/FileServerNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains information about the FileServer.", + "schema": { + "$ref": "#/definitions/FileServer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a file server's information": { + "$ref": "./examples/GetFileServer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/fileServers": { + "get": { + "tags": [ + "FileServer" + ], + "operationId": "FileServers_ListByWorkspace", + "description": "Gets a list of File Servers associated with the specified workspace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/MaxResultsParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of File Servers and their properties.", + "schema": { + "$ref": "#/definitions/FileServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of file servers": { + "$ref": "./examples/ListFileServerByWorkspace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/clusters/{clusterName}": { + "put": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_Create", + "description": "Creates a Cluster in the given Workspace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterCreateParameters" + }, + "description": "The parameters to provide for the Cluster creation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Cluster entity.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "The operation will be completed asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a cluster": { + "$ref": "./examples/PutCluster.json" + } + } + }, + "patch": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_Update", + "description": "Updates properties of a Cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdateParameters" + }, + "description": "Additional parameters for cluster update." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Cluster entity.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Resize a cluster": { + "$ref": "./examples/PatchCluster.json" + } + } + }, + "delete": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_Delete", + "description": "Deletes a Cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a cluster": { + "$ref": "./examples/DeleteCluster.json" + } + } + }, + "get": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_Get", + "description": "Gets information about a Cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains information about the Cluster.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a cluster's information": { + "$ref": "./examples/GetCluster.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/clusters/{clusterName}/listRemoteLoginInformation": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_ListRemoteLoginInformation", + "description": "Get the IP address, port of all the compute nodes in the Cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of IP addresses.", + "schema": { + "$ref": "#/definitions/RemoteLoginInformationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get remote login information for a cluster's nodes ": { + "$ref": "./examples/ClusterListRemoteLoginInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BatchAI/workspaces/{workspaceName}/clusters": { + "get": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_ListByWorkspace", + "description": "Gets information about Clusters associated with the given Workspace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/MaxResultsParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of Clusters and their properties.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of cluster in a workspace": { + "$ref": "./examples/ListClusterByWorkspace.json" + } + } + } + } + }, + "definitions": { + "UsageName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "properties": { + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The current usage of the resource." + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "description": "Describes Batch AI Resource Usage." + }, + "ListUsagesResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of compute resource usages." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information." + } + }, + "description": "The List Usages operation response." + }, + "FileServerBaseProperties": { + "properties": { + "vmSize": { + "type": "string", + "title": "VM size.", + "description": "The size of the virtual machine for the File Server. For information about available VM sizes from the Virtual Machines Marketplace, see Sizes for Virtual Machines (Linux)." + }, + "sshConfiguration": { + "title": "SSH configuration.", + "description": "SSH configuration for the File Server node.", + "$ref": "#/definitions/SshConfiguration" + }, + "dataDisks": { + "title": "Data disks.", + "description": "Settings for the data disks which will be created for the File Server.", + "$ref": "#/definitions/DataDisks" + }, + "subnet": { + "title": "Subnet identifier.", + "description": "Identifier of an existing virtual network subnet to put the File Server in. If not provided, a new virtual network and subnet will be created.", + "$ref": "#/definitions/ResourceId" + } + }, + "required": [ + "vmSize", + "sshConfiguration", + "dataDisks" + ], + "description": "The properties of a file server." + }, + "FileServerListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FileServer" + }, + "description": "The collection of File Servers." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the File Server List operation." + }, + "DataDisks": { + "properties": { + "diskSizeInGB": { + "type": "integer", + "format": "int32", + "readOnly": false, + "title": "Disk size in GB.", + "description": "Disk size in GB for the blank data disks." + }, + "cachingType": { + "type": "string", + "title": "Caching type.", + "description": "Caching type for the disks. Available values are none (default), readonly, readwrite. Caching type can be set only for VM sizes supporting premium storage.", + "default": "none", + "enum": [ + "none", + "readonly", + "readwrite" + ], + "x-ms-enum": { + "name": "CachingType", + "modelAsString": false + } + }, + "diskCount": { + "type": "integer", + "format": "int32", + "readOnly": false, + "title": "Number of data disks.", + "description": "Number of data disks attached to the File Server. If multiple disks attached, they will be configured in RAID level 0." + }, + "storageAccountType": { + "type": "string", + "readOnly": false, + "title": "Storage account type.", + "description": "Type of storage account to be used on the disk. Possible values are: Standard_LRS or Premium_LRS. Premium storage account type can only be used with VM sizes supporting premium storage.", + "enum": [ + "Standard_LRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": true + } + } + }, + "required": [ + "diskSizeInGB", + "diskCount", + "storageAccountType" + ], + "description": "Data disks settings." + }, + "KeyVaultSecretReference": { + "properties": { + "sourceVault": { + "title": "Key Vault resource identifier.", + "description": "Fully qualified resource indentifier of the Key Vault.", + "$ref": "#/definitions/ResourceId" + }, + "secretUrl": { + "type": "string", + "title": "Secret URL.", + "description": "The URL referencing a secret in the Key Vault." + } + }, + "required": [ + "sourceVault", + "secretUrl" + ], + "description": "Key Vault Secret reference." + }, + "MountSettings": { + "properties": { + "mountPoint": { + "type": "string", + "title": "Mount Point.", + "description": "Path where the data disks are mounted on the File Server." + }, + "fileServerPublicIP": { + "type": "string", + "title": "Public IP.", + "description": "Public IP address of the File Server which can be used to SSH to the node from outside of the subnet." + }, + "fileServerInternalIP": { + "type": "string", + "title": "Internal IP.", + "description": "Internal IP address of the File Server which can be used to access the File Server from within the subnet." + } + }, + "description": "File Server mount Information." + }, + "SshConfiguration": { + "properties": { + "publicIPsToAllow": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Allowed public IPs.", + "description": "List of source IP ranges to allow SSH connection from. The default value is '*' (all source IPs are allowed). Maximum number of IP ranges that can be specified is 400." + }, + "userAccountSettings": { + "title": "User account settings.", + "description": "Settings for administrator user account to be created on a node. The account can be used to establish SSH connection to the node.", + "$ref": "#/definitions/UserAccountSettings" + } + }, + "required": [ + "userAccountSettings" + ], + "description": "SSH configuration." + }, + "FileServerCreateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/FileServerBaseProperties", + "description": "The properties of the File Server.", + "x-ms-client-flatten": true + } + }, + "description": "File Server creation parameters." + }, + "FileServerProperties": { + "properties": { + "vmSize": { + "type": "string", + "title": "VM size.", + "description": "VM size of the File Server." + }, + "sshConfiguration": { + "title": "SSH configuration.", + "description": "SSH configuration for accessing the File Server node.", + "$ref": "#/definitions/SshConfiguration" + }, + "dataDisks": { + "title": "Data disks configuration.", + "description": "Information about disks attached to File Server VM.", + "$ref": "#/definitions/DataDisks" + }, + "subnet": { + "title": "Subnet.", + "description": "File Server virtual network subnet resource ID.", + "$ref": "#/definitions/ResourceId" + }, + "mountSettings": { + "title": "Mount settings.", + "description": "File Server mount settings.", + "readOnly": true, + "$ref": "#/definitions/MountSettings" + }, + "provisioningStateTransitionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Provisioning State Transition time.", + "description": "Time when the provisioning state was changed." + }, + "creationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Creation time.", + "description": "Time when the FileServer was created." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "title": "Provisioning state.", + "description": "Provisioning state of the File Server. Possible values: creating - The File Server is getting created; updating - The File Server creation has been accepted and it is getting updated; deleting - The user has requested that the File Server be deleted, and it is in the process of being deleted; failed - The File Server creation has failed with the specified error code. Details about the error code are specified in the message field; succeeded - The File Server creation has succeeded.", + "enum": [ + "creating", + "updating", + "deleting", + "succeeded", + "failed" + ], + "x-ms-enum": { + "name": "FileServerProvisioningState", + "modelAsString": true + } + } + }, + "description": "File Server properties." + }, + "FileServer": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FileServerProperties", + "description": "File Server properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "File Server information." + }, + "ClusterBaseProperties": { + "properties": { + "vmSize": { + "type": "string", + "title": "VM size.", + "description": "The size of the virtual machines in the cluster. All nodes in a cluster have the same VM size. For information about available VM sizes for clusters using images from the Virtual Machines Marketplace see Sizes for Virtual Machines (Linux). Batch AI service supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + }, + "vmPriority": { + "type": "string", + "title": "VM priority.", + "description": "VM priority. Allowed values are: dedicated (default) and lowpriority.", + "default": "dedicated", + "enum": [ + "dedicated", + "lowpriority" + ], + "x-ms-enum": { + "name": "VmPriority", + "modelAsString": false + } + }, + "scaleSettings": { + "$ref": "#/definitions/ScaleSettings", + "title": "Scale settings.", + "description": "Scale settings for the cluster. Batch AI service supports manual and auto scale clusters." + }, + "virtualMachineConfiguration": { + "title": "VM configuration.", + "description": "OS image configuration for cluster nodes. All nodes in a cluster have the same OS image.", + "$ref": "#/definitions/VirtualMachineConfiguration" + }, + "nodeSetup": { + "title": "Node setup.", + "description": "Setup to be performed on each compute node in the cluster.", + "$ref": "#/definitions/NodeSetup" + }, + "userAccountSettings": { + "title": "User account settings.", + "description": "Settings for an administrator user account that will be created on each compute node in the cluster.", + "$ref": "#/definitions/UserAccountSettings" + }, + "subnet": { + "title": "Subnet.", + "description": "Existing virtual network subnet to put the cluster nodes in. Note, if a File Server mount configured in node setup, the File Server's subnet will be used automatically.", + "$ref": "#/definitions/ResourceId" + } + }, + "required": [ + "vmSize", + "userAccountSettings" + ], + "description": "The properties of a Cluster." + }, + "ClusterUpdateProperties": { + "properties": { + "scaleSettings": { + "$ref": "#/definitions/ScaleSettings", + "title": "Scale settings.", + "description": "Desired scale settings for the cluster. Batch AI service supports manual and auto scale clusters." + } + }, + "description": "The properties of a Cluster that need to be updated." + }, + "DeallocationOption": { + "type": "string", + "title": "Deallocation options.", + "description": "Actions which should be performed when compute nodes are removed from the cluster. Possible values are: requeue (default) - Terminate running jobs and requeue them so the jobs will run again. Remove compute nodes as soon as jobs have been terminated; terminate - Terminate running jobs. The jobs will not run again. Remove compute nodes as soon as jobs have been terminated. waitforjobcompletion - Allow currently running jobs to complete. Schedule no new jobs while waiting. Remove compute nodes when all jobs have completed.", + "default": "requeue", + "enum": [ + "requeue", + "terminate", + "waitforjobcompletion" + ], + "x-ms-enum": { + "name": "DeallocationOption", + "modelAsString": true + } + }, + "ScaleSettings": { + "properties": { + "manual": { + "$ref": "#/definitions/ManualScaleSettings", + "title": "Manual scale settings.", + "description": "Manual scale settings for the cluster." + }, + "autoScale": { + "$ref": "#/definitions/AutoScaleSettings", + "title": "Auto-scale settings.", + "description": "Auto-scale settings for the cluster." + } + }, + "description": "At least one of manual or autoScale settings must be specified. Only one of manual or autoScale settings can be specified. If autoScale settings are specified, the system automatically scales the cluster up and down (within the supplied limits) based on the pending jobs on the cluster." + }, + "AutoScaleSettings": { + "properties": { + "minimumNodeCount": { + "type": "integer", + "format": "int32", + "title": "Minimum node count.", + "description": "The minimum number of compute nodes the Batch AI service will try to allocate for the cluster. Note, the actual number of nodes can be less than the specified value if the subscription has not enough quota to fulfill the request." + }, + "maximumNodeCount": { + "type": "integer", + "format": "int32", + "title": "Maximum node count.", + "description": "The maximum number of compute nodes the cluster can have." + }, + "initialNodeCount": { + "type": "integer", + "format": "int32", + "title": "Initial node count.", + "description": "The number of compute nodes to allocate on cluster creation. Note that this value is used only during cluster creation. Default: 0.", + "default": 0 + } + }, + "required": [ + "minimumNodeCount", + "maximumNodeCount" + ], + "description": "Auto-scale settings for the cluster. The system automatically scales the cluster up and down (within minimumNodeCount and maximumNodeCount) based on the number of queued and running jobs assigned to the cluster." + }, + "ManualScaleSettings": { + "properties": { + "targetNodeCount": { + "type": "integer", + "format": "int32", + "title": "Target node count.", + "description": "The desired number of compute nodes in the Cluster. Default is 0.", + "default": 0 + }, + "nodeDeallocationOption": { + "title": "Node deallocation options.", + "description": "An action to be performed when the cluster size is decreasing. The default value is requeue.", + "default": "requeue", + "$ref": "#/definitions/DeallocationOption" + } + }, + "required": [ + "targetNodeCount" + ], + "description": "Manual scale settings for the cluster." + }, + "VirtualMachineConfiguration": { + "properties": { + "imageReference": { + "title": "Image reference.", + "description": "OS image reference for cluster nodes.", + "$ref": "#/definitions/ImageReference" + } + }, + "description": "VM configuration." + }, + "ImageReference": { + "properties": { + "publisher": { + "type": "string", + "title": "Publisher.", + "description": "Publisher of the image." + }, + "offer": { + "type": "string", + "title": "Offer.", + "description": "Offer of the image." + }, + "sku": { + "type": "string", + "title": "SKU.", + "description": "SKU of the image." + }, + "version": { + "type": "string", + "title": "Version.", + "description": "Version of the image." + }, + "virtualMachineImageId": { + "type": "string", + "title": "Custom VM image resource ID.", + "description": "The ARM resource identifier of the virtual machine image for the compute nodes. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}. The virtual machine image must be in the same region and subscription as the cluster. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. Note, you need to provide publisher, offer and sku of the base OS image of which the custom image has been derived from." + } + }, + "required": [ + "publisher", + "offer", + "sku" + ], + "description": "The OS image reference." + }, + "NodeStateCounts": { + "properties": { + "idleNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Idle node count.", + "description": "Number of compute nodes in idle state." + }, + "runningNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Running node count.", + "description": "Number of compute nodes which are running jobs." + }, + "preparingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preparing node count.", + "description": "Number of compute nodes which are being prepared." + }, + "unusableNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Unusable node count.", + "description": "Number of compute nodes which are in unusable state." + }, + "leavingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Leaving node count.", + "description": "Number of compute nodes which are leaving the cluster." + } + }, + "description": "Counts of various compute node states on the cluster." + }, + "UserAccountSettings": { + "properties": { + "adminUserName": { + "type": "string", + "title": "User name.", + "description": "Name of the administrator user account which can be used to SSH to nodes." + }, + "adminUserSshPublicKey": { + "type": "string", + "title": "SSH public key.", + "description": "SSH public key of the administrator user account." + }, + "adminUserPassword": { + "type": "string", + "title": "Password.", + "description": "Password of the administrator user account." + } + }, + "required": [ + "adminUserName" + ], + "description": "Settings for user account that gets created on each on the nodes of a cluster." + }, + "PerformanceCountersSettings": { + "properties": { + "appInsightsReference": { + "title": "Azure Application Insights reference.", + "description": "Azure Application Insights information for performance counters reporting. If provided, Batch AI will upload node performance counters to the corresponding Azure Application Insights account.", + "$ref": "#/definitions/AppInsightsReference" + } + }, + "required": [ + "appInsightsReference" + ], + "description": "Performance counters reporting settings." + }, + "AppInsightsReference": { + "properties": { + "component": { + "title": "Component ID.", + "description": "Azure Application Insights component resource ID.", + "$ref": "#/definitions/ResourceId" + }, + "instrumentationKey": { + "type": "string", + "title": "Instrumentation Key.", + "description": "Value of the Azure Application Insights instrumentation key." + }, + "instrumentationKeySecretReference": { + "title": "Instrumentation key KeyVault Secret reference.", + "description": "KeyVault Store and Secret which contains Azure Application Insights instrumentation key. One of instrumentationKey or instrumentationKeySecretReference must be specified.", + "$ref": "#/definitions/KeyVaultSecretReference" + } + }, + "required": [ + "component" + ], + "description": "Azure Application Insights information for performance counters reporting." + }, + "NodeSetup": { + "properties": { + "setupTask": { + "title": "Setup task.", + "description": "Setup task to run on cluster nodes when nodes got created or rebooted. The setup task code needs to be idempotent. Generally the setup task is used to download static data that is required for all jobs that run on the cluster VMs and/or to download/install software.", + "$ref": "#/definitions/SetupTask" + }, + "mountVolumes": { + "title": "Mount volumes.", + "description": "Mount volumes to be available to setup task and all jobs executing on the cluster. The volumes will be mounted at location specified by $AZ_BATCHAI_MOUNT_ROOT environment variable.", + "$ref": "#/definitions/MountVolumes" + }, + "performanceCountersSettings": { + "title": "Performance counters settings.", + "description": "Settings for performance counters collecting and uploading.", + "$ref": "#/definitions/PerformanceCountersSettings" + } + }, + "description": "Node setup settings." + }, + "SetupTask": { + "properties": { + "commandLine": { + "type": "string", + "title": "Command line.", + "description": "The command line to be executed on each cluster's node after it being allocated or rebooted. The command is executed in a bash subshell as a root." + }, + "environmentVariables": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "title": "Environment variables.", + "description": "A collection of user defined environment variables to be set for setup task." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariableWithSecretValue" + }, + "title": "Secrets.", + "description": "A collection of user defined environment variables with secret values to be set for the setup task. Server will never report values of these variables back." + }, + "stdOutErrPathPrefix": { + "type": "string", + "title": "Output path prefix.", + "description": "The prefix of a path where the Batch AI service will upload the stdout, stderr and execution log of the setup task." + }, + "stdOutErrPathSuffix": { + "type": "string", + "title": "Output path suffix.", + "description": "A path segment appended by Batch AI to stdOutErrPathPrefix to form a path where stdout, stderr and execution log of the setup task will be uploaded. Batch AI creates the setup task output directories under an unique path to avoid conflicts between different clusters. The full path can be obtained by concatenation of stdOutErrPathPrefix and stdOutErrPathSuffix.", + "readOnly": true + } + }, + "required": [ + "commandLine", + "stdOutErrPathPrefix" + ], + "description": "Specifies a setup task which can be used to customize the compute nodes of the cluster." + }, + "ClusterCreateParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/ClusterBaseProperties", + "description": "The properties of the Cluster.", + "x-ms-client-flatten": true + } + }, + "description": "Cluster creation operation." + }, + "ClusterUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterUpdateProperties", + "description": "The properties of the Cluster." + } + }, + "description": "Cluster update parameters." + }, + "ClusterProperties": { + "properties": { + "vmSize": { + "type": "string", + "title": "VM size.", + "description": "The size of the virtual machines in the cluster. All nodes in a cluster have the same VM size." + }, + "vmPriority": { + "type": "string", + "title": "VM priority.", + "description": "VM priority of cluster nodes.", + "default": "dedicated", + "enum": [ + "dedicated", + "lowpriority" + ], + "x-ms-enum": { + "name": "VmPriority", + "modelAsString": false + } + }, + "scaleSettings": { + "$ref": "#/definitions/ScaleSettings", + "title": "Scale settings.", + "description": "Scale settings of the cluster." + }, + "virtualMachineConfiguration": { + "title": "VM configuration.", + "description": "Virtual machine configuration (OS image) of the compute nodes. All nodes in a cluster have the same OS image configuration.", + "$ref": "#/definitions/VirtualMachineConfiguration" + }, + "nodeSetup": { + "title": "Node setup.", + "description": "Setup (mount file systems, performance counters settings and custom setup task) to be performed on each compute node in the cluster.", + "$ref": "#/definitions/NodeSetup" + }, + "userAccountSettings": { + "title": "User account settings.", + "description": "Administrator user account settings which can be used to SSH to compute nodes.", + "$ref": "#/definitions/UserAccountSettings" + }, + "subnet": { + "title": "Subnet.", + "description": "Virtual network subnet resource ID the cluster nodes belong to.", + "$ref": "#/definitions/ResourceId" + }, + "creationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Creation time.", + "description": "The time when the cluster was created." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "title": "Provisioning state.", + "description": "Provisioning state of the cluster. Possible value are: creating - Specifies that the cluster is being created. succeeded - Specifies that the cluster has been created successfully. failed - Specifies that the cluster creation has failed. deleting - Specifies that the cluster is being deleted.", + "enum": [ + "creating", + "succeeded", + "failed", + "deleting" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "provisioningStateTransitionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Provisioning State Transition time.", + "description": "Time when the provisioning state was changed." + }, + "allocationState": { + "type": "string", + "readOnly": true, + "title": "Allocation state.", + "description": "Allocation state of the cluster. Possible values are: steady - Indicates that the cluster is not resizing. There are no changes to the number of compute nodes in the cluster in progress. A cluster enters this state when it is created and when no operations are being performed on the cluster to change the number of compute nodes. resizing - Indicates that the cluster is resizing; that is, compute nodes are being added to or removed from the cluster.", + "enum": [ + "steady", + "resizing" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": true + } + }, + "allocationStateTransitionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Allocation state transition time.", + "description": "The time at which the cluster entered its current allocation state." + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "Collection of errors encountered by various compute nodes during node setup.", + "type": "array", + "items": { + "$ref": "#/definitions/BatchAIError" + } + }, + "currentNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Current node count.", + "description": "The number of compute nodes currently assigned to the cluster." + }, + "nodeStateCounts": { + "title": "Node state counts.", + "description": "Counts of various node states on the cluster.", + "readOnly": true, + "$ref": "#/definitions/NodeStateCounts" + } + }, + "description": "Cluster properties." + }, + "Cluster": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterProperties", + "description": "The properties associated with the Cluster." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Information about a Cluster." + }, + "ClusterListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + }, + "description": "The collection of returned Clusters." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List Clusters operation." + }, + "JobBaseProperties": { + "properties": { + "schedulingPriority": { + "type": "string", + "default": "normal", + "enum": [ + "low", + "normal", + "high" + ], + "x-ms-enum": { + "name": "JobPriority", + "modelAsString": true + }, + "title": "Scheduling priority.", + "description": "Scheduling priority associated with the job. Possible values: low, normal, high." + }, + "cluster": { + "title": "Cluster.", + "description": "Resource ID of the cluster on which this job will run.", + "$ref": "#/definitions/ResourceId" + }, + "mountVolumes": { + "title": "Mount volumes.", + "description": "Information on mount volumes to be used by the job. These volumes will be mounted before the job execution and will be unmouted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.", + "$ref": "#/definitions/MountVolumes" + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "title": "Node count.", + "description": "Number of compute nodes to run the job on. The job will be gang scheduled on that many compute nodes." + }, + "containerSettings": { + "title": "Container settings.", + "description": "Docker container settings for the job. If not provided, the job will run directly on the node.", + "$ref": "#/definitions/ContainerSettings" + }, + "cntkSettings": { + "title": "CNTK settings.", + "description": "Settings for CNTK (aka Microsoft Cognitive Toolkit) job.", + "$ref": "#/definitions/CNTKsettings" + }, + "pyTorchSettings": { + "title": "pyTorch settings.", + "description": "Settings for pyTorch job.", + "$ref": "#/definitions/PyTorchSettings" + }, + "tensorFlowSettings": { + "title": "TensorFlow settings.", + "description": "Settings for Tensor Flow job.", + "$ref": "#/definitions/TensorFlowSettings" + }, + "caffeSettings": { + "title": "Caffe settings.", + "description": "Settings for Caffe job.", + "$ref": "#/definitions/CaffeSettings" + }, + "caffe2Settings": { + "title": "Caffe2 settings.", + "description": "Settings for Caffe2 job.", + "$ref": "#/definitions/Caffe2Settings" + }, + "chainerSettings": { + "title": "Chainer settings.", + "description": "Settings for Chainer job.", + "$ref": "#/definitions/ChainerSettings" + }, + "customToolkitSettings": { + "title": "Custom tool kit job.", + "description": "Settings for custom tool kit job.", + "$ref": "#/definitions/CustomToolkitSettings" + }, + "customMpiSettings": { + "title": "Custom MPI settings.", + "description": "Settings for custom MPI job.", + "$ref": "#/definitions/CustomMpiSettings" + }, + "horovodSettings": { + "title": "Horovod settings.", + "description": "Settings for Horovod job.", + "$ref": "#/definitions/HorovodSettings" + }, + "jobPreparation": { + "title": "Job preparation.", + "description": "A command line to be executed on each node allocated for the job before tool kit is launched.", + "$ref": "#/definitions/JobPreparation" + }, + "stdOutErrPathPrefix": { + "type": "string", + "title": "Standard output path prefix.", + "description": "The path where the Batch AI service will store stdout, stderror and execution log of the job." + }, + "inputDirectories": { + "type": "array", + "items": { + "$ref": "#/definitions/InputDirectory" + }, + "title": "Input directories.", + "description": "A list of input directories for the job." + }, + "outputDirectories": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputDirectory" + }, + "title": "Output directories.", + "description": "A list of output directories for the job." + }, + "environmentVariables": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "title": "Environment variables.", + "description": "A list of user defined environment variables which will be setup for the job." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariableWithSecretValue" + }, + "title": "Secrets.", + "description": "A list of user defined environment variables with secret values which will be setup for the job. Server will never report values of these variables back." + }, + "constraints": { + "properties": { + "maxWallClockTime": { + "type": "string", + "format": "duration", + "title": "Max wall clock time.", + "description": "Max time the job can run. Default value: 1 week.", + "default": "7.00:00:00" + } + }, + "description": "Constraints associated with the Job." + } + }, + "required": [ + "cluster", + "nodeCount", + "stdOutErrPathPrefix" + ], + "description": "The properties of a Batch AI Job." + }, + "JobCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/JobBaseProperties", + "description": "The properties of the Job." + } + }, + "description": "Job creation parameters." + }, + "JobProperties": { + "properties": { + "schedulingPriority": { + "type": "string", + "default": "normal", + "enum": [ + "low", + "normal", + "high" + ], + "x-ms-enum": { + "name": "JobPriority", + "modelAsString": true + }, + "title": "Scheduling priority.", + "description": "Scheduling priority associated with the job." + }, + "cluster": { + "title": "Cluster.", + "description": "Resource ID of the cluster associated with the job.", + "$ref": "#/definitions/ResourceId" + }, + "mountVolumes": { + "title": "Mount volumes.", + "description": "Collection of mount volumes available to the job during execution. These volumes are mounted before the job execution and unmouted after the job completion. The volumes are mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.", + "$ref": "#/definitions/MountVolumes" + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "title": "Number of compute nodes to run the job on.", + "description": "The job will be gang scheduled on that many compute nodes" + }, + "containerSettings": { + "title": "If provided the job will run in the specified container.", + "description": "If the container was downloaded as part of cluster setup then the same container image will be used. If not provided, the job will run on the VM.", + "$ref": "#/definitions/ContainerSettings" + }, + "toolType": { + "title": "The toolkit type of this job.", + "description": "Possible values are: cntk, tensorflow, caffe, caffe2, chainer, pytorch, custom, custommpi, horovod.", + "$ref": "#/definitions/ToolType" + }, + "cntkSettings": { + "title": "Specifies the settings for CNTK (aka Microsoft Cognitive Toolkit) job.", + "$ref": "#/definitions/CNTKsettings" + }, + "pyTorchSettings": { + "title": "Specifies the settings for pyTorch job.", + "$ref": "#/definitions/PyTorchSettings" + }, + "tensorFlowSettings": { + "title": "Specifies the settings for Tensor Flow job.", + "$ref": "#/definitions/TensorFlowSettings" + }, + "caffeSettings": { + "title": "Specifies the settings for Caffe job.", + "$ref": "#/definitions/CaffeSettings" + }, + "caffe2Settings": { + "title": "Specifies the settings for Caffe2 job.", + "$ref": "#/definitions/Caffe2Settings" + }, + "chainerSettings": { + "title": "Specifies the settings for Chainer job.", + "$ref": "#/definitions/ChainerSettings" + }, + "customToolkitSettings": { + "title": "Specifies the settings for custom tool kit job.", + "$ref": "#/definitions/CustomToolkitSettings" + }, + "customMpiSettings": { + "title": "Specifies the settings for custom MPI job.", + "$ref": "#/definitions/CustomMpiSettings" + }, + "horovodSettings": { + "title": "Specifies the settings for Horovod job.", + "$ref": "#/definitions/HorovodSettings" + }, + "jobPreparation": { + "title": "Specifies the actions to be performed before tool kit is launched.", + "description": "The specified actions will run on all the nodes that are part of the job", + "$ref": "#/definitions/JobPreparation" + }, + "jobOutputDirectoryPathSegment": { + "readOnly": true, + "type": "string", + "title": "Output directory path segment.", + "description": "A segment of job's output directories path created by Batch AI. Batch AI creates job's output directories under an unique path to avoid conflicts between jobs. This value contains a path segment generated by Batch AI to make the path unique and can be used to find the output directory on the node or mounted filesystem." + }, + "stdOutErrPathPrefix": { + "type": "string", + "title": "Standard output directory path prefix.", + "description": "The path where the Batch AI service stores stdout, stderror and execution log of the job." + }, + "inputDirectories": { + "type": "array", + "items": { + "$ref": "#/definitions/InputDirectory" + }, + "title": "Input directories.", + "description": "A list of input directories for the job." + }, + "outputDirectories": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputDirectory" + }, + "title": "Output directories.", + "description": "A list of output directories for the job." + }, + "environmentVariables": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "title": "Environment variables.", + "description": "A collection of user defined environment variables to be setup for the job." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariableWithSecretValue" + }, + "title": "Secrets.", + "description": "A collection of user defined environment variables with secret values to be setup for the job. Server will never report values of these variables back." + }, + "constraints": { + "properties": { + "maxWallClockTime": { + "type": "string", + "format": "duration", + "title": "Max wall clock time.", + "description": "Max time the job can run. Default value: 1 week.", + "default": "7.00:00:00" + } + }, + "description": "Constraints associated with the Job." + }, + "creationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Creation time.", + "description": "The creation time of the job." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "title": "Provisioning state.", + "description": "The provisioned state of the Batch AI job", + "enum": [ + "creating", + "deleting", + "succeeded", + "failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "provisioningStateTransitionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Provisioning state transition time.", + "description": "The time at which the job entered its current provisioning state." + }, + "executionState": { + "readOnly": true, + "type": "string", + "title": "Execution state.", + "description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running succesfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.", + "enum": [ + "queued", + "running", + "terminating", + "succeeded", + "failed" + ], + "x-ms-enum": { + "name": "ExecutionState", + "modelAsString": true + } + }, + "executionStateTransitionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Execution state transition time.", + "description": "The time at which the job entered its current execution state." + }, + "executionInfo": { + "properties": { + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "title": "Start time.", + "description": "The time at which the job started running. 'Running' corresponds to the running state. If the job has been restarted or retried, this is the most recent time at which the job started running. This property is present only for job that are in the running or completed state." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "title": "End time.", + "description": "The time at which the job completed. This property is only returned if the job is in completed state." + }, + "exitCode": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Exit code.", + "description": "The exit code of the job. This property is only returned if the job is in completed state." + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "A collection of errors encountered by the service during job execution.", + "type": "array", + "items": { + "$ref": "#/definitions/BatchAIError" + } + } + }, + "description": "Information about the execution of a job." + } + }, + "description": "Job properties." + }, + "Job": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/JobProperties", + "description": "The properties associated with the Job." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Information about a Job." + }, + "JobListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Job" + }, + "description": "The collection of jobs." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "RemoteLoginInformation": { + "properties": { + "nodeId": { + "readOnly": true, + "type": "string", + "title": "Node ID.", + "description": "ID of the compute node." + }, + "ipAddress": { + "readOnly": true, + "type": "string", + "title": "IP address.", + "description": "Public IP address of the compute node." + }, + "port": { + "readOnly": true, + "type": "number", + "format": "int32", + "title": "Port.", + "description": "SSH port number of the node." + } + }, + "description": "Login details to SSH to a compute node in cluster." + }, + "RemoteLoginInformationListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RemoteLoginInformation" + }, + "description": "The collection of returned remote login details." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "FileProperties": { + "properties": { + "lastModified": { + "readOnly": true, + "type": "string", + "format": "date-time", + "title": "Last modified time.", + "description": "The time at which the file was last modified." + }, + "contentLength": { + "readOnly": true, + "type": "integer", + "format": "int64", + "title": "Content length.", + "description": "The file of the size." + } + }, + "description": "File properties." + }, + "File": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "title": "Name.", + "description": "Name of the file." + }, + "fileType": { + "readOnly": true, + "type": "string", + "enum": [ + "file", + "directory" + ], + "x-ms-enum": { + "name": "FileType", + "modelAsString": true + }, + "title": "File type.", + "description": "Type of the file. Possible values are file and directory." + }, + "downloadUrl": { + "readOnly": true, + "type": "string", + "title": "Download URL.", + "description": "URL to download the corresponding file. The downloadUrl is not returned for directories." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FileProperties", + "title": "Properties.", + "description": "The properties associated with the file. The properties are not returned for directories." + } + }, + "description": "Properties of the file or directory." + }, + "FileListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/File" + }, + "description": "The collection of returned job directories and files." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "ResourceId": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource" + } + }, + "required": [ + "id" + ], + "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", + "x-ms-azure-resource": true + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the resource" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource" + }, + "location": { + "readOnly": true, + "type": "string", + "description": "The location of the resource" + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags of the resource" + } + }, + "description": "A definition of an Azure resource.", + "x-ms-azure-resource": true + }, + "ProxyResource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + } + }, + "description": "A definition of an Azure proxy resource.", + "x-ms-azure-resource": true + }, + "ToolType": { + "type": "string", + "title": "Toolkit type.", + "description": "The toolkit type of the job.", + "enum": [ + "cntk", + "tensorflow", + "caffe", + "caffe2", + "chainer", + "horovod", + "custommpi", + "custom" + ], + "x-ms-enum": { + "name": "ToolType", + "modelAsString": true + } + }, + "NameValuePair": { + "properties": { + "name": { + "type": "string", + "title": "Name.", + "description": "The name in the name-value pair." + }, + "value": { + "type": "string", + "title": "Value.", + "description": "The value in the name-value pair." + } + }, + "description": "Name-value pair." + }, + "EnvironmentVariable": { + "properties": { + "name": { + "type": "string", + "title": "Name.", + "description": "The name of the environment variable." + }, + "value": { + "type": "string", + "title": "Value.", + "description": "The value of the environment variable." + } + }, + "required": [ + "name", + "value" + ], + "description": "An environment variable definition." + }, + "EnvironmentVariableWithSecretValue": { + "properties": { + "name": { + "type": "string", + "title": "Name.", + "description": "The name of the environment variable to store the secret value." + }, + "value": { + "type": "string", + "title": "Value.", + "description": "The value of the environment variable. This value will never be reported back by Batch AI." + }, + "valueSecretReference": { + "title": "KeyVault secret reference.", + "description": "KeyVault store and secret which contains the value for the environment variable. One of value or valueSecretReference must be provided.", + "$ref": "#/definitions/KeyVaultSecretReference" + } + }, + "required": [ + "name" + ], + "description": "An environment variable with secret value definition." + }, + "ImageSourceRegistry": { + "properties": { + "serverUrl": { + "type": "string", + "title": "Server URL.", + "description": "URL for image repository." + }, + "image": { + "type": "string", + "title": "Image.", + "description": "The name of the image in the image repository." + }, + "credentials": { + "title": "Credentials.", + "description": "Credentials to access the private docker repository.", + "$ref": "#/definitions/PrivateRegistryCredentials" + } + }, + "description": "Information about docker image for the job.", + "required": [ + "image" + ] + }, + "PrivateRegistryCredentials": { + "properties": { + "username": { + "type": "string", + "title": "User name.", + "description": "User name to login to the repository." + }, + "password": { + "type": "string", + "title": "Password.", + "description": "User password to login to the docker repository. One of password or passwordSecretReference must be specified." + }, + "passwordSecretReference": { + "title": "Password secret reference.", + "description": "KeyVault Secret storing the password. Users can store their secrets in Azure KeyVault and pass it to the Batch AI service to integrate with KeyVault. One of password or passwordSecretReference must be specified.", + "$ref": "#/definitions/KeyVaultSecretReference" + } + }, + "description": "Credentials to access a container image in a private repository.", + "required": [ + "username" + ] + }, + "ContainerSettings": { + "properties": { + "imageSourceRegistry": { + "title": "Image source registry.", + "description": "Information about docker image and docker registry to download the container from.", + "$ref": "#/definitions/ImageSourceRegistry" + }, + "shmSize": { + "type": "string", + "title": "/dev/shm size.", + "description": "Size of /dev/shm. Please refer to docker documentation for supported argument formats." + } + }, + "description": "Docker container settings.", + "required": [ + "imageSourceRegistry" + ] + }, + "InputDirectory": { + "properties": { + "id": { + "type": "string", + "title": "ID.", + "description": "The ID for the input directory. The job can use AZ_BATCHAI_INPUT_ environment variable to find the directory path, where is the value of id attribute." + }, + "path": { + "type": "string", + "title": "Path.", + "description": "The path to the input directory." + } + }, + "description": "Input directory for the job.", + "required": [ + "id", + "path" + ] + }, + "OutputDirectory": { + "properties": { + "id": { + "type": "string", + "title": "ID.", + "description": "The ID of the output directory. The job can use AZ_BATCHAI_OUTPUT_ environment variale to find the directory path, where is the value of id attribute." + }, + "pathPrefix": { + "type": "string", + "title": "Path prefix.", + "description": "The prefix path where the output directory will be created. Note, this is an absolute path to prefix. E.g. $AZ_BATCHAI_MOUNT_ROOT/MyNFS/MyLogs. The full path to the output directory by combining pathPrefix, jobOutputDirectoryPathSegment (reported by get job) and pathSuffix." + }, + "pathSuffix": { + "type": "string", + "title": "Path suffix.", + "description": "The suffix path where the output directory will be created. E.g. models. You can find the full path to the output directory by combining pathPrefix, jobOutputDirectoryPathSegment (reported by get job) and pathSuffix." + } + }, + "description": "Output directory for the job.", + "required": [ + "id", + "pathPrefix" + ] + }, + "AzureStorageCredentialsInfo": { + "properties": { + "accountKey": { + "type": "string", + "title": "Account key.", + "description": "Storage account key. One of accountKey or accountKeySecretReference must be specified." + }, + "accountKeySecretReference": { + "title": "Account key secret reference.", + "description": "Information about KeyVault secret storing the storage account key. One of accountKey or accountKeySecretReference must be specified.", + "$ref": "#/definitions/KeyVaultSecretReference" + } + }, + "description": "Azure storage account credentials." + }, + "AzureFileShareReference": { + "properties": { + "accountName": { + "type": "string", + "title": "Account name.", + "description": "Name of the Azure storage account." + }, + "azureFileUrl": { + "type": "string", + "title": "Azure File URL.", + "description": "URL to access the Azure File." + }, + "credentials": { + "title": "Credentials.", + "description": "Information about the Azure storage credentials.", + "$ref": "#/definitions/AzureStorageCredentialsInfo" + }, + "relativeMountPath": { + "type": "string", + "title": "Relative mount path.", + "description": "The relative path on the compute node where the Azure File share will be mounted. Note that all cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT." + }, + "fileMode": { + "type": "string", + "title": "File mode.", + "description": "File mode for files on the mounted file share. Default value: 0777.", + "default": "0777" + }, + "directoryMode": { + "type": "string", + "title": "Directory mode.", + "description": "File mode for directories on the mounted file share. Default value: 0777.", + "default": "0777" + } + }, + "description": "Azure File Share mounting configuration.", + "required": [ + "accountName", + "azureFileUrl", + "credentials", + "relativeMountPath" + ] + }, + "AzureBlobFileSystemReference": { + "properties": { + "accountName": { + "type": "string", + "title": "Account name.", + "description": "Name of the Azure storage account." + }, + "containerName": { + "type": "string", + "title": "Container name.", + "description": "Name of the Azure Blob Storage container to mount on the cluster." + }, + "credentials": { + "title": "Credentials.", + "description": "Information about the Azure storage credentials.", + "$ref": "#/definitions/AzureStorageCredentialsInfo" + }, + "relativeMountPath": { + "type": "string", + "title": "Relative mount path.", + "description": "The relative path on the compute node where the Azure File container will be mounted. Note that all cluster level containers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level containers will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT." + }, + "mountOptions": { + "type": "string", + "title": "Mount options.", + "description": "Mount options for mounting blobfuse file system." + } + }, + "description": "Azure Blob Storage Container mounting configuration.", + "required": [ + "accountName", + "containerName", + "credentials", + "relativeMountPath" + ] + }, + "FileServerReference": { + "properties": { + "fileServer": { + "title": "File server.", + "description": "Resource ID of the existing File Server to be mounted.", + "$ref": "#/definitions/ResourceId" + }, + "sourceDirectory": { + "type": "string", + "title": "Source directory.", + "description": "File Server directory that needs to be mounted. If this property is not specified, the entire File Server will be mounted." + }, + "relativeMountPath": { + "type": "string", + "title": "Relative mount path.", + "description": "The relative path on the compute node where the File Server will be mounted. Note that all cluster level file servers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file servers will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT." + }, + "mountOptions": { + "type": "string", + "title": "Mount options.", + "description": "Mount options to be passed to mount command." + } + }, + "description": "File Server mounting configuration.", + "required": [ + "fileServer", + "relativeMountPath" + ] + }, + "UnmanagedFileSystemReference": { + "properties": { + "mountCommand": { + "title": "Mount command.", + "description": "Mount command line. Note, Batch AI will append mount path to the command on its own.", + "type": "string" + }, + "relativeMountPath": { + "type": "string", + "title": "Relative mount path.", + "description": "The relative path on the compute node where the unmanaged file system will be mounted. Note that all cluster level unmanaged file systems will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level unmanaged file systems will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT." + } + }, + "description": "Unmananged file system mounting configuration.", + "required": [ + "mountCommand", + "relativeMountPath" + ] + }, + "MountVolumes": { + "properties": { + "azureFileShares": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFileShareReference" + }, + "title": "Azure File Shares.", + "description": "A collection of Azure File Shares that are to be mounted to the cluster nodes." + }, + "azureBlobFileSystems": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureBlobFileSystemReference" + }, + "title": "Azure Blob file systems.", + "description": "A collection of Azure Blob Containers that are to be mounted to the cluster nodes." + }, + "fileServers": { + "type": "array", + "items": { + "$ref": "#/definitions/FileServerReference" + }, + "title": "File Servers.", + "description": "A collection of Batch AI File Servers that are to be mounted to the cluster nodes." + }, + "unmanagedFileSystems": { + "type": "array", + "items": { + "$ref": "#/definitions/UnmanagedFileSystemReference" + }, + "title": "Unmanaged file systems.", + "description": "A collection of unmanaged file systems that are to be mounted to the cluster nodes." + } + }, + "description": "Details of volumes to mount on the cluster." + }, + "CNTKsettings": { + "properties": { + "languageType": { + "type": "string", + "title": "Language type.", + "description": "The language to use for launching CNTK (aka Microsoft Cognitive Toolkit) job. Valid values are 'BrainScript' or 'Python'." + }, + "configFilePath": { + "type": "string", + "title": "Config file path.", + "description": "Specifies the path of the BrainScript config file. This property can be specified only if the languageType is 'BrainScript'." + }, + "pythonScriptFilePath": { + "type": "string", + "title": "Python script file path.", + "description": "Python script to execute. This property can be specified only if the languageType is 'Python'." + }, + "pythonInterpreterPath": { + "type": "string", + "title": "Python interpreter path.", + "description": "The path to the Python interpreter. This property can be specified only if the languageType is 'Python'." + }, + "commandLineArgs": { + "type": "string", + "title": "Command line arguments.", + "description": "Command line arguments that need to be passed to the python script or cntk executable." + }, + "processCount": { + "type": "integer", + "format": "int32", + "title": "Process count.", + "description": "Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property" + } + }, + "description": "CNTK (aka Microsoft Cognitive Toolkit) job settings." + }, + "CaffeSettings": { + "properties": { + "configFilePath": { + "type": "string", + "title": "Config file path.", + "description": "Path of the config file for the job. This property cannot be specified if pythonScriptFilePath is specified." + }, + "pythonScriptFilePath": { + "type": "string", + "title": "Python script file path.", + "description": "Python script to execute. This property cannot be specified if configFilePath is specified." + }, + "pythonInterpreterPath": { + "type": "string", + "title": "Python interpreter path.", + "description": "The path to the Python interpreter. The property can be specified only if the pythonScriptFilePath is specified." + }, + "commandLineArgs": { + "type": "string", + "title": "Command line arguments.", + "description": "Command line arguments that need to be passed to the Caffe job." + }, + "processCount": { + "type": "integer", + "format": "int32", + "title": "Process count.", + "description": "Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property" + } + }, + "description": "Caffe job settings." + }, + "Caffe2Settings": { + "properties": { + "pythonScriptFilePath": { + "type": "string", + "title": "Python script file path.", + "description": "The python script to execute." + }, + "pythonInterpreterPath": { + "type": "string", + "title": "Python interpreter path.", + "description": "The path to the Python interpreter." + }, + "commandLineArgs": { + "type": "string", + "title": "Command line arguments.", + "description": "Command line arguments that need to be passed to the python script." + } + }, + "description": "Caffe2 job settings.", + "required": [ + "pythonScriptFilePath" + ] + }, + "ChainerSettings": { + "properties": { + "pythonScriptFilePath": { + "type": "string", + "title": "Python script file path.", + "description": "The python script to execute." + }, + "pythonInterpreterPath": { + "type": "string", + "title": "Python interpreter path.", + "description": "The path to the Python interpreter." + }, + "commandLineArgs": { + "type": "string", + "title": "Command line arguments.", + "description": "Command line arguments that need to be passed to the python script." + }, + "processCount": { + "type": "integer", + "format": "int32", + "title": "Process count.", + "description": "Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property" + } + }, + "description": "Chainer job settings.", + "required": [ + "pythonScriptFilePath" + ] + }, + "CustomToolkitSettings": { + "properties": { + "commandLine": { + "type": "string", + "title": "Command line.", + "description": "The command line to execute on the master node." + } + }, + "description": "Custom tool kit job settings." + }, + "CustomMpiSettings": { + "properties": { + "commandLine": { + "type": "string", + "title": "Command line.", + "description": "The command line to be executed by mpi runtime on each compute node." + }, + "processCount": { + "type": "integer", + "format": "int32", + "title": "Process count.", + "description": "Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property" + } + }, + "description": "Custom MPI job settings.", + "required": [ + "commandLine" + ] + }, + "JobPreparation": { + "properties": { + "commandLine": { + "type": "string", + "title": "Command line.", + "description": "The command line to execute. If containerSettings is specified on the job, this commandLine will be executed in the same container as job. Otherwise it will be executed on the node." + } + }, + "description": "Job preparation settings.", + "required": [ + "commandLine" + ] + }, + "PyTorchSettings": { + "properties": { + "pythonScriptFilePath": { + "type": "string", + "title": "Python script file path.", + "description": "The python script to execute." + }, + "pythonInterpreterPath": { + "type": "string", + "title": "Python interpreter path.", + "description": "The path to the Python interpreter." + }, + "commandLineArgs": { + "type": "string", + "title": "Command line arguments.", + "description": "Command line arguments that need to be passed to the python script." + }, + "processCount": { + "type": "integer", + "format": "int32", + "title": "Process count.", + "description": "Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property" + }, + "communicationBackend": { + "type": "string", + "title": "Communication backend.", + "description": "Type of the communication backend for distributed jobs. Valid values are 'TCP', 'Gloo' or 'MPI'. Not required for non-distributed jobs." + } + }, + "description": "pyTorch job settings.", + "required": [ + "pythonScriptFilePath" + ] + }, + "HorovodSettings": { + "properties": { + "pythonScriptFilePath": { + "type": "string", + "title": "Python script file path.", + "description": "The python script to execute." + }, + "pythonInterpreterPath": { + "type": "string", + "title": "Python interpreter path.", + "description": "The path to the Python interpreter." + }, + "commandLineArgs": { + "type": "string", + "title": "Command line arguments.", + "description": "Command line arguments that need to be passed to the python script." + }, + "processCount": { + "type": "integer", + "format": "int32", + "title": "Process count.", + "description": "Number of processes to launch for the job execution. The default value for this property is equal to nodeCount property" + } + }, + "description": "Specifies the settings for Horovod job.", + "required": [ + "pythonScriptFilePath" + ] + }, + "TensorFlowSettings": { + "properties": { + "pythonScriptFilePath": { + "type": "string", + "title": "Python script file path.", + "description": "The python script to execute." + }, + "pythonInterpreterPath": { + "type": "string", + "title": "Python interpreter path.", + "description": "The path to the Python interpreter." + }, + "masterCommandLineArgs": { + "type": "string", + "title": "Master command line arguments.", + "description": "Command line arguments that need to be passed to the python script for the master task." + }, + "workerCommandLineArgs": { + "type": "string", + "title": "Worker command line arguments.", + "description": "Command line arguments that need to be passed to the python script for the worker task. Optional for single process jobs." + }, + "parameterServerCommandLineArgs": { + "type": "string", + "title": "Parameter server command line arguments.", + "description": "Command line arguments that need to be passed to the python script for the parameter server. Optional for single process jobs." + }, + "workerCount": { + "type": "integer", + "format": "int32", + "title": "Worker count.", + "description": "The number of worker tasks. If specified, the value must be less than or equal to (nodeCount * numberOfGPUs per VM). If not specified, the default value is equal to nodeCount. This property can be specified only for distributed TensorFlow training." + }, + "parameterServerCount": { + "type": "integer", + "format": "int32", + "title": "Parameter server count.", + "description": "The number of parameter server tasks. If specified, the value must be less than or equal to nodeCount. If not specified, the default value is equal to 1 for distributed TensorFlow training. This property can be specified only for distributed TensorFlow training." + } + }, + "description": "TensorFlow job settings.", + "required": [ + "pythonScriptFilePath" + ] + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "readOnly": true, + "$ref": "#/definitions/CloudErrorBody", + "description": "An error response from the Batch AI service." + } + }, + "description": "An error response from the Batch AI service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Batch AI service." + }, + "BatchAIError": { + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "An identifier of the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Batch AI service." + }, + "Operation": { + "title": "A REST API operation.", + "description": "Details of a REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "title": "The operation name.", + "description": "This is of the format {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that describes the operation.", + "properties": { + "provider": { + "readOnly": true, + "title": "Friendly name of the resource provider.", + "type": "string" + }, + "operation": { + "readOnly": true, + "title": "The operation type.", + "description": "For example: read, write, delete, or listKeys/action", + "type": "string" + }, + "resource": { + "readOnly": true, + "title": "The resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "readOnly": true, + "title": "The friendly name of the operation.", + "type": "string" + } + } + }, + "origin": { + "readOnly": true, + "title": "The intended executor of the operation.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "title": "Properties of the operation.", + "type": "object" + } + } + }, + "OperationListResult": { + "title": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "description": "Contains the list of all operations supported by BatchAI resource provider", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "title": "The list of operations supported by the resource provider." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "title": "The URL to get the next set of operation list results if there are any." + } + } + }, + "WorkspaceListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + }, + "description": "The collection of workspaces." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "WorkspaceCreateParameters": { + "properties": { + "location": { + "type": "string", + "title": "Location.", + "description": "The region in which to create the Workspace." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "Tags.", + "description": "The user specified tags associated with the Workspace." + } + }, + "required": [ + "location" + ], + "description": "Workspace creation parameters." + }, + "WorkspaceUpdateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "Tags.", + "description": "The user specified tags associated with the Workspace." + } + }, + "description": "Workspace update parameters." + }, + "WorkspaceProperties": { + "properties": { + "creationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Creation time.", + "description": "Time when the Workspace was created." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "title": "Provisioning state.", + "description": "The provisioned state of the Workspace", + "enum": [ + "creating", + "deleting", + "succeeded", + "failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "provisioningStateTransitionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Provisioning state transition time.", + "description": "The time at which the workspace entered its current provisioning state." + } + }, + "description": "Workspace specific properties." + }, + "Workspace": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceProperties", + "description": "The properties associated with the workspace." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Batch AI Workspace information." + }, + "ExperimentListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Experiment" + }, + "description": "The collection of experiments." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "ExperimentProperties": { + "properties": { + "creationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Creation time.", + "description": "Time when the Experiment was created." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "title": "Provisioning state.", + "description": "The provisioned state of the experiment", + "enum": [ + "creating", + "deleting", + "succeeded", + "failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "provisioningStateTransitionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Provisioning state transition time.", + "description": "The time at which the experiment entered its current provisioning state." + } + }, + "description": "Experiment properties." + }, + "Experiment": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExperimentProperties", + "description": "The properties associated with the experiment." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Experiment information." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscriptionID for the Azure user." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group to which the resource belongs.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w_]+$", + "minLength": 1, + "maxLength": 64, + "x-ms-parameter-location": "method", + "description": "The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." + }, + "JobNameParameter": { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w_]+$", + "minLength": 1, + "maxLength": 64, + "x-ms-parameter-location": "method", + "description": "The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." + }, + "FileServerNameParameter": { + "name": "fileServerName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w_]+$", + "minLength": 1, + "maxLength": 64, + "x-ms-parameter-location": "method", + "description": "The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Specifies the version of API used for this request." + }, + "MaxResultsParameter": { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method", + "description": "The maximum number of items to return in the response. A maximum of 1000 files can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + "OutputDirectoryIdParameter": { + "name": "outputdirectoryid", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Id of the job output directory. This is the OutputDirectory-->id parameter that is given by the user during Create Job.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + "DownloadLinkExpiryParameter": { + "name": "linkexpiryinminutes", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 600, + "default": 60, + "x-ms-parameter-location": "method", + "description": "The number of minutes after which the download link will expire.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + "Directory": { + "name": "directory", + "in": "query", + "default": ".", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The path to the directory.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w_]+$", + "minLength": 1, + "maxLength": 64, + "x-ms-parameter-location": "method", + "description": "The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." + }, + "ExperimentNameParameter": { + "name": "experimentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w_]+$", + "minLength": 1, + "maxLength": 64, + "x-ms-parameter-location": "method", + "description": "The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long." + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ClusterListRemoteLoginInfo.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ClusterListRemoteLoginInfo.json new file mode 100644 index 000000000000..49bad0763fc4 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ClusterListRemoteLoginInfo.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "clusterName": "demo_cluster", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "nodeId": "tvm-3601533753_1-20170719t162906z", + "ipAddress": "13.84.190.124", + "port": 50000 + }, + { + "nodeId": "tvm-3601533753_2-20170719t162906z", + "ipAddress": "13.84.190.124", + "port": 50001 + } + ] + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteCluster.json new file mode 100644 index 000000000000..6ae0714066d2 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteCluster.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "clusterName": "demo_cluster", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", + "Retry-After": 15 + } + }, + "200": { + }, + "204": { + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteExperiment.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteExperiment.json new file mode 100644 index 000000000000..bb9bfe17576c --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteExperiment.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "experimentName": "demo_experiment", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", + "Retry-After": 15 + } + }, + "200": { + }, + "204": { + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteFileServer.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteFileServer.json new file mode 100644 index 000000000000..c0dfc900cc9c --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteFileServer.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "fileServerName": "demo_nfs", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", + "Retry-After": 15 + } + }, + "200": { + }, + "204": { + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteJob.json new file mode 100644 index 000000000000..ad639684ee1c --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteJob.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "experimentName": "demo_experiment", + "jobName": "demo_job", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", + "Retry-After": 15 + } + }, + "200": { + }, + "204": { + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteWorkspace.json new file mode 100644 index 000000000000..1234a997beea --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/DeleteWorkspace.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", + "Retry-After": 15 + } + }, + "200": { + }, + "204": { + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetCluster.json new file mode 100644 index 000000000000..bd49ded30a3d --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetCluster.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "clusterName": "demo_cluster", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/clusters/demo_cluster", + "name": "demo_cluster", + "type": "Microsoft.BatchAI/Clusters", + "properties": { + "provisioningState": "succeeded", + "allocationState": "resizing", + "creationTime": "2017-09-27T21:50:02.377Z", + "allocationStateTransitionTime": "2017-09-27T21:50:04.521Z", + "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z", + "vmSize": "STANDARD_NC6", + "currentNodeCount": 0, + "nodeStateCounts": { + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "preparingNodeCount": 0, + "leavingNodeCount": 0 + }, + "vmPriority": "dedicated", + "scaleSettings": { + "manual": { + "targetNodeCount": 1, + "nodeDeallocationOption": "requeue" + } + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "16.04-LTS", + "version": "latest" + } + }, + "userAccountSettings": { + "adminUserName": "admin_user_name" + }, + "nodeSetup": { + "mountVolumes": { + "azureFileShares": [ + { + "accountName": "storage_account_name", + "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", + "credentials": {}, + "relativeMountPath": "azfiles", + "fileMode": "0777", + "directoryMode": "0777" + } + ], + "fileServers": [ + { + "fileServer": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/fileservers/fileservercedd134b" + }, + "relativeMountPath": "nfs", + "mountOptions": "rw" + } + ] + } + }, + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" + } + } + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetExperiment.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetExperiment.json new file mode 100644 index 000000000000..e7e3195ec79d --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetExperiment.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "experimentName": "demo_experiment", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspace/demo_workspace/experiments/demo_experiment", + "name": "demo_experiment", + "type": "Microsoft.BatchAI/Experiments", + "properties": { + "creationTime": "2017-09-27T22:27:52.611Z", + "provisioningState": "succeeded", + "provisioningStateTransitionTime": "2017-09-27T22:28:08.327Z" + } + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetFileServer.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetFileServer.json new file mode 100644 index 000000000000..26728a96f575 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetFileServer.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "fileServerName": "demo_nfs", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/fileservers/fileservercedd134b", + "name": "fileservercedd134b", + "type": "Microsoft.BatchAI/FileServers", + "properties": { + "provisioningState": "succeeded", + "creationTime": "2017-09-27T21:45:28.159Z", + "provisioningStateTransitionTime": "2017-09-27T21:49:25.416Z", + "vmSize": "STANDARD_NC6", + "sshConfiguration": { + "userAccountSettings": { + "adminUserName": "admin_user_name" + } + }, + "dataDisks": { + "diskSizeInGB": 10, + "cachingType": "none", + "diskCount": 2, + "storageAccountType": "Standard_LRS" + }, + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" + }, + "mountSettings": { + "mountPoint": "/mnt/data", + "fileServerPublicIP": "13.90.141.66", + "fileServerInternalIP": "10.0.0.4" + } + } + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetJob.json new file mode 100644 index 000000000000..9cddc22e76d6 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetJob.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "experimentName": "demo_experiment", + "jobName": "demo_job", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/experiments/demo_experiment/jobs/demo_job", + "name": "demo_job", + "type": "Microsoft.BatchAI/Jobs", + "properties": { + "schedulingPriority": "normal", + "cluster": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/clusters/demo_cluster" + }, + "nodeCount": 1, + "containerSettings": { + "imageSourceRegistry": { + "image": "ubuntu" + } + }, + "toolType": "custom", + "customToolkitSettings": { + "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" + }, + "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", + "jobOutputDirectoryPathSegment": "00000000-0000-0000-0000-000000000000/demo_resource_group/workspaces/demo_workspace/experiments/demo_experiment/jobs/demo_job/00000000-0000-0000-0000-000000000000", + "inputDirectories": [ + { + "id": "INPUT", + "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" + } + ], + "outputDirectories": [ + { + "id": "OUTPUTS", + "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", + "pathSuffix": "files" + } + ], + "constraints": { + "maxWallClockTime": "P7D" + }, + "creationTime": "2017-09-27T23:36:52.611Z", + "provisioningState": "succeeded", + "provisioningStateTransitionTime": "2017-09-27T23:36:53.701Z", + "executionState": "running", + "executionStateTransitionTime": "2017-09-27T23:36:56.395Z", + "executionInfo": { + "startTime": "2017-09-27T23:36:54.115Z" + } + } + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetWorkspace.json new file mode 100644 index 000000000000..86c67ea2fdd9 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/GetWorkspace.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace", + "name": "demo_workspace", + "type": "Microsoft.BatchAI/Workspace", + "location": "eastus", + "properties": { + "creationTime": "2017-09-27T21:50:03.828Z", + "provisioningState": "succeeded", + "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z" + } + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/JobListRemoteLoginInfo.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/JobListRemoteLoginInfo.json new file mode 100644 index 000000000000..13b7d5aafe00 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/JobListRemoteLoginInfo.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "experimentName": "demo_experiment", + "jobName": "demo_job", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "nodeId": "tvm-3601533753_1-20170719t162906z", + "ipAddress": "13.84.190.124", + "port": 50000 + } + ] + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListClusterByWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListClusterByWorkspace.json new file mode 100644 index 000000000000..86e7bef7611e --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListClusterByWorkspace.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspace/demo_workspace/clusters/demo_cluster", + "name": "demo_cluster", + "type": "Microsoft.BatchAI/Clusters", + "properties": { + "provisioningState": "succeeded", + "allocationState": "resizing", + "creationTime": "2017-09-27T22:28:07.645Z", + "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", + "provisioningStateTransitionTime": "2017-09-27T22:28:08.327Z", + "vmSize": "STANDARD_NC6", + "currentNodeCount": 0, + "nodeStateCounts": { + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "preparingNodeCount": 0, + "leavingNodeCount": 0 + }, + "vmPriority": "dedicated", + "scaleSettings": { + "manual": { + "targetNodeCount": 1, + "nodeDeallocationOption": "requeue" + } + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "16.04-LTS", + "version": "latest" + } + }, + "userAccountSettings": { + "adminUserName": "admin_user_name" + }, + "nodeSetup": { + "mountVolumes": { + "azureFileShares": [ + { + "accountName": "storage_account_name", + "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", + "credentials": {}, + "relativeMountPath": "azfiles", + "fileMode": "0777", + "directoryMode": "0777" + } + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListExperimentByWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListExperimentByWorkspace.json new file mode 100644 index 000000000000..d3e6990dc623 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListExperimentByWorkspace.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspace/demo_workspace/experiments/demo_experiment", + "name": "demo_experiment", + "type": "Microsoft.BatchAI/Experiments", + "properties": { + "creationTime": "2017-09-27T22:27:52.611Z", + "provisioningState": "succeeded", + "provisioningStateTransitionTime": "2017-09-27T22:28:08.327Z" + } + } + ] + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListFileServerByWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListFileServerByWorkspace.json new file mode 100644 index 000000000000..7eb6060f6fbe --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListFileServerByWorkspace.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/fileservers/fileservercedd134b", + "name": "fileservercedd134b", + "type": "Microsoft.BatchAI/FileServers", + "properties": { + "provisioningState": "succeeded", + "creationTime": "2017-09-27T21:45:28.159Z", + "provisioningStateTransitionTime": "2017-09-27T21:49:25.416Z", + "vmSize": "STANDARD_NC6", + "sshConfiguration": { + "userAccountSettings": { + "adminUserName": "admin_user_name" + } + }, + "dataDisks": { + "diskSizeInGB": 10, + "cachingType": "none", + "diskCount": 2, + "storageAccountType": "Standard_LRS" + }, + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" + }, + "mountSettings": { + "mountPoint": "/mnt/data", + "fileServerPublicIP": "13.90.141.66", + "fileServerInternalIP": "10.0.0.4" + } + } + } + ] + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListJobByExperiment.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListJobByExperiment.json new file mode 100644 index 000000000000..bac6e5cda218 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListJobByExperiment.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "experimentName": "demo_experimnet", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/jobs/demo_job", + "name": "demo_job", + "type": "Microsoft.BatchAI/Jobs", + "properties": { + "schedulingPriority": "normal", + "cluster": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/clusters/demo_cluster" + }, + "nodeCount": 1, + "containerSettings": { + "imageSourceRegistry": { + "image": "ubuntu" + } + }, + "toolType": "custom", + "customToolkitSettings": { + "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" + }, + "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", + "jobOutputDirectoryPathSegment": "00000000-0000-0000-0000-000000000000/demo_resource_group/workspaces/demo_workspace/experiments/demo_experiment/jobs/demo_job/00000000-0000-0000-0000-000000000000", + "inputDirectories": [ + { + "id": "INPUT", + "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" + } + ], + "outputDirectories": [ + { + "id": "OUTPUTS", + "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", + "pathSuffix": "files" + } + ], + "constraints": { + "maxWallClockTime": "P7D" + }, + "creationTime": "2017-09-27T23:36:52.611Z", + "provisioningState": "succeeded", + "provisioningStateTransitionTime": "2017-09-27T23:36:53.701Z", + "executionState": "running", + "executionStateTransitionTime": "2017-09-27T23:36:56.395Z", + "executionInfo": { + "startTime": "2017-09-27T23:36:54.115Z" + } + } + } + ] + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListOperation.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListOperation.json new file mode 100644 index 000000000000..f45e44bfc7ba --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListOperation.json @@ -0,0 +1,299 @@ +{ + "parameters": { + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "value":[ + { + "display": { + "description": "Lists Batch AI workspaces or gets the properties of a Batch AI workspace", + "operation": "List or get Batch AI workspaces", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Workspaces" + }, + "name": "Microsoft.BatchAI/workspaces/read", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Creates a new Batch AI workspace or updates an existing Batch AI workspace", + "operation": "Create or update Batch AI workspace", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Workspaces" + }, + "name": "Microsoft.BatchAI/workspaces/write", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Deletes a Batch AI workspace", + "operation": "Delete Batch AI workspace", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Clusters" + }, + "name": "Microsoft.BatchAI/workspaces/delete", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Lists Batch AI experiments or gets the properties of a Batch AI experiment", + "operation": "List or get Batch AI experiements", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Experiments" + }, + "name": "Microsoft.BatchAI/workspaces/experiments/read", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Creates a new Batch AI experiment or updates an existing Batch AI experiment", + "operation": "Create or update Batch AI experiement", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Experiments" + }, + "name": "Microsoft.BatchAI/workspaces/experiments/write", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Deletes a Batch AI experiment", + "operation": "Delete Batch AI experiment", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Experiments" + }, + "name": "Microsoft.BatchAI/workspaces/experiments/delete", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Lists Batch AI clusters or gets the properties of a Batch AI cluster", + "operation": "List or get Batch AI clusters", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Clusters" + }, + "name": "Microsoft.BatchAI/clusters/read", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Lists Batch AI clusters or gets the properties of a Batch AI cluster", + "operation": "List or get Batch AI clusters", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Clusters" + }, + "name": "Microsoft.BatchAI/workspaces/clusters/read", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Creates a new Batch AI cluster or updates an existing Batch AI cluster", + "operation": "Create or update Batch AI cluster", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Clusters" + }, + "name": "Microsoft.BatchAI/workspaces/clusters/write", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Deletes a Batch AI cluster", + "operation": "Delete Batch AI cluster", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Clusters" + }, + "name": "Microsoft.BatchAI/workspaces/clusters/delete", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Lists remote-login information for a Batch AI cluster", + "operation": "List Batch AI cluster remote-login information", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Clusters" + }, + "name": "Microsoft.BatchAI/workspaces/clusters/remoteLoginInformation/action", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Lists Batch AI jobs or gets the properties of a Batch AI job", + "operation": "List or get Batch AI jobs", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Jobs" + }, + "name": "Microsoft.BatchAI/workspaces/experiments/jobs/read", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Creates a new Batch AI job or updates an existing Batch AI job", + "operation": "Create or update Batch AI job", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Jobs" + }, + "name": "Microsoft.BatchAI/workspaces/experiments/jobs/write", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Deletes a Batch AI job", + "operation": "Delete Batch AI job", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Jobs" + }, + "name": "Microsoft.BatchAI/workspaces/experiments/jobs/delete", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Terminates a Batch AI job", + "operation": "Terminate Batch AI job", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Jobs" + }, + "name": "Microsoft.BatchAI/workspaces/experiments/jobs/terminate/action", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Lists remote-login information for a Batch AI job", + "operation": "List Batch AI job remote-login information", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Jobs" + }, + "name": "Microsoft.BatchAI/workspaces/experiments/jobs/remoteLoginInformation/action", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Lists output files for a Batch AI job", + "operation": "List Batch AI job output files", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Jobs" + }, + "name": "Microsoft.BatchAI/workspaces/experiments/jobs/listoutputfiles/action", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Lists Batch AI fileservers or gets the properties of a Batch AI fileserver", + "operation": "List or get Batch AI fileservers", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Fileservers" + }, + "name": "Microsoft.BatchAI/fileservers/read", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Lists Batch AI fileservers or gets the properties of a Batch AI fileserver", + "operation": "List or get Batch AI fileservers", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Fileservers" + }, + "name": "Microsoft.BatchAI/workspaces/fileservers/read", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Creates a new Batch AI fileserver or updates an existing Batch AI fileserver", + "operation": "Create or update Batch AI fileserver", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Fileservers" + }, + "name": "Microsoft.BatchAI/workspaces/fileservers/write", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Deletes a Batch AI fileserver", + "operation": "Delete Batch AI filserver", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Fileservers" + }, + "name": "Microsoft.BatchAI/workspaces/fileservers/delete", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Gets Batch AI usages of the specified subscription at the specified Azure region", + "operation": "Get Batch AI Usages", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Usages" + }, + "name": "Microsoft.BatchAI/locations/usages/read", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Registers the subscription for the Batch AI Resource Provider and enables the creation of Batch AI resources", + "operation": "Register the Batch AI Resource Provider", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Resource Provider" + }, + "name": "Microsoft.BatchAI/register/action", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Unregisters the subscription for the Batch AI Resource Provider preventing the creation of Batch AI resources", + "operation": "Unregister the Batch AI Resource Provider", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Resource Provider" + }, + "name": "Microsoft.BatchAI/unregister/action", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Gets Batch AI async operation result at the specified Azure region", + "operation": "Get Batch AI Opreation Result", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Operation Results" + }, + "name": "Microsoft.BatchAI/locations/operationresults/read", + "origin": "user,system", + "properties": null + }, + { + "display": { + "description": "Gets Batch AI async operation status at the specified Azure region", + "operation": "Get Batch AI Opreation Status", + "provider": "Microsoft Batch AI", + "resource": "Batch AI Operation Statuses" + }, + "name": "Microsoft.BatchAI/locations/operationstatuses/read", + "origin": "user,system", + "properties": null + } + ] + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListOutputFiles.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListOutputFiles.json new file mode 100644 index 000000000000..1a9676422d27 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListOutputFiles.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "experimentName": "demo_experiment", + "jobName": "demo_job", + "outputdirectoryid": "stdouterr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "stderr-job_prep.txt", + "fileType": "file", + "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/host_prep_stderr.txt?sv=2016-05-31&sr=f&sig=CNPJmjDQT9Anld9%2FdnQ52ZBpfOff2el8r4el6J%2BnpJE%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", + "properties": { + "lastModified": "2017-09-28T00:22:19Z", + "contentLength": 0 + } + }, + { + "name": "stdout-job_prep.txt", + "fileType": "file", + "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/host_prep_stdout.txt?sv=2016-05-31&sr=f&sig=yK%2F5acWSTdcmBZGGL9%2F3IqeZ7N%2B1sRXfwB%2FaCkoRS%2Bc%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", + "properties": { + "lastModified": "2017-09-28T00:22:19Z", + "contentLength": 720 + } + }, + { + "name": "stderr.txt", + "fileType": "file", + "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/stderr.txt?sv=2016-05-31&sr=f&sig=TdvHhdQjvWWA0Z7aPb0oZpPgGbBPOyDarNXWHFnRS3c%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", + "properties": { + "lastModified": "2017-09-28T00:22:19Z", + "contentLength": 0 + } + }, + { + "name": "stdout.txt", + "fileType": "file", + "downloadUrl": "https://storage_account_name.file.core.windows.net/share/00000000-0000-0000-0000-000000000000/test_mgmt_batchai_jobs_test_job_preparation_hoste0e613b6/jobs/job/stdout.txt?sv=2016-05-31&sr=f&sig=nyydEjNnYpQfovknJc%2B5G%2F05g0IV4acWKlfkM35lh00%3D&se=2017-09-28T01%3A22%3A35Z&sp=rl", + "properties": { + "lastModified": "2017-09-28T00:22:19Z", + "contentLength": 32 + } + }, + { + "name": "counters", + "fileType": "directory" + } + ] + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListUsages.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListUsages.json new file mode 100644 index 000000000000..4852be27aa0a --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListUsages.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 5, + "limit": 20, + "name": { + "localizedValue": "Clusters", + "value": "Clusters" + }, + "unit": "Count" + }, + { + "currentValue": 49, + "limit": 600, + "name": { + "localizedValue": "Total Cluster Dedicated Regional vCPUs", + "value": "Total Cluster Dedicated Regional vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 1, + "limit": 600, + "name": { + "localizedValue": "Standard D Family Cluster Dedicated vCPUs", + "value": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 600, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", + "value": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 48, + "limit": 600, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", + "value": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", + "value": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", + "value": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 600, + "name": { + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", + "value": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 150, + "name": { + "localizedValue": "Total Cluster Low Priority Regional vCPUs", + "value": "Total Cluster LowPriority Regional vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 150, + "name": { + "localizedValue": "Standard D Family Cluster Low Priority vCPUs", + "value": "Standard D Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 150, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Low Priority vCPUs", + "value": "Standard Dv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 150, + "name": { + "localizedValue": "Standard NC Family Cluster Low Priority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Low Priority vCPUs", + "value": "Standard NCv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Low Priority vCPUs", + "value": "Standard NCv3 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Low Priority vCPUs", + "value": "Standard ND Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 150, + "name": { + "localizedValue": "Standard NV Family Cluster Low Priority vCPUs", + "value": "Standard NV Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListWorkspace.json new file mode 100644 index 000000000000..4c9d5ace6f2e --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListWorkspace.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspace/demo_workspace", + "name": "demo_workspace", + "type": "Microsoft.BatchAI/Workspaces", + "location": "eastus", + "properties": { + "creationTime": "2017-09-27T22:28:08.325Z", + "provisioningState": "succeeded", + "provisioningStateTransitionTime": "2017-09-27T22:28:08.327Z" + } + } + ] + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListWorkspaceByResourceGroup.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListWorkspaceByResourceGroup.json new file mode 100644 index 000000000000..a2684681d8be --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/ListWorkspaceByResourceGroup.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "demo_resource_group", + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspace/demo_workspace", + "name": "demo_workspace", + "type": "Microsoft.BatchAI/Workspaces", + "location": "eastus", + "properties": { + "creationTime": "2017-09-27T22:28:08.325Z", + "provisioningState": "succeeded", + "provisioningStateTransitionTime": "2017-09-27T22:28:08.327Z" + } + } + ] + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PatchCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PatchCluster.json new file mode 100644 index 000000000000..5d6802d5aabb --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PatchCluster.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "clusterName": "demo_cluster", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01", + "parameters": { + "properties": { + "scaleSettings": { + "autoScale": { + "minimumNodeCount": 0, + "maximumNodeCount": 10 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/clusters/demo_cluster", + "name": "demo_cluster", + "type": "Microsoft.BatchAI/Clusters", + "properties": { + "provisioningState": "succeeded", + "allocationState": "steady", + "creationTime": "2017-09-27T21:43:55.215Z", + "allocationStateTransitionTime": "2017-09-27T21:43:57.664Z", + "provisioningStateTransitionTime": "2017-09-27T21:43:56.238Z", + "vmSize": "STANDARD_NC6", + "currentNodeCount": 0, + "nodeStateCounts": { + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "preparingNodeCount": 0, + "leavingNodeCount": 0 + }, + "vmPriority": "dedicated", + "scaleSettings": { + "autoScale": { + "minimumNodeCount": 0, + "maximumNodeCount": 10, + "initialNodeCount": 0 + } + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "16.04-LTS", + "version": "latest" + } + }, + "userAccountSettings": { + "adminUserName": "admin_user_name" + }, + "nodeSetup": { + "mountVolumes": { + "azureFileShares": [ + { + "accountName": "storage_account_name", + "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", + "credentials": {}, + "relativeMountPath": "azfiles", + "fileMode": "0777", + "directoryMode": "0777" + } + ] + } + } + } + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PatchWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PatchWorkspace.json new file mode 100644 index 000000000000..8986a47f6656 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PatchWorkspace.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01", + "parameters": { + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace", + "name": "demo_worksapce", + "type": "Microsoft.BatchAI/Workspaces", + "location": "eastus", + "tags": { + "key1": "value1" + }, + "properties": { + "creationTime": "2017-09-27T21:50:03.828Z", + "provisioningState": "succeeded", + "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z" + } + } + } + } +} + diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutCluster.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutCluster.json new file mode 100644 index 000000000000..03923a888c84 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutCluster.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "clusterName": "demo_cluster", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01", + "parameters": { + "properties": { + "scaleSettings": { + "manual": { + "nodeDeallocationOption": "requeue", + "targetNodeCount": 1 + } + }, + "userAccountSettings": { + "adminUserPassword": "admin_user_password", + "adminUserSshPublicKey": "ssh-rsa AAAAB3NzaC1yc...", + "adminUserName": "admin_user_name" + }, + "nodeSetup": { + "mountVolumes": { + "fileServers": [ + { + "fileServer": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspaces/fileservers/fileservercedd134b" + }, + "mountOptions": "rw", + "relativeMountPath": "nfs" + } + ], + "azureFileShares": [ + { + "relativeMountPath": "azfiles", + "directoryMode": "0777", + "accountName": "storage_account_name", + "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", + "fileMode": "0777", + "credentials": { + "accountKey": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000==" + } + } + ] + } + }, + "vmPriority": "dedicated", + "vmSize": "STANDARD_NC6" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", + "Retry-After": 15 + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/clusters/demo_cluster", + "name": "demo_cluster", + "type": "Microsoft.BatchAI/Clusters", + "properties": { + "provisioningState": "succeeded", + "allocationState": "resizing", + "creationTime": "2017-09-27T21:50:02.377Z", + "allocationStateTransitionTime": "2017-09-27T21:50:04.521Z", + "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z", + "vmSize": "STANDARD_NC6", + "currentNodeCount": 0, + "nodeStateCounts": { + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "preparingNodeCount": 0, + "leavingNodeCount": 0 + }, + "vmPriority": "dedicated", + "scaleSettings": { + "manual": { + "targetNodeCount": 1, + "nodeDeallocationOption": "requeue" + } + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "16.04-LTS", + "version": "latest" + } + }, + "userAccountSettings": { + "adminUserName": "admin_user_name" + }, + "nodeSetup": { + "mountVolumes": { + "azureFileShares": [ + { + "accountName": "storage_account_name", + "azureFileUrl": "https://storage_account_name.file.core.windows.net/azure_file_share_name", + "credentials": {}, + "relativeMountPath": "azfiles", + "fileMode": "0777", + "directoryMode": "0777" + } + ], + "fileServers": [ + { + "fileServer": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspaces/fileservers/fileservercedd134b" + }, + "relativeMountPath": "nfs", + "mountOptions": "rw" + } + ] + } + }, + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" + } + } + } + } + } +} + diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutExperiment.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutExperiment.json new file mode 100644 index 000000000000..46c23bd97e1e --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutExperiment.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "experimentName": "demo_experiment", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01", + "parameters": { + "properties": { + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", + "Retry-After": 15 + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/experiments/demo_experiment", + "name": "demo_experiment", + "type": "Microsoft.BatchAI/Experiments", + "properties": { + "creationTime": "2017-09-27T21:49:52.611Z", + "provisioningState": "succeeded", + "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z" + } + } + } + } +} + diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutFileServer.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutFileServer.json new file mode 100644 index 000000000000..86208593a021 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutFileServer.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "fileServerName": "demo_nfs", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01", + "parameters": { + "properties": { + "sshConfiguration": { + "userAccountSettings": { + "adminUserPassword": "admin_user_password", + "adminUserName": "admin_user_name" + } + }, + "dataDisks": { + "diskSizeInGB": 10, + "storageAccountType": "Standard_LRS", + "diskCount": 2 + }, + "vmSize": "STANDARD_NC6" + } + } + }, + "responses": { + "200": { + "parameters": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/fileservers/fileservercedd134b", + "name": "demo_nfs", + "type": "Microsoft.BatchAI/FileServers", + "properties": { + "provisioningState": "succeeded", + "creationTime": "2017-09-27T21:45:28.159Z", + "provisioningStateTransitionTime": "2017-09-27T21:49:25.416Z", + "vmSize": "STANDARD_NC6", + "sshConfiguration": { + "userAccountSettings": { + "adminUserName": "admin_user_name" + } + }, + "dataDisks": { + "diskSizeInGB": 10, + "cachingType": "none", + "diskCount": 2, + "storageAccountType": "Standard_LRS" + }, + "subnet": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.Network/virtualNetworks/7feb1976-8c31-4f1f-bea2-86cb1839a7bavnet/subnets/Subnet-1" + }, + "mountSettings": { + "mountPoint": "/mnt/data", + "fileServerPublicIP": "13.90.141.66", + "fileServerInternalIP": "10.0.0.4" + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", + "Retry-After": 15 + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutJob.json new file mode 100644 index 000000000000..8d9d08d6cb20 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutJob.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "experimentName": "demo_experiment", + "jobName": "demo_job", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01", + "parameters": { + "properties": { + "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", + "cluster": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspace/demo_workspace/clusters/demo_cluster" + }, + "nodeCount": 1, + "customToolkitSettings": { + "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" + }, + "inputDirectories": [ + { + "id": "INPUT", + "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" + } + ], + "schedulingPriority": "normal", + "containerSettings": { + "imageSourceRegistry": { + "image": "ubuntu" + } + }, + "outputDirectories": [ + { + "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", + "id": "OUTPUTS", + "pathSuffix": "files" + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", + "Retry-After": 15 + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/experiments/demo_experiment/jobs/demo_job", + "name": "demo_job", + "type": "Microsoft.BatchAI/Job", + "properties": { + "schedulingPriority": "normal", + "cluster": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace/clusters/demo_cluster" + }, + "nodeCount": 1, + "containerSettings": { + "imageSourceRegistry": { + "image": "ubuntu" + } + }, + "toolType": "custom", + "customToolkitSettings": { + "commandLine": "echo hi | tee $AZ_BATCHAI_OUTPUT_OUTPUTS/hi.txt" + }, + "stdOutErrPathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles", + "jobOutputDirectoryPathSegment": "00000000-0000-0000-0000-000000000000/demo_resource_group/workspaces/demo_workspace/00000000-0000-0000-0000-000000000000/experiments/demo_experiment/00000000-0000-0000-0000-000000000000/jobs/demo_job/00000000-0000-0000-0000-000000000000", + "inputDirectories": [ + { + "id": "INPUT", + "path": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/input" + } + ], + "outputDirectories": [ + { + "id": "OUTPUTS", + "pathPrefix": "$AZ_BATCHAI_MOUNT_ROOT/azfiles/", + "pathSuffix": "files" + } + ], + "constraints": { + "maxWallClockTime": "P7D" + }, + "creationTime": "2017-09-27T23:36:52.611Z", + "provisioningState": "succeeded", + "provisioningStateTransitionTime": "2017-09-27T23:36:53.701Z", + "executionState": "running", + "executionStateTransitionTime": "2017-09-27T23:36:56.395Z", + "executionInfo": { + "startTime": "2017-09-27T23:36:54.115Z" + } + } + } + } + } +} diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutWorkspace.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutWorkspace.json new file mode 100644 index 000000000000..405e3970491d --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/PutWorkspace.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", + "Retry-After": 15 + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.BatchAI/workspaces/demo_workspace", + "name": "demo_worksapce", + "type": "Microsoft.BatchAI/Workspaces", + "location": "eastus", + "properties": { + "creationTime": "2017-09-27T21:50:03.828Z", + "provisioningState": "succeeded", + "provisioningStateTransitionTime": "2017-09-27T21:50:03.828Z" + } + } + } + } +} + diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/TerminateJob.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/TerminateJob.json new file mode 100644 index 000000000000..9376a6b307f8 --- /dev/null +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/examples/TerminateJob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "experimentName": "demo_experiment", + "jobName": "demo_job", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-05-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.BatchAI/locations/eastus/operationresults/7e69f371-db62-4183-bba0-5ee577d43bd7?api-version=2018-05-01", + "Retry-After": 15 + } + }, + "200": { + } + } +} diff --git a/specification/batchai/resource-manager/readme.md b/specification/batchai/resource-manager/readme.md index 704485786417..16ddf36b1a0d 100644 --- a/specification/batchai/resource-manager/readme.md +++ b/specification/batchai/resource-manager/readme.md @@ -24,7 +24,7 @@ These are the global settings for the Batch AI. ``` yaml openapi-type: arm -tag: package-2018-03 +tag: package-2018-05 ``` @@ -42,10 +42,19 @@ input-file: These settings apply only when `--tag=package-2018-03` is specified on the command line. ``` yaml $(tag) == 'package-2018-03' -input-file: +input-file: - Microsoft.BatchAI/stable/2018-03-01/BatchAI.json ``` +### Tag: package-2018-05 + +These settings apply only when `--tag=package-2018-05` is specified on the command line. + +``` yaml $(tag) == 'package-2018-05' +input-file: +- Microsoft.BatchAI/stable/2018-05-01/BatchAI.json +``` + --- # Code Generation @@ -58,7 +67,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node ``` @@ -123,6 +132,7 @@ go: batch: - tag: package-2017-09-preview - tag: package-2018-03 + - tag: package-2018-05 ``` ### Tag: package-2017-09-preview and go @@ -131,7 +141,7 @@ These settings apply only when `--tag=package-2017-09-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2017-09-preview' && $(go) -output-folder: $(go-sdk-folder)/services/batchai/mgmt/2017-09-preview/batchai +output-folder: $(go-sdk-folder)/services/preview/batchai/mgmt/2017-09-preview/batchai ``` ### Tag: package-2018-03 and go @@ -143,17 +153,73 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2018-05' && $(go) +output-folder: $(go-sdk-folder)/services/batchai/mgmt/2018-05-01/batchai +``` + ## Java These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.batchai +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-batchai +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-09-preview + - tag: package-2018-03 + - tag: package-2018-05 +``` + +### Tag: package-2017-09-preview and java + +These settings apply only when `--tag=package-2017-09-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag)=='package-2017-09-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.batchai - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-batchai + namespace: com.microsoft.azure.management.batchai.v2017_09_01_preview + output-folder: $(azure-libraries-for-java-folder)/batchai/resource-manager/v2017_09_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-03 and java + +These settings apply only when `--tag=package-2018-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag)=='package-2018-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.batchai.v2018_03_01 + output-folder: $(azure-libraries-for-java-folder)/batchai/resource-manager/v2018_03_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-05 and java + +These settings apply only when `--tag=package-2018-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag)=='package-2018-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.batchai.v2018_05_01 + output-folder: $(azure-libraries-for-java-folder)/batchai/resource-manager/v2018_05_01 +regenerate-manager: true +generate-interface: true ``` diff --git a/specification/batchai/resource-manager/readme.nodejs.md b/specification/batchai/resource-manager/readme.nodejs.md index 3289d8712ed2..4672965e3546 100644 --- a/specification/batchai/resource-manager/readme.nodejs.md +++ b/specification/batchai/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder=`. ``` yaml $(tag) == 'package-2018-03-preview' && $(go) -output-folder: $(go-sdk-folder)/services/billing/mgmt/2018-03-01-preview/billing +output-folder: $(go-sdk-folder)/services/preview/billing/mgmt/2018-03-01-preview/billing ``` ### Tag: package-2017-04-preview and go @@ -152,7 +155,7 @@ These settings apply only when `--tag=package-2017-04-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-04-preview' && $(go) -output-folder: $(go-sdk-folder)/services/billing/mgmt/2017-04-24-preview/billing +output-folder: $(go-sdk-folder)/services/preview/billing/mgmt/2017-04-24-preview/billing ``` ### Tag: package-2017-02-preview and go @@ -161,7 +164,7 @@ These settings apply only when `--tag=package-2017-02-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-02-preview' && $(go) -output-folder: $(go-sdk-folder)/services/billing/mgmt/2017-02-27-preview/billing +output-folder: $(go-sdk-folder)/services/preview/billing/mgmt/2017-02-27-preview/billing ``` @@ -171,11 +174,60 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.billing +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-billing +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-04-preview + - tag: package-2018-03-preview + - tag: package-2017-02-preview +``` + +### Tag: package-2017-04-preview and java + +These settings apply only when `--tag=package-2017-04-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.billing - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-billing + namespace: com.microsoft.azure.management.billing.v2017_04_24_preview + output-folder: $(azure-libraries-for-java-folder)/billing/resource-manager/v2017_04_24_preview +regenerate-manager: true +generate-interface: true ``` + +### Tag: package-2018-03-preview and java + +These settings apply only when `--tag=package-2018-03-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-03-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.billing.v2018_03_01_preview + output-folder: $(azure-libraries-for-java-folder)/billing/resource-manager/v2018_03_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-02-preview and java + +These settings apply only when `--tag=package-2017-02-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-02-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.billing.v2017_02_27_preview + output-folder: $(azure-libraries-for-java-folder)/billing/resource-manager/v2017_02_27_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/billing/resource-manager/readme.ruby.md b/specification/billing/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..1aa6339d90ab --- /dev/null +++ b/specification/billing/resource-manager/readme.ruby.md @@ -0,0 +1,37 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_billing +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2017-04-preview + - tag: package-2017-02-preview +``` + +### Tag: package-2017-04-preview and ruby + +These settings apply only when `--tag=package-2017-04-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-04-preview' && $(ruby) +namespace: "Azure::Billing::Mgmt::V2017_04_24_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_billing/lib +``` + +### Tag: package-2017-02-preview and ruby + +These settings apply only when `--tag=package-2017-02-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-02-preview' && $(ruby) +namespace: "Azure::Billing::Mgmt::V2017_02_27_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_billing/lib +``` diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/botservice.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/botservice.json new file mode 100644 index 000000000000..0b368eefc5c7 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/botservice.json @@ -0,0 +1,2249 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Bot Service", + "description": "Azure Bot Service is a platform for creating smart conversational agents.", + "version": "2017-12-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}": { + "put": { + "tags": [ + "Bot" + ], + "description": "Creates a Bot Service. Bot Service is a resource group wide resource type.", + "operationId": "Bots_Create", + "x-ms-examples": { + "Create Bot": { + "$ref": "./examples/CreateBot.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Bot" + }, + "description": "The parameters to provide for the created bot." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "Bot" + ], + "description": "Updates a Bot Service", + "operationId": "Bots_Update", + "x-ms-examples": { + "Update Bot": { + "$ref": "./examples/UpdateBot.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/Bot" + }, + "description": "The parameters to provide for the created bot." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "201": { + "description": "If resource is updated successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "Bot" + ], + "description": "Deletes a Bot Service from the resource group. ", + "operationId": "Bots_Delete", + "x-ms-examples": { + "Delete Bot": { + "$ref": "./examples/DeleteBot.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "Bot" + ], + "description": "Returns a BotService specified by the parameters.", + "operationId": "Bots_Get", + "x-ms-examples": { + "Get Bot": { + "$ref": "./examples/GetBot.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices": { + "get": { + "tags": [ + "Bot" + ], + "description": "Returns all the resources of a particular type belonging to a resource group", + "operationId": "Bots_ListByResourceGroup", + "x-ms-examples": { + "List Bots by Resource Group": { + "$ref": "./examples/ListBotsByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with \"value\" property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "schema": { + "$ref": "#/definitions/BotResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/botServices": { + "get": { + "tags": [ + "Bot" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "Bots_List", + "x-ms-examples": { + "List Bots by Subscription": { + "$ref": "./examples/ListBotsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", + "schema": { + "$ref": "#/definitions/BotResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}": { + "put": { + "tags": [ + "Channel" + ], + "description": "Creates a Channel registration for a Bot Service", + "operationId": "Channels_Create", + "x-ms-examples": { + "Create Bot": { + "$ref": "./examples/PutChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/channelNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BotChannel" + }, + "description": "The parameters to provide for the created bot." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "Channel" + ], + "description": "Updates a Channel registration for a Bot Service", + "operationId": "Channels_Update", + "x-ms-examples": { + "Update Bot": { + "$ref": "./examples/UpdateChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/channelNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/BotChannel" + }, + "description": "The parameters to provide for the created bot." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "201": { + "description": "If resource is updated successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "Channel" + ], + "description": "Deletes a Channel registration from a Bot Service", + "operationId": "Channels_Delete", + "x-ms-examples": { + "Delete Bot": { + "$ref": "./examples/DeleteChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "channelName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot resource." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "Channel" + ], + "description": "Returns a BotService Channel registration specified by the parameters.", + "operationId": "Channels_Get", + "x-ms-examples": { + "Get Bot": { + "$ref": "./examples/GetChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "channelName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot resource." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/listChannelWithKeys": { + "post": { + "tags": [ + "Channel" + ], + "description": "Lists a Channel registration for a Bot Service including secrets", + "operationId": "Channels_ListWithKeys", + "x-ms-examples": { + "List Channel": { + "$ref": "./examples/ListChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/channelNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is retrieved successfully, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels": { + "get": { + "tags": [ + "Channel" + ], + "description": "Returns all the Channel registrations of a particular BotService resource", + "operationId": "Channels_ListByResourceGroup", + "x-ms-examples": { + "List Bots by Resource Group": { + "$ref": "./examples/ListChannelsByBotService.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with \"value\" property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "schema": { + "$ref": "#/definitions/ChannelResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.BotService/botServices/checkNameAvailability": { + "get": { + "tags": [ + "Bot" + ], + "description": "Check whether a bot name is available.", + "operationId": "Bots_GetCheckNameAvailability", + "x-ms-examples": { + "List Bots by Subscription": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityRequestBody" + }, + "description": "The request body parameters to provide for the check name availability request" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResponseBody" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.BotService/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all the available BotService operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Get Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/OperationEntityListResult" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/listAuthServiceProviders": { + "post": { + "tags": [ + "ListServiceProviders" + ], + "description": "Lists the available Service Providers for creating Connection Settings", + "operationId": "BotConnection_ListServiceProviders", + "x-ms-examples": { + "List Auth Service Providers": { + "$ref": "./examples/ListServiceProviders.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is retrieved successfully, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/ServiceProviderResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/Connections/{connectionName}/listWithSecrets": { + "post": { + "tags": [ + "BotConnection" + ], + "x-ms-examples": { + "Update Connection Setting": { + "$ref": "./examples/GetConnection.json" + } + }, + "description": "Get a Connection Setting registration for a Bot Service", + "operationId": "BotConnection_ListWithSecrets", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/Connections/{connectionName}": { + "put": { + "tags": [ + "BotConnection" + ], + "description": "Register a new Auth Connection for a Bot Service", + "operationId": "BotConnection_Create", + "x-ms-examples": { + "Create Connection Setting": { + "$ref": "./examples/PutConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionSetting" + }, + "description": "The parameters to provide for creating the Connection Setting." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "BotConnection" + ], + "description": "Updates a Connection Setting registration for a Bot Service", + "operationId": "BotConnection_Update", + "x-ms-examples": { + "Update Connection Setting": { + "$ref": "./examples/UpdateConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionSetting" + }, + "description": "The parameters to provide for updating the Connection Setting." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "BotConnection" + ], + "x-ms-examples": { + "Update Connection Setting": { + "$ref": "./examples/GetConnection.json" + } + }, + "description": "Get a Connection Setting registration for a Bot Service", + "operationId": "BotConnection_Get", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "BotConnection" + ], + "description": "Deletes a Connection Setting registration for a Bot Service", + "operationId": "BotConnection_Delete", + "x-ms-examples": { + "Update Connection Setting": { + "$ref": "./examples/DeleteConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections": { + "get": { + "tags": [ + "BotConnection" + ], + "description": "Returns all the Connection Settings registered to a particular BotService resource", + "operationId": "BotConnection_ListByBotService", + "x-ms-examples": { + "List Connection Settings": { + "$ref": "./examples/ListConnectionsByBotService.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with \"value\" property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "schema": { + "$ref": "#/definitions/ConnectionSettingResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Resource": { + "description": "Azure resource", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "Specifies the resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Specifies the name of the resource.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "type": { + "description": "Specifies the type of the resource.", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU of the resource." + }, + "kind": { + "$ref": "#/definitions/Kind", + "description": "Required. Gets or sets the Kind of the resource." + }, + "etag": { + "type": "string", + "description": "Entity Tag" + } + } + }, + "Sku": { + "properties": { + "name": { + "$ref": "#/definitions/SkuName", + "description": "The sku name" + }, + "tier": { + "readOnly": true, + "type": "string", + "description": "Gets the sku tier. This is based on the SKU name.", + "enum": [ + "Free", + "Standard" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + }, + "required": [ + "name" + ], + "description": "The SKU of the cognitive services account." + }, + "SkuName": { + "type": "string", + "description": "The name of SKU.", + "enum": [ + "F0", + "S1" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "Kind": { + "type": "string", + "description": "Indicates the type of bot service", + "enum": [ + "sdk", + "designer", + "bot", + "function" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + }, + "Bot": { + "type": "object", + "description": "Bot resource definition", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BotProperties", + "description": "The set of properties specific to bot resource" + } + } + }, + "BotProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "The Name of the bot" + }, + "description": { + "type": "string", + "description": "The description of the bot" + }, + "iconUrl": { + "type": "string", + "description": "The Icon Url of the bot" + }, + "endpoint": { + "type": "string", + "description": "The bot's endpoint" + }, + "endpointVersion": { + "type": "string", + "readOnly": true, + "description": "The bot's endpoint version" + }, + "msaAppId": { + "type": "string", + "description": "Microsoft App Id for the bot" + }, + "configuredChannels": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Collection of channels for which the bot is configured" + }, + "enabledChannels": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Collection of channels for which the bot is enabled" + }, + "developerAppInsightKey": { + "type": "string", + "description": "The Application Insights key" + }, + "developerAppInsightsApiKey": { + "type": "string", + "description": "The Application Insights Api Key" + }, + "developerAppInsightsApplicationId": { + "type": "string", + "description": "The Application Insights App Id" + }, + "luisAppIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of LUIS App Ids" + }, + "luisKey": { + "type": "string", + "description": "The LUIS Key" + } + }, + "description": "The parameters to provide for the Bot.", + "required": [ + "displayName", + "endpoint", + "msaAppId" + ] + }, + "BotResponseList": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of bot service resources.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Bot" + }, + "description": "Gets the list of bot service results and their properties." + } + }, + "description": "The list of bot service operation response." + }, + "BotChannel": { + "type": "object", + "description": "Bot channel resource definition", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/Channel", + "description": "The set of properties specific to bot channel resource" + } + } + }, + "Channel": { + "type": "object", + "description": "Channel definition", + "discriminator": "channelName", + "properties": { + "channelName": { + "type": "string", + "description": "The channel name" + } + }, + "required": [ + "channelName" + ] + }, + "FacebookChannel": { + "type": "object", + "description": "Facebook channel definition", + "x-ms-discriminator-value": "FacebookChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FacebookChannelProperties", + "description": "The set of properties specific to bot facebook channel" + } + } + }, + "FacebookChannelProperties": { + "properties": { + "verifyToken": { + "type": "string", + "readOnly": true, + "description": "Verify token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "pages": { + "type": "array", + "items": { + "$ref": "#/definitions/FacebookPage" + }, + "description": "The list of Facebook pages" + }, + "appId": { + "type": "string", + "description": "Facebook application id" + }, + "appSecret": { + "type": "string", + "description": "Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "callbackUrl": { + "type": "string", + "readOnly": true, + "description": "Callback Url" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Facebook channel.", + "required": [ + "appId", + "appSecret", + "isEnabled" + ] + }, + "FacebookPage": { + "properties": { + "id": { + "type": "string", + "description": "Page id" + }, + "accessToken": { + "type": "string", + "description": "Facebook application access token. Value only returned through POST to the action Channel List API, otherwise empty." + } + }, + "description": "A Facebook page for Facebook channel registration", + "required": [ + "id", + "accessToken" + ] + }, + "EmailChannel": { + "type": "object", + "description": "Email channel definition", + "x-ms-discriminator-value": "EmailChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EmailChannelProperties", + "description": "The set of properties specific to email channel resource" + } + } + }, + "EmailChannelProperties": { + "properties": { + "emailAddress": { + "type": "string", + "description": "The email address" + }, + "password": { + "type": "string", + "description": "The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Email channel.", + "required": [ + "emailAddress", + "password", + "isEnabled" + ] + }, + "MsTeamsChannel": { + "type": "object", + "x-ms-discriminator-value": "MsTeamsChannel", + "description": "Microsoft Teams channel definition", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MsTeamsChannelProperties", + "description": "The set of properties specific to Microsoft Teams channel resource" + } + } + }, + "MsTeamsChannelProperties": { + "properties": { + "enableMessaging": { + "type": "boolean", + "description": "Enable messaging for Microsoft Teams channel" + }, + "enableMediaCards": { + "type": "boolean", + "description": "Enable media cards for Microsoft Teams channel" + }, + "enableVideo": { + "type": "boolean", + "description": "Enable video for Microsoft Teams channel" + }, + "enableCalling": { + "type": "boolean", + "description": "Enable calling for Microsoft Teams channel" + }, + "callMode": { + "type": "string", + "description": "Enable messaging for Microsoft Teams channel" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Microsoft Teams channel.", + "required": [ + "isEnabled" + ] + }, + "SkypeChannel": { + "type": "object", + "description": "Skype channel definition", + "x-ms-discriminator-value": "SkypeChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SkypeChannelProperties", + "description": "The set of properties specific to Skype channel resource" + } + } + }, + "SkypeChannelProperties": { + "properties": { + "enableMessaging": { + "type": "boolean", + "description": "Enable messaging for Skype channel" + }, + "enableMediaCards": { + "type": "boolean", + "description": "Enable media cards for Skype channel" + }, + "enableVideo": { + "type": "boolean", + "description": "Enable video for Skype channel" + }, + "enableCalling": { + "type": "boolean", + "description": "Enable calling for Skype channel" + }, + "enableScreenSharing": { + "type": "boolean", + "description": "Enable screen sharing for Skype channel" + }, + "enableGroups": { + "type": "boolean", + "description": "Enable groups for Skype channel" + }, + "groupsMode": { + "type": "string", + "description": "Group mode for Skype channel" + }, + "callingWebHook": { + "type": "string", + "description": "Calling web hook for Skype channel" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Microsoft Teams channel.", + "required": [ + "isEnabled" + ] + }, + "KikChannel": { + "type": "object", + "x-ms-discriminator-value": "KikChannel", + "description": "Kik channel definition", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/KikChannelProperties", + "description": "The set of properties specific to Kik channel resource" + } + } + }, + "KikChannelProperties": { + "properties": { + "userName": { + "type": "string", + "description": "The Kik user name" + }, + "apiKey": { + "type": "string", + "description": "Kik API key. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "type": "boolean", + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Kik channel.", + "required": [ + "userName", + "apiKey", + "isEnabled" + ] + }, + "WebChatChannel": { + "type": "object", + "x-ms-discriminator-value": "WebChatChannel", + "description": "Web Chat channel definition", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WebChatChannelProperties", + "description": "The set of properties specific to Web Chat channel resource" + } + } + }, + "WebChatChannelProperties": { + "properties": { + "webChatEmbedCode": { + "type": "string", + "x-ms-mutability": [ + "read" + ], + "readOnly": true, + "description": "Web chat control embed code" + }, + "sites": { + "type": "array", + "items": { + "$ref": "#/definitions/WebChatSite" + }, + "description": "The list of Web Chat sites" + } + }, + "description": "The parameters to provide for the Web Chat channel." + }, + "DirectLineChannel": { + "type": "object", + "x-ms-discriminator-value": "DirectLineChannel", + "description": "Direct Line channel definition", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DirectLineChannelProperties", + "description": "The set of properties specific to Direct Line channel resource" + } + } + }, + "DirectLineChannelProperties": { + "properties": { + "sites": { + "type": "array", + "items": { + "$ref": "#/definitions/DirectLineSite" + }, + "description": "The list of Direct Line sites" + } + }, + "description": "The parameters to provide for the Direct Line channel." + }, + "TelegramChannel": { + "type": "object", + "description": "Telegram channel definition", + "x-ms-discriminator-value": "TelegramChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TelegramChannelProperties", + "description": "The set of properties specific to Telegram channel resource" + } + } + }, + "TelegramChannelProperties": { + "properties": { + "accessToken": { + "type": "string", + "description": "The Telegram access token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "type": "boolean", + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Telegram channel.", + "required": [ + "accessToken", + "isEnabled" + ] + }, + "SmsChannel": { + "type": "object", + "description": "Sms channel definition", + "x-ms-discriminator-value": "SmsChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SmsChannelProperties", + "description": "The set of properties specific to Sms channel resource" + } + } + }, + "SmsChannelProperties": { + "properties": { + "phone": { + "type": "string", + "description": "The Sms phone" + }, + "accountSID": { + "type": "string", + "description": "The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "authToken": { + "type": "string", + "description": "The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "type": "boolean", + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Sms channel.", + "required": [ + "phone", + "accountSID", + "authToken", + "isEnabled" + ] + }, + "SlackChannel": { + "type": "object", + "description": "Slack channel definition", + "x-ms-discriminator-value": "SlackChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SlackChannelProperties", + "description": "The set of properties specific to Slack channel resource" + } + } + }, + "SlackChannelProperties": { + "properties": { + "clientId": { + "type": "string", + "description": "The Slack client id" + }, + "clientSecret": { + "type": "string", + "description": "The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "verificationToken": { + "type": "string", + "description": "The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "landingPageUrl": { + "type": "string", + "description": "The Slack landing page Url" + }, + "redirectAction": { + "type": "string", + "description": "The Slack redirect action", + "readOnly": true + }, + "lastSubmissionId": { + "type": "string", + "description": "The Sms auth token", + "readOnly": true + }, + "registerBeforeOAuthFlow": { + "type": "boolean", + "description": "Whether to register the settings before OAuth validation is performed. Recommended to True.", + "readOnly": true + }, + "isValidated": { + "type": "boolean", + "description": "Whether this channel is validated for the bot", + "readOnly": true + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Slack channel.", + "required": [ + "clientId", + "clientSecret", + "verificationToken", + "isEnabled" + ] + }, + "ChannelResponseList": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of bot service channel resources.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/BotChannel" + }, + "description": "Gets the list of bot service channel results and their properties." + } + }, + "description": "The list of bot service channel operation response." + }, + "WebChatSite": { + "properties": { + "siteId": { + "type": "string", + "description": "Site Id", + "x-ms-mutability": [ + "read" + ], + "readOnly": true + }, + "siteName": { + "type": "string", + "description": "Site name" + }, + "key": { + "type": "string", + "description": "Primary key. Value only returned through POST to the action Channel List API, otherwise empty.", + "x-ms-mutability": [ + "read" + ], + "readOnly": true + }, + "key2": { + "type": "string", + "description": "Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.", + "x-ms-mutability": [ + "read" + ], + "readOnly": true + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this site is enabled for DirectLine channel" + }, + "enablePreview": { + "type": "boolean", + "description": "Whether this site is enabled for preview versions of Webchat" + } + }, + "required": [ + "siteName", + "isEnabled", + "enablePreview" + ], + "description": "A site for the Webchat channel" + }, + "DirectLineSite": { + "properties": { + "siteId": { + "x-ms-mutability": [ + "read" + ], + "type": "string", + "description": "Site Id", + "readOnly": true + }, + "siteName": { + "type": "string", + "description": "Site name" + }, + "key": { + "x-ms-mutability": [ + "read" + ], + "type": "string", + "description": "Primary key. Value only returned through POST to the action Channel List API, otherwise empty.", + "readOnly": true + }, + "key2": { + "x-ms-mutability": [ + "read" + ], + "type": "string", + "description": "Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.", + "readOnly": true + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this site is enabled for DirectLine channel" + }, + "isV1Enabled": { + "type": "boolean", + "description": "Whether this site is enabled for Bot Framework V1 protocol" + }, + "isV3Enabled": { + "type": "boolean", + "description": "Whether this site is enabled for Bot Framework V1 protocol" + } + }, + "description": "A site for the Direct Line channel", + "required": [ + "isV1Enabled", + "isV3Enabled", + "isEnabled", + "siteName" + ] + }, + "ConnectionItemName": { + "properties": { + "name": { + "type": "string", + "description": "Connection Item name that has been added in the API", + "readOnly": true + } + }, + "description": "The display name of a connection Item Setting registered with the Bot" + }, + "ConnectionSettingParameter": { + "properties": { + "key": { + "type": "string", + "description": "Key for the Connection Setting Parameter." + }, + "value": { + "type": "string", + "description": "Value associated with the Connection Setting Parameter." + } + }, + "description": "Extra Parameter in a Connection Setting Properties to indicate service provider specific properties" + }, + "ConnectionSettingProperties": { + "properties": { + "clientId": { + "type": "string", + "description": "Client Id associated with the Connection Setting." + }, + "settingId": { + "type": "string", + "description": "Setting Id set by the service for the Connection Setting.", + "readOnly": true + }, + "clientSecret": { + "type": "string", + "description": "Client Secret associated with the Connection Setting" + }, + "scopes": { + "type": "string", + "description": "Scopes associated with the Connection Setting" + }, + "serviceProviderId": { + "type": "string", + "description": "Service Provider Id associated with the Connection Setting" + }, + "serviceProviderDisplayName": { + "type": "string", + "description": "Service Provider Display Name associated with the Connection Setting" + }, + "parameters": { + "type": "array", + "description": "Service Provider Parameters associated with the Connection Setting", + "items": { + "$ref": "#/definitions/ConnectionSettingParameter" + } + } + }, + "description": "Properties for a Connection Setting Item" + }, + "ConnectionSetting": { + "type": "object", + "description": "Bot channel resource definition", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ConnectionSettingProperties", + "description": "The set of properties specific to bot channel resource" + } + } + }, + "ConnectionSettingResponseList": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of bot service connection setting resources.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionSetting" + }, + "description": "Gets the list of bot service connection settings and their properties." + } + }, + "description": "The list of bot service connection settings response." + }, + "ServiceProviderResponseList": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of bot service service providers.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ServiceProvider" + }, + "description": "Gets the list of bot service service providers and their properties." + } + }, + "description": "The list of bot service service providers response." + }, + "ServiceProviderParameter": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Service Provider", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the Service Provider", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Service Provider", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the Service Provider", + "readOnly": true + }, + "helpUrl": { + "type": "string", + "description": "Help Url for the Service Provider", + "readOnly": true + }, + "default": { + "type": "string", + "description": "Default Name for the Service Provider", + "readOnly": true + } + }, + "description": "Extra Parameters specific to each Service Provider" + }, + "ServiceProviderProperties": { + "properties": { + "id": { + "type": "string", + "description": "Id for Service Provider", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Diplay Name of the Service Provider", + "readOnly": true + }, + "serviceProviderName": { + "type": "string", + "description": "Diplay Name of the Service Provider", + "readOnly": true + }, + "devPortalUrl": { + "type": "string", + "description": "Diplay Name of the Service Provider", + "readOnly": true + }, + "iconUrl": { + "type": "string", + "description": "Diplay Name of the Service Provider", + "readOnly": true + }, + "parameters": { + "description": "The list of parameters for the Service Provider", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceProviderParameter" + } + } + }, + "description": "The Object used to describe a Service Provider supported by Bot Service" + }, + "ServiceProvider": { + "type": "object", + "description": "Service Provider Definition", + "properties": { + "properties": { + "$ref": "#/definitions/ServiceProviderProperties", + "description": "The Properties of a Service Provider Object" + } + } + }, + "Error": { + "properties": { + "error": { + "$ref": "#/definitions/ErrorBody", + "description": "The error body." + } + }, + "description": "Bot Service error object." + }, + "ErrorBody": { + "properties": { + "code": { + "type": "string", + "description": "error code" + }, + "message": { + "type": "string", + "description": "error message" + } + }, + "description": "Bot Service error body.", + "required": [ + "code", + "message" + ] + }, + "OperationEntityListResult": { + "description": "The list of bot service operation response.", + "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 operations supported by Bot Service Management.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The operation supported by Bot Service Management." + }, + "origin": { + "description": "The origin of the operation.", + "type": "string" + }, + "properties": { + "description": "Additional properties.", + "type": "object" + } + } + }, + "OperationDisplayInfo": { + "description": "The operation supported by Bot Service Management.", + "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 Bot Service.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + } + } + }, + "CheckNameAvailabilityRequestBody": { + "description": "The request body for a request to Bot Service Management to check availability of a bot name.", + "type": "object", + "properties": { + "name": { + "description": "the name of the bot for which availability needs to be checked.", + "type": "string" + }, + "type": { + "description": "the type of the bot for which availability needs to be checked", + "type": "string" + } + } + }, + "CheckNameAvailabilityResponseBody": { + "description": "The response body returned for a request to Bot Service Management to check availability of a bot name.", + "type": "object", + "properties": { + "valid": { + "description": "indicates if the bot name is valid.", + "type": "boolean" + }, + "message": { + "description": "additional message from the bot management api showing why a bot name is not available", + "type": "string" + } + } + } + }, + "parameters": { + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot resource group in the user subscription." + }, + "resourceNameParameter": { + "name": "resourceName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot resource." + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2017-12-01" + }, + "connectionNameParameter": { + "name": "connectionName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot Service Connection Setting resource" + }, + "channelNameParameter": { + "name": "channelName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "FacebookChannel", + "EmailChannel", + "KikChannel", + "TelegramChannel", + "SlackChannel", + "MsTeamsChannel", + "SkypeChannel", + "WebChatChannel", + "DirectLineChannel", + "SmsChannel" + ], + "x-ms-enum": { + "name": "channelName", + "modelAsString": false, + "values": [ + { + "value": "FacebookChannel" + }, + { + "value": "EmailChannel" + }, + { + "value": "KikChannel" + }, + { + "value": "TelegramChannel" + }, + { + "value": "SlackChannel" + }, + { + "value": "MsTeamsChannel" + }, + { + "value": "SkypeChannel" + }, + { + "value": "WebChatChannel" + }, + { + "value": "DirectLineChannel" + }, + { + "value": "SmsChannel" + } + ] + }, + "description": "The name of the Channel resource." + } + } +} \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/CheckNameAvailability.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..05eeacdb11a0 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/CheckNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2017-01-01", + "parameters": { + "name": "testbotname", + "type": "string" + } + }, + "responses": { + "200": { + "body": { + "valid": true, + "message": "custom message from server" + } + } + } +} \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/CreateBot.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/CreateBot.json similarity index 100% rename from specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/CreateBot.json rename to specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/CreateBot.json diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/DeleteBot.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/DeleteBot.json similarity index 100% rename from specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/DeleteBot.json rename to specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/DeleteBot.json diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/DeleteChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/DeleteChannel.json new file mode 100644 index 000000000000..3ef121f395fe --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/DeleteChannel.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01", + "resourceName": "samplebotname", + "channelName": "EmailChannel" + }, + "responses": { + "200": { + }, + "204": { + } + } + } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/DeleteConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/DeleteConnection.json new file mode 100644 index 000000000000..7f11a36734a0 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/DeleteConnection.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01", + "resourceName": "samplebotname", + "connectionName": "sampleConnection" + }, + "responses": { + "200": { + }, + "204": { + } + } + } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/GetBot.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetBot.json similarity index 100% rename from specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/GetBot.json rename to specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetBot.json diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetChannel.json new file mode 100644 index 000000000000..b4d47e2ff7bd --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetChannel.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01", + "resourceName": "samplebotname", + "channelName": "EmailChannel" + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties":{ + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + } + } + } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetConnection.json new file mode 100644 index 000000000000..c77afa08e4f4 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetConnection.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01", + "resourceName": "samplebotname", + "connectionName": "sampleConnection" + }, + "responses": { + "200": { + "body": { + "location": "global", + "id": "someid", + "etag": "etag1", + "name": "The Name of the Connection Setting", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "serviceProviderDisplayName": "serviceProviderDisplayName", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + } + } + } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/GetOperations.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetOperations.json similarity index 100% rename from specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/GetOperations.json rename to specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetOperations.json diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/ListBotsByResourceGroup.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListBotsByResourceGroup.json similarity index 100% rename from specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/ListBotsByResourceGroup.json rename to specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListBotsByResourceGroup.json diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/ListBotsBySubscription.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListBotsBySubscription.json similarity index 100% rename from specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/ListBotsBySubscription.json rename to specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListBotsBySubscription.json diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListChannel.json new file mode 100644 index 000000000000..e67f9a9991cc --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListChannel.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01", + "resourceName": "samplebotname", + "channelName": "EmailChannel", + "parameters": { + "location": "global" + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties":{ + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + } + } + } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListChannelsByBotService.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListChannelsByBotService.json new file mode 100644 index 000000000000..2f6126c6eef8 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListChannelsByBotService.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "resourceName": "samplebotname", + "api-version": "2017-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties":{ + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + }, + { + "location": "global", + "properties": { + "channelName": "FacebookChannel", + "properties":{ + "verifyToken": "othertoken", + "appId": "id", + "appSecret": "secret", + "callbackUrl": "appid", + "isEnabled": true, + "pages": [ + { + "accessToken": "token", + "id": "id" + } + ] + } + } + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListConnectionsByBotService.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListConnectionsByBotService.json new file mode 100644 index 000000000000..49c377536a72 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListConnectionsByBotService.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01", + "resourceName": "samplebotname" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "The Name of the Connection Setting", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListServiceProviders.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListServiceProviders.json new file mode 100644 index 000000000000..ff0c08f4bb8d --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListServiceProviders.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "api-version": "2017-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "id": "sampleId", + "displayName": "sample display name", + "serviceProviderName": "sampleServiceProvider", + "devPortalUrl": "sampleDevPortalUrl", + "iconUrl": "sampleIconUrl", + "parameters": [ + { + "name": "sampleParameterName", + "type": "sampleParameterType", + "displayName": "sampleDisplayName", + "description": "sampleDescription", + "helpUrl": "sampleHelpUrl", + "default": "sampleDefaultValue" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/PutChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/PutChannel.json new file mode 100644 index 000000000000..e14c2fd30a52 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/PutChannel.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01", + "resourceName": "samplebotname", + "channelName": "EmailChannel", + "parameters": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties":{ + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties":{ + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + }, + "201": { + "body": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties":{ + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + } + } + } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/PutConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/PutConnection.json new file mode 100644 index 000000000000..513f1bd473c5 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/PutConnection.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01", + "resourceName": "samplebotname", + "connectionName": "sampleConnection", + "parameters": { + "location": "West US", + "etag": "etag1", + "name": "samplename", + "type": "sampletype", + "id": "someid", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "id": "someid", + "etag": "etag1", + "name": "The Name of the Connection Setting", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "serviceProviderDisplayName": "serviceProviderDisplayName", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + }, + "201": { + "body": { + "location": "global", + "id": "someid", + "etag": "etag1", + "name": "The Name of the Connection Setting", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "serviceProviderDisplayName": "serviceProviderDisplayName", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/UpdateBot.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/UpdateBot.json similarity index 100% rename from specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/UpdateBot.json rename to specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/UpdateBot.json diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/UpdateChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/UpdateChannel.json new file mode 100644 index 000000000000..e14c2fd30a52 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/UpdateChannel.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01", + "resourceName": "samplebotname", + "channelName": "EmailChannel", + "parameters": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties":{ + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties":{ + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + }, + "201": { + "body": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties":{ + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + } + } + } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/UpdateConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/UpdateConnection.json new file mode 100644 index 000000000000..ed4550c1d27f --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/UpdateConnection.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01", + "resourceName": "samplebotname", + "connectionName": "sampleConnection", + "parameters": { + "location": "global", + "etag": "etag1", + "id": "someid", + "name": "The Name of the Connection Setting", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "serviceProviderDisplayName": "serviceProviderDisplayName", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "id": "someid", + "name": "The Name of the Connection Setting", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "serviceProviderDisplayName": "serviceProviderDisplayName", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + }, + "201": { + "body": { + "location": "global", + "etag": "etag1", + "id": "someid", + "name": "The Name of the Connection Setting", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "serviceProviderDisplayName": "serviceProviderDisplayName", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/botservice.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/botservice.json deleted file mode 100644 index 2b1783cd385b..000000000000 --- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/botservice.json +++ /dev/null @@ -1,772 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Bot Service", - "description": "Azure Bot Service is a platform for creating smart conversational agents.", - "version": "2017-12-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}": { - "put": { - "tags": [ - "BotService" - ], - "description": "Creates a Bot Service. Bot Service is a resource group wide resource type.", - "operationId": "BotServices_Create", - "x-ms-examples": { - "Create Bot": { - "$ref": "./examples/CreateBot.json" - } - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 64, - "minLength": 2, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", - "description": "The name of the Bot resource." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/BotResource" - }, - "description": "The parameters to provide for the created bot." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "If resource is created successfully or already existed, the service should return 200 (OK).", - "schema": { - "$ref": "#/definitions/BotResource" - } - }, - "201": { - "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", - "schema": { - "$ref": "#/definitions/BotResource" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "patch": { - "tags": [ - "BotService" - ], - "description": "Updates a Bot Service", - "operationId": "BotServices_Update", - "x-ms-examples": { - "Update Bot": { - "$ref": "./examples/UpdateBot.json" - } - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 64, - "minLength": 2, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", - "description": "The name of the Bot resource." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "x-ms-client-flatten": true, - "schema": { - "$ref": "#/definitions/BotResource" - }, - "description": "The parameters to provide for the created bot." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", - "schema": { - "$ref": "#/definitions/BotResource" - } - }, - "201": { - "description": "If resource is updated successfully, the service should return 201 (Created). Execution to continue asynchronously.", - "schema": { - "$ref": "#/definitions/BotResource" - } - }, - "default": { - "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "delete": { - "tags": [ - "BotService" - ], - "description": "Deletes a Bot Service from the resource group. ", - "operationId": "BotServices_Delete", - "x-ms-examples": { - "Delete Bot": { - "$ref": "./examples/DeleteBot.json" - } - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 64, - "minLength": 2, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", - "description": "The name of the Bot resource." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" - }, - "204": { - "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "get": { - "tags": [ - "BotService" - ], - "description": "Returns a BotService specified by the parameters.", - "operationId": "BotServices_Get", - "x-ms-examples": { - "Get Bot": { - "$ref": "./examples/GetBot.json" - } - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 64, - "minLength": 2, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", - "description": "The name of the Bot resource." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", - "schema": { - "$ref": "#/definitions/BotResource" - } - }, - "default": { - "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices": { - "get": { - "tags": [ - "BotService" - ], - "description": "Returns all the resources of a particular type belonging to a resource group", - "operationId": "BotServices_ListByResourceGroup", - "x-ms-examples": { - "List Bots by Resource Group": { - "$ref": "./examples/ListBotsByResourceGroup.json" - } - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", - "schema": { - "$ref": "#/definitions/BotResponseList" - } - }, - "default": { - "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/botServices": { - "get": { - "tags": [ - "BotService" - ], - "description": "Returns all the resources of a particular type belonging to a subscription.", - "operationId": "BotServices_List", - "x-ms-examples": { - "List Bots by Subscription": { - "$ref": "./examples/ListBotsBySubscription.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", - "schema": { - "$ref": "#/definitions/BotResponseList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/checkNameAvailability": { - "get": { - "tags": [ - "BotService" - ], - "description": "Check whether a bot name is available.", - "operationId": "BotServices_GetCheckNameAvailability", - "x-ms-examples": { - "List Bots by Subscription": { - "$ref": "./examples/CheckNameAvailability.json" - } - }, - "parameters": [ - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CheckNameAvaialabilityRequestBody" - }, - "description" : "The request body parameters to provide for the Check Name Avaialability request." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityResponseBody" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/providers/Microsoft.BotService/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all the available BotService operations.", - "operationId": "Operations_List", - "x-ms-examples": { - "Get Operations": { - "$ref": "./examples/GetOperations.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/OperationEntityListResult" - } - } - }, - "deprecated": false, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "Resource": { - "description": "Azure resource", - "x-ms-azure-resource": true, - "properties": { - "id": { - "description": "Specifies the resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Specifies the name of the resource.", - "type": "string", - "readOnly": true - }, - "location": { - "description": "Specifies the location of the resource.", - "type": "string" - }, - "type": { - "description": "Specifies the type of the resource.", - "type": "string", - "readOnly": true - }, - "tags": { - "description": "Contains resource tags defined as key/value pairs.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets the SKU of the resource." - }, - "kind": { - "$ref": "#/definitions/Kind", - "description": "Required. Gets or sets the Kind of the resource." - }, - "etag": { - "type": "string", - "description": "Entity Tag" - } - } - }, - "Sku": { - "properties": { - "name": { - "$ref": "#/definitions/SkuName", - "description": "The sku name" - }, - "tier": { - "readOnly": true, - "type": "string", - "description": "Gets the sku tier. This is based on the SKU name.", - "enum": [ - "Free", - "Standard", - "Premium" - ], - "x-ms-enum": { - "name": "SkuTier", - "modelAsString": false - } - } - }, - "required": [ - "name" - ], - "description": "The SKU of the cognitive services account." - }, - "SkuName": { - "type": "string", - "description": "The name of SKU.", - "enum": [ - "F0", - "S1" - ], - "x-ms-enum": { - "name": "SkuName", - "modelAsString": true - } - }, - "Kind": { - "type": "string", - "description": "Indicates the type of bot service", - "enum": [ - "sdk", - "designer", - "bot", - "function" - ], - "x-ms-enum": { - "name": "Kind", - "modelAsString": true - } - }, - "BotResource": { - "type": "object", - "description": "Bot resource definition", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BotResourceProperties", - "description": "The set of properties specific to bot resource" - } - } - }, - "BotResourceProperties": { - "properties": { - "displayName": { - "type": "string", - "description": "The Name of the bot" - }, - "description": { - "type": "string", - "description": "The description of the bot" - }, - "iconUrl": { - "type": "string", - "description": "The Icon Url of the bot" - }, - "endpoint": { - "type": "string", - "description": "The bot's endpoint" - }, - "endpointVersion": { - "type": "string", - "readOnly": true, - "description": "The bot's endpoint version" - }, - "msaAppId": { - "type": "string", - "description": "Microsoft App Id for the bot" - }, - "configuredChannels": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "Collection of channels for which the bot is configured" - }, - "enabledChannels": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "Collection of channels for which the bot is enabled" - }, - "developerAppInsightKey": { - "type": "string", - "description": "The Application Insights key" - }, - "developerAppInsightsApiKey": { - "type": "string", - "description": "The Application Insights Api Key" - }, - "developerAppInsightsApplicationId": { - "type": "string", - "description": "The Application Insights App Id" - }, - "luisAppIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Collection of LUIS App Ids" - }, - "luisKey": { - "type": "string", - "description": "The LUIS Key" - } - }, - "description": "The parameters to provide for the Bot.", - "required": [ - "displayName", - "endpoint", - "msaAppId" - ] - }, - "BotResponseList": { - "properties": { - "nextLink": { - "description": "The link used to get the next page of bot service resources.", - "type": "string" - }, - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/BotResource" - }, - "description": "Gets the list of bot service results and their properties." - } - }, - "description": "The list of bot service operation response." - }, - "Error": { - "properties": { - "error": { - "$ref": "#/definitions/ErrorBody", - "description": "The error body." - } - }, - "description": "Bot Service error object." - }, - "ErrorBody": { - "properties": { - "code": { - "type": "string", - "description": "error code" - }, - "message": { - "type": "string", - "description": "error message" - } - }, - "description": "Bot Service error body.", - "required": [ - "code", - "message" - ] - }, - "OperationEntityListResult": { - "description": "The list of bot service operation response.", - "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 operations supported by Bot Service Management.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}.", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationDisplayInfo", - "description": "The operation supported by Bot Service Management." - }, - "origin": { - "description": "The origin of the operation.", - "type": "string" - }, - "properties": { - "description": "Additional properties.", - "type": "object" - } - } - }, - "OperationDisplayInfo": { - "description": "The operation supported by Bot Service Management.", - "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 Bot Service.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed.", - "type": "string" - } - } - }, - "CheckNameAvailabilityResponseBody": { - "description": "The response returned on a check bot name availability request by Bot Service Management.", - "type": "object", - "properties": { - "valid": { - "description": "boolean indicating whether the bot name is available for use.", - "type": "boolean" - }, - "message": { - "description": "description indicating why the bot name is invalid, if it is not available.", - "type" : "string" - } - } - }, - "CheckNameAvaialabilityRequestBody": { - "description": "The request body for a check bot name availability request to Bot Service Management.", - "type": "object", - "properties": { - "name": { - "description": "name of the bot, that needs to be checked for availability.", - "type": "string" - }, - "type": { - "description": "resource type for the bot.", - "type" : "string" - } - } - } - }, - "parameters": { - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Azure Subscription ID.", - "required": true, - "type": "string" - }, - "botNameParameter": { - "name": "botName", - "in": "path", - "description": "Proposed bot name", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "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-12-01" - } - } -} \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/CheckNameAvailability.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/CheckNameAvailability.json deleted file mode 100644 index ab2f334380ab..000000000000 --- a/specification/botservice/resource-manager/Microsoft.BotService/stable/2017-12-01/examples/CheckNameAvailability.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "subscriptionId": "subscription-id", - "api-version": "2017-01-01", - "parameters": { - "name": "samplebotname", - "type": "botservice" - } - }, - "responses": { - "200": { - "body": { - "valid": true, - "message": "" - } - } - } -} \ No newline at end of file diff --git a/specification/botservice/resource-manager/readme.md b/specification/botservice/resource-manager/readme.md index 28c42126ad69..e834505725ae 100644 --- a/specification/botservice/resource-manager/readme.md +++ b/specification/botservice/resource-manager/readme.md @@ -7,6 +7,28 @@ This is the AutoRest configuration file for BotService. --- + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-12-01 +``` + +### Tag: package-2017-12-01 and java + +These settings apply only when `--tag=package-2017-12-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-12-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.botservice.v2017_12_01 + output-folder: $(azure-libraries-for-java-folder)/botservice/resource-manager/v2017_12_01 +regenerate-manager: true +generate-interface: true +``` + + ## Getting Started To build the SDK for BotService, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: @@ -35,9 +57,21 @@ These settings apply only when `--tag=package-2017-12-01` is specified on the co ``` yaml $(tag) == 'package-2017-12-01' input-file: -- Microsoft.BotService/stable/2017-12-01/botservice.json +- Microsoft.BotService/preview/2017-12-01/botservice.json +directive: + - suppress: R3010 + from: botservice.json + reason: It is not a useful operation in the bot service. + - suppress: R2001 + from: botservice.json + reason: Flatten does not improve the programming experience here. + - suppress: R3018 + from: botservice.json + reason: We used Enums where we might extend to multiple states, and left booleans where it would ease development. + - suppress: R2066 + from: botservice.json + reason: The path as-is is quite descriptive. ``` - --- # Code Generation @@ -52,7 +86,6 @@ swagger-to-sdk: - repo: azure-sdk-for-go ``` - ## C# These settings apply only when `--csharp` is specified on the command line. @@ -82,11 +115,18 @@ go: clear-output-folder: true ``` +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2017-12-01 +``` + ### Tag: package-2017-12-01 and go These settings apply only when `--tag=package-2017-12-01 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-' && $(go) -output-folder: $(go-sdk-folder)/services/botservice/mgmt/2017-12-01/botservices +``` yaml $(tag) == 'package-2017-12-01' && $(go) +output-folder: $(go-sdk-folder)/services/preview/botservice/mgmt/2017-12-01/botservices ``` diff --git a/specification/cdn/resource-manager/readme.md b/specification/cdn/resource-manager/readme.md index ae4d46782003..12ec17266500 100644 --- a/specification/cdn/resource-manager/readme.md +++ b/specification/cdn/resource-manager/readme.md @@ -87,11 +87,13 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-net - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_cdn'] ``` diff --git a/specification/cdn/resource-manager/readme.ruby.md b/specification/cdn/resource-manager/readme.ruby.md index 3de075ff9d48..e120956e650c 100644 --- a/specification/cdn/resource-manager/readme.ruby.md +++ b/specification/cdn/resource-manager/readme.ruby.md @@ -2,10 +2,10 @@ These settings apply only when `--ruby` is specified on the command line. -``` yaml $(ruby) -ruby: - package-name: azure_mgmt_cdn - package-version": "0.16.0" +``` yaml +package-name: azure_mgmt_cdn +package-version: "0.16.0" +azure-arm: true ``` ### Ruby multi-api @@ -25,8 +25,8 @@ These settings apply only when `--tag=package-2017-10 --ruby` is specified on th Please also specify `--ruby-sdks-folder=`. ``` yaml $(tag) == 'package-2017-10' && $(ruby) -namespace: "Azure::CDN::Mgmt::V2017_10_23" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_cdn/lib/2017-10-12 +namespace: "Azure::CDN::Mgmt::V2017_10_12" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_cdn/lib ``` @@ -37,7 +37,7 @@ Please also specify `--ruby-sdks-folder= see https://aka.ms/autorest + +Configuration for generating AutoSuggest Search SDK. + +The current release is `release_1_0`. + +``` yaml + +tag: release_1_0 +add-credentials: true +openapi-type: data-plane +``` +# Releases + +### Release 1.0 +These settings apply only when `--tag=release_1_0` is specified on the command line. + +``` yaml $(tag) == 'release_1_0' +input-file: stable/v1.0/AutoSuggest.json +``` + +## 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-libraries-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_autosuggest'] +``` + + +## CSharp Settings +These settings apply only when `--csharp` is specified on the command line. +``` yaml $(csharp) +csharp: + namespace: Microsoft.Azure.CognitiveServices.Search.AutoSuggest + output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Search/BingAutoSuggest/BingAutoSuggest/Generated/AutoSuggest +``` + +``` yaml +directive: + - suppress: R2022 # the message to suppress + - suppress: R3014 # the message to suppress + - suppress: R3016 # the message to suppress +``` + +## 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 + add-credentials: true + payload-flattening-threshold: 2 + namespace: azure.cognitiveservices.search.autosuggest + package-name: azure-cognitiveservices-search-autosuggest + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-autosuggest +``` + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: autosuggest + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: release_1_0 +``` + +### Tag: release_1_0 and go + +These settings apply only when `--tag=release_1_0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v1.0/autosuggest +``` + + +## 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.search.autosuggest + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/search/bingautosuggest + with-optional-parameters: true + prefix-model-type: Bing + with-single-async-method: true +``` diff --git a/specification/cognitiveservices/data-plane/AutoSuggest/readme.nodejs.md b/specification/cognitiveservices/data-plane/AutoSuggest/readme.nodejs.md new file mode 100644 index 000000000000..127d6a2509e5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AutoSuggest/readme.nodejs.md @@ -0,0 +1,16 @@ +## 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-autosuggest + package-version: 0.1.0-preview + output-folder: $(node-sdks-folder)/lib/services/cognitiveServicesAutoSuggest + override-client-name: AutoSuggestAPIClient + azure-arm: false + generate-license-txt: true + generate-package-json: true + generate-readme-md: false +``` diff --git a/specification/cognitiveservices/data-plane/AutoSuggest/readme.ruby.md b/specification/cognitiveservices/data-plane/AutoSuggest/readme.ruby.md new file mode 100644 index 000000000000..81985d4d0405 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AutoSuggest/readme.ruby.md @@ -0,0 +1,27 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_cognitiveservices_autosuggest +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: release_1_0 +``` + +### Tag: release_1_0 and ruby + +These settings apply only when `--tag=release_1_0 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::AutoSuggest::V1_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_autosuggest/lib +title: "AutoSuggestClient" +``` diff --git a/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json b/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json new file mode 100644 index 000000000000..4bb38df98c1d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json @@ -0,0 +1,647 @@ +{ + "swagger": "2.0", + "info": { + "title": "AutoSuggest Search API", + "description": "The AutoSuggest Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for AutoSuggest](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-api-v7-reference).", + "version": "1.0" + }, + "parameters": { + "x-bingapis-sdk": { + "name": "X-BingApis-SDK", + "description": "Activate swagger compliance", + "x-ms-parameter-location": "method", + "required": true, + "type": "string", + "in": "header", + "x-ms-enum": { + "name": "XBingApisSDK", + "modelAsString": true + }, + "enum": [ + "true" + ] + } + }, + "host": "api.cognitive.microsoft.com", + "basePath": "/bing/v7.0", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "apiKeyHeader": { + "name": "Ocp-Apim-Subscription-Key", + "type": "apiKey", + "in": "header" + } + }, + "security": [ + { + "apiKeyHeader": [] + } + ], + "paths": { + "/Suggestions": { + "get": { + "summary": "The AutoSuggest API lets you send a search query to Bing and get back a list of suggestions. This section provides technical details about the query parameters and headers that you use to request suggestions and the JSON response objects that contain them.", + "operationId": "AutoSuggest", + "tags": [ + "AutoSuggest" + ], + "parameters": [ + { + "$ref": "#/parameters/x-bingapis-sdk" + }, + { + "name": "Accept", + "in": "header", + "description": "The default media type is application/json. To specify that the response use [JSON-LD](http://json-ld.org/), set the Accept header to application/ld+json.", + "required": false, + "type": "string" + }, + { + "name": "Accept-Language", + "x-ms-client-name": "AcceptLanguage", + "in": "header", + "description": "A comma-delimited list of one or more languages to use for user interface strings. The list is in decreasing order of preference. For additional information, including expected format, see [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the setLang query parameter are mutually exclusive; do not specify both. If you set this header, you must also specify the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-api-v7-reference#cc) query parameter. To determine the market to return results for, Bing uses the first supported language it finds from the list and combines it with the cc parameter value. If the list does not include a supported language, Bing finds the closest language and market that supports the request or it uses an aggregated or default market for the results. To determine the market that Bing used, see the BingAPIs-Market header. Use this header and the cc query parameter only if you specify multiple languages. Otherwise, use the [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-api-v7-reference#mkt) and [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-api-v7-reference#setlang) query parameters. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Any links to Bing.com properties in the response objects apply the specified language.", + "required": false, + "type": "string" + }, + { + "name": "Pragma", + "in": "header", + "description": "By default, Bing returns cached content, if available. To prevent Bing from returning cached content, set the Pragma header to no-cache (for example, Pragma: no-cache).", + "required": false, + "type": "string" + }, + { + "name": "User-Agent", + "x-ms-client-name": "UserAgent", + "in": "header", + "description": "The user agent originating the request. Bing uses the user agent to provide mobile users with an optimized experience. Although optional, you are encouraged to always specify this header. The user-agent should be the same string that any commonly used browser sends. For information about user agents, see [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The following are examples of user-agent strings. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53", + "required": false, + "type": "string" + }, + { + "name": "X-MSEdge-ClientID", + "x-ms-client-name": "ClientId", + "in": "header", + "description": "Bing uses this header to provide users with consistent behavior across Bing API calls. Bing often flights new features and improvements, and it uses the client ID as a key for assigning traffic on different flights. If you do not use the same client ID for a user across multiple requests, then Bing may assign the user to multiple conflicting flights. Being assigned to multiple conflicting flights can lead to an inconsistent user experience. For example, if the second request has a different flight assignment than the first, the experience may be unexpected. Also, Bing can use the client ID to tailor web results to that client ID’s search history, providing a richer experience for the user. Bing also uses this header to help improve result rankings by analyzing the activity generated by a client ID. The relevance improvements help with better quality of results delivered by Bing APIs and in turn enables higher click-through rates for the API consumer. IMPORTANT: Although optional, you should consider this header required. Persisting the client ID across multiple requests for the same end user and device combination enables 1) the API consumer to receive a consistent user experience, and 2) higher click-through rates via better quality of results from the Bing APIs. Each user that uses your application on the device must have a unique, Bing generated client ID. If you do not include this header in the request, Bing generates an ID and returns it in the X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is the first time the user uses your app on that device. Use the client ID for each Bing API request that your app makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a persistent HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other apps such as mobile apps, use the device's persistent storage to persist the ID. The next time the user uses your app on that device, get the client ID that you persisted. Bing responses may or may not include this header. If the response includes this header, capture the client ID and use it for all subsequent Bing requests for the user on that device. If you include the X-MSEdge-ClientID, you must not include cookies in the request.", + "required": false, + "type": "string" + }, + { + "name": "X-MSEdge-ClientIP", + "x-ms-client-name": "ClientIp", + "in": "header", + "description": "The IPv4 or IPv6 address of the client device. The IP address is used to discover the user's location. Bing uses the location information to determine safe search behavior. Although optional, you are encouraged to always specify this header and the X-Search-Location header. Do not obfuscate the address (for example, by changing the last octet to 0). Obfuscating the address results in the location not being anywhere near the device's actual location, which may result in Bing serving erroneous results.", + "required": false, + "type": "string" + }, + { + "name": "X-Search-Location", + "x-ms-client-name": "Location", + "in": "header", + "description": "A semicolon-delimited list of key/value pairs that describe the client's geographical location. Bing uses the location information to determine safe search behavior and to return relevant local content. Specify the key/value pair as :. The following are the keys that you use to specify the user's location. lat (required): The latitude of the client's location, in degrees. The latitude must be greater than or equal to -90.0 and less than or equal to +90.0. Negative values indicate southern latitudes and positive values indicate northern latitudes. long (required): The longitude of the client's location, in degrees. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy of the coordinates. Pass the value returned by the device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC UNIX timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since January 1, 1970.) head (optional): The client's relative heading or direction of travel. Specify the direction of travel as degrees from 0 through 360, counting clockwise relative to true north. Specify this key only if the sp key is nonzero. sp (optional): The horizontal velocity (speed), in meters per second, that the client device is traveling. alt (optional): The altitude of the client device, in meters. are (optional): The radius, in meters, that specifies the vertical accuracy of the coordinates. Specify this key only if you specify the alt key. Although many of the keys are optional, the more information that you provide, the more accurate the location results are. Although optional, you are encouraged to always specify the user's geographical location. Providing the location is especially important if the client's IP address does not accurately reflect the user's physical location (for example, if the client uses VPN). For optimal results, you should include this header and the X-MSEdge-ClientIP header, but at a minimum, you should include this header.", + "required": false, + "type": "string" + }, + { + "name": "cc", + "x-ms-client-name": "CountryCode", + "in": "query", + "description": "A 2-character country code of the country where the results come from. This API supports only the United States market. If you specify this query parameter, it must be set to us. If you set this parameter, you must also specify the Accept-Language header. Bing uses the first supported language it finds from the languages list, and combine that language with the country code that you specify to determine the market to return results for. If the languages list does not include a supported language, Bing finds the closest language and market that supports the request, or it may use an aggregated or default market for the results instead of a specified one. You should use this query parameter and the Accept-Language query parameter only if you specify multiple languages; otherwise, you should use the mkt and setLang query parameters. This parameter and the mkt query parameter are mutually exclusive—do not specify both.", + "required": false, + "type": "string" + }, + { + "name": "mkt", + "x-ms-client-name": "Market", + "in": "query", + "description": "The market where the results come from. You are strongly encouraged to always specify the market, if known. Specifying the market helps Bing route the request and return an appropriate and optimal response. This parameter and the cc query parameter are mutually exclusive—do not specify both.", + "required": false, + "type": "string", + "default": "en-us" + }, + { + "name": "q", + "x-ms-client-name": "Query", + "in": "query", + "description": "The user's search term.", + "required": true, + "type": "string" + }, + { + "name": "safeSearch", + "x-ms-client-name": "SafeSearch", + "in": "query", + "description": "Filter suggestions for adult content. The following are the possible filter values. Off: Return suggestions with adult text, images, or videos. Moderate: Return suggestion with adult text but not adult images or videos. Strict: Do not return news articles with adult text, images, or videos. If the request comes from a market that Bing's adult policy requires that safeSearch is set to Strict, Bing ignores the safeSearch value and uses Strict. If you use the site: query operator, there is the chance that the response may contain adult content regardless of what the safeSearch query parameter is set to. Use site: only if you are aware of the content on the site and your scenario supports the possibility of adult content.", + "required": false, + "type": "string", + "enum": [ + "Off", + "Moderate", + "Strict" + ], + "x-ms-enum": { + "name": "SafeSearch", + "modelAsString": true + } + }, + { + "name": "setLang", + "x-ms-client-name": "SetLang", + "in": "query", + "description": "The language to use for user interface strings. Specify the language using the ISO 639-1 2-letter language code. For example, the language code for English is EN. The default is EN (English). Although optional, you should always specify the language. Typically, you set setLang to the same language specified by mkt unless the user wants the user interface strings displayed in a different language. This parameter and the Accept-Language header are mutually exclusive; do not specify both. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Also, any links to Bing.com properties in the response objects apply the specified language.", + "required": false, + "type": "string" + }, + { + "name": "ResponseFormat", + "in": "query", + "description": "The media type to use for the response. The following are the possible case-insensitive values: JSON, JSONLD. The default is JSON. If you specify JSONLD, the response body includes JSON-LD objects that contain the search results.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "Json", + "JsonLd" + ], + "x-ms-enum": { + "name": "ResponseFormat", + "modelAsString": true + } + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/Suggestions" + } + }, + "default": { + "description": "An error has occurred. Check the response type and/or status code for more details.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulQueryRequest.json" + } + } + } + } + }, + "definitions": { + "Suggestions": { + "allOf": [ + { + "$ref": "#/definitions/SearchResultsAnswer" + } + ], + "type": "object", + "required": [ + "suggestionGroups" + ], + "properties": { + "suggestionGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/SuggestionsSuggestionGroup" + } + } + } + }, + "SearchResultsAnswer": { + "description": "Defines a search result answer.", + "allOf": [ + { + "$ref": "#/definitions/Answer" + } + ], + "type": "object", + "properties": { + "queryContext": { + "$ref": "#/definitions/QueryContext", + "readOnly": true + } + } + }, + "SuggestionsSuggestionGroup": { + "x-ms-discriminator-value": "Suggestions/SuggestionGroup", + "discriminator": "_type", + "type": "object", + "required": [ + "name", + "searchSuggestions", + "_type" + ], + "properties": { + "name": { + "type": "string", + "default": "Unknown", + "enum": [ + "Unknown", + "Web", + "StoreApps", + "SearchHistory", + "PersonalSearchDocuments", + "PersonalSearchTags", + "Custom" + ], + "x-ms-enum": { + "name": "ScenarioType", + "modelAsString": true + } + }, + "searchSuggestions": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchAction" + } + }, + "_type": { + "type": "string" + } + } + }, + "Answer": { + "description": "Defines an answer.", + "allOf": [ + { + "$ref": "#/definitions/Response" + } + ], + "type": "object", + "properties": {} + }, + "QueryContext": { + "description": "Defines the query context that Bing used for the request.", + "discriminator": "_type", + "type": "object", + "required": [ + "originalQuery", + "_type" + ], + "properties": { + "originalQuery": { + "description": "The query string as specified in the request.", + "type": "string" + }, + "alteredQuery": { + "description": "The query string used by Bing to perform the query. Bing uses the altered query string if the original query string contained spelling mistakes. For example, if the query string is \"saling downwind\", the altered query string will be \"sailing downwind\". This field is included only if the original query string contains a spelling mistake.", + "readOnly": true, + "type": "string" + }, + "alterationOverrideQuery": { + "description": "The query string to use to force Bing to use the original string. For example, if the query string is \"saling downwind\", the override query string will be \"+saling downwind\". Remember to encode the query string which results in \"%2Bsaling+downwind\". This field is included only if the original query string contains a spelling mistake.", + "readOnly": true, + "type": "string" + }, + "adultIntent": { + "description": "A Boolean value that indicates whether the specified query has adult intent. The value is true if the query has adult intent; otherwise, false.", + "readOnly": true, + "type": "boolean" + }, + "askUserForLocation": { + "description": "A Boolean value that indicates whether Bing requires the user's location to provide accurate results. If you specified the user's location by using the X-MSEdge-ClientIP and X-Search-Location headers, you can ignore this field. For location aware queries, such as \"today's weather\" or \"restaurants near me\" that need the user's location to provide accurate results, this field is set to true. For location aware queries that include the location (for example, \"Seattle weather\"), this field is set to false. This field is also set to false for queries that are not location aware, such as \"best sellers\".", + "readOnly": true, + "type": "boolean" + }, + "isTransactional": { + "readOnly": true, + "type": "boolean" + }, + "_type": { + "type": "string" + } + } + }, + "SearchAction": { + "allOf": [ + { + "$ref": "#/definitions/Action" + } + ], + "type": "object", + "properties": { + "displayText": { + "readOnly": true, + "type": "string" + }, + "query": { + "readOnly": true, + "type": "string" + }, + "searchKind": { + "readOnly": true, + "type": "string", + "default": "WebSearch", + "enum": [ + "WebSearch", + "HistorySearch", + "DocumentSearch", + "TagSearch", + "LocationSearch", + "CustomSearch" + ], + "x-ms-enum": { + "name": "SearchKind", + "modelAsString": true + } + } + } + }, + "Response": { + "description": "Defines a response. All schemas that could be returned at the root of a response should inherit from this", + "allOf": [ + { + "$ref": "#/definitions/Identifiable" + } + ], + "type": "object", + "properties": { + "readLink": { + "description": "The URL that returns this resource.", + "readOnly": true, + "type": "string" + }, + "webSearchUrl": { + "description": "The URL To Bing's search result for this item.", + "readOnly": true, + "type": "string" + }, + "potentialAction": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Action" + } + }, + "immediateAction": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Action" + } + }, + "preferredClickthroughUrl": { + "readOnly": true, + "type": "string" + }, + "adaptiveCard": { + "readOnly": true, + "type": "string" + } + } + }, + "Action": { + "allOf": [ + { + "$ref": "#/definitions/CreativeWork" + } + ], + "type": "object", + "properties": { + "result": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Thing" + } + }, + "displayName": { + "readOnly": true, + "type": "string" + }, + "isTopAction": { + "readOnly": true, + "type": "boolean" + }, + "serviceUrl": { + "readOnly": true, + "type": "string" + } + } + }, + "Identifiable": { + "description": "Defines the identity of a resource.", + "allOf": [ + { + "$ref": "#/definitions/ResponseBase" + } + ], + "type": "object", + "properties": { + "id": { + "description": "A String identifier.", + "readOnly": true, + "type": "string" + } + } + }, + "ErrorResponse": { + "description": "The top-level response that represents a failed request.", + "allOf": [ + { + "$ref": "#/definitions/Response" + } + ], + "type": "object", + "required": [ + "errors" + ], + "properties": { + "errors": { + "description": "A list of errors that describe the reasons why the request failed.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "Thing": { + "description": "Defines a thing.", + "allOf": [ + { + "$ref": "#/definitions/Response" + } + ], + "type": "object", + "properties": { + "url": { + "description": "The URL to get more information about the thing represented by this object.", + "readOnly": true, + "type": "string" + } + } + }, + "CreativeWork": { + "description": "The most generic kind of creative work, including books, movies, photographs, software programs, etc.", + "allOf": [ + { + "$ref": "#/definitions/Thing" + } + ], + "type": "object", + "properties": { + "thumbnailUrl": { + "description": "The URL to a thumbnail of the item.", + "readOnly": true, + "type": "string" + }, + "about": { + "description": "For internal use only.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Thing" + } + }, + "mentions": { + "description": "For internal use only.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Thing" + } + }, + "provider": { + "description": "The source of the creative work.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Thing" + } + }, + "creator": { + "$ref": "#/definitions/Thing", + "readOnly": true + }, + "text": { + "description": "Text content of this creative work", + "readOnly": true, + "type": "string" + }, + "discussionUrl": { + "readOnly": true, + "type": "string" + }, + "commentCount": { + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "mainEntity": { + "$ref": "#/definitions/Thing", + "readOnly": true + }, + "headLine": { + "readOnly": true, + "type": "string" + }, + "copyrightHolder": { + "$ref": "#/definitions/Thing", + "readOnly": true + }, + "copyrightYear": { + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "disclaimer": { + "readOnly": true, + "type": "string" + }, + "isAccessibleForFree": { + "readOnly": true, + "type": "boolean" + }, + "genre": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "isFamilyFriendly": { + "readOnly": true, + "type": "boolean" + } + } + }, + "ResponseBase": { + "description": "Response base", + "discriminator": "_type", + "type": "object", + "required": [ + "_type" + ], + "properties": { + "_type": { + "type": "string" + } + } + }, + "Error": { + "description": "Defines the error that occurred.", + "discriminator": "_type", + "type": "object", + "required": [ + "code", + "message", + "_type" + ], + "properties": { + "code": { + "description": "The error code that identifies the category of error.", + "type": "string", + "default": "None", + "enum": [ + "None", + "ServerError", + "InvalidRequest", + "RateLimitExceeded", + "InvalidAuthorization", + "InsufficientAuthorization" + ], + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true + } + }, + "message": { + "description": "A description of the error.", + "type": "string" + }, + "moreDetails": { + "description": "A description that provides additional information about the error.", + "readOnly": true, + "type": "string" + }, + "parameter": { + "description": "The parameter in the request that caused the error.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "The parameter's value in the request that was not valid.", + "readOnly": true, + "type": "string" + }, + "_type": { + "type": "string" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/examples/SuccessfulQueryRequest.json b/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/examples/SuccessfulQueryRequest.json new file mode 100644 index 000000000000..610969288fc3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/examples/SuccessfulQueryRequest.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "X-BingApis-SDK": "true", + "Ocp-Apim-Subscription-Key": "{API key}", + "q": "a" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "_type": "Suggestions", + "queryContext": { + "_type": "QueryContext", + "originalQuery": "a" + }, + "suggestionGroups": [ + { + "_type": "Suggestions\/SuggestionGroup", + "name": "Web", + "searchSuggestions": [ + { + "_type": "SearchAction", + "url": "https:\/\/www.bing.com\/search?q=amazon&FORM=USBAPI", + "displayText": "amazon", + "query": "amazon", + "searchKind": "WebSearch" + }, + { + "_type": "SearchAction", + "url": "https:\/\/www.bing.com\/search?q=alaska+airlines&FORM=USBAPI", + "displayText": "alaska airlines", + "query": "alaska airlines", + "searchKind": "WebSearch" + }, + { + "_type": "SearchAction", + "url": "https:\/\/www.bing.com\/search?q=aol&FORM=USBAPI", + "displayText": "aol", + "query": "aol", + "searchKind": "WebSearch" + }, + { + "_type": "SearchAction", + "url": "https:\/\/www.bing.com\/search?q=amazon+prime&FORM=USBAPI", + "displayText": "amazon prime", + "query": "amazon prime", + "searchKind": "WebSearch" + }, + { + "_type": "SearchAction", + "url": "https:\/\/www.bing.com\/search?q=airbnb&FORM=USBAPI", + "displayText": "airbnb", + "query": "airbnb", + "searchKind": "WebSearch" + }, + { + "_type": "SearchAction", + "url": "https:\/\/www.bing.com\/search?q=american+express&FORM=USBAPI", + "displayText": "american express", + "query": "american express", + "searchKind": "WebSearch" + }, + { + "_type": "SearchAction", + "url": "https:\/\/www.bing.com\/search?q=autotrader&FORM=USBAPI", + "displayText": "autotrader", + "query": "autotrader", + "searchKind": "WebSearch" + }, + { + "_type": "SearchAction", + "url": "https:\/\/www.bing.com\/search?q=autozone&FORM=USBAPI", + "displayText": "autozone", + "query": "autozone", + "searchKind": "WebSearch" + } + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Common/ExtendedRegions.json b/specification/cognitiveservices/data-plane/Common/ExtendedRegions.json index f84af7057dd3..ee17d02be818 100644 --- a/specification/cognitiveservices/data-plane/Common/ExtendedRegions.json +++ b/specification/cognitiveservices/data-plane/Common/ExtendedRegions.json @@ -31,7 +31,11 @@ "northeurope", "eastasia", "australiaeast", - "brazilsouth" + "brazilsouth", + "canadacentral", + "centralindia", + "uksouth", + "japaneast" ] } } diff --git a/specification/cognitiveservices/data-plane/Common/Parameters.json b/specification/cognitiveservices/data-plane/Common/Parameters.json index 05038c300269..8831df933942 100644 --- a/specification/cognitiveservices/data-plane/Common/Parameters.json +++ b/specification/cognitiveservices/data-plane/Common/Parameters.json @@ -38,6 +38,7 @@ ], "properties": { "url": { + "description": "Publicly reachable URL of an image", "type": "string" } } diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.md index 6c2c3f8afc91..6a7dc3febccf 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/readme.md +++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.md @@ -4,21 +4,21 @@ Configuration for generating Computer Vision SDK. -The current release is `release_1_0`. +The current release is `release_2_0`. ``` yaml -tag: release_1_0 +tag: release_2_0 add-credentials: true openapi-type: data-plane ``` # Releases -### Release 1.0 -These settings apply only when `--tag=release_1_0` is specified on the command line. +### Release 2.0 +These settings apply only when `--tag=release_2_0` is specified on the command line. -``` yaml $(tag) == 'release_1_0' -input-file: stable/v1.0/ComputerVision.json +``` yaml $(tag) == 'release_2_0' +input-file: stable/v2.0/ComputerVision.json ``` ## Swagger to SDK @@ -29,9 +29,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_computervision'] ``` @@ -45,6 +48,13 @@ csharp: namespace: Microsoft.Azure.CognitiveServices.Vision.ComputerVision output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Vision/ComputerVision/ComputerVision/Generated clear-output-folder: true + +directive: + from: source-file-csharp + where: $ + transform: > + $ = $.replace( /TextRecognitionMode mode, string url,/g, "string url, TextRecognitionMode mode," ); + $ = $.replace( /mode, url,/g, "url, mode," ); ``` ## Python @@ -62,6 +72,12 @@ python: namespace: azure.cognitiveservices.vision.computervision package-name: azure-cognitiveservices-vision-computervision clear-output-folder: true + +directive: + from: source-file-python + where: $ + transform: > + $ = $.replace( /self, mode, url,/g, "self, url, mode," ); ``` ``` yaml $(python) && $(python-mode) == 'update' python: @@ -89,16 +105,16 @@ go: ``` yaml $(go) && $(multiapi) batch: - - tag: release_1_0 + - tag: release_2_0 ``` -### Tag: release_1_0 and go +### Tag: release_2_0 and go -These settings apply only when `--tag=release_1_0 --go` is specified on the command line. +These settings apply only when `--tag=release_2_0 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'release_1_0' && $(go) -output-folder: $(go-sdk-folder)/services/cognitiveservices/v1.0/computervision +``` yaml $(tag) == 'release_2_0' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v2.0/computervision ``` @@ -110,9 +126,18 @@ Please also specify `--azure-libraries-for-java-folder= + $ = $.replace( /TextRecognitionMode mode, String url/g, "String url, TextRecognitionMode mode" ); + $ = $.replace( /recognizeTextWithServiceResponseAsync\(mode, url\)/g, "recognizeTextWithServiceResponseAsync(url, mode)" ) ``` diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.nodejs.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.nodejs.md index 02fef39a36dd..678e38461366 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/readme.nodejs.md +++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.nodejs.md @@ -6,11 +6,17 @@ Please also specify `--node-sdks-folder= + $ = $.replace( /mode: string, url: string/g, "url: string, mode: string" ); + $ = $.replace( /mode, url/g, "url, mode" ); ``` diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md new file mode 100644 index 000000000000..adfd7087e1f3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md @@ -0,0 +1,33 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_cognitiveservices_computervision +package-version: "0.16.0" +azure-arm: true + +directive: + from: source-file-ruby + where: $ + transform: > + $ = $.replace( /mode, url/g, "url, mode" ); +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: release_2_0 +``` + +### Tag: release_2_0 and ruby + +These settings apply only when `--tag=release_2_0 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'release_2_0' && $(ruby) +namespace: "Azure::CognitiveServices::ComputerVision::V2_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_computervision/lib +title: "ComputerVisionClient" +``` diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/ComputerVision.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/ComputerVision.json index 2269e878b2f3..91d90b29086b 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/ComputerVision.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/ComputerVision.json @@ -58,7 +58,7 @@ } } }, - "/analyze?overload=url": { + "/analyze": { "post": { "description": "This operation extracts a rich set of visual features based on the image content. Two 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.", "operationId": "AnalyzeImage", @@ -93,21 +93,7 @@ } }, { - "name": "language", - "in": "query", - "description": "A string indicating which language to return. The service will return recognition results in specified language. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default.zh - Simplified Chinese.", - "type": "string", - "required": false, - "default": "en", - "x-nullable": false, - "x-ms-enum": { - "name": "Language", - "modelAsString": false - }, - "enum": [ - "en", - "zh" - ] + "$ref": "#/parameters/ServiceLanguage" }, { "$ref": "../../../Common/Parameters.json#/parameters/ImageUrl" @@ -134,7 +120,7 @@ } } }, - "/generateThumbnail?overload=url": { + "/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. A 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.", "operationId": "GenerateThumbnail", @@ -191,12 +177,12 @@ }, "x-ms-examples": { "Successful Generate Thumbnail request": { - "$ref": "./examples/SuccessfulGenerateThumbnail.json" + "$ref": "./examples/SuccessfulGenerateThumbnailWithUrl.json" } } } }, - "/ocr?overload=url": { + "/ocr": { "post": { "description": "Optical Character Recognition (OCR) detects printed text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon 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", @@ -238,7 +224,7 @@ } } }, - "/describe?overload=url": { + "/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. All descriptions are in English. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL.A 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", @@ -257,6 +243,9 @@ "required": false, "default": "1" }, + { + "$ref": "#/parameters/ServiceLanguage" + }, { "$ref": "../../../Common/Parameters.json#/parameters/ImageUrl" } @@ -282,9 +271,9 @@ } } }, - "/tag?overload=url": { + "/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 “cello” may be accompanied by the hint “musical instrument”. All tags are in English.", + "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 'cello' may be accompanied by the hint 'musical instrument'. All tags are in English.", "operationId": "TagImage", "consumes": [ "application/json" @@ -293,6 +282,9 @@ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ServiceLanguage" + }, { "$ref": "../../../Common/Parameters.json#/parameters/ImageUrl" } @@ -318,7 +310,7 @@ } } }, - "/models/{model}/analyze?overload=url": { + "/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 only provides a single domain-specific model: celebrities. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A 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": "AnalyzeImageByDomain", @@ -334,16 +326,10 @@ "in": "path", "description": "The domain-specific content to recognize.", "required": true, - "type": "string", - "x-nullable": false, - "x-ms-enum": { - "name": "DomainModels", - "modelAsString": false - }, - "enum": [ - "Celebrities", - "Landmarks" - ] + "type": "string" + }, + { + "$ref": "#/parameters/ServiceLanguage" }, { "$ref": "../../../Common/Parameters.json#/parameters/ImageUrl" @@ -370,9 +356,9 @@ } } }, - "/recognizeText?overload=url": { + "/recognizeText": { "post": { - "description": "Recognize Text operation. When you use the Recognize Text interface, the response contains a field called “Operation-Location”. The “Operation-Location” field contains the URL that you must use for your Get Handwritten Text Operation Result operation.", + "description": "Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Handwritten Text Operation Result operation.", "operationId": "RecognizeText", "parameters": [ { @@ -456,7 +442,8 @@ "description": "This operation extracts a rich set of visual features based on the image content.", "operationId": "AnalyzeImageInStream", "consumes": [ - "application/octet-stream" + "application/octet-stream", + "multipart/form-data" ], "produces": [ "application/json" @@ -477,16 +464,7 @@ ] }, { - "name": "language", - "in": "query", - "description": "A string indicating which language to return. The service will return recognition results in specified language. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default.zh - Simplified Chinese.", - "type": "string", - "required": false, - "default": "en", - "enum": [ - "en", - "zh" - ] + "$ref": "#/parameters/ServiceLanguage" }, { "$ref": "../../../Common/Parameters.json#/parameters/ImageStream" @@ -505,6 +483,11 @@ "$ref": "#/definitions/ComputerVisionError" } } + }, + "x-ms-examples": { + "Successful Analyze with Url request": { + "$ref": "./examples/SuccessfulAnalyzeWithStream.json" + } } } }, @@ -513,11 +496,11 @@ "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. A 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.", "operationId": "GenerateThumbnailInStream", "consumes": [ - "application/octet-stream" + "application/octet-stream", + "multipart/form-data" ], "produces": [ - "application/octet-stream", - "application/json" + "application/octet-stream" ], "parameters": [ { @@ -563,6 +546,11 @@ "$ref": "#/definitions/ComputerVisionError" } } + }, + "x-ms-examples": { + "Successful Generate Thumbnail request": { + "$ref": "./examples/SuccessfulGenerateThumbnailWithStream.json" + } } } }, @@ -571,7 +559,8 @@ "description": "Optical Character Recognition (OCR) detects printed text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon 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" + "application/octet-stream", + "multipart/form-data" ], "produces": [ "application/json" @@ -600,6 +589,11 @@ "$ref": "#/definitions/ComputerVisionError" } } + }, + "x-ms-examples": { + "Successful Ocr request": { + "$ref": "./examples/SuccessfulOcrWithStream.json" + } } } }, @@ -608,7 +602,8 @@ "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. All descriptions are in English. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL.A 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" + "application/octet-stream", + "multipart/form-data" ], "produces": [ "application/json" @@ -622,6 +617,9 @@ "required": false, "default": "1" }, + { + "$ref": "#/parameters/ServiceLanguage" + }, { "$ref": "../../../Common/Parameters.json#/parameters/ImageStream" } @@ -639,20 +637,29 @@ "$ref": "#/definitions/ComputerVisionError" } } + }, + "x-ms-examples": { + "Successful Describe request": { + "$ref": "./examples/SuccessfulDescribeWithStream.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 “cello” may be accompanied by the hint “musical instrument”. All tags are in English.", + "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 'cello' may be accompanied by the hint 'musical instrument'. All tags are in English.", "operationId": "TagImageInStream", "consumes": [ - "application/octet-stream" + "application/octet-stream", + "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ + { + "$ref": "#/parameters/ServiceLanguage" + }, { "$ref": "../../../Common/Parameters.json#/parameters/ImageStream" } @@ -670,6 +677,11 @@ "$ref": "#/definitions/ComputerVisionError" } } + }, + "x-ms-examples": { + "Successful Tag request": { + "$ref": "./examples/SuccessfulTagWithStream.json" + } } } }, @@ -678,7 +690,8 @@ "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 only provides a single domain-specific model: celebrities. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A 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": "AnalyzeImageByDomainInStream", "consumes": [ - "application/octet-stream" + "application/octet-stream", + "multipart/form-data" ], "produces": [ "application/json" @@ -691,6 +704,9 @@ "required": true, "type": "string" }, + { + "$ref": "#/parameters/ServiceLanguage" + }, { "$ref": "../../../Common/Parameters.json#/parameters/ImageStream" } @@ -708,12 +724,17 @@ "$ref": "#/definitions/ComputerVisionError" } } + }, + "x-ms-examples": { + "Successful Domain Model analysis request": { + "$ref": "./examples/SuccessfulDomainModelWithStream.json" + } } } }, "/recognizeText?overload=stream": { "post": { - "description": "Recognize Text operation. When you use the Recognize Text interface, the response contains a field called “Operation-Location”. The “Operation-Location” field contains the URL that you must use for your Get Handwritten Text Operation Result operation.", + "description": "Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Handwritten Text Operation Result operation.", "operationId": "RecognizeTextInStream", "parameters": [ { @@ -745,6 +766,11 @@ "$ref": "#/definitions/ComputerVisionError" } } + }, + "x-ms-examples": { + "Successful Domain Model analysis request": { + "$ref": "./examples/SuccessfulRecognizeTextWithStream.json" + } } } } @@ -831,15 +857,12 @@ } }, "adult": { - "description": "A property scoring on whether the image is adult-oriented and/or racy.", "$ref": "#/definitions/AdultInfo" }, "color": { - "description": "A property scoring on color spectrums.", "$ref": "#/definitions/ColorInfo" }, "imageType": { - "description": "A property indicating type of image (whether it's clipart or line drawing)", "$ref": "#/definitions/ImageType" }, "tags": { @@ -850,7 +873,6 @@ } }, "description": { - "description": "Description of the image.", "$ref": "#/definitions/ImageDescriptionDetails" }, "faces": { @@ -865,7 +887,6 @@ "description": "Id of the request for tracking purposes." }, "metadata": { - "description": "Image metadata", "$ref": "#/definitions/ImageMetadata" } } @@ -874,7 +895,8 @@ "type": "object", "properties": { "language": { - "$ref": "#/definitions/OcrResult" + "type": "string", + "description": "The BCP-47 language code of the text in the image." }, "textAngle": { "type": "number", @@ -975,29 +997,66 @@ "description": "Result of image analysis using a specific domain model including additional metadata.", "properties": { "result": { - "description": "Result of the image analysis.", "x-ms-client-flatten": true, - "$ref": "#/definitions/DomainModelResult" + "type": "object", + "description": "Model-specific response" }, "requestId": { "type": "string", "description": "Id of the REST API request." }, "metadata": { - "description": "Additional image metadata", "$ref": "#/definitions/ImageMetadata" } } }, - "DomainModelResult": { + "CelebrityResults": { "type": "object", + "description": "List of celebrities recognized in the image.", "properties": { "celebrities": { "type": "array", - "description": "An array of possible celebritied identified in the image.", "items": { "$ref": "#/definitions/CelebritiesModel" } + }, + "requestId": { + "type": "string", + "description": "Id of the REST API request." + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + } + }, + "LandmarkResults": { + "type": "object", + "description": "List of landmarks recognized in the image.", + "properties": { + "landmarks": { + "type": "array", + "items": { + "type": "object", + "description": "A landmark recognized in the image", + "properties": { + "name": { + "type": "string", + "description": "Name of the landmark." + }, + "confidence": { + "type": "number", + "format": "double", + "description": "Confidence level for the landmark recognition." + } + } + } + }, + "requestId": { + "type": "string", + "description": "Id of the REST API request." + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" } } }, @@ -1027,7 +1086,6 @@ "description": "Id of the REST API request." }, "metadata": { - "description": "Image metadata", "$ref": "#/definitions/ImageMetadata" } } @@ -1055,7 +1113,6 @@ "description": "Id of the REST API request." }, "metadata": { - "description": "Image metadata", "$ref": "#/definitions/ImageMetadata" } } @@ -1161,6 +1218,10 @@ "gender": { "type": "string", "description": "Possible gender of the face.", + "x-ms-enum": { + "name": "Gender-", + "modelAsString": false + }, "enum": [ "Male", "Female" @@ -1256,8 +1317,6 @@ "description": "Scoring of the category." }, "detail": { - "type": "object", - "description": "Additional category detail if available.", "$ref": "#/definitions/CategoryDetail" } } @@ -1314,6 +1373,9 @@ "description": "A unique request identifier." } } + }, + "ServiceLanguage": { + "type": "string" } }, "parameters": { @@ -1398,11 +1460,28 @@ "HandwritingBoolean": { "name": "detectHandwriting", "in": "query", - "description": "If “true” is specified, handwriting recognition is performed. If this parameter is set to “false” or is not specified, printed text recognition is performed.", + "description": "If 'true' is specified, handwriting recognition is performed. If this parameter is set to 'false' or is not specified, printed text recognition is performed.", "required": false, "x-ms-parameter-location": "method", "type": "boolean", "default": false + }, + "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.", + "type": "string", + "required": false, + "x-ms-parameter-location": "method", + "x-nullable": false, + "default": "en", + "enum": [ + "en", + "es", + "ja", + "pt", + "zh" + ] } } } \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulAnalyzeWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulAnalyzeWithStream.json new file mode 100644 index 000000000000..4b711e44d75d --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulAnalyzeWithStream.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "Content-Type": "application/octet-stream", + "Ocp-Apim-Subscription-Key": "{API key}", + "visualFeatures": "Categories,Adult,Tags,Description,Faces,Color,ImageType", + "details": "Celebrities", + "language": "en", + "body": "{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, + "adultScore": 0.0934349000453949, + "racyScore": 0.068613491952419281 + }, + "tags": [ + { + "name": "person", + "confidence": 0.98979085683822632 + }, + { + "name": "man", + "confidence": 0.94493889808654785 + }, + { + "name": "outdoor", + "confidence": 0.938492476940155 + }, + { + "name": "window", + "confidence": 0.89513939619064331 + } + ], + "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 + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulDescribeWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulDescribeWithStream.json new file mode 100644 index 000000000000..307cc72fd052 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulDescribeWithStream.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Content-Type": "application/octet-stream", + "Ocp-Apim-Subscription-Key": "{API key}", + "maxCandidates": "1", + "body": "{binary}" + }, + "responses": { + "200": { + "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" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulDomainModelWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulDomainModelWithStream.json new file mode 100644 index 000000000000..3ea4f78af418 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulDomainModelWithStream.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Content-Type": "application/octet-stream", + "Ocp-Apim-Subscription-Key": "{API key}", + "Model": "Celebrities", + "body": "{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 + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulGenerateThumbnailWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulGenerateThumbnailWithStream.json new file mode 100644 index 000000000000..353d43c7e0a2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulGenerateThumbnailWithStream.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Content-Type": "application/octet-stream", + "Ocp-Apim-Subscription-Key": "{API key}", + "width": "500", + "height": "500", + "smartCropping": true, + "body": "{binary}" + }, + "responses": { + "200": { + "headers": {}, + "body": "{Binary}" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulGenerateThumbnail.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulGenerateThumbnailWithUrl.json similarity index 100% rename from specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulGenerateThumbnail.json rename to specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulGenerateThumbnailWithUrl.json diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulOcrWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulOcrWithStream.json new file mode 100644 index 000000000000..5cd77b68f477 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulOcrWithStream.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "Content-Type": "application/octet-stream", + "Ocp-Apim-Subscription-Key": "{API key}", + "detectOrientation": "true", + "language": "en", + "body": "{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" + } + ] + } + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulRecognizeTextWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulRecognizeTextWithStream.json new file mode 100644 index 000000000000..1bb35b0b7cd2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulRecognizeTextWithStream.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Content-Type": "application/octet-stream", + "Ocp-Apim-Subscription-Key": "{API key}", + "Handwriting": "true", + "body": "{binary}" + }, + "responses": { + "202": { + "header": { + "Operation-Location": "https://{domain}/vision/v1.0/textOperations/49a36324-fc4b-4387-aa06-090cfbf0064f" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulTagWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulTagWithStream.json new file mode 100644 index 000000000000..ac649a3afb3d --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v1.0/examples/SuccessfulTagWithStream.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Content-Type": "application/octet-stream", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": "{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" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json new file mode 100644 index 000000000000..30c5f79aefbf --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json @@ -0,0 +1,1568 @@ +{ + "swagger": "2.0", + "info": { + "version": "2.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/v2.0", + "schemes": [ + "https" + ], + "paths": { + "/models": { + "get": { + "description": "This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API only supports one domain-specific model: a celebrity recognizer. A 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", + "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 List Domains request": { + "$ref": "./examples/SuccessfulListDomainModels.json" + } + } + } + }, + "/analyze": { + "post": { + "description": "This operation extracts a rich set of visual features based on the image content. Two 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.", + "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.", + "type": "array", + "required": false, + "collectionFormat": "csv", + "items": { + "type": "string", + "x-nullable": false, + "x-ms-enum": { + "name": "Details", + "modelAsString": false + }, + "enum": [ + "Celebrities", + "Landmarks" + ] + } + }, + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$ref": "#/parameters/ImageUrl" + } + ], + "responses": { + "200": { + "description": "The response include the extracted features in JSON format.Here is the definitions for enumeration typesClipartTypeNon-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 Analyze with Url request": { + "$ref": "./examples/SuccessfulAnalyzeWithUrl.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. A 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.", + "operationId": "GenerateThumbnail", + "consumes": [ + "application/json" + ], + "produces": [ + "application/octet-stream" + ], + "parameters": [ + { + "name": "width", + "type": "integer", + "in": "query", + "required": true, + "minimum": 1, + "maximum": 1023, + "description": "Width of the thumbnail. It must be between 1 and 1024. Recommended minimum of 50." + }, + { + "name": "height", + "type": "integer", + "in": "query", + "required": true, + "minimum": 1, + "maximum": 1023, + "description": "Height of the thumbnail. It must be between 1 and 1024. Recommended minimum of 50." + }, + { + "$ref": "#/parameters/ImageUrl" + }, + { + "name": "smartCropping", + "type": "boolean", + "in": "query", + "required": false, + "default": false, + "description": "Boolean flag for enabling smart cropping." + } + ], + "responses": { + "200": { + "description": "The generated thumbnail in binary format.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful Generate Thumbnail request": { + "$ref": "./examples/SuccessfulGenerateThumbnailWithUrl.json" + } + } + } + }, + "/ocr": { + "post": { + "description": "Optical Character Recognition (OCR) detects printed text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon 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/ImageUrl" + }, + { + "$ref": "#/parameters/OcrLanguage" + } + ], + "responses": { + "200": { + "description": "The OCR results in the hierarchy of region/line/word. The results include text, bounding box for regions, lines and words.textAngleThe angle, in degrees, 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 Ocr request": { + "$ref": "./examples/SuccessfulOcrWithUrl.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. All descriptions are in English. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL.A 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.", + "type": "string", + "required": false, + "default": "1" + }, + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$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 Describe request": { + "$ref": "./examples/SuccessfulDescribeWithUrl.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 'cello' may be accompanied by the hint 'musical instrument'. All tags are in English.", + "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 Tag request": { + "$ref": "./examples/SuccessfulTagWithUrl.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 only provides a single domain-specific model: celebrities. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A 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": "AnalyzeImageByDomain", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "model", + "in": "path", + "description": "The domain-specific content to recognize.", + "required": true, + "type": "string" + }, + { + "$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 Domain Model analysis request": { + "$ref": "./examples/SuccessfulDomainModelWithUrl.json" + } + } + } + }, + "/recognizeText": { + "post": { + "description": "Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Recognize Text Operation Result operation.", + "operationId": "RecognizeText", + "parameters": [ + { + "$ref": "#/parameters/ImageUrl" + }, + { + "$ref": "#/parameters/TextRecognitionMode" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "The service has accepted the request and will start processing later. It will return Accepted immediately and include an Operation-Location header. Client side should further query the operation status using the URL specified in this header. The operation ID will expire in 48 hours.", + "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 Domain Model analysis request": { + "$ref": "./examples/SuccessfulRecognizeTextWithUrl.json" + } + } + } + }, + "/textOperations/{operationId}": { + "get": { + "description": "This interface is used for getting text operation result. The URL to this interface should be retrieved from 'Operation-Location' field returned from Recognize Text interface.", + "operationId": "GetTextOperationResult", + "parameters": [ + { + "name": "operationId", + "in": "path", + "description": "Id of the text operation returned in the response of the 'Recognize Text'", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns the operation status.", + "schema": { + "$ref": "#/definitions/TextOperationResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful Domain Model analysis request": { + "$ref": "./examples/SuccessfulGetTextOperationResult.json" + } + } + } + } + }, + "x-ms-paths": { + "/analyze?overload=stream": { + "post": { + "description": "This operation extracts a rich set of visual features based on the image content.", + "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.", + "type": "string", + "required": false, + "enum": [ + "Celebrities", + "Landmarks" + ] + }, + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "The response include the extracted features in JSON format. Here is the definitions for enumeration types clipart = 0, ambiguous = 1, normal-clipart = 2, good-clipart = 3. Non-LineDrawing = 0,LineDrawing = 1.", + "schema": { + "$ref": "#/definitions/ImageAnalysis" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful Analyze with Url request": { + "$ref": "./examples/SuccessfulAnalyzeWithStream.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. A 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.", + "operationId": "GenerateThumbnailInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/octet-stream" + ], + "parameters": [ + { + "name": "width", + "type": "integer", + "in": "query", + "required": true, + "minimum": 1, + "maximum": 1023, + "description": "Width of the thumbnail. It must be between 1 and 1024. Recommended minimum of 50." + }, + { + "name": "height", + "type": "integer", + "in": "query", + "required": true, + "minimum": 1, + "maximum": 1023, + "description": "Height of the thumbnail. It must be between 1 and 1024. Recommended minimum of 50." + }, + { + "$ref": "#/parameters/ImageStream" + }, + { + "name": "smartCropping", + "type": "boolean", + "in": "query", + "required": false, + "default": false, + "description": "Boolean flag for enabling smart cropping." + } + ], + "responses": { + "200": { + "description": "The generated thumbnail in binary format.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful Generate Thumbnail request": { + "$ref": "./examples/SuccessfulGenerateThumbnailWithStream.json" + } + } + } + }, + "/ocr?overload=stream": { + "post": { + "description": "Optical Character Recognition (OCR) detects printed text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon 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/OcrLanguage" + }, + { + "$ref": "#/parameters/DetectOrientation" + }, + { + "$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 degrees, 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 Ocr request": { + "$ref": "./examples/SuccessfulOcrWithStream.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. All descriptions are in English. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL.A 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.", + "type": "string", + "required": false, + "default": "1" + }, + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$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 Describe request": { + "$ref": "./examples/SuccessfulDescribeWithStream.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 'cello' may be accompanied by the hint 'musical instrument'. All tags are in English.", + "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 Tag request": { + "$ref": "./examples/SuccessfulTagWithStream.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 only provides a single domain-specific model: celebrities. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A 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": "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" + }, + { + "$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 Domain Model analysis request": { + "$ref": "./examples/SuccessfulDomainModelWithStream.json" + } + } + } + }, + "/recognizeText?overload=stream": { + "post": { + "description": "Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Recognize Text Operation Result operation.", + "operationId": "RecognizeTextInStream", + "parameters": [ + { + "$ref": "#/parameters/ImageStream" + }, + { + "$ref": "#/parameters/TextRecognitionMode" + } + ], + "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 Domain Model analysis request": { + "$ref": "./examples/SuccessfulRecognizeTextWithStream.json" + } + } + } + } + }, + "definitions": { + "TextOperationResult": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Status of the text operation.", + "enum": [ + "Not Started", + "Running", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "TextOperationStatusCodes", + "modelAsString": false + }, + "x-nullable": false + }, + "recognitionResult": { + "$ref": "#/definitions/RecognitionResult" + } + } + }, + "RecognitionResult": { + "type": "object", + "properties": { + "lines": { + "type": "array", + "items": { + "$ref": "#/definitions/Line" + } + } + } + }, + "Line": { + "type": "object", + "properties": { + "boundingBox": { + "$ref": "#/definitions/BoundingBox" + }, + "text": { + "type": "string" + }, + "words": { + "type": "array", + "items": { + "$ref": "#/definitions/Word" + } + } + } + }, + "Word": { + "type": "object", + "properties": { + "boundingBox": { + "$ref": "#/definitions/BoundingBox" + }, + "text": { + "type": "string" + } + } + }, + "BoundingBox": { + "type": "array", + "items": { + "type": "integer", + "x-nullable": false + } + }, + "ImageAnalysis": { + "type": "object", + "description": "Result of AnalyzeImage operation.", + "properties": { + "categories": { + "type": "array", + "description": "An array indicating identified categories.", + "items": { + "$ref": "#/definitions/Category" + } + }, + "adult": { + "$ref": "#/definitions/AdultInfo" + }, + "color": { + "$ref": "#/definitions/ColorInfo" + }, + "imageType": { + "$ref": "#/definitions/ImageType" + }, + "tags": { + "type": "array", + "description": "A list of tags with confidence level.", + "items": { + "$ref": "#/definitions/ImageTag" + } + }, + "description": { + "$ref": "#/definitions/ImageDescriptionDetails" + }, + "faces": { + "type": "array", + "description": "An array of possible faces within the image.", + "items": { + "$ref": "#/definitions/FaceDescription" + } + }, + "requestId": { + "type": "string", + "description": "Id of the request for tracking purposes." + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + } + }, + "OcrResult": { + "type": "object", + "properties": { + "language": { + "type": "string", + "description": "The BCP-47 language code of the text in the image." + }, + "textAngle": { + "type": "number", + "format": "double", + "x-nullable": false, + "description": "The angle, in degrees, 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." + }, + "orientation": { + "type": "string", + "description": "Orientation of the text recognized in the image. 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)." + }, + "regions": { + "type": "array", + "description": "An array of objects, where each object represents a region of recognized text.", + "items": { + "$ref": "#/definitions/OcrRegion" + } + } + } + }, + "OcrRegion": { + "type": "object", + "description": "A region consists of multiple lines (e.g. a column of text in a multi-column document).", + "properties": { + "boundingBox": { + "type": "string", + "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." + }, + "lines": { + "type": "array", + "items": { + "$ref": "#/definitions/OcrLine" + } + } + } + }, + "OcrLine": { + "type": "object", + "description": "An object describing a single recognized line of text.", + "properties": { + "boundingBox": { + "type": "string", + "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." + }, + "words": { + "type": "array", + "description": "An array of objects, where each object represents a recognized word.", + "items": { + "$ref": "#/definitions/OcrWord" + } + } + } + }, + "OcrWord": { + "type": "object", + "description": "Information on a recognized word.", + "properties": { + "boundingBox": { + "type": "string", + "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." + }, + "text": { + "type": "string", + "description": "String value of a recognized word." + } + } + }, + "ListModelsResult": { + "type": "object", + "description": "Result of the List Domain Models operation.", + "properties": { + "models": { + "type": "array", + "readOnly": true, + "description": "An array of supported models.", + "items": { + "$ref": "#/definitions/ModelDescription" + } + } + } + }, + "ModelDescription": { + "type": "object", + "description": "An object describing supported model by name and categories.", + "properties": { + "name": { + "type": "string" + }, + "categories": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DomainModelResults": { + "type": "object", + "description": "Result of image analysis using a specific domain model including additional metadata.", + "properties": { + "result": { + "x-ms-client-flatten": true, + "type": "object", + "description": "Model-specific response" + }, + "requestId": { + "type": "string", + "description": "Id of the REST API request." + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + } + }, + "CelebrityResults": { + "type": "object", + "description": "List of celebrities recognized in the image.", + "properties": { + "celebrities": { + "type": "array", + "items": { + "$ref": "#/definitions/CelebritiesModel" + } + }, + "requestId": { + "type": "string", + "description": "Id of the REST API request." + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + } + }, + "LandmarkResults": { + "type": "object", + "description": "List of landmarks recognized in the image.", + "properties": { + "landmarks": { + "type": "array", + "items": { + "$ref": "#/definitions/LandmarksModel" + } + }, + "requestId": { + "type": "string", + "description": "Id of the REST API request." + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + } + }, + "ImageDescription": { + "type": "object", + "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.", + "properties": { + "description": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageDescriptionDetails" + }, + "requestId": { + "type": "string", + "description": "Id of the REST API request." + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + } + }, + "TagResult": { + "type": "object", + "description": "The results of a image tag operation, including any tags and image metadata.", + "properties": { + "tags": { + "type": "array", + "description": "A list of tags with confidence level.", + "items": { + "$ref": "#/definitions/ImageTag" + } + }, + "requestId": { + "type": "string", + "description": "Id of the REST API request." + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + } + }, + "ImageDescriptionDetails": { + "type": "object", + "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.", + "properties": { + "tags": { + "type": "array", + "description": "A collection of image tags.", + "items": { + "type": "string" + } + }, + "captions": { + "type": "array", + "description": "A list of captions, sorted by confidence level.", + "items": { + "$ref": "#/definitions/ImageCaption" + } + } + } + }, + "ImageCaption": { + "type": "object", + "description": "An image caption, i.e. a brief description of what the image depicts.", + "properties": { + "text": { + "type": "string", + "description": "The text of the caption" + }, + "confidence": { + "type": "number", + "format": "double", + "x-nullable": false, + "description": "The level of confidence the service has in the caption" + } + } + }, + "ImageTag": { + "type": "object", + "description": "An image caption, i.e. a brief description of what the image depicts.", + "properties": { + "name": { + "type": "string", + "description": "The tag value" + }, + "confidence": { + "type": "number", + "format": "double", + "x-nullable": false, + "description": "The level of confidence the service has in the caption" + }, + "hint": { + "type": "string", + "description": "Optional categorization for the tag" + } + } + }, + "ImageMetadata": { + "type": "object", + "description": "Image metadata", + "properties": { + "width": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "description": "Image width" + }, + "height": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "description": "Image height" + }, + "format": { + "type": "string", + "description": "Image format" + } + } + }, + "CelebritiesModel": { + "type": "object", + "description": "An object describing possible celebrity identification.", + "properties": { + "name": { + "type": "string", + "description": "Name of the celebrity." + }, + "confidence": { + "type": "number", + "format": "double", + "x-nullable": false, + "description": "Level of confidence ranging from 0 to 1." + }, + "faceRectangle": { + "$ref": "#/definitions/FaceRectangle" + } + } + }, + "LandmarksModel": { + "type": "object", + "description": "A landmark recognized in the image", + "properties": { + "name": { + "type": "string", + "description": "Name of the landmark." + }, + "confidence": { + "type": "number", + "format": "double", + "x-nullable": false, + "description": "Confidence level for the landmark recognition." + } + } + }, + "FaceRectangle": { + "type": "object", + "description": "An object describing face rectangle.", + "properties": { + "left": { + "type": "integer", + "x-nullable": false, + "description": "X-coordinate of the top left point of the face." + }, + "top": { + "type": "integer", + "x-nullable": false, + "description": "Y-coordinate of the top left point of the face." + }, + "width": { + "type": "integer", + "x-nullable": false, + "description": "Width measured from the top-left point of the face." + }, + "height": { + "type": "integer", + "x-nullable": false, + "description": "Height measured from the top-left point of the face." + } + } + }, + "FaceDescription": { + "type": "object", + "description": "An object describing a face identified in the image.", + "properties": { + "age": { + "type": "integer", + "x-nullable": false, + "description": "Possible age of the face." + }, + "gender": { + "type": "string", + "description": "Possible gender of the face.", + "x-ms-enum": { + "name": "Gender-", + "modelAsString": false + }, + "enum": [ + "Male", + "Female" + ] + }, + "faceRectangle": { + "$ref": "#/definitions/FaceRectangle" + } + } + }, + "ImageType": { + "type": "object", + "description": "An object providing possible image types and matching confidence levels.", + "properties": { + "clipArtType": { + "type": "number", + "x-nullable": false, + "description": "Confidence level that the image is a clip art." + }, + "lineDrawingType": { + "type": "number", + "x-nullable": false, + "description": "Confidence level that the image is a line drawing." + } + } + }, + "ColorInfo": { + "type": "object", + "description": "An object providing additional metadata describing color attributes.", + "properties": { + "dominantColorForeground": { + "type": "string", + "description": "Possible dominant foreground color." + }, + "dominantColorBackground": { + "type": "string", + "description": "Possible dominant background color." + }, + "dominantColors": { + "type": "array", + "description": "An array of possible dominant colors.", + "items": { + "type": "string" + } + }, + "accentColor": { + "type": "string", + "description": "Possible accent color." + }, + "isBWImg": { + "type": "boolean", + "description": "A value indicating if the image is black and white." + } + } + }, + "AdultInfo": { + "type": "object", + "description": "An object describing whether the image contains adult-oriented content and/or is racy.", + "properties": { + "isAdultContent": { + "type": "boolean", + "x-nullable": false, + "description": "A value indicating if the image contains adult-oriented content." + }, + "isRacyContent": { + "type": "boolean", + "x-nullable": false, + "description": "A value indicating if the image is race." + }, + "adultScore": { + "type": "number", + "format": "double", + "x-nullable": false, + "description": "Score from 0 to 1 that indicates how much of adult content is within the image." + }, + "racyScore": { + "type": "number", + "format": "double", + "x-nullable": false, + "description": "Score from 0 to 1 that indicates how suggestive is the image." + } + } + }, + "Category": { + "type": "object", + "description": "An object describing identified category.", + "properties": { + "name": { + "type": "string", + "description": "Name of the category." + }, + "score": { + "type": "number", + "format": "double", + "x-nullable": false, + "description": "Scoring of the category." + }, + "detail": { + "$ref": "#/definitions/CategoryDetail" + } + } + }, + "CategoryDetail": { + "type": "object", + "description": "An object describing additional category details.", + "properties": { + "celebrities": { + "type": "array", + "description": "An array of celebrities if any identified.", + "items": { + "$ref": "#/definitions/CelebritiesModel" + } + }, + "landmarks": { + "type": "array", + "description": "An array of landmarks if any identified.", + "items": { + "$ref": "#/definitions/LandmarksModel" + } + } + } + }, + "ComputerVisionError": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "description": "The error code.", + "enum": [ + "InvalidImageUrl", + "InvalidImageFormat", + "InvalidImageSize", + "NotSupportedVisualFeature", + "NotSupportedImage", + "InvalidDetails", + "NotSupportedLanguage", + "BadArgument", + "FailedToProcess", + "Timeout", + "InternalServerError", + "Unspecified", + "StorageException" + ], + "x-ms-enum": { + "name": "ComputerVisionErrorCodes", + "modelAsString": false + } + }, + "message": { + "type": "string", + "description": "A message explaining the error reported by the service." + }, + "requestId": { + "type": "string", + "description": "A unique request identifier." + } + } + }, + "ServiceLanguage": { + "type": "string" + }, + "ImageUrl": { + "type": "object", + "required": [ + "url" + ], + "properties": { + "url": { + "description": "Publicly reachable URL of an image", + "type": "string" + } + } + } + }, + "parameters": { + "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). Sexually suggestive content is also detected.", + "type": "array", + "x-ms-parameter-location": "method", + "required": false, + "collectionFormat": "csv", + "items": { + "type": "string", + "x-nullable": false, + "x-ms-enum": { + "name": "VisualFeatureTypes", + "modelAsString": false + }, + "enum": [ + "ImageType", + "Faces", + "Adult", + "Categories", + "Color", + "Tags", + "Description" + ] + } + }, + "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'", + "type": "string", + "required": false, + "x-ms-parameter-location": "method", + "x-nullable": false, + "x-ms-enum": { + "name": "OcrLanguages", + "modelAsString": false + }, + "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" + ] + }, + "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, + "x-ms-parameter-location": "method", + "type": "boolean", + "default": true + }, + "TextRecognitionMode": { + "name": "mode", + "in": "query", + "description": "Type of text to recognize.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string", + "x-ms-enum": { + "name": "TextRecognitionMode", + "modelAsString": false + }, + "enum": [ + "Handwritten", + "Printed" + ] + }, + "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.", + "type": "string", + "required": false, + "x-ms-parameter-location": "method", + "x-nullable": false, + "default": "en", + "enum": [ + "en", + "es", + "ja", + "pt", + "zh" + ] + }, + "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/v2.0/examples/SuccessfulAnalyzeWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithStream.json new file mode 100644 index 000000000000..d0f29538c213 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithStream.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "visualFeatures": ["Categories", "Adult", "Tags", "Description", "Faces", "Color", "ImageType"], + "details": "Celebrities", + "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, + "adultScore": 0.0934349000453949, + "racyScore": 0.068613491952419281 + }, + "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 + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithUrl.json new file mode 100644 index 000000000000..6d926348b297 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeWithUrl.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "visualFeatures": "Categories,Adult,Tags,Description,Faces,Color,ImageType", + "details": "Celebrities,Landmarks", + "language": "en", + "ImageUrl": "{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, + "adultScore": 0.0934349000453949, + "racyScore": 0.068613491952419281 + }, + "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 + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithStream.json new file mode 100644 index 000000000000..39ebe227d6c0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithStream.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" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithUrl.json new file mode 100644 index 000000000000..11321cb00337 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeWithUrl.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "maxCandidates": "1", + "ImageUrl": "{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" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithStream.json new file mode 100644 index 000000000000..966c40a3a3f9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithStream.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 + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithUrl.json new file mode 100644 index 000000000000..20f6694e5cc5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDomainModelWithUrl.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "model": "Celebrities", + "ImageUrl": "{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 + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithStream.json new file mode 100644 index 000000000000..2b37e72ab2a6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.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}" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithUrl.json new file mode 100644 index 000000000000..c84c56f7f702 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGenerateThumbnailWithUrl.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, + "ImageUrl": "{url}" + }, + "responses": { + "200": { + "headers": {}, + "body": "{Binary}" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetTextOperationResult.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetTextOperationResult.json new file mode 100644 index 000000000000..6f818b12c4fc --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetTextOperationResult.json @@ -0,0 +1,272 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "operationId": "49a36324-fc4b-4387-aa06-090cfbf0064f" + }, + "responses": { + "200": { + "header": {}, + "body": { + "status": "Succeeded", + "recognitionResult": { + "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" + }, + { + "boundingBox": [ + 519, + 628, + 1057, + 630, + 1057, + 832, + 518, + 830 + ], + "text": "greatest" + }, + { + "boundingBox": [ + 1114, + 630, + 1549, + 631, + 1548, + 833, + 1114, + 832 + ], + "text": "glory" + }, + { + "boundingBox": [ + 1586, + 631, + 1785, + 632, + 1784, + 834, + 1586, + 833 + ], + "text": "is" + }, + { + "boundingBox": [ + 1822, + 632, + 2115, + 633, + 2115, + 835, + 1822, + 834 + ], + "text": "not" + } + ] + }, + { + "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" + }, + { + "boundingBox": [ + 667, + 1268, + 808, + 1268, + 809, + 1506, + 668, + 1507 + ], + "text": "in" + }, + { + "boundingBox": [ + 874, + 1267, + 1289, + 1265, + 1290, + 1504, + 875, + 1506 + ], + "text": "rising" + }, + { + "boundingBox": [ + 1331, + 1265, + 1771, + 1263, + 1772, + 1502, + 1332, + 1504 + ], + "text": "every" + }, + { + "boundingBox": [ + 1812, + 1263, + 2178, + 1261, + 2179, + 1500, + 1813, + 1502 + ], + "text": "time" + }, + { + "boundingBox": [ + 2219, + 1261, + 2510, + 1260, + 2511, + 1498, + 2220, + 1500 + ], + "text": "we" + }, + { + "boundingBox": [ + 2551, + 1260, + 3016, + 1258, + 3017, + 1496, + 2552, + 1498 + ], + "text": "fall" + } + ] + }, + { + "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" + }, + { + "boundingBox": [ + 1753, + 933, + 2132, + 930, + 2133, + 1144, + 1754, + 1146 + ], + "text": "never" + }, + { + "boundingBox": [ + 2162, + 930, + 2673, + 927, + 2674, + 1140, + 2164, + 1144 + ], + "text": "failing" + }, + { + "boundingBox": [ + 2703, + 926, + 2788, + 926, + 2790, + 1139, + 2705, + 1140 + ], + "text": "," + } + ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulListDomainModels.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulListDomainModels.json new file mode 100644 index 000000000000..adeddea9ee82 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulListDomainModels.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_" + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithStream.json new file mode 100644 index 000000000000..413c855b3edc --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithStream.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" + } + ] + } + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithUrl.json new file mode 100644 index 000000000000..4c721c32ee0b --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulOcrWithUrl.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "detectOrientation": "true", + "language": "en", + "ImageUrl": "{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" + } + ] + } + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithStream.json new file mode 100644 index 000000000000..ff591f1f48b9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithStream.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "mode": "Handwritten", + "Image": "{binary}" + }, + "responses": { + "202": { + "header": { + "Operation-Location": "https://{domain}/vision/v2.0/textOperations/49a36324-fc4b-4387-aa06-090cfbf0064f" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithUrl.json new file mode 100644 index 000000000000..cbe739a8c3be --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulRecognizeTextWithUrl.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "mode": "Handwritten", + "ImageUrl": "{url}" + }, + "responses": { + "202": { + "header": { + "Operation-Location": "https://westus.api.cognitive.microsoft.com/vision/v2.0/textOperations/49a36324-fc4b-4387-aa06-090cfbf0064f" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithStream.json new file mode 100644 index 000000000000..16c1f7a065dd --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithStream.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" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithUrl.json new file mode 100644 index 000000000000..548064b77e2d --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulTagWithUrl.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "ImageUrl": "{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" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ContentModerator/readme.md b/specification/cognitiveservices/data-plane/ContentModerator/readme.md index 2622b8846cd7..2d531f01202b 100644 --- a/specification/cognitiveservices/data-plane/ContentModerator/readme.md +++ b/specification/cognitiveservices/data-plane/ContentModerator/readme.md @@ -35,9 +35,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_contentmoderator'] ``` @@ -120,9 +123,10 @@ Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::ContentModerator::V1_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_contentmoderator/lib +title: "ContentModeratorClient" +``` diff --git a/specification/cognitiveservices/data-plane/CustomImageSearch/readme.md b/specification/cognitiveservices/data-plane/CustomImageSearch/readme.md new file mode 100644 index 000000000000..0babb830e27c --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomImageSearch/readme.md @@ -0,0 +1,126 @@ +# Cognitive Services Custom Search SDK + +> see https://aka.ms/autorest + +Configuration for generating Custom Search SDK. + +The current release is `release_1_0`. + +``` yaml + +tag: release_1_0 +add-credentials: true +openapi-type: data-plane +``` +# Releases + +### Release 1.0 +These settings apply only when `--tag=release_1_0` is specified on the command line. + +``` yaml $(tag) == 'release_1_0' +input-file: stable/v1.0/CustomImageSearch.json +``` + + +## 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-node +``` + + +## CSharp Settings +These settings apply only when `--csharp` is specified on the command line. +``` yaml $(csharp) +csharp: + namespace: Microsoft.Azure.CognitiveServices.Search.CustomImageSearch + output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Search/BingCustomImageSearch/BingCustomImageSearch/Generated/CustomImageSearch + sync-methods: none +``` + +## 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 + add-credentials: true + payload-flattening-threshold: 2 + namespace: azure.cognitiveservices.search.customimagesearch + package-name: azure-cognitiveservices-search-customimagesearch + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-customimagesearch/azure/cognitiveservices/search/customimagesearch +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-customimagesearch +``` + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: customimagesearch + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: release_1_0 +``` + +### Tag: release_1_0 and go + +These settings apply only when `--tag=release_1_0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v1.0/customimagesearch +``` + +## Suppressions +Suppressing errors due to API design: +``` yaml +directive: + - suppress: R3016 + reason: _type is a polymorphic discriminator that can't be changed. +``` + + +## 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.search.customimagesearch + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/search/bingcustomimagesearch + with-optional-parameters: true + prefix-model-type: Bing + with-single-async-method: true +``` diff --git a/specification/cognitiveservices/data-plane/CustomImageSearch/readme.nodejs.md b/specification/cognitiveservices/data-plane/CustomImageSearch/readme.nodejs.md new file mode 100644 index 000000000000..07c26097fcb7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomImageSearch/readme.nodejs.md @@ -0,0 +1,16 @@ +## 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-customimagesearch + package-version: 0.1.0-preview + output-folder: $(node-sdks-folder)/lib/services/cognitiveServicesCustomImageSearch + override-client-name: CustomImageSearchAPIClient + azure-arm: false + generate-license-txt: true + generate-package-json: true + generate-readme-md: false +``` diff --git a/specification/cognitiveservices/data-plane/CustomImageSearch/stable/v1.0/CustomImageSearch.json b/specification/cognitiveservices/data-plane/CustomImageSearch/stable/v1.0/CustomImageSearch.json new file mode 100644 index 000000000000..4236a1154c6e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomImageSearch/stable/v1.0/CustomImageSearch.json @@ -0,0 +1,790 @@ +{ + "swagger": "2.0", + "info": { + "title": "Custom Image Search API", + "description": "The Bing Custom Image Search API lets you send an image search query to Bing and get back image search results customized to meet your custom search definition.", + "version": "1.0" + }, + "parameters": { + "x-bingapis-sdk": { + "name": "X-BingApis-SDK", + "description": "Activate swagger compliance", + "x-ms-parameter-location": "method", + "required": true, + "type": "string", + "in": "header", + "x-ms-enum": { + "name": "XBingApisSDK", + "modelAsString": true + }, + "enum": [ + "true" + ] + } + }, + "host": "api.cognitive.microsoft.com", + "basePath": "/bingcustomsearch/v7.0", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "apiKeyHeader": { + "name": "Ocp-Apim-Subscription-Key", + "type": "apiKey", + "in": "header" + } + }, + "security": [{ + "apiKeyHeader": [] + }], + "paths": { + "/images/search": { + "get": { + "summary": "The Custom Image Search API lets you send an image search query to Bing and get image results found in your custom view of the web.", + "operationId": "CustomInstance_ImageSearch", + "tags": [ + "CustomImageSearch" + ], + "parameters": [{ + "$ref": "#/parameters/x-bingapis-sdk" + }, + { + "name": "Accept", + "in": "header", + "description": "The default media type is application/json. To specify that the response use [JSON-LD](http://json-ld.org/), set the Accept header to application/ld+json.", + "required": false, + "type": "string" + }, + { + "name": "Accept-Language", + "x-ms-client-name": "AcceptLanguage", + "in": "header", + "description": "A comma-delimited list of one or more languages to use for user interface strings. The list is in decreasing order of preference. For additional information, including expected format, see [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#setlang) query parameter are mutually exclusive; do not specify both. If you set this header, you must also specify the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#cc) query parameter. To determine the market to return results for, Bing uses the first supported language it finds from the list and combines it with the cc parameter value. If the list does not include a supported language, Bing finds the closest language and market that supports the request or it uses an aggregated or default market for the results. To determine the market that Bing used, see the BingAPIs-Market header. Use this header and the cc query parameter only if you specify multiple languages. Otherwise, use the [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#mkt) and [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#setlang) query parameters. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Any links to Bing.com properties in the response objects apply the specified language.", + "required": false, + "type": "string" + }, + { + "name": "User-Agent", + "x-ms-client-name": "UserAgent", + "in": "header", + "description": "The user agent originating the request. Bing uses the user agent to provide mobile users with an optimized experience. Although optional, you are encouraged to always specify this header. The user-agent should be the same string that any commonly used browser sends. For information about user agents, see [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The following are examples of user-agent strings. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53", + "required": false, + "type": "string" + }, + { + "name": "X-MSEdge-ClientID", + "x-ms-client-name": "ClientId", + "in": "header", + "description": "Bing uses this header to provide users with consistent behavior across Bing API calls. Bing often flights new features and improvements, and it uses the client ID as a key for assigning traffic on different flights. If you do not use the same client ID for a user across multiple requests, then Bing may assign the user to multiple conflicting flights. Being assigned to multiple conflicting flights can lead to an inconsistent user experience. For example, if the second request has a different flight assignment than the first, the experience may be unexpected. Also, Bing can use the client ID to tailor web results to that client ID’s search history, providing a richer experience for the user. Bing also uses this header to help improve result rankings by analyzing the activity generated by a client ID. The relevance improvements help with better quality of results delivered by Bing APIs and in turn enables higher click-through rates for the API consumer. IMPORTANT: Although optional, you should consider this header required. Persisting the client ID across multiple requests for the same end user and device combination enables 1) the API consumer to receive a consistent user experience, and 2) higher click-through rates via better quality of results from the Bing APIs. Each user that uses your application on the device must have a unique, Bing generated client ID. If you do not include this header in the request, Bing generates an ID and returns it in the X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is the first time the user uses your app on that device. Use the client ID for each Bing API request that your app makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a persistent HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other apps such as mobile apps, use the device's persistent storage to persist the ID. The next time the user uses your app on that device, get the client ID that you persisted. Bing responses may or may not include this header. If the response includes this header, capture the client ID and use it for all subsequent Bing requests for the user on that device. If you include the X-MSEdge-ClientID, you must not include cookies in the request.", + "required": false, + "type": "string" + }, + { + "name": "X-MSEdge-ClientIP", + "x-ms-client-name": "ClientIp", + "in": "header", + "description": "The IPv4 or IPv6 address of the client device. The IP address is used to discover the user's location. Bing uses the location information to determine safe search behavior. Although optional, you are encouraged to always specify this header and the X-Search-Location header. Do not obfuscate the address (for example, by changing the last octet to 0). Obfuscating the address results in the location not being anywhere near the device's actual location, which may result in Bing serving erroneous results.", + "required": false, + "type": "string" + }, + { + "name": "X-Search-Location", + "x-ms-client-name": "Location", + "in": "header", + "description": "A semicolon-delimited list of key/value pairs that describe the client's geographical location. Bing uses the location information to determine safe search behavior and to return relevant local content. Specify the key/value pair as :. The following are the keys that you use to specify the user's location. lat (required): The latitude of the client's location, in degrees. The latitude must be greater than or equal to -90.0 and less than or equal to +90.0. Negative values indicate southern latitudes and positive values indicate northern latitudes. long (required): The longitude of the client's location, in degrees. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy of the coordinates. Pass the value returned by the device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC UNIX timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since January 1, 1970.) head (optional): The client's relative heading or direction of travel. Specify the direction of travel as degrees from 0 through 360, counting clockwise relative to true north. Specify this key only if the sp key is nonzero. sp (optional): The horizontal velocity (speed), in meters per second, that the client device is traveling. alt (optional): The altitude of the client device, in meters. are (optional): The radius, in meters, that specifies the vertical accuracy of the coordinates. Specify this key only if you specify the alt key. Although many of the keys are optional, the more information that you provide, the more accurate the location results are. Although optional, you are encouraged to always specify the user's geographical location. Providing the location is especially important if the client's IP address does not accurately reflect the user's physical location (for example, if the client uses VPN). For optimal results, you should include this header and the X-MSEdge-ClientIP header, but at a minimum, you should include this header.", + "required": false, + "type": "string" + }, + { + "name": "customConfig", + "x-ms-client-name": "CustomConfig", + "in": "query", + "description": "The identifier for the custom search configuration", + "required": true, + "type": "integer", + "format": "int64", + "minimum": 0 + }, + { + "name": "aspect", + "x-ms-client-name": "Aspect", + "in": "query", + "description": "Filter images by the following aspect ratios. All: Do not filter by aspect.Specifying this value is the same as not specifying the aspect parameter. Square: Return images with standard aspect ratio. Wide: Return images with wide screen aspect ratio. Tall: Return images with tall aspect ratio.", + "required": false, + "type": "string", + "enum": [ + "All", + "Square", + "Wide", + "Tall" + ], + "x-ms-enum": { + "name": "ImageAspect", + "modelAsString": true + } + }, + { + "name": "color", + "x-ms-client-name": "Color", + "in": "query", + "description": "Filter images by the following color options. ColorOnly: Return color images. Monochrome: Return black and white images. Return images with one of the following dominant colors: Black, Blue, Brown, Gray, Green, Orange, Pink, Purple, Red, Teal, White, Yellow", + "required": false, + "type": "string", + "enum": [ + "ColorOnly", + "Monochrome", + "Black", + "Blue", + "Brown", + "Gray", + "Green", + "Orange", + "Pink", + "Purple", + "Red", + "Teal", + "White", + "Yellow" + ], + "x-ms-enum": { + "name": "ImageColor", + "modelAsString": true + } + }, + { + "name": "cc", + "x-ms-client-name": "CountryCode", + "in": "query", + "description": "A 2-character country code of the country where the results come from. For a list of possible values, see [Market Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#market-codes). If you set this parameter, you must also specify the [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#acceptlanguage) header. Bing uses the first supported language it finds from the languages list, and combine that language with the country code that you specify to determine the market to return results for. If the languages list does not include a supported language, Bing finds the closest language and market that supports the request, or it may use an aggregated or default market for the results instead of a specified one. You should use this query parameter and the Accept-Language query parameter only if you specify multiple languages; otherwise, you should use the mkt and setLang query parameters. This parameter and the [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#mkt) query parameter are mutually exclusive—do not specify both.", + "required": false, + "type": "string" + }, + { + "name": "count", + "x-ms-client-name": "Count", + "in": "query", + "description": "The number of images to return in the response. The actual number delivered may be less than requested. The default is 35. The maximum value is 150. You use this parameter along with the offset parameter to page results.For example, if your user interface displays 20 images per page, set count to 20 and offset to 0 to get the first page of results.For each subsequent page, increment offset by 20 (for example, 0, 20, 40). Use this parameter only with the Image Search API.Do not specify this parameter when calling the Insights, Trending Images, or Web Search APIs.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "freshness", + "x-ms-client-name": "Freshness", + "in": "query", + "description": "Filter images by the following discovery options. Day: Return images discovered by Bing within the last 24 hours. Week: Return images discovered by Bing within the last 7 days. Month: Return images discovered by Bing within the last 30 days.", + "required": false, + "type": "string", + "enum": [ + "Day", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "Freshness", + "modelAsString": true + } + }, + { + "name": "height", + "x-ms-client-name": "Height", + "in": "query", + "description": "Filter images that have the specified height, in pixels. You may use this filter with the size filter to return small images that have a height of 150 pixels.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "id", + "x-ms-client-name": "Id", + "in": "query", + "description": "An ID that uniquely identifies an image. Use this parameter to ensure that the specified image is the first image in the list of images that Bing returns. The [Image](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image) object's imageId field contains the ID that you set this parameter to.", + "required": false, + "type": "string" + }, + { + "name": "imageContent", + "x-ms-client-name": "ImageContent", + "in": "query", + "description": "Filter images by the following content types. Face: Return images that show only a person's face. Portrait: Return images that show only a person's head and shoulders.", + "required": false, + "type": "string", + "enum": [ + "Face", + "Portrait" + ], + "x-ms-enum": { + "name": "ImageContent", + "modelAsString": true + } + }, + { + "name": "imageType", + "x-ms-client-name": "ImageType", + "in": "query", + "description": "Filter images by the following image types. AnimatedGif: Return only animated GIFs. Clipart: Return only clip art images. Line: Return only line drawings. Photo: Return only photographs(excluding line drawings, animated Gifs, and clip art). Shopping: Return only images that contain items where Bing knows of a merchant that is selling the items. This option is valid in the en - US market only.Transparent: Return only images with a transparent background.", + "required": false, + "type": "string", + "enum": [ + "AnimatedGif", + "Clipart", + "Line", + "Photo", + "Shopping", + "Transparent" + ], + "x-ms-enum": { + "name": "ImageType", + "modelAsString": true + } + }, + { + "name": "license", + "x-ms-client-name": "License", + "in": "query", + "description": "Filter images by the following license types. All: Do not filter by license type.Specifying this value is the same as not specifying the license parameter. Any: Return images that are under any license type. The response doesn't include images that do not specify a license or the license is unknown. Public: Return images where the creator has waived their exclusive rights, to the fullest extent allowed by law. Share: Return images that may be shared with others. Changing or editing the image might not be allowed. Also, modifying, sharing, and using the image for commercial purposes might not be allowed. Typically, this option returns the most images. ShareCommercially: Return images that may be shared with others for personal or commercial purposes. Changing or editing the image might not be allowed. Modify: Return images that may be modified, shared, and used. Changing or editing the image might not be allowed. Modifying, sharing, and using the image for commercial purposes might not be allowed. ModifyCommercially: Return images that may be modified, shared, and used for personal or commercial purposes. Typically, this option returns the fewest images. For more information about these license types, see [Filter Images By License Type](http://go.microsoft.com/fwlink/?LinkId=309768).", + "required": false, + "type": "string", + "enum": [ + "All", + "Any", + "Public", + "Share", + "ShareCommercially", + "Modify", + "ModifyCommercially" + ], + "x-ms-enum": { + "name": "ImageLicense", + "modelAsString": true + } + }, + { + "name": "mkt", + "x-ms-client-name": "Market", + "in": "query", + "description": "The market where the results come from. Typically, mkt is the country where the user is making the request from. However, it could be a different country if the user is not located in a country where Bing delivers results. The market must be in the form -. For example, en-US. The string is case insensitive. For a list of possible market values, see [Market Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#market-codes). NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the request and return an appropriate and optimal response. If you specify a market that is not listed in [Market Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#market-codes), Bing uses a best fit market code based on an internal mapping that is subject to change. This parameter and the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#cc) query parameter are mutually exclusive—do not specify both.", + "required": false, + "type": "string" + }, + { + "name": "maxFileSize", + "x-ms-client-name": "MaxFileSize", + "in": "query", + "description": "Filter images that are less than or equal to the specified file size. The maximum file size that you may specify is 520,192 bytes. If you specify a larger value, the API uses 520,192. It is possible that the response may include images that are slightly larger than the specified maximum. You may specify this filter and minFileSize to filter images within a range of file sizes.", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "maxHeight", + "x-ms-client-name": "MaxHeight", + "in": "query", + "description": "Filter images that have a height that is less than or equal to the specified height. Specify the height in pixels. You may specify this filter and minHeight to filter images within a range of heights. This filter and the height filter are mutually exclusive.", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "maxWidth", + "x-ms-client-name": "MaxWidth", + "in": "query", + "description": "Filter images that have a width that is less than or equal to the specified width. Specify the width in pixels. You may specify this filter and maxWidth to filter images within a range of widths. This filter and the width filter are mutually exclusive.", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "minFileSize", + "x-ms-client-name": "MinFileSize", + "in": "query", + "description": "Filter images that are greater than or equal to the specified file size. The maximum file size that you may specify is 520,192 bytes. If you specify a larger value, the API uses 520,192. It is possible that the response may include images that are slightly smaller than the specified minimum. You may specify this filter and maxFileSize to filter images within a range of file sizes.", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "minHeight", + "x-ms-client-name": "MinHeight", + "in": "query", + "description": "Filter images that have a height that is greater than or equal to the specified height. Specify the height in pixels. You may specify this filter and maxHeight to filter images within a range of heights. This filter and the height filter are mutually exclusive.", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "minWidth", + "x-ms-client-name": "MinWidth", + "in": "query", + "description": "Filter images that have a width that is greater than or equal to the specified width. Specify the width in pixels. You may specify this filter and maxWidth to filter images within a range of widths. This filter and the width filter are mutually exclusive.", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "offset", + "x-ms-client-name": "Offset", + "in": "query", + "description": "The zero-based offset that indicates the number of images to skip before returning images. The default is 0. The offset should be less than ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#totalestimatedmatches) - count). Use this parameter along with the count parameter to page results. For example, if your user interface displays 20 images per page, set count to 20 and offset to 0 to get the first page of results. For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to include some overlap in results. To prevent duplicates, see [nextOffset](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#nextoffset). Use this parameter only with the Image API. Do not specify this parameter when calling the Trending Images API or the Web Search API.", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "q", + "x-ms-client-name": "Query", + "in": "query", + "description": "The user's search query term. The term cannot be empty. The term may contain [Bing Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit images to a specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. To help improve relevance of an insights query (see [insightsToken](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#insightstoken)), you should always include the user's query term. Use this parameter only with the Image Search API.Do not specify this parameter when calling the Trending Images API.", + "required": true, + "type": "string" + }, + { + "name": "safeSearch", + "x-ms-client-name": "SafeSearch", + "in": "query", + "description": "Filter images for adult content. The following are the possible filter values. Off: May return images with adult content. If the request is through the Image Search API, the response includes thumbnail images that are clear (non-fuzzy). However, if the request is through the Web Search API, the response includes thumbnail images that are pixelated (fuzzy). Moderate: If the request is through the Image Search API, the response doesn't include images with adult content. If the request is through the Web Search API, the response may include images with adult content (the thumbnail images are pixelated (fuzzy)). Strict: Do not return images with adult content. The default is Moderate. If the request comes from a market that Bing's adult policy requires that safeSearch is set to Strict, Bing ignores the safeSearch value and uses Strict. If you use the site: query operator, there is the chance that the response may contain adult content regardless of what the safeSearch query parameter is set to. Use site: only if you are aware of the content on the site and your scenario supports the possibility of adult content.", + "required": false, + "type": "string", + "enum": [ + "Off", + "Moderate", + "Strict" + ], + "x-ms-enum": { + "name": "SafeSearch", + "modelAsString": true + } + }, + { + "name": "size", + "x-ms-client-name": "Size", + "in": "query", + "description": "Filter images by the following sizes. All: Do not filter by size. Specifying this value is the same as not specifying the size parameter. Small: Return images that are less than 200x200 pixels. Medium: Return images that are greater than or equal to 200x200 pixels but less than 500x500 pixels. Large: Return images that are 500x500 pixels or larger. Wallpaper: Return wallpaper images. You may use this parameter along with the height or width parameters. For example, you may use height and size to request small images that are 150 pixels tall.", + "required": false, + "type": "string", + "enum": [ + "All", + "Small", + "Medium", + "Large", + "Wallpaper" + ], + "x-ms-enum": { + "name": "ImageSize", + "modelAsString": true + } + }, + { + "name": "setLang", + "x-ms-client-name": "SetLang", + "in": "query", + "description": "The language to use for user interface strings. Specify the language using the ISO 639-1 2-letter language code. For example, the language code for English is EN. The default is EN (English). Although optional, you should always specify the language. Typically, you set setLang to the same language specified by mkt unless the user wants the user interface strings displayed in a different language. This parameter and the [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#acceptlanguage) header are mutually exclusive; do not specify both. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Also, any links to Bing.com properties in the response objects apply the specified language.", + "required": false, + "type": "string" + }, + { + "name": "width", + "x-ms-client-name": "Width", + "in": "query", + "description": "Filter images that have the specified width, in pixels. You may use this filter with the size filter to return small images that have a width of 150 pixels.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/Images" + } + }, + "default": { + "description": "An error has occurred. Check the response type and/or status code for more details.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful image search": { + "$ref": "./examples/SuccessfulImageSearchRequest.json" + } + } + } + } + }, + "definitions": { + "Images": { + "description": "Defines an image answer", + "allOf": [{ + "$ref": "#/definitions/SearchResultsAnswer" + }], + "type": "object", + "required": [ + "value" + ], + "properties": { + "nextOffset": { + "description": "Used as part of deduping. Tells client the next offset that client should use in the next pagination request", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "value": { + "description": "A list of image objects that are relevant to the query. If there are no results, the List is empty.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageObject" + } + } + } + }, + "SearchResultsAnswer": { + "description": "Defines a search result answer.", + "allOf": [{ + "$ref": "#/definitions/Answer" + }], + "type": "object", + "properties": { + "totalEstimatedMatches": { + "description": "The estimated number of webpages that are relevant to the query. Use this number along with the count and offset query parameters to page the results.", + "readOnly": true, + "type": "integer", + "format": "int64" + } + } + }, + "ImageObject": { + "description": "Defines an image", + "allOf": [{ + "$ref": "#/definitions/MediaObject" + }], + "type": "object", + "properties": { + "thumbnail": { + "description": "The URL to a thumbnail of the image", + "$ref": "#/definitions/ImageObject", + "readOnly": true + }, + "imageInsightsToken": { + "description": "The token that you use in a subsequent call to the Image Search API to get additional information about the image. For information about using this token, see the insightsToken query parameter.", + "readOnly": true, + "type": "string" + }, + "imageId": { + "description": "Unique Id for the image", + "readOnly": true, + "type": "string" + }, + "accentColor": { + "description": "A three-byte hexadecimal number that represents the color that dominates the image. Use the color as the temporary background in your client until the image is loaded.", + "readOnly": true, + "type": "string" + }, + "visualWords": { + "description": "Visual representation of the image. Used for getting more sizes", + "readOnly": true, + "type": "string" + } + } + }, + "Query": { + "description": "Defines a search query.", + "type": "object", + "required": [ + "text" + ], + "properties": { + "text": { + "description": "The query string. Use this string as the query term in a new search request.", + "type": "string" + }, + "displayText": { + "description": "The display version of the query term. This version of the query term may contain special characters that highlight the search term found in the query string. The string contains the highlighting characters only if the query enabled hit highlighting", + "readOnly": true, + "type": "string" + }, + "webSearchUrl": { + "description": "The URL that takes the user to the Bing search results page for the query.Only related search results include this field.", + "readOnly": true, + "type": "string" + }, + "searchLink": { + "description": "The URL that you use to get the results of the related search. Before using the URL, you must append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. Use this URL if you're displaying the results in your own user interface. Otherwise, use the webSearchUrl URL.", + "readOnly": true, + "type": "string" + }, + "thumbnail": { + "description": "The URL to a thumbnail of a related image.", + "$ref": "#/definitions/ImageObject", + "readOnly": true + } + } + }, + "Answer": { + "description": "Defines an answer.", + "allOf": [{ + "$ref": "#/definitions/Response" + }], + "type": "object", + "properties": {} + }, + "MediaObject": { + "description": "Defines a media object.", + "allOf": [{ + "$ref": "#/definitions/CreativeWork" + }], + "type": "object", + "properties": { + "contentUrl": { + "description": "Original URL to retrieve the source (file) for the media object (e.g the source URL for the image).", + "readOnly": true, + "type": "string" + }, + "hostPageUrl": { + "description": "URL of the page that hosts the media object.", + "readOnly": true, + "type": "string" + }, + "contentSize": { + "description": "Size of the media object content (use format \"value unit\" e.g \"1024 B\").", + "readOnly": true, + "type": "string" + }, + "encodingFormat": { + "description": "Encoding format (e.g mp3, mp4, jpeg, etc).", + "readOnly": true, + "type": "string" + }, + "hostPageDisplayUrl": { + "description": "Display URL of the page that hosts the media object.", + "readOnly": true, + "type": "string" + }, + "width": { + "description": "The width of the media object, in pixels.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "height": { + "description": "The height of the media object, in pixels.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "Response": { + "description": "Defines a response. All schemas that could be returned at the root of a response should inherit from this", + "allOf": [{ + "$ref": "#/definitions/Identifiable" + }], + "type": "object", + "properties": { + "readLink": { + "description": "The URL that returns this resource.", + "readOnly": true, + "type": "string" + }, + "webSearchUrl": { + "description": "The URL To Bing's search result for this item.", + "readOnly": true, + "type": "string" + } + } + }, + "CreativeWork": { + "description": "The most generic kind of creative work, including books, movies, photographs, software programs, etc.", + "allOf": [{ + "$ref": "#/definitions/Thing" + }], + "type": "object", + "properties": { + "thumbnailUrl": { + "description": "The URL to a thumbnail of the item.", + "readOnly": true, + "type": "string" + }, + "provider": { + "description": "The source of the creative work.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Thing" + } + }, + "text": { + "description": "Text content of this creative work", + "readOnly": true, + "type": "string" + } + } + }, + "Identifiable": { + "description": "Defines the identity of a resource.", + "allOf": [{ + "$ref": "#/definitions/ResponseBase" + }], + "type": "object", + "properties": { + "id": { + "description": "A String identifier.", + "readOnly": true, + "type": "string" + } + } + }, + "ErrorResponse": { + "description": "The top-level response that represents a failed request.", + "allOf": [{ + "$ref": "#/definitions/Response" + }], + "type": "object", + "required": [ + "errors" + ], + "properties": { + "errors": { + "description": "A list of errors that describe the reasons why the request failed.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "Thing": { + "description": "Defines a thing.", + "allOf": [{ + "$ref": "#/definitions/Response" + }], + "type": "object", + "properties": { + "name": { + "description": "The name of the thing represented by this object.", + "readOnly": true, + "type": "string" + }, + "url": { + "description": "The URL to get more information about the thing represented by this object.", + "readOnly": true, + "type": "string" + }, + "image": { + "description": "An image of the item.", + "$ref": "#/definitions/ImageObject", + "readOnly": true + }, + "description": { + "description": "A short description of the item.", + "readOnly": true, + "type": "string" + }, + "alternateName": { + "description": "An alias for the item", + "readOnly": true, + "type": "string" + }, + "bingId": { + "description": "An ID that uniquely identifies this item.", + "readOnly": true, + "type": "string" + } + } + }, + "WebPage": { + "description": "Defines a webpage that is relevant to the query.", + "allOf": [{ + "$ref": "#/definitions/CreativeWork" + }], + "type": "object", + "properties": {} + }, + "ResponseBase": { + "description": "Response base", + "discriminator": "_type", + "type": "object", + "required": [ + "_type" + ], + "properties": { + "_type": { + "type": "string" + } + } + }, + "Error": { + "description": "Defines the error that occurred.", + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "description": "The error code that identifies the category of error.", + "type": "string", + "default": "None", + "enum": [ + "None", + "ServerError", + "InvalidRequest", + "RateLimitExceeded", + "InvalidAuthorization", + "InsufficientAuthorization" + ], + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true + } + }, + "subCode": { + "description": "The error code that further helps to identify the error.", + "readOnly": true, + "type": "string", + "enum": [ + "UnexpectedError", + "ResourceError", + "NotImplemented", + "ParameterMissing", + "ParameterInvalidValue", + "HttpNotAllowed", + "Blocked", + "AuthorizationMissing", + "AuthorizationRedundancy", + "AuthorizationDisabled", + "AuthorizationExpired" + ], + "x-ms-enum": { + "name": "ErrorSubCode", + "modelAsString": true + } + }, + "message": { + "description": "A description of the error.", + "type": "string" + }, + "moreDetails": { + "description": "A description that provides additional information about the error.", + "readOnly": true, + "type": "string" + }, + "parameter": { + "description": "The parameter in the request that caused the error.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "The parameter's value in the request that was not valid.", + "readOnly": true, + "type": "string" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomImageSearch/stable/v1.0/examples/SuccessfulImageSearchRequest.json b/specification/cognitiveservices/data-plane/CustomImageSearch/stable/v1.0/examples/SuccessfulImageSearchRequest.json new file mode 100644 index 000000000000..f39b61737d0f --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomImageSearch/stable/v1.0/examples/SuccessfulImageSearchRequest.json @@ -0,0 +1,1303 @@ +{ + "parameters": { + "X-BingApis-SDK": "true", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "_type": "Images", + "readLink": "https://www.bingapis.com/api/v7/images/search?q=degas", + "webSearchUrl": "https://www.bing.com/images/search?q=degas&FORM=OIIARP", + "totalEstimatedMatches": 760, + "nextOffset": 43, + "value": [{ + "webSearchUrl": "https://www.bing.com/images/search?view=detailv2&FORM=OIIRPO&q=shakira&id=7EF3DDA339ECA0C776A2E6527EBA20EAF7F53864&simid=608010321633281048", + "webSearchUrlPingSuffix": "DevEx,5025.1", + "name": "SHAKIRA TO PERFORM “LA LA LA (BRAZIL 2014)” FEATURING CARLINHOS BROWN AT THE CLOSING CEREMONY OF ...", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OIP.TIS8T2F1s2ko6HMRiWjTDwHaFj&pid=Api", + "datePublished": "2018-04-01T23:48:00.0000000Z", + "contentUrl": "http://shakira.com/uploaded/news/a97aa8715363e7f34fea2c7760544745.jpg", + "contentUrlPingSuffix": "DevEx,5027.1", + "hostPageUrl": "http://www.shakira.com/news/763", + "hostPageUrlPingSuffix": "DevEx,5026.1", + "contentSize": "159687 B", + "encodingFormat": "jpeg", + "hostPageDisplayUrl": "www.shakira.com/news/763", + "width": 1200, + "height": 900, + "thumbnail": { + "width": 474, + "height": 355 + }, + "imageInsightsToken": "ccid_TIS8T2F1*mid_7EF3DDA339ECA0C776A2E6527EBA20EAF7F53864*simid_608010321633281048*thid_OIP.TIS8T2F1s2ko6HMRiWjTDwHaFj", + "insightsMetadata": { + "recipeSourcesCount": 0, + "pagesIncludingCount": 183, + "availableSizesCount": 106 + }, + "imageId": "7EF3DDA339ECA0C776A2E6527EBA20EAF7F53864", + "accentColor": "714736" + }, + { + "webSearchUrl": "https://www.bing.com/images/search?view=detailv2&FORM=OIIRPO&q=shakira&id=1CB301751BADA7E12D406ED7FD1DCC722F94F22E&simid=607990341451188543", + "webSearchUrlPingSuffix": "DevEx,5031.1", + "name": "Photo gallery | Shakira", + "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OIP.F7xp1YpZw-hNuvMCl5B6mgHaJj&pid=Api", + "datePublished": "2018-04-07T09:37:00.0000000Z", + "contentUrl": "http://www.shakira.com/uploaded/gallery/c66aabc25117763c3341d1ce69bf4c7e.jpg", + "contentUrlPingSuffix": "DevEx,5033.1", + "hostPageUrl": "http://www.shakira.com/official_photos/15", + "hostPageUrlPingSuffix": "DevEx,5032.1", + "contentSize": "85868 B", + "encodingFormat": "jpeg", + "hostPageDisplayUrl": "www.shakira.com/official_photos/15", + "width": 620, + "height": 800, + "thumbnail": { + "width": 474, + "height": 611 + }, + "imageInsightsToken": "ccid_F7xp1YpZ*mid_1CB301751BADA7E12D406ED7FD1DCC722F94F22E*simid_607990341451188543*thid_OIP.F7xp1YpZw-hNuvMCl5B6mgHaJj", + "insightsMetadata": { + "recipeSourcesCount": 0, + "bestRepresentativeQuery": { + "text": "Shakira Personal Life", + "displayText": "Shakira Personal Life", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Personal+Life&id=1CB301751BADA7E12D406ED7FD1DCC722F94F22E&FORM=IDBQDM", + "webSearchUrlPingSuffix": "DevEx,5130.1" + }, + "pagesIncludingCount": 38, + "availableSizesCount": 17 + }, + "imageId": "1CB301751BADA7E12D406ED7FD1DCC722F94F22E", + "accentColor": "605157" + }, + { + "webSearchUrl": "https://www.bing.com/images/search?view=detailv2&FORM=OIIRPO&q=shakira&id=24C6054C5C245A8722F66498836C3D0FD3E68811&simid=608019517105376935", + "webSearchUrlPingSuffix": "DevEx,5037.1", + "name": "Music | Shakira", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OIP.purUY7xz93NpXe_6R4blTwHaHa&pid=Api", + "datePublished": "2018-04-04T10:37:00.0000000Z", + "contentUrl": "http://www.shakira.com/uploaded/audio/thumbs/91bf2b3f46545e353b8bc8bbb6508a2e.jpg", + "contentUrlPingSuffix": "DevEx,5039.1", + "hostPageUrl": "http://www.shakira.com/music/", + "hostPageUrlPingSuffix": "DevEx,5038.1", + "contentSize": "95162 B", + "encodingFormat": "jpeg", + "hostPageDisplayUrl": "www.shakira.com/music", + "width": 650, + "height": 650, + "thumbnail": { + "width": 474, + "height": 474 + }, + "imageInsightsToken": "ccid_purUY7xz*mid_24C6054C5C245A8722F66498836C3D0FD3E68811*simid_608019517105376935*thid_OIP.purUY7xz93NpXe\\_6R4blTwHaHa", + "insightsMetadata": { + "recipeSourcesCount": 0, + "bestRepresentativeQuery": { + "text": "Shakira Red Hair", + "displayText": "Shakira Red Hair", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Red+Hair&id=24C6054C5C245A8722F66498836C3D0FD3E68811&FORM=IDBQDM", + "webSearchUrlPingSuffix": "DevEx,5136.1" + }, + "pagesIncludingCount": 93, + "availableSizesCount": 38 + }, + "imageId": "24C6054C5C245A8722F66498836C3D0FD3E68811", + "accentColor": "A63325" + }, + { + "webSearchUrl": "https://www.bing.com/images/search?view=detailv2&FORM=OIIRPO&q=shakira&id=5477DF7ACA10385159F359B1EDB9986E55AB9DAC&simid=608012731164198123", + "webSearchUrlPingSuffix": "DevEx,5043.1", + "name": "Photo gallery | Shakira", + "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OIP.p00wd93qbKE7rvvoRK5E8wHaJ4&pid=Api", + "datePublished": "2018-04-05T10:29:00.0000000Z", + "contentUrl": "http://www.shakira.com/uploaded/gallery/98209db6aa85c20462bdace8f964ed3f.jpg", + "contentUrlPingSuffix": "DevEx,5045.1", + "hostPageUrl": "http://www.shakira.com/official_photos/34", + "hostPageUrlPingSuffix": "DevEx,5044.1", + "contentSize": "247472 B", + "encodingFormat": "jpeg", + "hostPageDisplayUrl": "www.shakira.com/official_photos/34", + "width": 1050, + "height": 1400, + "thumbnail": { + "width": 474, + "height": 632 + }, + "imageInsightsToken": "ccid_p00wd93q*mid_5477DF7ACA10385159F359B1EDB9986E55AB9DAC*simid_608012731164198123*thid_OIP.p00wd93qbKE7rvvoRK5E8wHaJ4", + "insightsMetadata": { + "recipeSourcesCount": 0, + "bestRepresentativeQuery": { + "text": "Shakira Photo Shoot 2017", + "displayText": "Shakira Photo Shoot 2017", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Photo+Shoot+2017&id=5477DF7ACA10385159F359B1EDB9986E55AB9DAC&FORM=IDBQDM", + "webSearchUrlPingSuffix": "DevEx,5142.1" + }, + "pagesIncludingCount": 4, + "availableSizesCount": 4 + }, + "imageId": "5477DF7ACA10385159F359B1EDB9986E55AB9DAC", + "accentColor": "666666" + }, + { + "webSearchUrl": "https://www.bing.com/images/search?view=detailv2&FORM=OIIRPO&q=shakira&id=24C6054C5C245A8722F68C321866CBF330FF4EC3&simid=608022867237341025", + "webSearchUrlPingSuffix": "DevEx,5049.1", + "name": "Music | Shakira", + "thumbnailUrl": "https://tse3.mm.bing.net/th?id=OIP.z3MtbLMurt5TPVZce8Z91AHaHa&pid=Api", + "datePublished": "2018-04-04T10:37:00.0000000Z", + "contentUrl": "http://www.shakira.com/uploaded/audio/thumbs/55b85208fff5c0c58b99539f5a2a45eb.jpg", + "contentUrlPingSuffix": "DevEx,5051.1", + "hostPageUrl": "http://www.shakira.com/music/", + "hostPageUrlPingSuffix": "DevEx,5050.1", + "contentSize": "110150 B", + "encodingFormat": "jpeg", + "hostPageDisplayUrl": "www.shakira.com/music", + "width": 650, + "height": 650, + "thumbnail": { + "width": 474, + "height": 474 + }, + "imageInsightsToken": "ccid_z3MtbLMu*mid_24C6054C5C245A8722F68C321866CBF330FF4EC3*simid_608022867237341025*thid_OIP.z3MtbLMurt5TPVZce8Z91AHaHa", + "insightsMetadata": { + "recipeSourcesCount": 0, + "bestRepresentativeQuery": { + "text": "Shakira Oral Fixation Album Cover", + "displayText": "Shakira Oral Fixation Album Cover", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Oral+Fixation+Album+Cover&id=24C6054C5C245A8722F68C321866CBF330FF4EC3&FORM=IDBQDM", + "webSearchUrlPingSuffix": "DevEx,5148.1" + }, + "pagesIncludingCount": 132, + "availableSizesCount": 54 + }, + "imageId": "24C6054C5C245A8722F68C321866CBF330FF4EC3", + "accentColor": "BA072C" + }, + { + "webSearchUrl": "https://www.bing.com/images/search?view=detailv2&FORM=OIIRPO&q=shakira&id=0C52D10661E6744DB0871B033E14154A5820E043&simid=608052730102286836", + "webSearchUrlPingSuffix": "DevEx,5055.1", + "name": "VEVO Hot This Year Awards | Shakira", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OIP.kg9zozwg5umxErr4mzY9MAHaDk&pid=Api", + "datePublished": "2018-04-08T13:10:00.0000000Z", + "contentUrl": "http://www.shakira.com/uploaded/news/4e1df8d65360e2f7612ad1a15328c45c.png", + "contentUrlPingSuffix": "DevEx,5057.1", + "hostPageUrl": "http://www.shakira.com/news/813", + "hostPageUrlPingSuffix": "DevEx,5056.1", + "contentSize": "679805 B", + "encodingFormat": "png", + "hostPageDisplayUrl": "www.shakira.com/news/813", + "width": 1200, + "height": 579, + "thumbnail": { + "width": 474, + "height": 228 + }, + "imageInsightsToken": "ccid_kg9zozwg*mid_0C52D10661E6744DB0871B033E14154A5820E043*simid_608052730102286836*thid_OIP.kg9zozwg5umxErr4mzY9MAHaDk", + "insightsMetadata": { + "recipeSourcesCount": 0, + "pagesIncludingCount": 4, + "availableSizesCount": 3 + }, + "imageId": "0C52D10661E6744DB0871B033E14154A5820E043", + "accentColor": "2D4E62" + }, + { + "webSearchUrl": "https://www.bing.com/images/search?view=detailv2&FORM=OIIRPO&q=shakira&id=08D6E5DA9D6D7F34CB183702AB7B7F0892AD859B&simid=608048907635721292", + "webSearchUrlPingSuffix": "DevEx,5061.1", + "name": "Donna Magazine | Shakira", + "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OIP.szMSGJAkDW4q5kAlW4tjqwHaKE&pid=Api", + "datePublished": "2018-04-10T17:33:00.0000000Z", + "contentUrl": "http://www.shakira.com/uploaded/news/008ddfa6a1601ae8b353191756a82e2b.jpg", + "contentUrlPingSuffix": "DevEx,5063.1", + "hostPageUrl": "http://www.shakira.com/news/810", + "hostPageUrlPingSuffix": "DevEx,5062.1", + "contentSize": "208229 B", + "encodingFormat": "jpeg", + "hostPageDisplayUrl": "www.shakira.com/news/810", + "width": 735, + "height": 1000, + "thumbnail": { + "width": 474, + "height": 644 + }, + "imageInsightsToken": "ccid_szMSGJAk*mid_08D6E5DA9D6D7F34CB183702AB7B7F0892AD859B*simid_608048907635721292*thid_OIP.szMSGJAkDW4q5kAlW4tjqwHaKE", + "insightsMetadata": { + "recipeSourcesCount": 0, + "bestRepresentativeQuery": { + "text": "Shakira Magazine Cover 2014", + "displayText": "Shakira Magazine Cover 2014", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Magazine+Cover+2014&id=08D6E5DA9D6D7F34CB183702AB7B7F0892AD859B&FORM=IDBQDM", + "webSearchUrlPingSuffix": "DevEx,5154.1" + }, + "pagesIncludingCount": 12, + "availableSizesCount": 10 + }, + "imageId": "08D6E5DA9D6D7F34CB183702AB7B7F0892AD859B", + "accentColor": "747057" + }, + { + "webSearchUrl": "https://www.bing.com/images/search?view=detailv2&FORM=OIIRPO&q=shakira&id=AB70D41706D7459FD1157135130400229D12979E&simid=608003196278473613", + "webSearchUrlPingSuffix": "DevEx,5067.1", + "name": "Homepage | Shakira", + "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OIP.-TIZ9FhcqLJJXhdJmZdKZgHaFQ&pid=Api", + "datePublished": "2014-05-24T21:56:00.0000000Z", + "contentUrl": "http://www.shakira.com/uploaded/news/thumbs/d93d2f466448c4aaa9bd202498b8446e.jpeg", + "contentUrlPingSuffix": "DevEx,5069.1", + "hostPageUrl": "http://www.shakira.com/home", + "hostPageUrlPingSuffix": "DevEx,5068.1", + "contentSize": "28784 B", + "encodingFormat": "jpeg", + "hostPageDisplayUrl": "www.shakira.com/home", + "width": 500, + "height": 355, + "thumbnail": { + "width": 474, + "height": 336 + }, + "imageInsightsToken": "ccid_+TIZ9Fhc*mid_AB70D41706D7459FD1157135130400229D12979E*simid_608003196278473613*thid_OIP.-TIZ9FhcqLJJXhdJmZdKZgHaFQ", + "insightsMetadata": { + "recipeSourcesCount": 0, + "bestRepresentativeQuery": { + "text": "Shakira Gallery", + "displayText": "Shakira Gallery", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Gallery&id=AB70D41706D7459FD1157135130400229D12979E&FORM=IDBQDM", + "webSearchUrlPingSuffix": "DevEx,5160.1" + }, + "pagesIncludingCount": 9, + "availableSizesCount": 5 + }, + "imageId": "AB70D41706D7459FD1157135130400229D12979E", + "accentColor": "515156" + }, + { + "webSearchUrl": "https://www.bing.com/images/search?view=detailv2&FORM=OIIRPO&q=shakira&id=82822E07EE9A27BE48E79016B7D8A7819B076DE3&simid=608048138834609014", + "webSearchUrlPingSuffix": "DevEx,5073.1", + "name": "#20women | Shakira", + "thumbnailUrl": "https://tse1.mm.bing.net/th?id=OIP.llPZ5Um3HHr_6Oe3vM9XHwHaLF&pid=Api", + "datePublished": "2018-04-10T16:43:00.0000000Z", + "contentUrl": "http://www.shakira.com/uploaded/news/5ac25f6f0aff4dc110b08520051f5721.jpg", + "contentUrlPingSuffix": "DevEx,5075.1", + "hostPageUrl": "http://www.shakira.com/news/786", + "hostPageUrlPingSuffix": "DevEx,5074.1", + "contentSize": "179642 B", + "encodingFormat": "jpeg", + "hostPageDisplayUrl": "www.shakira.com/news/786", + "width": 668, + "height": 1000, + "thumbnail": { + "width": 474, + "height": 709 + }, + "imageInsightsToken": "ccid_llPZ5Um3*mid_82822E07EE9A27BE48E79016B7D8A7819B076DE3*simid_608048138834609014*thid_OIP.llPZ5Um3HHr\\_6Oe3vM9XHwHaLF", + "insightsMetadata": { + "recipeSourcesCount": 0, + "bestRepresentativeQuery": { + "text": "Shakira Black and White", + "displayText": "Shakira Black and White", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Black+and+White&id=82822E07EE9A27BE48E79016B7D8A7819B076DE3&FORM=IDBQDM", + "webSearchUrlPingSuffix": "DevEx,5166.1" + }, + "pagesIncludingCount": 73, + "availableSizesCount": 21 + }, + "imageId": "82822E07EE9A27BE48E79016B7D8A7819B076DE3", + "accentColor": "666565" + }, + { + "webSearchUrl": "https://www.bing.com/images/search?view=detailv2&FORM=OIIRPO&q=shakira&id=8ADCFC782120D9C059804955E2B4B80F71626D3F&simid=608044346346111030", + "webSearchUrlPingSuffix": "DevEx,5079.1", + "name": "Homepage | Shakira", + "thumbnailUrl": "https://tse2.mm.bing.net/th?id=OIP.yU4OGH7YwujbbZCh3pXuaAHaFQ&pid=Api", + "datePublished": "2017-06-23T12:26:00.0000000Z", + "contentUrl": "http://www.shakira.com/uploaded/news/thumbs/7d70ef8859916faf58b70fa18eb47634.jpg", + "contentUrlPingSuffix": "DevEx,5081.1", + "hostPageUrl": "http://www.shakira.com/", + "hostPageUrlPingSuffix": "DevEx,5080.1", + "contentSize": "48567 B", + "encodingFormat": "jpeg", + "hostPageDisplayUrl": "www.shakira.com", + "width": 500, + "height": 355, + "thumbnail": { + "width": 474, + "height": 336 + }, + "imageInsightsToken": "ccid_yU4OGH7Y*mid_8ADCFC782120D9C059804955E2B4B80F71626D3F*simid_608044346346111030*thid_OIP.yU4OGH7YwujbbZCh3pXuaAHaFQ", + "insightsMetadata": { + "recipeSourcesCount": 0, + "bestRepresentativeQuery": { + "text": "2017 Shakira", + "displayText": "2017 Shakira", + "webSearchUrl": "https://www.bing.com/images/search?q=2017+Shakira&id=8ADCFC782120D9C059804955E2B4B80F71626D3F&FORM=IDBQDM", + "webSearchUrlPingSuffix": "DevEx,5172.1" + }, + "pagesIncludingCount": 13, + "availableSizesCount": 5 + }, + "imageId": "8ADCFC782120D9C059804955E2B4B80F71626D3F", + "accentColor": "953664" + } + ], + "queryExpansions": [{ + "text": "Shakira Pregnant", + "displayText": "Pregnant", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Pregnant&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Pregnant%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5179.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Pregnant&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Pregnant%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Shakira+Pregnant&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Baby", + "displayText": "Baby", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Baby&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Baby%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5181.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Baby&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Baby%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Baby&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Husband", + "displayText": "Husband", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Husband&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Husband%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5183.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Husband&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Husband%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Shakira+Husband&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "YouTube Shakira", + "displayText": "YouTube", + "webSearchUrl": "https://www.bing.com/images/search?q=YouTube+Shakira&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22YouTube%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5185.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=YouTube+Shakira&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22YouTube%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=YouTube+Shakira&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Colombia", + "displayText": "Colombia", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Colombia&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Colombia%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5187.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Colombia&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Colombia%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Colombia&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Pique", + "displayText": "Pique", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Pique&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Pique%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5189.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Pique&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Pique%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Pique&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Voice", + "displayText": "Voice", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Voice&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Voice%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5191.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Voice&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Voice%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Voice&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira FIFA", + "displayText": "FIFA", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+FIFA&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22FIFA%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5193.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+FIFA&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22FIFA%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+FIFA&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira World Cup", + "displayText": "World Cup", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+World+Cup&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22World+Cup%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5195.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+World+Cup&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22World+Cup%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Shakira+World+Cup&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Waka Waka", + "displayText": "Waka Waka", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Waka+Waka&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Waka+Waka%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5197.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Waka+Waka&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Waka+Waka%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Waka+Waka&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Dress", + "displayText": "Dress", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Dress&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Dress%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5199.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Dress&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Dress%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Shakira+Dress&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Hair", + "displayText": "Hair", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Hair&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Hair%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5201.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Hair&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Hair%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Shakira+Hair&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Hairstyles", + "displayText": "Hairstyles", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Hairstyles&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Hairstyles%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5203.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Hairstyles&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Hairstyles%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Hairstyles&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Oral Fixation", + "displayText": "Oral Fixation", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Oral+Fixation&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Oral+Fixation%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5205.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Oral+Fixation&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Oral+Fixation%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Oral+Fixation&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Album Cover", + "displayText": "Album Cover", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Album+Cover&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Album+Cover%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5207.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Album+Cover&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Album+Cover%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Shakira+Album+Cover&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Zootopia", + "displayText": "Zootopia", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Zootopia&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Zootopia%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5209.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Zootopia&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Zootopia%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Shakira+Zootopia&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Beyonce Shakira", + "displayText": "Beyonce", + "webSearchUrl": "https://www.bing.com/images/search?q=Beyonce+Shakira&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Beyonce%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5211.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Beyonce+Shakira&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Beyonce%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Beyonce+Shakira&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Loca", + "displayText": "Loca", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Loca&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Loca%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5213.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Loca&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Loca%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Shakira+Loca&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Suerte", + "displayText": "Suerte", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Suerte&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Suerte%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5215.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Suerte&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Suerte%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Suerte&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Singing", + "displayText": "Singing", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Singing&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Singing%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5217.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Singing&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Singing%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Shakira+Singing&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Dancing", + "displayText": "Dancing", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Dancing&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Dancing%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5219.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Dancing&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Dancing%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Dancing&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Caine", + "displayText": "Caine", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Caine&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Caine%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5221.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Caine&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Caine%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Shakira+Caine&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Son", + "displayText": "Son", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Son&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Son%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5223.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Son&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Son%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Son&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Parents", + "displayText": "Parents", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Parents&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Parents%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5225.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Parents&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Parents%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Shakira+Parents&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Family", + "displayText": "Family", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Family&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Family%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5227.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Family&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Family%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Family&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Remember to for Get You Shakira", + "displayText": "Remember to for Get You", + "webSearchUrl": "https://www.bing.com/images/search?q=Remember+to+for+Get+You+Shakira&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Remember+to+for+Get+You%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5229.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Remember+to+for+Get+You+Shakira&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Remember+to+for+Get+You%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Remember+to+for+Get+You+Shakira&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Gypsy", + "displayText": "Gypsy", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Gypsy&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Gypsy%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5231.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Gypsy&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Gypsy%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Gypsy&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Rabiosa", + "displayText": "Rabiosa", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Rabiosa&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Rabiosa%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5233.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Rabiosa&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Rabiosa%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Shakira+Rabiosa&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Wallpaper", + "displayText": "Wallpaper", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Wallpaper&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Wallpaper%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5235.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Wallpaper&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Wallpaper%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Wallpaper&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Cartoon", + "displayText": "Cartoon", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Cartoon&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Cartoon%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5237.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Cartoon&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Cartoon%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Cartoon&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Doll", + "displayText": "Doll", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Doll&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Doll%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5239.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Doll&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Doll%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Shakira+Doll&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Poster", + "displayText": "Poster", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Poster&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Poster%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5241.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Poster&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Poster%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Shakira+Poster&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Beautiful Shakira", + "displayText": "Beautiful", + "webSearchUrl": "https://www.bing.com/images/search?q=Beautiful+Shakira&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Beautiful%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5243.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Beautiful+Shakira&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Beautiful%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Beautiful+Shakira&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Enrique Iglesias", + "displayText": "Enrique Iglesias", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Enrique+Iglesias&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Enrique+Iglesias%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5245.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Enrique+Iglesias&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Enrique+Iglesias%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Enrique+Iglesias&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Jennifer Lopez Shakira", + "displayText": "Jennifer Lopez", + "webSearchUrl": "https://www.bing.com/images/search?q=Jennifer+Lopez+Shakira&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Jennifer+Lopez%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5247.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Jennifer+Lopez+Shakira&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Jennifer+Lopez%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Jennifer+Lopez+Shakira&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Pies Descalzos", + "displayText": "Pies Descalzos", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Pies+Descalzos&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Pies+Descalzos%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5249.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Pies+Descalzos&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Pies+Descalzos%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Shakira+Pies+Descalzos&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Boots", + "displayText": "Boots", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Boots&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Boots%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5251.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Boots&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Boots%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Shakira+Boots&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Jeans", + "displayText": "Jeans", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Jeans&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Jeans%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5253.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Jeans&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Jeans%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Shakira+Jeans&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Outfits", + "displayText": "Outfits", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Outfits&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Outfits%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5255.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Outfits&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Outfits%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Outfits&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira 2002", + "displayText": "2002", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+2002&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%222002%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5257.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+2002&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%222002%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Shakira+2002&pid=Api&mkt=en-US&adlt=strict&t=1" + } + } + ], + "pivotSuggestions": [{ + "pivot": "shakira", + "suggestions": [{ + "text": "Jennifer Lopez", + "displayText": "Jennifer Lopez", + "webSearchUrl": "https://www.bing.com/images/search?q=Jennifer+Lopez&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Jennifer+Lopez%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5264.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Jennifer+Lopez&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Jennifer+Lopez%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Jennifer+Lopez&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Rihanna", + "displayText": "Rihanna", + "webSearchUrl": "https://www.bing.com/images/search?q=Rihanna&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Rihanna%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5266.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Rihanna&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Rihanna%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Rihanna&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Beyoncé Knowles", + "displayText": "Beyoncé Knowles", + "webSearchUrl": "https://www.bing.com/images/search?q=Beyonc%c3%a9+Knowles&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Beyonc%c3%a9+Knowles%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5268.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Beyonc%c3%a9+Knowles&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Beyonc%c3%a9+Knowles%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Beyonc%c3%a9+Knowles&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Usher Raymond IV", + "displayText": "Usher Raymond IV", + "webSearchUrl": "https://www.bing.com/images/search?q=Usher+Raymond+IV&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Usher+Raymond+IV%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5270.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Usher+Raymond+IV&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Usher+Raymond+IV%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Usher+Raymond+IV&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Christina Aguilera", + "displayText": "Christina Aguilera", + "webSearchUrl": "https://www.bing.com/images/search?q=Christina+Aguilera&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Christina+Aguilera%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5272.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Christina+Aguilera&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Christina+Aguilera%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Christina+Aguilera&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Adam Levine", + "displayText": "Adam Levine", + "webSearchUrl": "https://www.bing.com/images/search?q=Adam+Levine&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Adam+Levine%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5274.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Adam+Levine&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Adam+Levine%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Adam+Levine&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Katy Perry", + "displayText": "Katy Perry", + "webSearchUrl": "https://www.bing.com/images/search?q=Katy+Perry&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Katy+Perry%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5276.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Katy+Perry&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Katy+Perry%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Katy+Perry&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Blake Shelton", + "displayText": "Blake Shelton", + "webSearchUrl": "https://www.bing.com/images/search?q=Blake+Shelton&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Blake+Shelton%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5278.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Blake+Shelton&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Blake+Shelton%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Blake+Shelton&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Pitbull Rapper", + "displayText": "Pitbull Rapper", + "webSearchUrl": "https://www.bing.com/images/search?q=Pitbull+Rapper&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Pitbull+Rapper%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5280.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Pitbull+Rapper&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Pitbull+Rapper%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Pitbull+Rapper&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Lady Gaga", + "displayText": "Lady Gaga", + "webSearchUrl": "https://www.bing.com/images/search?q=Lady+Gaga&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Lady+Gaga%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5282.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Lady+Gaga&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Lady+Gaga%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Lady+Gaga&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Selena Gomez", + "displayText": "Selena Gomez", + "webSearchUrl": "https://www.bing.com/images/search?q=Selena+Gomez&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Selena+Gomez%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5284.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Selena+Gomez&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Selena+Gomez%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Selena+Gomez&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Britney Spears", + "displayText": "Britney Spears", + "webSearchUrl": "https://www.bing.com/images/search?q=Britney+Spears&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Britney+Spears%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5286.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Britney+Spears&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Britney+Spears%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Britney+Spears&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Miley Cyrus", + "displayText": "Miley Cyrus", + "webSearchUrl": "https://www.bing.com/images/search?q=Miley+Cyrus&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Miley+Cyrus%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5288.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Miley+Cyrus&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Miley+Cyrus%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Miley+Cyrus&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Taylor Swift", + "displayText": "Taylor Swift", + "webSearchUrl": "https://www.bing.com/images/search?q=Taylor+Swift&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Taylor+Swift%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5290.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Taylor+Swift&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Taylor+Swift%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Taylor+Swift&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Nicki Minaj", + "displayText": "Nicki Minaj", + "webSearchUrl": "https://www.bing.com/images/search?q=Nicki+Minaj&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Nicki+Minaj%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5292.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Nicki+Minaj&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Nicki+Minaj%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Nicki+Minaj&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Justin Bieber", + "displayText": "Justin Bieber", + "webSearchUrl": "https://www.bing.com/images/search?q=Justin+Bieber&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Justin+Bieber%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5294.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Justin+Bieber&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Justin+Bieber%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Justin+Bieber&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Madonna Louise Veronica Ciccone", + "displayText": "Madonna Louise Veronica Ciccone", + "webSearchUrl": "https://www.bing.com/images/search?q=Madonna+Louise+Veronica+Ciccone&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Madonna+Louise+Veronica+Ciccone%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5296.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Madonna+Louise+Veronica+Ciccone&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Madonna+Louise+Veronica+Ciccone%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Madonna+Louise+Veronica+Ciccone&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Mariah Carey", + "displayText": "Mariah Carey", + "webSearchUrl": "https://www.bing.com/images/search?q=Mariah+Carey&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Mariah+Carey%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5298.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Mariah+Carey&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Mariah+Carey%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Mariah+Carey&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Demi Lovato", + "displayText": "Demi Lovato", + "webSearchUrl": "https://www.bing.com/images/search?q=Demi+Lovato&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Demi+Lovato%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5300.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Demi+Lovato&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Demi+Lovato%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Demi+Lovato&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Iggy Azalea", + "displayText": "Iggy Azalea", + "webSearchUrl": "https://www.bing.com/images/search?q=Iggy+Azalea&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Iggy+Azalea%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d&FORM=IRQBPS", + "webSearchUrlPingSuffix": "DevEx,5302.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Iggy+Azalea&tq=%7b%22pq%22%3a%22shakira%22%2c%22qs%22%3a%5b%7b%22cv%22%3a%22shakira%22%2c%22pv%22%3a%22shakira%22%2c%22hps%22%3atrue%2c%22iqp%22%3afalse%7d%2c%7b%22cv%22%3a%22Iggy+Azalea%22%2c%22pv%22%3a%22%22%2c%22hps%22%3afalse%2c%22iqp%22%3atrue%7d%5d%7d", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Iggy+Azalea&pid=Api&mkt=en-US&adlt=strict&t=1" + } + } + ] + }], + "relatedSearches": [{ + "text": "Demi Lovato", + "displayText": "Demi Lovato", + "webSearchUrl": "https://www.bing.com/images/search?q=Demi+Lovato&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5309.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Demi+Lovato", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Demi+Lovato&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Jennifer Lopez", + "displayText": "Jennifer Lopez", + "webSearchUrl": "https://www.bing.com/images/search?q=Jennifer+Lopez&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5311.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Jennifer+Lopez", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Jennifer+Lopez&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Lady Gaga", + "displayText": "Lady Gaga", + "webSearchUrl": "https://www.bing.com/images/search?q=Lady+Gaga&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5313.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Lady+Gaga", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Lady+Gaga&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Katy Perry", + "displayText": "Katy Perry", + "webSearchUrl": "https://www.bing.com/images/search?q=Katy+Perry&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5315.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Katy+Perry", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Katy+Perry&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Nicki Minaj", + "displayText": "Nicki Minaj", + "webSearchUrl": "https://www.bing.com/images/search?q=Nicki+Minaj&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5317.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Nicki+Minaj", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Nicki+Minaj&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Ariana Grande", + "displayText": "Ariana Grande", + "webSearchUrl": "https://www.bing.com/images/search?q=Ariana+Grande&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5319.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Ariana+Grande", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Ariana+Grande&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Beyonce", + "displayText": "Beyonce", + "webSearchUrl": "https://www.bing.com/images/search?q=Beyonce&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5321.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Beyonce", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Beyonce&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Christina Aguilera", + "displayText": "Christina Aguilera", + "webSearchUrl": "https://www.bing.com/images/search?q=Christina+Aguilera&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5323.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Christina+Aguilera", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Christina+Aguilera&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Gwen Stefani", + "displayText": "Gwen Stefani", + "webSearchUrl": "https://www.bing.com/images/search?q=Gwen+Stefani&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5325.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Gwen+Stefani", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Gwen+Stefani&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Rihanna", + "displayText": "Rihanna", + "webSearchUrl": "https://www.bing.com/images/search?q=Rihanna&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5327.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Rihanna", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Rihanna&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Selena Gomez", + "displayText": "Selena Gomez", + "webSearchUrl": "https://www.bing.com/images/search?q=Selena+Gomez&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5329.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Selena+Gomez", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Selena+Gomez&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Justin Bieber", + "displayText": "Justin Bieber", + "webSearchUrl": "https://www.bing.com/images/search?q=Justin+Bieber&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5331.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Justin+Bieber", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Justin+Bieber&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "2017 Shakira", + "displayText": "2017 Shakira", + "webSearchUrl": "https://www.bing.com/images/search?q=2017+Shakira&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5333.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=2017+Shakira", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=2017+Shakira&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "2018 Shakira", + "displayText": "2018 Shakira", + "webSearchUrl": "https://www.bing.com/images/search?q=2018+Shakira&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5335.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=2018+Shakira", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=2018+Shakira&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira 2012", + "displayText": "Shakira 2012", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+2012&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5337.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+2012", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Shakira+2012&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Taylor Swift", + "displayText": "Taylor Swift", + "webSearchUrl": "https://www.bing.com/images/search?q=Taylor+Swift&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5339.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Taylor+Swift", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Taylor+Swift&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Avril Lavigne", + "displayText": "Avril Lavigne", + "webSearchUrl": "https://www.bing.com/images/search?q=Avril+Lavigne&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5341.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Avril+Lavigne", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Avril+Lavigne&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Adele", + "displayText": "Adele", + "webSearchUrl": "https://www.bing.com/images/search?q=Adele&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5343.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Adele", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Adele&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Son", + "displayText": "Shakira Son", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Son&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5345.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Son", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Son&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Now", + "displayText": "Shakira Now", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Now&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5347.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Now", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Now&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Black Hair", + "displayText": "Shakira Black Hair", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Black+Hair&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5349.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Black+Hair", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Shakira+Black+Hair&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Album", + "displayText": "Shakira Album", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Album&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5351.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Album", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Shakira+Album&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Caine", + "displayText": "Shakira Caine", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Caine&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5353.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Caine", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Shakira+Caine&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Face", + "displayText": "Shakira Face", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Face&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5355.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Face", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Shakira+Face&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Dancing", + "displayText": "Shakira Dancing", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Dancing&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5357.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Dancing", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Dancing&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Singing", + "displayText": "Shakira Singing", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Singing&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5359.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Singing", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Shakira+Singing&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira and Gerard Pique", + "displayText": "Shakira and Gerard Pique", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+and+Gerard+Pique&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5361.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+and+Gerard+Pique", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Shakira+and+Gerard+Pique&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Pique Shakira", + "displayText": "Pique Shakira", + "webSearchUrl": "https://www.bing.com/images/search?q=Pique+Shakira&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5363.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Pique+Shakira", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Pique+Shakira&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "FLL Shakira Clothing Off", + "displayText": "FLL Shakira Clothing Off", + "webSearchUrl": "https://www.bing.com/images/search?q=FLL+Shakira+Clothing+Off&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5365.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=FLL+Shakira+Clothing+Off", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=FLL+Shakira+Clothing+Off&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Hair", + "displayText": "Shakira Hair", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Hair&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5367.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Hair", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Shakira+Hair&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Boyfriend", + "displayText": "Shakira Boyfriend", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Boyfriend&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5369.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Boyfriend", + "thumbnail": { + "thumbnailUrl": "https://tse4.mm.bing.net/th?q=Shakira+Boyfriend&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira and Her Husband", + "displayText": "Shakira and Her Husband", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+and+Her+Husband&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5371.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+and+Her+Husband", + "thumbnail": { + "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Shakira+and+Her+Husband&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Shakira Loca", + "displayText": "Shakira Loca", + "webSearchUrl": "https://www.bing.com/images/search?q=Shakira+Loca&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5373.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Shakira+Loca", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Shakira+Loca&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Best of Shakira", + "displayText": "Best of Shakira", + "webSearchUrl": "https://www.bing.com/images/search?q=Best+of+Shakira&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5375.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Best+of+Shakira", + "thumbnail": { + "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Best+of+Shakira&pid=Api&mkt=en-US&adlt=strict&t=1" + } + }, + { + "text": "Scarlett Johansson", + "displayText": "Scarlett Johansson", + "webSearchUrl": "https://www.bing.com/images/search?q=Scarlett+Johansson&FORM=IRPATC", + "webSearchUrlPingSuffix": "DevEx,5377.1", + "searchLink": "https://cognitivegblppe.azure-api.net/api/v7/images/search?q=Scarlett+Johansson", + "thumbnail": { + "thumbnailUrl": "https://tse2.mm.bing.net/th?q=Scarlett+Johansson&pid=Api&mkt=en-US&adlt=strict&t=1" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomSearch/readme.md b/specification/cognitiveservices/data-plane/CustomSearch/readme.md deleted file mode 100644 index 45f6f3d63e20..000000000000 --- a/specification/cognitiveservices/data-plane/CustomSearch/readme.md +++ /dev/null @@ -1,124 +0,0 @@ -# Cognitive Services Custom Search SDK - -> see https://aka.ms/autorest - -Configuration for generating Custom Search SDK. - -The current release is `release_1_0`. - -``` yaml - -tag: release_1_0 -add-credentials: true -openapi-type: data-plane -``` -# Releases - -### Release 1.0 -These settings apply only when `--tag=release_1_0` is specified on the command line. - -``` yaml $(tag) == 'release_1_0' -input-file: stable/v1.0/CustomSearch.json -``` - - -## 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-libraries-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node -``` - - -## CSharp Settings -These settings apply only when `--csharp` is specified on the command line. -``` yaml $(csharp) -csharp: - namespace: Microsoft.Azure.CognitiveServices.Search.CustomSearch - output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Search/BingCustomSearch/BingCustomSearch/Generated/CustomSearch - sync-methods: none -``` - -## 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 - add-credentials: true - payload-flattening-threshold: 2 - namespace: azure.cognitiveservices.search.customsearch - package-name: azure-cognitiveservices-search-customsearch - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-customsearch/azure/cognitiveservices/search/customsearch -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-customsearch -``` - -## Go - -These settings apply only when `--go` is specified on the command line. - -``` yaml $(go) -go: - license-header: MICROSOFT_APACHE_NO_VERSION - namespace: customsearch - clear-output-folder: true -``` - -### Go multi-api - -``` yaml $(go) && $(multiapi) -batch: - - tag: release_1_0 -``` - -### Tag: release_1_0 and go - -These settings apply only when `--tag=release_1_0 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'release_1_0' && $(go) -output-folder: $(go-sdk-folder)/services/cognitiveservices/v1.0/customsearch -``` - -## Suppressions -Suppressing errors due to API design: -``` yaml -directive: - - suppress: R3016 - reason: _type is a polymorphic discriminator that can't be changed. -``` - - -## 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 - fluent: true - namespace: com.microsoft.azure.cognitiveservices.customsearch - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-cognitiveservices/customsearch -``` diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md index bb0b21a3d9df..ba75914f85de 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md @@ -17,18 +17,22 @@ openapi-type: data-plane These settings apply only when `--tag=release_1_0` is specified on the command line. ``` yaml $(tag) == 'release_1_0' -input-file: stable/v1.1/Prediction.json +input-file: stable/v2.0/Prediction.json ``` -# Code Generation +# Validation ## Suppression + ``` yaml directive: - - suppress: DefinitionsPropertiesNamesCamelCase - reason: Live service and portal doesn't use came case properties + - suppress: R3017 # GuidUsage + reason: + - Existing service and previous versions use Guid as ids. ``` +# Code Generation + ## Swagger to SDK This section describes what SDK should be generated by the automatic system. @@ -38,13 +42,15 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - 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 + sync-methods: all license-header: MICROSOFT_MIT_NO_VERSION azure-arm: false namespace: Microsoft.Azure.CognitiveServices.Vision.CustomVision.Prediction @@ -104,3 +110,20 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(java) +java: + azure-arm: true + namespace: com.microsoft.azure.cognitiveservices.vision.customvision.prediction + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/vision/customvision/prediction + with-optional-parameters: true + with-single-async-method: true +``` diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.nodejs.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.nodejs.md new file mode 100644 index 000000000000..ae5fa10e636b --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.nodejs.md @@ -0,0 +1,16 @@ +## 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-customvision-prediction + package-version: 1.0.0-preview + output-folder: $(node-sdks-folder)/lib/services/customVision/prediction + override-client-name: PredictionAPIClient + azure-arm: false + generate-license-txt: true + generate-package-json: true + generate-readme-md: false +``` diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md new file mode 100644 index 000000000000..411adce418c5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md @@ -0,0 +1,27 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_cognitiveservices_customvision_prediction +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: release_1_0 +``` + +### Tag: release_1_0 and ruby + +These settings apply only when `--tag=release_1_0 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::CustomVision::Prediction::V1_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvision_prediction/lib +title: "PredictionClient" +``` diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/Prediction.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/Prediction.json new file mode 100644 index 000000000000..51c067a6c051 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/Prediction.json @@ -0,0 +1,415 @@ +{ + "swagger": "2.0", + "info": { + "version": "2.0", + "title": "PredictionEndpoint" + }, + "host": "southcentralus.api.cognitive.microsoft.com", + "basePath": "/customvision/v2.0/Prediction", + "schemes": [ + "https" + ], + "paths": { + "/{projectId}/url": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Predict an image url and saves the result", + "operationId": "PredictImageUrl", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "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": "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", + "x-nullable": true + }, + { + "name": "application", + "in": "query", + "description": "Optional. Specifies the name of application using the endpoint", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + } + }, + "x-ms-examples": { + "Successful PredictImageUrl request": { + "$ref": "./examples/PredictImageUrl.json" + } + } + } + }, + "/{projectId}/image": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Predict an image and saves the result", + "operationId": "PredictImage", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/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", + "x-nullable": true + }, + { + "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", + "required": true, + "type": "file" + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + } + }, + "x-ms-examples": { + "Successful PredictImage request": { + "$ref": "./examples/PredictImage.json" + } + } + } + }, + "/{projectId}/url/nostore": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Predict an image url without saving the result", + "operationId": "PredictImageUrlWithNoStore", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "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": "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", + "x-nullable": true + }, + { + "name": "application", + "in": "query", + "description": "Optional. Specifies the name of application using the endpoint", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + } + }, + "x-ms-examples": { + "Successful PredictImageUrlWithNoStore request": { + "$ref": "./examples/PredictImageUrlWithNoStore.json" + } + } + } + }, + "/{projectId}/image/nostore": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Predict an image without saving the result", + "operationId": "PredictImageWithNoStore", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/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", + "x-nullable": true + }, + { + "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", + "required": true, + "type": "file" + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + } + }, + "x-ms-examples": { + "Successful PredictImageWithNoStore request": { + "$ref": "./examples/PredictImageWithNoStore.json" + } + } + } + } + }, + "definitions": { + "ImageUrl": { + "type": "object", + "properties": { + "url": { + "type": "string", + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImagePrediction": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "project": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "iteration": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "predictions": { + "type": "array", + "items": { + "$ref": "#/definitions/Prediction" + }, + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "Prediction": { + "type": "object", + "properties": { + "probability": { + "format": "float", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagName": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "boundingBox": { + "$ref": "#/definitions/BoundingBox", + "readOnly": true + } + }, + "x-nullable": true + }, + "BoundingBox": { + "type": "object", + "properties": { + "left": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "top": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "width": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "height": { + "format": "float", + "type": "number", + "x-nullable": false + } + }, + "x-nullable": true + } + }, + "parameters": { + "ApiKey": { + "name": "Prediction-Key", + "in": "header", + "required": true, + "type": "string", + "x-ms-client-name": "ApiKey", + "x-ms-parameter-location": "client" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/examples/PredictImage.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/examples/PredictImage.json new file mode 100644 index 000000000000..645a80f03a73 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/examples/PredictImage.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Prediction-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:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/examples/PredictImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/examples/PredictImageUrl.json new file mode 100644 index 000000000000..0727445f3d86 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/examples/PredictImageUrl.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Prediction-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:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/examples/PredictImageUrlWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/examples/PredictImageUrlWithNoStore.json new file mode 100644 index 000000000000..0727445f3d86 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/examples/PredictImageUrlWithNoStore.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Prediction-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:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/examples/PredictImageWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/examples/PredictImageWithNoStore.json new file mode 100644 index 000000000000..645a80f03a73 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/examples/PredictImageWithNoStore.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Prediction-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:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} \ 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 38bc744b6ba2..6bd7275f0655 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_1_0`. +The current release is `release_2_1`. ``` yaml -tag: release_1_0 +tag: release_2_1 openapi-type: data-plane ``` # Releases @@ -17,18 +17,28 @@ openapi-type: data-plane These settings apply only when `--tag=release_1_0` is specified on the command line. ``` yaml $(tag) == 'release_1_0' -input-file: stable/v1.2/Training.json +input-file: stable/v2.0/Training.json ``` -# Code Generation +### Release 2.1 +These settings apply only when `--tag=release_2_1` is specified on the command line. + +``` yaml $(tag) == 'release_2_1' +input-file: stable/v2.1/Training.json +``` +# Validation ## Suppression + ``` yaml directive: - - suppress: DefinitionsPropertiesNamesCamelCase - reason: Live service and portal doesn't use came case properties + - suppress: R3017 # GuidUsage + reason: + - Existing service and previous versions use Guid as ids. ``` +# Code Generation + ## Swagger to SDK This section describes what SDK should be generated by the automatic system. @@ -38,13 +48,15 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - 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 + sync-methods: all license-header: MICROSOFT_MIT_NO_VERSION azure-arm: false namespace: Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training @@ -95,6 +107,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: release_1_0 + - tag: release_2_1 ``` ### Tag: release_1_0 and go @@ -105,3 +118,28 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_2_1' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v2.1/customvision/$(namespace) +``` + +## 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.vision.customvision.training + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/vision/customvision/training + with-optional-parameters: true + with-single-async-method: true +``` diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.nodejs.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.nodejs.md new file mode 100644 index 000000000000..6601680d8a5a --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.nodejs.md @@ -0,0 +1,16 @@ +## 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-customvision-training + package-version: 1.0.0-preview + output-folder: $(node-sdks-folder)/lib/services/customVision/training + override-client-name: TrainingAPIClient + azure-arm: false + generate-license-txt: true + generate-package-json: true + generate-readme-md: false +``` diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md new file mode 100644 index 000000000000..6fcea51453d6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md @@ -0,0 +1,27 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_cognitiveservices_customvision_training +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: release_1_0 +``` + +### Tag: release_1_0 and ruby + +These settings apply only when `--tag=release_1_0 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::CustomVision::Training::V1_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvision_training/lib +title: "TrainingClient" +``` diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/Training.json new file mode 100644 index 000000000000..702f5975a7d3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/Training.json @@ -0,0 +1,3672 @@ +{ + "swagger": "2.0", + "info": { + "version": "2.0", + "title": "TrainingApi" + }, + "host": "southcentralus.api.cognitive.microsoft.com", + "basePath": "/customvision/v2.0/Training", + "schemes": [ + "https" + ], + "paths": { + "/domains": { + "get": { + "tags": [ + "DomainsApi" + ], + "summary": "Get a list of the available domains", + "operationId": "GetDomains", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Domain" + }, + "x-nullable": true + } + } + }, + "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", + "text/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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Domain" + } + } + }, + "x-ms-examples": { + "Successful GetDomain request": { + "$ref": "./examples/GetDomain.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", + "text/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", + "x-nullable": true + }, + { + "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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "orderBy", + "in": "query", + "description": "The ordering. Defaults to newest", + "required": false, + "type": "string", + "enum": [ + "Newest", + "Oldest" + ], + "x-nullable": false + }, + { + "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 + }, + { + "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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetTaggedImages request": { + "$ref": "./examples/GetTaggedImages.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", + "text/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", + "x-nullable": true + }, + { + "name": "orderBy", + "in": "query", + "description": "The ordering. Defaults to newest", + "required": false, + "type": "string", + "enum": [ + "Newest", + "Oldest" + ], + "x-nullable": false + }, + { + "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 + }, + { + "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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetUntaggedImages request": { + "$ref": "./examples/GetUntaggedImages.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", + "text/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", + "x-nullable": true + }, + { + "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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "format": "int32", + "type": "integer", + "x-nullable": false + } + } + }, + "x-ms-examples": { + "Successful GetTaggedImageCount request": { + "$ref": "./examples/GetTaggedImageCount.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", + "text/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", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "format": "int32", + "type": "integer", + "x-nullable": false + } + } + }, + "x-ms-examples": { + "Successful GetUntaggedImageCount request": { + "$ref": "./examples/GetUntaggedImageCount.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", + "text/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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetImagesByIds request": { + "$ref": "./examples/GetImagesByIds.json" + } + } + } + }, + "/projects/{projectId}/images": { + "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", + "operationId": "CreateImagesFromData", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "imageData", + "in": "formData", + "required": true, + "type": "file" + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + } + }, + "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": [], + "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. Limted to 256 images per batch", + "required": true, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteImages request": { + "$ref": "./examples/DeleteImages.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.", + "operationId": "CreateImagesFromFiles", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + } + }, + "x-ms-examples": { + "Successful CreateImagesFromFiles request": { + "$ref": "./examples/CreateImagesFromFiles.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.", + "operationId": "CreateImagesFromUrls", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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 and tag ids. Limited to 64 images and 20 tags per batch", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrlCreateBatch" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + } + }, + "x-ms-examples": { + "Successful CreateImagesFromUrls request": { + "$ref": "./examples/CreateImagesFromUrls.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.", + "operationId": "CreateImagesFromPredictions", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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 and tag ids. Limted to 64 images and 20 tags per batch", + "required": true, + "schema": { + "$ref": "#/definitions/ImageIdCreateBatch" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + } + }, + "x-ms-examples": { + "Successful CreateImagesFromPredictions request": { + "$ref": "./examples/CreateImagesFromPredictions.json" + } + } + } + }, + "/projects/{projectId}/images/tags": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Associate a set of images with a set of tags", + "operationId": "CreateImageTags", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageTagCreateSummary" + } + } + }, + "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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "tagIds", + "in": "query", + "description": "Tags to be deleted from the specified images. Limted to 20 tags", + "required": true, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteImageTags request": { + "$ref": "./examples/DeleteImageTags.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.", + "operationId": "CreateImageRegions", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageRegionCreateSummary" + } + } + }, + "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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteImageRegions request": { + "$ref": "./examples/DeleteImageRegions.json" + } + } + } + }, + "/{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", + "text/json" + ], + "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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageRegionProposal" + } + } + }, + "x-ms-examples": { + "Successful GetImageRegionProposals request": { + "$ref": "./examples/GetImageRegionProposals.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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "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", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PredictionQueryResult" + } + } + }, + "x-ms-examples": { + "Successful QueryPredictions request": { + "$ref": "./examples/QueryPredictions.json" + } + } + } + }, + "/projects/{projectId}/quicktest/url": { + "post": { + "tags": [ + "PredictionsApi" + ], + "summary": "Quick test an image url", + "operationId": "QuickTestImageUrl", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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 {Iris.Web.Api.Models.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", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + } + }, + "x-ms-examples": { + "Successful QuickTestImageUrl request": { + "$ref": "./examples/QuickTestImageUrl.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", + "text/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", + "x-nullable": true + }, + { + "name": "imageData", + "in": "formData", + "required": true, + "type": "file" + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + } + }, + "x-ms-examples": { + "Successful QuickTestImage request": { + "$ref": "./examples/QuickTestImage.json" + } + } + } + }, + "/projects/{projectId}/train": { + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Queues project for training", + "operationId": "TrainProject", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Iteration" + } + } + }, + "x-ms-examples": { + "Successful TrainProject request": { + "$ref": "./examples/TrainProject.json" + } + } + } + }, + "/projects": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get your projects", + "operationId": "GetProjects", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Project" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetProjects request": { + "$ref": "./examples/GetProjects.json" + } + } + }, + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Create a project", + "operationId": "CreateProject", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Name of the project", + "required": true, + "type": "string", + "x-nullable": true + }, + { + "name": "description", + "in": "query", + "description": "The description of the project", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "name": "domainId", + "in": "query", + "description": "The id of the domain to use for this project. Defaults to General", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + } + }, + "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", + "text/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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + } + }, + "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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteProject request": { + "$ref": "./examples/DeleteProject.json" + } + } + }, + "patch": { + "tags": [ + "ProjectApi" + ], + "summary": "Update a specific project", + "operationId": "UpdateProject", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + } + }, + "x-ms-examples": { + "Successful UpdateProject request": { + "$ref": "./examples/UpdateProject.json" + } + } + } + }, + "/projects/{projectId}/iterations": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get iterations for the project", + "operationId": "GetIterations", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Iteration" + }, + "x-nullable": true + } + } + }, + "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", + "text/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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Iteration" + } + } + }, + "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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteIteration request": { + "$ref": "./examples/DeleteIteration.json" + } + } + }, + "patch": { + "tags": [ + "ProjectApi" + ], + "summary": "Update a specific iteration", + "operationId": "UpdateIteration", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Iteration" + } + } + }, + "x-ms-examples": { + "Successful UpdateIteration request": { + "$ref": "./examples/UpdateIteration.json" + } + } + } + }, + "/projects/{projectId}/iterations/{iterationId}/performance": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get detailed performance information about an iteration", + "operationId": "GetIterationPerformance", + "consumes": [], + "produces": [ + "application/json", + "text/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" + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IterationPerformance" + } + } + }, + "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", + "text/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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "orderBy", + "in": "query", + "description": "The ordering. Defaults to newest", + "required": false, + "type": "string", + "enum": [ + "Newest", + "Oldest" + ], + "x-nullable": false + }, + { + "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 + }, + { + "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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ImagePerformance" + }, + "x-nullable": true + } + } + }, + "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", + "text/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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "format": "int32", + "type": "integer", + "x-nullable": false + } + } + }, + "x-ms-examples": { + "Successful GetImagePerformanceCount request": { + "$ref": "./examples/GetImagePerformanceCount.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", + "text/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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Export" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetExports request": { + "$ref": "./examples/GetExports.json" + } + } + }, + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Export a trained iteration", + "operationId": "ExportIteration", + "consumes": [], + "produces": [ + "application/json", + "text/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 (coreml or tensorflow)", + "required": true, + "type": "string", + "x-nullable": true + }, + { + "name": "flavor", + "in": "query", + "description": "The flavor of the target platform (Windows, Linux, ARM, or GPU)", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Export" + } + } + }, + "x-ms-examples": { + "Successful ExportIteration request": { + "$ref": "./examples/ExportIteration.json" + } + } + } + }, + "/projects/{projectId}/tags/{tagId}": { + "get": { + "tags": [ + "TagsApi" + ], + "summary": "Get information about a specific tag", + "operationId": "GetTag", + "consumes": [], + "produces": [ + "application/json", + "text/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", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Tag" + } + } + }, + "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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteTag request": { + "$ref": "./examples/DeleteTag.json" + } + } + }, + "patch": { + "tags": [ + "TagsApi" + ], + "summary": "Update a tag", + "operationId": "UpdateTag", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Tag" + } + } + }, + "x-ms-examples": { + "Successful UpdateTag request": { + "$ref": "./examples/UpdateTag.json" + } + } + } + }, + "/projects/{projectId}/tags": { + "get": { + "tags": [ + "TagsApi" + ], + "summary": "Get the tags for a given project and iteration", + "operationId": "GetTags", + "consumes": [], + "produces": [ + "application/json", + "text/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", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-nullable": true + } + } + }, + "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", + "text/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", + "x-nullable": true + }, + { + "name": "description", + "in": "query", + "description": "Optional description for the tag", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Tag" + } + } + }, + "x-ms-examples": { + "Successful CreateTag request": { + "$ref": "./examples/CreateTag.json" + } + } + } + } + }, + "definitions": { + "Domain": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "name": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "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 + } + }, + "x-nullable": true + }, + "Image": { + "description": "Image model to be sent as JSON", + "type": "object", + "properties": { + "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, + "x-nullable": true + }, + "thumbnailUri": { + "type": "string", + "readOnly": true, + "x-nullable": 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 + } + }, + "x-nullable": true + }, + "ImageTag": { + "type": "object", + "properties": { + "tagId": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagName": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + } + }, + "x-nullable": true + }, + "ImageRegion": { + "type": "object", + "properties": { + "regionId": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagName": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "left": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "top": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "width": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "height": { + "format": "float", + "type": "number", + "x-nullable": false + } + }, + "x-nullable": true + }, + "ImageCreateSummary": { + "type": "object", + "properties": { + "isBatchSuccessful": { + "type": "boolean", + "readOnly": true, + "x-nullable": false + }, + "images": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageCreateResult" + }, + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageCreateResult": { + "type": "object", + "properties": { + "sourceUrl": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "status": { + "enum": [ + "OK", + "OKDuplicate", + "ErrorSource", + "ErrorImageFormat", + "ErrorImageSize", + "ErrorStorage", + "ErrorLimitExceed", + "ErrorTagLimitExceed", + "ErrorRegionLimitExceed", + "ErrorUnknown" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ImageUploadStatus", + "modelAsString": true + } + }, + "image": { + "$ref": "#/definitions/Image", + "readOnly": true + } + }, + "x-nullable": true + }, + "ImageFileCreateBatch": { + "type": "object", + "properties": { + "images": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageFileCreateEntry" + }, + "x-nullable": true + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageFileCreateEntry": { + "type": "object", + "properties": { + "name": { + "type": "string", + "x-nullable": true + }, + "contents": { + "format": "byte", + "type": "string", + "x-nullable": true + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "x-nullable": true + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/Region" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "Region": { + "type": "object", + "properties": { + "tagId": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "left": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "top": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "width": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "height": { + "format": "float", + "type": "number", + "x-nullable": false + } + }, + "x-nullable": true + }, + "ImageUrlCreateBatch": { + "type": "object", + "properties": { + "images": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageUrlCreateEntry" + }, + "x-nullable": true + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageUrlCreateEntry": { + "type": "object", + "properties": { + "url": { + "type": "string", + "x-nullable": true + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "x-nullable": true + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/Region" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageIdCreateBatch": { + "type": "object", + "properties": { + "images": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageIdCreateEntry" + }, + "x-nullable": true + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageIdCreateEntry": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "x-nullable": true + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/Region" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageTagCreateBatch": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTagCreateEntry" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageTagCreateEntry": { + "type": "object", + "properties": { + "imageId": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "type": "string", + "x-nullable": false + } + }, + "x-nullable": true + }, + "ImageTagCreateSummary": { + "type": "object", + "properties": { + "created": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTagCreateEntry" + }, + "x-nullable": true + }, + "duplicated": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTagCreateEntry" + }, + "x-nullable": true + }, + "exceeded": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTagCreateEntry" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageRegionCreateBatch": { + "description": "Batch of image region information to create.", + "type": "object", + "properties": { + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageRegionCreateEntry" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageRegionCreateEntry": { + "type": "object", + "properties": { + "imageId": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "left": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "top": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "width": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "height": { + "format": "float", + "type": "number", + "x-nullable": false + } + }, + "x-nullable": true + }, + "ImageRegionCreateSummary": { + "type": "object", + "properties": { + "created": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageRegionCreateResult" + }, + "x-nullable": true + }, + "duplicated": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageRegionCreateEntry" + }, + "x-nullable": true + }, + "exceeded": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageRegionCreateEntry" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageRegionCreateResult": { + "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": true + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "left": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "top": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "width": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "height": { + "format": "float", + "type": "number", + "x-nullable": 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" + }, + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "RegionProposal": { + "type": "object", + "properties": { + "confidence": { + "format": "float", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "boundingBox": { + "$ref": "#/definitions/BoundingBox", + "readOnly": true + } + }, + "x-nullable": true + }, + "BoundingBox": { + "type": "object", + "properties": { + "left": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "top": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "width": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "height": { + "format": "float", + "type": "number", + "x-nullable": false + } + }, + "x-nullable": true + }, + "PredictionQueryToken": { + "type": "object", + "properties": { + "session": { + "type": "string", + "x-nullable": true + }, + "continuation": { + "type": "string", + "x-nullable": true + }, + "maxCount": { + "format": "int32", + "type": "integer", + "x-nullable": false + }, + "orderBy": { + "enum": [ + "Newest", + "Oldest", + "Suggested" + ], + "type": "string", + "x-nullable": false, + "x-ms-enum": { + "name": "OrderBy", + "modelAsString": true + } + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/PredictionQueryTag" + }, + "x-nullable": true + }, + "iterationId": { + "format": "uuid", + "type": "string", + "x-nullable": true + }, + "startTime": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "endTime": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "application": { + "type": "string", + "x-nullable": true + } + }, + "x-nullable": true + }, + "PredictionQueryTag": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "minThreshold": { + "format": "float", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "maxThreshold": { + "format": "float", + "type": "number", + "readOnly": true, + "x-nullable": false + } + }, + "x-nullable": true + }, + "PredictionQueryResult": { + "type": "object", + "properties": { + "token": { + "$ref": "#/definitions/PredictionQueryToken", + "readOnly": true + }, + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/StoredImagePrediction" + }, + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "StoredImagePrediction": { + "description": "result of an image classification request", + "type": "object", + "properties": { + "imageUri": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "thumbnailUri": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "domain": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "id": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "project": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "iteration": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "predictions": { + "type": "array", + "items": { + "$ref": "#/definitions/Prediction" + }, + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "Prediction": { + "type": "object", + "properties": { + "probability": { + "format": "float", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagName": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "boundingBox": { + "$ref": "#/definitions/BoundingBox", + "readOnly": true + } + }, + "x-nullable": true + }, + "ImageUrl": { + "type": "object", + "properties": { + "url": { + "type": "string", + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImagePrediction": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "project": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "iteration": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "predictions": { + "type": "array", + "items": { + "$ref": "#/definitions/Prediction" + }, + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "Iteration": { + "description": "Iteration model to be sent over JSON", + "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", + "x-nullable": true + }, + "isDefault": { + "description": "Gets or sets a value indicating whether the iteration is the default iteration for the project", + "type": "boolean", + "x-nullable": false + }, + "status": { + "description": "Gets the current iteration status", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "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 + }, + "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 + } + }, + "x-nullable": true + }, + "Project": { + "description": "Represents a project", + "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", + "x-nullable": true + }, + "description": { + "description": "Gets or sets the description of the project", + "type": "string", + "x-nullable": true + }, + "settings": { + "$ref": "#/definitions/ProjectSettings", + "description": "Gets or sets the project settings" + }, + "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 modifed", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "thumbnailUri": { + "description": "Gets the thumbnail url representing the project", + "type": "string", + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "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", + "x-nullable": false + } + }, + "x-nullable": true + }, + "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" + }, + "readOnly": true, + "x-nullable": 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 + } + }, + "x-nullable": true + }, + "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": 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 + } + }, + "x-nullable": 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, + "x-nullable": true + }, + "thumbnailUri": { + "type": "string", + "readOnly": true, + "x-nullable": 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 + } + }, + "x-nullable": true + }, + "Export": { + "type": "object", + "properties": { + "platform": { + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ExportPlatform", + "modelAsString": true + } + }, + "status": { + "enum": [ + "Exporting", + "Failed", + "Done" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ExportStatusModel", + "modelAsString": true + } + }, + "downloadUri": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "flavor": { + "enum": [ + "Linux", + "Windows" + ], + "type": "string", + "readOnly": true, + "x-nullable": true, + "x-ms-enum": { + "name": "ExportFlavor", + "modelAsString": true + } + } + }, + "x-nullable": true + }, + "Tag": { + "description": "Represents a Tag", + "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", + "x-nullable": true + }, + "description": { + "description": "Gets or sets the description of the tag", + "type": "string", + "x-nullable": true + }, + "imageCount": { + "format": "int32", + "description": "Gets the number of images with this tag", + "type": "integer", + "readOnly": true, + "x-nullable": false + } + }, + "x-nullable": true + } + }, + "parameters": { + "ApiKey": { + "name": "Training-Key", + "in": "header", + "required": true, + "type": "string", + "x-ms-client-name": "ApiKey", + "x-ms-parameter-location": "client" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImageRegions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImageRegions.json new file mode 100644 index 000000000000..850cb26abd78 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImageRegions.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "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 + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "created": [ ], + "duplicated": [], + "exceeded": [] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImageTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImageTags.json new file mode 100644 index 000000000000..a665e7f9dce2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImageTags.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "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 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImagesFromData.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImagesFromData.json new file mode 100644 index 000000000000..75509c5cb6ac --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImagesFromData.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "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:10.65Z", + "width": 1095, + "height": 900, + "imageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.6105895Z" + } + ] + } + }, + { + "sourceUrl": "\"hemlock_6.jpg\"", + "status": "OK", + "image": { + "id": "f1855a92-b873-47e7-b513-f07a667ceda1", + "created": "2017-12-19T15:56:10.57Z", + "width": 900, + "height": 1531, + "imageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.5168568Z" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImagesFromFiles.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImagesFromFiles.json new file mode 100644 index 000000000000..da978c0a0170 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImagesFromFiles.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "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:10.65Z", + "width": 1095, + "height": 900, + "imageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.6105895Z" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImagesFromPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImagesFromPredictions.json new file mode 100644 index 000000000000..58564980619d --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImagesFromPredictions.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "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:10.65Z", + "width": 1095, + "height": 900, + "imageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.6105895Z" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImagesFromUrls.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImagesFromUrls.json new file mode 100644 index 000000000000..b654934ccf85 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateImagesFromUrls.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "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:10.65Z", + "width": 1095, + "height": 900, + "imageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.6105895Z" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateProject.json new file mode 100644 index 000000000000..7cd7ddc0da8d --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateProject.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "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:18.08Z", + "lastModified": "2017-12-18T05:43:18.0962423Z", + "thumbnailUri": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateTag.json new file mode 100644 index 000000000000..ed2bdd0a3ed1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/CreateTag.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "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", + "imageCount": 0 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteImageRegions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteImageRegions.json new file mode 100644 index 000000000000..8f6df982b3f1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteImageRegions.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "regionIds": [ "" ] + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteImageTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteImageTags.json new file mode 100644 index 000000000000..518da817475e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteImageTags.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "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": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteImages.json new file mode 100644 index 000000000000..145476cdc56d --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteImages.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "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": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteIteration.json new file mode 100644 index 000000000000..e8485f9861ca --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteIteration.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758" + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeletePrediction.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeletePrediction.json new file mode 100644 index 000000000000..4d32761fe2ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeletePrediction.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "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": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteProject.json new file mode 100644 index 000000000000..df01ee93a164 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteProject.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e" + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteTag.json new file mode 100644 index 000000000000..a0ec1fcd1899 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/DeleteTag.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "tagId": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01" + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/ExportIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/ExportIteration.json new file mode 100644 index 000000000000..56492e41b46e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/ExportIteration.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "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": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetDomain.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetDomain.json new file mode 100644 index 000000000000..d48adae04acd --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetDomain.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "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", + "exportable": false + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetDomains.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetDomains.json new file mode 100644 index 000000000000..1ddf4a5f2290 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetDomains.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "name": "General", + "exportable": false + }, + { + "id": "c151d5b5-dd07-472a-acc8-15d29dea8518", + "name": "Food", + "exportable": false + }, + { + "id": "ca455789-012d-4b50-9fec-5bb63841c793", + "name": "Landmarks", + "exportable": false + }, + { + "id": "b30a91ae-e3c1-4f73-a81e-c270bff27c39", + "name": "Retail", + "exportable": false + }, + { + "id": "45badf75-3591-4f26-a705-45678d3e9f5f", + "name": "Adult", + "exportable": false + }, + { + "id": "0732100f-1a38-4e49-a514-c9b44c697ab5", + "name": "General (compact)", + "exportable": true + }, + { + "id": "b5cfd229-2ac7-4b2b-8d0a-2b0661344894", + "name": "Landmarks (compact)", + "exportable": true + }, + { + "id": "6b4faeda-8396-481b-9f8b-177b9fa3097f", + "name": "Retail (compact)", + "exportable": true + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetExports.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetExports.json new file mode 100644 index 000000000000..3f1b714ce6c3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetExports.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "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", + "downloadUri": "{Download URI" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetImagePerformanceCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetImagePerformanceCount.json new file mode 100644 index 000000000000..aa56993d9e22 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetImagePerformanceCount.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "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" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetImagePerformances.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetImagePerformances.json new file mode 100644 index 000000000000..53d22d37a5bd --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetImagePerformances.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "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:26.5806336Z", + "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": [ ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetImageRegionProposals.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetImageRegionProposals.json new file mode 100644 index 000000000000..02aeecf2c97e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetImageRegionProposals.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "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 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetImagesByIds.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetImagesByIds.json new file mode 100644 index 000000000000..b4074dc03914 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetImagesByIds.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": [] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetIteration.json new file mode 100644 index 000000000000..73d869176e5e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetIteration.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "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", + "isDefault": false, + "status": "Completed", + "created": "2017-12-18T22:40:36.9066667Z", + "lastModified": "2017-12-19T15:47:02.9511889Z", + "trainedAt": "2017-12-19T15:47:02.9511889Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetIterationPerformance.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetIterationPerformance.json new file mode 100644 index 000000000000..7439d312e675 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetIterationPerformance.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "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 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetIterations.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetIterations.json new file mode 100644 index 000000000000..65076112db77 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetIterations.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "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", + "isDefault": true, + "status": "Completed", + "created": "2017-12-18T22:40:29.7304213Z", + "lastModified": "2017-12-18T22:40:41.3173903Z", + "trainedAt": "2017-12-18T22:40:41.0058589Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + { + "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "name": "Iteration 2", + "isDefault": false, + "status": "Completed", + "created": "2017-12-18T22:40:36.9066667Z", + "lastModified": "2017-12-19T15:47:02.9511889Z", + "trainedAt": "2017-12-19T15:47:02.9511889Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + { + "id": "3adaf7b2-18fc-4376-9da4-b5ea160a7cf5", + "name": "Iteration 3", + "isDefault": false, + "status": "New", + "created": "2017-12-19T15:46:59.2533333Z", + "lastModified": "2017-12-19T15:46:59.2699369Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": null + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetProject.json new file mode 100644 index 000000000000..1aa6738e11f5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetProject.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "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:18.08Z", + "lastModified": "2017-12-18T05:43:18.0962423Z", + "thumbnailUri": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetProjects.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetProjects.json new file mode 100644 index 000000000000..267009f6e8b9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetProjects.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "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:18.08Z", + "lastModified": "2017-12-18T05:43:18.0962423Z", + "thumbnailUri": null + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetTag.json new file mode 100644 index 000000000000..bf11b89c5a4c --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetTag.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "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", + "imageCount": 0 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetTaggedImageCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetTaggedImageCount.json new file mode 100644 index 000000000000..ad6351b8c0f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetTaggedImageCount.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "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" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetTaggedImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetTaggedImages.json new file mode 100644 index 000000000000..b4074dc03914 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetTaggedImages.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": [] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetTags.json new file mode 100644 index 000000000000..f424d85ce713 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetTags.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "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", + "imageCount": 0 + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetUntaggedImageCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetUntaggedImageCount.json new file mode 100644 index 000000000000..ad6351b8c0f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetUntaggedImageCount.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "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" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetUntaggedImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetUntaggedImages.json new file mode 100644 index 000000000000..b4074dc03914 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/GetUntaggedImages.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": [] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/QueryPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/QueryPredictions.json new file mode 100644 index 000000000000..bf1cf24fbc77 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/QueryPredictions.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "query": { + "orderBy": "Newest", + "tags": [ + { + "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "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:26.5806336Z", + "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 + } + ], + "imageUri": "", + "thumbnailUri": "" + } + ], + "token": { + "session": "1:286613", + "continuation": null, + "maxCount": 0, + "orderBy": "Newest", + "tags": [ + { + "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "minThreshold": 0.9, + "maxThreshold": 1.0 + } + ], + "iterationId": null, + "startTime": null, + "endTime": null, + "application": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/QuickTestImage.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/QuickTestImage.json new file mode 100644 index 000000000000..69ce03eeb6b1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/QuickTestImage.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "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:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.00 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/QuickTestImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/QuickTestImageUrl.json new file mode 100644 index 000000000000..99363212a175 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/QuickTestImageUrl.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "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:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.00 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/TrainProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/TrainProject.json new file mode 100644 index 000000000000..b12850dc8165 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/TrainProject.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "name": "Iteration 2", + "isDefault": false, + "status": "Training", + "created": "2017-12-18T22:40:36.9066667Z", + "lastModified": "2017-12-19T15:46:58.197323Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/UpdateIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/UpdateIteration.json new file mode 100644 index 000000000000..3c7cfc7ae1a4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/UpdateIteration.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "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", + "isDefault": false, + "status": "Completed", + "created": "2017-12-18T22:40:36.9066667Z", + "lastModified": "2017-12-19T15:53:07.8782881Z", + "trainedAt": "2017-12-19T15:47:02.9511889Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/UpdateProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/UpdateProject.json new file mode 100644 index 000000000000..7c287615090c --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/UpdateProject.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "updatedProject": { + "name": "New Project Name", + "description": "A new Description" + } + }, + "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:18.08Z", + "lastModified": "2017-12-18T05:43:18.0962423Z", + "thumbnailUri": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/UpdateTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/UpdateTag.json new file mode 100644 index 000000000000..49157fcd803b --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/examples/UpdateTag.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "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", + "description": "Better description" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", + "name": "Better Tag Name", + "description": "Better description", + "imageCount": 0 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/Training.json new file mode 100644 index 000000000000..39088061cd7f --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/Training.json @@ -0,0 +1,3726 @@ +{ + "swagger": "2.0", + "info": { + "version": "2.1", + "title": "TrainingApi" + }, + "host": "southcentralus.api.cognitive.microsoft.com", + "basePath": "/customvision/v2.1/Training", + "schemes": [ + "https" + ], + "paths": { + "/domains": { + "get": { + "tags": [ + "DomainsApi" + ], + "summary": "Get a list of the available domains", + "operationId": "GetDomains", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Domain" + }, + "x-nullable": true + } + } + }, + "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", + "text/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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Domain" + } + } + }, + "x-ms-examples": { + "Successful GetDomain request": { + "$ref": "./examples/GetDomain.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", + "text/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", + "x-nullable": true + }, + { + "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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "orderBy", + "in": "query", + "description": "The ordering. Defaults to newest", + "required": false, + "type": "string", + "enum": [ + "Newest", + "Oldest" + ], + "x-nullable": false + }, + { + "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 + }, + { + "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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetTaggedImages request": { + "$ref": "./examples/GetTaggedImages.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", + "text/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", + "x-nullable": true + }, + { + "name": "orderBy", + "in": "query", + "description": "The ordering. Defaults to newest", + "required": false, + "type": "string", + "enum": [ + "Newest", + "Oldest" + ], + "x-nullable": false + }, + { + "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 + }, + { + "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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetUntaggedImages request": { + "$ref": "./examples/GetUntaggedImages.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", + "text/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", + "x-nullable": true + }, + { + "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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "format": "int32", + "type": "integer", + "x-nullable": false + } + } + }, + "x-ms-examples": { + "Successful GetTaggedImageCount request": { + "$ref": "./examples/GetTaggedImageCount.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", + "text/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", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "format": "int32", + "type": "integer", + "x-nullable": false + } + } + }, + "x-ms-examples": { + "Successful GetUntaggedImageCount request": { + "$ref": "./examples/GetUntaggedImageCount.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", + "text/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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetImagesByIds request": { + "$ref": "./examples/GetImagesByIds.json" + } + } + } + }, + "/projects/{projectId}/images": { + "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", + "operationId": "CreateImagesFromData", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "imageData", + "in": "formData", + "required": true, + "type": "file" + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + } + }, + "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": [], + "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. Limted to 256 images per batch", + "required": true, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteImages request": { + "$ref": "./examples/DeleteImages.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.", + "operationId": "CreateImagesFromFiles", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + } + }, + "x-ms-examples": { + "Successful CreateImagesFromFiles request": { + "$ref": "./examples/CreateImagesFromFiles.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.", + "operationId": "CreateImagesFromUrls", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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 and tag ids. Limited to 64 images and 20 tags per batch", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrlCreateBatch" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + } + }, + "x-ms-examples": { + "Successful CreateImagesFromUrls request": { + "$ref": "./examples/CreateImagesFromUrls.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.", + "operationId": "CreateImagesFromPredictions", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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 and tag ids. Limted to 64 images and 20 tags per batch", + "required": true, + "schema": { + "$ref": "#/definitions/ImageIdCreateBatch" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + } + }, + "x-ms-examples": { + "Successful CreateImagesFromPredictions request": { + "$ref": "./examples/CreateImagesFromPredictions.json" + } + } + } + }, + "/projects/{projectId}/images/tags": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Associate a set of images with a set of tags", + "operationId": "CreateImageTags", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageTagCreateSummary" + } + } + }, + "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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "tagIds", + "in": "query", + "description": "Tags to be deleted from the specified images. Limted to 20 tags", + "required": true, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteImageTags request": { + "$ref": "./examples/DeleteImageTags.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.", + "operationId": "CreateImageRegions", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageRegionCreateSummary" + } + } + }, + "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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteImageRegions request": { + "$ref": "./examples/DeleteImageRegions.json" + } + } + } + }, + "/{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", + "text/json" + ], + "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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageRegionProposal" + } + } + }, + "x-ms-examples": { + "Successful GetImageRegionProposals request": { + "$ref": "./examples/GetImageRegionProposals.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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "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", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PredictionQueryResult" + } + } + }, + "x-ms-examples": { + "Successful QueryPredictions request": { + "$ref": "./examples/QueryPredictions.json" + } + } + } + }, + "/projects/{projectId}/quicktest/url": { + "post": { + "tags": [ + "PredictionsApi" + ], + "summary": "Quick test an image url", + "operationId": "QuickTestImageUrl", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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 {Iris.Web.Api.Models.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", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + } + }, + "x-ms-examples": { + "Successful QuickTestImageUrl request": { + "$ref": "./examples/QuickTestImageUrl.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", + "text/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", + "x-nullable": true + }, + { + "name": "imageData", + "in": "formData", + "required": true, + "type": "file" + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + } + }, + "x-ms-examples": { + "Successful QuickTestImage request": { + "$ref": "./examples/QuickTestImage.json" + } + } + } + }, + "/projects/{projectId}/train": { + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Queues project for training", + "operationId": "TrainProject", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Iteration" + } + } + }, + "x-ms-examples": { + "Successful TrainProject request": { + "$ref": "./examples/TrainProject.json" + } + } + } + }, + "/projects": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get your projects", + "operationId": "GetProjects", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Project" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetProjects request": { + "$ref": "./examples/GetProjects.json" + } + } + }, + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Create a project", + "operationId": "CreateProject", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Name of the project", + "required": true, + "type": "string", + "x-nullable": true + }, + { + "name": "description", + "in": "query", + "description": "The description of the project", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "name": "domainId", + "in": "query", + "description": "The id of the domain to use for this project. Defaults to General", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "name": "classificationType", + "in": "query", + "description": "The type of classifier to create for this project", + "required": false, + "type": "string", + "enum": [ + "Multiclass", + "Multilabel" + ], + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + } + }, + "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", + "text/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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + } + }, + "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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteProject request": { + "$ref": "./examples/DeleteProject.json" + } + } + }, + "patch": { + "tags": [ + "ProjectApi" + ], + "summary": "Update a specific project", + "operationId": "UpdateProject", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + } + }, + "x-ms-examples": { + "Successful UpdateProject request": { + "$ref": "./examples/UpdateProject.json" + } + } + } + }, + "/projects/{projectId}/iterations": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get iterations for the project", + "operationId": "GetIterations", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Iteration" + }, + "x-nullable": true + } + } + }, + "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", + "text/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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Iteration" + } + } + }, + "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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteIteration request": { + "$ref": "./examples/DeleteIteration.json" + } + } + }, + "patch": { + "tags": [ + "ProjectApi" + ], + "summary": "Update a specific iteration", + "operationId": "UpdateIteration", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Iteration" + } + } + }, + "x-ms-examples": { + "Successful UpdateIteration request": { + "$ref": "./examples/UpdateIteration.json" + } + } + } + }, + "/projects/{projectId}/iterations/{iterationId}/performance": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get detailed performance information about an iteration", + "operationId": "GetIterationPerformance", + "consumes": [], + "produces": [ + "application/json", + "text/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" + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IterationPerformance" + } + } + }, + "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", + "text/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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "orderBy", + "in": "query", + "description": "The ordering. Defaults to newest", + "required": false, + "type": "string", + "enum": [ + "Newest", + "Oldest" + ], + "x-nullable": false + }, + { + "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 + }, + { + "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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ImagePerformance" + }, + "x-nullable": true + } + } + }, + "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", + "text/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", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "format": "int32", + "type": "integer", + "x-nullable": false + } + } + }, + "x-ms-examples": { + "Successful GetImagePerformanceCount request": { + "$ref": "./examples/GetImagePerformanceCount.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", + "text/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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Export" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetExports request": { + "$ref": "./examples/GetExports.json" + } + } + }, + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Export a trained iteration", + "operationId": "ExportIteration", + "consumes": [], + "produces": [ + "application/json", + "text/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 (coreml or tensorflow)", + "required": true, + "type": "string", + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX" + ], + "x-nullable": true + }, + { + "name": "flavor", + "in": "query", + "description": "The flavor of the target platform (Windows, Linux, ARM, or GPU)", + "required": false, + "type": "string", + "enum": [ + "Linux", + "Windows" + ], + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Export" + } + } + }, + "x-ms-examples": { + "Successful ExportIteration request": { + "$ref": "./examples/ExportIteration.json" + } + } + } + }, + "/projects/{projectId}/tags/{tagId}": { + "get": { + "tags": [ + "TagsApi" + ], + "summary": "Get information about a specific tag", + "operationId": "GetTag", + "consumes": [], + "produces": [ + "application/json", + "text/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", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Tag" + } + } + }, + "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 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteTag request": { + "$ref": "./examples/DeleteTag.json" + } + } + }, + "patch": { + "tags": [ + "TagsApi" + ], + "summary": "Update a tag", + "operationId": "UpdateTag", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/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" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Tag" + } + } + }, + "x-ms-examples": { + "Successful UpdateTag request": { + "$ref": "./examples/UpdateTag.json" + } + } + } + }, + "/projects/{projectId}/tags": { + "get": { + "tags": [ + "TagsApi" + ], + "summary": "Get the tags for a given project and iteration", + "operationId": "GetTags", + "consumes": [], + "produces": [ + "application/json", + "text/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", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-nullable": true + } + } + }, + "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", + "text/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", + "x-nullable": true + }, + { + "name": "description", + "in": "query", + "description": "Optional description for the tag", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Tag" + } + } + }, + "x-ms-examples": { + "Successful CreateTag request": { + "$ref": "./examples/CreateTag.json" + } + } + } + } + }, + "definitions": { + "Domain": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "name": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "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 + } + }, + "x-nullable": true + }, + "Image": { + "description": "Image model to be sent as JSON", + "type": "object", + "properties": { + "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, + "x-nullable": true + }, + "thumbnailUri": { + "type": "string", + "readOnly": true, + "x-nullable": 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 + } + }, + "x-nullable": true + }, + "ImageTag": { + "type": "object", + "properties": { + "tagId": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagName": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + } + }, + "x-nullable": true + }, + "ImageRegion": { + "type": "object", + "properties": { + "regionId": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagName": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "left": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "top": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "width": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "height": { + "format": "float", + "type": "number", + "x-nullable": false + } + }, + "x-nullable": true + }, + "ImageCreateSummary": { + "type": "object", + "properties": { + "isBatchSuccessful": { + "type": "boolean", + "readOnly": true, + "x-nullable": false + }, + "images": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageCreateResult" + }, + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageCreateResult": { + "type": "object", + "properties": { + "sourceUrl": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "status": { + "enum": [ + "OK", + "OKDuplicate", + "ErrorSource", + "ErrorImageFormat", + "ErrorImageSize", + "ErrorStorage", + "ErrorLimitExceed", + "ErrorTagLimitExceed", + "ErrorRegionLimitExceed", + "ErrorUnknown" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ImageUploadStatus", + "modelAsString": true + } + }, + "image": { + "$ref": "#/definitions/Image", + "readOnly": true + } + }, + "x-nullable": true + }, + "ImageFileCreateBatch": { + "type": "object", + "properties": { + "images": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageFileCreateEntry" + }, + "x-nullable": true + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageFileCreateEntry": { + "type": "object", + "properties": { + "name": { + "type": "string", + "x-nullable": true + }, + "contents": { + "format": "byte", + "type": "string", + "x-nullable": true + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "x-nullable": true + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/Region" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "Region": { + "type": "object", + "properties": { + "tagId": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "left": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "top": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "width": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "height": { + "format": "float", + "type": "number", + "x-nullable": false + } + }, + "x-nullable": true + }, + "ImageUrlCreateBatch": { + "type": "object", + "properties": { + "images": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageUrlCreateEntry" + }, + "x-nullable": true + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageUrlCreateEntry": { + "type": "object", + "properties": { + "url": { + "type": "string", + "x-nullable": true + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "x-nullable": true + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/Region" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageIdCreateBatch": { + "type": "object", + "properties": { + "images": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageIdCreateEntry" + }, + "x-nullable": true + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageIdCreateEntry": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "x-nullable": true + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/Region" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageTagCreateBatch": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTagCreateEntry" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageTagCreateEntry": { + "type": "object", + "properties": { + "imageId": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "type": "string", + "x-nullable": false + } + }, + "x-nullable": true + }, + "ImageTagCreateSummary": { + "type": "object", + "properties": { + "created": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTagCreateEntry" + }, + "x-nullable": true + }, + "duplicated": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTagCreateEntry" + }, + "x-nullable": true + }, + "exceeded": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTagCreateEntry" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageRegionCreateBatch": { + "description": "Batch of image region information to create.", + "type": "object", + "properties": { + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageRegionCreateEntry" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageRegionCreateEntry": { + "type": "object", + "properties": { + "imageId": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "left": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "top": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "width": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "height": { + "format": "float", + "type": "number", + "x-nullable": false + } + }, + "x-nullable": true + }, + "ImageRegionCreateSummary": { + "type": "object", + "properties": { + "created": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageRegionCreateResult" + }, + "x-nullable": true + }, + "duplicated": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageRegionCreateEntry" + }, + "x-nullable": true + }, + "exceeded": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageRegionCreateEntry" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageRegionCreateResult": { + "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": true + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "left": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "top": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "width": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "height": { + "format": "float", + "type": "number", + "x-nullable": 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" + }, + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "RegionProposal": { + "type": "object", + "properties": { + "confidence": { + "format": "float", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "boundingBox": { + "$ref": "#/definitions/BoundingBox", + "readOnly": true + } + }, + "x-nullable": true + }, + "BoundingBox": { + "type": "object", + "properties": { + "left": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "top": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "width": { + "format": "float", + "type": "number", + "x-nullable": false + }, + "height": { + "format": "float", + "type": "number", + "x-nullable": false + } + }, + "x-nullable": true + }, + "PredictionQueryToken": { + "type": "object", + "properties": { + "session": { + "type": "string", + "x-nullable": true + }, + "continuation": { + "type": "string", + "x-nullable": true + }, + "maxCount": { + "format": "int32", + "type": "integer", + "x-nullable": false + }, + "orderBy": { + "enum": [ + "Newest", + "Oldest", + "Suggested" + ], + "type": "string", + "x-nullable": false, + "x-ms-enum": { + "name": "OrderBy", + "modelAsString": true + } + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/PredictionQueryTag" + }, + "x-nullable": true + }, + "iterationId": { + "format": "uuid", + "type": "string", + "x-nullable": true + }, + "startTime": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "endTime": { + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "application": { + "type": "string", + "x-nullable": true + } + }, + "x-nullable": true + }, + "PredictionQueryTag": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "minThreshold": { + "format": "float", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "maxThreshold": { + "format": "float", + "type": "number", + "readOnly": true, + "x-nullable": false + } + }, + "x-nullable": true + }, + "PredictionQueryResult": { + "type": "object", + "properties": { + "token": { + "$ref": "#/definitions/PredictionQueryToken", + "readOnly": true + }, + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/StoredImagePrediction" + }, + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "StoredImagePrediction": { + "description": "result of an image classification request", + "type": "object", + "properties": { + "imageUri": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "thumbnailUri": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "domain": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "id": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "project": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "iteration": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "predictions": { + "type": "array", + "items": { + "$ref": "#/definitions/Prediction" + }, + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "Prediction": { + "type": "object", + "properties": { + "probability": { + "format": "float", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagName": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "boundingBox": { + "$ref": "#/definitions/BoundingBox", + "readOnly": true + } + }, + "x-nullable": true + }, + "ImageUrl": { + "type": "object", + "properties": { + "url": { + "type": "string", + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImagePrediction": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "project": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "iteration": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "predictions": { + "type": "array", + "items": { + "$ref": "#/definitions/Prediction" + }, + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "Iteration": { + "description": "Iteration model to be sent over JSON", + "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", + "x-nullable": true + }, + "isDefault": { + "description": "Gets or sets a value indicating whether the iteration is the default iteration for the project", + "type": "boolean", + "x-nullable": false + }, + "status": { + "description": "Gets the current iteration status", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "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 + }, + "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 + } + } + }, + "x-nullable": true + }, + "Project": { + "description": "Represents a project", + "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", + "x-nullable": true + }, + "description": { + "description": "Gets or sets the description of the project", + "type": "string", + "x-nullable": true + }, + "settings": { + "$ref": "#/definitions/ProjectSettings", + "description": "Gets or sets the project settings" + }, + "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 modifed", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "thumbnailUri": { + "description": "Gets the thumbnail url representing the project", + "type": "string", + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "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", + "x-nullable": false + }, + "classificationType": { + "description": "Gets or sets the classification type of the project", + "enum": [ + "Multiclass", + "Multilabel" + ], + "type": "string", + "x-nullable": true, + "x-ms-enum": { + "name": "Classifier", + "modelAsString": true + } + } + }, + "x-nullable": true + }, + "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" + }, + "readOnly": true, + "x-nullable": 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 + } + }, + "x-nullable": true + }, + "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": 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 + } + }, + "x-nullable": 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, + "x-nullable": true + }, + "thumbnailUri": { + "type": "string", + "readOnly": true, + "x-nullable": 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 + } + }, + "x-nullable": true + }, + "Export": { + "type": "object", + "properties": { + "platform": { + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ExportPlatform", + "modelAsString": true + } + }, + "status": { + "enum": [ + "Exporting", + "Failed", + "Done" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ExportStatusModel", + "modelAsString": true + } + }, + "downloadUri": { + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "flavor": { + "enum": [ + "Linux", + "Windows" + ], + "type": "string", + "readOnly": true, + "x-nullable": true, + "x-ms-enum": { + "name": "ExportFlavor", + "modelAsString": true + } + }, + "newerVersionAvailable": { + "type": "boolean", + "readOnly": true, + "x-nullable": false + } + }, + "x-nullable": true + }, + "Tag": { + "description": "Represents a Tag", + "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", + "x-nullable": true + }, + "description": { + "description": "Gets or sets the description of the tag", + "type": "string", + "x-nullable": true + }, + "imageCount": { + "format": "int32", + "description": "Gets the number of images with this tag", + "type": "integer", + "readOnly": true, + "x-nullable": false + } + }, + "x-nullable": true + } + }, + "parameters": { + "ApiKey": { + "name": "Training-Key", + "in": "header", + "required": true, + "type": "string", + "x-ms-client-name": "ApiKey", + "x-ms-parameter-location": "client" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImageRegions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImageRegions.json new file mode 100644 index 000000000000..850cb26abd78 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImageRegions.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "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 + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "created": [ ], + "duplicated": [], + "exceeded": [] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImageTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImageTags.json new file mode 100644 index 000000000000..a665e7f9dce2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImageTags.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "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 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImagesFromData.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImagesFromData.json new file mode 100644 index 000000000000..75509c5cb6ac --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImagesFromData.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "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:10.65Z", + "width": 1095, + "height": 900, + "imageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.6105895Z" + } + ] + } + }, + { + "sourceUrl": "\"hemlock_6.jpg\"", + "status": "OK", + "image": { + "id": "f1855a92-b873-47e7-b513-f07a667ceda1", + "created": "2017-12-19T15:56:10.57Z", + "width": 900, + "height": 1531, + "imageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.5168568Z" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImagesFromFiles.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImagesFromFiles.json new file mode 100644 index 000000000000..da978c0a0170 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImagesFromFiles.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "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:10.65Z", + "width": 1095, + "height": 900, + "imageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.6105895Z" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImagesFromPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImagesFromPredictions.json new file mode 100644 index 000000000000..58564980619d --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImagesFromPredictions.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "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:10.65Z", + "width": 1095, + "height": 900, + "imageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.6105895Z" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImagesFromUrls.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImagesFromUrls.json new file mode 100644 index 000000000000..b654934ccf85 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateImagesFromUrls.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "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:10.65Z", + "width": 1095, + "height": 900, + "imageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.6105895Z" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateProject.json new file mode 100644 index 000000000000..7cd7ddc0da8d --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateProject.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "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:18.08Z", + "lastModified": "2017-12-18T05:43:18.0962423Z", + "thumbnailUri": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateTag.json new file mode 100644 index 000000000000..ed2bdd0a3ed1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/CreateTag.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "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", + "imageCount": 0 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteImageRegions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteImageRegions.json new file mode 100644 index 000000000000..8f6df982b3f1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteImageRegions.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "regionIds": [ "" ] + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteImageTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteImageTags.json new file mode 100644 index 000000000000..518da817475e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteImageTags.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "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": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteImages.json new file mode 100644 index 000000000000..145476cdc56d --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteImages.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "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": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteIteration.json new file mode 100644 index 000000000000..e8485f9861ca --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteIteration.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758" + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeletePrediction.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeletePrediction.json new file mode 100644 index 000000000000..4d32761fe2ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeletePrediction.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "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": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteProject.json new file mode 100644 index 000000000000..df01ee93a164 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteProject.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e" + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteTag.json new file mode 100644 index 000000000000..a0ec1fcd1899 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/DeleteTag.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "tagId": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01" + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/ExportIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/ExportIteration.json new file mode 100644 index 000000000000..56492e41b46e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/ExportIteration.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "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": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetDomain.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetDomain.json new file mode 100644 index 000000000000..d48adae04acd --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetDomain.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "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", + "exportable": false + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetDomains.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetDomains.json new file mode 100644 index 000000000000..1ddf4a5f2290 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetDomains.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "name": "General", + "exportable": false + }, + { + "id": "c151d5b5-dd07-472a-acc8-15d29dea8518", + "name": "Food", + "exportable": false + }, + { + "id": "ca455789-012d-4b50-9fec-5bb63841c793", + "name": "Landmarks", + "exportable": false + }, + { + "id": "b30a91ae-e3c1-4f73-a81e-c270bff27c39", + "name": "Retail", + "exportable": false + }, + { + "id": "45badf75-3591-4f26-a705-45678d3e9f5f", + "name": "Adult", + "exportable": false + }, + { + "id": "0732100f-1a38-4e49-a514-c9b44c697ab5", + "name": "General (compact)", + "exportable": true + }, + { + "id": "b5cfd229-2ac7-4b2b-8d0a-2b0661344894", + "name": "Landmarks (compact)", + "exportable": true + }, + { + "id": "6b4faeda-8396-481b-9f8b-177b9fa3097f", + "name": "Retail (compact)", + "exportable": true + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetExports.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetExports.json new file mode 100644 index 000000000000..3f1b714ce6c3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetExports.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "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", + "downloadUri": "{Download URI" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetImagePerformanceCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetImagePerformanceCount.json new file mode 100644 index 000000000000..aa56993d9e22 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetImagePerformanceCount.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "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" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetImagePerformances.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetImagePerformances.json new file mode 100644 index 000000000000..53d22d37a5bd --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetImagePerformances.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "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:26.5806336Z", + "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": [ ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetImageRegionProposals.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetImageRegionProposals.json new file mode 100644 index 000000000000..02aeecf2c97e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetImageRegionProposals.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "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 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetImagesByIds.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetImagesByIds.json new file mode 100644 index 000000000000..b4074dc03914 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetImagesByIds.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": [] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetIteration.json new file mode 100644 index 000000000000..73d869176e5e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetIteration.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "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", + "isDefault": false, + "status": "Completed", + "created": "2017-12-18T22:40:36.9066667Z", + "lastModified": "2017-12-19T15:47:02.9511889Z", + "trainedAt": "2017-12-19T15:47:02.9511889Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetIterationPerformance.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetIterationPerformance.json new file mode 100644 index 000000000000..7439d312e675 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetIterationPerformance.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "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 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetIterations.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetIterations.json new file mode 100644 index 000000000000..65076112db77 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetIterations.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "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", + "isDefault": true, + "status": "Completed", + "created": "2017-12-18T22:40:29.7304213Z", + "lastModified": "2017-12-18T22:40:41.3173903Z", + "trainedAt": "2017-12-18T22:40:41.0058589Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + { + "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "name": "Iteration 2", + "isDefault": false, + "status": "Completed", + "created": "2017-12-18T22:40:36.9066667Z", + "lastModified": "2017-12-19T15:47:02.9511889Z", + "trainedAt": "2017-12-19T15:47:02.9511889Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + { + "id": "3adaf7b2-18fc-4376-9da4-b5ea160a7cf5", + "name": "Iteration 3", + "isDefault": false, + "status": "New", + "created": "2017-12-19T15:46:59.2533333Z", + "lastModified": "2017-12-19T15:46:59.2699369Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": null + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetProject.json new file mode 100644 index 000000000000..1aa6738e11f5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetProject.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "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:18.08Z", + "lastModified": "2017-12-18T05:43:18.0962423Z", + "thumbnailUri": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetProjects.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetProjects.json new file mode 100644 index 000000000000..267009f6e8b9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetProjects.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "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:18.08Z", + "lastModified": "2017-12-18T05:43:18.0962423Z", + "thumbnailUri": null + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetTag.json new file mode 100644 index 000000000000..bf11b89c5a4c --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetTag.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "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", + "imageCount": 0 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetTaggedImageCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetTaggedImageCount.json new file mode 100644 index 000000000000..ad6351b8c0f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetTaggedImageCount.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "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" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetTaggedImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetTaggedImages.json new file mode 100644 index 000000000000..b4074dc03914 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetTaggedImages.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": [] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetTags.json new file mode 100644 index 000000000000..f424d85ce713 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetTags.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "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", + "imageCount": 0 + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetUntaggedImageCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetUntaggedImageCount.json new file mode 100644 index 000000000000..ad6351b8c0f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetUntaggedImageCount.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "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" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetUntaggedImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetUntaggedImages.json new file mode 100644 index 000000000000..b4074dc03914 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/GetUntaggedImages.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": [] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/QueryPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/QueryPredictions.json new file mode 100644 index 000000000000..bf1cf24fbc77 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/QueryPredictions.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "query": { + "orderBy": "Newest", + "tags": [ + { + "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "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:26.5806336Z", + "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 + } + ], + "imageUri": "", + "thumbnailUri": "" + } + ], + "token": { + "session": "1:286613", + "continuation": null, + "maxCount": 0, + "orderBy": "Newest", + "tags": [ + { + "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "minThreshold": 0.9, + "maxThreshold": 1.0 + } + ], + "iterationId": null, + "startTime": null, + "endTime": null, + "application": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/QuickTestImage.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/QuickTestImage.json new file mode 100644 index 000000000000..69ce03eeb6b1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/QuickTestImage.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "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:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.00 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/QuickTestImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/QuickTestImageUrl.json new file mode 100644 index 000000000000..99363212a175 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/QuickTestImageUrl.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "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:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.00 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/TrainProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/TrainProject.json new file mode 100644 index 000000000000..b12850dc8165 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/TrainProject.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "name": "Iteration 2", + "isDefault": false, + "status": "Training", + "created": "2017-12-18T22:40:36.9066667Z", + "lastModified": "2017-12-19T15:46:58.197323Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/UpdateIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/UpdateIteration.json new file mode 100644 index 000000000000..3c7cfc7ae1a4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/UpdateIteration.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "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", + "isDefault": false, + "status": "Completed", + "created": "2017-12-18T22:40:36.9066667Z", + "lastModified": "2017-12-19T15:53:07.8782881Z", + "trainedAt": "2017-12-19T15:47:02.9511889Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/UpdateProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/UpdateProject.json new file mode 100644 index 000000000000..7c287615090c --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/UpdateProject.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "updatedProject": { + "name": "New Project Name", + "description": "A new Description" + } + }, + "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:18.08Z", + "lastModified": "2017-12-18T05:43:18.0962423Z", + "thumbnailUri": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/UpdateTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/UpdateTag.json new file mode 100644 index 000000000000..49157fcd803b --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/examples/UpdateTag.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "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", + "description": "Better description" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", + "name": "Better Tag Name", + "description": "Better description", + "imageCount": 0 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomWebSearch/readme.md b/specification/cognitiveservices/data-plane/CustomWebSearch/readme.md new file mode 100644 index 000000000000..4de3f40edad3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomWebSearch/readme.md @@ -0,0 +1,129 @@ +# Cognitive Services Custom Search SDK + +> see https://aka.ms/autorest + +Configuration for generating Custom Search SDK. + +The current release is `release_1_0`. + +``` yaml + +tag: release_1_0 +add-credentials: true +openapi-type: data-plane +``` +# Releases + +### Release 1.0 +These settings apply only when `--tag=release_1_0` is specified on the command line. + +``` yaml $(tag) == 'release_1_0' +input-file: stable/v1.0/CustomSearch.json +``` + + +## 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-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_customsearch'] +``` + + +## CSharp Settings +These settings apply only when `--csharp` is specified on the command line. +``` yaml $(csharp) +csharp: + namespace: Microsoft.Azure.CognitiveServices.Search.CustomSearch + output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Search/BingCustomSearch/BingCustomSearch/Generated/CustomSearch + sync-methods: none +``` + +## 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 + add-credentials: true + payload-flattening-threshold: 2 + namespace: azure.cognitiveservices.search.customsearch + package-name: azure-cognitiveservices-search-customsearch + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-customsearch/azure/cognitiveservices/search/customsearch +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-customsearch +``` + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: customsearch + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: release_1_0 +``` + +### Tag: release_1_0 and go + +These settings apply only when `--tag=release_1_0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v1.0/customsearch +``` + +## Suppressions +Suppressing errors due to API design: +``` yaml +directive: + - suppress: R3016 + reason: _type is a polymorphic discriminator that can't be changed. +``` + + +## 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.search.customsearch + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/search/bingcustomsearch + with-optional-parameters: true + prefix-model-type: Bing + with-single-async-method: true +``` diff --git a/specification/cognitiveservices/data-plane/CustomSearch/readme.nodejs.md b/specification/cognitiveservices/data-plane/CustomWebSearch/readme.nodejs.md similarity index 100% rename from specification/cognitiveservices/data-plane/CustomSearch/readme.nodejs.md rename to specification/cognitiveservices/data-plane/CustomWebSearch/readme.nodejs.md diff --git a/specification/cognitiveservices/data-plane/CustomWebSearch/readme.ruby.md b/specification/cognitiveservices/data-plane/CustomWebSearch/readme.ruby.md new file mode 100644 index 000000000000..48f381688ca0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomWebSearch/readme.ruby.md @@ -0,0 +1,27 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_cognitiveservices_customsearch +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: release_1_0 +``` + +### Tag: release_1_0 and ruby + +These settings apply only when `--tag=release_1_0 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::CustomSearch::V1_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customsearch/lib +title: "CustomSearchClient" +``` diff --git a/specification/cognitiveservices/data-plane/CustomSearch/stable/v1.0/CustomSearch.json b/specification/cognitiveservices/data-plane/CustomWebSearch/stable/v1.0/CustomSearch.json similarity index 100% rename from specification/cognitiveservices/data-plane/CustomSearch/stable/v1.0/CustomSearch.json rename to specification/cognitiveservices/data-plane/CustomWebSearch/stable/v1.0/CustomSearch.json diff --git a/specification/cognitiveservices/data-plane/CustomSearch/stable/v1.0/examples/SuccessfulQueryRequest.json b/specification/cognitiveservices/data-plane/CustomWebSearch/stable/v1.0/examples/SuccessfulQueryRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/CustomSearch/stable/v1.0/examples/SuccessfulQueryRequest.json rename to specification/cognitiveservices/data-plane/CustomWebSearch/stable/v1.0/examples/SuccessfulQueryRequest.json diff --git a/specification/cognitiveservices/data-plane/EntitySearch/readme.md b/specification/cognitiveservices/data-plane/EntitySearch/readme.md index a00c2c2177d3..f55dc630ea08 100644 --- a/specification/cognitiveservices/data-plane/EntitySearch/readme.md +++ b/specification/cognitiveservices/data-plane/EntitySearch/readme.md @@ -29,9 +29,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_entitysearch'] ``` @@ -106,9 +109,11 @@ Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::EntitySearch::V1_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_entitysearch/lib +title: "EntitySearchClient" +``` diff --git a/specification/cognitiveservices/data-plane/Face/readme.md b/specification/cognitiveservices/data-plane/Face/readme.md index 341dfd6f22a2..5c8ccf20dc8a 100644 --- a/specification/cognitiveservices/data-plane/Face/readme.md +++ b/specification/cognitiveservices/data-plane/Face/readme.md @@ -29,9 +29,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_face'] ``` @@ -110,9 +113,10 @@ Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::Face::V1_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_face/lib +title: "FaceClient" +``` 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 5f5171cb1d02..037d7cf848ae 100644 --- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "version": "1.0", - "title": "Face API", + "title": "Face Client", "description": "An API for face detection, verification, and identification." }, "securityDefinitions": { @@ -17,14 +17,7 @@ "apim_key": [] } ], - "x-ms-parameterized-host": { - "hostTemplate": "{AzureRegion}.api.cognitive.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/ExtendedRegions.json#/parameters/AzureRegion" - } - ] - }, + "host": "api.cognitive.microsoft.com", "basePath": "/face/v1.0", "schemes": [ "https" diff --git a/specification/cognitiveservices/data-plane/ImageSearch/readme.md b/specification/cognitiveservices/data-plane/ImageSearch/readme.md index f6291f5950f3..9bb44157ef38 100644 --- a/specification/cognitiveservices/data-plane/ImageSearch/readme.md +++ b/specification/cognitiveservices/data-plane/ImageSearch/readme.md @@ -29,9 +29,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_imagesearch'] ``` @@ -115,9 +118,11 @@ Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::ImageSearch::V1_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_imagesearch/lib +title: "ImageSearchClient" +``` diff --git a/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json b/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json index 88c3a2377e50..2a6773c47853 100644 --- a/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json +++ b/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json @@ -23,10 +23,10 @@ } }, "host": "api.cognitive.microsoft.com", + "basePath": "/bing/v7.0", "schemes": [ "https" ], - "basePath": "/bing/v7.0", "produces": [ "application/json" ], diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md new file mode 100644 index 000000000000..ce0e2b543774 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md @@ -0,0 +1,120 @@ +# Cognitive Services LUIS SDKs + +> see https://aka.ms/autorest + +Configuration for generating LUIS Authoring SDK. + +``` yaml +tag: authoring_2_0 +add-credentials: true +openapi-type: data-plane +``` + +The current release for the Authoring Endpoint is `authoring_2_0`. + +# Releases + +## Authoring 2.0 +These settings apply only when `--tag=authoring_2_0` is specified on the command line. + +``` yaml $(tag) == 'authoring_2_0' +input-file: stable/v2.0/LUIS-Authoring.json +``` + +Deprecated Pattern's Operations + +``` yaml $(tag) == 'authoring_2_0' +directive: + - reason: Deprecated + remove-operation: Features_GetApplicationVersionPatternFeatures + - reason: Deprecated + remove-operation: Features_CreatePatternFeature + - reason: Deprecated + remove-operation: Features_GetPatternFeatureInfo + - reason: Deprecated + remove-operation: Features_UpdatePatternFeature + - reason: Deprecated + remove-operation: Features_DeletePatternFeature +``` + +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolve without updates to the API implementation +directive: + - suppress: DeleteMustNotHaveRequestBody + reason: Body is used to specify entity to delete + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Changing casing will break existing clients/consumers +``` + +--- +# 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-go + - repo: azure-sdk-for-python +``` + +### Authoring 2.0 - 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.Language.LUIS.Authoring + output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Language/LUIS/Authoring/Generated + clear-output-folder: true +``` + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: authoring + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: authoring_2_0 +``` + +### Tag: authoring_2_0 and go + +These settings apply only when `--tag=authoring_2_0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'authoring_2_0' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v2.0/luis/$(namespace) +``` + + +## 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.language.luis.authoring + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/language/luis/authoring + with-optional-parameters: true + with-single-async-method: true +``` diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.python.md b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.python.md new file mode 100644 index 000000000000..75d8aa53e6bd --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/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.language.luis.authoring + package-name: azure-cognitiveservices-language-luis + clear-output-folder: true + +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-language-luis/azure/cognitiveservices/language/luis/authoring +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-language-luis +``` diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json new file mode 100644 index 000000000000..11b1a1b4cccc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json @@ -0,0 +1,9789 @@ +{ + "swagger": "2.0", + "info": { + "title": "LUIS Authoring Client", + "version": "2.0" + }, + "host": "api.cognitive.microsoft.com", + "basePath": "/luis/api/v2.0", + "schemes": [ + "https" + ], + "securityDefinitions": { + "apiKeyHeader": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apiKeyHeader": [] + } + ], + "paths": { + "/apps/{appId}/versions/{versionId}/patterns": { + "post": { + "description": "[DEPRECATED NOTICE: This operation will soon be removed] Creates a new pattern feature.", + "operationId": "Features_CreatePatternFeature", + "deprecated": true, + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patternCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatternCreateObject" + }, + "description": "The Name and Pattern of the feature." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created feature.", + "schema": { + "$ref": "#/definitions/FeatureIDResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Pattern Feature request": { + "$ref": "./examples/features/SuccessfulCreatePatternFeatureRequest.json" + } + } + }, + "get": { + "description": "[DEPRECATED NOTICE: This operation will soon be removed] Gets all the pattern features.", + "operationId": "Features_GetApplicationVersionPatternFeatures", + "deprecated": true, + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of pattern features.", + "schema": { + "$ref": "#/definitions/PatternFeatureInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Pattern Features request": { + "$ref": "./examples/features/SuccessfulGetApplicationVersionPatternFeaturesRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/phraselists": { + "post": { + "description": "Creates a new phraselist feature.", + "operationId": "Features_AddPhraseList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "phraselistCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PhraselistCreateObject" + }, + "description": "A Phraselist object containing Name, comma-separated Phrases and the isExchangeable boolean. Default value for isExchangeable is true." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created feature.", + "schema": { + "$ref": "#/definitions/FeatureIDResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Phraselist Feature request": { + "$ref": "./examples/features/SuccessfulCreatePhraselistFeatureRequest.json" + } + } + }, + "get": { + "description": "Gets all the phraselist features.", + "operationId": "Features_ListPhraseLists", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of all phraselist features.", + "schema": { + "$ref": "#/definitions/PhraseListFeatureInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Phraselist Features request": { + "$ref": "./examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/features": { + "get": { + "description": "Gets all the extraction features for the specified application version.", + "operationId": "Features_List", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of all phraselist features and a list of all pattern features.", + "schema": { + "$ref": "#/definitions/FeaturesResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Features request": { + "$ref": "./examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patterns/{patternId}": { + "get": { + "description": "[DEPRECATED NOTICE: This operation will soon be removed] Gets the specified pattern feature's info.", + "operationId": "Features_GetPatternFeatureInfo", + "deprecated": true, + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patternId", + "in": "path", + "description": "The pattern feature ID.", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "The pattern feature info.", + "schema": { + "$ref": "#/definitions/PatternFeatureInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Pattern Feature Info request": { + "$ref": "./examples/features/SuccessfulGetPatternFeatureInfoRequest.json" + } + } + }, + "put": { + "description": "[DEPRECATED NOTICE: This operation will soon be removed] Updates the pattern, the name and the state of the pattern feature.", + "operationId": "Features_UpdatePatternFeature", + "deprecated": true, + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patternId", + "in": "path", + "description": "The pattern feature ID.", + "required": true, + "type": "integer" + }, + { + "name": "patternUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatternUpdateObject" + }, + "description": "The new values for: - Just a boolean called IsActive, in which case the status of the feature will be changed. - Name, Pattern and a boolean called IsActive to update the feature." + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Pattern Feature Info request": { + "$ref": "./examples/features/SuccessfulUpdatePatternFeatureInfoRequest.json" + } + } + }, + "delete": { + "description": "[DEPRECATED NOTICE: This operation will soon be removed] Deletes a pattern feature.", + "operationId": "Features_DeletePatternFeature", + "deprecated": true, + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patternId", + "in": "path", + "description": "The pattern feature ID.", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Pattern Feature Info request": { + "$ref": "./examples/features/SuccessfulDeletePatternFeatureInfoRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/phraselists/{phraselistId}": { + "get": { + "description": "Gets phraselist feature info.", + "operationId": "Features_GetPhraseList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "phraselistId", + "in": "path", + "description": "The ID of the feature to be retrieved.", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "A phraselist feature info.", + "schema": { + "$ref": "#/definitions/PhraseListFeatureInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Phraselist Feature Info request": { + "$ref": "./examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the phrases, the state and the name of the phraselist feature.", + "operationId": "Features_UpdatePhraseList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "phraselistId", + "in": "path", + "description": "The ID of the feature to be updated.", + "required": true, + "type": "integer" + }, + { + "name": "phraselistUpdateObject", + "in": "body", + "schema": { + "$ref": "#/definitions/PhraselistUpdateObject" + }, + "description": "The new values for: - Just a boolean called IsActive, in which case the status of the feature will be changed. - Name, Pattern, Mode, and a boolean called IsActive to update the feature." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated phraselist.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Phraselist Feature Info request": { + "$ref": "./examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json" + } + } + }, + "delete": { + "description": "Deletes a phraselist feature.", + "operationId": "Features_DeletePhraseList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "phraselistId", + "in": "path", + "description": "The ID of the feature to be deleted.", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Successfully deleted phraselist.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Phraselist Feature Info request": { + "$ref": "./examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/example": { + "post": { + "description": "Adds a labeled example to the application.", + "operationId": "Examples_Add", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "exampleLabelObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExampleLabelObject" + }, + "description": "An example label with the expected intent and entities." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created example.", + "schema": { + "$ref": "#/definitions/LabelExampleResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Label request": { + "$ref": "./examples/examples/SuccessfulAddLabelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/examples": { + "post": { + "description": "Adds a batch of labeled examples to the application.", + "operationId": "Examples_Batch", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "exampleLabelObjectArray", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExampleLabelObjectArray" + }, + "description": "Array of examples." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "A string array determining which labels were added successfully.", + "schema": { + "$ref": "#/definitions/BatchLabelExampleResponse" + } + }, + "207": { + "description": "Indicates that the request was partially successful. The response contains a string array indicating the status of each of the added labels.", + "schema": { + "$ref": "#/definitions/BatchLabelExampleResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Batch Add Labels request": { + "$ref": "./examples/examples/SuccessfulBatchAddLabelsRequest.json" + } + } + }, + "get": { + "description": "Returns examples to be reviewed.", + "operationId": "Examples_List", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of predictions and label pairs for every example in the application.", + "schema": { + "$ref": "#/definitions/LabeledUtterances" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Review Labeled Examples request": { + "$ref": "./examples/examples/SuccessfulReviewLabeledExamplesRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/examples/{exampleId}": { + "delete": { + "description": "Deletes the labeled example with the specified ID.", + "operationId": "Examples_Delete", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "exampleId", + "in": "path", + "description": "The example ID.", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Successfully deleted example label.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Example Label request": { + "$ref": "./examples/examples/SuccessfulDeleteExampleLabelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/intents": { + "post": { + "description": "Adds an intent classifier to the application.", + "operationId": "Model_AddIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "intentCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelCreateObject" + }, + "description": "A model object containing the name of the new intent classifier." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Intent Classifier request": { + "$ref": "./examples/model/SuccessfulCreateIntentClassifierRequest.json" + } + } + }, + "get": { + "description": "Gets information about the intent models.", + "operationId": "Model_ListIntents", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of intent model infos.", + "schema": { + "$ref": "#/definitions/IntentClassifiersList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Intent Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities": { + "post": { + "description": "Adds an entity extractor to the application.", + "operationId": "Model_AddEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "modelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelCreateObject" + }, + "description": "A model object containing the name for the new entity extractor." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Entity Extractor request": { + "$ref": "./examples/model/SuccessfulCreateEntityExtractorRequest.json" + } + } + }, + "get": { + "description": "Gets information about the entity models.", + "operationId": "Model_ListEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of entity model infos.", + "schema": { + "$ref": "#/definitions/EntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Entity Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities": { + "post": { + "description": "Adds a hierarchical entity extractor to the application version.", + "operationId": "Model_AddHierarchicalEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "hierarchicalModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HierarchicalEntityModel" + }, + "description": "A model containing the name and children of the new entity extractor." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Hierarchical Entity Extractor request": { + "$ref": "./examples/model/SuccessfulCreateHierarchicalEntityExtractorRequest.json" + } + } + }, + "get": { + "description": "Gets information about the hierarchical entity models.", + "operationId": "Model_ListHierarchicalEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of hierarchical entity model infos.", + "schema": { + "$ref": "#/definitions/HierarchicalEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Hierarchical Entity Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities": { + "post": { + "description": "Adds a composite entity extractor to the application.", + "operationId": "Model_AddCompositeEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "compositeModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CompositeEntityModel" + }, + "description": "A model containing the name and children of the new entity extractor." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created Model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Composite Entity Extractor": { + "$ref": "./examples/model/SuccessfulCreateCompositeEntityExtractorRequest.json" + } + } + }, + "get": { + "description": "Gets information about the composite entity models.", + "operationId": "Model_ListCompositeEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of composite entity model infos.", + "schema": { + "$ref": "#/definitions/CompositeEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Composite Entity Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists": { + "get": { + "description": "Gets information about the closedlist models.", + "operationId": "Model_ListClosedLists", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of closedlist entity model infos.", + "schema": { + "$ref": "#/definitions/ClosedListEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Closed List Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json" + } + } + }, + "post": { + "description": "Adds a closed list model to the application.", + "operationId": "Model_AddClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "closedListModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClosedListModelCreateObject" + }, + "description": "A model containing the name and words for the new closed list entity extractor." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Closed List Entity Model request": { + "$ref": "./examples/model/SuccessfulCreateClosedListEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/prebuilts": { + "post": { + "description": "Adds a list of prebuilt entity extractors to the application.", + "operationId": "Model_AddPrebuilt", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltExtractorNames", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrebuiltExtractorNames" + }, + "description": "An array of prebuilt entity extractor names." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "An array of the created prebuilt extractor infos.", + "schema": { + "$ref": "#/definitions/PrebuiltEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Application Version Prebuilt Infos request": { + "$ref": "./examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json" + } + } + }, + "get": { + "description": "Gets information about the prebuilt entity models.", + "operationId": "Model_ListPrebuilts", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of prebuilt entity models infos.", + "schema": { + "$ref": "#/definitions/PrebuiltEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Prebuilt Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/listprebuilts": { + "get": { + "description": "Gets all the available prebuilt entity extractors for the application.", + "operationId": "Model_ListPrebuiltEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of the possible prebuilt entity extractors.", + "schema": { + "$ref": "#/definitions/AvailablePrebuiltEntityModels" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Available Prebuilt Entity Extractors request": { + "$ref": "./examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/models": { + "get": { + "description": "Gets information about the application version models.", + "operationId": "Model_ListModels", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of application model infos.", + "schema": { + "$ref": "#/definitions/ModelsInfoResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Model Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/models/{modelId}/examples": { + "get": { + "description": "Gets the utterances for the given model in the given app version.", + "operationId": "Model_Examples", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "modelId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID (GUID) of the model.", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of examples for the model.", + "schema": { + "$ref": "#/definitions/ExamplesPerModelResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Examples Per Model Request": { + "$ref": "./examples/model/SuccessfulGetExamplesPerModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/intents/{intentId}": { + "get": { + "description": "Gets information about the intent model.", + "operationId": "Model_GetIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + } + ], + "responses": { + "200": { + "description": "An intent model info.", + "schema": { + "$ref": "#/definitions/IntentClassifier" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Intent Info request": { + "$ref": "./examples/model/SuccessfulGetIntentInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the name of an intent classifier.", + "operationId": "Model_UpdateIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "name": "modelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelUpdateObject" + }, + "description": "A model object containing the new intent classifier name." + } + ], + "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 Rename Intent Model request": { + "$ref": "./examples/model/SuccessfulRenameIntentModelRequest.json" + } + } + }, + "delete": { + "description": "Deletes an intent classifier from the application.", + "operationId": "Model_DeleteIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "name": "deleteUtterances", + "in": "query", + "type": "boolean", + "description": "Also delete the intent's utterances (true). Or move the utterances to the None intent (false - the default value).", + "default": false + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Intent Model request": { + "$ref": "./examples/model/SuccessfulDeleteIntentModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}": { + "get": { + "description": "Gets information about the entity model.", + "operationId": "Model_GetEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity model info.", + "schema": { + "$ref": "#/definitions/EntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Entity Info request": { + "$ref": "./examples/model/SuccessfulGetEntityInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the name of an entity extractor.", + "operationId": "Model_UpdateEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "modelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelUpdateObject" + }, + "description": "A model object containing the new entity extractor name." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated entity extractor name.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Rename Entity Info request": { + "$ref": "./examples/model/SuccessfulRenameEntityExtractorRequest.json" + } + } + }, + "delete": { + "description": "Deletes an entity extractor from the application.", + "operationId": "Model_DeleteEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully deleted entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Entity Info request": { + "$ref": "./examples/model/SuccessfulDeleteEntityExtractorRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}": { + "get": { + "description": "Gets information about the hierarchical entity model.", + "operationId": "Model_GetHierarchicalEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "A hierarchical entity model info.", + "schema": { + "$ref": "#/definitions/HierarchicalEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Hierarchical Entity Info request": { + "$ref": "./examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the name and children of a hierarchical entity model.", + "operationId": "Model_UpdateHierarchicalEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "hierarchicalModelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HierarchicalEntityModel" + }, + "description": "Model containing names of the children of the hierarchical entity." + } + ], + "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 Get Hierarchical Entity Info request": { + "$ref": "./examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json" + } + } + }, + "delete": { + "description": "Deletes a hierarchical entity extractor from the application version.", + "operationId": "Model_DeleteHierarchicalEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "Successfully deleted entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Hierarchical Entity Model request": { + "$ref": "./examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}": { + "get": { + "description": "Gets information about the composite entity model.", + "operationId": "Model_GetCompositeEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "The composite entity model info.", + "schema": { + "$ref": "#/definitions/CompositeEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Composite Entity Info request": { + "$ref": "./examples/model/SuccessfulGetCompositeEntityInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the composite entity extractor.", + "operationId": "Model_UpdateCompositeEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "compositeModelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CompositeEntityModel" + }, + "description": "A model object containing the new entity extractor name and children." + } + ], + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Composite Entity Extractor request": { + "$ref": "./examples/model/SuccessfulUpdateCompositeEntityModelRequest.json" + } + }, + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated composite entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "description": "Deletes a composite entity extractor from the application.", + "operationId": "Model_DeleteCompositeEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "Successfully deleted composite entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Entity Info request": { + "$ref": "./examples/model/SuccessfulDeleteCompositeEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}": { + "get": { + "description": "Gets information of a closed list model.", + "operationId": "Model_GetClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The closed list model ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The closed list model info.", + "schema": { + "$ref": "#/definitions/ClosedListEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Closed List Entity Info request": { + "$ref": "./examples/model/SuccessfulGetClosedListEntityInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the closed list model.", + "operationId": "Model_UpdateClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The closed list model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "closedListModelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClosedListModelUpdateObject" + }, + "description": "The new entity name and words list." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated Closed List name and words list.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Closed List Entity Info request": { + "$ref": "./examples/model/SuccessfulUpdateClosedListEntityModelRequest.json" + } + } + }, + "patch": { + "description": "Adds a batch of sublists to an existing closedlist.", + "operationId": "Model_PatchClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The closed list model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "closedListModelPatchObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClosedListModelPatchObject" + }, + "description": "A words list batch." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully added sublists to Closed List.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add SubLists to Closed List Entity request": { + "$ref": "./examples/model/SuccessfulPatchClosedListEntityModelRequest.json" + } + } + }, + "delete": { + "description": "Deletes a closed list model from the application.", + "operationId": "Model_DeleteClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The closed list model ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully delete Closed List from application.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Closed List Entity Info request": { + "$ref": "./examples/model/SuccessfulDeleteClosedListEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/prebuilts/{prebuiltId}": { + "get": { + "description": "Gets information about the prebuilt entity model.", + "operationId": "Model_GetPrebuilt", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltId", + "in": "path", + "description": "The prebuilt entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A prebuilt entity models info.", + "schema": { + "$ref": "#/definitions/PrebuiltEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Prebuilt Info request": { + "$ref": "./examples/model/SuccessfulGetPrebuiltInfoRequest.json" + } + } + }, + "delete": { + "description": "Deletes a prebuilt entity extractor from the application.", + "operationId": "Model_DeletePrebuilt", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltId", + "in": "path", + "description": "The prebuilt entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Prebuilt Info request": { + "$ref": "./examples/model/SuccessfulDeletePrebuiltEntityRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists/{subListId}": { + "delete": { + "description": "Deletes a sublist of a specific closed list model.", + "operationId": "Model_DeleteSubList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The closed list entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "subListId", + "in": "path", + "description": "The sublist ID.", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Successfully deleted sublist.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Sublist request": { + "$ref": "./examples/model/SuccessfulDeleteSublistRequest.json" + } + } + }, + "put": { + "description": "Updates one of the closed list's sublists.", + "operationId": "Model_UpdateSubList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The closed list entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "subListId", + "in": "path", + "description": "The sublist ID.", + "required": true, + "type": "integer" + }, + { + "name": "wordListBaseUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WordListBaseUpdateObject" + }, + "description": "A sublist update object containing the new canonical form and the list of words." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated sublist.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Sublist request": { + "$ref": "./examples/model/SuccessfulUpdateSublistRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/intents/{intentId}/suggest": { + "get": { + "description": "Suggests examples that would improve the accuracy of the intent model.", + "operationId": "Model_GetIntentSuggestions", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "If there's no trained model, nothing is returned in the response. If there's a trained model and the active learning algorithm finds any relevant queries, they are returned with the model predictions. If there's a trained model but the active learning algorithm didn't find any relevant queries, an empty list is returned in the response.", + "schema": { + "$ref": "#/definitions/IntentsSuggestionExamples" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Intents Suggestion Examples": { + "$ref": "./examples/model/SuccessfulGetIntentsSuggestionExamples.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}/suggest": { + "get": { + "description": "Get suggestion examples that would improve the accuracy of the entity model.", + "operationId": "Model_GetEntitySuggestions", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The target entity extractor model to enhance.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "If there's no trained model, nothing is returned in the response. If there's a trained model and the active learning algorithm finds any relevant queries, they are returned with the model predictions. If there's a trained model but the active learning algorithm didn't find any relevant queries, an empty list is returned in the response.", + "schema": { + "$ref": "#/definitions/EntitiesSuggestionExamples" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Entity Suggestion Examples": { + "$ref": "./examples/model/SuccessfulGetEntitySuggestionExamples.json" + } + } + } + }, + "/apps/": { + "post": { + "description": "Creates a new LUIS app.", + "operationId": "Apps_Add", + "parameters": [ + { + "name": "applicationCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationCreateObject" + }, + "description": "A model containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is 0.1. Note: the culture cannot be changed after the app is created." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created application.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Application Creation": { + "$ref": "./examples/apps/SuccessfulAddApplicationRequest.json" + } + } + }, + "get": { + "description": "Lists all of the user applications.", + "operationId": "Apps_List", + "parameters": [ + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of the user applications.", + "schema": { + "$ref": "#/definitions/ApplicationsInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Applications List request": { + "$ref": "./examples/apps/SuccessfulGetApplicationsListRequest.json" + } + } + } + }, + "/apps/import": { + "post": { + "description": "Imports an application to LUIS, the application's structure should be included in in the request body.", + "operationId": "Apps_Import", + "parameters": [ + { + "name": "appName", + "in": "query", + "description": "The application name to create. If not specified, the application name will be read from the imported object.", + "type": "string" + }, + { + "name": "luisApp", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LuisApp" + }, + "description": "A LUIS application structure." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the imported application.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Import Application": { + "$ref": "./examples/apps/SuccessfulImportApplicationRequest.json" + } + } + } + }, + "/apps/assistants": { + "get": { + "description": "Gets the endpoint URLs for the prebuilt Cortana applications.", + "operationId": "Apps_ListCortanaEndpoints", + "responses": { + "200": { + "description": "A personal assistant apps JSON object containing the endpoint URLs for Cortana applications and the user's endpoint keys.", + "schema": { + "$ref": "#/definitions/PersonalAssistantsResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Personal Assistant Applications": { + "$ref": "./examples/apps/SuccessfulGetPersonalAssistantApplications.json" + } + } + } + }, + "/apps/domains": { + "get": { + "description": "Gets the available application domains.", + "operationId": "Apps_ListDomains", + "responses": { + "200": { + "description": "A list object containing the available application domains.", + "schema": { + "$ref": "#/definitions/AvailableDomains" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Domains request": { + "$ref": "./examples/apps/SuccessfulGetApplicationDomainsRequest.json" + } + } + } + }, + "/apps/usagescenarios": { + "get": { + "description": "Gets the application available usage scenarios.", + "operationId": "Apps_ListUsageScenarios", + "responses": { + "200": { + "description": "A list object containing the available application usage scenarios.", + "schema": { + "$ref": "#/definitions/ApplicationUsageScenarios" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Usage Scenarios request": { + "$ref": "./examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json" + } + } + } + }, + "/apps/cultures": { + "get": { + "description": "Gets the supported application cultures.", + "operationId": "Apps_ListSupportedCultures", + "responses": { + "200": { + "description": "A list object containing the supported application cultures.", + "schema": { + "$ref": "#/definitions/AvailableCultures" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Cultures request": { + "$ref": "./examples/apps/SuccessfulGetApplicationCulturesRequest.json" + } + } + } + }, + "/apps/{appId}/querylogs": { + "get": { + "description": "Gets the query logs of the past month for the application.", + "operationId": "Apps_DownloadQueryLogs", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "A CSV file containing the query logs for the past month.", + "schema": { + "type": "object", + "format": "file", + "description": "The query logs of an application for the past month in CSV format." + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/octet-stream" + ], + "x-ms-examples": { + "Successful Download Application Query logs request": { + "$ref": "./examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json" + } + } + } + }, + "/apps/{appId}": { + "get": { + "description": "Gets the application info.", + "operationId": "Apps_Get", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "The application info.", + "schema": { + "$ref": "#/definitions/ApplicationInfoResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Info request": { + "$ref": "./examples/apps/SuccessfulGetApplicationInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the name or description of the application.", + "operationId": "Apps_Update", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "applicationUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationUpdateObject" + }, + "description": "A model containing Name and Description of the application." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated application name and description.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Rename Application request": { + "$ref": "./examples/apps/SuccessfulRenameApplicationRequest.json" + } + } + }, + "delete": { + "description": "Deletes an application.", + "operationId": "Apps_Delete", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "Successfully deleted application.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Rename Application request": { + "$ref": "./examples/apps/SuccessfulDeleteApplicationRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/clone": { + "post": { + "description": "Creates a new version using the current snapshot of the selected application version.", + "operationId": "Versions_Clone", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "versionCloneObject", + "in": "body", + "schema": { + "$ref": "#/definitions/TaskUpdateObject" + }, + "description": "A model containing the new version ID." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The version ID of the created task.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Clone Application Version request": { + "$ref": "./examples/versions/SuccessfulCloneApplicatioVersionRequest.json" + } + } + } + }, + "/apps/{appId}/publish": { + "post": { + "description": "Publishes a specific version of the application.", + "operationId": "Apps_Publish", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "applicationPublishObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationPublishObject" + }, + "description": "The application publish object. The region is the target region that the application is published to." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "An object containing the application endpoint URL and its assigned endpoint key.", + "schema": { + "$ref": "#/definitions/ProductionOrStagingEndpointInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Publish Application request": { + "$ref": "./examples/apps/SuccessfulPublishApplicationRequest.json" + } + } + } + }, + "/apps/{appId}/versions": { + "get": { + "description": "Gets the application versions info.", + "operationId": "Versions_List", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of all versions of the application.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VersionInfo" + } + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Versions info request": { + "$ref": "./examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/": { + "get": { + "description": "Gets the version info.", + "operationId": "Versions_Get", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "A model containing the version info.", + "schema": { + "$ref": "#/definitions/VersionInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version info request": { + "$ref": "./examples/versions/SuccessfulGetApplicationVersionInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the name or description of the application version.", + "operationId": "Versions_Update", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "versionUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TaskUpdateObject" + }, + "description": "A model containing Name and Description of the application." + } + ], + "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 Rename Application Version request": { + "$ref": "./examples/versions/SuccessfulRenameApplicationVersionRequest.json" + } + } + }, + "delete": { + "description": "Deletes an application version.", + "operationId": "Versions_Delete", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Application Version request": { + "$ref": "./examples/versions/SuccessfulDeleteApplicationVersionRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/export": { + "get": { + "description": "Exports a LUIS application to JSON format.", + "operationId": "Versions_Export", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/LuisApp" + }, + "description": "The LUIS application structure in JSON format." + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Export Application Version": { + "$ref": "./examples/versions/SuccessfulExportApplicationVersionRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/train": { + "post": { + "description": "Sends a training request for a version of a specified LUIS app. This POST request initiates a request asynchronously. To determine whether the training request is successful, submit a GET request to get training status. Note: The application version is not fully trained unless all the models (intents and entities) are trained successfully or are up to date. To verify training success, get the training status at least once after training is complete.", + "operationId": "Train_TrainVersion", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "202": { + "description": "This response indicates the initial training status.", + "schema": { + "$ref": "#/definitions/EnqueueTrainingResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Train Application Version request": { + "$ref": "./examples/train/SuccessfulTrainApplicationVersionRequest.json" + } + } + }, + "get": { + "description": "Gets the training status of all models (intents and entities) for the specified LUIS app. You must call the train API to train the LUIS app before you call this API to get training status. \"appID\" specifies the LUIS app ID. \"versionId\" specifies the version number of the LUIS app. For example, \"0.1\".", + "operationId": "Train_GetStatus", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "A successful response provides an array of training status details for a LUIS app that you submitted for training. Each element in the response array provides training status for a model (intent or entity) in the LUIS app. Note: Training status is not provided for prebuilt entities because they are pretrained. The \"modelId\" property identifies which intent or entity the training status corresponds to. To get the name and type of each model, use the models API which has a request URL in this format: https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/{appId}/versions/{versionId}/models The details property for each model can contain the following fields: \"statusId\": An integer from 0 to 3 that corresponds to the value of the status field. \"status\": A string with one of the following values: \"Success\", \"UpToDate\", \"InProgress\", \"Fail\". If the status is \"Fail\", the \"failureReason\" property provides the reason for failure. \"exampleCount\": The number of examples used for training. In the case of the None intent or prebuilt domain intents and entities, this number includes example provided internally by the system as well as examples you added to your LUIS app. \"failureReason\": A string that indicates the reason training failed. The value \"FewLabels\" means that no labeled examples were provided for training. \"trainingDateTime\": A string indicating the time the model was last trained. The value uses the ISO 8601 format for representing times in UTC (Coordinated Universal Time) with a UTC designator (\"Z\"), for example: \"2017-08-10T01:08:34Z\".", + "schema": { + "$ref": "#/definitions/ModelTrainingInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json", + "JSON" + ], + "x-ms-examples": { + "Successful Get Application Version Training Status request": { + "$ref": "./examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json" + } + } + } + }, + "/apps/{appId}/versions/import": { + "post": { + "description": "Imports a new version into a LUIS application.", + "operationId": "Versions_Import", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "versionId", + "in": "query", + "description": "The new versionId to import. If not specified, the versionId will be read from the imported object.", + "type": "string" + }, + { + "name": "luisApp", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LuisApp" + }, + "description": "A LUIS application structure." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The created application version.", + "schema": { + "$ref": "#/definitions/VersionResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Import Application": { + "$ref": "./examples/versions/SuccessfulImportApplicationVersionRequest.json" + } + } + } + }, + "/apps/{appId}/settings": { + "get": { + "description": "Get the application settings.", + "operationId": "Apps_GetSettings", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "The application settings.", + "schema": { + "$ref": "#/definitions/ApplicationSettings" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Settings request": { + "$ref": "./examples/apps/SuccessfulGetApplicationSettingsRequest.json" + } + } + }, + "put": { + "description": "Updates the application settings.", + "operationId": "Apps_UpdateSettings", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "applicationSettingUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationSettingUpdateObject" + }, + "description": "An object containing the new application settings." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated application settings.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Application Settings request": { + "$ref": "./examples/apps/SuccessfulUpdateApplicationSettingsRequest.json" + } + } + } + }, + "/apps/{appId}/publishsettings": { + "get": { + "description": "Get the application publish settings.", + "operationId": "Apps_GetPublishSettings", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "The application publish settings.", + "schema": { + "$ref": "#/definitions/PublishSettings" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Publish Settings request": { + "$ref": "./examples/apps/SuccessfulGetPublishSettingsRequest.json" + } + } + }, + "put": { + "description": "Updates the application publish settings.", + "operationId": "Apps_UpdatePublishSettings", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "publishSettingUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PublishSettingUpdateObject" + }, + "description": "An object containing the new publish application settings." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated application settings.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Publish Settings request": { + "$ref": "./examples/apps/SuccessfulUpdatePublishSettingsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/suggest": { + "delete": { + "description": "Deleted an unlabelled utterance.", + "operationId": "Versions_DeleteUnlabelledUtterance", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "utterance", + "in": "body", + "required": true, + "schema": { + "type": "string" + }, + "description": "The utterance text to delete." + } + ], + "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 Delete Unlabelled Utterance": { + "$ref": "./examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json" + } + } + } + }, + "/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 users access list with the one 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's 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.", + "operationId": "Apps_ListEndpoints", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "Returns a list of endpoints regions and their corresponding endpoint URL.", + "schema": { + "$ref": "#/definitions/AvailableEndpoints" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Endpoints request": { + "$ref": "./examples/apps/SuccessfulGetEndpointsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists": { + "post": { + "description": "Adds a list to an existing closed list.", + "operationId": "Model_AddSubList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The closed list entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "wordListCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WordListObject" + }, + "description": "Words list." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the newly created list.", + "schema": { + "type": "integer" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Sublist request": { + "$ref": "./examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltdomains": { + "post": { + "description": "Adds a customizable prebuilt domain along with all of its models to this application.", + "operationId": "Model_AddCustomPrebuiltDomain", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltDomainObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrebuiltDomainCreateBaseObject" + }, + "description": "A prebuilt domain create object containing the name of the domain." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "An array of the created custom prebuilt domain model Ids.", + "schema": { + "$ref": "#/definitions/GuidList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Custom Prebuilt Domain to Application request": { + "$ref": "./examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltintents": { + "post": { + "description": "Adds a custom prebuilt intent model to the application.", + "operationId": "Model_AddCustomPrebuiltIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltDomainModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrebuiltDomainModelCreateObject" + }, + "description": "A model object containing the name of the custom prebuilt intent and the name of the domain to which this model belongs." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Custom Prebuilt Intent request": { + "$ref": "./examples/model/SuccessfulAddCustomPrebuildIntentRequest.json" + } + } + }, + "get": { + "description": "Gets custom prebuilt intents information of this application.", + "operationId": "Model_ListCustomPrebuiltIntents", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "Returns a list of all custom prebuilt intents and their representations.", + "schema": { + "$ref": "#/definitions/IntentClassifiersList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Custom Prebuilt Intent request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuildIntentRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltentities": { + "post": { + "description": "Adds a custom prebuilt entity model to the application.", + "operationId": "Model_AddCustomPrebuiltEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltDomainModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrebuiltDomainModelCreateObject" + }, + "description": "A model object containing the name of the custom prebuilt entity and the name of the domain to which this model belongs." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Custom Prebuilt Entity request": { + "$ref": "./examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json" + } + } + }, + "get": { + "description": "Gets all custom prebuilt entities information of this application.", + "operationId": "Model_ListCustomPrebuiltEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "Returns a list of all custom prebuilt entities and their representations.", + "schema": { + "$ref": "#/definitions/EntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Custom Prebuilt Domain Entities request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltmodels": { + "get": { + "description": "Gets all custom prebuilt models information of this application.", + "operationId": "Model_ListCustomPrebuiltModels", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "Returns a list of all custom prebuilt models and their representations.", + "schema": { + "$ref": "#/definitions/CustomPrebuiltModelList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Custom Prebuilt Domain Models request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltdomains/{domainName}": { + "delete": { + "description": "Deletes a prebuilt domain's models from the application.", + "operationId": "Model_DeleteCustomPrebuiltDomain", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "domainName", + "in": "path", + "description": "Domain name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Prebuilt Domain from Application request": { + "$ref": "./examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json" + } + } + } + }, + "/apps/customprebuiltdomains": { + "get": { + "description": "Gets all the available custom prebuilt domains for all cultures.", + "operationId": "Apps_ListAvailableCustomPrebuiltDomains", + "responses": { + "200": { + "description": "Returns a list of all custom prebuilt domains and their intents/entities representation.", + "schema": { + "$ref": "#/definitions/PrebuiltDomainsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Available Custom Prebuilt Domains request": { + "$ref": "./examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json" + } + } + }, + "post": { + "description": "Adds a prebuilt domain along with its models as a new application.", + "operationId": "Apps_AddCustomPrebuiltDomain", + "parameters": [ + { + "name": "prebuiltDomainCreateObject", + "in": "body", + "required": true, + "description": "A prebuilt domain create object containing the name and culture of the domain.", + "schema": { + "$ref": "#/definitions/PrebuiltDomainCreateObject" + } + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created application.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Custom Prebuilt Application request": { + "$ref": "./examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json" + } + } + } + }, + "/apps/customprebuiltdomains/{culture}": { + "get": { + "description": "Gets all the available custom prebuilt domains for a specific culture.", + "operationId": "Apps_ListAvailableCustomPrebuiltDomainsForCulture", + "parameters": [ + { + "name": "culture", + "in": "path", + "description": "Culture.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns a list of all domains and their intents/entities representation for a specific culture.", + "schema": { + "$ref": "#/definitions/PrebuiltDomainsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get AvailableCustomPrebuiltDomainsForCulture request": { + "$ref": "./examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children/{hChildId}": { + "get": { + "description": "Gets information about the hierarchical entity child model.", + "operationId": "Model_GetHierarchicalEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "hChildId", + "in": "path", + "description": "The hierarchical entity extractor child ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The hierarchical entity child model info.", + "schema": { + "$ref": "#/definitions/HierarchicalChildEntity" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Hierarchical Entity Child Info request": { + "$ref": "./examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json" + } + } + }, + "put": { + "description": "Renames a single child in an existing hierarchical entity model.", + "operationId": "Model_UpdateHierarchicalEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "hChildId", + "in": "path", + "required": true, + "description": "The hierarchical entity extractor child ID.", + "type": "string", + "format": "uuid" + }, + { + "name": "hierarchicalChildModelUpdateObject", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "description": "Model object containing new name of the hierarchical entity child." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated entity child.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Hierarchical Entity Child Model request": { + "$ref": "./examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json" + } + } + }, + "delete": { + "description": "Deletes a hierarchical entity extractor child from the application.", + "operationId": "Model_DeleteHierarchicalEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "hChildId", + "in": "path", + "description": "The hierarchical entity extractor child ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully deleted entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Hierarchical Entity Child Model request": { + "$ref": "./examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children": { + "post": { + "description": "Creates a single child in an existing hierarchical entity model.", + "operationId": "Model_AddHierarchicalEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "hierarchicalChildModelCreateObject", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "description": "A model object containing the name of the new hierarchical child model." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Hierarchical Entity Child Model request": { + "$ref": "./examples/model/SuccessfulCreateHierarchicalChildModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children": { + "post": { + "description": "Creates a single child in an existing composite entity model.", + "operationId": "Model_AddCompositeEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "compositeChildModelCreateObject", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "description": "A model object containing the name of the new composite child model." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Composite Entity Child Model request": { + "$ref": "./examples/model/SuccessfulCreateCompositeChildModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children/{cChildId}": { + "delete": { + "description": "Deletes a composite entity extractor child from the application.", + "operationId": "Model_DeleteCompositeEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "cChildId", + "in": "path", + "description": "The hierarchical entity extractor child ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully deleted entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Composite Entity Child Model request": { + "$ref": "./examples/model/SuccessfulDeleteCompositeChildModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/regexentities": { + "get": { + "summary": "Gets information about the regex entity models.", + "operationId": "Model_GetRegexEntityInfos", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of regex entity model infos.", + "schema": { + "$ref": "#/definitions/RegexEntityExtractorList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Regex Entity Models request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionRegexEntityInfosRequest.json" + } + } + }, + "post": { + "summary": "Adds a regex entity model to the application version.", + "operationId": "Model_CreateRegexEntityModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "regexEntityExtractorCreateObj", + "in": "body", + "description": "A model object containing the name and regex pattern for the new regex entity extractor.", + "required": true, + "schema": { + "$ref": "#/definitions/RegexModelCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Regex Entity Model request": { + "$ref": "./examples/model/SuccessfulCreateRegexEntityExtractorRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities": { + "get": { + "summary": "Get information about the Pattern.Any entity models.", + "operationId": "Model_GetPatternAnyEntityInfos", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of Pattern.Any entity model infos.", + "schema": { + "$ref": "#/definitions/PatternAnyEntityExtractorList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Regex Entity Model request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionPatternAnyEntityInfosRequest.json" + } + } + }, + "post": { + "summary": "Adds a pattern.any entity extractor to the application.", + "operationId": "Model_CreatePatternAnyEntityModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "extractorCreateObject", + "in": "body", + "description": "A model object containing the name and explicit list for the new Pattern.Any entity extractor.", + "required": true, + "schema": { + "$ref": "#/definitions/PatternAnyModelCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created Pattern.Any entity model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Regex Entity Model request": { + "$ref": "./examples/model/SuccessfulCreatePatternAnyEntityExtractorRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}/roles": { + "get": { + "summary": "Get All Entity Roles for a given entity", + "operationId": "Model_GetEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create an entity role for an entity in the application.", + "operationId": "Model_CreateEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/prebuilts/{entityId}/roles": { + "get": { + "summary": "Get All Entity Roles for a given entity", + "operationId": "Model_GetPrebuiltEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Prebuilt Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetPrebuiltEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create an entity role for an entity in the application.", + "operationId": "Model_CreatePrebuiltEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulCreatePrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{entityId}/roles": { + "get": { + "summary": "Get All Entity Roles for a given entity", + "operationId": "Model_GetClosedListEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Closed List Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetClosedListEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create an entity role for an entity in the application.", + "operationId": "Model_CreateClosedListEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Closed List Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateClosedListEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/regexentities/{entityId}/roles": { + "get": { + "summary": "Get All Entity Roles for a given entity", + "operationId": "Model_GetRegexEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Regex Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetRegexEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create an entity role for an entity in the application.", + "operationId": "Model_CreateRegexEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Regex Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateRegexEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/roles": { + "get": { + "summary": "Get All Entity Roles for a given entity", + "operationId": "Model_GetCompositeEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Composite Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetCompositeEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create an entity role for an entity in the application.", + "operationId": "Model_CreateCompositeEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Composite Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateCompositeEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/roles": { + "get": { + "summary": "Get All Entity Roles for a given entity", + "operationId": "Model_GetPatternAnyEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Pattern.Any Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create an entity role for an entity in the application.", + "operationId": "Model_CreatePatternAnyEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Pattern.Any Entity Role request": { + "$ref": "./examples/model/SuccessfulCreatePatternAnyEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/roles": { + "get": { + "summary": "Get All Entity Roles for a given entity", + "operationId": "Model_GetHierarchicalEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Hierarchical Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetHierarchicalEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create an entity role for an entity in the application.", + "operationId": "Model_CreateHierarchicalEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Hierarchical Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateHierarchicalEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltentities/{entityId}/roles": { + "get": { + "summary": "Get All Entity Roles for a given entity", + "operationId": "Model_GetCustomPrebuiltEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Custom Prebuilt Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuiltEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create an entity role for an entity in the application.", + "operationId": "Model_CreateCustomPrebuiltEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Custom Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateCustomPrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/explicitlist": { + "get": { + "summary": "Get the explicit list of the pattern.any entity.", + "operationId": "Model_GetExplicitList", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the explict list items", + "schema": { + "$ref": "#/definitions/ExplicitListItemList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Explicit List request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyExplicitListRequest.json" + } + } + }, + "post": { + "summary": "Add a new item to the explicit list for the Pattern.Any entity.", + "operationId": "Model_AddExplicitListItem", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "item", + "in": "body", + "description": "The new explicit list item.", + "required": true, + "schema": { + "$ref": "#/definitions/ExplicitListItemCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created explicit list item.", + "schema": { + "$ref": "#/definitions/ExplicitListItemIDResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Custom Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulCreatePatternAnyExplicitListRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/regexentities/{regexEntityId}": { + "get": { + "summary": "Gets information of a regex entity model.", + "operationId": "Model_GetRegexEntityEntityInfo", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "regexEntityId", + "in": "path", + "description": "The regex entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A regex entity model info.", + "schema": { + "$ref": "#/definitions/RegexEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Regex Entity request": { + "$ref": "./examples/model/SuccessfulGetRegexEntityInfoRequest.json" + } + } + }, + "put": { + "summary": "Updates the regex entity model .", + "operationId": "Model_UpdateRegexEntityModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "regexEntityId", + "in": "path", + "description": "The regex entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "regexEntityUpdateObject", + "in": "body", + "description": "An object containing the new entity name and regex pattern.", + "required": true, + "schema": { + "$ref": "#/definitions/RegexModelUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the regex entity extractor.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Regex Entity request": { + "$ref": "./examples/model/SuccessfulUpdateRegexEntityModelRequest.json" + } + } + }, + "delete": { + "summary": "Deletes a regex entity model from the application.", + "operationId": "Model_DeleteRegexEntityModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "regexEntityId", + "in": "path", + "description": "The regex entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Regex Entity request": { + "$ref": "./examples/model/SuccessfulDeleteRegexEntityRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}": { + "get": { + "summary": "Gets information about the application version's Pattern.Any model.", + "operationId": "Model_GetPatternAnyEntityInfo", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A regex entity model info.", + "schema": { + "$ref": "#/definitions/PatternAnyEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Pattern.Any Entity request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyEntityInfoRequest.json" + } + } + }, + "put": { + "summary": "Updates the name and explicit list of a Pattern.Any entity model.", + "operationId": "Model_UpdatePatternAnyEntityModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "patternAnyUpdateObject", + "in": "body", + "description": "An object containing the explicit list of the Pattern.Any entity.", + "required": true, + "schema": { + "$ref": "#/definitions/PatternAnyModelUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the Pattern.Any entity extractor.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Pattern.Any Entity request": { + "$ref": "./examples/model/SuccessfulUpdatePatternAnyEntityRequest.json" + } + } + }, + "delete": { + "summary": "Deletes a Pattern.Any entity extractor from the application.", + "operationId": "Model_DeletePatternAnyEntityModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Pattern.Any Entity request": { + "$ref": "./examples/model/SuccessfulDeletePatternAnyEntityRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one entity role for a given entity", + "operationId": "Model_GetEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulGetEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update an entity role for a given entity", + "operationId": "Model_UpdateEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete an entity role.", + "operationId": "Model_DeleteEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulDeleteEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/prebuilts/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one entity role for a given entity", + "operationId": "Model_GetPrebuiltEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulGetPrebuiltEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update an entity role for a given entity", + "operationId": "Model_UpdatePrebuiltEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Prebuilt Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdatePrebuiltEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete an entity role.", + "operationId": "Model_DeletePrebuiltEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one entity role for a given entity", + "operationId": "Model_GetClosedListEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Closed List Entity Role request": { + "$ref": "./examples/model/SuccessfulGetClosedListEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update an entity role for a given entity", + "operationId": "Model_UpdateClosedListEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Closed List Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateClosedListEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete an entity role.", + "operationId": "Model_DeleteClosedListEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/regexentities/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one entity role for a given entity", + "operationId": "Model_GetRegexEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Regex Entity Role request": { + "$ref": "./examples/model/SuccessfulGetRegexEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update an entity role for a given entity", + "operationId": "Model_UpdateRegexEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Regex Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateRegexEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete an entity role.", + "operationId": "Model_DeleteRegexEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Regex Entity Role request": { + "$ref": "./examples/model/SuccessfulDeleteRegexEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/roles/{roleId}": { + "get": { + "summary": "Get one entity role for a given entity", + "operationId": "Model_GetCompositeEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Composite Entity Role request": { + "$ref": "./examples/model/SuccessfulGetCompositeEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update an entity role for a given entity", + "operationId": "Model_UpdateCompositeEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Composite Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateCompositeEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete an entity role.", + "operationId": "Model_DeleteCompositeEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Composite Entity Role request": { + "$ref": "./examples/model/SuccessfulDeleteCompositeEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one entity role for a given entity", + "operationId": "Model_GetPatternAnyEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Pattern.Any Entity Role request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update an entity role for a given entity", + "operationId": "Model_UpdatePatternAnyEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Pattern.Any Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdatePatternAnyEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete an entity role.", + "operationId": "Model_DeletePatternAnyEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Pattern.Any Entity Role request": { + "$ref": "./examples/model/SuccessfulDeletePatternAnyEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/roles/{roleId}": { + "get": { + "summary": "Get one entity role for a given entity", + "operationId": "Model_GetHierarchicalEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Hierarchical Entity Role request": { + "$ref": "./examples/model/SuccessfulGetHierarchicalEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update an entity role for a given entity", + "operationId": "Model_UpdateHierarchicalEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Hierarchical Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateHierarchicalEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete an entity role.", + "operationId": "Model_DeleteHierarchicalEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Hierarchical Entity Role request": { + "$ref": "./examples/model/SuccessfulDeleteHierarchicalEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltentities/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one entity role for a given entity", + "operationId": "Model_GetCustomEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Custom Prebuilt Domain Entity Role request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuiltEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update an entity role for a given entity", + "operationId": "Model_UpdateCustomPrebuiltEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Custom Prebuilt Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateCustomPrebuiltEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete an entity role.", + "operationId": "Model_DeleteCustomEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Custom Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulDeleteCustomPrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/explicitlist/{itemId}": { + "get": { + "summary": "Get the explicit list of the pattern.any entity.", + "operationId": "Model_GetExplicitListItem", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "itemId", + "in": "path", + "description": "The explicit list item Id.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "An explicit list item info.", + "schema": { + "$ref": "#/definitions/ExplicitListItem" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Pattern.Any Explicit List Item request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyExplicitListItemRequest.json" + } + } + }, + "put": { + "summary": "Updates an explicit list item for a Pattern.Any entity.", + "operationId": "Model_UpdateExplicitListItem", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "itemId", + "in": "path", + "description": "The explicit list item ID.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "item", + "in": "body", + "description": "The new explicit list item.", + "required": true, + "schema": { + "$ref": "#/definitions/ExplicitListItemUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the explicit list item.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Pattern.Any Entity Explicit List Item request": { + "$ref": "./examples/model/SuccessfulUpdatePatternAnyEntityExplicitListItemRequest.json" + } + } + }, + "delete": { + "summary": "Delete the explicit list item from the Pattern.any explicit list.", + "operationId": "Model_DeleteExplicitListItem", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The pattern.any entity id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "itemId", + "in": "path", + "description": "The explicit list item which will be deleted.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Pattern.Any Explicit List Item request": { + "$ref": "./examples/model/SuccessfulDeletePatternAnyExplicitListItemRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternrule": { + "post": { + "summary": "Adds one pattern to the specified application.", + "operationId": "Pattern_AddPattern", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "pattern", + "in": "body", + "description": "The input pattern.", + "required": true, + "schema": { + "$ref": "#/definitions/PatternRuleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The created pattern", + "schema": { + "$ref": "#/definitions/PatternRuleInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Add Pattern request": { + "$ref": "./examples/patterns/SuccessfulAddPatternRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternrules": { + "get": { + "summary": "Returns an application version's patterns.", + "operationId": "Pattern_GetPatterns", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "The retrieved patterns", + "schema": { + "$ref": "#/definitions/PatternRuleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Application Version Patterns request": { + "$ref": "./examples/patterns/SuccessfulGetPatternsRequest.json" + } + } + }, + "put": { + "summary": "Updates patterns", + "operationId": "Pattern_UpdatePatterns", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patterns", + "in": "body", + "description": "An array represents the patterns.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PatternRuleUpdateObject" + } + } + } + ], + "responses": { + "200": { + "description": "The updated patterns", + "schema": { + "$ref": "#/definitions/PatternRuleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Batch Update Patterns request": { + "$ref": "./examples/patterns/SuccessfulUpdatePatternsRequest.json" + } + } + }, + "post": { + "summary": "Adds a batch of patterns to the specified application.", + "operationId": "Pattern_BatchAddPatterns", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patterns", + "in": "body", + "description": "A JSON array containing patterns.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PatternRuleCreateObject" + } + } + } + ], + "responses": { + "201": { + "description": "The created patterns", + "schema": { + "$ref": "#/definitions/PatternRuleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Batch Add Patterns request": { + "$ref": "./examples/patterns/SuccessfulBatchAddLabelsRequest.json" + } + } + }, + "delete": { + "summary": "Deletes the patterns with the specified IDs.", + "operationId": "Pattern_DeletePatterns", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patternIds", + "in": "body", + "description": "The patterns IDs.", + "required": true, + "schema": { + "type": "array", + "items": { + "format": "uuid", + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Batch Delete Patterns request": { + "$ref": "./examples/patterns/SuccessfulDeletePatternsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternrules/{patternId}": { + "put": { + "summary": "Updates a pattern", + "operationId": "Pattern_UpdatePattern", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patternId", + "in": "path", + "description": "The pattern ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "pattern", + "in": "body", + "description": "An object representing a pattern.", + "required": true, + "schema": { + "$ref": "#/definitions/PatternRuleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "The updated pattern", + "schema": { + "$ref": "#/definitions/PatternRuleInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Pattern request": { + "$ref": "./examples/patterns/SuccessfulUpdatePatternRequest.json" + } + } + }, + "delete": { + "summary": "Deletes the pattern with the specified ID.", + "operationId": "Pattern_DeletePattern", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patternId", + "in": "path", + "description": "The pattern ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Pattern request": { + "$ref": "./examples/patterns/SuccessfulDeletePatternRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/intents/{intentId}/patternrules": { + "get": { + "summary": "Returns patterns to be retrieved for the specific intent.", + "operationId": "Pattern_GetIntentPatterns", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "The retrieved patterns", + "schema": { + "$ref": "#/definitions/PatternRuleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Intent Patterns request": { + "$ref": "./examples/patterns/SuccessfulGetIntentPatternsRequest.json" + } + } + } + } + }, + "definitions": { + "EntityLabelObject": { + "description": "Defines the entity type and position of the extracted entity within the example.", + "type": "object", + "required": [ + "entityName", + "startCharIndex", + "endCharIndex" + ], + "properties": { + "entityName": { + "description": "The entity type.", + "type": "string" + }, + "startCharIndex": { + "description": "The index within the utterance where the extracted entity starts.", + "type": "integer" + }, + "endCharIndex": { + "description": "The index within the utterance where the extracted entity ends.", + "type": "integer" + } + } + }, + "ApplicationCreateObject": { + "description": "Properties for creating a new LUIS Application", + "type": "object", + "required": [ + "culture", + "name" + ], + "properties": { + "culture": { + "description": "The culture for the new application. It is the language that your app understands and speaks. E.g.: \"en-us\". Note: the culture cannot be changed after the app is created.", + "type": "string" + }, + "domain": { + "description": "The domain for the new application. Optional. E.g.: Comics.", + "type": "string" + }, + "description": { + "description": "Description of the new application. Optional.", + "type": "string" + }, + "initialVersionId": { + "description": "The initial version ID. Optional. Default value is: \"0.1\"", + "type": "string" + }, + "usageScenario": { + "description": "Defines the scenario for the new application. Optional. E.g.: IoT.", + "type": "string" + }, + "name": { + "description": "The name for the new application.", + "type": "string" + } + } + }, + "PrebuiltDomainCreateBaseObject": { + "description": "A model object containing the name of the custom prebuilt entity and the name of the domain to which this model belongs.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name.", + "type": "string" + } + } + }, + "PrebuiltDomainCreateObject": { + "description": "A prebuilt domain create object containing the name and culture of the domain.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name.", + "type": "string" + }, + "culture": { + "description": "The culture of the new domain.", + "type": "string" + } + } + }, + "PrebuiltDomainModelCreateObject": { + "description": "A model object containing the name of the custom prebuilt intent or entity and the name of the domain to which this model belongs.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name.", + "type": "string" + }, + "modelName": { + "description": "The intent name or entity name.", + "type": "string" + } + } + }, + "HierarchicalEntityModel": { + "description": "A Hierarchical Entity Extractor.", + "type": "object", + "properties": { + "children": { + "description": "Child entities.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Entity name.", + "type": "string" + } + } + }, + "CompositeEntityModel": { + "description": "A composite entity.", + "type": "object", + "properties": { + "children": { + "description": "Child entities.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Entity name.", + "type": "string" + } + } + }, + "JSONEntity": { + "description": "Exported Model - Extracted Entity from utterance.", + "type": "object", + "required": [ + "startPos", + "endPos", + "entity" + ], + "properties": { + "startPos": { + "description": "The index within the utterance where the extracted entity starts.", + "type": "integer" + }, + "endPos": { + "description": "The index within the utterance where the extracted entity ends.", + "type": "integer" + }, + "entity": { + "description": "The entity name.", + "type": "string" + } + } + }, + "ApplicationSettingUpdateObject": { + "description": "Object model for updating an application's settings.", + "type": "object", + "properties": { + "public": { + "description": "Setting your application as public allows other people to use your application's endpoint using their own keys.", + "type": "boolean", + "x-nullable": false + } + } + }, + "PublishSettingUpdateObject": { + "description": "Object model for updating an application's publish settings.", + "type": "object", + "properties": { + "sentimentAnalysis": { + "description": "Setting sentiment analysis as true returns the Sentiment of the input utterance along with the resopnse", + "type": "boolean", + "x-nullable": false + }, + "speech": { + "description": "Setting speech as public enables speech priming in your app", + "type": "boolean", + "x-nullable": false + }, + "spellChecker": { + "description": "Setting spell checker as public enables spell checking the input utterance.", + "type": "boolean", + "x-nullable": false + } + } + }, + "ExampleLabelObject": { + "description": "A labeled example.", + "type": "object", + "properties": { + "text": { + "description": "The sample's utterance.", + "type": "string" + }, + "entityLabels": { + "description": "The idenfied entities within the utterance.", + "items": { + "type": "object", + "$ref": "#/definitions/EntityLabelObject" + }, + "type": "array" + }, + "intentName": { + "description": "The idenfitied intent representing the utterance.", + "type": "string" + } + } + }, + "PhraselistCreateObject": { + "description": "Object model for creating a phraselist model.", + "type": "object", + "properties": { + "phrases": { + "description": "List of comma-separated phrases that represent the Phraselist.", + "type": "string" + }, + "name": { + "description": "The Phraselist name.", + "type": "string" + }, + "isExchangeable": { + "description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.", + "default": true, + "type": "boolean" + } + } + }, + "SubClosedList": { + "description": "Sublist of items for a Closed list.", + "type": "object", + "properties": { + "canonicalForm": { + "description": "The standard form that the list represents.", + "type": "string" + }, + "list": { + "description": "List of synonym words.", + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "SubClosedListResponse": { + "description": "Sublist of items for a Closed list.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubClosedList" + } + ], + "properties": { + "id": { + "description": "The sublist ID", + "type": "integer", + "x-nullable": false + } + } + }, + "ApplicationUpdateObject": { + "description": "Object model for updating the name or description of an application.", + "type": "object", + "properties": { + "name": { + "description": "The application's new name.", + "type": "string" + }, + "description": { + "description": "The application's new description.", + "type": "string" + } + } + }, + "PrebuiltExtractorNames": { + "description": "Objet model for adding a prebuilt entity to the application.", + "type": "array", + "items": { + "type": "string" + } + }, + "JSONRegexFeature": { + "description": "Exported Model - A Pattern feature.", + "type": "object", + "properties": { + "pattern": { + "description": "The Regular Expression to match.", + "type": "string" + }, + "activated": { + "description": "Indicates if the Pattern feature is enabled.", + "type": "boolean" + }, + "name": { + "description": "Name of the feature.", + "type": "string" + } + } + }, + "PatternUpdateObject": { + "description": "Object model for updating an existing Pattern feature.", + "type": "object", + "properties": { + "pattern": { + "description": "The Regular Expression to match.", + "type": "string" + }, + "name": { + "description": "Name of the feature.", + "type": "string" + }, + "isActive": { + "description": "Indicates if the Pattern feature is enabled.", + "default": true, + "type": "boolean" + } + } + }, + "ClosedList": { + "description": "Exported Model - A Closed List.", + "type": "object", + "properties": { + "name": { + "description": "Name of the closed list feature.", + "type": "string" + }, + "subLists": { + "description": "Sublists for the feature.", + "items": { + "type": "object", + "$ref": "#/definitions/SubClosedList" + }, + "type": "array" + }, + "roles": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "ClosedListModelPatchObject": { + "description": "Object model for adding a batch of sublists to an existing closedlist.", + "type": "object", + "properties": { + "subLists": { + "description": "Sublists to add.", + "items": { + "type": "object", + "$ref": "#/definitions/WordListObject" + }, + "type": "array" + } + } + }, + "JSONModelFeature": { + "description": "Exported Model - Phraselist Model Feature.", + "type": "object", + "properties": { + "activated": { + "description": "Indicates if the feature is enabled.", + "type": "boolean" + }, + "name": { + "description": "The Phraselist name.", + "type": "string" + }, + "words": { + "description": "List of comma-separated phrases that represent the Phraselist.", + "type": "string" + }, + "mode": { + "description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.", + "type": "boolean" + } + } + }, + "ModelCreateObject": { + "description": "Object model for creating a new entity extractor.", + "type": "object", + "properties": { + "name": { + "description": "Name of the new entity extractor.", + "type": "string" + } + } + }, + "PatternCreateObject": { + "description": "Object model for creating a Pattern feature.", + "type": "object", + "properties": { + "pattern": { + "description": "The Regular Expression to match.", + "type": "string" + }, + "name": { + "description": "Name of the feature.", + "type": "string" + } + } + }, + "WordListObject": { + "description": "Sublist of items for a Closed list.", + "type": "object", + "properties": { + "canonicalForm": { + "description": "The standard form that the list represents.", + "type": "string" + }, + "list": { + "description": "List of synonym words.", + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "WordListBaseUpdateObject": { + "description": "Object model for updating one of the closed list's sublists.", + "type": "object", + "properties": { + "canonicalForm": { + "description": "The standard form that the list represents.", + "type": "string" + }, + "list": { + "description": "List of synonym words.", + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "JSONUtterance": { + "description": "Exported Model - Utterance that was used to train the model.", + "type": "object", + "properties": { + "text": { + "description": "The utterance.", + "type": "string" + }, + "intent": { + "description": "The matched intent.", + "type": "string" + }, + "entities": { + "description": "The matched entities.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONEntity" + }, + "type": "array" + } + } + }, + "ModelUpdateObject": { + "description": "Object model for updating an intent classifier.", + "type": "object", + "properties": { + "name": { + "description": "The entity's new name.", + "type": "string" + } + } + }, + "ClosedListModelUpdateObject": { + "description": "Object model for updating a closed list.", + "type": "object", + "properties": { + "subLists": { + "description": "The new sublists for the feature.", + "items": { + "type": "object", + "$ref": "#/definitions/WordListObject" + }, + "type": "array" + }, + "name": { + "description": "The new name of the closed list feature.", + "type": "string" + } + } + }, + "ClosedListModelCreateObject": { + "description": "Object model for creating a closed list.", + "type": "object", + "properties": { + "subLists": { + "description": "Sublists for the feature.", + "items": { + "type": "object", + "$ref": "#/definitions/WordListObject" + }, + "type": "array" + }, + "name": { + "description": "Name of the closed list feature.", + "type": "string" + } + } + }, + "ExampleLabelObjectArray": { + "description": "Object model for adding a batch of labeled examples.", + "items": { + "type": "object", + "$ref": "#/definitions/ExampleLabelObject" + }, + "type": "array" + }, + "VersionInfo": { + "description": "Object model of an application version.", + "type": "object", + "required": [ + "version", + "trainingStatus" + ], + "properties": { + "version": { + "description": "The version ID. E.g.: \"0.1\"", + "type": "string" + }, + "createdDateTime": { + "description": "The version's creation timestamp.", + "type": "string", + "format": "date-time" + }, + "lastModifiedDateTime": { + "description": "Timestamp of the last update.", + "type": "string", + "format": "date-time" + }, + "lastTrainedDateTime": { + "description": "Timestamp of the last time the model was trained.", + "type": "string", + "format": "date-time" + }, + "lastPublishedDateTime": { + "description": "Timestamp when was last published.", + "type": "string", + "format": "date-time" + }, + "endpointUrl": { + "description": "The Runtime endpoint URL for this model version.", + "type": "string" + }, + "assignedEndpointKey": { + "description": "The endpoint key.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "externalApiKeys": { + "description": "External keys.", + "type": "object" + }, + "intentsCount": { + "description": "Number of intents in this model.", + "type": "integer" + }, + "entitiesCount": { + "description": "Number of entities in this model.", + "type": "integer" + }, + "endpointHitsCount": { + "description": "Number of calls made to this endpoint.", + "type": "integer" + }, + "trainingStatus": { + "description": "The current training status.", + "type": "string", + "enum": [ + "NeedsTraining", + "InProgress", + "Trained" + ], + "x-ms-enum": { + "name": "TrainingStatus" + } + } + } + }, + "TaskUpdateObject": { + "description": "Object model for cloning an application's version.", + "type": "object", + "properties": { + "version": { + "description": "The new version for the cloned model.", + "type": "string" + } + } + }, + "PhraselistUpdateObject": { + "description": "Object model for updating a Phraselist.", + "type": "object", + "properties": { + "phrases": { + "description": "List of comma-separated phrases that represent the Phraselist.", + "type": "string" + }, + "name": { + "description": "The Phraselist name.", + "type": "string" + }, + "isActive": { + "description": "Indicates if the Phraselist is enabled.", + "default": true, + "type": "boolean" + }, + "isExchangeable": { + "description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.", + "default": true, + "type": "boolean" + } + } + }, + "PrebuiltDomainObject": { + "type": "object", + "properties": { + "domain_name": { + "type": "string" + }, + "model_name": { + "type": "string" + } + } + }, + "HierarchicalModel": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "children": { + "items": { + "type": "string" + }, + "type": "array" + }, + "inherits": { + "type": "object", + "$ref": "#/definitions/PrebuiltDomainObject" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ApplicationPublishObject": { + "description": "Object model for publishing a specific application version.", + "type": "object", + "properties": { + "versionId": { + "description": "The version ID to publish.", + "type": "string" + }, + "isStaging": { + "description": "Indicates if the staging slot should be used, instead of the Production one.", + "default": false, + "type": "boolean" + }, + "region": { + "description": "The target region that the application is published to.", + "type": "string" + } + } + }, + "LuisApp": { + "description": "Exported Model - An exported LUIS Application.", + "additionalProperties": true, + "type": "object", + "properties": { + "name": { + "description": "The name of the application.", + "type": "string" + }, + "versionId": { + "description": "The version ID of the application that was exported.", + "type": "string" + }, + "desc": { + "description": "The description of the application.", + "type": "string" + }, + "culture": { + "description": "The culture of the application. E.g.: en-us.", + "type": "string" + }, + "intents": { + "description": "List of intents.", + "items": { + "type": "object", + "$ref": "#/definitions/HierarchicalModel" + }, + "type": "array" + }, + "entities": { + "description": "List of entities.", + "items": { + "type": "object", + "$ref": "#/definitions/HierarchicalModel" + }, + "type": "array" + }, + "closedLists": { + "description": "List of closed lists.", + "items": { + "type": "object", + "$ref": "#/definitions/ClosedList" + }, + "type": "array" + }, + "composites": { + "description": "List of composite entities.", + "items": { + "type": "object", + "$ref": "#/definitions/HierarchicalModel" + }, + "type": "array" + }, + "patternAnyEntities": { + "description": "List of Pattern.Any entities.", + "items": { + "type": "object", + "$ref": "#/definitions/PatternAny" + }, + "type": "array" + }, + "regex_entities": { + "description": "List of regular expression entities.", + "items": { + "type": "object", + "$ref": "#/definitions/RegexEntity" + }, + "type": "array" + }, + "prebuiltEntities": { + "description": "List of prebuilt entities.", + "items": { + "type": "object", + "$ref": "#/definitions/PrebuiltEntity" + }, + "type": "array" + }, + "regex_features": { + "description": "List of pattern features.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONRegexFeature" + }, + "type": "array" + }, + "model_features": { + "description": "List of model features.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONModelFeature" + }, + "type": "array" + }, + "patterns": { + "description": "List of patterns.", + "items": { + "type": "object", + "$ref": "#/definitions/PatternRule" + }, + "type": "array" + }, + "utterances": { + "description": "List of sample utterances.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONUtterance" + }, + "type": "array" + } + } + }, + "GuidResponse": { + "description": "The ID (GUID) returned by an operation.", + "type": "string", + "format": "uuid" + }, + "VersionResponse": { + "description": "The new version ID returned by when importing a model version.", + "type": "string" + }, + "FeatureIDResponse": { + "description": "The ID of the created feature.", + "type": "integer", + "x-nullable": false + }, + "LabeledUtterances": { + "description": "A list of predictions and label pairs for every example in the application.", + "type": "array", + "items": { + "$ref": "#/definitions/LabeledUtterance" + } + }, + "LabeledUtterance": { + "description": "A prediction and label pair of an example.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of Labeled Utterance." + }, + "text": { + "type": "string", + "description": "The utterance. E.g.: what's the weather like in seattle?" + }, + "tokenizedText": { + "type": "array", + "description": "The utterance tokenized.", + "items": { + "type": "string" + } + }, + "intentLabel": { + "description": "The intent matching the example.", + "type": "string" + }, + "entityLabels": { + "description": "The entities matching the example.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityLabel" + } + }, + "intentPredictions": { + "description": "List of suggested intents.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentPrediction" + } + }, + "entityPredictions": { + "description": "List of suggested entities.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityPrediction" + } + } + } + }, + "IntentsSuggestionExamples": { + "description": "List of predicted/suggested intents.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentsSuggestionExample" + } + }, + "IntentsSuggestionExample": { + "description": "Predicted/suggested intent.", + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The utterance. E.g.: what's the weather like in seattle?" + }, + "tokenizedText": { + "type": "array", + "description": "The utterance tokenized.", + "items": { + "type": "string" + } + }, + "intentPredictions": { + "description": "Predicted/suggested intents.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentPrediction" + } + }, + "entityPredictions": { + "description": "Predicted/suggested entities.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityPrediction" + } + } + } + }, + "EntitiesSuggestionExamples": { + "description": "List of predicted/suggested entities.", + "type": "array", + "items": { + "$ref": "#/definitions/EntitiesSuggestionExample" + } + }, + "EntitiesSuggestionExample": { + "description": "Predicted/suggested entity.", + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The utterance. E.g.: what's the weather like in seattle?" + }, + "tokenizedText": { + "type": "array", + "description": "The utterance tokenized.", + "items": { + "type": "string" + } + }, + "intentPredictions": { + "description": "Predicted/suggested intents.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentPrediction" + } + }, + "entityPredictions": { + "description": "Predicted/suggested entities.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityPrediction" + } + } + } + }, + "EntityLabel": { + "description": "Defines the entity type and position of the extracted entity within the example.", + "type": "object", + "properties": { + "entityName": { + "description": "The entity type.", + "type": "string" + }, + "startTokenIndex": { + "description": "The index within the utterance where the extracted entity starts.", + "type": "integer" + }, + "endTokenIndex": { + "description": "The index within the utterance where the extracted entity ends.", + "type": "integer" + } + }, + "required": [ + "entityName", + "startTokenIndex", + "endTokenIndex" + ] + }, + "IntentPrediction": { + "description": "A suggested intent.", + "type": "object", + "properties": { + "name": { + "description": "The intent's name", + "type": "string" + }, + "score": { + "description": "The intent's score, based on the prediction model.", + "type": "number" + } + } + }, + "EntityPrediction": { + "description": "A suggested entity.", + "type": "object", + "required": [ + "entityName", + "startTokenIndex", + "endTokenIndex", + "phrase" + ], + "properties": { + "entityName": { + "description": "The entity's name", + "type": "string" + }, + "startTokenIndex": { + "description": "The index within the utterance where the extracted entity starts.", + "type": "integer" + }, + "endTokenIndex": { + "description": "The index within the utterance where the extracted entity ends.", + "type": "integer" + }, + "phrase": { + "type": "string", + "description": "The actual token(s) that comprise the entity." + } + } + }, + "PersonalAssistantsResponse": { + "type": "object", + "description": "Response containing user's endpoint keys and the endpoint URLs of the prebuilt Cortana applications.", + "properties": { + "endpointKeys": { + "$ref": "#/definitions/EndpointKeys" + }, + "endpointUrls": { + "$ref": "#/definitions/PersonalAssistantUrls" + } + } + }, + "EndpointKeys": { + "type": "array", + "description": "An a array of GUIDs, comprised of Azure Endpoint Keys and the Authoring API key.", + "items": { + "type": "string", + "format": "uuid" + } + }, + "PersonalAssistantUrls": { + "type": "object", + "description": "Endpoint URLs for prebuilt Cortana applications.", + "additionalProperties": { + "type": "string" + } + }, + "ModelInfo": { + "description": "Base type used in entity types.", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "The ID of the Entity Model." + }, + "name": { + "type": "string", + "description": "Name of the Entity Model." + }, + "typeId": { + "type": "integer", + "description": "The type ID of the Entity Model." + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + } + }, + "required": [ + "id", + "readableType" + ] + }, + "ModelsInfoResponseObject": { + "description": "A list of application model infos.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelInfoResponse" + } + }, + "ModelInfoResponse": { + "description": "An application model info.", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "The ID of the Entity Model." + }, + "name": { + "type": "string", + "description": "Name of the Entity Model." + }, + "typeId": { + "type": "integer", + "description": "The type ID of the Entity Model." + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + } + }, + "required": [ + "id", + "readableType" + ], + "allOf": [ + { + "$ref": "#/definitions/HierarchicalEntityExtractor" + }, + { + "$ref": "#/definitions/CompositeEntityExtractor" + }, + { + "$ref": "#/definitions/ClosedListEntityExtractor" + }, + { + "$ref": "#/definitions/IntentClassifier" + }, + { + "$ref": "#/definitions/EntityExtractor" + }, + { + "$ref": "#/definitions/RegexEntityExtractor" + }, + { + "$ref": "#/definitions/PatternAnyEntityExtractor" + } + ] + }, + "EntityModelInfo": { + "description": "An Entity Extractor model info.", + "type": "object", + "properties": { + "roles": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + } + ] + }, + "ReadableType": { + "description": "Full name of the entity type.", + "type": "string", + "enum": [ + "Entity Extractor", + "Hierarchical Entity Extractor", + "Hierarchical Child Entity Extractor", + "Composite Entity Extractor", + "Closed List Entity Extractor", + "Prebuilt Entity Extractor", + "Intent Classifier", + "Pattern.Any Entity Extractor", + "Regex Entity Extractor" + ] + }, + "HierarchicalEntityExtractor": { + "description": "Hierarchical Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Hierarchical Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "children": { + "description": "List of child entities.", + "type": "array", + "items": { + "$ref": "#/definitions/ChildEntity" + } + } + } + }, + "HierarchicalEntityExtractorsList": { + "description": "List of Hierarchical Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/HierarchicalEntityExtractor" + } + }, + "CompositeEntityExtractor": { + "description": "A Composite Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Composite Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "children": { + "description": "List of child entities.", + "type": "array", + "items": { + "$ref": "#/definitions/ChildEntity" + } + } + } + }, + "CompositeEntityExtractorsList": { + "description": "List of Composite Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/CompositeEntityExtractor" + } + }, + "ClosedListEntityExtractor": { + "description": "Closed List Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Closed List Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "subLists": { + "description": "List of sub-lists.", + "type": "array", + "items": { + "$ref": "#/definitions/SubClosedListResponse" + } + } + } + }, + "ClosedListEntityExtractorsList": { + "description": "List of Closed List Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/ClosedListEntityExtractor" + } + }, + "PrebuiltEntityExtractor": { + "description": "Prebuilt Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Prebuilt Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ] + }, + "PrebuiltEntityExtractorsList": { + "description": "List of Prebuilt Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltEntityExtractor" + } + }, + "ChildEntity": { + "type": "object", + "description": "The base child entity type.", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "The ID (GUID) belonging to a child entity." + }, + "name": { + "type": "string", + "description": "The name of a child entity." + } + }, + "required": [ + "id" + ] + }, + "HierarchicalChildEntity": { + "description": "A Hierarchical Child Entity.", + "type": "object", + "properties": { + "typeId": { + "description": "The type ID of the Entity Model.", + "type": "integer" + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ChildEntity" + } + ] + }, + "CustomPrebuiltModel": { + "description": "A Custom Prebuilt model.", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/IntentClassifier" + }, + { + "$ref": "#/definitions/EntityExtractor" + } + ] + }, + "CustomPrebuiltModelList": { + "description": "A List of Custom Prebuilt models.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomPrebuiltModel" + } + }, + "IntentClassifier": { + "description": "Intent Classifier.", + "type": "object", + "x-ms-discriminator-value": "Intent Classifier", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + } + ], + "properties": { + "customPrebuiltDomainName": { + "description": "The domain name.", + "type": "string" + }, + "customPrebuiltModelName": { + "description": "The intent name or entity name.", + "type": "string" + } + } + }, + "EntityExtractor": { + "description": "Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "customPrebuiltDomainName": { + "description": "The domain name.", + "type": "string" + }, + "customPrebuiltModelName": { + "description": "The intent name or entity name.", + "type": "string" + } + } + }, + "IntentClassifiersList": { + "description": "List of Intent Classifiers.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentClassifier" + } + }, + "EntityExtractorsList": { + "description": "List of Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityExtractor" + } + }, + "FeaturesResponseObject": { + "description": "Model Features, including Patterns and Phraselists.", + "type": "object", + "properties": { + "phraselistFeatures": { + "$ref": "#/definitions/PhraseListFeatureInfoList" + }, + "patternFeatures": { + "$ref": "#/definitions/PatternFeatureInfoList" + } + } + }, + "FeatureInfoObject": { + "description": "The base class Features-related response objects inherit from.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "A six-digit ID used for Features." + }, + "name": { + "type": "string", + "description": "The name of the Feature." + }, + "isActive": { + "description": "Indicates if the feature is enabled.", + "type": "boolean" + } + } + }, + "PatternFeatureInfo": { + "description": "Pattern feature.", + "type": "object", + "properties": { + "pattern": { + "description": "The Regular Expression to match.", + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/FeatureInfoObject" + } + ] + }, + "PatternFeatureInfoList": { + "description": "List of Pattern features.", + "type": "array", + "items": { + "$ref": "#/definitions/PatternFeatureInfo" + } + }, + "PhraseListFeatureInfo": { + "description": "Phraselist Feature.", + "type": "object", + "properties": { + "phrases": { + "type": "string", + "description": "A list of comma-separated values." + }, + "isExchangeable": { + "description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.", + "type": "boolean" + } + }, + "allOf": [ + { + "$ref": "#/definitions/FeatureInfoObject" + } + ] + }, + "PhraseListFeatureInfoList": { + "description": "List of Phraselist Features.", + "type": "array", + "items": { + "$ref": "#/definitions/PhraseListFeatureInfo" + } + }, + "LabelExampleResponse": { + "description": "Response when adding a labeled example.", + "type": "object", + "properties": { + "UtteranceText": { + "description": "The sample's utterance.", + "type": "string" + }, + "ExampleId": { + "description": "The newly created sample ID.", + "type": "integer" + } + } + }, + "BatchLabelExample": { + "description": "Response when adding a batch of labeled examples.", + "type": "object", + "properties": { + "value": { + "$ref": "#/definitions/LabelExampleResponse" + }, + "hasError": { + "type": "boolean" + }, + "error": { + "$ref": "#/definitions/OperationStatus" + } + } + }, + "BatchLabelExampleResponse": { + "description": "Response when adding a batch of labeled examples.", + "type": "array", + "items": { + "$ref": "#/definitions/BatchLabelExample" + } + }, + "ApplicationInfoResponse": { + "description": "Response containing the Application Info.", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "The ID (GUID) of the application." + }, + "name": { + "description": "The name of the application.", + "type": "string" + }, + "description": { + "description": "The description of the application.", + "type": "string" + }, + "culture": { + "description": "The culture of the application. E.g.: en-us.", + "type": "string" + }, + "usageScenario": { + "description": "Defines the scenario for the new application. Optional. E.g.: IoT.", + "type": "string" + }, + "domain": { + "description": "The domain for the new application. Optional. E.g.: Comics.", + "type": "string" + }, + "versionsCount": { + "description": "Amount of model versions within the application.", + "type": "integer" + }, + "createdDateTime": { + "description": "The version's creation timestamp.", + "type": "string" + }, + "endpoints": { + "description": "The Runtime endpoint URL for this model version.", + "type": "object" + }, + "endpointHitsCount": { + "description": "Number of calls made to this endpoint.", + "type": "integer" + }, + "activeVersion": { + "description": "The version ID currently marked as active.", + "type": "string" + } + } + }, + "ApplicationsInfoList": { + "description": "List of Application Infos.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationInfoResponse" + } + }, + "ProductionOrStagingEndpointInfo": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointInfo" + } + ] + }, + "EndpointInfo": { + "type": "object", + "description": "The base class \"ProductionOrStagingEndpointInfo\" inherits from.", + "properties": { + "versionId": { + "description": "The version ID to publish.", + "type": "string" + }, + "isStaging": { + "description": "Indicates if the staging slot should be used, instead of the Production one.", + "type": "boolean" + }, + "endpointUrl": { + "description": "The Runtime endpoint URL for this model version.", + "type": "string" + }, + "region": { + "description": "The target region that the application is published to.", + "type": "string" + }, + "assignedEndpointKey": { + "description": "The endpoint key.", + "type": "string" + }, + "endpointRegion": { + "type": "string", + "description": "The endpoint's region." + }, + "publishedDateTime": { + "description": "Timestamp when was last published.", + "type": "string" + } + } + }, + "AvailableEndpoints": { + "type": "object", + "description": "Collection of endpoint URLs where the selected application is deployed to.", + "additionalProperties": { + "type": "string" + } + }, + "AvailableCulture": { + "description": "Available culture for using in a new application.", + "type": "object", + "properties": { + "name": { + "description": "The language name.", + "type": "string" + }, + "code": { + "description": "The ISO value for the language.", + "type": "string" + } + } + }, + "AvailableCultures": { + "type": "array", + "description": "A list of available application cultures.", + "items": { + "$ref": "#/definitions/AvailableCulture" + } + }, + "AvailableDomains": { + "description": "A list of available application domains.", + "type": "array", + "items": { + "type": "string" + } + }, + "ApplicationUsageScenarios": { + "description": "A list of possible application usage scenarios.", + "type": "array", + "items": { + "type": "string" + } + }, + "ApplicationSettings": { + "description": "The application settings.", + "type": "object", + "properties": { + "id": { + "description": "The application ID.", + "type": "string", + "format": "uuid" + }, + "public": { + "description": "Setting your application as public allows other people to use your application's endpoint using their own keys.", + "type": "boolean", + "x-nullable": false, + "x-ms-client-name": "isPublic" + } + }, + "required": [ + "id", + "public" + ] + }, + "PublishSettings": { + "description": "The application publish settings.", + "type": "object", + "properties": { + "id": { + "description": "The application ID.", + "type": "string", + "format": "uuid" + }, + "sentimentAnalysis": { + "description": "Setting sentiment analysis as true returns the Sentiment of the input utterance along with the resopnse", + "type": "boolean", + "x-nullable": false, + "x-ms-client-name": "IsSentimentAnalysisEnabled" + }, + "speech": { + "description": "Setting speech as public enables speech priming in your app", + "type": "boolean", + "x-nullable": false, + "x-ms-client-name": "IsSpeechEnabled" + }, + "spellChecker": { + "description": "Setting spell checker as public enables spell checking the input utterance.", + "type": "boolean", + "x-nullable": false, + "x-ms-client-name": "IsSpellCheckerEnabled" + } + }, + "required": [ + "id", + "sentimentAnalysis", + "speech", + "spellChecker" + ] + }, + "AvailablePrebuiltEntityModel": { + "description": "Available Prebuilt entity model for using in an application.", + "type": "object", + "properties": { + "name": { + "description": "The entity name.", + "type": "string" + }, + "description": { + "description": "The entity description and usage information.", + "type": "string" + }, + "examples": { + "description": "Usage examples.", + "type": "string" + } + } + }, + "AvailablePrebuiltEntityModels": { + "description": "List of Available Prebuilt entity models.", + "type": "array", + "items": { + "$ref": "#/definitions/AvailablePrebuiltEntityModel" + } + }, + "EnqueueTrainingResponse": { + "description": "Response model when requesting to train the model.", + "type": "object", + "properties": { + "statusId": { + "description": "The train request status ID.", + "type": "integer" + }, + "status": { + "$ref": "#/definitions/TrainingStatus" + } + } + }, + "TrainingStatus": { + "description": "The Training status.", + "type": "string", + "enum": [ + "Queued", + "InProgress", + "UpToDate", + "Fail", + "Success" + ] + }, + "ModelTrainingInfo": { + "description": "Model Training Info.", + "type": "object", + "properties": { + "modelId": { + "type": "string", + "format": "uuid", + "description": "The ID (GUID) of the model." + }, + "details": { + "$ref": "#/definitions/ModelTrainingDetails" + } + } + }, + "ModelTrainingDetails": { + "description": "Model Training Details.", + "type": "object", + "properties": { + "statusId": { + "description": "The train request status ID.", + "type": "integer" + }, + "status": { + "$ref": "#/definitions/TrainingStatus" + }, + "exampleCount": { + "description": "The count of examples used to train the model.", + "type": "integer" + }, + "trainingDateTime": { + "description": "When the model was trained.", + "type": "string", + "format": "date-time" + }, + "failureReason": { + "description": "Reason for the training failure.", + "type": "string" + } + } + }, + "ModelTrainingInfoList": { + "description": "List of Model Training Infos.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelTrainingInfo" + } + }, + "UserAccessList": { + "description": "List of user permissions.", + "type": "object", + "properties": { + "owner": { + "type": "string", + "description": "The email address of owner of the application." + }, + "emails": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UserCollaborator": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "The email address of the user." + } + } + }, + "CollaboratorsArray": { + "type": "object", + "properties": { + "emails": { + "type": "array", + "description": "The email address of the users.", + "items": { + "type": "string" + } + } + } + }, + "OperationStatus": { + "description": "Response of an Operation status.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Status Code.", + "enum": [ + "Failed", + "FAILED", + "Success" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "OperationStatusType" + } + }, + "message": { + "type": "string", + "description": "Status details." + } + } + }, + "ErrorResponse": { + "description": "Error response when invoking an operation on the API.", + "type": "object", + "properties": { + "errorType": { + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "OperationError": { + "description": "Operation error details when invoking an operation on the API.", + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "PrebuiltDomainsList": { + "description": "List of Prebuilt Domains.", + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltDomain" + } + }, + "PrebuiltDomain": { + "description": "Prebuilt Domain.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "culture": { + "type": "string" + }, + "description": { + "type": "string" + }, + "examples": { + "type": "string" + }, + "intents": { + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltDomainItem" + } + }, + "entities": { + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltDomainItem" + } + } + } + }, + "PrebuiltDomainItem": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "examples": { + "type": "string" + } + } + }, + "GuidList": { + "description": "List of IDs (GUID)", + "type": "array", + "items": { + "$ref": "#/definitions/GuidResponse" + } + }, + "EntityRoleCreateObject": { + "description": "Object model for creating an entity role.", + "type": "object", + "properties": { + "name": { + "description": "The entity role name.", + "type": "string" + } + } + }, + "RegexModelCreateObject": { + "description": "Model object for creating a regex entity model.", + "type": "object", + "properties": { + "regexPattern": { + "description": "The regex entity pattern.", + "type": "string" + }, + "name": { + "description": "The model name.", + "type": "string" + } + } + }, + "PatternAnyModelCreateObject": { + "description": "Model object for creating a Pattern.Any entity model.", + "type": "object", + "properties": { + "name": { + "description": "The model name.", + "type": "string" + }, + "explicitList": { + "description": "The Pattern.Any explicit list.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ExplicitListItemCreateObject": { + "description": "Object model for creating an explicit list item.", + "type": "object", + "properties": { + "explicitListItem": { + "description": "The explicit list item.", + "type": "string" + } + } + }, + "RegexModelUpdateObject": { + "description": "Model object for updating a regex entity model.", + "type": "object", + "properties": { + "regexPattern": { + "description": "The regex entity pattern.", + "type": "string" + }, + "name": { + "description": "The model name.", + "type": "string" + } + } + }, + "PatternAnyModelUpdateObject": { + "description": "Model object for updating a Pattern.Any entity model.", + "type": "object", + "properties": { + "name": { + "description": "The model name.", + "type": "string" + }, + "explicitList": { + "description": "The Pattern.Any explicit list.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EntityRoleUpdateObject": { + "description": "Object model for updating an entity role.", + "type": "object", + "properties": { + "name": { + "description": "The entity role name.", + "type": "string" + } + } + }, + "ExplicitListItemUpdateObject": { + "description": "Model object for updating an explicit list item.", + "type": "object", + "properties": { + "explicitListItem": { + "description": "The explicit list item.", + "type": "string" + } + } + }, + "PatternRuleCreateObject": { + "description": "Object model for creating a pattern", + "type": "object", + "properties": { + "pattern": { + "description": "The pattern text.", + "type": "string" + }, + "intent": { + "description": "The intent's name which the pattern belongs to.", + "type": "string" + } + } + }, + "PatternRuleUpdateObject": { + "description": "Object model for updating a pattern.", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The pattern ID.", + "type": "string" + }, + "pattern": { + "description": "The pattern text.", + "type": "string" + }, + "intent": { + "description": "The intent's name which the pattern belongs to.", + "type": "string" + } + } + }, + "RegexEntityExtractor": { + "description": "Regex Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Regex Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "regexPattern": { + "description": "The Regex entity pattern.", + "type": "string" + } + } + }, + "RegexEntityExtractorList": { + "description": "List of Regex Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/RegexEntityExtractor" + } + }, + "PatternAnyEntityExtractor": { + "description": "Pattern.Any Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Pattern.Any Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "explicitList": { + "$ref": "#/definitions/ExplicitListItemList" + } + } + }, + "PatternAnyEntityExtractorList": { + "description": "List of Pattern.Any Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/PatternAnyEntityExtractor" + } + }, + "EntityRole": { + "description": "Entity extractor role", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The entity role ID.", + "type": "string" + }, + "name": { + "description": "The entity role name.", + "type": "string" + } + } + }, + "EntityRoleList": { + "description": "List of Pattern.Any Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityRole" + } + }, + "ExplicitListItem": { + "description": "Explicit list item", + "type": "object", + "properties": { + "id": { + "format": "int64", + "description": "The explicit list item ID.", + "type": "integer" + }, + "explicitListItem": { + "description": "The explicit list item value.", + "type": "string" + } + } + }, + "ExplicitListItemList": { + "description": "List of explicit list items", + "type": "array", + "items": { + "$ref": "#/definitions/ExplicitListItem" + } + }, + "ExplicitListItemIDResponse": { + "description": "The ID of the created explicit list item.", + "type": "integer", + "x-nullable": false + }, + "PatternRuleInfo": { + "description": "Pattern rule", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The pattern ID.", + "type": "string" + }, + "pattern": { + "description": "The pattern text.", + "type": "string" + }, + "intent": { + "description": "The intent's name where the pattern belongs to.", + "type": "string" + } + } + }, + "PatternRuleList": { + "description": "List of patterns", + "type": "array", + "items": { + "$ref": "#/definitions/PatternRuleInfo" + } + }, + "ExamplesPerModelResponseObject":{ + "description": "A list of examples per model.", + "type": "array", + "items": { + "$ref": "#/definitions/LabelTextObject" + } + }, + "LabelTextObject":{ + "description": "An object containing the example's text.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the Label." + }, + "text": { + "type": "string", + "description": "The text of the label." + } + } + }, + "PatternAny": { + "description": "Pattern.Any Entity Extractor.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "explicitList": { + "items": { + "type": "string" + }, + "type": "array" + }, + "roles": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "RegexEntity": { + "description": "Regular Expression Entity Extractor.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "regexPattern": { + "type": "string" + }, + "roles": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "PrebuiltEntity": { + "description": "Prebuilt Entity Extractor.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "roles": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "PatternRule": { + "description": "Pattern", + "type": "object", + "properties": { + "pattern": { + "description": "The pattern text.", + "type": "string" + }, + "intent": { + "description": "The intent's name where the pattern belongs to.", + "type": "string" + } + } + } + }, + "parameters": { + "AppIdInPath": { + "name": "appId", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "The application ID.", + "x-ms-parameter-location": "method" + }, + "VersionIdInPath": { + "name": "versionId", + "in": "path", + "description": "The version ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "CEntityIdInPath": { + "name": "cEntityId", + "in": "path", + "description": "The composite entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "HEntityIdInPath": { + "name": "hEntityId", + "in": "path", + "description": "The hierarchical entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "IntentIdInPath": { + "name": "intentId", + "in": "path", + "description": "The intent classifier ID.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "SkipInPath": { + "name": "skip", + "in": "query", + "description": "The number of entries to skip. Default value is 0.", + "type": "integer", + "default": 0, + "minimum": 0, + "x-ms-parameter-location": "method" + }, + "TakeInPath": { + "name": "take", + "in": "query", + "description": "The number of entries to return. Maximum page size is 500. Default is 100.", + "type": "integer", + "default": 100, + "minimum": 0, + "maximum": 500, + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulAddApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulAddApplicationRequest.json similarity index 78% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulAddApplicationRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulAddApplicationRequest.json index 041a6013630d..88aa9f3683fa 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulAddApplicationRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulAddApplicationRequest.json @@ -13,7 +13,7 @@ "responses": { "201": { "headers": { - "location": "https://api.luis.ai/api/v2.0/apps/9e6703ec-56fe-48ce-8a72-10d592f6056d" + "location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/9e6703ec-56fe-48ce-8a72-10d592f6056d" }, "body": "9e6703ec-56fe-48ce-8a72-10d592f6056d" } diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json new file mode 100644 index 000000000000..46ca77fd8a00 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "prebuiltDomainCreateObject": { + "culture": "en-US", + "domainName": "Web" + } + }, + "responses": { + "201": { + "headers": { + "location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/customprebuiltdomains/00000000-0000-0000-0000-000000000000" + }, + "body": "00000000-0000-0000-0000-000000000000" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulDeleteApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulDeleteApplicationRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulDeleteApplicationRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulDeleteApplicationRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetApplicationCulturesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationCulturesRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetApplicationCulturesRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationCulturesRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetApplicationDomainsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationDomainsRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetApplicationDomainsRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationDomainsRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetApplicationInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationInfoRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetApplicationInfoRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationInfoRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetApplicationQueryLogsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationQueryLogsRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetApplicationQueryLogsRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationQueryLogsRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetApplicationSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationSettingsRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetApplicationSettingsRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationSettingsRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetApplicationsListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationsListRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetApplicationsListRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationsListRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetEndpointsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetEndpointsRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetEndpointsRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetEndpointsRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetPersonalAssistantApplications.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetPersonalAssistantApplications.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulGetPersonalAssistantApplications.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetPersonalAssistantApplications.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetPublishSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetPublishSettingsRequest.json new file mode 100644 index 000000000000..9b95cb6a0a15 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetPublishSettingsRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "51963bf0-08a1-44b7-9c69-735dbb92ce74", + "sentimentAnalysis": true, + "speech": true, + "spellChecker": true + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulImportApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulImportApplicationRequest.json similarity index 84% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulImportApplicationRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulImportApplicationRequest.json index 0a25491bf97f..ca863ec9841e 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulImportApplicationRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulImportApplicationRequest.json @@ -4,12 +4,19 @@ "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", "appName": "Test LUIS App", "luisApp": { - "luis_schema_version": "2.1.0", + "luis_schema_version": "3.0.0", "versionId": "0.1", "name": "LuisBot", "desc": "", "culture": "en-us", "intents": [ + { + "name": "HomeAutomation.TurnOff", + "inherits": { + "domain_name": "HomeAutomation", + "model_name": "TurnOff" + } + }, { "name": "dateintent" }, @@ -28,17 +35,44 @@ ], "entities": [ { - "name": "AirportCode" + "name": "AirportCode", + "roles": [ + "destination" + ] }, { - "name": "Hotel" + "name": "Hotel", + "roles": [] } ], "composites": [], "closedLists": [], - "bing_entities": [ - "datetimeV2", - "geography" + "patternAnyEntities": [ + { + "name": "patternAny1", + "explicitList": [], + "roles": [ + "role1", + "role2" + ] + } + ], + "regex_entities": [ + { + "name": "regex1", + "regexPattern": "[^a]+", + "roles": [ + "regex role" + ] + } + ], + "prebuiltEntities": [ + { + "name": "datetimeV2", + "roles": [ + "datetime role" + ] + } ], "model_features": [ { @@ -61,6 +95,12 @@ "activated": true } ], + "patterns": [ + { + "pattern": "this is [a test] {patternAny1:role1}", + "intent": "Help" + } + ], "utterances": [ { "text": "i need help", @@ -259,7 +299,7 @@ "responses": { "201": { "headers": { - "Location": "https://api.luis.ai/api/v2.0/apps/374fac89-ae12-4afd-8c21-8a6424ce1c1f" + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/374fac89-ae12-4afd-8c21-8a6424ce1c1f" }, "body": "374fac89-ae12-4afd-8c21-8a6424ce1c1f" } diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulPublishApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulPublishApplicationRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulPublishApplicationRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulPublishApplicationRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulRenameApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulRenameApplicationRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulRenameApplicationRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulRenameApplicationRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulUpdateApplicationSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulUpdateApplicationSettingsRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulUpdateApplicationSettingsRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulUpdateApplicationSettingsRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulUpdatePublishSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulUpdatePublishSettingsRequest.json new file mode 100644 index 000000000000..0a42f477337b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulUpdatePublishSettingsRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "publishSettingUpdateObject": { + "sentimentAnalysis": true, + "speech": true, + "spellChecker": true + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/examples/SuccessfulAddLabelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/examples/SuccessfulAddLabelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/examples/SuccessfulAddLabelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/examples/SuccessfulAddLabelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/examples/SuccessfulBatchAddLabelsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/examples/SuccessfulBatchAddLabelsRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/examples/SuccessfulBatchAddLabelsRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/examples/SuccessfulBatchAddLabelsRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/examples/SuccessfulDeleteExampleLabelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/examples/SuccessfulDeleteExampleLabelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/examples/SuccessfulDeleteExampleLabelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/examples/SuccessfulDeleteExampleLabelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulCreatePatternFeatureRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulCreatePatternFeatureRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulCreatePatternFeatureRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulCreatePatternFeatureRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulCreatePhraselistFeatureRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulCreatePhraselistFeatureRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulCreatePhraselistFeatureRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulCreatePhraselistFeatureRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulDeletePatternFeatureInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulDeletePatternFeatureInfoRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulDeletePatternFeatureInfoRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulDeletePatternFeatureInfoRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulGetApplicationVersionPatternFeaturesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulGetApplicationVersionPatternFeaturesRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulGetApplicationVersionPatternFeaturesRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulGetApplicationVersionPatternFeaturesRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulGetPatternFeatureInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulGetPatternFeatureInfoRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulGetPatternFeatureInfoRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulGetPatternFeatureInfoRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulUpdatePatternFeatureInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulUpdatePatternFeatureInfoRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulUpdatePatternFeatureInfoRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulUpdatePatternFeatureInfoRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulAddCustomPrebuildIntentRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulAddCustomPrebuildIntentRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulAddCustomPrebuildIntentRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulAddCustomPrebuildIntentRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulAddPrebuiltEntityExtractorsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulAddPrebuiltEntityExtractorsRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulAddPrebuiltEntityExtractorsRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulAddPrebuiltEntityExtractorsRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json new file mode 100644 index 000000000000..1683e6855ba1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf", + "wordListCreateObject": { + "canonicalForm": "Texas", + "list": [ + "tx", + "texas" + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/closedlists/28027e3b-8356-4cdf-b395-24afb94e9469/sublists/6134877" + }, + "body": 6134877 + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateClosedListEntityModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateClosedListEntityModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateClosedListEntityModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateClosedListEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateClosedListEntityRoleRequest.json new file mode 100644 index 000000000000..9d0f8b5f9a70 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateClosedListEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/closedlists/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateCompositeChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateCompositeChildModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateCompositeChildModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateCompositeChildModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateCompositeEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateCompositeEntityExtractorRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateCompositeEntityExtractorRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateCompositeEntityExtractorRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateCompositeEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateCompositeEntityRoleRequest.json new file mode 100644 index 000000000000..6eb2326b3931 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateCompositeEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/compositeentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateCustomPrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateCustomPrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..2ae5515f3376 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateCustomPrebuiltEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/customprebuiltentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateEntityExtractorRequest.json new file mode 100644 index 000000000000..3561271a5e40 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateEntityExtractorRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "modelCreateObject": { + "name": "DayOfWeek" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities/7e838199-a5db-47a6-8931-d79f1729a922" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateEntityRoleRequest.json new file mode 100644 index 000000000000..7459655d8835 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateHierarchicalChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateHierarchicalChildModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateHierarchicalChildModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateHierarchicalChildModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateHierarchicalEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateHierarchicalEntityExtractorRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateHierarchicalEntityExtractorRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateHierarchicalEntityExtractorRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateHierarchicalEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateHierarchicalEntityRoleRequest.json new file mode 100644 index 000000000000..e7f9436e49f7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateHierarchicalEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/hierarchicalentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateIntentClassifierRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateIntentClassifierRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateIntentClassifierRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateIntentClassifierRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreatePatternAnyEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreatePatternAnyEntityExtractorRequest.json new file mode 100644 index 000000000000..ca8b43236af6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreatePatternAnyEntityExtractorRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "extractorCreateObject": { + "name": "AirportCodeRegex", + "explicitList": [ + "item 1", + "item 2" + ] + } + }, + "responses": { + "201": { + "headers": {}, + "body": "bc1bae43-7904-48ad-a165-88b1910174f9" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreatePatternAnyEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreatePatternAnyEntityRoleRequest.json new file mode 100644 index 000000000000..06be00385dc4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreatePatternAnyEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/patternanyentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreatePatternAnyExplicitListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreatePatternAnyExplicitListRequest.json new file mode 100644 index 000000000000..89e5d428c486 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreatePatternAnyExplicitListRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "item": { + "explicitListItem": "item 1" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/patternanyentities/fc821c4e-a2f8-4074-9410-7271b38a692d/explicitlist/8645" + }, + "body": 8645 + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreatePrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreatePrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..98afecdc13e5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreatePrebuiltEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/prebuilts/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateRegexEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateRegexEntityExtractorRequest.json new file mode 100644 index 000000000000..6c7ca15ff635 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateRegexEntityExtractorRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "regexEntityExtractorCreateObj": { + "name": "AirportCodeRegex", + "regexPattern": "[a-z]{3}" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "bc1bae43-7904-48ad-a165-88b1910174f9" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateRegexEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateRegexEntityRoleRequest.json new file mode 100644 index 000000000000..46b0adb25757 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulCreateRegexEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/regexentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteClosedListEntityModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteClosedListEntityModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteClosedListEntityModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteCompositeChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteCompositeChildModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteCompositeChildModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteCompositeChildModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteCompositeEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteCompositeEntityModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteCompositeEntityModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteCompositeEntityModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteCompositeEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteCompositeEntityRoleRequest.json new file mode 100644 index 000000000000..ab8b59485cf6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteCompositeEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteCustomPrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteCustomPrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..7515bcd640af --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteCustomPrebuiltEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteEntityExtractorRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteEntityExtractorRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteEntityExtractorRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteEntityRoleRequest.json new file mode 100644 index 000000000000..7515bcd640af --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteHierarchicalEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteHierarchicalEntityRoleRequest.json new file mode 100644 index 000000000000..926b269e83a1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteHierarchicalEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteIntentModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteIntentModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteIntentModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteIntentModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePatternAnyEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePatternAnyEntityRequest.json new file mode 100644 index 000000000000..e0cf65ad934c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePatternAnyEntityRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePatternAnyEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePatternAnyEntityRoleRequest.json new file mode 100644 index 000000000000..7515bcd640af --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePatternAnyEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePatternAnyExplicitListItemRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePatternAnyExplicitListItemRequest.json new file mode 100644 index 000000000000..b5b898bf0d2c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePatternAnyExplicitListItemRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "itemId": 543211 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeletePrebuiltEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePrebuiltEntityRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeletePrebuiltEntityRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePrebuiltEntityRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..7515bcd640af --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteRegexEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteRegexEntityRequest.json new file mode 100644 index 000000000000..7fb7d5d56c6d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteRegexEntityRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "regexEntityId": "a065c863-918e-4c56-a267-9aaae3c7dced" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteRegexEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteRegexEntityRoleRequest.json new file mode 100644 index 000000000000..7515bcd640af --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteRegexEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteSublistRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteSublistRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulDeleteSublistRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulDeleteSublistRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json similarity index 80% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json index 2950c322e565..7423a2636518 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json @@ -43,6 +43,16 @@ "cal." ] } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } ] } ] diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json new file mode 100644 index 000000000000..e936eea71e61 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "bc1bae43-7904-48ad-a165-88b1910174f9", + "name": "Reservation", + "typeId": 4, + "readableType": "Composite Entity Extractor", + "children": [ + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "Location::To" + }, + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json new file mode 100644 index 000000000000..d04607c61fa3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": "0", + "take": "100" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "DayOfWeek", + "typeId": 1, + "readableType": "Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "b8e31be4-300f-455e-894b-6f079abca0a2", + "name": "$Camera.AppName", + "typeId": 1, + "readableType": "Entity Extractor", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "AppName", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json new file mode 100644 index 000000000000..28b298d3649f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "name": "Location", + "typeId": 3, + "readableType": "Hierarchical Entity Extractor", + "children": [ + { + "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82", + "name": "From" + }, + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "To" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json new file mode 100644 index 000000000000..27d4a0d448ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": "0", + "take": "100" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8", + "name": "BookFlight", + "typeId": 0, + "readableType": "Intent Classifier" + }, + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime", + "typeId": 2, + "readableType": "Prebuilt Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "DayOfWeek", + "typeId": 1, + "readableType": "Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "name": "Location", + "typeId": 3, + "readableType": "Hierarchical Entity Extractor", + "children": [ + { + "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82", + "name": "From" + }, + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "To" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "8285a9ee-6bc0-4409-87f4-82d539f70529", + "name": "None", + "typeId": 0, + "readableType": "Intent Classifier" + }, + { + "id": "bc1bae43-7904-48ad-a165-88b1910174f9", + "name": "Reservation", + "typeId": 4, + "readableType": "Composite Entity Extractor", + "children": [ + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "Location::To" + }, + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "8713b104-78ec-4c4f-9f96-f2e53562cc16", + "name": "States", + "typeId": 5, + "readableType": "Closed List Entity Extractor", + "subLists": [ + { + "id": 1, + "canonicalForm": "new york", + "list": [ + "ny", + "new york" + ] + }, + { + "id": 2, + "canonicalForm": "washington", + "list": [ + "washington", + "wa" + ] + }, + { + "id": 3, + "canonicalForm": "california", + "list": [ + "california", + "ca", + "calif.", + "cal." + ] + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "b8e31be4-300f-455e-894b-6f079abca0a2", + "name": "$Camera.AppName", + "typeId": 1, + "readableType": "Entity Extractor", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "AppName", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "9500536f-ffec-4fab-93ad-6268abb0f73c", + "name": "$Camera.CapturePhoto", + "typeId": 0, + "readableType": "Intent Classifier", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "CapturePhoto" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionPatternAnyEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionPatternAnyEntityInfosRequest.json new file mode 100644 index 000000000000..7deb42c6e8d0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionPatternAnyEntityInfosRequest.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "any 1", + "typeId": 7, + "readableType": "Pattern.Any Entity Extractor", + "explicitList": [ + { + "id": 456, + "explicitListItem": "item 1" + }, + { + "id": 457, + "explicitListItem": "item 2" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "any 2", + "typeId": 7, + "readableType": "Pattern.Any Entity Extractor", + "explicitList": [], + "roles": [] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json new file mode 100644 index 000000000000..c058cc89f247 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": "0", + "take": "100" + }, + "responses":{ + "200":{ + "headers": {}, + "body": [ + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime", + "typeId": 2, + "readableType": "Prebuilt Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionRegexEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionRegexEntityInfosRequest.json new file mode 100644 index 000000000000..20ee0557e101 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionRegexEntityInfosRequest.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "AirportCodeRegex", + "regexPattern": "[a-z]{3}", + "typeId": 8, + "readableType": "Regex Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "Guid regex", + "regexPattern": "[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{3}-[0-9A-F]{12}", + "typeId": 8, + "readableType": "Regex Entity Extractor", + "roles": [] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json similarity index 81% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json index 210fad4b7543..5bc09f40ffeb 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json @@ -41,6 +41,16 @@ "cal." ] } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } ] } } diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetClosedListEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetClosedListEntityRoleInfoRequest.json new file mode 100644 index 000000000000..873709a27f45 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetClosedListEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetClosedListEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetClosedListEntityRolesRequest.json new file mode 100644 index 000000000000..e3a67e955f56 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetClosedListEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json new file mode 100644 index 000000000000..5dbf8b5799c8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "cEntityId": "{cEntityId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "bc1bae43-7904-48ad-a165-88b1910174f9", + "name": "Reservation", + "typeId": 4, + "readableType": "Composite Entity Extractor", + "children": [ + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "Location::To" + }, + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCompositeEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCompositeEntityRoleInfoRequest.json new file mode 100644 index 000000000000..e722538d2400 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCompositeEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCompositeEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCompositeEntityRolesRequest.json new file mode 100644 index 000000000000..44864fee81b7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCompositeEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetCustomPrebuildIntentRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCustomPrebuildIntentRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetCustomPrebuildIntentRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCustomPrebuildIntentRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json new file mode 100644 index 000000000000..51deac14d9e5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "1.0" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "b8e31be4-300f-455e-894b-6f079abca0a2", + "name": "Camera.AppName", + "typeId": 1, + "readableType": "Entity Extractor", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "AppName", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json new file mode 100644 index 000000000000..2690d0c8c29b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "1.0" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "1aa813da-8d36-4d16-bb13-d6f193290fea", + "name": "Calendar.Find", + "typeId": 0, + "readableType": "Intent Classifier", + "customPrebuiltDomainName": "Calendar", + "customPrebuiltModelName": "Find" + }, + { + "id": "d02b2e38-6b3c-412e-bf9e-f6770a40c9a0", + "name": "Calendar.Location", + "typeId": 1, + "readableType": "Entity Extractor", + "customPrebuiltDomainName": "Calendar", + "customPrebuiltModelName": "Location", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltEntityRoleInfoRequest.json new file mode 100644 index 000000000000..873709a27f45 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltEntityRolesRequest.json new file mode 100644 index 000000000000..e3a67e955f56 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetEntityInfoRequest.json new file mode 100644 index 000000000000..5e45a8bad607 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetEntityInfoRequest.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "DayOfWeek", + "typeId": 1, + "readableType": "Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetEntityRoleInfoRequest.json new file mode 100644 index 000000000000..873709a27f45 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetEntityRolesRequest.json new file mode 100644 index 000000000000..e3a67e955f56 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetEntitySuggestionExamples.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetEntitySuggestionExamples.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetEntitySuggestionExamples.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetEntitySuggestionExamples.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetExamplesPerModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetExamplesPerModelRequest.json new file mode 100644 index 000000000000..9bd4fe5c1f1c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetExamplesPerModelRequest.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "modelId": "e4770e43-233a-48ad-a1fa-54f4f97eff9f" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": 10002, + "text": "Lorem ipsum dolor sit amet" + }, + { + "id": 10003, + "text": "consectetur adipiscing elit" + }, + { + "id": 10004, + "text": "sed do eiusmod tempor incididunt" + } + ] + } + } + } diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json new file mode 100644 index 000000000000..cd05afc993a6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "hEntityId": "{hEntityId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "name": "Location", + "typeId": 3, + "readableType": "Hierarchical Entity Extractor", + "children": [ + { + "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82", + "name": "From" + }, + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "To" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetHierarchicalEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetHierarchicalEntityRoleInfoRequest.json new file mode 100644 index 000000000000..6a50d59cff75 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetHierarchicalEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetHierarchicalEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetHierarchicalEntityRolesRequest.json new file mode 100644 index 000000000000..9634461c4917 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetHierarchicalEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetIntentInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetIntentInfoRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetIntentInfoRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetIntentInfoRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyEntityInfoRequest.json new file mode 100644 index 000000000000..5a54ce71ea70 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyEntityInfoRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "any", + "typeId": 7, + "readableType": "Pattern.Any Entity Extractor", + "explicitList": [ + { + "id": 456, + "explicitListItem": "item 1" + }, + { + "id": 457, + "explicitListItem": "item 2" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyEntityRoleInfoRequest.json new file mode 100644 index 000000000000..873709a27f45 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyEntityRolesRequest.json new file mode 100644 index 000000000000..e3a67e955f56 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyExplicitListItemRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyExplicitListItemRequest.json new file mode 100644 index 000000000000..e4ab8a723d7b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyExplicitListItemRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a", + "itemId": 76451 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": 76451, + "explicitListItem": "item 2" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyExplicitListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyExplicitListRequest.json new file mode 100644 index 000000000000..12a6c6ab31ce --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPatternAnyExplicitListRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": 48674, + "explicitListItem": "item 1" + }, + { + "id": 76451, + "explicitListItem": "item 2" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPrebuiltEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPrebuiltEntityRoleInfoRequest.json new file mode 100644 index 000000000000..873709a27f45 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPrebuiltEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPrebuiltEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPrebuiltEntityRolesRequest.json new file mode 100644 index 000000000000..e3a67e955f56 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPrebuiltEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json new file mode 100644 index 000000000000..2f1031f4135c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "prebuiltId": "a065c863-918e-4c56-a267-9aaae3c7dced" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a065c863-918e-4c56-a267-9aaae3c7dced", + "name": "datetimeV2", + "typeId": 2, + "readableType": "Prebuilt Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetRegexEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetRegexEntityInfoRequest.json new file mode 100644 index 000000000000..aef4394bf9d6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetRegexEntityInfoRequest.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "regexEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "AirportCodeRegex", + "regexPattern": "[a-z]{3}", + "typeId": 8, + "readableType": "Regex Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetRegexEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetRegexEntityRoleInfoRequest.json new file mode 100644 index 000000000000..873709a27f45 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetRegexEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetRegexEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetRegexEntityRolesRequest.json new file mode 100644 index 000000000000..e3a67e955f56 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetRegexEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulPatchClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulPatchClosedListEntityModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulPatchClosedListEntityModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulPatchClosedListEntityModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulRenameEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulRenameEntityExtractorRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulRenameEntityExtractorRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulRenameEntityExtractorRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulRenameIntentModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulRenameIntentModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulRenameIntentModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulRenameIntentModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulUpdateClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateClosedListEntityModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulUpdateClosedListEntityModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateClosedListEntityModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateClosedListEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateClosedListEntityRoleRequest.json new file mode 100644 index 000000000000..371cf7985b42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateClosedListEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulUpdateCompositeEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateCompositeEntityModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulUpdateCompositeEntityModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateCompositeEntityModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateCompositeEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateCompositeEntityRoleRequest.json new file mode 100644 index 000000000000..7c67a750666e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateCompositeEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateCustomPrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateCustomPrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..371cf7985b42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateCustomPrebuiltEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateEntityRoleRequest.json new file mode 100644 index 000000000000..371cf7985b42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateHierarchicalEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateHierarchicalEntityRoleRequest.json new file mode 100644 index 000000000000..a01310ff22d0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateHierarchicalEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdatePatternAnyEntityExplicitListItemRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdatePatternAnyEntityExplicitListItemRequest.json new file mode 100644 index 000000000000..a051e8440744 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdatePatternAnyEntityExplicitListItemRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "itemId": 53435, + "item": { + "explicitListItem": "new item" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdatePatternAnyEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdatePatternAnyEntityRequest.json new file mode 100644 index 000000000000..5a281b463010 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdatePatternAnyEntityRequest.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "patternAnyUpdateObject": { + "name": "New Name", + "explicitList": [ + "item1", + "item2" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdatePatternAnyEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdatePatternAnyEntityRoleRequest.json new file mode 100644 index 000000000000..371cf7985b42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdatePatternAnyEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdatePrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdatePrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..371cf7985b42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdatePrebuiltEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateRegexEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateRegexEntityModelRequest.json new file mode 100644 index 000000000000..3965664be198 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateRegexEntityModelRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "regexEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "regexEntityUpdateObject": { + "name": "New Name", + "regexPattern": "[a-z]{3}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateRegexEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateRegexEntityRoleRequest.json new file mode 100644 index 000000000000..371cf7985b42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateRegexEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulUpdateSublistRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateSublistRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulUpdateSublistRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulUpdateSublistRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulAddPatternRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulAddPatternRequest.json new file mode 100644 index 000000000000..02d6253e0ee6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulAddPatternRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "pattern": { + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulBatchAddLabelsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulBatchAddLabelsRequest.json new file mode 100644 index 000000000000..4573664d1398 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulBatchAddLabelsRequest.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "2370fb9d-7dbc-4898-a361-a742cf290766", + "versionId": "0.1", + "patterns": [ + { + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + }, + { + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + } + ] + }, + "responses": { + "201": { + "headers": {}, + "body": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulDeletePatternRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulDeletePatternRequest.json new file mode 100644 index 000000000000..6deb92b648c7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulDeletePatternRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "patternId": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulDeletePatternsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulDeletePatternsRequest.json new file mode 100644 index 000000000000..e82704a8a12c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulDeletePatternsRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "patternIds": [ + "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "2126479d-2a98-4d06-a65e-b8799df2dd53" + ] + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulGetIntentPatternsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulGetIntentPatternsRequest.json new file mode 100644 index 000000000000..bc0592cabc13 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulGetIntentPatternsRequest.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "58077d3a-4bbb-47ba-8aa9-31c0ead0bf08", + "pattern": "who's reporting to {Name}?", + "intent": "report to" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulGetPatternsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulGetPatternsRequest.json new file mode 100644 index 000000000000..053c2ff78eb2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulGetPatternsRequest.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "58077d3a-4bbb-47ba-8aa9-31c0ead0bf08", + "pattern": "who's reporting to {Name}?", + "intent": "report to" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulUpdatePatternRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulUpdatePatternRequest.json new file mode 100644 index 000000000000..783ecc5bbb75 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulUpdatePatternRequest.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "patternId": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": { + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulUpdatePatternsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulUpdatePatternsRequest.json new file mode 100644 index 000000000000..9d9558c7d311 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/patterns/SuccessfulUpdatePatternsRequest.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "AzureRegion": "westus", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "patterns": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + } + ] + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/permissions/SuccessfulAddUserToAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/permissions/SuccessfulAddUserToAccessListRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/permissions/SuccessfulAddUserToAccessListRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/permissions/SuccessfulAddUserToAccessListRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/train/SuccessfulTrainApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/train/SuccessfulTrainApplicationVersionRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/train/SuccessfulTrainApplicationVersionRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/train/SuccessfulTrainApplicationVersionRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/user/SuccessfulResetUserProgrammaticKeyRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/user/SuccessfulResetUserProgrammaticKeyRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/user/SuccessfulResetUserProgrammaticKeyRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/user/SuccessfulResetUserProgrammaticKeyRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulCloneApplicatioVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulCloneApplicatioVersionRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulCloneApplicatioVersionRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulCloneApplicatioVersionRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulDeleteApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulDeleteApplicationVersionRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulDeleteApplicationVersionRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulDeleteApplicationVersionRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulExportApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulExportApplicationVersionRequest.json similarity index 85% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulExportApplicationVersionRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulExportApplicationVersionRequest.json index 7ad31c9833ac..cde1bdabb9df 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulExportApplicationVersionRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulExportApplicationVersionRequest.json @@ -10,12 +10,19 @@ "headers": { }, "body": { - "luis_schema_version": "2.1.0", + "luis_schema_version": "3.0.0", "versionId": "0.1", "name": "LuisBot", "desc": "", "culture": "en-us", "intents": [ + { + "name": "HomeAutomation.TurnOff", + "inherits": { + "domain_name": "HomeAutomation", + "model_name": "TurnOff" + } + }, { "name": "dateintent" }, @@ -34,17 +41,44 @@ ], "entities": [ { - "name": "AirportCode" + "name": "AirportCode", + "roles": [ + "destination" + ] }, { - "name": "Hotel" + "name": "Hotel", + "roles": [] } ], "composites": [], "closedLists": [], - "bing_entities": [ - "datetimeV2", - "geography" + "patternAnyEntities": [ + { + "name": "patternAny1", + "explicitList": [], + "roles": [ + "role1", + "role2" + ] + } + ], + "regex_entities": [ + { + "name": "regex1", + "regexPattern": "[^a]+", + "roles": [ + "regex role" + ] + } + ], + "prebuiltEntities": [ + { + "name": "datetimeV2", + "roles": [ + "datetime role" + ] + } ], "model_features": [ { @@ -67,6 +101,12 @@ "activated": true } ], + "patterns": [ + { + "pattern": "this is [a test] {patternAny1:role1}", + "intent": "Help" + } + ], "utterances": [ { "text": "i need help", diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulGetApplicationVersionInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulGetApplicationVersionInfoRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulGetApplicationVersionInfoRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulGetApplicationVersionInfoRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulImportApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulImportApplicationVersionRequest.json similarity index 84% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulImportApplicationVersionRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulImportApplicationVersionRequest.json index 22342165c31e..5c48cf56f0aa 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulImportApplicationVersionRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulImportApplicationVersionRequest.json @@ -5,12 +5,19 @@ "appId": "bd72e8d7-62b8-48f5-9dcb-e3b0588b803a", "versionId": "0.2", "luisApp": { - "luis_schema_version": "2.1.0", + "luis_schema_version": "3.0.0", "versionId": "0.1", "name": "LuisBot", "desc": "", "culture": "en-us", "intents": [ + { + "name": "HomeAutomation.TurnOff", + "inherits": { + "domain_name": "HomeAutomation", + "model_name": "TurnOff" + } + }, { "name": "dateintent" }, @@ -29,17 +36,44 @@ ], "entities": [ { - "name": "AirportCode" + "name": "AirportCode", + "roles": [ + "destination" + ] }, { - "name": "Hotel" + "name": "Hotel", + "roles": [] } ], "composites": [], "closedLists": [], - "bing_entities": [ - "datetimeV2", - "geography" + "patternAnyEntities": [ + { + "name": "patternAny1", + "explicitList": [], + "roles": [ + "role1", + "role2" + ] + } + ], + "regex_entities": [ + { + "name": "regex1", + "regexPattern": "[^a]+", + "roles": [ + "regex role" + ] + } + ], + "prebuiltEntities": [ + { + "name": "datetimeV2", + "roles": [ + "datetime role" + ] + } ], "model_features": [ { @@ -62,6 +96,12 @@ "activated": true } ], + "patterns": [ + { + "pattern": "this is [a test] {patternAny1:role1}", + "intent": "Help" + } + ], "utterances": [ { "text": "i need help", @@ -260,7 +300,7 @@ "responses": { "201": { "headers": { - "Location": "https://api.luis.ai/api/v2.0/bd72e8d7-62b8-48f5-9dcb-e3b0588b803a/versions/0.2" + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/bd72e8d7-62b8-48f5-9dcb-e3b0588b803a/versions/0.2" }, "body": "0.2" } diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulRenameApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulRenameApplicationVersionRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/versions/SuccessfulRenameApplicationVersionRequest.json rename to specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulRenameApplicationVersionRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/readme.md b/specification/cognitiveservices/data-plane/LUIS/Programmatic/readme.md deleted file mode 100644 index 760c71c9a608..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/readme.md +++ /dev/null @@ -1,119 +0,0 @@ -# Cognitive Services LUIS SDKs - -> see https://aka.ms/autorest - -Configuration for generating LUIS Programmatic SDK. - -``` yaml -tag: programmatic_2_0 -add-credentials: true -openapi-type: data-plane -``` - -The current release for the Programmatic Endpoint is `programmatic_2_0`. - -# Releases - -## Programmatic 2.0 -These settings apply only when `--tag=programmatic_2_0` is specified on the command line. - -``` yaml $(tag) == 'programmatic_2_0' -input-file: stable/v2.0/LUIS-Programmatic.json -``` - -Deprecated Pattern's Operations - -``` yaml $(tag) == 'programmatic_2_0' -directive: - - reason: Deprecated - remove-operation: Features_GetApplicationVersionPatternFeatures - - reason: Deprecated - remove-operation: Features_CreatePatternFeature - - reason: Deprecated - remove-operation: Features_GetPatternFeatureInfo - - reason: Deprecated - remove-operation: Features_UpdatePatternFeature - - reason: Deprecated - remove-operation: Features_DeletePatternFeature -``` - -AutoRest-Linter Suppressions - -``` yaml -# Ignore autorest-linter issues that cannot be resolve without updates to the API implementation -directive: - - suppress: DeleteMustNotHaveRequestBody - reason: Body is used to specify entity to delete - - suppress: DefinitionsPropertiesNamesCamelCase - reason: Changing casing will break existing clients/consumers -``` - ---- -# 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-go -``` - -### Programmatic 2.0 - CSharp Settings -These settings apply only when `--csharp` is specified on the command line. -``` yaml $(csharp) -csharp: - override-client-name: LuisProgrammaticAPI - sync-methods: None - license-header: MICROSOFT_MIT_NO_VERSION - azure-arm: false - namespace: Microsoft.Azure.CognitiveServices.Language.LUIS.Programmatic - output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Language/LUIS/Programmatic/Generated - clear-output-folder: true -``` - -## Go - -These settings apply only when `--go` is specified on the command line. - -``` yaml $(go) -go: - license-header: MICROSOFT_APACHE_NO_VERSION - namespace: programmatic - clear-output-folder: true -``` - -### Go multi-api - -``` yaml $(go) && $(multiapi) -batch: - - tag: programmatic_2_0 -``` - -### Tag: programmatic_2_0 and go - -These settings apply only when `--tag=programmatic_2_0 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'programmatic_2_0' && $(go) -output-folder: $(go-sdk-folder)/services/cognitiveservices/v2.0/luis/programmatic -``` - - -## 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 - fluent: true - namespace: com.microsoft.azure.cognitiveservices.luis.programmatic - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-cognitiveservices/luis/programmatic -``` diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/LUIS-Programmatic.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/LUIS-Programmatic.json deleted file mode 100644 index 68fa3053acc0..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/LUIS-Programmatic.json +++ /dev/null @@ -1,6498 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "LUIS Programmatic API", - "version": "v2.0" - }, - "x-ms-parameterized-host": { - "hostTemplate": "{AzureRegion}.api.cognitive.microsoft.com", - "parameters": [ - { - "$ref": "../../../../Common/ExtendedRegions.json#/parameters/AzureRegion" - } - ] - }, - "basePath": "/luis/api/v2.0", - "schemes": [ - "https" - ], - "securityDefinitions": { - "apiKeyHeader": { - "type": "apiKey", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } - }, - "security": [ - { - "apiKeyHeader": [] - } - ], - "paths": { - "/apps/{appId}/versions/{versionId}/patterns": { - "post": { - "description": "[DEPRECATED NOTICE: This operation will soon be removed] Creates a new pattern feature.", - "operationId": "Features_CreatePatternFeature", - "deprecated": true, - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "patternCreateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PatternCreateObject" - }, - "description": "The Name and Pattern of the feature." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the created feature.", - "schema": { - "$ref": "#/definitions/FeatureIDResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Create Pattern Feature request": { - "$ref": "./examples/features/SuccessfulCreatePatternFeatureRequest.json" - } - } - }, - "get": { - "description": "[DEPRECATED NOTICE: This operation will soon be removed] Gets all the pattern features.", - "operationId": "Features_GetApplicationVersionPatternFeatures", - "deprecated": true, - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/SkipInPath" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "A list of pattern features.", - "schema": { - "$ref": "#/definitions/PatternFeatureInfoList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Version Pattern Features request": { - "$ref": "./examples/features/SuccessfulGetApplicationVersionPatternFeaturesRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/phraselists": { - "post": { - "description": "Creates a new phraselist feature.", - "operationId": "Features_AddPhraseList", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "phraselistCreateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PhraselistCreateObject" - }, - "description": "A Phraselist object containing Name, comma-separated Phrases and the isExchangeable boolean. Default value for isExchangeable is true." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the created feature.", - "schema": { - "$ref": "#/definitions/FeatureIDResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Create Phraselist Feature request": { - "$ref": "./examples/features/SuccessfulCreatePhraselistFeatureRequest.json" - } - } - }, - "get": { - "description": "Gets all the phraselist features.", - "operationId": "Features_ListPhraseLists", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/SkipInPath" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "A list of all phraselist features.", - "schema": { - "$ref": "#/definitions/PhraseListFeatureInfoList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Version Phraselist Features request": { - "$ref": "./examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/features": { - "get": { - "description": "Gets all the extraction features for the specified application version.", - "operationId": "Features_List", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/SkipInPath" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "A list of all phraselist features and a list of all pattern features.", - "schema": { - "$ref": "#/definitions/FeaturesResponseObject" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Version Features request": { - "$ref": "./examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/patterns/{patternId}": { - "get": { - "description": "[DEPRECATED NOTICE: This operation will soon be removed] Gets the specified pattern feature's info.", - "operationId": "Features_GetPatternFeatureInfo", - "deprecated": true, - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "patternId", - "in": "path", - "description": "The pattern feature ID.", - "required": true, - "type": "integer" - } - ], - "responses": { - "200": { - "description": "The pattern feature info.", - "schema": { - "$ref": "#/definitions/PatternFeatureInfo" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Pattern Feature Info request": { - "$ref": "./examples/features/SuccessfulGetPatternFeatureInfoRequest.json" - } - } - }, - "put": { - "description": "[DEPRECATED NOTICE: This operation will soon be removed] Updates the pattern, the name and the state of the pattern feature.", - "operationId": "Features_UpdatePatternFeature", - "deprecated": true, - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "patternId", - "in": "path", - "description": "The pattern feature ID.", - "required": true, - "type": "integer" - }, - { - "name": "patternUpdateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PatternUpdateObject" - }, - "description": "The new values for: - Just a boolean called IsActive, in which case the status of the feature will be changed. - Name, Pattern and a boolean called IsActive to update the feature." - } - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Update Pattern Feature Info request": { - "$ref": "./examples/features/SuccessfulUpdatePatternFeatureInfoRequest.json" - } - } - }, - "delete": { - "description": "[DEPRECATED NOTICE: This operation will soon be removed] Deletes a pattern feature.", - "operationId": "Features_DeletePatternFeature", - "deprecated": true, - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "patternId", - "in": "path", - "description": "The pattern feature ID.", - "required": true, - "type": "integer" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Delete Pattern Feature Info request": { - "$ref": "./examples/features/SuccessfulDeletePatternFeatureInfoRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/phraselists/{phraselistId}": { - "get": { - "description": "Gets phraselist feature info.", - "operationId": "Features_GetPhraseList", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "phraselistId", - "in": "path", - "description": "The ID of the feature to be retrieved.", - "required": true, - "type": "integer" - } - ], - "responses": { - "200": { - "description": "A phraselist feature info.", - "schema": { - "$ref": "#/definitions/PhraseListFeatureInfo" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Phraselist Feature Info request": { - "$ref": "./examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json" - } - } - }, - "put": { - "description": "Updates the phrases, the state and the name of the phraselist feature.", - "operationId": "Features_UpdatePhraseList", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "phraselistId", - "in": "path", - "description": "The ID of the feature to be updated.", - "required": true, - "type": "integer" - }, - { - "name": "phraselistUpdateObject", - "in": "body", - "schema": { - "$ref": "#/definitions/PhraselistUpdateObject" - }, - "description": "The new values for: - Just a boolean called IsActive, in which case the status of the feature will be changed. - Name, Pattern, Mode, and a boolean called IsActive to update the feature." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "200": { - "description": "Successfully updated phraselist.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Update Phraselist Feature Info request": { - "$ref": "./examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json" - } - } - }, - "delete": { - "description": "Deletes a phraselist feature.", - "operationId": "Features_DeletePhraseList", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "phraselistId", - "in": "path", - "description": "The ID of the feature to be deleted.", - "required": true, - "type": "integer" - } - ], - "responses": { - "200": { - "description": "Successfully deleted phraselist.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Delete Phraselist Feature Info request": { - "$ref": "./examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/example": { - "post": { - "description": "Adds a labeled example to the application.", - "operationId": "Examples_Add", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "exampleLabelObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ExampleLabelObject" - }, - "description": "An example label with the expected intent and entities." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the created example.", - "schema": { - "$ref": "#/definitions/LabelExampleResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Add Label request": { - "$ref": "./examples/examples/SuccessfulAddLabelRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/examples": { - "post": { - "description": "Adds a batch of labeled examples to the application.", - "operationId": "Examples_Batch", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "exampleLabelObjectArray", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ExampleLabelObjectArray" - }, - "description": "Array of examples." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "A string array determining which labels were added successfully.", - "schema": { - "$ref": "#/definitions/BatchLabelExampleResponse" - } - }, - "207": { - "description": "Indicates that the request was partially successful. The response contains a string array indicating the status of each of the added labels.", - "schema": { - "$ref": "#/definitions/BatchLabelExampleResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Batch Add Labels request": { - "$ref": "./examples/examples/SuccessfulBatchAddLabelsRequest.json" - } - } - }, - "get": { - "description": "Returns examples to be reviewed.", - "operationId": "Examples_List", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/SkipInPath" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "A list of predictions and label pairs for every example in the application.", - "schema": { - "$ref": "#/definitions/LabeledUtterances" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Review Labeled Examples request": { - "$ref": "./examples/examples/SuccessfulReviewLabeledExamplesRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/examples/{exampleId}": { - "delete": { - "description": "Deletes the labeled example with the specified ID.", - "operationId": "Examples_Delete", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "exampleId", - "in": "path", - "description": "The example ID.", - "required": true, - "type": "integer" - } - ], - "responses": { - "200": { - "description": "Successfully deleted example label.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Delete Example Label request": { - "$ref": "./examples/examples/SuccessfulDeleteExampleLabelRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/intents": { - "post": { - "description": "Adds an intent classifier to the application.", - "operationId": "Model_AddIntent", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "intentCreateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ModelCreateObject" - }, - "description": "A model object containing the name of the new intent classifier." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the created model.", - "x-nullable": false, - "schema": { - "$ref": "#/definitions/GuidResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Create Intent Classifier request": { - "$ref": "./examples/model/SuccessfulCreateIntentClassifierRequest.json" - } - } - }, - "get": { - "description": "Gets information about the intent models.", - "operationId": "Model_ListIntents", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/SkipInPath" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "A list of intent model infos.", - "schema": { - "$ref": "#/definitions/IntentClassifiersList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Version Intent Infos request": { - "$ref": "./examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/entities": { - "post": { - "description": "Adds an entity extractor to the application.", - "operationId": "Model_AddEntity", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "modelCreateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ModelCreateObject" - }, - "description": "A model object containing the name for the new entity extractor." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the created model.", - "x-nullable": false, - "schema": { - "$ref": "#/definitions/GuidResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Create Entity Extractor request": { - "$ref": "./examples/model/SuccessfulCreateEntityExtractorRequest.json" - } - } - }, - "get": { - "description": "Gets information about the entity models.", - "operationId": "Model_ListEntities", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/SkipInPath" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "A list of entity model infos.", - "schema": { - "$ref": "#/definitions/EntityExtractorsList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Version Entity Infos request": { - "$ref": "./examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/hierarchicalentities": { - "post": { - "description": "Adds a hierarchical entity extractor to the application version.", - "operationId": "Model_AddHierarchicalEntity", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "hierarchicalModelCreateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/HierarchicalEntityModel" - }, - "description": "A model containing the name and children of the new entity extractor." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the created model.", - "x-nullable": false, - "schema": { - "$ref": "#/definitions/GuidResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Create Hierarchical Entity Extractor request": { - "$ref": "./examples/model/SuccessfulCreateHierarchicalEntityExtractorRequest.json" - } - } - }, - "get": { - "description": "Gets information about the hierarchical entity models.", - "operationId": "Model_ListHierarchicalEntities", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/SkipInPath" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "A list of hierarchical entity model infos.", - "schema": { - "$ref": "#/definitions/HierarchicalEntityExtractorsList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Version Hierarchical Entity Infos request": { - "$ref": "./examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/compositeentities": { - "post": { - "description": "Adds a composite entity extractor to the application.", - "operationId": "Model_AddCompositeEntity", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "compositeModelCreateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CompositeEntityModel" - }, - "description": "A model containing the name and children of the new entity extractor." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the created Model.", - "x-nullable": false, - "schema": { - "$ref": "#/definitions/GuidResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Create Composite Entity Extractor": { - "$ref": "./examples/model/SuccessfulCreateCompositeEntityExtractorRequest.json" - } - } - }, - "get": { - "description": "Gets information about the composite entity models.", - "operationId": "Model_ListCompositeEntities", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/SkipInPath" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "A list of composite entity model infos.", - "schema": { - "$ref": "#/definitions/CompositeEntityExtractorsList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Version Composite Entity Infos request": { - "$ref": "./examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/closedlists": { - "get": { - "description": "Gets information about the closedlist models.", - "operationId": "Model_ListClosedLists", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/SkipInPath" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "A list of closedlist entity model infos.", - "schema": { - "$ref": "#/definitions/ClosedListEntityExtractorsList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Version Closed List Infos request": { - "$ref": "./examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json" - } - } - }, - "post": { - "description": "Adds a closed list model to the application.", - "operationId": "Model_AddClosedList", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "closedListModelCreateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClosedListModelCreateObject" - }, - "description": "A model containing the name and words for the new closed list entity extractor." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the created model.", - "x-nullable": false, - "schema": { - "$ref": "#/definitions/GuidResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Create Closed List Entity Model request": { - "$ref": "./examples/model/SuccessfulCreateClosedListEntityModelRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/prebuilts": { - "post": { - "description": "Adds a list of prebuilt entity extractors to the application.", - "operationId": "Model_AddPrebuilt", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "prebuiltExtractorNames", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PrebuiltExtractorNames" - }, - "description": "An array of prebuilt entity extractor names." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "An array of the created prebuilt extractor infos.", - "schema": { - "$ref": "#/definitions/PrebuiltEntityExtractorsList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Add Application Version Prebuilt Infos request": { - "$ref": "./examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json" - } - } - }, - "get": { - "description": "Gets information about the prebuilt entity models.", - "operationId": "Model_ListPrebuilts", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/SkipInPath" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "A list of prebuilt entity models infos.", - "schema": { - "$ref": "#/definitions/PrebuiltEntityExtractorsList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Version Prebuilt Infos request": { - "$ref": "./examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/listprebuilts": { - "get": { - "description": "Gets all the available prebuilt entity extractors for the application.", - "operationId": "Model_ListPrebuiltEntities", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - } - ], - "responses": { - "200": { - "description": "A list of the possible prebuilt entity extractors.", - "schema": { - "$ref": "#/definitions/AvailablePrebuiltEntityModels" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Available Prebuilt Entity Extractors request": { - "$ref": "./examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/models": { - "get": { - "description": "Gets information about the application version models.", - "operationId": "Model_ListModels", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/SkipInPath" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "A list of application model infos.", - "schema": { - "$ref": "#/definitions/ModelsInfoResponseObject" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Version Model Infos request": { - "$ref": "./examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/intents/{intentId}": { - "get": { - "description": "Gets information about the intent model.", - "operationId": "Model_GetIntent", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/IntentIdInPath" - } - ], - "responses": { - "200": { - "description": "An intent model info.", - "schema": { - "$ref": "#/definitions/IntentClassifier" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Intent Info request": { - "$ref": "./examples/model/SuccessfulGetIntentInfoRequest.json" - } - } - }, - "put": { - "description": "Updates the name of an intent classifier.", - "operationId": "Model_UpdateIntent", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/IntentIdInPath" - }, - { - "name": "modelUpdateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ModelUpdateObject" - }, - "description": "A model object containing the new intent classifier name." - } - ], - "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 Rename Intent Model request": { - "$ref": "./examples/model/SuccessfulRenameIntentModelRequest.json" - } - } - }, - "delete": { - "description": "Deletes an intent classifier from the application.", - "operationId": "Model_DeleteIntent", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/IntentIdInPath" - }, - { - "name": "deleteUtterances", - "in": "query", - "type": "boolean", - "description": "Also delete the intent's utterances (true). Or move the utterances to the None intent (false - the default value).", - "default": false - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Delete Intent Model request": { - "$ref": "./examples/model/SuccessfulDeleteIntentModelRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/entities/{entityId}": { - "get": { - "description": "Gets information about the entity model.", - "operationId": "Model_GetEntity", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "entityId", - "in": "path", - "description": "The entity extractor ID.", - "required": true, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "An entity model info.", - "schema": { - "$ref": "#/definitions/EntityExtractor" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Entity Info request": { - "$ref": "./examples/model/SuccessfulGetEntityInfoRequest.json" - } - } - }, - "put": { - "description": "Updates the name of an entity extractor.", - "operationId": "Model_UpdateEntity", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "entityId", - "in": "path", - "description": "The entity extractor ID.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "name": "modelUpdateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ModelUpdateObject" - }, - "description": "A model object containing the new entity extractor name." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "200": { - "description": "Successfully updated entity extractor name.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Rename Entity Info request": { - "$ref": "./examples/model/SuccessfulRenameEntityExtractorRequest.json" - } - } - }, - "delete": { - "description": "Deletes an entity extractor from the application.", - "operationId": "Model_DeleteEntity", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "entityId", - "in": "path", - "description": "The entity extractor ID.", - "required": true, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "Successfully deleted entity.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Delete Entity Info request": { - "$ref": "./examples/model/SuccessfulDeleteEntityExtractorRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}": { - "get": { - "description": "Gets information about the hierarchical entity model.", - "operationId": "Model_GetHierarchicalEntity", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/HEntityIdInPath" - } - ], - "responses": { - "200": { - "description": "A hierarchical entity model info.", - "schema": { - "$ref": "#/definitions/HierarchicalEntityExtractor" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Hierarchical Entity Info request": { - "$ref": "./examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json" - } - } - }, - "put": { - "description": "Updates the name and children of a hierarchical entity model.", - "operationId": "Model_UpdateHierarchicalEntity", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/HEntityIdInPath" - }, - { - "name": "hierarchicalModelUpdateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/HierarchicalEntityModel" - }, - "description": "Model containing names of the children of the hierarchical entity." - } - ], - "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 Get Hierarchical Entity Info request": { - "$ref": "./examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json" - } - } - }, - "delete": { - "description": "Deletes a hierarchical entity extractor from the application version.", - "operationId": "Model_DeleteHierarchicalEntity", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/HEntityIdInPath" - } - ], - "responses": { - "200": { - "description": "Successfully deleted entity.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Delete Hierarchical Entity Model request": { - "$ref": "./examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}": { - "get": { - "description": "Gets information about the composite entity model.", - "operationId": "Model_GetCompositeEntity", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/CEntityIdInPath" - } - ], - "responses": { - "200": { - "description": "The composite entity model info.", - "schema": { - "$ref": "#/definitions/CompositeEntityExtractor" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Composite Entity Info request": { - "$ref": "./examples/model/SuccessfulGetCompositeEntityInfoRequest.json" - } - } - }, - "put": { - "description": "Updates the composite entity extractor.", - "operationId": "Model_UpdateCompositeEntity", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/CEntityIdInPath" - }, - { - "name": "compositeModelUpdateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CompositeEntityModel" - }, - "description": "A model object containing the new entity extractor name and children." - } - ], - "consumes": [ - "application/json" - ], - "x-ms-examples": { - "Successful Update Composite Entity Extractor request": { - "$ref": "./examples/model/SuccessfulUpdateCompositeEntityModelRequest.json" - } - }, - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Successfully updated composite entity.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "description": "Deletes a composite entity extractor from the application.", - "operationId": "Model_DeleteCompositeEntity", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/CEntityIdInPath" - } - ], - "responses": { - "200": { - "description": "Successfully deleted composite entity.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Delete Entity Info request": { - "$ref": "./examples/model/SuccessfulDeleteCompositeEntityModelRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}": { - "get": { - "description": "Gets information of a closed list model.", - "operationId": "Model_GetClosedList", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "clEntityId", - "in": "path", - "description": "The closed list model ID.", - "required": true, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "The closed list model info.", - "schema": { - "$ref": "#/definitions/ClosedListEntityExtractor" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Closed List Entity Info request": { - "$ref": "./examples/model/SuccessfulGetClosedListEntityInfoRequest.json" - } - } - }, - "put": { - "description": "Updates the closed list model.", - "operationId": "Model_UpdateClosedList", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "clEntityId", - "in": "path", - "description": "The closed list model ID.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "name": "closedListModelUpdateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClosedListModelUpdateObject" - }, - "description": "The new entity name and words list." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "200": { - "description": "Successfully updated Closed List name and words list.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Update Closed List Entity Info request": { - "$ref": "./examples/model/SuccessfulUpdateClosedListEntityModelRequest.json" - } - } - }, - "patch": { - "description": "Adds a batch of sublists to an existing closedlist.", - "operationId": "Model_PatchClosedList", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "clEntityId", - "in": "path", - "description": "The closed list model ID.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "name": "closedListModelPatchObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClosedListModelPatchObject" - }, - "description": "A words list batch." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "200": { - "description": "Successfully added sublists to Closed List.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Add SubLists to Closed List Entity request": { - "$ref": "./examples/model/SuccessfulPatchClosedListEntityModelRequest.json" - } - } - }, - "delete": { - "description": "Deletes a closed list model from the application.", - "operationId": "Model_DeleteClosedList", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "clEntityId", - "in": "path", - "description": "The closed list model ID.", - "required": true, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "Successfully delete Closed List from application.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Delete Closed List Entity Info request": { - "$ref": "./examples/model/SuccessfulDeleteClosedListEntityModelRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/prebuilts/{prebuiltId}": { - "get": { - "description": "Gets information about the prebuilt entity model.", - "operationId": "Model_GetPrebuilt", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "prebuiltId", - "in": "path", - "description": "The prebuilt entity extractor ID.", - "required": true, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "A prebuilt entity models info.", - "schema": { - "$ref": "#/definitions/PrebuiltEntityExtractor" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Prebuilt Info request": { - "$ref": "./examples/model/SuccessfulGetPrebuiltInfoRequest.json" - } - } - }, - "delete": { - "description": "Deletes a prebuilt entity extractor from the application.", - "operationId": "Model_DeletePrebuilt", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "prebuiltId", - "in": "path", - "description": "The prebuilt entity extractor ID.", - "required": true, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Prebuilt Info request": { - "$ref": "./examples/model/SuccessfulDeletePrebuiltEntityRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists/{subListId}": { - "delete": { - "description": "Deletes a sublist of a specific closed list model.", - "operationId": "Model_DeleteSubList", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "clEntityId", - "in": "path", - "description": "The closed list entity extractor ID.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "name": "subListId", - "in": "path", - "description": "The sublist ID.", - "required": true, - "type": "integer" - } - ], - "responses": { - "200": { - "description": "Successfully deleted sublist.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Delete Sublist request": { - "$ref": "./examples/model/SuccessfulDeleteSublistRequest.json" - } - } - }, - "put": { - "description": "Updates one of the closed list's sublists.", - "operationId": "Model_UpdateSubList", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "clEntityId", - "in": "path", - "description": "The closed list entity extractor ID.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "name": "subListId", - "in": "path", - "description": "The sublist ID.", - "required": true, - "type": "integer" - }, - { - "name": "wordListBaseUpdateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WordListBaseUpdateObject" - }, - "description": "A sublist update object containing the new canonical form and the list of words." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "200": { - "description": "Successfully updated sublist.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Update Sublist request": { - "$ref": "./examples/model/SuccessfulUpdateSublistRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/intents/{intentId}/suggest": { - "get": { - "description": "Suggests examples that would improve the accuracy of the intent model.", - "operationId": "Model_GetIntentSuggestions", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/IntentIdInPath" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "If there's no trained model, nothing is returned in the response. If there's a trained model and the active learning algorithm finds any relevant queries, they are returned with the model predictions. If there's a trained model but the active learning algorithm didn't find any relevant queries, an empty list is returned in the response.", - "schema": { - "$ref": "#/definitions/IntentsSuggestionExamples" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Intents Suggestion Examples": { - "$ref": "./examples/model/SuccessfulGetIntentsSuggestionExamples.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/entities/{entityId}/suggest": { - "get": { - "description": "Get suggestion examples that would improve the accuracy of the entity model.", - "operationId": "Model_GetEntitySuggestions", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "entityId", - "in": "path", - "description": "The target entity extractor model to enhance.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "If there's no trained model, nothing is returned in the response. If there's a trained model and the active learning algorithm finds any relevant queries, they are returned with the model predictions. If there's a trained model but the active learning algorithm didn't find any relevant queries, an empty list is returned in the response.", - "schema": { - "$ref": "#/definitions/EntitiesSuggestionExamples" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Entity Suggestion Examples": { - "$ref": "./examples/model/SuccessfulGetEntitySuggestionExamples.json" - } - } - } - }, - "/apps/": { - "post": { - "description": "Creates a new LUIS app.", - "operationId": "Apps_Add", - "parameters": [ - { - "name": "applicationCreateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationCreateObject" - }, - "description": "A model containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is 0.1. Note: the culture cannot be changed after the app is created." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the created application.", - "x-nullable": false, - "schema": { - "$ref": "#/definitions/GuidResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Application Creation": { - "$ref": "./examples/apps/SuccessfulAddApplicationRequest.json" - } - } - }, - "get": { - "description": "Lists all of the user applications.", - "operationId": "Apps_List", - "parameters": [ - { - "$ref": "#/parameters/SkipInPath" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "A list of the user applications.", - "schema": { - "$ref": "#/definitions/ApplicationsInfoList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Applications List request": { - "$ref": "./examples/apps/SuccessfulGetApplicationsListRequest.json" - } - } - } - }, - "/apps/import": { - "post": { - "description": "Imports an application to LUIS, the application's structure should be included in in the request body.", - "operationId": "Apps_Import", - "parameters": [ - { - "name": "appName", - "in": "query", - "description": "The application name to create. If not specified, the application name will be read from the imported object.", - "type": "string" - }, - { - "name": "luisApp", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/LuisApp" - }, - "description": "A LUIS application structure." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the imported application.", - "x-nullable": false, - "schema": { - "$ref": "#/definitions/GuidResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Import Application": { - "$ref": "./examples/apps/SuccessfulImportApplicationRequest.json" - } - } - } - }, - "/apps/assistants": { - "get": { - "description": "Gets the endpoint URLs for the prebuilt Cortana applications.", - "operationId": "Apps_ListCortanaEndpoints", - "responses": { - "200": { - "description": "A personal assistant apps JSON object containing the endpoint URLs for Cortana applications and the user's endpoint keys.", - "schema": { - "$ref": "#/definitions/PersonalAssistantsResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Personal Assistant Applications": { - "$ref": "./examples/apps/SuccessfulGetPersonalAssistantApplications.json" - } - } - } - }, - "/apps/domains": { - "get": { - "description": "Gets the available application domains.", - "operationId": "Apps_ListDomains", - "responses": { - "200": { - "description": "A list object containing the available application domains.", - "schema": { - "$ref": "#/definitions/AvailableDomains" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Domains request": { - "$ref": "./examples/apps/SuccessfulGetApplicationDomainsRequest.json" - } - } - } - }, - "/apps/usagescenarios": { - "get": { - "description": "Gets the application available usage scenarios.", - "operationId": "Apps_ListUsageScenarios", - "responses": { - "200": { - "description": "A list object containing the available application usage scenarios.", - "schema": { - "$ref": "#/definitions/ApplicationUsageScenarios" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Usage Scenarios request": { - "$ref": "./examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json" - } - } - } - }, - "/apps/cultures": { - "get": { - "description": "Gets the supported application cultures.", - "operationId": "Apps_ListSupportedCultures", - "responses": { - "200": { - "description": "A list object containing the supported application cultures.", - "schema": { - "$ref": "#/definitions/AvailableCultures" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Cultures request": { - "$ref": "./examples/apps/SuccessfulGetApplicationCulturesRequest.json" - } - } - } - }, - "/apps/{appId}/querylogs": { - "get": { - "description": "Gets the query logs of the past month for the application.", - "operationId": "Apps_DownloadQueryLogs", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - } - ], - "responses": { - "200": { - "description": "A CSV file containing the query logs for the past month.", - "schema": { - "type": "object", - "format": "file", - "description": "The query logs of an application for the past month in CSV format." - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/octet-stream" - ], - "x-ms-examples": { - "Successful Download Application Query logs request": { - "$ref": "./examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json" - } - } - } - }, - "/apps/{appId}": { - "get": { - "description": "Gets the application info.", - "operationId": "Apps_Get", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - } - ], - "responses": { - "200": { - "description": "The application info.", - "schema": { - "$ref": "#/definitions/ApplicationInfoResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Info request": { - "$ref": "./examples/apps/SuccessfulGetApplicationInfoRequest.json" - } - } - }, - "put": { - "description": "Updates the name or description of the application.", - "operationId": "Apps_Update", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "name": "applicationUpdateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationUpdateObject" - }, - "description": "A model containing Name and Description of the application." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "200": { - "description": "Successfully updated application name and description.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Rename Application request": { - "$ref": "./examples/apps/SuccessfulRenameApplicationRequest.json" - } - } - }, - "delete": { - "description": "Deletes an application.", - "operationId": "Apps_Delete", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - } - ], - "responses": { - "200": { - "description": "Successfully deleted application.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Rename Application request": { - "$ref": "./examples/apps/SuccessfulDeleteApplicationRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/clone": { - "post": { - "description": "Creates a new version using the current snapshot of the selected application version.", - "operationId": "Versions_Clone", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "versionCloneObject", - "in": "body", - "schema": { - "$ref": "#/definitions/TaskUpdateObject" - }, - "description": "A model containing the new version ID." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The version ID of the created task.", - "schema": { - "type": "string", - "example": "0.2" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Clone Application Version request": { - "$ref": "./examples/versions/SuccessfulCloneApplicatioVersionRequest.json" - } - } - } - }, - "/apps/{appId}/publish": { - "post": { - "description": "Publishes a specific version of the application.", - "operationId": "Apps_Publish", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "name": "applicationPublishObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationPublishObject" - }, - "description": "The application publish object. The region is the target region that the application is published to." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "An object containing the application endpoint URL and its assigned endpoint key.", - "schema": { - "$ref": "#/definitions/ProductionOrStagingEndpointInfo" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Publish Application request": { - "$ref": "./examples/apps/SuccessfulPublishApplicationRequest.json" - } - } - } - }, - "/apps/{appId}/versions": { - "get": { - "description": "Gets the application versions info.", - "operationId": "Versions_List", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/SkipInPath" - }, - { - "$ref": "#/parameters/TakeInPath" - } - ], - "responses": { - "200": { - "description": "A list of all versions of the application.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VersionInfo" - } - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Versions info request": { - "$ref": "./examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/": { - "get": { - "description": "Gets the version info.", - "operationId": "Versions_Get", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - } - ], - "responses": { - "200": { - "description": "A model containing the version info.", - "schema": { - "$ref": "#/definitions/VersionInfo" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Version info request": { - "$ref": "./examples/versions/SuccessfulGetApplicationVersionInfoRequest.json" - } - } - }, - "put": { - "description": "Updates the name or description of the application version.", - "operationId": "Versions_Update", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "versionUpdateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TaskUpdateObject" - }, - "description": "A model containing Name and Description of the application." - } - ], - "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 Rename Application Version request": { - "$ref": "./examples/versions/SuccessfulRenameApplicationVersionRequest.json" - } - } - }, - "delete": { - "description": "Deletes an application version.", - "operationId": "Versions_Delete", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Delete Application Version request": { - "$ref": "./examples/versions/SuccessfulDeleteApplicationVersionRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/export": { - "get": { - "description": "Exports a LUIS application to JSON format.", - "operationId": "Versions_Export", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - } - ], - "responses": { - "200": { - "schema": { - "$ref": "#/definitions/LuisApp" - }, - "description": "The LUIS application structure in JSON format." - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Export Application Version": { - "$ref": "./examples/versions/SuccessfulExportApplicationVersionRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/train": { - "post": { - "description": "Sends a training request for a version of a specified LUIS app. This POST request initiates a request asynchronously. To determine whether the training request is successful, submit a GET request to get training status. Note: The application version is not fully trained unless all the models (intents and entities) are trained successfully or are up to date. To verify training success, get the training status at least once after training is complete.", - "operationId": "Train_TrainVersion", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - } - ], - "responses": { - "202": { - "description": "This response indicates the initial training status.", - "schema": { - "$ref": "#/definitions/EnqueueTrainingResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Train Application Version request": { - "$ref": "./examples/train/SuccessfulTrainApplicationVersionRequest.json" - } - } - }, - "get": { - "description": "Gets the training status of all models (intents and entities) for the specified LUIS app. You must call the train API to train the LUIS app before you call this API to get training status. \"appID\" specifies the LUIS app ID. \"versionId\" specifies the version number of the LUIS app. For example, \"0.1\".", - "operationId": "Train_GetStatus", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - } - ], - "responses": { - "200": { - "description": "A successful response provides an array of training status details for a LUIS app that you submitted for training. Each element in the response array provides training status for a model (intent or entity) in the LUIS app. Note: Training status is not provided for prebuilt entities because they are pretrained. The \"modelId\" property identifies which intent or entity the training status corresponds to. To get the name and type of each model, use the models API which has a request URL in this format: https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/{appId}/versions/{versionId}/models The details property for each model can contain the following fields: \"statusId\": An integer from 0 to 3 that corresponds to the value of the status field. \"status\": A string with one of the following values: “Success”, “UpToDate”, “InProgress”, “Fail”. If the status is “Fail”, the \"failureReason\" property provides the reason for failure. \"exampleCount\": The number of examples used for training. In the case of the None intent or prebuilt domain intents and entities, this number includes example provided internally by the system as well as examples you added to your LUIS app. \"failureReason\": A string that indicates the reason training failed. The value \"FewLabels\" means that no labeled examples were provided for training. \"trainingDateTime\": A string indicating the time the model was last trained. The value uses the ISO 8601 format for representing times in UTC (Coordinated Universal Time) with a UTC designator (“Z”), for example: \"2017-08-10T01:08:34Z\".", - "schema": { - "$ref": "#/definitions/ModelTrainingInfoList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json", - "JSON" - ], - "x-ms-examples": { - "Successful Get Application Version Training Status request": { - "$ref": "./examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json" - } - } - } - }, - "/apps/{appId}/versions/import": { - "post": { - "description": "Imports a new version into a LUIS application.", - "operationId": "Versions_Import", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "name": "versionId", - "in": "query", - "description": "The new versionId to import. If not specified, the versionId will be read from the imported object.", - "type": "string" - }, - { - "name": "luisApp", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/LuisApp" - }, - "description": "A LUIS application structure." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The created application version.", - "schema": { - "$ref": "#/definitions/VersionResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Import Application": { - "$ref": "./examples/versions/SuccessfulImportApplicationVersionRequest.json" - } - } - } - }, - "/apps/{appId}/settings": { - "get": { - "description": "Get the application settings.", - "operationId": "Apps_GetSettings", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - } - ], - "responses": { - "200": { - "description": "The application settings.", - "schema": { - "$ref": "#/definitions/ApplicationSettings" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application Settings request": { - "$ref": "./examples/apps/SuccessfulGetApplicationSettingsRequest.json" - } - } - }, - "put": { - "description": "Updates the application settings.", - "operationId": "Apps_UpdateSettings", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "name": "applicationSettingUpdateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationSettingUpdateObject" - }, - "description": "An object containing the new application settings." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "200": { - "description": "Successfully updated application settings.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Update Application Settings request": { - "$ref": "./examples/apps/SuccessfulUpdateApplicationSettingsRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/suggest": { - "delete": { - "description": "Deleted an unlabelled utterance.", - "operationId": "Versions_DeleteUnlabelledUtterance", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "utterance", - "in": "body", - "required": true, - "schema": { - "type": "string" - }, - "description": "The utterance text to delete." - } - ], - "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 Delete Unlabelled Utterance": { - "$ref": "./examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json" - } - } - } - }, - "/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 users access list with the one 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's 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.", - "operationId": "Apps_ListEndpoints", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - } - ], - "responses": { - "200": { - "description": "Returns a list of endpoints regions and their corresponding endpoint URL.", - "schema": { - "$ref": "#/definitions/AvailableEndpoints" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Endpoints request": { - "$ref": "./examples/apps/SuccessfulGetEndpointsRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists": { - "post": { - "description": "Adds a list to an existing closed list.", - "operationId": "Model_AddSubList", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "clEntityId", - "in": "path", - "description": "The closed list entity extractor ID.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "name": "wordListCreateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WordListObject" - }, - "description": "Words list." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the newly created list.", - "schema": { - "type": "integer", - "example": 90440 - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Add Sublist request": { - "$ref": "./examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/customprebuiltdomains": { - "post": { - "description": "Adds a customizable prebuilt domain along with all of its models to this application.", - "operationId": "Model_AddCustomPrebuiltDomain", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "prebuiltDomainObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PrebuiltDomainCreateBaseObject" - }, - "description": "A prebuilt domain create object containing the name of the domain." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "An array of the created custom prebuilt domain model Ids.", - "schema": { - "$ref": "#/definitions/GuidList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Add Custom Prebuilt Domain to Application request": { - "$ref": "./examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/customprebuiltintents": { - "post": { - "description": "Adds a custom prebuilt intent model to the application.", - "operationId": "Model_AddCustomPrebuiltIntent", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "prebuiltDomainModelCreateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PrebuiltDomainModelCreateObject" - }, - "description": "A model object containing the name of the custom prebuilt intent and the name of the domain to which this model belongs." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the created model.", - "x-nullable": false, - "schema": { - "$ref": "#/definitions/GuidResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Add Custom Prebuilt Intent request": { - "$ref": "./examples/model/SuccessfulAddCustomPrebuildIntentRequest.json" - } - } - }, - "get": { - "description": "Gets custom prebuilt intents information of this application.", - "operationId": "Model_ListCustomPrebuiltIntents", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - } - ], - "responses": { - "200": { - "description": "Returns a list of all custom prebuilt intents and their representations.", - "schema": { - "$ref": "#/definitions/IntentClassifiersList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Custom Prebuilt Intent request": { - "$ref": "./examples/model/SuccessfulGetCustomPrebuildIntentRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/customprebuiltentities": { - "post": { - "description": "Adds a custom prebuilt entity model to the application.", - "operationId": "Model_AddCustomPrebuiltEntity", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "prebuiltDomainModelCreateObject", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PrebuiltDomainModelCreateObject" - }, - "description": "A model object containing the name of the custom prebuilt entity and the name of the domain to which this model belongs." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the created model.", - "x-nullable": false, - "schema": { - "$ref": "#/definitions/GuidResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Add Custom Prebuilt Entity request": { - "$ref": "./examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json" - } - } - }, - "get": { - "description": "Gets all custom prebuilt entities information of this application.", - "operationId": "Model_ListCustomPrebuiltEntities", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - } - ], - "responses": { - "200": { - "description": "Returns a list of all custom prebuilt entities and their representations.", - "schema": { - "$ref": "#/definitions/EntityExtractorsList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Custom Prebuilt Domain Entities request": { - "$ref": "./examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/customprebuiltmodels": { - "get": { - "description": "Gets all custom prebuilt models information of this application.", - "operationId": "Model_ListCustomPrebuiltModels", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - } - ], - "responses": { - "200": { - "description": "Returns a list of all custom prebuilt models and their representations.", - "schema": { - "$ref": "#/definitions/CustomPrebuiltModelList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Custom Prebuilt Domain Models request": { - "$ref": "./examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/customprebuiltdomains/{domainName}": { - "delete": { - "description": "Deletes a prebuilt domain's models from the application.", - "operationId": "Model_DeleteCustomPrebuiltDomain", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "name": "domainName", - "in": "path", - "description": "Domain name.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Successful operation.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Delete Prebuilt Domain from Application request": { - "$ref": "./examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json" - } - } - } - }, - "/apps/customprebuiltdomains": { - "get": { - "description": "Gets all the available custom prebuilt domains for all cultures.", - "operationId": "Apps_ListAvailableCustomPrebuiltDomains", - "responses": { - "200": { - "description": "Returns a list of all custom prebuilt domains and their intents/entities representation.", - "schema": { - "$ref": "#/definitions/PrebuiltDomainsList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Available Custom Prebuilt Domains request": { - "$ref": "./examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json" - } - } - }, - "post": { - "description": "Adds a prebuilt domain along with its models as a new application.", - "operationId": "Apps_AddCustomPrebuiltDomain", - "parameters": [ - { - "name": "prebuiltDomainCreateObject", - "in": "body", - "required": true, - "description": "A prebuilt domain create object containing the name and culture of the domain.", - "schema": { - "$ref": "#/definitions/PrebuiltDomainCreateObject" - } - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the created application.", - "x-nullable": false, - "schema": { - "$ref": "#/definitions/GuidResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Add Custom Prebuilt Application request": { - "$ref": "./examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json" - } - } - } - }, - "/apps/customprebuiltdomains/{culture}": { - "get": { - "description": "Gets all the available custom prebuilt domains for a specific culture.", - "operationId": "Apps_ListAvailableCustomPrebuiltDomainsForCulture", - "parameters": [ - { - "name": "culture", - "in": "path", - "description": "Culture.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Returns a list of all domains and their intents/entities representation for a specific culture.", - "schema": { - "$ref": "#/definitions/PrebuiltDomainsList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get AvailableCustomPrebuiltDomainsForCulture request": { - "$ref": "./examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children/{hChildId}": { - "get": { - "description": "Gets information about the hierarchical entity child model.", - "operationId": "Model_GetHierarchicalEntityChild", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/HEntityIdInPath" - }, - { - "name": "hChildId", - "in": "path", - "description": "The hierarchical entity extractor child ID.", - "required": true, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "The hierarchical entity child model info.", - "schema": { - "$ref": "#/definitions/HierarchicalChildEntity" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Hierarchical Entity Child Info request": { - "$ref": "./examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json" - } - } - }, - "put": { - "description": "Renames a single child in an existing hierarchical entity model.", - "operationId": "Model_UpdateHierarchicalEntityChild", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/HEntityIdInPath" - }, - { - "name": "hChildId", - "in": "path", - "required": true, - "description": "The hierarchical entity extractor child ID.", - "type": "string", - "format": "uuid" - }, - { - "name": "hierarchicalChildModelUpdateObject", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - }, - "description": "Model object containing new name of the hierarchical entity child." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "200": { - "description": "Successfully updated entity child.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Update Hierarchical Entity Child Model request": { - "$ref": "./examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json" - } - } - }, - "delete": { - "description": "Deletes a hierarchical entity extractor child from the application.", - "operationId": "Model_DeleteHierarchicalEntityChild", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/HEntityIdInPath" - }, - { - "name": "hChildId", - "in": "path", - "description": "The hierarchical entity extractor child ID.", - "required": true, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "Successfully deleted entity.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Delete Hierarchical Entity Child Model request": { - "$ref": "./examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children": { - "post": { - "description": "Creates a single child in an existing hierarchical entity model.", - "operationId": "Model_AddHierarchicalEntityChild", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/HEntityIdInPath" - }, - { - "name": "hierarchicalChildModelCreateObject", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - }, - "description": "A model object containing the name of the new hierarchical child model." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the created model.", - "x-nullable": false, - "schema": { - "$ref": "#/definitions/GuidResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Create Hierarchical Entity Child Model request": { - "$ref": "./examples/model/SuccessfulCreateHierarchicalChildModelRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children": { - "post": { - "description": "Creates a single child in an existing composite entity model.", - "operationId": "Model_AddCompositeEntityChild", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/CEntityIdInPath" - }, - { - "name": "compositeChildModelCreateObject", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - }, - "description": "A model object containing the name of the new composite child model." - } - ], - "consumes": [ - "application/json" - ], - "responses": { - "201": { - "description": "The ID of the created model.", - "x-nullable": false, - "schema": { - "$ref": "#/definitions/GuidResponse" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Create Composite Entity Child Model request": { - "$ref": "./examples/model/SuccessfulCreateCompositeChildModelRequest.json" - } - } - } - }, - "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children/{cChildId}": { - "delete": { - "description": "Deletes a composite entity extractor child from the application.", - "operationId": "Model_DeleteCompositeEntityChild", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "$ref": "#/parameters/VersionIdInPath" - }, - { - "$ref": "#/parameters/CEntityIdInPath" - }, - { - "name": "cChildId", - "in": "path", - "description": "The hierarchical entity extractor child ID.", - "required": true, - "type": "string", - "format": "uuid" - } - ], - "responses": { - "200": { - "description": "Successfully deleted entity.", - "schema": { - "$ref": "#/definitions/OperationStatus" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Delete Composite Entity Child Model request": { - "$ref": "./examples/model/SuccessfulDeleteCompositeChildModelRequest.json" - } - } - } - } - }, - "definitions": { - "EntityLabelObject": { - "description": "Defines the entity type and position of the extracted entity within the example.", - "type": "object", - "required": [ - "entityName", - "startCharIndex", - "endCharIndex" - ], - "properties": { - "entityName": { - "description": "The entity type.", - "type": "string" - }, - "startCharIndex": { - "description": "The index within the utterance where the extracted entity starts.", - "type": "integer" - }, - "endCharIndex": { - "description": "The index within the utterance where the extracted entity ends.", - "type": "integer" - } - } - }, - "ApplicationCreateObject": { - "description": "Properties for creating a new LUIS Application", - "type": "object", - "required": [ - "culture", - "name" - ], - "properties": { - "culture": { - "description": "The culture for the new application. It is the language that your app understands and speaks. E.g.: \"en-us\". Note: the culture cannot be changed after the app is created.", - "type": "string" - }, - "domain": { - "description": "The domain for the new application. Optional. E.g.: Comics.", - "type": "string" - }, - "description": { - "description": "Description of the new application. Optional.", - "type": "string" - }, - "initialVersionId": { - "description": "The initial version ID. Optional. Default value is: \"0.1\"", - "type": "string" - }, - "usageScenario": { - "description": "Defines the scenario for the new application. Optional. E.g.: IoT.", - "type": "string" - }, - "name": { - "description": "The name for the new application.", - "type": "string" - } - }, - "example": { - "name": "MyFirstDummyApp", - "description": "This is my first dummy application.", - "culture": "en-us", - "usageScenario": "IoT", - "domain": "Comics", - "initialVersionId": "1.0" - } - }, - "PrebuiltDomainCreateBaseObject": { - "description": "A model object containing the name of the custom prebuilt entity and the name of the domain to which this model belongs.", - "type": "object", - "properties": { - "domainName": { - "description": "The domain name.", - "type": "string" - } - }, - "example": { - "domainName": "Camera" - } - }, - "PrebuiltDomainCreateObject": { - "description": "A prebuilt domain create object containing the name and culture of the domain.", - "type": "object", - "properties": { - "domainName": { - "description": "The domain name.", - "type": "string" - }, - "culture": { - "description": "The culture of the new domain.", - "type": "string" - } - }, - "example": { - "domainName": "Web", - "culture": "en-US" - } - }, - "PrebuiltDomainModelCreateObject": { - "description": "A model object containing the name of the custom prebuilt intent or entity and the name of the domain to which this model belongs.", - "type": "object", - "properties": { - "domainName": { - "description": "The domain name.", - "type": "string" - }, - "modelName": { - "description": "The intent name or entity name.", - "type": "string" - } - }, - "example": { - "domainName": "Camera", - "modelName": "AppName" - } - }, - "HierarchicalEntityModel": { - "description": "A Hierarchical Entity Extractor.", - "type": "object", - "properties": { - "children": { - "description": "Child entities.", - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Entity name.", - "type": "string" - } - }, - "example": { - "name": "Reservation", - "children": [ - "Location::To" - ] - } - }, - "CompositeEntityModel": { - "description": "A composite entity.", - "type": "object", - "properties": { - "children": { - "description": "Child entities.", - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Entity name.", - "type": "string" - } - }, - "example": { - "name": "Reservation", - "children": [ - "Class", - "Location" - ] - } - }, - "JSONEntity": { - "description": "Exported Model - Extracted Entity from utterance.", - "type": "object", - "required": [ - "startPos", - "endPos", - "entity" - ], - "properties": { - "startPos": { - "description": "The index within the utterance where the extracted entity starts.", - "type": "integer" - }, - "endPos": { - "description": "The index within the utterance where the extracted entity ends.", - "type": "integer" - }, - "entity": { - "description": "The entity name.", - "type": "string" - } - } - }, - "ApplicationSettingUpdateObject": { - "description": "Object model for updating an application's settings.", - "type": "object", - "properties": { - "public": { - "description": "Setting your application as public allows other people to use your application's endpoint using their own keys.", - "type": "boolean", - "x-nullable": false - } - }, - "example": { - "public": true - } - }, - "ExampleLabelObject": { - "description": "A labeled example.", - "type": "object", - "properties": { - "text": { - "description": "The sample's utterance.", - "type": "string" - }, - "entityLabels": { - "description": "The idenfied entities within the utterance.", - "items": { - "type": "object", - "$ref": "#/definitions/EntityLabelObject" - }, - "type": "array" - }, - "intentName": { - "description": "The idenfitied intent representing the utterance.", - "type": "string" - } - }, - "example": { - "text": "whats the weather in buenos aires?", - "intentName": "WeatherInPlace", - "entityLabels": [ - { - "entityName": "Place", - "startCharIndex": 21, - "endCharIndex": 34 - } - ] - } - }, - "PhraselistCreateObject": { - "description": "Object model for creating a phraselist model.", - "type": "object", - "properties": { - "phrases": { - "description": "List of comma-separated phrases that represent the Phraselist.", - "type": "string" - }, - "name": { - "description": "The Phraselist name.", - "type": "string" - }, - "isExchangeable": { - "description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.", - "default": true, - "type": "boolean" - } - }, - "example": { - "name": "DaysOfWeek", - "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", - "isExchangeable": false - } - }, - "SubClosedList": { - "description": "Sublist of items for a Closed list.", - "type": "object", - "properties": { - "canonicalForm": { - "description": "The standard form that the list represents.", - "type": "string" - }, - "list": { - "description": "List of synonym words.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "example": { - "canonicalForm": "BankName", - "list": [ - "HSBC", - "CitiBank" - ] - } - }, - "SubClosedListResponse": { - "description": "Sublist of items for a Closed list.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SubClosedList" - } - ], - "properties": { - "id": { - "description": "The sublist ID", - "type": "integer", - "x-nullable": false, - "example": "123456" - } - } - }, - "ApplicationUpdateObject": { - "description": "Object model for updating the name or description of an application.", - "type": "object", - "properties": { - "name": { - "description": "The application's new name.", - "type": "string" - }, - "description": { - "description": "The application's new description.", - "type": "string" - } - }, - "example": { - "name": "MyFirstRenamedDummyAp", - "description": "This is my first modified dummy description." - } - }, - "PrebuiltExtractorNames": { - "description": "Objet model for adding a prebuilt entity to the application.", - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "number", - "ordinal" - ] - }, - "JSONRegexFeature": { - "description": "Exported Model - A Pattern feature.", - "type": "object", - "properties": { - "pattern": { - "description": "The Regular Expression to match.", - "type": "string" - }, - "activated": { - "description": "Indicates if the Pattern feature is enabled.", - "type": "boolean" - }, - "name": { - "description": "Name of the feature.", - "type": "string" - } - } - }, - "PatternUpdateObject": { - "description": "Object model for updating an existing Pattern feature.", - "type": "object", - "properties": { - "pattern": { - "description": "The Regular Expression to match.", - "type": "string" - }, - "name": { - "description": "Name of the feature.", - "type": "string" - }, - "isActive": { - "description": "Indicates if the Pattern feature is enabled.", - "default": true, - "type": "boolean" - } - }, - "example": { - "name": "ModifiedEmailPattern", - "pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b" - } - }, - "ClosedList": { - "description": "Exported Model - A Closed List.", - "type": "object", - "properties": { - "name": { - "description": "Name of the closed list feature.", - "type": "string" - }, - "subLists": { - "description": "Sublists for the feature.", - "items": { - "type": "object", - "$ref": "#/definitions/SubClosedList" - }, - "type": "array" - } - } - }, - "ClosedListModelPatchObject": { - "description": "Object model for adding a batch of sublists to an existing closedlist.", - "type": "object", - "properties": { - "subLists": { - "description": "Sublists to add.", - "items": { - "type": "object", - "$ref": "#/definitions/WordListObject" - }, - "type": "array" - } - }, - "example": { - "subLists": [ - { - "canonicalForm": "Ohio", - "list": [ - "Ohio", - "OH" - ] - } - ] - } - }, - "JSONModelFeature": { - "description": "Exported Model - Phraselist Model Feature.", - "type": "object", - "properties": { - "activated": { - "description": "Indicates if the feature is enabled.", - "type": "boolean" - }, - "name": { - "description": "The Phraselist name.", - "type": "string" - }, - "words": { - "description": "List of comma-separated phrases that represent the Phraselist.", - "type": "string" - }, - "mode": { - "description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.", - "type": "boolean" - } - } - }, - "ModelCreateObject": { - "description": "Object model for creating a new entity extractor.", - "type": "object", - "properties": { - "name": { - "description": "Name of the new entity extractor.", - "type": "string" - } - }, - "example": { - "name": "DayOfWeek" - } - }, - "PatternCreateObject": { - "description": "Object model for creating a Pattern feature.", - "type": "object", - "properties": { - "pattern": { - "description": "The Regular Expression to match.", - "type": "string" - }, - "name": { - "description": "Name of the feature.", - "type": "string" - } - }, - "example": { - "name": "EmailPattern", - "pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b" - } - }, - "WordListObject": { - "description": "Sublist of items for a Closed list.", - "type": "object", - "properties": { - "canonicalForm": { - "description": "The standard form that the list represents.", - "type": "string" - }, - "list": { - "description": "List of synonym words.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "example": { - "canonicalForm": "California", - "list": [ - "California", - "CA", - "Calif.", - "Cal." - ] - } - }, - "WordListBaseUpdateObject": { - "description": "Object model for updating one of the closed list's sublists.", - "type": "object", - "properties": { - "canonicalForm": { - "description": "The standard form that the list represents.", - "type": "string" - }, - "list": { - "description": "List of synonym words.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "example": { - "canonicalForm": "California", - "list": [ - "California", - "CA", - "Calif.", - "Cal." - ] - } - }, - "JSONUtterance": { - "description": "Exported Model - Utterance that was used to train the model.", - "type": "object", - "properties": { - "text": { - "description": "The utterance.", - "type": "string" - }, - "intent": { - "description": "The matched intent.", - "type": "string" - }, - "entities": { - "description": "The matched entities.", - "items": { - "type": "object", - "$ref": "#/definitions/JSONEntity" - }, - "type": "array" - } - } - }, - "ModelUpdateObject": { - "description": "Object model for updating an intent classifier.", - "type": "object", - "properties": { - "name": { - "description": "The entity's new name.", - "type": "string" - } - }, - "example": { - "name": "New Name" - } - }, - "ClosedListModelUpdateObject": { - "description": "Object model for updating a closed list.", - "type": "object", - "properties": { - "subLists": { - "description": "The new sublists for the feature.", - "items": { - "type": "object", - "$ref": "#/definitions/WordListObject" - }, - "type": "array" - }, - "name": { - "description": "The new name of the closed list feature.", - "type": "string" - } - }, - "example": { - "name": "States", - "subLists": [ - { - "canonicalForm": "new york", - "list": [ - "ny", - "new york" - ] - }, - { - "canonicalForm": "washington", - "list": [ - "washington", - "wa" - ] - }, - { - "canonicalForm": "california", - "list": [ - "california", - "ca", - "calif.", - "cal." - ] - }, - { - "canonicalForm": "Texas", - "list": [ - "Texas", - "TX" - ] - } - ] - } - }, - "ClosedListModelCreateObject": { - "description": "Object model for creating a closed list.", - "type": "object", - "properties": { - "subLists": { - "description": "Sublists for the feature.", - "items": { - "type": "object", - "$ref": "#/definitions/WordListObject" - }, - "type": "array" - }, - "name": { - "description": "Name of the closed list feature.", - "type": "string" - } - }, - "example": { - "name": "States", - "subLists": [ - { - "canonicalForm": "New York", - "list": [ - "NY", - "New York" - ] - }, - { - "canonicalForm": "Washington", - "list": [ - "Washington", - "WA" - ] - }, - { - "canonicalForm": "California", - "list": [ - "California", - "CA", - "Calif.", - "Cal." - ] - } - ] - } - }, - "ExampleLabelObjectArray": { - "description": "Object model for adding a batch of labeled examples.", - "items": { - "type": "object", - "$ref": "#/definitions/ExampleLabelObject" - }, - "type": "array", - "example": [ - { - "text": "Book me a flight from Cairo to Redmond next Thursday", - "intentName": "BookFlight", - "entityLabels": [ - { - "entityName": "Location::From", - "startCharIndex": 22, - "endCharIndex": 26 - }, - { - "entityName": "Location::To", - "startCharIndex": 31, - "endCharIndex": 37 - } - ] - }, - { - "text": "What's the weather like in Seattle?", - "intentName": "GetWeather", - "entityLabels": [ - { - "entityName": "Location", - "startCharIndex": 27, - "endCharIndex": 33 - } - ] - } - ] - }, - "VersionInfo": { - "description": "Object model of an application version.", - "type": "object", - "required": [ - "version", - "trainingStatus" - ], - "properties": { - "version": { - "description": "The version ID. E.g.: \"0.1\"", - "type": "string" - }, - "createdDateTime": { - "description": "The version's creation timestamp.", - "type": "string", - "format": "date-time" - }, - "lastModifiedDateTime": { - "description": "Timestamp of the last update.", - "type": "string", - "format": "date-time" - }, - "lastTrainedDateTime": { - "description": "Timestamp of the last time the model was trained.", - "type": "string", - "format": "date-time" - }, - "lastPublishedDateTime": { - "description": "Timestamp when was last published.", - "type": "string", - "format": "date-time" - }, - "endpointUrl": { - "description": "The Runtime endpoint URL for this model version.", - "type": "string" - }, - "assignedEndpointKey": { - "description": "The endpoint key.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "externalApiKeys": { - "description": "External keys.", - "type": "object" - }, - "intentsCount": { - "description": "Number of intents in this model.", - "type": "integer" - }, - "entitiesCount": { - "description": "Number of entities in this model.", - "type": "integer" - }, - "endpointHitsCount": { - "description": "Number of calls made to this endpoint.", - "type": "integer" - }, - "trainingStatus": { - "description": "The current training status.", - "type": "string", - "enum": [ - "NeedsTraining", - "InProgress", - "Trained" - ], - "x-ms-enum": { - "name": "TrainingStatus" - } - } - } - }, - "TaskUpdateObject": { - "description": "Object model for cloning an application's version.", - "type": "object", - "properties": { - "version": { - "description": "The new version for the cloned model.", - "type": "string" - } - }, - "example": { - "version": "1.0" - } - }, - "PhraselistUpdateObject": { - "description": "Object model for updating a Phraselist.", - "type": "object", - "properties": { - "phrases": { - "description": "List of comma-separated phrases that represent the Phraselist.", - "type": "string" - }, - "name": { - "description": "The Phraselist name.", - "type": "string" - }, - "isActive": { - "description": "Indicates if the Phraselist is enabled.", - "default": true, - "type": "boolean" - }, - "isExchangeable": { - "description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.", - "default": true, - "type": "boolean" - } - }, - "example": { - "name": "DaysOfWeek", - "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday" - } - }, - "HierarchicalModel": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "children": { - "items": { - "type": "string" - }, - "type": "array" - } - } - }, - "ApplicationPublishObject": { - "description": "Object model for publishing a specific application version.", - "type": "object", - "properties": { - "versionId": { - "description": "The version ID to publish.", - "type": "string" - }, - "isStaging": { - "description": "Indicates if the staging slot should be used, instead of the Production one.", - "default": false, - "type": "boolean" - }, - "region": { - "description": "The target region that the application is published to.", - "type": "string" - } - }, - "example": { - "versionId": "0.1", - "isStaging": false, - "region": "westus" - } - }, - "LuisApp": { - "description": "Exported Model - An exported LUIS Application.", - "additionalProperties": true, - "type": "object", - "properties": { - "name": { - "description": "The name of the application.", - "type": "string" - }, - "versionId": { - "description": "The version ID of the application that was exported.", - "type": "string" - }, - "desc": { - "description": "The description of the application.", - "type": "string" - }, - "culture": { - "description": "The culture of the application. E.g.: en-us.", - "type": "string" - }, - "intents": { - "description": "List of intents.", - "items": { - "type": "object", - "$ref": "#/definitions/HierarchicalModel" - }, - "type": "array" - }, - "entities": { - "description": "List of entities.", - "items": { - "type": "object", - "$ref": "#/definitions/HierarchicalModel" - }, - "type": "array" - }, - "bing_entities": { - "description": "List of prebuilt intents.", - "items": { - "type": "string" - }, - "type": "array" - }, - "closedLists": { - "description": "List of closed lists.", - "items": { - "type": "object", - "$ref": "#/definitions/ClosedList" - }, - "type": "array" - }, - "composites": { - "description": "List of composite entities.", - "items": { - "type": "object", - "$ref": "#/definitions/HierarchicalModel" - }, - "type": "array" - }, - "regex_features": { - "description": "List of pattern features.", - "items": { - "type": "object", - "$ref": "#/definitions/JSONRegexFeature" - }, - "type": "array" - }, - "model_features": { - "description": "List of model features.", - "items": { - "type": "object", - "$ref": "#/definitions/JSONModelFeature" - }, - "type": "array" - }, - "utterances": { - "description": "List of sample utterances.", - "items": { - "type": "object", - "$ref": "#/definitions/JSONUtterance" - }, - "type": "array" - } - }, - "example": { - "luis_schema_version": "2.1.0", - "versionId": "0.1", - "name": "LuisBot", - "desc": "", - "culture": "en-us", - "intents": [ - { - "name": "dateintent" - }, - { - "name": "Help" - }, - { - "name": "None" - }, - { - "name": "SearchHotels" - }, - { - "name": "ShowHotelsReviews" - } - ], - "entities": [ - { - "name": "AirportCode" - }, - { - "name": "Hotel" - } - ], - "composites": [], - "closedLists": [], - "bing_entities": [ - "datetimeV2", - "geography" - ], - "model_features": [ - { - "name": "Near", - "mode": true, - "words": "near,around,close,nearby", - "activated": true - }, - { - "name": "Show", - "mode": true, - "words": "show,find,look,search", - "activated": true - } - ], - "regex_features": [ - { - "name": "AirportCodeRegex", - "pattern": "[a-z]{3}", - "activated": true - } - ], - "utterances": [ - { - "text": "i need help", - "intent": "Help", - "entities": [] - }, - { - "text": "help me", - "intent": "Help", - "entities": [] - }, - { - "text": "tomorrow", - "intent": "dateintent", - "entities": [] - }, - { - "text": "search for hotels in seattle", - "intent": "SearchHotels", - "entities": [] - }, - { - "text": "what can i do?", - "intent": "Help", - "entities": [] - }, - { - "text": "next monday", - "intent": "dateintent", - "entities": [] - }, - { - "text": "next year", - "intent": "dateintent", - "entities": [] - }, - { - "text": "look for hotels in miami", - "intent": "SearchHotels", - "entities": [] - }, - { - "text": "show me hotels in california", - "intent": "SearchHotels", - "entities": [] - }, - { - "text": "show me the reviews of the amazing bot resort", - "intent": "ShowHotelsReviews", - "entities": [ - { - "entity": "Hotel", - "startPos": 23, - "endPos": 44 - } - ] - }, - { - "text": "can i see the reviews of extended bot hotel?", - "intent": "ShowHotelsReviews", - "entities": [ - { - "entity": "Hotel", - "startPos": 25, - "endPos": 42 - } - ] - }, - { - "text": "find reviews of hotelxya", - "intent": "ShowHotelsReviews", - "entities": [ - { - "entity": "Hotel", - "startPos": 16, - "endPos": 23 - } - ] - }, - { - "text": "show me reviews of the amazing hotel", - "intent": "ShowHotelsReviews", - "entities": [ - { - "entity": "Hotel", - "startPos": 19, - "endPos": 35 - } - ] - }, - { - "text": "what are the available options?", - "intent": "Help", - "entities": [] - }, - { - "text": "best hotels in seattle", - "intent": "SearchHotels", - "entities": [] - }, - { - "text": "hotels in los angeles", - "intent": "SearchHotels", - "entities": [] - }, - { - "text": "can you show me hotels from los angeles?", - "intent": "SearchHotels", - "entities": [] - }, - { - "text": "can you show me the reviews of the amazing resort & hotel", - "intent": "ShowHotelsReviews", - "entities": [ - { - "entity": "Hotel", - "startPos": 31, - "endPos": 56 - } - ] - }, - { - "text": "what are the reviews of the hotel bot framework?", - "intent": "ShowHotelsReviews", - "entities": [ - { - "entity": "Hotel", - "startPos": 24, - "endPos": 46 - } - ] - }, - { - "text": "find hotels near eze", - "intent": "SearchHotels", - "entities": [ - { - "entity": "AirportCode", - "startPos": 17, - "endPos": 19 - } - ] - }, - { - "text": "where can i stay near nnn?", - "intent": "SearchHotels", - "entities": [ - { - "entity": "AirportCode", - "startPos": 22, - "endPos": 24 - } - ] - }, - { - "text": "show hotels near att airport", - "intent": "SearchHotels", - "entities": [ - { - "entity": "AirportCode", - "startPos": 17, - "endPos": 19 - } - ] - }, - { - "text": "find hotels near agl", - "intent": "SearchHotels", - "entities": [ - { - "entity": "AirportCode", - "startPos": 17, - "endPos": 19 - } - ] - }, - { - "text": "find hotels around eze airport", - "intent": "SearchHotels", - "entities": [ - { - "entity": "AirportCode", - "startPos": 19, - "endPos": 21 - } - ] - }, - { - "text": "01/7", - "intent": "dateintent", - "entities": [] - } - ] - } - }, - "GuidResponse": { - "description": "The ID (GUID) returned by an operation.", - "type": "string", - "format": "uuid", - "example": "363187f1-c573-46b3-bc4c-ae01d686e68e" - }, - "VersionResponse": { - "description": "The new version ID returned by when importing a model version.", - "type": "string", - "example": "0.1" - }, - "FeatureIDResponse": { - "description": "The ID of the created feature.", - "type": "integer", - "x-nullable": false, - "example": 398102 - }, - "LabeledUtterances": { - "description": "A list of predictions and label pairs for every example in the application.", - "type": "array", - "items": { - "$ref": "#/definitions/LabeledUtterance" - } - }, - "LabeledUtterance": { - "description": "A prediction and label pair of an example.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of Labeled Utterance." - }, - "text": { - "type": "string", - "description": "The utterance. E.g.: what's the weather like in seattle?" - }, - "tokenizedText": { - "type": "array", - "description": "The utterance tokenized.", - "items": { - "type": "string" - } - }, - "intentLabel": { - "description": "The intent matching the example.", - "type": "string" - }, - "entityLabels": { - "description": "The entities matching the example.", - "type": "array", - "items": { - "$ref": "#/definitions/EntityLabel" - } - }, - "intentPredictions": { - "description": "List of suggested intents.", - "type": "array", - "items": { - "$ref": "#/definitions/IntentPrediction" - } - }, - "entityPredictions": { - "description": "List of suggested entities.", - "type": "array", - "items": { - "$ref": "#/definitions/EntityPrediction" - } - } - } - }, - "IntentsSuggestionExamples": { - "description": "List of predicted/suggested intents.", - "type": "array", - "items": { - "$ref": "#/definitions/IntentsSuggestionExample" - } - }, - "IntentsSuggestionExample": { - "description": "Predicted/suggested intent.", - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "The utterance. E.g.: what's the weather like in seattle?" - }, - "tokenizedText": { - "type": "array", - "description": "The utterance tokenized.", - "items": { - "type": "string" - } - }, - "intentPredictions": { - "description": "Predicted/suggested intents.", - "type": "array", - "items": { - "$ref": "#/definitions/IntentPrediction" - } - }, - "entityPredictions": { - "description": "Predicted/suggested entities.", - "type": "array", - "items": { - "$ref": "#/definitions/EntityPrediction" - } - } - } - }, - "EntitiesSuggestionExamples": { - "description": "List of predicted/suggested entities.", - "type": "array", - "items": { - "$ref": "#/definitions/EntitiesSuggestionExample" - } - }, - "EntitiesSuggestionExample": { - "description": "Predicted/suggested entity.", - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "The utterance. E.g.: what's the weather like in seattle?" - }, - "tokenizedText": { - "type": "array", - "description": "The utterance tokenized.", - "items": { - "type": "string" - } - }, - "intentPredictions": { - "description": "Predicted/suggested intents.", - "type": "array", - "items": { - "$ref": "#/definitions/IntentPrediction" - } - }, - "entityPredictions": { - "description": "Predicted/suggested entities.", - "type": "array", - "items": { - "$ref": "#/definitions/EntityPrediction" - } - } - } - }, - "EntityLabel": { - "description": "Defines the entity type and position of the extracted entity within the example.", - "type": "object", - "properties": { - "entityName": { - "description": "The entity type.", - "type": "string" - }, - "startTokenIndex": { - "description": "The index within the utterance where the extracted entity starts.", - "type": "integer" - }, - "endTokenIndex": { - "description": "The index within the utterance where the extracted entity ends.", - "type": "integer" - } - }, - "required": [ - "entityName", - "startTokenIndex", - "endTokenIndex" - ] - }, - "IntentPrediction": { - "description": "A suggested intent.", - "type": "object", - "properties": { - "name": { - "description": "The intent's name", - "type": "string" - }, - "score": { - "description": "The intent's score, based on the prediction model.", - "type": "number" - } - } - }, - "EntityPrediction": { - "description": "A suggested entity.", - "type": "object", - "required": [ - "entityName", - "startTokenIndex", - "endTokenIndex", - "phrase" - ], - "properties": { - "entityName": { - "description": "The entity's name", - "type": "string" - }, - "startTokenIndex": { - "description": "The index within the utterance where the extracted entity starts.", - "type": "integer" - }, - "endTokenIndex": { - "description": "The index within the utterance where the extracted entity ends.", - "type": "integer" - }, - "phrase": { - "type": "string", - "description": "The actual token(s) that comprise the entity." - } - } - }, - "PersonalAssistantsResponse": { - "type": "object", - "description": "Response containing user's endpoint keys and the endpoint URLs of the prebuilt Cortana applications.", - "properties": { - "endpointKeys": { - "$ref": "#/definitions/EndpointKeys" - }, - "endpointUrls": { - "$ref": "#/definitions/PersonalAssistantUrls" - } - } - }, - "EndpointKeys": { - "type": "array", - "description": "An a array of GUIDs, comprised of Azure Endpoint Keys and the Programmatic API key.", - "items": { - "type": "string", - "format": "uuid" - } - }, - "PersonalAssistantUrls": { - "type": "object", - "description": "Endpoint URLs for prebuilt Cortana applications.", - "additionalProperties": { - "type": "string" - } - }, - "ModelInfo": { - "description": "Base type used in entity types.", - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "The ID of the Entity Model." - }, - "name": { - "type": "string", - "description": "Name of the Entity Model." - }, - "typeId": { - "type": "integer", - "description": "The type ID of the Entity Model." - }, - "readableType": { - "$ref": "#/definitions/ReadableType" - } - }, - "required": [ - "id", - "readableType" - ] - }, - "ModelsInfoResponseObject": { - "description": "A list of application model infos.", - "type": "array", - "items": { - "$ref": "#/definitions/ModelInfoResponse" - } - }, - "ModelInfoResponse": { - "description": "An application model info.", - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "The ID of the Entity Model." - }, - "name": { - "type": "string", - "description": "Name of the Entity Model." - }, - "typeId": { - "type": "integer", - "description": "The type ID of the Entity Model." - }, - "readableType": { - "$ref": "#/definitions/ReadableType" - } - }, - "required": [ - "id", - "readableType" - ], - "allOf": [ - { - "$ref": "#/definitions/HierarchicalEntityExtractor" - }, - { - "$ref": "#/definitions/CompositeEntityExtractor" - }, - { - "$ref": "#/definitions/ClosedListEntityExtractor" - }, - { - "$ref": "#/definitions/IntentClassifier" - }, - { - "$ref": "#/definitions/EntityExtractor" - } - ] - }, - "ReadableType": { - "description": "Full name of the entity type.", - "type": "string", - "enum": [ - "Entity Extractor", - "Hierarchical Entity Extractor", - "Hierarchical Child Entity Extractor", - "Composite Entity Extractor", - "Closed List Entity Extractor", - "Prebuilt Entity Extractor", - "Intent Classifier" - ] - }, - "HierarchicalEntityExtractor": { - "description": "Hierarchical Entity Extractor.", - "type": "object", - "x-ms-discriminator-value": "Hierarchical Entity Extractor", - "allOf": [ - { - "$ref": "#/definitions/ModelInfo" - } - ], - "properties": { - "children": { - "description": "List of child entities.", - "type": "array", - "items": { - "$ref": "#/definitions/ChildEntity" - } - } - } - }, - "HierarchicalEntityExtractorsList": { - "description": "List of Hierarchical Entity Extractors.", - "type": "array", - "items": { - "$ref": "#/definitions/HierarchicalEntityExtractor" - } - }, - "CompositeEntityExtractor": { - "description": "A Composite Entity Extractor.", - "type": "object", - "x-ms-discriminator-value": "Composite Entity Extractor", - "allOf": [ - { - "$ref": "#/definitions/ModelInfo" - } - ], - "properties": { - "children": { - "description": "List of child entities.", - "type": "array", - "items": { - "$ref": "#/definitions/ChildEntity" - } - } - } - }, - "CompositeEntityExtractorsList": { - "description": "List of Composite Entity Extractors.", - "type": "array", - "items": { - "$ref": "#/definitions/CompositeEntityExtractor" - } - }, - "ClosedListEntityExtractor": { - "description": "Closed List Entity Extractor.", - "type": "object", - "x-ms-discriminator-value": "Closed List Entity Extractor", - "allOf": [ - { - "$ref": "#/definitions/ModelInfo" - } - ], - "properties": { - "subLists": { - "description": "List of sub-lists.", - "type": "array", - "items": { - "$ref": "#/definitions/SubClosedListResponse" - } - } - } - }, - "ClosedListEntityExtractorsList": { - "description": "List of Closed List Entity Extractors.", - "type": "array", - "items": { - "$ref": "#/definitions/ClosedListEntityExtractor" - } - }, - "PrebuiltEntityExtractor": { - "description": "Prebuilt Entity Extractor.", - "type": "object", - "x-ms-discriminator-value": "Prebuilt Entity Extractor", - "allOf": [ - { - "$ref": "#/definitions/ModelInfo" - } - ] - }, - "PrebuiltEntityExtractorsList": { - "description": "List of Prebuilt Entity Extractors.", - "type": "array", - "items": { - "$ref": "#/definitions/PrebuiltEntityExtractor" - } - }, - "ChildEntity": { - "type": "object", - "description": "The base child entity type.", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "The ID (GUID) belonging to a child entity." - }, - "name": { - "type": "string", - "description": "The name of a child entity." - } - }, - "required": [ - "id" - ] - }, - "HierarchicalChildEntity": { - "description": "A Hierarchical Child Entity.", - "type": "object", - "properties": { - "typeId": { - "description": "The type ID of the Entity Model.", - "type": "integer" - }, - "readableType": { - "$ref": "#/definitions/ReadableType" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ChildEntity" - } - ] - }, - "CustomPrebuiltModel": { - "description": "A Custom Prebuilt model.", - "allOf": [ - { - "$ref": "#/definitions/ModelInfo" - }, - { - "$ref": "#/definitions/IntentClassifier" - }, - { - "$ref": "#/definitions/EntityExtractor" - } - ] - }, - "CustomPrebuiltModelList": { - "description": "A List of Custom Prebuilt models.", - "type": "array", - "items": { - "$ref": "#/definitions/CustomPrebuiltModel" - } - }, - "IntentClassifier": { - "description": "Intent Classifier.", - "type": "object", - "x-ms-discriminator-value": "Intent Classifier", - "allOf": [ - { - "$ref": "#/definitions/ModelInfo" - } - ], - "properties": { - "customPrebuiltDomainName": { - "description": "The domain name.", - "type": "string" - }, - "customPrebuiltModelName": { - "description": "The intent name or entity name.", - "type": "string" - } - } - }, - "EntityExtractor": { - "description": "Entity Extractor.", - "type": "object", - "x-ms-discriminator-value": "Entity Extractor", - "allOf": [ - { - "$ref": "#/definitions/ModelInfo" - } - ], - "properties": { - "customPrebuiltDomainName": { - "description": "The domain name.", - "type": "string" - }, - "customPrebuiltModelName": { - "description": "The intent name or entity name.", - "type": "string" - } - } - }, - "IntentClassifiersList": { - "description": "List of Intent Classifiers.", - "type": "array", - "items": { - "$ref": "#/definitions/IntentClassifier" - } - }, - "EntityExtractorsList": { - "description": "List of Entity Extractors.", - "type": "array", - "items": { - "$ref": "#/definitions/EntityExtractor" - } - }, - "FeaturesResponseObject": { - "description": "Model Features, including Patterns and Phraselists.", - "type": "object", - "properties": { - "phraselistFeatures": { - "$ref": "#/definitions/PhraseListFeatureInfoList" - }, - "patternFeatures": { - "$ref": "#/definitions/PatternFeatureInfoList" - } - } - }, - "FeatureInfoObject": { - "description": "The base class Features-related response objects inherit from.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "A six-digit ID used for Features." - }, - "name": { - "type": "string", - "description": "The name of the Feature." - }, - "isActive": { - "description": "Indicates if the feature is enabled.", - "type": "boolean" - } - } - }, - "PatternFeatureInfo": { - "description": "Pattern feature.", - "type": "object", - "properties": { - "pattern": { - "description": "The Regular Expression to match.", - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/definitions/FeatureInfoObject" - } - ] - }, - "PatternFeatureInfoList": { - "description": "List of Pattern features.", - "type": "array", - "items": { - "$ref": "#/definitions/PatternFeatureInfo" - } - }, - "PhraseListFeatureInfo": { - "description": "Phraselist Feature.", - "type": "object", - "properties": { - "phrases": { - "type": "string", - "description": "A list of comma-separated values." - }, - "isExchangeable": { - "description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.", - "type": "boolean" - } - }, - "allOf": [ - { - "$ref": "#/definitions/FeatureInfoObject" - } - ] - }, - "PhraseListFeatureInfoList": { - "description": "List of Phraselist Features.", - "type": "array", - "items": { - "$ref": "#/definitions/PhraseListFeatureInfo" - } - }, - "LabelExampleResponse": { - "description": "Response when adding a labeled example.", - "type": "object", - "properties": { - "UtteranceText": { - "description": "The sample's utterance.", - "type": "string", - "example": "book me a flight from cairo to redmond next thursday" - }, - "ExampleId": { - "description": "The newly created sample ID.", - "type": "integer", - "example": -6830368 - } - } - }, - "BatchLabelExample": { - "description": "Response when adding a batch of labeled examples.", - "type": "object", - "properties": { - "value": { - "$ref": "#/definitions/LabelExampleResponse" - }, - "hasError": { - "type": "boolean" - }, - "error": { - "$ref": "#/definitions/OperationStatus" - } - } - }, - "BatchLabelExampleResponse": { - "description": "Response when adding a batch of labeled examples.", - "type": "array", - "items": { - "$ref": "#/definitions/BatchLabelExample" - } - }, - "ApplicationInfoResponse": { - "description": "Response containing the Application Info.", - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "The ID (GUID) of the application." - }, - "name": { - "description": "The name of the application.", - "type": "string" - }, - "description": { - "description": "The description of the application.", - "type": "string" - }, - "culture": { - "description": "The culture of the application. E.g.: en-us.", - "type": "string" - }, - "usageScenario": { - "description": "Defines the scenario for the new application. Optional. E.g.: IoT.", - "type": "string" - }, - "domain": { - "description": "The domain for the new application. Optional. E.g.: Comics.", - "type": "string" - }, - "versionsCount": { - "description": "Amount of model versions within the application.", - "type": "integer" - }, - "createdDateTime": { - "description": "The version's creation timestamp.", - "type": "string" - }, - "endpoints": { - "description": "The Runtime endpoint URL for this model version.", - "type": "object" - }, - "endpointHitsCount": { - "description": "Number of calls made to this endpoint.", - "type": "integer" - }, - "activeVersion": { - "description": "The version ID currently marked as active.", - "type": "string" - } - } - }, - "ApplicationsInfoList": { - "description": "List of Application Infos.", - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationInfoResponse" - } - }, - "ProductionOrStagingEndpointInfo": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/EndpointInfo" - } - ] - }, - "EndpointInfo": { - "type": "object", - "description": "The base class \"ProductionOrStagingEndpointInfo\" inherits from.", - "properties": { - "versionId": { - "description": "The version ID to publish.", - "type": "string" - }, - "isStaging": { - "description": "Indicates if the staging slot should be used, instead of the Production one.", - "type": "boolean" - }, - "endpointUrl": { - "description": "The Runtime endpoint URL for this model version.", - "type": "string" - }, - "region": { - "description": "The target region that the application is published to.", - "type": "string" - }, - "assignedEndpointKey": { - "description": "The endpoint key.", - "type": "string" - }, - "endpointRegion": { - "type": "string", - "description": "The endpoint's region." - }, - "publishedDateTime": { - "description": "Timestamp when was last published.", - "type": "string" - } - } - }, - "AvailableEndpoints": { - "type": "object", - "description": "Collection of endpoint URLs where the selected application is deployed to.", - "additionalProperties": { - "type": "string" - } - }, - "AvailableCulture": { - "description": "Available culture for using in a new application.", - "type": "object", - "properties": { - "name": { - "description": "The language name.", - "type": "string" - }, - "code": { - "description": "The ISO value for the language.", - "type": "string" - } - } - }, - "AvailableCultures": { - "type": "array", - "description": "A list of available application cultures.", - "items": { - "$ref": "#/definitions/AvailableCulture" - } - }, - "AvailableDomains": { - "description": "A list of available application domains.", - "type": "array", - "items": { - "type": "string" - } - }, - "ApplicationUsageScenarios": { - "description": "A list of possible application usage scenarios.", - "type": "array", - "items": { - "type": "string" - } - }, - "ApplicationSettings": { - "description": "The application settings.", - "type": "object", - "properties": { - "id": { - "description": "The application ID.", - "type": "string", - "format": "uuid" - }, - "public": { - "description": "Setting your application as public allows other people to use your application's endpoint using their own keys.", - "type": "boolean", - "x-nullable": false, - "x-ms-client-name": "isPublic" - } - }, - "required": [ - "id", - "public" - ] - }, - "AvailablePrebuiltEntityModel": { - "description": "Available Prebuilt entity model for using in an application.", - "type": "object", - "properties": { - "name": { - "description": "The entity name.", - "type": "string" - }, - "description": { - "description": "The entity description and usage information.", - "type": "string" - }, - "examples": { - "description": "Usage examples.", - "type": "string" - } - } - }, - "AvailablePrebuiltEntityModels": { - "description": "List of Available Prebuilt entity models.", - "type": "array", - "items": { - "$ref": "#/definitions/AvailablePrebuiltEntityModel" - } - }, - "EnqueueTrainingResponse": { - "description": "Response model when requesting to train the model.", - "type": "object", - "properties": { - "statusId": { - "description": "The train request status ID.", - "type": "integer" - }, - "status": { - "$ref": "#/definitions/TrainingStatus" - } - } - }, - "TrainingStatus": { - "description": "The Trainning status.", - "type": "string", - "enum": [ - "Queued", - "InProgress", - "UpToDate", - "Fail", - "Success" - ] - }, - "ModelTrainingInfo": { - "description": "Model Training Info.", - "type": "object", - "properties": { - "modelId": { - "type": "string", - "format": "uuid", - "description": "The ID (GUID) of the model." - }, - "details": { - "$ref": "#/definitions/ModelTrainingDetails" - } - } - }, - "ModelTrainingDetails": { - "description": "Model Training Details.", - "type": "object", - "properties": { - "statusId": { - "description": "The train request status ID.", - "type": "integer" - }, - "status": { - "$ref": "#/definitions/TrainingStatus" - }, - "exampleCount": { - "description": "The count of examples used to train the model.", - "type": "integer" - }, - "trainingDateTime": { - "description": "When the model was trained.", - "type": "string", - "format": "date-time" - }, - "failureReason": { - "description": "Reason for the training failure.", - "type": "string" - } - } - }, - "ModelTrainingInfoList": { - "description": "List of Model Training Infos.", - "type": "array", - "items": { - "$ref": "#/definitions/ModelTrainingInfo" - } - }, - "UserAccessList": { - "description": "List of user permissions.", - "type": "object", - "properties": { - "owner": { - "type": "string", - "description": "The email address of owner of the application." - }, - "emails": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "UserCollaborator": { - "type": "object", - "properties": { - "email": { - "type": "string", - "description": "The email address of the user." - } - } - }, - "CollaboratorsArray": { - "type": "object", - "properties": { - "emails": { - "type": "array", - "description": "The email address of the users.", - "items": { - "type": "string" - } - } - } - }, - "OperationStatus": { - "description": "Response of an Operation status.", - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "Status Code.", - "enum": [ - "Failed", - "FAILED", - "Success" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "OperationStatusType" - } - }, - "message": { - "type": "string", - "description": "Status details." - } - } - }, - "ErrorResponse": { - "description": "Error response when invoking an operation on the API.", - "type": "object", - "properties": { - "errorType": { - "type": "string" - } - }, - "additionalProperties": { - "type": "object" - } - }, - "OperationError": { - "description": "Operation error details when invoking an operation on the API.", - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - } - } - }, - "PrebuiltDomainsList": { - "description": "List of Prebuilt Domains.", - "type": "array", - "items": { - "$ref": "#/definitions/PrebuiltDomain" - } - }, - "PrebuiltDomain": { - "description": "Prebuilt Domain.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "culture": { - "type": "string" - }, - "description": { - "type": "string" - }, - "examples": { - "type": "string" - }, - "intents": { - "type": "array", - "items": { - "$ref": "#/definitions/PrebuiltDomainItem" - } - }, - "entities": { - "type": "array", - "items": { - "$ref": "#/definitions/PrebuiltDomainItem" - } - } - } - }, - "PrebuiltDomainItem": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "examples": { - "type": "string" - } - } - }, - "GuidList": { - "description": "List of IDs (GUID)", - "type": "array", - "items": { - "$ref": "#/definitions/GuidResponse" - }, - "example": [ - "2639049a-e41d-4285-a3c6-8a17ed299473", - "200d6173-ecfa-4967-bf95-3c319902dc52", - "f80aa9ba-64c8-4a36-8cc5-92010d0aadf1" - ] - } - }, - "parameters": { - "AppIdInPath": { - "name": "appId", - "in": "path", - "required": true, - "type": "string", - "format": "uuid", - "description": "The application ID.", - "x-ms-parameter-location": "method" - }, - "VersionIdInPath": { - "name": "versionId", - "in": "path", - "description": "The version ID.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "CEntityIdInPath": { - "name": "cEntityId", - "in": "path", - "description": "The composite entity extractor ID.", - "required": true, - "type": "string", - "format": "uuid", - "x-ms-parameter-location": "method" - }, - "HEntityIdInPath": { - "name": "hEntityId", - "in": "path", - "description": "The hierarchical entity extractor ID.", - "required": true, - "type": "string", - "format": "uuid", - "x-ms-parameter-location": "method" - }, - "IntentIdInPath": { - "name": "intentId", - "in": "path", - "description": "The intent classifier ID.", - "required": true, - "type": "string", - "format": "uuid", - "x-ms-parameter-location": "method" - }, - "SkipInPath": { - "name": "skip", - "in": "query", - "description": "The number of entries to skip. Default value is 0.", - "type": "integer", - "default": 0, - "minimum": 0, - "x-ms-parameter-location": "method" - }, - "TakeInPath": { - "name": "take", - "in": "query", - "description": "The number of entries to return. Maximum page size is 500. Default is 100.", - "type": "integer", - "default": 100, - "minimum": 0, - "maximum": 500, - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json deleted file mode 100644 index 712f54841d7b..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "AzureRegion": "westus", - "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "prebuiltDomainCreateObject": { - "culture": "en-US", - "domainName": "Web" - } - }, - "responses": { - "201": { - "headers": { - "location": "https://api.luis.ai/api/v2.0/apps/customprebuiltdomains/00000000-0000-0000-0000-000000000000" - }, - "body": "00000000-0000-0000-0000-000000000000" - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json deleted file mode 100644 index 48d267736d51..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "AzureRegion": "westus", - "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", - "versionId": "0.1", - "clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf", - "wordListCreateObject": { - "canonicalForm": "Texas", - "list": [ - "tx", - "texas" - ] - } - }, - "responses": { - "201": { - "headers": { - "Location": "https://api.luis.ai/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/closedlists/28027e3b-8356-4cdf-b395-24afb94e9469/sublists/6134877" - }, - "body": 6134877 - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateEntityExtractorRequest.json deleted file mode 100644 index 1ec41f4dfe49..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulCreateEntityExtractorRequest.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "AzureRegion": "westus", - "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", - "versionId": "0.1", - "modelCreateObject": { - "name": "DayOfWeek" - } - }, - "responses": { - "201": { - "headers": { - "Location": "https://api.luis.ai/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities/7e838199-a5db-47a6-8931-d79f1729a922" - }, - "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json deleted file mode 100644 index fc823be2d86a..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "AzureRegion": "westus", - "Ocp-Apim-Subscription-Key": "{API key}", - "appId": "{appId}", - "versionId": "{versionId}", - "skip": 0, - "take": 100 - }, - "responses": { - "200": { - "headers": {}, - "body": [ - { - "id": "bc1bae43-7904-48ad-a165-88b1910174f9", - "name": "Reservation", - "typeId": 4, - "readableType": "Composite Entity Extractor", - "children": [ - { - "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", - "name": "Location::To" - }, - { - "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", - "name": "datetime" - } - ] - } - ] - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json deleted file mode 100644 index 679eed11df20..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "AzureRegion": "westus", - "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", - "versionId": "0.1", - "skip": "0", - "take": "100" - }, - "responses": { - "200": { - "headers": {}, - "body": [ - { - "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", - "name": "DayOfWeek", - "typeId": 1, - "readableType": "Entity Extractor" - }, - { - "id": "b8e31be4-300f-455e-894b-6f079abca0a2", - "name": "$Camera.AppName", - "typeId": 1, - "readableType": "Entity Extractor", - "customPrebuiltDomainName": "Camera", - "customPrebuiltModelName": "AppName" - } - ] - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json deleted file mode 100644 index 944e946c02a0..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "AzureRegion": "westus", - "Ocp-Apim-Subscription-Key": "{API key}", - "appId": "{appId}", - "versionId": "{versionId}", - "skip": 0, - "take": 100 - }, - "responses": { - "200": { - "headers": {}, - "body": [ - { - "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767", - "name": "Location", - "typeId": 3, - "readableType": "Hierarchical Entity Extractor", - "children": [ - { - "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82", - "name": "From" - }, - { - "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", - "name": "To" - } - ] - } - ] - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json deleted file mode 100644 index 10b7cd464c02..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json +++ /dev/null @@ -1,123 +0,0 @@ -{ - "parameters": { - "AzureRegion": "westus", - "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", - "versionId": "0.1", - "skip": "0", - "take": "100" - }, - "responses": { - "200": { - "headers": {}, - "body": [ - { - "id": "227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8", - "name": "BookFlight", - "typeId": 0, - "readableType": "Intent Classifier" - }, - { - "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", - "name": "datetime", - "typeId": 2, - "readableType": "Prebuilt Entity Extractor" - }, - { - "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", - "name": "DayOfWeek", - "typeId": 1, - "readableType": "Entity Extractor" - }, - { - "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767", - "name": "Location", - "typeId": 3, - "readableType": "Hierarchical Entity Extractor", - "children": [ - { - "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82", - "name": "From" - }, - { - "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", - "name": "To" - } - ] - }, - { - "id": "8285a9ee-6bc0-4409-87f4-82d539f70529", - "name": "None", - "typeId": 0, - "readableType": "Intent Classifier" - }, - { - "id": "bc1bae43-7904-48ad-a165-88b1910174f9", - "name": "Reservation", - "typeId": 4, - "readableType": "Composite Entity Extractor", - "children": [ - { - "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", - "name": "Location::To" - }, - { - "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", - "name": "datetime" - } - ] - }, - { - "id": "8713b104-78ec-4c4f-9f96-f2e53562cc16", - "name": "States", - "typeId": 5, - "readableType": "Closed List Entity Extractor", - "subLists": [ - { - "id": 1, - "canonicalForm": "new york", - "list": [ - "ny", - "new york" - ] - }, - { - "id": 2, - "canonicalForm": "washington", - "list": [ - "washington", - "wa" - ] - }, - { - "id": 3, - "canonicalForm": "california", - "list": [ - "california", - "ca", - "calif.", - "cal." - ] - } - ] - }, - { - "id": "b8e31be4-300f-455e-894b-6f079abca0a2", - "name": "$Camera.AppName", - "typeId": 1, - "readableType": "Entity Extractor", - "customPrebuiltDomainName": "Camera", - "customPrebuiltModelName": "AppName" - }, - { - "id": "9500536f-ffec-4fab-93ad-6268abb0f73c", - "name": "$Camera.CapturePhoto", - "typeId": 0, - "readableType": "Intent Classifier", - "customPrebuiltDomainName": "Camera", - "customPrebuiltModelName": "CapturePhoto" - } - ] - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json deleted file mode 100644 index f929aee4de2f..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "AzureRegion": "westus", - "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", - "versionId": "0.1", - "skip": "0", - "take": "100" - }, - "responses":{ - "200":{ - "headers": {}, - "body": [ - { - "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", - "name": "datetime", - "typeId": 2, - "readableType": "Prebuilt Entity Extractor" - } - ] - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json deleted file mode 100644 index a28d49739f28..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "AzureRegion": "westus", - "Ocp-Apim-Subscription-Key": "{API key}", - "appId": "{appId}", - "versionId": "{versionId}", - "cEntityId": "{cEntityId}" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "bc1bae43-7904-48ad-a165-88b1910174f9", - "name": "Reservation", - "typeId": 4, - "readableType": "Composite Entity Extractor", - "children": [ - { - "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", - "name": "Location::To" - }, - { - "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", - "name": "datetime" - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json deleted file mode 100644 index 7560a82804c8..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "AzureRegion": "westus", - "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", - "versionId": "1.0" - }, - "responses": { - "200": { - "headers": {}, - "body": [ - { - "id": "b8e31be4-300f-455e-894b-6f079abca0a2", - "name": "Camera.AppName", - "typeId": 1, - "readableType": "Entity Extractor", - "customPrebuiltDomainName": "Camera", - "customPrebuiltModelName": "AppName" - } - ] - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json deleted file mode 100644 index 4f578d9adf12..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "AzureRegion": "westus", - "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", - "versionId": "1.0" - }, - "responses": { - "200": { - "headers": {}, - "body": [ - { - "id": "1aa813da-8d36-4d16-bb13-d6f193290fea", - "name": "Calendar.Find", - "typeId": 0, - "readableType": "Intent Classifier", - "customPrebuiltDomainName": "Calendar", - "customPrebuiltModelName": "Find" - }, - { - "id": "d02b2e38-6b3c-412e-bf9e-f6770a40c9a0", - "name": "Calendar.Location", - "typeId": 1, - "readableType": "Entity Extractor", - "customPrebuiltDomainName": "Calendar", - "customPrebuiltModelName": "Location" - } - ] - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetEntityInfoRequest.json deleted file mode 100644 index bd0c094268b5..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetEntityInfoRequest.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "AzureRegion": "westus", - "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", - "versionId": "0.1", - "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", - "name": "DayOfWeek", - "typeId": 1, - "readableType": "Entity Extractor" - } - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json deleted file mode 100644 index 81e0ceea5f57..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "AzureRegion": "westus", - "Ocp-Apim-Subscription-Key": "{API key}", - "appId": "{appId}", - "versionId": "{versionId}", - "hEntityId": "{hEntityId}" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767", - "name": "Location", - "typeId": 3, - "readableType": "Hierarchical Entity Extractor", - "children": [ - { - "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82", - "name": "From" - }, - { - "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", - "name": "To" - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json deleted file mode 100644 index ae88f298e8e9..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Programmatic/stable/v2.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "AzureRegion": "westus", - "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", - "versionId": "0.1", - "prebuiltId": "a065c863-918e-4c56-a267-9aaae3c7dced" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "a065c863-918e-4c56-a267-9aaae3c7dced", - "name": "datetimeV2", - "typeId": 2, - "readableType": "Prebuilt Entity Extractor" - } - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md index 487f09cdcf3b..a9389a7cc28e 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md @@ -37,17 +37,17 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-go + - repo: azure-sdk-for-python ``` ### Runtime 2.0 - CSharp Settings These settings apply only when `--csharp` is specified on the command line. ``` yaml $(csharp) csharp: - override-client-name: LuisRuntimeAPI sync-methods: None license-header: MICROSOFT_MIT_NO_VERSION azure-arm: false - namespace: Microsoft.Azure.CognitiveServices.Language.LUIS + namespace: Microsoft.Azure.CognitiveServices.Language.LUIS.Runtime output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Language/LUIS/Runtime/Generated clear-output-folder: true @@ -97,10 +97,12 @@ Please also specify `--azure-libraries-for-java-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.language.luis.runtime + package-name: azure-cognitiveservices-language-luis + clear-output-folder: true + +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-language-luis/azure/cognitiveservices/language/luis/runtime +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-language-luis +``` diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/LUIS-Runtime.json b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/LUIS-Runtime.json index d3b080f6df81..d7fc0efa87ae 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/LUIS-Runtime.json +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/LUIS-Runtime.json @@ -1,18 +1,11 @@ { "swagger": "2.0", "info": { - "title": "Language Understanding Intelligent Service (LUIS) Endpoint API for running predictions and extracting user intentions and entities from utterances.", - "version": "v2.0" + "title": "LUIS Runtime Client", + "version": "2.0" }, - "x-ms-parameterized-host": { - "hostTemplate": "{AzureRegion}.api.cognitive.microsoft.com", - "parameters": [ - { - "$ref": "../../../../Common/ExtendedRegions.json#/parameters/AzureRegion" - } - ] - }, - "basePath": "/luis/v2.0/apps", + "host": "api.cognitive.microsoft.com", + "basePath": "/luis/v2.0", "schemes": [ "https" ], @@ -29,7 +22,7 @@ } ], "paths": { - "/{appId}": { + "/apps/{appId}": { "get": { "description": "Gets predictions for a given utterance, in the form of intents and entities. The current maximum query size is 500 characters.", "operationId": "Prediction_Resolve2", @@ -238,6 +231,9 @@ "items": { "$ref": "#/definitions/CompositeEntityModel" } + }, + "sentimentAnalysis": { + "$ref": "#/definitions/Sentiment" } } }, @@ -386,6 +382,20 @@ "description": "Cause of the error." } } + }, + "Sentiment": { + "description": "Sentiment of the input utterance.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The polarity of the sentiment, can be positive, neutral or negative." + }, + "score": { + "type": "number", + "description": "Score of the sentiment, ranges from 0 (most negative) to 1 (most positive)." + } + } } } } \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaGetRequest.json b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaGetRequest.json index 40071db127d7..9794022b988e 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaGetRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaGetRequest.json @@ -52,7 +52,11 @@ ] } } - ] + ], + "sentimentAnalysis": { + "label": "positive", + "score": 0.9163064 + } } } } diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaPostRequest.json b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaPostRequest.json index 40071db127d7..9794022b988e 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaPostRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaPostRequest.json @@ -52,7 +52,11 @@ ] } } - ] + ], + "sentimentAnalysis": { + "label": "positive", + "score": 0.9163064 + } } } } diff --git a/specification/cognitiveservices/data-plane/NewsSearch/readme.md b/specification/cognitiveservices/data-plane/NewsSearch/readme.md index fb875c42170b..f67edcdc06c9 100644 --- a/specification/cognitiveservices/data-plane/NewsSearch/readme.md +++ b/specification/cognitiveservices/data-plane/NewsSearch/readme.md @@ -38,9 +38,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_newssearch'] ``` @@ -116,9 +119,11 @@ Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::NewsSearch::V1_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_newssearch/lib +title: "NewsSearchClient" +``` diff --git a/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json b/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json index c9fc6f196705..f05cfc1aba66 100644 --- a/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json +++ b/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json @@ -23,10 +23,10 @@ } }, "host": "api.cognitive.microsoft.com", + "basePath": "/bing/v7.0", "schemes": [ "https" ], - "basePath": "/bing/v7.0", "produces": [ "application/json" ], diff --git a/specification/cognitiveservices/data-plane/SpellCheck/readme.md b/specification/cognitiveservices/data-plane/SpellCheck/readme.md index 41666de898d9..59dd20fa22af 100644 --- a/specification/cognitiveservices/data-plane/SpellCheck/readme.md +++ b/specification/cognitiveservices/data-plane/SpellCheck/readme.md @@ -18,7 +18,7 @@ openapi-type: data-plane These settings apply only when `--tag=release_1_0` is specified on the command line. ``` yaml $(tag) == 'release_1_0' -input-file: stable/V1.0/SpellCheck.json +input-file: stable/v1.0/SpellCheck.json ``` ## Swagger to SDK @@ -29,9 +29,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_spellcheck'] ``` @@ -107,9 +110,11 @@ Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::SpellCheck::V1_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_spellcheck/lib +title: "SpellCheckClient" +``` diff --git a/specification/cognitiveservices/data-plane/SpellCheck/stable/V1.0/SpellCheck.json b/specification/cognitiveservices/data-plane/SpellCheck/stable/v1.0/SpellCheck.json similarity index 99% rename from specification/cognitiveservices/data-plane/SpellCheck/stable/V1.0/SpellCheck.json rename to specification/cognitiveservices/data-plane/SpellCheck/stable/v1.0/SpellCheck.json index 7f8ccebabb97..d1e2d1822c30 100644 --- a/specification/cognitiveservices/data-plane/SpellCheck/stable/V1.0/SpellCheck.json +++ b/specification/cognitiveservices/data-plane/SpellCheck/stable/v1.0/SpellCheck.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Spell Check API", + "title": "Spell Check Client", "description": "The Spell Check API - V7 lets you check a text string for spelling and grammar errors.", "version": "1.0" }, @@ -23,10 +23,10 @@ } }, "host": "api.cognitive.microsoft.com", + "basePath": "/bing/v7.0", "schemes": [ "https" ], - "basePath": "/bing/v7.0", "produces": [ "application/json" ], diff --git a/specification/cognitiveservices/data-plane/SpellCheck/stable/V1.0/examples/SuccessfulProofModeRequest.json b/specification/cognitiveservices/data-plane/SpellCheck/stable/v1.0/examples/SuccessfulProofModeRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/SpellCheck/stable/V1.0/examples/SuccessfulProofModeRequest.json rename to specification/cognitiveservices/data-plane/SpellCheck/stable/v1.0/examples/SuccessfulProofModeRequest.json diff --git a/specification/cognitiveservices/data-plane/SpellCheck/stable/V1.0/examples/SuccessfulSpellModeRequest.json b/specification/cognitiveservices/data-plane/SpellCheck/stable/v1.0/examples/SuccessfulSpellModeRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/SpellCheck/stable/V1.0/examples/SuccessfulSpellModeRequest.json rename to specification/cognitiveservices/data-plane/SpellCheck/stable/v1.0/examples/SuccessfulSpellModeRequest.json diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/readme.md b/specification/cognitiveservices/data-plane/TextAnalytics/readme.md index 3ce0e49c6a96..d86e281c4031 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/readme.md +++ b/specification/cognitiveservices/data-plane/TextAnalytics/readme.md @@ -135,9 +135,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_textanalytics'] ``` @@ -149,7 +152,7 @@ csharp: license-header: MICROSOFT_MIT_NO_VERSION azure-arm: false namespace: Microsoft.Azure.CognitiveServices.Language.TextAnalytics - output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Language/Microsoft.CognitiveServices.Language/Generated/TextAnalytics + output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Language/TextAnalytics/Generated/TextAnalytics clear-output-folder: true ``` @@ -216,9 +219,10 @@ Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'release_2_0' && $(ruby) +namespace: "Azure::CognitiveServices::TextAnalytics::V2_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_textanalytics/lib +title: "TextAnalyticsClient" +``` diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/TextAnalytics.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/TextAnalytics.json index 02c8a78403b4..7ec0a0a41ce3 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/TextAnalytics.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/TextAnalytics.json @@ -7,17 +7,9 @@ "url": "https://azure.microsoft.com/en-us/services/cognitive-services/text-analytics/", "email": "mlapi@microsoft.com" }, - "title": "Text Analytics API", + "title": "Text Analytics Client", "description": "The Text Analytics API is a suite of text analytics web services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction and language detection. No training data is needed to use this API; just bring your text data. This API uses advanced natural language processing techniques to deliver best in class predictions. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview" }, - "x-ms-parameterized-host": { - "hostTemplate": "{AzureRegion}.api.cognitive.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/ExtendedRegions.json#/parameters/AzureRegion" - } - ] - }, "securityDefinitions": { "apim_key": { "type": "apiKey", @@ -30,18 +22,19 @@ "apim_key": [] } ], - "basePath": "/text/analytics", + "host": "api.cognitive.microsoft.com", + "basePath": "/text/analytics/v2.0", "schemes": [ "https" ], "paths": { - "/v2.0/keyPhrases": { + "/keyPhrases": { "post": { "tags": [ "Key Phrases" ], "summary": "The API returns a list of strings denoting the key talking points in the input text.", - "description": "We employ techniques from Microsoft Office's sophisticated Natural Language Processing toolkit. See the Text Analytics Documentation for details about the languages that are supported by key phrase extraction.", + "description": "See the Text Analytics Documentation for details about the languages that are supported by key phrase extraction.", "operationId": "Key Phrases", "consumes": [ "application/json" @@ -82,7 +75,7 @@ "deprecated": false } }, - "/v2.0/languages": { + "/languages": { "post": { "tags": [ "Detect Language" @@ -122,20 +115,20 @@ } }, "x-ms-examples": { - "Successful Key Phrase request": { + "Successful Detect Language request": { "$ref": "./examples//SuccessfulLanguagesRequest.json" } }, "deprecated": false } }, - "/v2.0/sentiment": { + "/sentiment": { "post": { "tags": [ "Sentiment" ], "summary": "The API returns a numeric score between 0 and 1.", - "description": "Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment. Sentiment score is generated using classification techniques. The input features to the classifier include n-grams, features generated from part-of-speech tags, and word embeddings. See the Text Analytics Documentation for details about the languages that are supported by sentiment analysis.", + "description": "Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment. A score of 0.5 indicates the lack of sentiment (e.g. a factoid statement). See the Text Analytics Documentation for details about the languages that are supported by sentiment analysis.", "operationId": "Sentiment", "consumes": [ "application/json" @@ -169,12 +162,59 @@ } }, "x-ms-examples": { - "Successful Key Phrase request": { + "Successful Sentiment request": { "$ref": "./examples//SuccessfulSentimentRequest.json" } }, "deprecated": false } + }, + "/entities": { + "post": { + "tags": [ + "Entities" + ], + "summary": "The API returns a list of recognized entities in a given document.", + "description": "To get even more information on each recognized entity we recommend using the Bing Entity Search API by querying for the recognized entities names. See the Supported languages in Text Analytics API for the list of enabled languages.", + "operationId": "Entities", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "input", + "in": "body", + "description": "Collection of documents to analyze.", + "required": true, + "schema": { + "$ref": "#/definitions/MultiLanguageBatchInput" + } + } + ], + "responses": { + "200": { + "description": "A successful call results in a list of recognized entities returned for each valid document", + "schema": { + "$ref": "#/definitions/EntitiesBatchResult" + } + }, + "default": { + "description": "Error Response", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Entities request": { + "$ref": "./examples//SuccessfulEntitiesRequest.json" + } + }, + "deprecated": false + } } }, "definitions": { @@ -441,6 +481,96 @@ "type": "string" } } + }, + "EntitiesBatchResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "items": { + "$ref": "#/definitions/EntitiesBatchResultItem" + }, + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorRecord" + }, + "readOnly": true + } + } + }, + "EntitiesBatchResultItem": { + "type": "object", + "properties": { + "id": { + "description": "Unique document identifier.", + "type": "string", + "readOnly": true + }, + "entities": { + "description": "Recognized entities in the document.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityRecord" + }, + "readOnly": true + } + } + }, + "EntityRecord": { + "type": "object", + "properties": { + "name": { + "description": "Entity formal name.", + "type": "string" + }, + "matches": { + "description": "List of instances this entity appears in the text.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchRecord" + }, + "readOnly": true + }, + "wikipediaLanguage": { + "description": "Wikipedia language for which the WikipediaId and WikipediaUrl refers to.", + "type": "string" + }, + "wikipediaId": { + "description": "Wikipedia unique identifier of the recognized entity.", + "type": "string" + }, + "wikipediaUrl": { + "description": "URL for the entity's English Wikipedia page.", + "type": "string", + "readOnly": true + }, + "bingId": { + "description": "Bing unique identifier of the recognized entity. Use in conjunction with the Bing Entity Search API to fetch additional relevant information.", + "type": "string" + } + } + }, + "MatchRecord": { + "type": "object", + "properties": { + "text": { + "description": "Entity text as appears in the request.", + "type": "string" + }, + "offset": { + "format": "int32", + "description": "Start position (in Unicode characters) for the entity match text.", + "type": "integer" + }, + "length": { + "format": "int32", + "description": "Length (in Unicode characters) for the entity match text.", + "type": "integer" + } + } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulEntitiesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulEntitiesRequest.json new file mode 100644 index 000000000000..01a7fd165fa2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulEntitiesRequest.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "AzureRegion": "westus", + "input": { + "documents": [ + { + "language": "en", + "id": "1", + "text": "Microsoft released Windows 10" + }, + { + "language": "en", + "id": "2", + "text": "In 1975, Bill Gates III and Paul Allen founded the company." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "id": "1", + "entities": [ + { + "name": "Windows 10", + "matches": [ + { + "text": "Windows 10", + "offset": 19, + "length": 10 + } + ], + "wikipediaLanguage": "en", + "wikipediaId": "Windows 10", + "wikipediaUrl": "https://en.wikipedia.org/wiki/Windows_10", + "bingId": "5f9fbd03-49c4-39ef-cc95-de83ab897b94" + }, + { + "name": "Microsoft", + "matches": [ + { + "text": "Microsoft", + "offset": 0, + "length": 9 + } + ], + "wikipediaLanguage": "en", + "wikipediaId": "Microsoft", + "wikipediaUrl": "https://en.wikipedia.org/wiki/Microsoft", + "bingId": "a093e9b9-90f5-a3d5-c4b8-5855e1b01f85" + } + ] + }, + { + "id": "2", + "entities": [ + { + "name": "Bill Gates", + "matches": [ + { + "text": "Bill Gates III", + "offset": 9, + "length": 14 + } + ], + "wikipediaLanguage": "en", + "wikipediaId": "Bill Gates", + "wikipediaUrl": "https://en.wikipedia.org/wiki/Bill_Gates", + "bingId": "0d47c987-0042-5576-15e8-97af601614fa" + }, + { + "name": "Paul Allen", + "matches": [ + { + "text": "Paul Allen", + "offset": 28, + "length": 10 + } + ], + "wikipediaLanguage": "en", + "wikipediaId": "Paul Allen", + "wikipediaUrl": "https://en.wikipedia.org/wiki/Paul_Allen", + "bingId": "df2c4376-9923-6a54-893f-2ee5a5badbc7" + } + ] + } + ], + "errors": [] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulKeyPhrasesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulKeyPhrasesRequest.json index 130d51f95106..3980b96282f8 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulKeyPhrasesRequest.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulKeyPhrasesRequest.json @@ -1,7 +1,8 @@ { "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "body": { + "AzureRegion": "westus", + "input": { "documents": [ { "id": "1", @@ -60,4 +61,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulLanguagesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulLanguagesRequest.json index 25bc96107ef6..747ab22bbcfd 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulLanguagesRequest.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulLanguagesRequest.json @@ -1,7 +1,8 @@ { "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "body": { + "AzureRegion": "westus", + "input": { "documents": [ { "id": "1", @@ -72,4 +73,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulSentimentRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulSentimentRequest.json index 8bda71709e96..210bee807bbc 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulSentimentRequest.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulSentimentRequest.json @@ -1,7 +1,8 @@ { "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "body": { + "AzureRegion": "westus", + "input": { "documents": [ { "id": "1", @@ -52,4 +53,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/VideoSearch/readme.md b/specification/cognitiveservices/data-plane/VideoSearch/readme.md index d5194d168f41..d791055165a0 100644 --- a/specification/cognitiveservices/data-plane/VideoSearch/readme.md +++ b/specification/cognitiveservices/data-plane/VideoSearch/readme.md @@ -29,9 +29,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_videosearch'] ``` @@ -107,9 +110,11 @@ Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::VideoSearch::V1_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_videosearch/lib +title: "VideoSearchClient" +``` diff --git a/specification/cognitiveservices/data-plane/VideoSearch/stable/v1.0/VideoSearch.json b/specification/cognitiveservices/data-plane/VideoSearch/stable/v1.0/VideoSearch.json index 09441ef1b486..3d87a12b7a91 100644 --- a/specification/cognitiveservices/data-plane/VideoSearch/stable/v1.0/VideoSearch.json +++ b/specification/cognitiveservices/data-plane/VideoSearch/stable/v1.0/VideoSearch.json @@ -23,10 +23,10 @@ } }, "host": "api.cognitive.microsoft.com", + "basePath": "/bing/v7.0", "schemes": [ "https" ], - "basePath": "/bing/v7.0", "produces": [ "application/json" ], diff --git a/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json new file mode 100644 index 000000000000..84c6a3a713a8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json @@ -0,0 +1,1270 @@ +{ + "swagger": "2.0", + "info": { + "title": "Visual Search API", + "description": "Visual Search API lets you discover insights about an image such as visually similar images, shopping sources, and related searches. The API can also perform text recognition, identify entities (people, places, things), return other topical content for the user to explore, and more. For more information, see [Visual Search Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).", + "version": "1.0" + }, + "parameters": { + "x-bingapis-sdk": { + "name": "X-BingApis-SDK", + "description": "Activate swagger compliance.", + "x-ms-parameter-location": "method", + "required": true, + "type": "string", + "in": "header", + "x-ms-enum": { + "name": "XBingApisSDK", + "modelAsString": true + }, + "enum": [ + "true" + ] + } + }, + "host": "api.cognitive.microsoft.com", + "basePath": "/bing/v7.0", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "apiKeyHeader": { + "name": "Ocp-Apim-Subscription-Key", + "type": "apiKey", + "in": "header" + } + }, + "security": [ + { + "apiKeyHeader": [] + } + ], + "paths": { + "/images/visualsearch": { + "post": { + "summary": "Visual Search API lets you discover insights about an image such as visually similar images, shopping sources, and related searches. The API can also perform text recognition, identify entities (people, places, things), return other topical content for the user to explore, and more. For more information, see [Visual Search Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).", + "operationId": "Images_VisualSearch", + "tags": [ + "ImageVisualSearch" + ], + "consumes": [ + "multipart/form-data", + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "parameters": [ + { + "$ref": "#/parameters/x-bingapis-sdk" + }, + { + "name": "Accept", + "in": "header", + "description": "The default media type is application/json. To specify that the response use [JSON-LD](http://json-ld.org/), set the Accept header to application/ld+json.", + "required": false, + "type": "string" + }, + { + "name": "Accept-Language", + "x-ms-client-name": "AcceptLanguage", + "in": "header", + "description": "A comma-delimited list of one or more languages to use for user interface strings. The list is in decreasing order of preference. For additional information, including expected format, see [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#setlang) query parameter are mutually exclusive; do not specify both. If you set this header, you must also specify the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#cc) query parameter. To determine the market to return results for, Bing uses the first supported language it finds from the list and combines it with the cc parameter value. If the list does not include a supported language, Bing finds the closest language and market that supports the request or it uses an aggregated or default market for the results. To determine the market that Bing used, see the BingAPIs-Market header. Use this header and the cc query parameter only if you specify multiple languages. Otherwise, use the [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#mkt) and [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#setlang) query parameters. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Any links to Bing.com properties in the response objects apply the specified language.", + "required": false, + "type": "string" + }, + { + "name": "Content-Type", + "x-ms-client-name": "ContentType", + "in": "header", + "description": "Must be set to multipart/form-data and include a boundary parameter (for example, multipart/form-data; boundary=). For more details, see [Content form types]( https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/overview#content-form-types).", + "required": false, + "type": "string" + }, + { + "name": "User-Agent", + "x-ms-client-name": "UserAgent", + "in": "header", + "description": "The user agent originating the request. Bing uses the user agent to provide mobile users with an optimized experience. Although optional, you are encouraged to always specify this header. The user-agent should be the same string that any commonly used browser sends. For information about user agents, see [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The following are examples of user-agent strings. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53.", + "required": false, + "type": "string" + }, + { + "name": "X-MSEdge-ClientID", + "x-ms-client-name": "ClientId", + "in": "header", + "description": "Bing uses this header to provide users with consistent behavior across Bing API calls. Bing often flights new features and improvements, and it uses the client ID as a key for assigning traffic on different flights. If you do not use the same client ID for a user across multiple requests, then Bing may assign the user to multiple conflicting flights. Being assigned to multiple conflicting flights can lead to an inconsistent user experience. For example, if the second request has a different flight assignment than the first, the experience may be unexpected. Also, Bing can use the client ID to tailor web results to that client ID’s search history, providing a richer experience for the user. Bing also uses this header to help improve result rankings by analyzing the activity generated by a client ID. The relevance improvements help with better quality of results delivered by Bing APIs and in turn enables higher click-through rates for the API consumer. IMPORTANT: Although optional, you should consider this header required. Persisting the client ID across multiple requests for the same end user and device combination enables 1) the API consumer to receive a consistent user experience, and 2) higher click-through rates via better quality of results from the Bing APIs. Each user that uses your application on the device must have a unique, Bing generated client ID. If you do not include this header in the request, Bing generates an ID and returns it in the X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is the first time the user uses your app on that device. Use the client ID for each Bing API request that your app makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a persistent HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other apps such as mobile apps, use the device's persistent storage to persist the ID. The next time the user uses your app on that device, get the client ID that you persisted. Bing responses may or may not include this header. If the response includes this header, capture the client ID and use it for all subsequent Bing requests for the user on that device. ATTENTION: You must ensure that this Client ID is not linkable to any authenticatable user account information. If you include the X-MSEdge-ClientID, you must not include cookies in the request.", + "required": false, + "type": "string" + }, + { + "name": "X-MSEdge-ClientIP", + "x-ms-client-name": "ClientIp", + "in": "header", + "description": "The IPv4 or IPv6 address of the client device. The IP address is used to discover the user's location. Bing uses the location information to determine safe search behavior. Although optional, you are encouraged to always specify this header and the X-Search-Location header. Do not obfuscate the address (for example, by changing the last octet to 0). Obfuscating the address results in the location not being anywhere near the device's actual location, which may result in Bing serving erroneous results.", + "required": false, + "type": "string" + }, + { + "name": "X-Search-Location", + "x-ms-client-name": "Location", + "in": "header", + "description": "A semicolon-delimited list of key/value pairs that describe the client's geographical location. Bing uses the location information to determine safe search behavior and to return relevant local content. Specify the key/value pair as :. The following are the keys that you use to specify the user's location. lat (required): The latitude of the client's location, in degrees. The latitude must be greater than or equal to -90.0 and less than or equal to +90.0. Negative values indicate southern latitudes and positive values indicate northern latitudes. long (required): The longitude of the client's location, in degrees. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy of the coordinates. Pass the value returned by the device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC UNIX timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since January 1, 1970.) head (optional): The client's relative heading or direction of travel. Specify the direction of travel as degrees from 0 through 360, counting clockwise relative to true north. Specify this key only if the sp key is nonzero. sp (optional): The horizontal velocity (speed), in meters per second, that the client device is traveling. alt (optional): The altitude of the client device, in meters. are (optional): The radius, in meters, that specifies the vertical accuracy of the coordinates. Specify this key only if you specify the alt key. Although many of the keys are optional, the more information that you provide, the more accurate the location results are. Although optional, you are encouraged to always specify the user's geographical location. Providing the location is especially important if the client's IP address does not accurately reflect the user's physical location (for example, if the client uses VPN). For optimal results, you should include this header and the X-MSEdge-ClientIP header, but at a minimum, you should include this header.", + "required": false, + "type": "string" + }, + { + "name": "knowledgeRequest", + "x-ms-client-name": "VisualSearchRequest", + "in": "formData", + "description": "The form data is a JSON object that identifies the image using an insights token or URL to the image. The object may also include an optional crop area that identifies an area of interest in the image. The insights token and URL are mutually exclusive – do not specify both. You may specify knowledgeRequest form data and image form data in the same request only if knowledgeRequest form data specifies the cropArea field only (it must not include an insights token or URL).", + "required": false, + "type": "string" + }, + { + "name": "image", + "x-ms-client-name": "Image", + "in": "formData", + "description": "The form data is an image binary. The Content-Disposition header's filename parameter must be set to \"image\". You must specify an image binary if you do not use knowledgeRequest form data to specify the image; you may not use both forms to specify an image. You may specify knowledgeRequest form data and image form data in the same request only if knowledgeRequest form data specifies the cropArea field only (it must not include an insights token or URL).", + "required": false, + "type": "file" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ImageKnowledge" + } + }, + "default": { + "description": "An error has occurred. Check the response type and/or status code for more details.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful visual search": { + "$ref": "./examples/SuccessfulVisualSearchRequest.json" + } + } + } + } + }, + "definitions": { + "ImageKnowledge": { + "allOf": [ + { + "$ref": "#/definitions/Response" + } + ], + "type": "object", + "properties": { + "tags": { + "description": "A list of visual search tags.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ImageTag" + } + }, + "image": { + "description": "Image object containing metadata about the requested image.", + "$ref": "#/definitions/ImageObject", + "readOnly": true + } + } + }, + "Response": { + "description": "Defines a response. All schemas that return at the root of the response must inherit from this object.", + "allOf": [ + { + "$ref": "#/definitions/Identifiable" + } + ], + "type": "object", + "properties": { + "readLink": { + "description": "The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.", + "readOnly": true, + "type": "string" + }, + "webSearchUrl": { + "description": "The URL to Bing's search result for this item.", + "readOnly": true, + "type": "string" + } + } + }, + "ImageTag": { + "allOf": [ + { + "$ref": "#/definitions/Thing" + } + ], + "type": "object", + "properties": { + "displayName": { + "description": "Display name for this tag. For the default tag, the display name is empty.", + "readOnly": true, + "type": "string" + }, + "boundingBox": { + "description": "The bounding box for this tag. For the default tag, there is no bounding box.", + "$ref": "#/definitions/ImageTagRegion", + "readOnly": true + }, + "actions": { + "description": "Actions within this tag. The order of the items denotes the default ranking order of these actions, with the first action being the most likely user intent.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ImageAction" + } + } + } + }, + "ImageObject": { + "description": "Defines an image.", + "allOf": [ + { + "$ref": "#/definitions/MediaObject" + } + ], + "type": "object", + "properties": { + "thumbnail": { + "description": "The URL to a thumbnail of the image.", + "$ref": "#/definitions/ImageObject", + "readOnly": true + }, + "imageInsightsToken": { + "description": "The token that you use in a subsequent call to Visual Search API to get additional information about the image. For information about using this token, see the imageInsightsToken field inside the knowledgeRequest request parameter.", + "readOnly": true, + "type": "string" + }, + "insightsMetadata": { + "description": "A count of the number of websites where you can shop or perform other actions related to the image. For example, if the image is of an apple pie, this object includes a count of the number of websites where you can buy an apple pie. To indicate the number of offers in your UX, include badging such as a shopping cart icon that contains the count. When the user clicks on the icon, use imageInisghtsToken in a subsequent Visual Search API call to get the list of shopping websites.", + "$ref": "#/definitions/ImagesImageMetadata", + "readOnly": true + }, + "imageId": { + "description": "Unique Id for the image.", + "readOnly": true, + "type": "string" + }, + "accentColor": { + "description": "A three-byte hexadecimal number that represents the color that dominates the image. Use the color as the temporary background in your client until the image is loaded.", + "readOnly": true, + "type": "string" + }, + "visualWords": { + "description": "For interal use only.", + "readOnly": true, + "type": "string" + } + } + }, + "Identifiable": { + "description": "Defines the identity of a resource.", + "allOf": [ + { + "$ref": "#/definitions/ResponseBase" + } + ], + "type": "object", + "properties": { + "id": { + "description": "A String identifier.", + "readOnly": true, + "type": "string" + } + } + }, + "ErrorResponse": { + "description": "The top-level response that represents a failed request.", + "allOf": [ + { + "$ref": "#/definitions/Response" + } + ], + "type": "object", + "required": [ + "errors" + ], + "properties": { + "errors": { + "description": "A list of errors that describe the reasons why the request failed.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "Thing": { + "description": "Defines a thing.", + "allOf": [ + { + "$ref": "#/definitions/Response" + } + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the thing represented by this object.", + "readOnly": true, + "type": "string" + }, + "url": { + "description": "The URL to get more information about the thing represented by this object.", + "readOnly": true, + "type": "string" + }, + "image": { + "description": "An image of the item.", + "$ref": "#/definitions/ImageObject", + "readOnly": true + }, + "description": { + "description": "A short description of the item.", + "readOnly": true, + "type": "string" + }, + "alternateName": { + "description": "An alias for the item.", + "readOnly": true, + "type": "string" + }, + "bingId": { + "description": "An ID that uniquely identifies this item.", + "readOnly": true, + "type": "string" + } + } + }, + "Action": { + "allOf": [ + { + "$ref": "#/definitions/CreativeWork" + } + ], + "type": "object", + "properties": { + "result": { + "description": "The result produced in the action.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Thing" + } + }, + "displayName": { + "description": "A display name for the action.", + "readOnly": true, + "type": "string" + }, + "isTopAction": { + "description": "A Boolean representing whether this result is the top action.", + "readOnly": true, + "type": "boolean" + }, + "serviceUrl": { + "description": "Use this URL to get additional data to determine how to take the appropriate action. For example, the serviceUrl might return JSON along with an image URL.", + "readOnly": true, + "type": "string" + } + } + }, + "ImageTagRegion": { + "type": "object", + "required": [ + "queryRectangle", + "displayRectangle" + ], + "properties": { + "queryRectangle": { + "description": "A rectangle that outlines the area of interest for this tag.", + "$ref": "#/definitions/NormalizedQuadrilateral" + }, + "displayRectangle": { + "description": "A recommended rectangle to show to the user.", + "$ref": "#/definitions/NormalizedQuadrilateral" + } + } + }, + "ImageAction": { + "allOf": [ + { + "$ref": "#/definitions/Action" + } + ], + "type": "object", + "properties": { + "actionType": { + "description": "A string representing the type of action.", + "readOnly": true, + "type": "string" + } + } + }, + "MediaObject": { + "description": "Defines a media object.", + "allOf": [ + { + "$ref": "#/definitions/CreativeWork" + } + ], + "type": "object", + "properties": { + "contentUrl": { + "description": "Original URL to retrieve the source (file) for the media object (e.g., the source URL for the image).", + "readOnly": true, + "type": "string" + }, + "hostPageUrl": { + "description": "URL of the page that hosts the media object.", + "readOnly": true, + "type": "string" + }, + "contentSize": { + "description": "Size of the media object content. Use format \"value unit\" (e.g., \"1024 B\").", + "readOnly": true, + "type": "string" + }, + "encodingFormat": { + "description": "Encoding format (e.g., mp3, mp4, jpeg, etc).", + "readOnly": true, + "type": "string" + }, + "hostPageDisplayUrl": { + "description": "Display URL of the page that hosts the media object.", + "readOnly": true, + "type": "string" + }, + "width": { + "description": "The width of the media object, in pixels.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "height": { + "description": "The height of the media object, in pixels.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "ImagesImageMetadata": { + "description": "Defines a count of the number of websites where you can shop or perform other actions related to the image.", + "x-ms-discriminator-value": "Images/ImageMetadata", + "type": "object", + "properties": { + "shoppingSourcesCount": { + "description": "The number of websites that sell the products seen in the image.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "recipeSourcesCount": { + "description": "The number of websites that offer recipes of the food seen in the image.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "aggregateOffer": { + "description": "A summary of the online offers of products found in the image. For example, if the image is of a dress, the offer might identify the lowest price and the number of offers found. Only visually similar products insights include this field. The offer includes the following fields: Name, AggregateRating, OfferCount, and LowPrice.", + "$ref": "#/definitions/AggregateOffer", + "readOnly": true + } + } + }, + "ResponseBase": { + "description": "Response base.", + "discriminator": "_type", + "type": "object", + "properties": { + "_type": { + "type": "string" + } + } + }, + "Error": { + "description": "Defines the error that occurred.", + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "description": "The error code that identifies the category of error.", + "type": "string", + "default": "None", + "enum": [ + "None", + "ServerError", + "InvalidRequest", + "RateLimitExceeded", + "InvalidAuthorization", + "InsufficientAuthorization" + ], + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true + } + }, + "subCode": { + "description": "The error code that further helps to identify the error.", + "readOnly": true, + "type": "string", + "enum": [ + "UnexpectedError", + "ResourceError", + "NotImplemented", + "ParameterMissing", + "ParameterInvalidValue", + "HttpNotAllowed", + "Blocked", + "AuthorizationMissing", + "AuthorizationRedundancy", + "AuthorizationDisabled", + "AuthorizationExpired" + ], + "x-ms-enum": { + "name": "ErrorSubCode", + "modelAsString": true + } + }, + "message": { + "description": "A description of the error.", + "type": "string" + }, + "moreDetails": { + "description": "A description that provides additional information about the error.", + "readOnly": true, + "type": "string" + }, + "parameter": { + "description": "The parameter in the request that caused the error.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "The parameter's value in the request that was not valid.", + "readOnly": true, + "type": "string" + } + } + }, + "CreativeWork": { + "description": "The most generic kind of creative work, including books, movies, photographs, software programs, etc.", + "allOf": [ + { + "$ref": "#/definitions/Thing" + } + ], + "type": "object", + "properties": { + "thumbnailUrl": { + "description": "The URL to a thumbnail of the item.", + "readOnly": true, + "type": "string" + }, + "provider": { + "description": "The source of the creative work.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Thing" + } + }, + "datePublished": { + "description": "The date on which the CreativeWork was published.", + "readOnly": true, + "type": "string" + }, + "text": { + "description": "Text content of this creative work.", + "readOnly": true, + "type": "string" + } + } + }, + "Offer": { + "description": "Defines a merchant's offer.", + "allOf": [ + { + "$ref": "#/definitions/Thing" + } + ], + "type": "object", + "properties": { + "seller": { + "description": "Seller for this offer.", + "$ref": "#/definitions/Organization", + "readOnly": true + }, + "price": { + "description": "The item's price.", + "readOnly": true, + "type": "number", + "format": "float" + }, + "priceCurrency": { + "description": "The monetary currency. For example, USD.", + "readOnly": true, + "type": "string", + "default": "USD", + "enum": [ + "USD", + "CAD", + "GBP", + "EUR", + "COP", + "JPY", + "CNY", + "AUD", + "INR", + "AED", + "AFN", + "ALL", + "AMD", + "ANG", + "AOA", + "ARS", + "AWG", + "AZN", + "BAM", + "BBD", + "BDT", + "BGN", + "BHD", + "BIF", + "BMD", + "BND", + "BOB", + "BOV", + "BRL", + "BSD", + "BTN", + "BWP", + "BYR", + "BZD", + "CDF", + "CHE", + "CHF", + "CHW", + "CLF", + "CLP", + "COU", + "CRC", + "CUC", + "CUP", + "CVE", + "CZK", + "DJF", + "DKK", + "DOP", + "DZD", + "EGP", + "ERN", + "ETB", + "FJD", + "FKP", + "GEL", + "GHS", + "GIP", + "GMD", + "GNF", + "GTQ", + "GYD", + "HKD", + "HNL", + "HRK", + "HTG", + "HUF", + "IDR", + "ILS", + "IQD", + "IRR", + "ISK", + "JMD", + "JOD", + "KES", + "KGS", + "KHR", + "KMF", + "KPW", + "KRW", + "KWD", + "KYD", + "KZT", + "LAK", + "LBP", + "LKR", + "LRD", + "LSL", + "LYD", + "MAD", + "MDL", + "MGA", + "MKD", + "MMK", + "MNT", + "MOP", + "MRO", + "MUR", + "MVR", + "MWK", + "MXN", + "MXV", + "MYR", + "MZN", + "NAD", + "NGN", + "NIO", + "NOK", + "NPR", + "NZD", + "OMR", + "PAB", + "PEN", + "PGK", + "PHP", + "PKR", + "PLN", + "PYG", + "QAR", + "RON", + "RSD", + "RUB", + "RWF", + "SAR", + "SBD", + "SCR", + "SDG", + "SEK", + "SGD", + "SHP", + "SLL", + "SOS", + "SRD", + "SSP", + "STD", + "SYP", + "SZL", + "THB", + "TJS", + "TMT", + "TND", + "TOP", + "TRY", + "TTD", + "TWD", + "TZS", + "UAH", + "UGX", + "UYU", + "UZS", + "VEF", + "VND", + "VUV", + "WST", + "XAF", + "XCD", + "XOF", + "XPF", + "YER", + "ZAR", + "ZMW" + ], + "x-ms-enum": { + "name": "Currency", + "modelAsString": true + } + }, + "availability": { + "description": "The item's availability. The following are the possible values: Discontinued, InStock, InStoreOnly, LimitedAvailability, OnlineOnly, OutOfStock, PreOrder, SoldOut.", + "readOnly": true, + "type": "string", + "enum": [ + "Discontinued", + "InStock", + "InStoreOnly", + "LimitedAvailability", + "OnlineOnly", + "OutOfStock", + "PreOrder", + "SoldOut" + ], + "x-ms-enum": { + "name": "ItemAvailability", + "modelAsString": true + } + }, + "aggregateRating": { + "description": "An aggregated rating that indicates how well the product has been rated by others.", + "$ref": "#/definitions/AggregateRating", + "readOnly": true + }, + "lastUpdated": { + "description": "The last date that the offer was updated. The date is in the form YYYY-MM-DD.", + "readOnly": true, + "type": "string" + } + } + }, + "Organization": { + "description": "Defines an organization.", + "allOf": [ + { + "$ref": "#/definitions/Thing" + } + ], + "type": "object", + "properties": {} + }, + "Person": { + "description": "Defines a person.", + "allOf": [ + { + "$ref": "#/definitions/Thing" + } + ], + "type": "object", + "properties": { + "jobTitle": { + "description": "The person's job title.", + "readOnly": true, + "type": "string" + }, + "twitterProfile": { + "description": "The URL of the person's twitter profile.", + "readOnly": true, + "type": "string" + } + } + }, + "Intangible": { + "description": "A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc.", + "allOf": [ + { + "$ref": "#/definitions/Thing" + } + ], + "type": "object" + }, + "NormalizedQuadrilateral": { + "description": "Defines a region of an image. The region is a convex quadrilateral defined by coordinates of its top left, top right, bottom left, and bottom right points. The coordinates are fractional values of the original image's width and height in the range 0.0 through 1.0.", + "allOf": [ + { + "$ref": "#/definitions/StructuredValue" + } + ], + "type": "object", + "required": [ + "topLeft", + "topRight", + "bottomRight", + "bottomLeft" + ], + "properties": { + "topLeft": { + "description": "The top left corner coordinate.", + "$ref": "#/definitions/Point2D" + }, + "topRight": { + "description": "The top right corner coordinate.", + "$ref": "#/definitions/Point2D" + }, + "bottomRight": { + "description": "The bottom right corner coordinate.", + "$ref": "#/definitions/Point2D" + }, + "bottomLeft": { + "description": "The bottom left corner coordinate.", + "$ref": "#/definitions/Point2D" + } + } + }, + "ImageEntityAction": { + "allOf": [ + { + "$ref": "#/definitions/ImageAction" + } + ], + "type": "object", + "properties": { + "data": { + "description": "Information about the entity.", + "$ref": "#/definitions/Thing", + "readOnly": true + } + } + }, + "ImageModuleAction": { + "allOf": [ + { + "$ref": "#/definitions/ImageAction" + } + ], + "type": "object", + "properties": { + "data": { + "description": "A list of images.", + "$ref": "#/definitions/ImagesModule", + "readOnly": true + } + } + }, + "ImageRecipesAction": { + "allOf": [ + { + "$ref": "#/definitions/ImageAction" + } + ], + "type": "object", + "properties": { + "data": { + "description": "A list of recipes related to the image.", + "$ref": "#/definitions/RecipesModule", + "readOnly": true + } + } + }, + "ImageRelatedSearchesAction": { + "allOf": [ + { + "$ref": "#/definitions/ImageAction" + } + ], + "type": "object", + "properties": { + "data": { + "description": "A list of queries related to the image.", + "$ref": "#/definitions/RelatedSearchesModule", + "readOnly": true + } + } + }, + "ImageShoppingSourcesAction": { + "allOf": [ + { + "$ref": "#/definitions/ImageAction" + } + ], + "type": "object", + "properties": { + "data": { + "description": "A list of merchants that offer items related to the image.", + "$ref": "#/definitions/AggregateOffer", + "readOnly": true + } + } + }, + "AggregateOffer": { + "description": "Defines a list of offers from merchants that are related to the image.", + "allOf": [ + { + "$ref": "#/definitions/Offer" + } + ], + "type": "object", + "properties": { + "offers": { + "description": "A list of offers from merchants that have offerings related to the image.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Offer" + } + } + } + }, + "Query": { + "description": "Defines a search query.", + "type": "object", + "required": [ + "text" + ], + "properties": { + "text": { + "description": "The query string. Use this string as the query term in a new search request.", + "type": "string" + }, + "displayText": { + "description": "The display version of the query term.", + "readOnly": true, + "type": "string" + }, + "webSearchUrl": { + "description": "The URL that takes the user to the Bing search results page for the query.", + "readOnly": true, + "type": "string" + }, + "searchLink": { + "description": "The URL that you use to get the results of the related search. Before using the URL, you must append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. Use this URL if you're displaying the results in your own user interface. Otherwise, use the webSearchUrl URL.", + "readOnly": true, + "type": "string" + }, + "thumbnail": { + "description": "The URL to a thumbnail of a related image.", + "$ref": "#/definitions/ImageObject", + "readOnly": true + } + } + }, + "Recipe": { + "description": "Defines a cooking recipe.", + "allOf": [ + { + "$ref": "#/definitions/CreativeWork" + } + ], + "type": "object", + "properties": { + "cookTime": { + "description": "The amount of time the food takes to cook. For example, PT25M. For information about the time format, see http://en.wikipedia.org/wiki/ISO_8601#Durations.", + "readOnly": true, + "type": "string" + }, + "prepTime": { + "description": "The amount of time required to prepare the ingredients. For example, PT15M. For information about the time format, see http://en.wikipedia.org/wiki/ISO_8601#Durations.", + "readOnly": true, + "type": "string" + }, + "totalTime": { + "description": "The total amount of time it takes to prepare and cook the recipe. For example, PT45M. For information about the time format, see http://en.wikipedia.org/wiki/ISO_8601#Durations.", + "readOnly": true, + "type": "string" + } + } + }, + "AggregateRating": { + "description": "Defines the metrics that indicate how well an item was rated by others.", + "allOf": [ + { + "$ref": "#/definitions/Rating" + } + ], + "type": "object", + "properties": { + "reviewCount": { + "description": "The number of times the recipe has been rated or reviewed.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "StructuredValue": { + "allOf": [ + { + "$ref": "#/definitions/Intangible" + } + ], + "type": "object" + }, + "PropertiesItem": { + "description": "Defines an item.", + "x-ms-discriminator-value": "Properties/Item", + "discriminator": "_type", + "type": "object", + "required": [ + "_type" + ], + "properties": { + "text": { + "description": "Text representation of an item.", + "readOnly": true, + "type": "string" + }, + "_type": { + "type": "string" + } + } + }, + "Point2D": { + "allOf": [ + { + "$ref": "#/definitions/StructuredValue" + } + ], + "type": "object", + "required": [ + "x", + "y" + ], + "properties": { + "x": { + "description": "The x-coordinate of the point.", + "type": "number", + "format": "float" + }, + "y": { + "description": "The y-coordinate of the point.", + "type": "number", + "format": "float" + } + } + }, + "ImagesModule": { + "description": "Defines a list of images.", + "type": "object", + "properties": { + "value": { + "description": "A list of images.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ImageObject" + } + } + } + }, + "RecipesModule": { + "description": "Defines a list of recipes.", + "type": "object", + "properties": { + "value": { + "description": "A list of recipes.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Recipe" + } + } + } + }, + "RelatedSearchesModule": { + "description": "Defines a list of related searches.", + "type": "object", + "properties": { + "value": { + "description": "A list of related searches.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Query" + } + } + } + }, + "Rating": { + "description": "Defines a rating.", + "allOf": [ + { + "$ref": "#/definitions/PropertiesItem" + } + ], + "type": "object", + "required": [ + "ratingValue" + ], + "properties": { + "ratingValue": { + "description": "The mean (average) rating. The possible values are 1.0 through 5.0.", + "type": "number", + "format": "float" + }, + "bestRating": { + "description": "The highest rated review. The possible values are 1.0 through 5.0.", + "readOnly": true, + "type": "number", + "format": "float" + } + } + }, + "VisualSearchRequest": { + "description": "A JSON object that contains information about the image to get insights of. Specify this object only in a knowledgeRequest form data.", + "type": "object", + "properties": { + "imageInfo": { + "description": "A JSON object that identities the image to get insights of.", + "$ref": "#/definitions/ImageInfo" + }, + "knowledgeRequest": { + "description": "A JSON object containing information about the request, such as filters, or a description.", + "$ref": "#/definitions/KnowledgeRequest" + } + } + }, + "ImageInfo": { + "description": "A JSON object that identities the image to get insights of . It also includes the optional crop area that you use to identify the region of interest in the image.", + "type": "object", + "properties": { + "imageInsightsToken": { + "description": "An image insights token. To get the insights token, call one of the Image Search APIs (for example, /images/search). In the search results, the [Image](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image) object's [imageInsightsToken](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image-imageinsightstoken) field contains the token. The imageInsightsToken and url fields mutually exclusive; do not specify both. Do not specify an insights token if the request includes the image form data.", + "type": "string" + }, + "url": { + "description": "The URL of the input image. The imageInsightsToken and url fields are mutually exclusive; do not specify both. Do not specify the URL if the request includes the image form data.", + "type": "string" + }, + "cropArea": { + "description": "A JSON object consisting of coordinates specifying the four corners of a cropped rectangle within the input image. Use the crop area to identify the region of interest in the image. You can apply the crop area to the images specified using the imageInsightsToken or url fields, or an image binary specified in an image form data.", + "$ref": "#/definitions/CropArea" + } + } + }, + "CropArea": { + "description": "A JSON object consisting of coordinates specifying the four corners of a cropped rectangle within the input image.", + "type": "object", + "required": [ + "top", + "bottom", + "left", + "right" + ], + "properties": { + "top": { + "description": "The top coordinate of the region to be cropped. The coordinate is a fractional value of the original image's height and is measured from the top edge of the image. Specify the coordinate as a value from 0.0 through 1.0.", + "type": "number", + "format": "float" + }, + "bottom": { + "description": "The bottom coordinate of the region to be cropped. The coordinate is a fractional value of the original image's height and is measured from the top edge of the image. Specify the coordinate as a value from 0.0 through 1.0.", + "type": "number", + "format": "float" + }, + "left": { + "description": "The left coordinate of the region to be cropped. The coordinate is a fractional value of the original image's width and is measured from the left edge of the image. Specify the coordinate as a value from 0.0 through 1.0.", + "type": "number", + "format": "float" + }, + "right": { + "description": "The right coordinate of the region to be cropped. The coordinate is a fractional value of the original image's width and is measured from the left edge of the image. Specify the coordinate as a value from 0.0 through 1.0.", + "type": "number", + "format": "float" + } + } + }, + "KnowledgeRequest": { + "description": "A JSON object containing information about the request, such as filters for the resulting actions.", + "type": "object", + "properties": { + "filters": { + "description": "A key-value object consisting of filters that may be specified to limit the results returned by the API.", + "$ref": "#/definitions/Filters" + } + } + }, + "Filters": { + "description": "A key-value object consisting of filters that may be specified to limit the results returned by the API. Current available filters: site.", + "type": "object", + "properties": { + "site": { + "description": "The URL of the site to return similar images and similar products from. (e.g., \"www.bing.com\", \"bing.com\").", + "type": "string" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/examples/SuccessfulVisualSearchRequest.json b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/examples/SuccessfulVisualSearchRequest.json new file mode 100644 index 000000000000..9d5a95c45a59 --- /dev/null +++ b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/examples/SuccessfulVisualSearchRequest.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "X-BingApis-SDK": "true", + "Content-Type": "multipart/form-data", + "Ocp-Apim-Subscription-Key": "{API key}", + "image": "multipart-form-data", + "knowledgeRequest": "{\r\n \"imageInfo\": {\r\n \"imageInsightsToken\": \"{Image Insights Token}\",\r\n \"url\": \"{Image URL}\",\r\n \"cropArea\": {\r\n \"top\": \"0.1\",\r\n \"bottom\": \"0.9\",\r\n \"left\": \"0.1\",\r\n \"right\": \"0.9\"\r\n }\r\n }\r\n }" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "_type":"ImageKnowledge", + "tags":[ + { + "image":{ + "thumbnailUrl":"https:\/\/tse4.mm.bing.net\/th?q=Space+Needle&pid=Api&mkt=en-US&adlt=moderate" + }, + "displayName":"Space Needle", + "boundingBox":{ + "queryRectangle":{ + "topLeft":{ + "x":0, + "y":0 + }, + "topRight":{ + "x":1, + "y":0 + }, + "bottomRight":{ + "x":1, + "y":1 + }, + "bottomLeft":{ + "x":0, + "y":1 + } + }, + "displayRectangle":{ + "topLeft":{ + "x":0, + "y":0 + }, + "topRight":{ + "x":1, + "y":0 + }, + "bottomRight":{ + "x":1, + "y":1 + }, + "bottomLeft":{ + "x":0, + "y":1 + } + } + }, + "actions":[ + { + "_type":"ImageModuleAction", + "actionType":"Trivia", + "data":{ + "value":[ + { + "name":"Nickname for space needle", + "text":"the original nickname of the space needle was \"the space cage.\". the original name of the restaurant was \"eye of the needle.\". from the time of its construction, the space needle has always had a light atop the structure. the most recent version is the legacy light, first illuminated on new year's eve 1999\/2000.", + "hostPageUrl":"http:\/\/spaceneedle.webs.com\/fun-facts" + }, + { + "name":"Who commissioned the space needle", + "text":"the space needle was commissioned as part of the 1962 world's fair hosted in seattle. the theme of that year's fair was \"century 21,\" which helps to explain the space needle's futuristic design. edward carlson came up with the original designs, which had a top that resembled a floating balloon.", + "hostPageUrl":"http:\/\/traveltips.usatoday.com\/seattle-space-needle-12040.html" + }, + { + "name":"Downtown seattle by the space needle", + "text":"built for the 1962 world’s fair, the space needle is located just north of the downtown area at seattle center. upon opening, it drew over 2 million visitors - nearly 20,000 per day during the world's fair!", + "hostPageUrl":"http:\/\/www.paramounthotelseattle.com\/explore-seattle\/space-needle.htm" + }, + { + "name":"Why is the space needle important", + "text":"No. The Space Needle is too small to be seen from space. The only man made structure you can see from space is the Great Wall of China. I'm ten years old.", + "hostPageUrl":"http:\/\/www.answers.com\/Q\/Why_is_the_space_needle_important" + }, + { + "name":"What does the space needle have inside of it", + "text":"making the world better, one answer at a time. inside the space needle is the observation deck which is the very top floor. the second floor of the space need which is directly under neath that is a restaurant, that has a moving floor that goes in circle, so while you eat you get the entire view of seattle.", + "hostPageUrl":"http:\/\/www.answers.com\/q\/what_is_inside_the_space_needle" + }, + { + "name":"12 Flag Space Needle Raising", + "text":"The Seahawks' 12 MAN Flag was risen atop the Space Needle on the Friday before the game against the Washington Redskins.", + "hostPageUrl":"http:\/\/www.seahawks.com\/galleries\/2013\/01\/05\/12-flag-space-needle-raising" + }, + { + "name":"How tall is the space needle with the antenna and spire", + "text":"once the tallest structure west of the mississippi river, it is 605 ft (184 m) high, 138 ft (42 m) wide, and weighs 9,550 tons.", + "hostPageUrl":"http:\/\/en.wikipedia.org\/wiki\/space_needle" + }, + { + "name":"Where is the space needle in washington seattle", + "text":"the space needle is a landmark of the pacific northwest and an icon of downtown seattle. it was built in the seattle center for the 1962 world's fair. today, nearly 20,000 people ride its elevators every 24 hours.", + "hostPageUrl":"http:\/\/viator.com\/tours\/seattle\/seattle-space-needle-observation-deck-admission\/d704-5929gen" + }, + { + "name":"When was the space needle built in gatlinburg", + "text":"the gatlinburg space needle, which originally opened in 1970, is probably the most iconic attraction in gatlinburg, tn. the space needle towers high over the parkway at a height of 407 feet and offers visitors the chance to view the smoky mountains from a 360 degree platform.", + "hostPageUrl":"http:\/\/smokymountains.com\/attractions\/gatlinburg-space-needle" + }, + { + "name":"Did lightning hit the space needle", + "text":"during an afternoon storm, lightning hit the space needle, lighting up the observation tower. twenty-five lightning rods, including the spire itself, scatter the roof of the needle in an attempt to protect the building from lightning strikes, according to the space needle website.", + "hostPageUrl":"http:\/\/www.nydailynews.com\/news\/national\/space-needle-struck-lightning-seattle-storm-article-1.2984070" + } + ] + } + } + ] + }, + { + "image":{ + "thumbnailUrl":"https:\/\/tse4.mm.bing.net\/th?q=city&pid=Api&mkt=en-US&adlt=moderate" + }, + "displayName":"city", + "boundingBox":{ + "queryRectangle":{ + "topLeft":{ + "x":0, + "y":0 + }, + "topRight":{ + "x":1, + "y":0 + }, + "bottomRight":{ + "x":1, + "y":1 + }, + "bottomLeft":{ + "x":0, + "y":1 + } + }, + "displayRectangle":{ + "topLeft":{ + "x":0, + "y":0 + }, + "topRight":{ + "x":1, + "y":0 + }, + "bottomRight":{ + "x":1, + "y":1 + }, + "bottomLeft":{ + "x":0, + "y":1 + } + } + }, + "actions":[ + { + "_type":"ImageAction", + "webSearchUrl":"https:\/\/www.bing.com\/images\/search?q=city", + "displayName":"city", + "serviceUrl":"https:\/\/www.bing.com\/api\/v7\/images\/search?q=city", + "actionType":"ImageResults" + } + ] + } + ], + "image":{ + "imageInsightsToken":"ccid_5raYvpmc*mid_28189CE73748FE8CB0AB80F7B377C4DA64EA132E" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/VisualSearch/readme.md b/specification/cognitiveservices/data-plane/VisualSearch/readme.md new file mode 100644 index 000000000000..85d43b586109 --- /dev/null +++ b/specification/cognitiveservices/data-plane/VisualSearch/readme.md @@ -0,0 +1,120 @@ +# Bing Visual Search SDK + +> see https://aka.ms/autorest + +Configuration for generating Visual Search SDK. + +The current release is `release_1_0`. + +``` yaml + +tag: release_1_0 +add-credentials: true +openapi-type: data-plane +``` +# Releases + +### Release 1.0 +These settings apply only when `--tag=release_1_0` is specified on the command line. + +``` yaml $(tag) == 'release_1_0' +input-file: preview/v1.0/VisualSearch.json +``` + +## Suppressions +Suppressing errors due to API design: +``` yaml +directive: + - suppress: R3016 + reason: _type is a polymorphic discriminator that can't be changed. +``` + +## 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 +``` + +## CSharp Settings +These settings apply only when `--csharp` is specified on the command line. +``` yaml $(csharp) +csharp: + namespace: Microsoft.Azure.CognitiveServices.Search.VisualSearch + output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Search/Search/Generated/VisualSearch + sync-methods: none +``` + +## 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 + add-credentials: true + payload-flattening-threshold: 2 + namespace: azure.cognitiveservices.search.visualsearch + package-name: azure-cognitiveservices-search-visualsearch + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-visualsearch/azure/cognitiveservices/search/visualsearch +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-visualsearch +``` + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: visualsearch + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: release_1_0 +``` + +### Tag: release_1_0 and go + +These settings apply only when `--tag=release_1_0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(go) +output-folder: $(go-sdk-folder)/services/preview/cognitiveservices/v1.0/$(namespace) +``` + +## 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.search.visualsearch + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/search/bingvisualsearch + with-optional-parameters: true + prefix-model-type: Bing + with-single-async-method: true +``` diff --git a/specification/cognitiveservices/data-plane/VisualSearch/readme.nodejs.md b/specification/cognitiveservices/data-plane/VisualSearch/readme.nodejs.md new file mode 100644 index 000000000000..09d3cb829335 --- /dev/null +++ b/specification/cognitiveservices/data-plane/VisualSearch/readme.nodejs.md @@ -0,0 +1,16 @@ +## 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-visualsearch + package-version: 1.0.0-preview + output-folder: $(node-sdks-folder)/lib/services/visualSearch + override-client-name: VisualSearchAPIClient + azure-arm: false + generate-license-txt: true + generate-package-json: true + generate-readme-md: false +``` diff --git a/specification/cognitiveservices/data-plane/WebSearch/readme.md b/specification/cognitiveservices/data-plane/WebSearch/readme.md index dd022be6a93f..ef4b7eb48573 100644 --- a/specification/cognitiveservices/data-plane/WebSearch/readme.md +++ b/specification/cognitiveservices/data-plane/WebSearch/readme.md @@ -32,7 +32,11 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-go + - repo: azure-sdk-for-python - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_websearch'] ``` ## CSharp Settings @@ -107,9 +111,11 @@ Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::WebSearch::V1_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_websearch/lib +title: "WebSearchClient" +``` diff --git a/specification/cognitiveservices/data-plane/WebSearch/stable/v1.0/WebSearch.json b/specification/cognitiveservices/data-plane/WebSearch/stable/v1.0/WebSearch.json index 1997bc99fc51..98ee8cecc62c 100644 --- a/specification/cognitiveservices/data-plane/WebSearch/stable/v1.0/WebSearch.json +++ b/specification/cognitiveservices/data-plane/WebSearch/stable/v1.0/WebSearch.json @@ -23,10 +23,10 @@ } }, "host": "api.cognitive.microsoft.com", + "basePath": "/bing/v7.0", "schemes": [ "https" ], - "basePath": "/bing/v7.0", "produces": [ "application/json" ], diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2016-02-01-preview/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2016-02-01-preview/cognitiveservices.json index 59263b2c885d..a026e4757532 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2016-02-01-preview/cognitiveservices.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2016-02-01-preview/cognitiveservices.json @@ -215,12 +215,12 @@ ], "responses": { "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are “name,” “type” and “id.”\nField\tDescription\nKind\trequired. String.\n\tThe API set for this API account. It can be \n\t· a single API, for example: Face API, Vision API, Speech API. \n\ta bundle of APIs: Face + Speech, Vision + Emotion, etc.\nsku.name\tRequired.\n\tThe pricing tier/plan of this API. Could be: \n\tF0 - Free\n\tB0 - Basic\n\tS0 - Standard\n\tP0 - Premium\n", + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nKind\trequired. String.\n\tThe API set for this API account. It can be \n\t· a single API, for example: Face API, Vision API, Speech API. \n\ta bundle of APIs: Face + Speech, Vision + Emotion, etc.\nsku.name\tRequired.\n\tThe pricing tier/plan of this API. Could be: \n\tF0 - Free\n\tB0 - Basic\n\tS0 - Standard\n\tP0 - Premium\n", "schema": { "$ref": "#/definitions/CognitiveServicesAccount" }, "examples": { - "application/json": "{\n “id”: “/subscriptions/{id}/resourceGroups/{group}/providers/{rpns}/{type}/{name}”,\n “name”: “{name}”,\n “type”: “Microsoft.CognitiveSerices/accounts”,\n \"location\": \"North US\",\n \"tags\": {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n },\n \"kind\" : \"resource kind\",\n \"sku\": {\n\t \"name\": \"sku code\"\n\t} \n “etag”: “00000000-0000-0000-0000-000000000000”,\n \"properties\": { }\n}" + "application/json": "{\n \"id\": \"/subscriptions/{id}/resourceGroups/{group}/providers/{rpns}/{type}/{name}\",\n \"name\": \"{name}\",\n \"type\": \"Microsoft.CognitiveSerices/accounts\",\n \"location\": \"North US\",\n \"tags\": {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n },\n \"kind\" : \"resource kind\",\n \"sku\": {\n\t \"name\": \"sku code\"\n\t} \n \"etag\": \"00000000-0000-0000-0000-000000000000\",\n \"properties\": { }\n}" } }, "default": { @@ -256,12 +256,12 @@ ], "responses": { "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with \"value\" property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", "schema": { "$ref": "#/definitions/CognitiveServicesAccountListResult" }, "examples": { - "application/json": "{\n “value”: [\n {\n “id”: “{url to resource 1}”,\n “name”: “Name1”,\n “type”: “Microsoft.CognitiveServices/accounts”,\n \"location\": \"North US\" \n \"kind\" : \"resource kind\",\n \"sku\": {\n\t \"name\": \"sku code\"\n\t }, \n \"etag\": \"00000000-0000-0000-0000-000000000000\",\n \"properties\": { }\n },\n {\n “id”: “{url to resource 2}”,\n “name”: “Name2”,\n “type”: “Microsoft.CognitiveServices/accounts”,\n \"location\": \"North US\",\n \"kind\" : \"resource kind\",\n \"sku\": {\n\t \"name\": \"sku code\"\n\t }, \n \"etag\": \"00000000-0000-0000-0000-000000000000\",\n \"properties\": { }\n }\n ],\n “nextLink”: “{originalRequestUrl}?$skipToken={opaqueString}”\n}" + "application/json": "{\n \"value\": [\n {\n \"id\": \"{url to resource 1}\",\n \"name\": \"Name1\",\n \"type\": \"Microsoft.CognitiveServices/accounts\",\n \"location\": \"North US\" \n \"kind\" : \"resource kind\",\n \"sku\": {\n\t \"name\": \"sku code\"\n\t }, \n \"etag\": \"00000000-0000-0000-0000-000000000000\",\n \"properties\": { }\n },\n {\n \"id\": \"{url to resource 2}\",\n \"name\": \"Name2\",\n \"type\": \"Microsoft.CognitiveServices/accounts\",\n \"location\": \"North US\",\n \"kind\" : \"resource kind\",\n \"sku\": {\n\t \"name\": \"sku code\"\n\t }, \n \"etag\": \"00000000-0000-0000-0000-000000000000\",\n \"properties\": { }\n }\n ],\n \"nextLink\": \"{originalRequestUrl}?$skipToken={opaqueString}\"\n}" } }, "default": { @@ -298,7 +298,7 @@ "$ref": "#/definitions/CognitiveServicesAccountListResult" }, "examples": { - "application/json": "{\n “value”: [\n {\n “id”: “{url to resource 1}”,\n “name”: “Name1”,\n “type”: “Microsoft.CognitiveServices/accounts”,\n \"location\": \"North US\" \n \"kind\" : \"resource kind\",\n \"sku\": {\n \"name\": \"sku code\"\n }, \n \"etag\": \"00000000-0000-0000-0000-000000000000\",\n \"properties\": { }\n },\n {\n “id”: “{url to resource 2}”,\n “name”: “Name2”,\n “type”: “Microsoft.CognitiveServices/accounts”,\n \"location\": \"North US\",\n \"kind\" : \"resource kind\",\n \"sku\": {\n \"name\": \"sku code\"\n }, \n \"etag\": \"00000000-0000-0000-0000-000000000000\",\n \"properties\": { }\n }\n ],\n “nextLink”: “{originalRequestUrl}?$skipToken={opaqueString}”\n}\n" + "application/json": "{\n \"value\": [\n {\n \"id\": \"{url to resource 1}\",\n \"name\": \"Name1\",\n \"type\": \"Microsoft.CognitiveServices/accounts\",\n \"location\": \"North US\" \n \"kind\" : \"resource kind\",\n \"sku\": {\n \"name\": \"sku code\"\n }, \n \"etag\": \"00000000-0000-0000-0000-000000000000\",\n \"properties\": { }\n },\n {\n \"id\": \"{url to resource 2}\",\n \"name\": \"Name2\",\n \"type\": \"Microsoft.CognitiveServices/accounts\",\n \"location\": \"North US\",\n \"kind\" : \"resource kind\",\n \"sku\": {\n \"name\": \"sku code\"\n }, \n \"etag\": \"00000000-0000-0000-0000-000000000000\",\n \"properties\": { }\n }\n ],\n \"nextLink\": \"{originalRequestUrl}?$skipToken={opaqueString}\"\n}\n" } }, "default": { @@ -459,7 +459,7 @@ ], "responses": { "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are “name,” “type” and “id.”\nField\tDescription\nsku\tRequired, object\n\tThe exact set of keys that define this sku. This matches the fields on the respective resource.\nsku.name\tRequired, string\n\tThe name of the SKU. This is typically a letter + number code, such as A0 or P3\nsku.tier\tRequired, string\n\tThe tier of this particular SKU. Typically one of:\n\t· Free\n\t· Basic\n\t· Standard\n\t· Premium\n", + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nsku\tRequired, object\n\tThe exact set of keys that define this sku. This matches the fields on the respective resource.\nsku.name\tRequired, string\n\tThe name of the SKU. This is typically a letter + number code, such as A0 or P3\nsku.tier\tRequired, string\n\tThe tier of this particular SKU. Typically one of:\n\t· Free\n\t· Basic\n\t· Standard\n\t· Premium\n", "schema": { "$ref": "#/definitions/CognitiveServicesAccountEnumerateSkusResult" }, 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 9d82f3a64ad6..20a160ae7423 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 @@ -244,7 +244,7 @@ ], "responses": { "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are “name,” “type” and “id.”\nField\tDescription\nKind\trequired. String.\n\tThe API set for this API account. It can be \n\t· a single API, for example: Face API, Vision API, Speech API. \n\ta bundle of APIs: Face + Speech, Vision + Emotion, etc.\nsku.name\tRequired.\n\tThe pricing tier/plan of this API. Could be: \n\tF0 - Free\n\tB0 - Basic\n\tS0 - Standard\n\tP0 - Premium\n", + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nKind\trequired. String.\n\tThe API set for this API account. It can be \n\t· a single API, for example: Face API, Vision API, Speech API. \n\ta bundle of APIs: Face + Speech, Vision + Emotion, etc.\nsku.name\tRequired.\n\tThe pricing tier/plan of this API. Could be: \n\tF0 - Free\n\tB0 - Basic\n\tS0 - Standard\n\tP0 - Premium\n", "schema": { "$ref": "#/definitions/CognitiveServicesAccount" } @@ -287,7 +287,7 @@ ], "responses": { "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with \"value\" property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", "schema": { "$ref": "#/definitions/CognitiveServicesAccountListResult" } @@ -532,7 +532,7 @@ ], "responses": { "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are “name,” “type” and “id.”\nField\tDescription\nsku\tRequired, object\n\tThe exact set of keys that define this sku. This matches the fields on the respective resource.\nsku.name\tRequired, string\n\tThe name of the SKU. This is typically a letter + number code, such as A0 or P3\nsku.tier\tRequired, string\n\tThe tier of this particular SKU. Typically one of:\n\t· Free\n\t· Basic\n\t· Standard\n\t· Premium\n", + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. The only GET specific properties are \"name,\" \"type\" and \"id.\"\nField\tDescription\nsku\tRequired, object\n\tThe exact set of keys that define this sku. This matches the fields on the respective resource.\nsku.name\tRequired, string\n\tThe name of the SKU. This is typically a letter + number code, such as A0 or P3\nsku.tier\tRequired, string\n\tThe tier of this particular SKU. Typically one of:\n\t· Free\n\t· Basic\n\t· Standard\n\t· Premium\n", "schema": { "$ref": "#/definitions/CognitiveServicesAccountEnumerateSkusResult" } diff --git a/specification/cognitiveservices/resource-manager/readme.md b/specification/cognitiveservices/resource-manager/readme.md index bc0cac21cc81..e0b15a12effb 100644 --- a/specification/cognitiveservices/resource-manager/readme.md +++ b/specification/cognitiveservices/resource-manager/readme.md @@ -62,9 +62,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_cognitive_services'] ``` @@ -117,7 +120,7 @@ These settings apply only when `--tag=package-2016-02-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2016-02-preview' && $(go) -output-folder: $(go-sdk-folder)/services/cognitiveservices/mgmt/2016-02-01-preview/cognitiveservices +output-folder: $(go-sdk-folder)/services/preview/cognitiveservices/preview/mgmt/2016-02-01-preview/cognitiveservices ``` @@ -127,11 +130,46 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.cognitiveservices +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-cognitiveservices +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-04 + - tag: package-2016-02-preview +``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.cognitiveservices - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-cognitiveservices + namespace: com.microsoft.azure.management.cognitiveservices.v2017_04_18 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/resource-manager/v2017_04_18 +regenerate-manager: true +generate-interface: true ``` + +### Tag: package-2016-02-preview and java + +These settings apply only when `--tag=package-2016-02-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-02-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.cognitiveservices.v2016_02_01_preview + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/resource-manager/v2016_02_01_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/cognitiveservices/resource-manager/readme.ruby.md b/specification/cognitiveservices/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..e3c1a0fb83c5 --- /dev/null +++ b/specification/cognitiveservices/resource-manager/readme.ruby.md @@ -0,0 +1,37 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_cognitive_services +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2017-04 + - tag: package-2016-02-preview +``` + +### Tag: package-2017-04 and ruby + +These settings apply only when `--tag=package-2017-04 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-04' && $(ruby) +namespace: "Azure::CognitiveServices::Mgmt::V2017_04_18" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_cognitive_services/lib +``` + +### Tag: package-2016-02-preview and ruby + +These settings apply only when `--tag=package-2016-02-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-02-preview' && $(ruby) +namespace: "Azure::CognitiveServices::Mgmt::V2016_02_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_cognitive_services/lib +``` diff --git a/specification/commerce/resource-manager/readme.md b/specification/commerce/resource-manager/readme.md index c6ddbd401e5d..b007fe0c7294 100644 --- a/specification/commerce/resource-manager/readme.md +++ b/specification/commerce/resource-manager/readme.md @@ -51,9 +51,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_commerce'] ``` @@ -109,7 +112,7 @@ These settings apply only when `--tag=package-2015-06-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-06-preview' && $(go) -output-folder: $(go-sdk-folder)/services/commerce/mgmt/2015-06-01-preview/commerce +output-folder: $(go-sdk-folder)/services/preview/commerce/mgmt/2015-06-01-preview/commerce ``` @@ -119,11 +122,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.commerce +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-commerce +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-06-preview +``` + +### Tag: package-2015-06-preview and java + +These settings apply only when `--tag=package-2015-06-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-06-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.commerce - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-commerce + namespace: com.microsoft.azure.management.commerce.v2015_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/commerce/resource-manager/v2015_06_01_preview +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/commerce/resource-manager/readme.ruby.md b/specification/commerce/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..d03a4a272588 --- /dev/null +++ b/specification/commerce/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_commerce +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2015-06-preview +``` + +### Tag: package-2015-06-preview and ruby + +These settings apply only when `--tag=package-2015-06-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-06-preview' && $(ruby) +namespace: "Azure::Commerce::Mgmt::V2015_06_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_commerce/lib +``` diff --git a/specification/common-types/resource-management/v1/types.json b/specification/common-types/resource-management/v1/types.json index 1d43a0a1649a..8fe86c59537d 100644 --- a/specification/common-types/resource-management/v1/types.json +++ b/specification/common-types/resource-management/v1/types.json @@ -26,6 +26,22 @@ }, "x-ms-azure-resource": true }, + "AzureEntityResource": { + "x-ms-client-name": "AzureEntityResource", + "description": "The resource model definition for a Azure Resource Manager resource with an etag.", + "properties": { + "etag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, "TrackedResource": { "description": "The resource model definition for a ARM tracked top level resource", "properties": { @@ -280,7 +296,7 @@ "pattern": "^[-\\w\\._\\(\\)]+$", "minLength": 1, "maxLength": 90, - "x-ms-parameter-location": "client" + "x-ms-parameter-location": "method" } } } \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/compute.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/compute.json index 5d4076fd5bf8..025a10643645 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/compute.json @@ -160,6 +160,34 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListBySubscription", + "description": "Lists all availability sets in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets": { "get": { "tags": [ @@ -191,7 +219,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -1288,7 +1316,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": { @@ -1481,7 +1512,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate": { @@ -1524,7 +1558,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": { @@ -1711,7 +1748,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": { @@ -1754,7 +1794,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": { @@ -1797,7 +1840,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": { @@ -1840,7 +1886,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { @@ -2029,7 +2078,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { @@ -2081,7 +2133,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { @@ -2277,7 +2332,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { @@ -2329,7 +2387,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { @@ -2381,7 +2442,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { @@ -2433,7 +2497,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { @@ -2476,7 +2543,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall": { @@ -2519,7 +2589,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimage": { @@ -2569,7 +2642,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimageall": { @@ -2619,7 +2695,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/deallocate": { @@ -2669,7 +2748,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}": { @@ -2926,7 +3008,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { @@ -2976,7 +3061,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { @@ -3026,7 +3114,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } } }, @@ -3126,8 +3217,15 @@ "$ref": "#/definitions/AvailabilitySet" }, "description": "The list of availability sets" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets." } }, + "required": [ + "value" + ], "description": "The List Availability Set operation response." }, "VirtualMachineSize": { @@ -5318,7 +5416,7 @@ "description": "Azure VM unique ID." }, "instanceView": { - "$ref": "#/definitions/VirtualMachineInstanceView", + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView", "readOnly": true, "description": "The virtual machine instance view." }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/disk.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/disk.json index 660b14199ba7..8a8e1e09d4bc 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/disk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/disk.json @@ -359,7 +359,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}": { @@ -680,7 +683,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } } }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListAvailabilitySetsInASubscription.json new file mode 100644 index 000000000000..760bbbae2ffc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListAvailabilitySetsInASubscription.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "api-version": "2016-04-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 2 + }, + "type": "Microsoft.Compute/availabilitySets", + "location": "centralus", + "tags": { + "{tagName}": "{tagValue}" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "name": "{availabilitySetName}", + "sku": { + "name": "Aligned" + } + }, + { + "properties": { + "platformUpdateDomainCount": 3, + "platformFaultDomainCount": 2 + }, + "type": "Microsoft.Compute/availabilitySets", + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "name": "{availabilitySetName}", + "sku": { + "name": "Classic" + } + } + ] + } + } + } +} \ No newline at end of file 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 f6a24fe80ee7..e2249648d65e 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 @@ -191,7 +191,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -998,7 +998,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": { @@ -1191,7 +1194,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": { @@ -1378,7 +1384,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": { @@ -1421,7 +1430,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": { @@ -1464,7 +1476,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": { @@ -1507,7 +1522,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { @@ -1696,7 +1714,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { @@ -1748,7 +1769,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { @@ -1944,7 +1968,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { @@ -1996,7 +2023,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { @@ -2048,7 +2078,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { @@ -2100,7 +2133,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { @@ -2143,7 +2179,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimage": { @@ -2193,7 +2232,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/deallocate": { @@ -2243,7 +2285,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}": { @@ -2500,7 +2545,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { @@ -2550,7 +2598,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { @@ -2600,7 +2651,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } } }, @@ -2692,8 +2746,15 @@ "$ref": "#/definitions/AvailabilitySet" }, "description": "The list of availability sets" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets." } }, + "required": [ + "value" + ], "description": "The List Availability Set operation response." }, "VirtualMachineSize": { @@ -4500,7 +4561,7 @@ "description": "Specifies whether the latest model has been applied to the virtual machine." }, "instanceView": { - "$ref": "#/definitions/VirtualMachineInstanceView", + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView", "readOnly": true, "description": "The virtual machine instance view." }, 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 e803f3333f00..94675019361f 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 @@ -160,6 +160,34 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListBySubscription", + "description": "Lists all availability sets in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets": { "get": { "tags": [ @@ -191,7 +219,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -1044,7 +1072,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": { @@ -1237,7 +1268,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": { @@ -1424,7 +1458,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": { @@ -1467,7 +1504,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": { @@ -1510,7 +1550,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": { @@ -1553,7 +1596,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { @@ -1742,7 +1788,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { @@ -1794,7 +1843,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { @@ -1990,7 +2042,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { @@ -2042,7 +2097,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { @@ -2094,7 +2152,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { @@ -2146,7 +2207,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { @@ -2189,7 +2253,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimage": { @@ -2239,7 +2306,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/deallocate": { @@ -2289,7 +2359,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}": { @@ -2546,7 +2619,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { @@ -2596,7 +2672,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { @@ -2646,7 +2725,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } } }, @@ -2738,8 +2820,15 @@ "$ref": "#/definitions/AvailabilitySet" }, "description": "The list of availability sets" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets." } }, + "required": [ + "value" + ], "description": "The List Availability Set operation response." }, "VirtualMachineSize": { @@ -4657,7 +4746,7 @@ "description": "Azure VM unique ID." }, "instanceView": { - "$ref": "#/definitions/VirtualMachineInstanceView", + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView", "readOnly": true, "description": "The virtual machine instance view." }, 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 4e1682583600..766842d5d8dd 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 @@ -164,6 +164,34 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListBySubscription", + "description": "Lists all availability sets in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets": { "get": { "tags": [ @@ -195,7 +223,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -1321,7 +1349,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": { @@ -1585,7 +1616,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate": { @@ -1628,7 +1662,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": { @@ -1815,7 +1852,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": { @@ -1858,7 +1898,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": { @@ -1901,7 +1944,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": { @@ -1944,7 +1990,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": { @@ -1987,7 +2036,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { @@ -2257,7 +2309,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { @@ -2309,7 +2364,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { @@ -2711,7 +2769,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { @@ -2763,7 +2824,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { @@ -2815,7 +2879,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { @@ -2867,7 +2934,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { @@ -2919,7 +2989,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall": { @@ -2971,7 +3044,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": { @@ -3014,7 +3090,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade": { @@ -3057,7 +3136,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest": { @@ -3146,7 +3228,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimageall": { @@ -3196,7 +3281,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/deallocate": { @@ -3246,7 +3334,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}": { @@ -3503,7 +3594,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { @@ -3553,7 +3647,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { @@ -3603,7 +3700,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } } }, @@ -3699,8 +3799,15 @@ "$ref": "#/definitions/AvailabilitySet" }, "description": "The list of availability sets" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets." } }, + "required": [ + "value" + ], "description": "The List Availability Set operation response." }, "VirtualMachineSize": { @@ -6674,7 +6781,7 @@ "description": "Azure VM unique ID." }, "instanceView": { - "$ref": "#/definitions/VirtualMachineInstanceView", + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView", "readOnly": true, "description": "The virtual machine instance view." }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/disk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/disk.json index 4d8c295422dc..1a595e5bf08b 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/disk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/disk.json @@ -361,7 +361,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}": { @@ -682,7 +685,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } } }, 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 new file mode 100644 index 000000000000..e1a22e4f5c34 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/ListAvailabilitySetsInASubscription.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "api-version": "2017-03-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 2 + }, + "type": "Microsoft.Compute/availabilitySets", + "location": "centralus", + "tags": { + "{tagName}": "{tagValue}" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "name": "{availabilitySetName}", + "sku": { + "name": "Aligned" + } + }, + { + "properties": { + "platformUpdateDomainCount": 3, + "platformFaultDomainCount": 2 + }, + "type": "Microsoft.Compute/availabilitySets", + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "name": "{availabilitySetName}", + "sku": { + "name": "Classic" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/runCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/runCommands.json index 4b93f4f14199..324fe10fc807 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/runCommands.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/runCommands.json @@ -170,7 +170,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } } }, 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 ad26dc7d1fc1..4a3a23bda98a 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 @@ -235,6 +235,34 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListBySubscription", + "description": "Lists all availability sets in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets": { "get": { "tags": [ @@ -266,7 +294,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -1416,7 +1444,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": { @@ -1733,7 +1764,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate": { @@ -1776,7 +1810,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": { @@ -1963,7 +2000,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": { @@ -2006,7 +2046,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": { @@ -2049,7 +2092,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": { @@ -2092,7 +2138,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": { @@ -2135,7 +2184,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { @@ -2405,7 +2457,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { @@ -2457,7 +2512,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { @@ -2901,7 +2959,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { @@ -2953,7 +3014,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { @@ -3005,7 +3069,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/redeploy": { @@ -3057,7 +3124,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/performMaintenance": { @@ -3066,7 +3136,7 @@ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_PerformMaintenance", - "description": "Perform maintenance on one or more virtual machines in a VM scale set.", + "description": "Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications", "parameters": [ { "name": "resourceGroupName", @@ -3109,7 +3179,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { @@ -3161,7 +3234,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { @@ -3213,7 +3289,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall": { @@ -3265,7 +3344,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": { @@ -3308,7 +3390,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade": { @@ -3351,7 +3436,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest": { @@ -3486,7 +3574,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimageall": { @@ -3536,7 +3627,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/deallocate": { @@ -3586,7 +3680,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}": { @@ -3903,7 +4000,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { @@ -3953,7 +4053,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { @@ -4003,7 +4106,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/redeploy": { @@ -4053,7 +4159,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance": { @@ -4103,7 +4212,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getRequestRateByInterval": { @@ -4154,7 +4266,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getThrottledRequests": { @@ -4205,7 +4320,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } } }, @@ -4376,8 +4494,15 @@ "$ref": "#/definitions/AvailabilitySet" }, "description": "The list of availability sets" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets." } }, + "required": [ + "value" + ], "description": "The List Availability Set operation response." }, "VirtualMachineSize": { @@ -5833,7 +5958,7 @@ "description": "The provisioning state, which only appears in the response." }, "instanceView": { - "$ref": "#/definitions/VirtualMachineInstanceView", + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView", "readOnly": true, "description": "The virtual machine instance view." }, @@ -5952,6 +6077,15 @@ }, "description": "Describes a virtual machine scale set sku." }, + "AutoOSUpgradePolicy": { + "properties": { + "disableAutoRollback": { + "type": "boolean", + "description": "Whether OS image rollback feature should be disabled. Default value is false." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, "UpgradePolicy": { "properties": { "mode": { @@ -5974,6 +6108,10 @@ "automaticOSUpgrade": { "type": "boolean", "description": "Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available." + }, + "autoOSUpgradePolicy": { + "$ref": "#/definitions/AutoOSUpgradePolicy", + "description": "Configuration parameters used for performing automatic OS Upgrade." } }, "description": "Describes an upgrade policy - automatic, manual, or rolling." @@ -7334,6 +7472,28 @@ ], "description": "The Virtual Machine Scale Set List Skus operation response." }, + "RollbackStatusInfo": { + "properties":{ + "successfullyRolledbackInstanceCount" : { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which have been successfully rolled back." + }, + "failedRolledbackInstanceCount" : { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which failed to rollback." + }, + "rollbackError" : { + "$ref": "#/definitions/ApiError", + "readOnly": true, + "description": "Error details if OS rollback failed." + } + }, + "description": "Information about rollback on failed VM instances after a OS Upgrade operation." + }, "UpgradeOperationHistoryStatus": { "properties": { "code": { @@ -7401,6 +7561,11 @@ "$ref": "#/definitions/ImageReference", "readOnly": true, "description": "Image Reference details" + }, + "rollbackInfo": { + "$ref": "#/definitions/RollbackStatusInfo", + "readOnly": true, + "description": "Information about OS rollback if performed" } }, "description": "Describes each OS upgrade on the Virtual Machine Scale Set." 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 new file mode 100644 index 000000000000..717c4351574e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListAvailabilitySetsInASubscription.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "api-version": "2017-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 2 + }, + "type": "Microsoft.Compute/availabilitySets", + "location": "centralus", + "tags": { + "{tagName}": "{tagValue}" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "name": "{availabilitySetName}", + "sku": { + "name": "Aligned" + } + }, + { + "properties": { + "platformUpdateDomainCount": 3, + "platformFaultDomainCount": 2 + }, + "type": "Microsoft.Compute/availabilitySets", + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "name": "{availabilitySetName}", + "sku": { + "name": "Classic" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/runCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/runCommands.json index 0b139676ac36..6ed0f682d77b 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/runCommands.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/runCommands.json @@ -170,7 +170,10 @@ "description": "Accepted" } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } } } }, 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 new file mode 100644 index 000000000000..32ce8d5a0cb6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json @@ -0,0 +1,8019 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Compute/operations": { + "get": { + "tags": [ + "ComputeOperations" + ], + "operationId": "Operations_List", + "description": "Gets a list of compute operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ComputeOperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}": { + "put": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_CreateOrUpdate", + "description": "Create or update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "Parameters supplied to the Create Availability Set operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + }, + "x-ms-examples": { + "Create an availability set.": { + "$ref": "./examples/CreateAnAvailabilitySet.json" + } + } + }, + "patch": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Update", + "description": "Update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySetUpdate" + }, + "description": "Parameters supplied to the Update Availability Set operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + } + }, + "delete": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Delete", + "description": "Delete an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Get", + "description": "Retrieves information about an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListBySubscription", + "description": "Lists all availability sets in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_List", + "description": "Lists all availability sets in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/vmSizes": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListAvailableSizes", + "description": "Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_Get", + "description": "Gets a virtual machine extension image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListTypes", + "description": "Gets a list of virtual machine extension image types.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListVersions", + "description": "Gets a list of virtual machine extension image versions.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + }, + "x-ms-odata": "#/definitions/VirtualMachineExtensionImage" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}": { + "put": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_CreateOrUpdate", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be created or updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "Parameters supplied to the Create Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Update", + "description": "The operation to update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be deleted." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions": { + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_List", + "description": "The operation to get all extensions of a Virtual Machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionsListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_Get", + "description": "Gets a virtual machine image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU version." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineImage" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_List", + "description": "Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + }, + "x-ms-odata": "#/definitions/VirtualMachineImageResource" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListOffers", + "description": "Gets a list of virtual machine image offers for the specified location and publisher.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListPublishers", + "description": "Gets a list of virtual machine image publishers for the specified Azure location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListSkus", + "description": "Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usage_List", + "description": "Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "Lists all available virtual machine sizes for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}": { + "put": { + "tags": [ + "Images" + ], + "operationId": "Images_CreateOrUpdate", + "description": "Create or update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Image" + }, + "description": "Parameters supplied to the Create Image operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-examples": { + "Create a virtual machine image from a blob.": { + "$ref": "./examples/CreateAnImageFromABlob.json" + }, + "Create a virtual machine image from a snapshot.": { + "$ref": "./examples/CreateAnImageFromASnapshot.json" + }, + "Create a virtual machine image from a managed disk.": { + "$ref": "./examples/CreateAnImageFromAManagedDisk.json" + }, + "Create a virtual machine image from an existing virtual machine.": { + "$ref": "./examples/CreateAnImageFromAVM.json" + }, + "Create a virtual machine image that includes a data disk from a blob.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromABlob.json" + }, + "Create a virtual machine image that includes a data disk from a snapshot.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json" + }, + "Create a virtual machine image that includes a data disk from a managed disk.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Images" + ], + "operationId": "Images_Update", + "description": "Update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUpdate" + }, + "description": "Parameters supplied to the Update Image operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Images" + ], + "operationId": "Images_Delete", + "description": "Deletes an Image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_Get", + "description": "Gets an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-examples": { + "Get information about a virtual machine image.": { + "$ref": "./examples/GetInformationAboutAnImage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_ListByResourceGroup", + "description": "Gets the list of images under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a resource group.": { + "$ref": "./examples/ListImagesInAResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_List", + "description": "Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a subscription.": { + "$ref": "./examples/ListImagesInASubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Capture", + "description": "Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureParameters" + }, + "description": "Parameters supplied to the Capture Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": { + "put": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_CreateOrUpdate", + "description": "The operation to create or update a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "Parameters supplied to the Create Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a vm with password authentication.": { + "$ref": "./examples/CreateAVmWithPasswordAuthentication.json" + }, + "Create a vm with ssh authentication.": { + "$ref": "./examples/CreateAVmWithSshAuthentication.json" + }, + "Create a vm with premium storage.": { + "$ref": "./examples/CreateAVmWithPremiumStorage.json" + }, + "Create a vm in an availability set.": { + "$ref": "./examples/CreateAVmInAnAvailabilitySet.json" + }, + "Create a vm with boot diagnostics.": { + "$ref": "./examples/CreateAVmWithBootDiagnostics.json" + }, + "Create a vm with empty data disks.": { + "$ref": "./examples/CreateAVmWithEmptyDataDisks.json" + }, + "Create a vm with a marketplace image plan.": { + "$ref": "./examples/CreateAVmWithAMarketplaceImagePlan.json" + }, + "Create a vm from a custom image.": { + "$ref": "./examples/CreateAVmFromACustomImage.json" + }, + "Create a platform-image vm with unmanaged os and data disks.": { + "$ref": "./examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json" + }, + "Create a custom-image vm from an unmanaged generalized os image.": { + "$ref": "./examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Update", + "description": "The operation to update a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Delete", + "description": "The operation to delete a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Get", + "description": "Retrieves information about the model view or the instance view of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_InstanceView", + "description": "Retrieves information about the run-time state of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/convertToManagedDisks": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ConvertToManagedDisks", + "description": "Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Deallocate", + "description": "Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Generalize", + "description": "Sets the state of the virtual machine to generalized.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_List", + "description": "Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAll", + "description": "Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAvailableSizes", + "description": "Lists all available virtual machine sizes to which the specified virtual machine can be resized.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/powerOff": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PowerOff", + "description": "The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Restart", + "description": "The operation to restart a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Start", + "description": "The operation to start a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Redeploy", + "description": "The operation to redeploy a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PerformMaintenance", + "description": "The operation to perform maintenance on a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { + "put": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_CreateOrUpdate", + "description": "Create or update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The scale set object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a scale set with password authentication.": { + "$ref": "./examples/CreateAScaleSetWithPasswordAuthentication.json" + }, + "Create a scale set with ssh authentication.": { + "$ref": "./examples/CreateAScaleSetWithSshAuthentication.json" + }, + "Create a scale set with premium storage.": { + "$ref": "./examples/CreateAScaleSetWithPremiumStorage.json" + }, + "Create a scale set with empty data disks on each vm.": { + "$ref": "./examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json" + }, + "Create a scale set with an azure load balancer.": { + "$ref": "./examples/CreateAScaleSetWithAnAzureLoadBalancer.json" + }, + "Create a scale set with an azure application gateway.": { + "$ref": "./examples/CreateAScaleSetWithAnAzureApplicationGateway.json" + }, + "Create a scale set with boot diagnostics.": { + "$ref": "./examples/CreateAScaleSetWithBootDiagnostics.json" + }, + "Create a scale set with a marketplace image plan.": { + "$ref": "./examples/CreateAScaleSetWithAMarketplaceImagePlan.json" + }, + "Create a scale set from a custom image.": { + "$ref": "./examples/CreateAScaleSetFromACustomImage.json" + }, + "Create a platform-image scale set with unmanaged os disks.": { + "$ref": "./examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json" + }, + "Create a custom-image scale set from an unmanaged generalized os image.": { + "$ref": "./examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json" + }, + "Create a scale set with virtual machines in different zones.": { + "$ref": "./examples/CreateAScaleSetWithVMsInDifferentZones.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Update", + "description": "Update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdate" + }, + "description": "The scale set object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Delete", + "description": "Deletes a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Get", + "description": "Display information about a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Deallocate", + "description": "Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_DeleteInstances", + "description": "Deletes virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetInstanceView", + "description": "Gets the status of a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_List", + "description": "Gets a list of all VM scale sets under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}": { + "put": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_CreateOrUpdate", + "description": "The operation to create or update an extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "Parameters supplied to the Create VM scale set Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be deleted." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions": { + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_List", + "description": "Gets a list of all extensions in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListAll", + "description": "Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListWithLinkResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListSkus", + "description": "Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListSkusResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetOSUpgradeHistory", + "description": "Gets list of OS upgrades on a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListOSUpgradeHistory" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PowerOff", + "description": "Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Restart", + "description": "Restarts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Start", + "description": "Starts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/redeploy": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Redeploy", + "description": "Redeploy one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PerformMaintenance", + "description": "Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_UpdateInstances", + "description": "Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Reimage", + "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ReimageAll", + "description": "Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_Cancel", + "description": "Cancels the current virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade", + "description": "Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest": { + "get": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_GetLatest", + "description": "Gets the status of the latest virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RollingUpgradeStatusInfo" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/forceRecoveryServiceFabricPlatformUpdateDomainWalk": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk", + "description": "Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "platformUpdateDomain", + "in": "query", + "required": true, + "type": "integer", + "description": "The platform update domain for which a manual recovery walk is requested" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryWalkResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Reimage", + "description": "Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_ReimageAll", + "description": "Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Deallocate", + "description": "Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}": { + "put": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Update", + "description": "Updates a virtual machine of a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "Parameters supplied to the Update Virtual Machine Scale Sets VM operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Delete", + "description": "Deletes a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Get", + "description": "Gets a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_GetInstanceView", + "description": "Gets the status of a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_List", + "description": "Gets a list of all virtual machines in a VM scale sets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply to the operation." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The list parameters." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PowerOff", + "description": "Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Restart", + "description": "Restarts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Start", + "description": "Starts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/redeploy": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Redeploy", + "description": "Redeploys a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PerformMaintenance", + "description": "Performs maintenance on a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getRequestRateByInterval": { + "post": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_ExportRequestRateByInterval", + "x-ms-examples": { + "Export logs which contain all Api requests made to Compute Resource Provider within the given time period broken down by intervals.": { + "$ref": "./examples/LogAnalyticsRequestRateByInterval.json" + } + }, + "description": "Export logs that show Api requests made by this subscription in the given time window to show throttling activities.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RequestRateByIntervalInput" + }, + "description": "Parameters supplied to the LogAnalytics getRequestRateByInterval Api." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getThrottledRequests": { + "post": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_ExportThrottledRequests", + "x-ms-examples": { + "Export logs which contain all throttled Api requests made to Compute Resource Provider within the given time period.": { + "$ref": "./examples/LogAnalyticsThrottledRequests.json" + } + }, + "description": "Export logs that show total throttled Api requests for this subscription in the given time window.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThrottledRequestsInput" + }, + "description": "Parameters supplied to the LogAnalytics getThrottledRequests Api." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } + } + } + }, + "definitions": { + "ComputeOperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ComputeOperationValue" + }, + "description": "The list of compute operations" + } + }, + "description": "The List Compute Operation operation response." + }, + "ComputeOperationValue": { + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the compute operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the compute operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ComputeOperationValueDisplay" + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "ComputeOperationValueDisplay": { + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the compute operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Compute Operation Value Display." + }, + "InstanceViewStatus": { + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": false + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "AvailabilitySetProperties": { + "properties": { + "platformUpdateDomainCount": { + "type": "integer", + "format": "int32", + "description": "Update Domain count." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count." + }, + "virtualMachines": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "A list of references to all virtual machines in the availability set." + }, + "statuses": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a resource." + }, + "AvailabilitySet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the availability set" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "AvailabilitySetUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the availability set" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated." + }, + "AvailabilitySetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "The list of availability sets" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets." + } + }, + "required": [ + "value" + ], + "description": "The List Availability Set operation response." + }, + "VirtualMachineSize": { + "properties": { + "name": { + "type": "string", + "description": "The name of the virtual machine size." + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "The number of cores supported by the virtual machine size." + }, + "osDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The OS disk size, in MB, allowed by the virtual machine size." + }, + "resourceDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The resource disk size, in MB, allowed by the virtual machine size." + }, + "memoryInMB": { + "type": "integer", + "format": "int32", + "description": "The amount of memory, in MB, supported by the virtual machine size." + }, + "maxDataDiskCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of data disks that can be attached to the virtual machine size." + } + }, + "description": "Describes the properties of a VM size." + }, + "VirtualMachineSizeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "description": "The list of virtual machine sizes." + } + }, + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineExtensionImageProperties": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system this extension supports." + }, + "computeRole": { + "type": "string", + "description": "The type of role (IaaS or PaaS) this extension supports." + }, + "handlerSchema": { + "type": "string", + "description": "The schema defined by publisher, where extension consumers should provide settings in a matching schema." + }, + "vmScaleSetEnabled": { + "type": "boolean", + "description": "Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS." + }, + "supportsMultipleExtensions": { + "type": "boolean", + "description": "Whether the handler can support multiple extensions." + } + }, + "required": [ + "operatingSystem", + "computeRole", + "handlerSchema" + ], + "description": "Describes the properties of a Virtual Machine Extension Image." + }, + "VirtualMachineExtensionImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension Image." + }, + "VirtualMachineImageResource": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "location": { + "type": "string", + "description": "The supported Azure location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md)." + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Virtual machine image resource information." + }, + "VirtualMachineExtensionInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The virtual machine extension name." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "substatuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView", + "description": "The virtual machine extension instance view." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtensionUpdateProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtension": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineExtensionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineExtensionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The list of extensions" + } + }, + "description": "The List Extension operation response" + }, + "PurchasePlan": { + "properties": { + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + } + }, + "required": [ + "publisher", + "name", + "product" + ], + "description": "Used for establishing the purchase context of any 3rd Party artifact through MarketPlace." + }, + "OSDiskImage": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system of the osDiskImage.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + } + }, + "required": [ + "operatingSystem" + ], + "description": "Contains the os disk image information." + }, + "DataDiskImage": { + "properties": { + "lun": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "description": "Contains the data disk images information." + }, + "VirtualMachineImageProperties": { + "properties": { + "plan": { + "$ref": "#/definitions/PurchasePlan" + }, + "osDiskImage": { + "$ref": "#/definitions/OSDiskImage" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDiskImage" + } + } + }, + "description": "Describes the properties of a Virtual Machine Image." + }, + "VirtualMachineImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineImageResource" + } + ], + "description": "Describes a Virtual Machine Image." + }, + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "properties": { + "unit": { + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "description": "The current usage of the resource." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes Compute Resource Usage." + }, + "ListUsagesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of compute resource usages." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information." + } + }, + "required": [ + "value" + ], + "description": "The List Usages operation response." + }, + "VirtualMachineCaptureParameters": { + "properties": { + "vhdPrefix": { + "type": "string", + "description": "The captured virtual hard disk's name prefix." + }, + "destinationContainerName": { + "type": "string", + "description": "The destination container name." + }, + "overwriteVhds": { + "type": "boolean", + "description": "Specifies whether to overwrite the destination virtual hard disk, in case of conflict." + } + }, + "required": [ + "vhdPrefix", + "destinationContainerName", + "overwriteVhds" + ], + "description": "Capture Virtual Machine parameters." + }, + "VirtualMachineCaptureResult": { + "properties": { + "$schema": { + "readOnly": true, + "type": "string", + "description": "the schema of the captured virtual machine" + }, + "contentVersion": { + "readOnly": true, + "type": "string", + "description": "the version of the content" + }, + "parameters": { + "readOnly": true, + "type": "object", + "description": "parameters of the captured virtual machine" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "type": "object", + "description": "resource item" + }, + "description": "a list of resource items of the captured virtual machine" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Output of virtual machine capture operation." + }, + "Plan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "HardwareProfile": { + "properties": { + "vmSize": { + "type": "string", + "description": "Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

[List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

[List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

[List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes)", + "enum": [ + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_B1s", + "Standard_B1ms", + "Standard_B2s", + "Standard_B2ms", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_DS13-4_v2", + "Standard_DS13-2_v2", + "Standard_DS14-8_v2", + "Standard_DS14-4_v2", + "Standard_E2_v3", + "Standard_E4_v3", + "Standard_E8_v3", + "Standard_E16_v3", + "Standard_E32_v3", + "Standard_E64_v3", + "Standard_E2s_v3", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_E32-16_v3", + "Standard_E32-8s_v3", + "Standard_E64-32s_v3", + "Standard_E64-16s_v3", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_GS4-8", + "Standard_GS4-4", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_M64-32ms", + "Standard_M64-16ms", + "Standard_M128-64ms", + "Standard_M128-32ms", + "Standard_NC6", + "Standard_NC12", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC6s_v2", + "Standard_NC12s_v2", + "Standard_NC24s_v2", + "Standard_NC24rs_v2", + "Standard_NC6s_v3", + "Standard_NC12s_v3", + "Standard_NC24s_v3", + "Standard_NC24rs_v3", + "Standard_ND6s", + "Standard_ND12s", + "Standard_ND24s", + "Standard_ND24rs", + "Standard_NV6", + "Standard_NV12", + "Standard_NV24" + ], + "x-ms-enum": { + "name": "VirtualMachineSizeTypes", + "modelAsString": true + } + } + }, + "description": "Specifies the hardware settings for the virtual machine." + }, + "ImageReference": { + "properties": { + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "KeyVaultSecretReference": { + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the secret." + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "KeyVaultKeyReference": { + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the key." + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Key" + }, + "DiskEncryptionSettings": { + "properties": { + "diskEncryptionKey": { + "$ref": "#/definitions/KeyVaultSecretReference", + "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyVaultKeyReference", + "description": "Specifies the location of the key encryption key in Key Vault." + }, + "enabled": { + "type": "boolean", + "description": "Specifies whether disk encryption should be enabled on the virtual machine." + } + }, + "description": "Describes a Encryption Settings for a Disk" + }, + "VirtualHardDisk": { + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + }, + "description": "Describes the uri of a disk." + }, + "Caching": { + "type": "string", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "CreateOption": { + "type": "string", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.", + "enum": [ + "FromImage", + "Empty", + "Attach" + ], + "x-ms-enum": { + "name": "DiskCreateOptionTypes", + "modelAsString": true + } + }, + "StorageAccountType": { + "type": "string", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountTypes", + "modelAsString": true + } + }, + "ManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "The parameters of a managed disk." + }, + "OSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

Possible values are:

**Windows**

**Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "encryptionSettings": { + "$ref": "#/definitions/DiskEncryptionSettings", + "description": "Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15" + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + } + }, + "required": [ + "createOption" + ], + "description": "Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "DataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a data disk." + }, + "StorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/OSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Specifies the storage settings for the virtual machine disks." + }, + "AdditionalUnattendContent": { + "properties": { + "passName": { + "type": "string", + "description": "The pass name. Currently, the only allowable value is OobeSystem.", + "enum": [ + "OobeSystem" + ], + "x-ms-enum": { + "name": "PassNames", + "modelAsString": false + } + }, + "componentName": { + "type": "string", + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ], + "x-ms-enum": { + "name": "ComponentNames", + "modelAsString": false + } + }, + "settingName": { + "type": "string", + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ], + "x-ms-enum": { + "name": "SettingNames", + "modelAsString": false + } + }, + "content": { + "type": "string", + "description": "Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted." + } + }, + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + }, + "WinRMListener": { + "properties": { + "protocol": { + "type": "string", + "description": "Specifies the protocol of listener.

Possible values are:
**http**

**https**", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProtocolTypes", + "modelAsString": false + } + }, + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + } + }, + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" + }, + "WinRMConfiguration": { + "properties": { + "listeners": { + "type": "array", + "items": { + "$ref": "#/definitions/WinRMListener" + }, + "description": "The list of Windows Remote Management listeners" + } + }, + "description": "Describes Windows Remote Management configuration of the VM" + }, + "WindowsConfiguration": { + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine.

When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later." + }, + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Indicates whether virtual machine is enabled for automatic updates." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" + }, + "additionalUnattendContent": { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + }, + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." + }, + "winRM": { + "$ref": "#/definitions/WinRMConfiguration", + "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." + } + }, + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "SshPublicKey": { + "properties": { + "path": { + "type": "string", + "description": "Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys" + }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + } + }, + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + }, + "SshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with linux based VMs." + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "LinuxConfiguration": { + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + } + }, + "description": "Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "VaultCertificate": { + "properties": { + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + }, + "certificateStore": { + "type": "string", + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "properties": { + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Describes a set of certificates which are all in the same Key Vault." + }, + "OSProfile": { + "properties": { + "computerName": { + "type": "string", + "description": "Specifies the host OS name of the virtual machine.

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

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

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

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

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

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

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

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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

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

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

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

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

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

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

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "Specifies set of certificates that should be installed onto the virtual machine." + } + }, + "description": "Specifies the operating system settings for the virtual machine." + }, + "NetworkInterfaceReferenceProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "description": "Describes a network interface reference properties." + }, + "NetworkInterfaceReference": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceReferenceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a network interface reference." + }, + "NetworkProfile": { + "properties": { + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceReference" + }, + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." + } + }, + "description": "Specifies the network interfaces of the virtual machine." + }, + "BootDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "DiagnosticsProfile": { + "properties": { + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnostics", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." + } + }, + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "VirtualMachineExtensionHandlerInstanceView": { + "properties": { + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "status": { + "$ref": "#/definitions/InstanceViewStatus", + "description": "The extension handler status." + } + }, + "description": "The instance view of a virtual machine extension handler." + }, + "VirtualMachineAgentInstanceView": { + "properties": { + "vmAgentVersion": { + "type": "string", + "description": "The VM Agent full version." + }, + "extensionHandlers": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionHandlerInstanceView" + }, + "description": "The virtual machine extension handler instance view." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of the VM Agent running on the virtual machine." + }, + "DiskInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "encryptionSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskEncryptionSettings" + }, + "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of the disk." + }, + "BootDiagnosticsInstanceView": { + "properties": { + "consoleScreenshotBlobUri": { + "type": "string", + "description": "The console screenshot blob URI." + }, + "serialConsoleLogBlobUri": { + "type": "string", + "description": "The Linux serial console log blob Uri." + } + }, + "description": "The instance view of a virtual machine boot diagnostics." + }, + "VirtualMachineIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "identityIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of user identities associated with the Virtual Machine. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'." + } + }, + "description": "Identity for the virtual machine." + }, + "MaintenanceRedeployStatus": { + "properties": { + "isCustomerInitiatedMaintenanceAllowed": { + "type": "boolean", + "description": "True, if customer is allowed to perform Maintenance." + }, + "preMaintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Pre Maintenance Window." + }, + "preMaintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Pre Maintenance Window." + }, + "maintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Maintenance Window." + }, + "maintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Maintenance Window." + }, + "lastOperationResultCode": { + "type": "string", + "description": "The Last Maintenance Operation Result Code.", + "enum": [ + "None", + "RetryLater", + "MaintenanceAborted", + "MaintenanceCompleted" + ], + "x-ms-enum": { + "name": "MaintenanceOperationResultCodeTypes", + "modelAsString": false + } + }, + "lastOperationMessage": { + "type": "string", + "description": "Message returned for the last Maintenance Operation." + } + }, + "description": "Maintenance Operation Status." + }, + "VirtualMachineInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the update domain of the virtual machine." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the fault domain of the virtual machine." + }, + "computerName": { + "type": "string", + "description": "The computer name assigned to the virtual machine." + }, + "osName": { + "type": "string", + "description": "The Operating System running on the virtual machine." + }, + "osVersion": { + "type": "string", + "description": "The version of Operating System running on the virtual machine." + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskInstanceView" + }, + "description": "The virtual machine disk information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "description": "The extensions information." + }, + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine." + }, + "VirtualMachineProperties": { + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the virtual machine." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands." + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachine": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine." + }, + "VirtualMachineUpdate": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Update." + }, + "VirtualMachineListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "The list of virtual machines." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" + }, + "capacity": { + "type": "integer", + "format": "int64", + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes a virtual machine scale set sku." + }, + "AutoOSUpgradePolicy": { + "properties": { + "disableAutoRollback": { + "type": "boolean", + "description": "Whether OS image rollback feature should be disabled. Default value is false." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "UpgradePolicy": { + "properties": { + "mode": { + "type": "string", + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

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

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time.", + "enum": [ + "Automatic", + "Manual", + "Rolling" + ], + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": false + } + }, + "rollingUpgradePolicy": { + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "automaticOSUpgrade": { + "type": "boolean", + "description": "Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available." + }, + "autoOSUpgradePolicy": { + "$ref": "#/definitions/AutoOSUpgradePolicy", + "description": "Configuration parameters used for performing automatic OS Upgrade." + } + }, + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "RollingUpgradePolicy": { + "properties": { + "maxBatchInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%." + }, + "maxUnhealthyInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%." + }, + "maxUnhealthyUpgradedInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%." + }, + "pauseTimeBetweenBatches": { + "type": "string", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)." + } + }, + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "ImageOSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "The OS State.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false + } + }, + "snapshot": { + "$ref": "#/definitions/SubResource", + "description": "The snapshot." + }, + "managedDisk": { + "$ref": "#/definitions/SubResource", + "description": "The managedDisk." + }, + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "type": "string", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + } + }, + "required": [ + "osType", + "osState" + ], + "description": "Describes an Operating System disk." + }, + "ImageDataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "snapshot": { + "$ref": "#/definitions/SubResource", + "description": "The snapshot." + }, + "managedDisk": { + "$ref": "#/definitions/SubResource", + "description": "The managedDisk." + }, + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "type": "string", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + } + }, + "required": [ + "lun" + ], + "description": "Describes a data disk." + }, + "ImageStorageProfile": { + "properties": { + "osDisk": { + "$ref": "#/definitions/ImageOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + }, + "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "zoneResilient": { + "type": "boolean", + "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)." + } + }, + "description": "Describes a storage profile." + }, + "ImageProperties": { + "properties": { + "sourceVirtualMachine": { + "$ref": "#/definitions/SubResource", + "description": "The source virtual machine from which Image is created." + }, + "storageProfile": { + "$ref": "#/definitions/ImageStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state." + } + }, + "description": "Describes the properties of an Image." + }, + "Image": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "ImageUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "The source user image virtual hard disk. Only tags may be updated." + }, + "ImageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "description": "The list of Images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images." + } + }, + "required": [ + "value" + ], + "description": "The List Image operation response." + }, + "VirtualMachineScaleSetIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "identityIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of user identities associated with the virtual machine scale set. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'." + } + }, + "description": "Identity for the virtual machine scale set." + }, + "VirtualMachineScaleSetOSProfile": { + "properties": { + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

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

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

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

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

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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

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

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

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

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

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

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

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetUpdateOSProfile": { + "properties": { + "customData": { + "type": "string", + "description": "A base-64 encoded string of custom data." + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "The Windows Configuration of the OS profile." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "The Linux Configuration of the OS profile." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "The List of certificates for addition to the VM." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + } + }, + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "VirtualMachineScaleSetOSDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "Specifies information about the unmanaged user image to base the scale set on." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the container urls that are used to store operating system disks for the scale set." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "required": [ + "createOption" + ], + "description": "Describes a virtual machine scale set operating system disk." + }, + "VirtualMachineScaleSetUpdateOSDisk": { + "properties": { + "caching": { + "$ref": "#/definitions/Caching", + "description": "The caching type." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of virtual hard disk container uris." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "description": "Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk." + }, + "VirtualMachineScaleSetDataDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "The create option." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a virtual machine scale set data disk." + }, + "VirtualMachineScaleSetStorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "VirtualMachineScaleSetUpdateStorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "The image reference." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSDisk", + "description": "The OS disk." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "description": "The data disks." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "ApiEntityReference": { + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "Specifies the identifier of the subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same 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": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetUpdateIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "The subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary IP Configuration in case the network interface has more than one IP Configuration." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The application gateway backend address pools." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The load balancer backend address pools." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The load balancer inbound nat pools." + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" + } + }, + "required": [ + "name" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfigurationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + }, + "description": "Specifies the IP configurations of the network interface." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Whether this is a primary NIC on a virtual machine." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfiguration" + }, + "description": "The virtual machine scale set IP Configuration." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + } + }, + "description": "Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration." + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" + } + }, + "required": [ + "name" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetUpdateNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfigurationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses" + } + }, + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created" + } + }, + "required": [ + "domainNameLabel" + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetIpTag": { + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + }, + "description": "Contains the IP tag associated with the public IP address." + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties" + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIpTag" + }, + "description": "The list of IP tags associated with the public IP address." + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetNetworkProfile": { + "properties": { + "healthProbe": { + "$ref": "#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetUpdateNetworkProfile": { + "properties": { + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtension": { + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The list of VM scale set extensions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions." + } + }, + "required": [ + "value" + ], + "description": "The List VM scale set extension operation response." + }, + "VirtualMachineScaleSetExtensionProfile": { + "properties": { + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The virtual machine scale set child extension resources." + } + }, + "description": "Describes a virtual machine scale set extension profile." + }, + "VirtualMachineScaleSetVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", + "description": "Specifies the operating system settings for the virtual machines in the scale set." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", + "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "priority": { + "type": "string", + "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview", + "enum": [ + "Regular", + "Low" + ], + "x-ms-enum": { + "name": "VirtualMachinePriorityTypes", + "modelAsString": true + } + }, + "evictionPolicy": { + "type": "string", + "description": "Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview", + "enum": [ + "Deallocate", + "Delete" + ], + "x-ms-enum": { + "name": "VirtualMachineEvictionPolicyTypes", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetUpdateVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSProfile", + "description": "The virtual machine scale set OS profile." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateStorageProfile", + "description": "The virtual machine scale set storage profile." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkProfile", + "description": "The virtual machine scale set network profile." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "The virtual machine scale set diagnostics profile." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "The virtual machine scale set extension profile." + }, + "licenseType": { + "type": "string", + "description": "The license type, which is for bring your own license scenario." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile", + "description": "The virtual machine profile." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "uniqueId": { + "readOnly": true, + "type": "string", + "description": "Specifies the ID which uniquely identifies a Virtual Machine Scale Set." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + }, + "zoneBalance": { + "type": "boolean", + "description": "Whether to force stictly even Virtual Machine distribution cross x-zones in case there is zone outage." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count for each placement group." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetUpdateProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateVMProfile", + "description": "The virtual machine profile." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSet": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetUpdate": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "The purchase plan when deploying a virtual machine scale set from VM Marketplace images." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetVMInstanceIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineScaleSetVMInstanceRequiredIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids." + } + }, + "required": [ + "instanceIds" + ], + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineStatusCodeCount": { + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The instance view status code." + }, + "count": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances having a particular status code." + } + }, + "description": "The status code and count of the virtual machine scale set instance view status summary." + }, + "VirtualMachineScaleSetInstanceViewStatusesSummary": { + "properties": { + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "description": "The extensions information." + } + }, + "description": "Instance view statuses summary for virtual machines of a virtual machine scale set." + }, + "VirtualMachineScaleSetVMExtensionsSummary": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The extension name." + }, + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "description": "The extensions information." + } + }, + "description": "Extensions summary for virtual machines of a virtual machine scale set." + }, + "VirtualMachineScaleSetInstanceView": { + "properties": { + "virtualMachine": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceViewStatusesSummary", + "readOnly": true, + "description": "The instance view status summary for the virtual machine scale set." + }, + "extensions": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsSummary" + }, + "description": "The extensions information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine scale set." + }, + "VirtualMachineScaleSetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetListWithLinkResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetSkuCapacity": { + "properties": { + "minimum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The minimum capacity." + }, + "maximum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum capacity that can be set." + }, + "defaultCapacity": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The default capacity." + }, + "scaleType": { + "readOnly": true, + "type": "string", + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "None" + ], + "x-ms-enum": { + "name": "VirtualMachineScaleSetSkuScaleType", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a sku." + }, + "VirtualMachineScaleSetSku": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the sku applies to." + }, + "sku": { + "$ref": "#/definitions/Sku", + "readOnly": true, + "description": "The Sku." + }, + "capacity": { + "$ref": "#/definitions/VirtualMachineScaleSetSkuCapacity", + "readOnly": true, + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes an available virtual machine scale set sku." + }, + "VirtualMachineScaleSetListSkusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetSku" + }, + "description": "The list of skus available for the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus." + } + }, + "required": [ + "value" + ], + "description": "The Virtual Machine Scale Set List Skus operation response." + }, + "RollbackStatusInfo": { + "properties":{ + "successfullyRolledbackInstanceCount" : { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which have been successfully rolled back." + }, + "failedRolledbackInstanceCount" : { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which failed to rollback." + }, + "rollbackError" : { + "$ref": "#/definitions/ApiError", + "readOnly": true, + "description": "Error details if OS rollback failed." + } + }, + "description": "Information about rollback on failed VM instances after a OS Upgrade operation." + }, + "UpgradeOperationHistoryStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "UpgradeState", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "End time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "UpgradeOperationHistoricalStatusInfoProperties": { + "properties": { + "runningStatus": { + "$ref": "#/definitions/UpgradeOperationHistoryStatus", + "readOnly": true, + "description": "Information about the overall status of the upgrade operation." + }, + "progress": { + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "readOnly": true, + "description": "Counts of the VM's in each state." + }, + "error": { + "$ref": "#/definitions/ApiError", + "readOnly": true, + "description": "Error Details for this upgrade if there are any." + }, + "startedBy": { + "readOnly": true, + "type": "string", + "description": "Invoker of the Upgrade Operation", + "enum": [ + "Unknown", + "User", + "Platform" + ], + "x-ms-enum": { + "name": "UpgradeOperationInvoker", + "modelAsString": false + } + }, + "targetImageReference": { + "$ref": "#/definitions/ImageReference", + "readOnly": true, + "description": "Image Reference details" + }, + "rollbackInfo": { + "$ref": "#/definitions/RollbackStatusInfo", + "readOnly": true, + "description": "Information about OS rollback if performed" + } + }, + "description": "Describes each OS upgrade on the Virtual Machine Scale Set." + }, + "UpgradeOperationHistoricalStatusInfo": { + "properties": { + "properties": { + "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfoProperties", + "readOnly": true, + "description": "Information about the properties of the upgrade operation." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Resource location" + } + }, + "description": "Virtual Machine Scale Set OS Upgrade History operation response." + }, + "VirtualMachineScaleSetListOSUpgradeHistory": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfo" + }, + "description": "The list of OS upgrades performed on the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades." + } + }, + "required": [ + "value" + ], + "description": "List of Virtual Machine Scale Set OS Upgrade History operation response." + }, + "VirtualMachineScaleSetVMProperties": { + "properties": { + "latestModelApplied": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the latest model has been applied to the virtual machine." + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Azure VM unique ID." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the virtual machine." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + } + }, + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVM": { + "properties": { + "instanceId": { + "readOnly": true, + "type": "string", + "description": "The virtual machine instance ID." + }, + "sku": { + "$ref": "#/definitions/Sku", + "readOnly": true, + "description": "The virtual machine SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVMInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "The Update Domain count." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "The Fault Domain count." + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskInstanceView" + }, + "description": "The disks information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "description": "The extensions information." + }, + "vmHealth": { + "readOnly": true, + "$ref": "#/definitions/VirtualMachineHealthStatus", + "description": "The health status for the VM." + }, + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "placementGroupId": { + "type": "string", + "description": "The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId." + } + }, + "description": "The instance view of a virtual machine scale set VM." + }, + "VirtualMachineHealthStatus": { + "properties": { + "status": { + "readOnly": true, + "$ref": "#/definitions/InstanceViewStatus", + "description": "The health status information for the VM." + } + }, + "description": "The health status of the VM." + }, + "VirtualMachineScaleSetVMListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "The list of virtual machine scale sets VMs." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs" + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine Scale Set VMs operation response." + }, + "RollingUpgradeStatusInfo": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RollingUpgradeStatusInfoProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeStatusInfoProperties": { + "properties": { + "policy": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The rolling upgrade policies applied for this upgrade." + }, + "runningStatus": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeRunningStatus", + "description": "Information about the current running state of the overall upgrade." + }, + "progress": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "error": { + "readOnly": true, + "$ref": "#/definitions/ApiError", + "description": "Error details for this upgrade, if there are any." + } + }, + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeRunningStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "RollingUpgradeStatusCode", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "lastAction": { + "type": "string", + "readOnly": true, + "description": "The last action performed on the rolling upgrade.", + "enum": [ + "Start", + "Cancel" + ], + "x-ms-enum": { + "name": "RollingUpgradeActionType", + "modelAsString": false + } + }, + "lastActionTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Last action time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "RollingUpgradeProgressInfo": { + "properties": { + "successfulInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have been successfully upgraded." + }, + "failedInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have failed to be upgraded successfully." + }, + "inProgressInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that are currently being upgraded." + }, + "pendingInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have not yet begun to be upgraded." + } + }, + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "ApiErrorBase": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error base." + }, + "InnerError": { + "properties": { + "exceptiontype": { + "type": "string", + "description": "The exception type." + }, + "errordetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + }, + "description": "Inner error details." + }, + "ApiError": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "description": "The Api error details" + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The Api inner error" + }, + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error." + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "UpdateResource": { + "description": "The Update Resource model definition.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "SubResourceReadOnly": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "RecoveryWalkResponse": { + "properties": { + "walkPerformed": { + "type": "boolean", + "readOnly": true, + "description": "Whether the recovery walk was performed" + }, + "nextPlatformUpdateDomain": { + "type": "integer", + "readOnly": true, + "description": "The next update domain that needs to be walked. Null means walk spanning all update domains has been completed" + } + }, + "description": "Response after calling a manual recovery walk" + }, + "RequestRateByIntervalInput": { + "properties": { + "intervalLength": { + "type": "string", + "description": "Interval value in minutes used to create LogAnalytics call rate logs.", + "enum": [ + "ThreeMins", + "FiveMins", + "ThirtyMins", + "SixtyMins" + ], + "x-ms-enum": { + "name": "IntervalInMins", + "modelAsString": false + } + } + }, + "required": [ + "intervalLength" + ], + "allOf": [ + { + "$ref": "#/definitions/LogAnalyticsInputBase" + } + ], + "description": "Api request input for LogAnalytics getRequestRateByInterval Api." + }, + "ThrottledRequestsInput": { + "allOf": [ + { + "$ref": "#/definitions/LogAnalyticsInputBase" + } + ], + "description": "Api request input for LogAnalytics getThrottledRequests Api." + }, + "LogAnalyticsInputBase": { + "properties": { + "blobContainerSasUri": { + "type": "string", + "description": "SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to." + }, + "fromTime": { + "type": "string", + "format": "date-time", + "description": "From time of the query" + }, + "toTime": { + "type": "string", + "format": "date-time", + "description": "To time of the query" + }, + "groupByThrottlePolicy": { + "type": "boolean", + "description": "Group query result by Throttle Policy applied." + }, + "groupByOperationName": { + "type": "boolean", + "description": "Group query result by by Operation Name." + }, + "groupByResourceName": { + "type": "boolean", + "description": "Group query result by Resource Name." + } + }, + "required": [ + "blobContainerSasUri", + "fromTime", + "toTime" + ], + "description": "Api input base class for LogAnalytics Api." + }, + "LogAnalyticsOperationResult": { + "properties": { + "properties": { + "readOnly": true, + "$ref": "#/definitions/LogAnalyticsOutput", + "description": "LogAnalyticsOutput" + } + }, + "description": "LogAnalytics operation status response" + }, + "LogAnalyticsOutput": { + "properties": { + "output": { + "readOnly": true, + "type": "string", + "description": "Output file Uri path to blob container." + } + }, + "description": "LogAnalytics output properties" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/disk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/disk.json index 64f9a2b1e09e..714d1630d3dd 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/disk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/disk.json @@ -201,10 +201,7 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationStatusResponse" - } + "description": "OK" }, "202": { "description": "Accepted" @@ -352,10 +349,7 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationStatusResponse" - } + "description": "OK" }, "202": { "description": "Accepted" @@ -522,10 +516,7 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationStatusResponse" - } + "description": "OK" }, "202": { "description": "Accepted" @@ -673,10 +664,7 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationStatusResponse" - } + "description": "OK" }, "202": { "description": "Accepted" @@ -722,21 +710,6 @@ ], "x-ms-azure-resource": true }, - "ResourceUpdate": { - "description": "The Resource model definition.", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "sku": { - "$ref": "#/definitions/DiskSku" - } - } - }, "Disk": { "properties": { "managedBy": { @@ -771,13 +744,18 @@ "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/DiskUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "sku": { + "$ref": "#/definitions/DiskSku" } }, - "allOf": [ - { - "$ref": "#/definitions/ResourceUpdate" - } - ], "description": "Disk update resource." }, "DiskList": { @@ -805,7 +783,8 @@ "type": "string", "enum": [ "Standard_LRS", - "Premium_LRS" + "Premium_LRS", + "StandardSSD_LRS" ], "x-ms-enum": { "name": "StorageAccountTypes", @@ -820,7 +799,7 @@ "description": "The sku tier." } }, - "description": "The disks sku name. Can be Standard_LRS or Premium_LRS." + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, or StandardSSD_LRS." }, "SnapshotSku": { "properties": { @@ -1086,7 +1065,7 @@ "description": "A SAS uri for accessing a disk." } }, - "description": "This object gets 'bubbled up' through flattening." + "description": "A disk access SAS uri." }, "Snapshot": { "properties": { @@ -1115,13 +1094,18 @@ "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/DiskUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "sku": { + "$ref": "#/definitions/SnapshotSku" } }, - "allOf": [ - { - "$ref": "#/definitions/ResourceUpdate" - } - ], "description": "Snapshot update resource." }, "SnapshotList": { @@ -1142,96 +1126,6 @@ "value" ], "description": "The List Snapshots operation response." - }, - "ApiErrorBase": { - "properties": { - "code": { - "type": "string", - "description": "The error code." - }, - "target": { - "type": "string", - "description": "The target of the particular error." - }, - "message": { - "type": "string", - "description": "The error message." - } - }, - "description": "Api error base." - }, - "InnerError": { - "properties": { - "exceptiontype": { - "type": "string", - "description": "The exception type." - }, - "errordetail": { - "type": "string", - "description": "The internal error message or exception dump." - } - }, - "description": "Inner error details." - }, - "ApiError": { - "properties": { - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiErrorBase" - }, - "description": "The Api error details" - }, - "innererror": { - "$ref": "#/definitions/InnerError", - "description": "The Api inner error" - }, - "code": { - "type": "string", - "description": "The error code." - }, - "target": { - "type": "string", - "description": "The target of the particular error." - }, - "message": { - "type": "string", - "description": "The error message." - } - }, - "description": "Api error." - }, - "OperationStatusResponse": { - "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/ApiError", - "description": "Api error" - } - }, - "description": "Operation status response" } }, "parameters": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json new file mode 100644 index 000000000000..ab9bb616e3e6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json @@ -0,0 +1,202 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2018-04-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "caching": "ReadWrite", + "image": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d6e9ab29-f8c9-4792-978c-ae2c07b98f17", + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d6e9ab29-f8c9-4792-978c-ae2c07b98f17", + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json new file mode 100644 index 000000000000..4f9f1876d67d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2018-04-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd" + }, + "osType": "Windows", + "createOption": "FromImage", + "caching": "ReadWrite", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + } + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + } + }, + "dataDisks": [] + }, + "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + } + }, + "dataDisks": [] + }, + "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json new file mode 100644 index 000000000000..a923bb671075 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2018-04-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "osDisk", + "vhdContainers": [ + "http://{existing-storage-account-name-0}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-1}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-2}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-3}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-4}.blob.core.windows.net/vhdContainer" + ] + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhdContainers": [ + "http://{existing-storage-account-name}.blob.core.windows.net/vhds" + ], + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhdContainers": [ + "http://{existing-storage-account-name}.blob.core.windows.net/vhds" + ], + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json new file mode 100644 index 000000000000..654744f21548 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json @@ -0,0 +1,214 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2018-04-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0, + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk0.vhd" + } + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1, + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk1.vhd" + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "name": "dataDisk0", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" + }, + "lun": 0 + }, + { + "name": "dataDisk1", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" + }, + "lun": 1 + } + ] + }, + "vmId": "5230a749-2f68-4830-900b-702182d32e63", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "name": "dataDisk0", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" + }, + "lun": 0 + }, + { + "name": "dataDisk1", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" + }, + "lun": 1 + } + ] + }, + "vmId": "5230a749-2f68-4830-900b-702182d32e63", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetFromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetFromACustomImage.json new file mode 100644 index 000000000000..0a3580b003aa --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetFromACustomImage.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2018-04-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json new file mode 100644 index 000000000000..7042385a6081 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2018-04-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json new file mode 100644 index 000000000000..a00706d28599 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2018-04-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/{existing-application-gateway-name}/backendAddressPools/{existing-backend-address-pool-name}" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json new file mode 100644 index 000000000000..5bb13661aed0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json @@ -0,0 +1,245 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2018-04-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/inboundNatPools/{existing-nat-pool-name}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/backendAddressPools/{existing-backend-address-pool-name}" + } + ] + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithBootDiagnostics.json new file mode 100644 index 000000000000..51edd367317a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithBootDiagnostics.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2018-04-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json new file mode 100644 index 000000000000..acb1f2d4c9fe --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2018-04-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Succeeded" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithPasswordAuthentication.json new file mode 100644 index 000000000000..a73a00a4863d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithPasswordAuthentication.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2018-04-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithPremiumStorage.json new file mode 100644 index 000000000000..b65694bcf46d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithPremiumStorage.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2018-04-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithSshAuthentication.json new file mode 100644 index 000000000000..70af1d6cca04 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithSshAuthentication.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2018-04-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithVMsInDifferentZones.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithVMsInDifferentZones.json new file mode 100644 index 000000000000..b3e37129623e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithVMsInDifferentZones.json @@ -0,0 +1,284 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2018-04-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "location": "centralus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + } + }, + "zones": [ + "1", + "3" + ] + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": false, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "zoneBalance": false, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + }, + "provisioningState": "Succeeded" + }, + "zones": [ + "1", + "3" + ], + "location": "centralus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": false, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "zoneBalance": false, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + }, + "provisioningState": "Creating" + }, + "zones": [ + "1", + "3" + ], + "location": "centralus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmFromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmFromACustomImage.json new file mode 100644 index 000000000000..ccf9a7684aaf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmFromACustomImage.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2018-04-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmInAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmInAnAvailabilitySet.json new file mode 100644 index 000000000000..d2d761f236cb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmInAnAvailabilitySet.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2018-04-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/{existing-availability-set-name}" + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithAMarketplaceImagePlan.json new file mode 100644 index 000000000000..01910919eb91 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithAMarketplaceImagePlan.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2018-04-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "name": "myVM", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithBootDiagnostics.json new file mode 100644 index 000000000000..425252a2588a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithBootDiagnostics.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2018-04-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithEmptyDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithEmptyDataDisks.json new file mode 100644 index 000000000000..1caa47caf5e3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithEmptyDataDisks.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2018-04-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithPasswordAuthentication.json new file mode 100644 index 000000000000..96e5b052e5ee --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithPasswordAuthentication.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2018-04-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithPremiumStorage.json new file mode 100644 index 000000000000..c8ecc10c67c1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithPremiumStorage.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2018-04-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithSshAuthentication.json new file mode 100644 index 000000000000..a3505e3ce8af --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAVmWithSshAuthentication.json @@ -0,0 +1,178 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2018-04-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "{image_sku}", + "publisher": "{image_publisher}", + "version": "latest", + "offer": "{image_offer}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnAvailabilitySet.json new file mode 100644 index 000000000000..857c4a59c872 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnAvailabilitySet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "availabilitySetName": "myAvailabilitySet", + "parameters": { + "location": "westus", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20 + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Classic" + }, + "name": "myAvailabilitySet", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20 + }, + "location": "westus", + "type": "Microsoft.Compute/availabilitySets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageFromABlob.json new file mode 100644 index 000000000000..14771f40eac4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageFromABlob.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageFromAManagedDisk.json new file mode 100644 index 000000000000..13f09bcbf009 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageFromAManagedDisk.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageFromASnapshot.json new file mode 100644 index 000000000000..ae462680ba09 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageFromASnapshot.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageFromAVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageFromAVM.json new file mode 100644 index 000000000000..30edab930986 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageFromAVM.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" + }, + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" + }, + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json new file mode 100644 index 000000000000..c0206fcd6864 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json new file mode 100644 index 000000000000..48c512e4ed87 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json new file mode 100644 index 000000000000..349d669af5e0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/GetInformationAboutAnImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/GetInformationAboutAnImage.json new file mode 100644 index 000000000000..4d7b59141870 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/GetInformationAboutAnImage.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "imageName": "myImage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + } + } +} 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 new file mode 100644 index 000000000000..4eef762de4a5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListAvailabilitySetsInASubscription.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 2 + }, + "type": "Microsoft.Compute/availabilitySets", + "location": "centralus", + "tags": { + "{tagName}": "{tagValue}" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "name": "{availabilitySetName}", + "sku": { + "name": "Aligned" + } + }, + { + "properties": { + "platformUpdateDomainCount": 3, + "platformFaultDomainCount": 2 + }, + "type": "Microsoft.Compute/availabilitySets", + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "name": "{availabilitySetName}", + "sku": { + "name": "Classic" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListImagesInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListImagesInAResourceGroup.json new file mode 100644 index 000000000000..5b3c5070a108 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListImagesInAResourceGroup.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListImagesInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListImagesInASubscription.json new file mode 100644 index 000000000000..73fba357dfb9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListImagesInASubscription.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/LogAnalyticsRequestRateByInterval.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/LogAnalyticsRequestRateByInterval.json new file mode 100644 index 000000000000..d453283944d7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/LogAnalyticsRequestRateByInterval.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "westus", + "api-version": "2018-04-01", + "parameters": { + "intervalLength": "FiveMins", + "blobContainerSasUri": "https://somesasuri", + "fromTime": "2018-01-21T01:54:06.862601Z", + "toTime": "2018-01-23T01:54:06.862601Z", + "groupByResourceName": true + } + }, + "responses": { + "200": { + "body": { + "startTime": "2018-01-30T17:54:14.8806951-08:00", + "endTime": "2018-01-30T17:54:17.5832413-08:00", + "status": "Succeeded", + "properties": { + "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/RequestRateByInterval_20180121-0154_20180123-0154.csv" + }, + "name": "8eb1169a-5cf9-46b1-aadf-41e4f60692df" + } + }, + "202": { + "body": "" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/LogAnalyticsThrottledRequests.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/LogAnalyticsThrottledRequests.json new file mode 100644 index 000000000000..ad168bcd799b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/LogAnalyticsThrottledRequests.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "westus", + "api-version": "2018-04-01", + "parameters": { + "blobContainerSasUri": "https://somesasuri", + "fromTime": "2018-01-21T01:54:06.862601Z", + "toTime": "2018-01-23T01:54:06.862601Z", + "groupByOperationName": true, + "groupByResourceName": false + } + }, + "responses": { + "200": { + "body": { + "startTime": "2018-01-30T17:54:14.8806951-08:00", + "endTime": "2018-01-30T17:54:17.5832413-08:00", + "status": "Succeeded", + "properties": { + "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/ThrottledRequests_20180121-0154_20180123-0154.csv" + }, + "name": "8eb1169a-5cf9-46b1-aadf-41e4f60692df" + } + }, + "202": { + "body": "" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommand.json new file mode 100644 index 000000000000..18067848da32 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommand.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", + "resourceGroupName": "crptestar98131", + "vmName": "vm3036", + "$top": "1", + "api-version": "2018-04-01", + "monitor": "true", + "parameters": { + "commandId": "RunPowerShellScript" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "code": "ComponentStatus/StdOut/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "This is a sample script with parameters value1 value2" + }, + { + "code": "ComponentStatus/StdErr/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "" + } + ] + } + }, + "202": { + "body": "" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommandGet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommandGet.json new file mode 100644 index 000000000000..4b656c9d313a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommandGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", + "location": "SoutheastAsia", + "commandId": "RunPowerShellScript", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "script": [ + "param(", + " [string]$arg1,", + " [string]$arg2", + ")", + "Write-Host This is a sample script with parameters $arg1 $arg2" + ], + "parameters": [ + { + "name": "arg1", + "type": "string", + "value": "value1" + }, + { + "name": "arg2", + "type": "string", + "value": "value2" + } + ], + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunPowerShellScript", + "osType": "Windows", + "label": "Executes a PowerShell script", + "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property." + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommandList.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommandList.json new file mode 100644 index 000000000000..f0bad376af5c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommandList.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "SoutheastAsia", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "value": [{ + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "EnableRemotePS", + "osType": "Windows", + "label": "Enable remote PowerShell", + "description": "Configure the machine to enable remote PowerShell." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "IPConfig", + "osType": "Windows", + "label": "List IP configuration", + "description": "Shows detailed information for the IP address, subnet mask and default gateway for each adapter bound to TCP/IP." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunPowerShellScript", + "osType": "Windows", + "label": "Executes a PowerShell script", + "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunShellScript", + "osType": "Linux", + "label": "Executes a Linux shell script", + "description": "Custom multiline shell script should be defined in script property. Optional parameters can be set in parameters property." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ifconfig", + "osType": "Linux", + "label": "List network configuration", + "description": "Get the configuration of all network interfaces." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "EnableAdminAccount", + "osType": "Windows", + "label": "Enable administrator account", + "description": "Checks if the local Administrator account is disabled, and if so enables it." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ResetAccountPassword", + "osType": "Windows", + "label": "Reset built-in Administrator account password", + "description": "Reset built-in Administrator account password." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RDPSettings", + "osType": "Windows", + "label": "Verify RDP Listener Settings", + "description": "Checks registry settings and domain policy settings. Suggests policy actions if machine is part of a domain or modifies the settings to default values." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "SetRDPPort", + "osType": "Windows", + "label": "Set Remote Desktop port", + "description": "Sets the default or user specified port number for Remote Desktop connections. Enables firewall rule for inbound access to the port." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ResetRDPCert", + "osType": "Windows", + "label": "Restore RDP Authentication mode to defaults", + "description": "Removes the SSL certificate tied to the RDP listener and restores the RDP listerner security to default. Use this script if you see any issues with the certificate." + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/runCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/runCommands.json new file mode 100644 index 000000000000..747038cae783 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/runCommands.json @@ -0,0 +1,461 @@ +{ + "swagger": "2.0", + "info": { + "title": "RunCommandsClient", + "description": "The Run Commands Client.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands": { + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_List", + "x-ms-examples": { + "VirtualMachineRunCommandList": { "$ref": "./examples/VirtualMachineRunCommandList.json" } + }, + "description": "Lists all available run commands for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which run commands is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}": { + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_Get", + "x-ms-examples": { + "VirtualMachineRunCommandGet": { "$ref": "./examples/VirtualMachineRunCommandGet.json" } + }, + "description": "Gets specific run command for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which run commands is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "The command id." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandDocument" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_RunCommand", + "x-ms-examples": { + "VirtualMachineRunCommand": { "$ref": "./examples/VirtualMachineRunCommand.json" } + }, + "description": "Run command on the VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandInput" + }, + "description": "Parameters supplied to the Run command operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/runCommand": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_RunCommand", + "description": "Run command on a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandInput" + }, + "description": "Parameters supplied to the Run command operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "RunCommandInputParameter": { + "properties": { + "name": { + "type": "string", + "description": "The run command parameter name." + }, + "value": { + "type": "string", + "description": "The run command parameter value." + } + }, + "required": [ + "name", + "value" + ], + "description": "Describes the properties of a run command parameter." + }, + "RunCommandInput": { + "properties": { + "commandId": { + "type": "string", + "description": "The run command id." + }, + "script": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. The script to be executed. When this value is given, the given script will override the default script of the command." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + }, + "description": "The run command parameters." + } + }, + "required": [ + "commandId" + ], + "description": "Capture Virtual Machine parameters." + }, + "RunCommandParameterDefinition": { + "properties": { + "name": { + "type": "string", + "description": "The run command parameter name." + }, + "type": { + "type": "string", + "description": "The run command parameter type." + }, + "defaultValue": { + "type": "string", + "description": "The run command parameter default value." + }, + "required": { + "type": "boolean", + "description": "The run command parameter required.", + "default": false + } + }, + "required": [ + "name", + "type" + ], + "description": "Describes the properties of a run command parameter." + }, + "RunCommandDocumentBase": { + "properties": { + "$schema": { + "type": "string", + "description": "The VM run command schema." + }, + "id": { + "type": "string", + "description": "The VM run command id." + }, + "osType": { + "type": "string", + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "label": { + "type": "string", + "description": "The VM run command label." + }, + "description": { + "type": "string", + "description": "The VM run command description." + } + }, + "required": [ + "$schema", + "id", + "osType", + "label", + "description" + ], + "description": "Describes the properties of a Run Command metadata." + }, + "RunCommandDocument": { + "allOf": [ + { + "$ref": "#/definitions/RunCommandDocumentBase" + } + ], + "properties": { + "script": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The script to be executed." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandParameterDefinition" + }, + "description": "The parameters used by the script." + } + }, + "required": [ + "script" + ], + "description": "Describes the properties of a Run Command." + }, + "RunCommandListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandDocumentBase" + }, + "description": "The list of virtual machine run commands." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "InstanceViewStatus": { + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": false + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "RunCommandResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "Run command operation response." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json new file mode 100644 index 000000000000..4ae94aa01d89 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json @@ -0,0 +1,8044 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2018-06-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Compute/operations": { + "get": { + "tags": [ + "ComputeOperations" + ], + "operationId": "Operations_List", + "description": "Gets a list of compute operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ComputeOperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}": { + "put": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_CreateOrUpdate", + "description": "Create or update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "Parameters supplied to the Create Availability Set operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + }, + "x-ms-examples": { + "Create an availability set.": { + "$ref": "./examples/CreateAnAvailabilitySet.json" + } + } + }, + "patch": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Update", + "description": "Update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySetUpdate" + }, + "description": "Parameters supplied to the Update Availability Set operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + } + }, + "delete": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Delete", + "description": "Delete an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Get", + "description": "Retrieves information about an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListBySubscription", + "description": "Lists all availability sets in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_List", + "description": "Lists all availability sets in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/vmSizes": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListAvailableSizes", + "description": "Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_Get", + "description": "Gets a virtual machine extension image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListTypes", + "description": "Gets a list of virtual machine extension image types.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListVersions", + "description": "Gets a list of virtual machine extension image versions.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + }, + "x-ms-odata": "#/definitions/VirtualMachineExtensionImage" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}": { + "put": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_CreateOrUpdate", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be created or updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "Parameters supplied to the Create Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Update", + "description": "The operation to update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be deleted." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions": { + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_List", + "description": "The operation to get all extensions of a Virtual Machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionsListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_Get", + "description": "Gets a virtual machine image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU version." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineImage" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_List", + "description": "Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + }, + "x-ms-odata": "#/definitions/VirtualMachineImageResource" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListOffers", + "description": "Gets a list of virtual machine image offers for the specified location and publisher.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListPublishers", + "description": "Gets a list of virtual machine image publishers for the specified Azure location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListSkus", + "description": "Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usage_List", + "description": "Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "Lists all available virtual machine sizes for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}": { + "put": { + "tags": [ + "Images" + ], + "operationId": "Images_CreateOrUpdate", + "description": "Create or update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Image" + }, + "description": "Parameters supplied to the Create Image operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-examples": { + "Create a virtual machine image from a blob.": { + "$ref": "./examples/CreateAnImageFromABlob.json" + }, + "Create a virtual machine image from a snapshot.": { + "$ref": "./examples/CreateAnImageFromASnapshot.json" + }, + "Create a virtual machine image from a managed disk.": { + "$ref": "./examples/CreateAnImageFromAManagedDisk.json" + }, + "Create a virtual machine image from an existing virtual machine.": { + "$ref": "./examples/CreateAnImageFromAVM.json" + }, + "Create a virtual machine image that includes a data disk from a blob.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromABlob.json" + }, + "Create a virtual machine image that includes a data disk from a snapshot.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json" + }, + "Create a virtual machine image that includes a data disk from a managed disk.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Images" + ], + "operationId": "Images_Update", + "description": "Update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUpdate" + }, + "description": "Parameters supplied to the Update Image operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Images" + ], + "operationId": "Images_Delete", + "description": "Deletes an Image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_Get", + "description": "Gets an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-examples": { + "Get information about a virtual machine image.": { + "$ref": "./examples/GetInformationAboutAnImage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_ListByResourceGroup", + "description": "Gets the list of images under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a resource group.": { + "$ref": "./examples/ListImagesInAResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_List", + "description": "Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a subscription.": { + "$ref": "./examples/ListImagesInASubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Capture", + "description": "Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureParameters" + }, + "description": "Parameters supplied to the Capture Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": { + "put": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_CreateOrUpdate", + "description": "The operation to create or update a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "Parameters supplied to the Create Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a vm with password authentication.": { + "$ref": "./examples/CreateAVmWithPasswordAuthentication.json" + }, + "Create a vm with ssh authentication.": { + "$ref": "./examples/CreateAVmWithSshAuthentication.json" + }, + "Create a vm with premium storage.": { + "$ref": "./examples/CreateAVmWithPremiumStorage.json" + }, + "Create a vm in an availability set.": { + "$ref": "./examples/CreateAVmInAnAvailabilitySet.json" + }, + "Create a vm with boot diagnostics.": { + "$ref": "./examples/CreateAVmWithBootDiagnostics.json" + }, + "Create a vm with empty data disks.": { + "$ref": "./examples/CreateAVmWithEmptyDataDisks.json" + }, + "Create a vm with a marketplace image plan.": { + "$ref": "./examples/CreateAVmWithAMarketplaceImagePlan.json" + }, + "Create a vm from a custom image.": { + "$ref": "./examples/CreateAVmFromACustomImage.json" + }, + "Create a platform-image vm with unmanaged os and data disks.": { + "$ref": "./examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json" + }, + "Create a custom-image vm from an unmanaged generalized os image.": { + "$ref": "./examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Update", + "description": "The operation to update a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Delete", + "description": "The operation to delete a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Get", + "description": "Retrieves information about the model view or the instance view of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_InstanceView", + "description": "Retrieves information about the run-time state of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/convertToManagedDisks": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ConvertToManagedDisks", + "description": "Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Deallocate", + "description": "Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Generalize", + "description": "Sets the state of the virtual machine to generalized.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_List", + "description": "Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAll", + "description": "Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAvailableSizes", + "description": "Lists all available virtual machine sizes to which the specified virtual machine can be resized.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/powerOff": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PowerOff", + "description": "The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Restart", + "description": "The operation to restart a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Start", + "description": "The operation to start a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Redeploy", + "description": "The operation to redeploy a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PerformMaintenance", + "description": "The operation to perform maintenance on a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { + "put": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_CreateOrUpdate", + "description": "Create or update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The scale set object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a scale set with password authentication.": { + "$ref": "./examples/CreateAScaleSetWithPasswordAuthentication.json" + }, + "Create a scale set with ssh authentication.": { + "$ref": "./examples/CreateAScaleSetWithSshAuthentication.json" + }, + "Create a scale set with premium storage.": { + "$ref": "./examples/CreateAScaleSetWithPremiumStorage.json" + }, + "Create a scale set with empty data disks on each vm.": { + "$ref": "./examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json" + }, + "Create a scale set with an azure load balancer.": { + "$ref": "./examples/CreateAScaleSetWithAnAzureLoadBalancer.json" + }, + "Create a scale set with an azure application gateway.": { + "$ref": "./examples/CreateAScaleSetWithAnAzureApplicationGateway.json" + }, + "Create a scale set with boot diagnostics.": { + "$ref": "./examples/CreateAScaleSetWithBootDiagnostics.json" + }, + "Create a scale set with a marketplace image plan.": { + "$ref": "./examples/CreateAScaleSetWithAMarketplaceImagePlan.json" + }, + "Create a scale set from a custom image.": { + "$ref": "./examples/CreateAScaleSetFromACustomImage.json" + }, + "Create a platform-image scale set with unmanaged os disks.": { + "$ref": "./examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json" + }, + "Create a custom-image scale set from an unmanaged generalized os image.": { + "$ref": "./examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Update", + "description": "Update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdate" + }, + "description": "The scale set object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Delete", + "description": "Deletes a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Get", + "description": "Display information about a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Deallocate", + "description": "Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_DeleteInstances", + "description": "Deletes virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetInstanceView", + "description": "Gets the status of a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_List", + "description": "Gets a list of all VM scale sets under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}": { + "put": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_CreateOrUpdate", + "description": "The operation to create or update an extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "Parameters supplied to the Create VM scale set Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be deleted." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions": { + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_List", + "description": "Gets a list of all extensions in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListAll", + "description": "Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListWithLinkResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListSkus", + "description": "Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListSkusResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetOSUpgradeHistory", + "description": "Gets list of OS upgrades on a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListOSUpgradeHistory" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PowerOff", + "description": "Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Restart", + "description": "Restarts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Start", + "description": "Starts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/redeploy": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Redeploy", + "description": "Redeploy one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PerformMaintenance", + "description": "Perform maintenance on one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_UpdateInstances", + "description": "Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Reimage", + "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ReimageAll", + "description": "Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_Cancel", + "description": "Cancels the current virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade", + "description": "Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest": { + "get": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_GetLatest", + "description": "Gets the status of the latest virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RollingUpgradeStatusInfo" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/forceRecoveryServiceFabricPlatformUpdateDomainWalk": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk", + "description": "Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "platformUpdateDomain", + "in": "query", + "required": true, + "type": "integer", + "description": "The platform update domain for which a manual recovery walk is requested" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryWalkResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Reimage", + "description": "Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_ReimageAll", + "description": "Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Deallocate", + "description": "Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}": { + "put": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Update", + "description": "Updates a virtual machine of a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "Parameters supplied to the Update Virtual Machine Scale Sets VM operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Delete", + "description": "Deletes a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Get", + "description": "Gets a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_GetInstanceView", + "description": "Gets the status of a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_List", + "description": "Gets a list of all virtual machines in a VM scale sets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply to the operation." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The list parameters." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PowerOff", + "description": "Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Restart", + "description": "Restarts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Start", + "description": "Starts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/redeploy": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Redeploy", + "description": "Redeploys a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PerformMaintenance", + "description": "Performs maintenance on a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getRequestRateByInterval": { + "post": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_ExportRequestRateByInterval", + "x-ms-examples": { + "Export logs which contain all Api requests made to Compute Resource Provider within the given time period broken down by intervals.": { + "$ref": "./examples/LogAnalyticsRequestRateByInterval.json" + } + }, + "description": "Export logs that show Api requests made by this subscription in the given time window to show throttling activities.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RequestRateByIntervalInput" + }, + "description": "Parameters supplied to the LogAnalytics getRequestRateByInterval Api." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getThrottledRequests": { + "post": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_ExportThrottledRequests", + "x-ms-examples": { + "Export logs which contain all throttled Api requests made to Compute Resource Provider within the given time period.": { + "$ref": "./examples/LogAnalyticsThrottledRequests.json" + } + }, + "description": "Export logs that show total throttled Api requests for this subscription in the given time window.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThrottledRequestsInput" + }, + "description": "Parameters supplied to the LogAnalytics getThrottledRequests Api." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via":"azure-async-operation" + } + } + } + }, + "definitions": { + "ComputeOperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ComputeOperationValue" + }, + "description": "The list of compute operations" + } + }, + "description": "The List Compute Operation operation response." + }, + "ComputeOperationValue": { + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the compute operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the compute operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ComputeOperationValueDisplay" + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "ComputeOperationValueDisplay": { + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the compute operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Compute Operation Value Display." + }, + "InstanceViewStatus": { + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": false + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "AvailabilitySetProperties": { + "properties": { + "platformUpdateDomainCount": { + "type": "integer", + "format": "int32", + "description": "Update Domain count." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count." + }, + "virtualMachines": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "A list of references to all virtual machines in the availability set." + }, + "statuses": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a resource." + }, + "AvailabilitySet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the availability set" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "AvailabilitySetUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the availability set" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated." + }, + "AvailabilitySetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "The list of availability sets" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets." + } + }, + "required": [ + "value" + ], + "description": "The List Availability Set operation response." + }, + "VirtualMachineSize": { + "properties": { + "name": { + "type": "string", + "description": "The name of the virtual machine size." + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "The number of cores supported by the virtual machine size." + }, + "osDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The OS disk size, in MB, allowed by the virtual machine size." + }, + "resourceDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The resource disk size, in MB, allowed by the virtual machine size." + }, + "memoryInMB": { + "type": "integer", + "format": "int32", + "description": "The amount of memory, in MB, supported by the virtual machine size." + }, + "maxDataDiskCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of data disks that can be attached to the virtual machine size." + } + }, + "description": "Describes the properties of a VM size." + }, + "VirtualMachineSizeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "description": "The list of virtual machine sizes." + } + }, + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineExtensionImageProperties": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system this extension supports." + }, + "computeRole": { + "type": "string", + "description": "The type of role (IaaS or PaaS) this extension supports." + }, + "handlerSchema": { + "type": "string", + "description": "The schema defined by publisher, where extension consumers should provide settings in a matching schema." + }, + "vmScaleSetEnabled": { + "type": "boolean", + "description": "Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS." + }, + "supportsMultipleExtensions": { + "type": "boolean", + "description": "Whether the handler can support multiple extensions." + } + }, + "required": [ + "operatingSystem", + "computeRole", + "handlerSchema" + ], + "description": "Describes the properties of a Virtual Machine Extension Image." + }, + "VirtualMachineExtensionImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension Image." + }, + "VirtualMachineImageResource": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "location": { + "type": "string", + "description": "The supported Azure location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md)." + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Virtual machine image resource information." + }, + "VirtualMachineExtensionInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The virtual machine extension name." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "substatuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView", + "description": "The virtual machine extension instance view." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtensionUpdateProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtension": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineExtensionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineExtensionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The list of extensions" + } + }, + "description": "The List Extension operation response" + }, + "PurchasePlan": { + "properties": { + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + } + }, + "required": [ + "publisher", + "name", + "product" + ], + "description": "Used for establishing the purchase context of any 3rd Party artifact through MarketPlace." + }, + "OSDiskImage": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system of the osDiskImage.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + } + }, + "required": [ + "operatingSystem" + ], + "description": "Contains the os disk image information." + }, + "DataDiskImage": { + "properties": { + "lun": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "description": "Contains the data disk images information." + }, + "VirtualMachineImageProperties": { + "properties": { + "plan": { + "$ref": "#/definitions/PurchasePlan" + }, + "osDiskImage": { + "$ref": "#/definitions/OSDiskImage" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDiskImage" + } + } + }, + "description": "Describes the properties of a Virtual Machine Image." + }, + "VirtualMachineImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineImageResource" + } + ], + "description": "Describes a Virtual Machine Image." + }, + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "properties": { + "unit": { + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "description": "The current usage of the resource." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes Compute Resource Usage." + }, + "ListUsagesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of compute resource usages." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information." + } + }, + "required": [ + "value" + ], + "description": "The List Usages operation response." + }, + "VirtualMachineCaptureParameters": { + "properties": { + "vhdPrefix": { + "type": "string", + "description": "The captured virtual hard disk's name prefix." + }, + "destinationContainerName": { + "type": "string", + "description": "The destination container name." + }, + "overwriteVhds": { + "type": "boolean", + "description": "Specifies whether to overwrite the destination virtual hard disk, in case of conflict." + } + }, + "required": [ + "vhdPrefix", + "destinationContainerName", + "overwriteVhds" + ], + "description": "Capture Virtual Machine parameters." + }, + "VirtualMachineCaptureResult": { + "properties": { + "$schema": { + "readOnly": true, + "type": "string", + "description": "the schema of the captured virtual machine" + }, + "contentVersion": { + "readOnly": true, + "type": "string", + "description": "the version of the content" + }, + "parameters": { + "readOnly": true, + "type": "object", + "description": "parameters of the captured virtual machine" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "type": "object", + "description": "resource item" + }, + "description": "a list of resource items of the captured virtual machine" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Output of virtual machine capture operation." + }, + "Plan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "HardwareProfile": { + "properties": { + "vmSize": { + "type": "string", + "description": "Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

    [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

    [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes)", + "enum": [ + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_B1s", + "Standard_B1ms", + "Standard_B2s", + "Standard_B2ms", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_DS13-4_v2", + "Standard_DS13-2_v2", + "Standard_DS14-8_v2", + "Standard_DS14-4_v2", + "Standard_E2_v3", + "Standard_E4_v3", + "Standard_E8_v3", + "Standard_E16_v3", + "Standard_E32_v3", + "Standard_E64_v3", + "Standard_E2s_v3", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_E32-16_v3", + "Standard_E32-8s_v3", + "Standard_E64-32s_v3", + "Standard_E64-16s_v3", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_GS4-8", + "Standard_GS4-4", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_M64-32ms", + "Standard_M64-16ms", + "Standard_M128-64ms", + "Standard_M128-32ms", + "Standard_NC6", + "Standard_NC12", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC6s_v2", + "Standard_NC12s_v2", + "Standard_NC24s_v2", + "Standard_NC24rs_v2", + "Standard_NC6s_v3", + "Standard_NC12s_v3", + "Standard_NC24s_v3", + "Standard_NC24rs_v3", + "Standard_ND6s", + "Standard_ND12s", + "Standard_ND24s", + "Standard_ND24rs", + "Standard_NV6", + "Standard_NV12", + "Standard_NV24" + ], + "x-ms-enum": { + "name": "VirtualMachineSizeTypes", + "modelAsString": true + } + } + }, + "description": "Specifies the hardware settings for the virtual machine." + }, + "ImageReference": { + "properties": { + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "KeyVaultSecretReference": { + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the secret." + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "KeyVaultKeyReference": { + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the key." + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Key" + }, + "DiskEncryptionSettings": { + "properties": { + "diskEncryptionKey": { + "$ref": "#/definitions/KeyVaultSecretReference", + "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyVaultKeyReference", + "description": "Specifies the location of the key encryption key in Key Vault." + }, + "enabled": { + "type": "boolean", + "description": "Specifies whether disk encryption should be enabled on the virtual machine." + } + }, + "description": "Describes a Encryption Settings for a Disk" + }, + "VirtualHardDisk": { + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + }, + "description": "Describes the uri of a disk." + }, + "Caching": { + "type": "string", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "CreateOption": { + "type": "string", + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.", + "enum": [ + "FromImage", + "Empty", + "Attach" + ], + "x-ms-enum": { + "name": "DiskCreateOptionTypes", + "modelAsString": true + } + }, + "StorageAccountType": { + "type": "string", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountTypes", + "modelAsString": true + } + }, + "ManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "The parameters of a managed disk." + }, + "OSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "encryptionSettings": { + "$ref": "#/definitions/DiskEncryptionSettings", + "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + } + }, + "required": [ + "createOption" + ], + "description": "Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "DataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a data disk." + }, + "StorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/OSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Specifies the storage settings for the virtual machine disks." + }, + "AdditionalUnattendContent": { + "properties": { + "passName": { + "type": "string", + "description": "The pass name. Currently, the only allowable value is OobeSystem.", + "enum": [ + "OobeSystem" + ], + "x-ms-enum": { + "name": "PassNames", + "modelAsString": false + } + }, + "componentName": { + "type": "string", + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ], + "x-ms-enum": { + "name": "ComponentNames", + "modelAsString": false + } + }, + "settingName": { + "type": "string", + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ], + "x-ms-enum": { + "name": "SettingNames", + "modelAsString": false + } + }, + "content": { + "type": "string", + "description": "Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted." + } + }, + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + }, + "WinRMListener": { + "properties": { + "protocol": { + "type": "string", + "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProtocolTypes", + "modelAsString": false + } + }, + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

    {
    \"data\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + } + }, + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" + }, + "WinRMConfiguration": { + "properties": { + "listeners": { + "type": "array", + "items": { + "$ref": "#/definitions/WinRMListener" + }, + "description": "The list of Windows Remote Management listeners" + } + }, + "description": "Describes Windows Remote Management configuration of the VM" + }, + "WindowsConfiguration": { + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine.

    When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later." + }, + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Indicates whether virtual machine is enabled for automatic updates." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" + }, + "additionalUnattendContent": { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + }, + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." + }, + "winRM": { + "$ref": "#/definitions/WinRMConfiguration", + "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." + } + }, + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "SshPublicKey": { + "properties": { + "path": { + "type": "string", + "description": "Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys" + }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

    For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + } + }, + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + }, + "SshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with linux based VMs." + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "LinuxConfiguration": { + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine.

    When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later." + } + }, + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "VaultCertificate": { + "properties": { + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

    {
    \"data\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" + }, + "certificateStore": { + "type": "string", + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

    For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "properties": { + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Describes a set of certificates which are all in the same Key Vault." + }, + "OSProfile": { + "properties": { + "computerName": { + "type": "string", + "description": "Specifies the host OS name of the virtual machine.

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

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

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

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

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

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

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

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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

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

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

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

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

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

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

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "Specifies set of certificates that should be installed onto the virtual machine." + }, + "allowExtensionOperations": { + "type": "boolean", + "description": "Specifies whether extension operations should be allowed on the virtual machine.

    This may only be set to False when no extensions are present on the virtual machine." + } + }, + "description": "Specifies the operating system settings for the virtual machine." + }, + "NetworkInterfaceReferenceProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "description": "Describes a network interface reference properties." + }, + "NetworkInterfaceReference": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceReferenceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a network interface reference." + }, + "NetworkProfile": { + "properties": { + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceReference" + }, + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." + } + }, + "description": "Specifies the network interfaces of the virtual machine." + }, + "BootDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "DiagnosticsProfile": { + "properties": { + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnostics", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." + } + }, + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "VirtualMachineExtensionHandlerInstanceView": { + "properties": { + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "status": { + "$ref": "#/definitions/InstanceViewStatus", + "description": "The extension handler status." + } + }, + "description": "The instance view of a virtual machine extension handler." + }, + "VirtualMachineAgentInstanceView": { + "properties": { + "vmAgentVersion": { + "type": "string", + "description": "The VM Agent full version." + }, + "extensionHandlers": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionHandlerInstanceView" + }, + "description": "The virtual machine extension handler instance view." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of the VM Agent running on the virtual machine." + }, + "DiskInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "encryptionSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskEncryptionSettings" + }, + "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of the disk." + }, + "BootDiagnosticsInstanceView": { + "properties": { + "consoleScreenshotBlobUri": { + "type": "string", + "description": "The console screenshot blob URI." + }, + "serialConsoleLogBlobUri": { + "type": "string", + "description": "The Linux serial console log blob Uri." + } + }, + "description": "The instance view of a virtual machine boot diagnostics." + }, + "VirtualMachineIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the virtual machine." + }, + "MaintenanceRedeployStatus": { + "properties": { + "isCustomerInitiatedMaintenanceAllowed": { + "type": "boolean", + "description": "True, if customer is allowed to perform Maintenance." + }, + "preMaintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Pre Maintenance Window." + }, + "preMaintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Pre Maintenance Window." + }, + "maintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Maintenance Window." + }, + "maintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Maintenance Window." + }, + "lastOperationResultCode": { + "type": "string", + "description": "The Last Maintenance Operation Result Code.", + "enum": [ + "None", + "RetryLater", + "MaintenanceAborted", + "MaintenanceCompleted" + ], + "x-ms-enum": { + "name": "MaintenanceOperationResultCodeTypes", + "modelAsString": false + } + }, + "lastOperationMessage": { + "type": "string", + "description": "Message returned for the last Maintenance Operation." + } + }, + "description": "Maintenance Operation Status." + }, + "VirtualMachineInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the update domain of the virtual machine." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the fault domain of the virtual machine." + }, + "computerName": { + "type": "string", + "description": "The computer name assigned to the virtual machine." + }, + "osName": { + "type": "string", + "description": "The Operating System running on the virtual machine." + }, + "osVersion": { + "type": "string", + "description": "The version of Operating System running on the virtual machine." + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskInstanceView" + }, + "description": "The virtual machine disk information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "description": "The extensions information." + }, + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine." + }, + "VirtualMachineProperties": { + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the virtual machine." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands." + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachine": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine." + }, + "VirtualMachineUpdate": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Update." + }, + "VirtualMachineListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "The list of virtual machines." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" + }, + "capacity": { + "type": "integer", + "format": "int64", + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes a virtual machine scale set sku." + }, + "AutoOSUpgradePolicy": { + "properties": { + "disableAutoRollback": { + "type": "boolean", + "description": "Whether OS image rollback feature should be disabled. Default value is false." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "UpgradePolicy": { + "properties": { + "mode": { + "type": "string", + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

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

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time.", + "enum": [ + "Automatic", + "Manual", + "Rolling" + ], + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": false + } + }, + "rollingUpgradePolicy": { + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "automaticOSUpgrade": { + "type": "boolean", + "description": "Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available." + }, + "autoOSUpgradePolicy": { + "$ref": "#/definitions/AutoOSUpgradePolicy", + "description": "Configuration parameters used for performing automatic OS Upgrade." + } + }, + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "RollingUpgradePolicy": { + "properties": { + "maxBatchInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%." + }, + "maxUnhealthyInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%." + }, + "maxUnhealthyUpgradedInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%." + }, + "pauseTimeBetweenBatches": { + "type": "string", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)." + } + }, + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "ImageOSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "The OS State.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false + } + }, + "snapshot": { + "$ref": "#/definitions/SubResource", + "description": "The snapshot." + }, + "managedDisk": { + "$ref": "#/definitions/SubResource", + "description": "The managedDisk." + }, + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "type": "string", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + } + }, + "required": [ + "osType", + "osState" + ], + "description": "Describes an Operating System disk." + }, + "ImageDataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "snapshot": { + "$ref": "#/definitions/SubResource", + "description": "The snapshot." + }, + "managedDisk": { + "$ref": "#/definitions/SubResource", + "description": "The managedDisk." + }, + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "type": "string", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + } + }, + "required": [ + "lun" + ], + "description": "Describes a data disk." + }, + "ImageStorageProfile": { + "properties": { + "osDisk": { + "$ref": "#/definitions/ImageOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + }, + "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "zoneResilient": { + "type": "boolean", + "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)." + } + }, + "description": "Describes a storage profile." + }, + "ImageProperties": { + "properties": { + "sourceVirtualMachine": { + "$ref": "#/definitions/SubResource", + "description": "The source virtual machine from which Image is created." + }, + "storageProfile": { + "$ref": "#/definitions/ImageStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state." + } + }, + "description": "Describes the properties of an Image." + }, + "Image": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "ImageUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "The source user image virtual hard disk. Only tags may be updated." + }, + "ImageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "description": "The list of Images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images." + } + }, + "required": [ + "value" + ], + "description": "The List Image operation response." + }, + "VirtualMachineScaleSetIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the virtual machine scale set." + }, + "VirtualMachineScaleSetOSProfile": { + "properties": { + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

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

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

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

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

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

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

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

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

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

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

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

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

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetUpdateOSProfile": { + "properties": { + "customData": { + "type": "string", + "description": "A base-64 encoded string of custom data." + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "The Windows Configuration of the OS profile." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "The Linux Configuration of the OS profile." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "The List of certificates for addition to the VM." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS." + } + }, + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "VirtualMachineScaleSetOSDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "Specifies information about the unmanaged user image to base the scale set on." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the container urls that are used to store operating system disks for the scale set." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "required": [ + "createOption" + ], + "description": "Describes a virtual machine scale set operating system disk." + }, + "VirtualMachineScaleSetUpdateOSDisk": { + "properties": { + "caching": { + "$ref": "#/definitions/Caching", + "description": "The caching type." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of virtual hard disk container uris." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "description": "Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk." + }, + "VirtualMachineScaleSetDataDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "The create option." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a virtual machine scale set data disk." + }, + "VirtualMachineScaleSetStorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "VirtualMachineScaleSetUpdateStorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "The image reference." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSDisk", + "description": "The OS disk." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "description": "The data disks." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "ApiEntityReference": { + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "Specifies the identifier of the subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same 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": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetUpdateIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "The subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary IP Configuration in case the network interface has more than one IP Configuration." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The application gateway backend address pools." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The load balancer backend address pools." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The load balancer inbound nat pools." + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" + } + }, + "required": [ + "name" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfigurationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + }, + "description": "Specifies the IP configurations of the network interface." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Whether this is a primary NIC on a virtual machine." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfiguration" + }, + "description": "The virtual machine scale set IP Configuration." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + } + }, + "description": "Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration." + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" + } + }, + "required": [ + "name" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetUpdateNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfigurationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses" + } + }, + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created" + } + }, + "required": [ + "domainNameLabel" + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetIpTag": { + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + }, + "description": "Contains the IP tag associated with the public IP address." + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties" + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIpTag" + }, + "description": "The list of IP tags associated with the public IP address." + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetNetworkProfile": { + "properties": { + "healthProbe": { + "$ref": "#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetUpdateNetworkProfile": { + "properties": { + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtension": { + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The list of VM scale set extensions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions." + } + }, + "required": [ + "value" + ], + "description": "The List VM scale set extension operation response." + }, + "VirtualMachineScaleSetExtensionProfile": { + "properties": { + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The virtual machine scale set child extension resources." + } + }, + "description": "Describes a virtual machine scale set extension profile." + }, + "VirtualMachineScaleSetVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", + "description": "Specifies the operating system settings for the virtual machines in the scale set." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", + "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "priority": { + "type": "string", + "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview", + "enum": [ + "Regular", + "Low" + ], + "x-ms-enum": { + "name": "VirtualMachinePriorityTypes", + "modelAsString": true + } + }, + "evictionPolicy": { + "type": "string", + "description": "Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview", + "enum": [ + "Deallocate", + "Delete" + ], + "x-ms-enum": { + "name": "VirtualMachineEvictionPolicyTypes", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetUpdateVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSProfile", + "description": "The virtual machine scale set OS profile." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateStorageProfile", + "description": "The virtual machine scale set storage profile." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkProfile", + "description": "The virtual machine scale set network profile." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "The virtual machine scale set diagnostics profile." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "The virtual machine scale set extension profile." + }, + "licenseType": { + "type": "string", + "description": "The license type, which is for bring your own license scenario." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile", + "description": "The virtual machine profile." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "uniqueId": { + "readOnly": true, + "type": "string", + "description": "Specifies the ID which uniquely identifies a Virtual Machine Scale Set." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + }, + "zoneBalance": { + "type": "boolean", + "description": "Whether to force stictly even Virtual Machine distribution cross x-zones in case there is zone outage." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count for each placement group." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetUpdateProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateVMProfile", + "description": "The virtual machine profile." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSet": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetUpdate": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "The purchase plan when deploying a virtual machine scale set from VM Marketplace images." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetVMInstanceIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineScaleSetVMInstanceRequiredIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids." + } + }, + "required": [ + "instanceIds" + ], + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineStatusCodeCount": { + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The instance view status code." + }, + "count": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances having a particular status code." + } + }, + "description": "The status code and count of the virtual machine scale set instance view status summary." + }, + "VirtualMachineScaleSetInstanceViewStatusesSummary": { + "properties": { + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "description": "The extensions information." + } + }, + "description": "Instance view statuses summary for virtual machines of a virtual machine scale set." + }, + "VirtualMachineScaleSetVMExtensionsSummary": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The extension name." + }, + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "description": "The extensions information." + } + }, + "description": "Extensions summary for virtual machines of a virtual machine scale set." + }, + "VirtualMachineScaleSetInstanceView": { + "properties": { + "virtualMachine": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceViewStatusesSummary", + "readOnly": true, + "description": "The instance view status summary for the virtual machine scale set." + }, + "extensions": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsSummary" + }, + "description": "The extensions information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine scale set." + }, + "VirtualMachineScaleSetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetListWithLinkResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetSkuCapacity": { + "properties": { + "minimum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The minimum capacity." + }, + "maximum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum capacity that can be set." + }, + "defaultCapacity": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The default capacity." + }, + "scaleType": { + "readOnly": true, + "type": "string", + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "None" + ], + "x-ms-enum": { + "name": "VirtualMachineScaleSetSkuScaleType", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a sku." + }, + "VirtualMachineScaleSetSku": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the sku applies to." + }, + "sku": { + "$ref": "#/definitions/Sku", + "readOnly": true, + "description": "The Sku." + }, + "capacity": { + "$ref": "#/definitions/VirtualMachineScaleSetSkuCapacity", + "readOnly": true, + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes an available virtual machine scale set sku." + }, + "VirtualMachineScaleSetListSkusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetSku" + }, + "description": "The list of skus available for the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus." + } + }, + "required": [ + "value" + ], + "description": "The Virtual Machine Scale Set List Skus operation response." + }, + "RollbackStatusInfo": { + "properties":{ + "successfullyRolledbackInstanceCount" : { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which have been successfully rolled back." + }, + "failedRolledbackInstanceCount" : { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which failed to rollback." + }, + "rollbackError" : { + "$ref": "#/definitions/ApiError", + "readOnly": true, + "description": "Error details if OS rollback failed." + } + }, + "description": "Information about rollback on failed VM instances after a OS Upgrade operation." + }, + "UpgradeOperationHistoryStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "UpgradeState", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "End time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "UpgradeOperationHistoricalStatusInfoProperties": { + "properties": { + "runningStatus": { + "$ref": "#/definitions/UpgradeOperationHistoryStatus", + "readOnly": true, + "description": "Information about the overall status of the upgrade operation." + }, + "progress": { + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "readOnly": true, + "description": "Counts of the VM's in each state." + }, + "error": { + "$ref": "#/definitions/ApiError", + "readOnly": true, + "description": "Error Details for this upgrade if there are any." + }, + "startedBy": { + "readOnly": true, + "type": "string", + "description": "Invoker of the Upgrade Operation", + "enum": [ + "Unknown", + "User", + "Platform" + ], + "x-ms-enum": { + "name": "UpgradeOperationInvoker", + "modelAsString": false + } + }, + "targetImageReference": { + "$ref": "#/definitions/ImageReference", + "readOnly": true, + "description": "Image Reference details" + }, + "rollbackInfo": { + "$ref": "#/definitions/RollbackStatusInfo", + "readOnly": true, + "description": "Information about OS rollback if performed" + } + }, + "description": "Describes each OS upgrade on the Virtual Machine Scale Set." + }, + "UpgradeOperationHistoricalStatusInfo": { + "properties": { + "properties": { + "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfoProperties", + "readOnly": true, + "description": "Information about the properties of the upgrade operation." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Resource location" + } + }, + "description": "Virtual Machine Scale Set OS Upgrade History operation response." + }, + "VirtualMachineScaleSetListOSUpgradeHistory": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfo" + }, + "description": "The list of OS upgrades performed on the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades." + } + }, + "required": [ + "value" + ], + "description": "List of Virtual Machine Scale Set OS Upgrade History operation response." + }, + "VirtualMachineScaleSetVMProperties": { + "properties": { + "latestModelApplied": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the latest model has been applied to the virtual machine." + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Azure VM unique ID." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the virtual machine." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + } + }, + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVM": { + "properties": { + "instanceId": { + "readOnly": true, + "type": "string", + "description": "The virtual machine instance ID." + }, + "sku": { + "$ref": "#/definitions/Sku", + "readOnly": true, + "description": "The virtual machine SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVMInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "The Update Domain count." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "The Fault Domain count." + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskInstanceView" + }, + "description": "The disks information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "description": "The extensions information." + }, + "vmHealth": { + "readOnly": true, + "$ref": "#/definitions/VirtualMachineHealthStatus", + "description": "The health status for the VM." + }, + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "placementGroupId": { + "type": "string", + "description": "The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId." + } + }, + "description": "The instance view of a virtual machine scale set VM." + }, + "VirtualMachineHealthStatus": { + "properties": { + "status": { + "readOnly": true, + "$ref": "#/definitions/InstanceViewStatus", + "description": "The health status information for the VM." + } + }, + "description": "The health status of the VM." + }, + "VirtualMachineScaleSetVMListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "The list of virtual machine scale sets VMs." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs" + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine Scale Set VMs operation response." + }, + "RollingUpgradeStatusInfo": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RollingUpgradeStatusInfoProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeStatusInfoProperties": { + "properties": { + "policy": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The rolling upgrade policies applied for this upgrade." + }, + "runningStatus": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeRunningStatus", + "description": "Information about the current running state of the overall upgrade." + }, + "progress": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "error": { + "readOnly": true, + "$ref": "#/definitions/ApiError", + "description": "Error details for this upgrade, if there are any." + } + }, + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeRunningStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "RollingUpgradeStatusCode", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "lastAction": { + "type": "string", + "readOnly": true, + "description": "The last action performed on the rolling upgrade.", + "enum": [ + "Start", + "Cancel" + ], + "x-ms-enum": { + "name": "RollingUpgradeActionType", + "modelAsString": false + } + }, + "lastActionTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Last action time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "RollingUpgradeProgressInfo": { + "properties": { + "successfulInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have been successfully upgraded." + }, + "failedInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have failed to be upgraded successfully." + }, + "inProgressInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that are currently being upgraded." + }, + "pendingInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have not yet begun to be upgraded." + } + }, + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "ApiErrorBase": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error base." + }, + "InnerError": { + "properties": { + "exceptiontype": { + "type": "string", + "description": "The exception type." + }, + "errordetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + }, + "description": "Inner error details." + }, + "ApiError": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "description": "The Api error details" + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The Api inner error" + }, + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error." + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "UpdateResource": { + "description": "The Update Resource model definition.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "SubResourceReadOnly": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "RecoveryWalkResponse": { + "properties": { + "walkPerformed": { + "type": "boolean", + "readOnly": true, + "description": "Whether the recovery walk was performed" + }, + "nextPlatformUpdateDomain": { + "type": "integer", + "readOnly": true, + "description": "The next update domain that needs to be walked. Null means walk spanning all update domains has been completed" + } + }, + "description": "Response after calling a manual recovery walk" + }, + "RequestRateByIntervalInput": { + "properties": { + "intervalLength": { + "type": "string", + "description": "Interval value in minutes used to create LogAnalytics call rate logs.", + "enum": [ + "ThreeMins", + "FiveMins", + "ThirtyMins", + "SixtyMins" + ], + "x-ms-enum": { + "name": "IntervalInMins", + "modelAsString": false + } + } + }, + "required": [ + "intervalLength" + ], + "allOf": [ + { + "$ref": "#/definitions/LogAnalyticsInputBase" + } + ], + "description": "Api request input for LogAnalytics getRequestRateByInterval Api." + }, + "ThrottledRequestsInput": { + "allOf": [ + { + "$ref": "#/definitions/LogAnalyticsInputBase" + } + ], + "description": "Api request input for LogAnalytics getThrottledRequests Api." + }, + "LogAnalyticsInputBase": { + "properties": { + "blobContainerSasUri": { + "type": "string", + "description": "SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to." + }, + "fromTime": { + "type": "string", + "format": "date-time", + "description": "From time of the query" + }, + "toTime": { + "type": "string", + "format": "date-time", + "description": "To time of the query" + }, + "groupByThrottlePolicy": { + "type": "boolean", + "description": "Group query result by Throttle Policy applied." + }, + "groupByOperationName": { + "type": "boolean", + "description": "Group query result by by Operation Name." + }, + "groupByResourceName": { + "type": "boolean", + "description": "Group query result by Resource Name." + } + }, + "required": [ + "blobContainerSasUri", + "fromTime", + "toTime" + ], + "description": "Api input base class for LogAnalytics Api." + }, + "LogAnalyticsOperationResult": { + "properties": { + "properties": { + "readOnly": true, + "$ref": "#/definitions/LogAnalyticsOutput", + "description": "LogAnalyticsOutput" + } + }, + "description": "LogAnalytics operation status response" + }, + "LogAnalyticsOutput": { + "properties": { + "output": { + "readOnly": true, + "type": "string", + "description": "Output file Uri path to blob container." + } + }, + "description": "LogAnalytics output properties" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json new file mode 100644 index 000000000000..ba923f4f6905 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json @@ -0,0 +1,202 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "caching": "ReadWrite", + "image": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d6e9ab29-f8c9-4792-978c-ae2c07b98f17", + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d6e9ab29-f8c9-4792-978c-ae2c07b98f17", + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json new file mode 100644 index 000000000000..7fc99c5727ae --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd" + }, + "osType": "Windows", + "createOption": "FromImage", + "caching": "ReadWrite", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + } + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + } + }, + "dataDisks": [] + }, + "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + } + }, + "dataDisks": [] + }, + "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateALinuxVmWithoutExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateALinuxVmWithoutExtensions.json new file mode 100644 index 000000000000..78975e0ecf11 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateALinuxVmWithoutExtensions.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2018-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "{image_sku}", + "publisher": "{image_publisher}", + "version": "latest", + "offer": "{image_offer}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + }, + "allowExtensionOperations": false + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true, + "provisionVMAgent": true + }, + "allowExtensionOperations": false + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true, + "provisionVMAgent": true + }, + "allowExtensionOperations": false + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateALinuxVmWithoutGuestAgent.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateALinuxVmWithoutGuestAgent.json new file mode 100644 index 000000000000..a866edaa2342 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateALinuxVmWithoutGuestAgent.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2018-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "{image_sku}", + "publisher": "{image_publisher}", + "version": "latest", + "offer": "{image_offer}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true, + "provisionVMAgent": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true, + "provisionVMAgent": false + }, + "allowExtensionOperations": false + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true, + "provisionVMAgent": false + }, + "allowExtensionOperations": false + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json new file mode 100644 index 000000000000..477271ee7f97 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "osDisk", + "vhdContainers": [ + "http://{existing-storage-account-name-0}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-1}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-2}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-3}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-4}.blob.core.windows.net/vhdContainer" + ] + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhdContainers": [ + "http://{existing-storage-account-name}.blob.core.windows.net/vhds" + ], + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhdContainers": [ + "http://{existing-storage-account-name}.blob.core.windows.net/vhds" + ], + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json new file mode 100644 index 000000000000..becc019a8fef --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json @@ -0,0 +1,214 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0, + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk0.vhd" + } + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1, + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk1.vhd" + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "name": "dataDisk0", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" + }, + "lun": 0 + }, + { + "name": "dataDisk1", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" + }, + "lun": 1 + } + ] + }, + "vmId": "5230a749-2f68-4830-900b-702182d32e63", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "name": "dataDisk0", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" + }, + "lun": 0 + }, + { + "name": "dataDisk1", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" + }, + "lun": 1 + } + ] + }, + "vmId": "5230a749-2f68-4830-900b-702182d32e63", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetFromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetFromACustomImage.json new file mode 100644 index 000000000000..c7e1dc2f167c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetFromACustomImage.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json new file mode 100644 index 000000000000..36e6b8084b15 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json new file mode 100644 index 000000000000..24c4d8c35c85 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/{existing-application-gateway-name}/backendAddressPools/{existing-backend-address-pool-name}" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json new file mode 100644 index 000000000000..0faeb3c42731 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json @@ -0,0 +1,245 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/inboundNatPools/{existing-nat-pool-name}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/backendAddressPools/{existing-backend-address-pool-name}" + } + ] + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithBootDiagnostics.json new file mode 100644 index 000000000000..4a31d9425386 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithBootDiagnostics.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json new file mode 100644 index 000000000000..3c1c117c59a3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithPasswordAuthentication.json new file mode 100644 index 000000000000..78a2a34ac36c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithPasswordAuthentication.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithPremiumStorage.json new file mode 100644 index 000000000000..50626139780c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithPremiumStorage.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithSshAuthentication.json new file mode 100644 index 000000000000..fcdf824e6e7b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAScaleSetWithSshAuthentication.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmFromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmFromACustomImage.json new file mode 100644 index 000000000000..0aec04501d1e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmFromACustomImage.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmInAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmInAnAvailabilitySet.json new file mode 100644 index 000000000000..fd66711a71c1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmInAnAvailabilitySet.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/{existing-availability-set-name}" + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithAMarketplaceImagePlan.json new file mode 100644 index 000000000000..41bf7f06d16e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithAMarketplaceImagePlan.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "name": "myVM", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithBootDiagnostics.json new file mode 100644 index 000000000000..c7dec4a7325e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithBootDiagnostics.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithEmptyDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithEmptyDataDisks.json new file mode 100644 index 000000000000..3e82199880af --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithEmptyDataDisks.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithPasswordAuthentication.json new file mode 100644 index 000000000000..a1bae28f04ed --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithPasswordAuthentication.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithPremiumStorage.json new file mode 100644 index 000000000000..38bca9ecbe98 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithPremiumStorage.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithSshAuthentication.json new file mode 100644 index 000000000000..6a9b0daee851 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAVmWithSshAuthentication.json @@ -0,0 +1,178 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "{image_sku}", + "publisher": "{image_publisher}", + "version": "latest", + "offer": "{image_offer}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAWindowsVmWithoutExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAWindowsVmWithoutExtensions.json new file mode 100644 index 000000000000..61e83f4ab16d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAWindowsVmWithoutExtensions.json @@ -0,0 +1,157 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2018-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "allowExtensionOperations": false + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "allowExtensionOperations": false + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "allowExtensionOperations": false + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAWindowsVmWithoutGuestAgent.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAWindowsVmWithoutGuestAgent.json new file mode 100644 index 000000000000..e198d8f7eb8e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAWindowsVmWithoutGuestAgent.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2018-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "windowsConfiguration": { + "provisionVMAgent": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": false, + "enableAutomaticUpdates": true + }, + "allowExtensionOperations": false + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": false, + "enableAutomaticUpdates": true + }, + "allowExtensionOperations": false + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnAvailabilitySet.json new file mode 100644 index 000000000000..b2faf50cbe2a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnAvailabilitySet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "availabilitySetName": "myAvailabilitySet", + "parameters": { + "location": "westus", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20 + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Classic" + }, + "name": "myAvailabilitySet", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20 + }, + "location": "westus", + "type": "Microsoft.Compute/availabilitySets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageFromABlob.json new file mode 100644 index 000000000000..b902b5829677 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageFromABlob.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageFromAManagedDisk.json new file mode 100644 index 000000000000..cb23cf2ac04a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageFromAManagedDisk.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageFromASnapshot.json new file mode 100644 index 000000000000..0cc87e86a313 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageFromASnapshot.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageFromAVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageFromAVM.json new file mode 100644 index 000000000000..84f9c61f0a6d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageFromAVM.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" + }, + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" + }, + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json new file mode 100644 index 000000000000..0fa483b5babe --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json new file mode 100644 index 000000000000..cccf0d0dc666 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json new file mode 100644 index 000000000000..bb0bfa07316b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateOrUpdateASimpleGallery.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateOrUpdateASimpleGallery.json new file mode 100644 index 000000000000..7198d052844e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateOrUpdateASimpleGallery.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-06-01", + "galleryName": "myGalleryName", + "gallery": { + "location": "West US", + "properties": { + "description": "This is the gallery description." + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "201": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "202": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateOrUpdateASimpleGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateOrUpdateASimpleGalleryImage.json new file mode 100644 index 000000000000..9c33b999dcef --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateOrUpdateASimpleGalleryImage.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-06-01", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImage": { + "location": "West US", + "properties": { + "osType": "Windows", + "osState": "Generalized", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + }, + "201": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + }, + "202": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateOrUpdateASimpleGalleryImageVersion.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateOrUpdateASimpleGalleryImageVersion.json new file mode 100644 index 000000000000..9988f4935959 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/CreateOrUpdateASimpleGalleryImageVersion.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-06-01", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "regions": ["West US", "East US"], + "source": { + "managedImage": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "regions": ["West US", "East US"], + "source": { + "managedImage": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + }, + "scaleTier": "S30", + "publishedDate": "2018-01-01T00:00:00Z" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "properties": { + "publishingProfile": { + "regions": ["West US", "East US"], + "source": { + "managedImage": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + }, + "scaleTier": "S30", + "publishedDate": "2018-01-01T00:00:00Z" + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "properties": { + "publishingProfile": { + "regions": ["West US", "East US"], + "source": { + "managedImage": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + }, + "scaleTier": "S30", + "publishedDate": "2018-01-01T00:00:00Z" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/DeleteAGallery.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/DeleteAGallery.json new file mode 100644 index 000000000000..9233c51b0fd7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/DeleteAGallery.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-06-01", + "galleryName": "myGalleryName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/DeleteAGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/DeleteAGalleryImage.json new file mode 100644 index 000000000000..f9ee37fdc479 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/DeleteAGalleryImage.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-06-01", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/DeleteAGalleryImageVersion.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/DeleteAGalleryImageVersion.json new file mode 100644 index 000000000000..832d7480e7fc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/DeleteAGalleryImageVersion.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-06-01", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetAGallery.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetAGallery.json new file mode 100644 index 000000000000..feb11900e5ef --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetAGallery.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-06-01", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetAGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetAGalleryImage.json new file mode 100644 index 000000000000..1e7ea418e867 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetAGalleryImage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-06-01", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryImageName" + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetAGalleryImageVersion.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetAGalleryImageVersion.json new file mode 100644 index 000000000000..0fc671a0152d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetAGalleryImageVersion.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-06-01", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "regions": ["West US", "East US"], + "source": { + "managedImage": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "regions": ["West US", "East US"], + "source": { + "managedImage": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + }, + "scaleTier": "S30", + "publishedDate": "2018-01-01T00:00:00Z" + }, + "storageProfile": { + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetAGalleryImageVersionWithReplicationStatus.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetAGalleryImageVersionWithReplicationStatus.json new file mode 100644 index 000000000000..672759b68213 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetAGalleryImageVersionWithReplicationStatus.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-06-01", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "regions": ["West US", "East US"], + "source": { + "managedImage": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + } + } + } + }, + "$expand": "ReplicationStatus" + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "regions": ["West US", "East US"], + "source": { + "managedImage": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + }, + "scaleTier": "S30", + "publishedDate": "2018-01-01T00:00:00Z" + }, + "storageProfile": { + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "replicationStatus": { + "aggregatedState": "Completed", + "summary": [ + { + "region": "West US", + "state": "Completed", + "details": "", + "progress": 100 + }, + { + "region": "East US", + "state": "Completed", + "details": "", + "progress": 100 + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetInformationAboutAnImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetInformationAboutAnImage.json new file mode 100644 index 000000000000..7666a0857c0b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/GetInformationAboutAnImage.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListGalleriesInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListGalleriesInAResourceGroup.json new file mode 100644 index 000000000000..2b59e50f1759 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListGalleriesInAResourceGroup.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryName", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName" + } + ], + "nextLink":"http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName" + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListGalleriesInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListGalleriesInASubscription.json new file mode 100644 index 000000000000..1f6b5b43eeb3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListGalleriesInASubscription.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryName", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName" + } + ], + "nextLink":"http://svchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName" + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListGalleryImageVersionsInAGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListGalleryImageVersionsInAGalleryImage.json new file mode 100644 index 000000000000..918cdf6b69db --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListGalleryImageVersionsInAGalleryImage.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-06-01", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "publishingProfile": { + "regions": ["West US", "East US"], + "source": { + "managedImage": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + }, + "scaleTier": "S30", + "publishedDate": "2018-01-01T00:00:00Z" + }, + "storageProfile": { + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + ], + "nextLink":"http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images/myGalleryImageName/versions?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/images/myGalleryImageName/versions/myGalleryImageVersionName" + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListGalleryImagesInAGallery.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListGalleryImagesInAGallery.json new file mode 100644 index 000000000000..785d36e1692c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListGalleryImagesInAGallery.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-06-01", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryImageName" + } + ], + "nextLink":"http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/images/myGalleryImageName" + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListImagesInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListImagesInAResourceGroup.json new file mode 100644 index 000000000000..4ccef25126de --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListImagesInAResourceGroup.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListImagesInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListImagesInASubscription.json new file mode 100644 index 000000000000..2ac83072ed92 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListImagesInASubscription.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2017-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/LogAnalyticsRequestRateByInterval.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/LogAnalyticsRequestRateByInterval.json new file mode 100644 index 000000000000..3b994abb5dd1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/LogAnalyticsRequestRateByInterval.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "westus", + "api-version": "2017-12-01", + "parameters": { + "intervalLength": "FiveMins", + "blobContainerSasUri": "https://somesasuri", + "fromTime": "2018-01-21T01:54:06.862601Z", + "toTime": "2018-01-23T01:54:06.862601Z", + "groupByResourceName": true + } + }, + "responses": { + "200": { + "body": { + "startTime": "2018-01-30T17:54:14.8806951-08:00", + "endTime": "2018-01-30T17:54:17.5832413-08:00", + "status": "Succeeded", + "properties": { + "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/RequestRateByInterval_20180121-0154_20180123-0154.csv" + }, + "name": "8eb1169a-5cf9-46b1-aadf-41e4f60692df" + } + }, + "202": { + "body": "" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/LogAnalyticsThrottledRequests.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/LogAnalyticsThrottledRequests.json new file mode 100644 index 000000000000..0379b5a9dc6d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/LogAnalyticsThrottledRequests.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "westus", + "api-version": "2017-12-01", + "parameters": { + "blobContainerSasUri": "https://somesasuri", + "fromTime": "2018-01-21T01:54:06.862601Z", + "toTime": "2018-01-23T01:54:06.862601Z", + "groupByOperationName": true, + "groupByResourceName": false + } + }, + "responses": { + "200": { + "body": { + "startTime": "2018-01-30T17:54:14.8806951-08:00", + "endTime": "2018-01-30T17:54:17.5832413-08:00", + "status": "Succeeded", + "properties": { + "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/ThrottledRequests_20180121-0154_20180123-0154.csv" + }, + "name": "8eb1169a-5cf9-46b1-aadf-41e4f60692df" + } + }, + "202": { + "body": "" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommand.json new file mode 100644 index 000000000000..f2d8da4631c6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommand.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", + "resourceGroupName": "crptestar98131", + "vmName": "vm3036", + "$top": "1", + "api-version": "2018-06-01", + "monitor": "true", + "parameters": { + "commandId": "RunPowerShellScript" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "code": "ComponentStatus/StdOut/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "This is a sample script with parameters value1 value2" + }, + { + "code": "ComponentStatus/StdErr/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "" + } + ] + } + }, + "202": { + "body": "" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommandGet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommandGet.json new file mode 100644 index 000000000000..e842642a68a7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommandGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", + "location": "SoutheastAsia", + "commandId": "RunPowerShellScript", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "body": { + "script": [ + "param(", + " [string]$arg1,", + " [string]$arg2", + ")", + "Write-Host This is a sample script with parameters $arg1 $arg2" + ], + "parameters": [ + { + "name": "arg1", + "type": "string", + "value": "value1" + }, + { + "name": "arg2", + "type": "string", + "value": "value2" + } + ], + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunPowerShellScript", + "osType": "Windows", + "label": "Executes a PowerShell script", + "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property." + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommandList.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommandList.json new file mode 100644 index 000000000000..d7cdf15d7f05 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommandList.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "SoutheastAsia", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "body": { + "value": [{ + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "EnableRemotePS", + "osType": "Windows", + "label": "Enable remote PowerShell", + "description": "Configure the machine to enable remote PowerShell." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "IPConfig", + "osType": "Windows", + "label": "List IP configuration", + "description": "Shows detailed information for the IP address, subnet mask and default gateway for each adapter bound to TCP/IP." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunPowerShellScript", + "osType": "Windows", + "label": "Executes a PowerShell script", + "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunShellScript", + "osType": "Linux", + "label": "Executes a Linux shell script", + "description": "Custom multiline shell script should be defined in script property. Optional parameters can be set in parameters property." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ifconfig", + "osType": "Linux", + "label": "List network configuration", + "description": "Get the configuration of all network interfaces." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "EnableAdminAccount", + "osType": "Windows", + "label": "Enable administrator account", + "description": "Checks if the local Administrator account is disabled, and if so enables it." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ResetAccountPassword", + "osType": "Windows", + "label": "Reset built-in Administrator account password", + "description": "Reset built-in Administrator account password." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RDPSettings", + "osType": "Windows", + "label": "Verify RDP Listener Settings", + "description": "Checks registry settings and domain policy settings. Suggests policy actions if machine is part of a domain or modifies the settings to default values." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "SetRDPPort", + "osType": "Windows", + "label": "Set Remote Desktop port", + "description": "Sets the default or user specified port number for Remote Desktop connections. Enables firewall rule for inbound access to the port." + }, { + "schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ResetRDPCert", + "osType": "Windows", + "label": "Restore RDP Authentication mode to defaults", + "description": "Removes the SSL certificate tied to the RDP listener and restores the RDP listerner security to default. Use this script if you see any issues with the certificate." + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/gallery.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/gallery.json new file mode 100644 index 000000000000..faf30fa3f808 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/gallery.json @@ -0,0 +1,1424 @@ +{ + "swagger": "2.0", + "info": { + "title": "SharedImageGalleryServiceClient", + "description": "Shared Image Gallery Service Client.", + "version": "2018-06-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}": { + "put": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_CreateOrUpdate", + "description": "Create or update a gallery.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "gallery", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Gallery" + }, + "description": "Parameters supplied to the create or update gallery operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery.": { + "$ref": "./examples/CreateOrUpdateASimpleGallery.json" + } + } + }, + "get": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_Get", + "description": "Retrieves information about a gallery.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery.": { + "$ref": "./examples/GetAGallery.json" + } + } + }, + "delete": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_Delete", + "description": "Delete a gallery.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a gallery.": { + "$ref": "./examples/DeleteAGallery.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}": { + "put": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_CreateOrUpdate", + "description": "Create or update a gallery image.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImage", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImage" + }, + "description": "Parameters supplied to the create or update gallery image operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery image.": { + "$ref": "./examples/CreateOrUpdateASimpleGalleryImage.json" + } + } + }, + "get": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_Get", + "description": "Retrieves information about a gallery image.", + "parameters":[ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery image.": { + "$ref": "./examples/GetAGalleryImage.json" + } + } + }, + "delete": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_Delete", + "description": "Delete a gallery image.", + "parameters":[ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a gallery image.": { + "$ref": "./examples/DeleteAGalleryImage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}": { + "put": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_CreateOrUpdate", + "description": "Create or update a gallery image version.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImageVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + }, + "description": "Parameters supplied to the create or update gallery image version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery image version.": { + "$ref": "./examples/CreateOrUpdateASimpleGalleryImageVersion.json" + } + } + }, + "get": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_Get", + "description": "Retrieves information about a gallery image version.", + "parameters":[ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "ReplicationStatus" + ], + "x-ms-enum": { + "name": "ReplicationStatusTypes", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery image version.": { + "$ref": "./examples/GetAGalleryImageVersion.json" + }, + "Get a gallery image version with replication status.": { + "$ref": "./examples/GetAGalleryImageVersionWithReplicationStatus.json" + } + } + }, + "delete": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_Delete", + "description": "Delete a gallery image version.", + "parameters":[ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a gallery image version.": { + "$ref": "./examples/DeleteAGalleryImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries": { + "get": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_ListByResourceGroup", + "description": "List galleries under a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List galleries in a resource group.": { + "$ref": "./examples/ListGalleriesInAResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries": { + "get": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_List", + "description": "List galleries under a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List galleries in a subscription.": { + "$ref": "./examples/ListGalleriesInASubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images": { + "get": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_ListByGallery", + "description": "List gallery images under a gallery.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List gallery images in a gallery.": { + "$ref": "./examples/ListGalleryImagesInAGallery.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions": { + "get": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_ListByGalleryImage", + "description": "List gallery image versions under a gallery image.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List gallery image versions in a gallery image.": { + "$ref": "./examples/ListGalleryImageVersionsInAGalleryImage.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Gallery": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery that you want to create or update." + }, + "GalleryProperties": { + "properties": { + "description": { + "type": "string", + "description": "The description of this gallery resource." + }, + "identifier": { + "$ref": "#/definitions/GalleryIdentifier" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "title": "The current state of the gallery.", + "description": "The provisioning state, which only appears in the response.", + "enum": [ + "Creating", + "Updating", + "Failed", + "Succeeded", + "Deleting", + "Migrating" + ] + } + }, + "description": "Describes the properties of a gallery." + }, + "GalleryIdentifier": { + "properties": { + "uniqueName": { + "readOnly": true, + "type": "string", + "description": "The unique name of the gallery" + } + }, + "description": "Describes the gallery unique name." + }, + "GalleryImage": { + "properties":{ + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery image that you want to create or update." + }, + "GalleryImageProperties": { + "properties": { + "description": { + "type": "string", + "description": "The description of this gallery image resource." + }, + "eula": { + "type": "string", + "description": "The Eula agreement for the gallery image." + }, + "privacyStatementUri": { + "type": "string", + "description": "The privacy statement uri." + }, + "releaseNoteUri": { + "type": "string", + "description": "The release note uri." + }, + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "The OS State.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false + } + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life of this gallery image." + }, + "identifier": { + "$ref": "#/definitions/GalleryImageIdentifier" + }, + "recommended": { + "$ref": "#/definitions/RecommendedMachineConfiguration" + }, + "disallowed": { + "$ref": "#/definitions/Disallowed" + }, + "purchasePlan":{ + "$ref": "#/definitions/ImagePurchasePlan" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "title": "The current state of the gallery image.", + "description": "The provisioning state, which only appears in the response.", + "enum": [ + "Creating", + "Updating", + "Failed", + "Succeeded", + "Deleting", + "Migrating" + ] + } + }, + "description": "Describes the properties of a gallery image." + }, + "GalleryImageIdentifier": { + "properties":{ + "publisher": { + "type": "string", + "description": "The gallery image publisher name." + }, + "offer": { + "type": "string", + "description": "The gallery image offer name." + }, + "sku": { + "type": "string", + "description": "The gallery image sku name." + } + }, + "description": "This is the gallery image identifier." + }, + "RecommendedMachineConfiguration": { + "properties": { + "vCPUs": { + "$ref": "#/definitions/ResourceRange" + }, + "memory": { + "$ref": "#/definitions/ResourceRange" + } + }, + "description": "Describes the recommended machine configuration." + }, + "ResourceRange": { + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum number of the resource." + }, + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum number of the resource." + } + }, + "description": "Describes the resource range." + }, + "Disallowed": { + "properties": { + "diskTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of disk types." + } + }, + "description": "Describes the disallowed disk types." + }, + "ImagePurchasePlan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "The product ID." + } + }, + "description": "Describes the gallery image purchase plan. This is used by marketplace images." + }, + "GalleryImageVersion": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "GalleryImageVersionProperties": { + "properties":{ + "publishingProfile": { + "$ref": "#/definitions/GalleryImageVersionPublishingProfile" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "title": "The current state of the gallery image version.", + "description": "The provisioning state, which only appears in the response.", + "enum": [ + "Creating", + "Updating", + "Failed", + "Succeeded", + "Deleting", + "Migrating" + ] + }, + "storageProfile": { + "readOnly": true, + "$ref": "#/definitions/GalleryImageVersionStorageProfile" + }, + "replicationStatus": { + "readOnly": true, + "$ref": "#/definitions/ReplicationStatus" + } + }, + "description": "Describes the properties of a gallery image version." + }, + "GalleryArtifactPublishingProfileBase": { + "properties": { + "regions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The regions where the artifact is going to be published." + }, + "source": { + "$ref": "#/definitions/GalleryArtifactSource" + } + }, + "description": "Describes the basic gallery artifact publishing profile." + }, + "GalleryArtifactSource": { + "properties": { + "managedImage": { + "$ref": "#/definitions/ManagedArtifact" + } + }, + "description": "The source of the gallery artifact." + }, + "ManagedArtifact": { + "properties": { + "id": { + "type": "string", + "description": "The managed artifact id." + } + }, + "description": "The managed artifact." + }, + "GalleryImageVersionPublishingProfile": { + "properties": { + "scaleTier": { + "type": "string", + "description": "The scale tier of the gallery image version. Valid values are 'S30' and 'S100'", + "enum": [ + "S30", + "S100" + ], + "x-ms-enum": { + "name": "ScaleTier", + "modelAsString": true + } + }, + "excludeFromLatest": { + "type": "boolean", + "description": "The flag means that if it is set to true, people deploying VMs with 'latest' as version will not use this version." + }, + "publishedDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the gallery image version is published." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image version." + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactPublishingProfileBase" + } + ], + "description": "The publishing profile of a gallery image version." + }, + "GalleryImageVersionStorageProfile": { + "properties": { + "osDiskImage": { + "readOnly": true, + "$ref": "#/definitions/GalleryOSDiskImage" + }, + "dataDiskImages": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/GalleryDataDiskImage" + }, + "description": "A list of data disk images." + } + }, + "description": "This is the storage profile of a gallery image version." + }, + "GalleryOSDiskImage": { + "allOf": [ + { + "$ref": "#/definitions/GalleryDiskImage" + } + ], + "description": "This is the OS disk image." + }, + "GalleryDataDiskImage": { + "properties": { + "lun": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryDiskImage" + } + ], + "description": "This is the data disk image." + }, + "GalleryDiskImage": { + "properties": { + "sizeInGB": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "It indicates the size of the VHD to create." + }, + "hostCaching":{ + "readOnly": true, + "type": "string", + "description": "The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "HostCaching", + "modelAsString": false + } + } + }, + "description": "This is the disk image base class." + }, + "ReplicationStatus": { + "properties": { + "aggregatedState": { + "readOnly": true, + "type": "string", + "description": "This is the aggregated replication status based on the regional replication status.", + "enum": [ + "Unknown", + "InProgress", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "AggregatedReplicationState", + "modelAsString": true + } + }, + "summary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RegionalReplicationStatus" + }, + "description": "This is a summary of replication status for each region." + } + }, + "description": "This is the replication status of the gallery image version." + }, + "RegionalReplicationStatus": { + "properties": { + "region": { + "readOnly": true, + "type": "string", + "description": "The region where the gallery image version is published to." + }, + "state": { + "readOnly": true, + "type": "string", + "description": "This is the regional replication state.", + "enum": [ + "Unknown", + "Replicating", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "ReplicationState", + "modelAsString": true + } + }, + "details": { + "readOnly": true, + "type": "string", + "description": "The details of the replication status." + }, + "progress": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "It indicates progress of the replication job." + } + }, + "description": "This is the regional replication status." + }, + "GalleryList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Gallery" + }, + "description": "A list of galleries." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries." + } + }, + "required": [ + "value" + ], + "description": "The List Galleries operation response." + }, + "GalleryImageList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryImage" + }, + "description": "A list of gallery images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of gallery images. Call ListNext() with this to fetch the next page of gallery images." + } + }, + "required": [ + "value" + ], + "description": "The List Gallery Images operation response." + }, + "GalleryImageVersionList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryImageVersion" + }, + "description": "A list of gallery image versions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of gallery image versions. Call ListNext() with this to fetch the next page of gallery image versions." + } + }, + "required": [ + "value" + ], + "description": "The List Gallery Image version operation response." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/ApiError" + } + }, + "description": "An error response from the Gallery service." + }, + "ApiError": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "description": "The Api error details" + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The Api inner error" + }, + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error." + }, + "ApiErrorBase": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error base." + }, + "InnerError": { + "properties": { + "exceptiontype": { + "type": "string", + "description": "The exception type." + }, + "errordetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + }, + "description": "Inner error details." + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + } + }, + "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." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the resource group." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/runCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/runCommands.json new file mode 100644 index 000000000000..946ad14c3669 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/runCommands.json @@ -0,0 +1,461 @@ +{ + "swagger": "2.0", + "info": { + "title": "RunCommandsClient", + "description": "The Run Commands Client.", + "version": "2018-06-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands": { + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_List", + "x-ms-examples": { + "VirtualMachineRunCommandList": { "$ref": "./examples/VirtualMachineRunCommandList.json" } + }, + "description": "Lists all available run commands for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which run commands is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}": { + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_Get", + "x-ms-examples": { + "VirtualMachineRunCommandGet": { "$ref": "./examples/VirtualMachineRunCommandGet.json" } + }, + "description": "Gets specific run command for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which run commands is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "The command id." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandDocument" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_RunCommand", + "x-ms-examples": { + "VirtualMachineRunCommand": { "$ref": "./examples/VirtualMachineRunCommand.json" } + }, + "description": "Run command on the VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandInput" + }, + "description": "Parameters supplied to the Run command operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/runCommand": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_RunCommand", + "description": "Run command on a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandInput" + }, + "description": "Parameters supplied to the Run command operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "RunCommandInputParameter": { + "properties": { + "name": { + "type": "string", + "description": "The run command parameter name." + }, + "value": { + "type": "string", + "description": "The run command parameter value." + } + }, + "required": [ + "name", + "value" + ], + "description": "Describes the properties of a run command parameter." + }, + "RunCommandInput": { + "properties": { + "commandId": { + "type": "string", + "description": "The run command id." + }, + "script": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. The script to be executed. When this value is given, the given script will override the default script of the command." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + }, + "description": "The run command parameters." + } + }, + "required": [ + "commandId" + ], + "description": "Capture Virtual Machine parameters." + }, + "RunCommandParameterDefinition": { + "properties": { + "name": { + "type": "string", + "description": "The run command parameter name." + }, + "type": { + "type": "string", + "description": "The run command parameter type." + }, + "defaultValue": { + "type": "string", + "description": "The run command parameter default value." + }, + "required": { + "type": "boolean", + "description": "The run command parameter required.", + "default": false + } + }, + "required": [ + "name", + "type" + ], + "description": "Describes the properties of a run command parameter." + }, + "RunCommandDocumentBase": { + "properties": { + "$schema": { + "type": "string", + "description": "The VM run command schema." + }, + "id": { + "type": "string", + "description": "The VM run command id." + }, + "osType": { + "type": "string", + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "label": { + "type": "string", + "description": "The VM run command label." + }, + "description": { + "type": "string", + "description": "The VM run command description." + } + }, + "required": [ + "$schema", + "id", + "osType", + "label", + "description" + ], + "description": "Describes the properties of a Run Command metadata." + }, + "RunCommandDocument": { + "allOf": [ + { + "$ref": "#/definitions/RunCommandDocumentBase" + } + ], + "properties": { + "script": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The script to be executed." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandParameterDefinition" + }, + "description": "The parameters used by the script." + } + }, + "required": [ + "script" + ], + "description": "Describes the properties of a Run Command." + }, + "RunCommandListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandDocumentBase" + }, + "description": "The list of virtual machine run commands." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "InstanceViewStatus": { + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": false + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "RunCommandResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "Run command operation response." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/readme.csharp.md b/specification/compute/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..88ac27080c53 --- /dev/null +++ b/specification/compute/resource-manager/readme.csharp.md @@ -0,0 +1,51 @@ +# C# Compute + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DNS. + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +## Common C# settings + + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true +``` + +``` yaml $(csharp) && !$(multiApi) +namespace: Microsoft.Azure.Management.Compute +output-folder: $(csharp-sdks-folder)/Compute/Management.Compute/Generated +``` + + + + + + + + + + + + + +## Batch settings +These settings are for batch mode only: (ie, add `--MultiApi` to the command line ) + +``` yaml $(multiApi) +namespace: Microsoft.Azure.Management.Compute.$(ApiVersionName) +output-folder: $(csharp-sdks-folder)/$(ApiVersionName)/Generated + +batch: + - tag: package-2017-03 + ApiVersionName: Api2017_03_30 + + - tag: package-2016-03 + ApiVersionName: Api2016_03_30 +``` \ No newline at end of file diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index a70ea5d3abeb..5c8cde8a8361 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -34,7 +34,7 @@ These are the global settings for the Compute API. title: ComputeManagementClient description: Compute Client openapi-type: arm -tag: package-2018-04 +tag: package-2018-04-01 directive: - where: @@ -144,13 +144,63 @@ directive: - $.definitions.VirtualMachineImage suppress: - TrackedResourcePatchOperation - - where: - $.definitions.VirtualMachineImageResource suppress: - TrackedResourceGetOperation - + - where: + - $.definitions.Gallery + suppress: + - TrackedResourcePatchOperation + - where: + - $.definitions.GalleryImage + suppress: + - TrackedResourcePatchOperation + - where: + - $.definitions.GalleryImageVersion + suppress: + - TrackedResourcePatchOperation + +``` + +### Tag: package-2018-06-01 + +These settings apply only when `--tag=package-2018-06-01` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06-01' +input-file: +- Microsoft.Compute/stable/2018-04-01/compute.json +- Microsoft.Compute/stable/2018-04-01/runCommands.json +- Microsoft.Compute/stable/2017-09-01/skus.json +- Microsoft.Compute/stable/2018-04-01/disk.json +- Microsoft.Compute/stable/2018-06-01/gallery.json +- Microsoft.ContainerService/stable/2017-01-31/containerService.json +``` + +### Tag: package-compute-only-2018-06 + +These settings apply only when `--tag=package-compute-only-2018-06` is specified on the command line. + +``` yaml $(tag) == 'package-compute-only-2018-06' +input-file: +- Microsoft.Compute/stable/2018-06-01/compute.json +- Microsoft.Compute/stable/2018-06-01/runCommands.json +- Microsoft.Compute/stable/2018-06-01/gallery.json +``` + +### Tag: package-2018-04-01 + +These settings apply only when `--tag=package-2018-04-01` is specified on the command line. + +``` yaml $(tag) == 'package-2018-04-01' +input-file: +- Microsoft.Compute/stable/2018-04-01/compute.json +- Microsoft.Compute/stable/2018-04-01/runCommands.json +- Microsoft.Compute/stable/2017-09-01/skus.json +- Microsoft.Compute/stable/2018-04-01/disk.json +- Microsoft.ContainerService/stable/2017-01-31/containerService.json ``` + ### Tag: package-2018-04 These settings apply only when `--tag=package-2018-04` is specified on the command line. @@ -164,6 +214,17 @@ input-file: - Microsoft.ContainerService/stable/2017-01-31/containerService.json ``` +### Tag: package-compute-2018-04 + +These settings apply only when `--tag=package-compute-2018-04` is specified on the command line. + +``` yaml $(tag) == 'package-compute-2018-04' +input-file: +- Microsoft.Compute/stable/2018-04-01/compute.json +- Microsoft.Compute/stable/2018-04-01/runCommands.json +- Microsoft.Compute/stable/2018-04-01/disk.json +``` + ### Tag: package-disks-2018-04 These settings apply only when `--tag=package-disks-2018-04` is specified on the command line. @@ -350,29 +411,14 @@ swagger-to-sdk: - repo: azure-sdk-for-python after_scripts: - python ./scripts/multiapi_init_gen.py azure-mgmt-compute - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_compute'] ``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - # last generated with AutoRest.1.0.0-Nightly20170126 - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Compute - payload-flattening-threshold: 1 - output-folder: $(csharp-sdks-folder)/Compute/Management.Compute/Generated - clear-output-folder: true -``` - - ## Go These settings apply only when `--go` is specified on the command line. @@ -387,66 +433,58 @@ go: ``` yaml $(go) && $(multiapi) batch: - - tag: package-2018-04 - #- tag: package-2017-12 broken - - tag: package-2017-03 - - tag: package-container-service-2017-01 - - tag: package-container-service-2016-09 + - tag: package-compute-only-2018-06 + - tag: package-compute-2018-04 + - tag: package-compute-only-2017-12 + - tag: package-compute-2017-03 - tag: package-compute-2016-04-preview - tag: package-compute-2016-03 + - tag: package-compute-2015-06 + - tag: package-skus-2017-09 + - tag: package-container-service-2017-01 + - tag: package-container-service-2016-09 - tag: package-container-service-2016-03 - tag: package-container-service-2015-11-preview - - tag: package-compute-2015-06 ``` -### Tag: package-2018-04 and go +### Tag: package-compute-only-2018-06 and go -These settings apply only when `--tag=package-2018-04 --go` is specified on the command line. +These settings apply only when `--tag=package-compute-only-2018-06 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag)=='package-2018-04' && $(go) +``` yaml $(tag)=='package-compute-only-2018-06' && $(go) namespace: compute -output-folder: $(go-sdk-folder)/services/compute/mgmt/2018-04-01/compute +output-folder: $(go-sdk-folder)/services/compute/mgmt/2018-06-01/compute ``` -### Tag: package-2017-12 and go +### Tag: package-compute-2018-04 and go -These settings apply only when `--tag=package-2017-12 --go` is specified on the command line. +These settings apply only when `--tag=package-compute-2018-04 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag)=='package-2017-12' && $(go) +``` yaml $(tag)=='package-compute-2018-04' && $(go) namespace: compute -output-folder: $(go-sdk-folder)/services/compute/mgmt/2017-12-01/compute +output-folder: $(go-sdk-folder)/services/compute/mgmt/2018-04-01/compute ``` -### Tag: package-2017-03 and go +### Tag: package-compute-only-2017-12 and go -These settings apply only when `--tag=package-2017-03 --go` is specified on the command line. +These settings apply only when `--tag=package-compute-only-2017-12 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag)=='package-2017-03' && $(go) +``` yaml $(tag)=='package-compute-only-2017-12' && $(go) namespace: compute -output-folder: $(go-sdk-folder)/services/compute/mgmt/2017-03-30/compute -``` - -### Tag: package-container-service-2017-01 and go - -These settings apply only when `--tag=package-container-service-2017-01 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag)=='package-container-service-2017-01' && $(go) -namespace: containerservice -output-folder: $(go-sdk-folder)/services/containerservice/mgmt/2017-01-31/containerservice +output-folder: $(go-sdk-folder)/services/compute/mgmt/2017-12-01/compute ``` -### Tag: package-container-service-2016-09 and go +### Tag: package-compute-2017-03 and go -These settings apply only when `--tag=package-container-service-2016-09 --go` is specified on the command line. +These settings apply only when `--tag=package-compute-2017-03 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag)=='package-container-service-2016-09' && $(go) -namespace: containerservice -output-folder: $(go-sdk-folder)/services/containerservice/mgmt/2016-09-30/containerservice +``` yaml $(tag)=='package-compute-2017-03' && $(go) +namespace: compute +output-folder: $(go-sdk-folder)/services/compute/mgmt/2017-03-30/compute ``` ### Tag: package-compute-2016-04-preview and go @@ -456,7 +494,7 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-compute-2015-06' && $(go) +namespace: compute +output-folder: $(go-sdk-folder)/services/compute/mgmt/2015-06-15/compute +``` + +### Tag: package-skus-2017-09 and go + +These settings apply only when `--tag=package-skus-2017-09 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-skus-2017-09' && $(go) +namespace: skus +output-folder: $(go-sdk-folder)/services/compute/mgmt/2017-09-01/skus +``` + +### Tag: package-container-service-2017-01 and go + +These settings apply only when `--tag=package-container-service-2017-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-container-service-2017-01' && $(go) +namespace: containerservice +output-folder: $(go-sdk-folder)/services/containerservice/mgmt/2017-01-31/containerservice +``` + +### Tag: package-container-service-2016-09 and go + +These settings apply only when `--tag=package-container-service-2016-09 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-container-service-2016-09' && $(go) +namespace: containerservice +output-folder: $(go-sdk-folder)/services/containerservice/mgmt/2016-09-30/containerservice +``` + ### Tag: package-container-service-2016-03 and go These settings apply only when `--tag=package-container-service-2016-03 --go` is specified on the command line. @@ -486,20 +564,9 @@ Please also specify `--go-sdk-folder=`. - -``` yaml $(tag)=='package-compute-2015-06' && $(go) -namespace: compute -output-folder: $(go-sdk-folder)/services/compute/mgmt/2015-06-15/compute +output-folder: $(go-sdk-folder)/services/preview/containerservice/mgmt/2015-11-01-preview/containerservice ``` - ## Python These settings apply only when `--python` is specified on the command line. @@ -520,7 +587,8 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: - - tag: package-disks-2018-04 + - tag: package-compute-only-2018-06 + - tag: package-compute-2018-04 - tag: package-compute-only-2017-12 - tag: package-skus-2017-09 - tag: package-compute-2017-03 @@ -529,12 +597,23 @@ batch: - tag: package-compute-2015-06 ``` -### Tag: package-disks-2018-04 and python +### Tag: package-compute-only-2018-06 and python + +These settings apply only when `--tag=package-compute-only-2018-06 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-compute-only-2018-06' && $(python) +python: + namespace: azure.mgmt.compute.v2018_06_01 + output-folder: $(python-sdks-folder)/azure-mgmt-compute/azure/mgmt/compute/v2018_06_01 +``` + +### Tag: package-compute-2018-04 and python -These settings apply only when `--tag=package-disks-2018-04 --python` is specified on the command line. +These settings apply only when `--tag=package-compute-2018-04 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-disks-2018-04' && $(python) +``` yaml $(tag) == 'package-compute-2018-04' && $(python) python: namespace: azure.mgmt.compute.v2018_04_01 output-folder: $(python-sdks-folder)/azure-mgmt-compute/azure/mgmt/compute/v2018_04_01 @@ -613,12 +692,72 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.compute +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-compute +``` + +### Java multi-api + +```yaml $(java) && $(multiapi) +batch: + - tag: package-disks-2018-04 + - tag: package-compute-only-2017-12 + - tag: package-skus-2017-09 + - tag: package-compute-2017-03 +``` + +### Tag: package-disks-2018-04 and java + +These settings apply only when `--tag=package-disks-2018-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-disks-2018-04' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.compute - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-compute + namespace: com.microsoft.azure.management.compute.v2018_04_01 + output-folder: $(azure-libraries-for-java-folder)/compute/resource-manager/v2018_04_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-compute-only-2017-12 and java + +These settings apply only when `--tag=package-compute-only-2017-12 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-compute-only-2017-12' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.compute.v2017_12_01 + output-folder: $(azure-libraries-for-java-folder)/compute/resource-manager/v2017_12_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-skus-2017-09 and java + +These settings apply only when `--tag=package-skus-2017-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-skus-2017-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.compute.v2017_09_01 + output-folder: $(azure-libraries-for-java-folder)/compute/resource-manager/v2017_09_01 +regenerate-manager: true +generate-interface: true ``` +### Tag: package-compute-2017-03 and java + +These settings apply only when `--tag=package-compute-2017-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-compute-2017-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.compute.v2017_03_30 + output-folder: $(azure-libraries-for-java-folder)/compute/resource-manager/v2017_03_30 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/compute/resource-manager/readme.ruby.md b/specification/compute/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..d6d4616853ed --- /dev/null +++ b/specification/compute/resource-manager/readme.ruby.md @@ -0,0 +1,92 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_compute +package-version: "0.17.1" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-disks-2018-04 + - tag: package-compute-only-2017-12 + - tag: package-skus-2017-09 + - tag: package-compute-2017-03 + - tag: package-compute-2016-04-preview + - tag: package-compute-2016-03 + - tag: package-compute-2015-06 +``` + +### Tag: package-disks-2018-04 and ruby + +These settings apply only when `--tag=package-disks-2018-04 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-disks-2018-04' && $(ruby) +namespace: "Azure::Compute::Mgmt::V2018_04_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_compute/lib +``` + +### Tag: package-compute-only-2017-12 and ruby + +These settings apply only when `--tag=package-compute-only-2017-12 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-compute-only-2017-12' && $(ruby) +namespace: "Azure::Compute::Mgmt::V2017_12_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_compute/lib +``` + +### Tag: package-skus-2017-09 and ruby + +These settings apply only when `--tag=package-skus-2017-09 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-skus-2017-09' && $(ruby) +namespace: "Azure::Compute::Mgmt::V2017_09_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_compute/lib +``` + +### Tag: package-compute-2017-03 and ruby + +These settings apply only when `--tag=package-compute-2017-03 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-compute-2017-03' && $(ruby) +namespace: "Azure::Compute::Mgmt::V2017_03_30" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_compute/lib +``` + +### Tag: package-compute-2016-04-preview and ruby + +These settings apply only when `--tag=package-compute-2016-04-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-compute-2016-04-preview' && $(ruby) +namespace: "Azure::Compute::Mgmt::V2016_04_30_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_compute/lib +``` + +### Tag: package-compute-2016-03 and ruby + +These settings apply only when `--tag=package-compute-2016-03 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-compute-2016-03' && $(ruby) +namespace: "Azure::Compute::Mgmt::V2016_03_30" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_compute/lib +``` + +### Tag: package-compute-2015-06 and ruby + +These settings apply only when `--tag=package-compute-2015-06 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-compute-2015-06' && $(ruby) +namespace: "Azure::Compute::Mgmt::V2015_06_15" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_compute/lib +``` diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/consumption.json index e2c2bcc4d9fa..eac7453f6c4f 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/consumption.json @@ -40,7 +40,7 @@ "UsageDetails" ], "operationId": "UsageDetails_List", - "description": "Lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.", + "description": "Lists the usage details for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, @@ -68,21 +68,965 @@ }, { "name": "$filter", - "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. 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 is separated by a colon (:).", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "$skiptoken", - "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListByBillingPeriod", + "description": "Lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriod.json" + }, + "UsageDetailsExpand": { + "$ref": "./examples/UsageDetailsExpand.json" + }, + "UsageDetailsListForBillingPeriodGroupByTag": { + "$ref": "./examples/UsageDetailsListForBillingPeriodGroupByTag.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetailsByBillingAccount_List", + "description": "Lists the usage details by billingAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsList": { + "$ref": "./examples/UsageDetailsListByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetailsByBillingAccount_ListByBillingPeriod", + "description": "Lists the usage details based on billingAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetailsByDepartment_List", + "description": "Lists the usage details by departmentId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsList": { + "$ref": "./examples/UsageDetailsListByDepartment.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/departmentIdParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": { +"get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetailsByDepartment_ListByBillingPeriod", + "description": "Lists the usage details based on departmentId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByDepartment.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/departmentIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetailsByEnrollmentAccount_List", + "description": "Lists the usage details by enrollmentAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsList": { + "$ref": "./examples/UsageDetailsListByEnrollmentAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": { +"get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetailsByEnrollmentAccount_ListByBillingPeriod", + "description": "Lists the usage details based on enrollmentAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "Marketplaces_List", + "description": "Lists the marketplaces for a scope by subscriptionId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesList": { + "$ref": "./examples/MarketplacesList.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "Marketplaces_ListByBillingPeriod", + "description": "Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesListForBillingPeriod.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "MarketplacesByBillingAccount_List", + "description": "Lists the marketplaces for a scope by billingAccountId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesList": { + "$ref": "./examples/MarketplacesByBillingAccountList.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "MarketplacesByBillingAccount_ListByBillingPeriod", + "description": "Lists the marketplaces for a scope by billing period and billingAccountId. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesByBillingAccountListForBillingPeriod.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "MarketplacesByDepartment_List", + "description": "Lists the marketplaces for a scope by departmentId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesList": { + "$ref": "./examples/MarketplacesByDepartmentList.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", "in": "query", "required": false, "type": "string" }, { "name": "$top", - "description": "May be used to limit the number of results to the most recent N usageDetails.", + "description": "May be used to limit the number of results to the most recent N marketplaces.", "in": "query", "required": false, "type": "integer", @@ -90,26 +1034,24 @@ "maximum": 1000 }, { - "name": "$apply", - "description": "OData apply expression to aggregatie usageDetails by tags or (tags and properties/usageStart)", + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", "in": "query", "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" - }, - "x-ms-client-name": "Apply" + "type": "string" }, { "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/departmentIdParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { - "$ref": "#/definitions/UsageDetailsListResult" + "$ref": "#/definitions/MarketplacesListResult" } }, "default": { @@ -124,59 +1066,38 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": { + "/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces": { "get": { "tags": [ - "UsageDetails" + "Marketplaces" ], - "operationId": "UsageDetails_ListByBillingPeriod", - "description": "Lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.", + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "MarketplacesByDepartment_ListByBillingPeriod", + "description": "Lists the marketplaces for a scope by billing period and departmentId. Marketplaces are available via this API only for May 1, 2014 or later.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { - "UsageDetailsListForBillingPeriod": { - "$ref": "./examples/UsageDetailsListForBillingPeriod.json" - }, - "UsageDetailsExpand": { - "$ref": "./examples/UsageDetailsExpand.json" - }, - "UsageDetailsListForBillingPeriodGroupByTag": { - "$ref": "./examples/UsageDetailsListForBillingPeriodGroupByTag.json" + "MarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesByDepartment_ListByBillingPeriod.json" } }, "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/billingPeriodNameParameter" - }, - { - "name": "$expand", - "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", - "in": "query", - "required": false, - "type": "string" - }, { "name": "$filter", - "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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 is separated by a colon (:).", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", "in": "query", "required": false, "type": "string" }, { - "name": "$apply", - "description": "OData apply expression to aggregatie usageDetails by tags or (tags and properties/usageStart) for specified billing period", + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", "in": "query", "required": false, - "type": "string", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" - }, - "x-ms-client-name": "Apply" + "type": "integer", + "minimum": 1, + "maximum": 1000 }, { "name": "$skiptoken", @@ -186,23 +1107,20 @@ "type": "string" }, { - "name": "$top", - "description": "May be used to limit the number of results to the most recent N usageDetails.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 1, - "maximum": 1000 + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "#/parameters/departmentIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { - "$ref": "#/definitions/UsageDetailsListResult" + "$ref": "#/definitions/MarketplacesListResult" } }, "default": { @@ -217,20 +1135,20 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/marketplaces": { + "/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Consumption/marketplaces": { "get": { "tags": [ "Marketplaces" ], "x-ms-odata": "#/definitions/Marketplace", - "operationId": "Marketplaces_List", - "description": "Lists the marketplaces for a scope by subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.", + "operationId": "MarketplacesByEnrollmentAccounts_List", + "description": "Lists the marketplaces for a scope by enrollmentAccountId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "MarketplacesList": { - "$ref": "./examples/MarketplacesList.json" + "$ref": "./examples/MarketplacesByEnrollmentAccountList.json" } }, "parameters": [ @@ -261,7 +1179,7 @@ "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "#/parameters/enrollmentAccountIdParameter" } ], "responses": { @@ -283,20 +1201,20 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces": { + "/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces": { "get": { "tags": [ "Marketplaces" ], "x-ms-odata": "#/definitions/Marketplace", - "operationId": "Marketplaces_ListByBillingPeriod", - "description": "Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.", + "operationId": "MarketplacesByEnrollmentAccounts_ListByBillingPeriod", + "description": "Lists the marketplaces for a scope by billing period and enrollmentAccountId. Marketplaces are available via this API only for May 1, 2014 or later.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { "MarketplacesListForBillingPeriod": { - "$ref": "./examples/MarketplacesListForBillingPeriod.json" + "$ref": "./examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json" } }, "parameters": [ @@ -327,7 +1245,7 @@ "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "#/parameters/enrollmentAccountIdParameter" }, { "$ref": "#/parameters/billingPeriodNameParameter" @@ -352,7 +1270,88 @@ } } }, - "/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationSummaries": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/balances": { + "get": { + "tags": [ + "Balances" + ], + "operationId": "GetBalancesByBillingAccount", + "description": "Gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "Balances": { + "$ref": "./examples/BalancesByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Balance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/balances": { + "get": { + "tags": [ + "Balances" + ], + "operationId": "GetBalancesByBillingAccount_ByBillingPeriod", + "description": "Gets the balances for a scope by billing period and billingAccountId. Balances are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "Balances": { + "$ref": "./examples/BalancesByBillingAccountForBillingPeriod.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Balance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationSummaries": { "get": { "tags": [ "ReservedInstances" @@ -1143,7 +2142,7 @@ } } }, - "/providers/Microsoft.CostManagement/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/costTags": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/costTags": { "get": { "tags": [ "CostTags" @@ -1185,8 +2184,8 @@ "tags": [ "CostTags" ], - "operationId": "CostTags_CreateOrUpdate", "description": "The operation to create or update cost tags assiciated with a billing account. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "operationId": "CostTags_CreateOrUpdate", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, @@ -1641,7 +2640,154 @@ } } }, - "ReservationSummaries": { + "Balance": { + "description": "A balance resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BalanceProperties", + "title": "Balance properties" + } + } + }, + "BalanceProperties": { + "description": "The properties of the balance.", + "type": "object", + "properties": { + "currency": { + "description": "The ISO currency in which the meter is charged, for example, USD.", + "type": "string", + "readOnly": true + }, + "beginningBalance": { + "description": "The beginning balance for the billing period.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "endingBalance": { + "description": "The ending balance for the billing period (for open periods this will be updated daily).", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "newPurchases": { + "description": "Total new purchase amount.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "adjustments": { + "description": "Total adjustment amount.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "utilized": { + "description": "Total Commitment usage.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "serviceOverage": { + "description": "Overage for Azure services.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "chargesBilledSeparately": { + "description": "Charges Billed separately.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "totalOverage": { + "description": "serviceOverage + chargesBilledSeparately.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "totalUsage": { + "description": "Azure service commitment + total Overage.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "azureMarketplaceServiceCharges": { + "description": "Total charges for Azure Marketplace.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "billingFrequency": { + "description": "The billing frequency.", + "type": "string", + "enum": [ + "Month", + "Quarter", + "Year" + ], + "x-ms-enum": { + "name": "BillingFrequency", + "modelAsString": true + } + }, + "priceHidden": { + "description": "Price is hidden or not.", + "type": "boolean", + "readOnly": true + }, + "newPurchasesDetails": { + "description": "List of new purchases.", + "type": "array", + "items": { + "type" : "object", + "properties" : { + "name" : { + "description": "the name of new purchase.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "the value of new purchase.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "readOnly": true + }, + "adjustmentDetails": { + "description": "List of Adjustments (Promo credit, SIE credit etc.).", + "type": "array", + "items": { + "type" : "object", + "properties" : { + "name" : { + "description": "the name of new adjustment.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "the value of new adjustment.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "readOnly": true + } + } + }, + "ReservationSummaries": { "description": "reservation summaries resource.", "type": "object", "allOf": [ @@ -2450,21 +3596,37 @@ "type": "string", "description": "Version of the API to be used with the client request. The current version is 2018-03-31." }, - "subscriptionIdParameter": { - "name": "subscriptionId", + "billingAccountIdParameter": { + "name": "billingAccountId", "in": "path", - "description": "Azure Subscription ID.", + "description": "BillingAccount ID", "required": true, - "type": "string" + "type": "string", + "x-ms-parameter-location": "method" }, - "billingAccountIdParameter": { - "name": "billingAccountId", + "departmentIdParameter": { + "name": "departmentId", + "in": "path", + "description": "Department ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "enrollmentAccountIdParameter": { + "name": "enrollmentAccountId", "in": "path", - "description": "Azure Billing Account ID.", + "description": "EnrollmentAccount ID", "required": true, "type": "string", "x-ms-parameter-location": "method" }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, "resourceGroupNameParameter": { "name": "resourceGroupName", "in": "path", diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/BalancesByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/BalancesByBillingAccount.json new file mode 100644 index 000000000000..1b0685536635 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/BalancesByBillingAccount.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "billingAccountId": "123456" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/balances/balanceId1", + "name": "balanceId1", + "type": "Microsoft.Consumption/balances", + "properties": { + "currency": "USD ", + "beginningBalance": 3396469.19, + "endingBalance": 2922371.02, + "newPurchases": 0, + "adjustments": 0, + "utilized": 474098.17, + "serviceOverage": 0, + "chargesBilledSeparately": 0, + "totalOverage": 0, + "totalUsage": 474098.17, + "azureMarketplaceServiceCharges": 609.82, + "billingFrequency": "Month", + "priceHidden": false, + "newPurchasesDetails": [ + { + "name": "Promo Purchase", + "value": 1 + } + ], + "adjustmentDetails": [ + { + "name": "Promo Credit", + "value": 1.1 + }, + { + "name": "SIE Credit", + "value": 1.0 + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/BalancesByBillingAccountForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/BalancesByBillingAccountForBillingPeriod.json new file mode 100644 index 000000000000..17bd27db06c2 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/BalancesByBillingAccountForBillingPeriod.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "billingAccountId": "123456", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/balances/balanceId1", + "name": "balanceId1", + "type": "Microsoft.Consumption/balances", + "properties": { + "currency": "USD ", + "beginningBalance": 3396469.19, + "endingBalance": 2922371.02, + "newPurchases": 0, + "adjustments": 0, + "utilized": 474098.17, + "serviceOverage": 0, + "chargesBilledSeparately": 0, + "totalOverage": 0, + "totalUsage": 474098.17, + "azureMarketplaceServiceCharges": 609.82, + "billingFrequency": "Month", + "priceHidden": false, + "newPurchasesDetails": [ + { + "name": "Promo Purchase", + "value": 1 + } + ], + "adjustmentDetails": [ + { + "name": "Promo Credit", + "value": 1.1 + }, + { + "name": "SIE Credit", + "value": 1.0 + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/CostTags.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/CostTags.json index c67713a4bc65..98f4f6a5049e 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/CostTags.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/CostTags.json @@ -6,7 +6,7 @@ "responses": { "200": { "body": { - "id": "providers/Microsoft.CostManagement/billingAccounts/{billingaccount-id}/providers/Microsoft.Consumption/costTags/costTags1", + "id": "providers/Microsoft.Billing/billingAccounts/{billingaccount-id}/providers/Microsoft.Consumption/costTags/costTags1", "name": "costTags1", "type": "Microsoft.Consumption/costTags", "eTag": "\"1d34d012214157f\"", diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/CreateOrUpdateCostTags.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/CreateOrUpdateCostTags.json index 37a9db21be3b..0f2ba3434d5a 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/CreateOrUpdateCostTags.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/CreateOrUpdateCostTags.json @@ -22,7 +22,7 @@ "responses": { "201": { "body": { - "id": "providers/Microsoft.CostManagement/billingAccounts/{billingaccount-id}/providers/Microsoft.Consumption/costTags/costTags1", + "id": "providers/Microsoft.Billing/billingAccounts/{billingaccount-id}/providers/Microsoft.Consumption/costTags/costTags1", "name": "costTags1", "type": "Microsoft.Consumption/costTags", "eTag": "\"1d34d012214157f\"", @@ -46,7 +46,7 @@ }, "200": { "body": { - "id": "providers/Microsoft.CostManagement/billingAccounts/{billingaccount-id}/providers/Microsoft.Consumption/costTags/costTags1", + "id": "providers/Microsoft.Billing/billingAccounts/{billingaccount-id}/providers/Microsoft.Consumption/costTags/costTags1", "name": "costTags1", "type": "Microsoft.Consumption/costTags", "eTag": "\"1d34d012214157f\"", diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByBillingAccountList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByBillingAccountList.json new file mode 100644 index 000000000000..b60ba36633e1 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByBillingAccountList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "billingAccountId": "123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplaceId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan1", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByBillingAccountListForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByBillingAccountListForBillingPeriod.json new file mode 100644 index 000000000000..8c2b63872908 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByBillingAccountListForBillingPeriod.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "billingAccountId": "123456", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByDepartmentList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByDepartmentList.json new file mode 100644 index 000000000000..9dfa9f192e55 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByDepartmentList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "departmentId": "123456", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByDepartment_ListByBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByDepartment_ListByBillingPeriod.json new file mode 100644 index 000000000000..46459faae17d --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByDepartment_ListByBillingPeriod.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "departmentId": "123456", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByEnrollmentAccountList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByEnrollmentAccountList.json new file mode 100644 index 000000000000..9bceabcbec8a --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByEnrollmentAccountList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "enrollmentAccountId": "123456", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json new file mode 100644 index 000000000000..5007be230830 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "enrollmentAccountId": "123456", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListByBillingAccount.json new file mode 100644 index 000000000000..1b0c22032b64 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListByBillingAccount.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "billingAccountId": "1234" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": + "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": + "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListByDepartment.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListByDepartment.json new file mode 100644 index 000000000000..4d8dc4eba081 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListByDepartment.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "departmentId": "1234" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": + "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": + "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListByEnrollmentAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListByEnrollmentAccount.json new file mode 100644 index 000000000000..5e5d56f6b358 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListByEnrollmentAccount.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "enrollmentAccountId": "1234" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": + "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": + "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListForBillingPeriodByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListForBillingPeriodByBillingAccount.json new file mode 100644 index 000000000000..fdbdd6877439 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListForBillingPeriodByBillingAccount.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "billingAccountId": "1234", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListForBillingPeriodByDepartment.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListForBillingPeriodByDepartment.json new file mode 100644 index 000000000000..95fa8087e1c9 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListForBillingPeriodByDepartment.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "departmentId": "1234", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json new file mode 100644 index 000000000000..01fbbdabc372 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "enrollmentAccountId": "1234", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/consumption.json new file mode 100644 index 000000000000..bdf310dff7d2 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/consumption.json @@ -0,0 +1,1521 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-05-31", + "title": "ConsumptionManagementClient", + "description": "Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions." + }, + "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.Consumption/pricesheets/default": { + "get": { + "tags": [ + "PriceSheet" + ], + "operationId": "PriceSheet_Get", + "description": "Gets the price sheet for a scope by subscriptionId. Price sheet is available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "PriceSheet": { + "$ref": "./examples/PriceSheet.json" + } + }, + "parameters": [ + { + "name": "$expand", + "description": "May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the top N results.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PriceSheetResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/default": { + "get": { + "tags": [ + "PriceSheet" + ], + "operationId": "PriceSheet_GetByBillingPeriod", + "description": "Get the price sheet for a scope by subscriptionId and billing period. Price sheet is available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "PriceSheetForBillingPeriod": { + "$ref": "./examples/PriceSheetForBillingPeriod.json" + }, + "PriceSheetExpand": { + "$ref": "./examples/PriceSheetExpand.json" + } + }, + "parameters": [ + { + "name": "$expand", + "description": "May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the top N results.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PriceSheetResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_List", + "description": "Lists the usage details for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsList": { + "$ref": "./examples/UsageDetailsList.json" + }, + "UsageDetailsListFilterByTag": { + "$ref": "./examples/UsageDetailsListFilterByTag.json" + }, + "UsageDetailsListGroupByTagDate": { + "$ref": "./examples/UsageDetailsListGroupByTagDate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListByBillingPeriod", + "description": "Lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriod.json" + }, + "UsageDetailsExpand": { + "$ref": "./examples/UsageDetailsExpand.json" + }, + "UsageDetailsListForBillingPeriodGroupByTag": { + "$ref": "./examples/UsageDetailsListForBillingPeriodGroupByTag.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListByBillingAccount", + "description": "Lists the usage details by billingAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsList": { + "$ref": "./examples/UsageDetailsListByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListForBillingPeriodByBillingAccount", + "description": "Lists the usage details based on billingAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListByDepartment", + "description": "Lists the usage details by departmentId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsList": { + "$ref": "./examples/UsageDetailsListByDepartment.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/departmentIdParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": { +"get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListForBillingPeriodByDepartment", + "description": "Lists the usage details based on departmentId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByDepartment.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/departmentIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListByEnrollmentAccount", + "description": "Lists the usage details by enrollmentAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsList": { + "$ref": "./examples/UsageDetailsListByEnrollmentAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": { +"get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListForBillingPeriodByEnrollmentAccount", + "description": "Lists the usage details based on enrollmentAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/forecasts": { + "get": { + "tags": [ + "Forecasts" + ], + "x-ms-odata": "#/definitions/Forecast", + "operationId": "Forecasts_List", + "description": "Lists the forecast charges by subscriptionId.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ForecastsList": { + "$ref": "./examples/ForecastsList.json" + }, + "ForecastsListFilterByGrain": { + "$ref": "./examples/ForecastsListFilterByGrain.json" + }, + "ForecastsListFilterByDates": { + "$ref": "./examples/ForecastsListFilterByDates.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ForecastsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.Consumption/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available consumption REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "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 + } + } + }, + "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" + } + } + }, + "Operation": { + "description": "A Consumption 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.Consumption.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed: UsageDetail, etc.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "OperationListResult": { + "description": "Result of listing consumption operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of consumption operations supported by the Microsoft.Consumption 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 + } + } + }, + "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." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "x-ms-azure-resource": true + }, + "PriceSheetResult": { + "description": "An pricesheet resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PriceSheetModel", + "title": "Price sheet properties" + } + } + }, + "PriceSheetModel": { + "description": "price sheet result. It contains the pricesheet associated with billing period", + "properties": { + "pricesheets": { + "description": "Price sheet", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PriceSheetProperties" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "PriceSheetProperties": { + "description": "The properties of the price sheet.", + "properties": { + "billingPeriodId": { + "description": "The id of the billing period resource that the usage belongs to.", + "type": "string", + "readOnly": true + }, + "meterId": { + "description": "The meter id (GUID)", + "type": "string", + "format":"uuid", + "readOnly": true + }, + "meterDetails": { + "description": "The details about the meter. By default this is not populated, unless it's specified in $expand.", + "$ref": "#/definitions/MeterDetails", + "readOnly": true + }, + "unitOfMeasure": { + "description": "Unit of measure", + "type": "string", + "readOnly": true + }, + "includedQuantity": { + "description": "Included quality for an offer", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "partNumber": { + "description": "Part Number", + "type": "string", + "readOnly": true + }, + "unitPrice": { + "description": "Unit Price", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "currencyCode": { + "description": "Currency Code", + "type": "string", + "readOnly": true + }, + "offerId": { + "description": "Offer Id", + "type": "string", + "readOnly": true + } + } + }, + "Forecast": { + "description": "A forecast resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ForecastProperties", + "title": "Forecast properties" + } + } + }, + "MeterDetails": { + "description": "The properties of the meter detail.", + "properties": { + "meterName": { + "description": "The name of the meter, within the given meter category", + "type": "string", + "readOnly": true + }, + "meterCategory": { + "description": "The category of the meter, for example, 'Cloud services', 'Networking', etc..", + "type": "string", + "readOnly": true + }, + "meterSubCategory": { + "description": "The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc..", + "type": "string", + "readOnly": true + }, + "unit": { + "description": "The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc.", + "type": "string", + "readOnly": true + }, + "meterLocation": { + "description": "The location in which the Azure service is available.", + "type": "string", + "readOnly": true + }, + "totalIncludedQuantity": { + "description": "The total included quantity associated with the offer.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "pretaxStandardRate": { + "description": "The pretax listing price.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "UsageDetail": { + "description": "An usage detail resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UsageDetailProperties", + "title": "Usage detail properties" + } + } + }, + "UsageDetailsListResult": { + "description": "Result of listing usage details. It contains a list of available usage details in reverse chronological order by billing period.", + "properties": { + "value": { + "description": "The list of usage details.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/UsageDetail" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "UsageDetailProperties": { + "description": "The properties of the usage detail.", + "properties": { + "billingPeriodId": { + "description": "The id of the billing period resource that the usage belongs to.", + "type": "string", + "readOnly": true + }, + "invoiceId": { + "description": "The id of the invoice resource that the usage belongs to.", + "type": "string", + "readOnly": true + }, + "usageStart": { + "description": "The start of the date time range covered by the usage detail.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "usageEnd": { + "description": "The end of the date time range covered by the usage detail.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "instanceName": { + "description": "The name of the resource instance that the usage is about.", + "type": "string", + "readOnly": true + }, + "instanceId": { + "description": "The uri of the resource instance that the usage is about.", + "type": "string", + "readOnly": true + }, + "instanceLocation": { + "description": "The location of the resource instance that the usage is about.", + "type": "string", + "readOnly": true + }, + "currency": { + "description": "The ISO currency in which the meter is charged, for example, USD.", + "type": "string", + "readOnly": true + }, + "usageQuantity": { + "description": "The quantity of usage.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "billableQuantity": { + "description": "The billable usage quantity.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "pretaxCost": { + "description": "The amount of cost before tax.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "isEstimated": { + "description": "The estimated usage is subject to change.", + "type": "boolean", + "readOnly": true + }, + "meterId": { + "description": "The meter id (GUID).", + "type": "string", + "format":"uuid", + "readOnly": true + }, + "meterDetails": { + "description": "The details about the meter. By default this is not populated, unless it's specified in $expand.", + "$ref": "#/definitions/MeterDetails", + "readOnly": true + }, + "subscriptionGuid": { + "description": "Subscription guid.", + "type": "string", + "format":"uuid", + "readOnly": true + }, + "subscriptionName": { + "description": "Subscription name.", + "type": "string", + "readOnly": true + }, + "accountName": { + "description": "Account name.", + "type": "string", + "readOnly": true + }, + "departmentName": { + "description": "Department name.", + "type": "string", + "readOnly": true + }, + "product": { + "description": "Product name.", + "type": "string", + "readOnly": true + }, + "consumedService": { + "description": "Consumed service name.", + "type": "string", + "readOnly": true + }, + "costCenter": { + "description": "The cost center of this department if it is a department and a costcenter exists", + "type": "string", + "readOnly": true + }, + "partNumber": { + "description": "Part Number", + "type": "string", + "readOnly": true + }, + "resourceGuid": { + "description": "Resource Guid", + "type": "string", + "readOnly": true + }, + "offerId": { + "description": "Offer Id", + "type": "string", + "readOnly": true + }, + "chargesBilledSeparately": { + "description": "Charges billed separately", + "type": "boolean", + "readOnly": true + }, + "additionalProperties": { + "description": "Additional details of this usage item. By default this is not populated, unless it's specified in $expand.", + "type": "string", + "readOnly": true + } + } + }, + "ForecastsListResult": { + "description": "Result of listing forecasts. It contains a list of available forecasts.", + "type": "object", + "properties": { + "value": { + "description": "The list of forecasts.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Forecast" + } + } + } + }, + "ForecastProperties": { + "description": "The properties of the forecast charge.", + "type": "object", + "properties": { + "usageDate": { + "description": "The usage date of the forecast.", + "type": "string", + "readOnly": true + }, + "grain": { + "description": "The granularity of forecast.", + "type": "string", + "enum": [ + "Daily", + "Monthly", + "Yearly" + ], + "x-ms-enum": { + "name": "Grain", + "modelAsString": true + } + }, + "charge": { + "description": "The amount of charge", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "currency": { + "description": "The ISO currency in which the meter is charged, for example, USD.", + "type": "string", + "readOnly": true + }, + "chargeType": { + "description": "The type of the charge. Could be actual or forecast", + "type": "string", + "enum": [ + "Actual", + "Forecast" + ], + "x-ms-enum": { + "name": "ChargeType", + "modelAsString": true + } + }, + "confidenceLevels": { + "description": "The details about the forecast confidence levels. This is populated only when chargeType is Forecast.", + "type": "array", + "items": { + "type": "object", + "properties": { + "percentage": { + "description": "The percentage level of the confidence", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "bound": { + "description": "The boundary of the percentage, values could be 'Upper' or 'Lower'", + "type": "string", + "enum": [ + "Upper", + "Lower" + ], + "x-ms-enum": { + "name": "Bound", + "modelAsString": true + } + }, + "value": { + "description": "The amount of forecast within the percentage level", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + + "readOnly": true + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. The current version is 2018-05-31." + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "billingPeriodNameParameter": { + "name": "billingPeriodName", + "in": "path", + "description": "Billing Period Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingAccountIdParameter": { + "name": "billingAccountId", + "in": "path", + "description": "BillingAccount ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "departmentIdParameter": { + "name": "departmentId", + "in": "path", + "description": "Department ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "enrollmentAccountIdParameter": { + "name": "enrollmentAccountId", + "in": "path", + "description": "EnrollmentAccount ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/ForecastsList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/ForecastsList.json new file mode 100644 index 000000000000..e43ad70810b3 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/ForecastsList.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Consumption/forecasts/forecastId1", + "name": "forecastId1", + "type": "Microsoft.Consumption/forecasts", + "properties": { + "usageDate": "2018-04-01", + "grain": "Daily", + "charge": 752.000000, + "currency": "USD", + "chargeType": "Actual", + "confidenceLevels": null + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.Consumption/forecasts/forecastId2", + "name": "forecastId2", + "type": "Microsoft.Consumption/forecasts", + "properties": { + "usageDate": "2018-04-02", + "grain": "Daily", + "charge": 753.809074, + "currency": "USD", + "chargeType": "Forecast", + "confidenceLevels": [ + { + "percentage": 95, + "bound": "Upper", + "value": 1165.951737 + }, + { + "percentage": 95, + "bound": "Lower", + "value": 340.753404 + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/ForecastsListFilterByDates.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/ForecastsListFilterByDates.json new file mode 100644 index 000000000000..7d174d5ed402 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/ForecastsListFilterByDates.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "usagedate ge '2018-04-01' AND usagedate le '2018-04-02'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Consumption/forecasts/forecastId1", + "name": "forecastId1", + "type": "Microsoft.Consumption/forecasts", + "properties": { + "usageDate": "2018-04-01", + "grain": "Daily", + "charge": 752.000000, + "currency": "USD", + "chargeType": "Actual", + "confidenceLevels": null + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.Consumption/forecasts/forecastId2", + "name": "forecastId2", + "type": "Microsoft.Consumption/forecasts", + "properties": { + "usageDate": "2018-04-02", + "grain": "Daily", + "charge": 753.809074, + "currency": "USD", + "chargeType": "Forecast", + "confidenceLevels": [ + { + "percentage": 95, + "bound": "Upper", + "value": 1165.951737 + }, + { + "percentage": 95, + "bound": "Lower", + "value": 340.753404 + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/ForecastsListFilterByGrain.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/ForecastsListFilterByGrain.json new file mode 100644 index 000000000000..365e0142ae62 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/ForecastsListFilterByGrain.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "Grain eq 'Monthly'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Consumption/forecasts/forecastId1", + "name": "forecastId1", + "type": "Microsoft.Consumption/forecasts", + "properties": { + "usageDate": "2018-04-01", + "grain": "Monthly", + "charge": 752.000000, + "currency": "USD", + "chargeType": "Actual", + "confidenceLevels": null + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.Consumption/forecasts/forecastId2", + "name": "forecastId2", + "type": "Microsoft.Consumption/forecasts", + "properties": { + "usageDate": "2018-05-01", + "grain": "Monthly", + "charge": 753.809074, + "currency": "USD", + "chargeType": "Forecast", + "confidenceLevels": [ + { + "percentage": 95, + "bound": "Upper", + "value": 1165.951737 + }, + { + "percentage": 95, + "bound": "Lower", + "value": 340.753404 + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/PriceSheet.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/PriceSheet.json new file mode 100644 index 000000000000..c1169ac1284e --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/PriceSheet.json @@ -0,0 +1,34 @@ +{ + "parameters": + { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": + { + "200": + { + "body": + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/pricesheets/default", + "name": "default", + "type": "Microsoft.Consumption/pricesheets", + "properties": + { + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31&$skiptoken=AQAAAA%3D%3D", + "pricesheets": [ + { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "meterId": "00000000-0000-0000-0000-000000000000", + "unitOfMeasure": "100 Hours", + "includedQuantity": 100, + "partNumber": "XX-11110", + "unitPrice": 0.00328, + "currencyCode": "EUR", + "offerId":"OfferId 1" + }] + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/PriceSheetExpand.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/PriceSheetExpand.json new file mode 100644 index 000000000000..a563dc620c6e --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/PriceSheetExpand.json @@ -0,0 +1,45 @@ +{ + "parameters": + { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201801", + "$expand": "meterDetails" + }, + "responses": + { + "200": + { + "body": + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default", + "name": "default", + "type": "Microsoft.Consumption/pricesheets", + "properties": + { + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31&$skiptoken=AQAAAA%3D%3D&$expand=properties/pricesheets/meterDetails", + "pricesheets": [ + { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "meterId": "00000000-0000-0000-0000-000000000000", + "unitOfMeasure": "100 Hours", + "includedQuantity": 100, + "partNumber": "XX-11110", + "unitPrice": 0.00328, + "currencyCode": "EUR", + "offerId":"OfferId 1", + "meterDetails": + { + "meterName": "Data Transfer Out (GB)", + "meterCategory": "Networking", + "unit": "GB", + "meterLocation": "Zone 2", + "totalIncludedQuantity": 0, + "pretaxStandardRate": 0.138 + } + }] + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/PriceSheetForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/PriceSheetForBillingPeriod.json new file mode 100644 index 000000000000..abd1243f2956 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/PriceSheetForBillingPeriod.json @@ -0,0 +1,35 @@ +{ + "parameters": + { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201801" + }, + "responses": + { + "200": + { + "body": + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default", + "name": "default", + "type": "Microsoft.Consumption/pricesheets", + "properties": + { + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31", + "pricesheets": [ + { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "meterId": "00000000-0000-0000-0000-000000000000", + "unitOfMeasure": "100 Hours", + "includedQuantity": 100, + "partNumber": "XX-11110", + "unitPrice": 0.00328, + "currencyCode": "EUR", + "offerId":"OfferId 1" + }] + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsExpand.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsExpand.json new file mode 100644 index 000000000000..de19342645e7 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsExpand.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201702", + "$expand": "meterDetails,additionalProperties", + "$filter": "properties/usageEnd ge '2018-01-14' AND properties/usageEnd le '2018-02-14' AND tags eq 'dev:tools'", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": { + "meterName": "Data Transfer Out (GB)", + "meterCategory": "Networking", + "unit": "GB", + "meterLocation": "Zone 2", + "totalIncludedQuantity": 0, + "pretaxStandardRate": 0.138 + }, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Dummy subscription", + "accountName": "My account name", + "departmentName": "My department name", + "product": "My product name", + "consumedService": "My consumed service", + "costCenter": "Cost center 1", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true, + "additionalProperties": "{\"MyType\":\"\",\"ServiceType\":\"\",\"VMName\":\"\",\"UsageType\":\"MyUsage\"}" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsList.json new file mode 100644 index 000000000000..8b4dd7f52d04 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListByBillingAccount.json new file mode 100644 index 000000000000..752b763e2da5 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListByBillingAccount.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "billingAccountId": "1234" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": + "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": + "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListByDepartment.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListByDepartment.json new file mode 100644 index 000000000000..d5e80a4e38c7 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListByDepartment.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "departmentId": "1234" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": + "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": + "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListByEnrollmentAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListByEnrollmentAccount.json new file mode 100644 index 000000000000..de0875e2ad5a --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListByEnrollmentAccount.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "enrollmentAccountId": "1234" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": + "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": + "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListFilterByTag.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListFilterByTag.json new file mode 100644 index 000000000000..31099676756d --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListFilterByTag.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "tags eq 'dev:tools'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriod.json new file mode 100644 index 000000000000..295f8f7b9d0f --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriod.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriodByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriodByBillingAccount.json new file mode 100644 index 000000000000..ad8f3938018c --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriodByBillingAccount.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "billingAccountId": "1234", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriodByDepartment.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriodByDepartment.json new file mode 100644 index 000000000000..05d4b7565851 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriodByDepartment.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "departmentId": "1234", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json new file mode 100644 index 000000000000..d218b60fb815 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "enrollmentAccountId": "1234", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriodGroupByTag.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriodGroupByTag.json new file mode 100644 index 000000000000..5b7ed78249c1 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListForBillingPeriodGroupByTag.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201803", + "$apply": "groupby((tags))" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "description": "Azure VCAP STA - RDS Server" + }, + "properties": { + "billingPeriodId": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301", + "usageQuantity": 11.11111, + "pretaxCost": 0, + "currency": "USD" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "description": "Domain controller - STA" + }, + "properties": { + "billingPeriodId": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301", + "usageQuantity": 111.11111111111, + "pretaxCost": 0, + "currency": "USD" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListGroupByTagDate.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListGroupByTagDate.json new file mode 100644 index 000000000000..bf3dc5c17ff1 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-05-31/examples/UsageDetailsListGroupByTagDate.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$apply": "groupby((tags,properties/usageStart))" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "description": "Azure VCAP STA - RDS Server" + }, + "properties": { + "billingPeriodId": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301", + "usageStart": "2018-03-01T00:00:00.0000000Z", + "usageEnd": "2018-03-01T23:59:59.0000000Z", + "usageQuantity": 11.11111, + "pretaxCost": 0, + "currency": "USD" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "description": "Azure VCAP STA - RDS Server" + }, + "properties": { + "billingPeriodId": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301", + "usageStart": "2018-03-02T00:00:00.0000000Z", + "usageEnd": "2018-03-02T23:59:59.0000000Z", + "usageQuantity": 1.11111111111, + "pretaxCost": 0, + "currency": "USD" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/consumption.json new file mode 100644 index 000000000000..eaf850133b73 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/consumption.json @@ -0,0 +1,3906 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-06-30", + "title": "ConsumptionManagementClient", + "description": "Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions." + }, + "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.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_List", + "description": "Lists the usage details for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsList": { + "$ref": "./examples/UsageDetailsList.json" + }, + "UsageDetailsListFilterByTag": { + "$ref": "./examples/UsageDetailsListFilterByTag.json" + }, + "UsageDetailsListGroupByTagDate": { + "$ref": "./examples/UsageDetailsListGroupByTagDate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListByBillingPeriod", + "description": "Lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriod.json" + }, + "UsageDetailsExpand": { + "$ref": "./examples/UsageDetailsExpand.json" + }, + "UsageDetailsListForBillingPeriodGroupByTag": { + "$ref": "./examples/UsageDetailsListForBillingPeriodGroupByTag.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListByBillingAccount", + "description": "Lists the usage details by billingAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsList": { + "$ref": "./examples/UsageDetailsListByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListForBillingPeriodByBillingAccount", + "description": "Lists the usage details based on billingAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListByDepartment", + "description": "Lists the usage details by departmentId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsList": { + "$ref": "./examples/UsageDetailsListByDepartment.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/departmentIdParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListForBillingPeriodByDepartment", + "description": "Lists the usage details based on departmentId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByDepartment.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/departmentIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListByEnrollmentAccount", + "description": "Lists the usage details by enrollmentAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsList": { + "$ref": "./examples/UsageDetailsListByEnrollmentAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_ListForBillingPeriodByEnrollmentAccount", + "description": "Lists the usage details based on enrollmentAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "UsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. 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 is separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$apply", + "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsageDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "Marketplaces_List", + "description": "Lists the marketplaces for a scope by subscriptionId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesList": { + "$ref": "./examples/MarketplacesList.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "Marketplaces_ListByBillingPeriod", + "description": "Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesListForBillingPeriod.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "Marketplaces_ListByBillingAccount", + "description": "Lists the marketplaces for a scope by billingAccountId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesList": { + "$ref": "./examples/MarketplacesByBillingAccountList.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "Marketplaces_ListForBillingPeriodByBillingAccount", + "description": "Lists the marketplaces for a scope by billing period and billingAccountId. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesByBillingAccountListForBillingPeriod.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "Marketplaces_ListByDepartment", + "description": "Lists the marketplaces for a scope by departmentId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesList": { + "$ref": "./examples/MarketplacesByDepartmentList.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/departmentIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "Marketplaces_ListForBillingPeriodByDepartment", + "description": "Lists the marketplaces for a scope by billing period and departmentId. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesByDepartment_ListByBillingPeriod.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/departmentIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "Marketplaces_ListByEnrollmentAccount", + "description": "Lists the marketplaces for a scope by enrollmentAccountId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesList": { + "$ref": "./examples/MarketplacesByEnrollmentAccountList.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "Marketplaces_ListForBillingPeriodByEnrollmentAccount", + "description": "Lists the marketplaces for a scope by billing period and enrollmentAccountId. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/balances": { + "get": { + "tags": [ + "Balances" + ], + "operationId": "Balances_GetByBillingAccount", + "description": "Gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "Balances": { + "$ref": "./examples/BalancesByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Balance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/balances": { + "get": { + "tags": [ + "Balances" + ], + "operationId": "Balances_GetForBillingPeriodByBillingAccount", + "description": "Gets the balances for a scope by billing period and billingAccountId. Balances are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "Balances": { + "$ref": "./examples/BalancesByBillingAccountForBillingPeriod.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Balance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationSummaries": { + "get": { + "tags": [ + "ReservedInstances" + ], + "operationId": "ReservationsSummaries_ListByReservationOrder", + "description": "Lists the reservations summaries for daily or monthly grain.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationSummariesDaily": { + "$ref": "./examples/ReservationSummariesDaily.json" + }, + "ReservationSummariesMonthly": { + "$ref": "./examples/ReservationSummariesMonthly.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/reservationOrderIdParameter" + }, + { + "$ref": "#/parameters/grainParameter" + }, + { + "name": "$filter", + "description": "Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationSummariesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries": { + "get": { + "tags": [ + "ReservedInstances" + ], + "operationId": "ReservationsSummaries_ListByReservationOrderAndReservation", + "description": "Lists the reservations summaries for daily or monthly grain.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationSummariesDailyWithReservationId": { + "$ref": "./examples/ReservationSummariesDailyWithReservationId.json" + }, + "ReservationSummariesMonthlyWithReservationId": { + "$ref": "./examples/ReservationSummariesMonthlyWithReservationId.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/reservationOrderIdParameter" + }, + { + "$ref": "#/parameters/reservationIdParameter" + }, + { + "$ref": "#/parameters/grainParameter" + }, + { + "name": "$filter", + "description": "Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationSummariesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationDetails": { + "get": { + "tags": [ + "ReservedInstances" + ], + "operationId": "ReservationsDetails_ListByReservationOrder", + "description": "Lists the reservations details for provided date range.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationDetails": { + "$ref": "./examples/ReservationDetails.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/reservationOrderIdParameter" + }, + { + "name": "$filter", + "description": "Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationDetails": { + "get": { + "tags": [ + "ReservedInstances" + ], + "operationId": "ReservationsDetails_ListByReservationOrderAndReservation", + "description": "Lists the reservations details for provided date range.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationDetailsWithReservationId": { + "$ref": "./examples/ReservationDetailsWithReservationId.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/reservationOrderIdParameter" + }, + { + "$ref": "#/parameters/reservationIdParameter" + }, + { + "name": "$filter", + "description": "Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/reservationRecommendations": { + "get": { + "tags": [ + "ReservationRecommendations" + ], + "operationId": "ReservationRecommendations_List", + "description": "List of recomendations for purchasing reserved instances.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationRecommendations": { + "$ref": "./examples/ReservationRecommendationsList.json" + }, + "ReservationRecommendationsFilterByScopeLookBackPeriod": { + "$ref": "./examples/ReservationRecommendationsFilterByScopeLookBackPeriod.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter reservationRecommendations by properties/scope and properties/lookBackPeriod.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReservationRecommendationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/budgets": { + "get": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_List", + "description": "Lists all budgets for a subscription.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "BudgetsList": { + "$ref": "./examples/BudgetsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BudgetsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Consumption/budgets": { + "get": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_ListByResourceGroupName", + "description": "Lists all budgets for a resource group under a subscription.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "BudgetsList": { + "$ref": "./examples/BudgetsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BudgetsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/budgets/{budgetName}": { + "get": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_Get", + "description": "Gets the budget for a subscription by budget name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "Budget": { + "$ref": "./examples/Budget.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_CreateOrUpdate", + "description": "The operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "CreateOrUpdateBudget": { + "$ref": "./examples/CreateOrUpdateBudget.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Budget" + }, + "description": "Parameters supplied to the Create Budget operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_Delete", + "description": "The operation to delete a budget.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "DeleteBudget": { + "$ref": "./examples/DeleteBudget.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Consumption/budgets/{budgetName}": { + "get": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_GetByResourceGroupName", + "description": "Gets the budget for a resource group under a subscription by budget name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "Budget": { + "$ref": "./examples/Budget.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_CreateOrUpdateByResourceGroupName", + "description": "The operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "CreateOrUpdateBudget": { + "$ref": "./examples/CreateOrUpdateBudget.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Budget" + }, + "description": "Parameters supplied to the Create Budget operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_DeleteByResourceGroupName", + "description": "The operation to delete a budget.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "DeleteBudget": { + "$ref": "./examples/DeleteBudget.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/pricesheets/default": { + "get": { + "tags": [ + "PriceSheet" + ], + "operationId": "PriceSheet_Get", + "description": "Gets the price sheet for a scope by subscriptionId. Price sheet is available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "PriceSheet": { + "$ref": "./examples/PriceSheet.json" + } + }, + "parameters": [ + { + "name": "$expand", + "description": "May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the top N results.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PriceSheetResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/default": { + "get": { + "tags": [ + "PriceSheet" + ], + "operationId": "PriceSheet_GetByBillingPeriod", + "description": "Get the price sheet for a scope by subscriptionId and billing period. Price sheet is available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "PriceSheetForBillingPeriod": { + "$ref": "./examples/PriceSheetForBillingPeriod.json" + }, + "PriceSheetExpand": { + "$ref": "./examples/PriceSheetExpand.json" + } + }, + "parameters": [ + { + "name": "$expand", + "description": "May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the top N results.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PriceSheetResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/costTags": { + "get": { + "tags": [ + "CostTags" + ], + "operationId": "CostTags_Get", + "description": "Get cost tags for a billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "CostTags_Get": { + "$ref": "./examples/CostTags.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CostTag" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CostTags" + ], + "description": "The operation to create or update cost tags assiciated with a billing account. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "operationId": "CostTags_CreateOrUpdate", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "CreateOrUpdateCostTags": { + "$ref": "./examples/CreateOrUpdateCostTags.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CostTag" + }, + "description": "Parameters supplied to the Create cost tags operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CostTag" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/CostTag" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/tags": { + "get": { + "tags": [ + "Tags" + ], + "operationId": "Tags_Get", + "description": "Get all available tag keys for a billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "Tags_Get": { + "$ref": "./examples/Tags.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/TagsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/forecasts": { + "get": { + "tags": [ + "Forecasts" + ], + "x-ms-odata": "#/definitions/Forecast", + "operationId": "Forecasts_List", + "description": "Lists the forecast charges by subscriptionId.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ForecastsList": { + "$ref": "./examples/ForecastsList.json" + }, + "ForecastsListFilterByGrain": { + "$ref": "./examples/ForecastsListFilterByGrain.json" + }, + "ForecastsListFilterByDates": { + "$ref": "./examples/ForecastsListFilterByDates.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ForecastsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.Consumption/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available consumption REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "MeterDetails": { + "description": "The properties of the meter detail.", + "properties": { + "meterName": { + "description": "The name of the meter, within the given meter category", + "type": "string", + "readOnly": true + }, + "meterCategory": { + "description": "The category of the meter, for example, 'Cloud services', 'Networking', etc..", + "type": "string", + "readOnly": true + }, + "meterSubCategory": { + "description": "The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc..", + "type": "string", + "readOnly": true + }, + "unit": { + "description": "The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc.", + "type": "string", + "readOnly": true + }, + "meterLocation": { + "description": "The location in which the Azure service is available.", + "type": "string", + "readOnly": true + }, + "totalIncludedQuantity": { + "description": "The total included quantity associated with the offer.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "pretaxStandardRate": { + "description": "The pretax listing price.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "serviceName": { + "description": "The name of the service.", + "type": "string", + "readOnly": true + }, + "serviceTier": { + "description": "The service tier.", + "type": "string", + "readOnly": true + } + } + }, + "UsageDetail": { + "description": "An usage detail resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UsageDetailProperties", + "title": "Usage detail properties" + } + } + }, + "UsageDetailsListResult": { + "description": "Result of listing usage details. It contains a list of available usage details in reverse chronological order by billing period.", + "properties": { + "value": { + "description": "The list of usage details.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/UsageDetail" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "UsageDetailProperties": { + "description": "The properties of the usage detail.", + "properties": { + "billingPeriodId": { + "description": "The id of the billing period resource that the usage belongs to.", + "type": "string", + "readOnly": true + }, + "invoiceId": { + "description": "The id of the invoice resource that the usage belongs to.", + "type": "string", + "readOnly": true + }, + "usageStart": { + "description": "The start of the date time range covered by the usage detail.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "usageEnd": { + "description": "The end of the date time range covered by the usage detail.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "instanceName": { + "description": "The name of the resource instance that the usage is about.", + "type": "string", + "readOnly": true + }, + "instanceId": { + "description": "The uri of the resource instance that the usage is about.", + "type": "string", + "readOnly": true + }, + "instanceLocation": { + "description": "The location of the resource instance that the usage is about.", + "type": "string", + "readOnly": true + }, + "currency": { + "description": "The ISO currency in which the meter is charged, for example, USD.", + "type": "string", + "readOnly": true + }, + "usageQuantity": { + "description": "The quantity of usage.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "billableQuantity": { + "description": "The billable usage quantity.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "pretaxCost": { + "description": "The amount of cost before tax.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "isEstimated": { + "description": "The estimated usage is subject to change.", + "type": "boolean", + "readOnly": true + }, + "meterId": { + "description": "The meter id (GUID).", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "meterDetails": { + "description": "The details about the meter. By default this is not populated, unless it's specified in $expand.", + "$ref": "#/definitions/MeterDetails", + "readOnly": true + }, + "subscriptionGuid": { + "description": "Subscription guid.", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "subscriptionName": { + "description": "Subscription name.", + "type": "string", + "readOnly": true + }, + "accountName": { + "description": "Account name.", + "type": "string", + "readOnly": true + }, + "departmentName": { + "description": "Department name.", + "type": "string", + "readOnly": true + }, + "product": { + "description": "Product name.", + "type": "string", + "readOnly": true + }, + "consumedService": { + "description": "Consumed service name.", + "type": "string", + "readOnly": true + }, + "costCenter": { + "description": "The cost center of this department if it is a department and a costcenter exists", + "type": "string", + "readOnly": true + }, + "partNumber": { + "description": "Part Number", + "type": "string", + "readOnly": true + }, + "resourceGuid": { + "description": "Resource Guid", + "type": "string", + "readOnly": true + }, + "offerId": { + "description": "Offer Id", + "type": "string", + "readOnly": true + }, + "chargesBilledSeparately": { + "description": "Charges billed separately", + "type": "boolean", + "readOnly": true + }, + "location": { + "description": "Resource Location", + "type": "string", + "readOnly": true + }, + "additionalProperties": { + "description": "Additional details of this usage item. By default this is not populated, unless it's specified in $expand.", + "type": "string", + "readOnly": true + } + } + }, + "Marketplace": { + "description": "An marketplace resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MarketplaceProperties", + "title": "Marketplace properties" + } + } + }, + "MarketplacesListResult": { + "description": "Result of listing marketplaces. It contains a list of available marketplaces in reverse chronological order by billing period.", + "type": "object", + "properties": { + "value": { + "description": "The list of marketplaces.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Marketplace" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "MarketplaceProperties": { + "description": "The properties of the marketplace usage detail.", + "type": "object", + "properties": { + "billingPeriodId": { + "description": "The id of the billing period resource that the usage belongs to.", + "type": "string", + "readOnly": true + }, + "usageStart": { + "description": "The start of the date time range covered by the usage detail.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "usageEnd": { + "description": "The end of the date time range covered by the usage detail.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "resourceRate": { + "description": "The marketplace resource rate.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "offerName": { + "description": "The type of offer.", + "type": "string", + "readOnly": true + }, + "resourceGroup": { + "description": "The name of resource group.", + "type": "string", + "readOnly": true + }, + "orderNumber": { + "description": "The order number.", + "type": "string", + "readOnly": true + }, + "instanceName": { + "description": "The name of the resource instance that the usage is about.", + "type": "string", + "readOnly": true + }, + "instanceId": { + "description": "The uri of the resource instance that the usage is about.", + "type": "string", + "readOnly": true + }, + "currency": { + "description": "The ISO currency in which the meter is charged, for example, USD.", + "type": "string", + "readOnly": true + }, + "consumedQuantity": { + "description": "The quantity of usage.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "unitOfMeasure": { + "description": "The unit of measure.", + "type": "string", + "readOnly": true + }, + "pretaxCost": { + "description": "The amount of cost before tax.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "isEstimated": { + "description": "The estimated usage is subject to change.", + "type": "boolean", + "readOnly": true + }, + "meterId": { + "description": "The meter id (GUID).", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "subscriptionGuid": { + "description": "Subscription guid.", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "subscriptionName": { + "description": "Subscription name.", + "type": "string", + "readOnly": true + }, + "accountName": { + "description": "Account name.", + "type": "string", + "readOnly": true + }, + "departmentName": { + "description": "Department name.", + "type": "string", + "readOnly": true + }, + "consumedService": { + "description": "Consumed service name.", + "type": "string", + "readOnly": true + }, + "costCenter": { + "description": "The cost center of this department if it is a department and a costcenter exists", + "type": "string", + "readOnly": true + }, + "additionalProperties": { + "description": "Additional details of this usage item. By default this is not populated, unless it's specified in $expand.", + "type": "string", + "readOnly": true + }, + "publisherName": { + "description": "The name of publisher.", + "type": "string", + "readOnly": true + }, + "planName": { + "description": "The name of plan.", + "type": "string", + "readOnly": true + } + } + }, + "Balance": { + "description": "A balance resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BalanceProperties", + "title": "Balance properties" + } + } + }, + "BalanceProperties": { + "description": "The properties of the balance.", + "type": "object", + "properties": { + "currency": { + "description": "The ISO currency in which the meter is charged, for example, USD.", + "type": "string", + "readOnly": true + }, + "beginningBalance": { + "description": "The beginning balance for the billing period.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "endingBalance": { + "description": "The ending balance for the billing period (for open periods this will be updated daily).", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "newPurchases": { + "description": "Total new purchase amount.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "adjustments": { + "description": "Total adjustment amount.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "utilized": { + "description": "Total Commitment usage.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "serviceOverage": { + "description": "Overage for Azure services.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "chargesBilledSeparately": { + "description": "Charges Billed separately.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "totalOverage": { + "description": "serviceOverage + chargesBilledSeparately.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "totalUsage": { + "description": "Azure service commitment + total Overage.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "azureMarketplaceServiceCharges": { + "description": "Total charges for Azure Marketplace.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "billingFrequency": { + "description": "The billing frequency.", + "type": "string", + "enum": [ + "Month", + "Quarter", + "Year" + ], + "x-ms-enum": { + "name": "BillingFrequency", + "modelAsString": true + } + }, + "priceHidden": { + "description": "Price is hidden or not.", + "type": "boolean", + "readOnly": true + }, + "newPurchasesDetails": { + "description": "List of new purchases.", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "description": "the name of new purchase.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "the value of new purchase.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "readOnly": true + }, + "adjustmentDetails": { + "description": "List of Adjustments (Promo credit, SIE credit etc.).", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "description": "the name of new adjustment.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "the value of new adjustment.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "readOnly": true + } + } + }, + "ReservationSummary": { + "description": "reservation summary resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReservationSummaryProperties", + "title": "Reservation Summary properties" + } + } + }, + "ReservationSummariesListResult": { + "description": "Result of listing reservation summaries.", + "properties": { + "value": { + "description": "The list of reservation summaries.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ReservationSummary" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ReservationSummaryProperties": { + "description": "The properties of the reservation summary.", + "properties": { + "reservationOrderId": { + "description": "The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.", + "type": "string", + "readOnly": true + }, + "reservationId": { + "description": "The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.", + "type": "string", + "readOnly": true + }, + "skuName": { + "description": "This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.", + "type": "string", + "readOnly": true + }, + "reservedHours": { + "description": "This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "usageDate": { + "description": "Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "usedHours": { + "description": "Total used hours by the reservation", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "minUtilizationPercentage": { + "description": "This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "avgUtilizationPercentage": { + "description": "This is average utilization for the entire time range. (day or month depending on the grain)", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "maxUtilizationPercentage": { + "description": "This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "ReservationDetail": { + "description": "reservation detail resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReservationDetailProperties", + "title": "Reservation Detail properties" + } + } + }, + "ReservationDetailsListResult": { + "description": "Result of listing reservation details.", + "properties": { + "value": { + "description": "The list of reservation details.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ReservationDetail" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ReservationDetailProperties": { + "description": "The properties of the reservation detail.", + "properties": { + "reservationOrderId": { + "description": "The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.", + "type": "string", + "readOnly": true + }, + "reservationId": { + "description": "The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.", + "type": "string", + "readOnly": true + }, + "skuName": { + "description": "This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.", + "type": "string", + "readOnly": true + }, + "reservedHours": { + "description": "This is the total hours reserved for the day. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "usageDate": { + "description": "The date on which consumption occurred.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "usedHours": { + "description": "This is the total hours used by the instance.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "instanceId": { + "description": "This identifier is the name of the resource or the fully qualified Resource ID.", + "type": "string", + "readOnly": true + }, + "totalReservedQuantity": { + "description": "This is the total count of instances that are reserved for the reservationid.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "ReservationRecommendation": { + "description": "Reservation recommendation resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/ResourceAttributes" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReservationRecommendationProperties", + "title": "Reservation Recommendation properties" + } + } + }, + "ReservationRecommendationsListResult": { + "description": "Result of listing reservation recommendations.", + "properties": { + "value": { + "description": "The list of reservation recommendations.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ReservationRecommendation" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ReservationRecommendationProperties": { + "description": "The properties of the reservation recommendation.", + "properties": { + "lookBackPeriod": { + "description": "The number of days of usage to look back for recommendation.", + "type": "string", + "readOnly": true + }, + "meterId": { + "description": "The meter id (GUID)", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "term": { + "description": "RI recommendations in one or three year terms.", + "type": "string", + "readOnly": true + }, + "costWithNoReservedInstances": { + "description": "The total amount of cost without reserved instances.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "recommendedQuantity": { + "description": "Recomended quality for reserved instances.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "totalCostWithReservedInstances": { + "description": "The total amount of cost with reserved instances.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "netSavings": { + "description": "Total estimated savings with reserved instances.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "firstUsageDate": { + "description": "The usage date for looking back.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "scope": { + "description": "Shared or single recommendation.", + "type": "string", + "readOnly": true + } + } + }, + "TagsResult": { + "description": "A resource listing all tags.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagProperties", + "title": "Tag properties" + } + } + }, + "TagProperties": { + "description": "The properties of the tag.", + "properties": { + "tags": { + "description": "A list of Tag.", + "type": "array", + "items": { + "$ref": "#/definitions/Tag" + } + } + } + }, + "Tag": { + "description": "The tag resource.", + "properties": { + "key": { + "description": "Tag key.", + "type": "string" + } + } + }, + "BudgetsListResult": { + "description": "Result of listing budgets. It contains a list of available budgets in the scope provided.", + "properties": { + "value": { + "description": "The list of budgets.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Budget" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "Budget": { + "description": "A budget resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BudgetProperties", + "title": "Budget properties" + } + } + }, + "BudgetProperties": { + "description": "The properties of the budget.", + "properties": { + "category": { + "description": "The category of the budget, whether the budget tracks cost or usage.", + "type": "string", + "enum": [ + "Cost", + "Usage" + ], + "x-ms-enum": { + "name": "CategoryType", + "modelAsString": true + } + }, + "amount": { + "description": "The total amount of cost to track with the budget", + "type": "number", + "format": "decimal" + }, + "timeGrain": { + "description": "The time covered by a budget. Tracking of the amount will be reset based on the time grain.", + "type": "string", + "enum": [ + "Monthly", + "Quarterly", + "Annually" + ], + "x-ms-enum": { + "name": "TimeGrainType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain preiod. There are no restrictions on the end date.", + "$ref": "#/definitions/BudgetTimePeriod" + }, + "filters": { + "description": "May be used to filter budgets by resource group, resource, or meter.", + "type": "object", + "$ref": "#/definitions/Filters" + }, + "currentSpend": { + "description": "The current amount of cost which is being tracked for a budget.", + "$ref": "#/definitions/CurrentSpend", + "readOnly": true + }, + "notifications": { + "type": "object", + "description": "Dictionary of notifications associated with the budget. Budget can have up to five notifications.", + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/Notification" + }, + "maxItems": 5 + } + }, + "required": [ + "category", + "amount", + "timeGrain", + "timePeriod" + ] + }, + "BudgetTimePeriod": { + "description": "The start and end date for a budget.", + "properties": { + "startDate": { + "description": "The start date for the budget.", + "type": "string", + "format": "date-time" + }, + "endDate": { + "description": "The end date for the budget. If not provided, we default this to 10 years from the start date.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "startDate" + ] + }, + "Filters": { + "description": "May be used to filter budgets by resource group, resource, or meter.", + "properties": { + "resourceGroups": { + "description": "The list of filters on resource groups, allowed at subscription level only.", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 0, + "maxItems": 10 + }, + "resources": { + "description": "The list of filters on resources.", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 0, + "maxItems": 10 + }, + "meters": { + "description": "The list of filters on meters (GUID), mandatory for budgets of usage category. ", + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "minItems": 0, + "maxItems": 10 + }, + "tags": { + "type": "object", + "description": "The dictionary of filters on tags.", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "minItems": 0, + "maxItems": 10 + } + } + }, + "CurrentSpend": { + "description": "The current amount of cost which is being tracked for a budget.", + "properties": { + "amount": { + "description": "The total amount of cost which is being tracked by the budget.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "unit": { + "description": "The unit of measure for the budget amount.", + "type": "string", + "readOnly": true + } + } + }, + "Notification": { + "description": "The notification associated with a budget.", + "properties": { + "enabled": { + "description": "The notification is enabled or not.", + "type": "boolean" + }, + "operator": { + "description": "The comparison operator.", + "type": "string", + "enum": [ + "EqualTo", + "GreaterThan", + "GreaterThanOrEqualTo" + ], + "x-ms-enum": { + "name": "OperatorType", + "modelAsString": true + } + }, + "threshold": { + "description": "Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.", + "type": "number", + "format": "decimal" + }, + "contactEmails": { + "description": "Email addresses to send the budget notification to when the threshold is exceeded.", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1, + "maxItems": 50 + }, + "contactRoles": { + "description": "Contact roles to send the budget notification to when the threshold is exceeded.", + "type": "array", + "items": { + "type": "string" + } + }, + "contactGroups": { + "description": "Action groups to send the budget notification to when the threshold is exceeded.", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 0, + "maxItems": 50 + } + }, + "required": [ + "enabled", + "operator", + "threshold", + "contactEmails" + ] + }, + "CostTag": { + "description": "A cost tag resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CostTagsModel", + "title": "Cost tag properties" + } + } + }, + "CostTagsModel": { + "description": "The cost tag.", + "properties": { + "costTags": { + "description": "Cost tags.", + "type": "array", + "items": { + "$ref": "#/definitions/CostTagProperties" + } + } + } + }, + "CostTagProperties": { + "description": "The properties of the cost tag.", + "properties": { + "key": { + "description": "Cost tag key.", + "type": "string" + } + } + }, + "PriceSheetResult": { + "description": "An pricesheet resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PriceSheetModel", + "title": "Price sheet properties" + } + } + }, + "PriceSheetModel": { + "description": "price sheet result. It contains the pricesheet associated with billing period", + "properties": { + "pricesheets": { + "description": "Price sheet", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PriceSheetProperties" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "PriceSheetProperties": { + "description": "The properties of the price sheet.", + "properties": { + "billingPeriodId": { + "description": "The id of the billing period resource that the usage belongs to.", + "type": "string", + "readOnly": true + }, + "meterId": { + "description": "The meter id (GUID)", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "meterDetails": { + "description": "The details about the meter. By default this is not populated, unless it's specified in $expand.", + "$ref": "#/definitions/MeterDetails", + "readOnly": true + }, + "unitOfMeasure": { + "description": "Unit of measure", + "type": "string", + "readOnly": true + }, + "includedQuantity": { + "description": "Included quality for an offer", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "partNumber": { + "description": "Part Number", + "type": "string", + "readOnly": true + }, + "unitPrice": { + "description": "Unit Price", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "currencyCode": { + "description": "Currency Code", + "type": "string", + "readOnly": true + }, + "offerId": { + "description": "Offer Id", + "type": "string", + "readOnly": true + } + } + }, + "Forecast": { + "description": "A forecast resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ForecastProperties", + "title": "Forecast properties" + } + } + }, + "ForecastsListResult": { + "description": "Result of listing forecasts. It contains a list of available forecasts.", + "type": "object", + "properties": { + "value": { + "description": "The list of forecasts.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Forecast" + } + } + } + }, + "ForecastProperties": { + "description": "The properties of the forecast charge.", + "type": "object", + "properties": { + "usageDate": { + "description": "The usage date of the forecast.", + "type": "string", + "readOnly": true + }, + "grain": { + "description": "The granularity of forecast.", + "type": "string", + "enum": [ + "Daily", + "Monthly", + "Yearly" + ], + "x-ms-enum": { + "name": "Grain", + "modelAsString": true + } + }, + "charge": { + "description": "The amount of charge", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "currency": { + "description": "The ISO currency in which the meter is charged, for example, USD.", + "type": "string", + "readOnly": true + }, + "chargeType": { + "description": "The type of the charge. Could be actual or forecast", + "type": "string", + "enum": [ + "Actual", + "Forecast" + ], + "x-ms-enum": { + "name": "ChargeType", + "modelAsString": true + } + }, + "confidenceLevels": { + "description": "The details about the forecast confidence levels. This is populated only when chargeType is Forecast.", + "type": "array", + "items": { + "type": "object", + "properties": { + "percentage": { + "description": "The percentage level of the confidence", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "bound": { + "description": "The boundary of the percentage, values could be 'Upper' or 'Lower'", + "type": "string", + "enum": [ + "Upper", + "Lower" + ], + "x-ms-enum": { + "name": "Bound", + "modelAsString": true + } + }, + "value": { + "description": "The amount of forecast within the percentage level", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "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 + } + } + }, + "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" + } + } + }, + "Operation": { + "description": "A Consumption 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.Consumption.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed: UsageDetail, etc.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "OperationListResult": { + "description": "Result of listing consumption operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of consumption operations supported by the Microsoft.Consumption 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 + } + } + }, + "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." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "x-ms-azure-resource": true + }, + "ResourceAttributes": { + "description": "The Resource model definition.", + "properties": { + "location": { + "readOnly": true, + "type": "string", + "description": "Resource location" + }, + "sku": { + "readOnly": true, + "type": "string", + "description": "Resource sku" + } + } + }, + "ProxyResource": { + "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." + }, + "eTag": { + "type": "string", + "description": "eTag of the resource. To handle concurrent update scenarion, this field will be used to determine whether the user is updating the latest version or not." + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. The current version is 2018-06-30." + }, + "billingAccountIdParameter": { + "name": "billingAccountId", + "in": "path", + "description": "BillingAccount ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "departmentIdParameter": { + "name": "departmentId", + "in": "path", + "description": "Department ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "enrollmentAccountIdParameter": { + "name": "enrollmentAccountId", + "in": "path", + "description": "EnrollmentAccount ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Azure Resource Group Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "budgetNameParameter": { + "name": "budgetName", + "in": "path", + "description": "Budget Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingPeriodNameParameter": { + "name": "billingPeriodName", + "in": "path", + "description": "Billing Period Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "reservationOrderIdParameter": { + "name": "reservationOrderId", + "in": "path", + "description": "Order Id of the reservation", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "reservationIdParameter": { + "name": "reservationId", + "in": "path", + "description": "Id of the reservation", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "grainParameter": { + "name": "grain", + "description": "Can be daily or monthly", + "x-ms-parameter-location": "method", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "daily", + "monthly" + ], + "x-ms-enum": { + "name": "datagrain", + "modelAsString": true, + "values": [ + { + "value": "daily", + "description": "Daily grain of data", + "name": "DailyGrain" + }, + { + "value": "monthly", + "description": "Monthly grain of data", + "name": "MonthlyGrain" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/BalancesByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/BalancesByBillingAccount.json new file mode 100644 index 000000000000..1b0685536635 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/BalancesByBillingAccount.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "billingAccountId": "123456" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/balances/balanceId1", + "name": "balanceId1", + "type": "Microsoft.Consumption/balances", + "properties": { + "currency": "USD ", + "beginningBalance": 3396469.19, + "endingBalance": 2922371.02, + "newPurchases": 0, + "adjustments": 0, + "utilized": 474098.17, + "serviceOverage": 0, + "chargesBilledSeparately": 0, + "totalOverage": 0, + "totalUsage": 474098.17, + "azureMarketplaceServiceCharges": 609.82, + "billingFrequency": "Month", + "priceHidden": false, + "newPurchasesDetails": [ + { + "name": "Promo Purchase", + "value": 1 + } + ], + "adjustmentDetails": [ + { + "name": "Promo Credit", + "value": 1.1 + }, + { + "name": "SIE Credit", + "value": 1.0 + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/BalancesByBillingAccountForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/BalancesByBillingAccountForBillingPeriod.json new file mode 100644 index 000000000000..17bd27db06c2 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/BalancesByBillingAccountForBillingPeriod.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "billingAccountId": "123456", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/balances/balanceId1", + "name": "balanceId1", + "type": "Microsoft.Consumption/balances", + "properties": { + "currency": "USD ", + "beginningBalance": 3396469.19, + "endingBalance": 2922371.02, + "newPurchases": 0, + "adjustments": 0, + "utilized": 474098.17, + "serviceOverage": 0, + "chargesBilledSeparately": 0, + "totalOverage": 0, + "totalUsage": 474098.17, + "azureMarketplaceServiceCharges": 609.82, + "billingFrequency": "Month", + "priceHidden": false, + "newPurchasesDetails": [ + { + "name": "Promo Purchase", + "value": 1 + } + ], + "adjustmentDetails": [ + { + "name": "Promo Credit", + "value": 1.1 + }, + { + "name": "SIE Credit", + "value": 1.0 + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/Budget.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/Budget.json new file mode 100644 index 000000000000..a1d05d081d63 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/Budget.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "budgetName": "TestBudget" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.Consumption/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2017-10-01T00:00:00Z", + "endDate": "2018-10-31T00:00:00Z" + }, + "filters": { + "resourceGroups": [ + "MPDEVTESTRG" + ], + "resources": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ], + "meters": [ + "00000000-0000-0000-0000-000000000000" + ], + "tags": { + "category": [ + "Dev", + "Prod" + ], + "department": [ + "engineering", + "sales" + ] + } + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ] + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/BudgetsList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/BudgetsList.json new file mode 100644 index 000000000000..8ac06213049f --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/BudgetsList.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.Consumption/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2017-10-01T00:00:00Z", + "endDate": "2018-10-31T00:00:00Z" + }, + "filters": { + "resourceGroups": [ + "MYDEVTESTRG" + ], + "resources": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MYVM2", + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ], + "meters": [ + "00000000-0000-0000-0000-000000000000" + ], + "tags": { + "category": [ + "Dev", + "Prod" + ], + "department": [ + "engineering", + "sales" + ] + } + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_90_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 90, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ] + } + } + } + }, + { + "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.Consumption/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 600.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2017-10-01T00:00:00Z", + "endDate": "2018-10-31T00:00:00Z" + }, + "filters": { + "resourceGroups": [ + "MYDEVTESTRG" + ], + "resources": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MYVM2", + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ], + "meters": [ + "00000000-0000-0000-0000-000000000000" + ], + "tags": { + "category": [ + "Dev", + "Prod" + ], + "department": [ + "engineering", + "sales" + ] + } + }, + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_40_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 40, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ] + } + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/CostTags.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/CostTags.json new file mode 100644 index 000000000000..98f4f6a5049e --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/CostTags.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "billingAccountId": "12345" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/{billingaccount-id}/providers/Microsoft.Consumption/costTags/costTags1", + "name": "costTags1", + "type": "Microsoft.Consumption/costTags", + "eTag": "\"1d34d012214157f\"", + "properties": { + "costTags": [ + { + "key": "Department" + }, + { + "key": "CostCenter" + }, + { + "key": "Portal" + }, + { + "key": "OrgName" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/CreateOrUpdateBudget.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/CreateOrUpdateBudget.json new file mode 100644 index 000000000000..947aaadf56e7 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/CreateOrUpdateBudget.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "budgetName": "TestBudget", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2017-10-01T00:00:00Z", + "endDate": "2018-10-31T00:00:00Z" + }, + "filters": { + "resourceGroups": [ + "MYDEVTESTRG" + ], + "resources": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MYVM2", + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ], + "meters": [ + "00000000-0000-0000-0000-000000000000" + ], + "tags": { + "category": [ + "Dev", + "Prod" + ], + "department": [ + "engineering", + "sales" + ] + } + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.Consumption/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2017-10-01T00:00:00Z", + "endDate": "2018-10-31T00:00:00Z" + }, + "filters": { + "resourceGroups": [ + "MPDEVTESTRG" + ], + "resources": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MYVM2", + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ], + "meters": [ + "00000000-0000-0000-0000-000000000000" + ], + "tags": { + "category": [ + "Dev", + "Prod" + ], + "department": [ + "engineering", + "sales" + ] + } + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.Consumption/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2017-10-01T00:00:00Z", + "endDate": "2018-10-31T00:00:00Z" + }, + "filters": { + "resourceGroups": [ + "MPDEVTESTRG" + ], + "resources": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MYVM2", + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ], + "meters": [ + "00000000-0000-0000-0000-000000000000" + ], + "tags": { + "category": [ + "Dev", + "Prod" + ], + "department": [ + "engineering", + "sales" + ] + } + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ] + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/CreateOrUpdateCostTags.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/CreateOrUpdateCostTags.json new file mode 100644 index 000000000000..0f2ba3434d5a --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/CreateOrUpdateCostTags.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "billingAccountId": "12345", + "parameters": { + "costTags": [ + { + "key": "Department" + }, + { + "key": "CostCenter" + }, + { + "key": "Portal" + }, + { + "key": "OrgName" + } + ] + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/{billingaccount-id}/providers/Microsoft.Consumption/costTags/costTags1", + "name": "costTags1", + "type": "Microsoft.Consumption/costTags", + "eTag": "\"1d34d012214157f\"", + "properties": { + "costTags": [ + { + "key": "Department" + }, + { + "key": "CostCenter" + }, + { + "key": "Portal" + }, + { + "key": "OrgName" + } + ] + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/{billingaccount-id}/providers/Microsoft.Consumption/costTags/costTags1", + "name": "costTags1", + "type": "Microsoft.Consumption/costTags", + "eTag": "\"1d34d012214157f\"", + "properties": { + "costTags": [ + { + "key": "Department" + }, + { + "key": "CostCenter" + }, + { + "key": "Portal" + }, + { + "key": "OrgName" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/DeleteBudget.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/DeleteBudget.json new file mode 100644 index 000000000000..d77e16b29e22 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/DeleteBudget.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "budgetName": "TestBudget" + }, + "responses": { + "200": { + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ForecastsList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ForecastsList.json new file mode 100644 index 000000000000..e43ad70810b3 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ForecastsList.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Consumption/forecasts/forecastId1", + "name": "forecastId1", + "type": "Microsoft.Consumption/forecasts", + "properties": { + "usageDate": "2018-04-01", + "grain": "Daily", + "charge": 752.000000, + "currency": "USD", + "chargeType": "Actual", + "confidenceLevels": null + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.Consumption/forecasts/forecastId2", + "name": "forecastId2", + "type": "Microsoft.Consumption/forecasts", + "properties": { + "usageDate": "2018-04-02", + "grain": "Daily", + "charge": 753.809074, + "currency": "USD", + "chargeType": "Forecast", + "confidenceLevels": [ + { + "percentage": 95, + "bound": "Upper", + "value": 1165.951737 + }, + { + "percentage": 95, + "bound": "Lower", + "value": 340.753404 + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ForecastsListFilterByDates.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ForecastsListFilterByDates.json new file mode 100644 index 000000000000..7d174d5ed402 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ForecastsListFilterByDates.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "usagedate ge '2018-04-01' AND usagedate le '2018-04-02'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Consumption/forecasts/forecastId1", + "name": "forecastId1", + "type": "Microsoft.Consumption/forecasts", + "properties": { + "usageDate": "2018-04-01", + "grain": "Daily", + "charge": 752.000000, + "currency": "USD", + "chargeType": "Actual", + "confidenceLevels": null + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.Consumption/forecasts/forecastId2", + "name": "forecastId2", + "type": "Microsoft.Consumption/forecasts", + "properties": { + "usageDate": "2018-04-02", + "grain": "Daily", + "charge": 753.809074, + "currency": "USD", + "chargeType": "Forecast", + "confidenceLevels": [ + { + "percentage": 95, + "bound": "Upper", + "value": 1165.951737 + }, + { + "percentage": 95, + "bound": "Lower", + "value": 340.753404 + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ForecastsListFilterByGrain.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ForecastsListFilterByGrain.json new file mode 100644 index 000000000000..365e0142ae62 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ForecastsListFilterByGrain.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "Grain eq 'Monthly'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Consumption/forecasts/forecastId1", + "name": "forecastId1", + "type": "Microsoft.Consumption/forecasts", + "properties": { + "usageDate": "2018-04-01", + "grain": "Monthly", + "charge": 752.000000, + "currency": "USD", + "chargeType": "Actual", + "confidenceLevels": null + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.Consumption/forecasts/forecastId2", + "name": "forecastId2", + "type": "Microsoft.Consumption/forecasts", + "properties": { + "usageDate": "2018-05-01", + "grain": "Monthly", + "charge": 753.809074, + "currency": "USD", + "chargeType": "Forecast", + "confidenceLevels": [ + { + "percentage": 95, + "bound": "Upper", + "value": 1165.951737 + }, + { + "percentage": 95, + "bound": "Lower", + "value": 340.753404 + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByBillingAccountList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByBillingAccountList.json new file mode 100644 index 000000000000..b60ba36633e1 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByBillingAccountList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "billingAccountId": "123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplaceId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan1", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByBillingAccountListForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByBillingAccountListForBillingPeriod.json new file mode 100644 index 000000000000..8c2b63872908 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByBillingAccountListForBillingPeriod.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "billingAccountId": "123456", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByDepartmentList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByDepartmentList.json new file mode 100644 index 000000000000..9dfa9f192e55 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByDepartmentList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "departmentId": "123456", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByDepartment_ListByBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByDepartment_ListByBillingPeriod.json new file mode 100644 index 000000000000..46459faae17d --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByDepartment_ListByBillingPeriod.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "departmentId": "123456", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/departments/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByEnrollmentAccountList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByEnrollmentAccountList.json new file mode 100644 index 000000000000..9bceabcbec8a --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByEnrollmentAccountList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "enrollmentAccountId": "123456", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json new file mode 100644 index 000000000000..5007be230830 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "enrollmentAccountId": "123456", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/enrollmentAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesList.json new file mode 100644 index 000000000000..8c10effe6f71 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Consumption/marketPlaces/marketplaceId1", + "name": "marketplaceId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan1", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesListForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesListForBillingPeriod.json new file mode 100644 index 000000000000..3550e9657336 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/MarketplacesListForBillingPeriod.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201801" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketPlaces/marketplacesId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/subid/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/PriceSheet.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/PriceSheet.json new file mode 100644 index 000000000000..c1169ac1284e --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/PriceSheet.json @@ -0,0 +1,34 @@ +{ + "parameters": + { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": + { + "200": + { + "body": + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/pricesheets/default", + "name": "default", + "type": "Microsoft.Consumption/pricesheets", + "properties": + { + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31&$skiptoken=AQAAAA%3D%3D", + "pricesheets": [ + { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "meterId": "00000000-0000-0000-0000-000000000000", + "unitOfMeasure": "100 Hours", + "includedQuantity": 100, + "partNumber": "XX-11110", + "unitPrice": 0.00328, + "currencyCode": "EUR", + "offerId":"OfferId 1" + }] + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/PriceSheetExpand.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/PriceSheetExpand.json new file mode 100644 index 000000000000..a563dc620c6e --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/PriceSheetExpand.json @@ -0,0 +1,45 @@ +{ + "parameters": + { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201801", + "$expand": "meterDetails" + }, + "responses": + { + "200": + { + "body": + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default", + "name": "default", + "type": "Microsoft.Consumption/pricesheets", + "properties": + { + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31&$skiptoken=AQAAAA%3D%3D&$expand=properties/pricesheets/meterDetails", + "pricesheets": [ + { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "meterId": "00000000-0000-0000-0000-000000000000", + "unitOfMeasure": "100 Hours", + "includedQuantity": 100, + "partNumber": "XX-11110", + "unitPrice": 0.00328, + "currencyCode": "EUR", + "offerId":"OfferId 1", + "meterDetails": + { + "meterName": "Data Transfer Out (GB)", + "meterCategory": "Networking", + "unit": "GB", + "meterLocation": "Zone 2", + "totalIncludedQuantity": 0, + "pretaxStandardRate": 0.138 + } + }] + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/PriceSheetForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/PriceSheetForBillingPeriod.json new file mode 100644 index 000000000000..abd1243f2956 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/PriceSheetForBillingPeriod.json @@ -0,0 +1,35 @@ +{ + "parameters": + { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201801" + }, + "responses": + { + "200": + { + "body": + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default", + "name": "default", + "type": "Microsoft.Consumption/pricesheets", + "properties": + { + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31", + "pricesheets": [ + { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "meterId": "00000000-0000-0000-0000-000000000000", + "unitOfMeasure": "100 Hours", + "includedQuantity": 100, + "partNumber": "XX-11110", + "unitPrice": 0.00328, + "currencyCode": "EUR", + "offerId":"OfferId 1" + }] + } + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationDetails.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationDetails.json new file mode 100644 index 000000000000..c5a3460cd183 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationDetails.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "$filter": "properties/usageDate ge '2017-10-01' AND properties/usageDate le '2017-12-05'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationDetails/20171129", + "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171129", + "type": "Microsoft.Consumption/reservationDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "usageDate": "2017-11-29T00:00:00Z", + "skuName": "Standard_D2_v2", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/wvn-sql/providers/microsoft.compute/virtualmachines/abc-sql2014sp33", + "totalReservedQuantity": 1.000000000000000, + "reservedHours": 24.000000000000000, + "usedHours": 24.000000000000000 + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationDetailsWithReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationDetailsWithReservationId.json new file mode 100644 index 000000000000..67ce88344331 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationDetailsWithReservationId.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "$filter": "properties/usageDate ge '2017-10-01' AND properties/usageDate le '2017-12-05'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationDetails/20171129", + "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171129", + "type": "Microsoft.Consumption/reservationDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "usageDate": "2017-11-29T00:00:00Z", + "skuName": "Standard_D2_v2", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/wvn-sql/providers/microsoft.compute/virtualmachines/wvn-sql2014sp33", + "totalReservedQuantity": 1.000000000000000, + "reservedHours": 24.000000000000000, + "usedHours": 24.000000000000000 + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationRecommendationsFilterByScopeLookBackPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationRecommendationsFilterByScopeLookBackPeriod.json new file mode 100644 index 000000000000..a8785dded1d4 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationRecommendationsFilterByScopeLookBackPeriod.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "properties/scope eq 'Single' AND properties/lookBackPeriod eq 'Last7Days'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations1", + "name": "reservationRecommendations1", + "type": "Microsoft.Consumption/reservationRecommendations", + "sku": "Standard_DS1_v2", + "location": "northeurope", + "properties": { + "lookBackPeriod": "Last7Days", + "meterId": "00000000-0000-0000-0000-000000000000", + "term": "P1Y", + "costWithNoReservedInstances": 0.0, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 0.0, + "netSavings": 4.634521202630137, + "firstUsageDate": "2018-03-06T00:00:00Z", + "scope": "Single" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations2", + "name": "reservationRecommendations2", + "type": "Microsoft.Consumption/reservationRecommendations", + "sku": "Standard_DS1_v2", + "location": "northeurope", + "properties": { + "lookBackPeriod": "Last7Days", + "meterId": "00000000-0000-0000-0000-000000000000", + "term": "P3Y", + "costWithNoReservedInstances": 0.0, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 0.0, + "netSavings": 7.2893157231780812, + "firstUsageDate": "2018-03-06T00:00:00Z", + "scope": "Single" + } + } + ], + "nextLink" : "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations?api-version=2018-03-31&$filter=properties/scope+eq+'Single'+AND+properties/lookBackPeriod+eq+'Last7Days'&$skiptoken=AQAAAA%3D%3D&" + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationRecommendationsList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationRecommendationsList.json new file mode 100644 index 000000000000..21237a8ac071 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationRecommendationsList.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations1", + "name": "reservationRecommendations1", + "type": "Microsoft.Consumption/reservationRecommendations", + "sku": "Standard_DS1_v2", + "location": "northeurope", + "properties": { + "lookBackPeriod": "Last7Days", + "meterId": "00000000-0000-0000-0000-000000000000", + "term": "P1Y", + "costWithNoReservedInstances": 0.0, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 0.0, + "netSavings": 4.634521202630137, + "firstUsageDate": "2018-03-06T00:00:00Z", + "scope": "Single" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations2", + "name": "reservationRecommendations2", + "type": "Microsoft.Consumption/reservationRecommendations", + "sku": "Standard_DS1_v2", + "location": "northeurope", + "properties": { + "lookBackPeriod": "Last7Days", + "meterId": "00000000-0000-0000-0000-000000000000", + "term": "P3Y", + "costWithNoReservedInstances": 0.0, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 0.0, + "netSavings": 7.2893157231780812, + "firstUsageDate": "2018-03-06T00:00:00Z", + "scope": "Single" + } + } + ], + "nextLink" : "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationRecommendations?api-version=2018-03-31&$skiptoken=AQAAAA%3D%3D&" + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationSummariesDaily.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationSummariesDaily.json new file mode 100644 index 000000000000..108f4de1d686 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationSummariesDaily.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "grain":"daily", + "$filter": "properties/usageDate ge '2017-10-01' AND properties/usageDate le '2017-11-20'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001", + "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001", + "type": "Microsoft.Consumption/reservationsummaries", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "skuName": "Standard_D8s_v3", + "reservedHours": 0.0, + "usageDate": "2017-10-01T00:00:00Z", + "usedHours": 0.0, + "minUtilizationPercentage": 0.0, + "avgUtilizationPercentage": 0.0, + "maxUtilizationPercentage": 0.0 + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationSummariesDailyWithReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationSummariesDailyWithReservationId.json new file mode 100644 index 000000000000..29d5d9195bbf --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationSummariesDailyWithReservationId.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "grain":"daily", + "$filter": "properties/usageDate ge '2017-10-01' AND properties/usageDate le '2017-11-20'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001", + "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001", + "type": "Microsoft.Consumption/reservationsummaries", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "skuName": "Standard_D8s_v3", + "reservedHours": 0.0, + "usageDate": "2017-10-01T00:00:00Z", + "usedHours": 0.0, + "minUtilizationPercentage": 0.0, + "avgUtilizationPercentage": 0.0, + "maxUtilizationPercentage": 0.0 + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationSummariesMonthly.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationSummariesMonthly.json new file mode 100644 index 000000000000..9a6e028b6b6b --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationSummariesMonthly.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "grain":"monthly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001", + "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001", + "type": "Microsoft.Consumption/reservationsummaries", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "skuName": "Standard_D8s_v3", + "reservedHours": 0.0, + "usageDate": "2017-10-01T00:00:00Z", + "usedHours": 0.0, + "minUtilizationPercentage": 0.0, + "avgUtilizationPercentage": 0.0, + "maxUtilizationPercentage": 0.0 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationSummariesMonthlyWithReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationSummariesMonthlyWithReservationId.json new file mode 100644 index 000000000000..63446aec57d4 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/ReservationSummariesMonthlyWithReservationId.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "grain":"monthly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Capacity/reservationOrders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/reservationSummaries/20171001", + "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000_20171001", + "type": "Microsoft.Consumption/reservationsummaries", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "skuName": "Standard_D8s_v3", + "reservedHours": 0.0, + "usageDate": "2017-10-01T00:00:00Z", + "usedHours": 0.0, + "minUtilizationPercentage": 0.0, + "avgUtilizationPercentage": 0.0, + "maxUtilizationPercentage": 0.0 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/Tags.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/Tags.json new file mode 100644 index 000000000000..ab3c184142be --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/Tags.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "billingAccountId": "12345" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/billingAccounts/{billingaccount-id}/providers/Microsoft.Consumption/tags/tags1", + "name": "tags1", + "type": "Microsoft.Consumption/tags", + "eTag": "\"1d34d012214157f\"", + "properties": { + "tags": [ + { + "key": "Department" + }, + { + "key": "CostCenter" + }, + { + "key": "Portal" + }, + { + "key": "OrgName" + }, + { + "key": "Namespace" + }, + { + "key": "resourceType" + }, + { + "key": "Subsystem" + }, + { + "key": "Environment" + }, + { + "key": "clusterName" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsExpand.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsExpand.json new file mode 100644 index 000000000000..800e34a0a651 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsExpand.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2018-06-30", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201702", + "$expand": "meterDetails,additionalProperties", + "$filter": "properties/usageEnd ge '2018-01-14' AND properties/usageEnd le '2018-02-14' AND tags eq 'dev:tools'", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "meterDetails": { + "meterName": "Data Transfer Out (GB)", + "meterCategory": "Networking", + "unit": "GB", + "meterLocation": "Zone 2", + "totalIncludedQuantity": 0, + "pretaxStandardRate": 0.138, + "serviceName":"Bandwidth", + "serviceTier":"Bandwidth - Outbound Data Transfer" + }, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "Dummy subscription", + "accountName": "My account name", + "departmentName": "My department name", + "product": "My product name", + "consumedService": "My consumed service", + "costCenter": "Cost center 1", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true, + "location":"EU West", + "additionalProperties": "{\"MyType\":\"\",\"ServiceType\":\"\",\"VMName\":\"\",\"UsageType\":\"MyUsage\"}" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsList.json new file mode 100644 index 000000000000..539ae37fa7d4 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsList.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2018-06-30", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true, + "location":"EU West" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListByBillingAccount.json new file mode 100644 index 000000000000..7c375e2b794b --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListByBillingAccount.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-06-30", + "billingAccountId": "1234" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": + "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": + "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true, + "location":"EU West" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListByDepartment.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListByDepartment.json new file mode 100644 index 000000000000..baac9c7005bc --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListByDepartment.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-06-30", + "departmentId": "1234" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": + "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": + "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true, + "location":"EU West" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListByEnrollmentAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListByEnrollmentAccount.json new file mode 100644 index 000000000000..5f729293c802 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListByEnrollmentAccount.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-06-30", + "enrollmentAccountId": "1234" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": + "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": + "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true, + "location":"EU West" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListFilterByTag.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListFilterByTag.json new file mode 100644 index 000000000000..9d7000d0cc70 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListFilterByTag.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2018-06-30", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "tags eq 'dev:tools'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true, + "location":"EU West" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriod.json new file mode 100644 index 000000000000..e3481c0a1ead --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriod.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-06-30", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true, + "location":"EU West" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriodByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriodByBillingAccount.json new file mode 100644 index 000000000000..c98250ce1280 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriodByBillingAccount.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-06-30", + "billingAccountId": "1234", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true, + "location":"EU West" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriodByDepartment.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriodByDepartment.json new file mode 100644 index 000000000000..df3c1e5e8f59 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriodByDepartment.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-06-30", + "departmentId": "1234", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true, + "location":"EU West" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json new file mode 100644 index 000000000000..7dbbc483efd4 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-06-30", + "enrollmentAccountId": "1234", + "billingPeriodName": "201702" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/billingPeriods/201702", + "invoiceId": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/invoices/201703-123456789", + "usageStart": "2017-02-13T00:00:00Z", + "usageEnd": "2017-02-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00328, + "billableQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "partNumber":"Part Number 1", + "resourceGuid":"00000000-0000-0000-0000-000000000000", + "offerId":"Offer Id 1", + "chargesBilledSeparately":true, + "location":"EU West" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriodGroupByTag.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriodGroupByTag.json new file mode 100644 index 000000000000..5b7ed78249c1 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListForBillingPeriodGroupByTag.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "billingPeriodName": "201803", + "$apply": "groupby((tags))" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "description": "Azure VCAP STA - RDS Server" + }, + "properties": { + "billingPeriodId": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301", + "usageQuantity": 11.11111, + "pretaxCost": 0, + "currency": "USD" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "description": "Domain controller - STA" + }, + "properties": { + "billingPeriodId": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301", + "usageQuantity": 111.11111111111, + "pretaxCost": 0, + "currency": "USD" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListGroupByTagDate.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListGroupByTagDate.json new file mode 100644 index 000000000000..bf3dc5c17ff1 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/examples/UsageDetailsListGroupByTagDate.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$apply": "groupby((tags,properties/usageStart))" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "description": "Azure VCAP STA - RDS Server" + }, + "properties": { + "billingPeriodId": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301", + "usageStart": "2018-03-01T00:00:00.0000000Z", + "usageEnd": "2018-03-01T23:59:59.0000000Z", + "usageQuantity": 11.11111, + "pretaxCost": 0, + "currency": "USD" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "description": "Azure VCAP STA - RDS Server" + }, + "properties": { + "billingPeriodId": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180301", + "usageStart": "2018-03-02T00:00:00.0000000Z", + "usageEnd": "2018-03-02T23:59:59.0000000Z", + "usageQuantity": 1.11111111111, + "pretaxCost": 0, + "currency": "USD" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/readme.md b/specification/consumption/resource-manager/readme.md index 547076ecd96d..22498694896e 100644 --- a/specification/consumption/resource-manager/readme.md +++ b/specification/consumption/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the Consumption API. ``` yaml openapi-type: arm -tag: package-2018-03 +tag: package-2018-06 ``` ### Tag: package-2017-11 @@ -58,6 +58,26 @@ input-file: - Microsoft.Consumption/stable/2018-03-31/consumption.json ``` +--- +### Tag: package-2018-05 + +These settings apply only when `--tag=package-2018-05` is specified on the command line. + +``` yaml $(tag) == 'package-2018-05' +input-file: +- Microsoft.Consumption/stable/2018-05-31/consumption.json +``` + +--- +### Tag: package-2018-06 + +These settings apply only when `--tag=package-2018-06` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06' +input-file: +- Microsoft.Consumption/stable/2018-06-30/consumption.json +``` + ## Suppression ``` yaml directive: @@ -101,6 +121,9 @@ swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_consumption'] ``` @@ -166,6 +189,8 @@ batch: - tag: package-2017-12-preview - tag: package-2018-01 - tag: package-2018-03 + - tag: package-2018-05 + - tag: package-2018-06 ``` @@ -175,7 +200,7 @@ These settings apply only when `--tag=package-2017-04-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-04-preview' && $(go) -output-folder: $(go-sdk-folder)/services/consumption/mgmt/2017-04-24-preview/consumption +output-folder: $(go-sdk-folder)/services/preview/consumption/mgmt/2017-04-24-preview/consumption ``` ### Tag: package-2017-11 and go @@ -191,7 +216,7 @@ These settings apply only when `--tag=package-2017-12-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-12-preview' && $(go) -output-folder: $(go-sdk-folder)/services/consumption/mgmt/2017-12-30-preview/consumption +output-folder: $(go-sdk-folder)/services/preview/consumption/mgmt/2017-12-30-preview/consumption ``` ### Tag: package-2018-01 and go @@ -210,17 +235,138 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-05' && $(go) +output-folder: $(go-sdk-folder)/services/consumption/mgmt/2018-05-31/consumption +``` + +### Tag: package-2018-06 and go +These settings apply only when `--tag=package-2018-06 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-06' && $(go) +output-folder: $(go-sdk-folder)/services/consumption/mgmt/2018-06-30/consumption +``` + ## Java These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.consumption +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-consumption +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-04-preview + - tag: package-2017-11 + - tag: package-2018-01 + - tag: package-2018-03 + - tag: package-2017-12-preview + - tag: package-2018-05 + - tag: package-2018-06 +``` + +### Tag: package-2017-04-preview and java + +These settings apply only when `--tag=package-2017-04-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.consumption - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-consumption -``` \ No newline at end of file + namespace: com.microsoft.azure.management.consumption.v2017_04_24_preview + output-folder: $(azure-libraries-for-java-folder)/consumption/resource-manager/v2017_04_24_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-11 and java + +These settings apply only when `--tag=package-2017-11 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-11' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.consumption.v2017_11_30 + output-folder: $(azure-libraries-for-java-folder)/consumption/resource-manager/v2017_11_30 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-01 and java + +These settings apply only when `--tag=package-2018-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.consumption.v2018_01_31 + output-folder: $(azure-libraries-for-java-folder)/consumption/resource-manager/v2018_01_31 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-03 and java + +These settings apply only when `--tag=package-2018-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.consumption.v2018_03_31 + output-folder: $(azure-libraries-for-java-folder)/consumption/resource-manager/v2018_03_31 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-12-preview and java + +These settings apply only when `--tag=package-2017-12-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-12-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.consumption.v2017_12_30_preview + output-folder: $(azure-libraries-for-java-folder)/consumption/resource-manager/v2017_12_30_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-05 and java + +These settings apply only when `--tag=package-2018-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.consumption.v2018_05_31 + output-folder: $(azure-libraries-for-java-folder)/consumption/resource-manager/v2018_05_31 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-06 and java + +These settings apply only when `--tag=package-2018-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.consumption.v2018_06_30 + output-folder: $(azure-libraries-for-java-folder)/consumption/resource-manager/v2018_06_30 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/consumption/resource-manager/readme.ruby.md b/specification/consumption/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..802d572a2438 --- /dev/null +++ b/specification/consumption/resource-manager/readme.ruby.md @@ -0,0 +1,59 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_consumption +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-01 + - tag: package-2017-12-preview + - tag: package-2017-11 + - tag: package-2017-04-preview +``` + +### Tag: package-2018-01 and ruby + +These settings apply only when `--tag=package-2018-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-01' && $(ruby) +namespace: "Azure::Consumption::Mgmt::V2018_01_31" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_consumption/lib +``` + +### Tag: package-2017-12-preview and ruby + +These settings apply only when `--tag=package-2017-12-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-12-preview' && $(ruby) +namespace: "Azure::Consumption::Mgmt::V2017_12_30_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_consumption/lib +``` + +### Tag: package-2017-11 and ruby + +These settings apply only when `--tag=package-2017-11 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-11' && $(ruby) +namespace: "Azure::Consumption::Mgmt::V2017_11_30" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_consumption/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. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-04-preview' && $(ruby) +namespace: "Azure::Consumption::Mgmt::V2017_04_24_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_consumption/lib +``` diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/containerInstance.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/containerInstance.json new file mode 100644 index 000000000000..5f3b86bffe07 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/containerInstance.json @@ -0,0 +1,1355 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-06-01", + "title": "ContainerInstanceManagementClient" + }, + "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.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_List", + "x-ms-examples": { + "ContainerGroupsList": { + "$ref": "./examples/ContainerGroupsList.json" + } + }, + "summary": "Get a list of container groups in the specified subscription.", + "description": "Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_ListByResourceGroup", + "x-ms-examples": { + "ContainerGroupsListByResourceGroup": { + "$ref": "./examples/ContainerGroupsListByResourceGroup.json" + } + }, + "summary": "Get a list of container groups in the specified subscription and resource group.", + "description": "Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}": { + "get": { + "operationId": "ContainerGroups_Get", + "x-ms-examples": { + "ContainerGroupsGet_Succeeded": { + "$ref": "./examples/ContainerGroupsGet_Succeeded.json" + }, + "ContainerGroupsGet_Failed": { + "$ref": "./examples/ContainerGroupsGet_Failed.json" + } + }, + "summary": "Get the properties of the specified container group.", + "description": "Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + } + } + }, + "put": { + "operationId": "ContainerGroups_CreateOrUpdate", + "x-ms-examples": { + "ContainerGroupsCreateOrUpdate": { + "$ref": "./examples/ContainerGroupsCreateOrUpdate.json" + } + }, + "summary": "Create or update container groups.", + "description": "Create or update container groups with specified configurations.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerGroup", + "description": "The properties of the container group to be created or updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "201": { + "description": "Created - the container group is created.", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ContainerGroups_Update", + "x-ms-examples": { + "ContainerGroupsUpdate": { + "$ref": "./examples/ContainerGroupsUpdate.json" + } + }, + "summary": "Update container groups.", + "description": "Updates container group tags with specified values.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "Resource", + "description": "The container group resource with just the tags to be updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/Resource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + } + } + }, + "delete": { + "operationId": "ContainerGroups_Delete", + "x-ms-examples": { + "ContainerGroupsDelete": { + "$ref": "./examples/ContainerGroupsDelete.json" + } + }, + "summary": "Delete the specified container group.", + "description": "Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "204": { + "description": "No Content - the specified container group was not found." + } + } + } + }, + "/providers/Microsoft.ContainerInstance/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "description": "List the operations for Azure Container Instance service.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/usages": { + "get": { + "operationId": "ContainerGroupUsage_List", + "x-ms-examples": { + "ContainerUsage": { + "$ref": "./examples/ContainerGroupUsage.json" + } + }, + "description": "Get the usage for a subscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs": { + "get": { + "operationId": "Container_ListLogs", + "x-ms-examples": { + "ContainerListLogs": { + "$ref": "./examples/ContainerListLogs.json" + } + }, + "summary": "Get the logs for a specified container instance.", + "description": "Get the logs for a specified container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "tail", + "in": "query", + "description": "The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb.", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Logs" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec": { + "post": { + "operationId": "Container_ExecuteCommand", + "x-ms-examples": { + "ContainerExec": { + "$ref": "./examples/ContainerExec.json" + } + }, + "summary": "Executes a command in a specific container instance.", + "description": "Executes a command for a specific container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name":"containerExecRequest", + "in":"body", + "description":"The request for the exec command.", + "required":true, + "schema":{ + "$ref":"#/definitions/ContainerExecRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerExecResponse" + } + } + } + } + } + }, + "definitions": { + "Container": { + "description": "A container instance.", + "type": "object", + "required": [ + "properties", + "name" + ], + "properties": { + "name": { + "description": "The user-provided name of the container instance.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the container instance.", + "$ref": "#/definitions/ContainerProperties" + } + } + }, + "ContainerProperties": { + "description": "The container instance properties.", + "type": "object", + "required": [ + "image", + "resources" + ], + "properties": { + "image": { + "description": "The name of the image used to create the container instance.", + "type": "string" + }, + "command": { + "description": "The commands to execute within the container instance in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "ports": { + "description": "The exposed ports on the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerPort" + } + }, + "environmentVariables": { + "description": "The environment variables to set in the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + } + }, + "instanceView": { + "description": "The instance view of the container instance. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "description": "The number of times that the container instance has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "Current container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "Previous container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + } + } + } + }, + "resources": { + "description": "The resource requirements of the container instance.", + "$ref": "#/definitions/ResourceRequirements" + }, + "volumeMounts": { + "description": "The volume mounts available to the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + } + }, + "livenessProbe": { + "description": "The liveness probe.", + "$ref": "#/definitions/ContainerProbe" + }, + "readinessProbe": { + "description": "The readiness probe.", + "$ref": "#/definitions/ContainerProbe" + } + } + }, + "ContainerState": { + "description": "The container instance state.", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "The state of the container instance." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The date-time when the container instance state started." + }, + "exitCode": { + "type": "integer", + "description": "The container instance exit codes correspond to those from the `docker run` command." + }, + "finishTime": { + "type": "string", + "format": "date-time", + "description": "The date-time when the container instance state finished." + }, + "detailStatus": { + "description": "The human-readable status of the container instance state.", + "type": "string" + } + } + }, + "Event": { + "description": "A container group or container instance event.", + "type": "object", + "properties": { + "count": { + "type": "integer", + "description": "The count of the event." + }, + "firstTimestamp": { + "type": "string", + "format": "date-time", + "description": "The date-time of the earliest logged event." + }, + "lastTimestamp": { + "type": "string", + "format": "date-time", + "description": "The date-time of the latest logged event." + }, + "name": { + "type": "string", + "description": "The event name." + }, + "message": { + "type": "string", + "description": "The event message." + }, + "type": { + "type": "string", + "description": "The event type." + } + } + }, + "ResourceRequirements": { + "description": "The resource requirements.", + "type": "object", + "required": [ + "requests" + ], + "properties": { + "requests": { + "description": "The resource requests of this container instance.", + "$ref": "#/definitions/ResourceRequests" + }, + "limits": { + "description": "The resource limits of this container instance.", + "$ref": "#/definitions/ResourceLimits" + } + } + }, + "ResourceRequests": { + "description": "The resource requests.", + "type": "object", + "required": [ + "memoryInGB", + "cpu" + ], + "properties": { + "memoryInGB": { + "description": "The memory request in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU request of this container instance.", + "type": "number", + "format": "double" + } + } + }, + "ResourceLimits": { + "description": "The resource limits.", + "type": "object", + "properties": { + "memoryInGB": { + "description": "The memory limit in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU limit of this container instance.", + "type": "number", + "format": "double" + } + } + }, + "AzureFileVolume": { + "description": "The properties of the Azure File volume. Azure File shares are mounted as volumes.", + "type": "object", + "required": [ + "shareName", + "storageAccountName" + ], + "properties": { + "shareName": { + "description": "The name of the Azure File share to be mounted as a volume.", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the Azure File shared mounted as a volume is read-only.", + "type": "boolean" + }, + "storageAccountName": { + "description": "The name of the storage account that contains the Azure File share.", + "type": "string" + }, + "storageAccountKey": { + "description": "The storage account access key used to access the Azure File share.", + "type": "string" + } + } + }, + "EmptyDirVolume": { + "description": "The empty directory volume.", + "type": "object", + "properties": {} + }, + "SecretVolume": { + "description": "The secret volume.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "GitRepoVolume": { + "description": "Represents a volume that is populated with the contents of a git repository", + "required": [ + "repository" + ], + "properties": { + "directory": { + "description": "Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.", + "type": "string" + }, + "repository": { + "description": "Repository URL", + "type": "string" + }, + "revision": { + "description": "Commit hash for the specified revision.", + "type": "string" + } + } + }, + "Volume": { + "description": "The properties of the volume.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the volume.", + "type": "string" + }, + "azureFile": { + "description": "The Azure File volume.", + "$ref": "#/definitions/AzureFileVolume" + }, + "emptyDir": { + "description": "The empty directory volume.", + "$ref": "#/definitions/EmptyDirVolume" + }, + "secret": { + "description": "The secret volume.", + "$ref": "#/definitions/SecretVolume" + }, + "gitRepo": { + "description": "The git repo volume.", + "$ref": "#/definitions/GitRepoVolume" + } + } + }, + "VolumeMount": { + "description": "The properties of the volume mount.", + "type": "object", + "required": [ + "name", + "mountPath" + ], + "properties": { + "name": { + "description": "The name of the volume mount.", + "type": "string" + }, + "mountPath": { + "description": "The path within the container where the volume should be mounted. Must not contain colon (:).", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the volume mount is read-only.", + "type": "boolean" + } + } + }, + "ContainerExec": { + "type": "object", + "description": "The container execution command, for liveness or readiness probe", + "properties": { + "command": { + "description": "The commands to execute within the container.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ContainerHttpGet": { + "type": "object", + "description": "The container Http Get settings, for liveness or readiness probe", + "properties": { + "path": { + "description": "The path to probe.", + "type": "string" + }, + "port": { + "type": "integer", + "description": "The port number to probe.", + "format": "int32" + }, + "scheme": { + "description": "The scheme.", + "type": "string", + "enum": [ + "http", + "https" + ] + } + }, + "required": [ + "port" + ] + }, + "ContainerProbe": { + "type": "object", + "description": "The container probe, for liveness or readiness", + "properties": { + "exec": { + "description": "The execution command to probe", + "$ref": "#/definitions/ContainerExec" + }, + "httpGet": { + "description": "The Http Get settings to probe", + "$ref": "#/definitions/ContainerHttpGet" + }, + "initialDelaySeconds": { + "description": "The initial delay seconds.", + "type": "integer", + "format": "int32" + }, + "periodSeconds": { + "description": "The period seconds.", + "type": "integer", + "format": "int32" + }, + "failureThreshold": { + "description": "The failure threshold.", + "type": "integer", + "format": "int32" + }, + "successThreshold": { + "description": "The success threshold.", + "type": "integer", + "format": "int32" + }, + "timeoutSeconds": { + "description": "The timeout seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "ContainerGroup": { + "description": "A container group.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the container group. This only appears in the response." + }, + "containers": { + "type": "array", + "description": "The containers within the container group.", + "items": { + "$ref": "#/definitions/Container" + } + }, + "imageRegistryCredentials": { + "type": "array", + "description": "The image registry credentials by which the container group is created from.", + "items": { + "$ref": "#/definitions/ImageRegistryCredential" + } + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy for all containers within the container group. \n- `Always` Always restart\n- `OnFailure` Restart on failure\n- `Never` Never restart\n", + "enum": [ + "Always", + "OnFailure", + "Never" + ], + "x-ms-enum": { + "name": "ContainerGroupRestartPolicy", + "modelAsString": true + } + }, + "ipAddress": { + "description": "The IP address type of the container group.", + "$ref": "#/definitions/IpAddress" + }, + "osType": { + "type": "string", + "description": "The operating system type required by the containers in the container group.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true + } + }, + "volumes": { + "type": "array", + "description": "The list of volumes that can be mounted by containers in this container group.", + "items": { + "$ref": "#/definitions/Volume" + } + }, + "instanceView": { + "description": "The instance view of the container group. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "events": { + "description": "The events of this container group.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Event" + } + }, + "state": { + "readOnly": true, + "type": "string", + "description": "The state of the container group. Only valid in response." + } + } + }, + "diagnostics": { + "description": "The diagnostic information for a container group.", + "$ref": "#/definitions/ContainerGroupDiagnostics" + } + }, + "required": [ + "containers", + "osType" + ] + } + } + } + ] + }, + "ImageRegistryCredential": { + "description": "Image registry credential.", + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "The Docker image registry server without a protocol such as \"http\" and \"https\"." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "The password for the private registry." + } + }, + "required": [ + "server", + "username" + ] + }, + "ContainerGroupDiagnostics": { + "description": "Container group diagnostic information.", + "type": "object", + "properties": { + "logAnalytics": { + "description": "Container group log analytics information.", + "$ref": "#/definitions/LogAnalytics" + } + } + }, + "LogAnalytics": { + "description": "Container group log analytics information.", + "type": "object", + "properties": { + "workspaceId": { + "description": "The workspace id for log analytics", + "type": "string" + }, + "workspaceKey": { + "description": "The workspace key for log analytics", + "type": "string" + } + }, + "required": [ + "workspaceId", + "workspaceKey" + ] + }, + "IpAddress": { + "description": "IP address for the container group.", + "type": "object", + "properties": { + "ports": { + "type": "array", + "description": "The list of ports exposed on the container group.", + "items": { + "$ref": "#/definitions/Port" + } + }, + "type": { + "type": "string", + "description": "Specifies if the IP is exposed to the public internet.", + "enum": [ + "Public" + ], + "x-ms-enum": { + "name": "ContainerGroupIpAddressType", + "modelAsString": true + } + }, + "ip": { + "type": "string", + "description": "The IP exposed to the public internet." + }, + "dnsNameLabel": { + "type": "string", + "description": "The Dns name label for the IP." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN for the IP." + } + }, + "required": [ + "ports", + "type" + ] + }, + "Port": { + "description": "The port exposed on the container group.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerGroupNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "description": "The port number.", + "format": "int32" + } + }, + "required": [ + "port" + ] + }, + "ContainerPort": { + "description": "The port exposed on the container instance.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port number exposed within the container group." + } + }, + "required": [ + "port" + ] + }, + "EnvironmentVariable": { + "description": "The environment variable to set within the container instance.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment variable." + }, + "value": { + "type": "string", + "description": "The value of the environment variable." + }, + "secureValue": { + "type": "string", + "description": "The value of the secure environment variable." + } + }, + "required": [ + "name" + ] + }, + "OperationListResult":{ + "description": "The operation list response that contains all operations for Azure Container Instance service.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "The list of operations." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of operations." + } + } + }, + "Operation": { + "description": "An operation for Azure Container Instance service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "description": "The display information of the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The name of the provider of the operation.", + "type": "string" + }, + "resource": { + "type": "string", + "description": "The name of the resource type of the operation." + }, + "operation": { + "description": "The friendly name of the operation.", + "type": "string" + }, + "description": { + "description": "The description of the operation.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The intended executor of the operation.", + "enum": [ + "User", + "System" + ], + "x-ms-enum": { + "name": "ContainerInstanceOperationsOrigin", + "modelAsString": true + } + } + }, + "required": [ + "name", + "display" + ] + }, + "UsageListResult": { + "description": "The response containing the usage data", + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + } + } + } + }, + "Usage": { + "description": "A single usage result", + "type": "object", + "properties": { + "unit": { + "readOnly": true, + "type": "string", + "description": "Unit of the usage result" + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "description": "The current usage of the resource" + }, + "limit": { + "readOnly": true, + "type": "integer", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "type": "object", + "description": "The name object of the resource", + "properties": { + "value":{ + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource" + } + } + } + } + }, + "ContainerGroupListResult": { + "description": "The container group list response that contains the container group properties.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerGroup" + }, + "description": "The list of container groups." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of container groups." + } + } + }, + "Logs": { + "description": "The logs.", + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content of the log." + } + } + }, + "ContainerExecRequest": { + "description": "The container exec request.", + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to be executed." + }, + "terminalSize": { + "type": "object", + "description": "The size of the terminal.", + "properties": { + "rows":{ + "type": "integer", + "description": "The row size of the terminal" + }, + "cols": { + "type": "integer", + "description": "The column size of the terminal" + } + } + } + } + }, + "ContainerExecResponse": { + "description": "The information for the container exec command.", + "type": "object", + "properties": { + "webSocketUri": { + "type": "string", + "description": "The uri for the exec websocket." + }, + "password": { + "type": "string", + "description": "The password to start the exec command." + } + } + }, + "Resource": { + "type": "object", + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier for the physical azure location.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version", + "x-ms-parameter-location": "client" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ContainerGroupNameParameter": { + "name": "containerGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container group.", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation Id.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerExec.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerExec.json new file mode 100644 index 000000000000..7559eb82d036 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerExec.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-06-01", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "containerExecRequest": { + "command": "/bin/bash", + "terminalSize": { + "row": 12, + "column": 12 + } + } + }, + "responses": { + "200": { + "body": { + "webSocketUri": "wss://web-socket-uri", + "password": "password" + } + } + } + } \ No newline at end of file diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupUsage.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupUsage.json new file mode 100644 index 000000000000..c8e8bd115bd2 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupUsage.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 1, + "limit": 2000, + "name": { + "value": "ContainerGroups", + "localizedValue": "Container Groups" + } + } + ] + } + } + } + } + \ No newline at end of file diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsCreateOrUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsCreateOrUpdate.json new file mode 100644 index 000000000000..36384886c287 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsCreateOrUpdate.json @@ -0,0 +1,262 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-06-01", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerGroup": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "west us", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid", + "workspaceKey": "workspaceKey" + } + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1" + }, + "osType": "Linux", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKey": "accountKey" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": + { + "secretKey1": "SecretValue1InBase64", + "secretKey2": "SecretValue2InBase64" + } + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid", + "workspaceKey": "" + } + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret":{} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} \ No newline at end of file diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsDelete.json new file mode 100644 index 000000000000..b88a2a58387e --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-06-01", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsGet_Failed.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsGet_Failed.json new file mode 100644 index 000000000000..3c226f3a65de --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsGet_Failed.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Waiting", + "startTime": "2017-08-08T00:09:10Z", + "detailStatus": "" + }, + "events": [ + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:01Z", + "lastTimestamp": "2017-08-08T00:09:01Z", + "message": "pulling image \"nginx\"", + "name": "Pulling", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:10Z", + "lastTimestamp": "2017-08-08T00:09:10Z", + "message": "Successfully pulled image \"nginx\"", + "name": "Pulled", + "type": "Normal" + } + ] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "instanceView": { + "events": [ + { + "count": 1, + "firstTimestamp": "2017-10-08T00:19:10Z", + "lastTimestamp": "2017-10-08T00:19:10Z", + "message": "Output: mount error(2): Permission denied", + "name": "FailedMount", + "type": "Normal" + } + ], + "state": "Pending" + }, + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Failed", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} \ No newline at end of file diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsGet_Succeeded.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsGet_Succeeded.json new file mode 100644 index 000000000000..8a7541ee00db --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsGet_Succeeded.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} \ No newline at end of file diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsList.json new file mode 100644 index 000000000000..493fd2c8c77d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsList.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Running", + "startTime": "2017-10-17T17:27:21Z", + "detailStatus": "" + }, + "events":[] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsListByResourceGroup.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsListByResourceGroup.json new file mode 100644 index 000000000000..da098c8dd165 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsListByResourceGroup.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsUpdate.json new file mode 100644 index 000000000000..a99e645d3220 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerGroupsUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-06-01", + "resourceGroupName": "demoResource", + "containerGroupName": "demo1", + "Resource": { + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demoResource/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "properties": { + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + }, + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerListLogs.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerListLogs.json new file mode 100644 index 000000000000..78893353f23e --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/ContainerListLogs.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-06-01", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "tail": 10 + }, + "responses": { + "200": { + "body": { + "content": "log content" + } + } + } +} \ No newline at end of file diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/OperationsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/OperationsList.json new file mode 100644 index 000000000000..d530a5263cbc --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/examples/OperationsList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ContainerInstance/containerGroups/read", + "display": { + "provider": "Microsoft Container Instance", + "resource": "Container Group", + "operation": "Get Container Groups", + "description": "Get all container goups." + }, + "origin": "User" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/containerinstance/resource-manager/readme.md b/specification/containerinstance/resource-manager/readme.md index 4d59d1789210..7186c97efae9 100644 --- a/specification/containerinstance/resource-manager/readme.md +++ b/specification/containerinstance/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the ContainerInstance API. ``` yaml openapi-type: arm -tag: package-2018-04 +tag: package-2018-06 +``` + +### Tag: package-2018-06 + +These settings apply only when `--tag=package-2018-06` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06' +input-file: +- Microsoft.ContainerInstance/stable/2018-06-01/containerInstance.json ``` ### Tag: package-2018-04 @@ -89,9 +98,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_container_instance'] ``` @@ -125,7 +137,7 @@ python: payload-flattening-threshold: 2 namespace: azure.mgmt.containerinstance package-name: azure-mgmt-containerinstance - package-version: 0.4.0 + package-version: 1.0.0 clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' @@ -155,19 +167,39 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-06 + - tag: package-2018-04 - tag: package-2018-02-preview - tag: package-2017-12-preview - tag: package-2017-10-preview - tag: package-2017-08-preview ``` +### Tag: package-2018-06 and go + +These settings apply only when `--tag=package-2018-06 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-04' && $(go) +output-folder: $(go-sdk-folder)/services/containerinstance/mgmt/2018-06-01/containerinstance +``` + +### Tag: package-2018-04 and go + +These settings apply only when `--tag=package-2018-04 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-04' && $(go) +output-folder: $(go-sdk-folder)/services/containerinstance/mgmt/2018-04-01/containerinstance +``` + ### Tag: package-2018-02-preview and go These settings apply only when `--tag=package-2018-02-preview --go` is specified on the command line. Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-02-preview' && $(go) -output-folder: $(go-sdk-folder)/services/containerinstance/mgmt/2018-02-01-preview/containerinstance +output-folder: $(go-sdk-folder)/services/preview/containerinstance/mgmt/2018-02-01-preview/containerinstance ``` ### Tag: package-2017-12-preview and go @@ -176,7 +208,7 @@ These settings apply only when `--tag=package-2017-12-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-12-preview' && $(go) -output-folder: $(go-sdk-folder)/services/containerinstance/mgmt/2017-12-01-preview/containerinstance +output-folder: $(go-sdk-folder)/services/preview/containerinstance/mgmt/2017-12-01-preview/containerinstance ``` ### Tag: package-2017-10-preview and go @@ -185,7 +217,7 @@ These settings apply only when `--tag=package-2017-10-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-10-preview' && $(go) -output-folder: $(go-sdk-folder)/services/containerinstance/mgmt/2017-10-01-preview/containerinstance +output-folder: $(go-sdk-folder)/services/preview/containerinstance/mgmt/2017-10-01-preview/containerinstance ``` ### Tag: package-2017-08-preview and go @@ -194,7 +226,7 @@ These settings apply only when `--tag=package-2017-08-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-08-preview' && $(go) -output-folder: $(go-sdk-folder)/services/containerinstance/mgmt/2017-08-01-preview/containerinstance +output-folder: $(go-sdk-folder)/services/preview/containerinstance/mgmt/2017-08-01-preview/containerinstance ``` @@ -204,11 +236,88 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.containerinstance +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-containerinstance +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-08-preview + - tag: package-2018-02-preview + - tag: package-2017-10-preview + - tag: package-2018-04 + - tag: package-2017-12-preview +``` + +### Tag: package-2017-08-preview and java + +These settings apply only when `--tag=package-2017-08-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-08-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.containerinstance - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-containerinstance + namespace: com.microsoft.azure.management.containerinstance.v2017_08_01_preview + output-folder: $(azure-libraries-for-java-folder)/containerinstance/resource-manager/v2017_08_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-02-preview and java + +These settings apply only when `--tag=package-2018-02-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-02-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerinstance.v2018_02_01_preview + output-folder: $(azure-libraries-for-java-folder)/containerinstance/resource-manager/v2018_02_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-10-preview and java + +These settings apply only when `--tag=package-2017-10-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-10-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerinstance.v2017_10_01_preview + output-folder: $(azure-libraries-for-java-folder)/containerinstance/resource-manager/v2017_10_01_preview +regenerate-manager: true +generate-interface: true ``` + +### Tag: package-2018-04 and java + +These settings apply only when `--tag=package-2018-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerinstance.v2018_04_01 + output-folder: $(azure-libraries-for-java-folder)/containerinstance/resource-manager/v2018_04_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-12-preview and java + +These settings apply only when `--tag=package-2017-12-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-12-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerinstance.v2017_12_01_preview + output-folder: $(azure-libraries-for-java-folder)/containerinstance/resource-manager/v2017_12_01_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/containerinstance/resource-manager/readme.ruby.md b/specification/containerinstance/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..de03943f180e --- /dev/null +++ b/specification/containerinstance/resource-manager/readme.ruby.md @@ -0,0 +1,59 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_container_instance +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-02-preview + - tag: package-2017-12-preview + - tag: package-2017-10-preview + - tag: package-2017-08-preview +``` + +### Tag: package-2018-02-preview and ruby + +These settings apply only when `--tag=package-2018-02-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-02-preview' && $(ruby) +namespace: "Azure::ContainerInstance::Mgmt::V2018_02_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_instance/lib +``` + +### Tag: package-2017-12-preview and ruby + +These settings apply only when `--tag=package-2017-12-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-12-preview' && $(ruby) +namespace: "Azure::ContainerInstance::Mgmt::V2017_12_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_instance/lib +``` + +### Tag: package-2017-10-preview and ruby + +These settings apply only when `--tag=package-2017-10-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-10-preview' && $(ruby) +namespace: "Azure::ContainerInstance::Mgmt::V2017_10_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_instance/lib +``` + +### Tag: package-2017-08-preview and ruby + +These settings apply only when `--tag=package-2017-08-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-08-preview' && $(ruby) +namespace: "Azure::ContainerInstance::Mgmt::V2017_08_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_instance/lib +``` diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/containerregistry_build.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/containerregistry_build.json new file mode 100644 index 000000000000..929fd5b1270c --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/containerregistry_build.json @@ -0,0 +1,2109 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-02-01-preview", + "title": "ContainerRegistryManagementClient" + }, + "host": "management.azure.com", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/builds": { + "get": { + "tags": [ + "Builds" + ], + "description": "Gets all the builds for a registry.", + "operationId": "Builds_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "The builds filter to apply on the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "$top is supported for get list of builds, which limits the maximum number of builds to return.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on get list of builds, which provides the next page in the list of builds.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/BuildListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-odata": "#/definitions/BuildFilter", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Builds_List": { + "$ref": "./examples/BuildsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/builds/{buildId}": { + "get": { + "tags": [ + "Builds" + ], + "description": "Gets the detailed information for a given build.", + "operationId": "Builds_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "buildId", + "in": "path", + "description": "The build ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Build" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry/build doesn't exist, 404 (Not found) is returned." + } + }, + "x-ms-examples": { + "Builds_Get": { + "$ref": "./examples/BuildsGet.json" + } + } + }, + "patch": { + "tags": [ + "Builds" + ], + "description": "Patch the build properties.", + "operationId": "Builds_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "buildId", + "in": "path", + "description": "The build ID.", + "required": true, + "type": "string" + }, + { + "name": "buildUpdateParameters", + "in": "body", + "description": "The build update properties.", + "required": true, + "schema": { + "$ref": "#/definitions/BuildUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Build" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/Build" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry/build doesn't exist, 404 (Not found) is returned. If any of the input parameters is wrong, 400(Bad Request) is returned." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Builds_Update": { + "$ref": "./examples/BuildsUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/builds/{buildId}/getLogLink": { + "post": { + "tags": [ + "Builds" + ], + "description": "Gets a link to download the build logs.", + "operationId": "Builds_GetLogLink", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "buildId", + "in": "path", + "description": "The build ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/BuildGetLogResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry/build doesn't exist, 404 (Not found) is returned." + } + }, + "x-ms-examples": { + "Builds_GetLogLink": { + "$ref": "./examples/BuildsGetLogLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/builds/{buildId}/cancel": { + "post": { + "tags": [ + "Builds" + ], + "description": "Cancel an existing build.", + "operationId": "Builds_Cancel", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "buildId", + "in": "path", + "description": "The build ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successfully accepted; the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed. If the registry/build doesn't exist, 404 (Not found) is returned." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Builds_Cancel": { + "$ref": "./examples/BuildsCancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/buildTasks/{buildTaskName}/steps": { + "get": { + "tags": [ + "BuildSteps" + ], + "description": "List all the build steps for a given build task.", + "operationId": "BuildSteps_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BuildTaskNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/BuildStepList" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BuildSteps_List": { + "$ref": "./examples/BuildStepsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/buildTasks/{buildTaskName}/steps/{stepName}": { + "get": { + "tags": [ + "BuildSteps" + ], + "description": "Gets the build step for a build task.", + "operationId": "BuildSteps_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BuildTaskNameParameter" + }, + { + "$ref": "#/parameters/StepNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/BuildStep" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry/step doesn't exist, 404 (Not found) is returned." + } + }, + "x-ms-examples": { + "BuildSteps_Get": { + "$ref": "./examples/BuildStepsGet.json" + } + } + }, + "put": { + "tags": [ + "BuildSteps" + ], + "description": "Creates a build step for a build task.", + "operationId": "BuildSteps_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BuildTaskNameParameter" + }, + { + "$ref": "#/parameters/StepNameParameter" + }, + { + "name": "buildStepCreateParameters", + "in": "body", + "description": "The parameters for creating a build step.", + "required": true, + "schema": { + "$ref": "#/definitions/BuildStep" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/BuildStep" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/BuildStep" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry doesn't exist, 404 (Not found) is returned.If any of the input parameters is wrong, 400(Bad Request) is returned." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BuildSteps_Create": { + "$ref": "./examples/BuildStepsCreate.json" + } + } + }, + "delete": { + "tags": [ + "BuildSteps" + ], + "description": "Deletes a build step from the build task.", + "operationId": "BuildSteps_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BuildTaskNameParameter" + }, + { + "$ref": "#/parameters/StepNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successfully accepted; the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BuildSteps_Delete": { + "$ref": "./examples/BuildStepsDelete.json" + } + } + }, + "patch": { + "tags": [ + "BuildSteps" + ], + "description": "Updates a build step in a build task.", + "operationId": "BuildSteps_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BuildTaskNameParameter" + }, + { + "$ref": "#/parameters/StepNameParameter" + }, + { + "name": "buildStepUpdateParameters", + "in": "body", + "description": "The parameters for updating a build step.", + "required": true, + "schema": { + "$ref": "#/definitions/BuildStepUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/BuildStep" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/BuildStep" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry/step doesn't exist, 404 (Not found) is returned.If any of the input parameters is wrong, 400(Bad Request) is returned." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BuildSteps_Update": { + "$ref": "./examples/BuildStepsUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/buildTasks/{buildTaskName}/steps/{stepName}/listBuildArguments": { + "post": { + "tags": [ + "BuildSteps" + ], + "description": "List the build arguments for a step including the secret arguments.", + "operationId": "BuildSteps_ListBuildArguments", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BuildTaskNameParameter" + }, + { + "$ref": "#/parameters/StepNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/BuildArgumentList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry/step doesn't exist, 404 (Not found) is returned." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BuildSteps_ListBuildArguments": { + "$ref": "./examples/BuildStepsListBuildArguments.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/buildTasks": { + "get": { + "tags": [ + "BuildTasks" + ], + "description": "Lists all the build tasks for a specified container registry.", + "operationId": "BuildTasks_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "The build task filter to apply on the operation.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on get list of build tasks, which provides the next page in the list of tasks.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/BuildTaskListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-odata": "#/definitions/BuildTaskFilter", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BuildTasks_List": { + "$ref": "./examples/BuildTasksList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/buildTasks/{buildTaskName}": { + "get": { + "tags": [ + "BuildTasks" + ], + "description": "Get the properties of a specified build task.", + "operationId": "BuildTasks_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BuildTaskNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/BuildTask" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry doesn't exist, 404 (Not found) is returned." + } + }, + "x-ms-examples": { + "BuildTasks_Get": { + "$ref": "./examples/BuildTasksGet.json" + } + } + }, + "put": { + "tags": [ + "BuildTasks" + ], + "description": "Creates a build task for a container registry with the specified parameters.", + "operationId": "BuildTasks_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BuildTaskNameParameter" + }, + { + "name": "buildTaskCreateParameters", + "in": "body", + "description": "The parameters for creating a build task.", + "required": true, + "schema": { + "$ref": "#/definitions/BuildTask" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/BuildTask" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/BuildTask" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry doesn't exist, 404 (Not found) is returned. If any of the input parameters is wrong, 400(Bad Request) is returned." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BuildTasks_Create": { + "$ref": "./examples/BuildTasksCreate.json" + } + } + }, + "delete": { + "tags": [ + "BuildTasks" + ], + "description": "Deletes a specified build task.", + "operationId": "BuildTasks_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BuildTaskNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successfully accepted; the operation will complete asynchronously." + }, + "204": { + "description": "No Content - the specified resource was not found." + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BuildTasks_Delete": { + "$ref": "./examples/BuildTasksDelete.json" + } + } + }, + "patch": { + "tags": [ + "BuildTasks" + ], + "description": "Updates a build task with the specified parameters.", + "operationId": "BuildTasks_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BuildTaskNameParameter" + }, + { + "name": "buildTaskUpdateParameters", + "in": "body", + "description": "The parameters for updating a build task.", + "required": true, + "schema": { + "$ref": "#/definitions/BuildTaskUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/BuildTask" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/BuildTask" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry doesn't exist, 404 (Not found) is returned. If any of the input parameters is wrong, 400(Bad Request) is returned." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BuildTasks_Update": { + "$ref": "./examples/BuildTasksUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/buildTasks/{buildTaskName}/listSourceRepositoryProperties": { + "post": { + "tags": [ + "BuildTasks" + ], + "description": "Get the source control properties for a build task.", + "operationId": "BuildTasks_ListSourceRepositoryProperties", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BuildTaskNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/SourceRepositoryProperties" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry doesn't exist, 404 (Not found) is returned." + } + }, + "x-ms-examples": { + "BuildTasks_ListSourceRepositoryProperties": { + "$ref": "./examples/BuildTasksListSourceRepositoryProperties.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/queueBuild": { + "post": { + "tags": [ + "Registries" + ], + "description": "Creates a new build based on the request parameters and add it to the build queue.", + "operationId": "Registries_QueueBuild", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "buildRequest", + "in": "body", + "description": "The parameters of a build that needs to queued.", + "required": true, + "schema": { + "$ref": "#/definitions/QueueBuildRequest" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Build" + } + }, + "202": { + "description": "The request was successfully accepted; the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed. If the registry/build doesn't exist, 404 (Not found) is returned. If any of the input parameters is wrong, 400(Bad Request) is returned." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Registries_QueueBuild": { + "$ref": "./examples/RegistriesQueueBuild.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/getBuildSourceUploadUrl": { + "post": { + "tags": [ + "Registries" + ], + "description": "Get the upload location for the user to be able to upload the source.", + "operationId": "Registries_GetBuildSourceUploadUrl", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/SourceUploadDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the registry/build doesn't exist, 404 (Not found) is returned." + } + }, + "x-ms-examples": { + "Registries_GetBuildSourceUploadUrl": { + "$ref": "./examples/RegistriesGetBuildSourceUploadUrl.json" + } + } + } + } + }, + "definitions": { + "BuildListResult": { + "description": "Collection of builds.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/Build" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "Build": { + "description": "Build resource properties", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BuildProperties", + "description": "The properties of a build.", + "x-ms-client-flatten": true + } + } + }, + "BuildProperties": { + "description": "The properties for a build.", + "type": "object", + "properties": { + "buildId": { + "description": "The unique identifier for the build.", + "type": "string" + }, + "status": { + "description": "The current status of the build.", + "enum": [ + "Queued", + "Started", + "Running", + "Succeeded", + "Failed", + "Canceled", + "Error", + "Timeout" + ], + "type": "string", + "x-ms-enum": { + "name": "BuildStatus", + "modelAsString": true + } + }, + "lastUpdatedTime": { + "format": "date-time", + "description": "The last updated time for the build.", + "type": "string" + }, + "buildType": { + "description": "The type of build.", + "enum": [ + "AutoBuild", + "QuickBuild" + ], + "type": "string", + "x-ms-enum": { + "name": "BuildType", + "modelAsString": true + } + }, + "createTime": { + "format": "date-time", + "description": "The time the build was created.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The time the build started.", + "type": "string" + }, + "finishTime": { + "format": "date-time", + "description": "The time the build finished.", + "type": "string" + }, + "outputImages": { + "description": "The list of all images that were generated from the build.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageDescriptor" + } + }, + "buildTask": { + "description": "The build task with which the build was started.", + "type": "string" + }, + "imageUpdateTrigger": { + "$ref": "#/definitions/ImageUpdateTrigger", + "description": "The image update trigger that caused the build." + }, + "gitCommitTrigger": { + "$ref": "#/definitions/GitCommitTrigger", + "description": "The git commit trigger that caused the build." + }, + "isArchiveEnabled": { + "description": "The value that indicates whether archiving is enabled or not.", + "default": false, + "type": "boolean" + }, + "platform": { + "$ref": "#/definitions/PlatformProperties", + "description": "The platform properties against which the build will happen." + }, + "provisioningState": { + "description": "The provisioning state of a build.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + } + }, + "ImageDescriptor": { + "description": "Properties for a registry image.", + "type": "object", + "properties": { + "registry": { + "description": "The registry login server.", + "type": "string" + }, + "repository": { + "description": "The repository name.", + "type": "string" + }, + "tag": { + "description": "The tag name.", + "type": "string" + }, + "digest": { + "description": "The sha256-based digest of the image manifest.", + "type": "string" + } + } + }, + "ImageUpdateTrigger": { + "description": "The image update trigger that caused a build.", + "type": "object", + "properties": { + "id": { + "description": "The unique ID of the trigger.", + "type": "string" + }, + "timestamp": { + "format": "date-time", + "description": "The timestamp when the image update happened.", + "type": "string" + }, + "images": { + "description": "The list of image updates that caused the build.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageDescriptor" + } + } + } + }, + "GitCommitTrigger": { + "description": "The git commit trigger that caused a build.", + "type": "object", + "properties": { + "id": { + "description": "The unique ID of the trigger.", + "type": "string" + }, + "commitId": { + "description": "The unique ID that identifies a commit.", + "type": "string" + }, + "repositoryUrl": { + "description": "The repository URL.", + "type": "string" + }, + "branchName": { + "description": "The branch name in the repository.", + "type": "string" + }, + "providerType": { + "description": "The source control provider type.", + "type": "string" + } + } + }, + "PlatformProperties": { + "description": "The platform properties against which the build has to happen.", + "required": [ + "osType" + ], + "type": "object", + "properties": { + "osType": { + "description": "The operating system type required for the build.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "x-ms-enum": { + "name": "OsType", + "modelAsString": true + } + }, + "cpu": { + "format": "int32", + "description": "The CPU configuration in terms of number of cores required for the build.", + "type": "integer" + } + } + }, + "BuildFilter": { + "description": "Properties that are enabled for Odata querying.", + "type": "object", + "properties": { + "buildId": { + "description": "The unique identifier for the build.", + "type": "string" + }, + "buildType": { + "description": "The type of build.", + "enum": [ + "AutoBuild", + "QuickBuild" + ], + "type": "string", + "x-ms-enum": { + "name": "BuildType", + "modelAsString": true + } + }, + "status": { + "description": "The current status of the build.", + "enum": [ + "Queued", + "Started", + "Running", + "Succeeded", + "Failed", + "Canceled", + "Error", + "Timeout" + ], + "type": "string", + "x-ms-enum": { + "name": "BuildStatus", + "modelAsString": true + } + }, + "createTime": { + "format": "date-time", + "description": "The create time for a build.", + "type": "string" + }, + "finishTime": { + "format": "date-time", + "description": "The time the build finished.", + "type": "string" + }, + "outputImageManifests": { + "description": "The list of comma-separated image manifests that were generated from the build.", + "type": "string" + }, + "isArchiveEnabled": { + "description": "The value that indicates whether archiving is enabled or not.", + "type": "boolean" + }, + "buildTaskName": { + "description": "The name of the build task that the build corresponds to.", + "type": "string" + } + } + }, + "BuildUpdateParameters": { + "description": "The set of build properties that can be updated.", + "type": "object", + "properties": { + "isArchiveEnabled": { + "description": "The value that indicates whether archiving is enabled or not.", + "type": "boolean" + } + } + }, + "BuildGetLogResult": { + "description": "The result of get log link operation.", + "type": "object", + "properties": { + "logLink": { + "description": "The link to logs for a azure container registry build.", + "type": "string" + } + } + }, + "BuildStepList": { + "description": "The collection of build items.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/BuildStep" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "BuildStep": { + "description": "Build step resource properties", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BuildStepProperties", + "description": "The properties of a build step." + } + } + }, + "BuildStepProperties": { + "description": "Base properties for any build step.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the build step.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "type": { + "description": "The type of the step.", + "enum": [ + "Docker" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BuildStepType", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "BuildStepUpdateParameters": { + "description": "The parameters for updating a build step.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/BuildStepPropertiesUpdateParameters", + "description": "The properties for updating a build step." + }, + "tags": { + "description": "The ARM resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BuildStepPropertiesUpdateParameters": { + "description": "The properties for updating a build step.", + "type": "object", + "properties": { + "type": { + "description": "The type of the step.", + "enum": [ + "Docker" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BuildStepType", + "modelAsString": true + } + } + }, + "discriminator": "type" + }, + "BuildArgumentList": { + "description": "The list of build arguments for a build step.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/BuildArgument" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "BuildArgument": { + "description": "Properties of a build argument.", + "required": [ + "type", + "name", + "value" + ], + "type": "object", + "properties": { + "type": { + "description": "The type of the argument.", + "enum": [ + "DockerBuildArgument" + ], + "type": "string", + "x-ms-enum": { + "name": "BuildArgumentType", + "modelAsString": true + } + }, + "name": { + "description": "The name of the argument.", + "type": "string" + }, + "value": { + "description": "The value of the argument.", + "type": "string" + }, + "isSecret": { + "description": "Flag to indicate whether the argument represents a secret and want to be removed from build logs.", + "default": false, + "type": "boolean" + } + } + }, + "BuildTaskListResult": { + "description": "The collection of build tasks.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/BuildTask" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "BuildTask": { + "description": "The build task that has the resource properties and all build items. The build task will have all information to schedule a build against it.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BuildTaskProperties", + "description": "The properties of a build task.", + "x-ms-client-flatten": true + } + } + }, + "BuildTaskProperties": { + "description": "The properties of a build task.", + "required": [ + "alias", + "sourceRepository", + "platform" + ], + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the build task.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of build task.", + "type": "string", + "readOnly": true + }, + "alias": { + "description": "The alternative updatable name for a build task.", + "type": "string" + }, + "status": { + "description": "The current status of build task.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "BuildTaskStatus", + "modelAsString": true + } + }, + "sourceRepository": { + "$ref": "#/definitions/SourceRepositoryProperties", + "description": "The properties that describes the source(code) for the build task." + }, + "platform": { + "$ref": "#/definitions/PlatformProperties", + "description": "The platform properties against which the build has to happen." + }, + "timeout": { + "format": "int32", + "description": "Build timeout in seconds.", + "default": 3600, + "maximum": 28800, + "minimum": 300, + "type": "integer" + } + } + }, + "SourceRepositoryProperties": { + "description": "The properties of the source code repository.", + "required": [ + "sourceControlType", + "repositoryUrl" + ], + "type": "object", + "properties": { + "sourceControlType": { + "description": "The type of source control service.", + "enum": [ + "Github", + "VisualStudioTeamService" + ], + "type": "string", + "x-ms-enum": { + "name": "SourceControlType", + "modelAsString": true + } + }, + "repositoryUrl": { + "description": "The full URL to the source code respository", + "type": "string" + }, + "isCommitTriggerEnabled": { + "description": "The value of this property indicates whether the source control commit trigger is enabled or not.", + "default": false, + "type": "boolean" + }, + "sourceControlAuthProperties": { + "$ref": "#/definitions/SourceControlAuthInfo", + "description": "The authorization properties for accessing the source code repository." + } + } + }, + "SourceControlAuthInfo": { + "description": "The authorization properties for accessing the source code repository.", + "required": [ + "token" + ], + "type": "object", + "properties": { + "tokenType": { + "description": "The type of Auth token.", + "enum": [ + "PAT", + "OAuth" + ], + "type": "string", + "x-ms-enum": { + "name": "TokenType", + "modelAsString": true + } + }, + "token": { + "description": "The access token used to access the source control provider.", + "type": "string" + }, + "refreshToken": { + "description": "The refresh token used to refresh the access token.", + "type": "string" + }, + "scope": { + "description": "The scope of the access token.", + "type": "string" + }, + "expiresIn": { + "format": "int32", + "description": "Time in seconds that the token remains valid", + "type": "integer" + } + } + }, + "BuildTaskFilter": { + "description": "The filter that can be used for listing build tasks.", + "type": "object", + "properties": { + "alias": { + "description": "The alternative name for build task.", + "type": "string" + } + } + }, + "BuildTaskUpdateParameters": { + "description": "The parameters for updating a build task.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/BuildTaskPropertiesUpdateParameters", + "description": "The properties for updating a build task.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The ARM resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BuildTaskPropertiesUpdateParameters": { + "description": "The properties for updating a build task.", + "type": "object", + "properties": { + "alias": { + "description": "The alternative updatable name for a build task.", + "type": "string" + }, + "status": { + "description": "The current status of build task.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "BuildTaskStatus", + "modelAsString": true + } + }, + "platform": { + "$ref": "#/definitions/PlatformProperties", + "description": "The platform properties against which the build has to happen." + }, + "timeout": { + "format": "int32", + "description": "Build timeout in seconds.", + "maximum": 28800, + "minimum": 300, + "type": "integer" + }, + "sourceRepository": { + "$ref": "#/definitions/SourceRepositoryUpdateParameters", + "description": "The properties that describes the source(code) for the build task." + } + } + }, + "SourceRepositoryUpdateParameters": { + "description": "The properties for updating the source code repository configuration.", + "type": "object", + "properties": { + "sourceControlAuthProperties": { + "$ref": "#/definitions/SourceControlAuthInfo", + "description": "The authorization properties for accessing the source code repository." + }, + "isCommitTriggerEnabled": { + "description": "The value of this property indicates whether the source control commit trigger is enabled or not.", + "type": "boolean" + } + } + }, + "QueueBuildRequest": { + "description": "The queue build request parameters.", + "type": "object", + "properties": { + "type": { + "description": "The type of the build request.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "type" + }, + "SourceUploadDefinition": { + "description": "The properties of a response to source upload request.", + "type": "object", + "properties": { + "uploadUrl": { + "description": "The URL where the client can upload the source.", + "type": "string" + }, + "relativePath": { + "description": "The relative path to the source. This is used to submit the subsequent queue build request.", + "type": "string" + } + } + }, + "Resource": { + "description": "An Azure resource.", + "required": [ + "location" + ], + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The location of the resource. This cannot be changed after the resource is created.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.", + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "DockerBuildStep": { + "description": "The Docker build step.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BuildStepProperties" + } + ], + "properties": { + "branch": { + "description": "The repository branch name.", + "type": "string" + }, + "imageNames": { + "description": "The fully qualified image names including the repository and tag.", + "type": "array", + "items": { + "type": "string" + } + }, + "isPushEnabled": { + "description": "The value of this property indicates whether the image built should be pushed to the registry or not.", + "default": true, + "type": "boolean" + }, + "noCache": { + "description": "The value of this property indicates whether the image cache is enabled or not.", + "default": false, + "type": "boolean" + }, + "dockerFilePath": { + "description": "The Docker file path relative to the source control root.", + "type": "string" + }, + "contextPath": { + "description": "The relative context path for a docker build in the source.", + "type": "string" + }, + "buildArguments": { + "description": "The custom arguments for building this build step.", + "type": "array", + "items": { + "$ref": "#/definitions/BuildArgument" + } + }, + "baseImageDependencies": { + "description": "List of base image dependencies for a step.", + "type": "array", + "items": { + "$ref": "#/definitions/BaseImageDependency" + }, + "readOnly": true + }, + "baseImageTrigger": { + "description": "The type of the auto trigger for base image dependency updates.", + "enum": [ + "All", + "Runtime", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "BaseImageTriggerType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "Docker" + }, + "BaseImageDependency": { + "description": "Properties that describe a base image dependency.", + "type": "object", + "properties": { + "type": { + "description": "The type of the base image dependency.", + "enum": [ + "BuildTime", + "RunTime" + ], + "type": "string", + "x-ms-enum": { + "name": "BaseImageDependencyType", + "modelAsString": true + } + }, + "registry": { + "description": "The registry login server.", + "type": "string" + }, + "repository": { + "description": "The repository name.", + "type": "string" + }, + "tag": { + "description": "The tag name.", + "type": "string" + }, + "digest": { + "description": "The sha256-based digest of the image manifest.", + "type": "string" + } + } + }, + "DockerBuildStepUpdateParameters": { + "description": "The properties for updating a docker build step.", + "required": [ + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BuildStepPropertiesUpdateParameters" + } + ], + "properties": { + "branch": { + "description": "The repository branch name.", + "type": "string" + }, + "imageNames": { + "description": "The fully qualified image names including the repository and tag.", + "type": "array", + "items": { + "type": "string" + } + }, + "isPushEnabled": { + "description": "The value of this property indicates whether the image built should be pushed to the registry or not.", + "type": "boolean" + }, + "noCache": { + "description": "The value of this property indicates whether the image cache is enabled or not.", + "type": "boolean" + }, + "dockerFilePath": { + "description": "The Docker file path relative to the source control root.", + "type": "string" + }, + "contextPath": { + "description": "The relative context path for a docker build in the source.", + "type": "string" + }, + "buildArguments": { + "description": "The custom arguments for building this build step.", + "type": "array", + "items": { + "$ref": "#/definitions/BuildArgument" + } + }, + "baseImageTrigger": { + "description": "The type of the auto trigger for base image dependency updates.", + "enum": [ + "All", + "Runtime", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "BaseImageTriggerType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "Docker" + }, + "BuildTaskBuildRequest": { + "description": "The queue build parameters based on a build task.", + "required": [ + "type", + "buildTaskName" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/QueueBuildRequest" + } + ], + "properties": { + "buildTaskName": { + "description": "The name of build task against which build has to be queued.", + "type": "string" + } + }, + "x-ms-discriminator-value": "BuildTask" + }, + "QuickBuildRequest": { + "description": "The queue build request parameters for a quick build.", + "required": [ + "type", + "sourceLocation", + "platform", + "dockerFilePath" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/QueueBuildRequest" + } + ], + "properties": { + "imageNames": { + "description": "The fully qualified image names including the repository and tag.", + "type": "array", + "items": { + "type": "string" + } + }, + "sourceLocation": { + "description": "The URL(absolute or relative) of the source that needs to be built. For Docker build, it can be an URL to a tar or github repoistory as supported by Docker.\r\nIf it is relative URL, the relative path should be obtained from calling getSourceUploadUrl API.", + "type": "string" + }, + "buildArguments": { + "description": "The collection of build arguments to be used.", + "type": "array", + "items": { + "$ref": "#/definitions/BuildArgument" + } + }, + "isPushEnabled": { + "description": "The value of this property indicates whether the image built should be pushed to the registry or not.", + "default": true, + "type": "boolean" + }, + "noCache": { + "description": "The value of this property indicates whether the image cache is enabled or not.", + "default": false, + "type": "boolean" + }, + "timeout": { + "format": "int32", + "description": "Build timeout in seconds.", + "default": 3600, + "maximum": 28800, + "minimum": 300, + "type": "integer" + }, + "platform": { + "$ref": "#/definitions/PlatformProperties", + "description": "The platform properties against which the build will happen." + }, + "dockerFilePath": { + "description": "The Docker file path relative to the source location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "QuickBuild" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Microsoft Azure subscription ID.", + "required": true, + "type": "string" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group to which the container registry belongs.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RegistryNameParameter": { + "name": "registryName", + "in": "path", + "description": "The name of the container registry.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9]*$", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The client API version.", + "required": true, + "type": "string" + }, + "BuildTaskNameParameter": { + "name": "buildTaskName", + "in": "path", + "description": "The name of the container registry build task.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9]*$", + "x-ms-parameter-location": "method" + }, + "StepNameParameter": { + "name": "stepName", + "in": "path", + "description": "The name of a build step for a container registry build task.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9]*$", + "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" + ] + } + ] +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsCreate.json new file mode 100644 index 000000000000..972e21e9a3bc --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsCreate.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildTaskName": "myBuildTask", + "stepName": "myStep", + "buildStepCreateParameters": { + "properties": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": true, + "buildArguments": [ + { + "type": "DockerBuildArgument", + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "type": "DockerBuildArgument", + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "type": "Docker", + "branch": "master", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "provisioningState": "Succeeded", + "baseImageTrigger": "Runtime", + "buildArguments": [ + { + "type": "DockerBuildArgument", + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "type": "DockerBuildArgument", + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/buildTasks/myBuildTask/steps/myStep", + "name": "myStep", + "type": "Microsoft.ContainerRegistry/registries/buildTasks/steps" + } + }, + "201": { + "body": { + "properties": { + "type": "Docker", + "branch": "master", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "provisioningState": "Updating", + "baseImageTrigger": "Runtime", + "buildArguments": [ + { + "type": "DockerBuildArgument", + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "type": "DockerBuildArgument", + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/buildTasks/myBuildTask/steps/myStep", + "name": "myStep", + "type": "Microsoft.ContainerRegistry/registries/buildTasks/steps" + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsDelete.json new file mode 100644 index 000000000000..728bfbc8d85c --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildTaskName": "myBuildTask", + "stepName": "myStep" + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsGet.json new file mode 100644 index 000000000000..b594955b6e51 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsGet.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildTaskName": "myBuildTask", + "stepName": "myStep" + }, + "responses": { + "200": { + "body": { + "properties": { + "type": "Docker", + "branch": "master", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "provisioningState": "Succeeded", + "baseImageTrigger": "Runtime", + "buildArguments": [ + { + "type": "DockerBuildArgument", + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "type": "DockerBuildArgument", + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/buildTasks/myBuildTask/steps/myStep", + "name": "myStep", + "type": "Microsoft.ContainerRegistry/registries/buildTasks/steps" + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsList.json new file mode 100644 index 000000000000..5f1d968c675e --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildTaskName": "myBuildTask" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "type": "Docker", + "branch": "master", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "provisioningState": "Succeeded", + "baseImageTrigger": "Runtime", + "buildArguments": [ + { + "type": "DockerBuildArgument", + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "type": "DockerBuildArgument", + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/buildTasks/myBuildTask/steps/myStep", + "name": "myStep", + "type": "Microsoft.ContainerRegistry/registries/buildTasks/steps" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsListBuildArguments.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsListBuildArguments.json new file mode 100644 index 000000000000..35492eade384 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsListBuildArguments.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildTaskName": "myBuildTask", + "stepName": "myStep" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "DockerBuildArgument", + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "type": "DockerBuildArgument", + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsUpdate.json new file mode 100644 index 000000000000..6e224805686d --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildStepsUpdate.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildTaskName": "myBuildTask", + "stepName": "myStep", + "buildStepUpdateParameters": { + "properties": { + "type": "Docker", + "imageNames": [ + "azurerest:testtag", + "azurerest1:testtag1" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "baseImageTrigger": "None", + "buildArguments": [ + { + "type": "DockerBuildArgument", + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "type": "DockerBuildArgument", + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "type": "Docker", + "branch": "master", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "provisioningState": "Succeeded", + "baseImageTrigger": "Runtime", + "buildArguments": [ + { + "type": "DockerBuildArgument", + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "type": "DockerBuildArgument", + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/buildTasks/myBuildTask/steps/myStep", + "name": "myStep", + "type": "Microsoft.ContainerRegistry/registries/buildTasks/steps" + } + }, + "201": { + "body": { + "properties": { + "type": "Docker", + "branch": "master", + "imageNames": [ + "azurerest:testtag" + ], + "dockerFilePath": "src/DockerFile", + "contextPath": "src", + "isPushEnabled": true, + "noCache": false, + "provisioningState": "Updating", + "baseImageTrigger": "Runtime", + "buildArguments": [ + { + "type": "DockerBuildArgument", + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "type": "DockerBuildArgument", + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/buildTasks/myBuildTask/steps/myStep", + "name": "myStep", + "type": "Microsoft.ContainerRegistry/registries/buildTasks/steps" + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksCreate.json new file mode 100644 index 000000000000..5c72bcc1f0e8 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksCreate.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildTaskName": "myBuildTask", + "buildTaskCreateParameters": { + "properties": { + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "sourceControlAuthProperties": { + "tokenType": "OAuth", + "token": "xxxxxx", + "scope": "repo" + }, + "isCommitTriggerEnabled": true + }, + "platform": { + "osType": "Linux", + "cpu": 2 + }, + "alias": "myalias", + "status": "Enabled" + }, + "location": "eastus", + "tags": { + "testkey": "value" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "alias": "myalias", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "isCommitTriggerEnabled": true + }, + "platform": { + "osType": "Linux", + "cpu": 2 + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/buildTasks/myBuildTask", + "name": "myBuildTask", + "type": "Microsoft.ContainerRegistry/registries/buildTasks", + "location": "eastus", + "tags": { + "key": "value" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "creationDate": "2018-01-25T06:54:23.536Z", + "alias": "myalias", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "isCommitTriggerEnabled": true + }, + "platform": { + "osType": "Linux", + "cpu": 2 + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/buildTasks/myBuildTask", + "name": "myBuildTask", + "type": "Microsoft.ContainerRegistry/registries/buildTasks", + "location": "eastus", + "tags": { + "key": "value" + } + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksDelete.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksDelete.json new file mode 100644 index 000000000000..215abe8c4929 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildTaskName": "myBuildTask" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksGet.json new file mode 100644 index 000000000000..d6dbdf16c728 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildTaskName": "myBuildTask" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "alias": "myalias", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "isCommitTriggerEnabled": true + }, + "platform": { + "osType": "Linux", + "cpu": 2 + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/buildTasks/myBuildTask", + "name": "myBuildTask", + "type": "Microsoft.ContainerRegistry/registries/buildTasks", + "location": "eastus", + "tags": { + "testkey": "value" + } + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksList.json new file mode 100644 index 000000000000..b0cd9b85763f --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "$filter": "alias%20eq%20'myalias'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "alias": "myalias", + "status": "Enabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "isCommitTriggerEnabled": true + }, + "platform": { + "osType": "Linux", + "cpu": 2 + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/buildTasks/myBuildTask", + "name": "myBuildTask", + "type": "Microsoft.ContainerRegistry/registries/buildTasks", + "location": "eastus", + "tags": { + "testkey": "value" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksListSourceRepositoryProperties.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksListSourceRepositoryProperties.json new file mode 100644 index 000000000000..04eb9f6cadf8 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksListSourceRepositoryProperties.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildTaskName": "myBuildTask" + }, + "responses": { + "200": { + "body": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "sourceControlAuthProperties": { + "tokenType": "OAuth", + "token": "xxxxxx", + "scope": "repo" + }, + "isCommitTriggerEnabled": true + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksUpdate.json new file mode 100644 index 000000000000..2ef91ce9eedc --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildTasksUpdate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildTaskName": "myBuildTask", + "buildTaskUpdateParameters": { + "properties": { + "alias": "myalias", + "status": "Disabled", + "base_image_trigger": "Runtime", + "sourceRepository": { + "sourceControlAuthProperties": { + "token": "xxxxx", + "scope": "repo" + }, + "isCommitTriggerEnabled": false + }, + "platform": { + "osType": "Linux", + "cpu": 2 + } + }, + "tags": { + "key": "value" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.458Z", + "alias": "myalias", + "status": "Disabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "isCommitTriggerEnabled": false + }, + "platform": { + "osType": "Linux", + "cpu": 2 + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/buildTasks/myBuildTask", + "name": "myBuildTask", + "type": "Microsoft.ContainerRegistry/registries/buildTasks", + "location": "eastus", + "tags": { + "key": "value" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Updating", + "creationDate": "2018-01-25T06:54:23.458Z", + "alias": "myalias", + "status": "Disabled", + "sourceRepository": { + "sourceControlType": "Github", + "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs", + "isCommitTriggerEnabled": false + }, + "platform": { + "osType": "Linux", + "cpu": 2 + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/buildTasks/myBuildTask", + "name": "myBuildTask", + "type": "Microsoft.ContainerRegistry/registries/buildTasks", + "location": "eastus", + "tags": { + "key": "value" + } + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsCancel.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsCancel.json new file mode 100644 index 000000000000..f69babb8977f --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsCancel.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildId": "0accec26-d6de-4757-8e74-d080f38eaaab" + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsGet.json new file mode 100644 index 000000000000..023f23c69f2f --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsGet.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildId": "0accec26-d6de-4757-8e74-d080f38eaaab" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "buildId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z", + "buildType": "AutoBuild", + "createTime": "2018-01-25T05:13:51.618Z", + "startTime": "2018-01-25T05:50:51.618Z", + "finishTime": "2018-01-25T06:13:51.618Z", + "outputImages": [ + { + "registry": "myregistry.azurecr.io", + "repository": "myimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ], + "buildTask": "myBuildTask", + "imageUpdateTrigger": { + "id": "c0c43143-da5d-41ef-b9e1-e7d749272e88", + "timestamp": "2018-01-25T05:13:51.618Z", + "images": [ + { + "registry": "registry.hub.docker.com", + "repository": "mybaseimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ] + }, + "isArchiveEnabled": true, + "platform": { + "osType": "Linux", + "cpu": 2 + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/builds/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/builds" + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsGetLogLink.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsGetLogLink.json new file mode 100644 index 000000000000..10df05621c46 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsGetLogLink.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildId": "0accec26-d6de-4757-8e74-d080f38eaaab" + }, + "responses": { + "200": { + "body": { + "logLink": "https://registrystorageaccount.blob.core.windows.net/sascontainer/logs/0accec26-d6de-4757-8e74-d080f38eaaab/rawtext.log?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D" + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsList.json new file mode 100644 index 000000000000..ea36d7999541 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "$filter": "", + "$top": 10 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "buildId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z", + "buildType": "AutoBuild", + "createTime": "2018-01-25T05:13:51.618Z", + "startTime": "2018-01-25T05:50:51.618Z", + "finishTime": "2018-01-25T06:13:51.618Z", + "outputImages": [ + { + "registry": "myregistry.azurecr.io", + "repository": "myimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ], + "buildTask": "myBuildTask", + "imageUpdateTrigger": { + "id": "c0c43143-da5d-41ef-b9e1-e7d749272e88", + "timestamp": "2018-01-25T05:13:51.618Z", + "images": [ + { + "registry": "registry.hub.docker.com", + "repository": "mybaseimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ] + }, + "isArchiveEnabled": true, + "platform": { + "osType": "Linux", + "cpu": 2 + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/builds/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/builds" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsUpdate.json new file mode 100644 index 000000000000..1a499ee98249 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/BuildsUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "buildUpdateParameters": { + "isArchiveEnabled": true + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "buildId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z", + "buildType": "AutoBuild", + "createTime": "2018-01-25T05:13:51.618Z", + "startTime": "2018-01-25T05:50:51.618Z", + "finishTime": "2018-01-25T06:13:51.618Z", + "outputImages": [ + { + "registry": "myregistry.azurecr.io", + "repository": "myimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ], + "buildTask": "myBuildTask", + "imageUpdateTrigger": { + "id": "c0c43143-da5d-41ef-b9e1-e7d749272e88", + "timestamp": "2018-01-25T05:13:51.618Z", + "images": [ + { + "registry": "registry.hub.docker.com", + "repository": "mybaseimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ] + }, + "isArchiveEnabled": true, + "platform": { + "osType": "Linux", + "cpu": 2 + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/builds/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/builds" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Updating", + "buildId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z", + "buildType": "AutoBuild", + "createTime": "2018-01-25T05:13:51.618Z", + "startTime": "2018-01-25T05:50:51.618Z", + "finishTime": "2018-01-25T06:13:51.618Z", + "outputImages": [ + { + "registry": "myregistry.azurecr.io", + "repository": "myimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ], + "buildTask": "myBuildTask", + "imageUpdateTrigger": { + "id": "c0c43143-da5d-41ef-b9e1-e7d749272e88", + "timestamp": "2018-01-25T05:13:51.618Z", + "images": [ + { + "registry": "registry.hub.docker.com", + "repository": "mybaseimage", + "tag": "latest", + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0" + } + ] + }, + "isArchiveEnabled": true, + "platform": { + "osType": "Linux", + "cpu": 2 + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/builds/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/builds" + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/RegistriesGetBuildSourceUploadUrl.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/RegistriesGetBuildSourceUploadUrl.json new file mode 100644 index 000000000000..4f896136a1c9 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/RegistriesGetBuildSourceUploadUrl.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview" + }, + "responses": { + "200": { + "body": { + "relativePath": "source/201802130000/b52f12d8-c3d6-4d75-9107-220f0bfc681d.tar.gz", + "uploadUrl": "https://registrystorageaccount.blob.core.windows.net/registrycontainer/source/201802130000/b52f12d8-c3d6-4d75-9107-220f0bfc681d.tar.gz?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D" + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/RegistriesQueueBuild.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/RegistriesQueueBuild.json new file mode 100644 index 000000000000..a94ab9c28500 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/examples/RegistriesQueueBuild.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-02-01-preview", + "buildRequest": { + "type": "QuickBuild", + "imageNames": [ + "azurerest:testtag" + ], + "noCache": true, + "sourceLocation": "https://myaccount.blob.core.windows.net/sascontainer/source.zip?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D", + "buildArguments": [ + { + "type": "DockerBuildArgument", + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "type": "DockerBuildArgument", + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ], + "isPushEnabled": true, + "platform": { + "osType": "Linux", + "cpu": 2 + }, + "dockerFilePath": "DockerFile" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "buildId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/builds/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/builds" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json index 4e5e4f53945c..d9fe8dc7c709 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json @@ -15,6 +15,55 @@ "application/json" ], "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importImage": { + "post": { + "tags": [ + "Registries" + ], + "description": "Copies an image to this container registry from the specified container registry.", + "operationId": "Registries_ImportImage", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters specifying the image to copy and the source container registry.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportImageParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the operation has completed successfully." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "ImportImageByTag": { + "$ref": "./examples/ImportImageByTag.json" + }, + "ImportImageByManifestDigest": { + "$ref": "./examples/ImportImageByManifestDigest.json" + } + }, + "x-ms-long-running-operation": true + } + }, "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/checkNameAvailability": { "post": { "tags": [ @@ -442,6 +491,91 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listPolicies": { + "get": { + "tags": [ + "Registries" + ], + "description": "Lists the policies for the specified container registry.", + "operationId": "Registries_ListPolicies", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the registry policies were retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/RegistryPolicies" + } + } + }, + "x-ms-examples": { + "RegistryListPolicies": { + "$ref": "./examples/RegistryListPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/updatePolicies": { + "post": { + "tags": [ + "Registries" + ], + "description": "Updates the policies for the specified container registry.", + "operationId": "Registries_UpdatePolicies", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "name": "registryPoliciesUpdateParameters", + "in": "body", + "description": "The parameters for updating policies of a container registry.", + "required": true, + "schema": { + "$ref": "#/definitions/RegistryPolicies" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/RegistryPolicies" + } + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "RegistryUpdatePolicies": { + "$ref": "./examples/RegistryUpdatePolicies.json" + } + }, + "x-ms-long-running-operation": true + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}": { "get": { "tags": [ @@ -1014,12 +1148,69 @@ } }, "definitions": { + "ImportImageParameters": { + "required": [ + "source" + ], + "type": "object", + "properties": { + "source": { + "$ref": "#/definitions/ImportSource", + "description": "The source of the image." + }, + "targetTags": { + "description": "List of strings of the form repo[:tag]. When tag is omitted the source will be used (or 'latest' if source tag is also omitted).", + "type": "array", + "items": { + "type": "string" + } + }, + "untaggedTargetRepositories": { + "description": "List of strings of repository names to do a manifest only copy. No tag will be created.", + "type": "array", + "items": { + "type": "string" + } + }, + "mode": { + "description": "When Force, any existing target tags will be overwritten. When NoForce, any existing target tags will fail the operation before any copying begins.", + "default": "NoForce", + "enum": [ + "NoForce", + "Force" + ], + "type": "string", + "x-ms-enum": { + "name": "ImportMode", + "modelAsString": true + } + } + } + }, + "ImportSource": { + "required": [ + "resourceId", + "sourceImage" + ], + "type": "object", + "properties": { + "resourceId": { + "description": "The resource identifier of the target Azure Container Registry.", + "type": "string" + }, + "sourceImage": { + "description": "Repository name of the source image.\r\nSpecify an image by repository ('hello-world'). This will use the 'latest' tag.\r\nSpecify an image by tag ('hello-world:latest').\r\nSpecify an image by sha256-based manifest digest ('hello-world@sha256:abc123').", + "type": "string" + } + } + }, "RegistryNameCheckRequest": { "description": "A request to check whether a container registry name is available.", "required": [ "name", "type" ], + "type": "object", "properties": { "name": { "description": "The name of the container registry.", @@ -1043,6 +1234,7 @@ }, "RegistryNameStatus": { "description": "The result of a request to check the availability of a container registry name.", + "type": "object", "properties": { "nameAvailable": { "description": "The value that indicates whether the name is available.", @@ -1060,6 +1252,7 @@ }, "OperationListResult": { "description": "The result of a request to list container registry operations.", + "type": "object", "properties": { "value": { "description": "The list of container registry operations. Since this list may be incomplete, the nextLink field should be used to request the next list of operations.", @@ -1076,7 +1269,12 @@ }, "OperationDefinition": { "description": "The definition of a container registry operation.", + "type": "object", "properties": { + "origin": { + "description": "The origin information of the container registry operation.", + "type": "string" + }, "name": { "description": "Operation name: {provider}/{resource}/{operation}.", "type": "string" @@ -1084,11 +1282,17 @@ "display": { "$ref": "#/definitions/OperationDisplayDefinition", "description": "The display information for the container registry operation." + }, + "properties": { + "$ref": "#/definitions/OperationPropertiesDefinition", + "description": "The properties information for the container registry operation.", + "x-ms-client-flatten": true } } }, "OperationDisplayDefinition": { "description": "The display information for a container registry operation.", + "type": "object", "properties": { "provider": { "description": "The resource provider name: Microsoft.ContainerRegistry.", @@ -1108,11 +1312,65 @@ } } }, + "OperationPropertiesDefinition": { + "description": "The definition of Azure Monitoring properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/OperationServiceSpecificationDefinition", + "description": "The definition of Azure Monitoring service." + } + } + }, + "OperationServiceSpecificationDefinition": { + "description": "The definition of Azure Monitoring metrics list.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "A list of Azure Monitoring metrics definition.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetricSpecificationDefinition" + } + } + } + }, + "OperationMetricSpecificationDefinition": { + "description": "The definition of Azure Monitoring metric.", + "type": "object", + "properties": { + "name": { + "description": "Metric name.", + "type": "string" + }, + "displayName": { + "description": "Metric display name.", + "type": "string" + }, + "displayDescription": { + "description": "Metric description.", + "type": "string" + }, + "unit": { + "description": "Metric unit.", + "type": "string" + }, + "aggregationType": { + "description": "Metric aggregation type.", + "type": "string" + }, + "internalMetricName": { + "description": "Internal metric name.", + "type": "string" + } + } + }, "Registry": { "description": "An object that represents a container registry.", "required": [ "sku" ], + "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" @@ -1135,6 +1393,7 @@ "required": [ "name" ], + "type": "object", "properties": { "name": { "description": "The SKU name of the container registry. Required for registry creation.", @@ -1169,6 +1428,7 @@ }, "RegistryProperties": { "description": "The properties of a container registry.", + "type": "object", "properties": { "loginServer": { "description": "The URL that can be used to log into the container registry.", @@ -1216,6 +1476,7 @@ }, "Status": { "description": "The status of an Azure resource at the time the operation was called.", + "type": "object", "properties": { "displayStatus": { "description": "The short label for the status.", @@ -1240,6 +1501,7 @@ "required": [ "id" ], + "type": "object", "properties": { "id": { "description": "The resource ID of the storage account.", @@ -1249,6 +1511,7 @@ }, "RegistryUpdateParameters": { "description": "The parameters for updating a container registry.", + "type": "object", "properties": { "tags": { "description": "The tags for the container registry.", @@ -1270,6 +1533,7 @@ }, "RegistryPropertiesUpdateParameters": { "description": "The parameters for updating the properties of a container registry.", + "type": "object", "properties": { "adminUserEnabled": { "description": "The value that indicates whether the admin user is enabled.", @@ -1283,6 +1547,7 @@ }, "RegistryListResult": { "description": "The result of a request to list container registries.", + "type": "object", "properties": { "value": { "description": "The list of container registries. Since this list may be incomplete, the nextLink field should be used to request the next list of container registries.", @@ -1299,6 +1564,7 @@ }, "RegistryListCredentialsResult": { "description": "The response from the ListCredentials operation.", + "type": "object", "properties": { "username": { "description": "The username for a container registry.", @@ -1315,6 +1581,7 @@ }, "RegistryPassword": { "description": "The login password for the container registry.", + "type": "object", "properties": { "name": { "description": "The password name.", @@ -1339,6 +1606,7 @@ "required": [ "name" ], + "type": "object", "properties": { "name": { "description": "Specifies name of the password which should be regenerated -- password or password2.", @@ -1356,6 +1624,7 @@ }, "RegistryUsageListResult": { "description": "The result of a request to get container registry quota usages.", + "type": "object", "properties": { "value": { "description": "The list of container registry quota usages.", @@ -1368,6 +1637,7 @@ }, "RegistryUsage": { "description": "The quota usage for a container registry.", + "type": "object", "properties": { "name": { "description": "The name of the usage.", @@ -1397,8 +1667,70 @@ } } }, + "RegistryPolicies": { + "description": "An object that represents policies for a container registry.", + "type": "object", + "properties": { + "quarantinePolicy": { + "$ref": "#/definitions/QuarantinePolicy", + "description": "An object that represents quarantine policy for a container registry." + }, + "trustPolicy": { + "$ref": "#/definitions/TrustPolicy", + "description": "An object that represents content trust policy for a container registry." + } + } + }, + "QuarantinePolicy": { + "description": "An object that represents quarantine policy for a container registry.", + "type": "object", + "properties": { + "status": { + "description": "The value that indicates whether the policy is enabled or not.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyStatus", + "modelAsString": true + } + } + } + }, + "TrustPolicy": { + "description": "An object that represents content trust policy for a container registry.", + "type": "object", + "properties": { + "type": { + "description": "The type of trust policy.", + "enum": [ + "Notary" + ], + "type": "string", + "x-ms-enum": { + "name": "TrustPolicyType", + "modelAsString": true + } + }, + "status": { + "description": "The value that indicates whether the policy is enabled or not.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyStatus", + "modelAsString": true + } + } + } + }, "Replication": { "description": "An object that represents a replication for a container registry.", + "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" @@ -1414,6 +1746,7 @@ }, "ReplicationProperties": { "description": "The properties of a replication.", + "type": "object", "properties": { "provisioningState": { "description": "The provisioning state of the replication at the time the operation was called.", @@ -1441,6 +1774,7 @@ }, "ReplicationUpdateParameters": { "description": "The parameters for updating a replication.", + "type": "object", "properties": { "tags": { "description": "The tags for the replication.", @@ -1453,6 +1787,7 @@ }, "ReplicationListResult": { "description": "The result of a request to list replications for a container registry.", + "type": "object", "properties": { "value": { "description": "The list of replications. Since this list may be incomplete, the nextLink field should be used to request the next list of replications.", @@ -1469,6 +1804,7 @@ }, "Webhook": { "description": "An object that represents a webhook for a container registry.", + "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" @@ -1487,6 +1823,7 @@ "required": [ "actions" ], + "type": "object", "properties": { "status": { "description": "The status of the webhook at the time the operation was called.", @@ -1510,7 +1847,8 @@ "items": { "enum": [ "push", - "delete" + "delete", + "quarantine" ], "type": "string", "x-ms-enum": { @@ -1543,6 +1881,7 @@ "required": [ "location" ], + "type": "object", "properties": { "tags": { "description": "The tags for the webhook.", @@ -1568,6 +1907,7 @@ "serviceUri", "actions" ], + "type": "object", "properties": { "serviceUri": { "description": "The service URI for the webhook to post notifications.", @@ -1602,7 +1942,8 @@ "items": { "enum": [ "push", - "delete" + "delete", + "quarantine" ], "type": "string", "x-ms-enum": { @@ -1615,6 +1956,7 @@ }, "WebhookUpdateParameters": { "description": "The parameters for updating a webhook.", + "type": "object", "properties": { "tags": { "description": "The tags for the webhook.", @@ -1632,6 +1974,7 @@ }, "WebhookPropertiesUpdateParameters": { "description": "The parameters for updating the properties of a webhook.", + "type": "object", "properties": { "serviceUri": { "description": "The service URI for the webhook to post notifications.", @@ -1666,7 +2009,8 @@ "items": { "enum": [ "push", - "delete" + "delete", + "quarantine" ], "type": "string", "x-ms-enum": { @@ -1679,6 +2023,7 @@ }, "WebhookListResult": { "description": "The result of a request to list webhooks for a container registry.", + "type": "object", "properties": { "value": { "description": "The list of webhooks. Since this list may be incomplete, the nextLink field should be used to request the next list of webhooks.", @@ -1695,6 +2040,7 @@ }, "EventInfo": { "description": "The basic information of an event.", + "type": "object", "properties": { "id": { "description": "The event ID.", @@ -1707,6 +2053,7 @@ "required": [ "serviceUri" ], + "type": "object", "properties": { "serviceUri": { "description": "The service URI for the webhook to post notifications.", @@ -1723,6 +2070,7 @@ }, "EventListResult": { "description": "The result of a request to list events for a webhook.", + "type": "object", "properties": { "value": { "description": "The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events.", @@ -1739,6 +2087,7 @@ }, "Event": { "description": "The event for a webhook.", + "type": "object", "allOf": [ { "$ref": "#/definitions/EventInfo" @@ -1757,6 +2106,7 @@ }, "EventRequestMessage": { "description": "The event request message sent to the service URI.", + "type": "object", "properties": { "content": { "$ref": "#/definitions/EventContent", @@ -1785,6 +2135,7 @@ }, "EventResponseMessage": { "description": "The event response message received from the service URI.", + "type": "object", "properties": { "content": { "description": "The content of the event response message.", @@ -1813,6 +2164,7 @@ }, "EventContent": { "description": "The content of the event request message.", + "type": "object", "properties": { "id": { "description": "The event ID.", @@ -1847,6 +2199,7 @@ }, "Target": { "description": "The target of the event.", + "type": "object", "properties": { "mediaType": { "description": "The MIME type of the referenced object.", @@ -1882,6 +2235,7 @@ }, "Request": { "description": "The request that generated the event.", + "type": "object", "properties": { "id": { "description": "The ID of the request that initiated the event.", @@ -1907,6 +2261,7 @@ }, "Actor": { "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request.", + "type": "object", "properties": { "name": { "description": "The subject or username associated with the request context that generated the event.", @@ -1916,6 +2271,7 @@ }, "Source": { "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.", + "type": "object", "properties": { "addr": { "description": "The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port.", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/examples/ImportImageByManifestDigest.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/examples/ImportImageByManifestDigest.json new file mode 100644 index 000000000000..59b84917f276 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/examples/ImportImageByManifestDigest.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2017-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "parameters": { + "source": { + "resourceId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/sourceResourceGroup/providers/Microsoft.ContainerRegistry/registries/sourceRegistry", + "sourceImage": "sourceRepository@sha256:0000000000000000000000000000000000000000000000000000000000000000" + }, + "targetTags": [ + "targetRepository:targetTag" + ], + "untaggedTargetRepositories": [ + "targetRepository1" + ], + "mode": "Force" + } + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/examples/ImportImageByTag.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/examples/ImportImageByTag.json new file mode 100644 index 000000000000..d96ff742da6c --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/examples/ImportImageByTag.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2017-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "parameters": { + "source": { + "resourceId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/sourceResourceGroup/providers/Microsoft.ContainerRegistry/registries/sourceRegistry", + "sourceImage": "sourceRepository:sourceTag" + }, + "targetTags": [ + "targetRepository:targetTag" + ], + "untaggedTargetRepositories": [ + "targetRepository1" + ], + "mode": "Force" + } + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/examples/RegistryListPolicies.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/examples/RegistryListPolicies.json new file mode 100644 index 000000000000..cddbf1c5608d --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/examples/RegistryListPolicies.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2017-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry" + }, + "responses": { + "200": { + "body": { + "quarantinePolicy": { + "status": "enabled" + }, + "trustPolicy": { + "status": "enabled", + "type": "Notary" + } + } + } + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/examples/RegistryUpdatePolicies.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/examples/RegistryUpdatePolicies.json new file mode 100644 index 000000000000..0034006e180c --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/examples/RegistryUpdatePolicies.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2017-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "registryPoliciesUpdateParameters": { + "quarantinePolicy": { + "status": "disabled" + }, + "trustPolicy": { + "status": "enabled", + "type": "Notary" + } + } + }, + "responses": { + "200": { + "body": { + "quarantinePolicy": { + "status": "disabled" + }, + "trustPolicy": { + "status": "enabled", + "type": "Notary" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/readme.md b/specification/containerregistry/resource-manager/readme.md index 90ab69a7e321..4d0899d10ad5 100644 --- a/specification/containerregistry/resource-manager/readme.md +++ b/specification/containerregistry/resource-manager/readme.md @@ -29,6 +29,16 @@ openapi-type: arm tag: package-2017-10 ``` +### Tag: package-2018-02-preview + +These settings apply only when `--tag=package-2018-02-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-02-preview' +input-file: +- Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json +- Microsoft.ContainerRegistry/preview/2018-02-01-preview/containerregistry_build.json +``` + ### Tag: package-2017-10 These settings apply only when `--tag=package-2017-10` is specified on the command line. @@ -80,9 +90,12 @@ swagger-to-sdk: - repo: azure-sdk-for-python after_scripts: - python ./scripts/multiapi_init_gen.py azure-mgmt-containerregistry - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_container_registry'] ``` @@ -122,10 +135,22 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: + - tag: package-2018-02-preview - tag: package-2017-10 - tag: package-2017-03 ``` +### Tag: package-2018-02-preview and python + +These settings apply only when `--tag=package-2018-02-preview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-02-preview' && $(python) +python: + namespace: azure.mgmt.containerregistry.v2018_02_01_preview + output-folder: $(python-sdks-folder)/azure-mgmt-containerregistry/azure/mgmt/containerregistry/v2018_02_01_preview +``` + ### Tag: package-2017-10 and python These settings apply only when `--tag=package-2017-10 --python` is specified on the command line. @@ -164,12 +189,22 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-02-preview - tag: package-2017-10 - tag: package-2017-06-preview - tag: package-2017-03 - tag: package-2016-06-preview ``` +### Tag: package-2018-02-preview and go + +These settings apply only when `--tag=package-2018-02-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-02-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/containerregistry/mgmt/2018-02-01/containerregistry +``` + ### Tag: package-2017-10 and go These settings apply only when `--tag=package-2017-10 --go` is specified on the command line. @@ -185,7 +220,7 @@ These settings apply only when `--tag=package-2017-06-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-06-preview' && $(go) -output-folder: $(go-sdk-folder)/services/containerregistry/mgmt/2017-06-01-preview/containerregistry +output-folder: $(go-sdk-folder)/services/preview/containerregistry/mgmt/2017-06-01-preview/containerregistry ``` ### Tag: package-2017-03 and go @@ -203,7 +238,7 @@ These settings apply only when `--tag=package-2016-06-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2016-06-preview' && $(go) -output-folder: $(go-sdk-folder)/services/containerregistry/mgmt/2016-06-27-preview/containerregistry +output-folder: $(go-sdk-folder)/services/preview/containerregistry/mgmt/2016-06-27-preview/containerregistry ``` @@ -213,11 +248,86 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.containerregistry +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-containerregistry +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-02-preview + - tag: package-2017-10 + - tag: package-2017-06-preview + - tag: package-2017-03 + - tag: package-2016-06-preview +``` + +### Tag: package-2018-02-preview and java + +These settings apply only when `--tag=package-2018-02-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-02-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.containerregistry - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-containerregistry + namespace: com.microsoft.azure.management.containerregistry.v2018_02_01_preview + output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2018_02_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-10 and java + +These settings apply only when `--tag=package-2017-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerregistry.v2017_10_01 + output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2017_10_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-06-preview and java + +These settings apply only when `--tag=package-2017-06-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-06-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerregistry.v2017_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2017_06_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-03 and java + +These settings apply only when `--tag=package-2017-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerregistry.v2017_03_01 + output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2017_03_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-06-preview and java + +These settings apply only when `--tag=package-2016-06-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-06-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerregistry.v2016_06_27_preview + output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2016_06_27_preview +regenerate-manager: true +generate-interface: true ``` diff --git a/specification/containerregistry/resource-manager/readme.nodejs.md b/specification/containerregistry/resource-manager/readme.nodejs.md index be128d60d182..4b2007b25076 100644 --- a/specification/containerregistry/resource-manager/readme.nodejs.md +++ b/specification/containerregistry/resource-manager/readme.nodejs.md @@ -7,9 +7,12 @@ Please also specify `--node-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-10' && $(ruby) +namespace: "Azure::ContainerRegistry::Mgmt::V2017_10_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_registry/lib +``` + +### Tag: package-2017-06-preview and ruby + +These settings apply only when `--tag=package-2017-06-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-06-preview' && $(ruby) +namespace: "Azure::ContainerRegistry::Mgmt::V2017_06_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_registry/lib +``` + +### Tag: package-2017-03 and ruby + +These settings apply only when `--tag=package-2017-03 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-03' && $(ruby) +namespace: "Azure::ContainerRegistry::Mgmt::V2017_03_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_registry/lib +``` + +### Tag: package-2016-06-preview and ruby + +These settings apply only when `--tag=package-2016-06-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-06-preview' && $(ruby) +namespace: "Azure::ContainerRegistry::Mgmt::V2016_06_27_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_registry/lib +``` + diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json new file mode 100644 index 000000000000..f0d7ec663d6c --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json @@ -0,0 +1,558 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2016-03-30" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/containerServices": { + "get": { + "tags": [ + "ContainerServices" + ], + "operationId": "ContainerServices_List", + "description": "Gets a list of container services in the specified subscription. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerServiceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices/{containerServiceName}": { + "put": { + "tags": [ + "ContainerServices" + ], + "operationId": "ContainerServices_CreateOrUpdate", + "description": "Creates or updates a container service with the specified configuration of orchestrator, masters, and agents.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "containerServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container service in the specified subscription and resource group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerService" + }, + "description": "Parameters supplied to the Create or Update a Container Service operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerService" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ContainerService" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ContainerService" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ContainerService" + ], + "operationId": "ContainerServices_Get", + "description": "Gets the properties of the specified container service in the specified subscription and resource group. The operation returns the properties including state, orchestrator, number of masters and agents, and FQDNs of masters and agents. ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "containerServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container service in the specified subscription and resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerService" + } + } + } + }, + "delete": { + "tags": [ + "ContainerService" + ], + "operationId": "ContainerServices_Delete", + "description": "Deletes the specified container service in the specified subscription and resource group. The operation does not delete other resources created as part of creating a container service, including storage accounts, VMs, and availability sets. All the other resources created with the container service are part of the same resource group and can be deleted individually.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "containerServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container service in the specified subscription and resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "Not found" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices": { + "get": { + "tags": [ + "ContainerService" + ], + "operationId": "ContainerServices_ListByResourceGroup", + "description": "Gets a list of container services in the specified subscription and resource group. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerServiceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "ContainerServiceOrchestratorProfile": { + "properties": { + "orchestratorType": { + "type": "string", + "enum": [ + "Swarm", + "DCOS" + ], + "x-ms-enum": { + "name": "ContainerServiceOchestratorTypes", + "modelAsString": false + }, + "description": "The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom." + } + }, + "description": "Profile for the container service orchestrator.", + "required": [ "orchestratorType" ] + }, + "ContainerServiceMasterProfile": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "enum": [ + 1, + 3, + 5 + ], + "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.", + "default": 1 + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create the FQDN for master." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FDQN for the master." + } + }, + "required": [ + "dnsPrefix" + ], + "description": "Profile for the container service master." + }, + "ContainerServiceAgentPoolProfile": { + "properties": { + "name": { + "type": "string", + "description": "Unique name of the agent pool profile in the context of the subscription and resource group." + }, + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. " + }, + "vmSize": { + "type": "string", + "enum": [ + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5" + ], + "x-ms-enum": { + "name": "ContainerServiceVMSizeTypes", + "modelAsString": true + }, + "description": "Size of agent VMs." + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create the FQDN for the agent pool." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FDQN for the agent pool." + } + }, + "required": [ + "name", + "dnsPrefix", + "vmSize" + ], + "description": "Profile for the container service agent pool." + }, + "ContainerServiceWindowsProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Windows VMs" + }, + "adminPassword": { + "type": "string", + "description": "The administrator password to use for Windows VMs" + } + }, + "required": [ + "adminUsername", + "adminPassword" + ], + "description": "Profile for Windows VMs in the container service cluster." + }, + "ContainerServiceLinuxProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for all Linux VMs" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The ssh key configuration for Linux VMs." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceSshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "description": "the list of SSH public keys used to authenticate with Linux-based VMs." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": ["publicKeys"] + }, + "ContainerServiceSshPublicKey": { + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ContainerServiceDiagnosticsProfile": { + "properties": { + "vmDiagnostics": { + "$ref": "#/definitions/ContainerServiceVMDiagnostics", + "description": "Profile for the container service VM diagnostic agent." + } + }, + "required": ["vmDiagnostics"] + }, + "ContainerServiceVMDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the VM diagnostic agent is provisioned on the VM." + }, + "storageUri": { + "readOnly": true, + "type": "string", + "description": "The URI of the storage account where diagnostics are stored." + } + }, + "description": "Profile for diagnostics on the container service VMs.", + "required": [ + "enabled" + ] + }, + "ContainerService": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerServiceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Container service." + }, + "ContainerServiceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerService" + }, + "description": "the list of container services." + } + }, + "description": "The response from the List Container Services operation." + }, + "ContainerServiceProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "the current deployment or provisioning state, which only appears in the response." + }, + "orchestratorProfile": { + "$ref": "#/definitions/ContainerServiceOrchestratorProfile", + "description": "Properties of the orchestrator." + }, + "masterProfile": { + "$ref": "#/definitions/ContainerServiceMasterProfile", + "description": "Properties of master agents." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceAgentPoolProfile" + }, + "description": "Properties of the agent pool." + }, + "windowsProfile": { + "$ref": "#/definitions/ContainerServiceWindowsProfile", + "description": "Properties of Windows VMs." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "Properties of Linux VMs." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/ContainerServiceDiagnosticsProfile", + "description": "Properties of the diagnostic agent." + } + }, + "required": [ + "masterProfile", + "agentPoolProfiles", + "linuxProfile" + ], + "description": "Properties of the container service." + } + }, + "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/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json new file mode 100644 index 000000000000..3d65d2e69b3f --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json @@ -0,0 +1,609 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2016-09-30" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/containerServices": { + "get": { + "tags": [ + "ContainerServices" + ], + "operationId": "ContainerServices_List", + "summary": "Gets a list of container services in the specified subscription.", + "description": "Gets a list of container services in the specified subscription. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerServiceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices/{containerServiceName}": { + "put": { + "tags": [ + "ContainerServices" + ], + "operationId": "ContainerServices_CreateOrUpdate", + "summary": "Creates or updates a container service.", + "description": "Creates or updates a container service with the specified configuration of orchestrator, masters, and agents.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "containerServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container service in the specified subscription and resource group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerService" + }, + "description": "Parameters supplied to the Create or Update a Container Service operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerService" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ContainerService" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ContainerService" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ContainerService" + ], + "operationId": "ContainerServices_Get", + "summary":"Gets the properties of the specified container service.", + "description": "Gets the properties of the specified container service in the specified subscription and resource group. The operation returns the properties including state, orchestrator, number of masters and agents, and FQDNs of masters and agents. ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "containerServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container service in the specified subscription and resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerService" + } + } + } + }, + "delete": { + "tags": [ + "ContainerService" + ], + "operationId": "ContainerServices_Delete", + "summary": "Deletes the specified container service.", + "description": "Deletes the specified container service in the specified subscription and resource group. The operation does not delete other resources created as part of creating a container service, including storage accounts, VMs, and availability sets. All the other resources created with the container service are part of the same resource group and can be deleted individually.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "containerServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container service in the specified subscription and resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "Not found" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices": { + "get": { + "tags": [ + "ContainerService" + ], + "operationId": "ContainerServices_ListByResourceGroup", + "summary": "Gets a list of container services in the specified resource group.", + "description": "Gets a list of container services in the specified subscription and resource group. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerServiceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "ContainerServiceCustomProfile": { + "properties": { + "orchestrator": { + "type": "string", + "description": "The name of the custom orchestrator to use." + } + }, + "description": "Properties to configure a custom container service cluster.", + "required": ["orchestrator"] + }, + "ContainerServiceServicePrincipalProfile": { + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId", + "secret" + ] + }, + "ContainerServiceOrchestratorProfile": { + "properties": { + "orchestratorType": { + "type": "string", + "enum": [ + "Swarm", + "DCOS", + "Custom", + "Kubernetes" + ], + "x-ms-enum": { + "name": "ContainerServiceOchestratorTypes", + "modelAsString": false + }, + "description": "The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom." + } + }, + "description": "Profile for the container service orchestrator.", + "required": [ "orchestratorType" ] + }, + "ContainerServiceMasterProfile": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "enum": [ + 1, + 3, + 5 + ], + "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.", + "default": 1 + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create the FQDN for master." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FDQN for the master." + } + }, + "required": [ + "dnsPrefix" + ], + "description": "Profile for the container service master." + }, + "ContainerServiceAgentPoolProfile": { + "properties": { + "name": { + "type": "string", + "description": "Unique name of the agent pool profile in the context of the subscription and resource group." + }, + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "vmSize": { + "type": "string", + "enum": [ + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5" + ], + "x-ms-enum": { + "name": "ContainerServiceVMSizeTypes", + "modelAsString": true + }, + "description": "Size of agent VMs." + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create the FQDN for the agent pool." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FDQN for the agent pool." + } + }, + "required": [ + "name", + "dnsPrefix", + "count", + "vmSize" + ], + "description": "Profile for the container service agent pool." + }, + "ContainerServiceWindowsProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Windows VMs.", + "pattern": "^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$" + }, + "adminPassword": { + "type": "string", + "description": "The administrator password to use for Windows VMs.", + "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%\\^&\\*\\(\\)])[a-zA-Z\\d!@#$%\\^&\\*\\(\\)]{12,123}$" + } + }, + "required": [ + "adminUsername", + "adminPassword" + ], + "description": "Profile for Windows VMs in the container service cluster." + }, + "ContainerServiceLinuxProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[a-z][a-z0-9_-]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The ssh key configuration for Linux VMs." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceSshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "description": "the list of SSH public keys used to authenticate with Linux-based VMs." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": ["publicKeys"] + }, + "ContainerServiceSshPublicKey": { + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ContainerServiceDiagnosticsProfile": { + "properties": { + "vmDiagnostics": { + "$ref": "#/definitions/ContainerServiceVMDiagnostics", + "description": "Profile for the container service VM diagnostic agent." + } + }, + "required": ["vmDiagnostics"] + }, + "ContainerServiceVMDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the VM diagnostic agent is provisioned on the VM." + }, + "storageUri": { + "readOnly": true, + "type": "string", + "description": "The URI of the storage account where diagnostics are stored." + } + }, + "description": "Profile for diagnostics on the container service VMs.", + "required": [ + "enabled" + ] + }, + "ContainerService": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerServiceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Container service." + }, + "ContainerServiceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerService" + }, + "description": "the list of container services." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of container service results." + } + }, + "description": "The response from the List Container Services operation." + }, + "ContainerServiceProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "the current deployment or provisioning state, which only appears in the response." + }, + "orchestratorProfile": { + "$ref": "#/definitions/ContainerServiceOrchestratorProfile", + "description": "Properties of the orchestrator." + }, + "customProfile": { + "$ref": "#/definitions/ContainerServiceCustomProfile", + "description": "Properties for custom clusters." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ContainerServiceServicePrincipalProfile", + "description": "Properties for cluster service principals." + }, + "masterProfile": { + "$ref": "#/definitions/ContainerServiceMasterProfile", + "description": "Properties of master agents." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceAgentPoolProfile" + }, + "description": "Properties of the agent pool." + }, + "windowsProfile": { + "$ref": "#/definitions/ContainerServiceWindowsProfile", + "description": "Properties of Windows VMs." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "Properties of Linux VMs." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/ContainerServiceDiagnosticsProfile", + "description": "Properties of the diagnostic agent." + } + }, + "required": [ + "masterProfile", + "agentPoolProfiles", + "linuxProfile" + ], + "description": "Properties of the container service." + } + }, + "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/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json new file mode 100644 index 000000000000..203f1728ccb7 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json @@ -0,0 +1,652 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2017-01-31" + }, + "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.ContainerService/containerServices": { + "get": { + "tags": [ + "ContainerServices" + ], + "operationId": "ContainerServices_List", + "summary": "Gets a list of container services in the specified subscription.", + "description": "Gets a list of container services in the specified subscription. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerServiceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Container Services": { + "$ref": "./examples/ContainerServicesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices/{containerServiceName}": { + "put": { + "tags": [ + "ContainerServices" + ], + "operationId": "ContainerServices_CreateOrUpdate", + "summary": "Creates or updates a container service.", + "description": "Creates or updates a container service with the specified configuration of orchestrator, masters, and agents.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "containerServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container service in the specified subscription and resource group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerService" + }, + "description": "Parameters supplied to the Create or Update a Container Service operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerService" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ContainerService" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ContainerService" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Container Service": { + "$ref": "./examples/ContainerServicesCreate_Update.json" + } + } + }, + "get": { + "tags": [ + "ContainerService" + ], + "operationId": "ContainerServices_Get", + "summary":"Gets the properties of the specified container service.", + "description": "Gets the properties of the specified container service in the specified subscription and resource group. The operation returns the properties including state, orchestrator, number of masters and agents, and FQDNs of masters and agents. ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "containerServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container service in the specified subscription and resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerService" + } + } + }, + "x-ms-examples": { + "Get Container Service": { + "$ref": "./examples/ContainerServicesGet.json" + } + } + }, + "delete": { + "tags": [ + "ContainerService" + ], + "operationId": "ContainerServices_Delete", + "summary": "Deletes the specified container service.", + "description": "Deletes the specified container service in the specified subscription and resource group. The operation does not delete other resources created as part of creating a container service, including storage accounts, VMs, and availability sets. All the other resources created with the container service are part of the same resource group and can be deleted individually.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "containerServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container service in the specified subscription and resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "Not found" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Container Service": { + "$ref": "./examples/ContainerServicesDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices": { + "get": { + "tags": [ + "ContainerService" + ], + "operationId": "ContainerServices_ListByResourceGroup", + "summary": "Gets a list of container services in the specified resource group.", + "description": "Gets a list of container services in the specified subscription and resource group. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerServiceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Container Services by Resource Group": { + "$ref": "./examples/ContainerServicesListByResourceGroup.json" + } + } + } + } + }, + "definitions": { + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "ContainerServiceCustomProfile": { + "properties": { + "orchestrator": { + "type": "string", + "description": "The name of the custom orchestrator to use." + } + }, + "description": "Properties to configure a custom container service cluster.", + "required": ["orchestrator"] + }, + "ContainerServiceServicePrincipalProfile": { + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId", + "secret" + ] + }, + "ContainerServiceOrchestratorProfile": { + "properties": { + "orchestratorType": { + "type": "string", + "enum": [ + "Swarm", + "DCOS", + "Custom", + "Kubernetes" + ], + "x-ms-enum": { + "name": "ContainerServiceOrchestratorTypes", + "modelAsString": false + }, + "description": "The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom." + } + }, + "description": "Profile for the container service orchestrator.", + "required": [ "orchestratorType" ] + }, + "ContainerServiceMasterProfile": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "enum": [ + 1, + 3, + 5 + ], + "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.", + "default": 1 + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create the FQDN for master." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FDQN for the master." + } + }, + "required": [ + "dnsPrefix" + ], + "description": "Profile for the container service master." + }, + "ContainerServiceAgentPoolProfile": { + "properties": { + "name": { + "type": "string", + "description": "Unique name of the agent pool profile in the context of the subscription and resource group." + }, + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "vmSize": { + "type": "string", + "enum": [ + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5" + ], + "x-ms-enum": { + "name": "ContainerServiceVMSizeTypes", + "modelAsString": true + }, + "description": "Size of agent VMs." + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create the FQDN for the agent pool." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FDQN for the agent pool." + } + }, + "required": [ + "name", + "dnsPrefix", + "count", + "vmSize" + ], + "description": "Profile for the container service agent pool." + }, + "ContainerServiceWindowsProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Windows VMs.", + "pattern": "^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$" + }, + "adminPassword": { + "type": "string", + "description": "The administrator password to use for Windows VMs.", + "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%\\^&\\*\\(\\)])[a-zA-Z\\d!@#$%\\^&\\*\\(\\)]{12,123}$" + } + }, + "required": [ + "adminUsername", + "adminPassword" + ], + "description": "Profile for Windows VMs in the container service cluster." + }, + "ContainerServiceLinuxProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[a-z][a-z0-9_-]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The ssh key configuration for Linux VMs." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceSshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "description": "the list of SSH public keys used to authenticate with Linux-based VMs." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": ["publicKeys"] + }, + "ContainerServiceSshPublicKey": { + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ContainerServiceDiagnosticsProfile": { + "properties": { + "vmDiagnostics": { + "$ref": "#/definitions/ContainerServiceVMDiagnostics", + "description": "Profile for the container service VM diagnostic agent." + } + }, + "required": ["vmDiagnostics"] + }, + "ContainerServiceVMDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the VM diagnostic agent is provisioned on the VM." + }, + "storageUri": { + "readOnly": true, + "type": "string", + "description": "The URI of the storage account where diagnostics are stored." + } + }, + "description": "Profile for diagnostics on the container service VMs.", + "required": [ + "enabled" + ] + }, + "ContainerService": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerServiceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Container service." + }, + "ContainerServiceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerService" + }, + "description": "the list of container services." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of container service results." + } + }, + "description": "The response from the List Container Services operation." + }, + "ContainerServiceProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "the current deployment or provisioning state, which only appears in the response." + }, + "orchestratorProfile": { + "$ref": "#/definitions/ContainerServiceOrchestratorProfile", + "description": "Properties of the orchestrator." + }, + "customProfile": { + "$ref": "#/definitions/ContainerServiceCustomProfile", + "description": "Properties for custom clusters." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ContainerServiceServicePrincipalProfile", + "description": "Properties for cluster service principals." + }, + "masterProfile": { + "$ref": "#/definitions/ContainerServiceMasterProfile", + "description": "Properties of master agents." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceAgentPoolProfile" + }, + "description": "Properties of the agent pool." + }, + "windowsProfile": { + "$ref": "#/definitions/ContainerServiceWindowsProfile", + "description": "Properties of Windows VMs." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "Properties of Linux VMs." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/ContainerServiceDiagnosticsProfile", + "description": "Properties of the diagnostic agent." + } + }, + "required": [ + "masterProfile", + "agentPoolProfiles", + "linuxProfile" + ], + "description": "Properties of the container service." + } + }, + "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/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesCreate_Update.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesCreate_Update.json new file mode 100644 index 000000000000..bf8ab0544f08 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesCreate_Update.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2017-01-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "containerServiceName": "acs1", + "parameters": { + "location": "location1" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ContainerService/ContainerServices", + "location": "location1", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/containerServices/acs1", + "name": "acs1", + "properties": { + "provisioningState": "Creating", + "orchestratorProfile": { + "orchestratorType": "DCOS" + }, + "masterProfile": { + "count": 1, + "dnsPrefix": "acs1-rg1-e240e5mgmt", + "fqdn": "acs1-rg1-e240e5mgmt.location1.cloudapp.azure.com" + }, + "agentPoolProfiles": [ + { + "name": "agentpool0", + "count": 3, + "vmSize": "Standard_D2_v2", + "dnsPrefix": "acs1-rg1-e240e5agent", + "fqdn": "acs1-rg1-e240e5agent.location1.cloudapp.azure.com" + } + ], + "linuxProfile": { + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa AAAAB3NzaC1y...+0vNzo1FAdQ== user@hostname.local\n" + } + ] + }, + "adminUsername": "azureuser" + }, + "diagnosticsProfile": { + "vmDiagnostics": { + "enabled": true, + "storageUri": "https://mjwjtrv73stvgdiag0.blob.core.windows.net/" + } + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ContainerService/ContainerServices", + "location": "location1", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/containerServices/acs1", + "name": "acs1", + "properties": { + "provisioningState": "Creating", + "orchestratorProfile": { + "orchestratorType": "DCOS" + }, + "masterProfile": { + "count": 1, + "dnsPrefix": "acs1-rg1-e240e5mgmt", + "fqdn": "acs1-rg1-e240e5mgmt.location1.cloudapp.azure.com" + }, + "agentPoolProfiles": [ + { + "name": "agentpool0", + "count": 3, + "vmSize": "Standard_D2_v2", + "dnsPrefix": "acs1-rg1-e240e5agent", + "fqdn": "acs1-rg1-e240e5agent.location1.cloudapp.azure.com" + } + ], + "linuxProfile": { + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa AAAAB3NzaC1y...+0vNzo1FAdQ== user@hostname.local\n" + } + ] + }, + "adminUsername": "azureuser" + }, + "diagnosticsProfile": { + "vmDiagnostics": { + "enabled": true, + "storageUri": "https://mjwjtrv73stvgdiag0.blob.core.windows.net/" + } + } + } + } + }, + "202": { + "body": { + "type": "Microsoft.ContainerService/ContainerServices", + "location": "location1", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/containerServices/acs1", + "name": "acs1", + "properties": { + "provisioningState": "Creating", + "orchestratorProfile": { + "orchestratorType": "DCOS" + }, + "masterProfile": { + "count": 1, + "dnsPrefix": "acs1-rg1-e240e5mgmt", + "fqdn": "acs1-rg1-e240e5mgmt.location1.cloudapp.azure.com" + }, + "agentPoolProfiles": [ + { + "name": "agentpool0", + "count": 3, + "vmSize": "Standard_D2_v2", + "dnsPrefix": "acs1-rg1-e240e5agent", + "fqdn": "acs1-rg1-e240e5agent.location1.cloudapp.azure.com" + } + ], + "linuxProfile": { + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa AAAAB3NzaC1y...+0vNzo1FAdQ== user@hostname.local\n" + } + ] + }, + "adminUsername": "azureuser" + }, + "diagnosticsProfile": { + "vmDiagnostics": { + "enabled": true, + "storageUri": "https://mjwjtrv73stvgdiag0.blob.core.windows.net/" + } + } + } + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesDelete.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesDelete.json new file mode 100644 index 000000000000..691e38a6ccee --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2017-01-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "containerServiceName": "acs1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesGet.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesGet.json new file mode 100644 index 000000000000..e8d11268207f --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesGet.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2017-01-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "containerServiceName": "acs1" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ContainerService/ContainerServices", + "location": "location1", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/containerServices/acs1", + "name": "acs1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorProfile": { + "orchestratorType": "DCOS" + }, + "masterProfile": { + "count": 1, + "dnsPrefix": "acs1-rg1-e240e5mgmt", + "fqdn": "acs1-rg1-e240e5mgmt.location1.cloudapp.azure.com" + }, + "agentPoolProfiles": [ + { + "name": "agentpool0", + "count": 3, + "vmSize": "Standard_D2_v2", + "dnsPrefix": "acs1-rg1-e240e5agent", + "fqdn": "acs1-rg1-e240e5agent.location1.cloudapp.azure.com" + } + ], + "linuxProfile": { + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa AAAAB3NzaC1y...+0vNzo1FAdQ== user@hostname.local\n" + } + ] + }, + "adminUsername": "azureuser" + }, + "diagnosticsProfile": { + "vmDiagnostics": { + "enabled": true, + "storageUri": "https://mjwjtrv73stvgdiag0.blob.core.windows.net/" + } + } + } + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesList.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesList.json new file mode 100644 index 000000000000..314dcd634ab2 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesList.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2017-01-31", + "subscriptionId": "subid1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ContainerService/ContainerServices", + "location": "location1", + "id": "/subscriptions/subid1/resourceGroups/RG1/providers/Microsoft.ContainerService/containerServices/acs1", + "name": "acs1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorProfile": { + "orchestratorType": "DCOS" + }, + "masterProfile": { + "count": 1, + "dnsPrefix": "acs1-rg1-e240e5mgmt", + "fqdn": "acs1-rg1-e240e5mgmt.location1.cloudapp.azure.com" + }, + "agentPoolProfiles": [ + { + "name": "agentpool0", + "count": 3, + "vmSize": "Standard_D2_v2", + "dnsPrefix": "acs1-rg1-e240e5agent", + "fqdn": "acs1-rg1-e240e5agent.location1.cloudapp.azure.com" + } + ], + "linuxProfile": { + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa AAAAB3NzaC1y...+0vNzo1FAdQ== user@hostname.local\n" + } + ] + }, + "adminUsername": "azureuser" + }, + "diagnosticsProfile": { + "vmDiagnostics": { + "enabled": true, + "storageUri": "https://mjwjtrv73stvgdiag0.blob.core.windows.net/" + } + } + } + }, + { + "type": "Microsoft.ContainerService/ContainerServices", + "location": "location1", + "id": "/subscriptions/subid1/resourceGroups/RG1/providers/Microsoft.ContainerService/containerServices/acs2", + "name": "acs2", + "properties": { + "provisioningState": "Creating", + "orchestratorProfile": { + "orchestratorType": "DCOS" + }, + "masterProfile": { + "count": 1, + "dnsPrefix": "acs2-rg1-e240e5mgmt" + }, + "agentPoolProfiles": [ + { + "name": "agentpool0", + "count": 3, + "vmSize": "Standard_D2_v2", + "dnsPrefix": "acs2-rg1-e240e5agent" + } + ], + "linuxProfile": { + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa AAAAB3NzaC1y...+0vNzo1FAdQ== user@hostname.local\n" + } + ] + }, + "adminUsername": "azureuser" + }, + "diagnosticsProfile": { + "vmDiagnostics": { + "enabled": true + } + } + } + } + ] + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesListByResourceGroup.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesListByResourceGroup.json new file mode 100644 index 000000000000..9e8f9f378c2c --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesListByResourceGroup.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2017-01-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ContainerService/ContainerServices", + "location": "location1", + "id": "/subscriptions/subid1/resourceGroups/RG1/providers/Microsoft.ContainerService/containerServices/acs1", + "name": "acs1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorProfile": { + "orchestratorType": "DCOS" + }, + "masterProfile": { + "count": 1, + "dnsPrefix": "acs1-rg1-e240e5mgmt", + "fqdn": "acs1-rg1-e240e5mgmt.location1.cloudapp.azure.com" + }, + "agentPoolProfiles": [ + { + "name": "agentpool0", + "count": 3, + "vmSize": "Standard_D2_v2", + "dnsPrefix": "acs1-rg1-e240e5agent", + "fqdn": "acs1-rg1-e240e5agent.location1.cloudapp.azure.com" + } + ], + "linuxProfile": { + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa AAAAB3NzaC1y...+0vNzo1FAdQ== user@hostname.local\n" + } + ] + }, + "adminUsername": "azureuser" + }, + "diagnosticsProfile": { + "vmDiagnostics": { + "enabled": true, + "storageUri": "https://mjwjtrv73stvgdiag0.blob.core.windows.net/" + } + } + } + }, + { + "type": "Microsoft.ContainerService/ContainerServices", + "location": "location1", + "id": "/subscriptions/subid1/resourceGroups/RG1/providers/Microsoft.ContainerService/containerServices/acs2", + "name": "acs2", + "properties": { + "provisioningState": "Creating", + "orchestratorProfile": { + "orchestratorType": "DCOS" + }, + "masterProfile": { + "count": 1, + "dnsPrefix": "acs2-rg1-e240e5mgmt" + }, + "agentPoolProfiles": [ + { + "name": "agentpool0", + "count": 3, + "vmSize": "Standard_D2_v2", + "dnsPrefix": "acs2-rg1-e240e5agent" + } + ], + "linuxProfile": { + "ssh": { + "publicKeys": [ + { + "keyData": "ssh-rsa AAAAB3NzaC1y...+0vNzo1FAdQ== user@hostname.local\n" + } + ] + }, + "adminUsername": "azureuser" + }, + "diagnosticsProfile": { + "vmDiagnostics": { + "enabled": true + } + } + } + } + ] + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json index 3921648127e0..d2e5b36e5f9e 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json @@ -309,7 +309,7 @@ }, "ContainerServiceVnetSubnetID": { "type": "string", - "description": "VNet SubnetID specifies the vnet's subnet identifier. If you specify either master VNet Subnet, or agent VNet Subnet, you need to specify both. And they have to be in the same VNet." + "description": "VNet SubnetID specifies the vnet's subnet identifier." }, "ContainerServiceVMSize": { "type": "string", @@ -319,7 +319,6 @@ }, "description": "Size of agent VMs.", "enum": [ - "Standard_A0", "Standard_A1", "Standard_A10", "Standard_A11", @@ -338,8 +337,6 @@ "Standard_A8_v2", "Standard_A8m_v2", "Standard_A9", - "Standard_B1ms", - "Standard_B1s", "Standard_B2ms", "Standard_B2s", "Standard_B4ms", @@ -609,7 +606,7 @@ }, "vnetSubnetID": { "$ref": "#/definitions/ContainerServiceVnetSubnetID", - "description": "VNet SubnetID specifies the vnet's subnet identifier. If you specify either master VNet Subnet, or agent VNet Subnet, you need to specify both. And they have to be in the same VNet." + "description": "VNet SubnetID specifies the vnet's subnet identifier." }, "firstConsecutiveStaticIP": { "type": "string", @@ -678,18 +675,10 @@ }, "vnetSubnetID": { "$ref": "#/definitions/ContainerServiceVnetSubnetID", - "description": "VNet SubnetID specifies the vnet's subnet identifier. If you specify either master VNet Subnet, or agent VNet Subnet, you need to specify both. And they have to be in the same VNet." + "description": "VNet SubnetID specifies the vnet's subnet identifier." }, "osType": { - "type": "string", - "default": "Linux", - "enum": [ - "Linux", - "Windows" - ], - "x-ms-enum": { - "name": "OSType" - }, + "$ref": "#/definitions/OSType", "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." } }, @@ -875,6 +864,19 @@ "linuxProfile" ], "description": "Properties of the container service." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true + }, + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." } }, "parameters": { diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersCreate_Update.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersCreate_Update.json index fe9ba362dd7c..776ea8057293 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersCreate_Update.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersCreate_Update.json @@ -55,12 +55,13 @@ }, "provisioningState": "Succeeded", "servicePrincipalProfile": { - "clientId": "clientid", - "keyVaultSecretRef": null, - "secret": "secret" + "clientId": "clientid" } }, - "tags": "managedcluster", + "tags": { + "archv2": "", + "tier": "production" + }, "type": "Microsoft.ContainerService/ManagedClusters" } }, @@ -99,12 +100,13 @@ }, "provisioningState": "Succeeded", "servicePrincipalProfile": { - "clientId": "clientid", - "keyVaultSecretRef": null, - "secret": "secret" + "clientId": "clientid" } }, - "tags": "managedcluster", + "tags": { + "archv2": "", + "tier": "production" + }, "type": "Microsoft.ContainerService/ManagedClusters" } } diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGet.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGet.json index ace118713d2c..7eb0ed30a77c 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGet.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGet.json @@ -41,12 +41,13 @@ }, "provisioningState": "Succeeded", "servicePrincipalProfile": { - "clientId": "clientid", - "keyVaultSecretRef": null, - "secret": "secret" + "clientId": "clientid" } }, - "tags": "managed-cluster", + "tags": { + "archv2": "", + "tier": "production" + }, "type": "Microsoft.ContainerService/ManagedClusters" } } diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGetAccessProfile.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..cc52d7e84df7 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2017-08-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "kubeConfig1" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersList.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersList.json index f3cc91bf7b20..01b4f967211f 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersList.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersList.json @@ -41,12 +41,13 @@ }, "provisioningState": "Succeeded", "servicePrincipalProfile": { - "clientId": "clientid", - "keyVaultSecretRef": null, - "secret": "secret" + "clientId": "clientid" } }, - "tags": "managed-cluster", + "tags": { + "archv2": "", + "tier": "production" + }, "type": "Microsoft.ContainerService/ManagedClusters" } ] diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersListByResourceGroup.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersListByResourceGroup.json index 10a805e885d7..19c10ddee39d 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersListByResourceGroup.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersListByResourceGroup.json @@ -42,12 +42,13 @@ }, "provisioningState": "Succeeded", "servicePrincipalProfile": { - "clientId": "clientid", - "keyVaultSecretRef": null, - "secret": "secret" + "clientId": "clientid" } }, - "tags": "managed-cluster", + "tags": { + "archv2": "", + "tier": "production" + }, "type": "Microsoft.ContainerService/ManagedClusters" } ] diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json index 708158d96970..e171ee495c85 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json @@ -154,6 +154,58 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "Gets the accessProfile for the specified role name of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}": { "get": { "tags": [ @@ -161,7 +213,8 @@ ], "operationId": "ManagedClusters_GetAccessProfiles", "summary": "Gets access profile of a managed cluster.", - "description": "Gets the accessProfile for the specified role name of the managed cluster with a specified resource group and name.", + "deprecated": true, + "description": "Use ManagedClusters_GetAccessProfile instead.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -416,7 +469,7 @@ }, "ContainerServiceVnetSubnetID": { "type": "string", - "description": "VNet SubnetID specifies the vnet's subnet identifier. If you specify either master VNet Subnet, or agent VNet Subnet, you need to specify both. And they have to be in the same VNet." + "description": "VNet SubnetID specifies the vnet's subnet identifier." }, "ContainerServiceVMSize": { "type": "string", @@ -426,7 +479,6 @@ }, "description": "Size of agent VMs.", "enum": [ - "Standard_A0", "Standard_A1", "Standard_A10", "Standard_A11", @@ -445,8 +497,6 @@ "Standard_A8_v2", "Standard_A8m_v2", "Standard_A9", - "Standard_B1ms", - "Standard_B1s", "Standard_B2ms", "Standard_B2s", "Standard_B4ms", @@ -677,7 +727,7 @@ }, "vnetSubnetID": { "$ref": "#/definitions/ContainerServiceVnetSubnetID", - "description": "VNet SubnetID specifies the vnet's subnet identifier. If you specify either master VNet Subnet, or agent VNet Subnet, you need to specify both. And they have to be in the same VNet." + "description": "VNet SubnetID specifies the vnet's subnet identifier." }, "firstConsecutiveStaticIP": { "type": "string", @@ -746,7 +796,7 @@ }, "vnetSubnetID": { "$ref": "#/definitions/ContainerServiceVnetSubnetID", - "description": "VNet SubnetID specifies the vnet's subnet identifier. If you specify either master VNet Subnet, or agent VNet Subnet, you need to specify both. And they have to be in the same VNet." + "description": "VNet SubnetID specifies the vnet's subnet identifier." }, "osType": { "$ref": "#/definitions/OSType", diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersCreate_Update.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..7fa522c908d4 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "dnsPrefix": "dnsprefix1", + "storageProfile": "ManagedDisks", + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": { + }, + "enableRBAC": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "storageProfile": "ManagedDisks", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "storageProfile": "ManagedDisks", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersDelete.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..256226ac74e1 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGet.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..27878d955d24 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGet.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "storageProfile": "ManagedDisks", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGetAccessProfile.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..7a5b01a66992 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "kubeConfig1" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..0a0c1e57bfed --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + "1.8.1" + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + "1.8.1" + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersList.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersList.json new file mode 100644 index 000000000000..2006224c507e --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersList.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "subid1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "storageProfile": "ManagedDisks", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersListByResourceGroup.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..4e905dcb35a9 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "storageProfile": "ManagedDisks", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersUpdateTags.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..a34864c4c62d --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "storageProfile": "ManagedDisks", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json new file mode 100644 index 000000000000..b53f6cb77a24 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json @@ -0,0 +1,1359 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2018-03-31" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ContainerService/operations": { + "get": { + "tags": [ + "managedClusters" + ], + "operationId": "Operations_List", + "description": "Gets a list of compute operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "description": "Gets a list of managed clusters in the specified subscription. The operation returns properties of each managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "description": "Lists managed clusters in the specified subscription and resource group. The operation returns properties of each managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets upgrade profile for a managed cluster.", + "description": "Gets the details of the upgrade profile for a managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "Gets the accessProfile for the specified role name of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "description": "Gets the details of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "description": "Creates or updates a managed cluster with the specified configuration for agents and Kubernetes version.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "Parameters supplied to the Create or Update a Managed Cluster operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "description": "Updates a managed cluster with the specified tags.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "description": "Deletes the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "description": "The list of compute operations" + } + }, + "description": "The List Compute Operation operation response." + }, + "OperationValue": { + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the compute operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the compute operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Compute Operation Value Display." + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "OperationValueDisplay": { + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the compute operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Compute Operation Value Display." + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "TagsObject": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 1023, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ContainerServiceStorageProfile": { + "type": "string", + "x-ms-enum": { + "name": "ContainerServiceStorageProfileTypes", + "modelAsString": true + }, + "enum": [ + "StorageAccount", + "ManagedDisks" + ], + "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." + }, + "ContainerServiceVnetSubnetID": { + "type": "string", + "description": "VNet SubnetID specifies the vnet's subnet identifier." + }, + "ContainerServiceVMSize": { + "type": "string", + "x-ms-enum": { + "name": "ContainerServiceVMSizeTypes", + "modelAsString": true + }, + "description": "Size of agent VMs.", + "enum": [ + "Standard_A1", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2", + "Standard_A2_v2", + "Standard_A2m_v2", + "Standard_A3", + "Standard_A4", + "Standard_A4_v2", + "Standard_A4m_v2", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A8_v2", + "Standard_A8m_v2", + "Standard_A9", + "Standard_B2ms", + "Standard_B2s", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D11", + "Standard_D11_v2", + "Standard_D11_v2_Promo", + "Standard_D12", + "Standard_D12_v2", + "Standard_D12_v2_Promo", + "Standard_D13", + "Standard_D13_v2", + "Standard_D13_v2_Promo", + "Standard_D14", + "Standard_D14_v2", + "Standard_D14_v2_Promo", + "Standard_D15_v2", + "Standard_D16_v3", + "Standard_D16s_v3", + "Standard_D1_v2", + "Standard_D2", + "Standard_D2_v2", + "Standard_D2_v2_Promo", + "Standard_D2_v3", + "Standard_D2s_v3", + "Standard_D3", + "Standard_D32_v3", + "Standard_D32s_v3", + "Standard_D3_v2", + "Standard_D3_v2_Promo", + "Standard_D4", + "Standard_D4_v2", + "Standard_D4_v2_Promo", + "Standard_D4_v3", + "Standard_D4s_v3", + "Standard_D5_v2", + "Standard_D5_v2_Promo", + "Standard_D64_v3", + "Standard_D64s_v3", + "Standard_D8_v3", + "Standard_D8s_v3", + "Standard_DS1", + "Standard_DS11", + "Standard_DS11_v2", + "Standard_DS11_v2_Promo", + "Standard_DS12", + "Standard_DS12_v2", + "Standard_DS12_v2_Promo", + "Standard_DS13", + "Standard_DS13-2_v2", + "Standard_DS13-4_v2", + "Standard_DS13_v2", + "Standard_DS13_v2_Promo", + "Standard_DS14", + "Standard_DS14-4_v2", + "Standard_DS14-8_v2", + "Standard_DS14_v2", + "Standard_DS14_v2_Promo", + "Standard_DS15_v2", + "Standard_DS1_v2", + "Standard_DS2", + "Standard_DS2_v2", + "Standard_DS2_v2_Promo", + "Standard_DS3", + "Standard_DS3_v2", + "Standard_DS3_v2_Promo", + "Standard_DS4", + "Standard_DS4_v2", + "Standard_DS4_v2_Promo", + "Standard_DS5_v2", + "Standard_DS5_v2_Promo", + "Standard_E16_v3", + "Standard_E16s_v3", + "Standard_E2_v3", + "Standard_E2s_v3", + "Standard_E32-16s_v3", + "Standard_E32-8s_v3", + "Standard_E32_v3", + "Standard_E32s_v3", + "Standard_E4_v3", + "Standard_E4s_v3", + "Standard_E64-16s_v3", + "Standard_E64-32s_v3", + "Standard_E64_v3", + "Standard_E64s_v3", + "Standard_E8_v3", + "Standard_E8s_v3", + "Standard_F1", + "Standard_F16", + "Standard_F16s", + "Standard_F16s_v2", + "Standard_F1s", + "Standard_F2", + "Standard_F2s", + "Standard_F2s_v2", + "Standard_F32s_v2", + "Standard_F4", + "Standard_F4s", + "Standard_F4s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_F8", + "Standard_F8s", + "Standard_F8s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS4-4", + "Standard_GS4-8", + "Standard_GS5", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H16", + "Standard_H16m", + "Standard_H16mr", + "Standard_H16r", + "Standard_H8", + "Standard_H8m", + "Standard_L16s", + "Standard_L32s", + "Standard_L4s", + "Standard_L8s", + "Standard_M128-32ms", + "Standard_M128-64ms", + "Standard_M128ms", + "Standard_M128s", + "Standard_M64-16ms", + "Standard_M64-32ms", + "Standard_M64ms", + "Standard_M64s", + "Standard_NC12", + "Standard_NC12s_v2", + "Standard_NC12s_v3", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC24rs_v2", + "Standard_NC24rs_v3", + "Standard_NC24s_v2", + "Standard_NC24s_v3", + "Standard_NC6", + "Standard_NC6s_v2", + "Standard_NC6s_v3", + "Standard_ND12s", + "Standard_ND24rs", + "Standard_ND24s", + "Standard_ND6s", + "Standard_NV12", + "Standard_NV24", + "Standard_NV6" + ] + }, + "KeyVaultSecretRef": { + "properties": { + "vaultID": { + "type": "string", + "description": "Key vault identifier." + }, + "secretName": { + "type": "string", + "description": "The secret name." + }, + "version": { + "type": "string", + "description": "The secret version." + } + }, + "description": "Reference to a secret stored in Azure Key Vault.", + "required": [ + "vaultID", + "secretName" + ] + }, + "ContainerServiceServicePrincipalProfile": { + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + }, + "keyVaultSecretRef": { + "$ref": "#/definitions/KeyVaultSecretRef", + "description": "Reference to a secret stored in Azure Key Vault." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs. Either secret or keyVaultSecretRef must be specified.", + "required": [ + "clientId" + ] + }, + "ContainerServiceMasterProfile": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "enum": [ + 1, + 3, + 5 + ], + "x-ms-enum": { + "name": "Count", + "modelAsString": false + }, + "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.", + "default": 1 + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create the FQDN for the master pool." + }, + "vmSize": { + "$ref": "#/definitions/ContainerServiceVMSize", + "description": "Size of agent VMs." + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk", + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "vnetSubnetID": { + "$ref": "#/definitions/ContainerServiceVnetSubnetID", + "description": "VNet SubnetID specifies the vnet's subnet identifier." + }, + "firstConsecutiveStaticIP": { + "type": "string", + "description": "FirstConsecutiveStaticIP used to specify the first static ip of masters.", + "default": "10.240.255.5" + }, + "storageProfile": { + "$ref": "#/definitions/ContainerServiceStorageProfile", + "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FDQN for the master pool." + } + }, + "required": [ + "dnsPrefix", + "vmSize" + ], + "description": "Profile for the container service master." + }, + "ManagedClusterAgentPoolProfile": { + "properties": { + "name": { + "type": "string", + "description": "Unique name of the agent pool profile in the context of the subscription and resource group." + }, + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "vmSize": { + "$ref": "#/definitions/ContainerServiceVMSize", + "description": "Size of agent VMs." + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk", + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create the FQDN for the agent pool." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FDQN for the agent pool." + }, + "ports": { + "type": "array", + "items": { + "type": "integer", + "minimum": 1, + "maximum": 65535 + }, + "description": "Ports number array used to expose on this agent pool. The default opened ports are different based on your choice of orchestrator." + }, + "storageProfile": { + "$ref": "#/definitions/ContainerServiceStorageProfile", + "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." + }, + "vnetSubnetID": { + "$ref": "#/definitions/ContainerServiceVnetSubnetID", + "description": "VNet SubnetID specifies the vnet's subnet identifier." + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "Maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + } + }, + "required": [ + "name", + "vmSize" + ], + "description": "Profile for the container service agent pool." + }, + "ContainerServiceWindowsProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Windows VMs.", + "pattern": "^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$" + }, + "adminPassword": { + "type": "string", + "description": "The administrator password to use for Windows VMs.", + "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%\\^&\\*\\(\\)])[a-zA-Z\\d!@#$%\\^&\\*\\(\\)]{12,123}$" + } + }, + "required": [ + "adminUsername", + "adminPassword" + ], + "description": "Profile for Windows VMs in the container service cluster." + }, + "ContainerServiceLinuxProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[a-z][a-z0-9_-]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceNetworkProfile": { + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true + }, + "description": "Network plugin used for building Kubernetes network." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "calico" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true + }, + "description": "Network policy used for building Kubernetes network." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "dockerBridgeCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "172.17.0.1/16", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range." + } + }, + "description": "Profile of network configuration." + }, + "ContainerServiceSshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ContainerServiceDiagnosticsProfile": { + "properties": { + "vmDiagnostics": { + "$ref": "#/definitions/ContainerServiceVMDiagnostics", + "description": "Profile for diagnostics on the container service VMs." + } + }, + "description": "Profile for diagnostics on the container service cluster.", + "required": [ + "vmDiagnostics" + ] + }, + "ContainerServiceVMDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the VM diagnostic agent is provisioned on the VM." + }, + "storageUri": { + "readOnly": true, + "type": "string", + "description": "The URI of the storage account where diagnostics are stored." + } + }, + "description": "Profile for diagnostics on the container service VMs.", + "required": [ + "enabled" + ] + }, + "ManagedClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + }, + "kubernetesVersion": { + "type": "string", + "description": "Version of Kubernetes specified when creating the managed cluster." + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix specified when creating the managed cluster." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FDQN for the master pool." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "description": "Properties of the agent pool." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "Profile for Linux VMs in the container service cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ContainerServiceServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs. Either secret or keyVaultSecretRef must be specified." + }, + "addonProfiles": { + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "Profile of managed cluster add-on." + }, + "nodeResourceGroup": { + "readOnly": true, + "type": "string", + "description": "Name of the resource group containing agent pool nodes." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "Profile of network configuration." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "Profile of Azure Active Directory configuration." + } + }, + "description": "Properties of the managed cluster." + }, + "OrchestratorProfile": { + "properties": { + "orchestratorType": { + "type": "string", + "description": "Orchestrator type." + }, + "orchestratorVersion": { + "type": "string", + "description": "Orchestrator version (major, minor, patch)." + } + }, + "required": [ + "orchestratorType", + "orchestratorVersion" + ], + "description": "Contains information about orchestrator." + }, + "ManagedClusterAccessProfile": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "name": { + "type": "string", + "description": "Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "ContainerServiceOSTypes", + "modelAsString": true + }, + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "upgrades": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAADProfile": { + "properties": { + "clientAppID": { + "type": "string", + "description": "The client AAD application ID." + }, + "serverAppID": { + "type": "string", + "description": "The server AAD application ID." + }, + "serverAppSecret": { + "type": "string", + "description": "The server AAD application secret." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "required": [ + "clientAppID", + "serverAppID", + "serverAppSecret" + ], + "description": "AADProfile specifies attributes for Azure Active Directory integration." + }, + "ManagedClusterAddonProfile": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterUpgradeProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "Properties of upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true + }, + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/containerservices/resource-manager/readme.md b/specification/containerservices/resource-manager/readme.md index 99794ecb67e2..0a85d3b35182 100644 --- a/specification/containerservices/resource-manager/readme.md +++ b/specification/containerservices/resource-manager/readme.md @@ -34,7 +34,18 @@ These are the global settings for the ContainerServices API. ```yaml openapi-type: arm -tag: package-2017-09 +tag: package-2018-03 +``` + +### Tag: package-2018-03 + +These settings apply only when `--tag=package-2018-03` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03' +input-file: +- Microsoft.ContainerService/stable/2017-07-01/containerService.json +- Microsoft.ContainerService/stable/2018-03-31/managedClusters.json +- Microsoft.ContainerService/stable/2017-09-30/location.json ``` ### Tag: package-2017-09 @@ -67,6 +78,51 @@ input-file: - Microsoft.ContainerService/stable/2017-07-01/containerService.json ``` +### 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.ContainerService/stable/2017-08-31/managedClusters.json +``` + +### Tag: package-2017-09-only + +These settings apply only when `--tag=package-2017-09-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-09-only' +input-file: +- Microsoft.ContainerService/stable/2017-09-30/location.json +``` + +### Tag: package-2017-01-only + +These settings apply only when `--tag=package-2017-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-01-only' +input-file: +- Microsoft.ContainerService/stable/2017-01-31/containerService.json +``` + +### Tag: package-2016-09-only + +These settings apply only when `--tag=package-2016-09-only` is specified on the command line. + +``` yaml $(tag) == 'package-2016-09-only' +input-file: +- Microsoft.ContainerService/stable/2016-09-30/containerService.json +``` + +### Tag: package-2016-03-only + +These settings apply only when `--tag=package-2016-03-only` is specified on the command line. + +``` yaml $(tag) == 'package-2016-03-only' +input-file: +- Microsoft.ContainerService/stable/2016-03-30/containerService.json +``` + --- # Code Generation @@ -80,9 +136,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_container_service'] ``` @@ -100,11 +159,22 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-03 - tag: package-2017-09 - tag: package-2017-08 - tag: package-2017-07 ``` +### Tag: package-2018-03 and go + +These settings apply only when `--tag=package-2018-03 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2018-03' && $(go) +namespace: containerservice +output-folder: $(go-sdk-folder)/services/containerservice/mgmt/2018-03-31/containerservice +``` + ### Tag: package-2017-09 and go These settings apply only when `--tag=package-2017-09 --go` is specified on the command line. @@ -149,7 +219,7 @@ python: payload-flattening-threshold: 2 namespace: azure.mgmt.containerservice package-name: azure-mgmt-containerservice - package-version: 3.0.1 + package-version: 4.1.0 clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' @@ -170,13 +240,71 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.containerservice +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-containerservice +title: ContainerServiceManagementClient +description: "Container Service Client" +``` + +### Java multi-api +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-09-only + - tag: package-2017-08-only + - tag: package-2017-07 +``` + +### Tag: package-2017-09-only and java + +These settings apply only when `--tag=package-2017-09-only` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-09-only' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.containerservice - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-containerservice - title: ContainerServiceManagementClient - description: "Container Service Client" + namespace: com.microsoft.azure.management.containerservice.v2017_09_30 + output-folder: $(azure-libraries-for-java-folder)/containerservice/resource-manager/v2017_09_30 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-08-only and java + +These settings apply only when `--tag=package-2017-08-only` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-08-only' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2017_08_31 + output-folder: $(azure-libraries-for-java-folder)/containerservice/resource-manager/v2017_08_31 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-07 and java + +These settings apply only when `--tag=package-2017-07` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2017_07_01 + output-folder: $(azure-libraries-for-java-folder)/containerservice/resource-manager/v2017_07_01 +regenerate-manager: true +generate-interface: true +``` + +## Suppression + +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + from: managedClusters.json + reason: Name chamge of "enableRBAC" property would break compatibility + - suppress: TrackedResourcePatchOperation + from: containerService.json + reason: ACS service is deprecated so a PATCH endpoint won't be implemented ``` diff --git a/specification/containerservices/resource-manager/readme.ruby.md b/specification/containerservices/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..325465ffc2f7 --- /dev/null +++ b/specification/containerservices/resource-manager/readme.ruby.md @@ -0,0 +1,51 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_container_service +package-version: "0.17.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2016-03-only + - tag: package-2016-09-only + - tag: package-2017-01-only +``` + +### Tag: package-2016-03-only and ruby + +These settings apply only when `--tag=package-2016-03-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-03-only' && $(ruby) +namespace: "Azure::ContainerService::Mgmt::V2016_03_30" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_service/lib +title: "ContainerServiceClient" +``` + +### Tag: package-2016-09-only and ruby + +These settings apply only when `--tag=package-2016-09-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-09-only' && $(ruby) +namespace: "Azure::ContainerService::Mgmt::V2016_09_30" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_service/lib +title: "ContainerServiceClient" +``` + +### Tag: package-2017-01-only and ruby + +These settings apply only when `--tag=package-2017-01-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-01-only' && $(ruby) +namespace: "Azure::ContainerService::Mgmt::V2017_01_31" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_service/lib +title: "ContainerServiceClient" +``` diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json index ef31745c691c..6537f7c32499 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json @@ -337,8 +337,131 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/offlineRegion": { + "post": { + "operationId": "DatabaseAccounts_OfflineRegion", + "x-ms-examples": { + "CosmosDBDatabaseAccountOfflineRegion": { "$ref": "./examples/CosmosDBDatabaseAccountOfflineRegion.json" } + }, + "description": "Offline the specified region for the specified Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "regionParameterForOffline", + "in": "body", + "required": true, + "description": "Cosmos DB region to offline for the database account.", + "schema": { + "$ref": "#/definitions/RegionForOnlineOffline" + } + } + ], + "responses": { + "200": { + "description": "The offline region operation is completed successfully." + }, + "202": { + "description": "Accepted. The offline region operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/onlineRegion": { + "post": { + "operationId": "DatabaseAccounts_OnlineRegion", + "x-ms-examples": { + "CosmosDBDatabaseAccountOnlineRegion": { "$ref": "./examples/CosmosDBDatabaseAccountOnlineRegion.json" } + }, + "description": "Online the specified region for the specified Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "regionParameterForOnline", + "in": "body", + "required": true, + "description": "Cosmos DB region to online for the database account.", + "schema": { + "$ref": "#/definitions/RegionForOnlineOffline" + } + } + ], + "responses": { + "200": { + "description": "The online region operation is completed successfully." + }, + "202": { + "description": "Accepted. The online region operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys": { "get": { + "operationId": "DatabaseAccounts_GetReadOnlyKeys", + "x-ms-examples": { + "CosmosDBDatabaseAccountListReadOnlyKeys": { "$ref": "./examples/CosmosDBDatabaseAccountListReadOnlyKeys.json" } + }, + "description": "Lists the read-only access keys for the specified Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountListReadOnlyKeysResult" + } + } + } + }, + "post": { "operationId": "DatabaseAccounts_ListReadOnlyKeys", "x-ms-examples": { "CosmosDBDatabaseAccountListReadOnlyKeys": { "$ref": "./examples/CosmosDBDatabaseAccountListReadOnlyKeys.json" } @@ -1261,6 +1384,19 @@ }, "description": "The List operation response, that contains the database accounts and their properties." }, + "ErrorResponse": { + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + }, + "description": "Error Response." + }, "FailoverPolicies": { "properties": { "failoverPolicies": { @@ -1297,6 +1433,18 @@ } } }, + "RegionForOnlineOffline": { + "properties": { + "region": { + "type": "string", + "description": "Cosmos DB region, with spaces between words and each word capitalized." + } + }, + "required": [ + "region" + ], + "description": "Cosmos DB region to online or offline." + }, "Location": { "description": "A region in which the Azure Cosmos DB database account is deployed.", "type": "object", diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBDatabaseAccountOfflineRegion.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBDatabaseAccountOfflineRegion.json new file mode 100644 index 000000000000..bd8dec50b239 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBDatabaseAccountOfflineRegion.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2015-04-08", + "subscriptionId": "subid", + "region":"North Europe" + }, + "responses": { + "200": { }, + "202": { } + } +} \ No newline at end of file diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBDatabaseAccountOnlineRegion.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBDatabaseAccountOnlineRegion.json new file mode 100644 index 000000000000..bd8dec50b239 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBDatabaseAccountOnlineRegion.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2015-04-08", + "subscriptionId": "subid", + "region":"North Europe" + }, + "responses": { + "200": { }, + "202": { } + } +} \ No newline at end of file diff --git a/specification/cosmos-db/resource-manager/readme.md b/specification/cosmos-db/resource-manager/readme.md index a321e629250d..abb18ec08e80 100644 --- a/specification/cosmos-db/resource-manager/readme.md +++ b/specification/cosmos-db/resource-manager/readme.md @@ -96,7 +96,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node ``` @@ -164,11 +164,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.cosmosdb +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-cosmosdb +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-04 +``` + +### Tag: package-2015-04 and java + +These settings apply only when `--tag=package-2015-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-04' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.cosmosdb - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-cosmosdb + namespace: com.microsoft.azure.management.cosmosdb.v2015_04_08 + output-folder: $(azure-libraries-for-java-folder)/cosmosdb/resource-manager/v2015_04_08 +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/costmanagement.json new file mode 100644 index 000000000000..8de2e71171c7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/costmanagement.json @@ -0,0 +1,1380 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-05-31", + "title": "CostManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reportconfigs": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "ReportConfig_List", + "description": "Lists all report configs for a subscription.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReportConfigList": { + "$ref": "./examples/ReportConfigList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReportConfigListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reportconfigs": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "ReportConfig_ListByResourceGroupName", + "description": "Lists all report configs for a resource group under a subscription.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReportConfigList": { + "$ref": "./examples/ReportConfigList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReportConfigListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reportconfigs/{reportConfigName}": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "ReportConfig_Get", + "description": "Gets the report config for a subscription by report config name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "Report": { + "$ref": "./examples/ReportConfig.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/reportConfigNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReportConfig" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Reports" + ], + "operationId": "ReportConfig_CreateOrUpdate", + "description": "The operation to create or update a report config. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "CreateOrUpdateReport": { + "$ref": "./examples/ReportConfigCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/reportConfigNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReportConfig" + }, + "description": "Parameters supplied to the CreateOrUpdate Report Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReportConfig" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/ReportConfig" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Reports" + ], + "operationId": "ReportConfig_Delete", + "description": "The operation to delete a report.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "DeleteReport": { + "$ref": "./examples/ReportConfigDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/reportConfigNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reportconfigs/{reportConfigName}": { + "get": { + "tags": [ + "Reports" + ], + "operationId": "ReportConfig_GetByResourceGroupName", + "description": "Gets the report config for a resource group under a subscription by report config name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReportConfig": { + "$ref": "./examples/ReportConfig.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/reportConfigNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReportConfig" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Reports" + ], + "operationId": "ReportConfig_CreateOrUpdateByResourceGroupName", + "description": "The operation to create or update a report config. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "CreateOrUpdateReport": { + "$ref": "./examples/ReportConfigCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/reportConfigNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReportConfig" + }, + "description": "Parameters supplied to the CreateOrUpdate Report Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ReportConfig" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/ReportConfig" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Reports" + ], + "operationId": "ReportConfig_DeleteByResourceGroupName", + "description": "The operation to delete a report config.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "DeleteReport": { + "$ref": "./examples/ReportConfigDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/reportConfigNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "BillingAccountDimensions_List", + "description": "Lists the dimensions by billingAccount Id.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "BillingAccountDimensionsList": { + "$ref": "./examples/BillingAccountDimensionsList.json" + }, + "BillingAccountDimensionsListExpandAndTop": { + "$ref": "./examples/BillingAccountDimensionsListExpandAndTop.json" + }, + "BillingAccountDimensionsListWithFilter": { + "$ref": "./examples/BillingAccountDimensionsListWithFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "name": "$filter", + "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DimensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "SubscriptionDimensions_List", + "description": "Lists the dimensions by subscription Id.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "SubscriptionDimensionsList": { + "$ref": "./examples/SubscriptionDimensionsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "name": "$filter", + "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DimensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "ResourceGroupDimensions_List", + "description": "Lists the dimensions by resource group Id.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ResourceGroupDimensionsList": { + "$ref": "./examples/ResourceGroupDimensionsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "$filter", + "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DimensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/Query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "QuerySubscription", + "description": "Lists the usage data for subscriptionId.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "SubscriptionQuery": { + "$ref": "./examples/SubscriptionQuery.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReportConfigDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Report Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/Query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "QueryResourceGroup", + "description": "Lists the usage data for subscriptionId and resource group.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ResourceGroupQuery": { + "$ref": "./examples/ResourceGroupQuery.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReportConfigDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Report Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/Query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "QueryBillingAccount", + "description": "Lists the usage data for billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "BillingAccountQuery": { + "$ref": "./examples/BillingAccountQuery.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReportConfigDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Report Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "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 + } + } + }, + "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" + } + } + }, + "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." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "x-ms-azure-resource": true + }, + "ReportConfigListResult": { + "description": "Result of listing report configs. It contains a list of available report configurations in the scope provided.", + "properties": { + "value": { + "description": "The list of report configs.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ReportConfig" + } + } + } + }, + "ReportConfig": { + "description": "A report config resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReportConfigProperties", + "title": "Report config properties" + } + } + }, + "ReportConfigProperties": { + "description": "The properties of the report config.", + "properties": { + "schedule": { + "description": "Has schedule information for the report config.", + "$ref": "#/definitions/ReportConfigSchedule" + }, + "format": { + "description": "The format of the report being delivered.", + "type": "string", + "enum": [ + "Csv" + ], + "x-ms-enum": { + "name": "FormatType", + "modelAsString": true + } + }, + "deliveryInfo": { + "description": "Has delivery information for the report config.", + "$ref": "#/definitions/ReportConfigDeliveryInfo" + }, + "definition": { + "description": "Has definition for the report config.", + "$ref": "#/definitions/ReportConfigDefinition" + } + }, + "required": [ + "deliveryInfo", + "definition" + ] + }, + "ReportConfigSchedule": { + "description": "The schedule associated with a report config.", + "properties": { + "status": { + "description": "The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused.", + "type": "string", + "enum": [ + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "StatusType", + "modelAsString": true + } + }, + "recurrence": { + "description": "The schedule recurrence.", + "type": "string", + "enum": [ + "Daily", + "Weekly", + "Monthly", + "Annually" + ], + "x-ms-enum": { + "name": "RecurrenceType", + "modelAsString": true + } + }, + "recurrencePeriod": { + "description": "Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.", + "$ref": "#/definitions/ReportConfigRecurrencePeriod" + } + }, + "required": [ + "recurrence", + "recurrencePeriod" + ] + }, + "ReportConfigDeliveryInfo": { + "description": "The delivery information associated with a report config.", + "properties": { + "destination": { + "description": "Has destination for the report being delivered.", + "$ref": "#/definitions/ReportConfigDeliveryDestination" + } + }, + "required": [ + "destination" + ] + }, + "ReportConfigDefinition": { + "description": "The definition of a report config.", + "properties": { + "type": { + "description": "The type of the report.", + "type": "string", + "enum": [ + "Usage" + ], + "x-ms-enum": { + "name": "ReportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the report. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "WeekToDate", + "MonthToDate", + "YearToDate", + "Custom" + ], + "x-ms-enum": { + "name": "TimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the report.", + "$ref": "#/definitions/ReportConfigTimePeriod" + }, + "dataset": { + "description": "Has definition for data in this report config.", + "$ref": "#/definitions/ReportConfigDataset" + } + }, + "required": [ + "type", + "timeframe" + ] + }, + "ReportConfigRecurrencePeriod": { + "description": "The start and end date for recurrence schedule.", + "properties": { + "from": { + "description": "The start date of recurrence.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date of recurrence. If not provided, we default this to 10 years from the start date.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from" + ] + }, + "ReportConfigDeliveryDestination": { + "description": "The destination information for the delivery of the report.", + "properties": { + "resourceId": { + "description": "The resource id of the storage account where reports will be delivered.", + "type": "string" + }, + "container": { + "description": "The name of the container where reports will be uploaded.", + "type": "string" + }, + "rootFolderPath": { + "description": "The name of the directory where reports will be uploaded.", + "type": "string" + } + }, + "required": [ + "resourceId", + "container" + ] + }, + "ReportConfigTimePeriod": { + "description": "The start and end date for pulling data for the report.", + "properties": { + "from": { + "description": "The start date to pull data from.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date to pull data to.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "ReportConfigDataset": { + "description": "The definition of data present in the report.", + "properties": { + "granularity": { + "description": "The granularity of rows in the report.", + "type": "string", + "enum": [ + "Daily" + ], + "x-ms-enum": { + "name": "GranularityType", + "modelAsString": true + } + }, + "configuration": { + "description": "Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided.", + "$ref": "#/definitions/ReportConfigDatasetConfiguration" + }, + "aggregation": { + "type": "object", + "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have upto 2 aggregation clauses.", + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/ReportConfigAggregation" + }, + "maxItems": 2 + }, + "grouping": { + "description": "Array of group by expression to use in the report. Report can have upto 2 group by clauses.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigGrouping" + }, + "maxItems": 2 + }, + "filter": { + "type": "object", + "description": "Has filter expression to use in the report.", + "$ref": "#/definitions/ReportConfigFilter" + } + } + }, + "ReportConfigDatasetConfiguration": { + "description": "The configuration of dataset in the report.", + "properties": { + "columns": { + "description": "Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ReportConfigAggregation": { + "description": "The aggregation expression to be used in the report.", + "properties": { + "name": { + "description": "The name of the column to aggregate.", + "type": "string" + }, + "function": { + "description": "The name of the aggregation function to use.", + "type": "string", + "enum": [ + "Sum" + ], + "x-ms-enum": { + "name": "FunctionType", + "modelAsString": true + } + } + }, + "required": [ + "name", + "function" + ] + }, + "ReportConfigGrouping": { + "description": "The group by expression to be used in the report.", + "properties": { + "columnType": { + "description": "Has type of the column to group.", + "$ref": "#/definitions/ReportConfigColumnType" + }, + "name": { + "description": "The name of the column to group.", + "type": "string" + } + }, + "required": [ + "columnType", + "name" + ] + }, + "ReportConfigFilter": { + "description": "The filter expression to be used in the report.", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have atleast 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigFilter" + }, + "minItems": 2 + }, + "or": { + "description": "The logical \"OR\" expression. Must have atleast 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigFilter" + }, + "minItems": 2 + }, + "not": { + "description": "The logical \"NOT\" expression.", + "$ref": "#/definitions/ReportConfigFilter" + }, + "dimension": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/ReportConfigComparisonExpression" + }, + "tag": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/ReportConfigComparisonExpression" + } + } + }, + "ReportConfigColumnType": { + "description": "The type of the column in the report.", + "type": "string", + "enum": [ + "Tag", + "Dimension" + ], + "x-ms-enum": { + "name": "ReportConfigColumnType", + "modelAsString": true + } + }, + "ReportConfigComparisonExpression": { + "description": "The comparison expression to be used in the report.", + "properties": { + "name": { + "description": "The name of the column to use in comaprison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In" + ], + "x-ms-enum": { + "name": "OperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "DimensionsListResult": { + "description": "Result of listing dimensions. It contains a list of available dimensions.", + "type": "object", + "properties": { + "value": { + "description": "The list of dimensions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Dimension" + } + } + } + }, + "Dimension": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DimensionProperties", + "title": "Dimension properties" + } + } + }, + "DimensionProperties": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "string" + } + }, + "total": { + "format": "int32", + "type": "integer" + }, + "category": { + "type": "string" + }, + "usageStart": { + "format": "date-time", + "type": "string" + }, + "usageEnd": { + "format": "date-time", + "type": "string" + }, + "nextLink": { + "type": "string" + } + } + }, + "QueryResult": { + "description": "Result of query. It contains all columns listed under groupings and aggregation.", + "type": "object", + "properties": { + "value": { + "description": "The list of usage data.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Query" + } + } + } + }, + "Query": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/QueryProperties", + "title": "Query properties" + } + } + }, + "QueryProperties": { + "type": "object", + "properties": { + "nextLink": { + "type": "string" + }, + "columns": { + "description": "Array of columns", + "type": "array", + "items": { + "$ref": "#/definitions/QueryColumn" + } + }, + "rows": { + "type": "array", + "items": { + "type": "array", + "items": {} + } + } + } + }, + "QueryColumn": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. The current version is 2018-05-31." + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Azure Resource Group Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingAccountIdParameter": { + "name": "billingAccountId", + "in": "path", + "description": "BillingAccount ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "reportConfigNameParameter": { + "name": "reportConfigName", + "in": "path", + "description": "Report Config Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/BillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/BillingAccountDimensionsList.json new file mode 100644 index 000000000000..23a7b5d6e43a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/BillingAccountDimensionsList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "billingAccountId": "100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.consumption/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.consumption/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/BillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/BillingAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..87d9d31d7bc9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/BillingAccountDimensionsListExpandAndTop.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "billingAccountId": "100", + "$expand": "properties/data", + "$top": "5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.consumption/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.consumption/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/BillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/BillingAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..db8aab50eec2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/BillingAccountDimensionsListWithFilter.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "billingAccountId": "100", + "$expand": "properties/data", + "$top": "5", + "$filter": "properties/category eq 'instanceId'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.consumption/dimensions_InstanceId_2018-05-01_2018-05-31_5", + "name": "dimensions_InstanceId_2018-05-01_2018-05-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "/subscriptions/39ae8bea-c3fd-4e24-8936-7c34974326ce/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/39ae8bea-c3fd-4e24-8936-7c34974326ce/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/39ae8bea-c3fd-4e24-8936-7c34974326ce/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "InstanceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "nextLink": "http://management.azure.com/ccmapi/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.Consumption/Dimensions?$filter=properties/category eq 'instanceId'&$top=5&api-version=2018-05-31&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/BillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/BillingAccountQuery.json new file mode 100644 index 000000000000..1ef7260472f9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/BillingAccountQuery.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "billingAccountId": "70664866", + "parameters":{ + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "configuration": { + "columns": [ + "PreTaxCost", + "ResourceGroup", + "UsageDate" + ] + }, + "filter":{ + "and": [ + { + "or":[ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2018-05-31&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331 + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331 + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331 + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331 + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ReportConfig.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ReportConfig.json new file mode 100644 index 000000000000..4e247bd74fc9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ReportConfig.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "reportConfigName": "TestReportConfig" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/reportconfigs/TestReportConfig", + "name": "TestReportConfig", + "type": "Microsoft.Consumption/reportconfigs", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "reports", + "rootFolderPath": "ad-hoc" + } + }, + "definition":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-06-01T00:00:00Z", + "to": "2018-10-31T00:00:00Z" + }, + "dataset": { + "granularity": "Daily", + "configuration": { + "columns": [ + "UsageDate", + "MeterId", + "InstanceId", + "ResourceLocation", + "UsageQuantity" + ] + }, + "aggregation": { + "usageSum": { + "name": "UsageQuantity", + "function": "Sum" + } + }, + "grouping": [ + { + "columnType": "Dimension", + "name": "SubscriptionName" + }, + { + "columnType": "Tag", + "name": "Environment" + } + ], + "filter":{ + "and": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "Contains", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ReportConfigCreateOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ReportConfigCreateOrUpdate.json new file mode 100644 index 000000000000..2125aa4fd520 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ReportConfigCreateOrUpdate.json @@ -0,0 +1,287 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "reportConfigName": "TestReportConfig", + "parameters": { + "properties": { + "schedule":{ + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from":"2018-06-01T00:00:00Z", + "to":"2018-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "reports", + "rootFolderPath": "ad-hoc" + } + }, + "definition":{ + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "InstanceId", + "ResourceLocation", + "PreTaxCost" + ] + }, + "aggregation": { + "costSum": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "columnType": "Dimension", + "name": "SubscriptionName" + }, + { + "columnType": "Tag", + "name": "Environment" + } + ], + "filter":{ + "and": [ + { + "or":[ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/reportconfigs/TestReportConfig", + "name": "TestReportConfig", + "type": "Microsoft.Consumption/reportconfigs", + "properties": { + "schedule":{ + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from":"2018-06-01T00:00:00Z", + "to":"2018-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "reports", + "rootFolderPath": "ad-hoc" + } + }, + "definition":{ + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "InstanceId", + "ResourceLocation", + "PreTaxCost" + ] + }, + "aggregation": { + "costSum": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "columnType": "Dimension", + "name": "SubscriptionName" + }, + { + "columnType": "Tag", + "name": "Environment" + } + ], + "filter":{ + "and": [ + { + "or":[ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/reportconfigs/TestReportConfig", + "name": "TestReportConfig", + "type": "Microsoft.Consumption/reportconfigs", + "properties": { + "schedule":{ + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from":"2018-06-01T00:00:00Z", + "to":"2018-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "reports", + "rootFolderPath": "ad-hoc" + } + }, + "definition":{ + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "InstanceId", + "ResourceLocation", + "PreTaxCost" + ] + }, + "aggregation": { + "costSum": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "columnType": "Dimension", + "name": "SubscriptionName" + }, + { + "columnType": "Tag", + "name": "Environment" + } + ], + "filter":{ + "and": [ + { + "or":[ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ReportConfigDelete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ReportConfigDelete.json new file mode 100644 index 000000000000..0a47186446a0 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ReportConfigDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "reportConfigName": "TestReport" + }, + "responses": { + "200": { + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ReportConfigList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ReportConfigList.json new file mode 100644 index 000000000000..6988b522bdb3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ReportConfigList.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/reportconfigs/TestReportConfig1", + "name": "TestReportConfig1", + "type": "Microsoft.Consumption/reportconfigs", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "reports", + "rootFolderPath": "ad-hoc" + } + }, + "definition":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-06-01T00:00:00Z", + "to": "2018-10-31T00:00:00Z" + }, + "dataset": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "InstanceId", + "ResourceLocation", + "PreTaxCost" + ] + }, + "aggregation": { + "costSum": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "columnType": "Dimension", + "name": "SubscriptionName" + } + ], + "filter":{ + "and": [ + { + "or":[ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + } + }, + { + "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/reportconfigs/TestReportConfig2", + "name": "TestReportConfig2", + "type": "Microsoft.Consumption/reportconfigs", + "properties": { + "schedule":{ + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from":"2018-06-01T00:00:00Z", + "to":"2018-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "reports", + "rootFolderPath": "ad-hoc" + } + }, + "definition":{ + "type": "Usage", + "timeframe": "WeekToDate", + "dataset": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "InstanceId", + "ResourceLocation", + "UsageQuantity" + ] + }, + "aggregation": { + "usageSum": { + "name": "UsageQuantity", + "function": "Sum" + } + }, + "grouping": [ + { + "columnType": "Tag", + "name": "Environment" + } + ], + "filter":{ + "and": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + } + } + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ResourceGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ResourceGroupDimensionsList.json new file mode 100644 index 000000000000..6bd76a0a90b9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ResourceGroupDimensionsList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "39ae8bea-c3fd-4e24-8936-7c34974326ce", + "resourceGroupName": "system.orlando", + "$expand": "properties/data", + "$top": "5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/39ae8bea-c3fd-4e24-8936-7c34974326ce/resourceGroups/system.orlando/providers/microsoft.consumption/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "microsoft.storage/storageaccounts" + ], + "total": 1, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00" + } + }, + { + "id": "subscriptions/39ae8bea-c3fd-4e24-8936-7c34974326ce/resourceGroups/system.orlando/providers/microsoft.consumption/dimensions_InstanceId_2018-05-01_2018-05-31_5", + "name": "dimensions_InstanceId_2018-05-01_2018-05-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "/subscriptions/39ae8bea-c3fd-4e24-8936-7c34974326ce/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/authprod", + "/subscriptions/39ae8bea-c3fd-4e24-8936-7c34974326ce/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/systemevents", + "/subscriptions/39ae8bea-c3fd-4e24-8936-7c34974326ce/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/armadminprod", + "/subscriptions/39ae8bea-c3fd-4e24-8936-7c34974326ce/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/39ae8bea-c3fd-4e24-8936-7c34974326ce/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/publicsystemportal" + ], + "total": 27, + "category": "InstanceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ResourceGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ResourceGroupQuery.json new file mode 100644 index 000000000000..24b99ae93eab --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/ResourceGroupQuery.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481", + "resourceGroupName": "ScreenSharingTest-peer", + "parameters":{ + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "configuration": { + "columns": [ + "PreTaxCost", + "ResourceGroup", + "UsageDate" + ] + }, + "filter":{ + "and": [ + { + "or":[ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/55312978-ba1b-415c-9304-c4b9c43c0481/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", + "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + } + ], + "rows": [ + [ + 2.10333307059661, + "ScreenSharingTest-peer", + 20180417 + ], + [ + 20.10333307059661, + "ScreenSharingTest-peer", + 20180418 + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/SubscriptionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/SubscriptionDimensionsList.json new file mode 100644 index 000000000000..a1bf887e7aeb --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/SubscriptionDimensionsList.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "39ae8bea-c3fd-4e24-8936-7c34974326ce", + "$top": "5", + "$expand": "properties/data" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/39ae8bea-c3fd-4e24-8936-7c34974326ce/providers/Microsoft.Consumption/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "dcrg", + "rg", + "offlinegalleryrg", + "system.orlando.adminkeyvault", + "system.orlando.keyvault" + ], + "total": 68, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00" + } + }, + { + "id": "subscriptions/39ae8bea-c3fd-4e24-8936-7c34974326ce/providers/Microsoft.Consumption/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "microsoft.storage/storageaccounts", + "microsoft.web.admin/role", + "microsoft.sql/servers", + "microsoft.compute/virtualmachines" + ], + "total": 4, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/SubscriptionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/SubscriptionQuery.json new file mode 100644 index 000000000000..b84af6a0ab53 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/examples/SubscriptionQuery.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2018-05-31", + "subscriptionId": "55312978-ba1b-415c-9304-c6b9c43c0481", + "parameters":{ + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "configuration": { + "columns": [ + "PreTaxCost", + "ResourceGroup", + "UsageDate" + ] + }, + "filter":{ + "and": [ + { + "or":[ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/55312978-ba1b-415c-9304-c6b9c43c0481/providers/Microsoft.CostManagement/Query/55312978-ba1b-415c-9304-c6b9c43c0481", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + } + ], + "rows": [ + [ + 2.10333307059661, + "ScreenSharingTest-peer", + 20180417 + ], + [ + 218.68795741935486, + "Ict_StratAndPlan_GoldSprova_Prod", + 20180331 + ], + [ + 0.14384913581657052, + "ssbciotelement01", + 20180331 + ], + [ + 0.009865586851323632, + "ict_stratandplan_goldsprova_prod", + 20180331 + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md new file mode 100644 index 000000000000..8ffdd887eb7f --- /dev/null +++ b/specification/cost-management/resource-manager/readme.md @@ -0,0 +1,155 @@ +# CostManagement + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Cost Management. + +--- +## Getting Started +To build the SDK for Cost Management, 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 Cost Management API. + +``` yaml +openapi-type: arm +tag: package-2018-05 +``` + +--- +### Tag: package-2018-05 + +These settings apply only when `--tag=package-2018-05` is specified on the command line. + +``` yaml $(tag) == 'package-2018-05' +input-file: +- Microsoft.CostManagement/stable/2018-05-31/costmanagement.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-go + - repo: azure-sdk-for-python + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_costmanagement'] +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.CostManagement + output-folder: $(csharp-sdks-folder)/CostManagement/Management.CostManagement/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.costmanagement + package-name: azure-mgmt-costmanagement + package-version: 1.2.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-costmanagement/azure/mgmt/costmanagement +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-costmanagement +``` + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: costmanagement + clear-output-folder: true +``` + +### Go multi-api +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-05 +``` + +### Tag: package-2018-05 and go +These settings apply only when `--tag=package-2018-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-05' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-05-31/$(namespace) +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.costmanagement +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-costmanagement +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-05 +``` + +### Tag: package-2018-05 and java + +These settings apply only when `--tag=package-2018-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.costmanagement.v2018_05_31 + output-folder: $(azure-libraries-for-java-folder)/costmanagement/resource-manager/v2018_05_31 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/customer-insights/resource-manager/readme.md b/specification/customer-insights/resource-manager/readme.md index 2f255da473bc..8cc231b53c5d 100644 --- a/specification/customer-insights/resource-manager/readme.md +++ b/specification/customer-insights/resource-manager/readme.md @@ -63,6 +63,9 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_customer_insights'] ``` @@ -125,11 +128,46 @@ 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 - fluent: true - namespace: com.microsoft.azure.management.customerinsights - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-customerinsights +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.customerinsights +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-customerinsights ``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-01 + - tag: package-2017-04 +``` + +### Tag: package-2017-01 and java + +These settings apply only when `--tag=package-2017-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.customerinsights.v2017_01_01 + output-folder: $(azure-libraries-for-java-folder)/customerinsights/resource-manager/v2017_01_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.customerinsights.v2017_04_26 + output-folder: $(azure-libraries-for-java-folder)/customerinsights/resource-manager/v2017_04_26 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/customer-insights/resource-manager/readme.ruby.md b/specification/customer-insights/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..a3c47a951f70 --- /dev/null +++ b/specification/customer-insights/resource-manager/readme.ruby.md @@ -0,0 +1,37 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_customer_insights +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2017-04 + - tag: package-2017-01 +``` + +### Tag: package-2017-04 and ruby + +These settings apply only when `--tag=package-2017-04 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-04' && $(ruby) +namespace: "Azure::CustomerInsights::Mgmt::V2017_04_26" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_customer_insights/lib +``` + +### Tag: package-2017-01 and ruby + +These settings apply only when `--tag=package-2017-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-01' && $(ruby) +namespace: "Azure::CustomerInsights::Mgmt::V2017_01_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_customer_insights/lib +``` diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/databox.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/databox.json new file mode 100644 index 000000000000..a3377ac231ef --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/databox.json @@ -0,0 +1,2157 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-01-01", + "title": "DataBoxManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.DataBox/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "This method gets all the operations.", + "operationId": "Operations_List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The supported operations list.", + "schema": { + "$ref": "#/definitions/OperationList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "description": "Lists all the jobs available under the subscription.", + "operationId": "Jobs_List", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List of jobs available under the subscription.", + "schema": { + "$ref": "#/definitions/JobResourceList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "JobsList": { + "$ref": "./examples/JobsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/availableSkus": { + "post": { + "tags": [ + "Service" + ], + "description": "This method provides the list of available skus for the given subscription and location.", + "operationId": "Service_ListAvailableSkus", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "availableSkuRequest", + "in": "body", + "description": "Filters for showing the available skus.", + "required": true, + "schema": { + "$ref": "#/definitions/AvailableSkuRequest" + } + } + ], + "responses": { + "200": { + "description": "The list of available skus.", + "schema": { + "$ref": "#/definitions/AvailableSkusResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServiceListAvailableSkus": { + "$ref": "./examples/ServiceListAvailableSkus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateAddress": { + "post": { + "tags": [ + "Service" + ], + "description": "This method validates the customer shipping address and provide alternate addresses if any.", + "operationId": "Service_ValidateAddress", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "validateAddress", + "in": "body", + "description": "Shipping address of the customer.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateAddress" + } + } + ], + "responses": { + "200": { + "description": "The valid and alternate addresses.", + "schema": { + "$ref": "#/definitions/AddressValidationOutput" + } + } + }, + "x-ms-examples": { + "ServiceValidateAddress": { + "$ref": "./examples/ServiceValidateAddress.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "description": "Lists all the jobs available under the given resource group.", + "operationId": "Jobs_ListByResourceGroup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List of jobs by resource group.", + "schema": { + "$ref": "#/definitions/JobResourceList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "JobsListByResourceGroup": { + "$ref": "./examples/JobsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}": { + "get": { + "tags": [ + "Jobs" + ], + "description": "Gets information about the specified job.", + "operationId": "Jobs_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "$expand is supported on details parameter for job, which provides details on the job stages.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Job object.", + "schema": { + "$ref": "#/definitions/JobResource" + } + } + }, + "x-ms-examples": { + "JobsGet": { + "$ref": "./examples/JobsGet.json" + } + } + }, + "put": { + "tags": [ + "Jobs" + ], + "description": "Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.", + "operationId": "Jobs_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "jobResource", + "in": "body", + "description": "Job details from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/JobResource" + } + } + ], + "responses": { + "200": { + "description": "Job object.", + "schema": { + "$ref": "#/definitions/JobResource" + } + }, + "202": { + "description": "Accepted request for create Job." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "JobsCreate": { + "$ref": "./examples/JobsCreate.json" + } + } + }, + "delete": { + "tags": [ + "Jobs" + ], + "description": "Deletes a job.", + "operationId": "Jobs_Delete", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Job deleted." + } + }, + "x-ms-examples": { + "JobsDelete": { + "$ref": "./examples/JobsDelete.json" + } + } + }, + "patch": { + "tags": [ + "Jobs" + ], + "description": "Updates the properties of an existing job.", + "operationId": "Jobs_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.", + "type": "string" + }, + { + "name": "jobResourceUpdateParameter", + "in": "body", + "description": "Job update parameters from request body.", + "required": true, + "schema": { + "$ref": "#/definitions/JobResourceUpdateParameter" + } + } + ], + "responses": { + "200": { + "description": "Job object.", + "schema": { + "$ref": "#/definitions/JobResource" + } + }, + "202": { + "description": "Accepted request for job updated." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "JobsUpdate": { + "$ref": "./examples/JobsUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Book shipment pick up.", + "operationId": "Jobs_BookShipmentPickUp", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "shipmentPickUpRequest", + "in": "body", + "description": "Details of shipment pick up request.", + "required": true, + "schema": { + "$ref": "#/definitions/ShipmentPickUpRequest" + } + } + ], + "responses": { + "200": { + "description": "Booked shipment pick up successfully.", + "schema": { + "$ref": "#/definitions/ShipmentPickUpResponse" + } + } + }, + "x-ms-examples": { + "JobsBookShipmentPickUp": { + "$ref": "./examples/JobsBookShipmentPickUp.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel": { + "post": { + "tags": [ + "Jobs" + ], + "description": "CancelJob.", + "operationId": "Jobs_Cancel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "cancellationReason", + "in": "body", + "description": "Reason for cancellation.", + "required": true, + "schema": { + "$ref": "#/definitions/CancellationReason" + } + } + ], + "responses": { + "204": { + "description": "Job cancelled." + } + }, + "x-ms-examples": { + "JobsCancel": { + "$ref": "./examples/JobsCancel.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/copyLogsUri": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Provides list of copy logs uri.", + "operationId": "Jobs_GetCopyLogsUri", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Copy logs uri.", + "schema": { + "$ref": "#/definitions/GetCopyLogsUriOutput" + } + } + }, + "x-ms-examples": { + "JobsGetCopyLogsUri": { + "$ref": "./examples/JobsGetCopyLogsUri.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/downloadShippingLabel": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Get shipping label sas uri.", + "operationId": "Jobs_DownloadShippingLabelUri", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Shipping label sas uri.", + "schema": { + "$ref": "#/definitions/ShippingLabelDetails" + } + } + }, + "x-ms-examples": { + "JobsDownloadShippingLabelUri": { + "$ref": "./examples/JobsDownloadShippingLabelUri.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listSecrets": { + "post": { + "tags": [ + "Jobs" + ], + "description": "This method gets the unencrypted secrets related to the job.", + "operationId": "Jobs_ListSecrets", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The unencrypted secrets of the job.", + "schema": { + "$ref": "#/definitions/UnencryptedSecrets" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "JobsListSecrets": { + "$ref": "./examples/JobsListSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/reportIssue": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Reports an issue.", + "operationId": "Jobs_ReportIssue", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/jobNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "reportIssueDetails", + "in": "body", + "description": "Details of reported issue.", + "required": true, + "schema": { + "$ref": "#/definitions/ReportIssueDetails" + } + } + ], + "responses": { + "204": { + "description": "Accepted issue report." + } + }, + "x-ms-examples": { + "JobsReportIssue": { + "$ref": "./examples/JobsReportIssue.json" + } + } + } + } + }, + "definitions": { + "AccountCopyLogDetails": { + "description": "Copy log details for an storage account", + "required": [ + "accountName", + "copyLogLink" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyLogDetails" + } + ], + "properties": { + "accountName": { + "description": "Destination account name.", + "type": "string" + }, + "copyLogLink": { + "description": "Link for copy logs.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Pod" + }, + "AccountCredentialDetails": { + "description": "Credential details of the account.", + "required": [ + "shareCredentialDetails" + ], + "type": "object", + "properties": { + "accountName": { + "description": "Name of the account.", + "type": "string" + }, + "shareCredentialDetails": { + "description": "Per share level unencrypted access credentials.", + "type": "array", + "items": { + "$ref": "#/definitions/ShareCredentialDetails" + } + } + } + }, + "AddressValidationOutput": { + "description": "Output of the address validation api.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddressValidationProperties", + "description": "The address validation properties.", + "x-ms-client-flatten": true + } + } + }, + "AddressValidationProperties": { + "description": "The address validation output.", + "type": "object", + "properties": { + "validationStatus": { + "description": "The address validation status.", + "enum": [ + "Valid", + "Invalid", + "Ambiguous" + ], + "type": "string", + "x-ms-enum": { + "name": "AddressValidationStatus", + "modelAsString": false + } + }, + "alternateAddresses": { + "description": "List of alternate addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/ShippingAddress" + } + } + } + }, + "ArmBaseObject": { + "description": "Base class for all objects under resource.", + "type": "object", + "properties": { + "name": { + "description": "Name of the object.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the object.", + "type": "string", + "readOnly": true + } + } + }, + "AvailableSkuRequest": { + "description": "The filters for showing the available skus.", + "required": [ + "transferType", + "country", + "location" + ], + "type": "object", + "properties": { + "transferType": { + "description": "Type of the transfer.", + "enum": [ + "ImportToAzure" + ], + "type": "string", + "x-ms-enum": { + "name": "TransferType", + "modelAsString": false + } + }, + "country": { + "description": "ISO country code. Country for hardware shipment. For codes check: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements", + "type": "string" + }, + "location": { + "description": "Location for data transfer. For locations check: https://management.azure.com/subscriptions/SUBSCRIPTIONID/locations?api-version=2018-01-01", + "type": "string" + } + } + }, + "AvailableSkusResult": { + "description": "The available skus operation response.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of available skus.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuInformation" + } + }, + "nextLink": { + "description": "Link for the next set of skus.", + "type": "string" + } + } + }, + "CabinetJobSecrets": { + "description": "The secrets related to a cabinet job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobSecrets" + } + ], + "properties": { + "cabinetPodSecrets": { + "description": "Contains the list of secret objects for a cabinet job.", + "type": "array", + "items": { + "$ref": "#/definitions/CabinetPodSecret" + } + } + }, + "x-ms-discriminator-value": "Cabinet" + }, + "CabinetPodSecret": { + "description": "The secrets related to a cabinet pod.", + "type": "object", + "properties": { + "deviceSerialNumber": { + "description": "Serial number of the assigned device.", + "type": "string" + }, + "devicePassword": { + "description": "Password for out of the box experience on device.", + "type": "string" + }, + "accountCredentialDetails": { + "description": "Per account level access credentials.", + "type": "array", + "items": { + "$ref": "#/definitions/AccountCredentialDetails" + } + } + } + }, + "CancellationReason": { + "description": "Reason for cancellation.", + "required": [ + "reason" + ], + "type": "object", + "properties": { + "reason": { + "description": "Reason for cancellation.", + "type": "string" + } + } + }, + "ContactDetails": { + "description": "Contact Details.", + "required": [ + "phone", + "emailList" + ], + "type": "object", + "properties": { + "contactName": { + "description": "Contact name of the person.", + "type": "string" + }, + "phone": { + "description": "Phone number of the contact person.", + "type": "string" + }, + "phoneExtension": { + "description": "Phone extension number of the contact person.", + "type": "string" + }, + "mobile": { + "description": "Mobile number of the contact person.", + "type": "string" + }, + "emailList": { + "description": "List of Email-ids to be notified about job progress.", + "type": "array", + "items": { + "type": "string" + } + }, + "notificationPreference": { + "description": "Notification preference for a job stage.", + "type": "array", + "items": { + "$ref": "#/definitions/NotificationPreference" + } + } + } + }, + "CopyLogDetails": { + "description": "Details for log generated during copy.", + "type": "object", + "properties": { + "copyLogDetailsType": { + "description": "Indicates the type of job details.", + "enum": [ + "Pod", + "Disk", + "Cabinet" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassDiscriminator", + "modelAsString": false + } + } + }, + "discriminator": "copyLogDetailsType" + }, + "CopyProgress": { + "description": "Copy progress.", + "type": "object", + "properties": { + "storageAccountName": { + "description": "Name of the storage account where the data needs to be uploaded.", + "type": "string" + }, + "bytesSentToCloud": { + "format": "int64", + "description": "Amount of data uploaded by the job as of now.", + "type": "integer" + }, + "totalBytesToProcess": { + "format": "int64", + "description": "Total amount of data to be processed by the job.", + "type": "integer" + } + } + }, + "DestinationAccountDetails": { + "description": "Details for the destination account.", + "required": [ + "accountId" + ], + "type": "object", + "properties": { + "accountId": { + "description": "Destination storage account id.", + "type": "string" + } + } + }, + "DestinationToServiceLocationMap": { + "description": "Map of destination location to service location", + "type": "object", + "properties": { + "destinationLocation": { + "description": "Location of the destination.", + "type": "string" + }, + "serviceLocation": { + "description": "Location of the service.", + "type": "string" + } + } + }, + "DiskCopyLogDetails": { + "description": "Copy Log Details for a disk", + "required": [ + "diskSerialNumber", + "errorLogLink", + "verboseLogLink" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyLogDetails" + } + ], + "properties": { + "diskSerialNumber": { + "description": "Disk Serial Number.", + "type": "string" + }, + "errorLogLink": { + "description": "Link for copy error logs.", + "type": "string" + }, + "verboseLogLink": { + "description": "Link for copy verbose logs.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Disk" + }, + "DiskCopyProgress": { + "description": "Disk Copy Progress", + "type": "object", + "properties": { + "serialNumber": { + "description": "The serial number of the disk", + "type": "string" + }, + "percentComplete": { + "format": "int32", + "description": "Indicates the percentage completed for the copy of the disk.", + "type": "integer" + }, + "status": { + "description": "The Status of the copy", + "enum": [ + "NotStarted", + "InProgress", + "Completed", + "CompletedWithErrors", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CopyStatus", + "modelAsString": false + } + } + } + }, + "DiskJobDetails": { + "description": "Disk Job Details.", + "required": [ + "contactDetails", + "shippingAddress" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "preferredDisks": { + "description": "User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + }, + "copyProgress": { + "description": "Copy progress per disk.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskCopyProgress" + } + }, + "disksAndSizeDetails": { + "description": "Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer.", + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + } + }, + "x-ms-discriminator-value": "Disk" + }, + "DiskJobSecrets": { + "description": "The secrets related to disk job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobSecrets" + } + ], + "properties": { + "diskSecrets": { + "description": "Contains the list of secrets object for that device.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskSecret" + } + } + }, + "x-ms-discriminator-value": "Disk" + }, + "DiskSecret": { + "description": "Contains all the secrets of a Disk.", + "type": "object", + "properties": { + "diskSerialNumber": { + "description": "Serial number of the assigned disk.", + "type": "string" + }, + "bitLockerKey": { + "description": "Bit Locker key of the disk which can be used to unlock the disk to copy data.", + "type": "string" + } + } + }, + "Error": { + "description": "Top level error for the job.", + "required": [ + "code" + ], + "type": "object", + "properties": { + "code": { + "description": "Error code that can be used to programmatically identify the error.", + "type": "string" + }, + "message": { + "description": "Describes the error in detail and provides debugging information.", + "type": "string" + } + } + }, + "GetCopyLogsUriOutput": { + "description": "Output for the GetCopyLogsUri.", + "type": "object", + "properties": { + "logType": { + "description": "Type/Level of the log.", + "type": "string" + }, + "copyLogDetails": { + "description": "List of copy log details.", + "type": "array", + "items": { + "$ref": "#/definitions/CopyLogDetails" + } + } + } + }, + "JobDetails": { + "description": "Job details.", + "required": [ + "contactDetails", + "shippingAddress" + ], + "type": "object", + "properties": { + "expectedDataSizeInTeraBytes": { + "format": "int32", + "description": "The expected size of the data, which needs to be transfered in this job, in tera bytes.", + "type": "integer" + }, + "jobStages": { + "description": "List of stages that run in the job.", + "type": "array", + "items": { + "$ref": "#/definitions/JobStages" + } + }, + "contactDetails": { + "$ref": "#/definitions/ContactDetails", + "description": "Contact details for notification and shipping." + }, + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping address of the customer." + }, + "errorDetails": { + "description": "Error details for failure. This is optional.", + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetails" + } + }, + "jobDetailsType": { + "description": "Indicates the type of job details.", + "enum": [ + "Pod", + "Disk", + "Cabinet" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassDiscriminator", + "modelAsString": false + } + } + }, + "discriminator": "jobDetailsType" + }, + "JobErrorDetails": { + "description": "Job Error Details for providing the information and recommended action.", + "type": "object", + "properties": { + "errorMessage": { + "description": "Message for the error.", + "type": "string" + }, + "errorCode": { + "format": "int32", + "description": "Code for the error.", + "type": "integer" + }, + "recommendedAction": { + "description": "Recommended action for the error.", + "type": "string" + }, + "exceptionMessage": { + "description": "Contains the non localized exception message", + "type": "string" + } + } + }, + "JobProperties": { + "description": "Job Properties", + "required": [ + "destinationAccountDetails" + ], + "type": "object", + "properties": { + "deviceType": { + "description": "Type of the device to be used for the job.", + "enum": [ + "Pod", + "Disk", + "Cabinet" + ], + "type": "string", + "x-ms-enum": { + "name": "DeviceType", + "modelAsString": false + } + }, + "isCancellable": { + "description": "Describes whether the job is cancellable or not.", + "type": "boolean" + }, + "isShippingAddressEditable": { + "description": "Describes whether the shipping address is editable or not.", + "type": "boolean" + }, + "status": { + "description": "Name of the stage which is in progress.", + "enum": [ + "DeviceOrdered", + "DevicePrepared", + "Dispatched", + "Delivered", + "PickedUp", + "AtAzureDC", + "DataCopy", + "Completed", + "CompletedWithErrors", + "Cancelled", + "Failed_IssueReportedAtCustomer", + "Failed_IssueDetectedAtAzureDC", + "Aborted" + ], + "type": "string", + "x-ms-enum": { + "name": "StageName", + "modelAsString": false + } + }, + "startTime": { + "format": "date-time", + "description": "Time at which the job was started in UTC ISO 8601 format.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Top level error for the job." + }, + "deliveryPackage": { + "$ref": "#/definitions/PackageShippingDetails", + "description": "Delivery package shipping details." + }, + "returnPackage": { + "$ref": "#/definitions/PackageShippingDetails", + "description": "Return package shipping details." + }, + "destinationAccountDetails": { + "description": "Destination account details.", + "type": "array", + "items": { + "$ref": "#/definitions/DestinationAccountDetails" + } + }, + "details": { + "$ref": "#/definitions/JobDetails", + "description": "Details of a job run. This field will only be sent for expand details filter." + }, + "cancellationReason": { + "description": "Reason for cancellation.", + "type": "string" + } + } + }, + "JobResource": { + "description": "Job Resource.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "Properties of a job.", + "x-ms-client-flatten": true + }, + "name": { + "description": "Name of the object.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the object.", + "type": "string", + "readOnly": true + } + } + }, + "JobResourceList": { + "description": "Job Resource Collection", + "type": "object", + "properties": { + "value": { + "description": "List of job resources.", + "type": "array", + "items": { + "$ref": "#/definitions/JobResource" + } + }, + "nextLink": { + "description": "Link for the next set of job resources.", + "type": "string" + } + } + }, + "JobResourceUpdateParameter": { + "description": "The JobResourceUpdateParameter.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateJobProperties", + "description": "Properties of a job to be updated.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "JobSecrets": { + "description": "The base class for the secrets", + "type": "object", + "properties": { + "jobSecretsType": { + "description": "Used to indicate what type of job secrets object.", + "enum": [ + "Pod", + "Disk", + "Cabinet" + ], + "type": "string", + "x-ms-enum": { + "name": "ClassDiscriminator", + "modelAsString": false + } + } + }, + "discriminator": "jobSecretsType" + }, + "JobStages": { + "description": "Job stages.", + "required": [ + "stageName", + "stageStatus" + ], + "type": "object", + "properties": { + "stageName": { + "description": "Name of the job stage.", + "enum": [ + "DeviceOrdered", + "DevicePrepared", + "Dispatched", + "Delivered", + "PickedUp", + "AtAzureDC", + "DataCopy", + "Completed", + "CompletedWithErrors", + "Cancelled", + "Failed_IssueReportedAtCustomer", + "Failed_IssueDetectedAtAzureDC", + "Aborted" + ], + "type": "string", + "x-ms-enum": { + "name": "StageName", + "modelAsString": false + } + }, + "displayName": { + "description": "Display name of the job stage.", + "type": "string" + }, + "stageStatus": { + "description": "Status of the job stage.", + "enum": [ + "None", + "InProgress", + "Succeeded", + "Failed", + "Cancelled", + "Cancelling", + "SucceededWithErrors" + ], + "type": "string", + "x-ms-enum": { + "name": "StageStatus", + "modelAsString": false + } + }, + "stageTime": { + "format": "date-time", + "description": "Time for the job stage in UTC ISO 8601 format.", + "type": "string" + }, + "jobStageDetails": { + "description": "Job Stage Details", + "type": "object" + }, + "errorDetails": { + "description": "Error details for the stage.", + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetails" + } + } + } + }, + "NotificationPreference": { + "description": "Notification preference for a job stage.", + "required": [ + "stageName", + "sendNotification" + ], + "type": "object", + "properties": { + "stageName": { + "description": "Name of the stage.", + "enum": [ + "DevicePrepared", + "Dispatched", + "Delivered", + "PickedUp", + "AtAzureDC", + "DataCopy" + ], + "type": "string", + "x-ms-enum": { + "name": "NotificationStageName", + "modelAsString": false + } + }, + "sendNotification": { + "description": "Notification is required or not.", + "type": "boolean" + } + } + }, + "Operation": { + "description": "Operation entity.", + "required": [ + "name", + "display", + "properties", + "origin" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the operation. Format: {resourceProviderNamespace}/{resourceType}/{read|write|delete|action}", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Operation display values." + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Operation properties.", + "x-ms-client-flatten": true + }, + "origin": { + "description": "Origin of the operation. Can be : user|system|user,system", + "type": "string" + } + } + }, + "OperationDisplay": { + "description": "Operation display", + "type": "object", + "properties": { + "provider": { + "description": "Provider name.", + "type": "string" + }, + "resource": { + "description": "Resource name.", + "type": "string" + }, + "operation": { + "description": "Localized name of the operation for display purpose.", + "type": "string" + }, + "description": { + "description": "Localized description of the operation for display purpose.", + "type": "string" + } + } + }, + "OperationList": { + "description": "Operation Collection.", + "type": "object", + "properties": { + "value": { + "description": "List of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "Link for the next set of operations.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Operation properties.", + "type": "object", + "properties": {} + }, + "PackageShippingDetails": { + "description": "Shipping details.", + "type": "object", + "properties": { + "carrierName": { + "description": "Name of the carrier.", + "type": "string" + }, + "trackingId": { + "description": "Tracking Id of shipment.", + "type": "string" + }, + "trackingUrl": { + "description": "Url where shipment can be tracked.", + "type": "string" + } + } + }, + "PodJobDetails": { + "description": "Pod Job Details", + "required": [ + "contactDetails", + "shippingAddress" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobDetails" + } + ], + "properties": { + "copyProgress": { + "description": "Copy progress per account.", + "type": "array", + "items": { + "$ref": "#/definitions/CopyProgress" + } + } + }, + "x-ms-discriminator-value": "Pod" + }, + "PodJobSecrets": { + "description": "The secrets related to a pod job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JobSecrets" + } + ], + "properties": { + "podSecrets": { + "description": "Contains the list of secret objects for a job.", + "type": "array", + "items": { + "$ref": "#/definitions/PodSecret" + } + } + }, + "x-ms-discriminator-value": "Pod" + }, + "PodSecret": { + "description": "The secrets related to a Pod.", + "type": "object", + "properties": { + "deviceSerialNumber": { + "description": "Serial number of the assigned device.", + "type": "string" + }, + "devicePassword": { + "description": "Password for out of the box experience on device.", + "type": "string" + }, + "accountCredentialDetails": { + "description": "Per account level access credentials.", + "type": "array", + "items": { + "$ref": "#/definitions/AccountCredentialDetails" + } + } + } + }, + "ReportIssueDetails": { + "description": "Details of the reported issue.", + "type": "object", + "properties": { + "issueType": { + "description": "Issue Type.", + "enum": [ + "DeviceMismatch", + "ValidationStringMismatch", + "CredentialNotWorking", + "DeviceFailure" + ], + "type": "string", + "x-ms-enum": { + "name": "IssueType", + "modelAsString": false + } + }, + "deviceIssueType": { + "description": "Device Issue Type. Only used for Device failure issue.", + "enum": [ + "DeviceTampering", + "DeviceNotBootingUp", + "DeviceHealthCheckShowFailures", + "NICsAreNotWorking", + "Misc" + ], + "type": "string", + "x-ms-enum": { + "name": "DeviceIssueType", + "modelAsString": false + } + } + } + }, + "Resource": { + "description": "Model of the Resource.", + "required": [ + "location", + "sku" + ], + "type": "object", + "properties": { + "location": { + "description": "The location of the resource. This will be one of the supported and registered Azure Regions (e.g. West US, East US, Southeast Asia, etc.). The region of a resource cannot be changed once it is created, but if an identical region is specified on update the request will succeed.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku type." + } + }, + "x-ms-azure-resource": true + }, + "ShareCredentialDetails": { + "description": "Credential details of the shares in account.", + "type": "object", + "properties": { + "shareName": { + "description": "Name of the share.", + "type": "string" + }, + "userName": { + "description": "User name for the share.", + "type": "string" + }, + "password": { + "description": "Password for the share.", + "type": "string" + } + } + }, + "ShipmentPickUpRequest": { + "description": "Shipment pick up request details.", + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "Minimum date after which the pick up should commence, this must be in local time of pick up area.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "Maximum date before which the pick up should commence, this must be in local time of pick up area.", + "type": "string" + }, + "shipmentLocation": { + "description": "Shipment Location in the pickup place. Eg.front desk", + "type": "string" + } + } + }, + "ShipmentPickUpResponse": { + "description": "Shipment pick up response.", + "type": "object", + "properties": { + "confirmationNumber": { + "description": "Confirmation number for the pick up request.", + "type": "string" + }, + "readyByTime": { + "format": "date-time", + "description": "Time by which shipment should be ready for pick up, this is in local time of pick up area.", + "type": "string" + } + } + }, + "ShippingAddress": { + "description": "Shipping address where customer wishes to receive the device.", + "required": [ + "streetAddress1", + "country", + "postalCode" + ], + "type": "object", + "properties": { + "streetAddress1": { + "description": "Street Address line 1.", + "type": "string" + }, + "streetAddress2": { + "description": "Street Address line 2.", + "type": "string" + }, + "streetAddress3": { + "description": "Street Address line 3.", + "type": "string" + }, + "city": { + "description": "Name of the City.", + "type": "string" + }, + "stateOrProvince": { + "description": "Name of the State or Province.", + "type": "string" + }, + "country": { + "description": "Name of the Country.", + "type": "string" + }, + "postalCode": { + "description": "Postal code.", + "type": "string" + }, + "zipExtendedCode": { + "description": "Extended Zip Code.", + "type": "string" + }, + "companyName": { + "description": "Name of the company.", + "type": "string" + }, + "addressType": { + "description": "Type of address.", + "enum": [ + "None", + "Residential", + "Commercial" + ], + "type": "string", + "x-ms-enum": { + "name": "AddressType", + "modelAsString": false + } + } + } + }, + "ShippingLabelDetails": { + "description": "Details for the shipping label.", + "required": [ + "shippingLabelSasUri" + ], + "type": "object", + "properties": { + "shippingLabelSasUri": { + "description": "Sas uri for accessing the shipping label.", + "type": "string" + } + } + }, + "Sku": { + "description": "The Sku.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The sku name.", + "type": "string" + }, + "displayName": { + "description": "The display name of the sku.", + "type": "string" + }, + "family": { + "description": "The sku family.", + "type": "string" + } + } + }, + "SkuCapacity": { + "description": "Capacity of the sku.", + "required": [ + "usable", + "maximum" + ], + "type": "object", + "properties": { + "usable": { + "description": "Usable capacity in TB.", + "type": "string" + }, + "maximum": { + "description": "Maximum capacity in TB.", + "type": "string" + } + } + }, + "SkuCost": { + "description": "Describes metadata for retrieving price info.", + "required": [ + "meterId", + "meterType" + ], + "type": "object", + "properties": { + "meterId": { + "description": "Meter id of the Sku.", + "type": "string" + }, + "meterType": { + "description": "The type of the meter.", + "type": "string" + } + } + }, + "SkuInformation": { + "description": "Information of the sku.", + "required": [ + "sku", + "enabled", + "properties" + ], + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The Sku." + }, + "enabled": { + "description": "The sku is enabled or not.", + "type": "boolean" + }, + "properties": { + "$ref": "#/definitions/SkuProperties", + "description": "Properties of the sku.", + "x-ms-client-flatten": true + } + } + }, + "SkuProperties": { + "description": "Properties of the sku.", + "required": [ + "capacity", + "costs", + "apiVersions" + ], + "type": "object", + "properties": { + "destinationToServiceLocationMap": { + "description": "The map of destination location to service location.", + "type": "array", + "items": { + "$ref": "#/definitions/DestinationToServiceLocationMap" + } + }, + "capacity": { + "$ref": "#/definitions/SkuCapacity", + "description": "Capacity of the Sku." + }, + "costs": { + "description": "Cost of the Sku.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuCost" + } + }, + "apiVersions": { + "description": "Api versions that support this Sku.", + "type": "array", + "items": { + "type": "string" + } + }, + "disabledReason": { + "description": "Reason why the Sku is disabled.", + "type": "string" + } + } + }, + "UnencryptedSecrets": { + "description": "Unencrypted secrets for accessing device.", + "required": [ + "jobName" + ], + "type": "object", + "properties": { + "jobName": { + "description": "Name of the job.", + "type": "string" + }, + "deviceType": { + "description": "The Device Type used in the job.", + "enum": [ + "Pod", + "Disk", + "Cabinet" + ], + "type": "string", + "x-ms-enum": { + "name": "DeviceType", + "modelAsString": false + } + }, + "jobSecrets": { + "$ref": "#/definitions/JobSecrets", + "description": "Secrets related to this job." + } + } + }, + "UpdateJobDetails": { + "description": "Job details for update.", + "type": "object", + "properties": { + "contactDetails": { + "$ref": "#/definitions/ContactDetails", + "description": "Contact details for notification and shipping." + }, + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping address of the customer." + } + } + }, + "UpdateJobProperties": { + "description": "Job Properties for update", + "required": [ + "details" + ], + "type": "object", + "properties": { + "details": { + "$ref": "#/definitions/UpdateJobDetails", + "description": "Details of a job to be updated." + } + } + }, + "ValidateAddress": { + "description": "The requirements to validate customer address where the device needs to be shipped.", + "type": "object", + "properties": { + "shippingAddress": { + "$ref": "#/definitions/ShippingAddress", + "description": "Shipping address of the customer." + }, + "deviceType": { + "description": "Device type to be used for the job.", + "enum": [ + "Pod", + "Disk", + "Cabinet" + ], + "type": "string", + "x-ms-enum": { + "name": "DeviceType", + "modelAsString": false + } + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API Version", + "required": true, + "type": "string" + }, + "jobNameParameter": { + "name": "jobName", + "in": "path", + "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only", + "required": true, + "type": "string", + "maxLength": 24, + "minLength": 3, + "pattern": "^[-\\w\\.]+$", + "x-ms-parameter-location": "method" + }, + "locationParameter": { + "name": "location", + "in": "path", + "description": "The location of the resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The Resource Group Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Subscription Id", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsBookShipmentPickUp.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsBookShipmentPickUp.json new file mode 100644 index 000000000000..6d714c782bc2 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsBookShipmentPickUp.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "sdktest5497", + "api-version": "2018-01-01", + "shipmentPickUpRequest": { + "startTime": "2018-04-15T18:30:00Z", + "endTime": "2018-04-17T18:30:00Z", + "shipmentLocation": "Front desk" + } + }, + "responses": { + "200": { + "body": { + "confirmationNumber": "2929602E9CP", + "readyByTime": "2023-04-19T00:00:00Z" + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCancel.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCancel.json new file mode 100644 index 000000000000..aa6aee09f5ac --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCancel.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "SdkJob8558", + "api-version": "2018-01-01", + "$expand": "details", + "cancellationReason": { + "reason": "CancelTest" + } + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCreate.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCreate.json new file mode 100644 index 000000000000..8383e15ec753 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsCreate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "SdkJob8558", + "api-version": "2018-01-01", + "jobResource": { + "properties": { + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/kvtestWUSrg/providers/microsoft.storage/storageAccounts/kvtestwus" + } + ], + "details": { + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + } + } + }, + "location": "westus", + "sku": { + "name": "DataBox" + } + } + }, + "responses": { + "202": { + "body": "" + }, + "200": { + "body": { + "properties": { + "deviceType": "Pod", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-13T16:28:38.9999793+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/kvtestWUSrg/providers/microsoft.storage/storageAccounts/kvtestwus" + } + ] + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob8558", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/SdkRg2508/providers/Microsoft.DataBox/jobs/SdkJob8558", + "type": "Microsoft.DataBox/jobs" + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDelete.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDelete.json new file mode 100644 index 000000000000..dbaf09e74212 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "SdkJob8558", + "api-version": "2018-01-01", + "$expand": "details" + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDownloadShippingLabelUri.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDownloadShippingLabelUri.json new file mode 100644 index 000000000000..e5a8a9d34663 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsDownloadShippingLabelUri.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "sdktest5497", + "api-version": "2018-01-01" + }, + "responses": { + "200": { + "body": { + "shippingLabelSasUri": "https://wusintd2cis2secx0fo9.blob.core.windows.net/dummycontainer/1Z12345E8791315509.PDF?sv=2016-05-31&sr=b&sig=ijNPoWPcbt0BNxTCK9p6nta4jsOr2hzJpgWyyE7AU0k%3D&st=2018-04-16T04%3A42%3A31Z&se=2018-04-16T05%3A12%3A31Z&sp=r" + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGet.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGet.json new file mode 100644 index 000000000000..c0aecc1b7796 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGet.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "SdkJob8558", + "api-version": "2018-01-01", + "$expand": "details" + }, + "responses": { + "200": { + "body": { + "properties": { + "deviceType": "Pod", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-13T16:28:38.9999793+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/kvtestWUSrg/providers/microsoft.storage/storageAccounts/kvtestwus" + } + ], + "details": { + "copyProgress": [ + { + "storageAccountName": "kvtestwus", + "bytesSentToCloud": 0, + "totalBytesToProcess": 0 + } + ], + "jobStages": [ + { + "stageName": "DeviceOrdered", + "displayName": "Ordered", + "stageStatus": "Succeeded", + "stageTime": "2018-04-13T16:28:41.1669459+05:30" + }, + { + "stageName": "DevicePrepared", + "displayName": "Processed", + "stageStatus": "None" + }, + { + "stageName": "Dispatched", + "displayName": "Dispatched", + "stageStatus": "None" + }, + { + "stageName": "Delivered", + "displayName": "Delivered", + "stageStatus": "None" + }, + { + "stageName": "PickedUp", + "displayName": "Picked up", + "stageStatus": "None" + }, + { + "stageName": "AtAzureDC", + "displayName": "Received", + "stageStatus": "None" + }, + { + "stageName": "DataCopy", + "displayName": "Data copy in progress", + "stageStatus": "None" + }, + { + "stageName": "Completed", + "displayName": "Completed", + "stageStatus": "None" + } + ], + "contactDetails": { + "contactName": "Public SDK Test", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ], + "notificationPreference": [ + { + "stageName": "DevicePrepared", + "sendNotification": true + }, + { + "stageName": "Dispatched", + "sendNotification": true + }, + { + "stageName": "Delivered", + "sendNotification": true + }, + { + "stageName": "PickedUp", + "sendNotification": true + }, + { + "stageName": "AtAzureDC", + "sendNotification": true + }, + { + "stageName": "DataCopy", + "sendNotification": true + } + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + }, + "errorDetails": [] + } + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob8558", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/SdkRg2508/providers/Microsoft.DataBox/jobs/SdkJob8558", + "type": "Microsoft.DataBox/jobs" + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGetCopyLogsUri.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGetCopyLogsUri.json new file mode 100644 index 000000000000..bdf4cc32c8d0 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsGetCopyLogsUri.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "sdktest5497", + "api-version": "2018-01-01" + }, + "responses": { + "200": { + "body": { + "copyLogDetails": [ + { + "accountName": "devicemanagertest1", + "copyLogLink": "test1234", + "copyLogDetailsType": "Pod" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsList.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsList.json new file mode 100644 index 000000000000..cf18a05a7fe2 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsList.json @@ -0,0 +1,243 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "api-version": "2018-01-01", + "$expand": "details" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "deviceType": "Pod", + "isCancellable": false, + "isShippingAddressEditable": false, + "status": "Cancelled", + "startTime": "2017-06-15T10:31:21.3912273+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/2c3771b6-6239-464c-9973-7995b0f45a6b/resourceGroups/CloudServiceCisVaultST14113BRS/providers/Microsoft.Storage/storageAccounts/devicemanagertest1" + } + ], + "cancellationReason": "Old job which is still in ordered state cancelled by the service" + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "abbhat-test", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourcegroups/abbhat-RG/providers/Microsoft.DataBox/jobs/abbhat-test", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "deviceType": "Pod", + "isCancellable": false, + "isShippingAddressEditable": false, + "status": "Cancelled", + "startTime": "2017-06-23T15:19:15.4076847+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/2c3771b6-6239-464c-9973-7995b0f45a6b/resourceGroups/CloudServiceCisVaultST14113BRS/providers/Microsoft.Storage/storageAccounts/devicemanagertest1" + } + ], + "cancellationReason": "Old job which is still in ordered state cancelled by the service" + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "abbhat-test-Clone", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourcegroups/abbhat-RG/providers/Microsoft.DataBox/jobs/abbhat-test-Clone", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "deviceType": "Pod", + "isCancellable": false, + "isShippingAddressEditable": false, + "status": "Cancelled", + "startTime": "2018-03-19T19:29:50.3094441+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/fgsdfgdfgsdfg/providers/Microsoft.Storage/storageAccounts/aaadsfdblob" + } + ], + "cancellationReason": "test job" + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "abbhatjob-testcancel", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourcegroups/abbhat-RG/providers/Microsoft.DataBox/jobs/abbhatjob-testcancel", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "deviceType": "Pod", + "isCancellable": false, + "isShippingAddressEditable": false, + "status": "Completed", + "startTime": "2018-04-10T13:35:54.463846+05:30", + "deliveryPackage": { + "carrierName": "UPS", + "trackingId": "1Z12345E8791315509", + "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z12345E8791315509" + }, + "returnPackage": { + "carrierName": "UPS", + "trackingId": "1Z12345E8791315509", + "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z12345E8791315509" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/abbhattestRG/providers/Microsoft.Storage/storageAccounts/abbhattest2" + } + ] + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "abbhattest10Apr", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourcegroups/abbhat-RG/providers/Microsoft.DataBox/jobs/abbhattest10Apr", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "deviceType": "Pod", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-10T20:43:52.0776009+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/sunil/providers/Microsoft.Storage/storageAccounts/111sunilais" + } + ] + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "abbhattest10Apr2", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourcegroups/abbhat-RG/providers/Microsoft.DataBox/jobs/abbhattest10Apr2", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "deviceType": "Pod", + "isCancellable": false, + "isShippingAddressEditable": false, + "status": "Completed", + "startTime": "2018-04-10T22:16:02.9830109+05:30", + "deliveryPackage": { + "carrierName": "UPS", + "trackingId": "1Z12345E8791315509", + "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z12345E8791315509" + }, + "returnPackage": { + "carrierName": "UPS", + "trackingId": "1Z12345E8791315509", + "trackingUrl": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z12345E8791315509" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/abbhat-RG/providers/Microsoft.Storage/storageAccounts/abbhattest" + } + ] + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "abbhattestApr10-2", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourcegroups/abbhat-RG/providers/Microsoft.DataBox/jobs/abbhattestApr10-2", + "type": "Microsoft.DataBox/jobs" + }, + { + "properties": { + "deviceType": "Disk", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-12T18:27:08.0966918+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/sunil/providers/Microsoft.Storage/storageAccounts/111sunilais" + } + ] + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBoxDisk" + }, + "name": "AndiDisk12April-Clone", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourcegroups/abbhat-RG/providers/Microsoft.DataBox/jobs/AndiDisk12April-Clone", + "type": "Microsoft.DataBox/jobs" + } + ], + "nextLink": "https://management.azure.com/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/providers/Microsoft.DataBox/jobs?api-version=2018-01-01&%24skiptoken=7VVdb5swFP0v0banJQEKKVSqpnwATQQ04cuBN4wJMdhAA4GQqv99bqN11bRV2tP2UMkPtu%2f1ucf3%2bvg%2bDork1Bi4yOvBzeMAqI7rOYObwb5pqvpmPKZREaUJTYpmFJ2Ph2QUl3RcH2EdH3DV4LKox1fxZIIigR9OuOtkKCpQHMoQ7YY7QdpBKO%2buOWk3rg5li1FyqMcmjg9lXe6a0SJqoll5GmclrL9FFR62zM4gbwWOl4ccz8aXT3WOK7fMk%2bJ2vVBECLoUUb%2bPBdLCjMOmI3ZLPCOQWm2ok2N45jDa2tRwVWGZyZ8FuNiU8kZQjohZEdC4CChHX1cOIRAv1nS5OC2gIDGLxAdbu2JzDwoNgZlozfE0Xc6nsv8aU%2byNbCobfEjiwmK%2bryjzabrWbCnWPYbr6xqGusf8fuwwHs9I6VqVSHJnb4Ltiosu0Yxwm7MzpqOygJpl5lzvUt6JVP7B3tr3Ua6eATE7U1W2jjszfX1fgRyFSKseHFeLoFdVLodCk%2bNVn%2fJBkq9oQFAdUau531bYJGXn6gxPt%2b9sSrAp7KnrBVIMlr1TlLLB%2fYnRL5wdeIV%2bcuUtrGXQDydBZoHEz3u%2fsEOgrq4CP%2bYh2U82NMwgsF9iRRppHKqEQFtJIFNFxKe9CfaRo63q4GzZhtu1LvVFpK1axDUkcd%2fkXtf6UPA5V1eyS32ec%2b7drSoItD5hJ1m2f%2bPxwn7Rte9Wn93eamHBql74e%2fZGWkjsNhL84zr9fIXYGHx9EcVctVx7anxo40MbF7W%2bqw3hfv4X2gD20ctm2MzIORD4LNEu2mHrE%2fBRjcCmdzMtM4uZAECl%2fddaedWJ6k3Xb%2fpIVSL2odd1QvlRHPejuinZX08rkow6XKCyq%2f9Fexk8PX0H" + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsListByResourceGroup.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsListByResourceGroup.json new file mode 100644 index 000000000000..98dbe476ce58 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "api-version": "2018-01-01", + "$expand": "details" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "deviceType": "Pod", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-13T16:28:38.9999793+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/kvtestWUSrg/providers/microsoft.storage/storageAccounts/kvtestwus" + } + ] + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob8558", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/SdkRg2508/providers/Microsoft.DataBox/jobs/SdkJob8558", + "type": "Microsoft.DataBox/jobs" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsListSecrets.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsListSecrets.json new file mode 100644 index 000000000000..425d3fc73e2e --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsListSecrets.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "sdktest5497", + "api-version": "2018-01-01" + }, + "responses": { + "200": { + "body": { + "jobName": "sdktest5497", + "deviceType": "Pod", + "jobSecrets": { + "podSecrets": [ + { + "deviceSerialNumber": "abbhatipv1epd", + "devicePassword": "GN7$gt]W9", + "accountCredentialDetails": [ + { + "accountName": "devicemanagertest1", + "shareCredentialDetails": [ + { + "shareName": "devicemanagertest1_PageBlob", + "userName": "devicemanagertest1", + "password": "E]vP#4y7" + }, + { + "shareName": "devicemanagertest1_BlockBlob", + "userName": "devicemanagertest1", + "password": "E]vP#4y7" + }, + { + "shareName": "devicemanagertest1_AzFile", + "userName": "devicemanagertest1", + "password": "E]vP#4y7" + } + ] + } + ] + } + ], + "jobSecretsType": "Pod" + } + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsReportIssue.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsReportIssue.json new file mode 100644 index 000000000000..96e42eae7f9e --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsReportIssue.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "sdktest5497", + "api-version": "2018-01-01", + "reportIssueDetails": { + "issueType": "DeviceFailure", + "deviceIssueType": "DeviceNotBootingUp" + } + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsUpdate.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsUpdate.json new file mode 100644 index 000000000000..94c4d4ceede6 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/JobsUpdate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "resourceGroupName": "SdkRg2508", + "jobName": "SdkJob8558", + "api-version": "2018-01-01", + "$expand": "details", + "jobResourceUpdateParameter": { + "properties": { + "details": { + "contactDetails": { + "contactName": "Update Job", + "phone": "1234567890", + "phoneExtension": "1234", + "emailList": [ + "testing@microsoft.com" + ] + }, + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "companyName": "Microsoft", + "addressType": "Commercial" + } + } + } + } + }, + "responses": { + "202": { + "body": "" + }, + "200": { + "body": { + "properties": { + "deviceType": "Pod", + "isCancellable": true, + "isShippingAddressEditable": true, + "status": "DeviceOrdered", + "startTime": "2018-04-13T16:28:38.9999793+05:30", + "deliveryPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "returnPackage": { + "carrierName": "", + "trackingId": "", + "trackingUrl": "" + }, + "destinationAccountDetails": [ + { + "accountId": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/kvtestWUSrg/providers/microsoft.storage/storageAccounts/kvtestwus" + } + ] + }, + "location": "westus", + "tags": {}, + "sku": { + "name": "DataBox" + }, + "name": "SdkJob8558", + "id": "/subscriptions/3c66da21-607e-49b4-8bdf-f25fbb8f705f/resourceGroups/SdkRg2508/providers/Microsoft.DataBox/jobs/SdkJob8558", + "type": "Microsoft.DataBox/jobs" + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/OperationsList.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/OperationsList.json new file mode 100644 index 000000000000..211756f55ce4 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/OperationsList.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "api-version": "2018-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataBox/jobs/listSecrets/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "List Secrets", + "description": "Lists the unencrypted secrets related to the order." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/cancel/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Cancel", + "description": "Cancels an order in progress." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/reportIssue/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Report Issue", + "description": "Reports an issue in the order." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/copyLogsUri/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Copy Log URL", + "description": "Get URL for the copy logs of each destination account." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/downloadShippingLabel/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Download Shipping Label", + "description": "Get shipping label for the return shipment." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/bookShipmentPickUp/action", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Book Shipment Pick Up", + "description": "Allows to book a pick up for return shipments." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/read", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "List Orders", + "description": "List or get the Orders" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/delete", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Delete Orders", + "description": "Delete the Orders" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/jobs/write", + "display": { + "provider": "Azure Data Box", + "resource": "Orders", + "operation": "Create or Update Orders", + "description": "Create or update the Orders" + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/validateAddress/action", + "display": { + "provider": "Azure Data Box", + "resource": "Validate Address", + "operation": "Validate Address", + "description": "Validates the shipping address and provides alternate addresses if any." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/regionAvailability/action", + "display": { + "provider": "Azure Data Box", + "resource": "Region Availability", + "operation": "Region Availability", + "description": "This method returns the list of supported regions for the service and for destination storage accounts." + }, + "properties": {}, + "origin": "user" + }, + { + "name": "Microsoft.DataBox/locations/availableSkus/action", + "display": { + "provider": "Azure Data Box", + "resource": "ArmApiRes_availableSkus" + }, + "properties": {}, + "origin": "user" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/ServiceListAvailableSkus.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/ServiceListAvailableSkus.json new file mode 100644 index 000000000000..bd7da8ef54b1 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/ServiceListAvailableSkus.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "location": "westus", + "api-version": "2018-01-01", + "availableSkuRequest": { + "country": "US", + "location": "westus", + "transferType": "ImportToAzure" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "DataBox" + }, + "enabled": true, + "properties": { + "destinationToServiceLocationMap": [ + { + "destinationLocation": "westus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "centralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "eastus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "eastus2", + "serviceLocation": "westus" + }, + { + "destinationLocation": "northcentralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "southcentralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "westcentralus", + "serviceLocation": "westus" + } + ], + "capacity": { + "usable": "80", + "maximum": "100" + }, + "costs": [ + { + "meterId": "0cf23ffc-0b64-49e6-9bdd-1db885349042", + "meterType": "DataBoxServiceFee" + }, + { + "meterId": "a701f058-119b-4713-a923-bed7da4b7801", + "meterType": "DataBoxShippingFee" + } + ], + "apiVersions": [ + "2018-01-01" + ] + } + }, + { + "sku": { + "name": "DataBoxDisk" + }, + "enabled": true, + "properties": { + "destinationToServiceLocationMap": [ + { + "destinationLocation": "westus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "centralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "eastus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "eastus2", + "serviceLocation": "westus" + }, + { + "destinationLocation": "northcentralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "southcentralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "westcentralus", + "serviceLocation": "westus" + } + ], + "capacity": { + "usable": "18", + "maximum": "20" + }, + "costs": [], + "apiVersions": [ + "2018-01-01" + ] + } + }, + { + "sku": { + "name": "DataBoxCabinet" + }, + "enabled": true, + "properties": { + "destinationToServiceLocationMap": [ + { + "destinationLocation": "westus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "centralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "eastus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "eastus2", + "serviceLocation": "westus" + }, + { + "destinationLocation": "northcentralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "southcentralus", + "serviceLocation": "westus" + }, + { + "destinationLocation": "westcentralus", + "serviceLocation": "westus" + } + ], + "capacity": { + "usable": "800", + "maximum": "1000" + }, + "costs": [], + "apiVersions": [ + "2018-01-01" + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/ServiceValidateAddress.json b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/ServiceValidateAddress.json new file mode 100644 index 000000000000..5c6b716dfb31 --- /dev/null +++ b/specification/databox/resource-manager/Microsoft.DataBox/preview/2018-01-01/examples/ServiceValidateAddress.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "3c66da21-607e-49b4-8bdf-f25fbb8f705f", + "location": "westus", + "api-version": "2018-01-01", + "validateAddress": { + "shippingAddress": { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "city": "San Francisco", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "validationStatus": "Valid", + "alternateAddresses": [ + { + "streetAddress1": "16 TOWNSEND ST", + "streetAddress2": "Unit 1", + "streetAddress3": "", + "city": "SAN FRANCISCO", + "stateOrProvince": "CA", + "country": "US", + "postalCode": "94107", + "addressType": "None" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/databox/resource-manager/readme.md b/specification/databox/resource-manager/readme.md new file mode 100644 index 000000000000..487819189c8e --- /dev/null +++ b/specification/databox/resource-manager/readme.md @@ -0,0 +1,106 @@ +# DataBox + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DataBox. + + + +--- +## Getting Started +To build the SDK for DataBox, 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 DataBox API. + +``` yaml +openapi-type: arm + +input-file: +- Microsoft.DataBox\preview\2018-01-01\databox.json +directive: + - suppress: + - R2016 #to suppress (PatchBodyParametersSchema/R2016/RPCViolation) + - R2062 #to suppress (XmsResourceInPutResponse/R2062/RPCViolation) +``` +--- +# 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-go + - repo: azure-sdk-for-node +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.DataBox + output-folder: $(csharp-sdks-folder)/DataBox/Management.DataBox/Generated + clear-output-folder: true +``` + + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: databox + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +``` + +### Tag: package-2017-06 and go + +Please also specify `--go-sdk-folder=`. + +``` yaml $(go) +output-folder: $(go-sdk-folder)/services/databox/mgmt/2018-01-01/databox +``` + + +## 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 + fluent: true + namespace: com.microsoft.azure.management.databox + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/databox +``` diff --git a/specification/databox/resource-manager/readme.nodejs.md b/specification/databox/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..081b5c0f619d --- /dev/null +++ b/specification/databox/resource-manager/readme.nodejs.md @@ -0,0 +1,11 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-databox + output-folder: $(node-sdks-folder)/lib/services/databox/lib +``` diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json index 33fa9d5d80f2..158c31e434ff 100644 --- a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json @@ -309,6 +309,40 @@ "nextLinkName": "nextLink" } } + }, + "/providers/Microsoft.Databricks/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available RP operations.", + "x-ms-examples": { + "Operations": { + "$ref": "./examples/OperationsList.json" + } + }, + "operationId": "Operations_List", + "parameters": [{ + "$ref": "#/parameters/ApiVersionParameter" + }], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } } }, "definitions": { @@ -400,6 +434,7 @@ ] }, "Resource": { + "description": "The core properties of ARM resources", "properties": { "id": { "readOnly": true, @@ -569,6 +604,49 @@ } }, "description": "List of workspaces." + }, + "Operation": { + "description": "REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.ResourceProvider", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Resource Provider operations supported by the Resource Provider resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } } }, "parameters": { diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/OperationsList.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/OperationsList.json new file mode 100644 index 000000000000..ae621c5399a9 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/OperationsList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": [ + { + "name": "Microsoft.Databricks/workspaces/read", + "display": { + "provider": "Microsoft Databricks", + "resource": "Workspace", + "operation": "List Workspaces", + "description": "Retrieves a list of workspaces." + } + }, + { + "name": "Microsoft.Databricks/workspaces/write", + "display": { + "provider": "Microsoft Databricks", + "resource": "Workspace", + "operation": "Create Workspace", + "description": "Creates an workspace." + } + }, + { + "name": "Microsoft.Databricks/workspaces/delete", + "display": { + "provider": "Microsoft Databricks", + "resource": "Workspace", + "operation": "Remove Workspace", + "description": "Removes an workspace." + } + } + ] + } + } +} diff --git a/specification/databricks/resource-manager/readme.md b/specification/databricks/resource-manager/readme.md index db55f8c46cd6..afd1f9ec3282 100644 --- a/specification/databricks/resource-manager/readme.md +++ b/specification/databricks/resource-manager/readme.md @@ -7,6 +7,28 @@ This is the AutoRest configuration file for Databricks. --- + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-04-01 +``` + +### Tag: package-2018-04-01 and java + +These settings apply only when `--tag=package-2018-04-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-04-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.databricks.v2018_04_01 + output-folder: $(azure-libraries-for-java-folder)/databricks/resource-manager/v2018_04_01 +regenerate-manager: true +generate-interface: true +``` + + ## Getting Started To build the SDK for Databricks, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: @@ -26,7 +48,7 @@ These are the global settings for the Databricks API. ``` yaml openapi-type: arm -tag: package-2018-03-01-preview +tag: package-2018-04-01 ``` diff --git a/specification/datacatalog/resource-manager/readme.md b/specification/datacatalog/resource-manager/readme.md index 3dc2a4e53d5c..d3404517387e 100644 --- a/specification/datacatalog/resource-manager/readme.md +++ b/specification/datacatalog/resource-manager/readme.md @@ -125,11 +125,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.datacatalog +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datacatalog +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-03-30 +``` + +### Tag: package-2016-03-30 and java + +These settings apply only when `--tag=package-2016-03-30 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-03-30' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.datacatalog - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datacatalog + namespace: com.microsoft.azure.management.datacatalog.v2016_03_30 + output-folder: $(azure-libraries-for-java-folder)/datacatalog/resource-manager/v2016_03_30 +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json index 5033dedf7769..13c5e57b598a 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json @@ -105,6 +105,54 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/configureFactoryRepo": { + "post": { + "tags": [ + "configureFactoryRepo" + ], + "operationId": "Factories_ConfigureFactoryRepo", + "x-ms-examples": { + "Factories_ConfigureFactoryRepo": { + "$ref": "./examples/Factories_ConfigureFactoryRepo.json" + } + }, + "description": "Updates a factory's repo information.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/locationId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "factoryRepoUpdate", + "description": "Update factory repo request definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FactoryRepoUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/Factory" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories": { "get": { "tags": [ @@ -2854,6 +2902,56 @@ "type": "object" } }, + "FactoryVSTSConfiguration": { + "description": "Factory's VSTS repo information.", + "properties": { + "accountName": { + "description": "VSTS account name.", + "type": "string" + }, + "projectName": { + "description": "VSTS project name.", + "type": "string" + }, + "repositoryName": { + "description": "VSTS repository name.", + "type": "string" + }, + "collaborationBranch": { + "description": "VSTS collaboration branch.", + "type": "string" + }, + "rootFolder": { + "description": "VSTS root folder.", + "type": "string" + }, + "lastCommitId": { + "description": "VSTS last commit id.", + "type": "string" + }, + "tenantId": { + "description": "VSTS tenant id.", + "type": "string" + } + } + }, + "FactoryRepoUpdate": { + "description": "Factory's VSTS repo information.", + "properties": { + "factoryResourceId": { + "description": "The factory resource id.", + "type": "string" + }, + "resourceGroupName": { + "description": "The resource group name.", + "type": "string" + }, + "vstsConfiguration": { + "$ref": "#/definitions/FactoryVSTSConfiguration", + "description": "VSTS repo information of the factory." + } + } + }, "FactoryProperties": { "description": "Factory resource properties.", "properties": { @@ -2872,6 +2970,10 @@ "description": "Version of the factory.", "type": "string", "readOnly": true + }, + "vstsConfiguration": { + "$ref": "#/definitions/FactoryVSTSConfiguration", + "description": "VSTS repo information of the factory." } } }, @@ -3698,6 +3800,14 @@ "maxLength": 63, "x-ms-parameter-location": "method" }, + "locationId": { + "name": "locationId", + "description": "The location identifier.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, "linkedServiceName": { "name": "linkedServiceName", "description": "The linked service name.", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/IntegrationRuntime.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/IntegrationRuntime.json index 2abc40247475..b3ee8b8e428e 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/IntegrationRuntime.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/IntegrationRuntime.json @@ -98,8 +98,7 @@ "maxParallelExecutionsPerNode": { "description": "Maximum parallel executions count per node for managed integration runtime.", "type": "integer", - "minimum": 1, - "maximum": 8 + "minimum": 1 }, "vNetProperties": { "description": "VNet properties for managed integration runtime.", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/LinkedService.json index 15858022aebf..6df8dcbba4f2 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/LinkedService.json @@ -66,8 +66,8 @@ "description": "Azure Storage linked service properties.", "properties": { "connectionString": { - "description": "The connection string. It is mutually exclusive with sasUri property.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "description": "The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" }, "sasUri": { "description": "SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property.", @@ -103,8 +103,8 @@ "description": "Azure SQL Data Warehouse linked service properties.", "properties": { "connectionString": { - "description": "The connection string.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" }, "servicePrincipalId": { "type": "object", @@ -151,8 +151,8 @@ "description": "SQL Server linked service properties.", "properties": { "connectionString": { - "description": "The connection string.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" }, "userName": { "type": "object", @@ -195,8 +195,8 @@ "description": "Azure SQL Database linked service properties.", "properties": { "connectionString": { - "description": "The connection string.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" }, "servicePrincipalId": { "type": "object", @@ -330,8 +330,8 @@ "description": "CosmosDB linked service properties.", "properties": { "connectionString": { - "description": "The connection string.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" }, "encryptedCredential": { "type": "object", @@ -544,8 +544,8 @@ "description": "Oracle database linked service properties.", "properties": { "connectionString": { - "description": "The connection string.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" }, "encryptedCredential": { "type": "object", @@ -580,8 +580,8 @@ "description": "Azure MySQL database linked service properties.", "properties": { "connectionString": { - "description": "The connection string.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" }, "encryptedCredential": { "type": "object", @@ -615,24 +615,8 @@ "MySqlLinkedServiceTypeProperties": { "description": "MySQL linked service properties.", "properties": { - "server": { - "type": "object", - "description": "Server name for connection. Type: string (or Expression with resultType string)." - }, - "database": { - "type": "object", - "description": "Database name for connection. Type: string (or Expression with resultType string)." - }, - "schema": { - "type": "object", - "description": "Schema name for connection. Type: string (or Expression with resultType string)." - }, - "username": { - "type": "object", - "description": "Username for authentication. Type: string (or Expression with resultType string)." - }, - "password": { - "description": "Password for authentication.", + "connectionString": { + "description": "The connection string.", "$ref": "../datafactory.json#/definitions/SecretBase" }, "encryptedCredential": { @@ -641,8 +625,7 @@ } }, "required": [ - "server", - "database" + "connectionString" ] }, "PostgreSqlLinkedService": { @@ -668,24 +651,8 @@ "PostgreSqlLinkedServiceTypeProperties": { "description": "PostgreSQL linked service properties.", "properties": { - "server": { - "type": "object", - "description": "Server name for connection. Type: string (or Expression with resultType string)." - }, - "database": { - "type": "object", - "description": "Database name for connection. Type: string (or Expression with resultType string)." - }, - "schema": { - "type": "object", - "description": "Schema name for connection. Type: string (or Expression with resultType string)." - }, - "username": { - "type": "object", - "description": "Username for authentication. Type: string (or Expression with resultType string)." - }, - "password": { - "description": "Password for authentication.", + "connectionString": { + "description": "The connection string.", "$ref": "../datafactory.json#/definitions/SecretBase" }, "encryptedCredential": { @@ -694,8 +661,7 @@ } }, "required": [ - "server", - "database" + "connectionString" ] }, "SybaseLinkedService": { @@ -794,10 +760,6 @@ "type": "object", "description": "Database name for connection. Type: string (or Expression with resultType string)." }, - "schema": { - "type": "object", - "description": "Schema name for connection. Type: string (or Expression with resultType string)." - }, "authenticationType": { "description": "AuthenticationType to be used for connection.", "type": "string", @@ -854,10 +816,6 @@ "type": "object", "description": "Server name for connection. Type: string (or Expression with resultType string)." }, - "schema": { - "type": "object", - "description": "Schema name for connection. Type: string (or Expression with resultType string)." - }, "authenticationType": { "description": "AuthenticationType to be used for connection.", "type": "string", @@ -968,8 +926,8 @@ "description": "ODBC linked service properties.", "properties": { "connectionString": { - "description": "The non-access credential portion of the connection string as well as an optional encrypted credential.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "description": "The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" }, "authenticationType": { "type": "object", @@ -2095,14 +2053,14 @@ ] }, "AzurePostgreSqlLinkedServiceTypeProperties": { - "description": "Azure PostgreSQL linked service properties.", + "description": "Azure PostgreSQL linked service properties.", "properties": { - "connectionString": { - "description": "An ODBC connection string.", - "$ref": "../datafactory.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).", + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } } @@ -2185,14 +2143,14 @@ ] }, "CouchbaseLinkedServiceTypeProperties": { - "description": "Couchbase server linked service properties.", + "description": "Couchbase server linked service properties.", "properties": { - "connectionString": { - "description": "An ODBC connection string.", - "$ref": "../datafactory.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).", + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } } @@ -2218,14 +2176,14 @@ ] }, "DrillLinkedServiceTypeProperties": { - "description": "Drill server linked service properties.", + "description": "Drill server linked service properties.", "properties": { - "connectionString": { - "description": "An ODBC connection string.", - "$ref": "../datafactory.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).", + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } } @@ -2393,14 +2351,14 @@ ] }, "GreenplumLinkedServiceTypeProperties": { - "description": "Greenplum Database linked service properties.", + "description": "Greenplum Database linked service properties.", "properties": { - "connectionString": { - "description": "An ODBC connection string.", - "$ref": "../datafactory.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).", + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } } @@ -2887,14 +2845,14 @@ ] }, "MariaDBLinkedServiceTypeProperties": { - "description": "MariaDB server linked service properties.", + "description": "MariaDB server linked service properties.", "properties": { - "connectionString": { - "description": "An ODBC connection string.", - "$ref": "../datafactory.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).", + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } } @@ -3215,7 +3173,7 @@ ] }, "QuickBooksLinkedServiceTypeProperties": { - "description": "QuickBooks server linked service properties.", + "description": "QuickBooks server linked service properties.", "properties": { "endpoint": { "description": "The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)", @@ -3225,6 +3183,14 @@ "description": "The company ID of the QuickBooks company to authorize.", "type": "object" }, + "consumerKey": { + "description": "The consumer key for OAuth 1.0 authentication.", + "type": "object" + }, + "consumerSecret": { + "description": "The consumer secret for OAuth 1.0 authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, "accessToken": { "description": "The access token for OAuth 1.0 authentication.", "$ref": "../datafactory.json#/definitions/SecretBase" @@ -3237,14 +3203,18 @@ "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", "type": "object" }, - "encryptedCredential": { - "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } }, "required": [ "endpoint", - "companyId" + "companyId", + "consumerKey", + "consumerSecret", + "accessToken", + "accessTokenSecret" ] }, "ServiceNowLinkedService": { @@ -3271,7 +3241,7 @@ "description": "ServiceNow server linked service properties.", "properties": { "endpoint": { - "description": "The endpoint of the ServiceNow server. (i.e. ServiceNowData.com)", + "description": "The endpoint of the ServiceNow server. (i.e. .service-now.com)", "type": "object" }, "authenticationType": { @@ -3681,14 +3651,14 @@ ] }, "VerticaLinkedServiceTypeProperties": { - "description": "Vertica linked service properties.", + "description": "Vertica linked service properties.", "properties": { - "connectionString": { - "description": "An ODBC connection string.", - "$ref": "../datafactory.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).", + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } } @@ -3714,14 +3684,14 @@ ] }, "NetezzaLinkedServiceTypeProperties": { - "description": "Netezza linked service properties.", + "description": "Netezza linked service properties.", "properties": { - "connectionString": { - "description": "An ODBC connection string.", - "$ref": "../datafactory.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).", + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } } diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json index 76a1c5b897f1..c054a23a24f4 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json @@ -1615,7 +1615,11 @@ "properties": { "columnMappings": { "type": "object", - "description": "Column mappings. Type: string (or Expression with resultType string)." + "description": "Column mappings. Example: \"UserId: MyUserId, Group: MyGroup, Name: MyName\" Type: string (or Expression with resultType string)." + }, + "schemaMapping": { + "type": "object", + "description": "The schema mapping to map between tabular data and hierarchical data. Example: {\"Column1\": \"$.Column1\", \"Column2\": \"$.Column2.Property1\", \"Column3\": \"$.Column2.Property2\"}. Type: object (or Expression with resultType object)." } } }, diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json index e0ab1a2bd29d..921b0da9c4da 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json @@ -275,6 +275,63 @@ "typeProperties" ] }, + "BlobEventsTrigger": + { + "description": "Trigger that runs everytime a Blob event occurs.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": + { + "description": "Blob Events Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "blobPathBeginsWith": { + "description": "The blob path must begin with the pattern provided for trigger to fire. For example, '/records/blobs/december/' will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.", + "type": "string" + }, + "blobPathEndsWith": { + "description": "The blob path must end with the pattern provided for trigger to fire. For example, 'december/boxes.csv' will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.", + "type": "string" + }, + "events": { + "description": "The type of events that cause this trigger to fire.", + "$ref": "#/definitions/BlobEventTypes" + }, + "scope": { + "description": "The ARM resource ID of the Storage Account.", + "type": "string" + } + }, + "required": [ + "events", + "scope" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "BlobEventTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Microsoft.Storage.BlobCreated", + "Microsoft.Storage.BlobDeleted" + ], + "x-ms-enum": { + "name": "BlobEventTypes", + "modelAsString": true + } + }, + "description": "Blob event types." + }, "TumblingWindowTrigger": { "description": "Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).", "type": "object", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_ConfigureFactoryRepo.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_ConfigureFactoryRepo.json new file mode 100644 index 000000000000..01f4de632836 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_ConfigureFactoryRepo.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "locationId": "eastus", + "factoryRepoUpdate": { + "resourceGroupName": "exampleResourceGroup", + "factoryId": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/examplefactoryname", + "vstsConfiguration": { + "accountName": "msdata", + "projectName": "datafactory", + "repositoryName": "exampleRepo", + "collaborationBranch": "master", + "rootFolder": "/", + "lastCommitId": "", + "tenantId": "12f988bf-86d1-41af-91ab-2d7cd011db49" + } + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:33:54 GMT", + "x-ms-request-id": "dc1954ed-a1d3-4437-bd73-480ffdf1ea5a", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-correlation-request-id": "8d66d31c-23f3-4ac1-bc8c-1b6464342ad1" + }, + "body": { + "name": "exampleFactoryName", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "createTime": "2017-09-13T17:33:54.0294655Z", + "version": "2017-09-01-preview", + "vstsConfiguration": { + "accountName": "msdata", + "projectName": "datafactory", + "repositoryName": "exampleRepo", + "collaborationBranch": "master", + "rootFolder": "/", + "lastCommitId": "", + "tenantId": "12f988bf-86d1-41af-91ab-2d7cd011db49" + } + }, + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/examplefactoryname", + "type": "Microsoft.DataFactory/factories", + "location": "East US" + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_CreateOrUpdate.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_CreateOrUpdate.json index aa231c3c90a4..4f258178de19 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_CreateOrUpdate.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_CreateOrUpdate.json @@ -4,7 +4,18 @@ "resourceGroupName": "exampleResourceGroup", "factoryName": "exampleFactoryName", "factory": { - "location": "East US" + "location": "East US", + "properties": { + "vstsConfiguration": { + "accountName": "msdata", + "projectName": "datafactory", + "repositoryName": "exampleRepo", + "collaborationBranch": "master", + "rootFolder": "/", + "lastCommitId": "", + "tenantId": "12f988bf-86d1-41af-91ab-2d7cd011db49" + } + } }, "api-version": "2017-09-01-preview" }, @@ -23,7 +34,16 @@ "properties": { "provisioningState": "Succeeded", "createTime": "2017-09-13T17:33:54.0294655Z", - "version": "2017-09-01-preview" + "version": "2017-09-01-preview", + "vstsConfiguration": { + "accountName": "msdata", + "projectName": "datafactory", + "repositoryName": "exampleRepo", + "collaborationBranch": "master", + "rootFolder": "/", + "lastCommitId": "", + "tenantId": "12f988bf-86d1-41af-91ab-2d7cd011db49" + } }, "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/examplefactoryname", "type": "Microsoft.DataFactory/factories", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json new file mode 100644 index 000000000000..d5667363d768 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json @@ -0,0 +1,4040 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2018-06-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.DataFactory/operations": { + "get": { + "tags": [ + "operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "description": "Lists the available Azure Data Factory API operations.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/OperationListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/factories": { + "get": { + "tags": [ + "factories" + ], + "operationId": "Factories_List", + "x-ms-examples": { + "Factories_List": { + "$ref": "./examples/Factories_List.json" + } + }, + "description": "Lists factories under the specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/FactoryListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/configureFactoryRepo": { + "post": { + "tags": [ + "factories" + ], + "operationId": "Factories_ConfigureFactoryRepo", + "x-ms-examples": { + "Factories_ConfigureFactoryRepo": { + "$ref": "./examples/Factories_ConfigureFactoryRepo.json" + } + }, + "description": "Updates a factory's repo information.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/locationId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "factoryRepoUpdate", + "description": "Update factory repo request definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FactoryRepoUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/Factory" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories": { + "get": { + "tags": [ + "factories" + ], + "operationId": "Factories_ListByResourceGroup", + "x-ms-examples": { + "Factories_ListByResourceGroup": { + "$ref": "./examples/Factories_ListByResourceGroup.json" + } + }, + "description": "Lists factories.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/FactoryListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}": { + "put": { + "tags": [ + "factories" + ], + "operationId": "Factories_CreateOrUpdate", + "x-ms-examples": { + "Factories_CreateOrUpdate": { + "$ref": "./examples/Factories_CreateOrUpdate.json" + } + }, + "description": "Creates or updates a factory.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "factory", + "description": "Factory resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Factory" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the factory entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/Factory" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "factories" + ], + "operationId": "Factories_Update", + "x-ms-examples": { + "Factories_Update": { + "$ref": "./examples/Factories_Update.json" + } + }, + "description": "Updates a factory.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "factoryUpdateParameters", + "description": "The parameters for updating a factory.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FactoryUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/Factory" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "factories" + ], + "operationId": "Factories_Get", + "x-ms-examples": { + "Factories_Get": { + "$ref": "./examples/Factories_Get.json" + } + }, + "description": "Gets a factory.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the factory 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/Factory" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "factories" + ], + "operationId": "Factories_Delete", + "x-ms-examples": { + "Factories_Delete": { + "$ref": "./examples/Factories_Delete.json" + } + }, + "description": "Deletes a factory.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes": { + "get": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_ListByFactory", + "x-ms-examples": { + "IntegrationRuntimes_ListByFactory": { + "$ref": "./examples/IntegrationRuntimes_ListByFactory.json" + } + }, + "description": "Lists integration runtimes.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}": { + "put": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_CreateOrUpdate", + "x-ms-examples": { + "IntegrationRuntimes_Create": { + "$ref": "./examples/IntegrationRuntimes_Create.json" + } + }, + "description": "Creates or updates an integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the integration runtime entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "integrationRuntime", + "description": "Integration runtime resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IntegrationRuntimeResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeResource" + } + }, + "default": { + "description": "An error response received from PUT integration runtime operation.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_Get", + "x-ms-examples": { + "IntegrationRuntimes_Get": { + "$ref": "./examples/IntegrationRuntimes_Get.json" + } + }, + "description": "Gets an integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the integration runtime entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from GET integration runtime operation.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_Update", + "x-ms-examples": { + "IntegrationRuntimes_Update": { + "$ref": "./examples/IntegrationRuntimes_Update.json" + } + }, + "description": "Updates an integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "updateIntegrationRuntimeRequest", + "description": "The parameters for updating an integration runtime.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateIntegrationRuntimeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_Delete", + "x-ms-examples": { + "IntegrationRuntimes_Delete": { + "$ref": "./examples/IntegrationRuntimes_Delete.json" + } + }, + "description": "Deletes an integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from DELETE integration runtime operation.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_GetStatus", + "x-ms-examples": { + "IntegrationRuntimes_GetStatus": { + "$ref": "./examples/IntegrationRuntimes_GetStatus.json" + } + }, + "description": "Gets detailed status information for an integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeStatusResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_GetConnectionInfo", + "x-ms-examples": { + "IntegrationRuntimes_GetConnectionInfo": { + "$ref": "./examples/IntegrationRuntimes_GetConnectionInfo.json" + } + }, + "description": "Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeConnectionInfo" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_RegenerateAuthKey", + "x-ms-examples": { + "IntegrationRuntimes_RegenerateAuthKey": { + "$ref": "./examples/IntegrationRuntimes_RegenerateAuthKey.json" + } + }, + "description": "Regenerates the authentication key for an integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "regenerateKeyParameters", + "description": "The parameters for regenerating integration runtime authentication key.", + "in": "body", + "required": true, + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeRegenerateKeyParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeAuthKeys" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_ListAuthKeys", + "x-ms-examples": { + "IntegrationRuntimes_ListAuthKeys": { + "$ref": "./examples/IntegrationRuntimes_ListAuthKeys.json" + } + }, + "description": "Retrieves the authentication keys for an integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeAuthKeys" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_Start", + "x-ms-examples": { + "IntegrationRuntimes_Start": { + "$ref": "./examples/IntegrationRuntimes_Start.json" + } + }, + "description": "Starts a ManagedReserved type integration runtime.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeStatusResponse" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/stop": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_Stop", + "x-ms-examples": { + "IntegrationRuntimes_Stop": { + "$ref": "./examples/IntegrationRuntimes_Stop.json" + } + }, + "description": "Stops a ManagedReserved type integration runtime.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_SyncCredentials", + "x-ms-examples": { + "IntegrationRuntimes_SyncCredentials": { + "$ref": "./examples/IntegrationRuntimes_SyncCredentials.json" + } + }, + "description": "Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_GetMonitoringData", + "x-ms-examples": { + "IntegrationRuntimes_GetMonitoringData": { + "$ref": "./examples/IntegrationRuntimes_GetMonitoringData.json" + } + }, + "description": "Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeMonitoringData" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/upgrade": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_Upgrade", + "x-ms-examples": { + "IntegrationRuntimes_Upgrade": { + "$ref": "./examples/IntegrationRuntimes_Upgrade.json" + } + }, + "description": "Upgrade self-hosted integration runtime to latest version if availably.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/removeLinks": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_RemoveLinks", + "x-ms-examples": { + "IntegrationRuntimes_Upgrade": { + "$ref": "./examples/IntegrationRuntimes_RemoveLinks.json" + } + }, + "description": "Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "linkedIntegrationRuntimeRequest", + "description": "The data factory name for the linked integration runtime.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkedIntegrationRuntimeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}": { + "delete": { + "tags": [ + "integrationRuntimeNodes" + ], + "operationId": "IntegrationRuntimeNodes_Delete", + "x-ms-examples": { + "IntegrationRuntimesNodes_Delete": { + "$ref": "./examples/IntegrationRuntimeNodes_Delete.json" + } + }, + "description": "Deletes a self-hosted integration runtime node.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/nodeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "integrationRuntimeNodes" + ], + "operationId": "IntegrationRuntimeNodes_Update", + "x-ms-examples": { + "IntegrationRuntimeNodes_Update": { + "$ref": "./examples/IntegrationRuntimeNodes_Update.json" + } + }, + "description": "Updates a self-hosted integration runtime node.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/nodeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "updateIntegrationRuntimeNodeRequest", + "description": "The parameters for updating an integration runtime node.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateIntegrationRuntimeNodeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/SelfHostedIntegrationRuntimeNode" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}/ipAddress": { + "post": { + "tags": [ + "integrationRuntimeNodes" + ], + "operationId": "IntegrationRuntimeNodes_GetIpAddress", + "x-ms-examples": { + "IntegrationRuntimeNodes_GetIpAddress": { + "$ref": "./examples/IntegrationRuntimeNodes_GetIpAddress.json" + } + }, + "description": "Get the IP address of self-hosted integration runtime node.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/nodeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeNodeIpAddress" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices": { + "get": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedServices_ListByFactory", + "x-ms-examples": { + "LinkedServices_ListByFactory": { + "$ref": "./examples/LinkedServices_ListByFactory.json" + } + }, + "description": "Lists linked services.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LinkedServiceListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}": { + "put": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedServices_CreateOrUpdate", + "x-ms-examples": { + "LinkedServices_Create": { + "$ref": "./examples/LinkedServices_Create.json" + }, + "LinkedServices_Update": { + "$ref": "./examples/LinkedServices_Update.json" + } + }, + "description": "Creates or updates a linked service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/linkedServiceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "linkedService", + "description": "Linked service resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkedServiceResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LinkedServiceResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedServices_Get", + "x-ms-examples": { + "LinkedServices_Get": { + "$ref": "./examples/LinkedServices_Get.json" + } + }, + "description": "Gets a linked service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/linkedServiceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the linked service entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LinkedServiceResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedServices_Delete", + "x-ms-examples": { + "LinkedServices_Delete": { + "$ref": "./examples/LinkedServices_Delete.json" + } + }, + "description": "Deletes a linked service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/linkedServiceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets": { + "get": { + "tags": [ + "datasets" + ], + "operationId": "Datasets_ListByFactory", + "x-ms-examples": { + "Datasets_ListByFactory": { + "$ref": "./examples/Datasets_ListByFactory.json" + } + }, + "description": "Lists datasets.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DatasetListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}": { + "put": { + "tags": [ + "datasets" + ], + "operationId": "Datasets_CreateOrUpdate", + "x-ms-examples": { + "Datasets_Create": { + "$ref": "./examples/Datasets_Create.json" + }, + "Datasets_Update": { + "$ref": "./examples/Datasets_Update.json" + } + }, + "description": "Creates or updates a dataset.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/datasetName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "dataset", + "description": "Dataset resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DatasetResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "datasets" + ], + "operationId": "Datasets_Get", + "x-ms-examples": { + "Datasets_Get": { + "$ref": "./examples/Datasets_Get.json" + } + }, + "description": "Gets a dataset.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/datasetName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DatasetResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "datasets" + ], + "operationId": "Datasets_Delete", + "x-ms-examples": { + "Datasets_Delete": { + "$ref": "./examples/Datasets_Delete.json" + } + }, + "description": "Deletes a dataset.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/datasetName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines": { + "get": { + "tags": [ + "pipelines" + ], + "operationId": "Pipelines_ListByFactory", + "x-ms-examples": { + "Pipelines_ListByFactory": { + "$ref": "./examples/Pipelines_ListByFactory.json" + } + }, + "description": "Lists pipelines.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}": { + "put": { + "tags": [ + "pipelines" + ], + "operationId": "Pipelines_CreateOrUpdate", + "x-ms-examples": { + "Pipelines_Create": { + "$ref": "./examples/Pipelines_Create.json" + }, + "Pipelines_Update": { + "$ref": "./examples/Pipelines_Update.json" + } + }, + "description": "Creates or updates a pipeline.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the pipeline entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "pipeline", + "description": "Pipeline resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PipelineResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "pipelines" + ], + "operationId": "Pipelines_Get", + "x-ms-examples": { + "Pipelines_Get": { + "$ref": "./examples/Pipelines_Get.json" + } + }, + "description": "Gets a pipeline.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the pipeline entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "pipelines" + ], + "operationId": "Pipelines_Delete", + "x-ms-examples": { + "Pipelines_Delete": { + "$ref": "./examples/Pipelines_Delete.json" + } + }, + "description": "Deletes a pipeline.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun": { + "post": { + "tags": [ + "pipelines" + ], + "operationId": "Pipelines_CreateRun", + "x-ms-examples": { + "Pipelines_CreateRun": { + "$ref": "./examples/Pipelines_CreateRun.json" + } + }, + "description": "Creates a run of a pipeline.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "referencePipelineRunId", + "description": "The pipeline run identifier. If run ID is specified the parameters of the the specified run will be used to create a new run.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "Parameters of the pipeline run. These parameters will be used only if the runId is not specified.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ParameterValueSpecification" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/CreateRunResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns": { + "post": { + "operationId": "PipelineRuns_QueryByFactory", + "x-ms-examples": { + "PipelineRuns_QueryByFactory": { + "$ref": "./examples/PipelineRuns_QueryByFactory.json" + } + }, + "description": "Query pipeline runs in the factory based on input filter conditions.", + "tags": [ + "pipelineruns" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "filterParameters", + "description": "Parameters to filter the pipeline run.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunFilterParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineRunsQueryResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}": { + "get": { + "operationId": "PipelineRuns_Get", + "x-ms-examples": { + "PipelineRuns_Get": { + "$ref": "./examples/PipelineRuns_Get.json" + } + }, + "description": "Get a pipeline run by its run ID.", + "tags": [ + "pipelineruns" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineRun" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns": { + "post": { + "operationId": "ActivityRuns_QueryByPipelineRun", + "x-ms-examples": { + "ActivityRuns_QueryByPipelineRun": { + "$ref": "./examples/ActivityRuns_QueryByPipelineRun.json" + } + }, + "description": "Query activity runs based on input filter conditions.", + "tags": [ + "activityruns" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "filterParameters", + "description": "Parameters to filter the activity runs.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunFilterParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ActivityRunsQueryResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/cancel": { + "post": { + "operationId": "PipelineRuns_Cancel", + "x-ms-examples": { + "PipelineRuns_Cancel": { + "$ref": "./examples/PipelineRuns_Cancel.json" + } + }, + "description": "Cancel a pipeline run by its run ID.", + "tags": [ + "pipelineruns" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Pipeline run has been canceled successfully. " + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers": { + "get": { + "tags": [ + "triggers" + ], + "operationId": "Triggers_ListByFactory", + "x-ms-examples": { + "Triggers_ListByFactory": { + "$ref": "./examples/Triggers_ListByFactory.json" + } + }, + "description": "Lists triggers.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}": { + "put": { + "tags": [ + "triggers" + ], + "operationId": "Triggers_CreateOrUpdate", + "x-ms-examples": { + "Triggers_Create": { + "$ref": "./examples/Triggers_Create.json" + }, + "Triggers_Update": { + "$ref": "./examples/Triggers_Update.json" + } + }, + "description": "Creates or updates a trigger.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "trigger", + "description": "Trigger resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "trigger" + ], + "operationId": "Triggers_Get", + "x-ms-examples": { + "Triggers_Get": { + "$ref": "./examples/Triggers_Get.json" + } + }, + "description": "Gets a trigger.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerResource" + } + }, + "304": { + "description": "Not modified." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "triggers" + ], + "operationId": "Triggers_Delete", + "x-ms-examples": { + "Triggers_Delete": { + "$ref": "./examples/Triggers_Delete.json" + } + }, + "description": "Deletes a trigger.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/start": { + "post": { + "tags": [ + "triggers" + ], + "operationId": "Triggers_Start", + "x-ms-examples": { + "Triggers_Start": { + "$ref": "./examples/Triggers_Start.json" + } + }, + "description": "Starts a trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Trigger has been started successfully." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/stop": { + "post": { + "tags": [ + "triggers" + ], + "operationId": "Triggers_Stop", + "x-ms-examples": { + "Triggers_Stop": { + "$ref": "./examples/Triggers_Stop.json" + } + }, + "description": "Stops a trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Trigger has been stopped successfully." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns": { + "post": { + "tags": [ + "triggerruns" + ], + "operationId": "TriggerRuns_QueryByFactory", + "x-ms-examples": { + "TriggerRuns_QueryByFactory": { + "$ref": "./examples/TriggerRuns_QueryByFactory.json" + } + }, + "description": "Query trigger runs.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "filterParameters", + "description": "Parameters to filter the pipeline run.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunFilterParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerRunsQueryResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "Resource": { + "x-ms-azure-resource": true, + "description": "Azure Data Factory top-level resource.", + "properties": { + "id": { + "type": "string", + "description": "The resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "The resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "eTag": { + "type": "string", + "description": "Etag identifies change in the resource.", + "readOnly": true + } + } + }, + "SubResource": { + "description": "Azure Data Factory nested resource, which belongs to a factory.", + "properties": { + "id": { + "type": "string", + "description": "The resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The resource type.", + "readOnly": true + }, + "etag": { + "type": "string", + "description": "Etag identifies change in the resource.", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "Expression": { + "description": "Azure Data Factory expression definition.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Expression type.", + "enum": [ + "Expression" + ] + }, + "value": { + "type": "string", + "description": "Expression value." + } + }, + "required": [ + "type", + "value" + ] + }, + "SecureString": { + "x-ms-discriminator-value": "SecureString", + "description": "Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretBase" + } + ], + "properties": { + "value": { + "type": "string", + "description": "Value of secure string." + } + }, + "required": [ + "value" + ] + }, + "AzureKeyVaultSecretReference": { + "x-ms-discriminator-value": "AzureKeyVaultSecret", + "description": "Azure Key Vault secret reference.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretBase" + } + ], + "properties": { + "store": { + "description": "The Azure Key Vault linked service reference.", + "$ref": "#/definitions/LinkedServiceReference" + }, + "secretName": { + "type": "object", + "description": "The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string)." + }, + "secretVersion": { + "type": "object", + "description": "The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "store", + "secretName" + ] + }, + "SecretBase": { + "description": "The base definition of a secret type.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the secret." + } + }, + "required": [ + "type" + ] + }, + "FactoryListResponse": { + "description": "A list of factory resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of factories.", + "items": { + "$ref": "#/definitions/Factory" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "IntegrationRuntimeListResponse": { + "description": "A list of integration runtime resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of integration runtimes.", + "items": { + "$ref": "#/definitions/IntegrationRuntimeResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "IntegrationRuntimeReference": { + "description": "Integration runtime reference type.", + "properties": { + "type": { + "type": "string", + "description": "Type of integration runtime.", + "enum": [ + "IntegrationRuntimeReference" + ] + }, + "referenceName": { + "type": "string", + "description": "Reference integration runtime name." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueSpecification", + "description": "Arguments for integration runtime." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "IntegrationRuntimeResource": { + "description": "Integration runtime resource type.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntime", + "description": "Integration runtime properties." + } + }, + "required": [ + "properties" + ] + }, + "IntegrationRuntimeStatusResponse": { + "description": "Integration runtime status response.", + "properties": { + "name": { + "type": "string", + "description": "The integration runtime name.", + "readOnly": true + }, + "properties": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeStatus", + "description": "Integration runtime properties." + } + }, + "required": [ + "properties" + ] + }, + "IntegrationRuntimeStatusListResponse": { + "description": "A list of integration runtime status.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of integration runtime status.", + "items": { + "$ref": "#/definitions/IntegrationRuntimeStatusResponse" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "UpdateIntegrationRuntimeRequest": { + "description": "Update integration runtime request.", + "type": "object", + "properties": { + "autoUpdate": { + "description": "Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189.", + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeAutoUpdate" + }, + "updateDelayOffset": { + "description": "The time offset (in hours) in the day, e.g., PT03H is 3 hours. The integration runtime auto update will happen on that time.", + "type": "string" + } + } + }, + "UpdateIntegrationRuntimeNodeRequest": { + "description": "Update integration runtime node request.", + "type": "object", + "properties": { + "concurrentJobsLimit": { + "description": "The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed.", + "type": "integer", + "minimum": 1 + } + } + }, + "LinkedIntegrationRuntimeRequest": { + "description": "Data factory name for linked integration runtime request.", + "type": "object", + "properties": { + "factoryName": { + "description": "The data factory name for linked integration runtime.", + "type": "string", + "x-ms-client-name": "linkedFactoryName" + } + }, + "required": [ + "factoryName" + ] + }, + "LinkedServiceListResponse": { + "description": "A list of linked service resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of linked services.", + "items": { + "$ref": "#/definitions/LinkedServiceResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "DatasetListResponse": { + "description": "A list of dataset resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of datasets.", + "items": { + "$ref": "#/definitions/DatasetResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "PipelineListResponse": { + "description": "A list of pipeline resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of pipelines.", + "items": { + "$ref": "#/definitions/PipelineResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "TriggerListResponse": { + "description": "A list of trigger resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of triggers.", + "items": { + "$ref": "#/definitions/TriggerResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "CreateRunResponse": { + "description": "Response body with a run identifier.", + "type": "object", + "properties": { + "runId": { + "description": "Identifier of a run.", + "type": "string" + } + }, + "required": [ + "runId" + ] + }, + "CloudError": { + "x-ms-external": true, + "description": "The object that defines the structure of an Azure Data Factory error response.", + "type": "object", + "properties": { + "error": { + "x-ms-client-flatten": true, + "description": "Error data", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "required": [ + "error" + ] + }, + "CloudErrorBody": { + "x-ms-external": true, + "description": "The object that defines the structure of an Azure Data Factory error.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "target": { + "description": "Property name/path in request associated with error.", + "type": "string" + }, + "details": { + "description": "Array with additional error details.", + "type": "array", + "items": { + "$ref": "#/definitions/CloudError" + } + } + }, + "required": [ + "code", + "message" + ] + }, + "ParameterDefinitionSpecification": { + "description": "Definition of all parameters for an entity.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ParameterSpecification" + } + }, + "ParameterSpecification": { + "description": "Definition of a single parameter for an entity.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Parameter type.", + "enum": [ + "Object", + "String", + "Int", + "Float", + "Bool", + "Array", + "SecureString" + ], + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": true + } + }, + "defaultValue": { + "type": "object", + "description": "Default value of parameter." + } + }, + "required": [ + "type" + ] + }, + "ParameterValueSpecification": { + "description": "An object mapping parameter names to argument values.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "FactoryRepoConfiguration": { + "description": "Factory's git repo information.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Type of repo configuration." + }, + "accountName": { + "description": "Account name.", + "type": "string" + }, + "repositoryName": { + "description": "Rrepository name.", + "type": "string" + }, + "collaborationBranch": { + "description": "Collaboration branch.", + "type": "string" + }, + "rootFolder": { + "description": "Root folder.", + "type": "string" + }, + "lastCommitId": { + "description": "Last commit id.", + "type": "string" + } + }, + "required": [ + "type", + "accountName", + "repositoryName", + "collaborationBranch", + "rootFolder" + ] + }, + "FactoryVSTSConfiguration": { + "x-ms-discriminator-value": "FactoryVSTSConfiguration", + "description": "Factory's VSTS repo information.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FactoryRepoConfiguration" + } + ], + "properties": { + "projectName": { + "description": "VSTS project name.", + "type": "string" + }, + "tenantId": { + "description": "VSTS tenant id.", + "type": "string" + } + }, + "required": [ + "projectName" + ] + }, + "FactoryGitHubConfiguration": { + "x-ms-discriminator-value": "FactoryGithubConfiguration", + "description": "Factory's GitHub repo information.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FactoryRepoConfiguration" + } + ], + "properties": { + "hostName": { + "description": "GitHub repo host name.", + "readOnly": true, + "type": "string" + } + } + }, + "FactoryRepoUpdate": { + "description": "Factory's git repo information.", + "properties": { + "factoryResourceId": { + "description": "The factory resource id.", + "type": "string" + }, + "repoConfiguration": { + "$ref": "#/definitions/FactoryRepoConfiguration", + "description": "Git repo information of the factory." + } + } + }, + "FactoryProperties": { + "description": "Factory resource properties.", + "properties": { + "provisioningState": { + "description": "Factory provisioning state, example Succeeded.", + "type": "string", + "readOnly": true + }, + "createTime": { + "description": "Time the factory was created in ISO8601 format.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "version": { + "description": "Version of the factory.", + "type": "string", + "readOnly": true + }, + "repoConfiguration": { + "$ref": "#/definitions/FactoryRepoConfiguration", + "description": "Git repo information of the factory." + } + } + }, + "PipelineResource": { + "description": "Pipeline resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "./entityTypes/Pipeline.json#/definitions/Pipeline", + "description": "Properties of the pipeline." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "properties" + ] + }, + "PipelineReference": { + "description": "Pipeline reference type.", + "properties": { + "type": { + "type": "string", + "description": "Pipeline reference type.", + "enum": [ + "PipelineReference" + ] + }, + "referenceName": { + "type": "string", + "description": "Reference pipeline name." + }, + "name": { + "type": "string", + "description": "Reference name." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "TriggerPipelineReference": { + "description": "Pipeline that needs to be triggered with the given parameters.", + "properties": { + "pipelineReference": { + "description": "Pipeline reference.", + "$ref": "#/definitions/PipelineReference" + }, + "parameters": { + "description": "Pipeline parameters.", + "$ref": "#/definitions/ParameterValueSpecification" + } + } + }, + "TriggerResource": { + "description": "Trigger resource type.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/Trigger.json#/definitions/Trigger", + "description": "Properties of the trigger." + } + }, + "required": [ + "properties" + ] + }, + "Factory": { + "description": "Factory resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/FactoryIdentity", + "description": "Managed service identity of the factory." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FactoryProperties", + "description": "Properties of the factory." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "FactoryUpdateParameters": { + "description": "Parameters for updating a factory resource.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "identity": { + "$ref": "#/definitions/FactoryIdentity", + "description": "Managed service identity of the factory." + } + } + }, + "FactoryIdentity": { + "description": "Identity properties of the factory resource.", + "properties": { + "type": { + "type": "string", + "description": "The identity type. Currently the only supported type is 'SystemAssigned'.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "FactoryIdentityType", + "modelAsString": false + } + }, + "principalId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "The principal id of the identity." + }, + "tenantId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "The client tenant id of the identity." + } + }, + "required": [ + "type" + ] + }, + "DatasetReference": { + "description": "Dataset reference type.", + "properties": { + "type": { + "type": "string", + "description": "Dataset reference type.", + "enum": [ + "DatasetReference" + ] + }, + "referenceName": { + "type": "string", + "description": "Reference dataset name." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueSpecification", + "description": "Arguments for dataset." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "DatasetResource": { + "description": "Dataset resource type.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/Dataset.json#/definitions/Dataset", + "description": "Dataset properties." + } + }, + "required": [ + "properties" + ] + }, + "LinkedServiceReference": { + "description": "Linked service reference type.", + "properties": { + "type": { + "type": "string", + "description": "Linked service reference type.", + "enum": [ + "LinkedServiceReference" + ] + }, + "referenceName": { + "type": "string", + "description": "Reference LinkedService name." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueSpecification", + "description": "Arguments for LinkedService." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "LinkedServiceResource": { + "description": "Linked service resource type.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/LinkedService.json#/definitions/LinkedService", + "description": "Properties of linked service." + } + }, + "required": [ + "properties" + ] + }, + "RunFilterParameters": { + "description": "Query parameters for listing runs.", + "type": "object", + "properties": { + "continuationToken": { + "description": "The continuation token for getting the next page of results. Null for first page.", + "type": "string" + }, + "lastUpdatedAfter": { + "description": "The time at or after which the run event was updated in 'ISO 8601' format.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedBefore": { + "description": "The time at or before which the run event was updated in 'ISO 8601' format.", + "type": "string", + "format": "date-time" + }, + "filters": { + "type": "array", + "description": "List of filters.", + "items": { + "$ref": "#/definitions/RunQueryFilter" + } + }, + "orderBy": { + "type": "array", + "description": "List of OrderBy option.", + "items": { + "$ref": "#/definitions/RunQueryOrderBy" + } + } + }, + "required": [ + "lastUpdatedAfter", + "lastUpdatedBefore" + ] + }, + "RunQueryFilter": { + "description": "Query filter option for listing runs.", + "type": "object", + "properties": { + "operand": { + "description": "Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status.", + "type": "string", + "enum": [ + "PipelineName", + "Status", + "RunStart", + "RunEnd", + "ActivityName", + "ActivityRunStart", + "ActivityRunEnd", + "ActivityType", + "TriggerName", + "TriggerRunTimestamp" + ], + "x-ms-enum": { + "name": "RunQueryFilterOperand", + "modelAsString": true + } + }, + "operator": { + "description": "Operator to be used for filter.", + "type": "string", + "enum": [ + "Equals", + "NotEquals", + "In", + "NotIn" + ], + "x-ms-enum": { + "name": "RunQueryFilterOperator", + "modelAsString": true + } + }, + "values": { + "type": "array", + "description": "List of filter values.", + "items": { + "type": "string" + } + } + }, + "required": [ + "operand", + "operator", + "values" + ] + }, + "RunQueryOrderBy": { + "description": "An object to provide order by options for listing runs.", + "type": "object", + "properties": { + "orderBy": { + "description": "Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status.", + "type": "string", + "enum": [ + "RunStart", + "RunEnd", + "PipelineName", + "Status", + "ActivityName", + "ActivityRunStart", + "ActivityRunEnd", + "TriggerName", + "TriggerRunTimestamp" + ], + "x-ms-enum": { + "name": "RunQueryOrderByField", + "modelAsString": true + } + }, + "order": { + "description": "Sorting order of the parameter.", + "type": "string", + "enum": [ + "ASC", + "DESC" + ], + "x-ms-enum": { + "name": "RunQueryOrder", + "modelAsString": true + } + } + }, + "required": [ + "orderBy", + "order" + ] + }, + "PipelineRunsQueryResponse": { + "description": "A list pipeline runs.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of pipeline runs.", + "items": { + "$ref": "#/definitions/PipelineRun" + } + }, + "continuationToken": { + "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise.", + "type": "string" + } + } + }, + "PipelineRun": { + "description": "Information about a pipeline run.", + "type": "object", + "properties": { + "runId": { + "description": "Identifier of a run.", + "type": "string", + "readOnly": true + }, + "pipelineName": { + "description": "The pipeline name.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "The full or partial list of parameter name, value pair used in the pipeline run.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "invokedBy": { + "description": "Entity that started the pipeline run.", + "$ref": "#/definitions/PipelineRunInvokedBy", + "readOnly": true + }, + "lastUpdated": { + "description": "The last updated timestamp for the pipeline run event in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "runStart": { + "description": "The start time of a pipeline run in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "runEnd": { + "description": "The end time of a pipeline run in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "durationInMs": { + "description": "The duration of a pipeline run.", + "type": "integer", + "readOnly": true + }, + "status": { + "description": "The status of a pipeline run.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message from a pipeline run.", + "type": "string", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "PipelineRunInvokedBy": { + "description": "Provides entity name and id that started the pipeline run.", + "type": "object", + "properties": { + "name": { + "description": "Name of the entity that started the pipeline run.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The ID of the entity that started the run.", + "type": "string", + "readOnly": true + }, + "invokedByType": { + "description": "The type of the entity that started the run.", + "type": "string", + "readOnly": true + } + } + }, + "ActivityRunsQueryResponse": { + "description": "A list activity runs.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of activity runs.", + "items": { + "$ref": "#/definitions/ActivityRun" + } + }, + "continuationToken": { + "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise.", + "type": "string" + } + } + }, + "ActivityRun": { + "description": "Information about an activity run in a pipeline.", + "type": "object", + "properties": { + "pipelineName": { + "description": "The name of the pipeline.", + "type": "string", + "readOnly": true + }, + "pipelineRunId": { + "description": "The id of the pipeline run.", + "type": "string", + "readOnly": true + }, + "activityName": { + "description": "The name of the activity.", + "type": "string", + "readOnly": true + }, + "activityType": { + "description": "The type of the activity.", + "type": "string", + "readOnly": true + }, + "activityRunId": { + "description": "The id of the activity run.", + "type": "string", + "readOnly": true + }, + "linkedServiceName": { + "description": "The name of the compute linked service.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the activity run.", + "type": "string", + "readOnly": true + }, + "activityRunStart": { + "description": "The start time of the activity run in 'ISO 8601' format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "activityRunEnd": { + "description": "The end time of the activity run in 'ISO 8601' format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "durationInMs": { + "description": "The duration of the activity run.", + "type": "integer", + "readOnly": true + }, + "input": { + "description": "The input for the activity.", + "type": "object", + "readOnly": true + }, + "output": { + "description": "The output for the activity.", + "type": "object", + "readOnly": true + }, + "error": { + "description": "The error if any from the activity run.", + "type": "object", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "TriggerRunsQueryResponse": { + "description": "A list of trigger runs.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of trigger runs.", + "items": { + "$ref": "#/definitions/TriggerRun" + } + }, + "continuationToken": { + "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise.", + "type": "string" + } + } + }, + "TriggerRun": { + "description": "Trigger runs.", + "type": "object", + "properties": { + "triggerRunId": { + "type": "string", + "description": "Trigger run id.", + "readOnly": true + }, + "triggerName": { + "type": "string", + "description": "Trigger name.", + "readOnly": true + }, + "triggerType": { + "type": "string", + "description": "Trigger type.", + "readOnly": true + }, + "triggerRunTimestamp": { + "type": "string", + "format": "date-time", + "description": "Trigger run start time.", + "readOnly": true + }, + "status": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Inprogress" + ], + "x-ms-enum": { + "name": "TriggerRunStatus", + "modelAsString": true + }, + "description": "Trigger run status.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Trigger error message.", + "readOnly": true + }, + "properties": { + "description": "List of property name and value related to trigger run. Name, value pair depends on type of trigger.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "triggeredPipelines": { + "description": "List of pipeline name and run Id triggered by the trigger run.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "OperationListResponse": { + "description": "A list of operations that can be performed by the Data Factory service.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Data Factory operations supported by the Data Factory resource provider." + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of results, if any remaining results exist." + } + } + }, + "Operation": { + "description": "Azure Data Factory API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "origin": { + "description": "The intended executor of the operation.", + "type": "string" + }, + "display": { + "description": "Metadata associated with the operation.", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string" + }, + "provider": { + "description": "The name of the provider.", + "type": "string" + }, + "resource": { + "description": "The name of the resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The type of operation: get, read, delete, etc.", + "type": "string" + } + } + }, + "properties": { + "description": "Additional details about the operation.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Additional details about an operation.", + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "serviceSpecification": { + "description": "Details about a service operation.", + "$ref": "#/definitions/OperationServiceSpecification" + } + } + }, + "OperationServiceSpecification": { + "description": "Details about a service operation.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Details about operations related to logs.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationLogSpecification" + } + }, + "metricSpecifications": { + "description": "Details about operations related to metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetricSpecification" + } + } + } + }, + "OperationLogSpecification": { + "description": "Details about an operation related to logs.", + "type": "object", + "properties": { + "name": { + "description": "The name of the log category.", + "type": "string" + }, + "displayName": { + "description": "Localized display name.", + "type": "string" + }, + "blobDuration": { + "description": "Blobs created in the customer storage account, per hour.", + "type": "string" + } + } + }, + "OperationMetricSpecification": { + "description": "Details about an operation related to metrics.", + "type": "object", + "properties": { + "name": { + "description": "The name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "The description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that the metric is measured in.", + "type": "string" + }, + "aggregationType": { + "description": "The type of metric aggregation.", + "type": "string" + }, + "enableRegionalMdmAccount": { + "description": "Whether or not the service is using regional MDM accounts.", + "type": "string" + }, + "sourceMdmAccount": { + "description": "The name of the MDM account.", + "type": "string" + }, + "sourceMdmNamespace": { + "description": "The name of the MDM namespace.", + "type": "string" + }, + "availabilities": { + "description": "Defines how often data for metrics becomes available.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetricAvailability" + } + }, + "dimensions": { + "description": "Defines the metric dimension.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetricDimension" + } + } + } + }, + "OperationMetricAvailability": { + "description": "Defines how often data for a metric becomes available.", + "type": "object", + "properties": { + "timeGrain": { + "description": "The granularity for the metric.", + "type": "string" + }, + "blobDuration": { + "description": "Blob created in the customer storage account, per hour.", + "type": "string" + } + } + }, + "OperationMetricDimension": { + "description": "Defines the metric dimension.", + "type": "object", + "properties": { + "name": { + "description": "The name of the dimension for the metric.", + "type": "string" + }, + "displayName": { + "description": "The display name of the metric dimension.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "Whether the dimension should be exported to Azure Monitor.", + "type": "boolean" + } + } + } + }, + "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" + }, + "factoryName": { + "name": "factoryName", + "description": "The factory name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method" + }, + "locationId": { + "name": "locationId", + "description": "The location identifier.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "linkedServiceName": { + "name": "linkedServiceName", + "description": "The linked service name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "datasetName": { + "name": "datasetName", + "description": "The dataset name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "pipelineName": { + "name": "pipelineName", + "description": "The pipeline name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "triggerName": { + "name": "triggerName", + "description": "The trigger name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "runId": { + "name": "runId", + "description": "The pipeline run identifier.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "integrationRuntimeName": { + "name": "integrationRuntimeName", + "description": "The integration runtime name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method" + }, + "nodeName": { + "name": "nodeName", + "description": "The integration runtime node name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z0-9A-Z][a-z0-9A-Z_-]{0,149}$", + "minLength": 1, + "maxLength": 150, + "x-ms-parameter-location": "method" + }, + "api-version": { + "name": "api-version", + "description": "The API version.", + "in": "query", + "required": true, + "type": "string" + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json new file mode 100644 index 000000000000..331467ae7d5c --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -0,0 +1,1444 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2017-09-01-preview" + }, + "paths": {}, + "definitions": { + "Dataset": { + "description": "The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Type of dataset." + }, + "description": { + "description": "Dataset description.", + "type": "string" + }, + "structure": { + "type": "object", + "description": "Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement." + }, + "linkedServiceName": { + "description": "Linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "parameters": { + "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification", + "description": "Parameters for dataset." + }, + "annotations": { + "description": "List of tags that can be used for describing the Dataset.", + "type": "array", + "items": { + "type": "object" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type", + "linkedServiceName" + ] + }, + "DatasetDataElement": { + "description": "Columns that define the structure of the dataset.", + "type": "object", + "properties": { + "name": { + "type": "object", + "description": "Name of the column. Type: string (or Expression with resultType string)." + }, + "type": { + "type": "object", + "description": "Type of the column. Type: string (or Expression with resultType string)." + } + } + }, + "DatasetStorageFormat": { + "discriminator": "type", + "description": "The format definition of a storage.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of dataset storage format." + }, + "serializer": { + "type": "object", + "description": "Serializer. Type: string (or Expression with resultType string)." + }, + "deserializer": { + "type": "object", + "description": "Deserializer. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "TextFormat": { + "description": "The data stored in text format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ], + "properties": { + "columnDelimiter": { + "type": "object", + "description": "The column delimiter. Type: string (or Expression with resultType string)." + }, + "rowDelimiter": { + "type": "object", + "description": "The row delimiter. Type: string (or Expression with resultType string)." + }, + "escapeChar": { + "type": "object", + "description": "The escape character. Type: string (or Expression with resultType string)." + }, + "quoteChar": { + "type": "object", + "description": "The quote character. Type: string (or Expression with resultType string)." + }, + "nullValue": { + "type": "object", + "description": "The null value string. Type: string (or Expression with resultType string)." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." + }, + "treatEmptyAsNull": { + "type": "object", + "description": "Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "skipLineCount": { + "type": "object", + "description": "The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer)." + }, + "firstRowAsHeader": { + "type": "object", + "description": "When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "JsonFormat": { + "description": "The data stored in JSON format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ], + "properties": { + "filePattern": { + "description": "File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive.", + "$ref": "#/definitions/JsonFormatFilePattern" + }, + "nestingSeparator": { + "type": "object", + "description": "The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string)." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string)." + }, + "jsonNodeReference": { + "type": "object", + "description": "The JSONPath of the JSON array element to be flattened. Example: \"$.ArrayPath\". Type: string (or Expression with resultType string)." + }, + "jsonPathDefinition": { + "type": "object", + "description": "The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with \"$\"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {\"Column1\": \"$.Column1Path\", \"Column2\": \"Column2PathInArray\"}. Type: object (or Expression with resultType object)." + } + } + }, + "JsonFormatFilePattern": { + "description": "JSON format file pattern. A property of JsonFormat.", + "type": "string", + "enum": [ + "setOfObjects", + "arrayOfObjects" + ], + "x-ms-enum": { + "name": "JsonFormatFilePattern", + "modelAsString": true + } + }, + "AvroFormat": { + "description": "The data stored in Avro format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ] + }, + "OrcFormat": { + "description": "The data stored in Optimized Row Columnar (ORC) format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ] + }, + "ParquetFormat": { + "description": "The data stored in Parquet format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ] + }, + "DatasetCompression": { + "discriminator": "type", + "description": "The compression method used on a dataset.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of dataset compression." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "DatasetBZip2Compression": { + "x-ms-discriminator-value": "BZip2", + "description": "The BZip2 compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": {} + }, + "DatasetGZipCompression": { + "x-ms-discriminator-value": "GZip", + "description": "The GZip compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": { + "level": { + "description": "The GZip compression level.", + "$ref": "#/definitions/CompressionLevel" + } + } + }, + "DatasetDeflateCompression": { + "x-ms-discriminator-value": "Deflate", + "description": "The Deflate compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": { + "level": { + "description": "The Deflate compression level.", + "$ref": "#/definitions/CompressionLevel" + } + } + }, + "DatasetZipDeflateCompression": { + "x-ms-discriminator-value": "ZipDeflate", + "description": "The ZipDeflate compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": { + "level": { + "description": "The ZipDeflate compression level.", + "$ref": "#/definitions/CompressionLevel" + } + } + }, + "CompressionLevel": { + "title": "Microsoft.Azure.Management.DataFactories.Models.CompressionLevel", + "description": "All available compression levels.", + "type": "string", + "enum": [ + "Optimal", + "Fastest" + ], + "x-ms-enum": { + "name": "DatasetCompressionLevel", + "modelAsString": true + } + }, + "AmazonS3Dataset": { + "x-ms-discriminator-value": "AmazonS3Object", + "description": "A single Amazon Simple Storage Service (S3) object or a set of S3 objects.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon S3 dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonS3DatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AmazonS3DatasetTypeProperties": { + "description": "Amazon S3 dataset properties.", + "properties": { + "bucketName": { + "type": "object", + "description": "The name of the Amazon S3 bucket. Type: string (or Expression with resultType string)." + }, + "key": { + "type": "object", + "description": "The key of the Amazon S3 object. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." + }, + "version": { + "type": "object", + "description": "The version for the S3 object. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of files.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used for the Amazon S3 object.", + "$ref": "#/definitions/DatasetCompression" + } + }, + "required": [ + "bucketName" + ] + }, + "AzureBlobDataset": { + "x-ms-discriminator-value": "AzureBlob", + "description": "The Azure Blob storage.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Blob dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBlobDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureBlobDatasetTypeProperties": { + "description": "Azure Blob dataset properties.", + "properties": { + "folderPath": { + "type": "object", + "description": "The path of the Azure Blob storage. Type: string (or Expression with resultType string)." + }, + "tableRootLocation": { + "type": "object", + "description": "The root of blob path. Type: string (or Expression with resultType string)." + }, + "fileName": { + "type": "object", + "description": "The name of the Azure Blob. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of the Azure Blob storage.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used for the blob storage.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "AzureTableDataset": { + "x-ms-discriminator-value": "AzureTable", + "description": "The Azure Table storage dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureTableDatasetTypeProperties": { + "description": "Azure Table dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the Azure Table storage. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "AzureSqlTableDataset": { + "x-ms-discriminator-value": "AzureSqlTable", + "description": "The Azure SQL Server database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSqlTableDatasetTypeProperties": { + "description": "Azure SQL dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the Azure SQL database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "AzureSqlDWTableDataset": { + "x-ms-discriminator-value": "AzureSqlDWTable", + "description": "The Azure SQL Data Warehouse dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL Data Warehouse dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlDWTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSqlDWTableDatasetTypeProperties": { + "description": "Azure SQL Data Warehouse dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "CassandraTableDataset": { + "x-ms-discriminator-value": "CassandraTable", + "description": "The Cassandra database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Cassandra dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CassandraTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CassandraTableDatasetTypeProperties": { + "description": "Cassandra dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the Cassandra database. Type: string (or Expression with resultType string)." + }, + "keyspace": { + "type": "object", + "description": "The keyspace of the Cassandra database. Type: string (or Expression with resultType string)." + } + } + }, + "CustomDataset": { + "description": "The custom dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Custom dataset properties.", + "x-ms-client-flatten": true, + "type": "object" + } + }, + "required": [ + "typeProperties" + ] + }, + "DocumentDbCollectionDataset": { + "x-ms-discriminator-value": "DocumentDbCollection", + "description": "Microsoft Azure Document Database Collection dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "DocumentDB Collection dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DocumentDbCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DocumentDbCollectionDatasetTypeProperties": { + "description": "DocumentDB Collection dataset properties.", + "properties": { + "collectionName": { + "type": "object", + "description": "Document Database collection name. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collectionName" + ] + }, + "DynamicsEntityDataset": { + "x-ms-discriminator-value": "DynamicsEntity", + "description": "The Dynamics entity dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics entity dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsEntityDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DynamicsEntityDatasetTypeProperties": { + "description": "Dynamics entity dataset properties.", + "properties": { + "entityName": { + "type": "object", + "description": "The logical name of the entity. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreDataset": { + "x-ms-discriminator-value": "AzureDataLakeStoreFile", + "description": "Azure Data Lake Store dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Lake Store dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataLakeStoreDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataLakeStoreDatasetTypeProperties": { + "description": "Azure Data Lake Store dataset properties.", + "properties": { + "folderPath": { + "type": "object", + "description": "Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string)." + }, + "fileName": { + "type": "object", + "description": "The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of the Data Lake Store.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used for the item(s) in the Azure Data Lake Store.", + "$ref": "#/definitions/DatasetCompression" + } + }, + "required": [ + "folderPath" + ] + }, + "FileShareDataset": { + "x-ms-discriminator-value": "FileShare", + "description": "An on-premises file system dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "On-premises file system dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FileShareDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "FileShareDatasetTypeProperties": { + "description": "On-premises file system dataset properties.", + "properties": { + "folderPath": { + "type": "object", + "description": "The path of the on-premises file system. Type: string (or Expression with resultType string)." + }, + "fileName": { + "type": "object", + "description": "The name of the on-premises file system. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of the files.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "fileFilter": { + "type": "object", + "description": "Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string)." + }, + "compression": { + "description": "The data compression method used for the file system.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "MongoDbCollectionDataset": { + "x-ms-discriminator-value": "MongoDbCollection", + "description": "The MongoDB database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbCollectionDatasetTypeProperties": { + "description": "MongoDB database dataset properties.", + "properties": { + "collectionName": { + "type": "object", + "description": "The table name of the MongoDB database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collectionName" + ] + }, + "ODataResourceDataset": { + "x-ms-discriminator-value": "ODataResource", + "description": "The Open Data Protocol (OData) resource dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "OData dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ODataResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ODataResourceDatasetTypeProperties": { + "description": "OData dataset properties.", + "properties": { + "path": { + "type": "object", + "description": "The OData resource path. Type: string (or Expression with resultType string)." + } + } + }, + "OracleTableDataset": { + "x-ms-discriminator-value": "OracleTable", + "description": "The on-premises Oracle database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "On-premises Oracle dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OracleTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "OracleTableDatasetTypeProperties": { + "description": "On-premises Oracle dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the on-premises Oracle database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "AzureMySqlTableDataset": { + "x-ms-discriminator-value": "AzureMySqlTable", + "description": "The Azure MySQL database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure MySQL database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureMySqlTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMySqlTableDatasetTypeProperties": { + "description": "Azure MySQL database dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The Azure MySQL database table name. Type: string (or Expression with resultType string)." + } + } + }, + "RelationalTableDataset": { + "x-ms-discriminator-value": "RelationalTable", + "description": "The relational table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Relational table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RelationalTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "RelationalTableDatasetTypeProperties": { + "description": "Relational table dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The relational table name. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceObjectDataset": { + "x-ms-discriminator-value": "SalesforceObject", + "description": "The Salesforce object dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce object dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceObjectDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SalesforceObjectDatasetTypeProperties": { + "description": "Salesforce object dataset properties.", + "properties": { + "objectApiName": { + "type": "object", + "description": "The Salesforce object API name. Type: string (or Expression with resultType string)." + } + } + }, + "SapCloudForCustomerResourceDataset": { + "x-ms-discriminator-value": "SapCloudForCustomerResource", + "description": "The path of the SAP Cloud for Customer OData entity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "SAP Cloud For Customer OData resource dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapCloudForCustomerResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapCloudForCustomerResourceDatasetTypeProperties": { + "description": "Sap Cloud For Customer OData resource dataset properties.", + "properties": { + "path": { + "type": "object", + "description": "The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "path" + ] + }, + "SapEccResourceDataset": { + "x-ms-discriminator-value": "SapEccResource", + "description": "The path of the SAP ECC OData entity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "SAP ECC OData resource dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapEccResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapEccResourceDatasetTypeProperties": { + "description": "Sap ECC OData resource dataset properties.", + "properties": { + "path": { + "type": "string", + "description": "The path of the SAP ECC OData entity. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "path" + ] + }, + "SqlServerTableDataset": { + "x-ms-discriminator-value": "SqlServerTable", + "description": "The on-premises SQL Server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "On-premises SQL Server dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SqlServerTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SqlServerTableDatasetTypeProperties": { + "description": "On-premises SQL Server dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the SQL Server dataset. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "WebTableDataset": { + "x-ms-discriminator-value": "WebTable", + "description": "The dataset points to a HTML table in the web page.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Web table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebTableDatasetTypeProperties": { + "description": "Web table dataset properties.", + "properties": { + "index": { + "type": "object", + "description": "The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "path": { + "type": "object", + "description": "The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "index" + ] + }, + "AzureSearchIndexDataset": { + "x-ms-discriminator-value": "AzureSearchIndex", + "description": "The Azure Search Index.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSearchIndexDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSearchIndexDatasetTypeProperties": { + "description": "Properties specific to this dataset type.", + "properties": { + "indexName": { + "type": "object", + "description": "The name of the Azure Search Index. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "indexName" + ] + }, + "HttpDataset": { + "x-ms-discriminator-value": "HttpFile", + "description": "A file in an HTTP web server.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HttpDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HttpDatasetTypeProperties": { + "description": "Properties specific to this dataset type.", + "properties": { + "relativeUrl": { + "type": "object", + "description": "The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string)." + }, + "requestMethod": { + "type": "object", + "description": "The HTTP method for the HTTP request. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The body for the HTTP request. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1\r\n...\r\nrequest-header-name-n:request-header-value-n Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of files.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used on files.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "AmazonMWSObjectDataset" : { + "x-ms-discriminator-value": "AmazonMWSObject", + "description": "Amazon Marketplace Web Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "AzurePostgreSqlTableDataset" : { + "x-ms-discriminator-value": "AzurePostgreSqlTable", + "description": "Azure PostgreSQL dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ConcurObjectDataset" : { + "x-ms-discriminator-value": "ConcurObject", + "description": "Concur Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "CouchbaseTableDataset" : { + "x-ms-discriminator-value": "CouchbaseTable", + "description": "Couchbase server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "DrillTableDataset" : { + "x-ms-discriminator-value": "DrillTable", + "description": "Drill server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "EloquaObjectDataset" : { + "x-ms-discriminator-value": "EloquaObject", + "description": "Eloqua server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "GoogleBigQueryObjectDataset" : { + "x-ms-discriminator-value": "GoogleBigQueryObject", + "description": "Google BigQuery service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "GreenplumTableDataset" : { + "x-ms-discriminator-value": "GreenplumTable", + "description": "Greenplum Database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "HBaseObjectDataset" : { + "x-ms-discriminator-value": "HBaseObject", + "description": "HBase server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "HiveObjectDataset" : { + "x-ms-discriminator-value": "HiveObject", + "description": "Hive Server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "HubspotObjectDataset" : { + "x-ms-discriminator-value": "HubspotObject", + "description": "Hubspot Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ImpalaObjectDataset" : { + "x-ms-discriminator-value": "ImpalaObject", + "description": "Impala server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "JiraObjectDataset" : { + "x-ms-discriminator-value": "JiraObject", + "description": "Jira Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "MagentoObjectDataset" : { + "x-ms-discriminator-value": "MagentoObject", + "description": "Magento server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "MariaDBTableDataset" : { + "x-ms-discriminator-value": "MariaDBTable", + "description": "MariaDB server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "MarketoObjectDataset" : { + "x-ms-discriminator-value": "MarketoObject", + "description": "Marketo server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "PaypalObjectDataset" : { + "x-ms-discriminator-value": "PaypalObject", + "description": "Paypal Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "PhoenixObjectDataset" : { + "x-ms-discriminator-value": "PhoenixObject", + "description": "Phoenix server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "PrestoObjectDataset" : { + "x-ms-discriminator-value": "PrestoObject", + "description": "Presto server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "QuickBooksObjectDataset" : { + "x-ms-discriminator-value": "QuickBooksObject", + "description": "QuickBooks server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ServiceNowObjectDataset" : { + "x-ms-discriminator-value": "ServiceNowObject", + "description": "ServiceNow server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ShopifyObjectDataset" : { + "x-ms-discriminator-value": "ShopifyObject", + "description": "Shopify Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "SparkObjectDataset" : { + "x-ms-discriminator-value": "SparkObject", + "description": "Spark Server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "SquareObjectDataset" : { + "x-ms-discriminator-value": "SquareObject", + "description": "Square Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "XeroObjectDataset" : { + "x-ms-discriminator-value": "XeroObject", + "description": "Xero Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ZohoObjectDataset" : { + "x-ms-discriminator-value": "ZohoObject", + "description": "Zoho server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "NetezzaTableDataset" : { + "x-ms-discriminator-value": "NetezzaTable", + "description": "Netezza dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "VerticaTableDataset" : { + "x-ms-discriminator-value": "VerticaTable", + "description": "Vertica dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "SalesforceMarketingCloudObjectDataset": { + "x-ms-discriminator-value": "SalesforceMarketingCloudObject", + "description": "Salesforce Marketing Cloud dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ResponsysObjectDataset": { + "x-ms-discriminator-value": "ResponsysObject", + "description": "Responsys dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json new file mode 100644 index 000000000000..42ee80c8959d --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json @@ -0,0 +1,954 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2017-09-01-preview" + }, + "paths": {}, + "definitions": { + "IntegrationRuntime": { + "description": "Azure Data Factory nested object which serves as a compute resource for activities.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "Type of integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeType" + }, + "description": { + "description": "Integration runtime description.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "IntegrationRuntimeType": { + "description": "The type of integration runtime.", + "type": "string", + "enum": [ + "Managed", + "SelfHosted" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeType", + "modelAsString": true + } + }, + "ManagedIntegrationRuntime": { + "x-ms-discriminator-value": "Managed", + "description": "Managed integration runtime, including managed elastic and managed dedicated integration runtimes.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IntegrationRuntime" + } + ], + "properties": { + "state": { + "description": "Integration runtime state, only valid for managed dedicated integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeState", + "readOnly": true + }, + "typeProperties": { + "description": "Managed integration runtime properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedIntegrationRuntimeTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ManagedIntegrationRuntimeTypeProperties": { + "description": "Managed integration runtime type properties.", + "type": "object", + "properties": { + "computeProperties": { + "description": "The compute resource for managed integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeComputeProperties" + }, + "ssisProperties": { + "description": "SSIS properties for managed integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeSsisProperties" + } + } + }, + "IntegrationRuntimeComputeProperties": { + "description": "The compute resource properties for managed integration runtime.", + "type": "object", + "properties": { + "location": { + "description": "The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities", + "type": "string" + }, + "nodeSize": { + "description": "The node size requirement to managed integration runtime.", + "type": "string" + }, + "numberOfNodes": { + "description": "The required number of nodes for managed integration runtime.", + "type": "integer", + "minimum": 1 + }, + "maxParallelExecutionsPerNode": { + "description": "Maximum parallel executions count per node for managed integration runtime.", + "type": "integer", + "minimum": 1 + }, + "vNetProperties": { + "description": "VNet properties for managed integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeVNetProperties" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeVNetProperties": { + "description": "VNet properties for managed integration runtime.", + "type": "object", + "properties": { + "vNetId": { + "description": "The ID of the VNet that this integration runtime will join.", + "type": "string" + }, + "subnet": { + "description": "The name of the subnet this integration runtime will join.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeSsisProperties": { + "description": "SSIS properties for managed integration runtime.", + "type": "object", + "properties": { + "catalogInfo": { + "description": "Catalog information for managed dedicated integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeSsisCatalogInfo" + }, + "licenseType": { + "description": "License type for bringing your own license scenario.", + "type": "string", + "enum": [ + "BasePrice", + "LicenseIncluded" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeLicenseType", + "modelAsString": true + } + }, + "customSetupScriptProperties": { + "description": "Custom setup script properties for a managed dedicated integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeCustomSetupScriptProperties" + }, + "edition": { + "description": "The edition for the SSIS Integration Runtime", + "type": "string", + "enum": [ + "Standard", + "Enterprise" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeEdition", + "modelAsString": true + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeSsisCatalogInfo": { + "description": "Catalog information for managed dedicated integration runtime.", + "type": "object", + "properties": { + "catalogServerEndpoint": { + "description": "The catalog database server URL.", + "type": "string" + }, + "catalogAdminUserName": { + "description": "The administrator user name of catalog database.", + "type": "string", + "minLength": 1, + "maxLength": 128 + }, + "catalogAdminPassword": { + "description": "The password of the administrator user account of the catalog database.", + "$ref": "../datafactory.json#/definitions/SecureString" + }, + "catalogPricingTier": { + "description": "The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/", + "type": "string", + "enum": [ + "Basic", + "Standard", + "Premium", + "PremiumRS" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeSsisCatalogPricingTier", + "modelAsString": true + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeCustomSetupScriptProperties": { + "description": "Custom setup script properties for a managed dedicated integration runtime.", + "type": "object", + "properties": { + "blobContainerUri": { + "description": "The URI of the Azure blob container that contains the custom setup script.", + "type": "string" + }, + "sasToken": { + "description": "The SAS token of the Azure blob container.", + "$ref": "../datafactory.json#/definitions/SecureString" + } + } + }, + "SelfHostedIntegrationRuntime": { + "x-ms-discriminator-value": "SelfHosted", + "description": "Self-hosted integration runtime.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IntegrationRuntime" + } + ], + "properties": { + "typeProperties": { + "description": "When this property is not null, means this is a linked integration runtime. The property is used to access original integration runtime.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SelfHostedIntegrationRuntimeTypeProperties" + } + } + }, + "SelfHostedIntegrationRuntimeTypeProperties": { + "description": "The self-hosted integration runtime properties.", + "type": "object", + "properties": { + "linkedInfo": { + "$ref": "#/definitions/LinkedIntegrationRuntimeType" + } + } + }, + "LinkedIntegrationRuntimeType": { + "description": "The base definition of a linked integration runtime.", + "discriminator": "authorizationType", + "type": "object", + "properties": { + "authorizationType": { + "type": "string", + "description": "The authorization type for integration runtime sharing." + } + }, + "required": [ + "authorizationType" + ] + }, + "LinkedIntegrationRuntimeKeyAuthorization": { + "x-ms-discriminator-value": "Key", + "description": "The key authorization type integration runtime.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedIntegrationRuntimeType" + } + ], + "properties": { + "key": { + "description": "The key used for authorization.", + "$ref": "../datafactory.json#/definitions/SecureString" + } + }, + "required": [ + "key" + ] + }, + "LinkedIntegrationRuntimeRbacAuthorization": { + "x-ms-discriminator-value": "RBAC", + "description": "The role based access control (RBAC) authorization type integration runtime.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedIntegrationRuntimeType" + } + ], + "properties": { + "resourceId": { + "description": "The resource identifier of the integration runtime to be shared.", + "type": "string" + } + }, + "required": [ + "resourceId" + ] + }, + "IntegrationRuntimeStatus": { + "description": "Integration runtime status.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "Type of integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeType" + }, + "dataFactoryName": { + "description": "The data factory name which the integration runtime belong to.", + "type": "string", + "readOnly": true + }, + "state": { + "description": "The state of integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeState", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeState": { + "description": "The state of integration runtime.", + "type": "string", + "readOnly": true, + "enum": [ + "Initial", + "Stopped", + "Started", + "Starting", + "Stopping", + "NeedRegistration", + "Online", + "Limited", + "Offline", + "AccessDenied" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeState", + "modelAsString": true + } + }, + "ManagedIntegrationRuntimeStatus": { + "x-ms-discriminator-value": "Managed", + "description": "Managed integration runtime status.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IntegrationRuntimeStatus" + } + ], + "properties": { + "typeProperties": { + "description": "Managed integration runtime status type properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedIntegrationRuntimeStatusTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ManagedIntegrationRuntimeStatusTypeProperties": { + "description": "Managed integration runtime status type properties.", + "type": "object", + "properties": { + "createTime": { + "description": "The time at which the integration runtime was created, in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "nodes": { + "description": "The list of nodes for managed integration runtime.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedIntegrationRuntimeNode" + }, + "readOnly": true + }, + "otherErrors": { + "description": "The errors that occurred on this integration runtime.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedIntegrationRuntimeError" + }, + "readOnly": true + }, + "lastOperation": { + "description": "The last operation result that occurred on this integration runtime.", + "$ref": "#/definitions/ManagedIntegrationRuntimeOperationResult", + "readOnly": true + } + } + }, + "ManagedIntegrationRuntimeOperationResult": { + "description": "Properties of managed integration runtime operation result.", + "properties": { + "type": { + "description": "The operation type. Could be start or stop.", + "type": "string", + "readOnly": true + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "result": { + "description": "The operation result.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "Managed integration runtime error parameters.", + "type": "array", + "items": { + "type": "string", + "description": "Error message parameters." + }, + "readOnly": true + }, + "activityId": { + "description": "The activity id for the operation request.", + "type": "string", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "ManagedIntegrationRuntimeNode": { + "description": "Properties of integration runtime node.", + "properties": { + "nodeId": { + "description": "The managed integration runtime node id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The managed integration runtime node status.", + "type": "string", + "readOnly": true, + "enum": [ + "Starting", + "Available", + "Recycling", + "Unavailable" + ], + "x-ms-enum": { + "name": "ManagedIntegrationRuntimeNodeStatus", + "modelAsString": true + } + }, + "errors": { + "description": "The errors that occurred on this integration runtime node.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedIntegrationRuntimeError" + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "ManagedIntegrationRuntimeError": { + "description": "Error definition for managed integration runtime.", + "properties": { + "time": { + "description": "The time when the error occurred.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "Managed integration runtime error parameters.", + "type": "array", + "items": { + "type": "string", + "description": "Error message parameters." + }, + "readOnly": true + }, + "message": { + "description": "Error message.", + "type": "string", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "SelfHostedIntegrationRuntimeStatus": { + "x-ms-discriminator-value": "SelfHosted", + "description": "Self-hosted integration runtime status.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IntegrationRuntimeStatus" + } + ], + "properties": { + "typeProperties": { + "description": "Self-hosted integration runtime status type properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SelfHostedIntegrationRuntimeStatusTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SelfHostedIntegrationRuntimeStatusTypeProperties": { + "description": "Self-hosted integration runtime status type properties.", + "type": "object", + "properties": { + "createTime": { + "description": "The time at which the integration runtime was created, in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "taskQueueId": { + "description": "The task queue id of the integration runtime.", + "type": "string", + "readOnly": true + }, + "internalChannelEncryption": { + "description": "It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).", + "type": "string", + "readOnly": true, + "enum": [ + "NotSet", + "SslEncrypted", + "NotEncrypted" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeInternalChannelEncryptionMode", + "modelAsString": true + } + }, + "version": { + "description": "Version of the integration runtime.", + "type": "string", + "readOnly": true + }, + "nodes": { + "description": "The list of nodes for this integration runtime.", + "type": "array", + "items": { + "$ref": "#/definitions/SelfHostedIntegrationRuntimeNode" + } + }, + "scheduledUpdateDate": { + "description": "The date at which the integration runtime will be scheduled to update, in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updateDelayOffset": { + "description": "The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 hours", + "type": "string", + "readOnly": true + }, + "localTimeZoneOffset": { + "description": "The local time zone offset in hours.", + "type": "string", + "readOnly": true + }, + "capabilities": { + "description": "Object with additional information about integration runtime capabilities.", + "type": "object", + "readOnly": true, + "additionalProperties": { + "type": "string" + } + }, + "serviceUrls": { + "description": "The URLs for the services used in integration runtime backend service.", + "type": "array", + "items": { + "description": "The service URL", + "type": "string" + }, + "readOnly": true + }, + "autoUpdate": { + "description": "Whether Self-hosted integration runtime auto update has been turned on.", + "$ref": "#/definitions/IntegrationRuntimeAutoUpdate", + "readOnly": true + }, + "versionStatus": { + "description": "Status of the integration runtime version.", + "type": "string", + "readOnly": true + }, + "links": { + "description": "The list of linked integration runtimes that are created to share with this integration runtime.", + "type": "array", + "items": { + "$ref": "#/definitions/LinkedIntegrationRuntime" + } + }, + "pushedVersion": { + "description": "The version that the integration runtime is going to update to.", + "type": "string", + "readOnly": true + }, + "latestVersion": { + "description": "The latest version on download center.", + "type": "string", + "readOnly": true + } + } + }, + "IntegrationRuntimeAutoUpdate": { + "description": "The state of integration runtime auto update.", + "type": "string", + "readOnly": true, + "enum": [ + "On", + "Off" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeAutoUpdate", + "modelAsString": true + } + }, + "LinkedIntegrationRuntime": { + "description": "The linked integration runtime information.", + "type": "object", + "properties": { + "name": { + "description": "The name of the linked integration runtime.", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "The subscription ID for which the linked integration runtime belong to.", + "type": "string", + "readOnly": true + }, + "dataFactoryName": { + "description": "The name of the data factory for which the linked integration runtime belong to.", + "type": "string", + "readOnly": true + }, + "dataFactoryLocation": { + "description": "The location of the data factory for which the linked integration runtime belong to.", + "type": "string", + "readOnly": true + }, + "createTime": { + "description": "The creating time of the linked integration runtime.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "SelfHostedIntegrationRuntimeNode": { + "description": "Properties of Self-hosted integration runtime node.", + "properties": { + "nodeName": { + "description": "Name of the integration runtime node.", + "type": "string", + "readOnly": true + }, + "machineName": { + "description": "Machine name of the integration runtime node.", + "type": "string", + "readOnly": true + }, + "hostServiceUri": { + "description": "URI for the host machine of the integration runtime.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the integration runtime node.", + "type": "string", + "readOnly": true, + "enum": [ + "NeedRegistration", + "Online", + "Limited", + "Offline", + "Upgrading", + "Initializing", + "InitializeFailed" + ], + "x-ms-enum": { + "name": "SelfHostedIntegrationRuntimeNodeStatus", + "modelAsString": true + } + }, + "capabilities": { + "description": "The integration runtime capabilities dictionary", + "type": "object", + "readOnly": true, + "additionalProperties": { + "type": "string" + } + }, + "versionStatus": { + "description": "Status of the integration runtime node version.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "Version of the integration runtime node.", + "type": "string", + "readOnly": true + }, + "registerTime": { + "description": "The time at which the integration runtime node was registered in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastConnectTime": { + "description": "The most recent time at which the integration runtime was connected in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "expiryTime": { + "description": "The time at which the integration runtime will expire in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastStartTime": { + "description": "The time the node last started up.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastStopTime": { + "description": "The integration runtime node last stop time.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastUpdateResult": { + "description": "The result of the last integration runtime node update.", + "type": "string", + "enum": [ + "Succeed", + "Fail" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeUpdateResult", + "modelAsString": true + }, + "readOnly": true + }, + "lastStartUpdateTime": { + "description": "The last time for the integration runtime node update start.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastEndUpdateTime": { + "description": "The last time for the integration runtime node update end.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "isActiveDispatcher": { + "description": "Indicates whether this node is the active dispatcher for integration runtime requests.", + "type": "boolean", + "readOnly": true + }, + "concurrentJobsLimit": { + "description": "Maximum concurrent jobs on the integration runtime node.", + "type": "integer", + "readOnly": true + }, + "maxConcurrentJobs": { + "description": "The maximum concurrent jobs in this integration runtime.", + "type": "integer", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeConnectionInfo": { + "description": "Connection information for encrypting the on-premises data source credentials.", + "type": "object", + "properties": { + "serviceToken": { + "description": "The token generated in service. Callers use this token to authenticate to integration runtime.", + "type": "string", + "readOnly": true + }, + "identityCertThumbprint": { + "description": "The integration runtime SSL certificate thumbprint. Click-Once application uses it to do server validation.", + "type": "string", + "readOnly": true + }, + "hostServiceUri": { + "description": "The on-premises integration runtime host URL.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The integration runtime version.", + "type": "string", + "readOnly": true + }, + "publicKey": { + "description": "The public key for encrypting a credential when transferring the credential to the integration runtime.", + "type": "string", + "readOnly": true + }, + "isIdentityCertExprired": { + "description": "Whether the identity certificate is expired.", + "type": "boolean", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeRegenerateKeyParameters": { + "description": "Parameters to regenerate the authentication key.", + "type": "object", + "properties": { + "keyName": { + "description": "The name of the authentication key to regenerate.", + "type": "string", + "enum": [ + "authKey1", + "authKey2" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeAuthKeyName", + "modelAsString": true + } + } + } + }, + "IntegrationRuntimeAuthKeys": { + "description": "The integration runtime authentication keys.", + "type": "object", + "properties": { + "authKey1": { + "type": "string", + "description": "The primary integration runtime authentication key." + }, + "authKey2": { + "type": "string", + "description": "The secondary integration runtime authentication key." + } + } + }, + "IntegrationRuntimeMonitoringData": { + "description": "Get monitoring data response.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Integration runtime name." + }, + "nodes": { + "type": "array", + "description": "Integration runtime node monitoring data.", + "items": { + "$ref": "#/definitions/IntegrationRuntimeNodeMonitoringData" + } + } + } + }, + "IntegrationRuntimeNodeMonitoringData": { + "description": "Monitoring data for integration runtime node.", + "type": "object", + "properties": { + "nodeName": { + "description": "Name of the integration runtime node.", + "type": "string", + "readOnly": true + }, + "availableMemoryInMB": { + "description": "Available memory (MB) on the integration runtime node.", + "type": "integer", + "readOnly": true + }, + "cpuUtilization": { + "description": "CPU percentage on the integration runtime node.", + "type": "integer", + "readOnly": true + }, + "concurrentJobsLimit": { + "description": "Maximum concurrent jobs on the integration runtime node.", + "type": "integer", + "readOnly": true + }, + "concurrentJobsRunning": { + "description": "The number of jobs currently running on the integration runtime node.", + "type": "integer", + "readOnly": true + }, + "maxConcurrentJobs": { + "description": "The maximum concurrent jobs in this integration runtime.", + "type": "integer", + "readOnly": true + }, + "sentBytes": { + "description": "Sent bytes on the integration runtime node.", + "type": "number", + "readOnly": true + }, + "receivedBytes": { + "description": "Received bytes on the integration runtime node.", + "type": "number", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeNodeIpAddress": { + "type": "object", + "description": "The IP address of self-hosted integration runtime node.", + "properties": { + "ipAddress": { + "description": "The IP address of self-hosted integration runtime node.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json new file mode 100644 index 000000000000..e38a8d9ad228 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -0,0 +1,4100 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2017-09-01-preview" + }, + "paths": {}, + "definitions": { + "LinkedService": { + "description": "The Azure Data Factory nested object which contains the information and credential which can be used to connect with related store or compute resource.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Type of linked service." + }, + "connectVia": { + "description": "The integration runtime reference.", + "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" + }, + "description": { + "description": "Linked service description.", + "type": "string" + }, + "parameters": { + "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification", + "description": "Parameters for linked service." + }, + "annotations": { + "description": "List of tags that can be used for describing the Dataset.", + "type": "array", + "items": { + "type": "object" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureStorageLinkedService": { + "x-ms-discriminator-value": "AzureStorage", + "description": "The storage account linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Storage linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureStorageLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureStorageLinkedServiceTypeProperties": { + "description": "Azure Storage linked service properties.", + "properties": { + "connectionString": { + "description": "The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "sasUri": { + "description": "SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "AzureSqlDWLinkedService": { + "x-ms-discriminator-value": "AzureSqlDW", + "description": "Azure SQL Data Warehouse linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL Data Warehouse linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlDWLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSqlDWLinkedServiceTypeProperties": { + "description": "Azure SQL Data Warehouse linked service properties.", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against Azure SQL Data Warehouse." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "SqlServerLinkedService": { + "x-ms-discriminator-value": "SqlServer", + "description": "SQL Server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "SQL Server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SqlServerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SqlServerLinkedServiceTypeProperties": { + "description": "SQL Server linked service properties.", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "userName": { + "type": "object", + "description": "The on-premises Windows authentication user name. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The on-premises Windows authentication password.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "AzureSqlDatabaseLinkedService": { + "x-ms-discriminator-value": "AzureSqlDatabase", + "description": "Microsoft Azure SQL Database linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL Database linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlDatabaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSqlDatabaseLinkedServiceTypeProperties": { + "description": "Azure SQL Database linked service properties.", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against Azure SQL Database." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "AzureBatchLinkedService": { + "x-ms-discriminator-value": "AzureBatch", + "description": "Azure Batch linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Batch linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBatchLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureBatchLinkedServiceTypeProperties": { + "description": "Azure Batch linked service properties.", + "properties": { + "accountName": { + "type": "object", + "description": "The Azure Batch account name. Type: string (or Expression with resultType string)." + }, + "accessKey": { + "description": "The Azure Batch account access key.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "batchUri": { + "type": "object", + "description": "The Azure Batch URI. Type: string (or Expression with resultType string)." + }, + "poolName": { + "type": "object", + "description": "The Azure Batch pool name. Type: string (or Expression with resultType string)." + }, + "linkedServiceName": { + "description": "The Azure Storage linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "accountName", + "batchUri", + "poolName", + "linkedServiceName" + ] + }, + "AzureKeyVaultLinkedService": { + "x-ms-discriminator-value": "AzureKeyVault", + "description": "Azure Key Vault linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Key Vault linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureKeyVaultLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureKeyVaultLinkedServiceTypeProperties": { + "description": "Azure Key Vault linked service properties.", + "properties": { + "baseUrl": { + "type": "object", + "description": "The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string)." + } + }, + "required": [ + "baseUrl" + ] + }, + "CosmosDbLinkedService": { + "x-ms-discriminator-value": "CosmosDb", + "description": "Microsoft Azure Cosmos Database (CosmosDB) linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "CosmosDB linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CosmosDbLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CosmosDbLinkedServiceTypeProperties": { + "description": "CosmosDB linked service properties.", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "DynamicsLinkedService": { + "x-ms-discriminator-value": "Dynamics", + "description": "Dynamics linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DynamicsLinkedServiceTypeProperties": { + "description": "Dynamics linked service properties.", + "properties": { + "deploymentType": { + "x-ms-enum": { + "name": "DynamicsDeploymentType", + "modelAsString": true + }, + "enum": [ + "Online", + "OnPremisesWithIfd" + ], + "type": "object", + "description": "The deployment type of the Dynamics instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string)." + }, + "hostName": { + "type": "object", + "description": "The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "serviceUri": { + "type": "object", + "description": "The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string)." + }, + "organizationName": { + "type": "object", + "description": "The organization name of the Dynamics instance. The property is required for on-prem and required for online when there are more than one Dynamics instances associated with the user. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "x-ms-enum": { + "name": "DynamicsAuthenticationType", + "modelAsString": true + }, + "enum": [ + "Office365", + "Ifd" + ], + "type": "object", + "description": "The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "User name to access the Dynamics instance. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the Dynamics instance.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "deploymentType", + "authenticationType", + "username" + ] + }, + "HDInsightLinkedService": { + "x-ms-discriminator-value": "HDInsight", + "description": "HDInsight linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "HDInsight linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HDInsightLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightLinkedServiceTypeProperties": { + "description": "HDInsight linked service properties.", + "properties": { + "clusterUri": { + "type": "object", + "description": "HDInsight cluster URI. Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "HDInsight cluster user name. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "HDInsight cluster password.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "linkedServiceName": { + "description": "The Azure Storage linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "hcatalogLinkedServiceName": { + "description": "A reference to the Azure SQL linked service that points to the HCatalog database.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "clusterUri" + ] + }, + "FileServerLinkedService": { + "x-ms-discriminator-value": "FileServer", + "description": "File system linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "File system linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FileServerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "FileServerLinkedServiceTypeProperties": { + "description": "File system linked service properties.", + "properties": { + "host": { + "type": "object", + "description": "Host name of the server. Type: string (or Expression with resultType string)." + }, + "userId": { + "type": "object", + "description": "User ID to logon the server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to logon the server.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "host" + ] + }, + "OracleLinkedService": { + "x-ms-discriminator-value": "Oracle", + "description": "Oracle database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Oracle database linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OracleLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "OracleLinkedServiceTypeProperties": { + "description": "Oracle database linked service properties.", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "AzureMySqlLinkedService": { + "x-ms-discriminator-value": "AzureMySql", + "description": "Azure MySQL database linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure MySQL database linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureMySqlLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMySqlLinkedServiceTypeProperties": { + "description": "Azure MySQL database linked service properties.", + "properties": { + "connectionString": { + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "MySqlLinkedService": { + "x-ms-discriminator-value": "MySql", + "description": "Linked service for MySQL data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MySQL linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MySqlLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MySqlLinkedServiceTypeProperties": { + "description": "MySQL linked service properties.", + "properties": { + "connectionString": { + "description": "The connection string.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "PostgreSqlLinkedService": { + "x-ms-discriminator-value": "PostgreSql", + "description": "Linked service for PostgreSQL data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "PostgreSQL linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PostgreSqlLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PostgreSqlLinkedServiceTypeProperties": { + "description": "PostgreSQL linked service properties.", + "properties": { + "connectionString": { + "description": "The connection string.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "SybaseLinkedService": { + "x-ms-discriminator-value": "Sybase", + "description": "Linked service for Sybase data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Sybase linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SybaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SybaseLinkedServiceTypeProperties": { + "description": "Sybase linked service properties.", + "properties": { + "server": { + "type": "object", + "description": "Server name for connection. Type: string (or Expression with resultType string)." + }, + "database": { + "type": "object", + "description": "Database name for connection. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "Schema name for connection. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "AuthenticationType to be used for connection.", + "type": "string", + "enum": [ + "Basic", + "Windows" + ], + "x-ms-enum": { + "name": "SybaseAuthenticationType", + "modelAsString": true + } + }, + "username": { + "type": "object", + "description": "Username for authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "database" + ] + }, + "Db2LinkedService": { + "x-ms-discriminator-value": "Db2", + "description": "Linked service for DB2 data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "DB2 linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/Db2LinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "Db2LinkedServiceTypeProperties": { + "description": "DB2 linked service properties.", + "properties": { + "server": { + "type": "object", + "description": "Server name for connection. Type: string (or Expression with resultType string)." + }, + "database": { + "type": "object", + "description": "Database name for connection. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "AuthenticationType to be used for connection.", + "type": "string", + "enum": [ + "Basic" + ], + "x-ms-enum": { + "name": "Db2AuthenticationType", + "modelAsString": true + } + }, + "username": { + "type": "object", + "description": "Username for authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "database" + ] + }, + "TeradataLinkedService": { + "x-ms-discriminator-value": "Teradata", + "description": "Linked service for Teradata data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Teradata linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/TeradataLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "TeradataLinkedServiceTypeProperties": { + "description": "Teradata linked service properties.", + "properties": { + "server": { + "type": "object", + "description": "Server name for connection. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "AuthenticationType to be used for connection.", + "type": "string", + "enum": [ + "Basic", + "Windows" + ], + "x-ms-enum": { + "name": "TeradataAuthenticationType", + "modelAsString": true + } + }, + "username": { + "type": "object", + "description": "Username for authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server" + ] + }, + "AzureMLLinkedService": { + "x-ms-discriminator-value": "AzureML", + "description": "Azure ML Web Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure ML Web Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureMLLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLLinkedServiceTypeProperties": { + "description": "Azure ML Web Service linked service properties.", + "properties": { + "mlEndpoint": { + "type": "object", + "description": "The Batch Execution REST URL for an Azure ML Web Service endpoint. Type: string (or Expression with resultType string)." + }, + "apiKey": { + "description": "The API key for accessing the Azure ML model endpoint.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "updateResourceEndpoint": { + "type": "object", + "description": "The Update Resource REST URL for an Azure ML Web Service endpoint. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML web service. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "$ref": "../datafactory.json#/definitions/SecretBase", + "description": "The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML web service." + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "mlEndpoint", + "apiKey" + ] + }, + "OdbcLinkedService": { + "x-ms-discriminator-value": "Odbc", + "description": "Open Database Connectivity (ODBC) linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "ODBC linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OdbcLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "OdbcLinkedServiceTypeProperties": { + "description": "ODBC linked service properties.", + "properties": { + "connectionString": { + "description": "The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "authenticationType": { + "type": "object", + "description": "Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string)." + }, + "credential": { + "description": "The access credential portion of the connection string specified in driver-specific property-value format.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "userName": { + "type": "object", + "description": "User name for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for Basic authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString" + ] + }, + "HdfsLinkedService": { + "x-ms-discriminator-value": "Hdfs", + "description": "Hadoop Distributed File System (HDFS) linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "HDFS linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HdfsLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HdfsLinkedServiceTypeProperties": { + "description": "HDFS linked service properties.", + "properties": { + "url": { + "type": "object", + "description": "The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "type": "object", + "description": "Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "User name for Windows authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for Windows authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + } + }, + "required": [ + "url" + ] + }, + "ODataLinkedService": { + "x-ms-discriminator-value": "OData", + "description": "Open Data Protocol (OData) linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "OData linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ODataLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ODataLinkedServiceTypeProperties": { + "description": "OData linked service properties.", + "properties": { + "url": { + "type": "object", + "description": "The URL of the OData service endpoint. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "Type of authentication used to connect to the OData service.", + "type": "string", + "enum": [ + "Basic", + "Anonymous" + ], + "x-ms-enum": { + "name": "ODataAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "User name of the OData service. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password of the OData service.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, + "WebLinkedService": { + "x-ms-discriminator-value": "Web", + "description": "Web linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Web linked service properties.", + "$ref": "#/definitions/WebLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebLinkedServiceTypeProperties": { + "description": "Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models.", + "discriminator": "authenticationType", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "Type of authentication used to connect to the web table source.", + "type": "string", + "enum": [ + "Basic", + "Anonymous", + "ClientCertificate" + ], + "x-ms-enum": { + "name": "WebAuthenticationType", + "modelAsString": true + } + } + }, + "required": [ + "authenticationType", + "url" + ] + }, + "WebAnonymousAuthentication": { + "description": "A WebLinkedService that uses anonymous authentication to communicate with an HTTP endpoint.", + "x-ms-discriminator-value": "Anonymous", + "allOf": [ + { + "$ref": "#/definitions/WebLinkedServiceTypeProperties" + } + ] + }, + "WebBasicAuthentication": { + "description": "A WebLinkedService that uses basic authentication to communicate with an HTTP endpoint.", + "x-ms-discriminator-value": "Basic", + "allOf": [ + { + "$ref": "#/definitions/WebLinkedServiceTypeProperties" + } + ], + "properties": { + "username": { + "type": "object", + "description": "User name for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password for Basic authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + } + }, + "required": [ + "username", + "password" + ] + }, + "WebClientCertificateAuthentication": { + "description": "A WebLinkedService that uses client certificate based authentication to communicate with an HTTP endpoint. This scheme follows mutual authentication; the server must also provide valid credentials to the client.", + "x-ms-discriminator-value": "ClientCertificate", + "allOf": [ + { + "$ref": "#/definitions/WebLinkedServiceTypeProperties" + } + ], + "properties": { + "pfx": { + "description": "Base64-encoded contents of a PFX file.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "password": { + "description": "Password for the PFX file.", + "$ref": "../datafactory.json#/definitions/SecretBase" + } + }, + "required": [ + "pfx", + "password" + ] + }, + "CassandraLinkedService": { + "x-ms-discriminator-value": "Cassandra", + "description": "Linked service for Cassandra data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Cassandra linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CassandraLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CassandraLinkedServiceTypeProperties": { + "description": "Cassandra linked service properties.", + "properties": { + "host": { + "type": "object", + "description": "Host name for connection. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "type": "object", + "description": "AuthenticationType to be used for connection. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The port for the connection. Type: integer (or Expression with resultType integer)." + }, + "username": { + "type": "object", + "description": "Username for authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "host" + ] + }, + "MongoDbLinkedService": { + "x-ms-discriminator-value": "MongoDb", + "description": "Linked service for MongoDb data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbLinkedServiceTypeProperties": { + "description": "MongoDB linked service properties.", + "properties": { + "server": { + "type": "object", + "description": "The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the MongoDB database.", + "type": "string", + "enum": [ + "Basic", + "Anonymous" + ], + "x-ms-enum": { + "name": "MongoDbAuthenticationType", + "modelAsString": true + } + }, + "databaseName": { + "type": "object", + "description": "The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "Username for authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "authSource": { + "type": "object", + "description": "Database to verify the username and password. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "enableSsl": { + "type": "object", + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "allowSelfSignedServerCert": { + "type": "object", + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "databaseName" + ] + }, + "AzureDataLakeStoreLinkedService": { + "x-ms-discriminator-value": "AzureDataLakeStore", + "description": "Azure Data Lake Store linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Lake Store linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataLakeStoreLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataLakeStoreLinkedServiceTypeProperties": { + "description": "Azure Data Lake Store linked service properties.", + "properties": { + "dataLakeStoreUri": { + "type": "object", + "description": "Data Lake Store service URI. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The Key of the application used to authenticate against the Azure Data Lake Store account.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "accountName": { + "type": "object", + "description": "Data Lake Store account name. Type: string (or Expression with resultType string)." + }, + "subscriptionId": { + "type": "object", + "description": "Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string)." + }, + "resourceGroupName": { + "type": "object", + "description": "Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "dataLakeStoreUri" + ] + }, + "SalesforceLinkedService": { + "x-ms-discriminator-value": "Salesforce", + "description": "Linked service for Salesforce.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SalesforceLinkedServiceTypeProperties": { + "description": "Salesforce linked service properties.", + "properties": { + "environmentUrl": { + "type": "object", + "description": "The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password for Basic authentication of the Salesforce instance.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "securityToken": { + "description": "The security token is required to remotely access Salesforce instance.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "SapCloudForCustomerLinkedService": { + "x-ms-discriminator-value": "SapCloudForCustomer", + "description": "Linked service for SAP Cloud for Customer.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "SAP Cloud for Customer linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapCloudForCustomerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapCloudForCustomerLinkedServiceTypeProperties": { + "description": "SAP Cloud for Customer linked service properties.", + "properties": { + "url": { + "type": "object", + "description": "The URL of SAP Cloud for Customer OData API. For example, '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "The username for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password for Basic authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, + "SapEccLinkedService": { + "x-ms-discriminator-value": "SapEcc", + "description": "Linked service for SAP ERP Central Component(SAP ECC).", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "SAP ECC linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapEccLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapEccLinkedServiceTypeProperties": { + "description": "SAP ECC linked service properties.", + "properties": { + "url": { + "type": "string", + "description": "The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "string", + "description": "The username for Basic authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password for Basic authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "string", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, + "AmazonS3LinkedService": { + "x-ms-discriminator-value": "AmazonS3", + "description": "Linked service for Amazon S3.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon S3 linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonS3LinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AmazonS3LinkedServiceTypeProperties": { + "description": "Amazon S3 linked service properties.", + "properties": { + "accessKeyId": { + "type": "object", + "description": "The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string)." + }, + "secretAccessKey": { + "description": "The secret access key of the Amazon S3 Identity and Access Management (IAM) user.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + } + }, + "AmazonRedshiftLinkedService": { + "x-ms-discriminator-value": "AmazonRedshift", + "description": "Linked service for Amazon Redshift.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon Redshift linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonRedshiftLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AmazonRedshiftLinkedServiceTypeProperties": { + "description": "Amazon Redshift linked service properties.", + "properties": { + "server": { + "type": "object", + "description": "The name of the Amazon Redshift server. Type: string (or Expression with resultType string)." + }, + "username": { + "type": "object", + "description": "The username of the Amazon Redshift source. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password of the Amazon Redshift source.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "database": { + "type": "object", + "description": "The database name of the Amazon Redshift source. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "database" + ] + }, + "CustomDataSourceLinkedService": { + "x-ms-discriminator-value": "CustomDataSource", + "description": "Custom linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Custom linked service properties.", + "x-ms-client-flatten": true, + "type": "object" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSearchLinkedService": { + "x-ms-discriminator-value": "AzureSearch", + "description": "Linked service for Windows Azure Search Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Windows Azure Search Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSearchLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSearchLinkedServiceTypeProperties": { + "description": "Windows Azure Search Service linked service properties.", + "properties": { + "url": { + "type": "object", + "description": "URL for Azure Search service. Type: string (or Expression with resultType string)." + }, + "key": { + "description": "Admin Key for Azure Search service", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, + "HttpLinkedService": { + "x-ms-discriminator-value": "HttpServer", + "description": "Linked service for an HTTP source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HttpLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HttpLinkedServiceTypeProperties": { + "description": "Properties specific to this linked service type.", + "properties": { + "url": { + "type": "object", + "description": "The base URL of the HTTP endpoint, e.g. http://www.microsoft.com. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the HTTP server.", + "type": "string", + "enum": [ + "Basic", + "Anonymous", + "Digest", + "Windows", + "ClientCertificate" + ], + "x-ms-enum": { + "name": "HttpAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "embeddedCertData": { + "type": "object", + "description": "Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string)." + }, + "certThumbprint": { + "type": "object", + "description": "Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "enableServerCertificateValidation": { + "type": "object", + "description": "If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "url" + ] + }, + "FtpServerLinkedService": { + "x-ms-discriminator-value": "FtpServer", + "description": "A FTP server Linked Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FtpServerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "FtpServerLinkedServiceTypeProperties": { + "description": "Properties specific to this linked service type.", + "properties": { + "host": { + "type": "object", + "description": "Host name of the FTP server. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The TCP port number that the FTP server uses to listen for client connections. Default value is 21. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the FTP server.", + "type": "string", + "enum": [ + "Basic", + "Anonymous" + ], + "x-ms-enum": { + "name": "FtpAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "Username to logon the FTP server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to logon the FTP server.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "enableSsl": { + "type": "object", + "description": "If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "enableServerCertificateValidation": { + "type": "object", + "description": "If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "host" + ] + }, + "SftpServerLinkedService": { + "x-ms-discriminator-value": "Sftp", + "description": "A linked service for an SSH File Transfer Protocol (SFTP) server. ", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SftpServerLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SftpServerLinkedServiceTypeProperties": { + "description": "Properties specific to this linked service type.", + "properties": { + "host": { + "type": "object", + "description": "The SFTP server host name. Type: string (or Expression with resultType string)." + }, + "port": { + "type": "object", + "description": "The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the FTP server.", + "type": "string", + "enum": [ + "Basic", + "SshPublicKey" + ], + "x-ms-enum": { + "name": "SftpAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "The username used to log on to the SFTP server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to logon the SFTP server for Basic authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "privateKeyPath": { + "type": "object", + "description": "The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string)." + }, + "privateKeyContent": { + "description": "Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.", + "$ref": "../datafactory.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" + }, + "skipHostKeyValidation": { + "type": "object", + "description": "If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "hostKeyFingerprint": { + "type": "object", + "description": "The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "host" + ] + }, + "SapBWLinkedService": { + "x-ms-discriminator-value": "SapBW", + "description": "SAP Business Warehouse Linked Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapBWLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapBWLinkedServiceTypeProperties": { + "description": "Properties specific to this linked service type.", + "properties": { + "server": { + "type": "object", + "description": "Host name of the SAP BW instance. Type: string (or Expression with resultType string)." + }, + "systemNumber": { + "type": "object", + "description": "System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string)." + }, + "clientId": { + "type": "object", + "description": "Client ID of the client on the BW system. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "Username to access the SAP BW server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the SAP BW server.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server", + "systemNumber", + "clientId" + ] + }, + "SapHanaLinkedService": { + "x-ms-discriminator-value": "SapHana", + "description": "SAP HANA Linked Service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this linked service type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapHanaLinkedServiceProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapHanaLinkedServiceProperties": { + "description": "Properties specific to this linked service type.", + "properties": { + "server": { + "type": "object", + "description": "Host name of the SAP HANA server. Type: string (or Expression with resultType string)." + }, + "authenticationType": { + "description": "The authentication type to be used to connect to the SAP HANA server.", + "type": "string", + "enum": [ + "Basic", + "Windows" + ], + "x-ms-enum": { + "name": "SapHanaAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "type": "object", + "description": "Username to access the SAP HANA server. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "Password to access the SAP HANA server.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "server" + ] + }, + "AmazonMWSLinkedService": { + "x-ms-discriminator-value": "AmazonMWS", + "description": "Amazon Marketplace Web Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon Marketplace Web Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonMWSLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AmazonMWSLinkedServiceTypeProperties": { + "description": "Amazon Marketplace Web Service linked service properties.", + "properties": { + "endpoint": { + "description": "The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com)", + "type": "object" + }, + "marketplaceID": { + "description": "The Amazon Marketplace ID you want to retrieve data from. To retrive data from multiple Marketplace IDs, seperate them with a comma (,). (i.e. A2EUQ1WTGCTBG2)", + "type": "object" + }, + "sellerID": { + "description": "The Amazon seller ID.", + "type": "object" + }, + "mwsAuthToken": { + "description": "The Amazon MWS authentication token.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "accessKeyId": { + "description": "The access key id used to access data.", + "type": "object" + }, + "secretKey": { + "description": "The secret key used to access data.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "marketplaceID", + "sellerID", + "accessKeyId" + ] + }, + "AzurePostgreSqlLinkedService": { + "x-ms-discriminator-value": "AzurePostgreSql", + "description": "Azure PostgreSQL linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure PostgreSQL linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzurePostgreSqlLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzurePostgreSqlLinkedServiceTypeProperties": { + "description": "Azure PostgreSQL linked service properties.", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "ConcurLinkedService": { + "x-ms-discriminator-value": "Concur", + "description": "Concur Serivce linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Concur Serivce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConcurLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ConcurLinkedServiceTypeProperties": { + "description": "Concur Serivce linked service properties.", + "properties": { + "clientId": { + "description": "Application client_id supplied by Concur App Management.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Concur Service.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the username field.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "clientId", + "username" + ] + }, + "CouchbaseLinkedService": { + "x-ms-discriminator-value": "Couchbase", + "description": "Couchbase server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Couchbase server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CouchbaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CouchbaseLinkedServiceTypeProperties": { + "description": "Couchbase server linked service properties.", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "DrillLinkedService": { + "x-ms-discriminator-value": "Drill", + "description": "Drill server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Drill server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DrillLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DrillLinkedServiceTypeProperties": { + "description": "Drill server linked service properties.", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "EloquaLinkedService": { + "x-ms-discriminator-value": "Eloqua", + "description": "Eloqua server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Eloqua server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/EloquaLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "EloquaLinkedServiceTypeProperties": { + "description": "Eloqua server linked service properties.", + "properties": { + "endpoint": { + "description": "The endpoint of the Eloqua server. (i.e. eloqua.example.com)", + "type": "object" + }, + "username": { + "description": "The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice)", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "username" + ] + }, + "GoogleBigQueryLinkedService": { + "x-ms-discriminator-value": "GoogleBigQuery", + "description": "Google BigQuery service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Google BigQuery service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GoogleBigQueryLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GoogleBigQueryLinkedServiceTypeProperties": { + "description": "Google BigQuery service linked service properties.", + "properties": { + "project": { + "description": "The default BigQuery project to query against.", + "type": "object" + }, + "additionalProjects": { + "description": "A comma-separated list of public BigQuery projects to access.", + "type": "object" + }, + "requestGoogleDriveScope": { + "description": "Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false.", + "type": "object" + }, + "authenticationType": { + "description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.", + "type": "string", + "enum": [ + "ServiceAuthentication", + "UserAuthentication" + ], + "x-ms-enum": { + "name": "GoogleBigQueryAuthenticationType", + "modelAsString": true + } + }, + "refreshToken": { + "description": "The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "clientId": { + "description": "The client id of the google application used to acquire the refresh token.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "clientSecret": { + "description": "The client secret of the google application used to acquire the refresh token.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "email": { + "description": "The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.", + "type": "object" + }, + "keyFilePath": { + "description": "The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "project", + "authenticationType" + ] + }, + "GreenplumLinkedService": { + "x-ms-discriminator-value": "Greenplum", + "description": "Greenplum Database linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Greenplum Database linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GreenplumLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GreenplumLinkedServiceTypeProperties": { + "description": "Greenplum Database linked service properties.", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "HBaseLinkedService": { + "x-ms-discriminator-value": "HBase", + "description": "HBase server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "HBase server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HBaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HBaseLinkedServiceTypeProperties": { + "description": "HBase server linked service properties.", + "properties": { + "host": { + "description": "The IP address or host name of the HBase server. (i.e. 192.168.222.160)", + "type": "object" + }, + "port": { + "description": "The TCP port that the HBase instance uses to listen for client connections. The default value is 9090.", + "type": "object" + }, + "httpPath": { + "description": "The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version)", + "type": "object" + }, + "authenticationType": { + "description": "The authentication mechanism to use to connect to the HBase server.", + "type": "string", + "enum": [ + "Anonymous", + "Basic" + ], + "x-ms-enum": { + "name": "HBaseAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the HBase instance.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "HiveLinkedService": { + "x-ms-discriminator-value": "Hive", + "description": "Hive Server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Hive Server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HiveLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HiveLinkedServiceTypeProperties": { + "description": "Hive Server linked service properties.", + "properties": { + "host": { + "description": "IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).", + "type": "object" + }, + "port": { + "description": "The TCP port that the Hive server uses to listen for client connections.", + "type": "object" + }, + "serverType": { + "description": "The type of Hive server.", + "type": "string", + "enum": [ + "HiveServer1", + "HiveServer2", + "HiveThriftServer" + ], + "x-ms-enum": { + "name": "HiveServerType", + "modelAsString": true + } + }, + "thriftTransportProtocol": { + "description": "The transport protocol to use in the Thrift layer.", + "type": "string", + "enum": [ + "Binary", + "SASL", + "HTTP " + ], + "x-ms-enum": { + "name": "HiveThriftTransportProtocol", + "modelAsString": true + } + }, + "authenticationType": { + "description": "The authentication method used to access the Hive server.", + "type": "string", + "enum": [ + "Anonymous", + "Username", + "UsernameAndPassword", + "WindowsAzureHDInsightService" + ], + "x-ms-enum": { + "name": "HiveAuthenticationType", + "modelAsString": true + } + }, + "serviceDiscoveryMode": { + "description": "true to indicate using the ZooKeeper service, false not.", + "type": "object" + }, + "zooKeeperNameSpace": { + "description": "The namespace on ZooKeeper under which Hive Server 2 nodes are added.", + "type": "object" + }, + "useNativeQuery": { + "description": "Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Hive Server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the Username field", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "httpPath": { + "description": "The partial URL corresponding to the Hive server.", + "type": "object" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "HubspotLinkedService": { + "x-ms-discriminator-value": "Hubspot", + "description": "Hubspot Serivce linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Hubspot Serivce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubspotLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HubspotLinkedServiceTypeProperties": { + "description": "Hubspot Serivce linked service properties.", + "properties": { + "clientId": { + "description": "The client ID associated with your Hubspot application.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with your Hubspot application.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "accessToken": { + "description": "The access token obtained when initially authenticating your OAuth integration.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "refreshToken": { + "description": "The refresh token obtained when initially authenticating your OAuth integration.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "clientId" + ] + }, + "ImpalaLinkedService": { + "x-ms-discriminator-value": "Impala", + "description": "Impala server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Impala server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImpalaLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ImpalaLinkedServiceTypeProperties": { + "description": "Impala server linked service properties.", + "properties": { + "host": { + "description": "The IP address or host name of the Impala server. (i.e. 192.168.222.160)", + "type": "object" + }, + "port": { + "description": "The TCP port that the Impala server uses to listen for client connections. The default value is 21050.", + "type": "object" + }, + "authenticationType": { + "description": "The authentication type to use.", + "type": "string", + "enum": [ + "Anonymous", + "SASLUsername", + "UsernameAndPassword" + ], + "x-ms-enum": { + "name": "ImpalaAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to access the Impala server. The default value is anonymous when using SASLUsername.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name when using UsernameAndPassword.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "JiraLinkedService": { + "x-ms-discriminator-value": "Jira", + "description": "Jira Serivce linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Jira Serivce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/JiraLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "JiraLinkedServiceTypeProperties": { + "description": "Jira Serivce linked service properties.", + "properties": { + "host": { + "description": "The IP address or host name of the Jira service. (e.g. jira.example.com)", + "type": "object" + }, + "port": { + "description": "The TCP port that the Jira server uses to listen for client connections. The default value is 443 if connecting through HTTPS, or 8080 if connecting through HTTP.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Jira Service.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the username field.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "username" + ] + }, + "MagentoLinkedService": { + "x-ms-discriminator-value": "Magento", + "description": "Magento server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Magento server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MagentoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MagentoLinkedServiceTypeProperties": { + "description": "Magento server linked service properties.", + "properties": { + "host": { + "description": "The URL of the Magento instance. (i.e. 192.168.222.110/magento3)", + "type": "object" + }, + "accessToken": { + "description": "The access token from Magento.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host" + ] + }, + "MariaDBLinkedService": { + "x-ms-discriminator-value": "MariaDB", + "description": "MariaDB server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MariaDB server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MariaDBLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MariaDBLinkedServiceTypeProperties": { + "description": "MariaDB server linked service properties.", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "MarketoLinkedService": { + "x-ms-discriminator-value": "Marketo", + "description": "Marketo server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Marketo server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MarketoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MarketoLinkedServiceTypeProperties": { + "description": "Marketo server linked service properties.", + "properties": { + "endpoint": { + "description": "The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com)", + "type": "object" + }, + "clientId": { + "description": "The client Id of your Marketo service.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret of your Marketo service.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "clientId" + ] + }, + "PaypalLinkedService": { + "x-ms-discriminator-value": "Paypal", + "description": "Paypal Serivce linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Paypal Serivce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PaypalLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PaypalLinkedServiceTypeProperties": { + "description": "Paypal Serivce linked service properties.", + "properties": { + "host": { + "description": "The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)", + "type": "object" + }, + "clientId": { + "description": "The client ID associated with your PayPal application.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with your PayPal application.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "clientId" + ] + }, + "PhoenixLinkedService": { + "x-ms-discriminator-value": "Phoenix", + "description": "Phoenix server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Phoenix server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PhoenixLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PhoenixLinkedServiceTypeProperties": { + "description": "Phoenix server linked service properties.", + "properties": { + "host": { + "description": "The IP address or host name of the Phoenix server. (i.e. 192.168.222.160)", + "type": "object" + }, + "port": { + "description": "The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.", + "type": "object" + }, + "httpPath": { + "description": "The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.", + "type": "object" + }, + "authenticationType": { + "description": "The authentication mechanism used to connect to the Phoenix server.", + "type": "string", + "enum": [ + "Anonymous", + "UsernameAndPassword", + "WindowsAzureHDInsightService" + ], + "x-ms-enum": { + "name": "PhoenixAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the Phoenix server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "authenticationType" + ] + }, + "PrestoLinkedService": { + "x-ms-discriminator-value": "Presto", + "description": "Presto server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Presto server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrestoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PrestoLinkedServiceTypeProperties": { + "description": "Presto server linked service properties.", + "properties": { + "host": { + "description": "The IP address or host name of the Presto server. (i.e. 192.168.222.160)", + "type": "object" + }, + "serverVersion": { + "description": "The version of the Presto server. (i.e. 0.148-t)", + "type": "object" + }, + "catalog": { + "description": "The catalog context for all request against the server.", + "type": "object" + }, + "port": { + "description": "The TCP port that the Presto server uses to listen for client connections. The default value is 8080.", + "type": "object" + }, + "authenticationType": { + "description": "The authentication mechanism used to connect to the Presto server.", + "type": "string", + "enum": [ + "Anonymous", + "LDAP" + ], + "x-ms-enum": { + "name": "PrestoAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the Presto server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "timeZoneID": { + "description": "The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value is the system time zone.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "serverVersion", + "catalog", + "authenticationType" + ] + }, + "QuickBooksLinkedService": { + "x-ms-discriminator-value": "QuickBooks", + "description": "QuickBooks server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "QuickBooks server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuickBooksLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "QuickBooksLinkedServiceTypeProperties": { + "description": "QuickBooks server linked service properties.", + "properties": { + "endpoint": { + "description": "The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)", + "type": "object" + }, + "companyId": { + "description": "The company ID of the QuickBooks company to authorize.", + "type": "object" + }, + "consumerKey": { + "description": "The consumer key for OAuth 1.0 authentication.", + "type": "object" + }, + "consumerSecret": { + "description": "The consumer secret for OAuth 1.0 authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "accessToken": { + "description": "The access token for OAuth 1.0 authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "accessTokenSecret": { + "description": "The access token secret for OAuth 1.0 authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "companyId", + "consumerKey", + "consumerSecret", + "accessToken", + "accessTokenSecret" + ] + }, + "ServiceNowLinkedService": { + "x-ms-discriminator-value": "ServiceNow", + "description": "ServiceNow server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "ServiceNow server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceNowLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ServiceNowLinkedServiceTypeProperties": { + "description": "ServiceNow server linked service properties.", + "properties": { + "endpoint": { + "description": "The endpoint of the ServiceNow server. (i.e. .service-now.com)", + "type": "object" + }, + "authenticationType": { + "description": "The authentication type to use.", + "type": "string", + "enum": [ + "Basic", + "OAuth2" + ], + "x-ms-enum": { + "name": "ServiceNowAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name for Basic and OAuth2 authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "clientId": { + "description": "The client id for OAuth2 authentication.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret for OAuth2 authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "authenticationType" + ] + }, + "ShopifyLinkedService": { + "x-ms-discriminator-value": "Shopify", + "description": "Shopify Serivce linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Shopify Serivce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ShopifyLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ShopifyLinkedServiceTypeProperties": { + "description": "Shopify Serivce linked service properties.", + "properties": { + "host": { + "description": "The endpoint of the Shopify server. (i.e. mystore.myshopify.com)", + "type": "object" + }, + "accessToken": { + "description": "The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host" + ] + }, + "SparkLinkedService": { + "x-ms-discriminator-value": "Spark", + "description": "Spark Server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Spark Server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SparkLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SparkLinkedServiceTypeProperties": { + "description": "Spark Server linked service properties.", + "properties": { + "host": { + "description": "IP address or host name of the Spark server", + "type": "object" + }, + "port": { + "description": "The TCP port that the Spark server uses to listen for client connections.", + "type": "object" + }, + "serverType": { + "description": "The type of Spark server.", + "type": "string", + "enum": [ + "SharkServer", + "SharkServer2", + "SparkThriftServer" + ], + "x-ms-enum": { + "name": "SparkServerType", + "modelAsString": true + } + }, + "thriftTransportProtocol": { + "description": "The transport protocol to use in the Thrift layer.", + "type": "string", + "enum": [ + "Binary", + "SASL", + "HTTP " + ], + "x-ms-enum": { + "name": "SparkThriftTransportProtocol", + "modelAsString": true + } + }, + "authenticationType": { + "description": "The authentication method used to access the Spark server.", + "type": "string", + "enum": [ + "Anonymous", + "Username", + "UsernameAndPassword", + "WindowsAzureHDInsightService" + ], + "x-ms-enum": { + "name": "SparkAuthenticationType", + "modelAsString": true + } + }, + "username": { + "description": "The user name that you use to access Spark Server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the Username field", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "httpPath": { + "description": "The partial URL corresponding to the Spark server.", + "type": "object" + }, + "enableSsl": { + "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "allowHostNameCNMismatch": { + "description": "Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.", + "type": "object" + }, + "allowSelfSignedServerCert": { + "description": "Specifies whether to allow self-signed certificates from the server. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "port", + "authenticationType" + ] + }, + "SquareLinkedService": { + "x-ms-discriminator-value": "Square", + "description": "Square Serivce linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Square Serivce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SquareLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SquareLinkedServiceTypeProperties": { + "description": "Square Serivce linked service properties.", + "properties": { + "host": { + "description": "The URL of the Square instance. (i.e. mystore.mysquare.com)", + "type": "object" + }, + "clientId": { + "description": "The client ID associated with your Square application.", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with your Square application.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "redirectUri": { + "description": "The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)", + "type": "object" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "clientId", + "redirectUri" + ] + }, + "XeroLinkedService": { + "x-ms-discriminator-value": "Xero", + "description": "Xero Serivce linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Xero Serivce linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/XeroLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "XeroLinkedServiceTypeProperties": { + "description": "Xero Serivce linked service properties.", + "properties": { + "host": { + "description": "The endpoint of the Xero server. (i.e. api.xero.com)", + "type": "object" + }, + "consumerKey": { + "description": "The consumer key associated with the Xero application.", + "$ref": "../datafactory.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" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host" + ] + }, + "ZohoLinkedService": { + "x-ms-discriminator-value": "Zoho", + "description": "Zoho server linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Zoho server linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ZohoLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ZohoLinkedServiceTypeProperties": { + "description": "Zoho server linked service properties.", + "properties": { + "endpoint": { + "description": "The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)", + "type": "object" + }, + "accessToken": { + "description": "The access token for Zoho authentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint" + ] + }, + "VerticaLinkedService": { + "x-ms-discriminator-value": "Vertica", + "description": "Vertica linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Vertica linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/VerticaLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "VerticaLinkedServiceTypeProperties": { + "description": "Vertica linked service properties.", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "NetezzaLinkedService": { + "x-ms-discriminator-value": "Netezza", + "description": "Netezza linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Netezza linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetezzaLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "NetezzaLinkedServiceTypeProperties": { + "description": "Netezza linked service properties.", + "properties": { + "connectionString": { + "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + } + }, + "SalesforceMarketingCloudLinkedService": { + "x-ms-discriminator-value": "SalesforceMarketingCloud", + "description": "Salesforce Marketing Cloud linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce Marketing Cloud linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceMarketingCloudLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SalesforceMarketingCloudLinkedServiceTypeProperties": { + "description": "Salesforce Marketing Cloud linked service properties.", + "properties": { + "clientId": { + "description": "The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "clientId" + ] + }, + "HDInsightOnDemandLinkedService": { + "x-ms-discriminator-value": "HDInsightOnDemand", + "description": "HDInsight ondemand linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "HDInsight ondemand linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HDInsightOnDemandLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightOnDemandLinkedServiceTypeProperties": { + "description": "HDInsight ondemand linked service properties.", + "properties": { + "clusterSize": { + "type": "object", + "description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string)." + }, + "timeToLive": { + "type": "object", + "description": "The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string)." + }, + "version": { + "type": "object", + "description": "Version of the HDInsight cluster.  Type: string (or Expression with resultType string)." + }, + "linkedServiceName": { + "description": "Azure Storage linked service to be used by the on-demand cluster for storing and processing data.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "hostSubscriptionId": { + "type": "object", + "description": "The customer’s subscription to host the cluster. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The key for the service principal id.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "description": "The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "clusterResourceGroup": { + "type": "object", + "description": "The resource group where the cluster belongs. Type: string (or Expression with resultType string)." + }, + "clusterNamePrefix": { + "type": "object", + "description": "The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string)." + }, + "clusterUserName": { + "type": "object", + "description": "The username to access the cluster. Type: string (or Expression with resultType string)." + }, + "clusterPassword": { + "description": "The password to access the cluster.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "clusterSshUserName": { + "type": "object", + "description": "The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string)." + }, + "clusterSshPassword": { + "description": "The password to SSH remotely connect cluster’s node (for Linux).", + "$ref": "../datafactory.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" + } + }, + "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" + }, + "clusterType": { + "type": "object", + "description": "The cluster type. Type: string (or Expression with resultType string)." + }, + "sparkVersion": { + "type": "object", + "description": "The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string)." + }, + "coreConfiguration": { + "description": "Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.", + "type": "object" + }, + "hBaseConfiguration": { + "description": "Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "hdfsConfiguration": { + "description": "Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "hiveConfiguration": { + "description": "Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "mapReduceConfiguration": { + "description": "Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "oozieConfiguration": { + "description": "Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "stormConfiguration": { + "description": "Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "yarnConfiguration": { + "description": "Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.", + "type": "object" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "headNodeSize": { + "type": "object", + "description": "Specifies the size of the head node for the HDInsight cluster." + }, + "dataNodeSize": { + "type": "object", + "description": "Specifies the size of the data node for the HDInsight cluster." + }, + "zookeeperNodeSize": { + "type": "object", + "description": "Specifies the size of the Zoo Keeper node for the HDInsight cluster." + } + }, + "required": [ + "clusterSize", + "timeToLive", + "version", + "linkedServiceName", + "hostSubscriptionId", + "tenant", + "clusterResourceGroup" + ] + }, + "AzureDataLakeAnalyticsLinkedService": { + "x-ms-discriminator-value": "AzureDataLakeAnalytics", + "description": "Azure Data Lake Analytics linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Lake Analytics linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataLakeAnalyticsLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataLakeAnalyticsLinkedServiceTypeProperties": { + "description": "Azure Data Lake Analytics linked service properties.", + "properties": { + "accountName": { + "type": "object", + "description": "The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The Key of the application used to authenticate against the Azure Data Lake Analytics account.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "subscriptionId": { + "type": "object", + "description": "Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string)." + }, + "resourceGroupName": { + "type": "object", + "description": "Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string)." + }, + "dataLakeAnalyticsUri": { + "type": "object", + "description": "Azure Data Lake Analytics URI Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "accountName", + "tenant" + ] + }, + "AzureDatabricksLinkedService": { + "x-ms-discriminator-value": "AzureDatabricks", + "description": "Azure Databricks linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Databricks linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDatabricksLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDatabricksLinkedServiceTypeProperties": { + "description": "Azure Databricks linked service properties.", + "properties": { + "domain": { + "type": "object", + "description": ".azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string)." + }, + "accessToken": { + "description": "Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "existingClusterId": { + "type": "object", + "description": "The id of an existing cluster that will be used for all runs of this job. Type: string (or Expression with resultType string)." + }, + "newClusterVersion": { + "type": "object", + "description": "The Spark version of new cluster. Type: string (or Expression with resultType string)." + }, + "newClusterNumOfWorker": { + "type": "object", + "description": "Number of worker nodes that new cluster should have. A string formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 as min and 10 as max. Type: string (or Expression with resultType string)." + }, + "newClusterNodeType": { + "type": "object", + "description": "The node types of new cluster. Type: string (or Expression with resultType string)." + }, + "newClusterSparkConf": { + "description": "a set of optional, user-specified Spark configuration key-value pairs.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "newClusterCustomTags": { + "description": "Additional tags for cluster resources.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "domain", + "accessToken" + ] + }, + "ResponsysLinkedService": { + "x-ms-discriminator-value": "Responsys", + "description": "Responsys linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Responsys linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ResponsysLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ResponsysLinkedServiceTypeProperties": { + "description": "Responsys linked service properties.", + "properties": { + "endpoint": { + "description": "The endpoint of the Responsys server.", + "type": "object" + }, + "clientId": { + "description": "The client ID associated with the Responsys application. Type: string (or Expression with resultType string).", + "type": "object" + }, + "clientSecret": { + "description": "The client secret associated with the Responsys application. Type: string (or Expression with resultType string).", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "endpoint", + "clientId" + ] + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json new file mode 100644 index 000000000000..34a97ad47185 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -0,0 +1,3014 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2017-09-01-preview" + }, + "paths": {}, + "definitions": { + "Pipeline": { + "description": "A data factory pipeline.", + "type": "object", + "properties": { + "description": { + "description": "The description of the pipeline.", + "type": "string" + }, + "activities": { + "type": "array", + "description": "List of activities in pipeline.", + "items": { + "$ref": "#/definitions/Activity" + } + }, + "parameters": { + "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification", + "description": "List of parameters for pipeline." + }, + "concurrency": { + "type": "integer", + "minimum": 1, + "description": "The max number of concurrent runs for the pipeline." + }, + "annotations": { + "description": "List of tags that can be used for describing the Pipeline.", + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "Activity": { + "discriminator": "type", + "description": "A pipeline activity.", + "type": "object", + "properties": { + "name": { + "description": "Activity name.", + "type": "string" + }, + "type": { + "type": "string", + "description": "Type of activity." + }, + "description": { + "description": "Activity description.", + "type": "string" + }, + "dependsOn": { + "type": "array", + "description": "Activity depends on condition.", + "items": { + "$ref": "#/definitions/ActivityDependency" + } + }, + "userProperties": { + "type": "array", + "description": "Activity user properties.", + "items": { + "$ref": "#/definitions/UserProperty" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "name", + "type" + ] + }, + "UserProperty": { + "description": "User property.", + "type": "object", + "properties": { + "name": { + "description": "User proprety name.", + "type": "string" + }, + "value": { + "description": "User proprety value. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "name", + "value" + ] + }, + "ActivityDependency": { + "description": "Activity dependency information.", + "type": "object", + "properties": { + "activity": { + "description": "Activity name.", + "type": "string" + }, + "dependencyConditions": { + "type": "array", + "description": "Match-Condition for the dependency.", + "items": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Skipped", + "Completed" + ], + "x-ms-enum": { + "name": "DependencyCondition", + "modelAsString": true + } + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "activity", + "dependencyConditions" + ] + }, + "ControlActivity": { + "x-ms-discriminator-value": "Container", + "description": "Base class for all control activities like IfCondition, ForEach , Until.", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": {} + }, + "ExecutionActivity": { + "x-ms-discriminator-value": "Execution", + "description": "Base class for all execution activities.", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": { + "linkedServiceName": { + "description": "Linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "policy": { + "$ref": "#/definitions/ActivityPolicy", + "description": "Activity policy." + } + } + }, + "ActivityPolicy": { + "description": "Execution policy for an activity.", + "type": "object", + "properties": { + "timeout": { + "type": "object", + "description": "Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "retry": { + "type": "object", + "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "retryIntervalInSeconds": { + "type": "integer", + "description": "Interval between each retry attempt (in seconds). The default is 30 sec.", + "minimum": 30, + "maximum": 86400 + }, + "secureOutput": { + "type": "boolean", + "description": "When set to true, Output from activity is considered as secure and will not be logged to monitoring." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "CopyActivity": { + "x-ms-discriminator-value": "Copy", + "description": "Copy activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Copy activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CopyActivityTypeProperties" + }, + "inputs": { + "type": "array", + "description": "List of inputs for the activity.", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + }, + "outputs": { + "type": "array", + "description": "List of outputs for the activity.", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + } + }, + "required": [ + "typeProperties" + ] + }, + "CopyActivityTypeProperties": { + "description": "Copy activity properties.", + "properties": { + "source": { + "description": "Copy activity source.", + "$ref": "#/definitions/CopySource" + }, + "sink": { + "description": "Copy activity sink.", + "$ref": "#/definitions/CopySink" + }, + "translator": { + "description": "Copy activity translator. If not specificed, tabular translator is used.", + "$ref": "#/definitions/CopyTranslator" + }, + "enableStaging": { + "type": "object", + "description": "Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "stagingSettings": { + "description": "Specifies interim staging settings when EnableStaging is true.", + "$ref": "#/definitions/StagingSettings" + }, + "parallelCopies": { + "type": "object", + "description": "Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "dataIntegrationUnits": { + "type": "object", + "description": "Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "enableSkipIncompatibleRow": { + "type": "object", + "description": "Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "redirectIncompatibleRowSettings": { + "description": "Redirect incompatible row settings when EnableSkipIncompatibleRow is true.", + "$ref": "#/definitions/RedirectIncompatibleRowSettings" + } + }, + "required": [ + "source", + "sink" + ] + }, + "CopySource": { + "discriminator": "type", + "description": "A copy activity source.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy source type." + }, + "sourceRetryCount": { + "type": "object", + "description": "Source retry count. Type: integer (or Expression with resultType integer)." + }, + "sourceRetryWait": { + "type": "object", + "description": "Source retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureTableSource": { + "description": "A copy activity Azure Table source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "azureTableSourceQuery": { + "type": "object", + "description": "Azure Table source query. Type: string (or Expression with resultType string)." + }, + "azureTableSourceIgnoreTableNotFound": { + "type": "object", + "description": "Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "BlobSource": { + "description": "A copy activity Azure Blob source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "treatEmptyAsNull": { + "type": "object", + "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." + }, + "skipHeaderLineCount": { + "type": "object", + "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." + }, + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "DocumentDbCollectionSource": { + "description": "A copy activity Document Database Collection source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Documents query. Type: string (or Expression with resultType string)." + }, + "nestingSeparator": { + "type": "object", + "description": "Nested properties separator. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsSource": { + "description": "A copy activity Dynamics source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string)." + } + } + }, + "RelationalSource": { + "description": "A copy activity source for various relational databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceSource": { + "description": "A copy activity Salesforce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "readBehavior": { + "description": "The read behavior for the operation. Default is Query.", + "type": "string", + "enum": [ + "Query", + "QueryAll" + ], + "x-ms-enum": { + "name": "SalesforceSourceReadBehavior", + "modelAsString": true + } + } + } + }, + "SapCloudForCustomerSource": { + "description": "A copy activity source for SAP Cloud for Customer source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SAP Cloud for Customer OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + } + } + }, + "SapEccSource": { + "description": "A copy activity source for SAP ECC source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "string", + "description": "SAP ECC OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + } + } + }, + "SqlSource": { + "description": "A copy activity SQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + } + } + }, + "SqlDWSource": { + "description": "A copy activity SQL Data Warehouse source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL Data Warehouse reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a SQL Data Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "type": "object", + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter." + } + } + }, + "FileSystemSource": { + "description": "A copy activity file system source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "HdfsSource": { + "description": "A copy activity HDFS source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "distcpSettings": { + "description": "Specifies Distcp-related settings.", + "$ref": "#/definitions/DistcpSettings" + } + } + }, + "DistcpSettings": { + "description": "Distcp settings.", + "type": "object", + "properties": { + "resourceManagerEndpoint": { + "type": "object", + "description": "Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string)." + }, + "tempScriptPath": { + "type": "object", + "description": "Specifies an existing folder path which will be used to store temp Distcp command script. The script file is generated by ADF and will be removed after Copy job finished. Type: string (or Expression with resultType string)." + }, + "distcpOptions": { + "type": "object", + "description": "Specifies the Distcp options. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "resourceManagerEndpoint", + "tempScriptPath" + ] + }, + "AzureMySqlSource": { + "description": "A copy activity Azure MySQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "OracleSource": { + "description": "A copy activity Oracle source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "oracleReaderQuery": { + "type": "object", + "description": "Oracle reader query. Type: string (or Expression with resultType string)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "WebSource": { + "description": "A copy activity source for web page table.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": {} + }, + "CassandraSource": { + "description": "A copy activity source for a Cassandra database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string)." + }, + "consistencyLevel": { + "description": "The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is case-insensitive.", + "type": "string", + "enum": [ + "ALL", + "EACH_QUORUM", + "QUORUM", + "LOCAL_QUORUM", + "ONE", + "TWO", + "THREE", + "LOCAL_ONE", + "SERIAL", + "LOCAL_SERIAL" + ], + "x-ms-enum": { + "name": "CassandraSourceReadConsistencyLevels", + "modelAsString": true + } + } + } + }, + "MongoDbSource": { + "description": "A copy activity source for a MongoDB database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreSource": { + "description": "A copy activity Azure Data Lake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "HttpSource": { + "description": "A copy activity source for an HTTP file.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "httpRequestTimeout": { + "type": "object", + "description": "Specifies the timeout for a HTTP client to get HTTP response from HTTP server. The default value is equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "AmazonMWSSource": { + "description": "A copy activity Amazon Marketplace Web Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzurePostgreSqlSource": { + "description": "A copy activity Azure PostgreSQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ConcurSource": { + "description": "A copy activity Concur Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "CouchbaseSource": { + "description": "A copy activity Couchbase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "DrillSource": { + "description": "A copy activity Drill server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "EloquaSource": { + "description": "A copy activity Eloqua server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GoogleBigQuerySource": { + "description": "A copy activity Google BigQuery service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GreenplumSource": { + "description": "A copy activity Greenplum Database source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HBaseSource": { + "description": "A copy activity HBase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HiveSource": { + "description": "A copy activity Hive Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HubspotSource": { + "description": "A copy activity Hubspot Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ImpalaSource": { + "description": "A copy activity Impala server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "JiraSource": { + "description": "A copy activity Jira Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MagentoSource": { + "description": "A copy activity Magento server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MariaDBSource": { + "description": "A copy activity MariaDB server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MarketoSource": { + "description": "A copy activity Marketo server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PaypalSource": { + "description": "A copy activity Paypal Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PhoenixSource": { + "description": "A copy activity Phoenix server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PrestoSource": { + "description": "A copy activity Presto server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "QuickBooksSource": { + "description": "A copy activity QuickBooks server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ServiceNowSource": { + "description": "A copy activity ServiceNow server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ShopifySource": { + "description": "A copy activity Shopify Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SparkSource": { + "description": "A copy activity Spark Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SquareSource": { + "description": "A copy activity Square Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "XeroSource": { + "description": "A copy activity Xero Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ZohoSource": { + "description": "A copy activity Zoho server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "NetezzaSource": { + "description": "A copy activity Netezza source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "VerticaSource": { + "description": "A copy activity Vertica source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceMarketingCloudSource": { + "description": "A copy activity Salesforce Marketing Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ResponsysSource": { + "description": "A copy activity Responsys source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + } , + "AmazonRedshiftSource": { + "description": "A copy activity source for Amazon Redshift Source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "redshiftUnloadSettings": { + "description": "The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.", + "$ref": "#/definitions/RedshiftUnloadSettings" + } + } + }, + "RedshiftUnloadSettings": { + "description": "The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.", + "type": "object", + "properties": { + "s3LinkedServiceName": { + "description": "The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "bucketName": { + "type": "object", + "description": "The bucket of the interim Amazon S3 which will be used to store the unloaded data from Amazon Redshift source. The bucket must be in the same region as the Amazon Redshift source. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "s3LinkedServiceName", + "bucketName" + ] + }, + "StoredProcedureParameter": { + "description": "SQL stored procedure parameter.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "Stored procedure parameter value. Type: string (or Expression with resultType string)." + }, + "type": { + "description": "Stored procedure parameter type.", + "$ref": "#/definitions/StoredProcedureParameterType" + } + }, + "required": [ + "value" + ] + }, + "StoredProcedureParameterType": { + "description": "Stored procedure parameter type.", + "type": "string", + "enum": [ + "String", + "Int", + "Decimal", + "Guid", + "Boolean", + "Date" + ], + "x-ms-enum": { + "name": "StoredProcedureParameterType", + "modelAsString": true + } + }, + "CopySink": { + "discriminator": "type", + "description": "A copy activity sink.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy sink type." + }, + "writeBatchSize": { + "type": "object", + "description": "Write batch size. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "writeBatchTimeout": { + "type": "object", + "description": "Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "sinkRetryCount": { + "type": "object", + "description": "Sink retry count. Type: integer (or Expression with resultType integer)." + }, + "sinkRetryWait": { + "type": "object", + "description": "Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "SapCloudForCustomerSink": { + "description": "A copy activity SAP Cloud for Customer sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is 'Insert'.", + "type": "string", + "enum": [ + "Insert", + "Update" + ], + "x-ms-enum": { + "name": "SapCloudForCustomerSinkWriteBehavior", + "modelAsString": true + } + } + } + }, + "AzureQueueSink": { + "description": "A copy activity Azure Queue sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": {} + }, + "CopyBehaviorType": { + "description": "All available types of copy behavior.", + "type": "string", + "enum": [ + "PreserveHierarchy", + "FlattenHierarchy", + "MergeFiles" + ], + "x-ms-enum": { + "name": "CopyBehaviorType", + "modelAsString": true + } + }, + "AzureTableSink": { + "description": "A copy activity Azure Table sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "azureTableDefaultPartitionKeyValue": { + "type": "object", + "description": "Azure Table default partition key value. Type: string (or Expression with resultType string)." + }, + "azureTablePartitionKeyName": { + "type": "object", + "description": "Azure Table partition key name. Type: string (or Expression with resultType string)." + }, + "azureTableRowKeyName": { + "type": "object", + "description": "Azure Table row key name. Type: string (or Expression with resultType string)." + }, + "azureTableInsertType": { + "type": "object", + "description": "Azure Table insert type. Type: string (or Expression with resultType string)." + } + } + }, + "BlobSink": { + "description": "A copy activity Azure Blob sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "blobWriterOverwriteFiles": { + "type": "object", + "description": "Blob writer overwrite files. Type: boolean (or Expression with resultType boolean)." + }, + "blobWriterDateTimeFormat": { + "type": "object", + "description": "Blob writer date time format. Type: string (or Expression with resultType string)." + }, + "blobWriterAddHeader": { + "type": "object", + "description": "Blob writer add header. Type: boolean (or Expression with resultType boolean)." + }, + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "$ref": "#/definitions/CopyBehaviorType" + } + } + }, + "FileSystemSink": { + "description": "A copy activity file system sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "$ref": "#/definitions/CopyBehaviorType" + } + } + }, + "DocumentDbCollectionSink": { + "description": "A copy activity Document Database Collection sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "nestingSeparator": { + "type": "object", + "description": "Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string)." + } + } + }, + "SqlSink": { + "description": "A copy activity SQL sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + } + } + }, + "SqlDWSink": { + "description": "A copy activity SQL Data Warehouse sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "allowPolyBase": { + "type": "object", + "description": "Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean)." + }, + "polyBaseSettings": { + "description": "Specifies PolyBase-related settings when allowPolyBase is true.", + "$ref": "#/definitions/PolybaseSettings" + } + } + }, + "PolybaseSettings": { + "description": "PolyBase settings.", + "type": "object", + "properties": { + "rejectType": { + "$ref": "#/definitions/PolybaseSettingsRejectType", + "description": "Reject type." + }, + "rejectValue": { + "type": "object", + "description": "Specifies the value or the percentage of rows that can be rejected before the query fails. Type: number (or Expression with resultType number), minimum: 0." + }, + "rejectSampleValue": { + "type": "object", + "description": "Determines the number of rows to attempt to retrieve before the PolyBase recalculates the percentage of rejected rows. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "useTypeDefault": { + "type": "object", + "description": "Specifies how to handle missing values in delimited text files when PolyBase retrieves data from the text file. Type: boolean (or Expression with resultType boolean)." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "PolybaseSettingsRejectType": { + "description": "Indicates whether the RejectValue property is specified as a literal value or a percentage.", + "type": "string", + "enum": [ + "value", + "percentage" + ], + "x-ms-enum": { + "name": "PolybaseSettingsRejectType", + "modelAsString": true + } + }, + "StagingSettings": { + "description": "Staging settings.", + "type": "object", + "properties": { + "linkedServiceName": { + "description": "Staging linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "path": { + "type": "object", + "description": "The path to storage for storing the interim data. Type: string (or Expression with resultType string)." + }, + "enableCompression": { + "type": "object", + "description": "Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "RedirectIncompatibleRowSettings": { + "description": "Redirect incompatible row settings", + "type": "object", + "properties": { + "linkedServiceName": { + "type": "object", + "description": "Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is specified. Type: string (or Expression with resultType string)." + }, + "path": { + "type": "object", + "description": "The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "OracleSink": { + "description": "A copy activity Oracle sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreSink": { + "description": "A copy activity Azure Data Lake Store sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "$ref": "#/definitions/CopyBehaviorType" + } + } + }, + "AzureSearchIndexSink": { + "description": "A copy activity Azure Search Index sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "Specify the write behavior when upserting documents into Azure Search Index.", + "type": "string", + "enum": [ + "Merge", + "Upload" + ], + "x-ms-enum": { + "name": "AzureSearchIndexWriteBehaviorType", + "modelAsString": true + } + } + } + }, + "OdbcSink": { + "description": "A copy activity ODBC sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsSink": { + "description": "A copy activity Dynamics sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation.", + "type": "string", + "enum": [ + "Upsert" + ], + "x-ms-enum": { + "name": "DynamicsSinkWriteBehavior", + "modelAsString": true + } + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "writeBehavior" + ] + }, + "SalesforceSink": { + "description": "A copy activity Salesforce sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is Insert.", + "type": "string", + "enum": [ + "Insert", + "Upsert" + ], + "x-ms-enum": { + "name": "SalesforceSinkWriteBehavior", + "modelAsString": true + } + }, + "externalIdFieldName": { + "type": "object", + "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "CopyTranslator": { + "discriminator": "type", + "description": "A copy activity translator.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy translator type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "TabularTranslator": { + "description": "A copy activity tabular translator.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyTranslator" + } + ], + "properties": { + "columnMappings": { + "type": "object", + "description": "Column mappings. Example: \"UserId: MyUserId, Group: MyGroup, Name: MyName\" Type: string (or Expression with resultType string)." + }, + "schemaMapping": { + "type": "object", + "description": "The schema mapping to map between tabular data and hierarchical data. Example: {\"Column1\": \"$.Column1\", \"Column2\": \"$.Column2.Property1\", \"Column3\": \"$.Column2.Property2\"}. Type: object (or Expression with resultType object)." + } + } + }, + "HDInsightHiveActivity": { + "description": "HDInsight Hive activity type.", + "x-ms-discriminator-value": "HDInsightHive", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight Hive activity properties.", + "$ref": "#/definitions/HDInsightHiveActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightHiveActivityTypeProperties": { + "description": "HDInsight Hive activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "scriptPath": { + "type": "object", + "description": "Script path. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "defines": { + "description": "Allows user to specify defines for Hive job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + } + }, + "HDInsightActivityDebugInfoOption": { + "description": "The HDInsightActivityDebugInfoOption settings to use.", + "type": "string", + "enum": [ + "None", + "Always", + "Failure" + ], + "x-ms-enum": { + "name": "HDInsightActivityDebugInfoOption", + "modelAsString": true + } + }, + "HDInsightPigActivity": { + "description": "HDInsight Pig activity type.", + "x-ms-discriminator-value": "HDInsightPig", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight Pig activity properties.", + "$ref": "#/definitions/HDInsightPigActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightPigActivityTypeProperties": { + "description": "HDInsight Pig activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "scriptPath": { + "type": "object", + "description": "Script path. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "defines": { + "description": "Allows user to specify defines for Pig job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + } + }, + "HDInsightMapReduceActivity": { + "description": "HDInsight MapReduce activity type.", + "x-ms-discriminator-value": "HDInsightMapReduce", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight MapReduce activity properties.", + "$ref": "#/definitions/HDInsightMapReduceActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightMapReduceActivityTypeProperties": { + "description": "HDInsight MapReduce activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "className": { + "type": "object", + "description": "Class name. Type: string (or Expression with resultType string)." + }, + "jarFilePath": { + "type": "object", + "description": "Jar path. Type: string (or Expression with resultType string)." + }, + "jarLinkedService": { + "description": "Jar linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "jarLibs": { + "description": "Jar libs.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "defines": { + "description": "Allows user to specify defines for the MapReduce job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "className", + "jarFilePath" + ] + }, + "HDInsightStreamingActivity": { + "description": "HDInsight streaming activity type.", + "x-ms-discriminator-value": "HDInsightStreaming", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight streaming activity properties.", + "$ref": "#/definitions/HDInsightStreamingActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightStreamingActivityTypeProperties": { + "description": "HDInsight streaming activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "mapper": { + "type": "object", + "description": "Mapper executable name. Type: string (or Expression with resultType string)." + }, + "reducer": { + "type": "object", + "description": "Reducer executable name. Type: string (or Expression with resultType string)." + }, + "input": { + "type": "object", + "description": "Input blob path. Type: string (or Expression with resultType string)." + }, + "output": { + "type": "object", + "description": "Output blob path. Type: string (or Expression with resultType string)." + }, + "filePaths": { + "description": "Paths to streaming job files. Can be directories.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "fileLinkedService": { + "description": "Linked service reference where the files are located.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "combiner": { + "type": "object", + "description": "Combiner executable name. Type: string (or Expression with resultType string)." + }, + "commandEnvironment": { + "description": "Command line environment values.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "defines": { + "description": "Allows user to specify defines for streaming job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "mapper", + "reducer", + "input", + "output", + "filePaths" + ] + }, + "HDInsightSparkActivity": { + "description": "HDInsight Spark activity.", + "x-ms-discriminator-value": "HDInsightSpark", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight spark activity properties.", + "$ref": "#/definitions/HDInsightSparkActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightSparkActivityTypeProperties": { + "description": "HDInsight spark activity properties.", + "properties": { + "rootPath": { + "type": "object", + "description": "The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string)." + }, + "entryFilePath": { + "type": "object", + "description": "The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string)." + }, + "arguments": { + "description": "The user-specified arguments to HDInsightSparkActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "sparkJobLinkedService": { + "description": "The storage linked service for uploading the entry file and dependencies, and for receiving logs.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "className": { + "description": "The application's Java/Spark main class.", + "type": "string" + }, + "proxyUser": { + "type": "object", + "description": "The user to impersonate that will execute the job. Type: string (or Expression with resultType string)." + }, + "sparkConfig": { + "description": "Spark configuration property.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "rootPath", + "entryFilePath" + ] + }, + "ExecuteSSISPackageActivity": { + "description": "Execute SSIS package activity.", + "x-ms-discriminator-value": "ExecuteSSISPackage", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute SSIS package activity properties.", + "$ref": "#/definitions/ExecuteSSISPackageActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecuteSSISPackageActivityTypeProperties": { + "description": "Execute SSIS package activity properties.", + "properties": { + "packageLocation": { + "description": "SSIS package location.", + "$ref": "#/definitions/SSISPackageLocation" + }, + "runtime": { + "description": "Specifies the runtime to execute SSIS package.", + "type": "string", + "enum": [ + "x64", + "x86" + ], + "x-ms-enum": { + "name": "SSISExecutionRuntime", + "modelAsString": true + } + }, + "loggingLevel": { + "description": "The logging level of SSIS package execution.", + "type": "string" + }, + "environmentPath": { + "description": "The environment path to execute the SSIS package.", + "type": "string" + }, + "connectVia": { + "description": "The integration runtime reference.", + "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" + }, + "projectParameters": { + "description": "The project level parameters to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "packageParameters": { + "description": "The package level parameters to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "projectConnectionManagers": { + "description": "The project level connection managers to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISConnectionManager" + } + }, + "packageConnectionManagers": { + "description": "The package level connection managers to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISConnectionManager" + } + }, + "propertyOverrides": { + "description": "The property overrides to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISPropertyOverride" + } + } + }, + "required": [ + "packageLocation", + "connectVia" + ] + }, + "SSISPackageLocation": { + "description": "SSIS package location.", + "type" : "object", + "properties": { + "packagePath": { + "description": "The SSIS package path.", + "type": "string" + } + }, + "required": [ + "packagePath" + ] + }, + "SSISConnectionManager": { + "description": "SSIS Connection Manager.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "SSISExecutionParameter": { + "description": "SSIS execution parameter.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "SSIS package execution parameter value. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "value" + ] + }, + "SSISPropertyOverride": { + "description": "SSIS property override.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "SSIS package property override value. Type: string (or Expression with resultType string)." + }, + "isSensitive": { + "type": "boolean", + "description": "Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true" + } + }, + "required": [ + "value" + ] + }, + "CustomActivity": { + "description": "Custom activity type.", + "x-ms-discriminator-value": "Custom", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Custom activity properties.", + "$ref": "#/definitions/CustomActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CustomActivityTypeProperties": { + "description": "Custom activity properties.", + "properties": { + "command": { + "type": "object", + "description": "Command for custom activity Type: string (or Expression with resultType string)." + }, + "resourceLinkedService": { + "description": "Resource linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "folderPath": { + "type": "object", + "description": "Folder path for resource files Type: string (or Expression with resultType string)." + }, + "referenceObjects": { + "description": "Reference objects", + "$ref": "#/definitions/CustomActivityReferenceObject" + }, + "extendedProperties": { + "description": "User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "command" + ] + }, + "CustomActivityReferenceObject": { + "description": "Reference objects for custom activity", + "properties": { + "linkedServices": { + "description": "Linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "datasets": { + "description": "Dataset references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + } + } + }, + "SqlServerStoredProcedureActivity": { + "description": "SQL stored procedure activity type.", + "x-ms-discriminator-value": "SqlServerStoredProcedure", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "SQL stored procedure activity properties.", + "$ref": "#/definitions/SqlServerStoredProcedureActivityTypeProperties" + } + }, + "required": [ + "typeProperties", + "linkedServiceName" + ] + }, + "SqlServerStoredProcedureActivityTypeProperties": { + "description": "SQL stored procedure activity properties.", + "properties": { + "storedProcedureName": { + "type": "object", + "description": "Stored procedure name. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + } + }, + "required": [ + "storedProcedureName" + ] + }, + "ExecutePipelineActivity": { + "x-ms-discriminator-value": "ExecutePipeline", + "description": "Execute pipeline activity.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Execute pipeline activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExecutePipelineActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecutePipelineActivityTypeProperties": { + "description": "Execute pipeline activity properties.", + "properties": { + "pipeline": { + "description": "Pipeline reference.", + "$ref": "../datafactory.json#/definitions/PipelineReference" + }, + "parameters": { + "description": "Pipeline parameters.", + "$ref": "../datafactory.json#/definitions/ParameterValueSpecification" + }, + "waitOnCompletion": { + "description": "Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.", + "type": "boolean" + } + }, + "required": [ + "pipeline" + ] + }, + "LookupActivity": { + "x-ms-discriminator-value": "Lookup", + "description": "Lookup activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Lookup activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LookupActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "LookupActivityTypeProperties": { + "description": "Lookup activity properties.", + "properties": { + "source": { + "description": "Dataset-specific source properties, same as copy activity source.", + "$ref": "#/definitions/CopySource" + }, + "dataset": { + "description": "Lookup activity dataset reference.", + "$ref": "../datafactory.json#/definitions/DatasetReference" + }, + "firstRowOnly": { + "type": "object", + "description": "Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "source", + "dataset" + ] + }, + "WebActivityMethod": { + "description": "The list of HTTP methods supported by a WebActivity.", + "type": "string", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE" + ], + "x-ms-enum": { + "name": "WebActivityMethod", + "modelAsString": true + } + }, + "WebActivity": { + "x-ms-discriminator-value": "WebActivity", + "description": "Web activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Web activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebActivityAuthentication": { + "description": "Web activity authentication properties.", + "properties": { + "type": { + "description": "Web activity authentication (Basic/ClientCertificate/MSI)", + "type": "string" + }, + "pfx": { + "description": "Base64-encoded contents of a PFX file.", + "$ref": "../datafactory.json#/definitions/SecureString" + }, + "username": { + "description": "Web activity authentication user name for basic authentication.", + "type": "string" + }, + "password": { + "description": "Password for the PFX file or basic authentication.", + "$ref": "../datafactory.json#/definitions/SecureString" + }, + "resource": { + "description": "Resource for which Azure Auth token will be requested when using MSI Authentication.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "WebActivityTypeProperties": { + "description": "Web activity type properties.", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/WebActivityMethod" + }, + "url": { + "type": "object", + "description": "Web activity target endpoint and path. Type: string (or Expression with resultType string)." + }, + "headers": { + "type": "object", + "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string)." + }, + "body": { + "type": "object", + "description": "Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string)." + }, + "authentication": { + "description": "Authentication method used for calling the endpoint.", + "$ref": "#/definitions/WebActivityAuthentication" + }, + "datasets": { + "type": "array", + "description": "List of datasets passed to web endpoint.", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + }, + "linkedServices": { + "type": "array", + "description": "List of linked services passed to web endpoint.", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + } + }, + "required": [ + "method", + "url" + ] + }, + "GetMetadataActivity": { + "x-ms-discriminator-value": "GetMetadata", + "description": "Activity to get metadata of dataset", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "GetMetadata activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GetMetadataActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GetMetadataActivityTypeProperties": { + "description": "GetMetadata activity properties.", + "properties": { + "dataset": { + "description": "GetMetadata activity dataset reference.", + "$ref": "../datafactory.json#/definitions/DatasetReference" + }, + "fieldList": { + "description": "Fields of metadata to get from dataset.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "dataset" + ] + }, + "IfConditionActivity": { + "x-ms-discriminator-value": "IfCondition", + "description": "This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "IfCondition activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/IfConditionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "IfConditionActivityTypeProperties": { + "description": "IfCondition activity properties.", + "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" + }, + "ifTrueActivities": { + "type": "array", + "description": "List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action.", + "items": { + "$ref": "#/definitions/Activity" + } + }, + "ifFalseActivities": { + "type": "array", + "description": "List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "expression" + ] + }, + "ForEachActivity": { + "x-ms-discriminator-value": "ForEach", + "description": "This activity is used for iterating over a collection and execute given activities.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "ForEach activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ForEachActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ForEachActivityTypeProperties": { + "description": "ForEach activity properties.", + "properties": { + "isSequential": { + "description": "Should the loop be executed in sequence or in parallel (max 50)", + "type": "boolean" + }, + "batchCount": { + "description": "Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).", + "type": "integer", + "maximum": 50 + }, + "items": { + "description": "Collection to iterate.", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "activities": { + "type": "array", + "description": "List of activities to execute .", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "items", + "activities" + ] + }, + "AzureMLBatchExecutionActivity": { + "description": "Azure ML Batch Execution activity.", + "x-ms-discriminator-value": "AzureMLBatchExecution", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Batch Execution activity properties.", + "$ref": "#/definitions/AzureMLBatchExecutionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLBatchExecutionActivityTypeProperties": { + "description": "Azure ML Batch Execution activity properties.", + "properties": { + "globalParameters": { + "description": "Key,Value pairs to be passed to the Azure ML Batch Execution Service endpoint. Keys must match the names of web service parameters defined in the published Azure ML web service. Values will be passed in the GlobalParameters property of the Azure ML batch execution request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "webServiceOutputs": { + "description": "Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile objects specifying the output Blob locations. This information will be passed in the WebServiceOutputs property of the Azure ML batch execution request.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AzureMLWebServiceFile" + } + }, + "webServiceInputs": { + "description": "Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. This information will be passed in the WebServiceInputs property of the Azure ML batch execution request.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AzureMLWebServiceFile" + } + } + } + }, + "AzureMLWebServiceFile": { + "description": "Azure ML WebService Input/Output file", + "type": "object", + "properties": { + "filePath": { + "type": "object", + "description": "The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string)." + }, + "linkedServiceName": { + "description": "Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "required": [ + "linkedServiceName", + "filePath" + ] + }, + "AzureMLUpdateResourceActivity": { + "description": "Azure ML Update Resource management activity.", + "x-ms-discriminator-value": "AzureMLUpdateResource", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Update Resource management activity properties.", + "$ref": "#/definitions/AzureMLUpdateResourceActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLUpdateResourceActivityTypeProperties": { + "description": "Azure ML Update Resource activity properties.", + "properties": { + "trainedModelName": { + "type": "object", + "description": "Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string)." + }, + "trainedModelLinkedServiceName": { + "description": "Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "trainedModelFilePath": { + "type": "object", + "description": "The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "trainedModelName", + "trainedModelLinkedServiceName", + "trainedModelFilePath" + ] + }, + "DataLakeAnalyticsUSQLActivity": { + "description": "Data Lake Analytics U-SQL activity.", + "x-ms-discriminator-value": "DataLakeAnalyticsU-SQL", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Data Lake Analytics U-SQL activity properties.", + "$ref": "#/definitions/DataLakeAnalyticsUSQLActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DataLakeAnalyticsUSQLActivityTypeProperties": { + "description": "DataLakeAnalyticsU-SQL activity properties.", + "properties": { + "scriptPath": { + "type": "object", + "description": "Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "degreeOfParallelism": { + "type": "object", + "description": "The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1." + }, + "priority": { + "type": "object", + "description": "Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1." + }, + "parameters": { + "description": "Parameters for U-SQL job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "runtimeVersion": { + "type": "object", + "description": "Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string)." + }, + "compilationMode": { + "type": "object", + "description": "Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "scriptPath", + "scriptLinkedService" + ] + }, + "WaitActivity": { + "x-ms-discriminator-value": "Wait", + "description": "This activity suspends pipeline execution for the specified interval.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Wait activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WaitActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WaitActivityTypeProperties": { + "description": "Wait activity properties.", + "properties": { + "waitTimeInSeconds": { + "description": "Duration in seconds.", + "type": "integer" + } + }, + "required": [ + "waitTimeInSeconds" + ] + }, + "UntilActivity": { + "x-ms-discriminator-value": "Until", + "description": "This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Until activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/UntilActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "UntilActivityTypeProperties": { + "description": "Until activity properties.", + "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" + }, + "timeout": { + "type": "object", + "description": "Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "activities": { + "type": "array", + "description": "List of activities to execute.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "expression", + "activities" + ] + }, + "FilterActivity": { + "x-ms-discriminator-value": "Filter", + "description": "Filter and return results from input array based on the conditions.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Filter activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FilterActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "FilterActivityTypeProperties": { + "description": "Fitler activity properties.", + "properties": { + "items": { + "description": "Input array on which filter should be applied.", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "condition": { + "description": "Condition to be used for filtering the input.", + "$ref": "../datafactory.json#/definitions/Expression" + } + }, + "required": [ + "condition", + "items" + ] + }, + "DatabricksNotebookActivity": { + "description": "DatabricksNotebook activity.", + "x-ms-discriminator-value": "DatabricksNotebook", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks Notebook activity properties.", + "$ref": "#/definitions/DatabricksNotebookActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksNotebookActivityTypeProperties": { + "description": "Databricks Notebook activity properties.", + "properties": { + "notebookPath": { + "type": "object", + "description": "The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string)." + }, + "baseParameters": { + "description": "Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", + "additionalProperties": { + "type": "object" + } + } + } + }, + "required": [ + "notebookPath" + ] + }, + "DatabricksSparkJarActivity": { + "description": "DatabricksSparkJar activity.", + "x-ms-discriminator-value": "DatabricksSparkJar", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks SparkJar activity properties.", + "$ref": "#/definitions/DatabricksSparkJarActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksSparkJarActivityTypeProperties": { + "description": "Databricks SparkJar activity properties.", + "properties": { + "mainClassName": { + "type": "object", + "description": "The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. Type: string (or Expression with resultType string)." + }, + "parameters": { + "description": "Parameters that will be passed to the main method.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", + "additionalProperties": { + "type": "object" + } + } + } + }, + "required": [ + "mainClassName" + ] + }, + "DatabricksSparkPythonActivity": { + "description": "DatabricksSparkPython activity.", + "x-ms-discriminator-value": "DatabricksSparkPython", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks SparkPython activity properties.", + "$ref": "#/definitions/DatabricksSparkPythonActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksSparkPythonActivityTypeProperties": { + "description": "Databricks SparkPython activity properties.", + "properties": { + "pythonFile": { + "type": "object", + "description": "The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string)." + }, + "parameters": { + "description": "Command line parameters that will be passed to the Python file.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "libraries": { + "description": "A list of libraries to be installed on the cluster that will execute the job.", + "type": "array", + "items": { + "type": "object", + "description": "Databricks library definition.", + "additionalProperties": { + "type": "object" + } + } + } + }, + "required": [ + "pythonFile" + ] + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json new file mode 100644 index 000000000000..eed541ff50d3 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json @@ -0,0 +1,427 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2017-09-01-preview" + }, + "paths": {}, + "definitions": { + "Trigger": { + "description": "Azure data factory nested object which contains information about creating pipeline run", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Trigger type." + }, + "description": { + "description": "Trigger description.", + "type": "string" + }, + "runtimeState": { + "$ref": "#/definitions/TriggerRuntimeState", + "description": "Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger.", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "TriggerRuntimeState": { + "type": "string", + "description": "Enumerates possible state of Triggers.", + "enum": [ + "Started", + "Stopped", + "Disabled" + ], + "x-ms-enum": { + "name": "TriggerRuntimeState", + "modelAsString": true + } + }, + "MultiplePipelineTrigger": { + "x-ms-discriminator-value": "MultiplePipelineTrigger", + "description": "Base class for all triggers that support one to many model for trigger to pipeline.", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "pipelines": { + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/TriggerPipelineReference" + }, + "description": "Pipelines that need to be started." + } + } + }, + "ScheduleTrigger": { + "description": "Trigger that creates pipeline runs periodically, on schedule.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": { + "description": "Schedule Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "recurrence": { + "$ref": "#/definitions/ScheduleTriggerRecurrence", + "description": "Recurrence schedule configuration." + } + }, + "required": [ + "recurrence" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "ScheduleTriggerRecurrence": { + "type": "object", + "properties": { + "frequency": { + "$ref": "#/definitions/RecurrenceFrequency", + "description": "The frequency." + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time." + }, + "timeZone": { + "type": "string", + "description": "The time zone." + }, + "schedule": { + "$ref": "#/definitions/RecurrenceSchedule", + "description": "The recurrence schedule." + } + }, + "additionalProperties": { + "type": "object" + }, + "description": "The workflow trigger recurrence." + }, + "RecurrenceFrequency": { + "description": "Enumerates possible frequency option for the schedule trigger.", + "type": "string", + "enum": [ + "NotSpecified", + "Minute", + "Hour", + "Day", + "Week", + "Month", + "Year" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": true + } + }, + "RecurrenceSchedule": { + "type": "object", + "properties": { + "minutes": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The minutes." + }, + "hours": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The hours." + }, + "weekDays": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DaysOfWeek", + "modelAsString": false + } + }, + "description": "The days of the week." + }, + "monthDays": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The month days." + }, + "monthlyOccurrences": { + "type": "array", + "items": { + "$ref": "#/definitions/RecurrenceScheduleOccurrence" + }, + "description": "The monthly occurrences." + } + }, + "additionalProperties": { + "type": "object" + }, + "description": "The recurrence schedule." + }, + "RecurrenceScheduleOccurrence": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/DayOfWeek", + "description": "The day of the week." + }, + "occurrence": { + "type": "integer", + "format": "int32", + "description": "The occurrence." + } + }, + "additionalProperties": { + "type": "object" + }, + "description": "The recurrence schedule occurence." + }, + "DayOfWeek": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + }, + "description": "The days of the week." + }, + "BlobTrigger": { + "description": "Trigger that runs everytime the selected Blob container changes.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": { + "description": "Blob Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "folderPath": { + "description": "The path of the container/folder that will trigger the pipeline.", + "type": "string" + }, + "maxConcurrency": { + "description": "The max number of parallel files to handle when it is triggered.", + "type": "integer" + }, + "linkedService": { + "description": "The Azure Storage linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "required": [ + "folderPath", + "maxConcurrency", + "linkedService" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "BlobEventsTrigger": + { + "description": "Trigger that runs everytime a Blob event occurs.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": + { + "description": "Blob Events Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "blobPathBeginsWith": { + "description": "The blob path must begin with the pattern provided for trigger to fire. For example, '/records/blobs/december/' will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.", + "type": "string" + }, + "blobPathEndsWith": { + "description": "The blob path must end with the pattern provided for trigger to fire. For example, 'december/boxes.csv' will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.", + "type": "string" + }, + "events": { + "description": "The type of events that cause this trigger to fire.", + "$ref": "#/definitions/BlobEventTypes" + }, + "scope": { + "description": "The ARM resource ID of the Storage Account.", + "type": "string" + } + }, + "required": [ + "events", + "scope" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "BlobEventTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Microsoft.Storage.BlobCreated", + "Microsoft.Storage.BlobDeleted" + ], + "x-ms-enum": { + "name": "BlobEventTypes", + "modelAsString": true + } + }, + "description": "Blob event types." + }, + "TumblingWindowTrigger": { + "description": "Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "pipeline": { + "$ref": "../datafactory.json#/definitions/TriggerPipelineReference", + "description": "Pipeline for which runs are created when an event is fired for trigger window that is ready." + }, + "typeProperties": { + "description": "Tumbling Window Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "frequency": { + "$ref": "#/definitions/TumblingWindowFrequency", + "description": "The frequency of the time windows." + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval of the time windows. The minimum interval allowed is 15 Minutes." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported." + }, + "delay": { + "type": "object", + "description": "Specifies how long the trigger waits past due time before triggering new run. It doesn't alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "maxConcurrency": { + "description": "The max number of parallel time windows (ready for execution) for which a new run is triggered.", + "type": "integer", + "minimum": 1, + "maximum": 50 + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Retry policy that will be applied for failed pipeline runs." + } + }, + "required": [ + "frequency", + "interval", + "startTime", + "maxConcurrency" + ] + } + }, + "required": [ + "pipeline", + "typeProperties" + ] + }, + "TumblingWindowFrequency": { + "description": "Enumerates possible frequency option for the tumbling window trigger.", + "type": "string", + "enum": [ + "Minute", + "Hour" + ], + "x-ms-enum": { + "name": "TumblingWindowFrequency", + "modelAsString": true + } + }, + "RetryPolicy": { + "description": "Execution policy for an activity.", + "properties": { + "count": { + "type": "object", + "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "intervalInSeconds": { + "description": "Interval between retries in seconds. Default is 30.", + "type": "integer", + "minimum": 30, + "maximum": 86400 + } + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ActivityRuns_QueryByPipelineRun.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ActivityRuns_QueryByPipelineRun.json new file mode 100644 index 000000000000..fe9db3793a6a --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ActivityRuns_QueryByPipelineRun.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "filterParameters": { + "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z", + "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z" + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:13 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1187", + "x-ms-request-id": "5465cf41-2e71-4ce6-8db4-9de1b92ffda9", + "x-ms-correlation-request-id": "5465cf41-2e71-4ce6-8db4-9de1b92ffda9" + }, + "body": { + "value": [ + { + "activityRunEnd": "2018-06-16T00:38:11.5445431Z", + "activityName": "ExampleForeachActivity", + "activityRunStart": "2018-06-16T00:37:49.4804925Z", + "activityType": "ForEach", + "durationInMs": 22064, + "retryAttempt": null, + "error": { + "errorCode": "", + "message": "", + "failureType": "", + "target": "ExampleForeachActivity" + }, + "activityRunId": "f30c5514-fb85-43ed-9fa4-768d42e58680", + "input": {}, + "linkedServiceName": "", + "output": {}, + "userProperties": {}, + "pipelineName": "examplePipeline", + "pipelineRunId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "status": "Succeeded" + }, + { + "activityRunEnd": "2018-06-16T00:38:07.4188923Z", + "activityName": "ExampleCopyActivity", + "activityRunStart": "2018-06-16T00:37:50.2460952Z", + "activityType": "Copy", + "durationInMs": 17172, + "retryAttempt": null, + "error": { + "errorCode": "", + "message": "", + "failureType": "", + "target": "ExampleCopyActivity" + }, + "activityRunId": "a96678c8-7167-4f00-b629-afccfbad4e51", + "input": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "linkedServiceName": "", + "output": { + "dataRead": 142000, + "dataWritten": 142000, + "filesRead": 1, + "filesWritten": 1, + "copyDuration": 6, + "throughput": 23.112, + "errors": [], + "effectiveIntegrationRuntime": "DefaultIntegrationRuntime (East US)", + "usedCloudDataMovementUnits": 4, + "usedParallelCopies": 1, + "executionDetails": [ + { + "source": { + "type": "AzureBlob" + }, + "sink": { + "type": "AzureBlob" + }, + "status": "Succeeded", + "start": "2018-06-16T00:37:50.68834Z", + "duration": 6, + "usedCloudDataMovementUnits": 4, + "usedParallelCopies": 1, + "detailedDurations": { + "queuingDuration": 4, + "transferDuration": 2 + } + } + ] + }, + "userProperties": {}, + "pipelineName": "examplePipeline", + "pipelineRunId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "status": "Succeeded" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_Create.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_Create.json new file mode 100644 index 000000000000..fb0244650aa1 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_Create.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "datasetName": "exampleDataset", + "ifMatch": null, + "dataset": { + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + } + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:38 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0", + "x-ms-correlation-request-id": "ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", + "name": "exampleDataset", + "type": "Microsoft.DataFactory/factories/datasets", + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "0a0066d4-0000-0000-0000-5b245bd20000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_Delete.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_Delete.json new file mode 100644 index 000000000000..c6053fe39891 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_Delete.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "datasetName": "exampleDataset", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:28 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-deletes": "14995", + "x-ms-request-id": "586c27ed-d96c-42eb-8336-a077ef7e8358", + "x-ms-correlation-request-id": "586c27ed-d96c-42eb-8336-a077ef7e8358" + }, + "body": null + }, + "204": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:28 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-deletes": "14994", + "x-ms-request-id": "18f08a60-3963-4a85-9db9-5122fad759ae", + "x-ms-correlation-request-id": "18f08a60-3963-4a85-9db9-5122fad759ae" + }, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_Get.json new file mode 100644 index 000000000000..90ecfb7b3b95 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "datasetName": "exampleDataset", + "ifNoneMatch": null, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:40 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14993", + "x-ms-request-id": "19ef529d-6aac-4997-a6af-87cdc02e88c5", + "x-ms-correlation-request-id": "19ef529d-6aac-4997-a6af-87cdc02e88c5" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", + "name": "exampleDataset", + "type": "Microsoft.DataFactory/factories/datasets", + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "0a0068d4-0000-0000-0000-5b245bd30000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_ListByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_ListByFactory.json new file mode 100644 index 000000000000..62f89924db05 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_ListByFactory.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:40 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14992", + "x-ms-request-id": "341c9ece-5062-448b-be98-3ccbf476ed5d", + "x-ms-correlation-request-id": "341c9ece-5062-448b-be98-3ccbf476ed5d" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", + "name": "exampleDataset", + "type": "Microsoft.DataFactory/factories/datasets", + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "0a0068d4-0000-0000-0000-5b245bd30000" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_Update.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_Update.json new file mode 100644 index 000000000000..ca71bc4482ba --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Datasets_Update.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "datasetName": "exampleDataset", + "ifMatch": null, + "dataset": { + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + } + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:39 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1193", + "x-ms-request-id": "e2e7f6be-e7ee-4aae-943f-6ff799e034f2", + "x-ms-correlation-request-id": "e2e7f6be-e7ee-4aae-943f-6ff799e034f2" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", + "name": "exampleDataset", + "type": "Microsoft.DataFactory/factories/datasets", + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "0a0068d4-0000-0000-0000-5b245bd30000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_ConfigureFactoryRepo.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_ConfigureFactoryRepo.json new file mode 100644 index 000000000000..b6f8fd06a9a7 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_ConfigureFactoryRepo.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "locationId": "East US", + "factoryRepoUpdate": { + "factoryResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", + "repoConfiguration": { + "type": "FactoryVSTSConfiguration", + "projectName": "project", + "tenantId": "", + "accountName": "ADF", + "repositoryName": "repo", + "collaborationBranch": "master", + "rootFolder": "/", + "lastCommitId": "" + } + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 19 Jun 2018 05:41:50 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1191", + "x-ms-request-id": "c63640bd-3e5f-4ee0-bae1-cea74f761a7d", + "x-ms-correlation-request-id": "c63640bd-3e5f-4ee0-bae1-cea74f761a7d" + }, + "body": { + "name": "exampleFactoryName", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-19T05:41:50.0041314Z", + "version": "2018-06-01", + "repoConfiguration": { + "type": "FactoryVSTSConfiguration", + "projectName": "project", + "tenantId": "", + "accountName": "ADF", + "repositoryName": "repo", + "collaborationBranch": "master", + "rootFolder": "/", + "lastCommitId": "" + } + }, + "eTag": "\"00004004-0000-0000-0000-5b28979e0000\"", + "location": "East US", + "tags": { + "exampleTag": "exampleValue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_CreateOrUpdate.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_CreateOrUpdate.json new file mode 100644 index 000000000000..83401598c21a --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_CreateOrUpdate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "factory": { + "location": "East US" + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 19 Jun 2018 05:41:50 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1193", + "x-ms-request-id": "657028b7-5e63-4d7c-b8e7-cb336ed92ff0", + "x-ms-correlation-request-id": "657028b7-5e63-4d7c-b8e7-cb336ed92ff0" + }, + "body": { + "name": "exampleFactoryName", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-19T05:41:50.0041314Z", + "version": "2018-06-01" + }, + "eTag": "\"00003e04-0000-0000-0000-5b28979e0000\"", + "location": "East US", + "tags": {} + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Delete.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Delete.json new file mode 100644 index 000000000000..1e8e7b08ecb6 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Delete.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:32 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-deletes": "14989", + "x-ms-request-id": "ea0cf989-0831-4d49-84a8-9732da344b72", + "x-ms-correlation-request-id": "ea0cf989-0831-4d49-84a8-9732da344b72" + }, + "body": null + }, + "204": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:32 GMT", + "x-ms-ratelimit-remaining-subscription-deletes": "14988", + "x-ms-request-id": "3bf2d00f-7f37-4ab0-96c4-9ae560bc1f64", + "x-ms-correlation-request-id": "3bf2d00f-7f37-4ab0-96c4-9ae560bc1f64", + "X-Content-Type-Options": "nosniff" + }, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Get.json new file mode 100644 index 000000000000..5ce72adc6147 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 19 Jun 2018 05:41:50 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14994", + "x-ms-request-id": "d84e59aa-718c-4b1a-951c-076ffff766c8", + "x-ms-correlation-request-id": "d84e59aa-718c-4b1a-951c-076ffff766c8" + }, + "body": { + "name": "exampleFactoryName", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-19T05:41:50.0041314Z", + "version": "2018-06-01", + "repoConfiguration": { + "type": "FactoryVSTSConfiguration", + "projectName": "project", + "tenantId": "", + "accountName": "ADF", + "repositoryName": "repo", + "collaborationBranch": "master", + "rootFolder": "/", + "lastCommitId": "" + } + }, + "eTag": "\"00004004-0000-0000-0000-5b28979e0000\"", + "location": "East US", + "tags": { + "exampleTag": "exampleValue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_List.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_List.json new file mode 100644 index 000000000000..f6bbd4f3b09f --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_List.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 19 Jun 2018 05:41:51 GMT", + "x-ms-ratelimit-remaining-subscription-reads": "14992", + "x-ms-request-id": "533da6af-ad1a-4f89-ae04-d55e9c72b89d", + "x-ms-correlation-request-id": "533da6af-ad1a-4f89-ae04-d55e9c72b89d", + "X-Content-Type-Options": "nosniff" + }, + "body": { + "value": [ + { + "name": "rpV2OrigDF-72c7d3d4-5e17-4ec6-91de-9ab433f15e79", + "identity": { + "type": "SystemAssigned", + "principalId": "399c3de2-6072-4326-bfa9-4d0c116f1a7b", + "tenantId": "12345678-1234-1234-1234-123456789abc" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/rg-yanzhang-dfv2/providers/Microsoft.DataFactory/factories/rpv2origdf-72c7d3d4-5e17-4ec6-91de-9ab433f15e79", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-05-29T13:39:35.615921Z", + "version": "2017-09-01-preview" + }, + "eTag": "\"0000aa0d-0000-0000-0000-5b0d58170000\"", + "location": "East US", + "tags": {} + }, + { + "name": "df-dogfood-yanzhang-we", + "identity": { + "type": "SystemAssigned", + "principalId": "e8dd6df9-bad5-4dea-8fb8-0d13d1845d9e", + "tenantId": "12345678-1234-1234-1234-123456789abc" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/rg-yanzhang-dfv2/providers/Microsoft.DataFactory/factories/df-dogfood-yanzhang-we", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-14T00:06:04.6667461Z", + "version": "2017-09-01-preview" + }, + "eTag": "\"0000f301-0000-0000-0000-5b21b16c0000\"", + "location": "West Europe", + "tags": {} + }, + { + "name": "exampleFactoryName-linked", + "identity": { + "type": "SystemAssigned", + "principalId": "10743799-44d2-42fe-8c4d-5bc5c51c0684", + "tenantId": "12345678-1234-1234-1234-123456789abc" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName-linked", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-15T08:56:07.1828318Z", + "version": "2017-09-01-preview" + }, + "eTag": "\"00008a02-0000-0000-0000-5b237f270000\"", + "location": "East US", + "tags": {} + }, + { + "name": "FactoryToUpgrade", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/factorytoupgrade", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-19T05:35:35.7133828Z", + "version": "2018-06-01" + }, + "eTag": "\"00003d04-0000-0000-0000-5b28962f0000\"", + "location": "East US", + "tags": {} + }, + { + "name": "exampleFactoryName", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-19T05:41:50.0041314Z", + "version": "2018-06-01", + "repoConfiguration": { + "type": "FactoryVSTSConfiguration", + "projectName": "project", + "tenantId": "", + "accountName": "ADF", + "repositoryName": "repo", + "collaborationBranch": "master", + "rootFolder": "/", + "lastCommitId": "" + } + }, + "eTag": "\"00004004-0000-0000-0000-5b28979e0000\"", + "location": "East US", + "tags": { + "exampleTag": "exampleValue" + } + }, + { + "name": "rpV2OrigDF-72c7d3d4-5e17-4ec6-91de-9ab433f15e79", + "identity": { + "type": "SystemAssigned", + "principalId": "399c3de2-6072-4326-bfa9-4d0c116f1a7b", + "tenantId": "12345678-1234-1234-1234-123456789abc" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/rg-yanzhang-dfv2/providers/Microsoft.DataFactory/factories/rpv2origdf-72c7d3d4-5e17-4ec6-91de-9ab433f15e79", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-05-29T13:39:35.615921Z", + "version": "2017-09-01-preview" + }, + "eTag": "\"0000aa0d-0000-0000-0000-5b0d58170000\"", + "location": "East US", + "tags": {} + }, + { + "name": "df-dogfood-yanzhang-we", + "identity": { + "type": "SystemAssigned", + "principalId": "e8dd6df9-bad5-4dea-8fb8-0d13d1845d9e", + "tenantId": "12345678-1234-1234-1234-123456789abc" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/rg-yanzhang-dfv2/providers/Microsoft.DataFactory/factories/df-dogfood-yanzhang-we", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-14T00:06:04.6667461Z", + "version": "2017-09-01-preview" + }, + "eTag": "\"0000f301-0000-0000-0000-5b21b16c0000\"", + "location": "West Europe", + "tags": {} + }, + { + "name": "exampleFactoryName-linked", + "identity": { + "type": "SystemAssigned", + "principalId": "10743799-44d2-42fe-8c4d-5bc5c51c0684", + "tenantId": "12345678-1234-1234-1234-123456789abc" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName-linked", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-15T08:56:07.1828318Z", + "version": "2017-09-01-preview" + }, + "eTag": "\"00008a02-0000-0000-0000-5b237f270000\"", + "location": "East US", + "tags": {} + }, + { + "name": "FactoryToUpgrade", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/factorytoupgrade", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-19T05:35:35.7133828Z", + "version": "2018-06-01" + }, + "eTag": "\"00003d04-0000-0000-0000-5b28962f0000\"", + "location": "East US", + "tags": {} + }, + { + "name": "exampleFactoryName", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-19T05:41:50.0041314Z", + "version": "2018-06-01", + "repoConfiguration": { + "type": "FactoryVSTSConfiguration", + "projectName": "project", + "tenantId": "", + "accountName": "ADF", + "repositoryName": "repo", + "collaborationBranch": "master", + "rootFolder": "/", + "lastCommitId": "" + } + }, + "eTag": "\"00004004-0000-0000-0000-5b28979e0000\"", + "location": "East US", + "tags": { + "exampleTag": "exampleValue" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_ListByResourceGroup.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_ListByResourceGroup.json new file mode 100644 index 000000000000..2aadecb3999c --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_ListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 19 Jun 2018 05:41:51 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14993", + "x-ms-request-id": "f9c976e7-4205-4cfc-833e-e5d50565fcef", + "x-ms-correlation-request-id": "f9c976e7-4205-4cfc-833e-e5d50565fcef" + }, + "body": { + "value": [ + { + "name": "exampleFactoryName-linked", + "identity": { + "type": "SystemAssigned", + "principalId": "10743799-44d2-42fe-8c4d-5bc5c51c0684", + "tenantId": "12345678-1234-1234-1234-123456789abc" + }, + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName-linked", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-15T08:56:07.1828318Z", + "version": "2017-09-01-preview" + }, + "eTag": "\"00008a02-0000-0000-0000-5b237f270000\"", + "location": "East US", + "tags": {} + }, + { + "name": "FactoryToUpgrade", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/factorytoupgrade", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-19T05:35:35.7133828Z", + "version": "2018-06-01" + }, + "eTag": "\"00003d04-0000-0000-0000-5b28962f0000\"", + "location": "East US", + "tags": {} + }, + { + "name": "exampleFactoryName", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-19T05:41:50.0041314Z", + "version": "2018-06-01", + "repoConfiguration": { + "type": "FactoryVSTSConfiguration", + "projectName": "project", + "tenantId": "", + "accountName": "ADF", + "repositoryName": "repo", + "collaborationBranch": "master", + "rootFolder": "/", + "lastCommitId": "" + } + }, + "eTag": "\"00004004-0000-0000-0000-5b28979e0000\"", + "location": "East US", + "tags": { + "exampleTag": "exampleValue" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Update.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Update.json new file mode 100644 index 000000000000..0ca66d871fbb --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Update.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "factoryUpdateParameters": { + "tags": { + "exampleTag": "exampleValue" + } + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 19 Jun 2018 05:41:50 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "699c67a6-fef5-40c9-bc73-d571d09783c3", + "x-ms-correlation-request-id": "699c67a6-fef5-40c9-bc73-d571d09783c3" + }, + "body": { + "name": "exampleFactoryName", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", + "type": "Microsoft.DataFactory/factories", + "properties": { + "provisioningState": "Succeeded", + "createTime": "2018-06-19T05:41:50.0041314Z", + "version": "2018-06-01" + }, + "eTag": "\"00003f04-0000-0000-0000-5b28979e0000\"", + "location": "East US", + "tags": { + "exampleTag": "exampleValue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeNodes_Delete.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeNodes_Delete.json new file mode 100644 index 000000000000..8ad31a2f4f0e --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeNodes_Delete.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "nodeName": "Node_1", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 15:01:22 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-deletes": "14999", + "x-ms-request-id": "c1016b57-daf8-4476-b9eb-d02890d03f8d", + "x-ms-correlation-request-id": "c1016b57-daf8-4476-b9eb-d02890d03f8d" + }, + "body": null + }, + "204": { + "headers": { + "Date": "Thu, 14 Jun 2018 15:01:34 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-deletes": "14998", + "x-ms-request-id": "9c6aed81-8fd1-477e-b365-c7b15fc7f51a", + "x-ms-correlation-request-id": "9c6aed81-8fd1-477e-b365-c7b15fc7f51a" + }, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeNodes_GetIpAddress.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeNodes_GetIpAddress.json new file mode 100644 index 000000000000..9d7b7cecfc8d --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeNodes_GetIpAddress.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "nodeName": "Node_1", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 15:36:39 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1199", + "x-ms-request-id": "f01265af-9f38-44b8-81a1-b67f567ea728", + "x-ms-correlation-request-id": "f01265af-9f38-44b8-81a1-b67f567ea728" + }, + "body": { + "ipAddress": "**********" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeNodes_Update.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeNodes_Update.json new file mode 100644 index 000000000000..bda4589fa6e5 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeNodes_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "nodeName": "Node_1", + "updateIntegrationRuntimeNodeRequest": { + "concurrentJobsLimit": 2 + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 15:01:00 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1199", + "x-ms-request-id": "cf0d05fa-afbe-4fac-aa10-227885658c83", + "x-ms-correlation-request-id": "cf0d05fa-afbe-4fac-aa10-227885658c83" + }, + "body": { + "nodeName": "Node_1", + "machineName": "YANZHANG-DT", + "hostServiceUri": "https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/", + "status": "Online", + "capabilities": { + "serviceBusConnected": "True", + "httpsPortEnabled": "True", + "credentialInSync": "True", + "connectedToResourceManager": "True", + "nodeEnabled": "True" + }, + "versionStatus": "UpToDate", + "version": "3.8.6730.2", + "registerTime": "2018-06-14T14:51:44.9237069Z", + "lastConnectTime": "2018-06-14T15:00:35.7544322Z", + "lastStartTime": "2018-06-14T14:52:59.8933313Z", + "lastUpdateResult": "None", + "isActiveDispatcher": true, + "concurrentJobsLimit": 2, + "maxConcurrentJobs": 56 + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Create.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Create.json new file mode 100644 index 000000000000..d29fa9183fe8 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Create.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "ifMatch": null, + "integrationRuntime": { + "properties": { + "type": "SelfHosted", + "description": "A selfhosted integration runtime" + } + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Jun 2018 22:20:47 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1197", + "x-ms-request-id": "125c07fa-e39a-4541-885f-5019631a5ecd", + "x-ms-correlation-request-id": "125c07fa-e39a-4541-885f-5019631a5ecd" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", + "name": "exampleIntegrationRuntime", + "type": "Microsoft.DataFactory/factories/integrationruntimes", + "properties": { + "type": "SelfHosted", + "description": "A selfhosted integration runtime" + }, + "etag": "000046c4-0000-0000-0000-5b2198bf0000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Delete.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Delete.json new file mode 100644 index 000000000000..b080ffbcd5c7 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Delete.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Jun 2018 22:30:01 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-deletes": "14979", + "x-ms-request-id": "6551f7f4-0d7f-4d02-a3a0-c4ee3b7bf15c", + "x-ms-correlation-request-id": "6551f7f4-0d7f-4d02-a3a0-c4ee3b7bf15c" + }, + "body": null + }, + "204": { + "headers": { + "Date": "Wed, 13 Jun 2018 22:30:02 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-deletes": "14978", + "x-ms-request-id": "7c5c6c3d-fca3-469e-9b6b-63ed9e4997dd", + "x-ms-correlation-request-id": "7c5c6c3d-fca3-469e-9b6b-63ed9e4997dd" + }, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Get.json new file mode 100644 index 000000000000..27917ea79da7 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Jun 2018 21:33:05 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14910", + "x-ms-request-id": "a453fdd5-2f17-4a84-b0c4-751151481ef3", + "x-ms-correlation-request-id": "a453fdd5-2f17-4a84-b0c4-751151481ef3" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", + "name": "exampleIntegrationRuntime", + "type": "Microsoft.DataFactory/factories/integrationruntimes", + "properties": { + "type": "SelfHosted", + "description": "A selfhosted integration runtime" + }, + "etag": "0400f1a1-0000-0000-0000-5b2188640000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetConnectionInfo.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetConnectionInfo.json new file mode 100644 index 000000000000..916a85249c56 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetConnectionInfo.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 14:53:21 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14998", + "x-ms-request-id": "05774db5-e79b-4224-9097-46714b92fbd8", + "x-ms-correlation-request-id": "05774db5-e79b-4224-9097-46714b92fbd8" + }, + "body": { + "version": "3.8.6730.2", + "publicKey": "**********", + "serviceToken": "**********", + "identityCertThumbprint": "**********", + "hostServiceUri": "https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/", + "isIdentityCertExprired": false + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetMonitoringData.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetMonitoringData.json new file mode 100644 index 000000000000..ee22ca1956db --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetMonitoringData.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 15:27:44 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14999", + "x-ms-request-id": "39277952-edbe-4336-ae94-f6f42b50b5f7", + "x-ms-correlation-request-id": "39277952-edbe-4336-ae94-f6f42b50b5f7" + }, + "body": { + "name": "exampleIntegrationRuntime", + "nodes": [ + { + "nodeName": "Node_1", + "availableMemoryInMB": 16740, + "cpuUtilization": 15, + "concurrentJobsLimit": 28, + "concurrentJobsRunning": 0, + "sentBytes": 2.6474916934967041, + "receivedBytes": 6.7314233779907227 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetStatus.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetStatus.json new file mode 100644 index 000000000000..eb30d6ce41c8 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetStatus.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 14:53:22 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14997", + "x-ms-request-id": "19efe790-074f-4241-ae94-0422935d0f46", + "x-ms-correlation-request-id": "19efe790-074f-4241-ae94-0422935d0f46" + }, + "body": { + "name": "exampleIntegrationRuntime", + "properties": { + "state": "Online", + "type": "SelfHosted", + "typeProperties": { + "autoUpdate": "Off", + "taskQueueId": "1a6296ab-423c-4346-9bcc-85a78c2c0582", + "version": "3.8.6730.2", + "nodes": [ + { + "nodeName": "Node_1", + "machineName": "YANZHANG-DT", + "hostServiceUri": "https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/", + "status": "Online", + "capabilities": { + "serviceBusConnected": "True", + "httpsPortEnabled": "True", + "credentialInSync": "True", + "connectedToResourceManager": "True", + "nodeEnabled": "True" + }, + "versionStatus": "UpToDate", + "version": "3.8.6730.2", + "registerTime": "2018-06-14T14:51:44.9237069Z", + "lastConnectTime": "2018-06-14T14:52:59.8933313Z", + "lastStartTime": "2018-06-14T14:52:59.8933313Z", + "lastUpdateResult": "None", + "isActiveDispatcher": true, + "maxConcurrentJobs": 56 + } + ], + "updateDelayOffset": "PT3H", + "localTimeZoneOffset": "PT8H", + "serviceUrls": [ + "wu.frontend.int.clouddatahub-int.net", + "*.servicebus.windows.net" + ], + "versionStatus": "UpToDate", + "capabilities": { + "serviceBusConnected": "True", + "httpsPortEnabled": "True", + "credentialInSync": "True", + "connectedToResourceManager": "True", + "nodeEnabled": "True" + }, + "latestVersion": "3.7.6711.1", + "createTime": "2018-06-14T09:17:45.1839685Z" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListAuthKeys.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListAuthKeys.json new file mode 100644 index 000000000000..d4469bbe608b --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListAuthKeys.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 14:51:00 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14999", + "x-ms-request-id": "2ea25426-9d1d-49f3-88b6-fb853eb02cb9", + "x-ms-correlation-request-id": "2ea25426-9d1d-49f3-88b6-fb853eb02cb9" + }, + "body": { + "authKey1": "**********", + "authKey2": "**********" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListByFactory.json new file mode 100644 index 000000000000..7961ec82f45b --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListByFactory.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "ifNoneMatch": null, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Jun 2018 21:33:05 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14909", + "x-ms-request-id": "f632df92-1140-4e19-9e19-0b1c8cbe393b", + "x-ms-correlation-request-id": "f632df92-1140-4e19-9e19-0b1c8cbe393b" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", + "name": "exampleIntegrationRuntime", + "type": "Microsoft.DataFactory/factories/integrationruntimes", + "properties": { + "type": "SelfHosted", + "description": "A selfhosted integration runtime" + }, + "etag": "0400f1a1-0000-0000-0000-5b2188640000" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_RegenerateAuthKey.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_RegenerateAuthKey.json new file mode 100644 index 000000000000..5587566f8150 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_RegenerateAuthKey.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "regenerateKeyParameters": { + "keyName": "authKey2" + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 14:50:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-request-id": "25af6d34-52c6-40a4-a882-16052af85c99", + "x-ms-correlation-request-id": "25af6d34-52c6-40a4-a882-16052af85c99" + }, + "body": { + "authKey2": "**********" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_RemoveLinks.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_RemoveLinks.json new file mode 100644 index 000000000000..3baecff413c6 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_RemoveLinks.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "linkedIntegrationRuntimeRequest": { + "factoryName": "exampleFactoryName-linked" + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 03 Jul 2018 06:33:25 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1195", + "x-ms-request-id": "360fbe4c-a1a7-436b-b0f5-e27a474a6b16", + "x-ms-correlation-request-id": "360fbe4c-a1a7-436b-b0f5-e27a474a6b16" + }, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Start.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Start.json new file mode 100644 index 000000000000..21953e6e20b9 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Start.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleManagedIntegrationRuntime", + "api-version": "2018-06-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Wed, 13 Jun 2018 21:11:03 GMT", + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleManagedIntegrationRuntime/start/operationresults/301b9c4b1c43415594e11918e678383c?api-version=2018-06-01", + "Retry-After": "15", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1194", + "x-ms-request-id": "cb03ccdd-9d7a-4ebe-a967-0edc96f33904", + "x-ms-correlation-request-id": "cb03ccdd-9d7a-4ebe-a967-0edc96f33904" + }, + "body": null + }, + "200": { + "headers": { + "Date": "Wed, 13 Jun 2018 21:33:00 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14912", + "x-ms-request-id": "2af47f9f-5625-4b01-a3a5-bccb576a4677", + "x-ms-correlation-request-id": "2af47f9f-5625-4b01-a3a5-bccb576a4677" + }, + "body": { + "name": "exampleManagedIntegrationRuntime", + "properties": { + "dataFactoryName": "exampleFactoryName", + "state": "Started", + "type": "Managed", + "dataFactoryLocation": null, + "resourceUri": null, + "typeProperties": { + "nodes": [], + "otherErrors": [], + "state": "Started", + "createTime": "2018-06-13T21:11:01.8695494Z" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Stop.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Stop.json new file mode 100644 index 000000000000..c629af7aa096 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Stop.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleManagedIntegrationRuntime", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Jun 2018 21:33:03 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1193", + "x-ms-request-id": "87f6c2c7-92f1-40e6-bb01-769f9e6ca22f", + "x-ms-correlation-request-id": "87f6c2c7-92f1-40e6-bb01-769f9e6ca22f" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleManagedIntegrationRuntime" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_SyncCredentials.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_SyncCredentials.json new file mode 100644 index 000000000000..b614b05b52e6 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_SyncCredentials.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 15:27:47 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-request-id": "a991b4b4-e33a-4973-9088-200f9137fb84", + "x-ms-correlation-request-id": "a991b4b4-e33a-4973-9088-200f9137fb84" + }, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Update.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Update.json new file mode 100644 index 000000000000..cbe1a8c4235b --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "updateIntegrationRuntimeRequest": { + "autoUpdate": "Off", + "updateDelayOffset": "\"PT3H\"" + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Jun 2018 21:33:04 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "eb1c35f8-4b37-4d08-b5dd-d6a0ad8b182d", + "x-ms-correlation-request-id": "eb1c35f8-4b37-4d08-b5dd-d6a0ad8b182d" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", + "name": "exampleIntegrationRuntime", + "type": "Microsoft.DataFactory/factories/integrationruntimes", + "properties": { + "type": "SelfHosted", + "description": "A selfhosted integration runtime" + }, + "etag": "0400f1a1-0000-0000-0000-5b2188640000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Upgrade.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Upgrade.json new file mode 100644 index 000000000000..30998ace71e3 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Upgrade.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Thu, 14 Jun 2018 14:53:30 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1196", + "x-ms-request-id": "e12b9b30-54bf-49a0-8b7e-c8ce58ba6a36", + "x-ms-correlation-request-id": "e12b9b30-54bf-49a0-8b7e-c8ce58ba6a36" + }, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Create.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Create.json new file mode 100644 index 000000000000..5f7c0bc17471 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Create.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "linkedServiceName": "exampleLinkedService", + "ifMatch": null, + "linkedService": { + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=" + } + } + } + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:34 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1196", + "x-ms-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de", + "x-ms-correlation-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "type": "Microsoft.DataFactory/factories/linkedservices", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "**********" + }, + "encryptedCredential": "ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkRGLURPR0ZPT0QtWUFOWkhBTkctV1VfM2FiMTk0NjYtNWUxNi00NzU1LWJlNzktMjI2ZTVmZWU3YzY0Ig0KfQ==" + } + }, + "etag": "0a0062d4-0000-0000-0000-5b245bcf0000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Delete.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Delete.json new file mode 100644 index 000000000000..ee8b10b68aec --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Delete.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "linkedServiceName": "exampleLinkedService", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:29 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-deletes": "14993", + "x-ms-request-id": "f55bd1ad-2ab5-4b94-bca5-01489e1b9d57", + "x-ms-correlation-request-id": "f55bd1ad-2ab5-4b94-bca5-01489e1b9d57" + }, + "body": null + }, + "204": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:29 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-deletes": "14992", + "x-ms-request-id": "b1456813-e580-4cb0-bb05-ffd6099320e6", + "x-ms-correlation-request-id": "b1456813-e580-4cb0-bb05-ffd6099320e6" + }, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Get.json new file mode 100644 index 000000000000..fcdfeba9318d --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "linkedServiceName": "exampleLinkedService", + "ifNoneMatch": null, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:36 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14995", + "x-ms-request-id": "b57420cc-9476-4947-b54f-50b041b614ec", + "x-ms-correlation-request-id": "b57420cc-9476-4947-b54f-50b041b614ec" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "type": "Microsoft.DataFactory/factories/linkedservices", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "**********" + }, + "encryptedCredential": "ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkRGLURPR0ZPT0QtWUFOWkhBTkctV1VfMGI2M2EyMmYtMGEzNC00NDg2LWIzMDktNzM0NTlkODUyY2Q1Ig0KfQ==" + }, + "description": "Example description" + }, + "etag": "0a0064d4-0000-0000-0000-5b245bd00000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_ListByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_ListByFactory.json new file mode 100644 index 000000000000..d90b155020ce --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_ListByFactory.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:36 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14994", + "x-ms-request-id": "558d0fd8-dc1f-44b6-9ca9-59fcca8af9a5", + "x-ms-correlation-request-id": "558d0fd8-dc1f-44b6-9ca9-59fcca8af9a5" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "type": "Microsoft.DataFactory/factories/linkedservices", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "**********" + }, + "encryptedCredential": "ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkRGLURPR0ZPT0QtWUFOWkhBTkctV1VfMGI2M2EyMmYtMGEzNC00NDg2LWIzMDktNzM0NTlkODUyY2Q1Ig0KfQ==" + }, + "description": "Example description" + }, + "etag": "0a0064d4-0000-0000-0000-5b245bd00000" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Update.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Update.json new file mode 100644 index 000000000000..2fea4585de27 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/LinkedServices_Update.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "linkedServiceName": "exampleLinkedService", + "ifMatch": null, + "linkedService": { + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=" + } + }, + "description": "Example description" + } + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:36 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1195", + "x-ms-request-id": "53ad9761-ecdf-43ed-916f-878a5fb92cb0", + "x-ms-correlation-request-id": "53ad9761-ecdf-43ed-916f-878a5fb92cb0" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "type": "Microsoft.DataFactory/factories/linkedservices", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "type": "SecureString", + "value": "**********" + }, + "encryptedCredential": "ew0KICAiVmVyc2lvbiI6ICIyMDE3LTExLTMwIiwNCiAgIlByb3RlY3Rpb25Nb2RlIjogIktleSIsDQogICJTZWNyZXRDb250ZW50VHlwZSI6ICJQbGFpbnRleHQiLA0KICAiQ3JlZGVudGlhbElkIjogIkRGLURPR0ZPT0QtWUFOWkhBTkctV1VfMGI2M2EyMmYtMGEzNC00NDg2LWIzMDktNzM0NTlkODUyY2Q1Ig0KfQ==" + }, + "description": "Example description" + }, + "etag": "0a0064d4-0000-0000-0000-5b245bd00000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Operations_List.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Operations_List.json new file mode 100644 index 000000000000..2a2ed78c8df8 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Operations_List.json @@ -0,0 +1,1034 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:33 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-tenant-reads": "14999", + "x-ms-request-id": "522fceaa-5c3b-42ff-a518-843b2a53e0aa", + "x-ms-correlation-request-id": "522fceaa-5c3b-42ff-a518-843b2a53e0aa" + }, + "body": { + "value": [ + { + "origin": "system", + "name": "Microsoft.DataFactory/datafactories/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.DataFactory", + "resource": "datafactories", + "operation": "Read datafactories metric definitions", + "description": "Gets the available metrics for datafactories" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "FailedRuns", + "displayName": "Failed Runs", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1H", + "blobDuration": "P1D" + } + ], + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetricsV1", + "dimensions": [ + { + "name": "pipelineName", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + }, + { + "name": "activityName", + "displayName": "Activity", + "toBeExportedForShoebox": true + }, + { + "name": "windowEnd", + "displayName": "Window End", + "toBeExportedForShoebox": true + }, + { + "name": "windowStart", + "displayName": "Window Start", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "SuccessfulRuns", + "displayName": "Successful Runs", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1H", + "blobDuration": "P1D" + } + ], + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetricsV1", + "dimensions": [ + { + "name": "pipelineName", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + }, + { + "name": "activityName", + "displayName": "Activity", + "toBeExportedForShoebox": true + }, + { + "name": "windowEnd", + "displayName": "Window End", + "toBeExportedForShoebox": true + }, + { + "name": "windowStart", + "displayName": "Window Start", + "toBeExportedForShoebox": true + } + ] + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.DataFactory/datafactories/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.DataFactory", + "resource": "datafactories", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.DataFactory/datafactories/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.DataFactory", + "resource": "datafactories", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft.DataFactory", + "resource": "The log definition of factories", + "operation": "Read factories log definitions", + "description": "Gets the available logs for factories" + }, + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "ActivityRuns", + "displayName": "Pipeline activity runs log", + "blobDuration": "PT1H" + }, + { + "name": "PipelineRuns", + "displayName": "Pipeline runs log", + "blobDuration": "PT1H" + }, + { + "name": "TriggerRuns", + "displayName": "Trigger runs log", + "blobDuration": "PT1H" + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.DataFactory", + "resource": "factories", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.DataFactory", + "resource": "factories", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.DataFactory", + "resource": "factories", + "operation": "Read metric definitions", + "description": "Gets the available metrics for factories" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "PipelineFailedRuns", + "displayName": "Failed pipeline runs metrics", + "unit": "Count", + "aggregationType": "Total", + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "PipelineSucceededRuns", + "displayName": "Succeeded pipeline runs metrics", + "unit": "Count", + "aggregationType": "Total", + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "ActivityFailedRuns", + "displayName": "Failed activity runs metrics", + "unit": "Count", + "aggregationType": "Total", + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "ActivityType", + "displayName": "Activity Type", + "toBeExportedForShoebox": true + }, + { + "name": "PipelineName", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Activity", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "ActivitySucceededRuns", + "displayName": "Succeeded activity runs metrics", + "unit": "Count", + "aggregationType": "Total", + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "ActivityType", + "displayName": "Activity Type", + "toBeExportedForShoebox": true + }, + { + "name": "PipelineName", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Activity", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "TriggerFailedRuns", + "displayName": "Failed trigger runs metrics", + "unit": "Count", + "aggregationType": "Total", + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "Name", + "displayName": "Trigger", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "TriggerSucceededRuns", + "displayName": "Succeeded trigger runs metrics", + "unit": "Count", + "aggregationType": "Total", + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "Name", + "displayName": "Trigger", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "IntegrationRuntimeCpuPercentage", + "displayName": "Integration runtime CPU utilization", + "unit": "Percent", + "aggregationType": "Average", + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "IntegrationRuntimeName", + "displayName": "Integration Runtime", + "toBeExportedForShoebox": true + }, + { + "name": "NodeName", + "displayName": "Integration Runtime Node", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "IntegrationRuntimeAvailableMemory", + "displayName": "Integration runtime available memory", + "unit": "Bytes", + "aggregationType": "Average", + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "IntegrationRuntimeName", + "displayName": "Integration Runtime", + "toBeExportedForShoebox": true + }, + { + "name": "NodeName", + "displayName": "Integration Runtime Node", + "toBeExportedForShoebox": true + } + ] + } + ] + } + } + }, + { + "name": "Microsoft.DataFactory/register/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Factory Resource Provider", + "operation": "Register Data Factory Resource Provider", + "description": "Registers the subscription for the Data Factory Resource Provider." + } + }, + { + "name": "Microsoft.DataFactory/unregister/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Factory Resource Provider", + "operation": "Unregister Data Factory Resource Provider", + "description": "Unregisters the subscription for the Data Factory Resource Provider." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Factory", + "operation": "Read Data Factory", + "description": "Reads the Data Factory." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/write", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Factory", + "operation": "Create or Update Data Factory", + "description": "Creates or Updates the Data Factory." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/delete", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Factory", + "operation": "Delete Data Factory", + "description": "Deletes the Data Factory." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/linkedServices/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Linked Service", + "operation": "Read Linked Service", + "description": "Reads any Linked Service." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/linkedServices/delete", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Linked Service", + "operation": "Delete Linked Service", + "description": "Deletes any Linked Service." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/linkedServices/write", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Linked Service", + "operation": "Create or Update Linked Service", + "description": "Creates or Updates any Linked Service." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datapipelines/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Pipeline", + "operation": "Read Pipeline", + "description": "Reads any Pipeline." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datapipelines/delete", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Pipeline", + "operation": "Delete Pipeline", + "description": "Deletes any Pipeline." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datapipelines/pause/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Pipeline", + "operation": "Pause Pipeline", + "description": "Pauses any Pipeline." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datapipelines/resume/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Pipeline", + "operation": "Resume Pipeline", + "description": "Resumes any Pipeline." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datapipelines/update/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Pipeline", + "operation": "Update Pipeline", + "description": "Updates any Pipeline." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datapipelines/write", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Pipeline", + "operation": "Create or Update Pipeline", + "description": "Creates or Updates any Pipeline." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datasets/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Dataset", + "operation": "Read Dataset", + "description": "Reads any Dataset." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datasets/delete", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Dataset", + "operation": "Delete Dataset", + "description": "Deletes any Dataset." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datasets/write", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Dataset", + "operation": "Create or Update Dataset", + "description": "Creates or Updates any Dataset." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/tables/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Dataset", + "operation": "Read Dataset", + "description": "Reads any Dataset." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/tables/delete", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Dataset", + "operation": "Delete Dataset", + "description": "Deletes any Dataset." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/tables/write", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Dataset", + "operation": "Create or Update Dataset", + "description": "Creates or Updates any Dataset." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datasets/slices/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Slice", + "operation": "Read Data Slices", + "description": "Gets the Data Slices in the given period." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datasets/slices/write", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Slice", + "operation": "Update Data Slice Status", + "description": "Update the Status of the Data Slice." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datasets/sliceruns/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Slice", + "operation": "Read Data Slice Run", + "description": "Reads the Data Slice Run for the given dataset with the given start time." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/runs/loginfo/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Run Log", + "operation": "Read Run Log Info", + "description": "Reads a SAS URI to a blob container containing the logs." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/activitywindows/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Activity Windows", + "operation": "Read Activity Windows in any Data Factory", + "description": "Reads Activity Windows in the Data Factory with specified parameters." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datapipelines/activitywindows/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Activity Windows", + "operation": "Read Activity Windows for any Pipeline", + "description": "Reads Activity Windows for the Pipeline with specified parameters." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datapipelines/activities/activitywindows/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Activity Windows", + "operation": "Read Activity Windows for any Pipeline Activity", + "description": "Reads Activity Windows for the Pipeline Activity with specified parameters." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/datasets/activitywindows/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Activity Windows", + "operation": "Read Activity Windows for any Dataset", + "description": "Reads Activity Windows for the Dataset with specified parameters." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/gateways/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Gateway", + "operation": "Read Gateway", + "description": "Reads any Gateway." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/gateways/write", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Gateway", + "operation": "Create or Update Gateway", + "description": "Creates or Updates any Gateway." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/gateways/delete", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Gateway", + "operation": "Delete Gateway", + "description": "Deletes any Gateway." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/gateways/connectioninfo/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Gateway", + "operation": "Read Gateway Connection Info", + "description": "Reads the Connection Info for any Gateway." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/gateways/listauthkeys/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Gateway", + "operation": "List Gateway Authentication Keys", + "description": "Lists the Authentication Keys for any Gateway." + } + }, + { + "name": "Microsoft.DataFactory/datafactories/gateways/regenerateauthkey/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Gateway", + "operation": "Regenerate Gateway Authentication Keys", + "description": "Regenerates the Authentication Keys for any Gateway." + } + }, + { + "name": "Microsoft.DataFactory/factories/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Factory", + "operation": "Read Data Factory", + "description": "Reads Data Factory." + } + }, + { + "name": "Microsoft.DataFactory/factories/write", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Factory", + "operation": "Create or Update any Data Factory.", + "description": "Create or Update Data Factory" + } + }, + { + "name": "Microsoft.DataFactory/factories/delete", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Factory", + "operation": "Delete Data Factory", + "description": "Deletes Data Factory." + } + }, + { + "name": "Microsoft.DataFactory/factories/linkedServices/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Linked Service", + "operation": "Read Linked Service", + "description": "Reads Linked Service." + } + }, + { + "name": "Microsoft.DataFactory/factories/linkedServices/delete", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Linked Service", + "operation": "Delete Linked Service", + "description": "Deletes Linked Service." + } + }, + { + "name": "Microsoft.DataFactory/factories/linkedServices/write", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Linked Service", + "operation": "Create or Update any Linked Service.", + "description": "Create or Update Linked Service" + } + }, + { + "name": "Microsoft.DataFactory/factories/pipelines/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Pipeline", + "operation": "Read Pipeline", + "description": "Reads Pipeline." + } + }, + { + "name": "Microsoft.DataFactory/factories/pipelines/delete", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Pipeline", + "operation": "Delete Pipeline", + "description": "Deletes Pipeline." + } + }, + { + "name": "Microsoft.DataFactory/factories/pipelines/write", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Pipeline", + "operation": "Create or Update any Pipeline.", + "description": "Create or Update Pipeline" + } + }, + { + "name": "Microsoft.DataFactory/factories/pipelines/createrun/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Pipeline", + "operation": "Create Pipeline Run", + "description": "Creates a run for the Pipeline." + } + }, + { + "name": "Microsoft.DataFactory/factories/cancelpipelinerun/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Factory", + "operation": "Cancel any Pipeline Run", + "description": "Cancels the pipeline run specified by the run ID." + } + }, + { + "name": "Microsoft.DataFactory/factories/pipelineruns/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Factory", + "operation": "Read Pipeline Runs", + "description": "Reads the Pipeline Runs." + } + }, + { + "name": "Microsoft.DataFactory/factories/pipelineruns/activityruns/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Factory", + "operation": "Read Activity Runs", + "description": "Reads the activity runs for the specified pipeline run ID." + } + }, + { + "name": "Microsoft.DataFactory/factories/datasets/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Dataset", + "operation": "Read Dataset", + "description": "Reads any Dataset." + } + }, + { + "name": "Microsoft.DataFactory/factories/datasets/delete", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Dataset", + "operation": "Delete Dataset", + "description": "Deletes any Dataset." + } + }, + { + "name": "Microsoft.DataFactory/factories/datasets/write", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Dataset", + "operation": "Create or Update Dataset", + "description": "Creates or Updates any Dataset." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "Read Integration Runtime", + "description": "Reads any Integration Runtime." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/write", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "Create or Update Integration Runtime", + "description": "Creates or Updates any Integration Runtime." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/delete", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "Delete Integration Runtime", + "description": "Deletes any Integration Runtime." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/start/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "Start Integration Runtime", + "description": "Starts any Integration Runtime." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/stop/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "Stop Integration Runtime", + "description": "Stops any Integration Runtime." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/getconnectioninfo/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "Read Integration Runtime Connection Info", + "description": "Reads Integration Runtime Connection Info." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/getstatus/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "Read Integration Runtime Status", + "description": "Reads Integration Runtime Status." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/listauthkeys/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "List Integration Runtime Authentication Keys", + "description": "Lists the Authentication Keys for any Integration Runtime." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/monitoringdata/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "Get Integration Runtime Monitoring Data", + "description": "Gets the Monitoring Data for any Integration Runtime." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/nodes/delete", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "Delete Integration Runtime Node", + "description": "Deletes the Node for the specified Integration Runtime." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/nodes/write", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "Update Integration Runtime Node", + "description": "Updates a self-hosted Integration Runtime Node." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/nodes/ipAddress/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "Read Integration Runtime Node IP Address", + "description": "Returns the IP Address for the specified node of the Integration Runtime." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/synccredentials/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "Sync Credentials for Integration Runtime", + "description": "Syncs the Credentials for the specified Integration Runtime." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/upgrade/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "Upgrade Integration Runtime", + "description": "Upgrades the specified Integration Runtime." + } + }, + { + "name": "Microsoft.DataFactory/factories/integrationruntimes/regenerateauthkey/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Integration Runtime", + "operation": "Regenerate Integration Runtime Authentication Keys", + "description": "Regenerates the Authentication Keys for the specified Integration Runtime." + } + }, + { + "name": "Microsoft.DataFactory/factories/triggers/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Trigger", + "operation": "Read Trigger", + "description": "Reads any Trigger." + } + }, + { + "name": "Microsoft.DataFactory/factories/triggers/write", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Trigger", + "operation": "Create or Update Trigger", + "description": "Creates or Updates any Trigger." + } + }, + { + "name": "Microsoft.DataFactory/factories/triggers/delete", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Trigger", + "operation": "Delete Trigger", + "description": "Deletes any Trigger." + } + }, + { + "name": "Microsoft.DataFactory/factories/triggers/start/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Trigger", + "operation": "Start Trigger", + "description": "Starts any Trigger." + } + }, + { + "name": "Microsoft.DataFactory/factories/triggers/stop/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Trigger", + "operation": "Stop Trigger", + "description": "Stops any Trigger." + } + }, + { + "name": "Microsoft.DataFactory/factories/triggers/triggerruns/read", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Factory", + "operation": "Read Trigger Runs", + "description": "Reads the Trigger Runs." + } + }, + { + "name": "Microsoft.DataFactory/locations/configureFactoryRepo/action", + "display": { + "provider": "Microsoft Data Factory", + "resource": "Data Factory", + "operation": "Configure Factory Repository", + "description": "Configures the repository for the factory." + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/PipelineRuns_Cancel.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/PipelineRuns_Cancel.json new file mode 100644 index 000000000000..ff5617cb7614 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/PipelineRuns_Cancel.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "runId": "16ac5348-ff82-4f95-a80d-638c1d47b721", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:39:51 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1188", + "x-ms-request-id": "00215772-3147-4e15-99ae-fbf225d5dd0a", + "x-ms-correlation-request-id": "00215772-3147-4e15-99ae-fbf225d5dd0a" + }, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/PipelineRuns_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/PipelineRuns_Get.json new file mode 100644 index 000000000000..657ed25eed2f --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/PipelineRuns_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:02 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14988", + "x-ms-request-id": "6d9de9bd-a412-4a6f-8b9e-37d369323646", + "x-ms-correlation-request-id": "6d9de9bd-a412-4a6f-8b9e-37d369323646" + }, + "body": { + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "pipelineName": "examplePipeline", + "parameters": { + "OutputBlobNameList": "[\"exampleoutput.csv\"]" + }, + "invokedBy": { + "id": "80a01654a9d34ad18b3fcac5d5d76b67", + "name": "Manual" + }, + "runStart": "2018-06-16T00:37:44.6257014Z", + "runEnd": "2018-06-16T00:38:12.7314495Z", + "durationInMs": 28105, + "status": "Succeeded", + "message": "", + "lastUpdated": "2018-06-16T00:38:12.7314495Z", + "annotations": [] + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/PipelineRuns_QueryByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/PipelineRuns_QueryByFactory.json new file mode 100644 index 000000000000..cbb12946813b --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/PipelineRuns_QueryByFactory.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "filterParameters": { + "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z", + "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z", + "filters": [ + { + "operand": "PipelineName", + "operator": "Equals", + "values": [ + "examplePipeline" + ] + } + ] + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:01 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14989", + "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", + "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd" + }, + "body": { + "value": [ + { + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "pipelineName": "examplePipeline", + "parameters": { + "OutputBlobNameList": "[\"exampleoutput.csv\"]" + }, + "invokedBy": { + "id": "80a01654a9d34ad18b3fcac5d5d76b67", + "name": "Manual" + }, + "runStart": "2018-06-16T00:37:44.6257014Z", + "runEnd": "2018-06-16T00:38:12.7314495Z", + "durationInMs": 28105, + "status": "Succeeded", + "message": "", + "lastUpdated": "2018-06-16T00:38:12.7314495Z", + "annotations": [] + }, + { + "runId": "16ac5348-ff82-4f95-a80d-638c1d47b721", + "pipelineName": "examplePipeline", + "parameters": { + "OutputBlobNameList": "[\"exampleoutput.csv\"]" + }, + "invokedBy": { + "id": "7c5fd7ef7e8a464b98b931cf15fcac66", + "name": "Manual" + }, + "runStart": "2018-06-16T00:39:49.2745128Z", + "runEnd": null, + "durationInMs": null, + "status": "Cancelled", + "message": "", + "lastUpdated": "2018-06-16T00:39:51.216097Z", + "annotations": [] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Create.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Create.json new file mode 100644 index 000000000000..36720c98f369 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Create.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "pipelineName": "examplePipeline", + "ifMatch": null, + "pipeline": { + "properties": { + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + } + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:41 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1192", + "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", + "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", + "name": "examplePipeline", + "type": "Microsoft.DataFactory/factories/pipelines", + "properties": { + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + }, + "etag": "0a0069d4-0000-0000-0000-5b245bd50000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_CreateRun.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_CreateRun.json new file mode 100644 index 000000000000..721114951093 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_CreateRun.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "pipelineName": "examplePipeline", + "referencePipelineRunId": null, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:48 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1190", + "x-ms-request-id": "5c2b442b-d360-43ec-9268-f923f88f31fd", + "x-ms-correlation-request-id": "5c2b442b-d360-43ec-9268-f923f88f31fd" + }, + "body": { + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Delete.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Delete.json new file mode 100644 index 000000000000..6cbb5ed82357 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Delete.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "pipelineName": "examplePipeline", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:27 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-deletes": "14997", + "x-ms-request-id": "10ea8bd9-4620-425c-92dd-adadef31c9e4", + "x-ms-correlation-request-id": "10ea8bd9-4620-425c-92dd-adadef31c9e4" + }, + "body": null + }, + "204": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:27 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-deletes": "14996", + "x-ms-request-id": "cfb3e876-4271-4300-bf3d-3bffc5a34695", + "x-ms-correlation-request-id": "cfb3e876-4271-4300-bf3d-3bffc5a34695" + }, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Get.json new file mode 100644 index 000000000000..9dc1bf7c1790 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Get.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "pipelineName": "examplePipeline", + "ifNoneMatch": null, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:43 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14991", + "x-ms-request-id": "e1e7bf40-37d4-4f38-92aa-4138cc1fa2fa", + "x-ms-correlation-request-id": "e1e7bf40-37d4-4f38-92aa-4138cc1fa2fa" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", + "name": "examplePipeline", + "type": "Microsoft.DataFactory/factories/pipelines", + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + }, + "etag": "0a006cd4-0000-0000-0000-5b245bd60000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_ListByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_ListByFactory.json new file mode 100644 index 000000000000..76bfe07287e2 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_ListByFactory.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:43 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14990", + "x-ms-request-id": "92292250-c10f-4c47-8eb6-b886b361add7", + "x-ms-correlation-request-id": "92292250-c10f-4c47-8eb6-b886b361add7" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", + "name": "examplePipeline", + "type": "Microsoft.DataFactory/factories/pipelines", + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + }, + "etag": "0a006cd4-0000-0000-0000-5b245bd60000" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Update.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Update.json new file mode 100644 index 000000000000..239e9d8251e9 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Pipelines_Update.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "pipelineName": "examplePipeline", + "ifMatch": null, + "pipeline": { + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + } + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:37:43 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1191", + "x-ms-request-id": "91a763b0-d944-493f-83fc-e989c8b6e122", + "x-ms-correlation-request-id": "91a763b0-d944-493f-83fc-e989c8b6e122" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", + "name": "examplePipeline", + "type": "Microsoft.DataFactory/factories/pipelines", + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + }, + "dataIntegrationUnits": 32 + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + }, + "etag": "0a006cd4-0000-0000-0000-5b245bd60000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/TriggerRuns_QueryByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/TriggerRuns_QueryByFactory.json new file mode 100644 index 000000000000..3e7e1935aeaa --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/TriggerRuns_QueryByFactory.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "filterParameters": { + "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z", + "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z", + "filters": [ + { + "operand": "TriggerName", + "operator": "Equals", + "values": [ + "exampleTrigger" + ] + } + ] + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:22 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1199", + "x-ms-request-id": "fb328f3e-d21e-44f7-80d7-dad60c955b4d", + "x-ms-correlation-request-id": "fb328f3e-d21e-44f7-80d7-dad60c955b4d" + }, + "body": { + "value": [ + { + "triggerName": "exampleTrigger", + "triggerRunId": "08586724970898148904457116912CU27", + "triggerType": "ScheduleTrigger", + "triggerRunTimestamp": "2018-06-16T00:43:15.660141Z", + "status": "Succeeded", + "message": "", + "properties": { + "TriggerTime": "6/16/2018 12:43:15 AM", + "ScheduleTime": "6/16/2018 12:43:14 AM" + }, + "triggeredPipelines": { + "examplePipeline": "9f3ce8b3-37d7-43eb-96ac-a656c0476283" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Create.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Create.json new file mode 100644 index 000000000000..8d0d568e11d3 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Create.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "triggerName": "exampleTrigger", + "ifMatch": null, + "trigger": { + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:13.8441801Z", + "endTime": "2018-06-16T00:55:13.8441801Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ] + } + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:14 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1186", + "x-ms-request-id": "373f1a49-685d-4c07-8857-0fcf1bcaffcb", + "x-ms-correlation-request-id": "373f1a49-685d-4c07-8857-0fcf1bcaffcb" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", + "name": "exampleTrigger", + "type": "Microsoft.DataFactory/factories/triggers", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:13.8441801Z", + "endTime": "2018-06-16T00:55:13.8441801Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "runtimeState": "Stopped" + }, + "etag": "0a008ad4-0000-0000-0000-5b245c6e0000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Delete.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Delete.json new file mode 100644 index 000000000000..a421eae21ad0 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Delete.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "triggerName": "exampleTrigger", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:26 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-deletes": "14999", + "x-ms-request-id": "1eea81f0-87de-4c9d-87cd-915e592a9bcc", + "x-ms-correlation-request-id": "1eea81f0-87de-4c9d-87cd-915e592a9bcc" + }, + "body": null + }, + "204": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:26 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-deletes": "14998", + "x-ms-request-id": "833e731f-67dc-48d3-b90f-6dd08e9d819f", + "x-ms-correlation-request-id": "833e731f-67dc-48d3-b90f-6dd08e9d819f" + }, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Get.json new file mode 100644 index 000000000000..2594e0f18c53 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Get.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "triggerName": "exampleTrigger", + "ifNoneMatch": null, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:17 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14987", + "x-ms-request-id": "060364d7-7980-4def-8bc1-800552a9b53d", + "x-ms-correlation-request-id": "060364d7-7980-4def-8bc1-800552a9b53d" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", + "name": "exampleTrigger", + "type": "Microsoft.DataFactory/factories/triggers", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:14.905167Z", + "endTime": "2018-06-16T00:55:14.905167Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "description": "Example description", + "runtimeState": "Stopped" + }, + "etag": "0a008dd4-0000-0000-0000-5b245c6f0000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_ListByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_ListByFactory.json new file mode 100644 index 000000000000..d624262a0bc7 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_ListByFactory.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:20 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14986", + "x-ms-request-id": "e474f8f8-b34f-4536-b059-ca740e6b44c3", + "x-ms-correlation-request-id": "e474f8f8-b34f-4536-b059-ca740e6b44c3" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", + "name": "exampleTrigger", + "type": "Microsoft.DataFactory/factories/triggers", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:14.905167Z", + "endTime": "2018-06-16T00:55:14.905167Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "description": "Example description", + "runtimeState": "Started" + }, + "etag": "0a008ed4-0000-0000-0000-5b245c740000" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Start.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Start.json new file mode 100644 index 000000000000..e519779f355a --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Start.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "triggerName": "exampleTrigger", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:20 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1184", + "x-ms-request-id": "0c1669a9-5b55-47fe-9413-df6d8710697d", + "x-ms-correlation-request-id": "0c1669a9-5b55-47fe-9413-df6d8710697d" + }, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Stop.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Stop.json new file mode 100644 index 000000000000..d26575b13848 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Stop.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "triggerName": "exampleTrigger", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:24 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-request-id": "5aa854a5-7ac0-4c7e-9356-79c657f4e231", + "x-ms-correlation-request-id": "5aa854a5-7ac0-4c7e-9356-79c657f4e231" + }, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Update.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Update.json new file mode 100644 index 000000000000..279774e97f2a --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Update.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "triggerName": "exampleTrigger", + "ifMatch": null, + "trigger": { + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:14.905167Z", + "endTime": "2018-06-16T00:55:14.905167Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "description": "Example description" + } + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:15 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1185", + "x-ms-request-id": "d5ccf096-0618-4b26-9829-db77e4c391c7", + "x-ms-correlation-request-id": "d5ccf096-0618-4b26-9829-db77e4c391c7" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", + "name": "exampleTrigger", + "type": "Microsoft.DataFactory/factories/triggers", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2018-06-16T00:39:14.905167Z", + "endTime": "2018-06-16T00:55:14.905167Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "description": "Example description", + "runtimeState": "Stopped" + }, + "etag": "0a008dd4-0000-0000-0000-5b245c6f0000" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/readme.md b/specification/datafactory/resource-manager/readme.md index cccb60253c10..9369892e1d55 100644 --- a/specification/datafactory/resource-manager/readme.md +++ b/specification/datafactory/resource-manager/readme.md @@ -27,7 +27,16 @@ These are the global settings for the Data Factory V2 API. title: DataFactoryManagementClient description: The Azure Data Factory V2 management API provides a RESTful set of web services that interact with Azure Data Factory V2 services. openapi-type: arm -tag: package-2017-09-preview +tag: package-2018-06 +``` + +### Tag: package-2018-06 + +These settings apply only when `--tag=package-2018-06` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06' +input-file: +- Microsoft.DataFactory/stable/2018-06-01/datafactory.json ``` ### Tag: package-2017-09-preview @@ -51,7 +60,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node ``` @@ -85,7 +94,7 @@ python: payload-flattening-threshold: 2 namespace: azure.mgmt.datafactory package-name: azure-mgmt-dafactory - package-version: 0.6.0 + package-version: 1.0.0 clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' @@ -116,6 +125,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2017-09-preview + - tag: package-2018-06 ``` ### Tag: package-2017-09-preview and go @@ -124,9 +134,17 @@ These settings apply only when `--tag=package-2017-09-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-09-preview' && $(go) -output-folder: $(go-sdk-folder)/services/datafactory/mgmt/2017-09-01-preview/datafactory +output-folder: $(go-sdk-folder)/services/preview/datafactory/mgmt/2017-09-01-preview/datafactory ``` +### Tag: package-2018-06 and go + +These settings apply only when `--tag=package-2018-06 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-06' && $(go) +output-folder: $(go-sdk-folder)/services/datafactory/mgmt/2018-06-01/datafactory +``` ## Java @@ -134,17 +152,52 @@ 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 - fluent: true - namespace: com.microsoft.azure.management.datafactory - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datafactory +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.datafactory +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datafactory ``` # Validation + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-09-preview + - tag: package-2018-06 +``` + +### Tag: package-2017-09-preview and java + +These settings apply only when `--tag=package-2017-09-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-09-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datafactoryv2.v2017_09_01_preview + output-folder: $(azure-libraries-for-java-folder)/datafactoryv2/resource-manager/v2017_09_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-06 and java + +These settings apply only when `--tag=package-2018-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datafactoryv2.v2018_06_01 + output-folder: $(azure-libraries-for-java-folder)/datafactoryv2/resource-manager/v2018_06_01 +regenerate-manager: true +generate-interface: true +``` + + ## Suppression ``` yaml @@ -156,6 +209,7 @@ directive: - $.definitions.TriggerResource.properties.properties - $.definitions.LinkedServiceResource.properties.properties - $.definitions.TriggerRun.properties.properties + - $.definitions.DatasetResource.properties.properties - $.properties.properties.LinkedServiceResource.definitions - $.properties.properties.LinkedServiceResource.definitions - $.properties.properties.IntegrationRuntimeStatusResponse.definitions @@ -185,23 +239,57 @@ directive: - suppress: R3017 # GuidUsage where: - $.definitions.FactoryIdentity.properties.principalId + - $.definitions.FactoryIdentity.properties.tenantId from: datafactory.json reason: - FactoryIdentity.properties.principalId should be a Guid, per MSI integration. + - FactoryIdentity.properties.tenantId should be a Guid, per MSI integration. - suppress: R3010 # TrackedResourceListByImmediateParent where: - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}"] - from: datafactory.json reason: - - Pipeline runs are listable in all but name. The operations PipelineRuns_QueryByFactory serves this purpose. + - Pipeline runs are not listable. The operation PipelineRuns_QueryByFactory serves this purpose. - suppress: R1003 # ListInOperationName where: - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData"].post.operationId - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData"].post.operationId - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns"].post.operationId - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns"].paths - - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns"].paths + - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns"].paths + - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns"].paths + - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns"].paths + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns"].post.operationId from: datafactory.json reason: - - PipelineRuns_QueryByFactory is by-design not a true list API; getting pipeline runs requires providing a filter that is part of the request body in a POST call. + - QueryBy API-s are by-design not true list API-s; getting runs requires providing a filter that is part of the request body in a POST call. + - suppress: R2066 # PostOperationIdContainsUrlVerb + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns"].post.operationId + - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns"].paths + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns"].post.operationId + - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns"].paths + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns"].post.operationId + - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns"].paths + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/cancelpipelinerun/{runId}"].post.operationId + from: datafactory.json + reason: + - PipelineRuns_QueryByFactory is placed in pipeline runs namespace fpr better user experience. The method name shows the scope. + - ActivityRuns_QueryByPipelineRun is placed in activity runs namespace fpr better user experience. The method name shows the scope. + - CancelPipelineRun API is fixed in our new API version + - suppress: R3018 # EnumInsteadOfBoolean + where: + - $.definitions.OperationMetricDimension.properties.toBeExportedForShoebox + - $.definitions.ActivityPolicy.properties.secureOutput + - $.definitions.SSISPropertyOverride.properties.isSensitive + - $.definitions.ForEachActivityTypeProperties.properties.isSequential + - $.definitions.ExecutePipelineActivityTypeProperties.properties.waitOnCompletion + - $.definitions.SelfHostedIntegrationRuntimeNode.properties.isActiveDispatcher + - $.definitions.IntegrationRuntimeConnectionInfo.properties.isIdentityCertExprired + reason: + - toBeExportedForShoebox is property we send to Azure Monitor which requries the boolean type + - The other properties are simple and self explanatory + ``` diff --git a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/catalog.json b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/catalog.json index dce1c84c82f9..243773558373 100644 --- a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/catalog.json +++ b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/catalog.json @@ -818,6 +818,104 @@ } } }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/tablefragments": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_ListTableFragments", + "description": "Retrieves the list of table fragments from the Data Lake Analytics catalog.", + "parameters": [ + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database containing the table fragments." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema containing the table fragments." + }, + { + "name": "tableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the table containing the table fragments." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to skip over before returning elements. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OrderBy clause. One or more comma-separated expressions with an optional \"asc\" (the default) or \"desc\" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of table fragments in the specified database and schema.", + "schema": { + "$ref": "#/definitions/USqlTableFragmentList" + } + } + }, + "x-ms-examples": { + "Retrieves the list of table fragments from the Data Lake Analytics catalog": { + "$ref": "./examples/Catalog_ListTableFragments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/USqlTableFragment" + } + }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables": { "get": { "tags": [ @@ -1578,6 +1676,77 @@ "x-ms-odata": "#/definitions/USqlTableStatistics" } }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions/{partitionName}/previewrows": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_PreviewTablePartition", + "description": "Retrieves a preview set of rows in given partition.", + "parameters": [ + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database containing the partition." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema containing the partition." + }, + { + "name": "tableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the table containing the partition." + }, + { + "name": "partitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the table partition." + }, + { + "name": "maxRows", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "description": "The maximum number of preview rows to be retrieved.Rows returned may be less than or equal to this number depending on row sizes and number of rows in the partition." + }, + { + "name": "maxColumns", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "description": "The maximum number of columns to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved preview rows for the specified partition.", + "schema": { + "$ref": "#/definitions/USqlTablePreview" + } + } + }, + "x-ms-examples": { + "Retrieves a preview set of rows in given partition": { + "$ref": "./examples/Catalog_PreviewTablePartition.json" + } + } + } + }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions/{partitionName}": { "get": { "tags": [ @@ -1633,6 +1802,70 @@ } } }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/previewrows": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_PreviewTable", + "description": "Retrieves a preview set of rows in given table.", + "parameters": [ + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database containing the table." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema containing the table." + }, + { + "name": "tableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the table." + }, + { + "name": "maxRows", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "description": "The maximum number of preview rows to be retrieved. Rows returned may be less than or equal to this number depending on row sizes and number of rows in the table." + }, + { + "name": "maxColumns", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "description": "The maximum number of columns to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved preview rows for the specified table.", + "schema": { + "$ref": "#/definitions/USqlTablePreview" + } + } + }, + "x-ms-examples": { + "Retrieves a preview set of rows in given table": { + "$ref": "./examples/Catalog_PreviewTable.json" + } + } + } + }, "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions": { "get": { "tags": [ @@ -3559,6 +3792,42 @@ }, "description": "A Data Lake Analytics catalog type field information item." }, + "USqlTablePreview": { + "properties": { + "totalRowCount": { + "type": "integer", + "format": "int64", + "description": "the total number of rows in the table or partition." + }, + "totalColumnCount": { + "type": "integer", + "format": "int64", + "description": "the total number of columns in the table or partition." + }, + "rows": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "the rows of the table or partition preview, where each row is an array of string representations the row's values. Note: Byte arrays will appear as base-64 encoded values, SqlMap and SqlArray objects will appear as escaped JSON objects, and DateTime objects will appear as ISO formatted UTC date-times." + }, + "truncated": { + "type": "boolean", + "description": "true if the amount of data in the response is less than expected due to the preview operation's size limitations. This can occur if the requested rows or row counts are too large." + }, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlTableColumn" + }, + "description": "the schema of the table or partition." + } + }, + "description": "A Data Lake Analytics catalog table or partition preview rows item." + }, "USqlTable": { "allOf": [ { @@ -3629,6 +3898,59 @@ }, "description": "A Data Lake Analytics catalog U-SQL table item list." }, + "USqlTableFragment": { + "properties": { + "parentId": { + "type": "string", + "format": "uuid", + "description": "the parent object Id of the table fragment. The parent could be a table or table partition." + }, + "fragmentId": { + "type": "string", + "format": "uuid", + "description": "the version of the catalog item." + }, + "indexId": { + "type": "integer", + "format": "int32", + "description": "the ordinal of the index which contains the table fragment." + }, + "size": { + "type": "integer", + "format": "int64", + "description": "the data size of the table fragment in bytes." + }, + "rowCount": { + "type": "integer", + "format": "int64", + "description": "the number of rows in the table fragment." + }, + "createDate": { + "type": "string", + "format": "date-time", + "description": "the creation time of the table fragment." + } + }, + "description": "A Data Lake Analytics catalog U-SQL table fragment item." + }, + "USqlTableFragmentList": { + "allOf": [ + { + "$ref": "#/definitions/CatalogItemList" + } + ], + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/USqlTableFragment" + }, + "description": "the list of table fragments in the database, schema and table combination" + } + }, + "description": "A Data Lake Analytics catalog U-SQL table fragment item list." + }, "USqlTableType": { "allOf": [ { diff --git a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_ListTableFragments.json b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_ListTableFragments.json new file mode 100644 index 000000000000..f119f573ed26 --- /dev/null +++ b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_ListTableFragments.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "accountName": "contosoadla", + "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net", + "databaseName": "master", + "schemaName": "dbo", + "tableName": "test_table_name", + "$filter": "test_filter", + "$top": 1, + "$skip": 1, + "$select": "test_select", + "$orderby": "test_orderby", + "$count": false + }, + "responses": { + "200": { + "body": { + "nextLink":"https://contosoadla.datalakeanalytics.net/catalog/usql/databases/master/schema/dbo/tables/test_table_name/tablefragments?api-version=2016-11-01&%24skiptoken=", + "value": [{ + "parentId": "9d2d7abd-c641-4ddb-88ab-90cafdfe1c1b", + "fragmentId": "797d2643-eed9-4900-8090-0f8ddd9e8ba7", + "indexId": 1, + "size": 33786, + "rowCount": 1, + "createDate": "2017-10-11T06:38:31.567-07:00" + }] + } + } + } +} diff --git a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_PreviewTable.json b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_PreviewTable.json new file mode 100644 index 000000000000..cd981e4bd261 --- /dev/null +++ b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_PreviewTable.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "accountName": "contosoadla", + "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net", + "databaseName": "master", + "schemaName": "dbo", + "tableName": "test_table_name" + }, + "responses": { + "200": { + "body": { + "totalRowCount": 1, + "totalColumnCount": 2, + "rows": [ + [ + "value_a", + "value_b" + ] + ], + "truncated": false, + "schema": [ + { + "name": "test_column_name", + "type": "test_data_type" + } + ] + } + } + } +} diff --git a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_PreviewTablePartition.json b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_PreviewTablePartition.json new file mode 100644 index 000000000000..e3d94341007c --- /dev/null +++ b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_PreviewTablePartition.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "accountName": "contosoadla", + "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net", + "databaseName": "master", + "schemaName": "dbo", + "tableName": "test_table_name", + "partitionName": "test_partition_name" + }, + "responses": { + "200": { + "body": { + "totalRowCount": 1, + "totalColumnCount": 2, + "rows": [ + [ + "value_a", + "value_b" + ] + ], + "truncated": false, + "schema": [ + { + "name": "test_column_name", + "type": "test_data_type" + } + ] + } + } + } +} diff --git a/specification/datalake-analytics/data-plane/readme.md b/specification/datalake-analytics/data-plane/readme.md index 95996832b001..3cedb30923da 100644 --- a/specification/datalake-analytics/data-plane/readme.md +++ b/specification/datalake-analytics/data-plane/readme.md @@ -100,7 +100,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node ``` @@ -191,7 +191,7 @@ Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-10-preview' && $(go) -output-folder: $(go-sdk-folder)/services/datalake/analytics/mgmt/2015-10-01-preview/account +output-folder: $(go-sdk-folder)/services/preview/datalake/analytics/mgmt/2015-10-01-preview/account ``` @@ -162,3 +165,39 @@ java: license-header: MICROSOFT_MIT_NO_CODEGEN output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datalake/analytics ``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-10-preview + - tag: package-2016-11 +``` + +### Tag: package-2015-10-preview and java + +These settings apply only when `--tag=package-2015-10-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-10-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datalakeanalytics.v2015_10_01_preview + output-folder: $(azure-libraries-for-java-folder)/datalakeanalytics/resource-manager/v2015_10_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-11 and java + +These settings apply only when `--tag=package-2016-11 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-11' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datalakeanalytics.v2016_11_01 + output-folder: $(azure-libraries-for-java-folder)/datalakeanalytics/resource-manager/v2016_11_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/datalake-analytics/resource-manager/readme.ruby.md b/specification/datalake-analytics/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..97c1fc498460 --- /dev/null +++ b/specification/datalake-analytics/resource-manager/readme.ruby.md @@ -0,0 +1,37 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_datalake_analytics +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2016-11 + - tag: package-2015-10-preview +``` + +### Tag: package-2016-11 and ruby + +These settings apply only when `--tag=package-2016-11 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-11' && $(ruby) +namespace: "Azure::DataLakeAnalytics::Mgmt::V2016_11_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_datalake_analytics/lib +``` + +### Tag: package-2015-10-preview and ruby + +These settings apply only when `--tag=package-2015-10-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-10-preview' && $(ruby) +namespace: "Azure::DataLakeAnalytics::Mgmt::V2015_10_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_datalake_analytics/lib +``` diff --git a/specification/datalake-store/data-plane/readme.md b/specification/datalake-store/data-plane/readme.md index 65f84a5f8a4c..fd7048489cf1 100644 --- a/specification/datalake-store/data-plane/readme.md +++ b/specification/datalake-store/data-plane/readme.md @@ -112,7 +112,7 @@ These settings apply only when `--tag=package-2015-10-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-10-preview' && $(go) -output-folder: $(go-sdk-folder)/services/datalake/store/2015-10-01-preview/filesystem +output-folder: $(go-sdk-folder)/services/preview/datalake/store/2015-10-01-preview/filesystem ``` diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/account.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/account.json index 4cbf0d1c3e84..5c14fc50ad18 100644 --- a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/account.json +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/account.json @@ -443,7 +443,7 @@ } }, "x-ms-examples": { - "Lists the Data Lake Store firewall rules within the specified Data Lake Store account": { + "Lists the Data Lake Store firewall rules within the specified Data Lake Store account.": { "$ref": "./examples/FirewallRules_ListByAccount.json" } }, @@ -539,7 +539,7 @@ } }, "x-ms-examples": { - "Gets the specified Data Lake Store firewall rule": { + "Gets the specified Data Lake Store firewall rule.": { "$ref": "./examples/FirewallRules_Get.json" } } @@ -589,7 +589,7 @@ } }, "x-ms-examples": { - "Updates the specified firewall rule": { + "Updates the specified firewall rule.": { "$ref": "./examples/FirewallRules_Update.json" } } @@ -599,7 +599,7 @@ "FirewallRules" ], "operationId": "FirewallRules_Delete", - "description": "Deletes the specified firewall rule from the specified Data Lake Store account", + "description": "Deletes the specified firewall rule from the specified Data Lake Store account.", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -630,12 +630,235 @@ } }, "x-ms-examples": { - "Deletes the specified firewall rule from the specified Data Lake Store account": { + "Deletes the specified firewall rule from the specified Data Lake Store account.": { "$ref": "./examples/FirewallRules_Delete.json" } } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/virtualNetworkRules": { + "get": { + "tags": [ + "VirtualNetworkRules" + ], + "operationId": "VirtualNetworkRules_ListByAccount", + "description": "Lists the Data Lake Store virtual network rules within the specified Data Lake Store account.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of virtual network rules.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRuleListResult" + } + } + }, + "x-ms-examples": { + "Lists the Data Lake Store virtual network rules within the specified Data Lake Store account.": { + "$ref": "./examples/VirtualNetworkRules_ListByAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "put": { + "tags": [ + "VirtualNetworkRules" + ], + "operationId": "VirtualNetworkRules_CreateOrUpdate", + "description": "Creates or updates the specified virtual network rule. During update, the virtual network rule with the specified name will be replaced with this new virtual network rule.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "virtualNetworkRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network rule to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateOrUpdateVirtualNetworkRuleParameters" + }, + "description": "Parameters supplied to create or update the virtual network rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the specified virtual network rule.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + } + }, + "x-ms-examples": { + "Creates or updates the specified virtual network rule. During update, the virtual network rule with the specified name will be replaced with this new virtual network rule.": { + "$ref": "./examples/VirtualNetworkRules_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "VirtualNetworkRules" + ], + "operationId": "VirtualNetworkRules_Get", + "description": "Gets the specified Data Lake Store virtual network rule.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "virtualNetworkRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network rule to retrieve." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the virtual network rule.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + } + }, + "x-ms-examples": { + "Gets the specified Data Lake Store virtual network rule.": { + "$ref": "./examples/VirtualNetworkRules_Get.json" + } + } + }, + "patch": { + "tags": [ + "VirtualNetworkRules" + ], + "operationId": "VirtualNetworkRules_Update", + "description": "Updates the specified virtual network rule.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "virtualNetworkRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network rule to update." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/UpdateVirtualNetworkRuleParameters" + }, + "description": "Parameters supplied to update the virtual network rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the specified virtual network rule.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + } + }, + "x-ms-examples": { + "Updates the specified virtual network rule.": { + "$ref": "./examples/VirtualNetworkRules_Update.json" + } + } + }, + "delete": { + "tags": [ + "VirtualNetworkRules" + ], + "operationId": "VirtualNetworkRules_Delete", + "description": "Deletes the specified virtual network rule from the specified Data Lake Store account.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "virtualNetworkRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network rule to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the specified virtual network rule." + }, + "204": { + "description": "The specified virtual network rule does not exist or was already deleted." + } + }, + "x-ms-examples": { + "Deletes the specified virtual network rule from the specified Data Lake Store account.": { + "$ref": "./examples/VirtualNetworkRules_Delete.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders": { "get": { "tags": [ @@ -1117,6 +1340,14 @@ }, "description": "The list of firewall rules associated with this Data Lake Store account." }, + "virtualNetworkRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "The list of virtual network rules associated with this Data Lake Store account." + }, "firewallState": { "readOnly": true, "type": "string", @@ -1410,6 +1641,50 @@ }, "description": "Data Lake Store firewall rule list information." }, + "VirtualNetworkRule": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "readOnly": true, + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkRuleProperties", + "description": "The virtual network rule properties." + } + }, + "description": "Data Lake Store virtual network rule information." + }, + "VirtualNetworkRuleProperties": { + "properties": { + "subnetId": { + "readOnly": true, + "type": "string", + "description": "The resource identifier for the subnet." + } + }, + "description": "The virtual network rule properties." + }, + "VirtualNetworkRuleListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "The results of the list operation." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The link (url) to the next page of results." + } + }, + "description": "Data Lake Store virtual network rule list information." + }, "TrustedIdProvider": { "allOf": [ { @@ -1645,6 +1920,13 @@ }, "description": "The list of firewall rules associated with this Data Lake Store account." }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/CreateVirtualNetworkRuleWithAccountParameters" + }, + "description": "The list of virtual network rules associated with this Data Lake Store account." + }, "firewallState": { "type": "string", "enum": [ @@ -1741,6 +2023,13 @@ }, "description": "The list of firewall rules associated with this Data Lake Store account." }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/UpdateVirtualNetworkRuleWithAccountParameters" + }, + "description": "The list of virtual network rules associated with this Data Lake Store account." + }, "firewallState": { "type": "string", "enum": [ @@ -1910,6 +2199,85 @@ }, "description": "The firewall rule properties to use when updating a firewall rule." }, + "CreateOrUpdateVirtualNetworkRuleParameters": { + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CreateOrUpdateVirtualNetworkRuleProperties", + "description": "The virtual network rule properties to use when creating a new virtual network rule." + } + }, + "description": "The parameters used to create a new virtual network rule." + }, + "CreateVirtualNetworkRuleWithAccountParameters": { + "required": [ + "name", + "properties" + ], + "properties": { + "name": { + "type": "string", + "description": "The unique name of the virtual network rule to create." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CreateOrUpdateVirtualNetworkRuleProperties", + "description": "The virtual network rule properties to use when creating a new virtual network rule." + } + }, + "description": "The parameters used to create a new virtual network rule while creating a new Data Lake Store account." + }, + "CreateOrUpdateVirtualNetworkRuleProperties": { + "required": [ + "subnetId" + ], + "properties": { + "subnetId": { + "type": "string", + "description": "The resource identifier for the subnet." + } + }, + "description": "The virtual network rule properties to use when creating a new virtual network rule." + }, + "UpdateVirtualNetworkRuleParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UpdateVirtualNetworkRuleProperties", + "description": "The virtual network rule properties to use when updating a virtual network rule." + } + }, + "description": "The parameters used to update a virtual network rule." + }, + "UpdateVirtualNetworkRuleWithAccountParameters": { + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "The unique name of the virtual network rule to update." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UpdateVirtualNetworkRuleProperties", + "description": "The virtual network rule properties to use when updating a virtual network rule." + } + }, + "description": "The parameters used to update a virtual network rule while updating a Data Lake Store account." + }, + "UpdateVirtualNetworkRuleProperties": { + "properties": { + "subnetId": { + "type": "string", + "description": "The resource identifier for the subnet." + } + }, + "description": "The virtual network rule properties to use when updating a virtual network rule." + }, "CreateOrUpdateTrustedIdProviderParameters": { "required": [ "properties" diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_CreateOrUpdate.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_CreateOrUpdate.json new file mode 100644 index 000000000000..0cc1b43c0a2d --- /dev/null +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_CreateOrUpdate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "contosorg", + "accountName": "contosoadla", + "virtualNetworkRuleName": "test_virtual_network_rules_name", + "parameters": { + "properties": { + "subnetId": "test_subnetId" + } + } + }, + "responses": { + "200": { + "body": { + "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test_virtual_network_rules_name", + "type": "test_type", + "properties": { + "subnetId": "test_subnetId" + } + } + } + } +} diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_Delete.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_Delete.json new file mode 100644 index 000000000000..3cdc988c0d79 --- /dev/null +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "contosorg", + "accountName": "contosoadla", + "virtualNetworkRuleName": "test_virtual_network_rules_name" + }, + "responses": { + "200": { + }, + "204": { + } + } +} diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_Get.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_Get.json new file mode 100644 index 000000000000..6ea34ad1e667 --- /dev/null +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "contosorg", + "accountName": "contosoadla", + "virtualNetworkRuleName": "test_virtual_network_rules_name" + }, + "responses": { + "200": { + "body": { + "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test_virtual_network_rules_name", + "type": "test_type", + "properties": { + "subnetId": "test_subnetId" + } + } + } + } +} + diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_ListByAccount.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_ListByAccount.json new file mode 100644 index 000000000000..fb4100b0adf8 --- /dev/null +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_ListByAccount.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "contosorg", + "accountName": "contosoadla" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test_virtual_network_rules_name", + "type": "test_type", + "properties": { + "subnetId": "test_subnetId" + } + }], + "nextLink": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosorg/providers/Microsoft.DataLakeStore/accounts/contosoadla/jobPolicies?api-version=2016-11-01&%24skiptoken=" + } + } + } +} + diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_Update.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_Update.json new file mode 100644 index 000000000000..0cc1b43c0a2d --- /dev/null +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/VirtualNetworkRules_Update.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "contosorg", + "accountName": "contosoadla", + "virtualNetworkRuleName": "test_virtual_network_rules_name", + "parameters": { + "properties": { + "subnetId": "test_subnetId" + } + } + }, + "responses": { + "200": { + "body": { + "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "name": "test_virtual_network_rules_name", + "type": "test_type", + "properties": { + "subnetId": "test_subnetId" + } + } + } + } +} diff --git a/specification/datalake-store/resource-manager/readme.md b/specification/datalake-store/resource-manager/readme.md index ba17eac0caf4..1416229383bd 100644 --- a/specification/datalake-store/resource-manager/readme.md +++ b/specification/datalake-store/resource-manager/readme.md @@ -76,9 +76,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_datalake_store'] ``` @@ -158,7 +161,7 @@ These settings apply only when `--tag=package-2015-10-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-10-preview' && $(go) -output-folder: $(go-sdk-folder)/services/datalake/store/mgmt/2015-10-01-preview/account +output-folder: $(go-sdk-folder)/services/preview/datalake/store/mgmt/2015-10-01-preview/account ``` @@ -174,3 +177,39 @@ java: license-header: MICROSOFT_MIT_NO_CODEGEN output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datalake/store ``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-10-preview + - tag: package-2016-11 +``` + +### Tag: package-2015-10-preview and java + +These settings apply only when `--tag=package-2015-10-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-10-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datalakestore.v2015_10_01_preview + output-folder: $(azure-libraries-for-java-folder)/datalakestore/resource-manager/v2015_10_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-11 and java + +These settings apply only when `--tag=package-2016-11 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-11' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datalakestore.v2016_11_01 + output-folder: $(azure-libraries-for-java-folder)/datalakestore/resource-manager/v2016_11_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/datalake-store/resource-manager/readme.ruby.md b/specification/datalake-store/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..39a8e6f46ab3 --- /dev/null +++ b/specification/datalake-store/resource-manager/readme.ruby.md @@ -0,0 +1,37 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_datalake_store +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2016-11 + - tag: package-2015-10-preview +``` + +### Tag: package-2016-11 and ruby + +These settings apply only when `--tag=package-2016-11 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-11' && $(ruby) +namespace: "Azure::DataLakeStore::Mgmt::V2016_11_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_datalake_store/lib +``` + +### Tag: package-2015-10-preview and ruby + +These settings apply only when `--tag=package-2015-10-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-10-preview' && $(ruby) +namespace: "Azure::DataLakeStore::Mgmt::V2015_10_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_datalake_store/lib +``` diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/MigrateSqlServerSqlDbTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/MigrateSqlServerSqlDbTask.json index 3b09e8bb79a9..58ba53733ac1 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/MigrateSqlServerSqlDbTask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/MigrateSqlServerSqlDbTask.json @@ -62,6 +62,7 @@ "MigrateSqlServerSqlDbTaskOutputMigrationLevel": { "x-ms-discriminator-value": "MigrationLevelOutput", "type": "object", + "description": "Migration level result for Sql server to Azure Sql DB migration.", "properties": { "startedOn": { "type": "string", @@ -154,6 +155,7 @@ }, "MigrateSqlServerSqlDbTaskOutputDatabaseLevel": { "type": "object", + "description": "Database level result for Sql Server to Azure Sql DB migration.", "x-ms-discriminator-value": "DatabaseLevelOutput", "properties": { "databaseName": { @@ -246,6 +248,7 @@ }, "MigrateSqlServerSqlDbTaskOutputTableLevel": { "type": "object", + "description": "Table level result for Sql Server to Azure Sql DB migration.", "x-ms-discriminator-value": "TableLevelOutput", "properties": { "objectName": { @@ -306,6 +309,7 @@ }, "MigrateSqlServerSqlDbTaskOutputError": { "type": "object", + "description": "Task errors for Sql Server to Azure Sql DB migration.", "x-ms-discriminator-value": "ErrorOutput", "properties": { "id": { @@ -370,6 +374,7 @@ "MigrateSqlServerSqlDbTaskOutputValidationResult": { "x-ms-discriminator-value": "MigrationValidationOutput", "type": "object", + "description": "Validation result for Sql Server to Azure Sql DB migration.", "$ref": "./MigrationValidation.json#/definitions/MigrationValidationResult", "allOf": [ { @@ -380,6 +385,7 @@ "MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult": { "x-ms-discriminator-value": "MigrationDatabaseLevelValidationOutput", "type": "object", + "description": "Database validation result for Sql Server to Azure Sql DB migration.", "$ref": "./MigrationValidation.json#/definitions/MigrationValidationDatabaseLevelResult", "allOf": [ { diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/examples/Services_NestedCheckNameAvailability.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/examples/Services_NestedCheckNameAvailability.json new file mode 100644 index 000000000000..f958e0f84674 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/examples/Services_NestedCheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "api-version": "2017-11-15-preview", + "parameters": { + "requestedName": { + "name": "Task1", + "type": "tasks" + } + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/MigrateSqlServerSqlDbTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/MigrateSqlServerSqlDbTask.json index 4ad624a45f34..bd533f98c446 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/MigrateSqlServerSqlDbTask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/MigrateSqlServerSqlDbTask.json @@ -62,6 +62,7 @@ "MigrateSqlServerSqlDbTaskOutputMigrationLevel": { "x-ms-discriminator-value": "MigrationLevelOutput", "type": "object", + "description": "Migration level result for Sql server to Azure Sql DB migration.", "properties": { "startedOn": { "type": "string", @@ -154,6 +155,7 @@ }, "MigrateSqlServerSqlDbTaskOutputDatabaseLevel": { "type": "object", + "description": "Database level result for Sql Server to Azure Sql DB migration.", "x-ms-discriminator-value": "DatabaseLevelOutput", "properties": { "databaseName": { @@ -246,6 +248,7 @@ }, "MigrateSqlServerSqlDbTaskOutputTableLevel": { "type": "object", + "description": "Table level result for Sql Server to Azure Sql DB migration.", "x-ms-discriminator-value": "TableLevelOutput", "properties": { "objectName": { @@ -306,6 +309,7 @@ }, "MigrateSqlServerSqlDbTaskOutputError": { "type": "object", + "description": "Task errors for Sql Server to Azure Sql DB migration.", "x-ms-discriminator-value": "ErrorOutput", "properties": { "id": { @@ -370,6 +374,7 @@ "MigrateSqlServerSqlDbTaskOutputValidationResult": { "x-ms-discriminator-value": "MigrationValidationOutput", "type": "object", + "description": "Validation result for Sql Server to Azure Sql DB migration.", "$ref": "./MigrationValidation.json#/definitions/MigrationValidationResult", "allOf": [ { @@ -380,6 +385,7 @@ "MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult": { "x-ms-discriminator-value": "MigrationDatabaseLevelValidationOutput", "type": "object", + "description": "Database validation result for Sql Server to Azure Sql DB migration.", "$ref": "./MigrationValidation.json#/definitions/MigrationValidationDatabaseLevelResult", "allOf": [ { diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/MigrateSqlServerSqlMITask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/MigrateSqlServerSqlMITask.json index 857f77a1be68..9a9173258fab 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/MigrateSqlServerSqlMITask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/MigrateSqlServerSqlMITask.json @@ -66,6 +66,7 @@ }, "MigrateSqlServerSqlMITaskOutputMigrationLevel": { "type": "object", + "description": "Migration level result for Sql server to Sql MI migration.", "x-ms-discriminator-value": "MigrationLevelOutput", "properties": { "startedOn": { @@ -140,6 +141,7 @@ }, "MigrateSqlServerSqlMITaskOutputDatabaseLevel": { "type": "object", + "description": "Database level result for Sql Server to Sql MI migration.", "x-ms-discriminator-value": "DatabaseLevelOutput", "properties": { "databaseName": { @@ -191,6 +193,7 @@ }, "MigrateSqlServerSqlMITaskOutputError": { "type": "object", + "description": "Task errors for Sql Server to Sql MI migration.", "x-ms-discriminator-value": "ErrorOutput", "properties": { "id": { diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/TasksCommon.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/TasksCommon.json index 365d94539564..65b8b0701bab 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/TasksCommon.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/TasksCommon.json @@ -352,7 +352,8 @@ "readOnly": true }, "type": { - "$ref": "#/definitions/ErrorType" + "$ref": "#/definitions/ErrorType", + "description": "Type of error." } } }, diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/examples/Services_NestedCheckNameAvailability.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/examples/Services_NestedCheckNameAvailability.json new file mode 100644 index 000000000000..e2b08c3cb47e --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/examples/Services_NestedCheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "api-version": "2018-03-15-preview", + "parameters": { + "requestedName": { + "name": "Task1", + "type": "tasks" + } + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/TasksCommon.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/TasksCommon.json index 74571d445123..e17e42f57991 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/TasksCommon.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/TasksCommon.json @@ -352,7 +352,8 @@ "readOnly": true }, "type": { - "$ref": "#/definitions/ErrorType" + "$ref": "#/definitions/ErrorType", + "description": "Type of error." } } }, @@ -544,7 +545,7 @@ }, "StartMigrationScenarioServerRoleResult": { "type": "object", - "description": "", + "description": "Server role migration result", "properties": { "name": { "type": "string", diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/examples/Services_NestedCheckNameAvailability.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/examples/Services_NestedCheckNameAvailability.json new file mode 100644 index 000000000000..0a85fee1d23a --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/examples/Services_NestedCheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "api-version": "2018-03-31-preview", + "parameters": { + "requestedName": { + "name": "Task1", + "type": "tasks" + } + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/datamigration.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/datamigration.json new file mode 100644 index 000000000000..d91194f27e3b --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/datamigration.json @@ -0,0 +1,1239 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19", + "description": "The Database Migration Service helps people migrate their data from on-premise database servers to Azure, or from older database software to newer software. The service manages one or more workers that are joined to a customer's virtual network, which is assumed to provide connectivity to their databases. To avoid frequent updates to the resource provider, database migration tasks are implemented by the resource provider in a generic way as task resources, each of which has a task type (which identifies the type of work to run), input, and output. The client is responsible for providing appropriate task type and inputs, which will be passed through unexamined to the machines that implement the functionality, and for understanding the output, which is passed back unexamined to the client.", + "x-ms-code-generation-settings": { + "name": "DataMigrationServiceClient", + "useDateTimeOffset": true + } + }, + "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.DataMigration/skus": { + "get": { + "summary": "Get supported SKUs", + "description": "The skus action returns the list of SKUs that DMS supports.", + "tags": [ + "Standard operation", + "GET" + ], + "operationId": "ResourceSkus_ListSkus", + "x-ms-examples": { + "ListSkus": { "$ref": "./examples/ResourceSkus_ListSkus.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Got SKUs", + "schema": { + "$ref": "./definitions/ResourceSkus.json#/definitions/ResourceSkusResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}": { + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "put": { + "summary": "Create or update DMS Instance", + "description": "The services resource is the top-level resource that represents the Database Migration Service. The PUT method creates a new service or updates an existing one. When a service is updated, existing child resources (i.e. tasks) are unaffected. Services currently support a single kind, \"vm\", which refers to a VM-based service, although other kinds may be added in the future. This method can change the kind, SKU, and network of the service, but if tasks are currently running (i.e. the service is busy), this will fail with 400 Bad Request (\"ServiceIsBusy\"). The provider will reply when successful with 200 OK or 201 Created. Long-running operations use the provisioningState property.", + "tags": [ + "Service resource", + "Standard operation", + "PUT" + ], + "operationId": "Services_CreateOrUpdate", + "x-ms-examples": { + "Services_CreateOrUpdate": { "$ref": "./examples/Services_CreateOrUpdate.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/service" + } + ], + "x-ms-long-running-operation": true, + "responses": { + "200": { + "description": "Service updated", + "schema": { + "$ref": "./definitions/Services.json#/definitions/DataMigrationService" + } + }, + "201": { + "description": "Service created (use provisioningState)", + "schema": { + "$ref": "./definitions/Services.json#/definitions/DataMigrationService" + } + }, + "202": { + "description": "Update accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + }, + "get": { + "summary": "Get DMS Service Instance", + "description": "The services resource is the top-level resource that represents the Database Migration Service. The GET method retrieves information about a service instance.", + "tags": [ + "Service resource", + "Standard operation", + "GET" + ], + "operationId": "Services_Get", + "x-ms-examples": { + "Services_CreateOrUpdate": { "$ref": "./examples/Services_Get.json" } + }, + "responses": { + "200": { + "description": "A service instance resource", + "schema": { + "$ref": "./definitions/Services.json#/definitions/DataMigrationService" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + }, + "delete": { + "summary": "Delete DMS Service Instance", + "description": "The services resource is the top-level resource that represents the Database Migration Service. The DELETE method deletes a service. Any running tasks will be canceled.", + "tags": [ + "Service resource", + "Standard operation", + "DELETE" + ], + "parameters": [ + { + "$ref": "#/parameters/deleteRunningTasks" + } + ], + "operationId": "Services_Delete", + "x-ms-examples": { + "Services_CreateOrUpdate": { "$ref": "./examples/Services_Delete.json" } + }, + "x-ms-long-running-operation": true, + "responses": { + "200": { + "description": "Service resource deleted" + }, + "202": { + "description": "Deletion accepted" + }, + "204": { + "description": "Service not found" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + }, + "patch": { + "summary": "Create or update DMS Service Instance", + "description": "The services resource is the top-level resource that represents the Database Migration Service. The PATCH method updates an existing service. This method can change the kind, SKU, and network of the service, but if tasks are currently running (i.e. the service is busy), this will fail with 400 Bad Request (\"ServiceIsBusy\").", + "tags": [ + "Service resource", + "Standard operation", + "PATCH" + ], + "operationId": "Services_Update", + "x-ms-examples": { + "Services_CreateOrUpdate": { "$ref": "./examples/Services_Update.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/service" + } + ], + "x-ms-long-running-operation": true, + "responses": { + "200": { + "description": "Service resource updated", + "schema": { + "$ref": "./definitions/Services.json#/definitions/DataMigrationService" + } + }, + "202": { + "description": "Update accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/checkStatus": { + "post": { + "summary": "Check service health status", + "description": "The services resource is the top-level resource that represents the Database Migration Service. This action performs a health check and returns the status of the service and virtual machine size.", + "tags": [ + "Service resource", + "Custom operation", + "POST" + ], + "operationId": "Services_CheckStatus", + "x-ms-examples": { + "Services_CheckStatus": { "$ref": "./examples/Services_CheckStatus.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Health checked", + "schema": { + "$ref": "./definitions/Services.json#/definitions/DataMigrationServiceStatusResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/start": { + "post": { + "summary": "Start service", + "description": "The services resource is the top-level resource that represents the Database Migration Service. This action starts the service and the service can be used for data migration.", + "tags": [ + "Service resource", + "Custom operation", + "POST" + ], + "operationId": "Services_Start", + "x-ms-examples": { + "Services_Start": { "$ref": "./examples/Services_Start.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "x-ms-long-running-operation": true, + "responses": { + "200": { + "description": "The service has already been started." + }, + "202": { + "description": "The request to start service is accepted." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/stop": { + "post": { + "summary": "Stop service", + "description": "The services resource is the top-level resource that represents the Database Migration Service. This action stops the service and the service cannot be used for data migration. The service owner won't be billed when the service is stopped.", + "tags": [ + "Service resource", + "Custom operation", + "POST" + ], + "operationId": "Services_Stop", + "x-ms-examples": { + "Services_Stop": { "$ref": "./examples/Services_Stop.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "x-ms-long-running-operation": true, + "responses": { + "200": { + "description": "The service has already been stopped." + }, + "202": { + "description": "The request to stop service is accepted." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/skus": { + "get": { + "summary": "Get compatible SKUs", + "description": "The services resource is the top-level resource that represents the Database Migration Service. The skus action returns the list of SKUs that a service resource can be updated to.", + "tags": [ + "Service resource", + "Standard operation", + "GET" + ], + "operationId": "Services_ListSkus", + "x-ms-examples": { + "Services_ListSkus": { "$ref": "./examples/Services_ListSkus.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Got SKUs", + "schema": { + "$ref": "./definitions/Services.json#/definitions/ServiceSkuList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks": { + "get": { + "summary": "Get tasks in a service", + "description": "The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of tasks owned by a service resource. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.", + "tags": [ + "Service resource", + "Standard operation", + "GET" + ], + "operationId": "Tasks_List", + "x-ms-examples": { + "Tasks_List": { "$ref": "./examples/Tasks_List.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/projectName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/taskType" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Got tasks", + "schema": { + "$ref": "./definitions/Tasks.json#/definitions/TaskList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/checkNameAvailability": { + "post": { + "summary": "Check nested resource name validity and availability", + "description": "This method checks whether a proposed nested resource name is valid and available.", + "tags": [ + "Custom operation", + "POST" + ], + "operationId": "Services_NestedCheckNameAvailability", + "x-ms-examples": { + "Services_NestedCheckNameAvailability": { "$ref": "./examples/Services_NestedCheckNameAvailability.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/requestedName" + } + ], + "responses": { + "200": { + "description": "Name checked", + "schema": { + "$ref": "./definitions/Common.json#/definitions/NameAvailabilityResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services": { + "get": { + "summary": "Get services in resource group", + "description": "The Services resource is the top-level resource that represents the Database Migration Service. This method returns a list of service resources in a resource group.", + "tags": [ + "Service resource", + "Standard operation", + "GET" + ], + "operationId": "Services_ListByResourceGroup", + "x-ms-examples": { + "Services_ListByResourceGroup": { "$ref": "./examples/Services_ListByResourceGroup.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Got services", + "schema": { + "$ref": "./definitions/Services.json#/definitions/DataMigrationServiceList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/services": { + "get": { + "summary": "Get services in subscription", + "description": "The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of service resources in a subscription.", + "tags": [ + "Service resource", + "Standard operation", + "GET" + ], + "operationId": "Services_List", + "x-ms-examples": { + "Services_List": { "$ref": "./examples/Services_List.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Got services", + "schema": { + "$ref": "./definitions/Services.json#/definitions/DataMigrationServiceList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}": { + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/projectName" + }, + { + "$ref": "#/parameters/taskName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "put": { + "summary": "Create or update task", + "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an exising one.", + "tags": [ + "Task resource", + "Standard operation", + "PUT" + ], + "operationId": "Tasks_CreateOrUpdate", + "x-ms-examples": { + "Tasks_CreateOrUpdate": { "$ref": "./examples/Tasks_CreateOrUpdate.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/projectTask" + } + ], + "responses": { + "200": { + "description": "Task updated", + "schema": { + "$ref": "./definitions/Tasks.json#/definitions/ProjectTask" + } + }, + "201": { + "description": "Task created", + "schema": { + "$ref": "./definitions/Tasks.json#/definitions/ProjectTask" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + }, + "get": { + "summary": "Get task information", + "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The GET method retrieves information about a task.", + "tags": [ + "Task resource", + "Standard operation", + "GET" + ], + "operationId": "Tasks_Get", + "x-ms-examples": { + "Tasks_Get": { "$ref": "./examples/Tasks_Get.json" } + }, + "parameters": [ + { + "name": "$expand", + "description": "Expand the response", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "A task resource", + "schema": { + "$ref": "./definitions/Tasks.json#/definitions/ProjectTask" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + }, + "delete": { + "summary": "Delete task", + "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The DELETE method deletes a task, canceling it first if it's running.", + "tags": [ + "Task resource", + "Standard operation", + "DELETE" + ], + "parameters": [ + { + "$ref": "#/parameters/deleteRunningTasks" + } + ], + "operationId": "Tasks_Delete", + "x-ms-examples": { + "Tasks_Delete": { "$ref": "./examples/Tasks_Delete.json" } + }, + "responses": { + "200": { + "description": "Task resource deleted" + }, + "204": { + "description": "Not found" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + }, + "patch": { + "summary": "Create or update task", + "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PATCH method updates an existing task, but since tasks have no mutable custom properties, there is little reason to do so.", + "tags": [ + "Task resource", + "Standard operation", + "PATCH" + ], + "operationId": "Tasks_Update", + "x-ms-examples": { + "Tasks_Update": { "$ref": "./examples/Tasks_Update.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/projectTask" + } + ], + "responses": { + "200": { + "description": "Task resource updated", + "schema": { + "$ref": "./definitions/Tasks.json#/definitions/ProjectTask" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/tasks/{taskName}/cancel": { + "post": { + "summary": "Cancel a task", + "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. This method cancels a task if it's currently queued or running.", + "tags": [ + "Task resource", + "Custom operation", + "POST" + ], + "operationId": "Tasks_Cancel", + "x-ms-examples": { + "Tasks_Cancel": { "$ref": "./examples/Tasks_Cancel.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/projectName" + }, + { + "$ref": "#/parameters/taskName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Task canceled", + "schema": { + "$ref": "./definitions/Tasks.json#/definitions/ProjectTask" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects": { + "get": { + "summary": "Get projects in a service", + "description": "The project resource is a nested resource representing a stored migration project. This method returns a list of projects owned by a service resource.", + "tags": [ + "Project resource", + "Standard operation", + "GET" + ], + "operationId": "Projects_ListByResourceGroup", + "x-ms-examples": { + "Projects_ListByResourceGroup": { "$ref": "./examples/Projects_List.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "List of projects", + "schema": { + "$ref": "./definitions/Projects.json#/definitions/ProjectList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}": { + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/projectName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "put": { + "summary": "Create or update project", + "description": "The project resource is a nested resource representing a stored migration project. The PUT method creates a new project or updates an existing one.", + "tags": [ + "Project resource", + "Standard operation", + "PUT" + ], + "operationId": "Projects_CreateOrUpdate", + "x-ms-examples": { + "Projects_CreateOrUpdate": { "$ref": "./examples/Projects_CreateOrUpdate.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/project" + } + ], + "responses": { + "200": { + "description": "Project updated", + "schema": { + "$ref": "./definitions/Projects.json#/definitions/Project" + } + }, + "201": { + "description": "Project created", + "schema": { + "$ref": "./definitions/Projects.json#/definitions/Project" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + }, + "get": { + "summary": "Get project information", + "description": "The project resource is a nested resource representing a stored migration project. The GET method retrieves information about a project.", + "tags": [ + "Project resource", + "Standard operation", + "GET" + ], + "operationId": "Projects_Get", + "x-ms-examples": { + "Projects_Get": { "$ref": "./examples/Projects_Get.json" } + }, + "responses": { + "200": { + "description": "A project resource", + "schema": { + "$ref": "./definitions/Projects.json#/definitions/Project" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + }, + "delete": { + "summary": "Delete project", + "description": "The project resource is a nested resource representing a stored migration project. The DELETE method deletes a project.", + "tags": [ + "Project resource", + "Standard operation", + "DELETE" + ], + "parameters": [ + { + "$ref": "#/parameters/deleteRunningTasks" + } + ], + "operationId": "Projects_Delete", + "x-ms-examples": { + "Projects_Delete": { "$ref": "./examples/Projects_Delete.json" } + }, + "responses": { + "200": { + "description": "Project resource deleted" + }, + "204": { + "description": "Not found" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + }, + "patch": { + "summary": "Update project", + "description": "The project resource is a nested resource representing a stored migration project. The PATCH method updates an existing project.", + "tags": [ + "Project resource", + "Standard operation", + "PATCH" + ], + "operationId": "Projects_Update", + "x-ms-examples": { + "Projects_Update": { "$ref": "./examples/Projects_Update.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/project" + } + ], + "responses": { + "200": { + "description": "Project resource updated", + "schema": { + "$ref": "./definitions/Projects.json#/definitions/Project" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/locations/{location}/checkNameAvailability": { + "post": { + "summary": "Check name validity and availability", + "description": "This method checks whether a proposed top-level resource name is valid and available.", + "tags": [ + "Standard operation", + "POST" + ], + "operationId": "Services_CheckNameAvailability", + "x-ms-examples": { + "Services_CheckNameAvailability": { "$ref": "./examples/Services_CheckNameAvailability.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/location" + }, + { + "$ref": "#/parameters/requestedName" + } + ], + "responses": { + "200": { + "description": "Name checked", + "schema": { + "$ref": "./definitions/Common.json#/definitions/NameAvailabilityResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataMigration/locations/{location}/usages": { + "get": { + "summary": "Get resource quotas and usage information", + "description": "This method returns region-specific quotas and resource usage information for the Database Migration Service.", + "tags": [ + "Standard operation", + "GET" + ], + "operationId": "Usages_List", + "x-ms-examples": { + "Services_Usages": { "$ref": "./examples/Usages_List.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/location" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Quotas returned", + "schema": { + "$ref": "./definitions/Common.json#/definitions/QuotaList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/providers/Microsoft.DataMigration/operations": { + "get": { + "summary": "Get available resource provider actions (operations)", + "description": "Lists all available actions exposed by the Database Migration Service resource provider.", + "tags": [ + "Standard operation", + "GET" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "Operations_List": { "$ref": "./examples/Operations_List.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Got action list", + "schema": { + "$ref": "./definitions/Services.json#/definitions/ServiceOperationList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "description": "Version of the API", + "in": "query", + "required": true, + "type": "string" + }, + "deleteRunningTasks": { + "name": "deleteRunningTasks", + "description": "Delete the resource even if it contains running tasks", + "in": "query", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "groupName": { + "name": "groupName", + "description": "Name of the resource group", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "location": { + "name": "location", + "description": "The Azure region of the operation", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "project": { + "name": "parameters", + "description": "Information about the project", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions/Projects.json#/definitions/Project" + }, + "x-ms-parameter-location": "method" + }, + "projectName": { + "name": "projectName", + "description": "Name of the project", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "requestedName": { + "name": "parameters", + "description": "Requested name to validate", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions/Common.json#/definitions/NameAvailabilityRequest" + }, + "x-ms-parameter-location": "method" + }, + "taskName": { + "name": "taskName", + "description": "Name of the Task", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "taskType": { + "name": "taskType", + "description": "Filter tasks by task type", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "service": { + "name": "parameters", + "description": "Information about the service", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions/Services.json#/definitions/DataMigrationService" + }, + "x-ms-parameter-location": "method" + }, + "serviceName": { + "name": "serviceName", + "description": "Name of the service", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "description": "Identifier of the subscription", + "in": "path", + "required": true, + "type": "string" + }, + "projectTask": { + "name": "parameters", + "description": "Information about the task", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions/Tasks.json#/definitions/ProjectTask" + }, + "x-ms-parameter-location": "method" + }, + "timeoutMs": { + "name": "timeoutMs", + "description": "The number of milliseconds the task is allowed to run, up to 20000", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Common.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Common.json new file mode 100644 index 000000000000..4fa419b122ee --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Common.json @@ -0,0 +1,321 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ApiError": { + "type": "object", + "description": "Error information.", + "properties": { + "error": { + "description": "Error information in OData format", + "$ref": "#/definitions/ODataError" + } + } + }, + "NameAvailabilityResponse": { + "type": "object", + "description": "Indicates whether a proposed resource name is available", + "properties": { + "nameAvailable": { + "readOnly": true, + "type": "boolean", + "description": "If true, the name is valid and available. If false, 'reason' describes why not." + }, + "reason": { + "readOnly": true, + "type": "string", + "description": "The reason why the name is not available, if nameAvailable is false", + "enum": [ + "AlreadyExists", + "Invalid" + ], + "x-ms-enum": { + "name": "NameCheckFailureReason", + "modelAsString": true + } + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The localized reason why the name is not available, if nameAvailable is false" + } + } + }, + "NameAvailabilityRequest": { + "type": "object", + "description": "A resource type and proposed name", + "properties": { + "name": { + "type": "string", + "description": "The proposed resource name" + }, + "type": { + "type": "string", + "description": "The resource type chain (e.g. virtualMachines/extensions)" + } + } + }, + "ODataError": { + "type": "object", + "description": "Error information in OData format.", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError'" + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The human-readable description of the error" + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + }, + "description": "Inner errors that caused this error" + } + } + }, + "Quota": { + "type": "object", + "description": "Describes a quota for or usage details about a resource", + "properties": { + "currentValue": { + "type": "number", + "format": "double", + "description": "The current value of the quota. If null or missing, the current value cannot be determined in the context of the request." + }, + "id": { + "type": "string", + "description": "The resource ID of the quota object" + }, + "limit": { + "type": "number", + "format": "double", + "description": "The maximum value of the quota. If null or missing, the quota has no maximum, in which case it merely tracks usage." + }, + "name": { + "type": "object", + "description": "The name of the quota", + "properties": { + "localizedValue": { + "type": "string", + "description": "The localized name of the quota" + }, + "value": { + "type": "string", + "description": "The unlocalized name (or ID) of the quota" + } + } + }, + "unit": { + "type": "string", + "description": "The unit for the quota, such as Count, Bytes, BytesPerSecond, etc." + } + } + }, + "QuotaList": { + "type": "object", + "description": "OData page of quota objects", + "properties": { + "value": { + "type": "array", + "description": "List of quotas", + "items": { + "$ref": "#/definitions/Quota" + } + }, + "nextLink": { + "type": "string", + "description": "URL to load the next page of quotas, or null or missing if this is the last page" + } + } + }, + "ReportableException": { + "type": "object", + "description": "Exception object for all custom exceptions", + "properties": { + "message": { + "readOnly": true, + "type": "string", + "description": "Error message" + }, + "filePath": { + "readOnly": true, + "type": "string", + "description": "The path to the file where exception occurred" + }, + "lineNumber": { + "readOnly": true, + "type": "string", + "description": "The line number where exception occurred" + }, + "hResult": { + "readOnly": true, + "type": "integer", + "description": "Coded numerical value that is assigned to a specific exception" + }, + "stackTrace": { + "readOnly": true, + "type": "string", + "description": "Stack trace" + } + } + }, + "Resource": { + "description": "ARM 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." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "ARM tracked top level resource.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource location." + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ConnectionInfo": { + "type": "object", + "description": "Defines the connection properties of a server", + "x-ms-discriminator-value": "Unknown", + "properties": { + "type": { + "type": "string", + "description": "Type of connection info" + }, + "userName": { + "type": "string", + "description": "User name" + }, + "password": { + "type": "string", + "description": "Password credential." + } + }, + "required": [ "type" ], + "discriminator": "type" + }, + "AuthenticationType": { + "type": "string", + "description": "An enumeration of possible authentication types when connecting", + "enum": [ + "None", + "WindowsAuthentication", + "SqlAuthentication", + "ActiveDirectoryIntegrated", + "ActiveDirectoryPassword" + ], + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "SqlConnectionInfo": { + "x-ms-discriminator-value": "SqlConnectionInfo", + "type": "object", + "description": "Information for connecting to SQL database server", + "allOf": [ + { + "$ref": "#/definitions/ConnectionInfo" + } + ], + "properties": { + "dataSource": { + "type": "string", + "description": "Data source in the format Protocol:MachineName\\SQLServerInstanceName,PortNumber" + }, + "authentication": { + "$ref": "#/definitions/AuthenticationType", + "description": "Authentication type to use for connection" + }, + "encryptConnection": { + "type": "boolean", + "description": "Whether to encrypt the connection", + "default": true + }, + "additionalSettings": { + "type": "string", + "description": "Additional connection settings" + }, + "trustServerCertificate": { + "type": "boolean", + "description": "Whether to trust the server certificate", + "default": false + } + }, + "required": [ "dataSource" ] + }, + "ServerLevelPermissionsGroup": { + "type": "string", + "description": "Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing.", + "enum": [ + "Default", + "MigrationFromSqlServerToAzureDB" + ], + "x-ms-enum": { + "name": "ServerLevelPermissionsGroup", + "modelAsString": true + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceSqlServerTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceSqlServerTask.json new file mode 100644 index 000000000000..0f945eb50672 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceSqlServerTask.json @@ -0,0 +1,240 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ConnectToSourceSqlServerTaskInput": { + "type": "object", + "description": "Input for the task that validates connection to SQL Server and also validates source server requirements", + "properties": { + "sourceConnectionInfo": { + "description": "Connection information for Source SQL Server", + "$ref": "./Common.json#/definitions/SqlConnectionInfo" + }, + "checkPermissionsGroup": { + "$ref": "./Common.json#/definitions/ServerLevelPermissionsGroup", + "description": "Permission group for validations" + }, + "collectLogins": { + "type": "boolean", + "description": "Flag for whether to collect logins from source server.", + "default": false + }, + "collectAgentJobs": { + "type": "boolean", + "description": "Flag for whether to collect agent jobs from source server.", + "default": false + } + }, + "required": [ + "sourceConnectionInfo" + ] + }, + "ConnectToSourceSqlServerTaskOutput": { + "type": "object", + "description": "Output for the task that validates connection to SQL Server and also validates source server requirements", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "resultType": { + "description": "Type of result - database level or task level", + "type": "string" + } + }, + "required": [ "resultType" ], + "discriminator": "resultType" + }, + "ConnectToSourceSqlServerTaskOutputTaskLevel": { + "x-ms-discriminator-value": "TaskLevelOutput", + "type": "object", + "description": "Task level output for the task that validates connection to SQL Server and also validates source server requirements", + "properties": { + "databases": { + "type": "string", + "description": "Source databases as a map from database name to database id", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "logins": { + "type": "string", + "description": "Source logins as a map from login name to login id.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "agentJobs": { + "type": "string", + "description": "Source agent jobs as a map from agent job name to id.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "sourceServerVersion": { + "type": "string", + "description": "Source server version", + "readOnly": true + }, + "sourceServerBrandVersion": { + "type": "string", + "description": "Source server brand version", + "readOnly": true + }, + "validationErrors": { + "description": "Validation errors", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectToSourceSqlServerTaskOutput" + } + ] + }, + "ConnectToSourceSqlServerTaskOutputDatabaseLevel": { + "x-ms-discriminator-value": "DatabaseLevelOutput", + "type": "object", + "description": "Database level output for the task that validates connection to SQL Server and also validates source server requirements", + "properties": { + "name": { + "type": "string", + "description": "Database name", + "readOnly": true + }, + "sizeMB": { + "type": "number", + "format": "double", + "description": "Size of the file in megabytes", + "readOnly": true + }, + "databaseFiles": { + "type": "array", + "description": "The list of database files", + "items": { + "$ref": "./TasksCommon.json#/definitions/DatabaseFileInfo" + }, + "readOnly": true + }, + "compatibilityLevel": { + "$ref": "./TasksCommon.json#/definitions/DatabaseCompatLevel", + "description": "SQL Server compatibility level of database", + "readOnly": true + }, + "databaseState": { + "$ref": "./TasksCommon.json#/definitions/DatabaseState", + "description": "State of the database", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectToSourceSqlServerTaskOutput" + } + ] + }, + "ConnectToSourceSqlServerTaskOutputLoginLevel": { + "x-ms-discriminator-value": "LoginLevelOutput", + "type": "object", + "description": "Login level output for the task that validates connection to SQL Server and also validates source server requirements", + "properties": { + "name": { + "type": "string", + "description": "Login name.", + "readOnly": true + }, + "loginType": { + "$ref": "./TasksCommon.json#/definitions/LoginType", + "description": "The type of login.", + "readOnly": true + }, + "defaultDatabase": { + "type": "string", + "description": "The default database for the login.", + "readOnly": true + }, + "isEnabled": { + "type": "boolean", + "description": "The state of the login.", + "readOnly": true + }, + "migrationEligibility": { + "$ref": "./TasksCommon.json#/definitions/MigrationEligibilityInfo", + "description": "Information about eligiblity of login for migration.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectToSourceSqlServerTaskOutput" + } + ] + }, + "ConnectToSourceSqlServerTaskOutputAgentJobLevel": { + "x-ms-discriminator-value": "AgentJobLevelOutput", + "type": "object", + "description": "AgentJob level output for the task that validates connection to SQL Server and also validates source server requirements", + "properties": { + "name": { + "type": "string", + "description": "AgentJob name", + "readOnly": true + }, + "jobCategory": { + "type": "string", + "description": "The type of AgentJob.", + "readOnly": true + }, + "isEnabled": { + "type": "boolean", + "description": "The state of the original AgentJob.", + "readOnly": true + }, + "jobOwner": { + "type": "string", + "description": "The owner of the AgentJob", + "readOnly": true + }, + "lastExecutedOn": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "UTC Date and time when the AgentJob was last executed." + }, + "migrationEligibility": { + "$ref": "./TasksCommon.json#/definitions/MigrationEligibilityInfo", + "description": "Information about eligiblity of agent job for migration.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectToSourceSqlServerTaskOutput" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlDbTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlDbTask.json new file mode 100644 index 000000000000..17362972b67c --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlDbTask.json @@ -0,0 +1,63 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ConnectToTargetSqlDbTaskInput": { + "type": "object", + "description": "Input for the task that validates connection to SQL DB and target server requirements", + "properties": { + "targetConnectionInfo": { + "description": "Connection information for target SQL DB", + "$ref": "./Common.json#/definitions/SqlConnectionInfo" + } + }, + "required": [ + "targetConnectionInfo" + ] + }, + "ConnectToTargetSqlDbTaskOutput": { + "type": "object", + "description": "Output for the task that validates connection to SQL DB and target server requirements", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "databases": { + "type": "string", + "description": "Source databases as a map from database name to database id", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "targetServerVersion": { + "type": "string", + "description": "Version of the target server", + "readOnly": true + }, + "targetServerBrandVersion": { + "type": "string", + "description": "Target server brand version", + "readOnly": true + } + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetUserTablesSqlTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetUserTablesSqlTask.json new file mode 100644 index 000000000000..a50ebb02e683 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetUserTablesSqlTask.json @@ -0,0 +1,88 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "GetUserTablesSqlTaskInput": { + "type": "object", + "description": "Input for the task that collects user tables for the given list of databases", + "properties": { + "connectionInfo": { + "description": "Connection information for SQL Server", + "$ref": "./Common.json#/definitions/SqlConnectionInfo" + }, + "selectedDatabases": { + "type": "array", + "description": "List of database names to collect tables for", + "items": { + "type": "string" + } + } + }, + "required": [ + "connectionInfo", + "selectedDatabases" + ] + }, + "GetUserTablesSqlTaskOutput": { + "type": "object", + "description": "Output of the task that collects user tables for the given list of databases", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "databasesToTables": { + "type": "string", + "description": "Mapping from database name to list of tables", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseTable" + } + }, + "readOnly": true + }, + "validationErrors": { + "description": "Validation errors", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + }, + "DatabaseTable": { + "type": "object", + "description": "Table properties", + "properties": { + "hasRows": { + "type": "boolean", + "description": "Indicates whether table is empty or not", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Schema-qualified name of the table", + "readOnly": true + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlDbTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlDbTask.json new file mode 100644 index 000000000000..44154a15e5fc --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlDbTask.json @@ -0,0 +1,398 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "MigrateSqlServerSqlDbTaskInput": { + "type": "object", + "description": "Input for the task that migrates on-prem SQL Server databases to Azure SQL Database", + "properties": { + "selectedDatabases": { + "type": "array", + "description": "Databases to migrate", + "items": { + "$ref": "#/definitions/MigrateSqlServerSqlDbDatabaseInput" + } + }, + "validationOptions": { + "description": "Options for enabling various post migration validations. Available options, \n 1.) Data Integrity Check: Performs a checksum based comparison on source and target tables after the migration to ensure the correctness of the data. \n 2.) Schema Validation: Performs a thorough schema comparison between the source and target tables and provides a list of differences between the source and target database, 3.) Query Analysis: Executes a set of queries picked up automatically either from the Query Plan Cache or Query Store and execute them and compares the execution time between the source and target database.", + "$ref": "./MigrationValidation.json#/definitions/MigrationValidationOptions" + } + }, + "required": [ + "selectedDatabases" + ], + "allOf": [ + { + "$ref": "./TasksCommon.json#/definitions/SqlMigrationTaskInput" + } + ] + }, + "MigrateSqlServerSqlDbTaskOutput": { + "type": "object", + "description": "Output for the task that migrates on-prem SQL Server databases to Azure SQL Database", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "resultType": { + "description": "Result type", + "type": "string" + } + }, + "required": [ "resultType" ], + "discriminator": "resultType" + }, + "MigrateSqlServerSqlDbTaskOutputMigrationLevel": { + "x-ms-discriminator-value": "MigrationLevelOutput", + "type": "object", + "description": "Migration level result for Sql server to Azure Sql DB migration.", + "properties": { + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "durationInSeconds": { + "type": "integer", + "format": "int64", + "description": "Duration of task execution in seconds.", + "readOnly": true + }, + "status": { + "$ref": "./TasksCommon.json#/definitions/MigrationStatus", + "description": "Current status of migration", + "readOnly": true + }, + "statusMessage": { + "type": "string", + "description": "Migration status message", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Migration progress message", + "readOnly": true + }, + "databases": { + "type": "string", + "description": "Selected databases as a map from database name to database id", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "databaseSummary": { + "type": "string", + "description": "Summary of database results in the migration", + "additionalProperties": { + "$ref": "#/definitions/DatabaseSummaryResult" + }, + "readOnly": true + }, + "migrationReport": { + "type": "object", + "description": "Migration Report Result, provides unique url for downloading your migration report.", + "$ref": "./MigrationValidation.json#/definitions/MigrationReportResult", + "readOnly": true + }, + "sourceServerVersion": { + "type": "string", + "description": "Source server version", + "readOnly": true + }, + "sourceServerBrandVersion": { + "type": "string", + "description": "Source server brand version", + "readOnly": true + }, + "targetServerVersion": { + "type": "string", + "description": "Target server version", + "readOnly": true + }, + "targetServerBrandVersion": { + "type": "string", + "description": "Target server brand version", + "readOnly": true + }, + "exceptionsAndWarnings": { + "description": "Migration exceptions and warnings.", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlDbTaskOutput" + } + ] + }, + "MigrateSqlServerSqlDbTaskOutputDatabaseLevel": { + "type": "object", + "description": "Database level result for Sql Server to Azure Sql DB migration.", + "x-ms-discriminator-value": "DatabaseLevelOutput", + "properties": { + "databaseName": { + "type": "string", + "description": "Name of the item", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "state": { + "$ref": "./TasksCommon.json#/definitions/MigrationState", + "description": "Current state of migration", + "readOnly": true + }, + "stage": { + "$ref": "./TasksCommon.json#/definitions/DatabaseMigrationStage", + "description": "Migration stage that this database is in", + "readOnly": true + }, + "statusMessage": { + "type": "string", + "description": "Status message", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Migration progress message", + "readOnly": true + }, + "numberOfObjects": { + "type": "integer", + "format": "int64", + "description": "Number of objects", + "readOnly": true + }, + "numberOfObjectsCompleted": { + "type": "integer", + "format": "int64", + "description": "Number of successfully completed objects", + "readOnly": true + }, + "errorCount": { + "type": "integer", + "format": "int64", + "description": "Number of database/object errors.", + "readOnly": true + }, + "errorPrefix": { + "type": "string", + "description": "Wildcard string prefix to use for querying all errors of the item", + "readOnly": true + }, + "resultPrefix": { + "type": "string", + "description": "Wildcard string prefix to use for querying all sub-tem results of the item", + "readOnly": true + }, + "exceptionsAndWarnings": { + "description": "Migration exceptions and warnings.", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + }, + "objectSummary": { + "type": "string", + "description": "Summary of object results in the migration", + "additionalProperties": { + "$ref": "./TasksCommon.json#/definitions/DataItemMigrationSummaryResult" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlDbTaskOutput" + } + ] + }, + "MigrateSqlServerSqlDbTaskOutputTableLevel": { + "type": "object", + "description": "Table level result for Sql Server to Azure Sql DB migration.", + "x-ms-discriminator-value": "TableLevelOutput", + "properties": { + "objectName": { + "type": "string", + "description": "Name of the item", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "state": { + "$ref": "./TasksCommon.json#/definitions/MigrationState", + "description": "Current state of migration", + "readOnly": true + }, + "statusMessage": { + "type": "string", + "description": "Status message", + "readOnly": true + }, + "itemsCount": { + "type": "integer", + "format": "int64", + "description": "Number of items", + "readOnly": true + }, + "itemsCompletedCount": { + "type": "integer", + "format": "int64", + "description": "Number of successfully completed items", + "readOnly": true + }, + "errorPrefix": { + "type": "string", + "description": "Wildcard string prefix to use for querying all errors of the item", + "readOnly": true + }, + "resultPrefix": { + "type": "string", + "description": "Wildcard string prefix to use for querying all sub-tem results of the item", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlDbTaskOutput" + } + ] + }, + "MigrateSqlServerSqlDbTaskOutputError": { + "type": "object", + "x-ms-discriminator-value": "ErrorOutput", + "description": "Task errors for Sql Server to Azure Sql DB migration.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the exception", + "readOnly": true + }, + "error": { + "$ref": "./Common.json#/definitions/ReportableException", + "description": "Migration error", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlDbTaskOutput" + } + ] + }, + "MigrateSqlServerSqlDbDatabaseInput": { + "type": "object", + "description": "Database specific information for SQL to Azure SQL DB migration task inputs", + "properties": { + "name": { + "type": "string", + "description": "Name of the database" + }, + "targetDatabaseName": { + "type": "string", + "description": "Name of target database. Note: Target database will be truncated before starting migration." + }, + "makeSourceDbReadOnly": { + "type": "boolean", + "description": "Whether to set database read only before migration" + }, + "tableMap": { + "type": "object", + "description": "Mapping of source to target tables", + "additionalProperties": { + "type": "string" + } + } + } + }, + "DatabaseSummaryResult": { + "type": "object", + "description": "Summary of database results in the migration", + "properties": { + "sizeMB": { + "type": "number", + "format": "double", + "description": "Size of the database in megabytes", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "./TasksCommon.json#/definitions/DataItemMigrationSummaryResult" + } + ] + }, + "MigrateSqlServerSqlDbTaskOutputValidationResult": { + "x-ms-discriminator-value": "MigrationValidationOutput", + "type": "object", + "description": "Validation result for Sql Server to Azure Sql DB migration.", + "$ref": "./MigrationValidation.json#/definitions/MigrationValidationResult", + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlDbTaskOutput" + } + ] + }, + "MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResult": { + "x-ms-discriminator-value": "MigrationDatabaseLevelValidationOutput", + "type": "object", + "description": "Database validation result for Sql Server to Azure Sql DB migration.", + "$ref": "./MigrationValidation.json#/definitions/MigrationValidationDatabaseLevelResult", + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlDbTaskOutput" + } + ] + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrationValidation.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrationValidation.json new file mode 100644 index 000000000000..0fc83ec85ed8 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrationValidation.json @@ -0,0 +1,443 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "MigrationValidationOptions": { + "type": "object", + "description": "Types of validations to run after the migration", + "properties": { + "enableSchemaValidation": { + "type": "boolean", + "description": "Allows to compare the schema information between source and target." + }, + "enableDataIntegrityValidation": { + "type": "boolean", + "description": "Allows to perform a checksum based data integrity validation between source and target for the selected database / tables ." + }, + "enableQueryAnalysisValidation": { + "type": "boolean", + "description": "Allows to perform a quick and intelligent query analysis by retrieving queries from the source database and executes them in the target. The result will have execution statistics for executions in source and target databases for the extracted queries." + } + } + }, + "MigrationReportResult": { + "type": "object", + "description": "Migration validation report result, contains the url for downloading the generated report.", + "properties": { + "id": { + "type": "string", + "description": "Migration validation result identifier", + "readOnly": true + }, + "reportUrl": { + "type": "string", + "description": "The url of the report.", + "readOnly": true + } + } + }, + "MigrationValidationResult": { + "type": "object", + "description": "Migration Validation Result", + "properties": { + "id": { + "type": "string", + "description": "Migration validation result identifier", + "readOnly": true + }, + "migrationId": { + "type": "string", + "description": "Migration Identifier", + "readOnly": true + }, + "summaryResults": { + "type": "object", + "description": "Validation summary results for each database", + "additionalProperties": { + "$ref": "#/definitions/MigrationValidationDatabaseSummaryResult" + } + }, + "status": { + "$ref": "#/definitions/ValidationStatus", + "description": "Current status of validation at the migration level. Status from the database validation result status will be aggregated here.", + "readOnly": true + } + } + }, + "MigrationValidationDatabaseSummaryResult": { + "type": "object", + "description": "Migration Validation Database level summary result", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "migrationId": { + "type": "string", + "description": "Migration Identifier", + "readOnly": true + }, + "sourceDatabaseName": { + "type": "string", + "description": "Name of the source database", + "readOnly": true + }, + "targetDatabaseName": { + "type": "string", + "description": "Name of the target database", + "readOnly": true + }, + + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Validation start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Validation end time", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/ValidationStatus", + "description": "Current status of validation at the database level", + "readOnly": true + } + } + }, + "MigrationValidationDatabaseLevelResult": { + "type": "object", + "description": "Database level validation results", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "migrationId": { + "type": "string", + "description": "Migration Identifier", + "readOnly": true + }, + "sourceDatabaseName": { + "type": "string", + "description": "Name of the source database", + "readOnly": true + }, + "targetDatabaseName": { + "type": "string", + "description": "Name of the target database", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Validation start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Validation end time", + "readOnly": true + }, + "dataIntegrityValidationResult": { + "description": "Provides data integrity validation result between the source and target tables that are migrated.", + "$ref": "#/definitions/DataIntegrityValidationResult", + "readOnly": true + }, + "schemaValidationResult": { + "description": "Provides schema comparison result between source and target database", + "$ref": "#/definitions/SchemaComparisonValidationResult", + "readOnly": true + }, + + "queryAnalysisValidationResult": { + "description": "Results of some of the query execution result between source and target database", + "$ref": "#/definitions/QueryAnalysisValidationResult", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/ValidationStatus", + "description": "Current status of validation at the database level", + "readOnly": true + } + } + }, + "DataIntegrityValidationResult": { + "type": "object", + "description": "Results for checksum based Data Integrity validation results", + "properties": { + "failedObjects": { + "type": "object", + "description": "List of failed table names of source and target pair", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "validationErrors": { + "type": "array", + "description": "List of errors that happened while performing data integrity validation", + "$ref": "#/definitions/ValidationError", + "readOnly": true + } + } + }, + "SchemaComparisonValidationResult": { + "type": "object", + "description": "Results for schema comparison between the source and target", + "properties": { + "schemaDifferences": { + "type": "array", + "description": "List of schema differences between the source and target databases", + "$ref": "#/definitions/SchemaComparisonValidationResultType", + "readOnly": true + }, + "validationErrors": { + "type": "array", + "description": "List of errors that happened while performing schema compare validation", + "$ref": "#/definitions/ValidationError", + "readOnly": true + }, + "sourceDatabaseObjectCount": { + "type": "object", + "description": "Count of source database objects", + "additionalProperties": { + "type": "integer", + "format": "int64", + "readOnly": true + } + }, + "targetDatabaseObjectCount": { + "type": "object", + "description": "Count of target database objects", + "additionalProperties": { + "type": "integer", + "format": "int64", + "readOnly": true + } + } + } + }, + "SchemaComparisonValidationResultType": { + "type": "object", + "description": "Description about the errors happen while performing migration validation", + "properties": { + "objectName": { + "type": "string", + "description": "Name of the object that has the difference", + "readOnly": true + }, + "objectType": { + "type": "object", + "$ref": "./TasksCommon.json#/definitions/DatabaseObjectType", + "description": "Type of the object that has the difference. e.g (Table/View/StoredProcedure)", + "readOnly": true + }, + "updateAction": { + "type": "string", + "description": "Update action type with respect to target", + "$ref": "#/definitions/UpdateActionType", + "readOnly": true + } + } + }, + "UpdateActionType": { + "type": "string", + "description": "Type of the actual difference for the compared object, while performing schema comparison", + "enum": [ + "DeletedOnTarget", + "ChangedOnTarget", + "AddedOnTarget" + ], + "x-ms-enum": { + "name": "UpdateActionType", + "modelAsString": true + } + }, + "QueryAnalysisValidationResult": { + "type": "object", + "description": "Results for query analysis comparison between the source and target", + "properties": { + "queryResults": { + "type": "array", + "description": "List of queries executed and it's execution results in source and target", + "$ref": "#/definitions/QueryExecutionResult", + "readOnly": true + }, + "validationErrors": { + "type": "array", + "description": "Errors that are part of the execution", + "$ref": "#/definitions/ValidationError", + "readOnly": true + } + } + }, + "QueryExecutionResult": { + "type": "object", + "description": "Describes query analysis results for execution in source and target", + "properties": { + "queryText": { + "type": "string", + "description": "Query text retrieved from the source server", + "readOnly": true + }, + "statementsInBatch": { + "type": "integer", + "format": "int64", + "description": "Total no. of statements in the batch", + "readOnly": true + }, + "sourceResult": { + "type": "object", + "description": "Query analysis result from the source", + "$ref": "#/definitions/ExecutionStatistics", + "readOnly": true + }, + "targetResult": { + "type": "object", + "description": "Query analysis result from the target", + "$ref": "#/definitions/ExecutionStatistics", + "readOnly": true + } + } + }, + "ExecutionStatistics": { + "type": "object", + "description": "Description about the errors happen while performing migration validation", + "properties": { + "executionCount": { + "type": "integer", + "format": "int64", + "description": "No. of query executions", + "readOnly": true + }, + "cpuTimeMs": { + "type": "number", + "format": "float", + "description": "CPU Time in millisecond(s) for the query execution", + "readOnly": true + }, + "elapsedTimeMs": { + "type": "number", + "format": "float", + "description": "Time taken in millisecond(s) for executing the query", + "readOnly": true + }, + "waitStats": { + "type": "object", + "description": "Dictionary of sql query execution wait types and the respective statistics", + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/WaitStatistics", + "readOnly": true + } + }, + "hasErrors": { + "type": "boolean", + "description": "Indicates whether the query resulted in an error", + "readOnly": true + }, + "sqlErrors": { + "type": "array", + "description": "List of sql Errors", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "WaitStatistics": { + "type": "object", + "description": "Wait statistics gathered during query batch execution", + "properties": { + "waitType": { + "type": "string", + "description": "Type of the Wait", + "readOnly": true + }, + "waitTimeMs": { + "type": "number", + "format": "float", + "default": 0, + "description": "Total wait time in millisecond(s)", + "readOnly": true + }, + "waitCount": { + "type": "integer", + "format": "int64", + "description": "Total no. of waits", + "readOnly": true + } + } + }, + "Severity": { + "type": "string", + "description": "Severity of the validation error", + "enum": [ + "Message", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + } + }, + "ValidationError": { + "type": "object", + "description": "Description about the errors happen while performing migration validation", + "properties": { + "text": { + "type": "string", + "description": "Error Text", + "readOnly": true + }, + "severity": { + "type": "string", + "description": "Severity of the error", + "$ref": "#/definitions/Severity", + "readOnly": true + } + } + }, + "ValidationStatus": { + "type": "string", + "description": "Current status of the validation", + "enum": [ + "Default", + "NotStarted", + "Initialized", + "InProgress", + "Completed", + "CompletedWithIssues", + "Failed", + "Stopped" + ], + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsString": true + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Projects.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Projects.json new file mode 100644 index 000000000000..9d7fc36d4441 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Projects.json @@ -0,0 +1,138 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "Project": { + "type": "object", + "description": "A project resource", + "properties": { + "properties": { + "description": "Project properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectProperties" + } + }, + "allOf": [ + { + "$ref": "./Common.json#/definitions/TrackedResource" + } + ] + }, + "ProjectList": { + "type": "object", + "description": "OData page of project resources", + "properties": { + "value": { + "type": "array", + "description": "List of projects", + "items": { + "$ref": "#/definitions/Project" + } + }, + "nextLink": { + "type": "string", + "description": "URL to load the next page of projects" + } + } + }, + "ProjectProperties": { + "type": "object", + "description": "Project-specific properties", + "properties": { + "sourcePlatform": { + "description": "Source platform for the project", + "$ref": "#/definitions/ProjectSourcePlatform" + }, + "targetPlatform": { + "description": "Target platform for the project", + "$ref": "#/definitions/ProjectTargetPlatform" + }, + "creationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "UTC Date and time when project was created" + }, + "sourceConnectionInfo": { + "$ref": "./Common.json#/definitions/ConnectionInfo", + "description": "Information for connecting to source" + }, + "targetConnectionInfo": { + "$ref": "./Common.json#/definitions/ConnectionInfo", + "description": "Information for connecting to target" + }, + "databasesInfo": { + "type": "array", + "description": "List of DatabaseInfo", + "items": { + "$ref": "#/definitions/DatabaseInfo" + } + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The project's provisioning state", + "enum": [ + "Deleting", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProjectProvisioningState", + "modelAsString": true + } + } + }, + "required": [ "sourcePlatform", "targetPlatform" ] + }, + "DatabaseInfo": { + "type": "object", + "description": "Project Database Details", + "properties": { + "sourceDatabaseName": { + "type": "string", + "description": "Name of the database" + } + }, + "required": [ "sourceDatabaseName" ] + }, + "ProjectSourcePlatform": { + "type": "string", + "description": "Source platform of the project", + "enum": [ + "SQL", + "Unknown" + ], + "x-ms-enum": { + "name": "ProjectSourcePlatform", + "modelAsString": true + } + }, + "ProjectTargetPlatform": { + "type": "string", + "description": "Target platform of the project", + "enum": [ + "SQLDB", + "Unknown" + ], + "x-ms-enum": { + "name": "ProjectTargetPlatform", + "modelAsString": true + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ResourceSkus.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ResourceSkus.json new file mode 100644 index 000000000000..f89c91824603 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ResourceSkus.json @@ -0,0 +1,231 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ResourceSku": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of SKU." + }, + "tier": { + "readOnly": true, + "type": "string", + "description": "Specifies the tier of DMS in a scale set." + }, + "size": { + "readOnly": true, + "type": "string", + "description": "The Size of the SKU." + }, + "family": { + "readOnly": true, + "type": "string", + "description": "The Family of this particular SKU." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "The Kind of resources that are supported in this SKU." + }, + "capacity": { + "$ref": "#/definitions/ResourceSkuCapacity", + "readOnly": true, + "description": "Not used." + }, + "locations": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available." + }, + "apiVersions": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The api versions that support this SKU." + }, + "costs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuCosts" + }, + "description": "Metadata for retrieving price info." + }, + "capabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuCapabilities" + }, + "description": "A name value pair to describe the capability." + }, + "restrictions": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuRestrictions" + }, + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." + } + }, + "description": "Describes an available DMS SKU." + }, + "ResourceSkuCapacity": { + "properties": { + "minimum": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "The maximum capacity." + }, + "default": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "The default capacity." + }, + "scaleType": { + "type": "string", + "readOnly": true, + "description": "The scale type applicable to the SKU.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "x-ms-enum": { + "name": "ResourceSkuCapacityScaleType", + "modelAsString": true + } + } + }, + "description": "Describes scaling information of a SKU." + }, + "ResourceSkuCosts": { + "properties": { + "meterID": { + "type": "string", + "readOnly": true, + "description": "Used for querying price from commerce." + }, + "quantity": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "The multiplier is needed to extend the base metered cost." + }, + "extendedUnit": { + "type": "string", + "readOnly": true, + "description": "An invariant to show the extended unit." + } + }, + "description": "Describes metadata for retrieving price info." + }, + "ResourceSkuCapabilities": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "An invariant to describe the feature." + }, + "value": { + "type": "string", + "readOnly": true, + "description": "An invariant if the feature is measured by quantity." + } + }, + "description": "Describes The SKU capabilites object." + }, + "ResourceSkuRestrictions": { + "properties": { + "type": { + "type": "string", + "readOnly": true, + "description": "The type of restrictions.", + "enum": [ + "location" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsType", + "modelAsString": true + } + }, + "values": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted." + }, + "reasonCode": { + "type": "string", + "readOnly": true, + "description": "The reason code for restriction.", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsReasonCode", + "modelAsString": true + } + } + }, + "description": "Describes scaling information of a SKU." + }, + "ResourceSkusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSku" + }, + "description": "The list of SKUs available for the subscription." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of DMS SKUs. Call ListNext() with this to fetch the next page of DMS SKUs." + } + }, + "required": [ + "value" + ], + "description": "The DMS List SKUs operation response." + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Services.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Services.json new file mode 100644 index 000000000000..357d27bd9dfd --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Services.json @@ -0,0 +1,283 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "AvailableServiceSku": { + "type": "object", + "description": "Describes the available service SKU.", + "properties": { + "resourceType": { + "type": "string", + "description": "The resource type, including the provider namespace" + }, + "sku": { + "type": "object", + "description": "SKU name, tier, etc.", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU" + }, + "family": { + "type": "string", + "description": "SKU family" + }, + "size": { + "type": "string", + "description": "SKU size" + }, + "tier": { + "type": "string", + "description": "The tier of the SKU, such as \"Free\", \"Basic\", \"Standard\", or \"Premium\"" + } + } + }, + "capacity": { + "type": "object", + "description": "A description of the scaling capacities of the SKU", + "properties": { + "minimum": { + "type": "integer", + "description": "The minimum capacity, usually 0 or 1." + }, + "maximum": { + "type": "integer", + "description": "The maximum capacity" + }, + "default": { + "type": "integer", + "description": "The default capacity" + }, + "scaleType": { + "type": "string", + "description": "The scalability approach", + "enum": [ + "none", + "manual", + "automatic" + ], + "x-ms-enum": { + "name": "ServiceScalability", + "modelAsString": true + } + } + } + } + } + }, + "DataMigrationService": { + "type": "object", + "description": "A Database Migration Service resource", + "properties": { + "etag": { + "type": "string", + "description": "HTTP strong entity tag value. Ignored if submitted" + }, + "kind": { + "type": "string", + "description": "The resource kind. Only 'vm' (the default) is supported." + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Custom service properties", + "$ref": "#/definitions/DataMigrationServiceProperties" + }, + "sku": { + "description": "Service SKU", + "$ref": "#/definitions/ServiceSku" + } + }, + "allOf": [ + { + "$ref": "./Common.json#/definitions/TrackedResource" + } + ] + }, + "DataMigrationServiceList": { + "type": "object", + "description": "OData page of service objects", + "properties": { + "value": { + "type": "array", + "description": "List of services", + "items": { + "$ref": "#/definitions/DataMigrationService" + } + }, + "nextLink": { + "type": "string", + "description": "URL to load the next page of services" + } + } + }, + "DataMigrationServiceProperties": { + "type": "object", + "description": "Properties of the Data Migration service instance", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The resource's provisioning state", + "enum": [ + "Accepted", + "Deleting", + "Deploying", + "Stopped", + "Stopping", + "Starting", + "FailedToStart", + "FailedToStop", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ServiceProvisioningState", + "modelAsString": true + } + }, + "publicKey": { + "type": "string", + "description": "The public key of the service, used to encrypt secrets sent to the service" + }, + "virtualSubnetId": { + "type": "string", + "description": "The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined" + } + }, + "required": [ "virtualSubnetId" ] + }, + "DataMigrationServiceStatusResponse": { + "type": "object", + "description": "Service health status", + "properties": { + "agentVersion": { + "type": "string", + "description": "The DMS instance agent version" + }, + "status": { + "type": "string", + "description": "The machine-readable status, such as 'Initializing', 'Offline', 'Online', 'Deploying', 'Deleting', 'Stopped', 'Stopping', 'Starting', 'FailedToStart', 'FailedToStop' or 'Failed'" + }, + "vmSize": { + "type": "string", + "description": "The services virtual machine size, such as 'Standard_D2_v2'" + }, + "supportedTaskTypes": { + "type": "array", + "description": "The list of supported task types", + "items": { + "type": "string", + "description": "Migration task type" + } + } + } + }, + "ServiceOperation": { + "type": "object", + "description": "Description of an action supported by the Database Migration Service", + "properties": { + "name": { + "type": "string", + "description": "The fully qualified action name, e.g. Microsoft.DataMigration/services/read" + }, + "display": { + "type": "object", + "description": "Localized display text", + "properties": { + "provider": { + "type": "string", + "description": "The localized resource provider name" + }, + "resource": { + "type": "string", + "description": "The localized resource type name" + }, + "operation": { + "type": "string", + "description": "The localized operation name" + }, + "description": { + "type": "string", + "description": "The localized operation description" + } + } + } + } + }, + "ServiceOperationList": { + "type": "object", + "description": "OData page of action (operation) objects", + "properties": { + "value": { + "type": "array", + "description": "List of actions", + "items": { + "$ref": "#/definitions/ServiceOperation" + } + }, + "nextLink": { + "type": "string", + "description": "URL to load the next page of actions" + } + } + }, + "ServiceSku": { + "type": "object", + "description": "An Azure SKU instance", + "properties": { + "name": { + "type": "string", + "description": "The unique name of the SKU, such as 'P3'" + }, + "tier": { + "type": "string", + "description": "The tier of the SKU, such as 'Free', 'Basic', 'Standard', or 'Premium'" + }, + "family": { + "type": "string", + "description": "The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines" + }, + "size": { + "type": "string", + "description": "The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines" + }, + "capacity": { + "type": "integer", + "description": "The capacity of the SKU, if it supports scaling" + } + } + }, + "ServiceSkuList": { + "type": "object", + "description": "OData page of available SKUs", + "properties": { + "value": { + "type": "array", + "description": "List of service SKUs", + "items": { + "$ref": "#/definitions/AvailableServiceSku" + } + }, + "nextLink": { + "type": "string", + "description": "URL to load the next page of service SKUs" + } + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Tasks.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Tasks.json new file mode 100644 index 000000000000..7110a241237d --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Tasks.json @@ -0,0 +1,192 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ProjectTaskProperties": { + "type": "object", + "description": "Base class for all types of DMS task properties. If task is not supported by current client, this object is returned.", + "x-ms-discriminator-value": "Unknown", + "properties": { + "taskType": { + "description": "Task type.", + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ODataError" + }, + "description": "Array of errors. This is ignored if submitted." + }, + "state": { + "type": "string", + "description": "The state of the task. This is ignored if submitted.", + "enum": [ + "Unknown", + "Queued", + "Running", + "Canceled", + "Succeeded", + "Failed", + "FailedInputValidation", + "Faulted" + ], + "x-ms-enum": { + "name": "TaskState", + "modelAsString": true + }, + "readOnly": true + } + }, + "required": [ "taskType" ], + "discriminator": "taskType" + }, + "ProjectTask": { + "type": "object", + "description": "A task resource", + "properties": { + "etag": { + "type": "string", + "description": "HTTP strong entity tag value. This is ignored if submitted." + }, + "properties": { + "description": "Custom task properties", + "$ref": "#/definitions/ProjectTaskProperties" + } + }, + "allOf": [ + { + "$ref": "./Common.json#/definitions/Resource" + } + ] + }, + "TaskList": { + "type": "object", + "description": "OData page of tasks", + "properties": { + "value": { + "type": "array", + "description": "List of tasks", + "items": { + "$ref": "#/definitions/ProjectTask" + } + }, + "nextLink": { + "type": "string", + "description": "URL to load the next page of tasks" + } + } + }, + "ConnectToSourceSqlServerTaskProperties": { + "x-ms-discriminator-value": "ConnectToSource.SqlServer", + "type": "object", + "description": "Properties for the task that validates connection to SQL Server and also validates source server requirements", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ConnectToSourceSqlServerTask.json#/definitions/ConnectToSourceSqlServerTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ConnectToSourceSqlServerTask.json#/definitions/ConnectToSourceSqlServerTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "ConnectToTargetSqlDbTaskProperties": { + "x-ms-discriminator-value": "ConnectToTarget.SqlDb", + "type": "object", + "description": "Properties for the task that validates connection to SQL DB and target server requirements", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ConnectToTargetSqlDbTask.json#/definitions/ConnectToTargetSqlDbTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ConnectToTargetSqlDbTask.json#/definitions/ConnectToTargetSqlDbTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "GetUserTablesSqlTaskProperties": { + "x-ms-discriminator-value": "GetUserTables.Sql", + "type": "object", + "description": "Properties for the task that collects user tables for the given list of databases", + "properties": { + "input": { + "description": "Task input", + "$ref": "./GetUserTablesSqlTask.json#/definitions/GetUserTablesSqlTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./GetUserTablesSqlTask.json#/definitions/GetUserTablesSqlTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "MigrateSqlServerSqlDbTaskProperties": { + "x-ms-discriminator-value": "Migrate.SqlServer.SqlDb", + "type": "object", + "description": "Properties for the task that migrates on-prem SQL Server databases to Azure SQL Database", + "properties": { + "input": { + "description": "Task input", + "$ref": "./MigrateSqlServerSqlDbTask.json#/definitions/MigrateSqlServerSqlDbTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./MigrateSqlServerSqlDbTask.json#/definitions/MigrateSqlServerSqlDbTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/TasksCommon.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/TasksCommon.json new file mode 100644 index 000000000000..72e5f0b4b33e --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/TasksCommon.json @@ -0,0 +1,619 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "Database": { + "type": "object", + "description": "Information about a single database", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the database", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of the database", + "readOnly": true + }, + "compatibilityLevel": { + "$ref": "#/definitions/DatabaseCompatLevel", + "description": "SQL Server compatibility level of database", + "readOnly": true + }, + "collation": { + "type": "string", + "description": "Collation name of the database", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "Name of the server", + "readOnly": true + }, + "fqdn": { + "type": "string", + "description": "Fully qualified name", + "readOnly": true + }, + "installId": { + "type": "string", + "description": "Install id of the database", + "readOnly": true + }, + "serverVersion": { + "type": "string", + "description": "Version of the server", + "readOnly": true + }, + "serverEdition": { + "type": "string", + "description": "Edition of the server", + "readOnly": true + }, + "serverLevel": { + "type": "string", + "description": "Product level of the server (RTM, SP, CTP).", + "readOnly": true + }, + "serverDefaultDataPath": { + "type": "string", + "description": "Default path of the data files", + "readOnly": true + }, + "serverDefaultLogPath": { + "type": "string", + "description": "Default path of the log files", + "readOnly": true + }, + "serverDefaultBackupPath": { + "type": "string", + "description": "Default path of the backup folder", + "readOnly": true + }, + "serverCoreCount": { + "type": "integer", + "description": "Number of cores on the server", + "readOnly": true + }, + "serverVisibleOnlineCoreCount": { + "type": "integer", + "description": "Number of cores on the server that have VISIBLE ONLINE status", + "readOnly": true + }, + "databaseState": { + "$ref": "#/definitions/DatabaseState", + "description": "State of the database", + "readOnly": true + }, + "serverId": { + "type": "string", + "description": "The unique Server Id", + "readOnly": true + } + } + }, + "DatabaseCompatLevel": { + "type": "string", + "description": "An enumeration of SQL Server database compatibility levels", + "enum": [ + "CompatLevel80", + "CompatLevel90", + "CompatLevel100", + "CompatLevel110", + "CompatLevel120", + "CompatLevel130", + "CompatLevel140" + ], + "x-ms-enum": { + "name": "DatabaseCompatLevel", + "modelAsString": true + } + }, + "DatabaseState": { + "type": "string", + "description": "An enumeration of SQL Server Database states", + "enum": [ + "Online", + "Restoring", + "Recovering", + "RecoveryPending", + "Suspect", + "Emergency", + "Offline", + "Copying", + "OfflineSecondary" + ], + "x-ms-enum": { + "name": "DatabaseState", + "modelAsString": true + } + }, + "DatabaseObjectType": { + "type": "string", + "description": "An enumeration of type of objects", + "enum": [ + "StoredProcedures", + "Table", + "User", + "View", + "Function" + ], + "x-ms-enum": { + "name": "ObjectType", + "modelAsString": true + } + }, + "DatabaseObjectName": { + "type": "object", + "description": "A representation of the name of an object in a database", + "properties": { + "databaseName": { + "type": "string", + "description": "The unescaped name of the database containing the object", + "readOnly": true + }, + "objectName": { + "type": "string", + "description": "The unescaped name of the object", + "readOnly": true + }, + "schemaName": { + "type": "string", + "description": "The unescaped name of the schema containing the object", + "readOnly": true + }, + "objectType": { + "$ref": "#/definitions/DatabaseObjectType", + "description": "Type of the object in the database" + } + } + }, + "DataItemMigrationSummaryResult": { + "type": "object", + "description": "Basic summary of a data item migration", + "properties": { + "name": { + "type": "string", + "description": "Name of the item", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/MigrationState", + "description": "Current state of migration", + "readOnly": true + }, + "statusMessage": { + "type": "string", + "description": "Status message", + "readOnly": true + }, + "itemsCount": { + "type": "integer", + "format": "int64", + "description": "Number of items", + "readOnly": true + }, + "itemsCompletedCount": { + "type": "integer", + "format": "int64", + "description": "Number of successfully completed items", + "readOnly": true + }, + "errorPrefix": { + "type": "string", + "description": "Wildcard string prefix to use for querying all errors of the item", + "readOnly": true + }, + "resultPrefix": { + "type": "string", + "description": "Wildcard string prefix to use for querying all sub-tem results of the item", + "readOnly": true + } + } + }, + "DataMigrationProjectMetadata": { + "type": "object", + "description": "Common metadata for migration projects", + "properties": { + "sourceServerName": { + "type": "string", + "description": "Source server name", + "readOnly": true + }, + "sourceServerPort": { + "type": "string", + "description": "Source server port number", + "readOnly": true + }, + "sourceUsername": { + "type": "string", + "description": "Source username", + "readOnly": true + }, + "targetServerName": { + "type": "string", + "description": "Target server name", + "readOnly": true + }, + "targetUsername": { + "type": "string", + "description": "Target username", + "readOnly": true + }, + "targetDbName": { + "type": "string", + "description": "Target database name", + "readOnly": true + }, + "targetUsingWinAuth": { + "type": "boolean", + "description": "Whether target connection is Windows authentication", + "readOnly": true + }, + "selectedMigrationTables": { + "type": "array", + "description": "List of tables selected for migration", + "readOnly": true, + "items": { + "$ref": "#/definitions/MigrationTableMetadata" + } + } + } + }, + "MigrationState": { + "type": "string", + "description": "Current state of migration", + "enum": [ + "None", + "InProgress", + "Failed", + "Warning", + "Completed", + "Skipped", + "Stopped" + ], + "x-ms-enum": { + "name": "MigrationState", + "modelAsString": true + } + }, + "MigrationStatus": { + "type": "string", + "description": "Current status of migration", + "enum": [ + "Default", + "Connecting", + "SourceAndTargetSelected", + "SelectLogins", + "Configured", + "Running", + "Error", + "Stopped", + "Completed", + "CompletedWithWarnings" + ], + "x-ms-enum": { + "name": "MigrationStatus", + "modelAsString": true + } + }, + "SqlMigrationTaskInput": { + "type": "object", + "description": "Base class for migration task input", + "properties": { + "sourceConnectionInfo": { + "$ref": "./Common.json#/definitions/SqlConnectionInfo", + "description": "Information for connecting to source" + }, + "targetConnectionInfo": { + "$ref": "./Common.json#/definitions/SqlConnectionInfo", + "description": "Information for connecting to target" + } + }, + "required": [ + "sourceConnectionInfo", + "targetConnectionInfo" + ] + }, + "MigrationTableMetadata": { + "type": "object", + "description": "Metadata for tables selected in migration project", + "properties": { + "sourceTableName": { + "type": "string", + "description": "Source table name", + "readOnly": true + }, + "targetTableName": { + "type": "string", + "description": "Target table name", + "readOnly": true + } + } + }, + "DataMigrationError": { + "type": "object", + "description": "Migration Task errors", + "properties": { + "message": { + "type": "string", + "description": "Error description", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/ErrorType", + "description": "Type of error." + } + } + }, + "ErrorType": { + "type": "string", + "description": "Error type", + "enum": [ + "Default", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "ErrorType", + "modelAsString": true + } + }, + "MigrateSqlServerSqlServerDatabaseInput": { + "type": "object", + "description": "Database specific information for SQL to SQL migration task inputs", + "properties": { + "name": { + "type": "string", + "description": "Name of the database" + }, + "restoreDatabaseName": { + "type": "string", + "description": "Name of the database at destination" + }, + "backupFileShare": { + "$ref": "#/definitions/FileShare", + "description": "Backup file share information for this database." + }, + "databaseFiles": { + "type": "array", + "description": "The list of database files", + "items": { + "$ref": "#/definitions/DatabaseFileInput" + } + } + } + }, + "DatabaseFileInput": { + "type": "object", + "description": "Database file specific information for input", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for database file" + }, + "logicalName": { + "type": "string", + "description": "Logical name of the file" + }, + "physicalFullName": { + "type": "string", + "description": "Operating-system full path of the file" + }, + "restoreFullName": { + "type": "string", + "description": "Suggested full path of the file for restoring" + }, + "fileType": { + "$ref": "#/definitions/DatabaseFileType", + "description": "Database file type" + } + } + }, + "DatabaseFileInfo": { + "type": "object", + "description": "Database file specific information", + "properties": { + "databaseName": { + "type": "string", + "description": "Name of the database" + }, + "id": { + "type": "string", + "description": "Unique identifier for database file" + }, + "logicalName": { + "type": "string", + "description": "Logical name of the file" + }, + "physicalFullName": { + "type": "string", + "description": "Operating-system full path of the file" + }, + "restoreFullName": { + "type": "string", + "description": "Suggested full path of the file for restoring" + }, + "fileType": { + "$ref": "#/definitions/DatabaseFileType", + "description": "Database file type" + }, + "sizeMB": { + "type": "number", + "format": "double", + "description": "Size of the file in megabytes" + } + } + }, + "DatabaseFileType": { + "type": "string", + "description": "An enumeration of SQL Server database file types", + "enum": [ + "Rows", + "Log", + "Filestream", + "NotSupported", + "Fulltext" + ], + "x-ms-enum": { + "name": "DatabaseFileType", + "modelAsString": true + } + }, + "DatabaseMigrationStage": { + "type": "string", + "description": "Current stage of migration", + "enum": [ + "None", + "Initialize", + "Backup", + "FileCopy", + "Restore", + "Completed" + ], + "x-ms-enum": { + "name": "DatabaseMigrationStage", + "modelAsString": true + } + }, + "BlobShare": { + "type": "object", + "description": "Blob container storage information.", + "properties": { + "sasUri": { + "type": "string", + "description": "SAS URI of Azure Storage Account Container." + } + }, + "required": [ + "sasUri" + ] + }, + "FileShare": { + "type": "object", + "description": "File share information with Path, Username, and Password.", + "properties": { + "userName": { + "type": "string", + "description": "User name credential to connect to the share location" + }, + "password": { + "type": "string", + "description": "Password credential used to connect to the share location." + }, + "path": { + "type": "string", + "description": "The folder path for this share." + } + }, + "required": [ + "path" + ] + }, + "StartMigrationScenarioServerRoleResult": { + "type": "object", + "description": "Migration results from a server role.", + "properties": { + "name": { + "type": "string", + "description": "Name of server role.", + "readOnly": true + }, + "state": { + "$ref": "./TasksCommon.json#/definitions/MigrationState", + "description": "Current state of migration", + "readOnly": true + }, + "exceptionsAndWarnings": { + "description": "Migration exceptions and warnings.", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + }, + "LoginType": { + "type": "string", + "description": "Enum mapping of SMO LoginType.", + "enum": [ + "WindowsUser", + "WindowsGroup", + "SqlLogin", + "Certificate", + "AsymmetricKey", + "ExternalUser", + "ExternalGroup" + ], + "x-ms-enum": { + "name": "LoginType" + } + }, + "LoginMigrationStage": { + "type": "string", + "description": "Enum of the different stage of login migration.", + "enum": [ + "None", + "Initialize", + "LoginMigration", + "EstablishUserMapping", + "AssignRoleMembership", + "AssignRoleOwnership", + "EstablishServerPermissions", + "EstablishObjectPermissions", + "Completed" + ], + "x-ms-enum": { + "name": "LoginMigrationStage" + } + }, + "MigrationEligibilityInfo": { + "type": "object", + "description": "Information about migration eligibility of a server object", + "properties": { + "isEligibileForMigration": { + "type": "boolean", + "description": "Whether object is eligible for migration or not.", + "readOnly": true + }, + "validationMessages": { + "description": "Information about eligibility failure for the server object.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Operations_List.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Operations_List.json new file mode 100644 index 000000000000..1be35f58f42f --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Operations_List.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataMigration/services/read", + "display": { + "provider": "Database Migration Service", + "resource": "Database Migration Service", + "operation": "Read", + "description": "Read information about services." + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_CreateOrUpdate.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_CreateOrUpdate.json new file mode 100644 index 000000000000..d6813ea61f2f --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_CreateOrUpdate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "api-version": "2018-04-19", + "parameters": { + "location": "southcentralus", + "properties": { + "sourcePlatform": "SQL", + "targetPlatform": "SQLDB" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sourcePlatform": "SQL", + "targetPlatform": "SQLDB", + "creationTime": "2017-11-03T02:14:54.2458282-07:00", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject", + "location": "southcentralus", + "name": "DmsSdkProject", + "type": "Microsoft.DataMigration/services/projects" + } + }, + "201": { + "body": { + "properties": { + "sourcePlatform": "SQL", + "targetPlatform": "SQLDB", + "creationTime": "2017-11-03T02:14:54.2458282-07:00", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject", + "location": "southcentralus", + "name": "DmsSdkProject", + "type": "Microsoft.DataMigration/services/projects" + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_Delete.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_Delete.json new file mode 100644 index 000000000000..93412481c6e4 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_Get.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_Get.json new file mode 100644 index 000000000000..80e39264d9cb --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": { + "properties": { + "sourcePlatform": "SQL", + "targetPlatform": "SQLDB", + "creationTime": "2017-11-03T02:35:11.6561001-07:00", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject", + "location": "southcentralus", + "name": "DmsSdkProject", + "type": "Microsoft.DataMigration/services/projects" + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_List.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_List.json new file mode 100644 index 000000000000..1349141ff64b --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "sourcePlatform": "SQL", + "targetPlatform": "SQLDB", + "creationTime": "2017-11-14T01:29:56.3049263+00:00", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/project1", + "location": "southcentralus", + "name": "project1", + "type": "Microsoft.DataMigration/services/projects" + }, + { + "properties": { + "sourcePlatform": "SQL", + "targetPlatform": "SQLDB", + "creationTime": "2017-11-14T01:30:05.6185148+00:00", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/project2", + "location": "southcentralus", + "name": "project2", + "type": "Microsoft.DataMigration/services/projects" + } + ] + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_Update.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_Update.json new file mode 100644 index 000000000000..5f5d289beba2 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Projects_Update.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "api-version": "2018-04-19", + "parameters": { + "properties": { + "sourcePlatform": "SQL", + "targetPlatform": "SQLDB" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sourcePlatform": "SQL", + "targetPlatform": "SQLDB", + "creationTime": "2017-11-03T02:14:54.2458282-07:00", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject", + "location": "southcentralus", + "name": "DmsSdkProject", + "type": "Microsoft.DataMigration/services/projects" + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/ResourceSkus_ListSkus.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/ResourceSkus_ListSkus.json new file mode 100644 index 000000000000..624561a9d00c --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/ResourceSkus_ListSkus.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "services", + "name": "PP1", + "locations": [ "East Asia", "Southeast Asia", "Australia East", "Australia Southeast", "Brazil South", "Canada Central", "Canada East", "North Europe", "West Europe", "Central India", "South India", "West India", "Japan East", "Japan West", "Korea South", "Korea Central", "UK South", "UK South 2", "UK North", "UK West", "East US 2 EUAP", "Central US", "East US", "East US 2", "North Central US", "South Central US", "West Central US", "West US", "West US 2" ], + "restrictions": [] + } + ] + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_CheckNameAvailability.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_CheckNameAvailability.json new file mode 100644 index 000000000000..444a14b8bc05 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "api-version": "2018-04-19", + "location": "eastus", + "parameters": { + "requestedName": { + "name": "DmsSdkService", + "type": "services" + } + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_CheckStatus.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_CheckStatus.json new file mode 100644 index 000000000000..3f1ab717ee28 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_CheckStatus.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": { + "agentVersion": "3.3.3871.6", + "status": "Online", + "vmSize": "Standard_A1_v2", + "supportedTaskTypes": [ + "diagnostic.count", + "diagnostic.echo", + "diagnostic.error", + "diagnostic.fastCount", + "ConnectToSource.SqlServer", + "GetUserTables.Sql", + "ConnectToTarget.SqlDb", + "Migrate.SqlServer.SqlDb" + ] + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_CreateOrUpdate.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_CreateOrUpdate.json new file mode 100644 index 000000000000..f75bbae87f33 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_CreateOrUpdate.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "api-version": "2018-04-19", + "parameters": { + "properties": { + "virtualSubnetId": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkTestNetwork/providers/Microsoft.Network/virtualNetworks/DmsSdkTestNetwork/subnets/default" + }, + "sku": { + "name": "Basic_1vCore" + }, + "location": "southcentralus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "virtualSubnetId": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkTestNetwork/providers/Microsoft.Network/virtualNetworks/DmsSdkTestNetwork/subnets/default" + }, + "etag": "9QuK/U0GvTJpjIrlOzITXVy68+bmmQ3bFkHudLxmkUw=", + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService", + "location": "southcentralus", + "name": "DmsSdkService", + "sku": { + "name": "Basic_1vCore", + "size": "1 vCore", + "tier": "Basic" + }, + "type": "Microsoft.DataMigration/services" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Accepted", + "virtualSubnetId": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkTestNetwork/providers/Microsoft.Network/virtualNetworks/DmsSdkTestNetwork/subnets/default" + }, + "etag": "9QuK/U0GvTJpjIrlOzITXVy68+bmmQ3bFkHudLxmkUw=", + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService", + "location": "southcentralus", + "name": "DmsSdkService", + "sku": { + "name": "Basic_1vCore", + "size": "1 vCore", + "tier": "Basic" + }, + "type": "Microsoft.DataMigration/services" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Delete.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Delete.json new file mode 100644 index 000000000000..fe08f524ec9a --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "api-version": "2018-04-19" + }, + "responses": { + "200": {}, + "202": { + "body": "" + }, + "204": {} + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Get.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Get.json new file mode 100644 index 000000000000..59a56081f946 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicKey": "0;AQAB;kkQk9TqKG6+ZP2DDr0yjdnlHsZjJFBbL++2eSJvTDzIJFE98nGSA3RNX4EC65oSmsaNhKZi7y6v+cuU6/7q08uom5IfTK0CxmjRnKdoOHnZnP9TShaFLiZPv7H/FXoUIzHKuaOxg+/35AlhDXLVFjKmwfScLC+g6sEWDhlfWzcN7c34yVOGF+BQyZHIeqBcf9HDcwgFfjvAlEh0x4sTeLUNdpjLEv74ce3A/kJMBdFUoxVXvHcMjVVGXC4gS1VLb7Ykoihx+/c5qbhKMNff21v5lwxzNLfIMGzL+T8vKab+3Cpmusk2JaBJ+6glIIuhrpaX5X9fgmvenzzluUWMX9w==", + "virtualSubnetId": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkTestNetwork/providers/Microsoft.Network/virtualNetworks/DmsSdkTestNetwork/subnets/default" + }, + "etag": "VVFgsiFIruaTduI4hoNOUXLMXr5Y79qytW2cotz4viI=", + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService", + "location": "southcentralus", + "name": "DmsSdkService", + "sku": { + "name": "Basic_1vCore", + "size": "1 vCore", + "tier": "Basic" + }, + "type": "Microsoft.DataMigration/services" + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_List.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_List.json new file mode 100644 index 000000000000..2fb635206228 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg1/providers/Microsoft.DataMigration/services/DmsSdkService1", + "name": "DmsSdkService1", + "type": "Microsoft.DataMigration/services", + "sku": { + "name": "GeneralPurpose_4vCores", + "tier": "General Purpose", + "size": "4 vCores" + }, + "location": "southcentralus" + }, + { + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg2/providers/Microsoft.DataMigration/services/DmsSdkService2", + "name": "DmsSdkService2", + "type": "Microsoft.DataMigration/services", + "sku": { + "name": "Basic_2vCores", + "tier": "Basic", + "size": "2 vCores" + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_ListByResourceGroup.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_ListByResourceGroup.json new file mode 100644 index 000000000000..35456f7c7104 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService1", + "name": "DmsSdkService1", + "type": "Microsoft.DataMigration/services", + "sku": { + "name": "GeneralPurpose_4vCores", + "tier": "General Purpose", + "size": "4 vCores" + }, + "location": "southcentralus" + }, + { + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService2", + "name": "DmsSdkService2", + "type": "Microsoft.DataMigration/services", + "sku": { + "name": "Basic_2vCores", + "tier": "Basic", + "size": "2 vCores" + }, + "location": "southcentralus" + } + ] + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_ListSkus.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_ListSkus.json new file mode 100644 index 000000000000..2445d7879a01 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_ListSkus.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.DataMigration/services", + "sku": { + "name": "Basic_1vCore", + "size": "1 vCore", + "tier": "Basic" + } + } + ] + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_NestedCheckNameAvailability.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_NestedCheckNameAvailability.json new file mode 100644 index 000000000000..1d0da536478b --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_NestedCheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "api-version": "2018-04-19", + "parameters": { + "requestedName": { + "name": "Task1", + "type": "tasks" + } + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Start.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Start.json new file mode 100644 index 000000000000..7394c9b644c3 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Start.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "api-version": "2018-04-19" + }, + "responses": { + "202": { + "body": "" + }, + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Stop.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Stop.json new file mode 100644 index 000000000000..7394c9b644c3 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Stop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "api-version": "2018-04-19" + }, + "responses": { + "202": { + "body": "" + }, + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Update.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Update.json new file mode 100644 index 000000000000..5bd64e97209a --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Services_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "api-version": "2018-04-19", + "parameters": { + "properties": { + "virtualSubnetId": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkTestNetwork/providers/Microsoft.Network/virtualNetworks/DmsSdkTestNetwork/subnets/default" + } + } + }, + "responses":{ + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "virtualSubnetId": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkTestNetwork/providers/Microsoft.Network/virtualNetworks/DmsSdkTestNetwork/subnets/default" + }, + "etag": "9QuK/U0GvTJpjIrlOzITXVy68+bmmQ3bFkHudLxmkUw=", + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService", + "location": "southcentralus", + "name": "DmsSdkService", + "sku": { + "name": "Basic_1vCore", + "size": "1 vCore", + "tier": "Basic" + }, + "type": "Microsoft.DataMigration/services" + } + }, + "202":{} + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_Cancel.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_Cancel.json new file mode 100644 index 000000000000..9aece28ca48a --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_Cancel.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "taskName": "DmsSdkTask", + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": { + "properties": { + "input": { + "targetConnectionInfo": { + "type": "SqlConnectionInfo", + "dataSource": "ssma-test-server.database.windows.net", + "authentication": "SqlAuthentication", + "encryptConnection": true, + "trustServerCertificate": true, + "userName": "testuser" + } + }, + "taskType": "ConnectToTarget.SqlDb", + "state": "Queued" + }, + "etag": "0vPYxzfnDaDH9yhOJAnqTyTRpa09Kb7pm+LEukDBbw8=", + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject/tasks/DmsSdkTask", + "name": "DmsSdkTask", + "type": "Microsoft.DataMigration/services/projects/tasks" + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_CreateOrUpdate.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_CreateOrUpdate.json new file mode 100644 index 000000000000..1e63b6e51c7d --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_CreateOrUpdate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "projectName": "DmsSdkProject", + "serviceName": "DmsSdkService", + "taskName": "DmsSdkTask", + "api-version": "2018-04-19", + "parameters": { + "properties": { + "taskType": "ConnectToTarget.SqlDb", + "input": { + "targetConnectionInfo": { + "type": "SqlConnectionInfo", + "dataSource": "ssma-test-server.database.windows.net", + "authentication": "SqlAuthentication", + "encryptConnection": true, + "trustServerCertificate": true, + "userName": "testuser", + "password": "testpassword" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "input": { + "targetConnectionInfo": { + "type": "SqlConnectionInfo", + "dataSource": "ssma-test-server.database.windows.net", + "authentication": "SqlAuthentication", + "encryptConnection": true, + "trustServerCertificate": true, + "userName": "testuser" + } + }, + "taskType": "ConnectToTarget.SqlDb", + "state": "Queued" + }, + "etag": "0vPYxzfnDaDH9yhOJAnqTyTRpa09Kb7pm+LEukDBbw8=", + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject/tasks/DmsSdkTask", + "name": "DmsSdkTask", + "type": "Microsoft.DataMigration/services/projects/tasks" + } + }, + "201": { + "body": { + "properties": { + "input": { + "targetConnectionInfo": { + "type": "SqlConnectionInfo", + "dataSource": "ssma-test-server.database.windows.net", + "authentication": "SqlAuthentication", + "encryptConnection": true, + "trustServerCertificate": true, + "userName": "testuser" + } + }, + "taskType": "ConnectToTarget.SqlDb", + "state": "Queued" + }, + "etag": "0vPYxzfnDaDH9yhOJAnqTyTRpa09Kb7pm+LEukDBbw8=", + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject/tasks/DmsSdkTask", + "name": "DmsSdkTask", + "type": "Microsoft.DataMigration/services/projects/tasks" + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_Delete.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_Delete.json new file mode 100644 index 000000000000..4ee39fc17577 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "taskName": "DmsSdkTask", + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_Get.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_Get.json new file mode 100644 index 000000000000..7203f0c70cf5 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "taskName": "DmsSdkTask", + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": { + "properties": { + "input": { + "targetConnectionInfo": { + "type": "SqlConnectionInfo", + "dataSource": "ssma-test-server.database.windows.net", + "authentication": "SqlAuthentication", + "encryptConnection": true, + "trustServerCertificate": true, + "userName": "testuser" + } + }, + "taskType": "ConnectToTarget.SqlDb", + "state": "Queued" + }, + "etag": "0vPYxzfnDaDH9yhOJAnqTyTRpa09Kb7pm+LEukDBbw8=", + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject/tasks/DmsSdkTask", + "name": "DmsSdkTask", + "type": "Microsoft.DataMigration/services/projects/tasks" + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_List.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_List.json new file mode 100644 index 000000000000..a3bd70f03d30 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "input": { + "targetConnectionInfo": { + "type": "SqlConnectionInfo", + "dataSource": "ssma-test-server.database.windows.net", + "authentication": "SqlAuthentication", + "encryptConnection": true, + "trustServerCertificate": true, + "userName": "testuser" + } + }, + "taskType": "ConnectToTarget.SqlDb", + "state": "Queued" + }, + "etag": "0vPYxzfnDaDH9yhOJAnqTyTRpa09Kb7pm+LEukDBbw8=", + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject/tasks/DmsSdkTask", + "name": "DmsSdkTask", + "type": "Microsoft.DataMigration/services/projects/tasks" + } + ] + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_Update.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_Update.json new file mode 100644 index 000000000000..ddbd91b9fcb9 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Tasks_Update.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "projectName": "DmsSdkProject", + "serviceName": "DmsSdkService", + "taskName": "DmsSdkTask", + "api-version": "2018-04-19", + "parameters": { + "properties": { + "taskType": "ConnectToTarget.SqlDb", + "input": { + "targetConnectionInfo": { + "type": "SqlConnectionInfo", + "dataSource": "ssma-test-server.database.windows.net", + "authentication": "SqlAuthentication", + "encryptConnection": true, + "trustServerCertificate": true, + "userName": "testuser", + "password": "testpassword" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "input": { + "targetConnectionInfo": { + "type": "SqlConnectionInfo", + "dataSource": "ssma-test-server.database.windows.net", + "authentication": "SqlAuthentication", + "encryptConnection": true, + "trustServerCertificate": true, + "userName": "testuser" + } + }, + "taskType": "ConnectToTarget.SqlDb", + "state": "Queued" + }, + "etag": "0vPYxzfnDaDH9yhOJAnqTyTRpa09Kb7pm+LEukDBbw8=", + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject/tasks/DmsSdkTask", + "name": "DmsSdkTask", + "type": "Microsoft.DataMigration/services/projects/tasks" + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Usages_List.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Usages_List.json new file mode 100644 index 000000000000..a99a785fc958 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/examples/Usages_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "90fb80a6-0f71-4761-8f03-921e7396f3c0", + "location": "westus", + "api-version": "2018-04-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 1.0, + "id": "/subscriptions/90fb80a6-0f71-4761-8f03-921e7396f3c0/providers/Microsoft.DataMigration/locations/westus/usages/Services", + "limit": 2.0, + "name": { + "localizedValue": "DMS service instances per region", + "value": "Services" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/datamigration/resource-manager/readme.md b/specification/datamigration/resource-manager/readme.md index ce4571ebcda0..61ecee7084fb 100644 --- a/specification/datamigration/resource-manager/readme.md +++ b/specification/datamigration/resource-manager/readme.md @@ -1,8 +1,8 @@ -# Data Migration Service +# Azure Database Migration Service > see https://aka.ms/autorest -This is the AutoRest configuration file for Database Migration Service. +This is the AutoRest configuration file for Azure Database Migration Service. The Data Migration RP comprises of APIs that enable a customer to manage the service instances that help migrate databases from a source to target. @@ -28,26 +28,48 @@ These are the global settings for the Database Migration Service API. title: DataMigrationManagementClient description: Data Migration Client openapi-type: arm -tag: package-2018-03-31-preview +tag: package-2018-04-19 ``` -### Tag: package-2017-11-15-preview +### Tag: package-2018-04-19 -These settings apply only when `--tag=package-2017-11-15-preview` is specified on the command line. +These settings apply only when `--tag=package-2018-04-19` is specified on the command line. -``` yaml $(tag) == 'package-2017-11-15-preview' +``` yaml $(tag) == 'package-2018-04-19' input-file: -- Microsoft.DataMigration/preview/2017-11-15-preview/datamigration.json -- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/Common.json -- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/ConnectToSourceSqlServerTask.json -- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/ConnectToTargetSqlDbTask.json -- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/GetUserTablesSqlTask.json -- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/MigrateSqlServerSqlDbTask.json -- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/Projects.json -- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/Services.json -- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/Tasks.json -- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/TasksCommon.json -- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/MigrationValidation.json +- Microsoft.DataMigration/stable/2018-04-19/datamigration.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/Common.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceSqlServerTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlDbTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/GetUserTablesSqlTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlDbTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/Projects.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/Services.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/Tasks.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/TasksCommon.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/MigrationValidation.json +``` + +### Tag: package-2018-03-31-preview + +These settings apply only when `--tag=package-2018-03-31-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03-31-preview' +input-file: +- Microsoft.DataMigration/preview/2018-03-31-preview/datamigration.json +- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/Common.json +- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ConnectToSourceSqlServerTask.json +- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ConnectToTargetSqlDbTask.json +- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ConnectToTargetSqlMITask.json +- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/GetUserTablesSqlTask.json +- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/MigrateSqlServerSqlDbTask.json +- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/MigrateSqlServerSqlMITask.json +- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/Projects.json +- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/Services.json +- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/Tasks.json +- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/TasksCommon.json +- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/MigrationValidation.json +- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ValidateMigrationInputSqlServerSqlMITask.json ``` ### Tag: package-2018-03-15-preview @@ -71,27 +93,26 @@ input-file: - Microsoft.DataMigration/preview/2018-03-15-preview/definitions/MigrationValidation.json - Microsoft.DataMigration/preview/2018-03-15-preview/definitions/ValidateMigrationInputSqlServerSqlMITask.json ``` -### Tag: package-2018-03-31-preview -These settings apply only when `--tag=package-2018-03-31-preview` is specified on the command line. +### Tag: package-2017-11-15-preview -``` yaml $(tag) == 'package-2018-03-31-preview' +These settings apply only when `--tag=package-2017-11-15-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-11-15-preview' input-file: -- Microsoft.DataMigration/preview/2018-03-31-preview/datamigration.json -- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/Common.json -- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ConnectToSourceSqlServerTask.json -- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ConnectToTargetSqlDbTask.json -- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ConnectToTargetSqlMITask.json -- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/GetUserTablesSqlTask.json -- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/MigrateSqlServerSqlDbTask.json -- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/MigrateSqlServerSqlMITask.json -- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/Projects.json -- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/Services.json -- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/Tasks.json -- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/TasksCommon.json -- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/MigrationValidation.json -- Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ValidateMigrationInputSqlServerSqlMITask.json +- Microsoft.DataMigration/preview/2017-11-15-preview/datamigration.json +- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/Common.json +- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/ConnectToSourceSqlServerTask.json +- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/ConnectToTargetSqlDbTask.json +- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/GetUserTablesSqlTask.json +- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/MigrateSqlServerSqlDbTask.json +- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/Projects.json +- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/Services.json +- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/Tasks.json +- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/TasksCommon.json +- Microsoft.DataMigration/preview/2017-11-15-preview/definitions/MigrationValidation.json ``` + --- # Code Generation @@ -176,7 +197,7 @@ These settings apply only when `--tag=package-2017-11-15-preview --go` is specif Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2017-11-15-preview' && $(go) -output-folder: $(go-sdk-folder)/services/datamigration/mgmt/2017-11-15-preview/datamigration +output-folder: $(go-sdk-folder)/services/preview/datamigration/mgmt/2017-11-15-preview/datamigration ``` ### Tag: package-2018-03-31-preview and go @@ -194,11 +215,46 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.datamigration +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datamigration +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-11-15-preview + - tag: package-2018-03-31-preview +``` + +### Tag: package-2017-11-15-preview and java + +These settings apply only when `--tag=package-2017-11-15-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-11-15-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.datamigration - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datamigration + namespace: com.microsoft.azure.management.azuredatabasemigrationservice.v2017_11_15_preview + output-folder: $(azure-libraries-for-java-folder)/azuredatabasemigrationservice/resource-manager/v2017_11_15_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-03-31-preview and java + +These settings apply only when `--tag=package-2018-03-31-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-03-31-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.azuredatabasemigrationservice.v2018_03_31_preview + output-folder: $(azure-libraries-for-java-folder)/azuredatabasemigrationservice/resource-manager/v2018_03_31_preview +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/deviceprovisioningservices/resource-manager/readme.md b/specification/deviceprovisioningservices/resource-manager/readme.md index 8d5ee3c77490..d1bc9143a85a 100644 --- a/specification/deviceprovisioningservices/resource-manager/readme.md +++ b/specification/deviceprovisioningservices/resource-manager/readme.md @@ -66,7 +66,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go ``` @@ -138,7 +138,7 @@ batch: These settings apply only when `--tag=package-2018-01 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag)=='package-2017-11' && $(go) +``` yaml $(tag)=='package-2018-01' && $(go) output-folder: $(go-sdk-folder)/services/provisioningservices/mgmt/2018-01-22/iothub ``` @@ -153,11 +153,11 @@ output-folder: $(go-sdk-folder)/services/provisioningservices/mgmt/2017-11-15/io ### Tag: package-2017-08 and go -These settings apply only when `--tag=package-2017-11 --go` is specified on the command line. +These settings apply only when `--tag=package-2017-08 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2017-08' && $(go) -output-folder: $(go-sdk-folder)/services/provisioningservices/mgmt/2017-08-21-preview/iothub +output-folder: $(go-sdk-folder)/services/preview/provisioningservices/preview/mgmt/2017-08-21-preview/iothub ``` ## Java @@ -166,11 +166,60 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.provisioningservices +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-provisioningservices +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-08 + - tag: package-2017-11 + - tag: package-2018-01 +``` + +### Tag: package-2017-08 and java + +These settings apply only when `--tag=package-2017-08 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-08' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.provisioningservices - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-provisioningservices + namespace: com.microsoft.azure.management.deviceprovisioningservices.v2017_08_21_preview + output-folder: $(azure-libraries-for-java-folder)/deviceprovisioningservices/resource-manager/v2017_08_21_preview +regenerate-manager: true +generate-interface: true ``` + +### Tag: package-2017-11 and java + +These settings apply only when `--tag=package-2017-11 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-11' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.deviceprovisioningservices.v2017_11_15 + output-folder: $(azure-libraries-for-java-folder)/deviceprovisioningservices/resource-manager/v2017_11_15 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-01 and java + +These settings apply only when `--tag=package-2018-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.deviceprovisioningservices.v2018_01_22 + output-folder: $(azure-libraries-for-java-folder)/deviceprovisioningservices/resource-manager/v2018_01_22 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/devspaces.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/devspaces.json new file mode 100644 index 000000000000..85ec0d38b2f4 --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/devspaces.json @@ -0,0 +1,731 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-06-01-preview", + "title": "DevSpacesManagement", + "description": "Dev Spaces REST API" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}": { + "get": { + "tags": [ + "Controllers" + ], + "summary": "Gets an Azure Dev Spaces Controller.", + "description": "Gets the properties for an Azure Dev Spaces Controller.", + "operationId": "Controllers_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; response contains the Azure Dev Spaces Controller.", + "schema": { + "$ref": "#/definitions/Controller" + } + }, + "default": { + "description": "Error response describing the reason for operation failure. 404 - NotFound(Azure Dev Spaces Controller doesn't exist.)", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ControllersGet": { + "$ref": "./examples/ControllersGet_example.json" + } + } + }, + "put": { + "tags": [ + "Controllers" + ], + "summary": "Creates an Azure Dev Spaces Controller.", + "description": "Creates an Azure Dev Spaces Controller with the specified create parameters.", + "operationId": "Controllers_Create", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/NameParameter" + }, + { + "name": "controller", + "in": "body", + "description": "Controller create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Controller" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; response contains the created Azure Dev Spaces Controller .", + "schema": { + "$ref": "#/definitions/Controller" + } + }, + "201": { + "description": "The request was successful; Azure Dev Spaces Controller is being created.", + "schema": { + "$ref": "#/definitions/Controller" + } + }, + "default": { + "description": "Error response describing the reason for operation failure. 404 - NotFound(Azure Dev Spaces Controller doesn't exist.), 400 - BadRequest(One or more creation parameters are invalid.)", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ControllersCreate": { + "$ref": "./examples/ControllersCreate_example.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Controllers" + ], + "summary": "Deletes an Azure Dev Spaces Controller.", + "description": "Deletes an existing Azure Dev Spaces Controller.", + "operationId": "Controllers_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the Azure Dev Spaces Controller is deleted." + }, + "202": { + "description": "The request was successful; Azure Dev Spaces Controller is being deleted." + }, + "204": { + "description": "The request was successful; Azure Dev Spaces Controller does not exist." + }, + "default": { + "description": "Error response describing the reason for operation failure. 409 - Conflict(Azure Dev Spaces Controller is already getting deleted.)", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ControllersDelete": { + "$ref": "./examples/ControllersDelete_example.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Controllers" + ], + "summary": "Updates an Azure Dev Spaces Controller.", + "description": "Updates the properties of an existing Azure Dev Spaces Controller with the specified update parameters.", + "operationId": "Controllers_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/NameParameter" + }, + { + "name": "controllerUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ControllerUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; response contains the updated Azure Dev Spaces Controller .", + "schema": { + "$ref": "#/definitions/Controller" + } + }, + "default": { + "description": "Error response describing the reason for operation failure. 404 - NotFound(Azure Dev Spaces Controller doesn't exist.), 400 - BadRequest(One or more update parameters are invalid.)", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ControllersUpdate": { + "$ref": "./examples/ControllersUpdate_example.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers": { + "get": { + "tags": [ + "Controllers" + ], + "summary": "Lists the Azure Dev Spaces Controllers in a resource group.", + "description": "Lists all the Azure Dev Spaces Controllers with their properties in the specified resource group and subscription.", + "operationId": "Controllers_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; response contains the list of Azure Dev Spaces Controllers in the resource group.", + "schema": { + "$ref": "#/definitions/ControllerList" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ControllersListByResourceGroup": { + "$ref": "./examples/ControllersListByResourceGroup_example.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevSpaces/controllers": { + "get": { + "tags": [ + "Controllers" + ], + "summary": "Lists the Azure Dev Spaces Controllers in a subscription.", + "description": "Lists all the Azure Dev Spaces Controllers with their properties in the subscription.", + "operationId": "Controllers_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; response contains the list of Azure Dev Spaces Controllers in the subscription.", + "schema": { + "$ref": "#/definitions/ControllerList" + } + }, + "default": { + "description": "Error response describing the reason for operation failure.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ControllersList": { + "$ref": "./examples/ControllersList_example.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}/listConnectionDetails": { + "post": { + "tags": [ + "Controllers" + ], + "summary": "Lists connection details for an Azure Dev Spaces Controller.", + "description": "Lists connection details for the underlying container resources of an Azure Dev Spaces Controller.", + "operationId": "Controllers_ListConnectionDetails", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; response contains the list of connection details for the Azure Dev Spaces Controller .", + "schema": { + "$ref": "#/definitions/ControllerConnectionDetailsList" + } + }, + "default": { + "description": "Error response describing the reason for operation failure. 404 - NotFound(Azure Dev Spaces Controller doesn't exist.)", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ControllersListConnectionDetails": { + "$ref": "./examples/ControllersListConnectionDetails_example.json" + } + } + } + }, + "/providers/Microsoft.DevSpaces/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists operations for the resource provider.", + "description": "Lists all the supported operations by the Microsoft.DevSpaces resource provider along with their description.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; response contains the list of operations under Microsoft.DevSpaces resource provider.", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Controller": { + "required": [ + "properties", + "sku", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ControllerProperties", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/Sku" + } + } + }, + "ControllerProperties": { + "required": [ + "hostSuffix", + "targetContainerHostResourceId", + "targetContainerHostCredentialsBase64" + ], + "properties": { + "provisioningState": { + "description": "Provisioning state of the Azure Dev Spaces Controller.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Updating", + "Creating", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "hostSuffix": { + "description": "DNS suffix for public endpoints running in the Azure Dev Spaces Controller.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dataPlaneFqdn": { + "description": "DNS name for accessing DataPlane services", + "type": "string", + "readOnly": true + }, + "targetContainerHostResourceId": { + "description": "Resource ID of the target container host", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetContainerHostCredentialsBase64": { + "description": "Credentials of the target container host (base64).", + "type": "string", + "x-ms-mutability": [ + "create" + ] + } + } + }, + "Sku": { + "description": "Model representing SKU for Azure Dev Spaces Controller.", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the SKU for Azure Dev Spaces Controller.", + "enum": [ + "S1" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "description": "The tier of the SKU for Azure Dev Spaces Controller.", + "enum": [ + "Standard" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + } + }, + "ControllerUpdateParameters": { + "description": "Parameters for updating an Azure Dev Spaces Controller.", + "properties": { + "tags": { + "description": "Tags for the Azure Dev Spaces Controller.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ControllerList": { + "properties": { + "value": { + "description": "List of Azure Dev Spaces Controllers.", + "type": "array", + "items": { + "$ref": "#/definitions/Controller" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next page for list of Azure Dev Spaces Controllers.", + "type": "string", + "readOnly": true + } + } + }, + "ControllerConnectionDetailsList": { + "properties": { + "connectionDetailsList": { + "description": "List of Azure Dev Spaces Controller connection details.", + "type": "array", + "items": { + "$ref": "#/definitions/ControllerConnectionDetails" + } + } + } + }, + "ControllerConnectionDetails": { + "properties": { + "authKey": { + "description": "Authentication key for communicating with services.", + "type": "string", + "readOnly": true + }, + "workspaceStorageAccountName": { + "description": "Workspace storage account name.", + "type": "string", + "readOnly": true + }, + "workspaceStorageSasToken": { + "description": "Workspace storage account SAS token.", + "type": "string", + "readOnly": true + }, + "orchestratorSpecificConnectionDetails": { + "$ref": "#/definitions/OrchestratorSpecificConnectionDetails" + } + } + }, + "OrchestratorSpecificConnectionDetails": { + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "tags": { + "description": "Tags for the Azure resource.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, + "location": { + "description": "Region where the Azure resource is located.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ResourceProviderOperationList": { + "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", + "readOnly": true + } + } + }, + "ResourceProviderOperationDefinition": { + "properties": { + "name": { + "description": "Resource provider operation name.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/ResourceProviderOperationDisplay" + } + } + }, + "ResourceProviderOperationDisplay": { + "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" + } + } + }, + "Resource": { + "description": "An Azure resource.", + "properties": { + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "KubernetesConnectionDetails": { + "allOf": [ + { + "$ref": "#/definitions/OrchestratorSpecificConnectionDetails" + } + ], + "properties": { + "kubeConfig": { + "description": "Gets the kubeconfig for the cluster.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Kubernetes" + }, + "ErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDetails", + "description": "The details of the error." + } + } + }, + "ErrorDetails": { + "properties": { + "code": { + "description": "Status code for the error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message describing the error in detail.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure subscription ID.", + "required": true, + "type": "string" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group to which the resource belongs.", + "required": true, + "type": "string", + "maxLength": 90, + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "NameParameter": { + "name": "name", + "in": "path", + "description": "Name of the resource.", + "required": true, + "type": "string", + "maxLength": 31, + "minLength": 3, + "pattern": "^[a-zA-Z0-9](-?[a-zA-Z0-9])*$", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client API version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesCreate_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesCreate_example.json new file mode 100644 index 000000000000..31e4a855ac66 --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesCreate_example.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "name": "myControllerResource", + "devSpaceCreateParameters": { + "location": "eastus", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "hostSuffix": "suffix", + "targetContainerHostCredentialsBase64": "QmFzZTY0IEVuY29kZWQgVmFsdWUK", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DevSpaces/controllers/myControllerResource", + "name": "myControllerResource", + "type": "Microsoft.DevSpaces/controllers", + "location": "eastus", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "hostSuffix": "suffix", + "dataPlaneFqdn": "dataplane.azds.io", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DevSpaces/controllers/myControllerResource", + "name": "myControllerResource", + "type": "Microsoft.DevSpaces/controllers", + "location": "eastus", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Creating", + "hostSuffix": "suffix", + "dataPlaneFqdn": "dataplane.azds.io", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesDelete_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesDelete_example.json new file mode 100644 index 000000000000..187f17b7a0b1 --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesDelete_example.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "name": "myControllerResource" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevSpaces/operationresults/00000000-0000-0000-0000-000000000000" + } + }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesGet_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesGet_example.json new file mode 100644 index 000000000000..f6deb02784f9 --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesGet_example.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "name": "myControllerResource" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DevSpaces/controllers/myControllerResource", + "name": "myControllerResource", + "type": "Microsoft.DevSpaces/controllers", + "location": "eastus", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "hostSuffix": "suffix", + "dataPlaneFqdn": "dataplane.azds.io", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesListByResourceGroup_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesListByResourceGroup_example.json new file mode 100644 index 000000000000..06ec0347ede0 --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesListByResourceGroup_example.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DevSpaces/controllers/myControllerResource", + "name": "myControllerResource", + "type": "Microsoft.DevSpaces/controllers", + "location": "eastus", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "hostSuffix": "suffix", + "dataPlaneFqdn": "dataplane.azds.io", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesListConnectionDetails_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesListConnectionDetails_example.json new file mode 100644 index 000000000000..5ef702bf8155 --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesListConnectionDetails_example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "name": "myControllerResource" + }, + "responses": { + "200": { + "body": { + "connectionDetailsList": [ + { + "authKey": "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "workspaceStorageAccountName": "storageAccount", + "workspaceStorageSasToken": "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "orchestratorSpecificConnectionDetails": { + "instanceType": "Kubernetes", + "kubeConfig": "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesList_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesList_example.json new file mode 100644 index 000000000000..7c34aed6946e --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesList_example.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DevSpaces/controllers/myControllerResource", + "name": "myControllerResource", + "type": "Microsoft.DevSpaces/controllers", + "location": "eastus", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "hostSuffix": "suffix", + "dataPlaneFqdn": "dataplane.azds.io", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesUpdate_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesUpdate_example.json new file mode 100644 index 000000000000..ac792de99122 --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesUpdate_example.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "name": "myControllerResource", + "devSpaceUpdateParameters": { + "tags": { + "key": "value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DevSpaces/controllers/myControllerResource", + "name": "myControllerResource", + "type": "Microsoft.DevSpaces/controllers", + "location": "eastus", + "tags": { + "key": "value" + }, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "hostSuffix": "suffix", + "dataPlaneFqdn": "dataplane.azds.io", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DevSpaces/controllers/myControllerResource", + "name": "myControllerResource", + "type": "Microsoft.DevSpaces/controllers", + "location": "eastus", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Updating", + "hostSuffix": "suffix", + "dataPlaneFqdn": "dataplane.azds.io", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersCreate_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersCreate_example.json new file mode 100644 index 000000000000..2a21085465af --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersCreate_example.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "name": "myControllerResource", + "controller": { + "location": "eastus", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "hostSuffix": "suffix", + "targetContainerHostCredentialsBase64": "QmFzZTY0IEVuY29kZWQgVmFsdWUK", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DevSpaces/controllers/myControllerResource", + "name": "myControllerResource", + "type": "Microsoft.DevSpaces/controllers", + "location": "eastus", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "hostSuffix": "suffix", + "dataPlaneFqdn": "dataplane.azds.io", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DevSpaces/controllers/myControllerResource", + "name": "myControllerResource", + "type": "Microsoft.DevSpaces/controllers", + "location": "eastus", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Creating", + "hostSuffix": "suffix", + "dataPlaneFqdn": "dataplane.azds.io", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersDelete_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersDelete_example.json new file mode 100644 index 000000000000..187f17b7a0b1 --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersDelete_example.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "name": "myControllerResource" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevSpaces/operationresults/00000000-0000-0000-0000-000000000000" + } + }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersGet_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersGet_example.json new file mode 100644 index 000000000000..f6deb02784f9 --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersGet_example.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "name": "myControllerResource" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DevSpaces/controllers/myControllerResource", + "name": "myControllerResource", + "type": "Microsoft.DevSpaces/controllers", + "location": "eastus", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "hostSuffix": "suffix", + "dataPlaneFqdn": "dataplane.azds.io", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersListByResourceGroup_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersListByResourceGroup_example.json new file mode 100644 index 000000000000..06ec0347ede0 --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersListByResourceGroup_example.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DevSpaces/controllers/myControllerResource", + "name": "myControllerResource", + "type": "Microsoft.DevSpaces/controllers", + "location": "eastus", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "hostSuffix": "suffix", + "dataPlaneFqdn": "dataplane.azds.io", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersListConnectionDetails_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersListConnectionDetails_example.json new file mode 100644 index 000000000000..5ef702bf8155 --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersListConnectionDetails_example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "name": "myControllerResource" + }, + "responses": { + "200": { + "body": { + "connectionDetailsList": [ + { + "authKey": "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "workspaceStorageAccountName": "storageAccount", + "workspaceStorageSasToken": "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "orchestratorSpecificConnectionDetails": { + "instanceType": "Kubernetes", + "kubeConfig": "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersList_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersList_example.json new file mode 100644 index 000000000000..7c34aed6946e --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersList_example.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DevSpaces/controllers/myControllerResource", + "name": "myControllerResource", + "type": "Microsoft.DevSpaces/controllers", + "location": "eastus", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "hostSuffix": "suffix", + "dataPlaneFqdn": "dataplane.azds.io", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersUpdate_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersUpdate_example.json new file mode 100644 index 000000000000..fe993c75c0c1 --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllersUpdate_example.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "name": "myControllerResource", + "controllerUpdateParameters": { + "tags": { + "key": "value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DevSpaces/controllers/myControllerResource", + "name": "myControllerResource", + "type": "Microsoft.DevSpaces/controllers", + "location": "eastus", + "tags": { + "key": "value" + }, + "sku": { + "name": "S1", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "hostSuffix": "suffix", + "dataPlaneFqdn": "dataplane.azds.io", + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/readme.md b/specification/devspaces/resource-manager/readme.md new file mode 100644 index 000000000000..934055b60ac8 --- /dev/null +++ b/specification/devspaces/resource-manager/readme.md @@ -0,0 +1,132 @@ +# DevSpaces + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DevSpaces. + + +--- +## Getting Started +To build the SDK for DevSpaces, 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 DevSpaces API. + +``` yaml +title: DevSpacesManagementClient +description: Dev Spaces Client +openapi-type: arm +tag: package-2018-06-01-preview +``` + +### Tag: package-2018-06-01-preview + +These settings apply only when `--tag=package-2018-06-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06-01-preview' +input-file: +- Microsoft.DevSpaces/preview/2018-06-01-preview/devspaces.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-java + - repo: azure-sdk-for-python +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + # last generated with AutoRest.1.0.0-Nightly20170126 + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.DevSpaces + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/DevSpaces/Management.DevSpaces/Generated + clear-output-folder: true +``` + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: devspaces + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-06-01-preview +``` + +### Tag: package-2018-06-01-preview and go + +These settings apply only when `--tag=package-2018-06-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-06-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-06-01-preview/$(namespace) +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.devspaces +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-devspaces +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-06-01-preview +``` + +### Tag: package-2018-06-01-preview and java + +These settings apply only when `--tag=2018-06-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag)=='package-2018-06-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.devspaces.v2018_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/devspaces/resource-manager/v2018_06_01_preview +regenerate-manager: true +generate-interface: true +``` \ No newline at end of file diff --git a/specification/devspaces/resource-manager/readme.nodejs.md b/specification/devspaces/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..056a5726b5c6 --- /dev/null +++ b/specification/devspaces/resource-manager/readme.nodejs.md @@ -0,0 +1,15 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-devspaces + package-version: 1.0.0-preview + output-folder: $(node-sdks-folder)/lib/services/devspacesManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/devspaces/resource-manager/readme.python.md b/specification/devspaces/resource-manager/readme.python.md new file mode 100644 index 000000000000..22ff496e58d7 --- /dev/null +++ b/specification/devspaces/resource-manager/readme.python.md @@ -0,0 +1,27 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.devspaces + package-name: azure-mgmt-devspaces + package-version: 0.1.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-devspaces/azure/mgmt/devspaces +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-devspaces +``` diff --git a/specification/devtestlabs/resource-manager/readme.md b/specification/devtestlabs/resource-manager/readme.md index eab443dc775c..9f28a653a8ab 100644 --- a/specification/devtestlabs/resource-manager/readme.md +++ b/specification/devtestlabs/resource-manager/readme.md @@ -61,9 +61,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_devtestlabs'] ``` @@ -144,7 +147,7 @@ These settings apply only when `--tag=package-2015-05-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-05-preview' && $(go) -output-folder: $(go-sdk-folder)/services/devtestlabs/mgmt/2015-05-21-preview/dtl +output-folder: $(go-sdk-folder)/services/preview/devtestlabs/mgmt/2015-05-21-preview/dtl ``` @@ -154,11 +157,46 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.devtestlabs +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-devtestlabs +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-05 + - tag: package-2015-05-preview +``` + +### Tag: package-2016-05 and java + +These settings apply only when `--tag=package-2016-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-05' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.devtestlabs - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-devtestlabs + namespace: com.microsoft.azure.management.devtestlab.v2016_05_15 + output-folder: $(azure-libraries-for-java-folder)/devtestlab/resource-manager/v2016_05_15 +regenerate-manager: true +generate-interface: true ``` + +### Tag: package-2015-05-preview and java + +These settings apply only when `--tag=package-2015-05-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-05-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.devtestlab.v2015_05_21_preview + output-folder: $(azure-libraries-for-java-folder)/devtestlab/resource-manager/v2015_05_21_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/devtestlabs/resource-manager/readme.ruby.md b/specification/devtestlabs/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..9c3d05b949be --- /dev/null +++ b/specification/devtestlabs/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_devtestlabs +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2016-05 +``` + +### Tag: package-2016-05 and ruby + +These settings apply only when `--tag=package-2016-05 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-05' && $(ruby) +namespace: "Azure::DevTestLabs::Mgmt::V2016_05_15" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_devtestlabs/lib +``` diff --git a/specification/dns/resource-manager/Microsoft.Network/preview/2015-05-04-preview/dns.json b/specification/dns/resource-manager/Microsoft.Network/preview/2015-05-04-preview/dns.json index 5a04f1ad0ae7..3a867d0218af 100644 --- a/specification/dns/resource-manager/Microsoft.Network/preview/2015-05-04-preview/dns.json +++ b/specification/dns/resource-manager/Microsoft.Network/preview/2015-05-04-preview/dns.json @@ -45,11 +45,7 @@ "description": "Creates a RecordSet within a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -135,11 +131,7 @@ "description": "Removes a RecordSet from a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -204,11 +196,7 @@ "description": "Gets a RecordSet.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -272,11 +260,7 @@ "description": "Lists the RecordSets of a specified type in a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group that contains the zone." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -350,11 +334,7 @@ "description": "Lists all RecordSets in a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group that contains the zone." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -407,11 +387,7 @@ "description": "Creates a DNS zone within a resource group.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -468,11 +444,7 @@ "description": "Removes a DNS zone from a resource group.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -508,11 +480,7 @@ "description": "Gets a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -547,11 +515,7 @@ "description": "Lists the DNS zones within a resource group.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "$top", diff --git a/specification/dns/resource-manager/Microsoft.Network/preview/2018-03-01-preview/dns.json b/specification/dns/resource-manager/Microsoft.Network/preview/2018-03-01-preview/dns.json index 8250e8db55a3..caf0a594747b 100644 --- a/specification/dns/resource-manager/Microsoft.Network/preview/2018-03-01-preview/dns.json +++ b/specification/dns/resource-manager/Microsoft.Network/preview/2018-03-01-preview/dns.json @@ -36,11 +36,7 @@ "description": "Updates a record set within a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -159,11 +155,7 @@ "description": "Creates or updates a record set within a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -296,11 +288,7 @@ "description": "Deletes a record set from a DNS zone. This operation cannot be undone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -407,11 +395,7 @@ "description": "Gets a record set.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -515,11 +499,7 @@ "description": "Lists the record sets of a specified type in a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -633,11 +613,7 @@ "description": "Lists all record sets in a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -701,11 +677,7 @@ "description": "Lists all record sets in a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -770,11 +742,7 @@ "description": "Creates or updates a DNS zone. Does not modify DNS records within the zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -838,6 +806,9 @@ "x-ms-examples": { "Create zone": { "$ref": "./examples/CreateOrUpdateZone.json" + }, + "Create private zone": { + "$ref": "./examples/CreateOrUpdatePrivateZone.json" } } }, @@ -849,11 +820,7 @@ "description": "Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -909,11 +876,7 @@ "description": "Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -957,11 +920,7 @@ "description": "Updates a DNS zone. Does not modify DNS records within the zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -1024,11 +983,7 @@ "description": "Lists the DNS zones within a resource group.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "$top", @@ -1623,4 +1578,4 @@ "description": "Specifies the API version." } } -} \ No newline at end of file +} diff --git a/specification/dns/resource-manager/Microsoft.Network/stable/2016-04-01/dns.json b/specification/dns/resource-manager/Microsoft.Network/stable/2016-04-01/dns.json index 073656073ff4..5534bf0d9d72 100644 --- a/specification/dns/resource-manager/Microsoft.Network/stable/2016-04-01/dns.json +++ b/specification/dns/resource-manager/Microsoft.Network/stable/2016-04-01/dns.json @@ -25,11 +25,7 @@ "description": "Updates a record set within a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -115,11 +111,7 @@ "description": "Creates or updates a record set within a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -219,11 +211,7 @@ "description": "Deletes a record set from a DNS zone. This operation cannot be undone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -300,11 +288,7 @@ "description": "Gets a record set.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -375,11 +359,7 @@ "description": "Lists the record sets of a specified type in a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -460,11 +440,7 @@ "description": "Lists all record sets in a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -523,11 +499,7 @@ "description": "Creates or updates a DNS zone. Does not modify DNS records within the zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -597,11 +569,7 @@ "description": "Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -655,11 +623,7 @@ "description": "Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -700,11 +664,7 @@ "description": "Lists the DNS zones within a resource group.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "$top", diff --git a/specification/dns/resource-manager/Microsoft.Network/stable/2017-09-01/dns.json b/specification/dns/resource-manager/Microsoft.Network/stable/2017-09-01/dns.json index 52443eb3b846..70d019b2ec0b 100644 --- a/specification/dns/resource-manager/Microsoft.Network/stable/2017-09-01/dns.json +++ b/specification/dns/resource-manager/Microsoft.Network/stable/2017-09-01/dns.json @@ -36,11 +36,7 @@ "description": "Updates a record set within a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -132,11 +128,7 @@ "description": "Creates or updates a record set within a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -242,11 +234,7 @@ "description": "Deletes a record set from a DNS zone. This operation cannot be undone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -329,11 +317,7 @@ "description": "Gets a record set.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -410,11 +394,7 @@ "description": "Lists the record sets of a specified type in a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -501,11 +481,7 @@ "description": "Lists all record sets in a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -569,11 +545,7 @@ "description": "Creates or updates a DNS zone. Does not modify DNS records within the zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -648,11 +620,7 @@ "description": "Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -708,11 +676,7 @@ "description": "Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -758,11 +722,7 @@ "description": "Lists the DNS zones within a resource group.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "$top", diff --git a/specification/dns/resource-manager/Microsoft.Network/stable/2017-10-01/dns.json b/specification/dns/resource-manager/Microsoft.Network/stable/2017-10-01/dns.json index e8c733e7d28f..091e2d1d8302 100644 --- a/specification/dns/resource-manager/Microsoft.Network/stable/2017-10-01/dns.json +++ b/specification/dns/resource-manager/Microsoft.Network/stable/2017-10-01/dns.json @@ -36,11 +36,7 @@ "description": "Updates a record set within a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -159,11 +155,7 @@ "description": "Creates or updates a record set within a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -296,11 +288,7 @@ "description": "Deletes a record set from a DNS zone. This operation cannot be undone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -407,11 +395,7 @@ "description": "Gets a record set.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -515,11 +499,7 @@ "description": "Lists the record sets of a specified type in a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -633,11 +613,7 @@ "description": "Lists all record sets in a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -701,11 +677,7 @@ "description": "Lists all record sets in a DNS zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -770,11 +742,7 @@ "description": "Creates or updates a DNS zone. Does not modify DNS records within the zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -849,11 +817,7 @@ "description": "Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -909,11 +873,7 @@ "description": "Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -957,11 +917,7 @@ "description": "Updates a DNS zone. Does not modify DNS records within the zone.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "zoneName", @@ -1024,11 +980,7 @@ "description": "Lists the DNS zones within a resource group.", "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "$top", diff --git a/specification/dns/resource-manager/readme.md b/specification/dns/resource-manager/readme.md index f7456bac7a64..91510f7236f3 100644 --- a/specification/dns/resource-manager/readme.md +++ b/specification/dns/resource-manager/readme.md @@ -113,7 +113,6 @@ input-file: ``` ---- # Code Generation @@ -125,9 +124,14 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + after_scripts: + - python ./scripts/multiapi_init_gen.py azure-mgmt-dns + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_dns'] ``` @@ -146,33 +150,6 @@ csharp: clear-output-folder: true ``` -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.dns - package-name: azure-mgmt-dns - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-dns/azure/mgmt/dns -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-dns -``` - ## Go @@ -238,7 +215,7 @@ These settings apply only when `--tag=package-2015-05-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-05-preview' && $(go) -output-folder: $(go-sdk-folder)/services/dns/mgmt/2015-05-04-preview/dns +output-folder: $(go-sdk-folder)/services/preview/dns/mgmt/2015-05-04-preview/dns ``` @@ -248,11 +225,44 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.dns +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-dns +``` + +### Java multi-api + +```yaml $(java) && $(multiapi) +batch: + - tag: package-2017-10 + - tag: package-2016-04 +``` + +### Tag: package-2017-10 and java + +These settings apply only when `--tag=package-2017-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-10' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.dns - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-dns + namespace: com.microsoft.azure.management.dns.v2017_10_01 + output-folder: $(azure-libraries-for-java-folder)/dns/resource-manager/v2017_10_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-04 and java + +These settings apply only when `--tag=package-2016-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.dns.v2016_04_01 + output-folder: $(azure-libraries-for-java-folder)/dns/resource-manager/v2016_04_01 +regenerate-manager: true +generate-interface: true ``` diff --git a/specification/dns/resource-manager/readme.python.md b/specification/dns/resource-manager/readme.python.md new file mode 100644 index 000000000000..b8441edc8c7f --- /dev/null +++ b/specification/dns/resource-manager/readme.python.md @@ -0,0 +1,45 @@ +## Python + +These settings apply only when `--python` is specified on the command line. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + package-name: azure-mgmt-dns + clear-output-folder: true + no-namespace-folders: true +``` + +### Python multi-api + +Generate all API versions currently shipped for this package + +```yaml $(python) && $(multiapi) +batch: + - tag: package-2018-03-preview + - tag: package-2016-04 +``` + +### Tag: package-2018-03-preview and python + +These settings apply only when `--tag=package-2018-03-preview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-03-preview' && $(python) +python: + namespace: azure.mgmt.dns.v2018_03_01_preview + output-folder: $(python-sdks-folder)/azure-mgmt-dns/azure/mgmt/dns/v2018_03_01_preview +``` + +### Tag: package-2016-04 and python + +These settings apply only when `--tag=package-2016-04 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-04' && $(python) +python: + namespace: azure.mgmt.dns.v2016_04_01 + output-folder: $(python-sdks-folder)/azure-mgmt-dns/azure/mgmt/dns/v2016_04_01 +``` diff --git a/specification/dns/resource-manager/readme.ruby.md b/specification/dns/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..566b4b37cbcc --- /dev/null +++ b/specification/dns/resource-manager/readme.ruby.md @@ -0,0 +1,59 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_dns +package-version: "0.16.1" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-03-preview + - tag: package-2017-10 + - tag: package-2017-09 + - tag: package-2016-04 +``` + +### Tag: package-2018-03-preview and ruby + +These settings apply only when `--tag=package-2018-03-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-03-preview' && $(ruby) +namespace: "Azure::Dns::Mgmt::V2018_03_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_dns/lib +``` + +### Tag: package-2017-10 and ruby + +These settings apply only when `--tag=package-2017-10 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-10' && $(ruby) +namespace: "Azure::Dns::Mgmt::V2017_10_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_dns/lib +``` + +### Tag: package-2017-09 and ruby + +These settings apply only when `--tag=package-2017-09 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-09' && $(ruby) +namespace: "Azure::Dns::Mgmt::V2017_09_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_dns/lib +``` + +### Tag: package-2016-04 and ruby + +These settings apply only when `--tag=package-2016-04 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-04' && $(ruby) +namespace: "Azure::Dns::Mgmt::V2016_04_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_dns/lib +``` diff --git a/specification/domainservices/resource-manager/readme.md b/specification/domainservices/resource-manager/readme.md index ee39af3f8acf..a8ab06845828 100644 --- a/specification/domainservices/resource-manager/readme.md +++ b/specification/domainservices/resource-manager/readme.md @@ -121,11 +121,46 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.domainservices +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-domainservices +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-06 + - tag: package-2017-01 +``` + +### Tag: package-2017-06 and java + +These settings apply only when `--tag=package-2017-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-06' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.domainservices - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-domainservices + namespace: com.microsoft.azure.management.domainservices.v2017_06_01 + output-folder: $(azure-libraries-for-java-folder)/domainservices/resource-manager/v2017_06_01 +regenerate-manager: true +generate-interface: true ``` + +### Tag: package-2017-01 and java + +These settings apply only when `--tag=package-2017-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.domainservices.v2017_01_01 + output-folder: $(azure-libraries-for-java-folder)/domainservices/resource-manager/v2017_01_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/IotHub.json b/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/IotHub.json index 2c2b4efc8351..ca447f11a224 100644 --- a/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/IotHub.json +++ b/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/IotHub.json @@ -26,35 +26,67 @@ ], "properties": {} }, + "IotHubDeviceConnectedEventData": { + "description": "Event data for Microsoft.Devices.DeviceConnected event.", + "allOf": [ + { + "$ref": "#/definitions/DeviceConnectionStateEventProperties" + } + ], + "properties": {} + }, + "IotHubDeviceDisconnectedEventData": { + "description": "Event data for Microsoft.Devices.DeviceDisconnected event.", + "allOf": [ + { + "$ref": "#/definitions/DeviceConnectionStateEventProperties" + } + ], + "properties": {} + }, "DeviceLifeCycleEventProperties": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, DeviceDeleted).", "properties": { "deviceId": { "type": "string", - "description": "The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '." + "description": "The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '." }, "hubName": { "type": "string", "description": "Name of the IoT Hub where the device was created or deleted." }, - "opType": { + "twin": { + "description": "Information about the device twin, which is the cloud representation of application device metadata.", + "$ref" : "#/definitions/DeviceTwinInfo" + } + } + }, + "DeviceConnectionStateEventProperties": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a device connection state event (DeviceConnected, DeviceDisconnected).", + "properties": { + "deviceId": { + "type": "string", + "description": "The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '." + }, + "moduleId": { "type": "string", - "description": "The event type specified for this operation by the IoT Hub." + "description": "The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '." }, - "operationTimestamp": { + "hubName": { "type": "string", - "description": "The ISO8601 timestamp of the operation." + "description": "Name of the IoT Hub where the device was created or deleted." }, - "twin": { - "description": "Information about the device twin, which is the cloud represenation of application device metadata.", - "$ref" : "#/definitions/DeviceTwinInfo" + "deviceConnectionStateEventInfo": { + "description": "Information about the device connection state event.", + "$ref" : "#/definitions/DeviceConnectionStateEventInfo" } } }, "DeviceTwinInfo": { "type": "object", - "description": "Information about the device twin, which is the cloud represenation of application device metadata.", + "description": "Information about the device twin, which is the cloud representation of application device metadata.", "properties": { "authenticationType": { "type": "string", @@ -148,6 +180,16 @@ "x-ms-client-name" : "$lastUpdated" } } + }, + "DeviceConnectionStateEventInfo" : { + "type": "object", + "description": "Information about the device connection state event.", + "properties": { + "sequenceNumber": { + "type": "string", + "description": "Sequence number is string representation of a hexadecimal number. string compare can be used to identify the larger number because both in ASCII and HEX numbers come after alphabets. If you are converting the string to hex, then the number is a 256 bit number." + } + } } } } \ No newline at end of file diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json index 1fb551307aa9..ab3336be3486 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json @@ -118,6 +118,43 @@ "type": "string" } } + }, + "SubscriptionValidationEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent.", + "type": "object", + "properties": { + "validationCode": { + "description": "The validation code sent by Azure Event Grid to validate an event subscription. To complete the validation handshake, the subscriber must either respond with this validation code as part of the validation response, or perform a GET request on the validationUrl (available starting version 2018-05-01-preview).", + "type": "string", + "readOnly": true + }, + "validationUrl": { + "description": "The validation URL sent by Azure Event Grid (available starting version 2018-05-01-preview). To complete the validation handshake, the subscriber must either respond with the validationCode as part of the validation response, or perform a GET request on the validationUrl (available starting version 2018-05-01-preview).", + "type": "string", + "readOnly": true + } + } + }, + "SubscriptionValidationResponse": { + "description": "To complete an event subscription validation handshake, a subscriber can use either the validationCode or the validationUrl received in a SubscriptionValidationEvent. When the validationCode is used, the SubscriptionValidationResponse can be used to build the response.", + "type": "object", + "properties": { + "validationResponse": { + "description": "The validation response sent by the subscriber to Azure Event Grid to complete the validation of an event subscription.", + "type": "string" + } + } + }, + "SubscriptionDeletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionDeletedEvent.", + "type": "object", + "properties": { + "eventSubscriptionId": { + "description": "The Azure resource ID of the deleted event subscription.", + "type": "string", + "readOnly": true + } + } } }, "parameters": { diff --git a/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json b/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json new file mode 100644 index 000000000000..c37924801329 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json @@ -0,0 +1,115 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-01-01", + "title": "Schema of Azure Media Services events published to Azure Event Grid", + "description": "Describes the schema of the Azure Media Services events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent." + }, + "paths": {}, + "definitions": { + "MediaJobStateChangeEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobStateChange event.", + "type": "object", + "properties": { + "previousState": { + "type": "string", + "enum": [ + "Canceled", + "Canceling", + "Error", + "Finished", + "Processing", + "Queued", + "Scheduled" + ], + "x-ms-enum": { + "name": "JobState", + "values": [ + { + "value": "Canceled", + "description": "The job was canceled. This is a final state for the job." + }, + { + "value": "Canceling", + "description": "The job is in the process of being canceled. This is a transient state for the job." + }, + { + "value": "Error", + "description": "The job has encountered an error. This is a final state for the job." + }, + { + "value": "Finished", + "description": "The job is finished. This is a final state for the job." + }, + { + "value": "Processing", + "description": "The job is processing. This is a transient state for the job." + }, + { + "value": "Queued", + "description": "The job is in a queued state, waiting for resources to become available. This is a transient state." + }, + { + "value": "Scheduled", + "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." + } + ], + "modelAsExtensible": true + }, + "description": "The previous state of the Job.", + "readOnly": true, + "x-nullable": false + }, + "state": { + "type": "string", + "enum": [ + "Canceled", + "Canceling", + "Error", + "Finished", + "Processing", + "Queued", + "Scheduled" + ], + "x-ms-enum": { + "name": "JobState", + "values": [ + { + "value": "Canceled", + "description": "The job was canceled. This is a final state for the job." + }, + { + "value": "Canceling", + "description": "The job is in the process of being canceled. This is a transient state for the job." + }, + { + "value": "Error", + "description": "The job has encountered an error. This is a final state for the job." + }, + { + "value": "Finished", + "description": "The job is finished. This is a final state for the job." + }, + { + "value": "Processing", + "description": "The job is processing. This is a transient state for the job." + }, + { + "value": "Queued", + "description": "The job is in a queued state, waiting for resources to become available. This is a transient state." + }, + { + "value": "Scheduled", + "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." + } + ], + "modelAsExtensible": true + }, + "description": "The new state of the Job.", + "readOnly": true, + "x-nullable": false + } + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/ServiceBus.json b/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/ServiceBus.json new file mode 100644 index 000000000000..ec8fa0def77c --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/ServiceBus.json @@ -0,0 +1,71 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-01-01", + "title": "Schema of Azure ServiceBus Messaging events published to Azure Event Grid", + "description": "Describes the schema of the Azure ServiceBus Messaging events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent." + }, + "paths": {}, + "definitions": { + "ServiceBusActiveMessagesAvailableWithNoListenersEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event.", + "type": "object", + "properties": { + "namespaceName": { + "description": "The namespace name of the Microsoft.ServiceBus resource.", + "type": "string" + }, + "requestUri": { + "description": "The endpoint of the Microsoft.ServiceBus resource.", + "type": "string" + }, + "entityType": { + "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'.", + "type": "string" + }, + "queueName": { + "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null.", + "type": "string" + }, + "topicName": { + "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null.", + "type": "string" + }, + "subscriptionName": { + "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null.", + "type": "string" + } + } + }, + "ServiceBusDeadletterMessagesAvailableWithNoListenersEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListenersEvent event.", + "type": "object", + "properties": { + "namespaceName": { + "description": "The namespace name of the Microsoft.ServiceBus resource.", + "type": "string" + }, + "requestUri": { + "description": "The endpoint of the Microsoft.ServiceBus resource.", + "type": "string" + }, + "entityType": { + "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'.", + "type": "string" + }, + "queueName": { + "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null.", + "type": "string" + }, + "topicName": { + "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null.", + "type": "string" + }, + "subscriptionName": { + "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null.", + "type": "string" + } + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/data-plane/readme.md b/specification/eventgrid/data-plane/readme.md index c30a168cd4d0..f506f4e8d7ae 100644 --- a/specification/eventgrid/data-plane/readme.md +++ b/specification/eventgrid/data-plane/readme.md @@ -50,6 +50,8 @@ input-file: - Microsoft.EventGrid/stable/2018-01-01/EventGrid.json - Microsoft.Devices/stable/2018-01-01/IotHub.json - Microsoft.ContainerRegistry/stable/2018-01-01/ContainerRegistry.json +- Microsoft.ServiceBus/stable/2018-01-01/ServiceBus.json +- Microsoft.Media/stable/2018-01-01/MediaServices.json ``` --- @@ -66,6 +68,9 @@ swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_event_grid'] ``` ## C# @@ -98,7 +103,7 @@ python: add-credentials: true namespace: azure.eventgrid package-name: azure-eventgrid - package-version: 0.1.0 + package-version: 1.0.0 clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' @@ -146,12 +151,28 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +namespace: com.microsoft.azure.eventgrid +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-eventgrid +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-01 +``` + +### Tag: package-2018-01 and java + +These settings apply only when `--tag=package-2018-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-01' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.eventgrid - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-eventgrid + namespace: com.microsoft.azure.eventgrid.v2018_01_01 + output-folder: $(azure-libraries-for-java-folder)/eventgrid/data-plane/v2018_01_01 ``` diff --git a/specification/eventgrid/data-plane/readme.ruby.md b/specification/eventgrid/data-plane/readme.ruby.md new file mode 100644 index 000000000000..dcffc8dfe04f --- /dev/null +++ b/specification/eventgrid/data-plane/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_event_grid +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-01 +``` + +### Tag: package-2018-01 and ruby + +These settings apply only when `--tag=package-2018-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-01' && $(ruby) +namespace: "Azure::EventGrid::V2018_01_01" +output-folder: $(ruby-sdks-folder)/data/azure_event_grid/lib +``` diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2018-05-01-preview/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2018-05-01-preview/EventGrid.json index b75d38608586..6b8170656987 100644 --- a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2018-05-01-preview/EventGrid.json +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2018-05-01-preview/EventGrid.json @@ -1532,7 +1532,8 @@ "x-ms-enum": { "name": "EventDeliverySchema", "modelAsString": true - } + }, + "default": "InputEventSchema" }, "retryPolicy": { "$ref": "#/definitions/RetryPolicy", @@ -1672,8 +1673,11 @@ "x-ms-discriminator-value": "WebHook" }, "DeadLetterDestination": { - "description": "Information about the dead letter destination for an event subscription", + "description": "Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.", "type": "object", + "required": [ + "endpointType" + ], "properties": { "endpointType": { "description": "Type of the endpoint for the dead letter destination", @@ -1963,6 +1967,20 @@ "type": "string", "readOnly": true }, + "inputSchema": { + "description": "This determines the format that Event Grid should expect for incoming events published to the topic.", + "enum": [ + "EventGridSchema", + "CustomEventSchema", + "CloudEventV01Schema" + ], + "type": "string", + "x-ms-enum": { + "name": "InputSchema", + "modelAsString": true + }, + "default": "EventGridSchema" + }, "inputSchemaMapping": { "$ref": "#/definitions/InputSchemaMapping", "description": "This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema." diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json index 67cc383daf85..f4f658fc7970 100644 --- a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json @@ -2052,4 +2052,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/eventgrid/resource-manager/readme.md b/specification/eventgrid/resource-manager/readme.md index 47037cc6c2fd..3b640b030cfb 100644 --- a/specification/eventgrid/resource-manager/readme.md +++ b/specification/eventgrid/resource-manager/readme.md @@ -26,7 +26,17 @@ These are the global settings for the Azure EventGrid API. ``` yaml openapi-type: arm -tag: package-2018-01 +tag: package-2018-05-preview +``` + + +### Tag: package-2018-05-preview + +These settings apply only when `--tag=package-2018-05-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-05-preview' +input-file: +- Microsoft.EventGrid/preview/2018-05-01-preview/EventGrid.json ``` @@ -72,9 +82,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_event_grid'] ``` @@ -107,6 +120,7 @@ python: payload-flattening-threshold: 2 namespace: azure.mgmt.eventgrid package-name: azure-mgmt-eventgrid + package-version: 1.0.0 clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' @@ -135,11 +149,21 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-05-preview - tag: package-2018-01 - tag: package-2017-09-preview - tag: package-2017-06-preview ``` +### Tag: package-2018-05-preview and go + +These settings apply only when `--tag=package-2018-05-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-05-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/eventgrid/mgmt/2018-05-01-preview/eventgrid +``` + ### Tag: package-2018-01 and go These settings apply only when `--tag=package-2018-01 --go` is specified on the command line. @@ -155,7 +179,7 @@ These settings apply only when `--tag=package-2017-09-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-09-preview' && $(go) -output-folder: $(go-sdk-folder)/services/eventgrid/mgmt/2017-09-15-preview/eventgrid +output-folder: $(go-sdk-folder)/services/preview/eventgrid/mgmt/2017-09-15-preview/eventgrid ``` ### Tag: package-2017-06-preview and go @@ -164,7 +188,7 @@ These settings apply only when `--tag=package-2017-06-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-06-preview' && $(go) -output-folder: $(go-sdk-folder)/services/eventgrid/mgmt/2017-06-15-preview/eventgrid +output-folder: $(go-sdk-folder)/services/preview/eventgrid/mgmt/2017-06-15-preview/eventgrid ``` @@ -174,11 +198,44 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.eventgrid +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-eventgrid +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-05-preview + - tag: package-2018-01 +``` + +### Tag: package-2018-05-preview and java + +These settings apply only when `--tag=package-2018-05-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-05-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.eventgrid - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-eventgrid + namespace: com.microsoft.azure.management.eventgrid.v2018_05_01_preview + output-folder: $(azure-libraries-for-java-folder)/eventgrid/resource-manager/v2018_05_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-01 and java + +These settings apply only when `--tag=package-2018-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.eventgrid.v2018_01_01 + output-folder: $(azure-libraries-for-java-folder)/eventgrid/resource-manager/v2018_01_01 +regenerate-manager: true +generate-interface: true ``` diff --git a/specification/eventgrid/resource-manager/readme.ruby.md b/specification/eventgrid/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..e71ecf40468d --- /dev/null +++ b/specification/eventgrid/resource-manager/readme.ruby.md @@ -0,0 +1,59 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_event_grid +package-version: "0.16.1" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-05-preview + - tag: package-2018-01 + - tag: package-2017-09-preview + - tag: package-2017-06-preview +``` + +### Tag: package-2018-05-preview and ruby + +These settings apply only when `--tag=package-2018-05-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-05-preview' && $(ruby) +namespace: "Azure::EventGrid::Mgmt::V2018_05_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_event_grid/lib +``` + +### Tag: package-2018-01 and ruby + +These settings apply only when `--tag=package-2018-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-01' && $(ruby) +namespace: "Azure::EventGrid::Mgmt::V2018_01_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_event_grid/lib +``` + +### Tag: package-2017-09-preview and ruby + +These settings apply only when `--tag=package-2017-09-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-09-preview' && $(ruby) +namespace: "Azure::EventGrid::Mgmt::V2017_09_15_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_event_grid/lib +``` + +### Tag: package-2017-06-preview and ruby + +These settings apply only when `--tag=package-2017-06-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-06-preview' && $(ruby) +namespace: "Azure::EventGrid::Mgmt::V2017_06_15_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_event_grid/lib +``` diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json new file mode 100644 index 000000000000..120e0ca73919 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json @@ -0,0 +1,1411 @@ +{ + "swagger": "2.0", + "info": { + "title": "EventHub2018PreviewManagementClient", + "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", + "version": "2018-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.EventHub/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "EHOperations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "description": "Lists all of the available Event Hub REST API operations.", + "parameters": [{ + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters": { + "get": { + "tags": [ + "Event Hubs Clusters" + ], + "operationId": "Clusters_ListByResourceGroup", + "x-ms-examples": { + "ClustersListByResourceGroup": { + "$ref": "./examples/Clusters/ClustersListByResourceGroup.json" + } + }, + "description": "Lists the available Event Hubs Clusters within an ARM resource group.", + "parameters": [{ + "$ref": "#/parameters/SubscriptionIdParameter" + }, { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Clusters returned successfully.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Event Hub Cluster error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}": { + "get": { + "tags": [ + "Event Hubs Cluster" + ], + "operationId": "Clusters_Get", + "x-ms-examples": { + "ClusterGet": { + "$ref": "./examples/Clusters/ClusterGet.json" + } + }, + "description": "Gets the resource description of the specified Event Hubs Cluster.", + "parameters": [{ + "$ref": "#/parameters/SubscriptionIdParameter" + }, { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/ClusterNameParameter" + }, { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Event Hubs Cluster resource description returned successfully.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Event Hubs Cluster error response describing why the cluster description get operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Event Hubs Cluster" + ], + "operationId": "Clusters_Patch", + "x-ms-examples": { + "ClusterPatch": { + "$ref": "./examples/Clusters/ClusterPatch.json" + } + }, + "description": "Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.", + "parameters": [{ + "$ref": "#/parameters/SubscriptionIdParameter" + }, { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/ClusterNameParameter" + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + }, + "description": "The properties of the Event Hubs Cluster which should be updated." + } + ], + "responses": { + "200": { + "description": "Event Hubs Cluster successfully created.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "Event Hubs Cluster update request accepted.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Event Hubs Cluster update request accepted." + }, + "default": { + "description": "Event Hubs error response detailing why the Event Hubs Cluster update operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default": { + "patch": { + "tags": [ + "Event Hubs Cluster Configuration" + ], + "operationId": "Configuration_Patch", + "parameters": [{ + "$ref": "#/parameters/SubscriptionIdParameter" + }, { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/ClusterNameParameter" + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterQuotaConfigurationProperties", + "required": [ + "settings" + ] + }, + "description": "Parameters for creating an Event Hubs Cluster resource." + } + ], + "x-ms-examples": { + "ClustersQuotasConfigurationPatch": { + "$ref": "./examples/Clusters/ClusterQuotaConfigurationPatch.json" + } + }, + "description": "Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.", + "responses": { + "200": { + "description": "Event Hubs Cluster settings configuration returned.", + "schema": { + "$ref": "#/definitions/ClusterQuotaConfigurationProperties" + } + }, + "201": { + "description": "Event Hubs Cluster setting configuration request successfully accepted.", + "schema": { + "$ref": "#/definitions/ClusterQuotaConfigurationProperties" + } + }, + "202": { + "description": "Event Hubs Cluster update request accepted." + }, + "default": { + "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Event Hubs Cluster Configuration" + ], + "operationId": "Configuration_Get", + "parameters": [{ + "$ref": "#/parameters/SubscriptionIdParameter" + }, { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/ClusterNameParameter" + }, { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "ClustersQuotasConfigurationGet": { + "$ref": "./examples/Clusters/ClusterQuotaConfigurationGet.json" + } + }, + "description": "Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.", + "responses": { + "200": { + "description": "Event Hubs Cluster settings configuration returned.", + "schema": { + "$ref": "#/definitions/ClusterQuotaConfigurationProperties" + } + }, + "default": { + "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_List", + "x-ms-examples": { + "NamespacesListBySubscription": { + "$ref": "./examples/NameSpaces/EHNameSpaceList.json" + } + }, + "description": "Lists all the available Namespaces within a subscription, irrespective of the resource groups.", + "parameters": [{ + "$ref": "#/parameters/ApiVersionParameter" + }, { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespaceListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListByResourceGroup", + "x-ms-examples": { + "NamespaceListByResourceGroup": { + "$ref": "./examples/NameSpaces/EHNameSpaceListByResourceGroup.json" + } + }, + "description": "Lists the available Namespaces within a resource group.", + "parameters": [{ + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespaceListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdate", + "x-ms-examples": { + "NamespaceCreate": { + "$ref": "./examples/NameSpaces/EHNameSpaceCreate.json" + } + }, + "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "parameters": [{ + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/NamespaceNameParameter" + }, { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EHNamespace", + "required": [ + "location" + ] + }, + "description": "Parameters for creating a namespace resource." + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Namespace create request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "200": { + "description": "Namespace successfuly created.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Delete", + "x-ms-examples": { + "NameSpaceDelete": { + "$ref": "./examples/NameSpaces/EHNameSpaceDelete.json" + } + }, + "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", + "parameters": [{ + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/NamespaceNameParameter" + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No content." + }, + "200": { + "description": "Namespace successfuly deleted." + }, + "202": { + "description": "Namespace delete request accepted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Get", + "x-ms-examples": { + "NameSpaceGet": { + "$ref": "./examples/NameSpaces/EHNameSpaceGet.json" + } + }, + "description": "Gets the description of the specified namespace.", + "parameters": [{ + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/NamespaceNameParameter" + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Update", + "x-ms-examples": { + "NamespacesUpdate": { + "$ref": "./examples/NameSpaces/EHNameSpaceUpdate.json" + } + }, + "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "parameters": [{ + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/NamespaceNameParameter" + }, { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EHNamespace" + }, + "description": "Parameters for updating a namespace resource." + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "200": { + "description": "Namespace successfuly updated.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/ipfilterrules": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListIPFilterRules", + "x-ms-examples": { + "ListIpFilterRules": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json" + } + }, + "description": "Gets a list of IP Filter rules for a Namespace.", + "parameters": [{ + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/NamespaceNameParameter" + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule successfully returned.", + "schema": { + "$ref": "#/definitions/IpFilterRuleListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdateIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleCreate": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json" + } + }, + "description": "Creates or updates an IpFilterRule for a Namespace.", + "parameters": [{ + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/NamespaceNameParameter" + }, { + "$ref": "#/parameters/IPFilterRuleNameParameter" + }, { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IpFilterRule" + }, + "description": "The Namespace IpFilterRule." + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule created", + "schema": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_DeleteIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleDelete": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json" + } + }, + "description": "Deletes an IpFilterRule for a Namespace.", + "parameters": [{ + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/NamespaceNameParameter" + }, { + "$ref": "#/parameters/IPFilterRuleNameParameter" + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No content." + }, + "200": { + "description": "Namespace IpFilterRule successfully deleted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_GetIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleGet": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json" + } + }, + "description": "Gets an IpFilterRule for a Namespace by rule name.", + "parameters": [{ + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/NamespaceNameParameter" + }, { + "$ref": "#/parameters/IPFilterRuleNameParameter" + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule returned successfully.", + "schema": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/virtualnetworkrules": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListVirtualNetworkRules", + "x-ms-examples": { + "ListIpFilterRules": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json" + } + }, + "description": "Gets a list of VirtualNetwork rules for a Namespace.", + "parameters": [{ + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/NamespaceNameParameter" + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule successfully returned.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRuleListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdateVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json" + } + }, + "description": "Creates or updates an VirtualNetworkRule for a Namespace.", + "parameters": [{ + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/NamespaceNameParameter" + }, { + "$ref": "#/parameters/VirtualNetworkRuleNameParameter" + }, { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "The Namespace VirtualNetworkRule." + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule created", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_DeleteVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleDelete": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json" + } + }, + "description": "Deletes an VirtualNetworkRule for a Namespace.", + "parameters": [{ + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/NamespaceNameParameter" + }, { + "$ref": "#/parameters/VirtualNetworkRuleNameParameter" + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No content." + }, + "200": { + "description": "Namespace VirtualNetworkRule successfully deleted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_GetVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleGet": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json" + } + }, + "description": "Gets an VirtualNetworkRule for a Namespace by rule name.", + "parameters": [{ + "$ref": "#/parameters/ResourceGroupNameParameter" + }, { + "$ref": "#/parameters/NamespaceNameParameter" + }, { + "$ref": "#/parameters/VirtualNetworkRuleNameParameter" + }, { + "$ref": "#/parameters/ApiVersionParameter" + }, { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule returned successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Event Hub operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of Event Hub operations supported by the Microsoft.EventHub resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "A Event Hub REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.EventHub" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource on which the operation is performed: Invoice, etc." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Operation type: Read, write, delete, etc." + } + } + } + } + }, + "Cluster": { + "properties": { + "sku": { + "$ref": "#/definitions/ClusterSku", + "description": "Properties of the cluster SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "properties": { + "created": { + "readOnly": true, + "type": "string", + "description": "The UTC time when the Event Hubs Cluster was created." + }, + "updated": { + "readOnly": true, + "type": "string", + "description": "The UTC time when the Event Hubs Cluster was last updated." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "The metric ID of the cluster resource. Provided by the service and not modifiable by the user." + } + }, + "description": "Event Hubs Cluster properties supplied in responses in List or Get operations." + } + }, + "allOf": [{ + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "Single Event Hubs Cluster resource in List or Get operations." + }, + "ClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + }, + "description": "The Event Hubs Clusters present in the List Event Hubs operation results." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters." + } + }, + "description": "The response of the List Event Hubs Clusters operation." + }, + "ClusterQuotaConfigurationProperties": { + "properties": { + "settings": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster." + } + }, + "description": "Contains all settings for the cluster." + }, + "ErrorResponse": { + "description": "Error response that indicates the service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "TrackedResource": { + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags" + } + }, + "allOf": [{ + "$ref": "#/definitions/Resource" + } + ], + "description": "Definition of an Azure resource." + }, + "Resource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + } + }, + "description": "The Resource definition", + "x-ms-azure-resource": true + }, + "ClusterSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this SKU.", + "enum": [ + "Dedicated" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "capacity": { + "format": "int32", + "maximum": 32, + "minimum": 1, + "type": "integer", + "description": "The quantity of Event Hubs Cluster Capacity Units contained in this cluster." + } + }, + "required": [ + "name" + ], + "description": "SKU parameters particular to a cluster instance." + }, + "EHNamespaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EHNamespace" + }, + "description": "Result of the List Namespace operation" + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of namespaces." + } + }, + "description": "The response of the List Namespace operation" + }, + "EHNamespace": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Properties of sku resource" + }, + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the Namespace." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the Namespace was created." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the Namespace was updated." + }, + "serviceBusEndpoint": { + "readOnly": true, + "type": "string", + "description": "Endpoint you can use to perform Service Bus operations." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "Identifier for Azure Insights metrics." + }, + "isAutoInflateEnabled": { + "type": "boolean", + "description": "Value that indicates whether AutoInflate is enabled for eventhub namespace." + }, + "maximumThroughputUnits": { + "format": "int32", + "type": "integer", + "maximum": 20, + "minimum": 0, + "description": "Upper limit of throughput units when AutoInflate is enabled, vaule should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" + }, + "kafkaEnabled": { + "type": "boolean", + "description": "Value that indicates whether Kafka is enabled for eventhub namespace." + }, + "zoneRedundant": { + "type": "boolean", + "description": "Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones." + } + }, + "description": "Namespace properties supplied for create namespace operation." + } + }, + "allOf": [{ + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "Single Namespace item in List or Get Operation" + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "The billing tier of this particular SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + }, + "capacity": { + "format": "int32", + "maximum": 20, + "minimum": 0, + "type": "integer", + "description": "The Event Hubs throughput units, vaule should be 0 to 20 throughput units." + } + }, + "required": [ + "name" + ], + "description": "SKU parameters supplied to the create namespace operation" + }, + "IpFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Accept", + "Reject" + ], + "x-ms-enum": { + "name": "IPAction", + "modelAsString": true + } + }, + "filterName": { + "type": "string", + "description": "IP Filter name" + } + }, + "description": "Properties supplied to create or update IpFilterRules" + } + }, + "allOf": [{ + "$ref": "#/definitions/Resource" + } + ], + "description": "Single item in a List or Get IpFilterRules operation" + }, + "IpFilterRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IpFilterRule" + }, + "description": "Result of the List IpFilter Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains an incomplete list of IpFilter Rules" + } + }, + "description": "The response from the List namespace operation." + }, + "VirtualNetworkRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "virtualNetworkSubnetId": { + "type": "string", + "description": "ARM ID of Virtual Network Subnet" + } + }, + "description": "Properties supplied to create or update VirtualNetworkRules" + } + }, + "allOf": [{ + "$ref": "#/definitions/Resource" + } + ], + "description": "Single item in a List or Get VirtualNetworkRules operation" + }, + "VirtualNetworkRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IpFilterRule" + }, + "description": "Result of the List VirtualNetwork Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains an incomplete list of VirtualNetwork Rules" + } + }, + "description": "The response from the List namespace operation." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials that uniquely identify a 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." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the resource group within the Azure subscription." + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "minLength": 6, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The name of the Event Hubs Cluster." + }, + "NamespaceNameParameter": { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 6, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The Namespace name" + }, + "AuthorizationRuleNameParameter": { + "name": "authorizationRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The authorization rule name." + }, + "IPFilterRuleNameParameter": { + "name": "ipFilterRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The IP Filter Rule name." + }, + "VirtualNetworkRuleNameParameter": { + "name": "virtualNetworkRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The Virtual Network Rule name." + }, + "SkuNameParameter": { + "name": "sku", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The sku type." + }, + "SkipParameter": { + "name": "$skip", + "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "maximum": 1000, + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000, + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHubCluster.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHubCluster.json deleted file mode 100644 index afc018b1935f..000000000000 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHubCluster.json +++ /dev/null @@ -1,560 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "EventHubClusterManagementClient", - "description": "Azure Event Hubs Cluster client for managing Event Hubs Cluster resources.", - "version": "2018-01-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.EventHub/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "x-ms-examples": { - "EHOperations_List": { "$ref": "./examples/Operations_List.json" } - }, - "description": "Lists all of the available Event Hub REST API operations.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters": { - "get": { - "tags": [ - "Event Hubs Clusters" - ], - "operationId": "Clusters_ListByResourceGroup", - "x-ms-examples": { - "ClustersListByResourceGroup": { - "$ref": "./examples/Clusters/ClustersListByResourceGroup.json" - } - }, - "description": "Lists the available Event Hubs Clusters within an ARM resource group.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Clusters returned successfully.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Event Hub Cluster error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}": { - "get": { - "tags": [ - "Event Hubs Cluster" - ], - "operationId": "Clusters_Get", - "x-ms-examples": { - "ClusterGet": { - "$ref": "./examples/Clusters/ClusterGet.json" - } - }, - "description": "Gets the resource description of the specified Event Hubs Cluster.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Event Hubs Cluster resource description returned successfully.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Event Hubs Cluster error response describing why the cluster description get operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Event Hubs Cluster" - ], - "operationId": "Clusters_Patch", - "x-ms-examples": { - "ClusterPatch": { - "$ref": "./examples/Clusters/ClusterPatch.json" - } - }, - "description": "Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Cluster" - }, - "description": "The properties of the Event Hubs Cluster which should be updated." - } - ], - "responses": { - "200": { - "description": "Event Hubs Cluster successfully created.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "201": { - "description": "Event Hubs Cluster update request accepted.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Event Hubs Cluster update request accepted." - }, - "default": { - "description": "Event Hubs error response detailing why the Event Hubs Cluster update operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default": { - "patch": { - "tags": [ - "Event Hubs Cluster Configuration" - ], - "operationId": "Configuration_Patch", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties", - "required": [ - "settings" - ] - }, - "description": "Parameters for creating an Event Hubs Cluster resource." - } - ], - "x-ms-examples": { - "ClustersQuotasConfigurationPatch": { - "$ref": "./examples/Clusters/ClusterQuotaConfigurationPatch.json" - } - }, - "description": "Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.", - "responses": { - "200": { - "description": "Event Hubs Cluster settings configuration returned.", - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties" - } - }, - "201": { - "description": "Event Hubs Cluster setting configuration request successfully accepted.", - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties" - } - }, - "202": { - "description": "Event Hubs Cluster update request accepted." - }, - "default": { - "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Event Hubs Cluster Configuration" - ], - "operationId": "Configuration_Get", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "x-ms-examples": { - "ClustersQuotasConfigurationGet": { - "$ref": "./examples/Clusters/ClusterQuotaConfigurationGet.json" - } - }, - "description": "Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.", - "responses": { - "200": { - "description": "Event Hubs Cluster settings configuration returned.", - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties" - } - }, - "default": { - "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "Cluster": { - "properties": { - "sku": { - "$ref": "#/definitions/ClusterSku", - "description": "Properties of the cluster SKU." - }, - "properties": { - "x-ms-client-flatten": true, - "properties": { - "created": { - "readOnly": true, - "type": "string", - "description": "The UTC time when the Event Hubs Cluster was created." - }, - "updated": { - "readOnly": true, - "type": "string", - "description": "The UTC time when the Event Hubs Cluster was last updated." - }, - "metricId": { - "readOnly": true, - "type": "string", - "description": "The metric ID of the cluster resource. Provided by the service and not modifiable by the user." - } - }, - "description": "Event Hubs Cluster properties supplied in responses in List or Get operations." - } - }, - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "description": "Single Event Hubs Cluster resource in List or Get operations." - }, - "ClusterListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Cluster" - }, - "description": "The Event Hubs Clusters present in the List Event Hubs operation results." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters." - } - }, - "description": "The response of the List Event Hubs Clusters operation." - }, - "ClusterQuotaConfigurationProperties": { - "properties": { - "settings": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster." - } - }, - "description": "Contains all settings for the cluster." - }, - "ErrorResponse": { - "description": "Error response that indicates the service is not able to process the incoming request. The reason is provided in the error message.", - "type": "object", - "properties": { - "code": { - "description": "Error code.", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, - "OperationListResult": { - "description": "Result of the request to list Event Hub operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "description": "List of Event Hub operations supported by the Microsoft.EventHub resource provider.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "URL to get the next set of operation list results if there are any." - } - } - }, - "Operation": { - "description": "A Event Hub REST API operation", - "type": "object", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Operation name: {provider}/{resource}/{operation}" - }, - "display": { - "description": "The object that represents the operation.", - "properties": { - "provider": { - "readOnly": true, - "type": "string", - "description": "Service provider: Microsoft.EventHub" - }, - "resource": { - "readOnly": true, - "type": "string", - "description": "Resource on which the operation is performed: Invoice, etc." - }, - "operation": { - "readOnly": true, - "type": "string", - "description": "Operation type: Read, write, delete, etc." - } - } - } - } - }, - "TrackedResource": { - "properties": { - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Definition of an Azure resource." - }, - "Resource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - } - }, - "description": "The Resource definition", - "x-ms-azure-resource": true - }, - "ClusterSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of this SKU.", - "enum": [ - "Dedicated" - ], - "x-ms-enum": { - "name": "SkuName", - "modelAsString": true - } - }, - "capacity": { - "format": "int32", - "maximum": 32, - "minimum": 1, - "type": "integer", - "description": "The quantity of Event Hubs Cluster Capacity Units contained in this cluster." - } - }, - "required": [ - "name" - ], - "description": "SKU parameters particular to a cluster instance." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Subscription credentials that uniquely identify a 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." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method", - "description": "Name of the resource group within the Azure subscription." - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "minLength": 6, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The name of the Event Hubs Cluster." - } - } -} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceCreate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceCreate.json new file mode 100644 index 000000000000..3c2e7ebd7e50 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceCreate.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5849", + "resourceGroupName": "ArunMonocle", + "api-version": "2017-04-01", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5849", + "name": "sdk-Namespace-5849", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-5849", + "createdAt": "2017-05-24T23:23:27.877Z", + "updatedAt": "2017-05-24T23:23:27.877Z", + "serviceBusEndpoint": "https://sdk-Namespace-5849.servicebus.windows-int.net:443/" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5849", + "name": "sdk-Namespace-5849", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-5849", + "createdAt": "2017-05-24T23:23:27.877Z", + "updatedAt": "2017-05-24T23:23:27.877Z", + "serviceBusEndpoint": "https://sdk-Namespace-5849.servicebus.windows-int.net:443/" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceDelete.json new file mode 100644 index 000000000000..b8b3ad3635e0 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5849", + "resourceGroupName": "SouthCentralUS", + "api-version": "2017-04-01", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceGet.json new file mode 100644 index 000000000000..fc61c3002d2f --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceGet.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5849", + "resourceGroupName": "ArunMonocle", + "api-version": "2017-04-01", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5849", + "name": "sdk-Namespace-5849", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-5849", + "createdAt": "2017-05-24T23:23:27.877Z", + "updatedAt": "2017-05-24T23:23:27.877Z", + "serviceBusEndpoint": "https://sdk-Namespace-5849.servicebus.windows-int.net:443/" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5849", + "name": "sdk-Namespace-5849", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Created", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-5849", + "createdAt": "2017-05-24T23:23:27.877Z", + "updatedAt": "2017-05-24T23:23:27.877Z", + "serviceBusEndpoint": "https://sdk-Namespace-5849.servicebus.windows-int.net:443/" + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceGetMessagningPlan.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceGetMessagningPlan.json new file mode 100644 index 000000000000..26779a9b18a2 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceGetMessagningPlan.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5849", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "subscriptionId": "subscriptionid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionid/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5849/messagingplan", + "name": "2", + "type": "Microsoft.EventHub/MessagingSKUPlan", + "location": null, + "tags": null, + "properties": { + "sku": 2, + "selectedEventHubUnit": 1, + "updatedAt": "2018-04-10T17:55:54.4048325Z", + "revision": 1 + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceList.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceList.json new file mode 100644 index 000000000000..5c8d199e1ac0 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceList.json @@ -0,0 +1,1361 @@ +{ + "parameters": { + "api-version": "2017-04-01", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/sadfsadfsadf/providers/Microsoft.EventHub/namespaces/eh-ns1", + "name": "eh-ns1", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:eh-ns1", + "createdAt": "2016-08-23T04:15:35.263Z", + "updatedAt": "2017-02-03T20:13:04.007Z", + "serviceBusEndpoint": "https://eh-ns1.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 9 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-EventHub-SouthCentralUS/providers/Microsoft.EventHub/namespaces/ehnamespace1", + "name": "ehnamespace1", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 20, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ehnamespace1", + "createdAt": "2016-08-05T16:56:48.657Z", + "updatedAt": "2017-05-03T23:49:12.69Z", + "serviceBusEndpoint": "https://ehnamespace1.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/NS-08dc2b6d-82f6-43e8-bdcd-56bbb31a1a95", + "name": "NS-08dc2b6d-82f6-43e8-bdcd-56bbb31a1a95", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-08dc2b6d-82f6-43e8-bdcd-56bbb31a1a95", + "createdAt": "2016-09-16T01:10:00.96Z", + "updatedAt": "2017-02-11T11:15:32.313Z", + "serviceBusEndpoint": "https://NS-08dc2b6d-82f6-43e8-bdcd-56bbb31a1a95.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/NS-027302b7-df82-43a1-abf7-b6a2e2429115", + "name": "NS-027302b7-df82-43a1-abf7-b6a2e2429115", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-027302b7-df82-43a1-abf7-b6a2e2429115", + "createdAt": "2016-08-05T04:13:34.727Z", + "updatedAt": "2017-02-11T10:35:30.053Z", + "serviceBusEndpoint": "https://NS-027302b7-df82-43a1-abf7-b6a2e2429115.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 7 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RichardsResources/providers/Microsoft.EventHub/namespaces/abc-7-14", + "name": "abc-7-14", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 14, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:abc-7-14", + "createdAt": "2017-05-05T17:58:58.433Z", + "updatedAt": "2017-05-05T17:59:20Z", + "serviceBusEndpoint": "https://abc-7-14.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-3054", + "name": "sdk-Namespace-3054", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-3054", + "createdAt": "2017-05-24T18:43:53.58Z", + "updatedAt": "2017-05-24T18:44:16.657Z", + "serviceBusEndpoint": "https://sdk-Namespace-3054.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-EventHub-SouthCentralUS/providers/Microsoft.EventHub/namespaces/namespace1asdfsa", + "name": "namespace1asdfsa", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:namespace1asdfsa", + "createdAt": "2016-09-12T18:23:15.833Z", + "updatedAt": "2017-02-04T01:58:49.523Z", + "serviceBusEndpoint": "https://namespace1asdfsa.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 3 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RichardsResources/providers/Microsoft.EventHub/namespaces/hello1-3-8", + "name": "hello1-3-8", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 8, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:hello1-3-8", + "createdAt": "2017-05-05T19:23:18.96Z", + "updatedAt": "2017-05-05T19:23:42.497Z", + "serviceBusEndpoint": "https://hello1-3-8.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.EventHub/namespaces/SBPerplexed", + "name": "SBPerplexed", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sbperplexed", + "createdAt": "2016-10-10T19:18:57.773Z", + "updatedAt": "2017-02-03T23:46:15.22Z", + "serviceBusEndpoint": "https://SBPerplexed.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-EventHub-SouthCentralUS/providers/Microsoft.EventHub/namespaces/ehnamespace123", + "name": "ehnamespace123", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ehnamespace123", + "createdAt": "2016-08-05T16:57:09Z", + "updatedAt": "2017-02-11T08:25:30.093Z", + "serviceBusEndpoint": "https://ehnamespace123.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/oaisdjfoiasdjfoiajsdfoijasd", + "name": "oaisdjfoiasdjfoiajsdfoijasd", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:oaisdjfoiasdjfoiajsdfoijasd", + "createdAt": "2017-05-03T22:05:29.61Z", + "updatedAt": "2017-05-03T22:05:51.593Z", + "serviceBusEndpoint": "https://oaisdjfoiasdjfoiajsdfoijasd.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/rrama-ns3", + "name": "rrama-ns3", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-ns3", + "createdAt": "2016-08-23T04:22:40.633Z", + "updatedAt": "2017-02-11T12:52:58.277Z", + "serviceBusEndpoint": "https://rrama-ns3.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/abc123", + "name": "abc123", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:abc123", + "createdAt": "2017-05-04T19:06:00.813Z", + "updatedAt": "2017-05-04T19:06:23.71Z", + "serviceBusEndpoint": "https://abc123.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-EventHub-SouthCentralUS/providers/Microsoft.EventHub/namespaces/ehnamespace21", + "name": "ehnamespace21", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ehnamespace21", + "createdAt": "2016-08-05T16:57:00.377Z", + "updatedAt": "2017-02-11T09:50:32.86Z", + "serviceBusEndpoint": "https://ehnamespace21.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.EventHub/namespaces/SBFlerbederp", + "name": "SBFlerbederp", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sbflerbederp", + "createdAt": "2016-10-10T19:32:17.56Z", + "updatedAt": "2017-02-03T20:46:59.227Z", + "serviceBusEndpoint": "https://SBFlerbederp.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 9 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RichardsResources/providers/Microsoft.EventHub/namespaces/aaa-001-9-11", + "name": "aaa-001-9-11", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 11, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:aaa-001-9-11", + "createdAt": "2017-05-05T17:32:22.37Z", + "updatedAt": "2017-05-05T17:32:44.76Z", + "serviceBusEndpoint": "https://aaa-001-9-11.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/NS-47a32389-7331-47c8-9228-4c145b2650d7", + "name": "NS-47a32389-7331-47c8-9228-4c145b2650d7", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-47a32389-7331-47c8-9228-4c145b2650d7", + "createdAt": "2016-09-16T01:41:51.857Z", + "updatedAt": "2017-02-11T08:28:03.157Z", + "serviceBusEndpoint": "https://NS-47a32389-7331-47c8-9228-4c145b2650d7.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/NS-54cbc924-fb3c-4b09-bd7a-4fe6d2b785a7", + "name": "NS-54cbc924-fb3c-4b09-bd7a-4fe6d2b785a7", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-54cbc924-fb3c-4b09-bd7a-4fe6d2b785a7", + "createdAt": "2016-08-05T03:39:52.323Z", + "updatedAt": "2017-02-11T04:40:32.24Z", + "serviceBusEndpoint": "https://NS-54cbc924-fb3c-4b09-bd7a-4fe6d2b785a7.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.EventHub/namespaces/SBFeasible", + "name": "SBFeasible", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sbfeasible", + "createdAt": "2016-10-10T19:05:24.76Z", + "updatedAt": "2017-02-03T19:51:55.893Z", + "serviceBusEndpoint": "https://SBFeasible.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/NS-3b72258b-a8a1-4250-8952-e89a15af71fc", + "name": "NS-3b72258b-a8a1-4250-8952-e89a15af71fc", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-3b72258b-a8a1-4250-8952-e89a15af71fc", + "createdAt": "2016-09-16T17:59:27.227Z", + "updatedAt": "2017-02-27T19:34:26.633Z", + "serviceBusEndpoint": "https://NS-3b72258b-a8a1-4250-8952-e89a15af71fc.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5849", + "name": "sdk-Namespace-5849", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-5849", + "createdAt": "2017-05-24T23:23:27.877Z", + "updatedAt": "2017-05-24T23:23:50.467Z", + "serviceBusEndpoint": "https://sdk-Namespace-5849.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/testDC/providers/Microsoft.EventHub/namespaces/TestNamespace1", + "name": "TestNamespace1", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 10, + "provisioningState": "Updating", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:testnamespace1", + "createdAt": "2017-04-25T00:28:00.243Z", + "updatedAt": "2017-04-26T20:54:41.18Z", + "serviceBusEndpoint": "https://TestNamespace1.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-EventHub-SouthCentralUS/providers/Microsoft.EventHub/namespaces/rrama-ehns", + "name": "rrama-ehns", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-ehns", + "createdAt": "2016-08-23T04:22:49.74Z", + "updatedAt": "2017-02-11T07:03:51.793Z", + "serviceBusEndpoint": "https://rrama-ehns.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/testDC/providers/Microsoft.EventHub/namespaces/TestNamespace3", + "name": "TestNamespace3", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:testnamespace3", + "createdAt": "2017-05-03T22:33:17.84Z", + "updatedAt": "2017-05-03T22:33:40.087Z", + "serviceBusEndpoint": "https://TestNamespace3.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-4984", + "name": "sdk-Namespace-4984", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-4984", + "createdAt": "2017-05-24T21:31:03.587Z", + "updatedAt": "2017-05-24T21:31:24.967Z", + "serviceBusEndpoint": "https://sdk-Namespace-4984.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/NS-19df9616-54d6-47c9-8779-a4651835a95c", + "name": "NS-19df9616-54d6-47c9-8779-a4651835a95c", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-19df9616-54d6-47c9-8779-a4651835a95c", + "createdAt": "2016-08-23T02:38:33.8Z", + "updatedAt": "2017-02-11T04:28:01.093Z", + "serviceBusEndpoint": "https://NS-19df9616-54d6-47c9-8779-a4651835a95c.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/NS-463af3de-8c87-4347-a614-a4c24f748109", + "name": "NS-463af3de-8c87-4347-a614-a4c24f748109", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-463af3de-8c87-4347-a614-a4c24f748109", + "createdAt": "2016-08-05T00:55:04.807Z", + "updatedAt": "2017-02-11T06:13:53.343Z", + "serviceBusEndpoint": "https://NS-463af3de-8c87-4347-a614-a4c24f748109.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5606", + "name": "sdk-Namespace-5606", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-5606", + "createdAt": "2017-05-24T18:56:05.093Z", + "updatedAt": "2017-05-24T18:56:27.32Z", + "serviceBusEndpoint": "https://sdk-Namespace-5606.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/NS-2d5d93d1-1d01-4141-9f4d-7d619b9c88c3", + "name": "NS-2d5d93d1-1d01-4141-9f4d-7d619b9c88c3", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-2d5d93d1-1d01-4141-9f4d-7d619b9c88c3", + "createdAt": "2016-08-05T04:18:53.27Z", + "updatedAt": "2017-02-11T06:49:39.877Z", + "serviceBusEndpoint": "https://NS-2d5d93d1-1d01-4141-9f4d-7d619b9c88c3.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-7703", + "name": "sdk-Namespace-7703", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-7703", + "createdAt": "2017-05-24T19:05:23.817Z", + "updatedAt": "2017-05-24T19:05:44.717Z", + "serviceBusEndpoint": "https://sdk-Namespace-7703.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 3 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/zzzzzzzzzzzzzzzzzzzzzz-00001", + "name": "zzzzzzzzzzzzzzzzzzzzzz-00001", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 11, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:zzzzzzzzzzzzzzzzzzzzzz-00001", + "createdAt": "2017-05-04T21:35:49.383Z", + "updatedAt": "2017-05-05T17:01:20.733Z", + "serviceBusEndpoint": "https://zzzzzzzzzzzzzzzzzzzzzz-00001.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.EventHub/namespaces/SBQuestionable", + "name": "SBQuestionable", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sbquestionable", + "createdAt": "2016-10-10T18:56:24.723Z", + "updatedAt": "2017-02-03T19:51:46.983Z", + "serviceBusEndpoint": "https://SBQuestionable.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-EventHub-SouthCentralUS/providers/Microsoft.EventHub/namespaces/ehnamespace1234", + "name": "ehnamespace1234", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ehnamespace1234", + "createdAt": "2016-08-05T16:57:17.863Z", + "updatedAt": "2017-02-11T10:35:33.817Z", + "serviceBusEndpoint": "https://ehnamespace1234.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-3919", + "name": "sdk-Namespace-3919", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-3919", + "createdAt": "2017-05-24T02:08:20.15Z", + "updatedAt": "2017-05-24T02:08:41.313Z", + "serviceBusEndpoint": "https://sdk-Namespace-3919.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-EventHub-SouthCentralUS/providers/Microsoft.EventHub/namespaces/arunarchivetest", + "name": "arunarchivetest", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:arunarchivetest", + "createdAt": "2017-03-08T19:25:49.897Z", + "updatedAt": "2017-03-08T19:26:17.49Z", + "serviceBusEndpoint": "https://arunarchivetest.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/aiosdjfaoidjasdoijasdfoijasdfofijsdf", + "name": "aiosdjfaoidjasdoijasdfoijasdfofijsdf", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:aiosdjfaoidjasdoijasdfoijasdfofijsdf", + "createdAt": "2017-05-04T21:23:23.9Z", + "updatedAt": "2017-05-04T21:23:46.78Z", + "serviceBusEndpoint": "https://aiosdjfaoidjasdoijasdfoijasdfofijsdf.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-3413", + "name": "sdk-Namespace-3413", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-3413", + "createdAt": "2017-05-24T19:02:15.45Z", + "updatedAt": "2017-05-24T19:02:38.047Z", + "serviceBusEndpoint": "https://sdk-Namespace-3413.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.EventHub/namespaces/SBConfuzzled", + "name": "SBConfuzzled", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sbconfuzzled", + "createdAt": "2016-10-10T19:30:45.71Z", + "updatedAt": "2017-02-03T22:49:17.82Z", + "serviceBusEndpoint": "https://SBConfuzzled.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-8695", + "name": "sdk-Namespace-8695", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-8695", + "createdAt": "2017-05-24T20:03:43.81Z", + "updatedAt": "2017-05-24T20:04:05.88Z", + "serviceBusEndpoint": "https://sdk-Namespace-8695.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 11 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RichardsResources/providers/Microsoft.EventHub/namespaces/aaa-11-17", + "name": "aaa-11-17", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 17, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:aaa-11-17", + "createdAt": "2017-05-08T18:47:07.64Z", + "updatedAt": "2017-05-08T18:47:29.587Z", + "serviceBusEndpoint": "https://aaa-11-17.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 4 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RichardsResources/providers/Microsoft.EventHub/namespaces/hello1-4-14", + "name": "hello1-4-14", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 14, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:hello1-4-14", + "createdAt": "2017-05-05T18:54:20.563Z", + "updatedAt": "2017-05-05T18:54:42.507Z", + "serviceBusEndpoint": "https://hello1-4-14.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-4801", + "name": "sdk-Namespace-4801", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-4801", + "createdAt": "2017-05-24T18:39:39.213Z", + "updatedAt": "2017-05-24T18:40:00.087Z", + "serviceBusEndpoint": "https://sdk-Namespace-4801.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 8 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RichardsResources/providers/Microsoft.EventHub/namespaces/RichardsEventHub1", + "name": "RichardsEventHub1", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 15, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:richardseventhub1", + "createdAt": "2017-04-27T19:15:13.05Z", + "updatedAt": "2017-05-09T19:34:41.127Z", + "serviceBusEndpoint": "https://RichardsEventHub1.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 7 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/rrama-autoinflate-test", + "name": "rrama-autoinflate-test", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 10, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-autoinflate-test", + "createdAt": "2017-05-01T16:58:11.34Z", + "updatedAt": "2017-05-08T21:52:42.663Z", + "serviceBusEndpoint": "https://rrama-autoinflate-test.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/foofoofoofoof", + "name": "foofoofoofoof", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:foofoofoofoof", + "createdAt": "2017-04-29T02:47:53.523Z", + "updatedAt": "2017-04-29T02:48:17.95Z", + "serviceBusEndpoint": "https://foofoofoofoof.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/asdf1234asdf", + "name": "asdf1234asdf", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:asdf1234asdf", + "createdAt": "2016-09-13T01:45:40.58Z", + "updatedAt": "2017-02-11T06:54:38.623Z", + "serviceBusEndpoint": "https://asdf1234asdf.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2812", + "name": "sdk-Namespace-2812", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2812", + "createdAt": "2017-05-24T18:55:44.687Z", + "updatedAt": "2017-05-24T18:56:05.587Z", + "serviceBusEndpoint": "https://sdk-Namespace-2812.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/NS-4aadc830-1029-49b8-8fbd-dd0130e7a84c", + "name": "NS-4aadc830-1029-49b8-8fbd-dd0130e7a84c", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-4aadc830-1029-49b8-8fbd-dd0130e7a84c", + "createdAt": "2016-08-05T04:02:53.43Z", + "updatedAt": "2017-02-11T05:13:02.697Z", + "serviceBusEndpoint": "https://NS-4aadc830-1029-49b8-8fbd-dd0130e7a84c.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/NS-5e79a429-aa52-42b9-8120-2fe72fc00727", + "name": "NS-5e79a429-aa52-42b9-8120-2fe72fc00727", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-5e79a429-aa52-42b9-8120-2fe72fc00727", + "createdAt": "2016-08-05T01:13:41.527Z", + "updatedAt": "2017-02-11T04:24:44.797Z", + "serviceBusEndpoint": "https://NS-5e79a429-aa52-42b9-8120-2fe72fc00727.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-EventHub-SouthCentralUS/providers/Microsoft.EventHub/namespaces/rrama-df-ns1", + "name": "rrama-df-ns1", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-df-ns1", + "createdAt": "2016-10-27T23:35:05.453Z", + "updatedAt": "2017-02-03T20:23:49.533Z", + "serviceBusEndpoint": "https://rrama-df-ns1.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 9 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RichardsResources/providers/Microsoft.EventHub/namespaces/bbbb-9-12", + "name": "bbbb-9-12", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 12, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:bbbb-9-12", + "createdAt": "2017-05-05T17:47:35.123Z", + "updatedAt": "2017-05-05T17:47:56.1Z", + "serviceBusEndpoint": "https://bbbb-9-12.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/eh-autoInflate/providers/Microsoft.EventHub/namespaces/rrama-autoinflate-template1", + "name": "rrama-autoinflate-template1", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 10, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-autoinflate-template1", + "createdAt": "2017-05-03T17:46:36.71Z", + "updatedAt": "2017-05-03T17:47:00.163Z", + "serviceBusEndpoint": "https://rrama-autoinflate-template1.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/RapscallionResources/providers/Microsoft.EventHub/namespaces/RandomPlotTwists", + "name": "RandomPlotTwists", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:randomplottwists", + "createdAt": "2017-05-18T00:37:26.13Z", + "updatedAt": "2017-05-18T00:37:49.533Z", + "serviceBusEndpoint": "https://RandomPlotTwists.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/NS-1862d295-09cc-4e54-b23d-a2bc3bab2392", + "name": "NS-1862d295-09cc-4e54-b23d-a2bc3bab2392", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-1862d295-09cc-4e54-b23d-a2bc3bab2392", + "createdAt": "2016-08-05T04:08:14.253Z", + "updatedAt": "2017-02-11T04:33:53.34Z", + "serviceBusEndpoint": "https://NS-1862d295-09cc-4e54-b23d-a2bc3bab2392.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/NS-MigrateThis", + "name": "NS-MigrateThis", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-migratethis", + "createdAt": "2016-08-06T00:23:12.3Z", + "updatedAt": "2017-02-04T00:25:08.043Z", + "serviceBusEndpoint": "https://NS-MigrateThis.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/NS-5e01d977-125c-4fd2-8a78-cc50be544d1f", + "name": "NS-5e01d977-125c-4fd2-8a78-cc50be544d1f", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-5e01d977-125c-4fd2-8a78-cc50be544d1f", + "createdAt": "2016-08-05T04:34:33.617Z", + "updatedAt": "2017-02-11T05:54:42.25Z", + "serviceBusEndpoint": "https://NS-5e01d977-125c-4fd2-8a78-cc50be544d1f.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/NS-2b17fb74-2719-4c68-9ba3-13a018485b1f", + "name": "NS-2b17fb74-2719-4c68-9ba3-13a018485b1f", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 10, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:ns-2b17fb74-2719-4c68-9ba3-13a018485b1f", + "createdAt": "2016-08-05T04:29:17.147Z", + "updatedAt": "2017-05-02T19:52:53.243Z", + "serviceBusEndpoint": "https://NS-2b17fb74-2719-4c68-9ba3-13a018485b1f.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-EventHub-SouthCentralUS/providers/Microsoft.EventHub/namespaces/rrama-int7-ehns123", + "name": "rrama-int7-ehns123", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-int7-ehns123", + "createdAt": "2016-09-13T23:35:15.473Z", + "updatedAt": "2016-09-13T23:35:38.63Z", + "serviceBusEndpoint": "https://rrama-int7-ehns123.servicebus.int7.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/rrama-autoinflate-test", + "name": "rrama-autoinflate-test", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 10, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-autoinflate-test", + "createdAt": "2017-05-01T17:48:04.55Z", + "updatedAt": "2017-05-04T21:15:36.013Z", + "serviceBusEndpoint": "https://rrama-autoinflate-test.servicebus.int7.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/rrama-autoinflate2", + "name": "rrama-autoinflate2", + "type": "Microsoft.EventHub/Namespaces", + "location": "North Europe", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 10, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-autoinflate2", + "createdAt": "2017-05-01T20:50:00.22Z", + "updatedAt": "2017-05-01T20:50:24.687Z", + "serviceBusEndpoint": "https://rrama-autoinflate2.servicebus.int7.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.EventHub/namespaces/db3-rrama-foo1", + "name": "db3-rrama-foo1", + "type": "Microsoft.EventHub/Namespaces", + "location": "North Europe", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:db3-rrama-foo1", + "createdAt": "2017-04-28T23:47:36.503Z", + "updatedAt": "2017-05-01T21:14:37.133Z", + "serviceBusEndpoint": "https://db3-rrama-foo1.servicebus.int7.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-EventHub-SouthCentralUS/providers/Microsoft.EventHub/namespaces/rrama-int7-ehns1", + "name": "rrama-int7-ehns1", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-int7-ehns1", + "createdAt": "2016-09-13T23:20:44.853Z", + "updatedAt": "2016-09-13T23:20:47.35Z", + "serviceBusEndpoint": "https://rrama-int7-ehns1.servicebus.int7.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-EventHub-SouthCentralUS/providers/Microsoft.EventHub/namespaces/rrama-int7-ns1", + "name": "rrama-int7-ns1", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-int7-ns1", + "createdAt": "2016-09-13T23:17:25.24Z", + "updatedAt": "2016-09-13T23:17:28.223Z", + "serviceBusEndpoint": "https://rrama-int7-ns1.servicebus.int7.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-EventHub-SouthCentralUS/providers/Microsoft.EventHub/namespaces/rrama-ehns2-int7", + "name": "rrama-ehns2-int7", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:rrama-ehns2-int7", + "createdAt": "2016-09-13T23:26:21.64Z", + "updatedAt": "2016-09-13T23:26:37.95Z", + "serviceBusEndpoint": "https://rrama-ehns2-int7.servicebus.int7.windows-int.net:443/" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceListByResourceGroup.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceListByResourceGroup.json new file mode 100644 index 000000000000..be277d878c9d --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceListByResourceGroup.json @@ -0,0 +1,312 @@ +{ + "parameters": { + "api-version": "2017-04-01", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "resourceGroupName": "ArunMonocle" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-3054", + "name": "sdk-Namespace-3054", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-3054", + "createdAt": "2017-05-24T18:43:53.58Z", + "updatedAt": "2017-05-24T18:44:16.657Z", + "serviceBusEndpoint": "https://sdk-Namespace-3054.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/oaisdjfoiasdjfoiajsdfoijasd", + "name": "oaisdjfoiasdjfoiajsdfoijasd", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:oaisdjfoiasdjfoiajsdfoijasd", + "createdAt": "2017-05-03T22:05:29.61Z", + "updatedAt": "2017-05-03T22:05:51.593Z", + "serviceBusEndpoint": "https://oaisdjfoiasdjfoiajsdfoijasd.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/abc123", + "name": "abc123", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:abc123", + "createdAt": "2017-05-04T19:06:00.813Z", + "updatedAt": "2017-05-04T19:06:23.71Z", + "serviceBusEndpoint": "https://abc123.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5849", + "name": "sdk-Namespace-5849", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-5849", + "createdAt": "2017-05-24T23:23:27.877Z", + "updatedAt": "2017-05-24T23:23:50.467Z", + "serviceBusEndpoint": "https://sdk-Namespace-5849.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-4984", + "name": "sdk-Namespace-4984", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-4984", + "createdAt": "2017-05-24T21:31:03.587Z", + "updatedAt": "2017-05-24T21:31:24.967Z", + "serviceBusEndpoint": "https://sdk-Namespace-4984.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5606", + "name": "sdk-Namespace-5606", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-5606", + "createdAt": "2017-05-24T18:56:05.093Z", + "updatedAt": "2017-05-24T18:56:27.32Z", + "serviceBusEndpoint": "https://sdk-Namespace-5606.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-7703", + "name": "sdk-Namespace-7703", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-7703", + "createdAt": "2017-05-24T19:05:23.817Z", + "updatedAt": "2017-05-24T19:05:44.717Z", + "serviceBusEndpoint": "https://sdk-Namespace-7703.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 3 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/zzzzzzzzzzzzzzzzzzzzzz-00001", + "name": "zzzzzzzzzzzzzzzzzzzzzz-00001", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": true, + "maximumThroughputUnits": 11, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:zzzzzzzzzzzzzzzzzzzzzz-00001", + "createdAt": "2017-05-04T21:35:49.383Z", + "updatedAt": "2017-05-05T17:01:20.733Z", + "serviceBusEndpoint": "https://zzzzzzzzzzzzzzzzzzzzzz-00001.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-3919", + "name": "sdk-Namespace-3919", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-3919", + "createdAt": "2017-05-24T02:08:20.15Z", + "updatedAt": "2017-05-24T02:08:41.313Z", + "serviceBusEndpoint": "https://sdk-Namespace-3919.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 0 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/aiosdjfaoidjasdoijasdfoijasdfofijsdf", + "name": "aiosdjfaoidjasdoijasdfoijasdfofijsdf", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:aiosdjfaoidjasdoijasdfoijasdfofijsdf", + "createdAt": "2017-05-04T21:23:23.9Z", + "updatedAt": "2017-05-04T21:23:46.78Z", + "serviceBusEndpoint": "https://aiosdjfaoidjasdoijasdfoijasdfofijsdf.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-3413", + "name": "sdk-Namespace-3413", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-3413", + "createdAt": "2017-05-24T19:02:15.45Z", + "updatedAt": "2017-05-24T19:02:38.047Z", + "serviceBusEndpoint": "https://sdk-Namespace-3413.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-8695", + "name": "sdk-Namespace-8695", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-8695", + "createdAt": "2017-05-24T20:03:43.81Z", + "updatedAt": "2017-05-24T20:04:05.88Z", + "serviceBusEndpoint": "https://sdk-Namespace-8695.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-4801", + "name": "sdk-Namespace-4801", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-4801", + "createdAt": "2017-05-24T18:39:39.213Z", + "updatedAt": "2017-05-24T18:40:00.087Z", + "serviceBusEndpoint": "https://sdk-Namespace-4801.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2812", + "name": "sdk-Namespace-2812", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Succeeded", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2812", + "createdAt": "2017-05-24T18:55:44.687Z", + "updatedAt": "2017-05-24T18:56:05.587Z", + "serviceBusEndpoint": "https://sdk-Namespace-2812.servicebus.windows-int.net:443/" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceUpdate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceUpdate.json new file mode 100644 index 000000000000..6bee975d1190 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/EHNameSpaceUpdate.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3668", + "resourceGroupName": "ArunMonocle", + "api-version": "2017-04-01", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", + "parameters":{ + "location": "South Central US", + "tags": { + "tag3": "value3", + "tag4": "value4" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-3668", + "name": "sdk-Namespace-3668", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": { + "tag3": "value3", + "tag4": "value4" + }, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Updating", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-3668", + "createdAt": "2017-06-01T21:37:04.46Z", + "updatedAt": "2017-06-01T21:37:53.413Z", + "serviceBusEndpoint": "https://sdk-Namespace-3668.servicebus.windows-int.net:443/" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 1 + }, + "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-3668", + "name": "sdk-Namespace-3668", + "type": "Microsoft.EventHub/Namespaces", + "location": "South Central US", + "tags": { + "tag3": "value3", + "tag4": "value4" + }, + "properties": { + "isAutoInflateEnabled": false, + "maximumThroughputUnits": 0, + "provisioningState": "Updating", + "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-3668", + "createdAt": "2017-06-01T21:37:04.46Z", + "updatedAt": "2017-06-01T21:37:53.413Z", + "serviceBusEndpoint": "https://sdk-Namespace-3668.servicebus.windows-int.net:443/" + } + } + }, + "202": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json new file mode 100644 index 000000000000..bcefa956851e --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5232", + "resourceGroupName": "ResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "Subscription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", + "name": "sdk-IPFilterRules-7337", + "type": "Microsoft.EventHub/Namespaces/IpFilterRules", + "properties": { + "ipMask": "13.78.143.246/32", + "action": "Accept", + "filterName": "sdk-IPFilterRules-7337" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json new file mode 100644 index 000000000000..b114af890566 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5232", + "resourceGroupName": "ResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "Subscription", + "ipFilterRuleName": "sdk-IPFilterRules-7337", + "parameters": { + "properties": { + "ipMask": "13.78.143.246/32", + "action": "Accept", + "filterName": "sdk-IPFilterRules-7337" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", + "name": "sdk-IPFilterRules-7337", + "type": "Microsoft.EventHub/Namespaces/IpFilterRules", + "properties": { + "ipMask": "13.78.143.246/32", + "action": "Accept", + "filterName": "sdk-IPFilterRules-7337" + } + } + } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json new file mode 100644 index 000000000000..91b4cda17551 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5232", + "resourceGroupName": "ResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "Subscription", + "ipFilterRuleName": "sdk-IPFilterRules-7337" + }, + "responses": { + "200": { }, + "204": { } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json new file mode 100644 index 000000000000..5ae908f796aa --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5232", + "resourceGroupName": "ResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "Subscription", + "ipFilterRuleName": "sdk-IPFilterRules-7337" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", + "name": "sdk-IPFilterRules-7337", + "type": "Microsoft.EventHub/Namespaces/IpFilterRules", + "properties": { + "ipMask": "13.78.143.246/32", + "action": "Accept", + "filterName": "sdk-IPFilterRules-7337" + } + } + } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleUpdate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleUpdate.json new file mode 100644 index 000000000000..0bfaea95486f --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleUpdate.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5849", + "resourceGroupName": "ResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "Subscription", + "ipFilterRuleName": "sdk-IPFilterRules-7337", + "parameters": { + "properties": { + "ipMask": "13.78.143.246/32", + "action": "Accept", + "filterName": "sdk-IPFilterRules-7337" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", + "name": "sdk-IPFilterRules-7337", + "type": "Microsoft.EventHub/Namespaces/IpFilterRules", + "properties": { + "ipMask": "13.78.143.246/32", + "action": "Accept", + "filterName": "sdk-IPFilterRules-7337" + } + } + } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json new file mode 100644 index 000000000000..a704f210cbad --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "Subscription", + "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191", + "parameters": { + "properties": { + "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/sbehvnettest/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", + "name": "sdk-VirtualNetworkRules-9191", + "type": "Microsoft.EventHub/Namespaces/VirtualNetworkRules", + "properties": { + "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json new file mode 100644 index 000000000000..05cecc4b578a --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "Subscription", + "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191" + }, + "responses": { + "200": { }, + "204": { } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json new file mode 100644 index 000000000000..d5c72d8e0f06 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "Subscription", + "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", + "name": "sdk-VirtualNetworkRules-9191", + "type": "Microsoft.EventHub/Namespaces/VirtualNetworkRules", + "properties": { + "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json new file mode 100644 index 000000000000..c0067a14d070 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "Subscription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", + "name": "sdk-VirtualNetworkRules-9191", + "type": "Microsoft.EventHub/Namespaces/VirtualNetworkRules", + "properties": { + "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleupdate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleupdate.json new file mode 100644 index 000000000000..666b79b83407 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleupdate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "Subscription", + "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191", + "parameters": { + "properties": { + "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/sbehvnettest/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", + "name": "sdk-VirtualNetworkRules-9191", + "type": "Microsoft.EventHub/Namespaces/VirtualNetworkRules", + "properties": { + "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" + } + } + } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json index 7bd13dc4e8b1..ff43617d3d09 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json @@ -1170,6 +1170,12 @@ }, { "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SkipParameter" + }, + { + "$ref": "#/parameters/TopParameter" } ], "responses": { @@ -1783,6 +1789,12 @@ }, { "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SkipParameter" + }, + { + "$ref": "#/parameters/TopParameter" } ], "responses": { @@ -2478,6 +2490,12 @@ "name": "RoleDisasterRecovery", "modelAsString": false } + }, + "pendingReplicationOperationsCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of entities pending to be replicated." } }, "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" @@ -2670,6 +2688,26 @@ "maxLength": 50, "x-ms-parameter-location": "method", "description": "The sku type." + }, + "SkipParameter": { + "name": "$skip", + "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "maximum": 1000, + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000, + "x-ms-parameter-location": "method" } } } \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/disasterRecoveryConfigs/EHAliasGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/disasterRecoveryConfigs/EHAliasGet.json index c7d25e9bccd2..6ab7cf000d25 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/disasterRecoveryConfigs/EHAliasGet.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/disasterRecoveryConfigs/EHAliasGet.json @@ -16,7 +16,8 @@ "provisioningState": "Accepted", "partnerNamespace": "sdk-Namespace-8859", "role": "Secondary", - "type": "MetadataReplication" + "type": "MetadataReplication", + "pendingReplicationOperationsCount": 0 } } } diff --git a/specification/eventhub/resource-manager/readme.md b/specification/eventhub/resource-manager/readme.md index e9c738f6a7c0..65f0235a7309 100644 --- a/specification/eventhub/resource-manager/readme.md +++ b/specification/eventhub/resource-manager/readme.md @@ -66,7 +66,7 @@ These settings apply only when `--tag=package-2018-01-preview` is specified on t ``` yaml $(tag) == 'package-2018-01-preview' input-file: -- Microsoft.EventHub/preview/2018-01-01-preview/EventHubCluster.json +- Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json ``` @@ -82,9 +82,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_event_hub'] ``` @@ -185,11 +188,60 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.eventhub +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-eventhub +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-01-preview + - tag: package-2015-08 + - tag: package-2017-04 +``` + +### Tag: package-2018-01-preview and java + +These settings apply only when `--tag=package-2018-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-01-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.eventhub - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-eventhub + namespace: com.microsoft.azure.management.eventhub.v2018_01_01_preview + output-folder: $(azure-libraries-for-java-folder)/eventhub/resource-manager/v2018_01_01_preview +regenerate-manager: true +generate-interface: true ``` + +### Tag: package-2015-08 and java + +These settings apply only when `--tag=package-2015-08 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-08' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.eventhub.v2015_08_01 + output-folder: $(azure-libraries-for-java-folder)/eventhub/resource-manager/v2015_08_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.eventhub.v2017_04_01 + output-folder: $(azure-libraries-for-java-folder)/eventhub/resource-manager/v2017_04_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/eventhub/resource-manager/readme.ruby.md b/specification/eventhub/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..4b4c1f8df273 --- /dev/null +++ b/specification/eventhub/resource-manager/readme.ruby.md @@ -0,0 +1,37 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_event_hub +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2017-04 + - tag: package-2015-08 +``` + +### Tag: package-2017-04 and ruby + +These settings apply only when `--tag=package-2017-04 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-04' && $(ruby) +namespace: "Azure::EventHub::Mgmt::V2017_04_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_event_hub/lib +``` + +### Tag: package-2015-08 and ruby + +These settings apply only when `--tag=package-2015-08 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-08' && $(ruby) +namespace: "Azure::EventHub::Mgmt::V2015_08_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_event_hub/lib +``` diff --git a/specification/graphrbac/data-plane/readme.md b/specification/graphrbac/data-plane/readme.md index 19116d49cb67..51b73c704bf7 100644 --- a/specification/graphrbac/data-plane/readme.md +++ b/specification/graphrbac/data-plane/readme.md @@ -51,9 +51,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_graph_rbac'] ``` diff --git a/specification/graphrbac/data-plane/readme.ruby.md b/specification/graphrbac/data-plane/readme.ruby.md new file mode 100644 index 000000000000..f912c476b68a --- /dev/null +++ b/specification/graphrbac/data-plane/readme.ruby.md @@ -0,0 +1,27 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_graph_rbac +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: 1.6 +``` + +### Tag: 1.6 and ruby + +These settings apply only when `--tag=1.6 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == '1.6' && $(ruby) +namespace: "Azure::GraphRbac::V1_6" +output-folder: $(ruby-sdks-folder)/data/azure_graph_rbac/lib +title: GraphRbacClient +``` diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_List.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_List.json index aecbf871f74f..afa0517bd59d 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_List.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_List.json @@ -50,8 +50,8 @@ "properties": { "hanaInstanceId": "00000000-0000-0000-0000-000000000000", "hardwareProfile": { - "hardwareType": "Cisco_UCS", - "hanaInstanceSize": "S72" + "hardwareType": "HPE", + "hanaInstanceSize": "S384" }, "networkProfile": { "networkInterfaces": [ @@ -70,9 +70,38 @@ "version": "12 SP1" } } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup2/providers/Microsoft.HanaOnAzure/hanaInstances/myHanaInstance3", + "name": "myHanaInstance3", + "type": "Microsoft.HanaOnAzure/hanaInstances", + "location": "westus", + "properties": { + "hanaInstanceId": "00000000-0000-0000-0000-000000000000", + "hardwareProfile": { + "hardwareType": "HPE", + "hanaInstanceSize": "S960m" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.102" + } + ], + "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup2/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.202" + }, + "osProfile": { + "computerName": "myComputerName3", + "osType": "SUSE", + "version": "12 SP1" + } + } } ] } } } -} \ No newline at end of file +} diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_ListByResourceGroup.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_ListByResourceGroup.json index 4d2454cbc8b8..3f9876758f12 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_ListByResourceGroup.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_ListByResourceGroup.json @@ -51,8 +51,8 @@ "properties": { "hanaInstanceId": "00000000-0000-0000-0000-000000000000", "hardwareProfile": { - "hardwareType": "Cisco_UCS", - "hanaInstanceSize": "S72" + "hardwareType": "HPE", + "hanaInstanceSize": "S384" }, "networkProfile": { "networkInterfaces": [ @@ -76,4 +76,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json index 047a9853698e..65e83d08c578 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json @@ -294,13 +294,14 @@ "readOnly": true, "type": "string", "enum": [ - "Cisco_UCS" + "Cisco_UCS", + "HPE" ], "x-ms-enum": { "name": "HanaHardwareTypeNamesEnum", "modelAsString": true }, - "description": "Name of the hardware type (vendor and/or thrie product name)" + "description": "Name of the hardware type (vendor and/or their product name)" }, "hanaInstanceSize": { "readOnly": true, @@ -311,7 +312,18 @@ "S72", "S144", "S192", - "S192m" + "S192m", + "S192xm", + "S384", + "S384m", + "S384xm", + "S384xxm", + "S576m", + "S576xm", + "S768", + "S768m", + "S768xm", + "S960m" ], "x-ms-enum": { "name": "HanaInstanceSizeNamesEnum", @@ -440,7 +452,7 @@ "provider": { "readOnly": true, "type": "string", - "description": "The localized friendly form of the resource provider name. This form is also expected to include the publisher/company responsible. Use Title Casing. Begin with “Microsoft” for 1st party services." + "description": "The localized friendly form of the resource provider name. This form is also expected to include the publisher/company responsible. Use Title Casing. Begin with \"Microsoft\" for 1st party services." }, "resource": { "readOnly": true, @@ -512,4 +524,4 @@ "description": "Client API version." } } -} \ No newline at end of file +} diff --git a/specification/hanaonazure/resource-manager/readme.md b/specification/hanaonazure/resource-manager/readme.md index 87124a0d34bc..713838b0cace 100644 --- a/specification/hanaonazure/resource-manager/readme.md +++ b/specification/hanaonazure/resource-manager/readme.md @@ -53,7 +53,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go ``` @@ -109,7 +109,7 @@ These settings apply only when `--tag=package-2017-11 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-11' && $(go) -output-folder: $(go-sdk-folder)/services/hanaonazure/mgmt/2017-11-03-preview/hanaonazure +output-folder: $(go-sdk-folder)/services/preview/hanaonazure/mgmt/2017-11-03-preview/hanaonazure ``` ## Java @@ -118,11 +118,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.hanaonazure +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-hanaonazure +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-11 +``` + +### Tag: package-2017-11 and java + +These settings apply only when `--tag=package-2017-11 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-11' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.hanaonazure - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-hanaonazure + namespace: com.microsoft.azure.management.hanaonazure.v2017_11_03_preview + output-folder: $(azure-libraries-for-java-folder)/hanaonazure/resource-manager/v2017_11_03_preview +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/applications.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/applications.json index 02ed9748174c..71f7a44cd8b7 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/applications.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/applications.json @@ -37,35 +37,34 @@ "tags": [ "Applications" ], - "description": "Lists all of the applications HDInsight cluster.", + "description": "Lists all of the applications for the HDInsight cluster.", "operationId": "Applications_List", "x-ms-examples": { "Get All Applications for an HDInsight cluster": { "$ref": "./examples/GetAllApplications.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK. The request has succeeded.", "schema": { @@ -93,35 +92,30 @@ "$ref": "./examples/GetApplicationInProgress.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApplicationNameParameter" }, { - "name": "applicationName", - "in": "path", - "required": true, - "type": "string", - "description": "The constant value for the application name." + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK. The request has succeeded.", "schema": { @@ -141,58 +135,47 @@ "$ref": "./examples/CreateApplication.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "applicationName", - "in": "path", - "required": true, - "type": "string", - "description": "The constant value for the application name.", - "enum": [ - "hue" - ], - "x-ms-enum": { - "name": "ApplicationName", - "modelAsString": false - } + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ApplicationGetProperties" + "$ref": "#/definitions/ApplicationProperties" }, "description": "The application create request." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK. The request has succeeded.", "schema": { "$ref": "#/definitions/Application" } } - } + }, + "x-ms-long-running-operation": true }, "delete": { "tags": [ @@ -205,44 +188,35 @@ "$ref": "./examples/DeleteApplication.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "applicationName", - "in": "path", - "required": true, - "type": "string", - "description": "The constant value for the application name.", - "enum": [ - "hue" - ], - "x-ms-enum": { - "name": "ApplicationName", - "modelAsString": false - } + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ApplicationNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted response definition." } }, "x-ms-long-running-operation": true @@ -300,7 +274,7 @@ } } }, - "ApplicationGetProperties": { + "ApplicationProperties": { "description": "The HDInsight cluster application GET response.", "type": "object", "properties": { @@ -353,7 +327,7 @@ "errors": { "type": "array", "items": { - "$ref": "./cluster.json#/definitions/errors" + "$ref": "./cluster.json#/definitions/Errors" }, "description": "The list of errors." }, @@ -394,7 +368,7 @@ } }, "properties": { - "$ref": "#/definitions/ApplicationGetProperties", + "$ref": "#/definitions/ApplicationProperties", "description": "The properties of the application." } } @@ -425,6 +399,30 @@ "type": "string", "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ApplicationNameParameter": { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The constant value for the application name.", + "x-ms-parameter-location": "method" + }, "ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/capabilities.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/capabilities.json deleted file mode 100644 index d6427a90f981..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/capabilities.json +++ /dev/null @@ -1,269 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsightManagementClient", - "description": "The HDInsight Management Client.", - "version": "2015-03-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [{ - "azure_auth": [ - "user_impersonation" - ] - }], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/capabilities": { - "get": { - "tags": [ - "Regions" - ], - "operationId": "Location_GetCapabilities", - "description": "Gets the capabilities for the specified location.", - "x-ms-examples": { - "Get the subscription capabilities for specific location": { - "$ref": "./examples/GetHDInsightCapabilities.json" - } - }, - "parameters": [{ - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location to get capabilities for." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/capabilitiesResult" - } - } - } - } - } - }, - "definitions": { - "versionSpec": { - "description": "The version properties.", - "properties": { - "friendlyName": { - "type": "string", - "description": "The friendly name" - }, - "displayName": { - "type": "string", - "description": "The display name" - }, - "isDefault": { - "type": "string", - "description": "Whether or not the version is the default version." - }, - "componentVersions": { - "type": "object", - "description": "The component version property.", - "additionalProperties": { - "type": "string" - } - } - } - }, - "versionsCapability": { - "description": "The version capability.", - "properties": { - "available": { - "description": "The list of version capabilities.", - "type": "array", - "items": { - "$ref": "#/definitions/versionSpec" - } - } - } - }, - "regionsCapability": { - "description": "The regions capability.", - "properties": { - "available": { - "description": "The list of region capabilities.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "vmSizesCapability": { - "description": "The virtual machine sizes capability.", - "properties": { - "available": { - "description": "The list of virtual machine size capabilities.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "vmSizeCompatibilityFilter": { - "description": "The virtual machine type compatibility filter.", - "properties": { - "FilterMode": { - "description": "The mode for the filter.", - "type": "string" - }, - "Regions": { - "description": "The list of regions.", - "type": "array", - "items": { - "type": "string" - } - }, - "ClusterFlavors": { - "description": "The list of cluster types available.", - "type": "array", - "items": { - "type": "string" - } - }, - "NodeTypes": { - "description": "The list of node types.", - "type": "array", - "items": { - "type": "string" - } - }, - "ClusterVersions": { - "description": "The list of cluster versions.", - "type": "array", - "items": { - "type": "string" - } - }, - "vmsizes": { - "description": "The list of virtual machine sizes.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "regionalQuotaCapability": { - "description": "The regional quota capacity.", - "properties": { - "region_name": { - "description": "The region name.", - "type": "string" - }, - "cores_used": { - "description": "The number of cores used in the region.", - "type": "integer", - "format": "int64" - }, - "cores_available": { - "description": "The number of courses available in the region.", - "type": "integer", - "format": "int64" - } - } - }, - "quotaCapability": { - "description": "The regional quota capability.", - "properties": { - "regionalQuotas": { - "description": "The list of region quota capabilities.", - "type": "array", - "items": { - "$ref": "#/definitions/regionalQuotaCapability" - } - } - } - }, - "capabilitiesResult": { - "description": "The Get Capabilities operation response.", - "properties": { - "versions": { - "description": "The version capability.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/versionsCapability" - } - }, - "regions": { - "description": "The virtual machine size compatibilty features.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/regionsCapability" - } - }, - "vmSizes": { - "description": "The virtual machine sizes.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/vmSizesCapability" - } - }, - "vmSize_filters": { - "description": "The virtual machine size compatibilty filters.", - "type": "array", - "items": { - "$ref": "#/definitions/vmSizeCompatibilityFilter" - } - }, - "features": { - "description": "The capabilty features.", - "type": "array", - "items": { - "type": "string" - } - }, - "quota": { - "description": "The quota capability.", - "$ref": "#/definitions/quotaCapability" - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The 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": "The HDInsight client API Version." - } - } -} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json index 46f1725b2b31..0bbe754530be 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json @@ -51,21 +51,23 @@ }, "Create Secure Hadoop cluster": { "$ref": "./examples/CreateLinuxHadoopSecureHadoop.json" + }, + "Create Hadoop cluster with Azure Data Lake Storage Gen 2": { + "$ref": "./examples/CreateLinuxHadoopAdlsGen2.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" }, { "name": "parameters", @@ -75,15 +77,15 @@ "$ref": "#/definitions/ClusterCreateParametersExtended" }, "description": "The cluster create request." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK response definition.", "schema": { @@ -104,19 +106,18 @@ "$ref": "./examples/PatchLinuxHadoopCluster.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" }, { "name": "parameters", @@ -126,15 +127,15 @@ "$ref": "#/definitions/ClusterPatchParameters" }, "description": "The cluster patch request." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK response definition.", "schema": { @@ -154,28 +155,27 @@ "$ref": "./examples/DeleteLinuxHadoopCluster.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "202": { "description": "Accepted response definition." }, @@ -199,28 +199,27 @@ "$ref": "./examples/GetLinuxSparkCluster.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK response definition.", "schema": { @@ -242,21 +241,24 @@ "$ref": "./examples/GetLinuxHadoopAllClustersInResourceGroup.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK response definition.", "schema": { @@ -281,19 +283,15 @@ "$ref": "./examples/ResizeLinuxHadoopCluster.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" }, { "name": "roleName", @@ -309,6 +307,9 @@ "modelAsString": true } }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, { "name": "parameters", "in": "body", @@ -317,15 +318,15 @@ "$ref": "#/definitions/ClusterResizeParameters" }, "description": "The parameters for the resize operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK response definition." }, @@ -348,14 +349,21 @@ } }, "description": "Lists all the HDInsight clusters under the subscription.", - "parameters": [{ - "$ref": "#/parameters/ApiVersionParameter" - }, + "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK response definition.", "schema": { @@ -483,6 +491,53 @@ } } }, + "SshPublicKey": { + "description": "The SSH public key for the cluster nodes.", + "properties": { + "certificateData": { + "type": "string", + "description": "The certificate for SSH." + } + } + }, + "SshProfile": { + "description": "The list of SSH public keys.", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "description": "The list of SSH public keys." + } + } + }, + "LinuxOperatingSystemProfile": { + "description": "The ssh username, password, and ssh public key.", + "properties": { + "username": { + "type": "string", + "description": "The username." + }, + "password": { + "type": "string", + "description": "The password." + }, + "sshProfile": { + "$ref": "#/definitions/SshProfile", + "description": "The SSH profile." + } + } + }, + "OsProfile": { + "description": "The Linux operation systems profile.", + "properties": { + "linuxOperatingSystemProfile": { + "$ref": "#/definitions/LinuxOperatingSystemProfile", + "description": "The Linux OS profile." + } + } + }, "Role": { "properties": { "name": { @@ -504,7 +559,7 @@ "description": "The hardware profile." }, "osProfile": { - "$ref": "./configurations.json#/definitions/OsProfile", + "$ref": "#/definitions/OsProfile", "description": "The operating system profile." }, "virtualNetworkProfile": { @@ -552,7 +607,11 @@ }, "container": { "type": "string", - "description": "The container in the storage account." + "description": "The container in the storage account, only to be specified for WASB storage accounts." + }, + "fileSystem": { + "type": "string", + "description": "The filesystem, only to be specified for Azure Data Lake Storage Gen 2." }, "key": { "type": "string", @@ -665,7 +724,7 @@ } } }, - "errors": { + "Errors": { "description": "The error message associated with the cluster creation.", "properties": { "code": { @@ -773,7 +832,7 @@ "errors": { "type": "array", "items": { - "$ref": "#/definitions/errors" + "$ref": "#/definitions/Errors" }, "description": "The list of errors." }, @@ -1002,7 +1061,7 @@ } }, "error": { - "$ref": "#/definitions/errors", + "$ref": "#/definitions/Errors", "description": "The operation error information." } }, @@ -1066,49 +1125,6 @@ "$ref": "#/definitions/Resource" } ] - }, - "Operation": { - "description": "The HDInsight REST API operation.", - "type": "object", - "properties": { - "name": { - "description": "The operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "The object that represents the operation.", - "properties": { - "provider": { - "description": "The service provider: Microsoft.HDInsight", - "type": "string" - }, - "resource": { - "description": "The resource on which the operation is performed: Cluster, Capabilities, etc.", - "type": "string" - }, - "operation": { - "description": "The operation type: read, write, delete, etc.", - "type": "string" - } - } - } - } - }, - "OperationListResult": { - "description": "Result of the request to list HDInsight 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": "The list of HDInsight operations supported by the HDInsight resource provider." - }, - "nextLink": { - "type": "string", - "description": "The URL to get the next set of operation list results if there are any." - } - } } }, "parameters": { @@ -1119,6 +1135,22 @@ "type": "string", "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, "ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/configurations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/configurations.json index d851b34fee70..12bb5e526c61 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/configurations.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/configurations.json @@ -47,51 +47,39 @@ "$ref": "./examples/ChangeHttpConnectivityDisable.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "configurationName", - "in": "path", - "required": true, - "type": "string", - "description": "The constant for configuration type of gateway.", - "enum": [ - "gateway" - ], - "x-ms-enum": { - "name": "ConfigurationName", - "modelAsString": false - } + "$ref": "#/parameters/ClusterNameParameter" }, { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/HttpConnectivitySettings" - }, - "description": "The name of the resource group." + "$ref": "#/parameters/ConfigurationNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterConfiguration" + }, + "description": "The cluster configurations." } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "Ok response definition" }, @@ -115,42 +103,34 @@ "$ref": "./examples/GetHttpConnectivity.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "configurationName", - "in": "path", - "required": true, - "type": "string", - "description": "The constant for configuration type of gateway." + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ConfigurationNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK response definition.", "schema": { - "type": "object", - "additionalProperties": { - "type": "string" - } + "$ref": "#/definitions/ClusterConfiguration" } } } @@ -158,93 +138,52 @@ } }, "definitions": { - "SshPublicKey": { - "description": "The SSH public key for the cluster nodes.", - "properties": { - "certificateData": { - "type": "string", - "description": "The certificate for SSH." - } - } - }, - "SshProfile": { - "description": "The list of SSH public keys.", - "properties": { - "publicKeys": { - "type": "array", - "items": { - "$ref": "#/definitions/SshPublicKey" - }, - "description": "The list of SSH public keys." - } - } - }, - "LinuxOperatingSystemProfile": { - "description": "The ssh username, password, and ssh public key.", - "properties": { - "username": { - "type": "string", - "description": "The username." - }, - "password": { - "type": "string", - "description": "The password." - }, - "sshProfile": { - "$ref": "#/definitions/SshProfile", - "description": "The SSH profile." - } - } - }, - "OsProfile": { - "description": "The Linux operation systems profile.", - "properties": { - "linuxOperatingSystemProfile": { - "$ref": "#/definitions/LinuxOperatingSystemProfile", - "description": "The Linux OS profile." - } - } - }, - "HttpConnectivitySettings": { - "properties": { - "restAuthCredential.isEnabled": { - "x-ms-client-name": "enabledCredential", - "type": "string", - "description": "Whether or not the HTTP based authorization is enabled.", - "enum": [ - "true", - "false" - ] - }, - "restAuthCredential.username": { - "x-ms-client-name": "username", - "type": "string", - "description": "The HTTP username." - }, - "restAuthCredential.password": { - "x-ms-client-name": "password", - "type": "string", - "format": "password", - "description": "The HTTP user password." - } + "ClusterConfiguration": { + "type": "object", + "additionalProperties": { + "type": "string" }, - "description": "The payload for a Configure HTTP settings request." + "description": "The configuration object for the specified configuration for the specified cluster." } }, "parameters": { "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The 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": "The HDInsight client API Version." - } + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster configuration.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateExtension.json index a537a23e4a0c..6738a1fe6424 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateExtension.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateExtension.json @@ -11,6 +11,7 @@ } }, "responses": { + "200": {}, "202": {} } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateLinuxHadoopAdlsGen2.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateLinuxHadoopAdlsGen2.json new file mode 100644 index 000000000000..b4724a8aea53 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateLinuxHadoopAdlsGen2.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.dfs.core.windows.net", + "isDefault": true, + "fileSystem": "default", + "key": "storagekey" + } + ] + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "minInstanceCount": 1, + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "minInstanceCount": 1, + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "zookeepernode", + "minInstanceCount": 1, + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteApplication.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteApplication.json index fa8ab95c2dda..101d3c534ced 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteApplication.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteApplication.json @@ -11,6 +11,7 @@ "headers": { "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" } - } + }, + "202": {} } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteExtension.json index a587152a40ec..e9e9d2486215 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteExtension.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteExtension.json @@ -7,6 +7,7 @@ "extensionName": "clustermonitoring" }, "responses": { + "200": {}, "202": {} } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DisableLinuxClusterMonitoring.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DisableLinuxClusterMonitoring.json index 350a92ee8a0c..4ee49f8033ca 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DisableLinuxClusterMonitoring.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DisableLinuxClusterMonitoring.json @@ -6,6 +6,7 @@ "subscriptionId": "subid" }, "responses": { + "200": {}, "202": {} } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/EnableLinuxClusterMonitoring.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/EnableLinuxClusterMonitoring.json index 8aa977ed32a8..049991d352a2 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/EnableLinuxClusterMonitoring.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/EnableLinuxClusterMonitoring.json @@ -10,6 +10,7 @@ } }, "responses": { + "200": {}, "202": {} } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHDInsightUsages.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHDInsightUsages.json new file mode 100644 index 000000000000..015cb4e48d2e --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHDInsightUsages.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "location": "West US", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "Body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 5000, + "name": { + "value": "cores", + "localizedValue": "Cores" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/extensions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/extensions.json index f274bcdc9155..a35b2f9f6407 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/extensions.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/extensions.json @@ -44,19 +44,18 @@ } }, "operationId": "Extension_EnableMonitoring", - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" }, { "name": "parameters", @@ -66,15 +65,18 @@ "$ref": "#/definitions/ClusterMonitoringRequest" }, "description": "The Operations Management Suite (OMS) workspace parameters." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, "202": { "description": "Accepted response definition." } @@ -92,28 +94,27 @@ } }, "operationId": "Extension_GetMonitoringStatus", - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK. The request has succeeded.", "schema": { @@ -133,28 +134,30 @@ } }, "operationId": "Extension_DisableMonitoring", - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, "202": { "description": "OK response definition." } @@ -175,51 +178,42 @@ "$ref": "./examples/CreateExtension.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Extension" - }, - "description": "The cluster extensions create request." + "$ref": "#/parameters/ClusterNameParameter" }, { - "name": "extensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster extension.", - "enum": [ - "clustermonitoring" - ], - "x-ms-enum": { - "name": "ExtensionName", - "modelAsString": false - } + "$ref": "#/parameters/ExtensionNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Extension" + }, + "description": "The cluster extensions create request." } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded." + }, "202": { "description": "OK. The request has succeeded." } @@ -236,42 +230,30 @@ } }, "operationId": "Extension_Get", - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "extensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster extension.", - "enum": [ - "clustermonitoring" - ], - "x-ms-enum": { - "name": "ExtensionName", - "modelAsString": false - } + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ExtensionNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK. The request has succeeded.", "schema": { @@ -291,42 +273,33 @@ } }, "operationId": "Extension_Delete", - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "extensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster extension.", - "enum": [ - "clustermonitoring" - ], - "x-ms-enum": { - "name": "ExtensionName", - "modelAsString": false - } + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ExtensionNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, "202": { "description": "OK response definition." } @@ -351,11 +324,11 @@ "ClusterMonitoringResponse": { "description": "The Operations Management Suite (OMS) status response", "properties": { - "ClusterMonitoringEnabled": { + "clusterMonitoringEnabled": { "description": "The status of the Operations Management Suite (OMS) on the HDInsight cluster.", "type": "boolean" }, - "WorkspaceId": { + "workspaceId": { "description": "The workspace ID of the Operations Management Suite (OMS) on the HDInsight cluster.", "type": "string" } @@ -376,19 +349,43 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The 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": "The HDInsight client API Version." - } + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ExtensionNameParameter": { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster extension.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/locations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/locations.json new file mode 100644 index 000000000000..fa4b6acbf035 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/locations.json @@ -0,0 +1,365 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2015-03-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/capabilities": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Locations_GetCapabilities", + "description": "Gets the capabilities for the specified location.", + "x-ms-examples": { + "Get the subscription capabilities for specific location": { + "$ref": "./examples/GetHDInsightCapabilities.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/CapabilitiesResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/usages": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Locations_ListUsages", + "description": "Lists the usages for the specified location.", + "x-ms-examples": { + "Get the subscription usages for specific location": { + "$ref": "./examples/GetHDInsightUsages.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + } + } + } + } + }, + "definitions": { + "VersionSpec": { + "description": "The version properties.", + "properties": { + "friendlyName": { + "type": "string", + "description": "The friendly name" + }, + "displayName": { + "type": "string", + "description": "The display name" + }, + "isDefault": { + "type": "string", + "description": "Whether or not the version is the default version." + }, + "componentVersions": { + "type": "object", + "description": "The component version property.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VersionsCapability": { + "description": "The version capability.", + "properties": { + "available": { + "description": "The list of version capabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/VersionSpec" + } + } + } + }, + "RegionsCapability": { + "description": "The regions capability.", + "properties": { + "available": { + "description": "The list of region capabilities.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "VmSizesCapability": { + "description": "The virtual machine sizes capability.", + "properties": { + "available": { + "description": "The list of virtual machine size capabilities.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "VmSizeCompatibilityFilter": { + "description": "The virtual machine type compatibility filter.", + "properties": { + "FilterMode": { + "description": "The mode for the filter.", + "type": "string" + }, + "Regions": { + "description": "The list of regions.", + "type": "array", + "items": { + "type": "string" + } + }, + "ClusterFlavors": { + "description": "The list of cluster types available.", + "type": "array", + "items": { + "type": "string" + } + }, + "NodeTypes": { + "description": "The list of node types.", + "type": "array", + "items": { + "type": "string" + } + }, + "ClusterVersions": { + "description": "The list of cluster versions.", + "type": "array", + "items": { + "type": "string" + } + }, + "vmsizes": { + "description": "The list of virtual machine sizes.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "RegionalQuotaCapability": { + "description": "The regional quota capacity.", + "properties": { + "region_name": { + "description": "The region name.", + "type": "string" + }, + "cores_used": { + "description": "The number of cores used in the region.", + "type": "integer", + "format": "int64" + }, + "cores_available": { + "description": "The number of courses available in the region.", + "type": "integer", + "format": "int64" + } + } + }, + "QuotaCapability": { + "description": "The regional quota capability.", + "properties": { + "regionalQuotas": { + "description": "The list of region quota capabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/RegionalQuotaCapability" + } + } + } + }, + "CapabilitiesResult": { + "description": "The Get Capabilities operation response.", + "properties": { + "versions": { + "description": "The version capability.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/VersionsCapability" + } + }, + "regions": { + "description": "The virtual machine size compatibilty features.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/RegionsCapability" + } + }, + "vmSizes": { + "description": "The virtual machine sizes.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/VmSizesCapability" + } + }, + "vmSize_filters": { + "description": "The virtual machine size compatibilty filters.", + "type": "array", + "items": { + "$ref": "#/definitions/VmSizeCompatibilityFilter" + } + }, + "features": { + "description": "The capabilty features.", + "type": "array", + "items": { + "type": "string" + } + }, + "quota": { + "description": "The quota capability.", + "$ref": "#/definitions/QuotaCapability" + } + } + }, + "LocalizedName": { + "description": "The details about the localizable name of a type of usage.", + "properties": { + "value": { + "description": "The name of the used resource.", + "type": "string" + }, + "localizedValue": { + "description": "The localized name of the used resource.", + "type": "string" + } + } + }, + "Usage": { + "description": "The details about the usage of a particular limited resource.", + "properties": { + "unit": { + "description": "The type of measurement for usage.", + "type": "string" + }, + "currentValue": { + "description": "The current usage.", + "type": "integer" + }, + "limit": { + "description": "The maximum allowed usage.", + "type": "integer" + }, + "name": { + "description": "The details about the localizable name of the used resource.", + "$ref": "#/definitions/LocalizedName" + } + } + }, + "UsagesListResult": { + "description": "The response for the operation to get regional usages for a subscription.", + "properties": { + "value": { + "description": "The list of usages.", + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/operations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/operations.json index 899e1292c21e..06b0460e7297 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/operations.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/operations.json @@ -29,10 +29,18 @@ "tags": ["Operations"], "description": "Lists all of the available HDInsight REST API operations.", "operationId": "Operations_List", - "parameters": [{ - "$ref": "#/parameters/ApiVersionParameter" - }], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, "200": { "description": "OK. The request has succeeded.", "schema": { @@ -63,7 +71,7 @@ "type": "string" }, "resource": { - "description": "The resource on which the operation is performed: Cluster, Capabilities, etc.", + "description": "The resource on which the operation is performed: Cluster, Applications, etc.", "type": "string" }, "operation": { @@ -89,16 +97,23 @@ "description": "The URL to get the next set of operation list results if there are any." } } + }, + "ErrorResponse": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The 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", diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/scriptActions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/scriptActions.json index 6a86a226912f..b50054bcb1ed 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/scriptActions.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/scriptActions.json @@ -44,35 +44,30 @@ "$ref": "./examples/DeleteScriptAction.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "scriptName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the script." + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ScriptNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK response definition." } @@ -91,19 +86,18 @@ "$ref": "./examples/PostExecuteScriptAction.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" }, { "name": "parameters", @@ -113,15 +107,15 @@ "$ref": "./cluster.json#/definitions/ExecuteScriptActionParameters" }, "description": "The parameters for executing script actions." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "202": { "description": "OK response definition." }, @@ -144,28 +138,27 @@ "$ref": "./examples/GetLinuxHadoopScriptAction.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK response definition.", "schema": { @@ -190,35 +183,30 @@ "$ref": "./examples/GetScriptActionById.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "scriptExecutionId", - "in": "path", - "required": true, - "type": "string", - "description": "The script execution Id" + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ScriptExecutionIdParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK response definition.", "schema": { @@ -240,28 +228,27 @@ "$ref": "./examples/GetScriptExecutionHistory.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK response definition.", "schema": { @@ -286,36 +273,30 @@ "$ref": "./examples/PromoteLinuxHadoopScriptAction.json" } }, - "parameters": [{ - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster." + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "scriptExecutionId", - "in": "path", - "required": true, - "type": "integer", - "format": "int64", - "description": "The script execution ID." + "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ScriptExecutionIdParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, "200": { "description": "OK response definition." } @@ -436,6 +417,38 @@ "type": "string", "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ScriptNameParameter": { + "name": "scriptName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the script.", + "x-ms-parameter-location": "method" + }, + "ScriptExecutionIdParameter": { + "name": "scriptExecutionId", + "in": "path", + "required": true, + "type": "string", + "description": "The script execution Id", + "x-ms-parameter-location": "method" + }, "ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/applications.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/applications.json new file mode 100644 index 000000000000..225b0aa592d3 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/applications.json @@ -0,0 +1,436 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications": { + "get": { + "tags": [ + "Applications" + ], + "description": "Lists all of the applications for the HDInsight cluster.", + "operationId": "Applications_ListByCluster", + "x-ms-examples": { + "Get All Applications for an HDInsight cluster": { + "$ref": "./examples/GetAllApplications.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApplicationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications/{applicationName}": { + "get": { + "tags": [ + "Applications" + ], + "description": "Gets properties of the specified application.", + "operationId": "Applications_Get", + "x-ms-examples": { + "Get application on HDInsight cluster successfully created.": { + "$ref": "./examples/GetApplicationCreated.json" + }, + "Get application on HDInsight cluster creation in progress": { + "$ref": "./examples/GetApplicationInProgress.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Application" + } + } + } + }, + "put": { + "tags": [ + "Applications" + ], + "description": "Creates applications for the HDInsight cluster.", + "operationId": "Applications_Create", + "x-ms-examples": { + "Create Application": { + "$ref": "./examples/CreateApplication.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationProperties" + }, + "description": "The application create request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Application" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Applications" + ], + "description": "Deletes the specified application on the HDInsight cluster.", + "operationId": "Applications_Delete", + "x-ms-examples": { + "Delete Application from HDInsight cluster": { + "$ref": "./examples/DeleteApplication.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ApplicationGetHttpsEndpoint": { + "description": "Gets the application HTTP endpoints.", + "type": "object", + "properties": { + "accessModes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of access modes for the application." + }, + "location": { + "type": "string", + "description": "The location of the endpoint." + }, + "destinationPort": { + "type": "integer", + "format": "int32", + "description": "The destination port to connect to." + }, + "publicPort": { + "type": "integer", + "format": "int32", + "description": "The public port to connect to." + } + }, + "additionalProperties": { + "type": "string" + } + }, + "ApplicationGetEndpoint": { + "description": "Gets the application SSH endpoint", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The location of the endpoint." + }, + "destinationPort": { + "type": "integer", + "format": "int32", + "description": "The destination port to connect to." + }, + "publicPort": { + "type": "integer", + "format": "int32", + "description": "The public port to connect to." + } + } + }, + "ApplicationProperties": { + "description": "The HDInsight cluster application GET response.", + "type": "object", + "properties": { + "computeProfile": { + "$ref": "./cluster.json#/definitions/ComputeProfile", + "description": "The list of roles in the cluster." + }, + "installScriptActions": { + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptAction" + }, + "description": "The list of install script actions." + }, + "uninstallScriptActions": { + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptAction" + }, + "description": "The list of uninstall script actions." + }, + "httpsEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGetHttpsEndpoint" + }, + "description": "The list of application HTTPS endpoints." + }, + "sshEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGetEndpoint" + }, + "description": "The list of application SSH endpoints." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the application." + }, + "applicationType": { + "type": "string", + "description": "The application type." + }, + "applicationState": { + "readOnly": true, + "type": "string", + "description": "The application state." + }, + "errors": { + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/Errors" + }, + "description": "The list of errors." + }, + "createdDate": { + "readOnly": true, + "type": "string", + "description": "The application create date time." + }, + "marketplaceIdentifier": { + "readOnly": true, + "type": "string", + "description": "The marketplace identifier." + }, + "additionalProperties": { + "description": "The additional properties for application.", + "type": "string" + } + } + }, + "Application": { + "description": "The HDInsight cluster application", + "type": "object", + "allOf": [ + { + "$ref": "./cluster.json#/definitions/ProxyResource" + } + ], + "properties": { + "etag": { + "description": "The ETag for the application", + "type": "string" + }, + "tags": { + "description": "The tags for the application.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ApplicationProperties", + "description": "The properties of the application." + } + } + }, + "ApplicationListResult": { + "description": "Result of the request to list cluster Applications. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Application" + }, + "description": "The list of HDInsight applications installed on HDInsight cluster." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of operation list results if there are any." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ApplicationNameParameter": { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The constant value for the application name.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/cluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/cluster.json new file mode 100644 index 000000000000..2a77e99c11dd --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/cluster.json @@ -0,0 +1,1162 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}": { + "put": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Create", + "description": "Creates a new HDInsight cluster with the specified parameters.", + "x-ms-examples": { + "Create Hadoop on Linux cluster with SSH password": { + "$ref": "./examples/CreateLinuxHadoopSshPassword.json" + }, + "Create Hadoop on Linux cluster with SSH public key": { + "$ref": "./examples/CreateLinuxHadoopSshPublicKey.json" + }, + "Create Spark on Linux Cluster with SSH password": { + "$ref": "./examples/CreateLinuxSparkSshPassword.json" + }, + "Create Secure Hadoop cluster": { + "$ref": "./examples/CreateLinuxHadoopSecureHadoop.json" + }, + "Create Hadoop cluster with Azure Data Lake Storage Gen 2": { + "$ref": "./examples/CreateLinuxHadoopAdlsGen2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterCreateParametersExtended" + }, + "description": "The cluster create request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Update", + "description": "Patch HDInsight cluster with the specified parameters.", + "x-ms-examples": { + "Patch HDInsight Linux clusters": { + "$ref": "./examples/PatchLinuxHadoopCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterPatchParameters" + }, + "description": "The cluster patch request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + } + } + }, + "delete": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Delete", + "description": "Deletes the specified HDInsight cluster.", + "x-ms-examples": { + "Delete Hadoop on Linux cluster": { + "$ref": "./examples/DeleteLinuxHadoopCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted response definition." + }, + "200": { + "description": "Ok response definition." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Get", + "description": "Gets the specified cluster.", + "x-ms-examples": { + "Get Hadoop on Linux cluster": { + "$ref": "./examples/GetLinuxHadoopCluster.json" + }, + "Get Spark on Linux cluster": { + "$ref": "./examples/GetLinuxSparkCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListByResourceGroup", + "description": "Lists the HDInsight clusters in a resource group.", + "x-ms-examples": { + "Get All Hadoop on Linux clusters in a resource group": { + "$ref": "./examples/GetLinuxHadoopAllClustersInResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/roles/{roleName}/resize": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Resize", + "description": "Resizes the specified HDInsight cluster to the specified size.", + "x-ms-examples": { + "Resize the worker nodes for a Hadoop on Linux cluster": { + "$ref": "./examples/ResizeLinuxHadoopCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The constant value for the roleName", + "enum": [ + "workernode" + ], + "x-ms-enum": { + "name": "RoleName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterResizeParameters" + }, + "description": "The parameters for the resize operation." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_List", + "x-ms-examples": { + "Get All Hadoop on Linux clusters": { + "$ref": "./examples/GetLinuxHadoopAllClusters.json" + } + }, + "description": "Lists all the HDInsight clusters under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ClusterDefinition": { + "description": "The cluster definition.", + "properties": { + "blueprint": { + "type": "string", + "description": "The link to the blueprint." + }, + "kind": { + "type": "string", + "description": "The type of cluster." + }, + "componentVersion": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The versions of different services in the cluster." + }, + "configurations": { + "type": "object", + "description": "The cluster configurations." + } + } + }, + "SecurityProfile": { + "description": "The security profile which contains Ssh public key for the HDInsight cluster.", + "properties": { + "directoryType": { + "type": "string", + "description": "The directory type.", + "enum": [ + "ActiveDirectory" + ], + "x-ms-enum": { + "name": "DirectoryType", + "modelAsString": false + } + }, + "domain": { + "type": "string", + "description": "The organization's active directory domain." + }, + "organizationalUnitDN": { + "type": "string", + "description": "The organizational unit within the Active Directory to place the cluster and service accounts." + }, + "ldapsUrls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The LDAPS protocol URLs to communicate with the Active Directory." + }, + "domainUsername": { + "type": "string", + "description": "The domain user account that will have admin privileges on the cluster." + }, + "domainUserPassword": { + "type": "string", + "format": "password", + "description": "The domain admin password." + }, + "clusterUsersGroupDNs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. The Distinguished Names for cluster user groups" + } + } + }, + "HardwareProfile": { + "properties": { + "vmSize": { + "type": "string", + "description": "The size of the VM" + } + }, + "description": "The hardware profile." + }, + "VirtualNetworkProfile": { + "description": "The virtual network properties.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the virtual network." + }, + "subnet": { + "type": "string", + "description": "The name of the subnet." + } + } + }, + "DataDisksGroups": { + "description": "The data disks groups for the role.", + "properties": { + "disksPerNode": { + "type": "integer", + "format": "int32", + "description": "The number of disks per node." + }, + "storageAccountType": { + "type": "string", + "description": "ReadOnly. The storage account type. Do not set this value.", + "readOnly": true + }, + "diskSizeGB": { + "type": "integer", + "description": "ReadOnly. The DiskSize in GB. Do not set this value.", + "readOnly": true + } + } + }, + "SshPublicKey": { + "description": "The SSH public key for the cluster nodes.", + "properties": { + "certificateData": { + "type": "string", + "description": "The certificate for SSH." + } + } + }, + "SshProfile": { + "description": "The list of SSH public keys.", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "description": "The list of SSH public keys." + } + } + }, + "LinuxOperatingSystemProfile": { + "description": "The ssh username, password, and ssh public key.", + "properties": { + "username": { + "type": "string", + "description": "The username." + }, + "password": { + "type": "string", + "description": "The password." + }, + "sshProfile": { + "$ref": "#/definitions/SshProfile", + "description": "The SSH profile." + } + } + }, + "OsProfile": { + "description": "The Linux operation systems profile.", + "properties": { + "linuxOperatingSystemProfile": { + "$ref": "#/definitions/LinuxOperatingSystemProfile", + "description": "The Linux OS profile." + } + } + }, + "Role": { + "properties": { + "name": { + "type": "string", + "description": "The name of the role." + }, + "minInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The minimum instance count of the cluster." + }, + "targetInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The instance count of the cluster." + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "The hardware profile." + }, + "osProfile": { + "$ref": "#/definitions/OsProfile", + "description": "The operating system profile." + }, + "virtualNetworkProfile": { + "$ref": "#/definitions/VirtualNetworkProfile", + "description": "The virtual network profile." + }, + "dataDisksGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisksGroups" + }, + "description": "The data disks groups for the role." + }, + "scriptActions": { + "type": "array", + "items": { + "$ref": "./scriptActions.json#/definitions/ScriptAction" + }, + "description": "The list of script actions on the role." + } + }, + "description": "Describes a role on the cluster." + }, + "ComputeProfile": { + "properties": { + "roles": { + "type": "array", + "items": { + "$ref": "#/definitions/Role" + }, + "description": "The list of roles in the cluster." + } + }, + "description": "Describes the compute profile." + }, + "StorageAccount": { + "properties": { + "name": { + "type": "string", + "description": "The name of the storage account." + }, + "isDefault": { + "type": "boolean", + "description": "Whether or not the storage account is the default storage account." + }, + "container": { + "type": "string", + "description": "The container in the storage account, only to be specified for WASB storage accounts." + }, + "fileSystem": { + "type": "string", + "description": "The filesystem, only to be specified for Azure Data Lake Storage type Gen 2." + }, + "key": { + "type": "string", + "description": "The storage account access key." + } + }, + "description": "The storage Account." + }, + "StorageProfile": { + "properties": { + "storageaccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "The list of storage accounts in the cluster." + } + }, + "description": "The storage profile." + }, + "ClusterCreateProperties": { + "description": "The cluster create parameters.", + "properties": { + "clusterVersion": { + "type": "string", + "description": "The version of the cluster." + }, + "osType": { + "type": "string", + "description": "The type of operating system.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": false + } + }, + "tier": { + "type": "string", + "description": "The cluster tier.", + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "Tier", + "modelAsString": false + } + }, + "clusterDefinition": { + "$ref": "#/definitions/ClusterDefinition", + "description": "The cluster definition." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "The security profile." + }, + "computeProfile": { + "$ref": "#/definitions/ComputeProfile", + "description": "The compute profile." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "The storage profile." + } + } + }, + "ClusterCreateParametersExtended": { + "properties": { + "location": { + "type": "string", + "description": "The location of the cluster." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "properties": { + "$ref": "#/definitions/ClusterCreateProperties", + "description": "The cluster create parameters." + } + }, + "description": "The CreateCluster request parameters." + }, + "ClusterPatchParameters": { + "properties": { + "tags": { + "type": "object", + "x-nullable": true, + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "description": "The PatchCluster request parameters" + }, + "QuotaInfo": { + "description": "The quota properties for the cluster.", + "properties": { + "coresUsed": { + "type": "integer", + "format": "int32", + "description": "The cores used by the cluster." + } + } + }, + "Errors": { + "description": "The error message associated with the cluster creation.", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "ConnectivityEndpoint": { + "description": "The connectivity properties", + "properties": { + "name": { + "type": "string", + "description": "The name of the endpoint." + }, + "protocol": { + "type": "string", + "description": "The protocol of the endpoint." + }, + "location": { + "type": "string", + "description": "The location of the endpoint." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port to connect to." + } + } + }, + "ClusterGetProperties": { + "description": "The properties of cluster.", + "properties": { + "clusterVersion": { + "type": "string", + "description": "The version of the cluster." + }, + "osType": { + "type": "string", + "description": "The type of operating system.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": false + } + }, + "tier": { + "type": "string", + "description": "The cluster tier.", + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "Tier", + "modelAsString": false + } + }, + "clusterDefinition": { + "$ref": "#/definitions/ClusterDefinition", + "description": "The cluster definition." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "The security profile." + }, + "computeProfile": { + "$ref": "#/definitions/ComputeProfile", + "description": "The compute profile." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state, which only appears in the response.", + "enum": [ + "InProgress", + "Failed", + "Succeeded", + "Canceled", + "Deleting" + ], + "x-ms-enum": { + "name": "HDInsightClusterProvisioningState", + "modelAsString": false + } + }, + "createdDate": { + "type": "string", + "description": "The date on which the cluster was created." + }, + "clusterState": { + "type": "string", + "description": "The state of the cluster." + }, + "quotaInfo": { + "$ref": "#/definitions/QuotaInfo", + "description": "The quota information." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/Errors" + }, + "description": "The list of errors." + }, + "connectivityEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectivityEndpoint" + }, + "description": "The list of connectivity endpoints." + } + }, + "required": [ + "clusterDefinition" + ] + }, + "Cluster": { + "allOf": [{ + "$ref": "#/definitions/TrackedResource" + }], + "properties": { + "etag": { + "type": "string", + "description": "The ETag for the resource" + }, + "properties": { + "$ref": "#/definitions/ClusterGetProperties", + "description": "The properties of the cluster." + } + }, + "description": "The HDInsight cluster." + }, + "RuntimeScriptAction": { + "properties": { + "name": { + "type": "string", + "description": "The name of the script action." + }, + "uri": { + "type": "string", + "description": "The URI to the script." + }, + "parameters": { + "type": "string", + "description": "The parameters for the script" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of roles where script will be executed." + }, + "applicationName": { + "readOnly": true, + "type": "string", + "description": "The application name of the script action, if any." + } + }, + "required": [ + "name", + "uri", + "roles" + ], + "description": "Describes a script action on a running cluster." + }, + "ExecuteScriptActionParameters": { + "properties": { + "scriptActions": { + "type": "array", + "items": { + "$ref": "#/definitions/RuntimeScriptAction" + }, + "description": "The list of run time script actions." + }, + "persistOnSuccess": { + "type": "boolean", + "description": "Gets or sets if the scripts needs to be persisted." + } + }, + "required": [ + "persistOnSuccess" + ], + "description": "The parameters for the script actions to execute on a running cluster." + }, + "ClusterListPersistedScriptActionsResult": { + "properties": { + "value": { + "description": "The list of Persisted Script Actions.", + "type": "array", + "items": { + "$ref": "#/definitions/RuntimeScriptAction" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "The ListPersistedScriptActions operation response." + }, + "ScriptActionExecutionSummary": { + "properties": { + "status": { + "readOnly": true, + "type": "string", + "description": "The status of script action execution." + }, + "instanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The instance count for a given script action execution status." + } + }, + "description": "The execution summary of a script action." + }, + "RuntimeScriptActionDetail": { + "allOf": [ + { + "$ref": "#/definitions/RuntimeScriptAction" + }, + { + "properties": { + "scriptExecutionId": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The execution id of the script action." + }, + "startTime": { + "readOnly": true, + "type": "string", + "description": "The start time of script action execution." + }, + "endTime": { + "readOnly": true, + "type": "string", + "description": "The end time of script action execution." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "The current execution status of the script action." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "The reason why the script action was executed." + }, + "executionSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ScriptActionExecutionSummary" + }, + "description": "The summary of script action execution result." + }, + "debugInformation": { + "readOnly": true, + "type": "string", + "description": "The script action execution debug information." + } + } + } + ], + "description": "The execution details of a script action." + }, + "ClusterListRuntimeScriptActionDetailResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RuntimeScriptActionDetail" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "The list runtime script action detail response." + }, + "ClusterListResult": { + "properties": { + "value": { + "description": "The list of Clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "The List Cluster operation response." + }, + "ClusterResizeParameters": { + "properties": { + "targetInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The target instance count for the operation." + } + }, + "description": "The Resize Cluster request parameters." + }, + "OperationResource": { + "properties": { + "status": { + "type": "string", + "description": "The async operation state.", + "enum": [ + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "AsyncOperationState", + "modelAsString": false + } + }, + "error": { + "$ref": "#/definitions/Errors", + "description": "The operation error information." + } + }, + "description": "The azure async operation response." + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region where the resource lives" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/configurations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/configurations.json new file mode 100644 index 000000000000..195561448e30 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/configurations.json @@ -0,0 +1,189 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}": { + "post": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Update", + "description": "Configures the configuration on the specified cluster.", + "x-ms-examples": { + "Enable HTTP connectivity": { + "$ref": "./examples/ChangeHttpConnectivityEnable.json" + }, + "Disable HTTP connectivity": { + "$ref": "./examples/ChangeHttpConnectivityDisable.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterConfiguration" + }, + "description": "The cluster configurations." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition" + }, + "202": { + "description": "Accepted response definition" + }, + "204": { + "description": "No content response definition" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Get", + "description": "The configuration object for the specified cluster.", + "x-ms-examples": { + "Get HTTP settings": { + "$ref": "./examples/GetHttpConnectivity.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterConfiguration" + } + } + } + } + } + }, + "definitions": { + "ClusterConfiguration": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The configuration object for the specified configuration for the specified cluster." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster configuration.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ChangeHttpConnectivityDisable.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ChangeHttpConnectivityDisable.json new file mode 100644 index 000000000000..36e6abcfc05e --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ChangeHttpConnectivityDisable.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "configurationName": "gateway", + "parameters": { + "restAuthCredential.isEnabled": "false" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ChangeHttpConnectivityEnable.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ChangeHttpConnectivityEnable.json new file mode 100644 index 000000000000..11b287ddbef3 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ChangeHttpConnectivityEnable.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "configurationName": "gateway", + "parameters": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "hadoop", + "restAuthCredential.password": "**********" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateApplication.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateApplication.json new file mode 100644 index 000000000000..a56b27bf2e7d --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateApplication.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "applicationName": "hue", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "computeProfile": { + "roles": [{ + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D12_v2" + } + }] + }, + "installScriptActions": [{ + "name": "app-install-app1", + "uri": "https://.../install.sh", + "parameters": "-version latest -port 20000", + "roles": [ + "edgenode" + ] + }], + "uninstallScriptActions": [], + "httpsEndpoints": [{ + "subDomainSuffix": "dss", + "destinationPort": 20000, + "accessModes": [ + "WebPage" + ] + }], + "provisioningState": "", + "applicationType": "CustomApplication", + "errors": [] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/hue", + "name": "hue", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "etag", + "tags": {}, + "properties": { + "computeProfile": { + "roles": [{ + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D12_v2" + } + }] + }, + "installScriptActions": [{ + "name": "app-install-app1", + "uri": "https://.../install.sh", + "parameters": "-version latest -port 20000", + "roles": [ + "edgenode" + ] + }], + "uninstallScriptActions": [], + "httpsEndpoints": [{ + "subDomainSuffix": "dss", + "destinationPort": 20000, + "accessModes": [ + "WebPage" + ] + }], + "sshEndpoints": [], + "provisioningState": "InProgress", + "applicationState": "ApplicationConfiguration", + "applicationType": "CustomApplication", + "errors": [], + "createdDate": "2017-02-28" + } + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateExtension.json new file mode 100644 index 000000000000..0ba75a738687 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateExtension.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "extensionName": "clustermonitoring", + "parameters": { + "workspaceId": "a2090ead-8c9f-4fba-b70e-533e3e003163", + "primaryKey": "**********" + } + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopAdlsGen2.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopAdlsGen2.json new file mode 100644 index 000000000000..0c791b3d6937 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopAdlsGen2.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.dfs.core.windows.net", + "isDefault": true, + "fileSystem": "default", + "key": "storagekey" + } + ] + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "minInstanceCount": 1, + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "minInstanceCount": 1, + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "zookeepernode", + "minInstanceCount": 1, + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSecureHadoop.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSecureHadoop.json new file mode 100644 index 000000000000..b7d04576b131 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSecureHadoop.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5", + "osType": "Linux", + "tier": "Premium", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [{ + "name": "mystorage", + "isDefault": true, + "container": "containername", + "key": "storage account key" + }] + }, + "securityProfile": { + "directoryType": "ActiveDirectory", + "domain": "DomainName", + "organizationalUnitDN": "OU=Hadoop,DC=hdinsight,DC=test", + "ldapsUrls": ["ldaps://10.10.0.4:636"], + "domainUsername": "DomainUsername", + "domainUserPassword": "**********", + "clusterUsersGroupDNs": ["hdiusers"] + }, + + + "computeProfile": { + "roles": [{ + "name": "headnode", + "minInstanceCount": 1, + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [{ + "certificateData": "**********" + }] + } + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + }, + "scriptActions": [] + }, + { + "name": "workernode", + "minInstanceCount": 1, + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [{ + "certificateData": "**********" + }] + } + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + }, + "scriptActions": [] + }, + { + "name": "zookeepernode", + "minInstanceCount": 1, + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [{ + "certificateData": "**********" + }] + } + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + }, + "scriptActions": [] + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSshPassword.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSshPassword.json new file mode 100644 index 000000000000..3831b22c7672 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSshPassword.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [{ + "name": "mystorage", + "isDefault": true, + "container": "containername", + "key": "storagekey" + }] + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "minInstanceCount": 1, + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "minInstanceCount": 1, + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "zookeepernode", + "minInstanceCount": 1, + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSshPublicKey.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSshPublicKey.json new file mode 100644 index 000000000000..9a1078519ddc --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSshPublicKey.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [{ + "name": "mystorage", + "isDefault": true, + "container": "containername", + "key": "storagekey" + }] + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "minInstanceCount": 1, + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "sshProfile": { + "publicKeys": [{ + "certificateData": "**********" + }] + } + } + } + }, + { + "name": "workernode", + "minInstanceCount": 1, + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "zookeepernode", + "minInstanceCount": 1, + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxSparkSshPassword.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxSparkSshPassword.json new file mode 100644 index 000000000000..8a9b5a07e513 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxSparkSshPassword.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Spark", + "componentVersion": { + "Spark": "2.0" + }, + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [{ + "name": "mystorage", + "isDefault": true, + "container": "containername", + "key": "storageapikey*" + }] + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "minInstanceCount": 1, + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D12_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "minInstanceCount": 1, + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D4_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteApplication.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteApplication.json new file mode 100644 index 000000000000..23d14c01f45d --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteApplication.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "applicationName": "hue", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteExtension.json new file mode 100644 index 000000000000..d73289f0c7a1 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteExtension.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "extensionName": "clustermonitoring" + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteLinuxHadoopCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteLinuxHadoopCluster.json new file mode 100644 index 000000000000..b1c8b19d9927 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteLinuxHadoopCluster.json @@ -0,0 +1,12 @@ + { + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "200": {} + } + } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteScriptAction.json new file mode 100644 index 000000000000..3a430578e53f --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteScriptAction.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "scriptName": "scriptName" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DisableLinuxClusterMonitoring.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DisableLinuxClusterMonitoring.json new file mode 100644 index 000000000000..d850812235da --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DisableLinuxClusterMonitoring.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/EnableLinuxClusterMonitoring.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/EnableLinuxClusterMonitoring.json new file mode 100644 index 000000000000..2206311af486 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/EnableLinuxClusterMonitoring.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "workspaceId": "a2090ead-8c9f-4fba-b70e-533e3e003163", + "primaryKey": "**********" + } + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetAllApplications.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetAllApplications.json new file mode 100644 index 000000000000..7f9fb39ed54d --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetAllApplications.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", + "name": "app", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC", + "tags": { "key1": "val1" }, + "properties": { + "computeProfile": { + "roles": [{ + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D12_v2" + } + }] + }, + "installScriptActions": [{ + "name": "app-install-app", + "uri": "http://testurl.com/public/hdi-app/20170301/hdinsight-app-install.sh", + "roles": ["edgenode"] + }], + "uninstallScriptActions": [], + "httpsEndpoints": [{ + "accessModes": ["WebPage"], + "location": "https://cluster1-app.apps.azurehdinsight.net:443", + "destinationPort": 20000, + "publicPort": 443 + }], + "sshEndpoints": [{ + "location": "app.cluster1-ssh.azurehdinsight.net:22", + "destinationPort": 22, + "publicPort": 22 + }], + "provisioningState": "Succeeded", + "applicationState": "Running", + "createdDate": "2017-03-22T21:34:39.293", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "app-on-hdiapp-on-hdi.1.0.3" + } + }, { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app2", + "name": "app2", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "2C128F8E-BB26-4637-99E4-18EBC39FD51F", + "tags": { "key1": "val1" }, + "properties": { + "computeProfile": { + "roles": [{ + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D3" + } + }] + }, + "installScriptActions": [{ + "name": "app2-Install", + "uri": "https://app2url.com/azure/2.4.0.0/app2_install.sh", + "roles": ["edgenode"] + }], + "uninstallScriptActions": [], + "httpsEndpoints": [{ + "accessModes": ["WebPage"], + "location": "location", + "destinationPort": 18630, + "publicPort": 443 + }], + "sshEndpoints": [], + "provisioningState": "InProgress", + "applicationState": "AzureVMConfiguration", + "createdDate": "2017-03-28T02:01:25.107", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "app2-hdinsightsmall.1.0.8" + } + }] + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetApplicationCreated.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetApplicationCreated.json new file mode 100644 index 000000000000..c8f8767c7d14 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetApplicationCreated.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "applicationName": "app", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", + "name": "app", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC", + "tags": { "key1": "val1" }, + "properties": { + "computeProfile": { + "roles": [{ + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D12_v2" + } + }] + }, + "installScriptActions": [{ + "name": "app-install", + "uri": "http://app.com/public/hdi-app/20170301/app-install.sh", + "roles": ["edgenode"] + }], + "uninstallScriptActions": [], + "httpsEndpoints": [{ + "accessModes": ["WebPage"], + "location": "https://cluster1.apps.azurehdinsight.net:443", + "destinationPort": 20000, + "publicPort": 443 + }], + "sshEndpoints": [{ + "location": "cluster1-ssh.azurehdinsight.net:22", + "destinationPort": 22, + "publicPort": 22 + }], + "provisioningState": "Succeeded", + "applicationState": "Running", + "createdDate": "2017-03-22T21:34:39.293", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "appMarketId" + } + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetApplicationInProgress.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetApplicationInProgress.json new file mode 100644 index 000000000000..c54dd5425f8d --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetApplicationInProgress.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "applicationName": "app", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", + "name": "app", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "2C128F8E-BB26-4637-99E4-18EBC39FD51F", + "tags": { "key1": "val1" }, + "properties": { + "computeProfile": { + "roles": [{ + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D3" + } + }] + }, + "installScriptActions": [{ + "name": "app-Install", + "uri": "https://app.com/azure/app_install.sh", + "roles": ["edgenode"] + }], + "uninstallScriptActions": [], + "httpsEndpoints": [{ + "accessModes": ["WebPage"], + "location": "location", + "destinationPort": 18630, + "publicPort": 443 + }], + "sshEndpoints": [], + "provisioningState": "InProgress", + "applicationState": "AzureVMConfiguration", + "createdDate": "2017-03-28T02:01:25.107", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "id" + } + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetExtension.json new file mode 100644 index 000000000000..d7cce776a632 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetExtension.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "extensionName": "clustermonitoring" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetHDInsightUsages.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetHDInsightUsages.json new file mode 100644 index 000000000000..c0d5a5b4653c --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetHDInsightUsages.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "location": "West US", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "Body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 5000, + "name": { + "value": "cores", + "localizedValue": "Cores" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetHttpConnectivity.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetHttpConnectivity.json new file mode 100644 index 000000000000..75ff30e36059 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetHttpConnectivity.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "configurationName": "gateway" + }, + "responses": { + "200": { + "body": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "hadoop", + "restAuthCredential.password": "**********" + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxClusterMonitoringStatus.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxClusterMonitoringStatus.json new file mode 100644 index 000000000000..99ce8d118673 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxClusterMonitoringStatus.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopAllClusters.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopAllClusters.json new file mode 100644 index 000000000000..538cd8531681 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopAllClusters.json @@ -0,0 +1,163 @@ + { + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster2", + "name": "cluster2", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster2-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster2.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json new file mode 100644 index 000000000000..72d54d1abcdb --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json @@ -0,0 +1,164 @@ + { + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster2", + "name": "cluster2", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster2-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster2.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopCluster.json new file mode 100644 index 000000000000..385d80ffd223 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopCluster.json @@ -0,0 +1,87 @@ + { + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } + } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopScriptAction.json new file mode 100644 index 000000000000..35e14bd1dcde --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopScriptAction.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "name": "app-Install", + "uri": "https://app.com/azure/app_install.sh", + "parameters": "", + "roles": ["edgenode"], + "applicationName": "app" + }] + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopScriptExecutionHistory.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopScriptExecutionHistory.json new file mode 100644 index 000000000000..60b3ddcf0b00 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopScriptExecutionHistory.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "scriptExecutionId": 386120808773799, + "name": "app-install", + "applicationName": "app", + "uri": "http://app.com/public/hdi-app/20170301/hdinsight-app-install.sh", + "parameters": "", + "roles": [ + "edgenode" + ], + "startTime": "2017-03-22T21:40:37.8865514Z", + "endTime": "2017-03-22T22:06:02.1584639Z", + "status": "Succeeded", + "operation": "AppInstall", + "executionSummary": [{ + "status": "COMPLETED", + "instanceCount": 1 + }] + }] + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxSparkCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxSparkCluster.json new file mode 100644 index 000000000000..d9b7e6ee6e9e --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxSparkCluster.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "4cd8b5a9-ca9c-4239-9e5b-3916032e994c", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/spark-3.5.1000.0.9625065.json", + "kind": "SPARK", + "componentVersion": { + "Spark": "2.0" + } + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D12_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D4_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-03-03T08:35:07.323", + "quotaInfo": { + "coresUsed": 40 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetScriptActionById.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetScriptActionById.json new file mode 100644 index 000000000000..635a25d3e455 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetScriptActionById.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "scriptExecutionId": "391145124054712" + }, + "responses": { + "200": { + "body": { + "scriptExecutionId": 391145124054712, + "name": "Test", + "applicationName": "app1", + "uri": "http://testurl.com/install.ssh", + "parameters": "", + "roles": [ + "headnode", + "workernode" + ], + "startTime": "2017-03-22T21:34:39.293", + "endTime": "2017-03-22T21:34:39.293", + "status": "ValidationFailed", + "operation": "PostClusterCreateScriptActionRequest", + "executionSummary": [], + "debugInformation": "" + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetScriptExecutionHistory.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetScriptExecutionHistory.json new file mode 100644 index 000000000000..fc162160c88a --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetScriptExecutionHistory.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "scriptExecutionId": "391145124054712" + }, + "responses": { + "200": { + "body": { + "value": [{ + "scriptExecutionId": 391145124054712, + "name": "Test", + "applicationName": "app1", + "uri": "http://testurl.com/install.ssh", + "parameters": "", + "roles": [ + "headnode", + "workernode" + ], + "startTime": "2017-03-22T21:34:39.293", + "endTime": "2017-03-22T21:34:39.293", + "status": "ValidationFailed", + "operation": "PostClusterCreateScriptActionRequest", + "executionSummary": [] + }, + { + "scriptExecutionId": 391144597342127, + "name": "Test", + "applicationName": "app2", + "uri": "http://testurl.com/install-script.ssh", + "parameters": "", + "roles": [ + "headnode", + "workernode" + ], + "startTime": "2017-03-22T21:34:39.293", + "endTime": "2017-03-22T21:34:39.293", + "status": "ValidationFailed", + "operation": "PostClusterCreateScriptActionRequest", + "executionSummary": [] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PatchLinuxHadoopCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PatchLinuxHadoopCluster.json new file mode 100644 index 000000000000..1d4c8485eced --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PatchLinuxHadoopCluster.json @@ -0,0 +1,90 @@ + { + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { "key1": "val1", "key2": "val2" } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1", "key2": "val2" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } + } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PostExecuteScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PostExecuteScriptAction.json new file mode 100644 index 000000000000..5727598112cc --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PostExecuteScriptAction.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "scriptActions": [{ + "name": "Test", + "uri": "http://testurl.com/install.ssh", + "roles": [ + "headnode", + "workernode" + ], + "parameters": "" + }], + "persistOnSuccess": false + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "200": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PromoteLinuxHadoopScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PromoteLinuxHadoopScriptAction.json new file mode 100644 index 000000000000..2fcf642c2d56 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PromoteLinuxHadoopScriptAction.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "scriptExecutionId": "391145124054712" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/RdpSettingsEnable.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/RdpSettingsEnable.json new file mode 100644 index 000000000000..cd7de3816f56 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/RdpSettingsEnable.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "osProfile": { + "windowsOperatingSystemProfile": { + "rdpSettings": { + "username": "hadoop", + "password": "**********", + "expiryDate": "2017-02-28" + } + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "200": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ResizeLinuxHadoopCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ResizeLinuxHadoopCluster.json new file mode 100644 index 000000000000..9562da3e97c9 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ResizeLinuxHadoopCluster.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "roleName": "workernode", + "parameters": { + "targetInstanceCount": 10 + } + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/extensions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/extensions.json new file mode 100644 index 000000000000..8fd625202ae2 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/extensions.json @@ -0,0 +1,393 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring": { + "put": { + "tags": [ + "Extensions" + ], + "description": "Enables the Operations Management Suite (OMS) on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/EnableLinuxClusterMonitoring.json" + } + }, + "operationId": "Extensions_EnableMonitoring", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterMonitoringRequest" + }, + "description": "The Operations Management Suite (OMS) workspace parameters." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Extensions" + ], + "description": "Gets the status of Operations Management Suite (OMS) on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/GetLinuxClusterMonitoringStatus.json" + } + }, + "operationId": "Extensions_GetMonitoringStatus", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ClusterMonitoringResponse" + } + } + } + }, + "delete": { + "tags": [ + "Extensions" + ], + "description": "Disables the Operations Management Suite (OMS) on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/DisableLinuxClusterMonitoring.json" + } + }, + "operationId": "Extensions_DisableMonitoring", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "OK response definition." + } + }, + "x-ms-long-running-operation": true + } + }, + + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}": { + "put": { + "tags": [ + "Extensions" + ], + "description": "Creates an HDInsight cluster extension.", + "operationId": "Extensions_Create", + "x-ms-examples": { + "Create a monitoring extension on Hadoop Linux cluster": { + "$ref": "./examples/CreateExtension.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Extension" + }, + "description": "The cluster extensions create request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Extensions" + ], + "description": "Gets the extension properties for the specified HDInsight cluster extension.", + "x-ms-examples": { + "Get an extension": { + "$ref": "./examples/GetExtension.json" + } + }, + "operationId": "Extensions_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Extension" + } + } + } + }, + "delete": { + "tags": [ + "Extensions" + ], + "description": "Deletes the specified extension for HDInsight cluster.", + "x-ms-examples": { + "Delete an extension": { + "$ref": "./examples/DeleteExtension.json" + } + }, + "operationId": "Extensions_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Extension": { + "description": "Cluster monitoring extensions", + "properties": { + "workspaceId": { + "description": "The workspace ID for the cluster monitoring extension.", + "type": "string" + }, + "primaryKey": { + "description": "The certificate for the cluster monitoring extensions.", + "type": "string" + } + } + }, + "ClusterMonitoringResponse": { + "description": "The Operations Management Suite (OMS) status response", + "properties": { + "clusterMonitoringEnabled": { + "description": "The status of the Operations Management Suite (OMS) on the HDInsight cluster.", + "type": "boolean" + }, + "workspaceId": { + "description": "The workspace ID of the Operations Management Suite (OMS) on the HDInsight cluster.", + "type": "string" + } + } + }, + "ClusterMonitoringRequest": { + "description": "The Operations Management Suite (OMS) parameters.", + "properties": { + "workspaceId": { + "description": "The Operations Management Suite (OMS) workspace ID.", + "type": "string" + }, + "primaryKey": { + "description": "The Operations Management Suite (OMS) workspace key.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ExtensionNameParameter": { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster extension.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/locations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/locations.json new file mode 100644 index 000000000000..a69ff4e0f1ac --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/locations.json @@ -0,0 +1,150 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/usages": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Locations_ListUsages", + "description": "Lists the usages for the specified location.", + "x-ms-examples": { + "Get the subscription usages for specific location": { + "$ref": "./examples/GetHDInsightUsages.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + } + } + } + } + }, + "definitions": { + "LocalizedName": { + "description": "The details about the localizable name of a type of usage.", + "properties": { + "value": { + "description": "The name of the used resource.", + "type": "string" + }, + "localizedValue": { + "description": "The localized name of the used resource.", + "type": "string" + } + }, + "readOnly": true + }, + "Usage": { + "description": "The details about the usage of a particular limited resource.", + "properties": { + "unit": { + "description": "The type of measurement for usage.", + "type": "string" + }, + "currentValue": { + "description": "The current usage.", + "type": "integer" + }, + "limit": { + "description": "The maximum allowed usage.", + "type": "integer" + }, + "name": { + "description": "The details about the localizable name of the used resource.", + "$ref": "#/definitions/LocalizedName" + } + }, + "readOnly": true + }, + "UsagesListResult": { + "description": "The response for the operation to get regional usages for a subscription.", + "properties": { + "value": { + "description": "The list of usages.", + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + } + } + }, + "readOnly": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location to get capabilities for.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/operations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/operations.json new file mode 100644 index 000000000000..d7e898ed03e1 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/operations.json @@ -0,0 +1,125 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": ["https"], + "consumes": ["application/json"], + "produces": ["application/json"], + "security": [{ + "azure_auth": ["user_impersonation"] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.HDInsight/operations": { + "get": { + "tags": ["Operations"], + "description": "Lists all of the available HDInsight REST API operations.", + "operationId": "Operations_List", + "parameters": [{ + "$ref": "#/parameters/ApiVersionParameter" + }], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Operation": { + "description": "The HDInsight REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "The operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "The service provider: Microsoft.HDInsight", + "type": "string" + }, + "resource": { + "description": "The resource on which the operation is performed: Cluster, Applications, etc.", + "type": "string" + }, + "operation": { + "description": "The operation type: read, write, delete, etc.", + "type": "string" + } + } + } + }, + "readOnly": true + }, + "OperationListResult": { + "description": "Result of the request to list HDInsight 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": "The list of HDInsight operations supported by the HDInsight resource provider." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of operation list results if there are any." + } + }, + "readOnly": true + }, + "ErrorResponse": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/scriptActions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/scriptActions.json new file mode 100644 index 000000000000..20677800032d --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/scriptActions.json @@ -0,0 +1,460 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions/{scriptName}": { + "delete": { + "tags": [ + "ScriptActions" + ], + "operationId": "ScriptActions_Delete", + "description": "Deletes a specified persisted script action of the cluster.", + "x-ms-examples": { + "Delete a script action on HDInsight cluster": { + "$ref": "./examples/DeleteScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ScriptNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ExecuteScriptActions", + "description": "Executes script actions on the specified HDInsight cluster.", + "x-ms-examples": { + "Execute script action on HDInsight cluster": { + "$ref": "./examples/PostExecuteScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./cluster.json#/definitions/ExecuteScriptActionParameters" + }, + "description": "The parameters for executing script actions." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "OK response definition." + }, + "200": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions": { + "get": { + "tags": [ + "ScriptActions" + ], + "operationId": "ScriptActions_ListByCluster", + "description": "Lists all the persisted script actions for the specified cluster.", + "x-ms-examples": { + "List all persisted script actions for the given cluster": { + "$ref": "./examples/GetLinuxHadoopScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ScriptActionsList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}": { + "get": { + "tags": [ + "ScriptExecutionHistory" + ], + "operationId": "ScriptActions_GetExecutionDetail", + "description": "Gets the script execution detail for the given script execution ID.", + "x-ms-examples": { + "Get script execution history by script id": { + "$ref": "./examples/GetScriptActionById.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ScriptExecutionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory": { + "get": { + "tags": [ + "ScriptExecutionHistory" + ], + "operationId": "ScriptExecutionHistory_ListByCluster", + "description": "Lists all scripts' execution history for the specified cluster.", + "x-ms-examples": { + "Get Script Execution History List": { + "$ref": "./examples/GetScriptExecutionHistory.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ScriptActionExecutionHistoryList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}/promote": { + "post": { + "tags": [ + "Promote" + ], + "operationId": "ScriptExecutionHistory_Promote", + "description": "Promotes the specified ad-hoc script execution to a persisted script.", + "x-ms-examples": { + "Promote a script action on HDInsight cluster": { + "$ref": "./examples/PromoteLinuxHadoopScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ScriptExecutionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + } + } + } + } + }, + "definitions": { + "ScriptActionExecutionHistoryList": { + "description": "The list script execution history response.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + }, + "description": "The list of persisted script action details for the cluster." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + } + }, + "ClusterListRuntimeScriptActionDetailResult": { + "description": "The list runtime script action detail response.", + "properties": { + "value": { + "description": "The list of persisted script action details for the cluster.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + } + }, + "ScriptAction": { + "properties": { + "name": { + "type": "string", + "description": "The name of the script action." + }, + "uri": { + "type": "string", + "description": "The URI to the script." + }, + "parameters": { + "type": "string", + "description": "The parameters for the script provided." + } + }, + "required": [ + "name", + "uri", + "parameters" + ], + "description": "Describes a script action on role on the cluster." + }, + "ScriptActionPersistedGetResponseSpec": { + "description": "The persisted script action for cluster.", + "properties": { + "name": { + "type": "string", + "description": "The name of script action." + }, + "uri": { + "type": "string", + "description": "The URI to the script." + }, + "parameters": { + "type": "string", + "description": "The parameters for the script provided." + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of roles where script will be executed." + }, + "applicationName": { + "type": "string", + "description": "The application name for the script action." + } + } + }, + "ScriptActionsList": { + "description": "The persisted script action for the cluster.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + }, + "description": "The list of persisted script action details for the cluster." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ScriptNameParameter": { + "name": "scriptName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the script.", + "x-ms-parameter-location": "method" + }, + "ScriptExecutionIdParameter": { + "name": "scriptExecutionId", + "in": "path", + "required": true, + "type": "string", + "description": "The script execution Id", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/readme.md b/specification/hdinsight/resource-manager/readme.md index 1d75812a193b..6d8dd5b58be2 100644 --- a/specification/hdinsight/resource-manager/readme.md +++ b/specification/hdinsight/resource-manager/readme.md @@ -29,7 +29,23 @@ title: HDInsightManagementClient description: HDInsight Management Client openapi-type: arm azure-arm: true -tag: package-2015-03-preview +tag: package-2018-06-preview +``` + + +### Tag: package-2018-06-preview + +These settings apply only when `--tag=package-2018-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06-preview' +input-file: +- Microsoft.HDInsight/preview/2018-06-01-preview/cluster.json +- Microsoft.HDInsight/preview/2018-06-01-preview/applications.json +- Microsoft.HDInsight/preview/2018-06-01-preview/locations.json +- Microsoft.HDInsight/preview/2018-06-01-preview/configurations.json +- Microsoft.HDInsight/preview/2018-06-01-preview/extensions.json +- Microsoft.HDInsight/preview/2018-06-01-preview/scriptActions.json +- Microsoft.HDInsight/preview/2018-06-01-preview/operations.json ``` @@ -41,7 +57,7 @@ These settings apply only when `--tag=package-2015-03-preview` is specified on t input-file: - Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json - Microsoft.HDInsight/preview/2015-03-01-preview/applications.json -- Microsoft.HDInsight/preview/2015-03-01-preview/capabilities.json +- Microsoft.HDInsight/preview/2015-03-01-preview/locations.json - Microsoft.HDInsight/preview/2015-03-01-preview/configurations.json - Microsoft.HDInsight/preview/2015-03-01-preview/extensions.json - Microsoft.HDInsight/preview/2015-03-01-preview/scriptActions.json @@ -61,7 +77,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-go - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-python - repo: azure-sdk-for-node ``` @@ -85,18 +101,29 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-06-preview - tag: package-2015-03-preview ``` +### Tag: package-2018-06-preview and go + +These settings apply only when `--tag=package-2018-06-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-06-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/hdinsight/mgmt/2018-06-01-preview/hdinsight +``` + ### Tag: package-2015-03-preview and go These settings apply only when `--tag=package-2015-03-preview --go` is specified on the command line. Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-03-preview' && $(go) -output-folder: $(go-sdk-folder)/services/hdinsight/mgmt/2015-03-01-preview/hdinsight +output-folder: $(go-sdk-folder)/services/preview/hdinsight/mgmt/2015-03-01-preview/hdinsight ``` + ## C# These settings apply only when `--csharp` is specified on the command line. @@ -117,11 +144,48 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.hdinsight +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-hdinsight +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-06-preview + - tag: package-2015-03-preview +``` + + +### Tag: package-2018-06-preview and java + +These settings apply only when `--tag=package-2015-03-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-06-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.hdinsight - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-hdinsight + namespace: com.microsoft.azure.management.hdinsight.v2018_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/hdinsight/resource-manager/v2018_06_01_preview +regenerate-manager: true +generate-interface: true ``` + + +### Tag: package-2015-03-preview and java + +These settings apply only when `--tag=package-2015-03-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-03-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.hdinsight.v2015_03_01_preview + output-folder: $(azure-libraries-for-java-folder)/hdinsight/resource-manager/v2015_03_01_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/hdinsight/resource-manager/readme.nodejs.md b/specification/hdinsight/resource-manager/readme.nodejs.md index 9aad401963b8..f6dbc5e896bb 100644 --- a/specification/hdinsight/resource-manager/readme.nodejs.md +++ b/specification/hdinsight/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder=`. ``` yaml $(java) -java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.intune - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-intune +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.intune +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-intune ``` diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_CheckNameAvailability.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_CheckNameAvailability.json new file mode 100644 index 000000000000..0b6098bd619f --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_CheckNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2017-07-01-privatepreview", + "operationInputs": { + "name": "myIoTCentralApp" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "nameAvailable": true + } + } + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_CreateOrUpdate.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_CreateOrUpdate.json new file mode 100644 index 000000000000..d894da696294 --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_CreateOrUpdate.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "resourceName": "myIoTCentralApp", + "api-version": "2017-07-01-privatepreview", + "App": { + "displayName": "My IoT Central App", + "subdomain": "my-iot-central-app", + "template": "iotc-default@1.0.0", + "location": "westus", + "sku": { + "name": "F1" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", + "name": "myIoTCentralApp", + "type": "Microsoft.IoTCentral/IoTApps", + "location": "westus", + "properties": { + "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", + "displayName": "My IoT Central App 2", + "subdomain": "my-iot-central-app-2", + "template": "iotc-default@1.0.0" + }, + "sku": { + "name": "F1" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", + "name": "myIoTCentralApp", + "type": "Microsoft.IoTCentral/IoTApps", + "location": "westus", + "properties": { + "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", + "displayName": "My IoT Central App", + "subdomain": "my-iot-central-app", + "template": "iotc-default@1.0.0" + }, + "sku": { + "name": "F1" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_Delete.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_Delete.json new file mode 100644 index 000000000000..85a89bf34018 --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "resourceName": "myIoTCentralApp", + "api-version": "2017-07-01-privatepreview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_Get.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_Get.json new file mode 100644 index 000000000000..07dd1f85209c --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "resourceName": "myIoTCentralApp", + "api-version": "2017-07-01-privatepreview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", + "location": "westus", + "type": "Microsoft.IoTCentral/IoTApps", + "name": "myIoTCentralApp", + "properties": { + "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", + "displayName": "My IoT Central App", + "subdomain": "my-iot-central-app", + "template": "iotc-default@1.0.0" + }, + "sku": { + "name": "F1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_ListByResourceGroup.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_ListByResourceGroup.json new file mode 100644 index 000000000000..846e92484a2f --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_ListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2017-07-01-privatepreview", + "resourceGroupName": "resRg" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", + "location": "westus", + "type": "Microsoft.IoTCentral/IoTApps", + "name": "myIoTCentralApp", + "properties": { + "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", + "displayName": "My IoT Central App", + "subdomain": "my-iot-central-app", + "template": "iotc-default@1.0.0" + }, + "sku": { + "name": "F1" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_ListBySubscription.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_ListBySubscription.json new file mode 100644 index 000000000000..01929b226fe0 --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_ListBySubscription.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2017-07-01-privatepreview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", + "location": "westus", + "type": "Microsoft.IoTCentral/IoTApps", + "name": "myIoTCentralApp", + "properties": { + "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", + "displayName": "My IoT Central App", + "subdomain": "my-iot-central-app", + "template": "iotc-default@1.0.0" + }, + "sku": { + "name": "F1" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_Update.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_Update.json new file mode 100644 index 000000000000..ed53dc94cd68 --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Apps_Update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "resourceName": "myIoTCentralApp", + "api-version": "2017-07-01-privatepreview", + "AppPatch": { + "displayName": "My IoT Central App 2" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", + "location": "westus", + "type": "Microsoft.IoTCentral/IoTApps", + "name": "myIoTCentralApp", + "properties": { + "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", + "displayName": "My IoT Central App 2", + "subdomain": "my-iot-central-app-2", + "template": "iotc-default@1.0.0" + }, + "sku": { + "name": "F1" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Operations_List.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Operations_List.json new file mode 100644 index 000000000000..498ce5dfd996 --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/examples/Operations_List.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2017-07-01-privatepreview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Microsoft.IoTCentral/IoTApps/read", + "display": { + "provider": "Microsoft IoT Central", + "resource": "IoTApps", + "operation": "Get IoT Central Application", + "description": "Gets a single IoT Central Application" + } + }, + { + "name": "Microsoft.IoTCentral/IoTApps/write", + "display": { + "provider": "Microsoft IoT Central", + "resource": "IoTApps", + "operation": "Create or Update IoT Central Application", + "description": "Creates or Updates an IoT Central Applications" + } + }, + { + "name": "Microsoft.IoTCentral/IoTApps/delete", + "display": { + "provider": "Microsoft IoT Central", + "resource": "IoTApps", + "operation": "Delete IoT Central Application", + "description": "Deletes an IoT Central Applications" + } + }, + { + "name": "Microsoft.IoTCentral/checkNameAvailability/action", + "display": { + "provider": "Microsoft IoT Central", + "resource": "", + "operation": "Check resource name availability", + "description": "Checks if an IoT Central Application name is available" + } + }, + { + "name": "Microsoft.IoTCentral/operations/read", + "display": { + "provider": "Microsoft IoT Central", + "resource": "", + "operation": "Get all the available operations", + "description": "Gets all the available operations on IoT Central Applications" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/iotcentral.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/iotcentral.json new file mode 100644 index 000000000000..bda79764bf93 --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/iotcentral.json @@ -0,0 +1,710 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-07-01-privatepreview", + "title": "IotCentralClient", + "description": "Use this API to manage IoT Central Applications in your Azure subscription." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/IoTApps/{resourceName}": { + "get": { + "tags": [ + "Apps" + ], + "description": "Get the metadata of an IoT Central application.", + "operationId": "Apps_Get", + "x-ms-examples": { + "Apps_Get": { + "$ref": "./examples/Apps_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all the non-security properties of the IoT Central application. Security-related properties are set to null.", + "schema": { + "$ref": "#/definitions/App" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Apps" + ], + "description": "Create or update the metadata of an IoT Central application. The usual pattern to modify a property is to retrieve the IoT Central application metadata and security metadata, and then combine them with the modified values in a new body to update the IoT Central application.", + "operationId": "Apps_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Apps_CreateOrUpdate": { + "$ref": "./examples/Apps_CreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "App", + "in": "body", + "description": "The IoT Central application metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/App" + } + } + ], + "responses": { + "200": { + "description": "This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.", + "schema": { + "$ref": "#/definitions/App" + } + }, + "201": { + "description": "This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.", + "schema": { + "$ref": "#/definitions/App" + } + }, + "202": { + "description": "Accepted - Put request accepted; the operation will complete asynchronously." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Apps" + ], + "description": "Update the metadata of an IoT Central application.", + "operationId": "Apps_Update", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Apps_Update": { + "$ref": "./examples/Apps_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "AppPatch", + "in": "body", + "description": "The IoT Central application metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/AppPatch" + } + } + ], + "responses": { + "200": { + "description": "This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.", + "schema": { + "$ref": "#/definitions/App" + } + }, + "202": { + "description": "Accepted - Put request accepted; the operation will complete asynchronously." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Apps" + ], + "description": "Delete an IoT Central application.", + "operationId": "Apps_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Apps_Delete": { + "$ref": "./examples/Apps_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state." + }, + "202": { + "description": "Accepted - Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the IoT Central application metadata in the service and the status of the delete operation is set to a completed state." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/IoTApps": { + "get": { + "tags": [ + "Apps" + ], + "description": "Get all IoT Central Applications in a subscription.", + "operationId": "Apps_ListBySubscription", + "x-ms-examples": { + "Apps_ListBySubscription": { + "$ref": "./examples/Apps_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT Central Applications in the subscription.", + "schema": { + "$ref": "#/definitions/AppListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/IoTApps": { + "get": { + "tags": [ + "Apps" + ], + "description": "Get all the IoT Central Applications in a resource group.", + "operationId": "Apps_ListByResourceGroup", + "x-ms-examples": { + "Apps_ListByResourceGroup": { + "$ref": "./examples/Apps_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT Central Applications in the resource group.", + "schema": { + "$ref": "#/definitions/AppListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkNameAvailability": { + "post": { + "tags": [ + "Apps" + ], + "description": "Check if an IoT Central application name is available.", + "operationId": "Apps_CheckNameAvailability", + "x-ms-examples": { + "Apps_CheckNameAvailability": { + "$ref": "./examples/Apps_CheckNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "operationInputs", + "in": "body", + "description": "Set the name parameter in the OperationInputs structure to the name of the IoT Central application to check.", + "required": true, + "schema": { + "$ref": "#/definitions/OperationInputs" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoT Central application name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/AppNameAvailabilityInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/providers/Microsoft.IoTCentral/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available IoT Central application REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + } + }, + "definitions": { + "AppProperties": { + "description": "The properties of an IoT Central application.", + "type": "object", + "properties": { + "applicationId": { + "description": "The ID of the application.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the application.", + "type": "string", + "pattern": "^.{1,200}$" + }, + "subdomain": { + "description": "The subdomain of the application.", + "type": "string", + "pattern": "^[a-z0-9-]{1,63}$" + }, + "template": { + "description": "The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + } + }, + "AppSkuInfo": { + "description": "Information about the SKU of the IoT Central application.", + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU.", + "enum": [ + "F1", + "S1" + ], + "type": "string", + "x-ms-enum": { + "name": "AppSku", + "modelAsString": true + } + } + }, + "required": [ + "name" + ] + }, + "App": { + "description": "The IoT Central application.", + "type": "object", + "properties": { + "properties": { + "description": "The common properties of an IoT Central application.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AppProperties" + }, + "sku": { + "description": "A valid instance SKU.", + "$ref": "#/definitions/AppSkuInfo" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "sku" + ] + }, + "AppPatch": { + "description": "The description of the IoT Central application.", + "type": "object", + "properties": { + "tags": { + "description": "Instance tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "description": "The common properties of an IoT Central application.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AppProperties" + } + } + }, + "Resource": { + "description": "The common properties of an ARM resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The ARM resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,99}[a-zA-Z0-9]$", + "x-comment": "pattern must match #/parameters/resourceName" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true, + "required": [ + "location" + ] + }, + "ErrorDetails": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + }, + "AppListResult": { + "description": "A list of IoT Central Applications with a next link.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of IoT Central Applications.", + "type": "string" + }, + "value": { + "description": "A list of IoT Central Applications.", + "type": "array", + "items": { + "$ref": "#/definitions/App" + } + } + } + }, + "OperationListResult": { + "description": "A list of IoT Central operations. It contains a list of operations and a URL link to get the next set of results.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of IoT Central description objects.", + "type": "string" + }, + "value": { + "description": "A list of operations supported by the Microsoft.IoTCentral resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + } + } + }, + "Operation": { + "description": "IoT Central REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{read | write | action | delete}" + }, + "display": { + "description": "The object that represents the operation.", + "$ref": "#/definitions/OperationDisplay" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft IoT Central" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource Type: IoT Central" + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Friendly description for the operation," + } + } + }, + "OperationInputs": { + "description": "Input values.", + "type": "object", + "properties": { + "name": { + "description": "The name of the IoT Central application instance to check.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "AppNameAvailabilityInfo": { + "description": "The properties indicating whether a given IoT Central application name is available.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value which indicates whether the provided name is available.", + "type": "boolean", + "readOnly": true + }, + "reason": { + "description": "The reason for unavailability.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AppNameUnavailabilityReason", + "modelAsString": false + } + }, + "message": { + "description": "The detailed reason message.", + "type": "string" + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier.", + "required": true, + "type": "string" + }, + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the API.", + "required": true, + "type": "string" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the IoT Central application.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The ARM resource name of the IoT Central application.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-comment": "validation must match #/definitions/Resource" + } + } +} diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CheckNameAvailability.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CheckNameAvailability.json new file mode 100644 index 000000000000..be3e48de33fb --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CheckNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-09-01", + "operationInputs": { + "name": "myIoTCentralApp" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "nameAvailable": true + } + } + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CreateOrUpdate.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CreateOrUpdate.json new file mode 100644 index 000000000000..08779ed2c704 --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CreateOrUpdate.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "resourceName": "myIoTCentralApp", + "api-version": "2018-09-01", + "App": { + "displayName": "My IoT Central App", + "subdomain": "my-iot-central-app", + "template": "iotc-default@1.0.0", + "location": "westus", + "sku": { + "name": "F1" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", + "name": "myIoTCentralApp", + "type": "Microsoft.IoTCentral/IoTApps", + "location": "westus", + "properties": { + "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", + "displayName": "My IoT Central App 2", + "subdomain": "my-iot-central-app-2", + "template": "iotc-default@1.0.0" + }, + "sku": { + "name": "F1" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", + "name": "myIoTCentralApp", + "type": "Microsoft.IoTCentral/IoTApps", + "location": "westus", + "properties": { + "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", + "displayName": "My IoT Central App", + "subdomain": "my-iot-central-app", + "template": "iotc-default@1.0.0" + }, + "sku": { + "name": "F1" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Delete.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Delete.json new file mode 100644 index 000000000000..ea4d3fd59aa4 --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "resourceName": "myIoTCentralApp", + "api-version": "2018-09-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Get.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Get.json new file mode 100644 index 000000000000..738c93b1e7da --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "resourceName": "myIoTCentralApp", + "api-version": "2018-09-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", + "location": "westus", + "type": "Microsoft.IoTCentral/IoTApps", + "name": "myIoTCentralApp", + "properties": { + "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", + "displayName": "My IoT Central App", + "subdomain": "my-iot-central-app", + "template": "iotc-default@1.0.0" + }, + "sku": { + "name": "F1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_ListByResourceGroup.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_ListByResourceGroup.json new file mode 100644 index 000000000000..63d9d00a43c9 --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_ListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-09-01", + "resourceGroupName": "resRg" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", + "location": "westus", + "type": "Microsoft.IoTCentral/IoTApps", + "name": "myIoTCentralApp", + "properties": { + "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", + "displayName": "My IoT Central App", + "subdomain": "my-iot-central-app", + "template": "iotc-default@1.0.0" + }, + "sku": { + "name": "F1" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_ListBySubscription.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_ListBySubscription.json new file mode 100644 index 000000000000..a74d0fe95317 --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_ListBySubscription.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-09-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", + "location": "westus", + "type": "Microsoft.IoTCentral/IoTApps", + "name": "myIoTCentralApp", + "properties": { + "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", + "displayName": "My IoT Central App", + "subdomain": "my-iot-central-app", + "template": "iotc-default@1.0.0" + }, + "sku": { + "name": "F1" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Update.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Update.json new file mode 100644 index 000000000000..cd7ef27c0f02 --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "resourceName": "myIoTCentralApp", + "api-version": "2018-09-01", + "AppPatch": { + "displayName": "My IoT Central App 2" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", + "location": "westus", + "type": "Microsoft.IoTCentral/IoTApps", + "name": "myIoTCentralApp", + "properties": { + "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", + "displayName": "My IoT Central App 2", + "subdomain": "my-iot-central-app-2", + "template": "iotc-default@1.0.0" + }, + "sku": { + "name": "F1" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Operations_List.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Operations_List.json new file mode 100644 index 000000000000..81eac53da335 --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Operations_List.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2018-09-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Microsoft.IoTCentral/IoTApps/read", + "display": { + "provider": "Microsoft IoT Central", + "resource": "IoTApps", + "operation": "Get IoT Central Application", + "description": "Gets a single IoT Central Application" + } + }, + { + "name": "Microsoft.IoTCentral/IoTApps/write", + "display": { + "provider": "Microsoft IoT Central", + "resource": "IoTApps", + "operation": "Create or Update IoT Central Application", + "description": "Creates or Updates an IoT Central Applications" + } + }, + { + "name": "Microsoft.IoTCentral/IoTApps/delete", + "display": { + "provider": "Microsoft IoT Central", + "resource": "IoTApps", + "operation": "Delete IoT Central Application", + "description": "Deletes an IoT Central Applications" + } + }, + { + "name": "Microsoft.IoTCentral/checkNameAvailability/action", + "display": { + "provider": "Microsoft IoT Central", + "resource": "", + "operation": "Check resource name availability", + "description": "Checks if an IoT Central Application name is available" + } + }, + { + "name": "Microsoft.IoTCentral/operations/read", + "display": { + "provider": "Microsoft IoT Central", + "resource": "", + "operation": "Get all the available operations", + "description": "Gets all the available operations on IoT Central Applications" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json new file mode 100644 index 000000000000..88b9479e2e79 --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json @@ -0,0 +1,710 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-09-01", + "title": "IotCentralClient", + "description": "Use this API to manage IoT Central Applications in your Azure subscription." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/IoTApps/{resourceName}": { + "get": { + "tags": [ + "Apps" + ], + "description": "Get the metadata of an IoT Central application.", + "operationId": "Apps_Get", + "x-ms-examples": { + "Apps_Get": { + "$ref": "./examples/Apps_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all the non-security properties of the IoT Central application. Security-related properties are set to null.", + "schema": { + "$ref": "#/definitions/App" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Apps" + ], + "description": "Create or update the metadata of an IoT Central application. The usual pattern to modify a property is to retrieve the IoT Central application metadata and security metadata, and then combine them with the modified values in a new body to update the IoT Central application.", + "operationId": "Apps_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Apps_CreateOrUpdate": { + "$ref": "./examples/Apps_CreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "App", + "in": "body", + "description": "The IoT Central application metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/App" + } + } + ], + "responses": { + "200": { + "description": "This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.", + "schema": { + "$ref": "#/definitions/App" + } + }, + "201": { + "description": "This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.", + "schema": { + "$ref": "#/definitions/App" + } + }, + "202": { + "description": "Accepted - Put request accepted; the operation will complete asynchronously." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Apps" + ], + "description": "Update the metadata of an IoT Central application.", + "operationId": "Apps_Update", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Apps_Update": { + "$ref": "./examples/Apps_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "AppPatch", + "in": "body", + "description": "The IoT Central application metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/AppPatch" + } + } + ], + "responses": { + "200": { + "description": "This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.", + "schema": { + "$ref": "#/definitions/App" + } + }, + "202": { + "description": "Accepted - Put request accepted; the operation will complete asynchronously." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Apps" + ], + "description": "Delete an IoT Central application.", + "operationId": "Apps_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Apps_Delete": { + "$ref": "./examples/Apps_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state." + }, + "202": { + "description": "Accepted - Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the IoT Central application metadata in the service and the status of the delete operation is set to a completed state." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/IoTApps": { + "get": { + "tags": [ + "Apps" + ], + "description": "Get all IoT Central Applications in a subscription.", + "operationId": "Apps_ListBySubscription", + "x-ms-examples": { + "Apps_ListBySubscription": { + "$ref": "./examples/Apps_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT Central Applications in the subscription.", + "schema": { + "$ref": "#/definitions/AppListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/IoTApps": { + "get": { + "tags": [ + "Apps" + ], + "description": "Get all the IoT Central Applications in a resource group.", + "operationId": "Apps_ListByResourceGroup", + "x-ms-examples": { + "Apps_ListByResourceGroup": { + "$ref": "./examples/Apps_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT Central Applications in the resource group.", + "schema": { + "$ref": "#/definitions/AppListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkNameAvailability": { + "post": { + "tags": [ + "Apps" + ], + "description": "Check if an IoT Central application name is available.", + "operationId": "Apps_CheckNameAvailability", + "x-ms-examples": { + "Apps_CheckNameAvailability": { + "$ref": "./examples/Apps_CheckNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "operationInputs", + "in": "body", + "description": "Set the name parameter in the OperationInputs structure to the name of the IoT Central application to check.", + "required": true, + "schema": { + "$ref": "#/definitions/OperationInputs" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoT Central application name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/AppNameAvailabilityInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/providers/Microsoft.IoTCentral/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available IoT Central application REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + } + }, + "definitions": { + "AppProperties": { + "description": "The properties of an IoT Central application.", + "type": "object", + "properties": { + "applicationId": { + "description": "The ID of the application.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The display name of the application.", + "type": "string", + "pattern": "^.{1,200}$" + }, + "subdomain": { + "description": "The subdomain of the application.", + "type": "string", + "pattern": "^[a-z0-9-]{1,63}$" + }, + "template": { + "description": "The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + } + }, + "AppSkuInfo": { + "description": "Information about the SKU of the IoT Central application.", + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU.", + "enum": [ + "F1", + "S1" + ], + "type": "string", + "x-ms-enum": { + "name": "AppSku", + "modelAsString": true + } + } + }, + "required": [ + "name" + ] + }, + "App": { + "description": "The IoT Central application.", + "type": "object", + "properties": { + "properties": { + "description": "The common properties of an IoT Central application.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AppProperties" + }, + "sku": { + "description": "A valid instance SKU.", + "$ref": "#/definitions/AppSkuInfo" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "sku" + ] + }, + "AppPatch": { + "description": "The description of the IoT Central application.", + "type": "object", + "properties": { + "tags": { + "description": "Instance tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "description": "The common properties of an IoT Central application.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AppProperties" + } + } + }, + "Resource": { + "description": "The common properties of an ARM resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The ARM resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,99}[a-zA-Z0-9]$", + "x-comment": "pattern must match #/parameters/resourceName" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true, + "required": [ + "location" + ] + }, + "ErrorDetails": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + }, + "AppListResult": { + "description": "A list of IoT Central Applications with a next link.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of IoT Central Applications.", + "type": "string" + }, + "value": { + "description": "A list of IoT Central Applications.", + "type": "array", + "items": { + "$ref": "#/definitions/App" + } + } + } + }, + "OperationListResult": { + "description": "A list of IoT Central operations. It contains a list of operations and a URL link to get the next set of results.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of IoT Central description objects.", + "type": "string" + }, + "value": { + "description": "A list of operations supported by the Microsoft.IoTCentral resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + } + } + }, + "Operation": { + "description": "IoT Central REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{read | write | action | delete}" + }, + "display": { + "description": "The object that represents the operation.", + "$ref": "#/definitions/OperationDisplay" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft IoT Central" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource Type: IoT Central" + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Friendly description for the operation," + } + } + }, + "OperationInputs": { + "description": "Input values.", + "type": "object", + "properties": { + "name": { + "description": "The name of the IoT Central application instance to check.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "AppNameAvailabilityInfo": { + "description": "The properties indicating whether a given IoT Central application name is available.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value which indicates whether the provided name is available.", + "type": "boolean", + "readOnly": true + }, + "reason": { + "description": "The reason for unavailability.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AppNameUnavailabilityReason", + "modelAsString": false + } + }, + "message": { + "description": "The detailed reason message.", + "type": "string" + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier.", + "required": true, + "type": "string" + }, + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the API.", + "required": true, + "type": "string" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the IoT Central application.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The ARM resource name of the IoT Central application.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-comment": "validation must match #/definitions/Resource" + } + } +} diff --git a/specification/iotcentral/resource-manager/readme.md b/specification/iotcentral/resource-manager/readme.md new file mode 100644 index 000000000000..24ac955cdf3d --- /dev/null +++ b/specification/iotcentral/resource-manager/readme.md @@ -0,0 +1,192 @@ +# IotCentral + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for IotCentral. + +--- +## Getting Started +To build the SDK for IotCentral, 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 IotCentral. + +``` yaml +openapi-type: arm +tag: package-2018-09-01 +``` + +### Tag: package-2018-09-01 + +These settings apply only when `--tag=package-2018-09-01` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09-01' +input-file: +- Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json +``` + +### Tag: package-2017-07-01-privatepreview + +These settings apply only when `--tag=package-2017-07-01-privatepreview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-07-01-privatepreview' +input-file: +- Microsoft.IoTCentral/preview/2017-07-01-privatepreview/iotcentral.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-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_iot_central'] +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.IotCentral + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/IotCentral/Management.IotCentral/Generated + clear-output-folder: true +``` + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + clear-output-folder: true + namespace: iotcentral +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-09-01 + - tag: package-2017-07-01-privatepreview +``` + +### Tag: package-2018-09-01 and go + +These settings apply only when `--tag=package-2018-09-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2018-09-01' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-09-01/$(namespace) +``` + +### Tag: package-2017-07-01-privatepreview and go + +These settings apply only when `--tag=package-2017-07-01-privatepreview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2017-07-01-privatepreview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2017-07-01-privatepreview/$(namespace) +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.iotcentral +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-iotcentral +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-09-01 + - tag: package-2017-07-01-privatepreview +``` + +### Tag: package-2018-09-01 and java + +These settings apply only when `--tag=package-2018-09-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag)=='package-2018-09-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.iotcentral.v2018_09_01 + output-folder: $(azure-libraries-for-java-folder)/iotcentral/resource-manager/v2018_09_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-07-01-privatepreview and java + +These settings apply only when `--tag=package-2017-07-01-privatepreview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag)=='package-2017-07-01-privatepreview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.iotcentral.v2017_07_01_privatepreview + output-folder: $(azure-libraries-for-java-folder)/iotcentral/resource-manager/v2017_07_01_privatepreview +regenerate-manager: true +generate-interface: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.iotcentral + package-name: azure-mgmt-iotcentral + clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-iotcentral/azure/mgmt/iotcentral +``` + +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-iotcentral +``` diff --git a/specification/iotcentral/resource-manager/readme.nodejs.md b/specification/iotcentral/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..b17a554c00ba --- /dev/null +++ b/specification/iotcentral/resource-manager/readme.nodejs.md @@ -0,0 +1,16 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-iotcentral + package-version: 1.0.0 + output-folder: $(node-sdks-folder)/lib/services/iotcentralManagement + payload-flattening-threshold: 1 + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/iotcentral/resource-manager/readme.ruby.md b/specification/iotcentral/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..629e7e179ce7 --- /dev/null +++ b/specification/iotcentral/resource-manager/readme.ruby.md @@ -0,0 +1,37 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_iot_central +package-version: "0.17.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-09-01 + - tag: package-2017-07-01-privatepreview +``` + +### Tag: package-2018-09-01 and ruby + +These settings apply only when `--tag=package-2018-09-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-09-01' && $(ruby) +namespace: "Azure::IotCentral::Mgmt::V2018_09_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_iot_central/lib +``` + +### Tag: package-2017-07-01-privatepreview and ruby + +These settings apply only when `--tag=package-2017-07-01-privatepreview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-07-01-privatepreview' && $(ruby) +namespace: "Azure::IotCentral::Mgmt::V2017_07_01_privatepreview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_iot_central/lib +``` diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_routingendpointhealth.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_routingendpointhealth.json new file mode 100644 index 000000000000..9b8bfcfa8e81 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_routingendpointhealth.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "endpointId": "id1", + "healthStatus": "healthy" + }, + { + "endpointId": "id2", + "healthStatus": "unknown" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_testallroutes.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_testallroutes.json new file mode 100644 index 000000000000..672c5f92d7c5 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_testallroutes.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "input": { + "routingSource": "DeviceMessages", + "message": { + "body": "Body of message", + "appProperties": "App Properties", + "systemProperties": "System Properties" + } + } + }, + "responses": { + "200": { + "body": { + "routes": [ + { + "properties": { + "name": "Routeid", + "source": "DeviceMessages", + "endpointNames": ["id1"], + "isEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_testnewroute.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_testnewroute.json new file mode 100644 index 000000000000..d1012877cf2f --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_testnewroute.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "input": { + "message": { + "body": "Body of message", + "appProperties": "App Properties", + "systemProperties": "System Properties" + }, + "route": { + "name": "Routeid", + "source": "DeviceMessages", + "endpointNames": [ + "id1" + ], + "isEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "result": "false", + "details": { + "compilationErrors": [ + { + "message": "string response", + "severity": "error", + "location": { + "start": { + "line": 12, + "column": 12 + }, + "end": { + "line": 12, + "column": 24 + } + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_usages.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_usages.json new file mode 100644 index 000000000000..316d5c3baff7 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_usages.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id" : "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages/freeHubCount", + "type": "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages", + "unit": "count", + "currentValue": 1, + "limit": 1, + "name": { + "value": "FreeHubCount", + "localizedValue": "Free Hub Count" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/iothub.json index a912e1fdccaf..2064804abf1e 100644 --- a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/iothub.json +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/iothub.json @@ -6,12 +6,18 @@ "description": "Use this API to manage the IoT hubs in your Azure subscription.", "x-ms-code-generation-settings": { "header": "MICROSOFT_MIT_NO_VERSION" - } + } }, "host": "management.azure.com", - "schemes": [ "https" ], - "consumes": [ "application/json" ], - "produces": [ "application/json" ], + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "security": [ { "azure_auth": [ @@ -37,7 +43,9 @@ "Operations" ], "x-ms-examples": { - "Operations_List": { "$ref": "./examples/iothub_operations.json" } + "Operations_List": { + "$ref": "./examples/iothub_operations.json" + } }, "operationId": "Operations_List", "description": "Lists all of the available IoT Hub REST API operations.", @@ -67,12 +75,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}": { "get": { - "tags": [ "GET" ], - "summary": "Get the non-security related metadata of an IoT hub.", + "tags": [ + "GET" + ], + "summary": "Get the non-security related metadata of an IoT hub", "description": "Get the non-security related metadata of an IoT hub.", "operationId": "IotHubResource_Get", "x-ms-examples": { - "IotHubResource_Get": { "$ref": "./examples/iothub_get.json" } + "IotHubResource_Get": { + "$ref": "./examples/iothub_get.json" + } }, "parameters": [ { @@ -105,12 +117,16 @@ "deprecated": false }, "put": { - "tags": [ "PUT" ], + "tags": [ + "PUT" + ], "summary": "Create or update the metadata of an IoT hub.", "description": "Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub.", "operationId": "IotHubResource_CreateOrUpdate", "x-ms-examples": { - "IotHubResource_CreateOrUpdate": { "$ref": "./examples/iothub_createOrUpdate.json" } + "IotHubResource_CreateOrUpdate": { + "$ref": "./examples/iothub_createOrUpdate.json" + } }, "x-ms-long-running-operation": true, "parameters": [ @@ -167,68 +183,74 @@ }, "patch": { "tags": [ - "PATCH" + "PATCH" ], "summary": "Update an existing IoT Hubs tags.", "description": "Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method", "x-ms-long-running-operation": true, "operationId": "IotHubResource_Update", "x-ms-examples": { - "IotHubResource_Update": { "$ref": "./examples/iothub_patch.json" } + "IotHubResource_Update": { + "$ref": "./examples/iothub_patch.json" + } }, "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource group identifier." - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of iot hub to update." - }, - { - "name": "IotHubTags", - "in": "body", - "required": true, - "description": "Updated tag information to set into the iot hub instance.", - "schema": { - "$ref": "#/definitions/TagsResource" - } - }, - { - "$ref": "#/parameters/api-version" - } + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of iot hub to update." + }, + { + "name": "IotHubTags", + "in": "body", + "required": true, + "description": "Updated tag information to set into the iot hub instance.", + "schema": { + "$ref": "#/definitions/TagsResource" + } + }, + { + "$ref": "#/parameters/api-version" + } ], "responses": { - "200": { - "description": "Iot Hub was successfully updated", - "schema": { - "$ref": "#/definitions/IotHubDescription" + "200": { + "description": "Iot Hub was successfully updated", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } } - } }, "produces": [ - "application/json" + "application/json" ], "consumes": [ - "application/json" + "application/json" ] - }, + }, "delete": { - "tags": [ "DELETE" ], - "summary": "Delete an IoT hub.", + "tags": [ + "DELETE" + ], + "summary": "Delete an IoT hub", "description": "Delete an IoT hub.", "operationId": "IotHubResource_Delete", "x-ms-examples": { - "IotHubResource_Delete": { "$ref": "./examples/iothub_delete.json" } + "IotHubResource_Delete": { + "$ref": "./examples/iothub_delete.json" + } }, "x-ms-long-running-operation": true, "parameters": [ @@ -279,12 +301,16 @@ }, "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs": { "get": { - "tags": [ "GET" ], - "summary": "Get all the IoT hubs in a subscription.", + "tags": [ + "GET" + ], + "summary": "Get all the IoT hubs in a subscription", "description": "Get all the IoT hubs in a subscription.", "operationId": "IotHubResource_ListBySubscription", "x-ms-examples": { - "IotHubResource_ListBySubscription": { "$ref": "./examples/iothub_listbysubscription.json" } + "IotHubResource_ListBySubscription": { + "$ref": "./examples/iothub_listbysubscription.json" + } }, "parameters": [ { @@ -316,12 +342,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs": { "get": { - "tags": [ "GET" ], - "summary": "Get all the IoT hubs in a resource group.", + "tags": [ + "GET" + ], + "summary": "Get all the IoT hubs in a resource group", "description": "Get all the IoT hubs in a resource group.", "operationId": "IotHubResource_ListByResourceGroup", "x-ms-examples": { - "IotHubResource_ListByResourceGroup": { "$ref": "./examples/iothub_listbyrg.json" } + "IotHubResource_ListByResourceGroup": { + "$ref": "./examples/iothub_listbyrg.json" + } }, "parameters": [ { @@ -356,12 +386,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats": { "get": { - "tags": [ "GET" ], - "summary": "Get the statistics from an IoT hub.", + "tags": [ + "GET" + ], + "summary": "Get the statistics from an IoT hub", "description": "Get the statistics from an IoT hub.", "operationId": "IotHubResource_GetStats", "x-ms-examples": { - "IotHubResource_GetStats": { "$ref": "./examples/iothub_stats.json" } + "IotHubResource_GetStats": { + "$ref": "./examples/iothub_stats.json" + } }, "parameters": [ { @@ -396,12 +430,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus": { "get": { - "tags": [ "GET" ], - "summary": "Get the list of valid SKUs for an IoT hub.", + "tags": [ + "GET" + ], + "summary": "Get the list of valid SKUs for an IoT hub", "description": "Get the list of valid SKUs for an IoT hub.", "operationId": "IotHubResource_GetValidSkus", "x-ms-examples": { - "IotHubResource_GetValidSkus": { "$ref": "./examples/iothub_getskus.json" } + "IotHubResource_GetValidSkus": { + "$ref": "./examples/iothub_getskus.json" + } }, "parameters": [ { @@ -439,12 +477,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups": { "get": { - "tags": [ "GET" ], - "summary": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.", + "tags": [ + "GET" + ], + "summary": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub", "description": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.", "operationId": "IotHubResource_ListEventHubConsumerGroups", "x-ms-examples": { - "IotHubResource_ListEventHubConsumerGroups": { "$ref": "./examples/iothub_listehgroups.json" } + "IotHubResource_ListEventHubConsumerGroups": { + "$ref": "./examples/iothub_listehgroups.json" + } }, "parameters": [ { @@ -489,12 +531,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}": { "get": { - "tags": [ "GET" ], - "summary": "Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.", + "tags": [ + "GET" + ], + "summary": "Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub", "description": "Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.", "operationId": "IotHubResource_GetEventHubConsumerGroup", "x-ms-examples": { - "IotHubResource_ListEventHubConsumerGroups": { "$ref": "./examples/iothub_getconsumergroup.json" } + "IotHubResource_ListEventHubConsumerGroups": { + "$ref": "./examples/iothub_getconsumergroup.json" + } }, "parameters": [ { @@ -541,12 +587,16 @@ "deprecated": false }, "put": { - "tags": [ "PUT" ], - "summary": "Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.", + "tags": [ + "PUT" + ], + "summary": "Add a consumer group to an Event Hub-compatible endpoint in an IoT hub", "description": "Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.", "operationId": "IotHubResource_CreateEventHubConsumerGroup", "x-ms-examples": { - "IotHubResource_CreateEventHubConsumerGroup": { "$ref": "./examples/iothub_createconsumergroup.json" } + "IotHubResource_CreateEventHubConsumerGroup": { + "$ref": "./examples/iothub_createconsumergroup.json" + } }, "parameters": [ { @@ -593,12 +643,16 @@ "deprecated": false }, "delete": { - "tags": [ "DELETE" ], - "summary": "Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.", + "tags": [ + "DELETE" + ], + "summary": "Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub", "description": "Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.", "operationId": "IotHubResource_DeleteEventHubConsumerGroup", "x-ms-examples": { - "IotHubResource_DeleteEventHubConsumerGroup": { "$ref": "./examples/iothub_deleteconsumergroup.json" } + "IotHubResource_DeleteEventHubConsumerGroup": { + "$ref": "./examples/iothub_deleteconsumergroup.json" + } }, "parameters": [ { @@ -644,12 +698,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs": { "get": { - "tags": [ "GET" ], - "summary": "Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.", + "tags": [ + "GET" + ], + "summary": "Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry", "description": "Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.", "operationId": "IotHubResource_ListJobs", "x-ms-examples": { - "IotHubResource_ListJobs": { "$ref": "./examples/iothub_listjobs.json" } + "IotHubResource_ListJobs": { + "$ref": "./examples/iothub_listjobs.json" + } }, "parameters": [ { @@ -687,12 +745,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}": { "get": { - "tags": [ "GET" ], - "summary": "Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.", + "tags": [ + "GET" + ], + "summary": "Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry", "description": "Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.", "operationId": "IotHubResource_GetJob", "x-ms-examples": { - "IotHubResource_GetJob": { "$ref": "./examples/iothub_getjob.json" } + "IotHubResource_GetJob": { + "$ref": "./examples/iothub_getjob.json" + } }, "parameters": [ { @@ -734,12 +796,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics": { "get": { - "tags": [ "GET" ], - "summary": "Get the quota metrics for an IoT hub.", + "tags": [ + "GET" + ], + "summary": "Get the quota metrics for an IoT hub", "description": "Get the quota metrics for an IoT hub.", "operationId": "IotHubResource_GetQuotaMetrics", "x-ms-examples": { - "IotHubResource_GetQuotaMetrics": { "$ref": "./examples/iothub_quotametrics.json" } + "IotHubResource_GetQuotaMetrics": { + "$ref": "./examples/iothub_quotametrics.json" + } }, "parameters": [ { @@ -775,14 +841,75 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth": { + "get": { + "tags": [ + "GET" + ], + "operationId": "IotHubResource_GetEndpointHealth", + "summary": "Get the health for routing endpoints", + "description": "Get the health for routing endpoints.", + "x-ms-examples": { + "IotHubResource_GetEndpointHealth": { + "$ref": "./examples/iothub_routingendpointhealth.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "iotHubName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EndpointHealthDataListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability": { "post": { - "tags": [ "POST" ], - "summary": "Check if an IoT hub name is available.", + "tags": [ + "POST" + ], + "summary": "Check if an IoT hub name is available", "description": "Check if an IoT hub name is available.", "operationId": "IotHubResource_CheckNameAvailability", "x-ms-examples": { - "IotHubResource_CheckNameAvailability": { "$ref": "./examples/checkNameAvailability.json" } + "IotHubResource_CheckNameAvailability": { + "$ref": "./examples/checkNameAvailability.json" + } }, "parameters": [ { @@ -818,14 +945,194 @@ "deprecated": false } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/usages": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the number of iot hubs in the subscription", + "description": "Get the number of free and paid iot hubs in the subscription", + "operationId": "ResourceProviderCommon_GetSubscriptionQuota", + "x-ms-examples": { + "ResourceProviderCommon_GetSubscriptionQuota": { + "$ref": "./examples/iothub_usages.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UserSubscriptionQuotaListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotHubResource_TestAllRoutes", + "summary": "Test all routes", + "description": "Test all routes configured in this Iot Hub", + "x-ms-examples": { + "IotHubResource_TestAllRoutes": { + "$ref": "./examples/iothub_testallroutes.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "input", + "description": "Input for testing all routes", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestAllRoutesInput" + } + }, + { + "name": "iotHubName", + "description": "IotHub to be tested", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "resource group which Iot Hub belongs to", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TestAllRoutesResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotHubResource_TestRoute", + "summary": "Test the new route", + "description": "Test the new route for this Iot Hub", + "x-ms-examples": { + "IotHubResource_TestRoute": { + "$ref": "./examples/iothub_testnewroute.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "input", + "description": "Route that needs to be tested", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestRouteInput" + } + }, + { + "name": "iotHubName", + "description": "IotHub to be tested", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "resource group which Iot Hub belongs to", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TestRouteResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys": { "post": { - "tags": [ "POST" ], - "summary": "Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", + "tags": [ + "POST" + ], + "summary": "Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security", "description": "Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", "operationId": "IotHubResource_ListKeys", "x-ms-examples": { - "IotHubResource_ListKeys": { "$ref": "./examples/iothub_listkeys.json" } + "IotHubResource_ListKeys": { + "$ref": "./examples/iothub_listkeys.json" + } }, "parameters": [ { @@ -863,12 +1170,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys": { "post": { - "tags": [ "POST" ], - "summary": "Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", + "tags": [ + "POST" + ], + "summary": "Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security", "description": "Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", "operationId": "IotHubResource_GetKeysForKeyName", "x-ms-examples": { - "IotHubResource_GetKeysForKeyName": { "$ref": "./examples/iothub_getkey.json" } + "IotHubResource_GetKeysForKeyName": { + "$ref": "./examples/iothub_getkey.json" + } }, "parameters": [ { @@ -910,12 +1221,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices": { "post": { - "tags": [ "POST" ], - "summary": "Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.", + "tags": [ + "POST" + ], + "summary": "Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities", "description": "Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.", "operationId": "IotHubResource_ExportDevices", "x-ms-examples": { - "IotHubResource_ExportDevices": { "$ref": "./examples/iothub_exportdevices.json" } + "IotHubResource_ExportDevices": { + "$ref": "./examples/iothub_exportdevices.json" + } }, "parameters": [ { @@ -959,12 +1274,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/importDevices": { "post": { - "tags": [ "POST" ], - "summary": "Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.", + "tags": [ + "POST" + ], + "summary": "Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities", "description": "Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.", "operationId": "IotHubResource_ImportDevices", "x-ms-examples": { - "IotHubResource_ImportDevices": { "$ref": "./examples/iothub_importdevices.json" } + "IotHubResource_ImportDevices": { + "$ref": "./examples/iothub_importdevices.json" + } }, "parameters": [ { @@ -1008,12 +1327,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates": { "get": { - "tags": [ "Certificates" ], + "tags": [ + "Certificates" + ], "summary": "Get the certificate list.", "description": "Returns the list of certificates.", "operationId": "Certificates_ListByIotHub", "x-ms-examples": { - "Certificates_ListByIotHub": { "$ref": "./examples/iothub_listcertificates.json" } + "Certificates_ListByIotHub": { + "$ref": "./examples/iothub_listcertificates.json" + } }, "parameters": [ { @@ -1048,12 +1371,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}": { "get": { - "tags": [ "Certificates" ], + "tags": [ + "Certificates" + ], "summary": "Get the certificate.", "description": "Returns the certificate.", "operationId": "Certificates_Get", "x-ms-examples": { - "Certificates_Get": { "$ref": "./examples/iothub_getcertificate.json" } + "Certificates_Get": { + "$ref": "./examples/iothub_getcertificate.json" + } }, "parameters": [ { @@ -1089,12 +1416,16 @@ "deprecated": false }, "put": { - "tags": [ "Certificates" ], + "tags": [ + "Certificates" + ], "summary": "Upload the certificate to the IoT hub.", "description": "Adds new or replaces existing certificate.", "operationId": "Certificates_CreateOrUpdate", "x-ms-examples": { - "Certificates_CreateOrUpdate": { "$ref": "./examples/iothub_certificatescreateorupdate.json" } + "Certificates_CreateOrUpdate": { + "$ref": "./examples/iothub_certificatescreateorupdate.json" + } }, "parameters": [ { @@ -1152,12 +1483,16 @@ "deprecated": false }, "delete": { - "tags": [ "Certificates" ], + "tags": [ + "Certificates" + ], "summary": "Delete an X509 certificate.", "description": "Deletes an existing X509 certificate or does nothing if it does not exist.", "operationId": "Certificates_Delete", "x-ms-examples": { - "Certificates_Delete": { "$ref": "./examples/iothub_certificatesdelete.json" } + "Certificates_Delete": { + "$ref": "./examples/iothub_certificatesdelete.json" + } }, "parameters": [ { @@ -1186,7 +1521,7 @@ "responses": { "200": { "description": "Certificate has been deleted." - }, + }, "204": { "description": "Certificate does not exist." }, @@ -1202,12 +1537,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/generateVerificationCode": { "post": { - "tags": [ "Certificates" ], + "tags": [ + "Certificates" + ], "summary": "Generate verification code for proof of possession flow.", "description": "Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.", "operationId": "Certificates_GenerateVerificationCode", "x-ms-examples": { - "Certificates_GenerateVerificationCode": { "$ref": "./examples/iothub_generateverificationcode.json" } + "Certificates_GenerateVerificationCode": { + "$ref": "./examples/iothub_generateverificationcode.json" + } }, "parameters": [ { @@ -1252,12 +1591,16 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/verify": { "post": { - "tags": [ "Certificates" ], + "tags": [ + "Certificates" + ], "summary": "Verify certificate's private key possession.", "description": "Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.", "operationId": "Certificates_Verify", "x-ms-examples": { - "Certificates_Verify": { "$ref": "./examples/iothub_certverify.json" } + "Certificates_Verify": { + "$ref": "./examples/iothub_certverify.json" + } }, "parameters": [ { @@ -1277,9 +1620,9 @@ }, { "name": "certificateVerificationBody", - "in":"body", - "description":"The name of the certificate", - "required":true, + "in": "body", + "description": "The name of the certificate", + "required": true, "schema": { "$ref": "#/definitions/CertificateVerificationDescription" } @@ -1311,7 +1654,7 @@ } }, "definitions": { - "CertificateVerificationDescription":{ + "CertificateVerificationDescription": { "description": "The JSON-serialized leaf certificate", "type": "object", "properties": { @@ -1321,16 +1664,6 @@ } } }, - "CertificateBodyDescription":{ - "description": "The JSON-serialized X509 Certificate.", - "type": "object", - "properties": { - "certificate": { - "description": "base-64 representation of the X509 leaf certificate .cer file or just .pem file content.", - "type": "string" - } - } - }, "CertificateListDescription": { "description": "The JSON-serialized array of Certificate objects.", "type": "object", @@ -1344,11 +1677,21 @@ } } }, + "CertificateBodyDescription": { + "description": "The JSON-serialized X509 Certificate.", + "type": "object", + "properties": { + "certificate": { + "description": "base-64 representation of the X509 leaf certificate .cer file or just .pem file content.", + "type": "string" + } + } + }, "CertificateDescription": { "description": "The X509 Certificate.", "type": "object", "properties": { - "properties" : { + "properties": { "$ref": "#/definitions/CertificateProperties" }, "id": { @@ -1375,12 +1718,12 @@ "x-ms-azure-resource": true }, "CertificateWithNonceDescription": { - "description": "The X509 Certificate.", + "description": "The X509 Certificate.", "type": "object", "properties": { - "properties" : { + "properties": { "$ref": "#/definitions/CertificatePropertiesWithNonce" - }, + }, "id": { "readOnly": true, "type": "string", @@ -1412,130 +1755,137 @@ "description": "The name of the shared access policy.", "type": "string" }, - "primaryKey": { - "description": "The primary key.", - "type": "string" + "primaryKey": { + "description": "The primary key.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary key.", + "type": "string" + }, + "rights": { + "description": "The permissions assigned to the shared access policy.", + "enum": [ + "RegistryRead", + "RegistryWrite", + "ServiceConnect", + "DeviceConnect", + "RegistryRead, RegistryWrite", + "RegistryRead, ServiceConnect", + "RegistryRead, DeviceConnect", + "RegistryWrite, ServiceConnect", + "RegistryWrite, DeviceConnect", + "ServiceConnect, DeviceConnect", + "RegistryRead, RegistryWrite, ServiceConnect", + "RegistryRead, RegistryWrite, DeviceConnect", + "RegistryRead, ServiceConnect, DeviceConnect", + "RegistryWrite, ServiceConnect, DeviceConnect", + "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": false + } + } + }, + "required": [ + "keyName", + "rights" + ] + }, + "CertificateProperties": { + "description": "The description of an X509 CA Certificate.", + "type": "object", + "properties": { + "subject": { + "description": "The certificate's subject name.", + "type": "string", + "readOnly": true + }, + "expiry": { + "description": "The certificate's expiration date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "thumbprint": { + "description": "The certificate's thumbprint.", + "type": "string", + "readOnly": true + }, + "isVerified": { + "description": "Determines whether certificate has been verified.", + "type": "boolean", + "readOnly": true + }, + "created": { + "description": "The certificate's create date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "updated": { + "description": "The certificate's last update date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "certificate": { + "description": "The certificate content", + "type": "string" + } + } + }, + "CertificatePropertiesWithNonce": { + "description": "The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.", + "type": "object", + "properties": { + "subject": { + "description": "The certificate's subject name.", + "type": "string", + "readOnly": true + }, + "expiry": { + "description": "The certificate's expiration date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "thumbprint": { + "description": "The certificate's thumbprint.", + "type": "string", + "readOnly": true + }, + "isVerified": { + "description": "Determines whether certificate has been verified.", + "type": "boolean", + "readOnly": true }, - "secondaryKey": { - "description": "The secondary key.", - "type": "string" + "created": { + "description": "The certificate's create date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true }, - "rights": { - "description": "The permissions assigned to the shared access policy.", - "enum": [ - "RegistryRead", - "RegistryWrite", - "ServiceConnect", - "DeviceConnect", - "RegistryRead, RegistryWrite", - "RegistryRead, ServiceConnect", - "RegistryRead, DeviceConnect", - "RegistryWrite, ServiceConnect", - "RegistryWrite, DeviceConnect", - "ServiceConnect, DeviceConnect", - "RegistryRead, RegistryWrite, ServiceConnect", - "RegistryRead, RegistryWrite, DeviceConnect", - "RegistryRead, ServiceConnect, DeviceConnect", - "RegistryWrite, ServiceConnect, DeviceConnect", - "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" - ], + "updated": { + "description": "The certificate's last update date and time.", "type": "string", - "x-ms-enum": { - "name": "AccessRights", - "modelAsString": false - } + "format": "date-time-rfc1123", + "readOnly": true + }, + "verificationCode": { + "description": "The certificate's verification code that will be used for proof of possession.", + "type": "string", + "readOnly": true + }, + "certificate": { + "description": "The certificate content", + "type": "string", + "readOnly": true } - }, - "required": [ - "keyName", - "rights" - ] + } }, - "CertificateProperties": - { - "description": "The description of an X509 CA Certificate.", - "type": "object", - "properties": { - "subject": { - "description": "The certificate's subject name.", - "type": "string", - "readOnly": true - }, - "expiry": { - "description": "The certificate's expiration date and time.", - "type": "string", - "format": "date-time-rfc1123", - "readOnly": true - }, - "thumbprint": { - "description": "The certificate's thumbprint.", - "type": "string", - "readOnly": true - }, - "isVerified": { - "description": "Determines whether certificate has been verified.", - "type": "boolean", - "readOnly": true - }, - "created": { - "description": "The certificate's create date and time.", - "type": "string", - "format": "date-time-rfc1123", - "readOnly": true - }, - "updated": { - "description": "The certificate's last update date and time.", - "type": "string", - "format": "date-time-rfc1123", - "readOnly": true - } - } - }, - "CertificatePropertiesWithNonce": - { - "description": "The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.", - "type": "object", - "properties": { - "subject": { - "description": "The certificate's subject name.", - "type": "string", - "readOnly": true - }, - "expiry": { - "description": "The certificate's expiration date and time.", - "type": "string", - "format": "date-time-rfc1123", - "readOnly": true - }, - "thumbprint": { - "description": "The certificate's thumbprint.", - "type": "string", - "readOnly": true - }, - "isVerified": { - "description": "Determines whether certificate has been verified.", - "type": "boolean", - "readOnly": true - }, - "created": { - "description": "The certificate's create date and time.", - "type": "string", - "format": "date-time-rfc1123", - "readOnly": true - }, - "updated": { - "description": "The certificate's last update date and time.", - "type": "string", - "format": "date-time-rfc1123", - "readOnly": true - }, - "verificationCode": { - "description": "The certificate's verification code that will be used for proof of possession.", - "type": "string", - "readOnly": true - } - } - }, "IotHubProperties": { "description": "The properties of an IoT hub.", "type": "object", @@ -1609,7 +1959,10 @@ }, "features": { "description": "The capabilities and features enabled for the IoT hub.", - "enum": [ "None", "DeviceManagement" ], + "enum": [ + "None", + "DeviceManagement" + ], "type": "string", "x-ms-enum": { "name": "Capabilities", @@ -1624,7 +1977,15 @@ "properties": { "name": { "description": "The name of the SKU.", - "enum": [ "F1", "S1", "S2", "S3", "B1", "B2", "B3" ], + "enum": [ + "F1", + "S1", + "S2", + "S3", + "B1", + "B2", + "B3" + ], "type": "string", "x-ms-enum": { "name": "IotHubSku", @@ -1633,7 +1994,11 @@ }, "tier": { "description": "The billing tier for the IoT hub.", - "enum": [ "Free", "Standard", "Basic" ], + "enum": [ + "Free", + "Standard", + "Basic" + ], "type": "string", "readOnly": true, "x-ms-enum": { @@ -1759,7 +2124,12 @@ "events": { "type": "object", "additionalProperties": { - "enum": [ "None", "Error", "Information", "Error, Information" ], + "enum": [ + "None", + "Error", + "Information", + "Error, Information" + ], "description": "The operations monitoring level.", "type": "string", "x-ms-enum": { @@ -1780,7 +2150,10 @@ }, "action": { "description": "The desired action for requests captured by this rule.", - "enum": [ "Accept", "Reject" ], + "enum": [ + "Accept", + "Reject" + ], "type": "string", "x-ms-enum": { "name": "IpFilterActionType", @@ -1842,37 +2215,37 @@ } }, "RoutingEndpoints": { - "description": "The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.", + "description": "The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.", "type": "object", "properties": { "serviceBusQueues": { - "description": "The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.", + "description": "The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.", "type": "array", "items": { "$ref": "#/definitions/RoutingServiceBusQueueEndpointProperties" } }, "serviceBusTopics": { - "description": "The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.", + "description": "The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.", "type": "array", "items": { "$ref": "#/definitions/RoutingServiceBusTopicEndpointProperties" } }, "eventHubs": { - "description": "The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.", + "description": "The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.", "type": "array", "items": { "$ref": "#/definitions/RoutingEventHubProperties" } }, "storageContainers": { - "description": "The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.", + "description": "The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.", "type": "array", "items": { "$ref": "#/definitions/RoutingStorageContainerProperties" } - } + } } }, "RoutingServiceBusQueueEndpointProperties": { @@ -1900,7 +2273,7 @@ "required": [ "name", "connectionString" - ] + ] }, "RoutingServiceBusTopicEndpointProperties": { "description": "The properties related to service bus topic endpoint types.", @@ -1927,7 +2300,7 @@ "required": [ "name", "connectionString" - ] + ] }, "RoutingEventHubProperties": { "description": "The properties related to an event hub endpoint.", @@ -1954,7 +2327,7 @@ "required": [ "name", "connectionString" - ] + ] }, "RoutingStorageContainerProperties": { "description": "The properties related to a storage container endpoint.", @@ -2008,20 +2381,26 @@ "name", "connectionString", "containerName" - ] + ] }, "RouteProperties": { - "description": "The properties of a routing rule that your IoT hub uses to route messages to endpoints.", + "description": "The properties of a routing rule that your IoT hub uses to route messages to endpoints.", "type": "object", "properties": { "name": { - "description": "The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.", + "description": "The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.", "type": "string", "pattern": "^[A-Za-z0-9-._]{1,64}$" }, "source": { "description": "The source that the routing rule is to be applied to, such as DeviceMessages.", - "enum": ["DeviceMessages", "TwinChangeEvents", "DeviceLifecycleEvents", "DeviceJobLifecycleEvents"], + "enum": [ + "Invalid", + "DeviceMessages", + "TwinChangeEvents", + "DeviceLifecycleEvents", + "DeviceJobLifecycleEvents" + ], "type": "string", "x-ms-enum": { "name": "RoutingSource", @@ -2029,12 +2408,12 @@ } }, "condition": { - "description": "The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language", + "description": "The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language", "type": "string" }, "endpointNames": { "description": "The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.", - "minItems": 1, + "minItems": 1, "maxItems": 1, "type": "array", "items": { @@ -2054,16 +2433,18 @@ ] }, "FallbackRouteProperties": { - "description": "The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.", + "description": "The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.", "type": "object", "properties": { "name": { - "description": "The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.", + "description": "The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.", "type": "string" }, "source": { - "description": "The source to which the routing rule is to be applied to. For example, DeviceMessages", - "enum": ["DeviceMessages"], + "description": "The source to which the routing rule is to be applied to. For example, DeviceMessages", + "enum": [ + "DeviceMessages" + ], "type": "string", "x-ms-enum": { "name": "RoutingSource", @@ -2071,12 +2452,12 @@ } }, "condition": { - "description": "The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language", + "description": "The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language", "type": "string" }, "endpointNames": { "description": "The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.", - "minItems": 1, + "minItems": 1, "maxItems": 1, "type": "array", "items": { @@ -2093,7 +2474,7 @@ "source", "isEnabled" ] - }, + }, "IotHubDescription": { "description": "The description of the IoT hub.", "type": "object", @@ -2103,9 +2484,11 @@ "type": "string" }, "properties": { + "description": "IotHub properties", "$ref": "#/definitions/IotHubProperties" }, "sku": { + "description": "IotHub SKU info", "$ref": "#/definitions/IotHubSkuInfo" } }, @@ -2115,7 +2498,7 @@ } ], "required": [ - "sku" + "sku" ] }, "Resource": { @@ -2265,6 +2648,48 @@ } } }, + "EndpointHealthDataListResult": { + "description": "The JSON-serialized array of EndpointHealthData objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "JSON-serialized array of Endpoint health data", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointHealthData" + } + }, + "nextLink": { + "description": "Link to more results", + "type": "string", + "readOnly": true + } + } + }, + "EndpointHealthData": { + "description": "The health data for an endpoint", + "type": "object", + "properties": { + "endpointId": { + "description": "Id of the endpoint", + "type": "string" + }, + "healthStatus": { + "description": "Health status", + "enum": [ + "unknown", + "healthy", + "unhealthy", + "dead" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointHealthStatus", + "modelAsString": true + } + } + } + }, "RegistryStatistics": { "description": "Identity registry statistics.", "type": "object", @@ -2301,7 +2726,7 @@ } }, "nextLink": { - "description": "The next link.", + "description": "The next link.", "type": "string", "readOnly": true } @@ -2321,11 +2746,12 @@ "$ref": "#/definitions/IotHubSkuInfo" }, "capacity": { + "description": "IotHub capacity", "$ref": "#/definitions/IotHubCapacity" } }, "required": [ - "sku", + "sku", "capacity" ] }, @@ -2366,7 +2792,11 @@ }, "scaleType": { "description": "The type of the scaling enabled.", - "enum": [ "Automatic", "Manual", "None" ], + "enum": [ + "Automatic", + "Manual", + "None" + ], "readOnly": true, "type": "string", "x-ms-enum": { @@ -2469,7 +2899,18 @@ }, "type": { "description": "The type of the job.", - "enum": [ "unknown", "export", "import", "backup", "readDeviceProperties", "writeDeviceProperties", "updateDeviceConfiguration", "rebootDevice", "factoryResetDevice", "firmwareUpdate" ], + "enum": [ + "unknown", + "export", + "import", + "backup", + "readDeviceProperties", + "writeDeviceProperties", + "updateDeviceConfiguration", + "rebootDevice", + "factoryResetDevice", + "firmwareUpdate" + ], "type": "string", "readOnly": true, "x-ms-enum": { @@ -2479,7 +2920,14 @@ }, "status": { "description": "The status of the job.", - "enum": [ "unknown", "enqueued", "running", "completed", "failed", "cancelled" ], + "enum": [ + "unknown", + "enqueued", + "running", + "completed", + "failed", + "cancelled" + ], "type": "string", "readOnly": true, "x-ms-enum": { @@ -2569,7 +3017,10 @@ }, "reason": { "description": "The reason for unavailability.", - "enum": [ "Invalid", "AlreadyExists" ], + "enum": [ + "Invalid", + "AlreadyExists" + ], "type": "string", "readOnly": true, "x-ms-enum": { @@ -2583,6 +3034,249 @@ } } }, + "UserSubscriptionQuotaListResult": { + "type": "object", + "description": "Json-serialized array of User subscription quota response", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UserSubscriptionQuota" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + } + }, + "UserSubscriptionQuota": { + "description": "User subscription quota response", + "type": "object", + "properties": { + "id": { + "description": "IotHub type id", + "type": "string" + }, + "type": { + "description": "Response type", + "type": "string" + }, + "unit": { + "description": "Unit of IotHub type", + "type": "string" + }, + "currentValue": { + "description": "Current number of IotHub type", + "format": "int32", + "type": "integer" + }, + "limit": { + "description": "Numerical limit on IotHub type", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "IotHub type", + "$ref": "#/definitions/Name" + } + } + }, + "Name": { + "description": "Name of Iot Hub type", + "type": "object", + "properties": { + "value": { + "description": "IotHub type", + "type": "string" + }, + "localizedValue": { + "description": "Localized value of name", + "type": "string" + } + } + }, + "TestAllRoutesInput": { + "description": "Input for testing all routes", + "type": "object", + "properties": { + "routingSource": { + "description": "Routing source", + "enum": [ + "Invalid", + "DeviceMessages", + "TwinChangeEvents", + "DeviceLifecycleEvents", + "DeviceJobLifecycleEvents" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingSource", + "modelAsString": true + } + }, + "message": { + "description": "Routing message", + "$ref": "#/definitions/RoutingMessage" + } + } + }, + "RoutingMessage": { + "description": "Routing message", + "type": "object", + "properties": { + "body": { + "description": "Body of routing message", + "type": "string" + }, + "appProperties": { + "description": "App properties", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "systemProperties": { + "description": "System properties", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TestAllRoutesResult": { + "description": "Result of testing all routes", + "type": "object", + "properties": { + "routes": { + "description": "JSON-serialized array of matched routes", + "type": "array", + "items": { + "$ref": "#/definitions/MatchedRoute" + } + } + } + }, + "MatchedRoute": { + "description": "Routes that matched", + "type": "object", + "properties": { + "properties": { + "description": "Properties of routes that matched", + "$ref": "#/definitions/RouteProperties" + } + } + }, + "TestRouteInput": { + "required": [ + "route" + ], + "description": "Input for testing route", + "type": "object", + "properties": { + "message": { + "description": "Routing message", + "$ref": "#/definitions/RoutingMessage" + }, + "route": { + "description": "Route properties", + "$ref": "#/definitions/RouteProperties" + } + } + }, + "TestRouteResult": { + "description": "Result of testing one route", + "type": "object", + "properties": { + "result": { + "description": "Result of testing route", + "enum": [ + "undefined", + "false", + "true" + ], + "type": "string", + "x-ms-enum": { + "name": "TestResultStatus", + "modelAsString": true + } + }, + "details": { + "description": "Detailed result of testing route", + "$ref": "#/definitions/TestRouteResultDetails" + } + } + }, + "TestRouteResultDetails": { + "description": "Detailed result of testing a route", + "type": "object", + "properties": { + "compilationErrors": { + "description": "JSON-serialized list of route compilation errors", + "type": "array", + "items": { + "$ref": "#/definitions/RouteCompilationError" + } + } + } + }, + "RouteCompilationError": { + "description": "Compilation error when evaluating route", + "type": "object", + "properties": { + "message": { + "description": "Route error message", + "type": "string" + }, + "severity": { + "description": "Severity of the route error", + "enum": [ + "error", + "warning" + ], + "type": "string", + "x-ms-enum": { + "name": "RouteErrorSeverity", + "modelAsString": true + } + }, + "location": { + "description": "Location where the route error happened", + "$ref": "#/definitions/RouteErrorRange" + } + } + }, + "RouteErrorRange": { + "description": "Range of route errors", + "type": "object", + "properties": { + "start": { + "description": "Start where the route error happened", + "$ref": "#/definitions/RouteErrorPosition" + }, + "end": { + "description": "End where the route error happened", + "$ref": "#/definitions/RouteErrorPosition" + } + } + }, + "RouteErrorPosition": { + "description": "Position where the route error happened", + "type": "object", + "properties": { + "line": { + "description": "Line where the route error happened", + "format": "int32", + "type": "integer" + }, + "column": { + "description": "Column where the route error happened", + "format": "int32", + "type": "integer" + } + } + }, "ExportDevicesRequest": { "description": "Use to provide parameters when requesting an export of all devices in the IoT hub.", "type": "object", @@ -2643,7 +3337,7 @@ "type": "string", "x-ms-parameter-location": "method" }, - "resourceName":{ + "resourceName": { "name": "resourceName", "in": "path", "description": "The name of the IoT hub.", @@ -2651,14 +3345,14 @@ "type": "string", "x-ms-parameter-location": "method" }, - "certificateName":{ + "certificateName": { "name": "certificateName", - "in":"path", - "description":"The name of the certificate", - "required":true, - "type":"string", - "pattern":"^[A-Za-z0-9-._]{1,64}$", + "in": "path", + "description": "The name of the certificate", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$", "x-ms-parameter-location": "method" } } -} +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/readme.md b/specification/iothub/resource-manager/readme.md index a69bc0a65cbb..23cc8f842904 100644 --- a/specification/iothub/resource-manager/readme.md +++ b/specification/iothub/resource-manager/readme.md @@ -86,9 +86,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_iot_hub'] ``` @@ -207,11 +210,30 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.iothub +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-iothub +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-04 +``` + +### Tag: package-2018-04 and java + +These settings apply only when `--tag=package-2018-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-04' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.iothub - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-iothub + namespace: com.microsoft.azure.management.iothub.v2018_04_01 + output-folder: $(azure-libraries-for-java-folder)/iothub/resource-manager/v2018_04_01 +regenerate-manager: true +generate-interface: true ``` diff --git a/specification/iothub/resource-manager/readme.nodejs.md b/specification/iothub/resource-manager/readme.nodejs.md index 28dd8fa6bc47..bfb57ea323e0 100644 --- a/specification/iothub/resource-manager/readme.nodejs.md +++ b/specification/iothub/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-07' && $(ruby) +namespace: "Azure::IotHub::Mgmt::V2017_07_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_iot_hub/lib +``` + +### Tag: package-2017-01 and ruby + +These settings apply only when `--tag=package-2017-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-01' && $(ruby) +namespace: "Azure::IotHub::Mgmt::V2017_01_19" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_iot_hub/lib +``` + +### Tag: package-2016-02 and ruby + +These settings apply only when `--tag=package-2016-02 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-02' && $(ruby) +namespace: "Azure::IotHub::Mgmt::V2016_02_03" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_iot_hub/lib +``` diff --git a/specification/iotspaces/resource-manager/readme.md b/specification/iotspaces/resource-manager/readme.md index 001eb4f038b7..efbb91da2023 100644 --- a/specification/iotspaces/resource-manager/readme.md +++ b/specification/iotspaces/resource-manager/readme.md @@ -5,6 +5,28 @@ This is the AutoRest configuration file for IoTSpaces Service. --- + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-10-preview +``` + +### Tag: package-2017-10-preview and java + +These settings apply only when `--tag=package-2017-10-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-10-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.iotspacesservice.v2017_10_01_preview + output-folder: $(azure-libraries-for-java-folder)/iotspacesservice/resource-manager/v2017_10_01_preview +regenerate-manager: true +generate-interface: true +``` + + ## Getting Started To build the SDK for IoTSpaces Service, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/BackupCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/BackupCertificate-example.json new file mode 100644 index 000000000000..343eee8b36a1 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/BackupCertificate-example.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "certificateName": "testcert", + "api-version": "7.0-preview" + }, + + "responses": { + "200": { + "body": { + "value": "JkF6dXJlS2V5VmF1bHRLZXlCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUkwTXpnMVlqQTNZaTFrTlRRM0xUUXlaVFV0WVdVNVpTMDJNVEJrWXpNNVpHWmhaamdpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLm85bmpNWEFSZWVla2NaRXBsVTNjdUxQcVZlWmxFbGRDM01XOWpYR0h6bnBXRTdHRGVOSXJraGZscHdTWXFnQnBYQkozMFpUQkRpRmpROENXSnJfUGlsUWNDRkZyN0xrdWJhWUs0TW1zcVh5WGIzbkRJcUJkQmZIUVNpZ1ZET0J5Ym9sUlRNNDYzYjBTbXhLVzJheEdFS2NuZzQ5WFkycG1SR0Vrb0plcHJWZ0tyRkpOUGQ3cGJIS3hQSWdDOFlnT2xudnZxR280RlRDSzh0ZWotcUt2UzBfRGV6Uk5vdTZqZ25SekpxX0g2NGxWMk1hQ0NnUy0xbTlyOGVOTVVvSlhTV1hwc0lneng1RzdEbzIya1ZEY25vMW9rajlCMXNvbklkWmtuY1JybDJBVHNRZVlzZXdkUVd1VmhxRzVLN0pNQWo5YzBRdkxhTmlpdl9PY2pFcm5qUS4zbmI4azJ3SEcyNHFJelNNb184WG13LnJzc3NMNjJ1aUNfTm9IbG5zQlgzcEEtck1uY3g5R3V2NmJYSHpKamxwOWNMUnVaSDBSWlJYVXRwU3BPQWdyZ20tU3BxeEdWSjd2bmprbV9FSzJwYy1sZHNjUWtRSDB4bVFVcGZFNzN5b1VTYTNXVVNMS2VIVnJLdUg5MUtJR0tLODE5ejc5d1Y5Y0F3UjlzcHJxbFFWZnlKdlNFM2tnZTh1RVBpRFFVMFl5WnJqVjBsMGJCU3VkeTN1MVlsVHB6Wk1EWmpUcE05ZGtMclgtaGdxZ1FGa2xFa1hNRWlzd0RDZVM3Y3J2bFg1bnVzbWh5SkZCMklCd3dxNWJieHptV1diU3JOc3lFMmJmWEpXOWN4TFlQcnJJZFpfbkd0X29RSGVQcUFZTS1iVnpTdzdBRGJjMU15NTZwclBGLW9PSm40MHptOTBaaFBTVGMyQXNKRGFBa3R5WFU4WktOYUhFVUlHLWI1SGhUdFBuZ20wN0FrWEtQNngwaDhzZ3ZIaGdCeGpfdWRfQVpQc3pLWG1HdUhFTW9lRGhpT3NkQVdRR0pwR2t0NHVlbmZyamNSeXVlaXJiTC1RV3o4MEtZUnk1QklxbzVJc19RVHpWN2dqMGstYS0td24tazNsNTJ4YjhaNkRXd2tWZ3hqUlNXOXZnV0pVd2U5M1ZrVWtHM3NLRW5SOE9ueTNjWlhQVl9LbWtBTEdlR0ZzQm53SmQwY3dueTBCN2I5VWQyQ19kWEZ0N1BvbnFVNldfT016cC1Nb1NtRzRHbEFpUkVfQ3FrWlhkalhIMVItSmpObUNfdXlPUTdaN1BVaDAtNmd2YUxpcE1CamlWR1FwdzlEZDhmVmtCbWk4VW5uOUxPYXJmSXVtcEJyUE43TTJhM05KdjN6b0NkanhZVFVUMTN1aElpYWl3aExoUFZhT2pUbFRmTkpqbHhIbG5lbGJ1RWJsZTk0bVV1bW8wcjhKRlFMSDdfRjhXMVo0OC1BcjhYYXJwMXhIY0FReHk1WWYwclktdUU1dTAyRnRHUHlPZ0JfNV9WdFlNR2VfRE1mdENLOGVMZGFnVllMRDJDNDUxTldZeVVfeHdNUWdQbXBaMWFnSEdCb2s0ejhsSFBndVhCQ3R2WFFuTHBXQTVBamdOLWNoWjNwUGJmc2RkNjBhekJuWDVaVXQza2hYaWNDdWk4b0xidEtzQUdmckNOZzFwT2Q0MHBHMEJlVy1lNVE1WWQydjY4eFh5a2RiTXhFblFCM3Fzd1djVlh1QXBIR18wREZVVmZvSlc2aVBZcDNWVE51amM5M3QtMDcxWnlZbUZ4V0RfVThMYTAtM19RLV8yZ0pwMVBaVV8tMVBRM1huLXdSWk1vb3JkZGZQa1VPZ0lqdWkwa1IwZWt5RjZvdWdLNnJrSVZHaGp3YUp0ekdKczJLdGxncnRCcEs2MXZEaE5zbFR5VHU5OUp2T2RFTXhwRG5lTEg4NnlvVnhxT3lIT3lxNjByXzdpTHgtdy03Q3FzWTloT3dmQlBZZ3BQVlM2bm9oZVBocTkwaGJTX0lrM21YbnRkRUNMREtSMi1wWFh6bjlPRjZIN09EdHB4S0VXQkdCaHJ0Ykxmd2JZS3dmWmZSVTJVUHpkLUxFd1lQdDloU203Z3lSODNoYkZiSFNBV1cySncxRWl1c3FURWRsRW1lQ3k2cFp1MVFZWko0TUQ0OG5rVXMwdmVHUVhTU2Ytb2RhQm1fYjZZdVh1cWcyWk03MlZjUTd4ZzV4MmpFenFqcllmdjdTTGJINFZBcWp0aFg5LUdRaWEwWEZaS18xempIenhkd1B0R2lSOHJfMkFFZTgtRXFoNi1FaTZKdjRFZjYyMnRrNWFJUWx3R1pETWpGSVNuUkpRdV8xcnJiY1E3enZsbWhUSWFQcUJNRFVxeHBEOXNWUlhuSHdIaTl1b1BCUTllbWJIMkV5WDV6MEhWRXlDa1JEbUd3cmR2RGdsOFVzMUhURjVwYXlYZmF2WkZUZjl3WFZyQXpsRFBEQkFJVFMzWnVJMEJWR2pJUGV1SnRiako4S1pTczRFQVNRRTVyVjViTUpNQXcwa19nYkVRTEZGSjJVb0ZzcWU1QUszM2xGXzR5cGMxU0JaWjJfUzYtbEQyNkpyRFVJSjFFRmJhbWtoUk12bWJIT1Utc0hDT0lRcHdadlJzV3Q3NExSQ1ZyQ09jMGpUdE5TT1JPUW5XRHVXRlFXSzk1TkRGMG96WjIyLVFEMU9YOE9iU3daaHdOXzNfS1pHRmtVMEhNdzNjSTI5LWUxbFltRDV3cmJ0ZlRFbllOeHJKOGpuUWFBY2FoNy14Q0JKeUQ3elo1MXIzRVVyY2VnazBzc1dLeHRPVjRLcTZENmxuVmU3bFpUT1dfTU5aZi1JSzJUbnZCaVZIMHk0SkVGaUxzSDJHbTM1d28yYlZVaXJsT1ljVEk1NlZhdDhMRWhGaEotVlUyNk84NHo2dUJFZmJucEZLbmdKc3pfYVlucW1zNWV1bmd3ek5ndjdlT0U0cUdKSURyMTRBUXRWdEYxcWdrZHNnVllWVXg4U29SQ0NobE5VUzRNRGxhc1hwS1VmV19ENWIxbDRkbXZiNEZNRHJqakJ6djk5dGJSeGZFYUVOSFlYTHZFZnJ0b0pMeW9na2tmNkxlbVoxVDZRbnRtNlR4S1IycU81WU1vMnRJZHlQNmZNRmkweEYtdE1IaHNSdVN3VEpybW1nREcteHVpZllVNkpfaElSNkMzVmo2VkFMMW1oZy0xeW1pRXZuanVLbElONzc4NmFWdVNpNmx5TjJJNzZqY0R6SHZ0VW1ibkVvWWtORHNPQXdqQk9MNFBlS0VjR1hWcm5YNDJhNW5IRWM2cmZQdjZ0Q2tVSUI0UldIdzEyUTFiNDM2N1JvRS1PTWN3TnV6ampob1M0S1ZJbHo4UEFMOW9YYTR4NXlQeG1aVzZ0UUVna1pKeFhEcS00SWRtd1UzTnpVZUoxdGpNaXFsc0xRWDdlc29fTHRtTWJ3bm83YkI3bjRlVnZ4aUtQU3p3dW94c25aaGs1b3ZSSE1xU0NtZjU2MjJvUTZvWEdmNUJLWExlQWdqaE1Sd21razEtUzlGajlyc1hlT19VYjJOMF9hVEFLemlidXIxNVcxaHI3Wk1PVFlxOFlSSGVPaWxSX3Bkdjl5NTlDRDQ1WmE0ZXFURHVrNmRxZ1d4YnoyVVVtMnpwM3pvTHVKSVZ1Y3FIaUVRTVNfMnFKcy1xQTAwT2FFY3huZTM2Q1RsZVNwZjF5cjh2VjNWNW1mQU5zRnJBa21CMnBRWTNfZ21UbldTYTJ3UWlMa2RFRllPSExTeEk5UVowNHo4ZFRfbW5QMmIwWV96N3ZLa0VGQmFpNU02UFdPWjVIOUx1M3Rnay1fR0g0ODd6ZHpuQm0weWZZY3ZIOHJUd1QyQl9UZVRFMG4xcWFRdDRiQ0diUkFQNE1DTDl0SGlIcmlzWEllejQzZlZ3b1c4R2x4YmxKanlLWkpXbmlRNjlBYks3SmYyUER6d2NVSHhkZU5HNGxEZmt6WmFxU2lybGRzZlhXOHBGLWZ6WFVVWHR4eDF4Um5nQ1hJVkxLbU5ZbV9CNnNrNGo0VzROVFMwQTBOcFhsZGJCWjZWWmFDMDNvRHVGUFY0MGtwdWQ0WEd3Q1l3M244ZjFHb0Z6Sk42QjFqOTRLeTdtNE5YT1JsQ3ZaRW5qZTl6T241T1d1ZG9USWRoRzBobXVDUTZ6TXI2YkVaTUFoV1ZFdlREY19iXzZsOWdLWmVxNmVtekxvcmptOEQzLXcyLXRBYlE2Tmpjd0J3eEhMZzlCRllRRFdvaU9UVmJKN2VBcUVFMHVxVkhBcE9KbFVIc2tmQy1uV3NzOV9fRTFURHBLcjRfRE93NFhPUGNzT3dlVU9EUWg3cVFXRE1ZcDVHU1poVWE4MVVHczhmemZKU3JPbmtaTmRVTS10Y0h3R01mX3didy11dmt4UFUtV0tvNUNqR2M2aU5KMDB4MjZZdUpCWXd6TVFyeDBJQWgxMjVBWlozX2FvaFFpLWw3a1pZVE82Q0JVOVZsYllNMndrZXp4ZGhrQ1oxd080Z1NNbDlKU3A5ejhxNV84SU1WM1pma00xV1VqSGZMQk4xRXdFMjRxZFVzcWxyU3NZN1hQaVlpcXQ5ZktXVmZDTWw4RU0yd2ZHYlhxMUI4eWl2UlpMcko0eEk2MUdVUWJFVGU4akNTYTF2aUxxZ0FIa25IYjVjVHIwbDRhTW1EZGZKWnJxZEdpb1lPb2IwdHBuc3IxanRfZm1obGhJa1NSQnREUk5XWEU1OXBjVXlULXpyVjBxZl9sOHN2TlNEV2N3d09YQ3lITWZzLWw0T29xMldVWTVLQi1nSG1HYUJod0oxa19ra3V2S0hlMl9TY0loc3JjTXV1eW5aLW14Vzl5NHBBS3pvdVFsQjR0ZGZvbHdSRk5KX0tHYWJPZXJiWFdDT0ZTd0JVTjdNaG0wOXNyVS1VWG5od1IwdTYyTjVvMDlfbGN5eThnWDg1ZUVrenhuOGZ2NHd2T0Y2dUd1cFk5UGxpSTRLMTNqSHlOd0ZuY2VmRlp2b0dxVlhkcUg5RGJkYS0zY1FhbVFlNmlMek0wRDlnLXlFc2NBTkpKS3ltelVzemZZdV8yY0p0TEhsd0I3NVhLeW1EMG9nUkRvRkRwTmNPd1dRRUlwdVJwU0pfdWtzR2EwZkd3MGVBTU4tQmc1OUs3emhRWHJISUZOckN1S1VPMVdvTkV5WkM2UGlKSUwtUlRsTFQ2WlBNZmdSZzZiUl9aQk43X2dseHBIakNDaFZXMkZ3MnJFUDJJX1pSeHFqdS1WbmVwV2o4eU1CaHZXZzdXNm9QWm1odmVtUTBkQUljNVZTbVVaelhvNFVURmJxSFN2MGlyVTNscVk2eUl1MGRPd2t2MlF4ZENfQVdRUmdLSGRUeG1xYXFUSXJwclZyUHZ1MDFQSGlFbVRnaDZZVEZ6Yllqb3JEeFExWDhlTUN5Rl80cWNjMnhOdTJRblBIdUR0RGZkSy1NV2xJUDhHUEhSMmhPMjlCa0JJSEM4TlgxZmxDN1ZSZkZsQ09McGVIeWl0MGRSd1d2S2tieGNIWl9fRE5ZLVBNQlZMZGpyR3lxT2JoQnpQZHZMeFpXWVU3THNRbnM1dmxiMTc5YXczX3VmclRIWGs0MVpjaDY2ekFRRl9tekQ3ZEVuMm1fb2tBaTh6NTRwdzdxUDAwNHkzenNPd0RmR0htYWF2c3dGMW5NMUN2YXhXajRINE45dVNUaV9DM1oza3lTRHlUNGdUZjNqc0FKUEJybXdSQVBpaU5PTTU3c0x2Y3dJRk9ENnA5QkdWbjFwbjQyZGRTU3A1M3JieTZEcnlwcHdDaDFrampQX3lCbTZRZnd6MElGUWJiSG1zVDNVa2RMb1dURjFSMF9sbjJtR1kxU0hHT2o3VHl1YnQ5d2xLVW5nczVMTWhVcHo3NU1LR3F6UkFnWXNKcHVKUVl1RVpKeGFPSHNmY2VwakdrcFdoMEtfWkhZUEJESzIwOFVqb3FqMDdlVVVueTBaXzJrNXUxTjQzWGJ3V0ZvWVBhdndheW1MYkhWdkRwbzdwMU9JT1IyNkt0SzdPeGlnZ0ZybGVISWNaODFwQzRCdlNzRnZsY1BCZEpHLTZxWTU0Q3J0R2xhaDRvQWplUXgxWS1YU0NLNnZLYUIwWnZHc2lIajhRQ0ZURjRuLUJqTWIzWDcycDJ5Q0tPRlpMRk5qcVR1aHJoYXNnMi1pWTNOTWdwVEQ5eVBSdjA2X1VpcEVfYjVsQ0R0Mmx5QU5NYVpZR1RvSmJTSVhBcFlyU1hEM1dFWllhTGUzQmFSUEJUYTAyeWpyVFZPRDRGNHRFR3c5MkZJZThOSk5NYXRXMFhPSFAwVWxKTXlQUDF2MVdvOUh5aFllaDFfdWg3SlRLcS1hWnJjOS1Xd0ItQXBKTHBQeGxmRzlGZkgwdjNwSTl0Z1VndWJmSkJQVjMwNll2MlNqQ0M2MmVYN3VFTUgzcXQ3TmFYcFVsNXZEVHpfMF9Vc3VlWERQcDNqV01XQTMwenFaYTRFT0dXdElMb0tEM1RjRWNVcmJONGV1bHFQSkFNcWdWdmk2YWRGdTgxU2w5cU1rVVUwaWpqMjZhZDFaeVlEUUZtWlJ4NjJYUW9ZdG81bXJ0eFZhYWtNNndqbkVPSUdJaHhBTnJoX0dNVzVxREhzMEV6TDU4b3lOY0Q5dE1MUC03N1FCbTZwUTFsR0swMVJ6Y3FzTk14ZzRMTzl2ZHQ3NFpIdEhMXzA1TjF2TUt4TE5GbkdhZmwxN1E0eEM0Z3NQeXpYdzBjcklyV2tIQlNQX0NoWE94SmZORWdyNjJOMXEzQVJZa0U1TVlCbzctM3djb3dNT09GcTlrakN1ZGpoekplRjRTUHdfMnFVWVhZRTZsNXJTYjYwUFlFSkJxdW82Skh5ZmdlOXFJX0Rzdmg4eEY1STJfLWtLT2pxU3FZam02NjU0cXVES3phQ3JWLUJFLWtQNF9DOU5OQ0xTaEVWUV92Z3hYdDhzbTRWNGNRMElDRmFzaWV6VnNuV1QtYmRQTGxBT2RqOS15RmhYVTRUYVF3YnZqQ0E2UHQ0aDNVWGdnQzNqWU5IMmJtRGpYSzhFdFJYRTV6cmJsTDRKMFZ1OGxHQVBZaGtOcGNOakNrNWhSSW5jT0dybE9aUk9jdTdSeVczR2JWM2Y1MGJKN0xLNHJjMnJCMTZuemhBdk41WXlydWdwQzdCOE9OR3NTY25ha1V1alJzRzZGYVpydDNzTDJMOW5RTUNoNE9INFF3VWpKWFZKUFJ2MHhPTF9jVEQtdjk0QWgwbWdtcFJ2Q1dhUkl5MXRxeDZHTmZ1R1Nyb0tObmtHYjRiRE1oblpZMmwxQWluWHlCMG5uRGlvci1EUmo1cjhRZi1iaUR6cGhTallzZTZrakdLR0ZObzU4WjFfaGxEaGFob1pQX1lRdlBtWi1Tb2pNaGhMRXZqMXEyZzZWRVd6a1FDWTdIWVEwM1Y3cHVCVm4yaXM1NXpBSGV4cGpERWoxWDgxWU92bnVTdXRhMGx3VkFEMkRoNjZDcmM2VVh2SEtUZTBCeFlsQWdVdkhQc1BkSy1OdVk4S3RaeGNqTWNDVWM0OVl6VW43RVBTamFNaHJ2Ni1mM0pwc09Na3JwREpLM0dPTUVRMUV4cnhYV1lGaGtLaHR2UXZkMXZCVS12b0pRcWJveU9vS1hMM29Xb0FRVnljWlR3Y2laeW4wbUtkVF96NDNFZGhNcDNKS3N5blJ3OVZtSzk3Q3lldGl5LV9HaWVMSngtWDladVMzOUdNa0YxaFVmYmkyc3FJZGZMZ0diem5uMTluTlRVUDlOR3dhaWhybU9Ib1lZeUJ6WE4tby1UWUxhSS01bkNuQ2FSSW9QTF9XSVhyWDZPSzdZU21IWjk4a2xJS19JNTlPSXlWSllrMVh6bGVwd1lPLXUwU0x6bTEtN0dKSE54RGVOMlZhUEk3TThVem10X0x5alliWWxocFFJQnNyUktsMmZZeExKaGt6Q3NjcWp2bVhDemRLVDNhNFV3NDJ4eDlsOWl6dFQ0UmtnV21fYV9YWWk0b0gwdjNCUXRSZ3NfUTBPaGo2T2Y2dEtyZU5XZmcxVDRjMk01SERJd3UxTkl2QXBqNzZtOXJWQkdPWTZFUnhfa2Y3d2twb1g5dWRvcjBCbEx4a1FCc0lwZXpUdzc1MTBncU81Nm1UWXlBUzFCUVdOY1Q2aWhfN3F4ZTVoUkVlZVB5YUpFMnhqR2JNWGg3V1hGYjN0ejVWVWJOTFpxMjBiM3E0UFdkdjJXX1Foc2VUY0JTRDY1eVFPYndTai1UcVpNNi1teUZHb3B6dVdfRWcxU3pzNzRaY3RMSUxyN3pMLXRyeC1WTTVfVHllMVZXbG9ZOTZVYUJyUktpQWU1SVhKMlBQd2RIY1p4SWx4N3dBRXdueXVOZXA2b2NKcXRwZUJ1elB0LTFaX3UyWjZrQmR4V0lpYlVEaGxOU3AxM1NkTGw0Z2hkemVqZWFaYVllRDVtTGltWWJ4dEhsQ1ZiTm0yNU1ZbDYxMFU3QlZnNVJJSXB6VUdmZ2Z5NnpJRzRLQjBMR3BISzNhdHRRUExvQ1VlTDRYNVdBUUFsb3BRa0RKOU5lTHFGdHN4cWpZaGJnZ1Z5am9ScjNPOVhzYzlJVEtVaXJaUDlyTVl0eFduT0tUck9YYVk2WVR2Wi05QUhpT3ZfdTRhOElTS01DVng3OUlnXzdqTjFfREhjdGd5cEEzVnpkbjNKdlJJQTlfbHZDV2dTSS1NUjlPQ19xekhIUmU5dENqWklDVzhwRURSYVhZOHc4UUQ0bXJicmFLTTNsWmtTNUF2NVp2WjFRTDJlZkExbXlJdmN2czhmekxRUFM0Nm0xX3ZPVzcxN05ydDQzeUcwbUZxZnk4aExaZEUzQ2RkMzRtVVFXWVdqSkdvQXZ0VHBXRmpwWkwwOERjQUd0RzVzdkU0Mi1WWjRqSVVYQ2JsemZaczl3N2VsNThvRkJLUng5dUJLby1PWmYxTVloVEZrSlU1V3YtUEVreXRPSVpfU09nZVM2RTVMTUZsOVpZenZ0QkJuWWF0bDY4NGpEdWx0STh4LXpmSHdwUEFwNk9CQVpxalk3S3JoSVJuVGRoc2Y1VUpCcmtvU1JGUFlaaXE4RjJLWHA2Nm1PbDMyRm5RTVprMUlDVkxiYVpnUFlWNnl5UXpZdEdhbjhOc3BFTG10RWkwMVlTZE1ySUxkUF9TVTZwXzJ1NU1oY0RPMDF0Y2hwMHp6eUVfTVp4YWJodXpMWUVIeXJvYl83cjFKdWNjZUQ4SlM5T3JBdEk1YXdsbEhGSFRRWExOWGJuTHdTQ2JrdHNiTGFoa05ya0ZXR1RDNFRzUlBfYTlHMVhFTE5DRkhaMVhvS3NsQTdMMzFGaWpyNFpEYjRQeW5hT1BrSlhCcEx6MGNLN2FmeFVxNWlySHhZNEQyVkdNT3gwUmc5UEJJeE1vdzN6TmVGZ3Y5dzRTdkJ5VUpQdjNGV3huX004M3g5dldiWFh3bU9LbHlLNVpWQi11LWxKVno5Rm81YWRfVEtwUkxqSGdNWURKNU9Ka2dhaEFQMmhOaG9lb0FicnBPNzVYT2tYZ3pONDdwVW1kdzhmZV9FN3ZSeUREZi1LNVZNS2UzOXRPSi0xRmxtemJVc0pET0lScHp5WVl0Y2Q4cGtPU3JQYnIzMWdJNFRIUjJHV2xwZWJCZ3VhYmppck9UTjI1Zy02MmRPWWVKNHVwNjI3MjdnbWNQWF9EYmJfSFdrTnVLaXBmdkJ1UmVNN2J1WE9LVzg2bllHSW5ZNzJZZ2lvYVpIaEJnY3pHbktuUUlkWTJ2U3NzQ3E2b1FSUGJqeHRQZ1gxT1h2bXNucmNBencwN01ULTNueWF1RDBfNG90RGJueF92dm1fM203ajBwcjBGUWZ6NWs1UEVNUG1sOFVhenFxX2xEU3djV2JOU21JbWF3OWt3U2NXN2xrOUViNTRLRTRhaWt2bVRxXzRuN3lkSDNQblI3bC1RMXE2X2k5VWdHUVFfSmk5UDZQbmszQzd6TTVYbDBpYllEVXVUV2FUdlRrX2ZjaXo0VUJXWkV1T0lLU2xZaHVBVzFQUTJPU3NiUWxPbDU4U3ZvTEYtS2w3TmNkRXRBODJVWjdkLVFCN2xKNWFCcnd0Vmx6TDFxX2Y1UGd6a2NtcW1pLVViM2tUQ0xlNjJYbzN1MmFvSnNTQ0c4bXhwZkJ6dVFVVkk3WXdTa2ktWUtNUnlJSGhuOG9xRDNQS0xMbHk2LVZkZy1VREE1RWhhLXA0TnZYb2lLb3ptRHdBZFFpeG1IcnJTdUEwWmh0eE14N0FSc0pqc285blZKR1BOSzhCeTMtbXQycnNOOHlMdHpyRXdkUzBtLW1sRHRKak9CWHJ1NmhWOFBPeV9vSWVzYmJtWkcxSk96Tkl5YmhPOWdNakpsNTBSQXVmcW1sSXJpOEVXQk9vdzdVT1RKQjgtTkR6VzVXdWNiS0VLOGotdWtSYXhhQklPcTJBTnI1Tl9hTEF2RFpmalp1cDl1RGNTc2FUOTNWR0dmQlhHX1BYRlhGWnNtd2NnamxsQWN3bkhCS2V6QWd3SnprRXpFaEdEOFhQMVh0dXJPZHh2YTRyd2ZtVG1yM1pHVWFmY0tTUm5malpnVERSVThVRFd4ZjRwMjB1T1h5RzBBUzlJLUF6WGN0Nm5EOFVQUlB1WDQ3UG1fN05mdWFVTkt4SEZ2RFdOdWYwcVE1OFlvZmhydjJlRDlzUFJFWV9CWjhXWm9IYy0tbVZ5MmM0aDdvTTUzQlFKbTQzRzNkaXotclRwWE0xUDExakc4em5XU3RBQkJxbW40LXdKVVl1UGpDV0VtY29qdGtRZEZmcjQzRUNqTzE1SDJaZGN6MkphZmpUcmxPdWlQOG96ZjEwa2RTYjBURTFVOXI1dHRIU0ZzOUxPVlZHVjJnQUxjUGtMU3R0clgwMXZHMWZLS1ZTRVI2TzlZM0pZYW02X0FwU2xONnlRbmlqM3NJTzdKc2xYdHhaMzY2bXI2Vnl6WmphajVVODlJSjdJUlY3eXBkOWtuZy1RRlZMT0FhRGU1eENvZG1jRjY4ZGp4LTZBVWpQWnBHOFYxVG04OXh5c3BTaU40M0lmLURacTlaMXFjSXNDOUJ4XzlxTHE2S3kwNTIydnBKWkw4NEdCZElXM0FuUUdKbFY2dkRXbThpcF9LMjg2NG8zcEg4UTdFWnpqc05KZ3p6RFU2SkU2Y2psTVdhMDR5dkVMa2dnUm9feVM1MWUzam1BNUFFdWpXLUJ6TXlzTjVkeUpiZC1HcnN4VFltck1wMWI0dFNhMXV1ZHBSdWl2cUFLdV9qbTBvYTA4UHZqRjJyNjRXYXZQZHVxcUs2VGUtMDc1RkFQNHFEZE5ocmpJSHpneWEtUWowY2NCRWtZbUo3di1mUWxneUxzaF80bHJZQmVyWnNCMDM1Z2Z2b19CakQ0Q1VWVWFTRkRya2U2OE41N1prblU0UkZXN1NNQXViaE93WjlCd1pmT0tuajV3bDhfemRFTDVLVDBQUm5IejRjQk01OTZGNXhleDFORzNqME80Y3JDbzVod0xMMUVwMnVweVlULXpfTkdkT1MwMG50bGt0dnNKMGFZSURuQy1SSDRYcUdBUXlpY3hJVzNnTXh3LUNvYlIyUGdPa1dLTVBJN2xFelNLN0VKcjZkZENmblhHRF9scE9HSXgtUTROdjFOU3E4VGw1dkRtdmdOXzZCOEhHbmV5bXdpQUlJZ3NpWWhfUmR0NnBrdWJLVF92aFkwMTI1WWZkck9NaW9keTFLbEpNR3NJNGxqX1dJYVRHQjdoY1dtY0stMy1NNWlZVnJUSktaR2RZbUFobXI3bkZVT28zWFFCZkVVZFpKb2Itc1R6eDdNYWttd2JEcHdQdHB5OXFQem03akI0ZC1yYmlncDI3azRTYlVFOXNFWTZVeVVJVk80Y2l5R3ltZThpOEdLY2dSWXJ3YTZmVlItTnNvcm16dmd5eGZVcDFGWDZuR0xNbE5VMDNEblBVU0JLT1RWTzVnM2JuNG1DNWI3anBVQnUwQTk5R2ZkTEJGaXg4dURwR2NsQm51TFhncjcyRFdCRmFKeldkZXNZbTlaLWk0WDBaUTh4cVZwdGpXTnI5Sm5sVDlLeDVKZXdRSHZkeXRRdHRaTXc3TS01Unc5UHJreklWd1JPZE5PVkxwRWl5RmVqM3YyZmJGRFVoRmg2ME00NWRMQ0hqU0k5eC15dDZ6LUVtQlBpdGtkcWpUT3hLam1qVV9WNzIta09tVndhZkY3MzdTcVRKa0lpWlVic002bEJoQ3Rxd2cwNi1DelR4U1pMYVgzOF95dE51aUY1S0JfcXVwcU54SGJ4TTVZN0l5SnJUcGR4MG9qNFZzWDlxWkFjTGxCZnRNaTFUSTVLMkJRSERSNW5FY2UwT2J1SWpjdlNrcjNYMmZwUWQ1cHlLdnBXcXpNbnNuQ3NsVnYyWUY5ZDZHVWFKeHlfQ2MzRVJqOXZIMnRJb2hBckh6VzJlN1lNUTRyQnducnowOXc0aWNnNG11TDdVSnVsVnJLcjdJS3FDYjJyWFViTDBIRUVrTUd3T0pISEVnVWxlYzRGajRNQl9ZNnh4SFJuekVKMVVBRXVTeDJaZG9Bd1JsSjMwRHZYTWMxcFo0NWktYXE5eV9oOFJxaUZSUlQwSktjYzFpeFA1Y1JWRmVpbFhKWXN0cDV6X1pKZ1FrSTdCQlBaR0M2bkZ5RC11LWh4MzhQN0IzQjdUUzdoWVlXdm9ETFpGSkI0a1ZGRUhvNlRKdWNDVlpJaEFMdHlfN3dreFFxdU1mMFNOREQtV0FPWUJkY3JpZzZmYnNKSVhvc2lMSWNDM3hOOGw2X1dzNk1UMXdXODZkcWRUWkJnN1Z6YUlnREJ2RDRNakRLdjk2M0k2c3ZmeG5FWWNEQ3dDalo5M2JwUGRJd0htZEY1ZE0xTGZVLTExMktBN3dCQTJWYjU2cFdBMWk2QXo3Z1N6RXhQRkZvVkNBdFlJUnBFcHh5SVBaQUVHV05zeDNpNEk2Z2lyZi1hUmFWejFXUURCemd3ZDd3TlpqV2xrRVlyRFBBZTFPVnl0bU9HQWlGZmZiQWVPaVF0V1lzMHYzVGFTOGcydk9peXRvakE4ZzM2dDQwQTB6T3pKYnlzUUM0Z0hjODJuVDdQUDJBTFdPU0RLTmxSX2M0eHFWTkxjdlhxZHFBNmpVRlBUY1FONzk4U1FRbGprcmd1bzhEcGxTZTBnODl1VHUwV0ttcFltSFA0WEtmeXRGRWlBR1FDSmIwZUl6NVZsTlAyVnFiRGRMcW1JSzhuNVlNSUtDY2ItY0FUdGFoRXU4QkxQcVE2VC1aa2t4MF93M2RmZjhVX3ZCZUFwS090SERMWUVqcTBnVktxUHhaUWczY3RJS2oxdXJPeTIybnJ5aTlnZWZVc2QzZUYyMnBCQkx2YWVWSk96QUZndk5YdnRiTXFsUW1CXzQxNG1tVGVtaGFlNktjOW9KRF9sLUxKWDZPU1FISlo4MHQ4Ql9VZkdacFZES1NubmFmMmY4UHYyMy1EUmlGNlNyQ0ZKN0d4TEhUNXJSNzU2MW1YUlV5Qy1leWtocVI1ZFZSZDZhOVQwSGY0TlZSbjJiaVdxeWhPR2VUa0hKazE0YllOUFdYTm5XSHl1VTdyNEZoOVVsb2lES2xIQjQ0VjlmYS1YMzE0c2VHZHRqUFNLdWhFRHBMeV90VU95aWU3aThJaGNIaE1XOHlFNi1Oa0lZSnF4cU5EbjAwdUkzSEhEUWtGYzFQV0RYdlVIcnBJUFRJcFFBQ3c1dkNWT2JpUmFoQVBJM2tFRFh4ZkY1S2VLMXRuS1hsZWRxQmRIc3lCUkZuNnp6T1p1UHdOWktKNHlYVDhoS2wyamQtNTlqdWpibDBmNF9WdVJFdmVQOW9FWWtTOHU3UmlBVEVHa1lPVkg3MkZXTzBzLVNJWGVRRkQzX3VvWjdrM0xjSm9GVjlXMDZrQUVWY1dURVZGRUlwamtNMy1FYnJSUVdMcy1heWVYQkNFSUxsQ2t0di1LblA2N0pyZFV0bTI2cnFlVXZ5MzdTMTBCTE53YjRiNHBvREhMS2FveGFuZy1iRjZUb29PR01UU01MWXUzaUlLc0R3Wm9kZG1WR0xyQ3FxNWJJR1BFZTNoMnc1RjFNZ1hyVEU2TmFubXpKckh5eHVPc0VyaGctaEpGeGVCcWE4WjZZWFduTXIxNDhLanNoYVAyeVpFSWV6OG81UEc3cWRWaHFRenhYT1c3eEQwSTUycjBvbkhxM1hzcV9SOGhFby1UYVdPbmY1NW1YYTNWMk81LV9XanZxZThWdzdwTUF5dG95dmh2NTVTVk9xcVdkNXNIdGhITzd0OWlMdDNFYVMxX0ZnaU8zVmVENmlvUVBNNjZsWmhaYkpZZHo4b1RFeU9SR09KbkpjSVpqVm1YSlJIbXF2eXZsUlpjdkVMM19KR1hEOEZGNHlBVE0zaGhlNDN6VEJVdk9oYlRjckhNQTRLZjhWczR4cU02QWFsczVBZzRUbVZSSnVLLUVRWFZCaFE0TEpBbEgxVXZzN3lKYTdLM2hsQlZEMWo5WXRWS2htMVhPNFJySTNrZmVxYmxoMTRHQ1NEdnI2OExyTk53SUZsY1JEY1pKalBOQi1GWGhUd25PbW50ZVItOFY0UTJVa19tczdTTm9ZUElWRnJqY1R6X1ZkQ3dYRTFmMjNocHpqQ2tnWGlsSUlNNEpNMkZmcDNTZTY2c1JHc1RXXzBBbF81R3Fqd3ZfZFBYWDA0RHJNMFI5dGljTHhLczBnM3hkSXF1M0huamxBRFU3S0c1Yl9NUmxUdWJCQ3pEamtJQWRRUEFwcUhaWktnODYyLWloMDE4bERfbFViWEwyMGhFNFBNbTE0eEg3R0dPQ3FWa1o3RVU4ekd5Yl9xWHV4RF9LZHFLSVR5eUc2WC00MHhOeTJ1cWpDMmlvVVpiM25Tam5kZWFiX19kbC1jMDBLWkU4RnhTRnRMN0RreWxpTWM2Yy1VQXBhUlZKQy1aa2NBaXlPZ2NBOVZQa0x5a2xlcGRNYXY1Y1J2a3FvTHhmS3RMU2FhS0taWEdveFd5OWp2am5KZHZfMmZDTXlUeFdOUWl6MzI5NG9mNkNNY09sTmc5VW5iaUlHb1JVX20tMHQzamNRWHBrZ0pDWlMwcmQyZ3RGVExYdUVlYU9ZTnJjZ2dPWkVQMkstc19kNUlCU2JqNXE1QS1HYU9hbzFuRmdFOEFlMDdEVXVzeTBYeVEzd0cxb3JIOXUtSUxpSHpyd01Ickx5ZWkwYmpYSm9HcVBuSWd5d29nWjdZRmF6a1ZSTGE4OTBZQjlXR2p2SEdqZ19yYmVabWRDWkFoalNiTlRveFN3bGkxMnh0bl93WkNWVkhlNzUtSGNkTHZHaGgyekwwVjlROG84NFI1NUFKVV9fNjI2REMxT2w0cXVLcEt1Z1EwMHowZElPbzMwcG5IT3hqa2xlcGRMM0dyN3dHNXZsSUJKbXVWMlBReC1Hc0JmX3lYbUhxOXBZZ2RJeXl3ZjNqSjlDcmROYXM1RGNseUExUS1Sa3MzdWtyU3dublN1ZE5OeTNCRlJ5ZkgtbHhWQmpYSHQxUUlQM2JLbjRvNmRPSHNLclc5XzRPVnBNREQ0UjNMRmpYNFM3MDJ5ZmdXSkk5Wld6TDFadk40X2t0Zy1iVHNYOC1zdzJfa2Y3dXVldmJmMkYzLThmM3lvNDNUZ2dQaDU2TEZjbFNidGdaNE05MDRTLWF5SGQ2NkhVbmU5T1Axc1NldGdKWXdZZVN6TTgzY2FUUXVqRVA4bFhEQWxKZGJ0MTRhZ2FValJkNlBNLVVIUGdGUmNtRTd5Y0k4YzNSdWxrVkU2Wk5qeUU4VkNnaFRoN2JMNTJNYXhUcVMzQWJKNUpHak9ESkk4ZTczV1BFZHZPZ1FPNnZvak0xNDFnSjFtaW9rTFNIbXNwVWRhSFdIdkNkc2VHeTZyZmJfYktmeGJGS3FNTEN6T3VKbjhxd3hlNUxJQms2djJCUmNzM1I4ZnI1VjBSQXB5U3J3bmRuWExFRHdVRU90YzdwSTBqajVNeGFJaWxKU1FMb00ydXpiWXZaVE1INklXSndEdU1hNW04MlFCRnV3TWFZRDd6WmNwM0RGb2dFc0N5YnFjZFd5SFBhV3NxQk5GSDRuYXdwRnMwQ2xZMWMwbGZQR1RnTWZJeTRxRnV5U012cHNkYWZORUdBdVFpYU5zRzROSnNJV2NYbFNFQ1FsLVhRaHF2YkpUWE03NldPVTVld0RneGRGeG5WREVhdFRlQWZZaUVEN1ZBelFNUXNFenU4VUx4VmI3RWJzX3RsUW5hU2hVX3E3RjNUVEV3VUpPdDNCeFdPcWFCbmhNdUdOdU5CNXJabFd3YVhrUTFNdGxwOEFmWTBXSF9kX2F3VXdQbUpCQXFEX0xKRncybWVBS25OZl85NlZiUW5iU2J1ME5uejlvTnVXVmNMcWZIeDIzX1JfVVE5enZibTlkaGlSaUxSMnVDUzN2d21XS1UzVG9vbks2c1NpeWNmYnh2QjE1TnFnN2l4UUV6M2U2emVkX3pQYy1GdF91ckRrR1dOTFJ1d2Zyb001REQ5XzQ0UFVvLU1SQ2NiVGp1emxqQmVjOXRUc1NRdnZWVnp3WHdNY004Zl8yWEJxcU5OVl91b3V6dVRPWkFfbkNVTDV0T1dFSXZIZmlDRWxJV3lrS0U1TUFUUVlUY3FRd0VwNUlBeDFDOXdudnZtVk5NcmFFNHpDSDJuZllsUGNIYWpMUGlXcHpUdUR4anJGeFhIbVBUc1JTM0Q1YU1yTmM5emwyZkR6ckJsbzV0Y1pPT0ladlR4X0ExeFA3RlFnNjMtbUZzTGlRZG16NzM1bWVjUEFmdkROMnV4dWp3YXFITGx5NGlLelljVVRjbHFhYV92X25VM09ESUxkcWt1S1pCZFZzZGwwX19YeDdkSlFHNG5nN3kxU0d1V2Z1NEdRRnV3azE5b1hJM0ptU0c2WVZHSW5wSUlNYjcwSy1BREliMlZBWjlVaUloMW1HNmpUZWRHWHJtMzF5b3Jnak1PUlRERU1rYnZCeTFaazVrR0E0V05aSmRKRnlSQUtXT3VNbVZOVXRWcTFWRHpkTkpNdGhaWUZHQUU5MEtBZVlaZDdmaFRSZlY3ZlFYdzhWOENmM3IxdmdMTXJyZ2JSOGwzeUsybFBLMnhMcFl0cVpRanFaREpvSjlwUHBlcHEwRF9Dc1JEcVlDVi0zNE5GbldXWklZQmtmZTRPSGFFZTRlXzNQOGxNVTFKUWlJY1dXWmJ1ZUJXSnlpNDQ1b24wRm0zVzdlYTRnUUJCN2c1MzU4MUJBZW9ZQVRUYnFFV0J0LWU4OS1YMDd1Nk1vSDVKUU80OV9kSW0wNU11VVlrV3ZQODFHNDMySDFPYmgxRUJBNG1WdHYtM2ZqeGVDRldiZHVzTWxxa3RYbXVodjBEVWdmWGh4OEoxS2JaMUdjN3cyT1E4S29KZXNGM2QyTzIycjFkdHRIamdmbHBUZlVXOGFaN2hPZ2otSy0wRHg5dXV3ZmNVVWMwUnd6bkNMbVdqd0lnZ2NfQWZJbVRpd1ljZWgzQzlpVnpLdkcyV3BfZHpCMjgzM3YycGI3SlRKbmFYT3VSSlhiM1JQS0pONGcyVXV1NnNYc1JBd2FlTnVtVVVpM1B5b0pCY3dhZFRsbVVrQ2JNcjJMQzBzYmZkbjNMOHk0bTd1UGg3VTJ1RE5EaGk1LTZaWUNYZE5SRVNzajVrR0QxNzJoUHRSVEV6RzhUeEN6Nlp4dE5MQ004a3pHVWtjS2FLeVctZFdaaFVWRENsZVdnQ3F0NWdvNUI1OEVaV2RJbi1SRTRxREZ5RlBDNDg3bk9nMUVyVmZBN0NHWldha1F2QXN5ZUhKb3dkc0RrdzZIV0x0Y2ZwQTJENHEyZ1Z2aDdraHVNMmwxSE5DdWxNOWJSXzZZYlhuTGlCMzIzN3Zjc1d2bHpBVmJCd0J3WHRQT3RGWEEwc0V3c3Qtb2N5V3Z4WFNsT19kdlhRNUdHa2pLcjhFX1hzM0dvZmlqaHpsZF91OWFROGNTek1XbE5xRGNPWncxdncxNUtaeFNXR1QzcDJ4S1VHLWtSZW1Jc1h6VW91TFdma2RCbk41Vk1tUTdJTXA1RkFfcmdHWnFwVHByaHJMSlVaeTNZN3I4bG1McW15Z055a2FMNWkyVEpIT3RWVHB2eHVzck1LMnUtSzdpbUJVMHlkQndFaHNOS1RWMXlGZng4Q2JZazJTeUo2QVlWeWZLM1FhVEdqb2FFMGxocGNPRUIycmpfUDhFWHAydlJ3TWZsYjBtc2daYTFCOE93d1BXRUJMdlROVjVzUEYycFpUaFlnM2xWVzFjSlZlTlBLRTJfYU1zS0p3UGVIY19YTTNrdDBXVkpMbTBnZzE2ek5EMjlsaUlfNTBjOW1VN2NpVG1hNEd5ZzJtSkUzVkg3VWxUanVkRldmNTZpSEZHNlJpU0FqVUFtMmtBTkNGMjFyb3ljVUhFTGo1aVlQZF90S09vcmJvRDlWRGcweDRDc3BQMmRKZWVzMVR6aVMwNU5qU096cnd4dG5qMTBBZ3kyd3B5XzUtbVl6dVJvYTUtNXVPSFhDRkFNSW5QQ2doakFudHVYUGw5REJRb1ZSMWYwUS1NdnJWQU1Qc3pfaXMxc2xZaTlFT3NDUWp1R2hsNGlxYmVNWWRhbFVZZllGYnd5dktaTGNlZndjaVdpY3EycWhpM2FxaWQ5WkVwVGRyR0FvRjItdmd5cWVsSjlRb2NfSG8xRldZdjFrVUR3RTBmQ2ZlV1FteHBFMTQyYmlZNVNnV01CaE9tVTBKWkt1c0hCV3B1ZWJ1TDVlc2RHVEJwRWtpcEpHWmtQSlB0YzBvTlJSVU90TVdZTTYxbXZaXzRTTFpqOW9kZ2U1akMwMHBzSHVYTUExTG5USDZ0R3FnSDlTd1Izd08zOTNTQnRMRU5oNy10UEVEVWc0dHpJeXAxTHQ4R2dWS09DTl8tc2RCbnlpSjJaNmYwSThEMXVPQnJYN0JGb3E2aHlkOWtMWnZiX2E1VHFUdzNKZDJCdHRzOHBWS3hhaXFtTW1WUmZPbU4xYmRJSHhlVUNCQzdXdE1LZUc0M2FNLXpYZDBfUmI4MkxJTVVVRDJadUxXb0MwUGZzUmpiYWNpOVhBOFlBVTE1WllTOVh1YV82NUZYT2xxcl9sT1RuUjd5Y0JZY2J5T2tIeGpIWVFmRGkyQmZRV0NkMElXaF9WcUxNZWozT3ZEUW5FZDZvNEU1N21FQ1lQUEJUSkFIZTNHTjU2UEl6T2xLNTRtVV9USUNpX0JKTkRXemJvdl8wSnVEWExZMmUxZnhCOXNURmc4c1hINUozYUhYY2dpYUdSaHlnMjRKZElJV3dkcXFRbmlLZWNfS1IxVTJhbEVqX2xPQTNNb3FadHk5Zzhnc2RCMjRmQlRLOWJZUnc5eW9OVWhrSl9fM2NxNlozVVFvc3VrWklreDJwVlRoTkU3THdEQ2gxbnVRYlpvUlZrN1NKc1pjWkZ1TTd1SUJRWUNVMGRIQzFRS2lublQxc3R5WDduM3RRLXZPWGRsSENaOEtmSERpR2tsemdKUkhVSFUwdU9JQUNuNGtUbkRzN1ZrRGtEZ2YxalBhYXVYLUR4X19Cdm5oWXIxRFp5eS01N2x3SG85c21rZDFNcGFUVGRLR0cxOVktUDh3MmcyNXJCcVlWQjhBZXRlbXQ1bEtZdE8yckhJNmZSSDZrLVhSM2I3WkVlSFA5MV9UTkc4QVZtV1djMUhaMmdYN0gySzgyUzRoUk1JcEItdkxUaFI2QmV4bTdDeXJHSFZqNHN3M0dtZWd0cG1obmJlNEZQRVo1UTZnNGhScUpmYTJvOUswZDI1aktwaURBTFllRVY3Y1VDUjhBVjRYNU5WR3hWdWppOVdYN0gwaU1mUjZHMmpIVkFZSmloSkxOSC1JSENWcVhxdng0ZWNSRmVxNGRqUjNBWjRITm5kNUJBaGlTSHRObkhlM3EzeG93cFduQVh4M0hHeFZKcUozZ0pVdDVtdGcyb29pYnJiTTVFVU1HT290QlZGT0k5eGd4RmZYT3dhYXNPNWxIbTVoQnFWZVczOHlXS1FqYU50VG16TjlITjFrRWFfS0JacHU0d3RGeGswNkdWTmFEUS1QbmZBV0FJalByQ1FjSjJMQ25kS2FBSHJyYTQ3WTI0dWJYd1hPNUZsSVh6NElaZzI3Z3NzTXpVR3kwdUtGc29LdnJrZkFLdjVWblR1WlJ6aklrZzNoZExLR2FMb3RPVmFwZkp5VnNidGh6T0JrSERUMDllcVlOYkFwbWdYWGdoVTZSb05nV3IwOURSMmZQV1FyaUVzbm9Gc21yZWc1MUUtc2JUWjJCb3FqVW1zRnlndjJZdVhpdTVXdFFUNGtKQ1NxczZZVEw0cGhoQy1sTEhubWs3Q0ZKVnNMUHpUM2ZUcVF5M2V6Sno5dUxyUWJKRXVVMGgyWHQtNGwzaENtNU1hQlVVUGU1SU0tWHZhVk5QM3FQUGN6NjEzZkt1WmwzV3NmZVVtYzl4OWhrbElxRlI4RE1aOFdpYnhJSG5CXy1vTnpvcGV3SXZkOU1RV18wQ0hJRlNWWV9lMDNfNlN4SDBiLU5DX1Y3MXZHNXpNTXpqUkc2WXB1d3hMVUQzQnV6cHNWSVR5ZTd4M1RSWFBxNE42aXF4cFlTeWpyMUUwVnk2UXhzWGc1Q0NsZEozN0p0R082b3pTY1gtdDNKOFJBbVk5Zk41WTRURUZCZkxFT3VtdkQ0WXdjd0xuVktKMnVYN3A5MWZjTTUzVVRhTVc4UTZSZ2JFaTlnZjg5SXl1OFc0WTBIQ0REbDE2dVhCSXdZR3IxX1lyRy1zOUU1dU9FbjVpVm9oY1JsX0RrZlNNenBsSUhPWkJzLVM2X0tud2lZMXZYeThhTWlqb2tFaTVOZnBMbUdZdklwdk1MUFViUzBrQXhGTWo3dktnRXR0S09pU2wxVTJleFF5d0tsYnJtUGxFamZ3YnFjRVZkbmZvTFhIYXpfNlhYTE1Qb1FobWhKUWtvVFN6UDFIb2J4UWY4Uk53VmpaeGF0enpxMGtpMjVmUXlTNTlET0wtVGtiWlFqOTByUnpCQ0hVaTZlNWFmNUN2b3p1T2NIdEJmRnJHVkw4R0JQMk1JWi1UTGsxZXcteFpBbE10UVRITEVuUE1US1Q3X0VwY2dJalNDQTVsZHFXQndZVWxJaXZWd3NzNXRlWEswQkNvWjY3OWxyTVdTOEIwUmRwbjM1djlPU1JOejh3TUFTNER4UVV3OXhOTzBrSjdCWHdUM1dOem90dVFFVDFIeWpEcDV0UHY2MVZuVlVDc3pRME1TaTcwakU2OGtnVm9TM0sxaHFxNUhyZlJoYTVEM2MzZDFBWnJzaUVsMXpMNU5OamktNnBpZENKVmxZeFNBa0gyc2VlZ3lGeUVVV2p3ejZRZzBzeWYtUGtCWVFaRGtKOGJsUWFyUjRMdVJGVmViUTZ0bnQtVThmS0M1d3kydzFXMUhiWUZOWHRzUnVkcm03WWVtUDI2eVVNRzNPUEktLS1zV3VEUW1VblIzemNaVGZkcVBkc3ZyRmtES1JESWZfN3hsbDBLVGtIbHEyRjJOTTBiYjlDb281SG5RdERpX1pJZmIxa3pZd1BHTDZMV1hsazdhcENaQ3daWVBLNWNmbHkyWU84QzRuX2w4eDJkLXdkclBMWGNMRi1xZnRtX2RzZmNrNjBrNUtGenozZEJKV0otY2l1ZWM0S010Sm1JMklxUm50MVpJRnNTOGhEcTF3b0ItLXVTX3ZfZ3lMMVRxRklNWE80b1dUZktOV0l6d1NOUVM3UGdCYXdIMHVIemZDeFJ1bmh5enRMTEdMZEtBamZxc3d6R2dDMnV0THcyOVJoZWtLWVNyaElGWFVoNFFjZF9GOUxfNXZyc3pSaXpKekRUMGVkWlhSVkZNdTFsV29zQUs2YV8wUGVZbFI5cC1XMS03eWo3dGJveGZGdzMyd3o2VlNWamJrMHlIUnpRYmtwNkp6QlIwcm1QU3VlU1QtcHNCSWVwSGI3S0dHQjA0ZmJvLXk2N3VSRkxKTHZlcTJua1o3dDFIRGozQ2taVGduUmJ0S0xYRVNkb3RFY0toQ1ZXaXNrTDZabURLVWJJTkF1MXpLMlJhZkJhNzVDNlVPX2llVnAweTBJX1JnT3hEd1Z4QzVReS0zdVZkc2trcFo5VGduUGhXQWlURF9tQlBmeWhQN2NCbFZvUUhoY1lKYWVjQ21jQmtVcTd3cmx1emdEWEduUkFveUp6MXlwZWNjWC1IUnlqOEFFYXhxSkVUeGpWTFpNODBNS0xtRjNXZWt1dVMxSDIxLTFYUFcyaDBfSkE1OTg1cm9uWnBCSUtoaXptUU44YVNndjBIbFlmVi03cTl1Vi0wLXFrNXVQWnljQkRDYnpUZnlGaEdzWGdKU0tPSm5PYkU0QWktMW14NHpJY3FSRmNiWkt1cF80clc5Z2lFX1pfYjBpTWlMTGlBUHJ5dGo5T241ckx1MnJhY2UxUHFvb2VrZzFuWWxCRllTdzA0eHBWSjNGNURCOTBDMHh0SzAyMEtEakpRU1VCZW52dUpsZ3V4WVMwWnQ1N3dKcnVXdmFpYUlIalFBTmRjMU1lSVJEZjF1Z2EwZ1NwVjZPbEltMlY2aTVDMllfcmY1eHJITmVlWjdwU3A1X3c1UTk5YlU4RkdEMHZNbXE5azc1eTdsR3NTMVlwc2stY2RZd0pSek5oa3RPeW5GOFZBNlcxSjkzVmZsa2Q0NTFnMGRJM3dGd05kY0FqWG8xdUMzWF9zdU1JOUl2ZU9jcWFqWlVNcEFCMTZzbU9waHVpQXlBcjNTbTltMTJMMVBvbzVVVDE4V1lEbFl6eXhNYkRmWmRUX0I2R2lNUnpFYVlHSENyQjJoaUhsYXlDdlpCNW9lbkVTUG1rS1c0dFNmOXhRc0R4U2U1ZnR0UGh4enJ4UWxieEM1V2dINlBibzdYdFcxdUpMUEVzVnlwdGRjS2lPSHczQ0d4dXA1NnVNdjhlRW50SGRHdVFERmVfalk5TUJYZXNsdnMtQTdBVzg0VUFvWE0xd0RYUFo0SVZjdmozSWRpbTh1WUVDU0dXMHlPcUo2MEVBYk9nM2ZERW1wbEpNVTBuc2kzREZmbWlqNkVRZ25hdk4yVUN0Z1lKVUUtUVoxU3lHTEY3OVlIRXhFVFRUZ0RheHNIYnZCX2NibWFwNC0zaGhPS041OXlQUmN1ZldZTGtrMUhpODg2c3V6VWJZa2MxTkZRWlBGekdYV28yUUFvUXlCQm5DS01YT2QyZzBPS2RaSFBYRUtVR05FM3A2blo1WVFCMUx4dXJhTVJCSUNqV2lHN1E2cC1XdXRpNHFvNnRvUjgyQlFFZUtqSC1KV2t4a0NoZ2tFaXpUSjFGcjlHRFZ0c3duOUdFcTBKZjJ0aFhKWXZUTkdTY2tTVFEwUzFIa0NlcVNLOXAyN0p3NHl4RTlocmFVdHYzaXl4MEhFZmNnTlNLVTk0WmpFa0R5UFozUXNLUUlCa0xweHJReGRsZ1hSV2ptMEpJSWQ3WmRiT3I0YUZPN2ozZlM2a3EwQk5SVzFBVnhRWXpkLThFWkV3b2w0MFNyNmFfaG5tUUo4WWZvYlFoTDBhZFBfWUNaT3dBc0g3alc4U0lKbGV1b0hLX2hPc2Fha1hkTnJPaFNoQ2VVYjNpNUQxRmxkak12SWFEajJFN1dfUDJodmVna25PNkFhOFJlZ1JRN1dvQkVpdGU4OEszeVdPOWJkdmZ1NjFJaTBIRU1RUm5LQVBILU83RVpMVWdzTmd1ak5YRW1jRmdmRmhmU1Zudko4Vjd1UnNmbE9NcEZkTmZzNU1KUDdEcEF6R3Q0aGRQaG14ZlBseDdqTXh4cnpOQ19GS0tvRDBwcWdJdWtTVnlMZzdrbXkwOE9paTk1QUNMREZsTnlQZjNtaUVUMHRfaHBmWFZrckhCZDB1Qk5Banltb2J6WmF5bW05SFhLTTFVSUFJN21WQWdUZnVUYmQ3eEY5TjlDNUJTZXVyVDJtYnNaY0JtWFNfa3hZTWtSWjFkSkdjN3FwVFBSZUxOVm10UURBVzZWdTZUWlpHNDREMHdRNllKalItNlFiVnNSR2NReGtxR09KQ2MyYm44SEdvMnZCSG50TTdEZVM0RXdLUXh0bVduVXdITTNVT0ZHaWVOVmRvZDhzcllzaE9sM2tvZlN1YUxIUkZiRGdVQlZoaHBFV3dUejF1VlhOd2VVN003N0R1dGJZYTFiRXRJY0hneXJjQUJTVW41dlh4cEhhbVY1RTJHczhEeDhYTmlBaWdYREJfbmhFZEdWWkVqSmd1TDg5VXltR0c0X3Z0cVMtN3hGYmtJaFpPMXBEVHZTMm1KM04zNUduNGI2S1FWcUEyWEY5amJwRFF0VFY0bEgwZWhiLUFyeGtGMkJjbnA0RUdNZWs0eDRXN1RfNEdtNzlFb3V0TjJzSW9iSFhXYi14bURJbUVId3ZHZkFsYkc5ZFFLZ1pDT3Rrb3EzUHJvY0hEMVFUTElpNEpQYU0zc1VFNngwcy00NXR5cEFHQ3N2MDhralVkUW5GbUVTYUhTYzJjSE5CUEFFX2ZzMGU2bm1fakRLektON095RkV5Ymd1bHZ5RTRsb2ZxWkxfcnNxWFlPN3lvT2oxX2FLVHhGa2ptallGNWhiS2FjcDhCNWstRUZUWVZYMzMzWG9OelJreDRnOFNWZW0xVUNibE1QOTJxb3BLUklPaWNJQWpmN2dkS2hhQmZTaE04UUt6bDJBVjBVU3lwMkdrUFRja0NrWEtXUXhhbl9RLWhtZ2l0V2w5ZVpOR3BpUjVSUGxqR3VRaVRYNlJENGZKcUdEQWNMSnEwYjZYZGhva24zMHd0Tmktc2J0RUN6NC1HV1ZOZVVBYThETl9haFNaMXAwT1MwMkRkbGVKOG1ZcW5vYThEbF90ZGZEV0xiNDg4WVplU3JwUmV2WlBJWm5OQ1lQUngxTDdxMVVGcWhfajVrQ1N3Q0VWTEpDUFdzaXlKSzluXzU5c3lUaW9DemxyM2tuTVZ2bDBZSnFYdXF2eW95TUZrcDdGdVdBbWtfYUR4eURaYm1mRGNLNVFnM0c2YlVwVXhPQVJyamgteWtreVpfcmxsa1hLUjVrTnJJMFFKYkw5UHBiWFNtMzZVSTFNajB4alVael9IYmx1Z3J3c2lzRUtGcGw0T0k2bUY1cUNLZVAwWmFmaW1nblhxS0d0RW9wNU9kTHNGRXNoa3BSSWh4Wk02eTVta0RZM0FrX0c5N0FuLUxzaVVWdG5IN2NYNUJPbHZIMVktREFGdzhkQTBpOFhPbkJoWnZ4aFZqdXctbWtHWjBITURVS0RMWk5uUVR1RXNnVEpDT1RQOVc5R0xtaGNfMGRSS1UwQTQ0RFVRU0l4SmxEYzNYWmdYOV9XdWxMY08tdjJib3pvLUhLcTB3blN0dmlPSU9YQ21BRW9PWDFodWROaUJmdktBc2NYTnE1bGc1YmtaN3dDR0xSQWoxUjRSelhDMnVsaUkyZ3lpMTFHZU1VanpoU0h5Ylk4NG5vWGpDODNJcGFTX1FTYl9WUFEyeWhMWExVdnp4SHJ4YldpajQ1a1VEMWJEZUkxOHhhQmd4UzJ6VlRVMF9FcW1WaU9wbjRnTWczd2oxMW5tV0JYOHVHUHlkUENhV2dtbFJTVXNxVXVGQ0dYZ3RNUFN2R09XRkl0LV82YzFWdVlzMGJDNzl3QnhwYy1MdENkRXIweVM4NWZKQTE3aktoclFINUJLQXNneUhKbzFVU21FZGMtTDRweWpkMS1obnZUYzZxRHBXQmhSREhieV9DeXBfc28ycERfYk12eFZ1YnBDX3FIT0dlaVRLSkpTcHdmMC1OdFRLSnAyUzloUXNQYnhIeUFlQy11ZThIMXA0WlcwWVVyWGpJRDVoS2pKRzQ4b1E2THBsaEJTWlNCa0xpczRqNm5nV2ozN0dLZEFNN01jNlpKVFZRdEw4RXZjWWNTSUlEN0liMHAzXzBIQzRKX21NTEtjRlZWWVp4TjlvSkVPZWJLUFVzbndwelVUX05KbjQ4VVZrMGwzeGtDaFlEVDVmMENoNl9MSmhSSzY3ckI0dXk2WTY3N2ZKN3RjRGFfWWsxZlotcmVpSlBRNHhMTnNOZ05hU0FoQ2tqZE5Nb241bmlPUFNhQUtVcWdDbkhsZzN5bDhPOXFhcVk1aXk0TzFlS1hHcmY1THkxV0lNX1luNmcyeFg4aF9TZ3hlcTdRN2ZOYlhIT0Ztd1Ywdk04aXhhRmJZYnF0N2hHT1pjWnVQaFVOaVdDSF8xb0MyUHlIUE1IcEtWcWdaOUNYYkdQNmFhY3J0UmpRMkxZdUZNSnNWRVhlN1gxNm1xMDZpd0dLUWxsUlZxXzZoZGtqUUs2SVpDVTNzMXV3cFlGeHdaTW1CQVVCaG1lb2kzUVItQlhrYnc0RU9nYXllQTJkSUV6a2g3cXFOYmNXNlNBdnp2eXd4cUlQT1FTSWYtMVlSRnZfSDBpYXN2MmQ0R0kxNHpDWXUtXzMwT0hqYzYyX0VMLWg4V29pa2Z3cTNXZWZNMTduN2hGSmZzMFNWNTVHY2U3UTdDQkxxNEVkSTlXc0t1MDlxeWhNWHJwUlZPWTBrZzdsNjYxa281c0VsN1RxYzgxNWl6OU1wS3RZU1RlV1lsd3pnb011clJDNktNYmZEV2poUmlldGo0Z0RkSW9GaUQ0dHJGNjZvU2k0WTE2WkNxYkVPMWVKNGNseWZZWk8zbzBwSk1NQ0gybUlwTVZPMkRueGJSSURIOUxiSEU2VE1qQjYtZkw1a3d3WUVoSHI3UnNaMnFFYUdWMDdXcFkwMUdoTWpEZXE5dGI3Qm0xXzFvcWtsdVcwMjZRUng5Vzcxa0RwU0xPNkxia1RWS2xuMlB4VmdZa3F5V0pHNlZUbU81T21fRWxlblhQMmx0bV9VVXN4MXgwdkxWczR1ejlHV1VYTGZKbVlzZnViQXBwVF85anZyRDlkV2xWc3NKdUMwRlVVNWxOUVUyOEJWSXpycV9ublJVRUJjc3BLR2d1RmN0Mjk0V2xFVjZzNFdTSU5vNG8zaVM1RWtfX1FsZEp3c3JKT3ZQS2M0S05OM1F2cFJDa3hPQ2VwZGpZZEMtbVdfMGxNdWVoVzVmcGUzRnhFMGhjeHFrZmkyUXA1Mk5VYkVZVWpPV2JRZ3UySVVmX3ZBMWpIRW9UTzRQNS1vYTBrRHZaUmxPQldRbTMyS0g0RkhwYWpiNndLTWVIOU1VZ2ZlS0dBNWVJRDRxaWwxWURONkRMa1BKT3FkeU91UGdqMTQ2WWJkZEtQdmFDOF9YS2w5Nm5BV1lfMVo3ZTNKYW9NNzhZR2pMaEV3alFpdHlSOElLRTV1ZmFDZHdYMWNPMG5FQlRnYTZPNzFrSEJkMEpGLTQ5X2FPX2RoWWo0WmVLWVNxOVhkQ1NHNGQzSFNxVGVsT2ozX0tzUGp5dk5ScmkzY0loVmJVWHkwcVoyN1NqdlRRcHFEaW5yMDBra1Q2OC13SXMxcXJhazQtcjZoQUFUeTM4S2FrUFJWYy1WMUQxUVppR3hFYUdrbUg5bF9YT2hFOEtHREIzZFgxNVNOREptRi1PR1dKSlJZNWhqZmpFWVNEVUhmb1NHTElNei01Wk5hVUs5cm42cFBMcWZfcTc1dkZ1TWRISzZhcTl3eWUtQTdLTjZyS0xqMlNfclV3RHk4dnBlbFBBTktNTG5Td09mV2U2eXdFRmFJTDRVLS01Z0NvczJBbGd0OWE4QmRKOVpsUDBUSzZEb0RVY0JTbE9VTWNJNGZXb0lDYkhwc3FnS1d3MUJXc0xGTFU1UnNSZVF0ZHhmSFNZdWs4azFWUlNhQnZnSEh5Uk9NemJXYzhSWmJCVjlQc1doaEpMeVpMM3RldzJ0RkhaM2h2U1A2SUVidWpxSE0tYnRWSXFqb3BEOHFDMG90YkNERnNqdXV0bFdVekgxTXhNVFFGdk1KY1Rfa0swM3NOSVBNTnc1MVlrQm1fV0hiQTNZY1V6d3BPd1JNNnQ4YWFVV2diRUkyNm93Szlhd3BUTzJmVHVncjdzNTJoWTFBNVRpMXRobDM4TU84UGNfeTFyYWJBeEVsMGloTUw3VlRFWmxhUml2VW5JS09ORDdXSXE0U2RHbjZzbXJLWW1LUGRFNy1vZzJfMXVhWkJyblRScHNrd1FiZUVlM09tT0lRUjltb3ZmNkRCdlZlVGtieG4zTHgyM2hwUVRRYlpFSTRORFFHMnlzTXcwSnQ4OHl2dEo3NkpwSEFYbWhkZUpBNWI0QTBYb2JvSW80a1JGTjNlUWlCQlB1eTVsZU1qeEZnVVE0N3Y2M0pyNmtibXpfSEVTZHowOGhNeUozakN4Q3ViNWdJVGhtbVdkQ1lIUjZRYjRtWlowMjhIT0ZCNTl6MkY4QVVENXNwU2wyZmhKZHBtUl9aZ1BsaVBuUm9YNGVPU25Dc2ZLTW95X1YwNk1KRTl3VGZPSXU1ME40cEhoTE9qQXNUX3NCSHBfYWJMb0x1ekpJZXdtV29SRThVR2xWVENOX2hJQk1pdWI1V01lbDgwa09nbHJTNXRMZnNCdW1qTTZXUEladUpjRG1jWlozdXpEeFBkRWdHbFZydXE0ZmpfMFBoUF9uNS1FcEVtYTkzZDFaLURCTXU3Wk54QWYwS1ZBOXVJOXZ1WFNQRDJOVmRpMG5QRFFjbFRCRWhKYW8wM01uc1VGbkxBNVZqQlJnQVV2Y05Cd3ZlYzRfOE9WMDJLRVRxZ0hMZ2tzbkIxdU1jZ0cxYnVQWHF5cmJJelN3WGJiTFViOTFWSkZERl9ZNGFTWGhWR0kyUzFpdGdZOVlsYzl3aFlJYU9pQy1KcTNiRUZiVnZiZnJnemMwOUtiYl9ya214ZjFpWDVRczh0blYybHpSaVB1eExibGx6dmlEYkM4ZkpMRE44VHo4NExMa0lMZHNmdjBHaWtkRThSelU5cFNnMVU5ZURUT0RnVktDRmtzaXdJbEJ5MDRqd0d5NnNwb1BudUxweG53OWhKQnpUc0M5dVRUTmlZeUk0SmxpdWs4Z3ZpR0JTT2lMeGNiRVlXTGFpN2NNQUYtcnI4VTYya2hDYlZZVU1mVGhnQjg5aklmNlZSa3pVSGs0QXVSR1k1QnpraWxBcDhHeHg2M1RacnVXR3ZMa1FKek5wNS1PVGN3V3hEN2N1VlFULU5icVNZRmZYMnZVcEt2Unp0WjNxeTJOMTRIYmdIeUZMYnl6SVVoTXdiNkY2M3dwcnlIN0hfMHp3OGRfb0N3bWVCMVBTQVBUcFhiYjhRZjluQlRXbjFCWlBMbUNVc1ZCaUFYQV8zUWp2SWkwUXlrN3gtb3BGc1E3OFdJUVpadkhsb0NRNWI4UGd0bVdaNUFwVDhPc1dXQU1sYkFzdXRLdXZjTFkzbW9DeFZIOGxzclZxOHVXSjhlQzgxUV9uOG5YNGFqcnZiNm51M2ZXTXRDNmxFeWwzSW1JSHRHd3lvVVZOVW4xZWlBQVpnYzdiQUlnNlBoV1pxS25DMkFyU19lbEVheVFUd0ZTWWxrM2Zjdlo4Z3RMOHB5THY0YkpEalI5NUprM1g4NGJEek5uSndfY2o2Y2Fqb0F3WW9nc3RRZFRnd0pqTU1WaU1Fa2hraVE2SVRUU3lDNUJmOTBCa2VXbWZwM2N3Y3c2cThwMG5NZEdnMjNDc0p4VHNla18zbFotRS1KcHZESHJnVUV4d3g1Z3lCVy1STjdrX2xnaGd3OUw3QUNTbHdGb2pHVzlZSzA4T0J3Tjg4ZEQwLVlmMkZSRmFnaFVQY0RfWXhmaC1qNDkyaGY1SnE1WWtyOGJMZENiZjdBTGgyeUp6UTRoUGREMDdnNW1uNThnT3ZMUWo4Z2tvTTBfMHVGOHBRaHpqenRjVlRaM2NBNkZobEI2a0Zkdk9OQXZVLXI5YkpFb2NOaW5fRTJmb1B4VUxqOVdEdGxaX3N2bWtEVzBjR05fRWRlR1dKLXhLcTdWNDRzck5vd0lCOEprZHE4dUhZXzFadVg3bWV6MHNYc0lNSEFFSWhkSnBJelpYQzVjYW9lTDRfalVxelB3dzJzMG1IU29CSlpQNjNWODhFQVpMVkdtaklwaC1PTkhQeU9QemFlQ21xajFlTVFaODdJSGNhYm1yUGNaWDFITTVvRi1meTZ5RFVzdUJyRkx1dmRyX0VJQ21TM0sxWEZmWVhsMkZCU1ZsRGNpUDJ0YVF1RzR0dHhjaWhoRWpERDVDcEZ4S2dha0lRSWc3VVFBTy1rUTN3THZHdW5CcG4wVy04eGpWRFBoU28zUUNOc29sNF9zWnFqVTBoeEVNTVo3YkVxTzNSVDNTVW1OM3RjdG9LWTBySzBxZmR1bk5iSXNjdG5TcUVPYzg3dWd4VTBXNHlQYjBNOEoyQUwySkV0bXlRZmN5RTBDalkzVjVZMjNlN19UVV83bEk5alBTbnhvVi0wdUhCRjZ0Z2xYN3p1akdJSG82MU5CMHo2MHpXZ01hYklqd0Rha3dPYXV2Uy1yX2RqbEZpeUUyZlJvQnNPNDN5WlI1OGJqcHhpRHJxOWdnMEtJcktBQ0gtWjliTUdxeFBIbHVrb1FGeHAtMWszQjdndE5GdGh4dEJqMng5Q1FBVUJwMFNZYXRhUmgwVlBPRGptMWhLd2FUTnUyNDlxZW0tbERiNTRhNFplaGZqVExkS1RoalFiMktwY2FCbVg4ekpQbnRhVlA2MXdDeVRGVDBSN2RIVHloZUhfS0NYbHA0WDN0ekdoRTg5VDVVWjVxVEZJWmNDR2I4YzM1c0pjYnh5bWZ0aUJJd05sUFRlbkNid3dfQXlOUWhreG95Wk1iai1lQ3NBN1M4V3FaUEp6ZVozWE5iV0ZJeS13S3hFMnVyTTJKRXd4eExXRllwOFQ1cFBQQVF1NG1NT0k3SDlfNzRTcWpMRFpCU1Myd3dUdU1YZW1aSDJuWVI0WmdCUF94UkZENzYyM204ZzRuLUdNNGhibVZPMW1LTllJbDlHdzljbkpQOHpSSWlNbUppWEdXTjktbjRPVHFRWExFVnlKbnlUQ0RCMzFTSFctTThyeUJMemEtOUxOdFZhUzVTWkM1UG1vem9EMFZyY2hFVEZmelhwREJfZGYwNk1aYS1icEpBQklTVWJidi1hM0Zobm9JUU0yRW1uT1N2Rkw1ZFdDRlZMcXAwREJOZEVOS0FiQmJaNGdaaGNEREVoSVQwQzh4dWJ5MjN1MW55ZlowRld0WXFoTTh1TS0xVzVOTlNLZGkwVFVhQ2d5OHhBdEh5Wk9YeWgzVFRMVTh2ME1rbjFRRjh5ODRsOVJlejE5VTR5Z2JqX01CVUJreGYtNnhpSFRVQkNpQmN1UnoxM1pSTkVMNUFzTUZLalQ3Y25zRDJxNS1fdDk4dEZ3SmNQejBTLVctbzFtVnBRSkFjZWZ1ZXBRcUdvVzdLNWIzMWFCVHUwWVc3MTZCeW1pSVEwTU5VdC1Cbnc0VTZtdG9wWWJVRjExVXhSSHl2R050dVVUMlp1MDFJSWlKTVRvYmxoZXlYQkFraEVUaDJTXy1Cckc4cG5oZWFZaE94a2wwZE1nZy1ISlJ6V0RXSHJTZ2tUN2plaThNNnhOY0Nwc19veC1kNkdsX1FwYnRkRGZWaGQ3clRaTzhCNTFQSVN3Yk9aYUhkZHotRlhUZmd1c3p6S0RwZmtSWjN0T010VFJ0U1ZWR2t3eG8wRWdfQW9iRVJSNnBBblRfN1hZQmpFWl9BSVVwQkhmYldjZENyUkN5YnR4b2VUU0RvS0twblJkV0E3cnpiLUtDQmVzNG9mdWhicnNldEdWXy1rT0dLc2FuT0lPbkNPQWdHc2VFb19NTnBvZVpjWmd5QlRlaHFmNXlCQ3FZN2FmM2E2Q0F0V2hfSE1IVzl4cGk1TVlZVk9sRVBWWHZHTFp4bi1xS2hzUDVwM0g4a0VHam10d21CWGFuQVhkNE1HemZtWnA2UkZ2d0VIaFJHNFJQQkZYSkZld3laMW1oSzZZVDZXYnpuUGloTC1PTjJPVnJEc25CSWdEUGVtclpnaVJIVWdnMkk0MXNnX1RMWTQ2N2NYUm1JZUc4NWpUTmRieEhkRkt5UWhNS045UUVBYXhDTGJsaF9FZFF1LWJtcnFfNVZoRmIwSDlocF93S0M2bFlOM3BFR3ZsajN5QzNIYU1LTW8xSVlBTkROcmhGM096U2VHUS1SWmZHeFQtZTNwdmRzc2ROTHE5XzNrdWdGZnB5ck1GY01iMkl5MFk1ajN2bF9vNTFvLVdiYUN1Wl9KZEZfb19JZV9zZ1ZnTUhoTVA0elIzRlBEVjVjVUR0bEtWWldSa25XMTRaZ1hnbFNRRG5kSG5lbmpqR1N0WkZnelh6c0FqX2xibm5BXzZnS2ktZHQ5SXk4aW92cFN1SzhTMmMxRFdqU2xIQ1FMS2tCdWR0REI4RFRaYjZneHJCZ0piNEpFUWp1LV9mUXlPR1NOellNZ01ISHFiVTVVbmpxOFVlQkFlclNnQnEzTWRza0xRNjlRVS04clRZbGszVEVLeFQzS3hhTUx6MmxWTkZSMzRkUDl5Zm9HMnZvOW9PS1VEb3VUaXRwNkdhV29Vdm5jWkdDME52bktJaUIzc1NiQ3pOWFdWbFpDWDhWdFhRQnB4NV9USDNhYi14bUJOUnVQMUZ4dlExNERsanZHQVBOM19DcHhxaHAwTmxzbk9xNzlqYmV0TmtqVHVrUTFZLVVhS1lUVFZOaTlQV21CbWJJTGx6X1FfQ21lSml1M1BwVVUyM28yNHlkR0JFTzZNZFg3aldMdHp5c1hxSVJyV1JUS0g1dG1rT3VwNlQzck03UGotb0NNMURacGZHdFUycU9aVW5hZF9TNGR2V3RBT0EzMVVsLU1DQjlLLUpHZEhyU1NKS0xoODNqM2d1ZDdoTUswVFJmYzVXLWdaZzdiT2xUc2EwcTB5anVKTzAxYmZQdjdQTjN2cTRkT1RabWluNnBJMzJSbzBTQU5NZzlBRkdvR1g3TElaR0Y5bVRMZkZGbkJTUlctaW5taW0yRW1NR1piQV9hNUdvTWxOamhmV2JvLW5aNHZubkI0M1NjZlNwZnI2LWRvRzd2VUZzMHlPUURuM0VvZF9ZcHBwUUwtLWtKR3VlYndlTVk4ZmdtVy14NktjRENjSEl6NU04MzhROC1KTEpPNzVLS0ZqREZGa3JtTGZfTGF5ZTJuekpKVGxhN0NnMUMyWS1kMFJGZnd3ODRHb1JjaGpVS0RPQnlFUDVlNzRpcnVSc2hjQjl4QVUweFpyZlIydmdQM2gwbG9UYjJ5UG9wekVwaXV3N01XZDA0eGhsMWhJUm1haXloRFMxc3R3WFh3aDN5SlNuWE5NMngwdnY5bGpQTmRDTzBiQ1lyZVQ1SXY3eFp0WEl1VW5jaWI3eldUQWZNZHM2cXF6Unp6Wkx5YXFTT0JrQkxJLW82R05SMm9PX3F6dTZteG5tMlJGOUlMcEdxYnRnZHhYTTdScVNkNVBEa1RfVjhrVzdOOXlfTUJuc2RpV05uelo3WndPNldrUlNvbkJPc0licVFVS3NXR1dUZ1E4ajE4dy1hd3hnWVJNQlhrY3lEakt5S0piMjZrWjhnRXNlcVQtM3RPTHdFeGM5cjh1MEtLT1M5YlROZDF3YTRFTWZHMEhFeE1SdmdqQ2N5QTlLa1pnU3Y3eTlNRm1BS2k1M3FXNnVvRHRfX1Bwa0lFLVpqUGhLLTdSa3Y1TmJUQnI1bmctTlR6ekFHc2s2enVPdnBpU05JSWxBRXNlUUJERWNES0c0M1Fsa0N0X3g0VmJ2QW9kQk9lTVJpZWNMeTVtLXo2SVZyME9xX0Jnek16ZW85Wl9xZFhWdFZobTU5ZkhDek1rcEM5WEN2dTVXaVU5UzhsV3Y0VmM1STZXa294QW9vZ081QXJFVVV4T3JsMzlma0ZpR2FvUmNBbWM0dG81anhUUjhuWVJXQ2tFdUQ1dEoxcFFUNkhpaW9XMk1OTXR0OExMTTFpeUMwejI4bWFlcmdBZUxGQ3pTODZ6QnJybXVTWFJEQlhhaW9DWGM3VkoxSEtmSUFYcDY2ZEZ3RjhRUkdUOE9LMm55dlZIMzlvRWhSX2M2T1NiRzJvYkxTOXdWM2RFSUFiY0RhR3hjVUpCU1JXeTdUR0ZhcWdhemlwRVRnejF0NThlNUZhS1AyUnoxMHV3LVRHSWN3VVJtRXhlSzVnbDZJWWdMVThKYmVNdWtpbTM4dVFXaklVQXEwOWhva3RsRFNueG8zRFg2STJjdFYtRk9xYk9rX1dLRURHRG9aRG9neG84UFNELUJWeGJrQldRZEwtTUNENUpzblBGRjZhLV9BdFBaWktKYnZoM0t5bWQwNXVfbk9qTURUdXFKU0xuNUV4MjFPbXAzQW9WZlpNYVlTV1hzaXpOWU10cEVReEMwbWp4aDFFLTNmRm5uOE9GdzVnTXFXNXN5d0ZHRklYcUF5MFlmc0Fsb0ZBTkstRVZvVmpCbjY0b0Q5X1NsNVBwZmxFZVlaSFFRS09IRmxWazVwdUhlZHdpckNfZGhkdGp2TnV2ZlNSb1BLU0VJWGxnV2owRHRrRkFiaXJkd1FNTFBUc21CT2pOYnhSWFkzVG9Qd0RSZGo3eC03VVJxY2Ftbjh2VW9UT1MxYWE4WVRMNm5FNVhsVHpuOW01MEh6ek1Rb2tnemcxQlFLSjRsMFJkbWw1a1RiX2tTRm5XY0hobHp5UGt3RUxvZnZfYnlBN0lSXzV0d21LLUZGcUVsYnE5WW1IaXNrR1BWMlpHTDFmTDFGaU1RSmtxLXNzeFlTNjZJRVZ3b1pCaGw4dUZJbnVidXhFeGJaSEpTX2xQY0pLTnQzcExWazJJSzJpc2duVFgwTnlJRWNzMG9pdDlfQVRERUJ5OHZwWTYyTjIxYk9la1lJM1o1Q0pleFFpVTc5VU1wektndTJvTGlaWnBaeXJ4TnVMa3BWSzJpT2toanNaN3gzNDhRdjBSUjdRN3p1aWM4b2hnbWYySUs5cjltOW93MTg4MlpRNFlETTdlOGlxc0t3dkZkOWZuOERlcWl2cmROQUhRcjFlQTZnN3BVSkpZZTNiUDJKLWpGSnN1azQwWXBFUXZVdGFaZjF0cUpPQlMtWlhvOE00aGEwUE5KTWx0bFhmZGJub2x6aHRnYVF5blR3WHJBRTBSZmtnWjlMaHFtenI3ay16TWEyM0t3UHdncDJmUGgzSmV0Z202Nkp4eHBnVjQ2dVl3UTVwSUFibll3MDFOTUxFTXlQaUNySlFFRWtwaXo4WG9hOGtJMkdRdkh3b1pTYlMtNzFZcHMzQ2oyLVZkRTBNaV8zUnRJUEZyaVVTUERfS2cxQ25pQlduN0IzS1pUYjd1MFFwOXl0VE1TdDNRbUNwcnR4YlktVWFwWEtESUYwYVVCN1RPaDRuN2lFZ0pQYzV5M1A1LVZkQ1VxUHJKS2VwckUxN3AzMmFyWjE4VFFwZE5rRHdXRWJWZFlMZDNvc2tTdkhCMHBmbTFablpMZzNpSGo3SmxFX0VsT0RIOVQ4MXRBS3ZyUFlzZUJsWnZQbEdUbDdRN29XN0tSZ21zVDJHMmlqOW11RlVEWEoyLU9ycFhHTWFURGxpdGNhcmpXR0tjMXFJRWhzQ0IybjI3LUlDX2FnbDdHbG4xUkdCRC02bEZGQjFuTVBWcHJpVGljQjA3THJZblNHSTVRdzFpY0pYNnV1TzYyOHRTMEh6Z0llUEdRVzhPMEtyR0xEZkktX2ozQkphbEN1eEpMeW5sdmE4MDVaWFZ3RUdCcEcyaGFOSlVleXhJeWFSamM2SGdOZzNHXzNIbFItWXhiUjBfSmtEODJwczhfd1VmZTBGOW4yYkUzWEVNeEd1bm9rbWdWbTdxQ3I0TzNxQk1HZ0dvN3ExNFRVTGhndk9GeXVZU3BKdkJ2a290NVptZS02SC1idVYySlVjNENQYUN6Y0pFSnB6QlNmTnk3eEFlQmNvbEN4Q0w2MzZDZS0yeUFGVTFFdjJ0NkN1U1BHZUlyY0RrRlUzT2RWOWxvRVlJaG5nNUdEdDdXUjN1RDJsRkh0M1dWLS1ieHkwSFU4YkZmT0c4b0hoU25NN1hsOWtGR1ROWUVxUndIUjk4eENYeXVlS1ZEMHVlN0ZPNnotY3dxV1NxX3BFb0ZUX0V4OFlHU0EtS1k4N1RCRFY1ODlYSEdMYW05bm43RXJybTdNc1p5Znp4V0NBb0U4YkktX0hRN3dTLVVTc3JuZkh0eVJCVkRMcHRSUDVXWDhTSW5jekUwbTFsZFdRUFRZdDFZTVdld1M1Wk5GWll0SFFVSU9FUzNRVlZ5dWlrcXZQczBQWE5Db1p1ZUJoVVViZlVab0E1WFpDTXFYWVdsQnBUMzRVWkRTV3RxUnRVcXhjZlk5YmpvNzZWNjRfSFAxUHJ4V2NQMFZFVi1QVmhxTE55VmRZd0VsRTB5YnlyWlNsRjRwVlM4VTdsd1VlS01UMnpHNWVDLUktakxpUEU5S1M0eWU5WEdtZjlVZEZjd1V3cXBiMjl0cVFFdXRUNFRmUU54elM1dzFqblUySF9BVmxvNm5LZGJiLWt5RjB5WGZyRXB4VHJtR1VSZTRqMEVzMHBXbU0xOVZxY05yeDJDczh0UDlGTlFxNlptQnJ1QVY5ajE0SlpOdUhvY1ozMmU3cTdsN2tfcWlseEtDN1hjR3lRS3U0YlpXdS1qWUEzdm5OSDVORnAyaEd4aWFLVmRka1pDQVlTUnBqMHVNZ1FuVGNEUkppTTJoV1piaGY0OXBUaUVwak90dmhIbHV0WDdYdmpnTDVZcWtVRzNBbUZVelZIOWs1QkFpUXo2VUtwVVJjUFVNUnFPTG5fbkpMd0VsY2xKUE0xYldZdEhZNHNTdzl0OTMzSjZxdzdENFdNRGJRLVI0QlJubkxwNUZZRUtSY2Z1cHVKWWtxV29xd3dQUzc4b1E1UmZfSF9VbVlBZEFOUXhsLVU0MUw5RTE1TEZqaFBsMUZObFhNLUp5ZVNJNjhlbUJ1NGNWY1l4d0oyMGd6Y2NuSWs5UEtjdXdUWE1IUjVIMmNtZENxRnVBY3lYUlJCaGhGRVBfNjFmbmxnRjMxMFZSdS02c3JmOVhnTGFuMEdtaVNZSC1UaVpmcUFrUjItRVlvdWxFUG9UWUw5OUhTekcwQTBveXhpc2YyaER3Z1NxNDVpbjJaTU9BQnRrNGpGT2ZKQ2kyOVZxMkV5YXVOQmRodkFQeUVzVHJpcV9ydHZPN1phUUs1Ulc3QndPZ0RsY3k5b0ROcmVfRG5mZm9jRUNmc3hMVndab0Z0Sm02eUpoNmU5SDVTOFdMcmF3MEhDTklaR2QyaWNTUTJEMG5oMjh6b3JSY1lfanpIYjBwX0VIZk1iNjhxa1hoQmREVE80ZVQxeGNtRmZuUXRCQnRCMVJYaEd6cW1MRlhTUXJRRWxHWFY0czZxNWFYRlJQNkljdGowQk02VkxHWXVpOUdZb3YxZEVrWVRaS3Y0QUtnQndySWRGazl4N0hOT29YRm8yRlgzY0hWTUpWU0hzck4xY00wekN5SVNGdDNkaHB4TnVsVHY5TkdfQWZmUUg4X3NQa05Ua1R6clcyRlM1RkZpTjVrQXJLeUZRRGlWNEZHZTRxWE5WbFhfOURtLW1Hdk03Q2lPWDg2Q3Z1OEg2c2JEckxFR2VxdVJFSHdxaE9DYnR1VDljczNIYlBsbDlvODhxTkw4TV9CSzc3aUh2a0lSQUc2Qkl3Qkt5ZFo1QUNpVnh0NVhIZ0tEUE05a1VaMTdLM3FwYXFUblk1YWw1QjF3bXVYMkwwSDVGckxxQjJTTFBPUE9zcU1RTlNidGExQXBkai1KMm0ybzFWY1JPaGhWeVJza29iLVNOUDd5WGJrbGlUOWJTSHl5YzFvbzFXcTZKYnNZd2hwdVI5aS1YX1cwYkc5M0hyYS10c2pvYmZPYjFBeW5sRXotRGpqZXl1eEt1UGVtLXVvRVlTWkZfbXRsd1JxbVNFSkFwWmlxQms5VHFTZW04LVBCZWxRR000MVhBOWtFeHc3cm41anROODZEdTdUX3JvRnRTWGxpakFQUm44ZTI4XzcyNEwyTWtrN3FPREpLMkg4Mzdvc3J5bjNXRWE5MW80OTJuTS1BcGNTZ0pfUUEzbURqUTJtaHZNVElPakh5TFRCZlBjaW4tby1UQzRhc28wdmpJUEhLZ3pUeE5oWnpYNHMySjFSRF9ldW91cHhfNXhocDdCTDZSTWt4eWVMd0o3Y2VwZFhDVmNmdzdzRDEwQnlyVGVtSnVoT2oxaWhrc1lVUmdEZFI4M3pweFl1Sk11a0ZqbjlxbEQ2a3c5YndNWnRpU2h4QjFZUHNuV1daV3U0TXFsVTg3SldZQzlEMzFUdXhiNFltYndsd1RsQTV6dFBTS3diTk1fYUI4aXZVUUhUazBPdFFwcndXMTlCdU9FbjFtWnpBYnJ0WkUyZ3NFQ2w3TTREWjZWR29nMGtza3gwSUlDVks3WkxEQmZRYXhIWmxFOFk2SGFCS0JrekhKSHE3MUNfcnMwcEo0UWZRV1NiNGdkRFpIeVpWY3JaNktPbEZsQTBma25LdEN4YnpjM3U2TUM5enFXa1ZYWWZZeWVvM1JSNUg3UVJZaUJqM1R6SjJVMVF4U1VqQjZyU19XeW9vWlhnNHNyeG5QRWdKak01TTdfMC1yY3NWVlVVdVNzT2RXMXFybjRlSy1Kd3Q0elkwUHhLYU5wZzRkMTFLUURIVXJkRjdPbnd4UmJ0NktLSFlGYW03UGh0ZVozV0dGbnBIbktzdHJYOVk2bEREYjBTLW5KQ3o4ODF5cUhUSmZ5YkhfRWFxS3R0ZU5ub3dDc190Nkt4NTVBS3o4c2VaU1psOXJnb0k1V0FrVkR5YmlfSlFFdTJnZnp0YzN0M1hCMnlTVDg4bl9BcDJNbU80X0V4QXBoVEpfNzdrYmJvWkl1Yll2ejA2Sjh5ZjR5Mk1yXzgySlFLVVBQYWhuNEozejR3eS16d2EtaDFLRkkyZThQTDZzODF3YmZ1QndrNlBHNFItZWg4UVhybEJrSXVqMkJ4eGU4VUZ3VUZONW9kbzY4VC1SWTF0bVdPRlZndnpDUkJKc1Zjb3htLU1CTGZsdW5XbTBVdDRvd0F1MlRKQ3lUaTRpWDhIM3E0X1lQTy1zMXBiQnRRaU0wQU01azVFNkdoZlc3MS1lQjJ2cHMtMjRORzE5R2gzTEhvTzNlelJtWmhwX3k3QXYxV0I5OURrbmJ6NXZ6dGxwcW92Y2hNNWRDOFNQalFkMDBDRW5NRmtwaVQ3SDZZTmFKVG5BcnVoanhTU2RKLXUxSmdGSE1ObzJpNEtfR0xxY1BlSGlIaTlPZDM5S2NGdVNQeHAxOV9wc0Z5bHRzWVp5cXhoNldJSG55bkRvdEpiOHd4dFU0bk1FMWFvazFZNk9yc1FUeGFtNnBFQnludFljbzFoLUlhanZHSGliWkV2UGdLNjgyc2RoZ295RjJ5OG1na2JTNWxHVDd6U2tYWm0yeUZwOGk0X0tVUnlYWUtqUndFZWdKTmktQ0gxWWs3ZHgwbExOaElOVzJEWkdyN3RFd1dOd2tFMzFHdWwtaXZWZzdGMTNMN2xXNW9OWTk1WXFXQlh0RzBsRHVoUlduSHg5dTNWV0twSDFmT0xDcnVIS1VXdzM3MmhtX21KS3U5UW1tQjNrWDF3SURXSkQ0SnFfeWlaekMxWEdIOEFzRmJfOFhtTGo3YW1aUmRwRFRRSmV3WlE2NXFJem44VEx0ekFhTUktUUlQZXJDSEZmeDFYWW81ZUpWdHc4MWphVHFRQWJCLVZ5X3ZXMG4zNXhUVklEOGdJUlpYakhRVEg3YTgtaDY3ZVFPdUNtS00yR2NZQjlFSmNRLVRPdUd5ck5Cd0lBckNxSGxDSzF3SjlPZjFYMjQ2cjY3dnd6MkJCQUdRWWp5dF9yZ09PcFFadGthV0pMd25ncXEwRE1pYWt5cE5LSlVJbEViX3ZkUGp6SFFKMV9IVzlMSFB2UWVHUmVJRTY2YzEyWlBBTm5tcndDaXR4M3hzcWNJZVd2d0Vya0ZzcWMteUlZbFd0V1Y4ejVmdklMY2JvSWRxVTJ4c3RqR0lvZDhudEp3RVRMeDJJQTZ6TUZHZ2E1UDZkcVhiMm85TUtxT3U3Z3UxYzBUaGtjVzB1QUFSb1F5ZzhDcnMzX0VfcC1YRXpCZGVWNzBIWUhXNk5CaV91OUVfLWVKVm13Vl9RcmJxanM4bEJxeEhsR1ZyUHVIbjd0ZU1ncXk5cjY4b0c4RVZRRFZUV0tXYWZ1U3Q1bHJpWXlTMlk5QnFqbXduUlBFR3lqTzJtLXVNRTRHQU84d0s2eFZVeWF1emlRQ0FyLnN4blQ5QmJTbklGT0RKQ1Y4WGR3RXc" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/BackupKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/BackupKey-example.json new file mode 100644 index 000000000000..41845a460198 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/BackupKey-example.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "key-name": "testkey", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "value": "&AzureKeyVaultKeyBackupV1.microsoft.comeyJraWQiOiJiNTc2NDI5Zi0yNTY4LTQ1YmUtYmZhYS0zN2VkMDdmYzBjODEiLCJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkExMjhDQkMtSFMyNTYifQ.YMIP_MrQq46_fpDL_H3RJJsIJ-3NhyBd1yk9bBKNI8ggN31ah6qehcPHHLgJrx8jkBLLXPqp5f1zlil_rUk-KkOryc8ZI9cssM5_Sy3xpI4Zy6WIc5cjPWuGCCmBpAyrtGOVzhjQxo3rTW1DSqgZUvr8TJly2PKrviI_RgnEd6-RVKuuVN4efVaK9XVTmn1vfygzpTr_TWC9PFmzhOJzgU98_9_nVrWVHNS1uLXJXnWhAOfRYtVRNEQIENeLc-g3cMrK91s6NWxNqfF_GL6Px6qXG2WWCOg357fBgOVStDKiVH6N1MedQ5piadxxTT6LHZokB4x1JlAIfL_bU69PVw.F9Qb3tVlMKprCKK-YEi82w.T0MQiauw0l9Mb_DWDcXoo1jN6IYu59Y7SEL2mgtU0x3XL9yTsjeF4cb44LAh_oP7gmH3n7J-VD_xJ7hWcMW6yS49E_M9iygt9SCl9f4Suki3CYvL0QERTYKImj2-AFDLZIwNmGba8G8axPqGcNKsRgGZgYTToiYLqBryrbvLJudCqgjeQdi5MmtyPFpagHpHvKkucFGp-XmJ1KbO2A2QOWQTQZ9CereBqrCn24IwaQrUC4rND2w0UA1TcwEeuVBGELdJZosXs6CGDfjZHqcvpz74Jwx5OEiq_DPs9TKrkMhowcEplZ8ZJMcNQRfu9J89d7YXgGdB5ikJzp5ZV89w12b0zCHNYJjgddHS62fjVeaE1OOP_7yfX5tJb6d5AXigr-JJ3lb7cba9q64plbiarMKzab5Hm2LMFuKBr5Nako5P00hQBgGc6ipIK8MOcKsdaB2Fr50_Ub6rDS086u37-CHtFFqy-1AhiCixQjCML_kXkI0vDbbjF-_xkMdaBV-Au79O6zWjsDeeWKtUvVQnB0c4By7IWCLeVw22i09Yi72zBqfOF4rNgxU3kJ7_-5boWmyYW6wM8esN4xGY3PhU4yKE_uDg6vNNwt5scWYoS0xx6PCos8KDtcr-UypQ92thU_FXgq9StTYq2YgVWGPns5CDLODAJ-l11I6IitlP7HhyLo39j77iWfTKDgL5kp7D9E3_qdPZktjVPDu3ZQcT739N2zz_1kXrDom-6PPqwVS6mQzAUmqixSivcqbqjZIFtOllKFA6qerh2eSAYzTMSCuwJxDBRB5-n0MQlIHjC17dLZhVqD1Sb6Prq_y9sv2ivWq9La9GfGlHA6VY3T3QdSCukYRjXXq-B-NnVdhFMValVvosrJfnHFaXfLi0gs5U9Ku4yjD7QoW1yR1IY9OrZ4qRQwkpnm9O2rrH1pm_XSzLQT4kZcKbugxsoYtlDOSiobKDXu1MtCqvDnvxz8Fw1GpMrBuLkVQDVeeP2j4ZwLlOnLTNi8bScNm_7vTsTPm4ID9mjpWI8Bap83TKi3dzP1k1i3Ggrr1HJUAOzCCcQ4gilDKZ8RElQe21BAqJ7yEnnVlucyG6AWa7viYYuxxBHkDl7XGdvX0jI26rwcS_FH2yNiafd3wJI1342XAvT7CQeh8dZedJSqXQGjB5BHayV_ofzeUp_8HjFDhKUdrcI4i0kFppHdPXMAu128wDu2LnUzyM4JZwSIum_njbQ3ISTymELNx3wt2WSEOd7AKyKyB4BsSsdPMGewKI1gsj-HCEoNBwxPBAvVqCII3lf94m-EM8-XzNtBUqiOv9dDBkgvzJmI9k2O_VjcmFknGJoi1VzYpiQU4XlIZzjCwsCDqkahubcqXWr08UtPmWHFEy4CKorVL7UHiXlVrOGUGtSvucwKdcKTOzWlRx-DcF0LCzMdGZwcg3ei5mitlYbF2UlbN2bZSCPX9c9lESdAQHqPEl5raT67h9VxlOswhanxJFo4enDCZafNmDFG2La69EqBV6KLz0_4uKZC5mxavDk6WKyfoDNyqsuVLto7YsjRN152X05XHHnESz4ne3c0jwWaz60ZIGD5MHMQHPy7O4WgakaVsJeOfaCskwbb49q_mBsX0NfZPcqabDXhZ7BYLQ9XERGbnwd3JDBh-_TT7k6XDicKTnVPueF7wsV_4hOGRJdTI6PTfWj5uf8u7qEOAuKy6euVMKy97MWKOT8-ZQl0hIj0rbVGZH-R4rqH1v_VgQPdi-qWoqWqky0aZK3CNA3QxWftLGp0qEWpu6OQ-ChN7-vxN0tUeddDZQyWWtwx6TW1KhCBWZGjZm9AC68bU2BuNME55oUWGlncN9EnFzgNmQMTuK5vTgwZBHMjfQzlIG_yfwAumHycK5OOOvx95Hc7wDAD2W1WRohy05yLRdlBv_4DQrrMkadEpf0utvhwUwevR5McVEybOwUL6gf9krC4L4bTumBQloBrx5h3nLxYw90rijlnKj5YbKaejrMwbImyF-qVNMmjSwb52StJ0wOG3xOGfBQDxPXrmIxh0DR8GsK0dy-1HIIej5-oRMd_J9aVKz0Y4wx6V23h-jP3q24JbawvwlA6rV5iUFdh6JQriMNC-_aD_u__5U7t8CH7ZVCuP3nIi5x7gmqalK3egHm3pdb_lowXE4ZEBDLvtkihl-w-PFsuYoUJIFVqFvVs5EnSSMW0PIXOSfVMYmJZekbiG_QjxkB23BhzYrSjCz1qnSMx9kvbp9Qh1ndRXJJIPU2jeHuLB4OgW3hzynCaqAvPEuG2XnKpxXfxAKNzWiLIN-0lQ4_Qt4tw-fjaYRUV5KUjrbVgk2506HPmYTGVQWQ_m7gSASPZj6DbInku7K8EZr6owuH253Xqk9kIl2LMBpvjOkNMaQMxKr2-2YdPEy--fMAPLp_UMy2xjlKLKk7nXIu_H1vRng_VUrVHneGjFan87QEORSV7rTAprO2fT2j_9hh6JmtYkQqgG86YyJksUjWs3xpdi6NPFELjAgyOFC-4kMgKlgI3iTHIBWQ3jjtSe0Gct1K7BpBJRrIAF-1UB6JT6cJ28gMswI98kud5hoXYmT5lA-ZaD-I8dM0qFtHH8kYW_nzzo9m69-iYfV_wsy2mBvueoNQddQKBkmiUMnxV90tAyEg8YrZYL1rOcXqcoeI6_8RetmvYxVM1bpuq_j9fMv-zTA9JCeyJ1qAN5VAaicIgg1JXICLB9jeSOOsQw1avqvM7N1ArwCr6oMHrq5ZCEK85yVb5G8cctewoiHYsuYOOHgH3LnchWzfJ3MiEcM6_V7RdvBQd03kPzGEV8uI2uh9tmLk6F7UKzYM6ExI5mKPC9-QN2Mxe0z46ke2mxGGGw-yqL61GGAiKAcpClK5GxyQmPnDJ8DqJNOVX3h_o7a11Uo32kdtG2huXpDUsay6E8TbyGWEgwfX7ZVvk7UM3ejt3jYpqbdYJPMMBB0gM9OfIQcKITroH0rDlQ6ZkxPc4dpeCmM3875pWNQkg1JJuQg3xpOVgEFjYZlED50EiVJ787qC5aGmjLQZ_r-P7_hI7OepLVgPGHASRLlwGN-FpL78QoUzj_Xu06Pd6AuTLmbjhViDD-udnqu5UGwJ4lYjbjJCA7uPOe_ujsQhYwUGA_XBylnErIlL7OXHOTxaDlJGH4-4wMroanhOY5hgcVdvUBZUgRDUh40l3z8FUbaRlihE1yt0uNoGqwMdrZvhNIwaQcPYPyUwQ7Auhuv_jItUqiFBogryRoscwz2qttjmv8AQYHyAly9ujvbury5LcIh_EQfTzBnJy_p5Yw0CXnBK87fEH8raZHxWETpqlxyfYdVf9PjDXLbLabVCbzMsR2sXfAo6m4VhghF-CGNWymknD00Tme4La4W-A-OeGj72-n8Vc6b9g78wnmbAttdrQ8PYWKQvcuyDlvyEGGH_5UmtlSyj2JltKesw7Wsj-ak8CX1btdsSlhBWcaBttj3RjwlCxhD2MyVttzt207rOB7qtAIyX5zrY1LZHpwEmMx8dZs747ecfaeS4dQBZczSyB4VEYTQXgHygE_q-bw_exj5k9sDGxsSFqyzQBVoU9Kename4DJsLXWZinuPHYQSmX2TdPZmsdHxBkpAprb-H4HgEJpOalBkGwhXskHpb6TNHPxy-oOm-hAizmMVOg9gL2NHzRuAmoI3U4Ewa_GEnowteAQSLecMzZ6qgyudk0pnuRyN6P1m3BSQ184WS3jx1C460LAJ3arI-4Aeuin_0VX3qGva344vet87DR7IbME3KMkYkTuz-hzjnxGUT5qvaZv077PTq1m5CQPTdee6Sg34f-ylxh70j1I-NZvwhP2LVv92duVxJRR7xslJzS575q7ifuPG0Rzt4Ny3YDJz4MeCNNpZIpMBJxdvnG7k8lmyoBUQbdz8xBunXOqlD1GSm93NKc-wo7qfzIjv0Z1zYZp-nK7J64E-Jzx2D1glIDnodl9GmyS9po339IYaOPfRgI3ZwQSVGppBP7GMEGlFEqlo7m5-4SYXG6JdXaNr3iQVghPKdAei-bCLAPlbFJCEAU55r_HEfKlT5-36SydteqaSdGo1XFEzZuaH-_z8BlwXW0N0tRitz7Ixu9NANC8GutgkvXuER_Nnw5UIlarepM6TD_Z_e8rFD7haxV1WtoZd9BSwNbRmIyu6cfZzX2xSOVRUJwVHG-Y3ZDdiqkso_WGBvLRJBTVOsoeVnqe1ZKjoCQK1DaFOopxP7SMhp9YicoWFOUQNN5-DB3-68CmDsv15-s3DTqQC58xiwbY-4nYktySQWayzTobVNXmbvb9K9-uj0aTVFLzH1G0YvLmhSSSwk_3O-ctRPLEnXPSQV6GUOjywLHOXSD6_cYS7RkUtx2g8m_1nhIQm08Wui5MJGPGBDoDf7K3wz22tgQQWL10cbtJUoBF262UiH7LNi22VCkl0IX1UQ7-wpI0p8dWSoWo6SnOa7dQ5iBIbf9P_rQwWaaYu5_ZBZpCM4UqVcgaGSYVsqDzWEV8-tck0X8NuI2rgrR94CJxcJk91l-oz0nWaMAhprnn2_wxRXGNay36bjSq3YxM1stt1M7Rczu7Q2Pz-fdjGYANHvqAKXQ6imJaAsplNtJHuIJujwrNTPwFs4a9l4dXwM04QIfhc4yzmbp9XF7UYU423WMhQSdL5JZNWyAuq8AnG7mwgSP3T24NThuSFzf7uNNrJg_PY9UCVriOKqD7YUKARgQECA-NkalnXSEuTCvk2ifEX8Hzq2Il5wLFr9QJV0fO_DRCrS5sDuZVbwD24cejOybmguUanL8b2IjKxzLUOOke2EO5TQMtPQfcy62vEyscpC2EawzaCvWub1SWKdYVu-qPstUxyiOPsipTwWY3MuMFJprSlqaUP1Iksz3D4TjjHIsoG6MAllTYqB-IjnHHfc26nS7ra1yUcltHEkDwt8GR6ng-6OW5bmOBvTQCjdTP8RmvwokHEvFA9Wlk69VHTZEJSZ4gQeqsqo7HBICHwvUb9mzbHgiNtld5YAGOuuSpNLMTq39-33UVhN0KkHKQvBzr59qfhPHSyUFuLg28ojX0doox2JQDgPhlvUbDwpinDBjTpb07lcODaR7ecv3KC9HIAWkx9aWIskmXoAVaSVL0lgNMC3GVLR1D_pehA6rIk6F_jl647L8HDjDRDn6QFtHkmAamtMOVK7O1-T_-TNWph6waQNu0kWY-ep2DDgt96ztXRFSUgM9rL2y78CN2EEYmfAI-3UcjgTnU1FrWhFwt-I6Uf4Vp6V8_6qN2sT2ryaKXz4cBIcCh6o-KDi9oyH5w0Qyx8VoLS6StaQ2aNEz9Jjg-gCxiZtCRXyigilw549UaV2Wkxtvl6dydffaS3jmaLjh4f9xGkRPEGjffo1V4uCyBB9BChiUBdmjTleVRQ8nBrnVAnjauHa4lWud6HcK59V2MNZMMWmKKooA8qkn35TcnDuynJ2HMCgdIBJuPUOSy25Bxnfp8ENMJVkW_TyOnMy9orm55hlxfJ4D58ZwaQDK4AiEfMHTwIsOngjgSJ4KRCv1QkSUx7XEXMSIMQkTa0jK_Z5-OCVMssAo13W85VQJmZCCKYG6Vm-rnuXIGYfVV-858ow8BYPhCaTaW4dVpKXDCD5_sQljgIJwtVg4ODJcWqzRiYjTis2W5cvPoOXZ5B2fqZU9BXeOAc8Kv6kfCUjt8UyP1Shk07lmgP9onO1btyW9VxPHNnPw166CyrfUW1hAGB0ua1MbkDU7_vN4JZ0cuV5_b-olRo4y_rxd7PdVDBldpVMLlWxZ-XbWUjtZSVwZOMk8KoWatnWz5R4KVK6AgmbELxikS1J61gYI6XSro0Fqu7GM3bWvVPbmqGt8I_Tr3GjiJx6w9HodiKlFPsbLjA79bnHnCpwpHFAXb9wq7vc-H_0MMVTl7xNzo8HgQ_GkOXIu9_n1Rbe-RD4WRiHwTnbnYmzG63xowGNPI7g8Gm7fL_NzCXhox7TIHW28tXQByY8fdw_v-1KoSiaJ3p4pIRyQBmkBzf99FFZOKh5mLK2pkHOH5aenQE6x6pqCjCdqnwS97xbtJJuNAx3UzP7G3iyZSyel8HGtaMTeWHO1nhOedSeq5ahi8tAEyZv0QRqLlA4ZALkThyeCYrJAwW2iBZ9nCEEgzljOMpu2gtzCFy9ZKYYIhifJuT7vPGuXFMKKVX4XU9feh8XH1EVnvxpCnF9yxFgy8nUnBuGlFEV8UBUNh8NApIYcpeL7yCQyl6P7qhrN7HHH4Ih6hKKiUiB-Z4M0rTJOffGz0XFZiZH7XOmJk0MszBlEahAEn2SSRZiQWM8lDTQpGk_JwBJQ_QUNkLfxBpzlK0T0aqKWw3ghXY-OqjzS8q1W8uAc3ZlTT0VGEgVuO26_oEzWNvXbzJ1E_TAqREVKL_9aezms3rjc-FvWRGjLWONMxTtl9g19DWalP6jReRRExH7v0KLGoHuuEnHTsP_hl2vn3NVYiwtQnjQB9zb26JFlpg6EhAuI3xlVL3xpDOjeIO5s72YJcS3r03bB3m5G1IcEU8JDvY1y22Phnb8ef6z5ri8D69rUKY8E9qkhLWaXN24S-6Ab3QeKJrlHGOrhG6fJBtIjL_wFOdZ2j8Z4mPYvbZ5CDQ7g3MraXuiRzqgouy7NIbzjs8FDND8dsLGVt9CKjtU2tykBkIJPfXkgu4-JRTTDN3H4gpzOfwPyW_19tLvPJ4JQlysnxJhJmInSPKTQ9crRGTQeKAwLvYzgB0nPZB1wgPUbGitlhySWZjmjeUNhJsgoFwdtEu9hN4Cz4NYEKgZ3ZpJL-lfeInjtTB07P8ukiWqGxcAiR9L4Ov_xVlMboanWn4CM-8UJvcDhUDkiLktxtI8M7fM5nx-2AR_s0ryCWAubefALQtuDRt51VkfyIfBvQarowH6zH_V_gYIXWNt9oLILOqk4yjrdygFWY9vAvP7V8CYkiFnIUkXcZyClOgfq39mtJxpL3csouZXTHp11gLbmdT5ESn20E8bnZDq5oHEDXlOlfGHOevlzFtB_UxGXtKYX9J1AiKzBrdb7BbozdEp0-xuiy6XDZub79-mKruPL2ZYb1i5hVjQACvFp2PpZOi7xUfJRhOFwf-49JaTOWN3-aXUoCukCi1gj88dCoPYcUuk9ZlMzZdWXIp9gCX27_zSE5YDBaiVCWOsw4CJFbc-kQT9CZ34dSXbs6xKSt9-ahr9osicbGciZ1ICW_6YdK3IzrHuQEzNsCCKDuobUQQdZARQLyaeGl45g37mFoKP7bxoMZcP3F0w37AGLLW1cV-6uNnihYCZtu8YrFPuaxh_UULONMResyLUlDurvlnAUyj1U1MSlC1LkOm_UWoMuPs_UjSc7H77E80rgvBfBA7Z2DP2jV8QQRb6CTbxKiFI9LXfFR729EqDYUuQEI5d3tcyb7u8O2eBv_Tj9O4ODLyZ97gpLuVwuJUoqjARgEOuSiGul1hRqa9y6VtfjL4Njj2Ib1lcbrA.Nqzdpe8b7qsc3BjXFXZYZQ" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/BackupSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/BackupSecret-example.json new file mode 100644 index 000000000000..8288ad015e4d --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/BackupSecret-example.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "secret-name": "testsecret", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "value": "KUF6dXJlS2V5VmF1bHRTZWNyZXRCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUppTlRjMk5ESTVaaTB5TlRZNExUUTFZbVV0WW1aaFlTMHpOMlZrTURkbVl6QmpPREVpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLmhERDdfVW9aU1ptR2JYN1dYUTU5WDkxZ0FQb05kdDcwZE1BbmgzbjQ3eWNjbkRNOU5vTm1hY0NHZmlNeUwxU0FlZDk0UjhBNDAtVE81TDNfQ05Qal9pdWIyaW03Z21nbHNPNnFFUVVIWU1tOEh2Wl9odFRrdEl4QzRPWEowYTB0S2hscnczZlBvVVFDZHVGcFg0ekEzYTR4VTZXTUNfYjZZVXZqUjZnSGM5TFRUR2tIazh1RTY0aVQ4cmt5RDRrU3RNcXhnU2lfRVZwUUdjWGdfNE9wQ1dBOUFha0N1NkpybGRaQW9BLUtXTWpQbGhaWHFYWGMyVkJlbUJjRTQ1YzY3QWhqYjJrSi1uQ1c5dHBjWS1JZ3JEUHFzWkswOS1WbHVtcl9SbzQzcG5FeW5jVFpTdzZlX1h6VnN0dUFOZHdiM0E2OVR1c1hfYkJKZ0J2SGQ4cDJSUS5WMTlhMVRacjZ2UjJHdEVaWGtOOXJRLmhwMU5IMmwtZklWbVgwWlNfTlRzekJfUEs1aktDUU5rSnJyRUhRQmZjQ2VjdHhmVU5uVlB6MVBqRWNDblZuV0pCUk4zTlFKZm01MjFLRHp1MzBIVUFEUGVmVHJyMFVFS2x5QTM2cThoWFY3VTdoQ0dHNk85NVpYclRsZlVENDI5RTNTNTQxdVBmWGpGR2cxbHlucFNTNnAtVkFzaXFlY1lpQWNuM1hhNzRhUm5xS3N3ZzhyU1ZOX09hSVU3ak1VVUhYZWY1ZmN0NlFrdWFfYkt6Z2dtR2ZiT2RTdVdNRmVQaF9mMkJMUFNGN3k1NThEMFZxSVlNY0JJR0dMU3BQUU93Q094OFF3Y3NVUEp4ZDFuWkVYYjRVNEJZYlhBcmFMX0NwekYxZlhYWVBsdmVUSGdKNVdrR28tWXNJVzAtT3ZqVGdLN2hIamxpR1psd29HOVUtbTJSVDZfbkhseHhVRFMyY3JseGNmay1OOTlXd0tEdUxFMTM5ZE1mN2RCSEl1aTdxd0RXdm1TN2JMTHYzM05Wd19XSl9DT1VGQjgycy1ELXk0UEdIRzVackhsSDgxa25mLVpRblU0SmZfY2lhMWhmWlY3ZFMxb21UZDQtNnJwZmpTMGxFT3VfZTQ5bUpYUGFpZ0hyLWFQYkFzTXJJQ2JvOUVIR2IzMXJ5SlR2QXF2ZmJDbU10bkdLUDV6aUNiZFh3SU5ONzBJTk5lZnJLWGZkZFBUd0RSV3d1ZkxCcGNlU0U0SG5EWVZVQmdkMDl4UUZidG12UDhhTXhhUlpGSTNpWG1fbmpCNmZfdlNhZUNUakdVYVVuRE1QQkdOQWQ5T2xVX3dvUnMtalNCVnVqd1FQSGlGcm5RWElkXzBRdXRYSm54cTU4aUtlTGJvNDJtOHgwaXBRcnB4aEZoUDdHNmZOWXAwVmxXR0RxZ1Q0VlpPQkZsZWRKUU0yaDQtb2xTbXdtUms0M0Y1cjdKd3h4aENqU1JReWx1MGEyQ0ZONWMyZjIxTElZaFliLWNReWFXMDNpV3hsb04zWld5cDJIb1FlUmZPR3lXUzBiU2NBT3JndGpBYnJaUFIwMGRRNnpSOHNBczFYUzh3dzBlaVczbFpsdjJwVWFxOVpTeVhnTS14b2NTOS1ueXRaWGtWWlUwX2dDVXJBV0ZKNG5XdW9oTGM1RkkyRWFQNWR0SXVWa3dnbXlsR1gtYk9ZeHp3dzVGYmI1V3VEbnJ5aDBMSnVic3Q4VXdLdnl3bk1jQ3duMjZSVTNxQVRudGJubVhJS0FyeGkwMldQVk9oTXdpUWZuX2h1TWk5emp3MEVuaXNWdktNWUNnR2xqNWlGZW5Tc0FKUXBiLUY4bng3OWFJQlJaTUc1a0huUDR5dGxmNm9FTkRsRXNJY21aeEtOdEIzcmJPdVROYUhLTXZBNmxSNzlMMDJZSTZrcEdrUUZnaHpIaTBjTWkwbFdCejRTM1AzUEMzZElZSVlQZ0Q2S05kT2FLWHkta0dWdUlsWFNmVlVrMnpzM0NBeTJhZEJjV0NMV094ZkRoQnlwNTl4MHpBRExvdnZySHRLOWF6TGN3N0lTbVl6eUhYMkpobVdReUYtTFd1VzhfcW41SkFVYlB5Z0RTRDYyMi1PTGZQVDZmc2VTWUVBUTFLVWRwZTFnSV9hZWxVT3FaRWN1aE5SckU1YUp0LTN5TEVLVWZIWXF6WTlGbHJrUE5MUC03Y2xRbmEySEhfZmMzZV9LTGtGUDFhQTJjM0RVaERseGhsTzB2bFVmV0c5eXpXaDNZN0NmRFlFMlBaUzZBcFBlYy0wa1NDcEVKMmtCcnFzWG4yeDJDX0FDdTdCTTVGZXNJQkN0M2NqSEdQSVVQRnEteGVmT0RCXzBQcXZDTXpBOHg5Zm10Ny1sNHhVQlJaa0dtZExhZFoxVzdFUXRNRVpsSWMtbDF1V1UzTU15cFZpVWR0OWxJUHVQVUEwc1NrbWxrTGhNSjgyNE5QN0hyVi01dC1ZNDcxaWVKMHdEUjFxMmU4MU8yazdNeTFlTDY3TlY4OVBHYU81SVR5WG1ueUVXMGtVbl9qa3l1UVRkV3dsS09HZVZIYkJWNFpxSXZHWjdQUS02TEE5eXc3a0dyZFRhVFZXOEdOOV9GY1c2VUhjbzA0U3dqTzY2S2x4VlFJWWpBdEZPZlBjWW5xNzF1RndyQS1UZHVDZG1sUFBHOVpjc2tiQmdrbF8wVk90dmhuc0pwYXZKZ2Zka0d3OF9qMkQzd0Jzemd0VndHNk9nNW16eVFwM2pFc0w3UmNtcXd6WFBOaDdKYXdHVDBJMlRvZHYyQ1Z3MDkzWjJlODFXR1NxRnlIejAxdjFBaGN2T2VWdmFjUGM2Y1JJaVduNW93ZF80d2FBdjlyNjVVdmtWa1FLRXpHUmo5eTZILXdZTTMyV1JyMzBlOU9MRTNKUU5POV9kNjRTRmIwSjZHa2VxUmtnNkVXc2xqN1JYLVU1VlhrS1BtMzNpS3c5dGU2NVBqQUNnZThRVDBYVWZEaUx5a1pGeUdpZ09ZMS1TVDFxUlE1eUhMTXhEc3BPRjFXd1lMQ2c2b3hocTlWMm55Z0U1cUJ2ZnYyWUtFaDdjM1dWNjJrYkw3UXJ2d0xkMHVRZ1FwYmUza3E3dGJzcC1lNWlud3cyY0YxQzByeHNScGZJRHlJMmg4b2xHMi1RQUZkWmtlMUlmaE1FZmNfdUdXX2pqSGJSWXVzYnZCRnpKMDdaOVJsVnFMR1A2WXBnTDFsRTFOY09xUVJyYVdxckdDTWZ6SzZMVENQSl93aHJRam9WTzdVRDJIUEVnUjZ2S3U3cWlmTmo3UjE5OUJuRi1EZmlnbk1TYTFKZkZadDNuVXVZOEhMUXRoUzN4MUMxOE50d3dsaDVuNGxYS3d5MERHenljbVNweE05QkdPNTFRckFmSXRfY0xHbUlzMlJ4MzMyeDRIdEZ3Z05nRzFBazNIUno4TlJ4V3lhNWhjb1NoYURXekhES2gyOVp3Vm4wYXVzeWJpal9uNlFGcnZZbjRSOHdPNlRQV3FrS09JcHkxc1lQNWxyNDc1anZSRVZGaFdCWDBiUXdJdnNlM0Q0a0dFQzgzU3FWYkhxY3phZTNwOFNxaG5tQW5ZYzBIbWp4clJfZUMzT0hYVFBGUFZmNDlVWHdrQjIwY1lvcjJ1dzBaTzJ2TUg3S1QwcjBSWDBQVy1qcGpORFpjSGRSNVVCMXFacGlWLWxaYkw0eF9IZW14aWUxY0RPOHNQSXhIOElUSWtOV0tTR1N2eWdraHBBbGl2RzVEZXJObElkeFE2c0tHQ3RtMDEyT2xjN2thaVFaNHh0TjR5ZVpPU2xyS0s0OTlIcWhObzhkNTNsbFFfMW5ncWlHbzhUSDlzWkFrclYwclc3dkJOSF92UlhBdTc2MnlpZGhZUURYYXJXSEFUMm9DU2hEN1lOdnotekoyZGtEajJMcW5CdFNCWFh5T2xsM3o0ZWFITDd2MDZ1QTgxMVBKQU5YZUdoenNaNFVQQUQ2Q0E4cGlxSHB4WGkxODRHNEJETVU4S2VHeHZLWnJiUlNOT2pTOFNrQUJKZERfSklIZ1RhNEFhNzdPUmNZcVY3OWZ5djFZVHNma2lLR2NUYzZIUjZzUVpsamt2U0NQNjdtTTRGUHRqTHlfX1pDQlNwdnRSVWd5UlpNM1dSOUViNHkxa29uRG4zUjMzN2lpSzdfbGtIa1UtZ21VbUpZUVdnUjYzT01pZUdRUHdNR3BSZXlRWE5yckJVTDN2Z2JYdjlac1ZDcDh1NHRwQjBleXJvUXgxZC1KSWJvOWVyR1VlX0ZzU1Fpd0tIaGFIUk02Nzh5dENkcHJFbDBWeG92TFVrX0xNcTFjN1R4MG5jbFl2WE4yUjhEMXNhU2FibkJSd19CU2tZMFNMSXdhb2RpY2o2ZzdLd0ZfMXB2eThhNF9LbnJNLUNkenBvdHA0aTd4QUJuY2JRVUEwWkpsYlp1elRpR0F4ZjFnclk1Z0dZOTVoWi1XZG1lOWlSazBHRTJGN3d4MlJyLUVvS3lZRjNjak0xMWt6MWFmME9fNFdyOXJoU3JrX1NHU3l2a3ZCTW9NZ0xOX0tSS1BlTjlqUnpwRlVST2VnN2NCbGlhdy1odnZhY2lCeDN2UWRqTE5jTldQdU1UbzVmME1QbmU4TUtXcFBoWjBySElMaEVuYW1pcG82X3pzNjczcE9ma09FS0JWWE9mUDEzR0UwS25SWTBab2JPLWRub254LVdBY1dodFZvX08xbkwwTWE5ZXFMMURhRGhJU0JNbVRIM1hkY2dDTnF0emIwcVMtS1l5Mk9zRzZOakRDVEM1aEI3MXIwU09WMUprNFV2QjdYemxTTW9YUXJnTzF2ZFVwSGtxaVhUM1RJZmlQMWRKcDEweDlSMlp5R0lzUzljQUtNMEZyMGRxQmJmQy16NTJpcWZweW4zUVVqb1Fld2hPYnJwUEZGOF9lUmVNRlIwSXZjUkxnMHpwek56UzU1N1pkQkZhemxNTThLcnkwN2QyUDAyTnZtclUtN1ZjOW8wZm1qem9WOHVVTG9PMkJHdmFRdnFJNmtBTmQ5VWo1X2JkY2NVUzBhcklzcGFZa1UtUXQtNnQxYU5YUUdGZEtUbFMwSVowek54bkNIZWRySEE4SkYtOFg3d1ZpRW1McXJQbU1Sd25sbWx3SnhxLVlReWMydmdUallSbUxCVU5TS3VrZkJsa2VnMmlCRWdySksxVlNyRWswX0ZvOXkzV1EwVlZuNXhEZXlGc1JuWDI4Tkl6alFQLVNXaHhYbzdPYm5YY1cxZHlWNE1fYjdzM096cEMwOTJWcGZYQkpaTDhBeHgxNGY2TmJzTEpXLW95VEdsaTJFb2FCZHJKQ2JkQlNOdWJlbGdRRmU2V2hqSjRGdlNrYVJISjFTT3ltbGFtQmYwaVNDOGM2X1g2SkZORjNmOXYuQjc5SDJvbVIyTU52SndydHVzclJ4UQ" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/CreateCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/CreateCertificate-example.json new file mode 100644 index 000000000000..4fa676e6e465 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/CreateCertificate-example.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "certificate-name": "selfSignedCert01", + "api-version": "7.0-preview", + "parameters": { + "policy": { + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=*.microsoft.com", + "sans": { + "dns_names": [ + "onedrive.microsoft.com", + "xbox.microsoft.com" + ] + } + }, + "issuer": { + "name": "Self" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/selfSignedCert01/pending", + "issuer": { + "name": "Self" + }, + "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=", + "cancellation_requested": false, + "status": "inProgress", + "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.", + "request_id": "6faacd568ab049a2803861e8dd3ae21f" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/CreateKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/CreateKey-example.json new file mode 100644 index 000000000000..ba0bf5ebcdcd --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/CreateKey-example.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "key-name": "CreateSoftKeyTest", + "api-version": "7.0-preview", + "parameters": { + "kty": "RSA", + "key_size": 2048, + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "attributes": {}, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942451, + "updated": 1493942451, + "recoverylevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteCertificate-example.json new file mode 100644 index 000000000000..e24ff51d1c59 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteCertificate-example.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "certificate-name": "importCert01", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedcertificates/importCert01", + "deletedDate": 1493938558, + "scheduledPurgeDate": 1501714558, + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "sid": "https://kv-sdk-test.vault-int.azure-int.net/secrets/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493938557, + "updated": 1493938557, + "recoverylevel": "Recoverable+Purgeable" + }, + "policy": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/importCert01/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297, + "basic_constraints": { + "ca": false + } + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1493938557, + "updated": 1493938557 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteCertificateContacts-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteCertificateContacts-example.json new file mode 100644 index 000000000000..93822094decf --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteCertificateContacts-example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/contacts", + "contacts": [ + { + "email": "admin@contoso.com", + "name": "John Doe", + "phone": "1111111111" + }, + { + "email": "admin@contoso2.com", + "name": "Johnathan Doeman", + "phone": "2222222222" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteCertificateIssuer-example.json new file mode 100644 index 000000000000..1af90afd1ef4 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteCertificateIssuer-example.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "issuer-name": "issuer01", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer01", + "provider": "Test", + "credentials": { + "account_id": "keyvaultuser" + }, + "org_details": { + "zip": 0, + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + }, + "attributes": { + "enabled": true, + "created": 1482188806, + "updated": 1482189526 + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteCertificateOperation-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteCertificateOperation-example.json new file mode 100644 index 000000000000..b290944b098f --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteCertificateOperation-example.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "certificate-name": "deletedRequestedCert01", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/deletedRequestedCert01/pending", + "issuer": { + "name": "issuer03" + }, + "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApf+kGcL+5uivj/ToYbQ15zcx3caEnpzXaX2eJgL0/Kwaz4u2/bNJ9+hoXnlOFFbCp4canVoNvgu8fw5NOu9U3gJNFQwjHeAqfsg8okZGkIk0riIpp4MMb/4GQb2y3B28AcTu2FANdzLoZzBqmQs51KBe1RONkdtqDYXIvnb5G+9+P7PCy5G//Ga0JAP6Y6P8+TrE9JLEj6Sny0ljLMpMyt4rIRAtNfKYSeiWVQmYX4jZfImIW3iq91zwMsRlrzTm80mNfHPCv7V/8NmYuh0MQgCr49lLbbKCgzDyo9h8sblVQvR5TAylpIk7bSQNf4tSdVNHnsF6CJWu6Pg31hyMpQIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBAHVjmYFs3FmecaJ1ExhK1WCFJaQJUTVbPJ1xJ93UJlLivhzI1yhQO9nMC2DKV+E+UCxceqjae6OG5LUhXfYAziS0HTc80+ZcUqrZRb5ZRt+8HU0TPbTDDqjj8wMZ4VlgQ3eXGAGesMfZV3AqWwa5itofvqm8KAmL4Yn/XMSHcKfRx3h9WnC6RXgZ8WNYK+r5o+gHlmuF7/AaNFh8UjIsjjOZQ0Yin/vA4yBEYTt1/OC7pScs3bdL9CIf4rC98qaMSf4B2W/vfrXUo0gGPYcep25jy7xnIltSY80Trn3Mty5YQ0IT+KPQcJKhbryGg6bIy4jJDwS7zkn51MR1q3kNoOA=", + "cancellation_requested": false, + "status": "inProgress", + "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.", + "request_id": "b88791e33d9c4d609d3e3cc3d2d40d11" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteKey-example.json new file mode 100644 index 000000000000..e0a01a184232 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteKey-example.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "key-name": "CreateSoftKeyTest", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedkeys/CreateSoftKeyTest", + "deletedDate": 1493942452, + "scheduledPurgeDate": 1501718452, + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942451, + "updated": 1493942451, + "recoverylevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteSecret-example.json new file mode 100644 index 000000000000..d41a74f2a1f4 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/DeleteSecret-example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "secret-name": "GetDeletedSecretTest", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedsecrets/GetDeletedSecretTest", + "deletedDate": 1493938433, + "scheduledPurgeDate": 1501714433, + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/GetDeletedSecretTest/b595353d9c39413d80626575b3b5d865", + "attributes": { + "enabled": true, + "created": 1493938433, + "updated": 1493938433, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificate-example.json new file mode 100644 index 000000000000..28595933d0dd --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificate-example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "certificate-name": "selfSignedCert01", + "certificate-version": "pending", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/selfSignedCert01/pending", + "issuer": { + "name": "Self" + }, + "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=", + "cancellation_requested": false, + "status": "completed", + "target": "https://testvault1021.vault.azure.net/certificates/selfSignedCert01", + "request_id": "6faacd568ab049a2803861e8dd3ae21f" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateContacts-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateContacts-example.json new file mode 100644 index 000000000000..93822094decf --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateContacts-example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/contacts", + "contacts": [ + { + "email": "admin@contoso.com", + "name": "John Doe", + "phone": "1111111111" + }, + { + "email": "admin@contoso2.com", + "name": "Johnathan Doeman", + "phone": "2222222222" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateIssuer-example.json new file mode 100644 index 000000000000..1af90afd1ef4 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateIssuer-example.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "issuer-name": "issuer01", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer01", + "provider": "Test", + "credentials": { + "account_id": "keyvaultuser" + }, + "org_details": { + "zip": 0, + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + }, + "attributes": { + "enabled": true, + "created": 1482188806, + "updated": 1482189526 + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateIssuers-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateIssuers-example.json new file mode 100644 index 000000000000..46170408100b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateIssuers-example.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer01", + "provider": "Test" + }, + { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer02", + "provider": "Test" + }, + { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer03", + "provider": "Test" + } + ], + "nextLink": null + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateOperation-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateOperation-example.json new file mode 100644 index 000000000000..ce49d6c826e4 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateOperation-example.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "certificate-name": "selfSignedCert01", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/selfSignedCert01/pending", + "issuer": { + "name": "Self" + }, + "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=", + "cancellation_requested": false, + "status": "inProgress", + "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.", + "request_id": "6faacd568ab049a2803861e8dd3ae21f" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificatePolicy-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificatePolicy-example.json new file mode 100644 index 000000000000..2658b3ba4c7c --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificatePolicy-example.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "certificate-name": "updateCert01", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/updateCert01/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297, + "basic_constraints": { + "ca": false + } + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1482188947, + "updated": 1482188947 + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateVersions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateVersions-example.json new file mode 100644 index 000000000000..84ded9f0a5fa --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificateVersions-example.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "certificate-name": "listVersionsCert01", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/listVersionsCert01/002ade539442463aba45c0efb42e3e84", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482189534, + "updated": 1482189534 + } + }, + { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/listVersionsCert01/7fcb3e9eb8bf43f3a6ff4b9c3740801d", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482189532, + "updated": 1482189532 + } + } + ], + "nextLink": null + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificates-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificates-example.json new file mode 100644 index 000000000000..56b06b4f6823 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetCertificates-example.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://testvault1021.vault.azure.net/certificates/listCert01", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482188987, + "updated": 1482188987 + } + }, + { + "id": "https://testvault1021.vault.azure.net/certificates/listCert02", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482188988, + "updated": 1482188988 + } + } + ], + "nextLink": null + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedCertificate-example.json new file mode 100644 index 000000000000..b39e9bff772b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedCertificate-example.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "certificate-name": "getDeletedCert", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedcertificates/getDeletedCert", + "deletedDate": 1493938292, + "scheduledPurgeDate": 1501714292, + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769", + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769", + "sid": "https://kv-sdk-test.vault-int.azure-int.net/secrets/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493938289, + "updated": 1493938291, + "recoverylevel": "Recoverable+Purgeable" + }, + "policy": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/getDeletedCert/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297, + "basic_constraints": { + "ca": false + } + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1493938289, + "updated": 1493938291 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedCertificates-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedCertificates-example.json new file mode 100644 index 000000000000..7be54d40546b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedCertificates-example.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "7.0-preview", + "maxresults": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedcertificates/listdeletedcerttest0", + "deletedDate": 1493937659, + "scheduledPurgeDate": 1501713659, + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/listdeletedcerttest0", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493937658, + "updated": 1493937658, + "recoverylevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://kv-sdk-test.vault-int.azure-int.net:443/deletedcertificates?api-version=7.0-preview&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMTIhTURBd01ETTVJV05sY25ScFptbGpZWFJsTDB4SlUxUkVSVXhGVkVWRVEwVlNWRlJGVTFRd0wxQlBURWxEV1NFd01EQXdNamdoT1RrNU9TMHhNaTB6TVZReU16bzFPVG8xT1M0NU9UazVPVGs1V2lFLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedKey-example.json new file mode 100644 index 000000000000..e0a01a184232 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedKey-example.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "key-name": "CreateSoftKeyTest", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedkeys/CreateSoftKeyTest", + "deletedDate": 1493942452, + "scheduledPurgeDate": 1501718452, + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942451, + "updated": 1493942451, + "recoverylevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedKeys-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedKeys-example.json new file mode 100644 index 000000000000..95e555e5a8c2 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedKeys-example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "7.0-preview", + "maxresults": "1", + "$skiptoken": "eyJOZXh0TWFya2VyIjoiMiE5MiFNREF3TURJeklXdGxlUzlNU1ZOVVJFVk1SVlJGUkV0RldWUkZVMVF3SVRBd01EQXlPQ0V5TURFM0xUQTFMVEEwVkRJeU9qRTJPakF5TGpnM09URXpOemxhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedkeys/listdeletedkeytest0", + "deletedDate": 1493938031, + "scheduledPurgeDate": 1501714031, + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/listdeletedkeytest0", + "attributes": { + "enabled": true, + "created": 1493938031, + "updated": 1493938031, + "recoverylevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://kv-sdk-test.vault-int.azure-int.net:443/deletedkeys?api-version=7.0-preview&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVSRVZNUlZSRlJFdEZXVlJGVTFRd0x6RkRRa0ZGTkVaQk5qQTBNelJGTmtZNE9FUXdORE5GTkRFM09FUkNPVFE1SVRBd01EQXlPQ0V5TURFM0xUQTFMVEEwVkRJeU9qUTNPakU1TGpVeU1UZ3dPVEZhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedSecret-example.json new file mode 100644 index 000000000000..d41a74f2a1f4 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedSecret-example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "secret-name": "GetDeletedSecretTest", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedsecrets/GetDeletedSecretTest", + "deletedDate": 1493938433, + "scheduledPurgeDate": 1501714433, + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/GetDeletedSecretTest/b595353d9c39413d80626575b3b5d865", + "attributes": { + "enabled": true, + "created": 1493938433, + "updated": 1493938433, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedSecrets-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedSecrets-example.json new file mode 100644 index 000000000000..79a091bf46c1 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetDeletedSecrets-example.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "7.0-preview", + "maxresults": "1", + "$skiptoken": "eyJOZXh0TWFya2VyIjoiMiExMDAhTURBd01ESTVJWE5sWTNKbGRDOU1TVk5VUkVWTVJWUkZSRk5GUTFKRlZGUkZVMVF3SVRBd01EQXlPQ0V5TURFM0xUQTFMVEEwVkRFNU9qSTFPakU0TGpJNE5qUXdORFZhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedsecrets/listdeletedsecrettest0", + "deletedDate": 1493937855, + "scheduledPurgeDate": 1501713855, + "contentType": "plainText", + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/listdeletedsecrettest0", + "attributes": { + "enabled": true, + "created": 1493937855, + "updated": 1493937855, + "recoverylevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://kv-sdk-test.vault-int.azure-int.net:443/deletedsecrets?api-version=7.0-preview&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExNDQhTURBd01EWXlJWE5sWTNKbGRDOU1TVk5VUkVWTVJWUkZSRk5GUTFKRlZGUkZVMVF3THpZMU16ZERSRVJGTlRJNU5qUkRSa1pDTVRkQ1JVWXhORGszUXpSQ1JEZEVJVEF3TURBeU9DRXlNREUzTFRBMUxUQTBWREl5T2pRME9qUXdMamsxTnpZeE1UbGFJUS0tIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetKey-example.json new file mode 100644 index 000000000000..0c87df0fd00e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetKey-example.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "key-name": "CreateSoftKeyTest", + "key-version": "78deebed173b48e48f55abf87ed4cf71", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942451, + "updated": 1493942451, + "recoverylevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetKeyVersions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetKeyVersions-example.json new file mode 100644 index 000000000000..8350169cc002 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetKeyVersions-example.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "key-name": "listkeyversionstest", + "api-version": "7.0-preview", + "maxresults": "1", + "$skiptoken": "eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVTMFZaVmtWU1UwbFBUbE5VUlZOVUx6ZERPVVJETmpjM05VUXdSVFF4TnpjNE1qZERORVk1T0VZME9ESkdRekV5SVRBd01EQXlPQ0U1T1RrNUxURXlMVE14VkRJek9qVTVPalU1TGprNU9UazVPVGxhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/listkeyversionstest/7c9dc6775d0e4177827c4f98f482fc12", + "attributes": { + "enabled": true, + "created": 1493937851, + "updated": 1493937851, + "recoverylevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://kv-sdk-test.vault-int.azure-int.net:443/keys/listkeyversionstest/versions?api-version=7.0-preview&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVTMFZaVmtWU1UwbFBUbE5VUlZOVUwwRXdPRUZDUVVVNE1UZ3pNalF5TVRsQ05EUXpPREZFTWpoRVJURkdSVEJESVRBd01EQXlPQ0U1T1RrNUxURXlMVE14VkRJek9qVTVPalU1TGprNU9UazVPVGxhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetKeys-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetKeys-example.json new file mode 100644 index 000000000000..411a9c27e991 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetKeys-example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "7.0-preview", + "maxresults": "1", + "$skiptoken": "eyJOZXh0TWFya2VyIjoiMiE4MCFNREF3TURFMElXdGxlUzlUUkV0VVJWTlVTMFZaSVRBd01EQXlPQ0V5TURFM0xUQXlMVEUzVkRBd09qQXhPakEyTGpnd056azBOemhhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/sdktestkey", + "attributes": { + "enabled": true, + "created": 1493937656, + "updated": 1493937656, + "recoverylevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://kv-sdk-test.vault-int.azure-int.net:443/keys?api-version=7.0-preview&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE5NiFNREF3TURJM0lXdGxlUzlWVUVSQlZFVkxSVmxCVkZSU1NVSlZWRVZUVkVWVFZDRXdNREF3TWpnaE1qQXhOeTB3TlMwd05GUXdNVG94TVRveE5pNDNNekE0TnpReVdpRS0iLCJUYXJnZXRMb2NhdGlvbiI6MH0&maxresults=1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetSecret-example.json new file mode 100644 index 000000000000..bb691dc64674 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetSecret-example.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "secret-name": "mysecretname", + "secret-version": "4387e9f3d6e14c459867679a90fd0f79", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "value": "mysecretvalue", + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79", + "attributes": { + "enabled": true, + "created": 1493938410, + "updated": 1493938410, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetSecretVersions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetSecretVersions-example.json new file mode 100644 index 000000000000..3afc455ab948 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetSecretVersions-example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "secret-name": "listsecretversionstest", + "api-version": "7.0-preview", + "maxresults": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://testvault1021.vault.azure.net/secrets/listsecretversionstest/11a536561da34d6b8b452d880df58f3a", + "attributes": { + "enabled": true, + "created": 1481851699, + "updated": 1481851699 + } + } + ], + "nextLink": "https://testvault1021.vault.azure.net:443/secrets/listsecretversionstest/versions?api-version=7.0-preview&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExNDQhTURBd01EWXlJWE5sWTNKbGRDOU1TVk5VVTBWRFVrVlVWa1ZTVTBsUFRsTlVSVk5VTHpGRU5EazJNa0l4UlVRM09EUkVRa1k0T1RsR016TXpNa1UwTnpZNFFqY3dJVEF3TURBeU9DRTVPVGs1TFRFeUxUTXhWREl6T2pVNU9qVTVMams1T1RrNU9UbGFJUS0tIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetSecrets-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetSecrets-example.json new file mode 100644 index 000000000000..3cda8d990890 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/GetSecrets-example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "7.0-preview", + "maxresults": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "contentType": "plainText", + "id": "https://testvault1021.vault.azure.net/secrets/listsecrettest0", + "attributes": { + "enabled": true, + "created": 1482189047, + "updated": 1482189047 + } + } + ], + "nextLink": "https://testvault1021.vault.azure.net:443/secrets?api-version=7.0-preview&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE4OCFNREF3TURJeUlYTmxZM0psZEM5TVNWTlVVMFZEVWtWVVZFVlRWREVoTURBd01ESTRJVEl3TVRZdE1USXRNVGxVTWpNNk1UQTZORFV1T0RneE9ERXhNRm9oIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/ImportCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/ImportCertificate-example.json new file mode 100644 index 000000000000..a1496a3f3f52 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/ImportCertificate-example.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "certificate-name": "importCert01", + "api-version": "7.0-preview", + "parameters": { + "value": "MIIJOwIBAzCCCPcGCSqGSIb3DQEHAaCCCOgEggjkMIII4DCCBgkGCSqGSIb3DQEHAaCCBfoEggX2MIIF8jCCBe4GCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAj15YH9pOE58AICB9AEggTYLrI+SAru2dBZRQRlJY7XQ3LeLkah2FcRR3dATDshZ2h0IA2oBrkQIdsLyAAWZ32qYR1qkWxLHn9AqXgu27AEbOk35+pITZaiy63YYBkkpR+pDdngZt19Z0PWrGwHEq5z6BHS2GLyyN8SSOCbdzCz7blj3+7IZYoMj4WOPgOm/tQ6U44SFWek46QwN2zeA4i97v7ftNNns27ms52jqfhOvTA9c/wyfZKAY4aKJfYYUmycKjnnRl012ldS2lOkASFt+lu4QCa72IY6ePtRudPCvmzRv2pkLYS6z3cI7omT8nHP3DymNOqLbFqr5O2M1ZYaLC63Q3xt3eVvbcPh3N08D1hHkhz/KDTvkRAQpvrW8ISKmgDdmzN55Pe55xHfSWGB7gPw8sZea57IxFzWHTK2yvTslooWoosmGxanYY2IG/no3EbPOWDKjPZ4ilYJe5JJ2immlxPz+2e2EOCKpDI+7fzQcRz3PTd3BK+budZ8aXX8aW/lOgKS8WmxZoKnOJBNWeTNWQFugmktXfdPHAdxMhjUXqeGQd8wTvZ4EzQNNafovwkI7IV/ZYoa++RGofVR3ZbRSiBNF6TDj/qXFt0wN/CQnsGAmQAGNiN+D4mY7i25dtTu/Jc7OxLdhAUFpHyJpyrYWLfvOiS5WYBeEDHkiPUa/8eZSPA3MXWZR1RiuDvuNqMjct1SSwdXADTtF68l/US1ksU657+XSC+6ly1A/upz+X71+C4Ho6W0751j5ZMT6xKjGh5pee7MVuduxIzXjWIy3YSd0fIT3U0A5NLEvJ9rfkx6JiHjRLx6V1tqsrtT6BsGtmCQR1UCJPLqsKVDvAINx3cPA/CGqr5OX2BGZlAihGmN6n7gv8w4O0k0LPTAe5YefgXN3m9pE867N31GtHVZaJ/UVgDNYS2jused4rw76ZWN41akx2QN0JSeMJqHXqVz6AKfz8ICS/dFnEGyBNpXiMRxrY/QPKi/wONwqsbDxRW7vZRVKs78pBkE0ksaShlZk5GkeayDWC/7Hi/NqUFtIloK9XB3paLxo1DGu5qqaF34jZdktzkXp0uZqpp+FfKZaiovMjt8F7yHCPk+LYpRsU2Cyc9DVoDA6rIgf+uEP4jppgehsxyT0lJHax2t869R2jYdsXwYUXjgwHIV0voj7bJYPGFlFjXOp6ZW86scsHM5xfsGQoK2Fp838VT34SHE1ZXU/puM7rviREHYW72pfpgGZUILQMohuTPnd8tFtAkbrmjLDo+k9xx7HUvgoFTiNNWuq/cRjr70FKNguMMTIrid+HwfmbRoaxENWdLcOTNeascER2a+37UQolKD5ksrPJG6RdNA7O2pzp3micDYRs/+s28cCIxO//J/d4nsgHp6RTuCu4+Jm9k0YTw2Xg75b2cWKrxGnDUgyIlvNPaZTB5QbMid4x44/lE0LLi9kcPQhRgrK07OnnrMgZvVGjt1CLGhKUv7KFc3xV1r1rwKkosxnoG99oCoTQtregcX5rIMjHgkc1IdflGJkZzaWMkYVFOJ4Weynz008i4ddkske5vabZs37Lb8iggUYNBYZyGzalruBgnQyK4fz38Fae4nWYjyildVfgyo/fCePR2ovOfphx9OQJi+M9BoFmPrAg+8ARDZ+R+5yzYuEc9ZoVX7nkp7LTGB3DANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBXBgkqhkiG9w0BCRQxSh5IAGEAOAAwAGQAZgBmADgANgAtAGUAOQA2AGUALQA0ADIAMgA0AC0AYQBhADEAMQAtAGIAZAAxADkANABkADUAYQA2AGIANwA3MF0GCSsGAQQBgjcRATFQHk4ATQBpAGMAcgBvAHMAbwBmAHQAIABTAHQAcgBvAG4AZwAgAEMAcgB5AHAAdABvAGcAcgBhAHAAaABpAGMAIABQAHIAbwB2AGkAZABlAHIwggLPBgkqhkiG9w0BBwagggLAMIICvAIBADCCArUGCSqGSIb3DQEHATAcBgoqhkiG9w0BDAEGMA4ECNX+VL2MxzzWAgIH0ICCAojmRBO+CPfVNUO0s+BVuwhOzikAGNBmQHNChmJ/pyzPbMUbx7tO63eIVSc67iERda2WCEmVwPigaVQkPaumsfp8+L6iV/BMf5RKlyRXcwh0vUdu2Qa7qadD+gFQ2kngf4Dk6vYo2/2HxayuIf6jpwe8vql4ca3ZtWXfuRix2fwgltM0bMz1g59d7x/glTfNqxNlsty0A/rWrPJjNbOPRU2XykLuc3AtlTtYsQ32Zsmu67A7UNBw6tVtkEXlFDqhavEhUEO3dvYqMY+QLxzpZhA0q44ZZ9/ex0X6QAFNK5wuWxCbupHWsgxRwKftrxyszMHsAvNoNcTlqcctee+ecNwTJQa1/MDbnhO6/qHA7cfG1qYDq8Th635vGNMW1w3sVS7l0uEvdayAsBHWTcOC2tlMa5bfHrhY8OEIqj5bN5H9RdFy8G/W239tjDu1OYjBDydiBqzBn8HG1DSj1Pjc0kd/82d4ZU0308KFTC3yGcRad0GnEH0Oi3iEJ9HbriUbfVMbXNHOF+MktWiDVqzndGMKmuJSdfTBKvGFvejAWVO5E4mgLvoaMmbchc3BO7sLeraHnJN5hvMBaLcQI38N86mUfTR8AP6AJ9c2k514KaDLclm4z6J8dMz60nUeo5D3YD09G6BavFHxSvJ8MF0Lu5zOFzEePDRFm9mH8W0N/sFlIaYfD/GWU/w44mQucjaBk95YtqOGRIj58tGDWr8iUdHwaYKGqU24zGeRae9DhFXPzZshV1ZGsBQFRaoYkyLAwdJWIXTi+c37YaC8FRSEnnNmS79Dou1Kc3BvK4EYKAD2KxjtUebrV174gD0Q+9YuJ0GXOTspBvCFd5VT2Rw5zDNrA/J3F5fMCk4wOzAfMAcGBSsOAwIaBBSxgh2xyF+88V4vAffBmZXv8Txt4AQU4O/NX4MjxSodbE7ApNAMIvrtREwCAgfQ", + "pwd": "123", + "policy": { + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "sid": "https://kv-sdk-test.vault-int.azure-int.net/secrets/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493938557, + "updated": 1493938557, + "recoverylevel": "Recoverable+Purgeable" + }, + "policy": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/importCert01/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297, + "basic_constraints": { + "ca": false + } + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1493938557, + "updated": 1493938557 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/ImportKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/ImportKey-example.json new file mode 100644 index 000000000000..1f6f808d9a77 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/ImportKey-example.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "key-name": "ImportSoftKeyTest", + "api-version": "7.0-preview", + "parameters": { + "key": { + "kty": "RSA", + "n": "nKAwarTrOpzd1hhH4cQNdVTgRF-b0ubPD8ZNVf0UXjb62QuAk3Dn68ESThcF7SoDYRx2QVcfoMC9WCcuQUQDieJF-lvJTSer1TwH72NBovwKlHvrXqEI0a6_uVYY5n-soGt7qFZNbwQLdWWA6PrbqTLIkv6r01dcuhTiQQAn6OWEa0JbFvWfF1kILQIaSBBBaaQ4R7hZs7-VQTHGD7J1xGteof4gw2VTiwNdcE8p5UG5b6S9KQwAeET4yB4KFPwQ3TDdzxJQ89mwYVi_sgAIggN54hTq4oEKYJHBOMtFGIN0_HQ60ZSUnpOi87xNC-8VFqnv4rfTQ7nkK6XMvjMVfw", + "e": "AQAB", + "d": "GeT1_D5LAZa7qlC7WZ0DKJnOth8kcPrN0urTEFtWCbmHQWkAad_px_VUpGp0BWDDzENbXbQcu4QCCdf4crve5eXt8dVI86OSah-RpEdBq8OFsETIhg2Tmq8MbYTJexoynRcIC62xAaCmkFMmu931gQSvWnYWTEuOPgmD2oE_F-bP9TFlGRc69a6MSbtcSRyFTsd5KsUr40QS4zf2W4kZCOWejyLuxk88SXgUqcJx86Ulc1Ol1KkTBLadvReAZCyCMwKBlNRGw46BU_iK0vK7rTD9fmEd639Gjti6eLpnyQYpnVe8uGgwVU1fHBkAKyapWoEG6VMhMntcrvgukKLIsQ", + "dp": "ZGnmWx-Nca71z9a9vvT4g02iv3S-3kSgmhl8JST09YQwK8tfiK7nXnNMtXJi2K4dLKKnLicGtCzB6W3mXdLcP2SUOWDOeStoBt8HEBT4MrI1psCKqnBum78WkHju90rBFj99amkP6UeQy5EASAzgmKQu2nUaUnRV0lYP8LHMCkE", + "dq": "dtpke0foFs04hPS6XYLA5lc7-1MAHfZKN4CkMAofwDqPmRQzCxpDJUk0gMWGJEdU_Lqfbg22Py44cci0dczH36NW3UU5BL86T2_SPPDOuyX7kDscrIJCdowxQCGJHGRBEozM_uTL46wu6UnUIv7m7cuGgodJyZBcdwpo6ziFink", + "qi": "Y9KD5GaHkAYmAqpOfAQUMr71QuAAaBb0APzMuUvoEYw39PD3_vJeh9HZ15QmJ8zCX10-nlzUB-bWwvK-rGcJXbK4pArilr5MiaYv7e8h5eW2zs2_itDJ6Oebi-wVbMhg7DvUTBbkCvPhhIedE4UlDQmMYP7RhzVVs7SfmkGs_DQ", + "p": "v1jeCPnuJQM2PW2690Q9KJk0Ulok8VFGjkcHUHVi3orKdy7y_TCIWM6ZGvgFzI6abinzYbTEPKV4wFdMAwvOWmawXj5YrsoeB44_HXJ0ak_5_iP6XXR8MLGXbd0ZqsxvAZyzMj9vyle7EN2cBod6aenI2QZoRDucPvjPwZsZotk", + "q": "0Yv-Dj6qnvx_LL70lUnKA6MgHE_bUC4drl5ZNDDsUdUUYfxIK4G1rGU45kHGtp-Qg-Uyf9s52ywLylhcVE3jfbjOgEozlSwKyhqfXkLpMLWHqOKj9fcfYd4PWKPOgpzWsqjA6fJbBUMYo0CU2G9cWCtVodO7sBJVSIZunWrAlBc" + }, + "tags": { + "purpose": "unit test" + } + } + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/ImportSoftKeyTest/2eb4a15d74184c6f84159c3ca90f0f4b", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "nKAwarTrOpzd1hhH4cQNdVTgRF-b0ubPD8ZNVf0UXjb62QuAk3Dn68ESThcF7SoDYRx2QVcfoMC9WCcuQUQDieJF-lvJTSer1TwH72NBovwKlHvrXqEI0a6_uVYY5n-soGt7qFZNbwQLdWWA6PrbqTLIkv6r01dcuhTiQQAn6OWEa0JbFvWfF1kILQIaSBBBaaQ4R7hZs7-VQTHGD7J1xGteof4gw2VTiwNdcE8p5UG5b6S9KQwAeET4yB4KFPwQ3TDdzxJQ89mwYVi_sgAIggN54hTq4oEKYJHBOMtFGIN0_HQ60ZSUnpOi87xNC-8VFqnv4rfTQ7nkK6XMvjMVfw", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942691, + "updated": 1493942691, + "recoverylevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/MergeCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/MergeCertificate-example.json new file mode 100644 index 000000000000..2efedb34f35c --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/MergeCertificate-example.json @@ -0,0 +1,70 @@ +{ + "parameters":{ + "certificate-name":"testcert", + "api-version":"7.0-preview", + "parameters":{ + "x5c":[ + "MIICxTCCAb....trimmed for brevitiy...EPAQj8=" + ] + } + }, + "responses":{ + "201":{ + "body":{ + "id":"https://mykeyvault.vault.azure.net/certificates/mycert1/f366e1a9dd774288ad84a45a5f620352", + "kid":"https:// mykeyvault.vault.azure.net/keys/mycert1/f366e1a9dd774288ad84a45a5f620352", + "sid":" mykeyvault.vault.azure.net/secrets/mycert1/f366e1a9dd774288ad84a45a5f620352", + "cer":"……de34534……", + "x5t":"n14q2wbvyXr71Pcb58NivuiwJKk", + "attributes":{ + "enabled":true, + "exp":1530394215, + "nbf":1435699215, + "created":1435699919, + "updated":1435699919 + }, + "pending":{ + "id":"https:// mykeyvault.vault.azure.net/certificates/mycert1/pending" + }, + "policy":{ + "id":"https:// mykeyvault.vault.azure.net/certificates/mycert1/policy", + "key_props":{ + "exportable":false, + "kty":"RSA", + "key_size":2048, + "reuse_key":false + }, + "secret_props":{ + "contentType":"application/x-pkcs12" + }, + "x509_props":{ + "subject":"CN=Mycert1", + "ekus":[ + "1.3.6.1.5.5.7.3.1", + "1.3.6.1.5.5.7.3.2" + ], + "validity_months":12 + }, + "lifetime_actions":[ + { + "trigger":{ + "lifetime_percentage":80 + }, + "action":{ + "action_type":"EmailContacts" + } + } + ], + "issuer":{ + "name":"Unknown" + }, + "attributes":{ + "enabled":true, + "created":1435699811, + "updated":1435699811 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/PurgeDeletedCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/PurgeDeletedCertificate-example.json new file mode 100644 index 000000000000..6dbabbff4b1e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/PurgeDeletedCertificate-example.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "certificate-name": "deletedcertificates", + "api-version": "7.0-preview" + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/PurgeDeletedKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/PurgeDeletedKey-example.json new file mode 100644 index 000000000000..114f407b7cd6 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/PurgeDeletedKey-example.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "key-name": "testdeletedkey", + "api-version": "7.0-preview" + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/PurgeDeletedSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/PurgeDeletedSecret-example.json new file mode 100644 index 000000000000..bb9ce316e025 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/PurgeDeletedSecret-example.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "secret-name": "testsecret", + "api-version": "7.0-preview" + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RecoverDeletedCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RecoverDeletedCertificate-example.json new file mode 100644 index 000000000000..6922eb6fbbec --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RecoverDeletedCertificate-example.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "certificate-name": "CertCreateDeleteRecoverPurgeTest", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d", + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d", + "sid": "https://kv-sdk-test.vault-int.azure-int.net/secrets/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493938486, + "updated": 1493938486, + "recoverylevel": "Recoverable+Purgeable" + }, + "policy": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/CertCreateDeleteRecoverPurgeTest/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297, + "basic_constraints": { + "ca": false + } + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1493938486, + "updated": 1493938486 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RecoverDeletedKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RecoverDeletedKey-example.json new file mode 100644 index 000000000000..52fee42d9f20 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RecoverDeletedKey-example.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "key-name": "CreateDeleteRecoverPurgeTest", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/CreateDeleteRecoverPurgeTest/6fc2be54c6be4a7ea7bbb8a2a99a1996", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "v-SWMCmPNKoK_rB_pNXUl6Iwh9Kqd3XzQlh6SXi_slBishqP7pyKEFjNbUvMSlyvPt21rJupLbJr-yhsK2Rq2V6O0doGuCsoadgNGih1aVAuUJAJls1-b-G1IJjD18ArM4RitnCvJmQFqyK2RVHa3EpEfaQW4gcRrsRAhiJDjc1L1S3skdt-E_rZfL7DIh1ZtqFyQAqIWSAG0BXDdbgfEx1kJKqH-HRokDKeMCIaJtKZof6e-DJr3e9Iy8aAR7V-BsZ7vY7JMjyeEukMzEji4MEsIyOESL67DgFllDEi4OM_3WKyxr6uXxzHDzmppWsk2ykLsYA_ALLnR3ZNZCuL9Q", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493938342, + "updated": 1493938342, + "recoverylevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateDeleteRecoverPurgeTest" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RecoverDeletedSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RecoverDeletedSecret-example.json new file mode 100644 index 000000000000..b18bf1187861 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RecoverDeletedSecret-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "secret-name": "SecretCreateDeleteRecoverPurgeTest", + "api-version": "7.0-preview" + }, + "responses": { + "200": { + "body": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/SecretCreateDeleteRecoverPurgeTest/16f5f7feb7004280b7f3b8ac50cd01f9", + "attributes": { + "enabled": true, + "created": 1493937960, + "updated": 1493937960, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RestoreCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RestoreCertificate-example.json new file mode 100644 index 000000000000..5b65921c09a6 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RestoreCertificate-example.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "certificateName": "testcert", + "api-version": "7.0-preview", + "value": "JkF6dXJlS2V5VmF1bHRLZXlCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUkwTXpnMVlqQTNZaTFrTlRRM0xUUXlaVFV0WVdVNVpTMDJNVEJrWXpNNVpHWmhaamdpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLm85bmpNWEFSZWVla2NaRXBsVTNjdUxQcVZlWmxFbGRDM01XOWpYR0h6bnBXRTdHRGVOSXJraGZscHdTWXFnQnBYQkozMFpUQkRpRmpROENXSnJfUGlsUWNDRkZyN0xrdWJhWUs0TW1zcVh5WGIzbkRJcUJkQmZIUVNpZ1ZET0J5Ym9sUlRNNDYzYjBTbXhLVzJheEdFS2NuZzQ5WFkycG1SR0Vrb0plcHJWZ0tyRkpOUGQ3cGJIS3hQSWdDOFlnT2xudnZxR280RlRDSzh0ZWotcUt2UzBfRGV6Uk5vdTZqZ25SekpxX0g2NGxWMk1hQ0NnUy0xbTlyOGVOTVVvSlhTV1hwc0lneng1RzdEbzIya1ZEY25vMW9rajlCMXNvbklkWmtuY1JybDJBVHNRZVlzZXdkUVd1VmhxRzVLN0pNQWo5YzBRdkxhTmlpdl9PY2pFcm5qUS4zbmI4azJ3SEcyNHFJelNNb184WG13LnJzc3NMNjJ1aUNfTm9IbG5zQlgzcEEtck1uY3g5R3V2NmJYSHpKamxwOWNMUnVaSDBSWlJYVXRwU3BPQWdyZ20tU3BxeEdWSjd2bmprbV9FSzJwYy1sZHNjUWtRSDB4bVFVcGZFNzN5b1VTYTNXVVNMS2VIVnJLdUg5MUtJR0tLODE5ejc5d1Y5Y0F3UjlzcHJxbFFWZnlKdlNFM2tnZTh1RVBpRFFVMFl5WnJqVjBsMGJCU3VkeTN1MVlsVHB6Wk1EWmpUcE05ZGtMclgtaGdxZ1FGa2xFa1hNRWlzd0RDZVM3Y3J2bFg1bnVzbWh5SkZCMklCd3dxNWJieHptV1diU3JOc3lFMmJmWEpXOWN4TFlQcnJJZFpfbkd0X29RSGVQcUFZTS1iVnpTdzdBRGJjMU15NTZwclBGLW9PSm40MHptOTBaaFBTVGMyQXNKRGFBa3R5WFU4WktOYUhFVUlHLWI1SGhUdFBuZ20wN0FrWEtQNngwaDhzZ3ZIaGdCeGpfdWRfQVpQc3pLWG1HdUhFTW9lRGhpT3NkQVdRR0pwR2t0NHVlbmZyamNSeXVlaXJiTC1RV3o4MEtZUnk1QklxbzVJc19RVHpWN2dqMGstYS0td24tazNsNTJ4YjhaNkRXd2tWZ3hqUlNXOXZnV0pVd2U5M1ZrVWtHM3NLRW5SOE9ueTNjWlhQVl9LbWtBTEdlR0ZzQm53SmQwY3dueTBCN2I5VWQyQ19kWEZ0N1BvbnFVNldfT016cC1Nb1NtRzRHbEFpUkVfQ3FrWlhkalhIMVItSmpObUNfdXlPUTdaN1BVaDAtNmd2YUxpcE1CamlWR1FwdzlEZDhmVmtCbWk4VW5uOUxPYXJmSXVtcEJyUE43TTJhM05KdjN6b0NkanhZVFVUMTN1aElpYWl3aExoUFZhT2pUbFRmTkpqbHhIbG5lbGJ1RWJsZTk0bVV1bW8wcjhKRlFMSDdfRjhXMVo0OC1BcjhYYXJwMXhIY0FReHk1WWYwclktdUU1dTAyRnRHUHlPZ0JfNV9WdFlNR2VfRE1mdENLOGVMZGFnVllMRDJDNDUxTldZeVVfeHdNUWdQbXBaMWFnSEdCb2s0ejhsSFBndVhCQ3R2WFFuTHBXQTVBamdOLWNoWjNwUGJmc2RkNjBhekJuWDVaVXQza2hYaWNDdWk4b0xidEtzQUdmckNOZzFwT2Q0MHBHMEJlVy1lNVE1WWQydjY4eFh5a2RiTXhFblFCM3Fzd1djVlh1QXBIR18wREZVVmZvSlc2aVBZcDNWVE51amM5M3QtMDcxWnlZbUZ4V0RfVThMYTAtM19RLV8yZ0pwMVBaVV8tMVBRM1huLXdSWk1vb3JkZGZQa1VPZ0lqdWkwa1IwZWt5RjZvdWdLNnJrSVZHaGp3YUp0ekdKczJLdGxncnRCcEs2MXZEaE5zbFR5VHU5OUp2T2RFTXhwRG5lTEg4NnlvVnhxT3lIT3lxNjByXzdpTHgtdy03Q3FzWTloT3dmQlBZZ3BQVlM2bm9oZVBocTkwaGJTX0lrM21YbnRkRUNMREtSMi1wWFh6bjlPRjZIN09EdHB4S0VXQkdCaHJ0Ykxmd2JZS3dmWmZSVTJVUHpkLUxFd1lQdDloU203Z3lSODNoYkZiSFNBV1cySncxRWl1c3FURWRsRW1lQ3k2cFp1MVFZWko0TUQ0OG5rVXMwdmVHUVhTU2Ytb2RhQm1fYjZZdVh1cWcyWk03MlZjUTd4ZzV4MmpFenFqcllmdjdTTGJINFZBcWp0aFg5LUdRaWEwWEZaS18xempIenhkd1B0R2lSOHJfMkFFZTgtRXFoNi1FaTZKdjRFZjYyMnRrNWFJUWx3R1pETWpGSVNuUkpRdV8xcnJiY1E3enZsbWhUSWFQcUJNRFVxeHBEOXNWUlhuSHdIaTl1b1BCUTllbWJIMkV5WDV6MEhWRXlDa1JEbUd3cmR2RGdsOFVzMUhURjVwYXlYZmF2WkZUZjl3WFZyQXpsRFBEQkFJVFMzWnVJMEJWR2pJUGV1SnRiako4S1pTczRFQVNRRTVyVjViTUpNQXcwa19nYkVRTEZGSjJVb0ZzcWU1QUszM2xGXzR5cGMxU0JaWjJfUzYtbEQyNkpyRFVJSjFFRmJhbWtoUk12bWJIT1Utc0hDT0lRcHdadlJzV3Q3NExSQ1ZyQ09jMGpUdE5TT1JPUW5XRHVXRlFXSzk1TkRGMG96WjIyLVFEMU9YOE9iU3daaHdOXzNfS1pHRmtVMEhNdzNjSTI5LWUxbFltRDV3cmJ0ZlRFbllOeHJKOGpuUWFBY2FoNy14Q0JKeUQ3elo1MXIzRVVyY2VnazBzc1dLeHRPVjRLcTZENmxuVmU3bFpUT1dfTU5aZi1JSzJUbnZCaVZIMHk0SkVGaUxzSDJHbTM1d28yYlZVaXJsT1ljVEk1NlZhdDhMRWhGaEotVlUyNk84NHo2dUJFZmJucEZLbmdKc3pfYVlucW1zNWV1bmd3ek5ndjdlT0U0cUdKSURyMTRBUXRWdEYxcWdrZHNnVllWVXg4U29SQ0NobE5VUzRNRGxhc1hwS1VmV19ENWIxbDRkbXZiNEZNRHJqakJ6djk5dGJSeGZFYUVOSFlYTHZFZnJ0b0pMeW9na2tmNkxlbVoxVDZRbnRtNlR4S1IycU81WU1vMnRJZHlQNmZNRmkweEYtdE1IaHNSdVN3VEpybW1nREcteHVpZllVNkpfaElSNkMzVmo2VkFMMW1oZy0xeW1pRXZuanVLbElONzc4NmFWdVNpNmx5TjJJNzZqY0R6SHZ0VW1ibkVvWWtORHNPQXdqQk9MNFBlS0VjR1hWcm5YNDJhNW5IRWM2cmZQdjZ0Q2tVSUI0UldIdzEyUTFiNDM2N1JvRS1PTWN3TnV6ampob1M0S1ZJbHo4UEFMOW9YYTR4NXlQeG1aVzZ0UUVna1pKeFhEcS00SWRtd1UzTnpVZUoxdGpNaXFsc0xRWDdlc29fTHRtTWJ3bm83YkI3bjRlVnZ4aUtQU3p3dW94c25aaGs1b3ZSSE1xU0NtZjU2MjJvUTZvWEdmNUJLWExlQWdqaE1Sd21razEtUzlGajlyc1hlT19VYjJOMF9hVEFLemlidXIxNVcxaHI3Wk1PVFlxOFlSSGVPaWxSX3Bkdjl5NTlDRDQ1WmE0ZXFURHVrNmRxZ1d4YnoyVVVtMnpwM3pvTHVKSVZ1Y3FIaUVRTVNfMnFKcy1xQTAwT2FFY3huZTM2Q1RsZVNwZjF5cjh2VjNWNW1mQU5zRnJBa21CMnBRWTNfZ21UbldTYTJ3UWlMa2RFRllPSExTeEk5UVowNHo4ZFRfbW5QMmIwWV96N3ZLa0VGQmFpNU02UFdPWjVIOUx1M3Rnay1fR0g0ODd6ZHpuQm0weWZZY3ZIOHJUd1QyQl9UZVRFMG4xcWFRdDRiQ0diUkFQNE1DTDl0SGlIcmlzWEllejQzZlZ3b1c4R2x4YmxKanlLWkpXbmlRNjlBYks3SmYyUER6d2NVSHhkZU5HNGxEZmt6WmFxU2lybGRzZlhXOHBGLWZ6WFVVWHR4eDF4Um5nQ1hJVkxLbU5ZbV9CNnNrNGo0VzROVFMwQTBOcFhsZGJCWjZWWmFDMDNvRHVGUFY0MGtwdWQ0WEd3Q1l3M244ZjFHb0Z6Sk42QjFqOTRLeTdtNE5YT1JsQ3ZaRW5qZTl6T241T1d1ZG9USWRoRzBobXVDUTZ6TXI2YkVaTUFoV1ZFdlREY19iXzZsOWdLWmVxNmVtekxvcmptOEQzLXcyLXRBYlE2Tmpjd0J3eEhMZzlCRllRRFdvaU9UVmJKN2VBcUVFMHVxVkhBcE9KbFVIc2tmQy1uV3NzOV9fRTFURHBLcjRfRE93NFhPUGNzT3dlVU9EUWg3cVFXRE1ZcDVHU1poVWE4MVVHczhmemZKU3JPbmtaTmRVTS10Y0h3R01mX3didy11dmt4UFUtV0tvNUNqR2M2aU5KMDB4MjZZdUpCWXd6TVFyeDBJQWgxMjVBWlozX2FvaFFpLWw3a1pZVE82Q0JVOVZsYllNMndrZXp4ZGhrQ1oxd080Z1NNbDlKU3A5ejhxNV84SU1WM1pma00xV1VqSGZMQk4xRXdFMjRxZFVzcWxyU3NZN1hQaVlpcXQ5ZktXVmZDTWw4RU0yd2ZHYlhxMUI4eWl2UlpMcko0eEk2MUdVUWJFVGU4akNTYTF2aUxxZ0FIa25IYjVjVHIwbDRhTW1EZGZKWnJxZEdpb1lPb2IwdHBuc3IxanRfZm1obGhJa1NSQnREUk5XWEU1OXBjVXlULXpyVjBxZl9sOHN2TlNEV2N3d09YQ3lITWZzLWw0T29xMldVWTVLQi1nSG1HYUJod0oxa19ra3V2S0hlMl9TY0loc3JjTXV1eW5aLW14Vzl5NHBBS3pvdVFsQjR0ZGZvbHdSRk5KX0tHYWJPZXJiWFdDT0ZTd0JVTjdNaG0wOXNyVS1VWG5od1IwdTYyTjVvMDlfbGN5eThnWDg1ZUVrenhuOGZ2NHd2T0Y2dUd1cFk5UGxpSTRLMTNqSHlOd0ZuY2VmRlp2b0dxVlhkcUg5RGJkYS0zY1FhbVFlNmlMek0wRDlnLXlFc2NBTkpKS3ltelVzemZZdV8yY0p0TEhsd0I3NVhLeW1EMG9nUkRvRkRwTmNPd1dRRUlwdVJwU0pfdWtzR2EwZkd3MGVBTU4tQmc1OUs3emhRWHJISUZOckN1S1VPMVdvTkV5WkM2UGlKSUwtUlRsTFQ2WlBNZmdSZzZiUl9aQk43X2dseHBIakNDaFZXMkZ3MnJFUDJJX1pSeHFqdS1WbmVwV2o4eU1CaHZXZzdXNm9QWm1odmVtUTBkQUljNVZTbVVaelhvNFVURmJxSFN2MGlyVTNscVk2eUl1MGRPd2t2MlF4ZENfQVdRUmdLSGRUeG1xYXFUSXJwclZyUHZ1MDFQSGlFbVRnaDZZVEZ6Yllqb3JEeFExWDhlTUN5Rl80cWNjMnhOdTJRblBIdUR0RGZkSy1NV2xJUDhHUEhSMmhPMjlCa0JJSEM4TlgxZmxDN1ZSZkZsQ09McGVIeWl0MGRSd1d2S2tieGNIWl9fRE5ZLVBNQlZMZGpyR3lxT2JoQnpQZHZMeFpXWVU3THNRbnM1dmxiMTc5YXczX3VmclRIWGs0MVpjaDY2ekFRRl9tekQ3ZEVuMm1fb2tBaTh6NTRwdzdxUDAwNHkzenNPd0RmR0htYWF2c3dGMW5NMUN2YXhXajRINE45dVNUaV9DM1oza3lTRHlUNGdUZjNqc0FKUEJybXdSQVBpaU5PTTU3c0x2Y3dJRk9ENnA5QkdWbjFwbjQyZGRTU3A1M3JieTZEcnlwcHdDaDFrampQX3lCbTZRZnd6MElGUWJiSG1zVDNVa2RMb1dURjFSMF9sbjJtR1kxU0hHT2o3VHl1YnQ5d2xLVW5nczVMTWhVcHo3NU1LR3F6UkFnWXNKcHVKUVl1RVpKeGFPSHNmY2VwakdrcFdoMEtfWkhZUEJESzIwOFVqb3FqMDdlVVVueTBaXzJrNXUxTjQzWGJ3V0ZvWVBhdndheW1MYkhWdkRwbzdwMU9JT1IyNkt0SzdPeGlnZ0ZybGVISWNaODFwQzRCdlNzRnZsY1BCZEpHLTZxWTU0Q3J0R2xhaDRvQWplUXgxWS1YU0NLNnZLYUIwWnZHc2lIajhRQ0ZURjRuLUJqTWIzWDcycDJ5Q0tPRlpMRk5qcVR1aHJoYXNnMi1pWTNOTWdwVEQ5eVBSdjA2X1VpcEVfYjVsQ0R0Mmx5QU5NYVpZR1RvSmJTSVhBcFlyU1hEM1dFWllhTGUzQmFSUEJUYTAyeWpyVFZPRDRGNHRFR3c5MkZJZThOSk5NYXRXMFhPSFAwVWxKTXlQUDF2MVdvOUh5aFllaDFfdWg3SlRLcS1hWnJjOS1Xd0ItQXBKTHBQeGxmRzlGZkgwdjNwSTl0Z1VndWJmSkJQVjMwNll2MlNqQ0M2MmVYN3VFTUgzcXQ3TmFYcFVsNXZEVHpfMF9Vc3VlWERQcDNqV01XQTMwenFaYTRFT0dXdElMb0tEM1RjRWNVcmJONGV1bHFQSkFNcWdWdmk2YWRGdTgxU2w5cU1rVVUwaWpqMjZhZDFaeVlEUUZtWlJ4NjJYUW9ZdG81bXJ0eFZhYWtNNndqbkVPSUdJaHhBTnJoX0dNVzVxREhzMEV6TDU4b3lOY0Q5dE1MUC03N1FCbTZwUTFsR0swMVJ6Y3FzTk14ZzRMTzl2ZHQ3NFpIdEhMXzA1TjF2TUt4TE5GbkdhZmwxN1E0eEM0Z3NQeXpYdzBjcklyV2tIQlNQX0NoWE94SmZORWdyNjJOMXEzQVJZa0U1TVlCbzctM3djb3dNT09GcTlrakN1ZGpoekplRjRTUHdfMnFVWVhZRTZsNXJTYjYwUFlFSkJxdW82Skh5ZmdlOXFJX0Rzdmg4eEY1STJfLWtLT2pxU3FZam02NjU0cXVES3phQ3JWLUJFLWtQNF9DOU5OQ0xTaEVWUV92Z3hYdDhzbTRWNGNRMElDRmFzaWV6VnNuV1QtYmRQTGxBT2RqOS15RmhYVTRUYVF3YnZqQ0E2UHQ0aDNVWGdnQzNqWU5IMmJtRGpYSzhFdFJYRTV6cmJsTDRKMFZ1OGxHQVBZaGtOcGNOakNrNWhSSW5jT0dybE9aUk9jdTdSeVczR2JWM2Y1MGJKN0xLNHJjMnJCMTZuemhBdk41WXlydWdwQzdCOE9OR3NTY25ha1V1alJzRzZGYVpydDNzTDJMOW5RTUNoNE9INFF3VWpKWFZKUFJ2MHhPTF9jVEQtdjk0QWgwbWdtcFJ2Q1dhUkl5MXRxeDZHTmZ1R1Nyb0tObmtHYjRiRE1oblpZMmwxQWluWHlCMG5uRGlvci1EUmo1cjhRZi1iaUR6cGhTallzZTZrakdLR0ZObzU4WjFfaGxEaGFob1pQX1lRdlBtWi1Tb2pNaGhMRXZqMXEyZzZWRVd6a1FDWTdIWVEwM1Y3cHVCVm4yaXM1NXpBSGV4cGpERWoxWDgxWU92bnVTdXRhMGx3VkFEMkRoNjZDcmM2VVh2SEtUZTBCeFlsQWdVdkhQc1BkSy1OdVk4S3RaeGNqTWNDVWM0OVl6VW43RVBTamFNaHJ2Ni1mM0pwc09Na3JwREpLM0dPTUVRMUV4cnhYV1lGaGtLaHR2UXZkMXZCVS12b0pRcWJveU9vS1hMM29Xb0FRVnljWlR3Y2laeW4wbUtkVF96NDNFZGhNcDNKS3N5blJ3OVZtSzk3Q3lldGl5LV9HaWVMSngtWDladVMzOUdNa0YxaFVmYmkyc3FJZGZMZ0diem5uMTluTlRVUDlOR3dhaWhybU9Ib1lZeUJ6WE4tby1UWUxhSS01bkNuQ2FSSW9QTF9XSVhyWDZPSzdZU21IWjk4a2xJS19JNTlPSXlWSllrMVh6bGVwd1lPLXUwU0x6bTEtN0dKSE54RGVOMlZhUEk3TThVem10X0x5alliWWxocFFJQnNyUktsMmZZeExKaGt6Q3NjcWp2bVhDemRLVDNhNFV3NDJ4eDlsOWl6dFQ0UmtnV21fYV9YWWk0b0gwdjNCUXRSZ3NfUTBPaGo2T2Y2dEtyZU5XZmcxVDRjMk01SERJd3UxTkl2QXBqNzZtOXJWQkdPWTZFUnhfa2Y3d2twb1g5dWRvcjBCbEx4a1FCc0lwZXpUdzc1MTBncU81Nm1UWXlBUzFCUVdOY1Q2aWhfN3F4ZTVoUkVlZVB5YUpFMnhqR2JNWGg3V1hGYjN0ejVWVWJOTFpxMjBiM3E0UFdkdjJXX1Foc2VUY0JTRDY1eVFPYndTai1UcVpNNi1teUZHb3B6dVdfRWcxU3pzNzRaY3RMSUxyN3pMLXRyeC1WTTVfVHllMVZXbG9ZOTZVYUJyUktpQWU1SVhKMlBQd2RIY1p4SWx4N3dBRXdueXVOZXA2b2NKcXRwZUJ1elB0LTFaX3UyWjZrQmR4V0lpYlVEaGxOU3AxM1NkTGw0Z2hkemVqZWFaYVllRDVtTGltWWJ4dEhsQ1ZiTm0yNU1ZbDYxMFU3QlZnNVJJSXB6VUdmZ2Z5NnpJRzRLQjBMR3BISzNhdHRRUExvQ1VlTDRYNVdBUUFsb3BRa0RKOU5lTHFGdHN4cWpZaGJnZ1Z5am9ScjNPOVhzYzlJVEtVaXJaUDlyTVl0eFduT0tUck9YYVk2WVR2Wi05QUhpT3ZfdTRhOElTS01DVng3OUlnXzdqTjFfREhjdGd5cEEzVnpkbjNKdlJJQTlfbHZDV2dTSS1NUjlPQ19xekhIUmU5dENqWklDVzhwRURSYVhZOHc4UUQ0bXJicmFLTTNsWmtTNUF2NVp2WjFRTDJlZkExbXlJdmN2czhmekxRUFM0Nm0xX3ZPVzcxN05ydDQzeUcwbUZxZnk4aExaZEUzQ2RkMzRtVVFXWVdqSkdvQXZ0VHBXRmpwWkwwOERjQUd0RzVzdkU0Mi1WWjRqSVVYQ2JsemZaczl3N2VsNThvRkJLUng5dUJLby1PWmYxTVloVEZrSlU1V3YtUEVreXRPSVpfU09nZVM2RTVMTUZsOVpZenZ0QkJuWWF0bDY4NGpEdWx0STh4LXpmSHdwUEFwNk9CQVpxalk3S3JoSVJuVGRoc2Y1VUpCcmtvU1JGUFlaaXE4RjJLWHA2Nm1PbDMyRm5RTVprMUlDVkxiYVpnUFlWNnl5UXpZdEdhbjhOc3BFTG10RWkwMVlTZE1ySUxkUF9TVTZwXzJ1NU1oY0RPMDF0Y2hwMHp6eUVfTVp4YWJodXpMWUVIeXJvYl83cjFKdWNjZUQ4SlM5T3JBdEk1YXdsbEhGSFRRWExOWGJuTHdTQ2JrdHNiTGFoa05ya0ZXR1RDNFRzUlBfYTlHMVhFTE5DRkhaMVhvS3NsQTdMMzFGaWpyNFpEYjRQeW5hT1BrSlhCcEx6MGNLN2FmeFVxNWlySHhZNEQyVkdNT3gwUmc5UEJJeE1vdzN6TmVGZ3Y5dzRTdkJ5VUpQdjNGV3huX004M3g5dldiWFh3bU9LbHlLNVpWQi11LWxKVno5Rm81YWRfVEtwUkxqSGdNWURKNU9Ka2dhaEFQMmhOaG9lb0FicnBPNzVYT2tYZ3pONDdwVW1kdzhmZV9FN3ZSeUREZi1LNVZNS2UzOXRPSi0xRmxtemJVc0pET0lScHp5WVl0Y2Q4cGtPU3JQYnIzMWdJNFRIUjJHV2xwZWJCZ3VhYmppck9UTjI1Zy02MmRPWWVKNHVwNjI3MjdnbWNQWF9EYmJfSFdrTnVLaXBmdkJ1UmVNN2J1WE9LVzg2bllHSW5ZNzJZZ2lvYVpIaEJnY3pHbktuUUlkWTJ2U3NzQ3E2b1FSUGJqeHRQZ1gxT1h2bXNucmNBencwN01ULTNueWF1RDBfNG90RGJueF92dm1fM203ajBwcjBGUWZ6NWs1UEVNUG1sOFVhenFxX2xEU3djV2JOU21JbWF3OWt3U2NXN2xrOUViNTRLRTRhaWt2bVRxXzRuN3lkSDNQblI3bC1RMXE2X2k5VWdHUVFfSmk5UDZQbmszQzd6TTVYbDBpYllEVXVUV2FUdlRrX2ZjaXo0VUJXWkV1T0lLU2xZaHVBVzFQUTJPU3NiUWxPbDU4U3ZvTEYtS2w3TmNkRXRBODJVWjdkLVFCN2xKNWFCcnd0Vmx6TDFxX2Y1UGd6a2NtcW1pLVViM2tUQ0xlNjJYbzN1MmFvSnNTQ0c4bXhwZkJ6dVFVVkk3WXdTa2ktWUtNUnlJSGhuOG9xRDNQS0xMbHk2LVZkZy1VREE1RWhhLXA0TnZYb2lLb3ptRHdBZFFpeG1IcnJTdUEwWmh0eE14N0FSc0pqc285blZKR1BOSzhCeTMtbXQycnNOOHlMdHpyRXdkUzBtLW1sRHRKak9CWHJ1NmhWOFBPeV9vSWVzYmJtWkcxSk96Tkl5YmhPOWdNakpsNTBSQXVmcW1sSXJpOEVXQk9vdzdVT1RKQjgtTkR6VzVXdWNiS0VLOGotdWtSYXhhQklPcTJBTnI1Tl9hTEF2RFpmalp1cDl1RGNTc2FUOTNWR0dmQlhHX1BYRlhGWnNtd2NnamxsQWN3bkhCS2V6QWd3SnprRXpFaEdEOFhQMVh0dXJPZHh2YTRyd2ZtVG1yM1pHVWFmY0tTUm5malpnVERSVThVRFd4ZjRwMjB1T1h5RzBBUzlJLUF6WGN0Nm5EOFVQUlB1WDQ3UG1fN05mdWFVTkt4SEZ2RFdOdWYwcVE1OFlvZmhydjJlRDlzUFJFWV9CWjhXWm9IYy0tbVZ5MmM0aDdvTTUzQlFKbTQzRzNkaXotclRwWE0xUDExakc4em5XU3RBQkJxbW40LXdKVVl1UGpDV0VtY29qdGtRZEZmcjQzRUNqTzE1SDJaZGN6MkphZmpUcmxPdWlQOG96ZjEwa2RTYjBURTFVOXI1dHRIU0ZzOUxPVlZHVjJnQUxjUGtMU3R0clgwMXZHMWZLS1ZTRVI2TzlZM0pZYW02X0FwU2xONnlRbmlqM3NJTzdKc2xYdHhaMzY2bXI2Vnl6WmphajVVODlJSjdJUlY3eXBkOWtuZy1RRlZMT0FhRGU1eENvZG1jRjY4ZGp4LTZBVWpQWnBHOFYxVG04OXh5c3BTaU40M0lmLURacTlaMXFjSXNDOUJ4XzlxTHE2S3kwNTIydnBKWkw4NEdCZElXM0FuUUdKbFY2dkRXbThpcF9LMjg2NG8zcEg4UTdFWnpqc05KZ3p6RFU2SkU2Y2psTVdhMDR5dkVMa2dnUm9feVM1MWUzam1BNUFFdWpXLUJ6TXlzTjVkeUpiZC1HcnN4VFltck1wMWI0dFNhMXV1ZHBSdWl2cUFLdV9qbTBvYTA4UHZqRjJyNjRXYXZQZHVxcUs2VGUtMDc1RkFQNHFEZE5ocmpJSHpneWEtUWowY2NCRWtZbUo3di1mUWxneUxzaF80bHJZQmVyWnNCMDM1Z2Z2b19CakQ0Q1VWVWFTRkRya2U2OE41N1prblU0UkZXN1NNQXViaE93WjlCd1pmT0tuajV3bDhfemRFTDVLVDBQUm5IejRjQk01OTZGNXhleDFORzNqME80Y3JDbzVod0xMMUVwMnVweVlULXpfTkdkT1MwMG50bGt0dnNKMGFZSURuQy1SSDRYcUdBUXlpY3hJVzNnTXh3LUNvYlIyUGdPa1dLTVBJN2xFelNLN0VKcjZkZENmblhHRF9scE9HSXgtUTROdjFOU3E4VGw1dkRtdmdOXzZCOEhHbmV5bXdpQUlJZ3NpWWhfUmR0NnBrdWJLVF92aFkwMTI1WWZkck9NaW9keTFLbEpNR3NJNGxqX1dJYVRHQjdoY1dtY0stMy1NNWlZVnJUSktaR2RZbUFobXI3bkZVT28zWFFCZkVVZFpKb2Itc1R6eDdNYWttd2JEcHdQdHB5OXFQem03akI0ZC1yYmlncDI3azRTYlVFOXNFWTZVeVVJVk80Y2l5R3ltZThpOEdLY2dSWXJ3YTZmVlItTnNvcm16dmd5eGZVcDFGWDZuR0xNbE5VMDNEblBVU0JLT1RWTzVnM2JuNG1DNWI3anBVQnUwQTk5R2ZkTEJGaXg4dURwR2NsQm51TFhncjcyRFdCRmFKeldkZXNZbTlaLWk0WDBaUTh4cVZwdGpXTnI5Sm5sVDlLeDVKZXdRSHZkeXRRdHRaTXc3TS01Unc5UHJreklWd1JPZE5PVkxwRWl5RmVqM3YyZmJGRFVoRmg2ME00NWRMQ0hqU0k5eC15dDZ6LUVtQlBpdGtkcWpUT3hLam1qVV9WNzIta09tVndhZkY3MzdTcVRKa0lpWlVic002bEJoQ3Rxd2cwNi1DelR4U1pMYVgzOF95dE51aUY1S0JfcXVwcU54SGJ4TTVZN0l5SnJUcGR4MG9qNFZzWDlxWkFjTGxCZnRNaTFUSTVLMkJRSERSNW5FY2UwT2J1SWpjdlNrcjNYMmZwUWQ1cHlLdnBXcXpNbnNuQ3NsVnYyWUY5ZDZHVWFKeHlfQ2MzRVJqOXZIMnRJb2hBckh6VzJlN1lNUTRyQnducnowOXc0aWNnNG11TDdVSnVsVnJLcjdJS3FDYjJyWFViTDBIRUVrTUd3T0pISEVnVWxlYzRGajRNQl9ZNnh4SFJuekVKMVVBRXVTeDJaZG9Bd1JsSjMwRHZYTWMxcFo0NWktYXE5eV9oOFJxaUZSUlQwSktjYzFpeFA1Y1JWRmVpbFhKWXN0cDV6X1pKZ1FrSTdCQlBaR0M2bkZ5RC11LWh4MzhQN0IzQjdUUzdoWVlXdm9ETFpGSkI0a1ZGRUhvNlRKdWNDVlpJaEFMdHlfN3dreFFxdU1mMFNOREQtV0FPWUJkY3JpZzZmYnNKSVhvc2lMSWNDM3hOOGw2X1dzNk1UMXdXODZkcWRUWkJnN1Z6YUlnREJ2RDRNakRLdjk2M0k2c3ZmeG5FWWNEQ3dDalo5M2JwUGRJd0htZEY1ZE0xTGZVLTExMktBN3dCQTJWYjU2cFdBMWk2QXo3Z1N6RXhQRkZvVkNBdFlJUnBFcHh5SVBaQUVHV05zeDNpNEk2Z2lyZi1hUmFWejFXUURCemd3ZDd3TlpqV2xrRVlyRFBBZTFPVnl0bU9HQWlGZmZiQWVPaVF0V1lzMHYzVGFTOGcydk9peXRvakE4ZzM2dDQwQTB6T3pKYnlzUUM0Z0hjODJuVDdQUDJBTFdPU0RLTmxSX2M0eHFWTkxjdlhxZHFBNmpVRlBUY1FONzk4U1FRbGprcmd1bzhEcGxTZTBnODl1VHUwV0ttcFltSFA0WEtmeXRGRWlBR1FDSmIwZUl6NVZsTlAyVnFiRGRMcW1JSzhuNVlNSUtDY2ItY0FUdGFoRXU4QkxQcVE2VC1aa2t4MF93M2RmZjhVX3ZCZUFwS090SERMWUVqcTBnVktxUHhaUWczY3RJS2oxdXJPeTIybnJ5aTlnZWZVc2QzZUYyMnBCQkx2YWVWSk96QUZndk5YdnRiTXFsUW1CXzQxNG1tVGVtaGFlNktjOW9KRF9sLUxKWDZPU1FISlo4MHQ4Ql9VZkdacFZES1NubmFmMmY4UHYyMy1EUmlGNlNyQ0ZKN0d4TEhUNXJSNzU2MW1YUlV5Qy1leWtocVI1ZFZSZDZhOVQwSGY0TlZSbjJiaVdxeWhPR2VUa0hKazE0YllOUFdYTm5XSHl1VTdyNEZoOVVsb2lES2xIQjQ0VjlmYS1YMzE0c2VHZHRqUFNLdWhFRHBMeV90VU95aWU3aThJaGNIaE1XOHlFNi1Oa0lZSnF4cU5EbjAwdUkzSEhEUWtGYzFQV0RYdlVIcnBJUFRJcFFBQ3c1dkNWT2JpUmFoQVBJM2tFRFh4ZkY1S2VLMXRuS1hsZWRxQmRIc3lCUkZuNnp6T1p1UHdOWktKNHlYVDhoS2wyamQtNTlqdWpibDBmNF9WdVJFdmVQOW9FWWtTOHU3UmlBVEVHa1lPVkg3MkZXTzBzLVNJWGVRRkQzX3VvWjdrM0xjSm9GVjlXMDZrQUVWY1dURVZGRUlwamtNMy1FYnJSUVdMcy1heWVYQkNFSUxsQ2t0di1LblA2N0pyZFV0bTI2cnFlVXZ5MzdTMTBCTE53YjRiNHBvREhMS2FveGFuZy1iRjZUb29PR01UU01MWXUzaUlLc0R3Wm9kZG1WR0xyQ3FxNWJJR1BFZTNoMnc1RjFNZ1hyVEU2TmFubXpKckh5eHVPc0VyaGctaEpGeGVCcWE4WjZZWFduTXIxNDhLanNoYVAyeVpFSWV6OG81UEc3cWRWaHFRenhYT1c3eEQwSTUycjBvbkhxM1hzcV9SOGhFby1UYVdPbmY1NW1YYTNWMk81LV9XanZxZThWdzdwTUF5dG95dmh2NTVTVk9xcVdkNXNIdGhITzd0OWlMdDNFYVMxX0ZnaU8zVmVENmlvUVBNNjZsWmhaYkpZZHo4b1RFeU9SR09KbkpjSVpqVm1YSlJIbXF2eXZsUlpjdkVMM19KR1hEOEZGNHlBVE0zaGhlNDN6VEJVdk9oYlRjckhNQTRLZjhWczR4cU02QWFsczVBZzRUbVZSSnVLLUVRWFZCaFE0TEpBbEgxVXZzN3lKYTdLM2hsQlZEMWo5WXRWS2htMVhPNFJySTNrZmVxYmxoMTRHQ1NEdnI2OExyTk53SUZsY1JEY1pKalBOQi1GWGhUd25PbW50ZVItOFY0UTJVa19tczdTTm9ZUElWRnJqY1R6X1ZkQ3dYRTFmMjNocHpqQ2tnWGlsSUlNNEpNMkZmcDNTZTY2c1JHc1RXXzBBbF81R3Fqd3ZfZFBYWDA0RHJNMFI5dGljTHhLczBnM3hkSXF1M0huamxBRFU3S0c1Yl9NUmxUdWJCQ3pEamtJQWRRUEFwcUhaWktnODYyLWloMDE4bERfbFViWEwyMGhFNFBNbTE0eEg3R0dPQ3FWa1o3RVU4ekd5Yl9xWHV4RF9LZHFLSVR5eUc2WC00MHhOeTJ1cWpDMmlvVVpiM25Tam5kZWFiX19kbC1jMDBLWkU4RnhTRnRMN0RreWxpTWM2Yy1VQXBhUlZKQy1aa2NBaXlPZ2NBOVZQa0x5a2xlcGRNYXY1Y1J2a3FvTHhmS3RMU2FhS0taWEdveFd5OWp2am5KZHZfMmZDTXlUeFdOUWl6MzI5NG9mNkNNY09sTmc5VW5iaUlHb1JVX20tMHQzamNRWHBrZ0pDWlMwcmQyZ3RGVExYdUVlYU9ZTnJjZ2dPWkVQMkstc19kNUlCU2JqNXE1QS1HYU9hbzFuRmdFOEFlMDdEVXVzeTBYeVEzd0cxb3JIOXUtSUxpSHpyd01Ickx5ZWkwYmpYSm9HcVBuSWd5d29nWjdZRmF6a1ZSTGE4OTBZQjlXR2p2SEdqZ19yYmVabWRDWkFoalNiTlRveFN3bGkxMnh0bl93WkNWVkhlNzUtSGNkTHZHaGgyekwwVjlROG84NFI1NUFKVV9fNjI2REMxT2w0cXVLcEt1Z1EwMHowZElPbzMwcG5IT3hqa2xlcGRMM0dyN3dHNXZsSUJKbXVWMlBReC1Hc0JmX3lYbUhxOXBZZ2RJeXl3ZjNqSjlDcmROYXM1RGNseUExUS1Sa3MzdWtyU3dublN1ZE5OeTNCRlJ5ZkgtbHhWQmpYSHQxUUlQM2JLbjRvNmRPSHNLclc5XzRPVnBNREQ0UjNMRmpYNFM3MDJ5ZmdXSkk5Wld6TDFadk40X2t0Zy1iVHNYOC1zdzJfa2Y3dXVldmJmMkYzLThmM3lvNDNUZ2dQaDU2TEZjbFNidGdaNE05MDRTLWF5SGQ2NkhVbmU5T1Axc1NldGdKWXdZZVN6TTgzY2FUUXVqRVA4bFhEQWxKZGJ0MTRhZ2FValJkNlBNLVVIUGdGUmNtRTd5Y0k4YzNSdWxrVkU2Wk5qeUU4VkNnaFRoN2JMNTJNYXhUcVMzQWJKNUpHak9ESkk4ZTczV1BFZHZPZ1FPNnZvak0xNDFnSjFtaW9rTFNIbXNwVWRhSFdIdkNkc2VHeTZyZmJfYktmeGJGS3FNTEN6T3VKbjhxd3hlNUxJQms2djJCUmNzM1I4ZnI1VjBSQXB5U3J3bmRuWExFRHdVRU90YzdwSTBqajVNeGFJaWxKU1FMb00ydXpiWXZaVE1INklXSndEdU1hNW04MlFCRnV3TWFZRDd6WmNwM0RGb2dFc0N5YnFjZFd5SFBhV3NxQk5GSDRuYXdwRnMwQ2xZMWMwbGZQR1RnTWZJeTRxRnV5U012cHNkYWZORUdBdVFpYU5zRzROSnNJV2NYbFNFQ1FsLVhRaHF2YkpUWE03NldPVTVld0RneGRGeG5WREVhdFRlQWZZaUVEN1ZBelFNUXNFenU4VUx4VmI3RWJzX3RsUW5hU2hVX3E3RjNUVEV3VUpPdDNCeFdPcWFCbmhNdUdOdU5CNXJabFd3YVhrUTFNdGxwOEFmWTBXSF9kX2F3VXdQbUpCQXFEX0xKRncybWVBS25OZl85NlZiUW5iU2J1ME5uejlvTnVXVmNMcWZIeDIzX1JfVVE5enZibTlkaGlSaUxSMnVDUzN2d21XS1UzVG9vbks2c1NpeWNmYnh2QjE1TnFnN2l4UUV6M2U2emVkX3pQYy1GdF91ckRrR1dOTFJ1d2Zyb001REQ5XzQ0UFVvLU1SQ2NiVGp1emxqQmVjOXRUc1NRdnZWVnp3WHdNY004Zl8yWEJxcU5OVl91b3V6dVRPWkFfbkNVTDV0T1dFSXZIZmlDRWxJV3lrS0U1TUFUUVlUY3FRd0VwNUlBeDFDOXdudnZtVk5NcmFFNHpDSDJuZllsUGNIYWpMUGlXcHpUdUR4anJGeFhIbVBUc1JTM0Q1YU1yTmM5emwyZkR6ckJsbzV0Y1pPT0ladlR4X0ExeFA3RlFnNjMtbUZzTGlRZG16NzM1bWVjUEFmdkROMnV4dWp3YXFITGx5NGlLelljVVRjbHFhYV92X25VM09ESUxkcWt1S1pCZFZzZGwwX19YeDdkSlFHNG5nN3kxU0d1V2Z1NEdRRnV3azE5b1hJM0ptU0c2WVZHSW5wSUlNYjcwSy1BREliMlZBWjlVaUloMW1HNmpUZWRHWHJtMzF5b3Jnak1PUlRERU1rYnZCeTFaazVrR0E0V05aSmRKRnlSQUtXT3VNbVZOVXRWcTFWRHpkTkpNdGhaWUZHQUU5MEtBZVlaZDdmaFRSZlY3ZlFYdzhWOENmM3IxdmdMTXJyZ2JSOGwzeUsybFBLMnhMcFl0cVpRanFaREpvSjlwUHBlcHEwRF9Dc1JEcVlDVi0zNE5GbldXWklZQmtmZTRPSGFFZTRlXzNQOGxNVTFKUWlJY1dXWmJ1ZUJXSnlpNDQ1b24wRm0zVzdlYTRnUUJCN2c1MzU4MUJBZW9ZQVRUYnFFV0J0LWU4OS1YMDd1Nk1vSDVKUU80OV9kSW0wNU11VVlrV3ZQODFHNDMySDFPYmgxRUJBNG1WdHYtM2ZqeGVDRldiZHVzTWxxa3RYbXVodjBEVWdmWGh4OEoxS2JaMUdjN3cyT1E4S29KZXNGM2QyTzIycjFkdHRIamdmbHBUZlVXOGFaN2hPZ2otSy0wRHg5dXV3ZmNVVWMwUnd6bkNMbVdqd0lnZ2NfQWZJbVRpd1ljZWgzQzlpVnpLdkcyV3BfZHpCMjgzM3YycGI3SlRKbmFYT3VSSlhiM1JQS0pONGcyVXV1NnNYc1JBd2FlTnVtVVVpM1B5b0pCY3dhZFRsbVVrQ2JNcjJMQzBzYmZkbjNMOHk0bTd1UGg3VTJ1RE5EaGk1LTZaWUNYZE5SRVNzajVrR0QxNzJoUHRSVEV6RzhUeEN6Nlp4dE5MQ004a3pHVWtjS2FLeVctZFdaaFVWRENsZVdnQ3F0NWdvNUI1OEVaV2RJbi1SRTRxREZ5RlBDNDg3bk9nMUVyVmZBN0NHWldha1F2QXN5ZUhKb3dkc0RrdzZIV0x0Y2ZwQTJENHEyZ1Z2aDdraHVNMmwxSE5DdWxNOWJSXzZZYlhuTGlCMzIzN3Zjc1d2bHpBVmJCd0J3WHRQT3RGWEEwc0V3c3Qtb2N5V3Z4WFNsT19kdlhRNUdHa2pLcjhFX1hzM0dvZmlqaHpsZF91OWFROGNTek1XbE5xRGNPWncxdncxNUtaeFNXR1QzcDJ4S1VHLWtSZW1Jc1h6VW91TFdma2RCbk41Vk1tUTdJTXA1RkFfcmdHWnFwVHByaHJMSlVaeTNZN3I4bG1McW15Z055a2FMNWkyVEpIT3RWVHB2eHVzck1LMnUtSzdpbUJVMHlkQndFaHNOS1RWMXlGZng4Q2JZazJTeUo2QVlWeWZLM1FhVEdqb2FFMGxocGNPRUIycmpfUDhFWHAydlJ3TWZsYjBtc2daYTFCOE93d1BXRUJMdlROVjVzUEYycFpUaFlnM2xWVzFjSlZlTlBLRTJfYU1zS0p3UGVIY19YTTNrdDBXVkpMbTBnZzE2ek5EMjlsaUlfNTBjOW1VN2NpVG1hNEd5ZzJtSkUzVkg3VWxUanVkRldmNTZpSEZHNlJpU0FqVUFtMmtBTkNGMjFyb3ljVUhFTGo1aVlQZF90S09vcmJvRDlWRGcweDRDc3BQMmRKZWVzMVR6aVMwNU5qU096cnd4dG5qMTBBZ3kyd3B5XzUtbVl6dVJvYTUtNXVPSFhDRkFNSW5QQ2doakFudHVYUGw5REJRb1ZSMWYwUS1NdnJWQU1Qc3pfaXMxc2xZaTlFT3NDUWp1R2hsNGlxYmVNWWRhbFVZZllGYnd5dktaTGNlZndjaVdpY3EycWhpM2FxaWQ5WkVwVGRyR0FvRjItdmd5cWVsSjlRb2NfSG8xRldZdjFrVUR3RTBmQ2ZlV1FteHBFMTQyYmlZNVNnV01CaE9tVTBKWkt1c0hCV3B1ZWJ1TDVlc2RHVEJwRWtpcEpHWmtQSlB0YzBvTlJSVU90TVdZTTYxbXZaXzRTTFpqOW9kZ2U1akMwMHBzSHVYTUExTG5USDZ0R3FnSDlTd1Izd08zOTNTQnRMRU5oNy10UEVEVWc0dHpJeXAxTHQ4R2dWS09DTl8tc2RCbnlpSjJaNmYwSThEMXVPQnJYN0JGb3E2aHlkOWtMWnZiX2E1VHFUdzNKZDJCdHRzOHBWS3hhaXFtTW1WUmZPbU4xYmRJSHhlVUNCQzdXdE1LZUc0M2FNLXpYZDBfUmI4MkxJTVVVRDJadUxXb0MwUGZzUmpiYWNpOVhBOFlBVTE1WllTOVh1YV82NUZYT2xxcl9sT1RuUjd5Y0JZY2J5T2tIeGpIWVFmRGkyQmZRV0NkMElXaF9WcUxNZWozT3ZEUW5FZDZvNEU1N21FQ1lQUEJUSkFIZTNHTjU2UEl6T2xLNTRtVV9USUNpX0JKTkRXemJvdl8wSnVEWExZMmUxZnhCOXNURmc4c1hINUozYUhYY2dpYUdSaHlnMjRKZElJV3dkcXFRbmlLZWNfS1IxVTJhbEVqX2xPQTNNb3FadHk5Zzhnc2RCMjRmQlRLOWJZUnc5eW9OVWhrSl9fM2NxNlozVVFvc3VrWklreDJwVlRoTkU3THdEQ2gxbnVRYlpvUlZrN1NKc1pjWkZ1TTd1SUJRWUNVMGRIQzFRS2lublQxc3R5WDduM3RRLXZPWGRsSENaOEtmSERpR2tsemdKUkhVSFUwdU9JQUNuNGtUbkRzN1ZrRGtEZ2YxalBhYXVYLUR4X19Cdm5oWXIxRFp5eS01N2x3SG85c21rZDFNcGFUVGRLR0cxOVktUDh3MmcyNXJCcVlWQjhBZXRlbXQ1bEtZdE8yckhJNmZSSDZrLVhSM2I3WkVlSFA5MV9UTkc4QVZtV1djMUhaMmdYN0gySzgyUzRoUk1JcEItdkxUaFI2QmV4bTdDeXJHSFZqNHN3M0dtZWd0cG1obmJlNEZQRVo1UTZnNGhScUpmYTJvOUswZDI1aktwaURBTFllRVY3Y1VDUjhBVjRYNU5WR3hWdWppOVdYN0gwaU1mUjZHMmpIVkFZSmloSkxOSC1JSENWcVhxdng0ZWNSRmVxNGRqUjNBWjRITm5kNUJBaGlTSHRObkhlM3EzeG93cFduQVh4M0hHeFZKcUozZ0pVdDVtdGcyb29pYnJiTTVFVU1HT290QlZGT0k5eGd4RmZYT3dhYXNPNWxIbTVoQnFWZVczOHlXS1FqYU50VG16TjlITjFrRWFfS0JacHU0d3RGeGswNkdWTmFEUS1QbmZBV0FJalByQ1FjSjJMQ25kS2FBSHJyYTQ3WTI0dWJYd1hPNUZsSVh6NElaZzI3Z3NzTXpVR3kwdUtGc29LdnJrZkFLdjVWblR1WlJ6aklrZzNoZExLR2FMb3RPVmFwZkp5VnNidGh6T0JrSERUMDllcVlOYkFwbWdYWGdoVTZSb05nV3IwOURSMmZQV1FyaUVzbm9Gc21yZWc1MUUtc2JUWjJCb3FqVW1zRnlndjJZdVhpdTVXdFFUNGtKQ1NxczZZVEw0cGhoQy1sTEhubWs3Q0ZKVnNMUHpUM2ZUcVF5M2V6Sno5dUxyUWJKRXVVMGgyWHQtNGwzaENtNU1hQlVVUGU1SU0tWHZhVk5QM3FQUGN6NjEzZkt1WmwzV3NmZVVtYzl4OWhrbElxRlI4RE1aOFdpYnhJSG5CXy1vTnpvcGV3SXZkOU1RV18wQ0hJRlNWWV9lMDNfNlN4SDBiLU5DX1Y3MXZHNXpNTXpqUkc2WXB1d3hMVUQzQnV6cHNWSVR5ZTd4M1RSWFBxNE42aXF4cFlTeWpyMUUwVnk2UXhzWGc1Q0NsZEozN0p0R082b3pTY1gtdDNKOFJBbVk5Zk41WTRURUZCZkxFT3VtdkQ0WXdjd0xuVktKMnVYN3A5MWZjTTUzVVRhTVc4UTZSZ2JFaTlnZjg5SXl1OFc0WTBIQ0REbDE2dVhCSXdZR3IxX1lyRy1zOUU1dU9FbjVpVm9oY1JsX0RrZlNNenBsSUhPWkJzLVM2X0tud2lZMXZYeThhTWlqb2tFaTVOZnBMbUdZdklwdk1MUFViUzBrQXhGTWo3dktnRXR0S09pU2wxVTJleFF5d0tsYnJtUGxFamZ3YnFjRVZkbmZvTFhIYXpfNlhYTE1Qb1FobWhKUWtvVFN6UDFIb2J4UWY4Uk53VmpaeGF0enpxMGtpMjVmUXlTNTlET0wtVGtiWlFqOTByUnpCQ0hVaTZlNWFmNUN2b3p1T2NIdEJmRnJHVkw4R0JQMk1JWi1UTGsxZXcteFpBbE10UVRITEVuUE1US1Q3X0VwY2dJalNDQTVsZHFXQndZVWxJaXZWd3NzNXRlWEswQkNvWjY3OWxyTVdTOEIwUmRwbjM1djlPU1JOejh3TUFTNER4UVV3OXhOTzBrSjdCWHdUM1dOem90dVFFVDFIeWpEcDV0UHY2MVZuVlVDc3pRME1TaTcwakU2OGtnVm9TM0sxaHFxNUhyZlJoYTVEM2MzZDFBWnJzaUVsMXpMNU5OamktNnBpZENKVmxZeFNBa0gyc2VlZ3lGeUVVV2p3ejZRZzBzeWYtUGtCWVFaRGtKOGJsUWFyUjRMdVJGVmViUTZ0bnQtVThmS0M1d3kydzFXMUhiWUZOWHRzUnVkcm03WWVtUDI2eVVNRzNPUEktLS1zV3VEUW1VblIzemNaVGZkcVBkc3ZyRmtES1JESWZfN3hsbDBLVGtIbHEyRjJOTTBiYjlDb281SG5RdERpX1pJZmIxa3pZd1BHTDZMV1hsazdhcENaQ3daWVBLNWNmbHkyWU84QzRuX2w4eDJkLXdkclBMWGNMRi1xZnRtX2RzZmNrNjBrNUtGenozZEJKV0otY2l1ZWM0S010Sm1JMklxUm50MVpJRnNTOGhEcTF3b0ItLXVTX3ZfZ3lMMVRxRklNWE80b1dUZktOV0l6d1NOUVM3UGdCYXdIMHVIemZDeFJ1bmh5enRMTEdMZEtBamZxc3d6R2dDMnV0THcyOVJoZWtLWVNyaElGWFVoNFFjZF9GOUxfNXZyc3pSaXpKekRUMGVkWlhSVkZNdTFsV29zQUs2YV8wUGVZbFI5cC1XMS03eWo3dGJveGZGdzMyd3o2VlNWamJrMHlIUnpRYmtwNkp6QlIwcm1QU3VlU1QtcHNCSWVwSGI3S0dHQjA0ZmJvLXk2N3VSRkxKTHZlcTJua1o3dDFIRGozQ2taVGduUmJ0S0xYRVNkb3RFY0toQ1ZXaXNrTDZabURLVWJJTkF1MXpLMlJhZkJhNzVDNlVPX2llVnAweTBJX1JnT3hEd1Z4QzVReS0zdVZkc2trcFo5VGduUGhXQWlURF9tQlBmeWhQN2NCbFZvUUhoY1lKYWVjQ21jQmtVcTd3cmx1emdEWEduUkFveUp6MXlwZWNjWC1IUnlqOEFFYXhxSkVUeGpWTFpNODBNS0xtRjNXZWt1dVMxSDIxLTFYUFcyaDBfSkE1OTg1cm9uWnBCSUtoaXptUU44YVNndjBIbFlmVi03cTl1Vi0wLXFrNXVQWnljQkRDYnpUZnlGaEdzWGdKU0tPSm5PYkU0QWktMW14NHpJY3FSRmNiWkt1cF80clc5Z2lFX1pfYjBpTWlMTGlBUHJ5dGo5T241ckx1MnJhY2UxUHFvb2VrZzFuWWxCRllTdzA0eHBWSjNGNURCOTBDMHh0SzAyMEtEakpRU1VCZW52dUpsZ3V4WVMwWnQ1N3dKcnVXdmFpYUlIalFBTmRjMU1lSVJEZjF1Z2EwZ1NwVjZPbEltMlY2aTVDMllfcmY1eHJITmVlWjdwU3A1X3c1UTk5YlU4RkdEMHZNbXE5azc1eTdsR3NTMVlwc2stY2RZd0pSek5oa3RPeW5GOFZBNlcxSjkzVmZsa2Q0NTFnMGRJM3dGd05kY0FqWG8xdUMzWF9zdU1JOUl2ZU9jcWFqWlVNcEFCMTZzbU9waHVpQXlBcjNTbTltMTJMMVBvbzVVVDE4V1lEbFl6eXhNYkRmWmRUX0I2R2lNUnpFYVlHSENyQjJoaUhsYXlDdlpCNW9lbkVTUG1rS1c0dFNmOXhRc0R4U2U1ZnR0UGh4enJ4UWxieEM1V2dINlBibzdYdFcxdUpMUEVzVnlwdGRjS2lPSHczQ0d4dXA1NnVNdjhlRW50SGRHdVFERmVfalk5TUJYZXNsdnMtQTdBVzg0VUFvWE0xd0RYUFo0SVZjdmozSWRpbTh1WUVDU0dXMHlPcUo2MEVBYk9nM2ZERW1wbEpNVTBuc2kzREZmbWlqNkVRZ25hdk4yVUN0Z1lKVUUtUVoxU3lHTEY3OVlIRXhFVFRUZ0RheHNIYnZCX2NibWFwNC0zaGhPS041OXlQUmN1ZldZTGtrMUhpODg2c3V6VWJZa2MxTkZRWlBGekdYV28yUUFvUXlCQm5DS01YT2QyZzBPS2RaSFBYRUtVR05FM3A2blo1WVFCMUx4dXJhTVJCSUNqV2lHN1E2cC1XdXRpNHFvNnRvUjgyQlFFZUtqSC1KV2t4a0NoZ2tFaXpUSjFGcjlHRFZ0c3duOUdFcTBKZjJ0aFhKWXZUTkdTY2tTVFEwUzFIa0NlcVNLOXAyN0p3NHl4RTlocmFVdHYzaXl4MEhFZmNnTlNLVTk0WmpFa0R5UFozUXNLUUlCa0xweHJReGRsZ1hSV2ptMEpJSWQ3WmRiT3I0YUZPN2ozZlM2a3EwQk5SVzFBVnhRWXpkLThFWkV3b2w0MFNyNmFfaG5tUUo4WWZvYlFoTDBhZFBfWUNaT3dBc0g3alc4U0lKbGV1b0hLX2hPc2Fha1hkTnJPaFNoQ2VVYjNpNUQxRmxkak12SWFEajJFN1dfUDJodmVna25PNkFhOFJlZ1JRN1dvQkVpdGU4OEszeVdPOWJkdmZ1NjFJaTBIRU1RUm5LQVBILU83RVpMVWdzTmd1ak5YRW1jRmdmRmhmU1Zudko4Vjd1UnNmbE9NcEZkTmZzNU1KUDdEcEF6R3Q0aGRQaG14ZlBseDdqTXh4cnpOQ19GS0tvRDBwcWdJdWtTVnlMZzdrbXkwOE9paTk1QUNMREZsTnlQZjNtaUVUMHRfaHBmWFZrckhCZDB1Qk5Banltb2J6WmF5bW05SFhLTTFVSUFJN21WQWdUZnVUYmQ3eEY5TjlDNUJTZXVyVDJtYnNaY0JtWFNfa3hZTWtSWjFkSkdjN3FwVFBSZUxOVm10UURBVzZWdTZUWlpHNDREMHdRNllKalItNlFiVnNSR2NReGtxR09KQ2MyYm44SEdvMnZCSG50TTdEZVM0RXdLUXh0bVduVXdITTNVT0ZHaWVOVmRvZDhzcllzaE9sM2tvZlN1YUxIUkZiRGdVQlZoaHBFV3dUejF1VlhOd2VVN003N0R1dGJZYTFiRXRJY0hneXJjQUJTVW41dlh4cEhhbVY1RTJHczhEeDhYTmlBaWdYREJfbmhFZEdWWkVqSmd1TDg5VXltR0c0X3Z0cVMtN3hGYmtJaFpPMXBEVHZTMm1KM04zNUduNGI2S1FWcUEyWEY5amJwRFF0VFY0bEgwZWhiLUFyeGtGMkJjbnA0RUdNZWs0eDRXN1RfNEdtNzlFb3V0TjJzSW9iSFhXYi14bURJbUVId3ZHZkFsYkc5ZFFLZ1pDT3Rrb3EzUHJvY0hEMVFUTElpNEpQYU0zc1VFNngwcy00NXR5cEFHQ3N2MDhralVkUW5GbUVTYUhTYzJjSE5CUEFFX2ZzMGU2bm1fakRLektON095RkV5Ymd1bHZ5RTRsb2ZxWkxfcnNxWFlPN3lvT2oxX2FLVHhGa2ptallGNWhiS2FjcDhCNWstRUZUWVZYMzMzWG9OelJreDRnOFNWZW0xVUNibE1QOTJxb3BLUklPaWNJQWpmN2dkS2hhQmZTaE04UUt6bDJBVjBVU3lwMkdrUFRja0NrWEtXUXhhbl9RLWhtZ2l0V2w5ZVpOR3BpUjVSUGxqR3VRaVRYNlJENGZKcUdEQWNMSnEwYjZYZGhva24zMHd0Tmktc2J0RUN6NC1HV1ZOZVVBYThETl9haFNaMXAwT1MwMkRkbGVKOG1ZcW5vYThEbF90ZGZEV0xiNDg4WVplU3JwUmV2WlBJWm5OQ1lQUngxTDdxMVVGcWhfajVrQ1N3Q0VWTEpDUFdzaXlKSzluXzU5c3lUaW9DemxyM2tuTVZ2bDBZSnFYdXF2eW95TUZrcDdGdVdBbWtfYUR4eURaYm1mRGNLNVFnM0c2YlVwVXhPQVJyamgteWtreVpfcmxsa1hLUjVrTnJJMFFKYkw5UHBiWFNtMzZVSTFNajB4alVael9IYmx1Z3J3c2lzRUtGcGw0T0k2bUY1cUNLZVAwWmFmaW1nblhxS0d0RW9wNU9kTHNGRXNoa3BSSWh4Wk02eTVta0RZM0FrX0c5N0FuLUxzaVVWdG5IN2NYNUJPbHZIMVktREFGdzhkQTBpOFhPbkJoWnZ4aFZqdXctbWtHWjBITURVS0RMWk5uUVR1RXNnVEpDT1RQOVc5R0xtaGNfMGRSS1UwQTQ0RFVRU0l4SmxEYzNYWmdYOV9XdWxMY08tdjJib3pvLUhLcTB3blN0dmlPSU9YQ21BRW9PWDFodWROaUJmdktBc2NYTnE1bGc1YmtaN3dDR0xSQWoxUjRSelhDMnVsaUkyZ3lpMTFHZU1VanpoU0h5Ylk4NG5vWGpDODNJcGFTX1FTYl9WUFEyeWhMWExVdnp4SHJ4YldpajQ1a1VEMWJEZUkxOHhhQmd4UzJ6VlRVMF9FcW1WaU9wbjRnTWczd2oxMW5tV0JYOHVHUHlkUENhV2dtbFJTVXNxVXVGQ0dYZ3RNUFN2R09XRkl0LV82YzFWdVlzMGJDNzl3QnhwYy1MdENkRXIweVM4NWZKQTE3aktoclFINUJLQXNneUhKbzFVU21FZGMtTDRweWpkMS1obnZUYzZxRHBXQmhSREhieV9DeXBfc28ycERfYk12eFZ1YnBDX3FIT0dlaVRLSkpTcHdmMC1OdFRLSnAyUzloUXNQYnhIeUFlQy11ZThIMXA0WlcwWVVyWGpJRDVoS2pKRzQ4b1E2THBsaEJTWlNCa0xpczRqNm5nV2ozN0dLZEFNN01jNlpKVFZRdEw4RXZjWWNTSUlEN0liMHAzXzBIQzRKX21NTEtjRlZWWVp4TjlvSkVPZWJLUFVzbndwelVUX05KbjQ4VVZrMGwzeGtDaFlEVDVmMENoNl9MSmhSSzY3ckI0dXk2WTY3N2ZKN3RjRGFfWWsxZlotcmVpSlBRNHhMTnNOZ05hU0FoQ2tqZE5Nb241bmlPUFNhQUtVcWdDbkhsZzN5bDhPOXFhcVk1aXk0TzFlS1hHcmY1THkxV0lNX1luNmcyeFg4aF9TZ3hlcTdRN2ZOYlhIT0Ztd1Ywdk04aXhhRmJZYnF0N2hHT1pjWnVQaFVOaVdDSF8xb0MyUHlIUE1IcEtWcWdaOUNYYkdQNmFhY3J0UmpRMkxZdUZNSnNWRVhlN1gxNm1xMDZpd0dLUWxsUlZxXzZoZGtqUUs2SVpDVTNzMXV3cFlGeHdaTW1CQVVCaG1lb2kzUVItQlhrYnc0RU9nYXllQTJkSUV6a2g3cXFOYmNXNlNBdnp2eXd4cUlQT1FTSWYtMVlSRnZfSDBpYXN2MmQ0R0kxNHpDWXUtXzMwT0hqYzYyX0VMLWg4V29pa2Z3cTNXZWZNMTduN2hGSmZzMFNWNTVHY2U3UTdDQkxxNEVkSTlXc0t1MDlxeWhNWHJwUlZPWTBrZzdsNjYxa281c0VsN1RxYzgxNWl6OU1wS3RZU1RlV1lsd3pnb011clJDNktNYmZEV2poUmlldGo0Z0RkSW9GaUQ0dHJGNjZvU2k0WTE2WkNxYkVPMWVKNGNseWZZWk8zbzBwSk1NQ0gybUlwTVZPMkRueGJSSURIOUxiSEU2VE1qQjYtZkw1a3d3WUVoSHI3UnNaMnFFYUdWMDdXcFkwMUdoTWpEZXE5dGI3Qm0xXzFvcWtsdVcwMjZRUng5Vzcxa0RwU0xPNkxia1RWS2xuMlB4VmdZa3F5V0pHNlZUbU81T21fRWxlblhQMmx0bV9VVXN4MXgwdkxWczR1ejlHV1VYTGZKbVlzZnViQXBwVF85anZyRDlkV2xWc3NKdUMwRlVVNWxOUVUyOEJWSXpycV9ublJVRUJjc3BLR2d1RmN0Mjk0V2xFVjZzNFdTSU5vNG8zaVM1RWtfX1FsZEp3c3JKT3ZQS2M0S05OM1F2cFJDa3hPQ2VwZGpZZEMtbVdfMGxNdWVoVzVmcGUzRnhFMGhjeHFrZmkyUXA1Mk5VYkVZVWpPV2JRZ3UySVVmX3ZBMWpIRW9UTzRQNS1vYTBrRHZaUmxPQldRbTMyS0g0RkhwYWpiNndLTWVIOU1VZ2ZlS0dBNWVJRDRxaWwxWURONkRMa1BKT3FkeU91UGdqMTQ2WWJkZEtQdmFDOF9YS2w5Nm5BV1lfMVo3ZTNKYW9NNzhZR2pMaEV3alFpdHlSOElLRTV1ZmFDZHdYMWNPMG5FQlRnYTZPNzFrSEJkMEpGLTQ5X2FPX2RoWWo0WmVLWVNxOVhkQ1NHNGQzSFNxVGVsT2ozX0tzUGp5dk5ScmkzY0loVmJVWHkwcVoyN1NqdlRRcHFEaW5yMDBra1Q2OC13SXMxcXJhazQtcjZoQUFUeTM4S2FrUFJWYy1WMUQxUVppR3hFYUdrbUg5bF9YT2hFOEtHREIzZFgxNVNOREptRi1PR1dKSlJZNWhqZmpFWVNEVUhmb1NHTElNei01Wk5hVUs5cm42cFBMcWZfcTc1dkZ1TWRISzZhcTl3eWUtQTdLTjZyS0xqMlNfclV3RHk4dnBlbFBBTktNTG5Td09mV2U2eXdFRmFJTDRVLS01Z0NvczJBbGd0OWE4QmRKOVpsUDBUSzZEb0RVY0JTbE9VTWNJNGZXb0lDYkhwc3FnS1d3MUJXc0xGTFU1UnNSZVF0ZHhmSFNZdWs4azFWUlNhQnZnSEh5Uk9NemJXYzhSWmJCVjlQc1doaEpMeVpMM3RldzJ0RkhaM2h2U1A2SUVidWpxSE0tYnRWSXFqb3BEOHFDMG90YkNERnNqdXV0bFdVekgxTXhNVFFGdk1KY1Rfa0swM3NOSVBNTnc1MVlrQm1fV0hiQTNZY1V6d3BPd1JNNnQ4YWFVV2diRUkyNm93Szlhd3BUTzJmVHVncjdzNTJoWTFBNVRpMXRobDM4TU84UGNfeTFyYWJBeEVsMGloTUw3VlRFWmxhUml2VW5JS09ORDdXSXE0U2RHbjZzbXJLWW1LUGRFNy1vZzJfMXVhWkJyblRScHNrd1FiZUVlM09tT0lRUjltb3ZmNkRCdlZlVGtieG4zTHgyM2hwUVRRYlpFSTRORFFHMnlzTXcwSnQ4OHl2dEo3NkpwSEFYbWhkZUpBNWI0QTBYb2JvSW80a1JGTjNlUWlCQlB1eTVsZU1qeEZnVVE0N3Y2M0pyNmtibXpfSEVTZHowOGhNeUozakN4Q3ViNWdJVGhtbVdkQ1lIUjZRYjRtWlowMjhIT0ZCNTl6MkY4QVVENXNwU2wyZmhKZHBtUl9aZ1BsaVBuUm9YNGVPU25Dc2ZLTW95X1YwNk1KRTl3VGZPSXU1ME40cEhoTE9qQXNUX3NCSHBfYWJMb0x1ekpJZXdtV29SRThVR2xWVENOX2hJQk1pdWI1V01lbDgwa09nbHJTNXRMZnNCdW1qTTZXUEladUpjRG1jWlozdXpEeFBkRWdHbFZydXE0ZmpfMFBoUF9uNS1FcEVtYTkzZDFaLURCTXU3Wk54QWYwS1ZBOXVJOXZ1WFNQRDJOVmRpMG5QRFFjbFRCRWhKYW8wM01uc1VGbkxBNVZqQlJnQVV2Y05Cd3ZlYzRfOE9WMDJLRVRxZ0hMZ2tzbkIxdU1jZ0cxYnVQWHF5cmJJelN3WGJiTFViOTFWSkZERl9ZNGFTWGhWR0kyUzFpdGdZOVlsYzl3aFlJYU9pQy1KcTNiRUZiVnZiZnJnemMwOUtiYl9ya214ZjFpWDVRczh0blYybHpSaVB1eExibGx6dmlEYkM4ZkpMRE44VHo4NExMa0lMZHNmdjBHaWtkRThSelU5cFNnMVU5ZURUT0RnVktDRmtzaXdJbEJ5MDRqd0d5NnNwb1BudUxweG53OWhKQnpUc0M5dVRUTmlZeUk0SmxpdWs4Z3ZpR0JTT2lMeGNiRVlXTGFpN2NNQUYtcnI4VTYya2hDYlZZVU1mVGhnQjg5aklmNlZSa3pVSGs0QXVSR1k1QnpraWxBcDhHeHg2M1RacnVXR3ZMa1FKek5wNS1PVGN3V3hEN2N1VlFULU5icVNZRmZYMnZVcEt2Unp0WjNxeTJOMTRIYmdIeUZMYnl6SVVoTXdiNkY2M3dwcnlIN0hfMHp3OGRfb0N3bWVCMVBTQVBUcFhiYjhRZjluQlRXbjFCWlBMbUNVc1ZCaUFYQV8zUWp2SWkwUXlrN3gtb3BGc1E3OFdJUVpadkhsb0NRNWI4UGd0bVdaNUFwVDhPc1dXQU1sYkFzdXRLdXZjTFkzbW9DeFZIOGxzclZxOHVXSjhlQzgxUV9uOG5YNGFqcnZiNm51M2ZXTXRDNmxFeWwzSW1JSHRHd3lvVVZOVW4xZWlBQVpnYzdiQUlnNlBoV1pxS25DMkFyU19lbEVheVFUd0ZTWWxrM2Zjdlo4Z3RMOHB5THY0YkpEalI5NUprM1g4NGJEek5uSndfY2o2Y2Fqb0F3WW9nc3RRZFRnd0pqTU1WaU1Fa2hraVE2SVRUU3lDNUJmOTBCa2VXbWZwM2N3Y3c2cThwMG5NZEdnMjNDc0p4VHNla18zbFotRS1KcHZESHJnVUV4d3g1Z3lCVy1STjdrX2xnaGd3OUw3QUNTbHdGb2pHVzlZSzA4T0J3Tjg4ZEQwLVlmMkZSRmFnaFVQY0RfWXhmaC1qNDkyaGY1SnE1WWtyOGJMZENiZjdBTGgyeUp6UTRoUGREMDdnNW1uNThnT3ZMUWo4Z2tvTTBfMHVGOHBRaHpqenRjVlRaM2NBNkZobEI2a0Zkdk9OQXZVLXI5YkpFb2NOaW5fRTJmb1B4VUxqOVdEdGxaX3N2bWtEVzBjR05fRWRlR1dKLXhLcTdWNDRzck5vd0lCOEprZHE4dUhZXzFadVg3bWV6MHNYc0lNSEFFSWhkSnBJelpYQzVjYW9lTDRfalVxelB3dzJzMG1IU29CSlpQNjNWODhFQVpMVkdtaklwaC1PTkhQeU9QemFlQ21xajFlTVFaODdJSGNhYm1yUGNaWDFITTVvRi1meTZ5RFVzdUJyRkx1dmRyX0VJQ21TM0sxWEZmWVhsMkZCU1ZsRGNpUDJ0YVF1RzR0dHhjaWhoRWpERDVDcEZ4S2dha0lRSWc3VVFBTy1rUTN3THZHdW5CcG4wVy04eGpWRFBoU28zUUNOc29sNF9zWnFqVTBoeEVNTVo3YkVxTzNSVDNTVW1OM3RjdG9LWTBySzBxZmR1bk5iSXNjdG5TcUVPYzg3dWd4VTBXNHlQYjBNOEoyQUwySkV0bXlRZmN5RTBDalkzVjVZMjNlN19UVV83bEk5alBTbnhvVi0wdUhCRjZ0Z2xYN3p1akdJSG82MU5CMHo2MHpXZ01hYklqd0Rha3dPYXV2Uy1yX2RqbEZpeUUyZlJvQnNPNDN5WlI1OGJqcHhpRHJxOWdnMEtJcktBQ0gtWjliTUdxeFBIbHVrb1FGeHAtMWszQjdndE5GdGh4dEJqMng5Q1FBVUJwMFNZYXRhUmgwVlBPRGptMWhLd2FUTnUyNDlxZW0tbERiNTRhNFplaGZqVExkS1RoalFiMktwY2FCbVg4ekpQbnRhVlA2MXdDeVRGVDBSN2RIVHloZUhfS0NYbHA0WDN0ekdoRTg5VDVVWjVxVEZJWmNDR2I4YzM1c0pjYnh5bWZ0aUJJd05sUFRlbkNid3dfQXlOUWhreG95Wk1iai1lQ3NBN1M4V3FaUEp6ZVozWE5iV0ZJeS13S3hFMnVyTTJKRXd4eExXRllwOFQ1cFBQQVF1NG1NT0k3SDlfNzRTcWpMRFpCU1Myd3dUdU1YZW1aSDJuWVI0WmdCUF94UkZENzYyM204ZzRuLUdNNGhibVZPMW1LTllJbDlHdzljbkpQOHpSSWlNbUppWEdXTjktbjRPVHFRWExFVnlKbnlUQ0RCMzFTSFctTThyeUJMemEtOUxOdFZhUzVTWkM1UG1vem9EMFZyY2hFVEZmelhwREJfZGYwNk1aYS1icEpBQklTVWJidi1hM0Zobm9JUU0yRW1uT1N2Rkw1ZFdDRlZMcXAwREJOZEVOS0FiQmJaNGdaaGNEREVoSVQwQzh4dWJ5MjN1MW55ZlowRld0WXFoTTh1TS0xVzVOTlNLZGkwVFVhQ2d5OHhBdEh5Wk9YeWgzVFRMVTh2ME1rbjFRRjh5ODRsOVJlejE5VTR5Z2JqX01CVUJreGYtNnhpSFRVQkNpQmN1UnoxM1pSTkVMNUFzTUZLalQ3Y25zRDJxNS1fdDk4dEZ3SmNQejBTLVctbzFtVnBRSkFjZWZ1ZXBRcUdvVzdLNWIzMWFCVHUwWVc3MTZCeW1pSVEwTU5VdC1Cbnc0VTZtdG9wWWJVRjExVXhSSHl2R050dVVUMlp1MDFJSWlKTVRvYmxoZXlYQkFraEVUaDJTXy1Cckc4cG5oZWFZaE94a2wwZE1nZy1ISlJ6V0RXSHJTZ2tUN2plaThNNnhOY0Nwc19veC1kNkdsX1FwYnRkRGZWaGQ3clRaTzhCNTFQSVN3Yk9aYUhkZHotRlhUZmd1c3p6S0RwZmtSWjN0T010VFJ0U1ZWR2t3eG8wRWdfQW9iRVJSNnBBblRfN1hZQmpFWl9BSVVwQkhmYldjZENyUkN5YnR4b2VUU0RvS0twblJkV0E3cnpiLUtDQmVzNG9mdWhicnNldEdWXy1rT0dLc2FuT0lPbkNPQWdHc2VFb19NTnBvZVpjWmd5QlRlaHFmNXlCQ3FZN2FmM2E2Q0F0V2hfSE1IVzl4cGk1TVlZVk9sRVBWWHZHTFp4bi1xS2hzUDVwM0g4a0VHam10d21CWGFuQVhkNE1HemZtWnA2UkZ2d0VIaFJHNFJQQkZYSkZld3laMW1oSzZZVDZXYnpuUGloTC1PTjJPVnJEc25CSWdEUGVtclpnaVJIVWdnMkk0MXNnX1RMWTQ2N2NYUm1JZUc4NWpUTmRieEhkRkt5UWhNS045UUVBYXhDTGJsaF9FZFF1LWJtcnFfNVZoRmIwSDlocF93S0M2bFlOM3BFR3ZsajN5QzNIYU1LTW8xSVlBTkROcmhGM096U2VHUS1SWmZHeFQtZTNwdmRzc2ROTHE5XzNrdWdGZnB5ck1GY01iMkl5MFk1ajN2bF9vNTFvLVdiYUN1Wl9KZEZfb19JZV9zZ1ZnTUhoTVA0elIzRlBEVjVjVUR0bEtWWldSa25XMTRaZ1hnbFNRRG5kSG5lbmpqR1N0WkZnelh6c0FqX2xibm5BXzZnS2ktZHQ5SXk4aW92cFN1SzhTMmMxRFdqU2xIQ1FMS2tCdWR0REI4RFRaYjZneHJCZ0piNEpFUWp1LV9mUXlPR1NOellNZ01ISHFiVTVVbmpxOFVlQkFlclNnQnEzTWRza0xRNjlRVS04clRZbGszVEVLeFQzS3hhTUx6MmxWTkZSMzRkUDl5Zm9HMnZvOW9PS1VEb3VUaXRwNkdhV29Vdm5jWkdDME52bktJaUIzc1NiQ3pOWFdWbFpDWDhWdFhRQnB4NV9USDNhYi14bUJOUnVQMUZ4dlExNERsanZHQVBOM19DcHhxaHAwTmxzbk9xNzlqYmV0TmtqVHVrUTFZLVVhS1lUVFZOaTlQV21CbWJJTGx6X1FfQ21lSml1M1BwVVUyM28yNHlkR0JFTzZNZFg3aldMdHp5c1hxSVJyV1JUS0g1dG1rT3VwNlQzck03UGotb0NNMURacGZHdFUycU9aVW5hZF9TNGR2V3RBT0EzMVVsLU1DQjlLLUpHZEhyU1NKS0xoODNqM2d1ZDdoTUswVFJmYzVXLWdaZzdiT2xUc2EwcTB5anVKTzAxYmZQdjdQTjN2cTRkT1RabWluNnBJMzJSbzBTQU5NZzlBRkdvR1g3TElaR0Y5bVRMZkZGbkJTUlctaW5taW0yRW1NR1piQV9hNUdvTWxOamhmV2JvLW5aNHZubkI0M1NjZlNwZnI2LWRvRzd2VUZzMHlPUURuM0VvZF9ZcHBwUUwtLWtKR3VlYndlTVk4ZmdtVy14NktjRENjSEl6NU04MzhROC1KTEpPNzVLS0ZqREZGa3JtTGZfTGF5ZTJuekpKVGxhN0NnMUMyWS1kMFJGZnd3ODRHb1JjaGpVS0RPQnlFUDVlNzRpcnVSc2hjQjl4QVUweFpyZlIydmdQM2gwbG9UYjJ5UG9wekVwaXV3N01XZDA0eGhsMWhJUm1haXloRFMxc3R3WFh3aDN5SlNuWE5NMngwdnY5bGpQTmRDTzBiQ1lyZVQ1SXY3eFp0WEl1VW5jaWI3eldUQWZNZHM2cXF6Unp6Wkx5YXFTT0JrQkxJLW82R05SMm9PX3F6dTZteG5tMlJGOUlMcEdxYnRnZHhYTTdScVNkNVBEa1RfVjhrVzdOOXlfTUJuc2RpV05uelo3WndPNldrUlNvbkJPc0licVFVS3NXR1dUZ1E4ajE4dy1hd3hnWVJNQlhrY3lEakt5S0piMjZrWjhnRXNlcVQtM3RPTHdFeGM5cjh1MEtLT1M5YlROZDF3YTRFTWZHMEhFeE1SdmdqQ2N5QTlLa1pnU3Y3eTlNRm1BS2k1M3FXNnVvRHRfX1Bwa0lFLVpqUGhLLTdSa3Y1TmJUQnI1bmctTlR6ekFHc2s2enVPdnBpU05JSWxBRXNlUUJERWNES0c0M1Fsa0N0X3g0VmJ2QW9kQk9lTVJpZWNMeTVtLXo2SVZyME9xX0Jnek16ZW85Wl9xZFhWdFZobTU5ZkhDek1rcEM5WEN2dTVXaVU5UzhsV3Y0VmM1STZXa294QW9vZ081QXJFVVV4T3JsMzlma0ZpR2FvUmNBbWM0dG81anhUUjhuWVJXQ2tFdUQ1dEoxcFFUNkhpaW9XMk1OTXR0OExMTTFpeUMwejI4bWFlcmdBZUxGQ3pTODZ6QnJybXVTWFJEQlhhaW9DWGM3VkoxSEtmSUFYcDY2ZEZ3RjhRUkdUOE9LMm55dlZIMzlvRWhSX2M2T1NiRzJvYkxTOXdWM2RFSUFiY0RhR3hjVUpCU1JXeTdUR0ZhcWdhemlwRVRnejF0NThlNUZhS1AyUnoxMHV3LVRHSWN3VVJtRXhlSzVnbDZJWWdMVThKYmVNdWtpbTM4dVFXaklVQXEwOWhva3RsRFNueG8zRFg2STJjdFYtRk9xYk9rX1dLRURHRG9aRG9neG84UFNELUJWeGJrQldRZEwtTUNENUpzblBGRjZhLV9BdFBaWktKYnZoM0t5bWQwNXVfbk9qTURUdXFKU0xuNUV4MjFPbXAzQW9WZlpNYVlTV1hzaXpOWU10cEVReEMwbWp4aDFFLTNmRm5uOE9GdzVnTXFXNXN5d0ZHRklYcUF5MFlmc0Fsb0ZBTkstRVZvVmpCbjY0b0Q5X1NsNVBwZmxFZVlaSFFRS09IRmxWazVwdUhlZHdpckNfZGhkdGp2TnV2ZlNSb1BLU0VJWGxnV2owRHRrRkFiaXJkd1FNTFBUc21CT2pOYnhSWFkzVG9Qd0RSZGo3eC03VVJxY2Ftbjh2VW9UT1MxYWE4WVRMNm5FNVhsVHpuOW01MEh6ek1Rb2tnemcxQlFLSjRsMFJkbWw1a1RiX2tTRm5XY0hobHp5UGt3RUxvZnZfYnlBN0lSXzV0d21LLUZGcUVsYnE5WW1IaXNrR1BWMlpHTDFmTDFGaU1RSmtxLXNzeFlTNjZJRVZ3b1pCaGw4dUZJbnVidXhFeGJaSEpTX2xQY0pLTnQzcExWazJJSzJpc2duVFgwTnlJRWNzMG9pdDlfQVRERUJ5OHZwWTYyTjIxYk9la1lJM1o1Q0pleFFpVTc5VU1wektndTJvTGlaWnBaeXJ4TnVMa3BWSzJpT2toanNaN3gzNDhRdjBSUjdRN3p1aWM4b2hnbWYySUs5cjltOW93MTg4MlpRNFlETTdlOGlxc0t3dkZkOWZuOERlcWl2cmROQUhRcjFlQTZnN3BVSkpZZTNiUDJKLWpGSnN1azQwWXBFUXZVdGFaZjF0cUpPQlMtWlhvOE00aGEwUE5KTWx0bFhmZGJub2x6aHRnYVF5blR3WHJBRTBSZmtnWjlMaHFtenI3ay16TWEyM0t3UHdncDJmUGgzSmV0Z202Nkp4eHBnVjQ2dVl3UTVwSUFibll3MDFOTUxFTXlQaUNySlFFRWtwaXo4WG9hOGtJMkdRdkh3b1pTYlMtNzFZcHMzQ2oyLVZkRTBNaV8zUnRJUEZyaVVTUERfS2cxQ25pQlduN0IzS1pUYjd1MFFwOXl0VE1TdDNRbUNwcnR4YlktVWFwWEtESUYwYVVCN1RPaDRuN2lFZ0pQYzV5M1A1LVZkQ1VxUHJKS2VwckUxN3AzMmFyWjE4VFFwZE5rRHdXRWJWZFlMZDNvc2tTdkhCMHBmbTFablpMZzNpSGo3SmxFX0VsT0RIOVQ4MXRBS3ZyUFlzZUJsWnZQbEdUbDdRN29XN0tSZ21zVDJHMmlqOW11RlVEWEoyLU9ycFhHTWFURGxpdGNhcmpXR0tjMXFJRWhzQ0IybjI3LUlDX2FnbDdHbG4xUkdCRC02bEZGQjFuTVBWcHJpVGljQjA3THJZblNHSTVRdzFpY0pYNnV1TzYyOHRTMEh6Z0llUEdRVzhPMEtyR0xEZkktX2ozQkphbEN1eEpMeW5sdmE4MDVaWFZ3RUdCcEcyaGFOSlVleXhJeWFSamM2SGdOZzNHXzNIbFItWXhiUjBfSmtEODJwczhfd1VmZTBGOW4yYkUzWEVNeEd1bm9rbWdWbTdxQ3I0TzNxQk1HZ0dvN3ExNFRVTGhndk9GeXVZU3BKdkJ2a290NVptZS02SC1idVYySlVjNENQYUN6Y0pFSnB6QlNmTnk3eEFlQmNvbEN4Q0w2MzZDZS0yeUFGVTFFdjJ0NkN1U1BHZUlyY0RrRlUzT2RWOWxvRVlJaG5nNUdEdDdXUjN1RDJsRkh0M1dWLS1ieHkwSFU4YkZmT0c4b0hoU25NN1hsOWtGR1ROWUVxUndIUjk4eENYeXVlS1ZEMHVlN0ZPNnotY3dxV1NxX3BFb0ZUX0V4OFlHU0EtS1k4N1RCRFY1ODlYSEdMYW05bm43RXJybTdNc1p5Znp4V0NBb0U4YkktX0hRN3dTLVVTc3JuZkh0eVJCVkRMcHRSUDVXWDhTSW5jekUwbTFsZFdRUFRZdDFZTVdld1M1Wk5GWll0SFFVSU9FUzNRVlZ5dWlrcXZQczBQWE5Db1p1ZUJoVVViZlVab0E1WFpDTXFYWVdsQnBUMzRVWkRTV3RxUnRVcXhjZlk5YmpvNzZWNjRfSFAxUHJ4V2NQMFZFVi1QVmhxTE55VmRZd0VsRTB5YnlyWlNsRjRwVlM4VTdsd1VlS01UMnpHNWVDLUktakxpUEU5S1M0eWU5WEdtZjlVZEZjd1V3cXBiMjl0cVFFdXRUNFRmUU54elM1dzFqblUySF9BVmxvNm5LZGJiLWt5RjB5WGZyRXB4VHJtR1VSZTRqMEVzMHBXbU0xOVZxY05yeDJDczh0UDlGTlFxNlptQnJ1QVY5ajE0SlpOdUhvY1ozMmU3cTdsN2tfcWlseEtDN1hjR3lRS3U0YlpXdS1qWUEzdm5OSDVORnAyaEd4aWFLVmRka1pDQVlTUnBqMHVNZ1FuVGNEUkppTTJoV1piaGY0OXBUaUVwak90dmhIbHV0WDdYdmpnTDVZcWtVRzNBbUZVelZIOWs1QkFpUXo2VUtwVVJjUFVNUnFPTG5fbkpMd0VsY2xKUE0xYldZdEhZNHNTdzl0OTMzSjZxdzdENFdNRGJRLVI0QlJubkxwNUZZRUtSY2Z1cHVKWWtxV29xd3dQUzc4b1E1UmZfSF9VbVlBZEFOUXhsLVU0MUw5RTE1TEZqaFBsMUZObFhNLUp5ZVNJNjhlbUJ1NGNWY1l4d0oyMGd6Y2NuSWs5UEtjdXdUWE1IUjVIMmNtZENxRnVBY3lYUlJCaGhGRVBfNjFmbmxnRjMxMFZSdS02c3JmOVhnTGFuMEdtaVNZSC1UaVpmcUFrUjItRVlvdWxFUG9UWUw5OUhTekcwQTBveXhpc2YyaER3Z1NxNDVpbjJaTU9BQnRrNGpGT2ZKQ2kyOVZxMkV5YXVOQmRodkFQeUVzVHJpcV9ydHZPN1phUUs1Ulc3QndPZ0RsY3k5b0ROcmVfRG5mZm9jRUNmc3hMVndab0Z0Sm02eUpoNmU5SDVTOFdMcmF3MEhDTklaR2QyaWNTUTJEMG5oMjh6b3JSY1lfanpIYjBwX0VIZk1iNjhxa1hoQmREVE80ZVQxeGNtRmZuUXRCQnRCMVJYaEd6cW1MRlhTUXJRRWxHWFY0czZxNWFYRlJQNkljdGowQk02VkxHWXVpOUdZb3YxZEVrWVRaS3Y0QUtnQndySWRGazl4N0hOT29YRm8yRlgzY0hWTUpWU0hzck4xY00wekN5SVNGdDNkaHB4TnVsVHY5TkdfQWZmUUg4X3NQa05Ua1R6clcyRlM1RkZpTjVrQXJLeUZRRGlWNEZHZTRxWE5WbFhfOURtLW1Hdk03Q2lPWDg2Q3Z1OEg2c2JEckxFR2VxdVJFSHdxaE9DYnR1VDljczNIYlBsbDlvODhxTkw4TV9CSzc3aUh2a0lSQUc2Qkl3Qkt5ZFo1QUNpVnh0NVhIZ0tEUE05a1VaMTdLM3FwYXFUblk1YWw1QjF3bXVYMkwwSDVGckxxQjJTTFBPUE9zcU1RTlNidGExQXBkai1KMm0ybzFWY1JPaGhWeVJza29iLVNOUDd5WGJrbGlUOWJTSHl5YzFvbzFXcTZKYnNZd2hwdVI5aS1YX1cwYkc5M0hyYS10c2pvYmZPYjFBeW5sRXotRGpqZXl1eEt1UGVtLXVvRVlTWkZfbXRsd1JxbVNFSkFwWmlxQms5VHFTZW04LVBCZWxRR000MVhBOWtFeHc3cm41anROODZEdTdUX3JvRnRTWGxpakFQUm44ZTI4XzcyNEwyTWtrN3FPREpLMkg4Mzdvc3J5bjNXRWE5MW80OTJuTS1BcGNTZ0pfUUEzbURqUTJtaHZNVElPakh5TFRCZlBjaW4tby1UQzRhc28wdmpJUEhLZ3pUeE5oWnpYNHMySjFSRF9ldW91cHhfNXhocDdCTDZSTWt4eWVMd0o3Y2VwZFhDVmNmdzdzRDEwQnlyVGVtSnVoT2oxaWhrc1lVUmdEZFI4M3pweFl1Sk11a0ZqbjlxbEQ2a3c5YndNWnRpU2h4QjFZUHNuV1daV3U0TXFsVTg3SldZQzlEMzFUdXhiNFltYndsd1RsQTV6dFBTS3diTk1fYUI4aXZVUUhUazBPdFFwcndXMTlCdU9FbjFtWnpBYnJ0WkUyZ3NFQ2w3TTREWjZWR29nMGtza3gwSUlDVks3WkxEQmZRYXhIWmxFOFk2SGFCS0JrekhKSHE3MUNfcnMwcEo0UWZRV1NiNGdkRFpIeVpWY3JaNktPbEZsQTBma25LdEN4YnpjM3U2TUM5enFXa1ZYWWZZeWVvM1JSNUg3UVJZaUJqM1R6SjJVMVF4U1VqQjZyU19XeW9vWlhnNHNyeG5QRWdKak01TTdfMC1yY3NWVlVVdVNzT2RXMXFybjRlSy1Kd3Q0elkwUHhLYU5wZzRkMTFLUURIVXJkRjdPbnd4UmJ0NktLSFlGYW03UGh0ZVozV0dGbnBIbktzdHJYOVk2bEREYjBTLW5KQ3o4ODF5cUhUSmZ5YkhfRWFxS3R0ZU5ub3dDc190Nkt4NTVBS3o4c2VaU1psOXJnb0k1V0FrVkR5YmlfSlFFdTJnZnp0YzN0M1hCMnlTVDg4bl9BcDJNbU80X0V4QXBoVEpfNzdrYmJvWkl1Yll2ejA2Sjh5ZjR5Mk1yXzgySlFLVVBQYWhuNEozejR3eS16d2EtaDFLRkkyZThQTDZzODF3YmZ1QndrNlBHNFItZWg4UVhybEJrSXVqMkJ4eGU4VUZ3VUZONW9kbzY4VC1SWTF0bVdPRlZndnpDUkJKc1Zjb3htLU1CTGZsdW5XbTBVdDRvd0F1MlRKQ3lUaTRpWDhIM3E0X1lQTy1zMXBiQnRRaU0wQU01azVFNkdoZlc3MS1lQjJ2cHMtMjRORzE5R2gzTEhvTzNlelJtWmhwX3k3QXYxV0I5OURrbmJ6NXZ6dGxwcW92Y2hNNWRDOFNQalFkMDBDRW5NRmtwaVQ3SDZZTmFKVG5BcnVoanhTU2RKLXUxSmdGSE1ObzJpNEtfR0xxY1BlSGlIaTlPZDM5S2NGdVNQeHAxOV9wc0Z5bHRzWVp5cXhoNldJSG55bkRvdEpiOHd4dFU0bk1FMWFvazFZNk9yc1FUeGFtNnBFQnludFljbzFoLUlhanZHSGliWkV2UGdLNjgyc2RoZ295RjJ5OG1na2JTNWxHVDd6U2tYWm0yeUZwOGk0X0tVUnlYWUtqUndFZWdKTmktQ0gxWWs3ZHgwbExOaElOVzJEWkdyN3RFd1dOd2tFMzFHdWwtaXZWZzdGMTNMN2xXNW9OWTk1WXFXQlh0RzBsRHVoUlduSHg5dTNWV0twSDFmT0xDcnVIS1VXdzM3MmhtX21KS3U5UW1tQjNrWDF3SURXSkQ0SnFfeWlaekMxWEdIOEFzRmJfOFhtTGo3YW1aUmRwRFRRSmV3WlE2NXFJem44VEx0ekFhTUktUUlQZXJDSEZmeDFYWW81ZUpWdHc4MWphVHFRQWJCLVZ5X3ZXMG4zNXhUVklEOGdJUlpYakhRVEg3YTgtaDY3ZVFPdUNtS00yR2NZQjlFSmNRLVRPdUd5ck5Cd0lBckNxSGxDSzF3SjlPZjFYMjQ2cjY3dnd6MkJCQUdRWWp5dF9yZ09PcFFadGthV0pMd25ncXEwRE1pYWt5cE5LSlVJbEViX3ZkUGp6SFFKMV9IVzlMSFB2UWVHUmVJRTY2YzEyWlBBTm5tcndDaXR4M3hzcWNJZVd2d0Vya0ZzcWMteUlZbFd0V1Y4ejVmdklMY2JvSWRxVTJ4c3RqR0lvZDhudEp3RVRMeDJJQTZ6TUZHZ2E1UDZkcVhiMm85TUtxT3U3Z3UxYzBUaGtjVzB1QUFSb1F5ZzhDcnMzX0VfcC1YRXpCZGVWNzBIWUhXNk5CaV91OUVfLWVKVm13Vl9RcmJxanM4bEJxeEhsR1ZyUHVIbjd0ZU1ncXk5cjY4b0c4RVZRRFZUV0tXYWZ1U3Q1bHJpWXlTMlk5QnFqbXduUlBFR3lqTzJtLXVNRTRHQU84d0s2eFZVeWF1emlRQ0FyLnN4blQ5QmJTbklGT0RKQ1Y4WGR3RXc" + }, + + "responses": { + "200": { + "body": { + "id": "https://demovault-rude-junior-95.vault.azure.net/certificates/testcert/21983500952149bbb3129b0c60e367a6", + "kid": "https://demovault-rude-junior-95.vault.azure.net/keys/testcert/21983500952149bbb3129b0c60e367a6", + "sid": "https://demovault-rude-junior-95.vault.azure.net/secrets/testcert/21983500952149bbb3129b0c60e367a6", + "x5t": "Z-n6Mydb08bmyOgk7bmx5HT8tyo", + "cer": "MIIDMjCCAhqgAwIBAgIQGn/FrGQZT/Cd9kgXIsytEjANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDEwtleGFtcGxlLmNvbTAeFw0xODA0MTcxODI2MjZaFw0xOTA0MTcxODM2MjZaMBYxFDASBgNVBAMTC2V4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsODIu9EJhfnn57k4++j6dC1M6Egi9aZucFQ9Jc29vFG9L9BkzllPGluKKdH1ypsrAUif7yGaq5d1nDyLhZUncU8dV/YIA7oll/fC+d0H4A37kVbM/60zXhXnKRx+DRZ2hJQzNBOodCaZpyZZEuYvtWdSCSILpa0R7yXYevjLaG5LfckOzuurXqeos7WB+l2q1c+6zx1KbNXbBl7QOz2nzk9oJU7CdhPOc+LOLppmsXRwwluKtmCDyKdrKAF/dANp5zGXFsognQcRctLSGQp8FbgBVQyZ+v81n9bPpSaBoUQMcH4uG9jPO6CWwbDSWE+FVYAm5kgjuW/1hqRSnOEV8QIDAQABo3wwejAOBgNVHQ8BAf8EBAMCBaAwCQYDVR0TBAIwADAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwHwYDVR0jBBgwFoAUaYJoBFokrORdsxOTA8sgrosMOmgwHQYDVR0OBBYEFGmCaARaJKzkXbMTkwPLIK6LDDpoMA0GCSqGSIb3DQEBCwUAA4IBAQAxL3t0kV1dq/PGUztjW+qK6Nh4sx7jsU59JtjON6zcibJ4hM+Q3Z+cEvW9zuGkuTbLz6fKNL9VnkF1LnlWTsyRmS7bF15/7iOgfdrr0vkJKVM1Zv/tqKEpBJ7Cbc0vW/VJQxZN+OlqGNc9bcx3cnqkRwpkgM25T0dVpoWtCgMwayUtbPFbTZWHHbpzHLF2BzYf5HyW1BoKXcVPM3r/rS7RETasRRsz2GqXXdfhjCd+HKVyv5kD9N3WcFNUsaq3TqAUZyOx9bO0Cn3gkmgz05JpfhPEylXwVpVAccOoXsNoFdxEKGO0w7pk7PwOhsW8sFprdXWp6OxtL0rrCNFF/llT", + "attributes": { + "enabled": true, + "nbf": 1523989586, + "exp": 1555526186, + "created": 1523990186, + "updated": 1523990186, + "recoveryLevel": "Purgeable" + }, + "policy": { + "id": "https://rude-junior-95.vault.azure.net/certificates/testcert/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=example.com", + "ekus": [ + "1.3.6.1.5.5.7.3.1", + "1.3.6.1.5.5.7.3.2" + ], + "key_usage": [ + "digitalSignature", + "keyEncipherment" + ], + "validity_months": 12, + "basic_constraints": { + "ca": false + } + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "AutoRenew" + } + } + ], + "issuer": { + "name": "Self" + }, + "attributes": { + "enabled": true, + "created": 1523990175, + "updated": 1523990175 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RestoreKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RestoreKey-example.json new file mode 100644 index 000000000000..9683f5fef9c2 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RestoreKey-example.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "key-name": "testkey", + "api-version": "7.0-preview", + "value": "&AzureKeyVaultKeyBackupV1.microsoft.comeyJraWQiOiJiNTc2NDI5Zi0yNTY4LTQ1YmUtYmZhYS0zN2VkMDdmYzBjODEiLCJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkExMjhDQkMtSFMyNTYifQ.YMIP_MrQq46_fpDL_H3RJJsIJ-3NhyBd1yk9bBKNI8ggN31ah6qehcPHHLgJrx8jkBLLXPqp5f1zlil_rUk-KkOryc8ZI9cssM5_Sy3xpI4Zy6WIc5cjPWuGCCmBpAyrtGOVzhjQxo3rTW1DSqgZUvr8TJly2PKrviI_RgnEd6-RVKuuVN4efVaK9XVTmn1vfygzpTr_TWC9PFmzhOJzgU98_9_nVrWVHNS1uLXJXnWhAOfRYtVRNEQIENeLc-g3cMrK91s6NWxNqfF_GL6Px6qXG2WWCOg357fBgOVStDKiVH6N1MedQ5piadxxTT6LHZokB4x1JlAIfL_bU69PVw.F9Qb3tVlMKprCKK-YEi82w.T0MQiauw0l9Mb_DWDcXoo1jN6IYu59Y7SEL2mgtU0x3XL9yTsjeF4cb44LAh_oP7gmH3n7J-VD_xJ7hWcMW6yS49E_M9iygt9SCl9f4Suki3CYvL0QERTYKImj2-AFDLZIwNmGba8G8axPqGcNKsRgGZgYTToiYLqBryrbvLJudCqgjeQdi5MmtyPFpagHpHvKkucFGp-XmJ1KbO2A2QOWQTQZ9CereBqrCn24IwaQrUC4rND2w0UA1TcwEeuVBGELdJZosXs6CGDfjZHqcvpz74Jwx5OEiq_DPs9TKrkMhowcEplZ8ZJMcNQRfu9J89d7YXgGdB5ikJzp5ZV89w12b0zCHNYJjgddHS62fjVeaE1OOP_7yfX5tJb6d5AXigr-JJ3lb7cba9q64plbiarMKzab5Hm2LMFuKBr5Nako5P00hQBgGc6ipIK8MOcKsdaB2Fr50_Ub6rDS086u37-CHtFFqy-1AhiCixQjCML_kXkI0vDbbjF-_xkMdaBV-Au79O6zWjsDeeWKtUvVQnB0c4By7IWCLeVw22i09Yi72zBqfOF4rNgxU3kJ7_-5boWmyYW6wM8esN4xGY3PhU4yKE_uDg6vNNwt5scWYoS0xx6PCos8KDtcr-UypQ92thU_FXgq9StTYq2YgVWGPns5CDLODAJ-l11I6IitlP7HhyLo39j77iWfTKDgL5kp7D9E3_qdPZktjVPDu3ZQcT739N2zz_1kXrDom-6PPqwVS6mQzAUmqixSivcqbqjZIFtOllKFA6qerh2eSAYzTMSCuwJxDBRB5-n0MQlIHjC17dLZhVqD1Sb6Prq_y9sv2ivWq9La9GfGlHA6VY3T3QdSCukYRjXXq-B-NnVdhFMValVvosrJfnHFaXfLi0gs5U9Ku4yjD7QoW1yR1IY9OrZ4qRQwkpnm9O2rrH1pm_XSzLQT4kZcKbugxsoYtlDOSiobKDXu1MtCqvDnvxz8Fw1GpMrBuLkVQDVeeP2j4ZwLlOnLTNi8bScNm_7vTsTPm4ID9mjpWI8Bap83TKi3dzP1k1i3Ggrr1HJUAOzCCcQ4gilDKZ8RElQe21BAqJ7yEnnVlucyG6AWa7viYYuxxBHkDl7XGdvX0jI26rwcS_FH2yNiafd3wJI1342XAvT7CQeh8dZedJSqXQGjB5BHayV_ofzeUp_8HjFDhKUdrcI4i0kFppHdPXMAu128wDu2LnUzyM4JZwSIum_njbQ3ISTymELNx3wt2WSEOd7AKyKyB4BsSsdPMGewKI1gsj-HCEoNBwxPBAvVqCII3lf94m-EM8-XzNtBUqiOv9dDBkgvzJmI9k2O_VjcmFknGJoi1VzYpiQU4XlIZzjCwsCDqkahubcqXWr08UtPmWHFEy4CKorVL7UHiXlVrOGUGtSvucwKdcKTOzWlRx-DcF0LCzMdGZwcg3ei5mitlYbF2UlbN2bZSCPX9c9lESdAQHqPEl5raT67h9VxlOswhanxJFo4enDCZafNmDFG2La69EqBV6KLz0_4uKZC5mxavDk6WKyfoDNyqsuVLto7YsjRN152X05XHHnESz4ne3c0jwWaz60ZIGD5MHMQHPy7O4WgakaVsJeOfaCskwbb49q_mBsX0NfZPcqabDXhZ7BYLQ9XERGbnwd3JDBh-_TT7k6XDicKTnVPueF7wsV_4hOGRJdTI6PTfWj5uf8u7qEOAuKy6euVMKy97MWKOT8-ZQl0hIj0rbVGZH-R4rqH1v_VgQPdi-qWoqWqky0aZK3CNA3QxWftLGp0qEWpu6OQ-ChN7-vxN0tUeddDZQyWWtwx6TW1KhCBWZGjZm9AC68bU2BuNME55oUWGlncN9EnFzgNmQMTuK5vTgwZBHMjfQzlIG_yfwAumHycK5OOOvx95Hc7wDAD2W1WRohy05yLRdlBv_4DQrrMkadEpf0utvhwUwevR5McVEybOwUL6gf9krC4L4bTumBQloBrx5h3nLxYw90rijlnKj5YbKaejrMwbImyF-qVNMmjSwb52StJ0wOG3xOGfBQDxPXrmIxh0DR8GsK0dy-1HIIej5-oRMd_J9aVKz0Y4wx6V23h-jP3q24JbawvwlA6rV5iUFdh6JQriMNC-_aD_u__5U7t8CH7ZVCuP3nIi5x7gmqalK3egHm3pdb_lowXE4ZEBDLvtkihl-w-PFsuYoUJIFVqFvVs5EnSSMW0PIXOSfVMYmJZekbiG_QjxkB23BhzYrSjCz1qnSMx9kvbp9Qh1ndRXJJIPU2jeHuLB4OgW3hzynCaqAvPEuG2XnKpxXfxAKNzWiLIN-0lQ4_Qt4tw-fjaYRUV5KUjrbVgk2506HPmYTGVQWQ_m7gSASPZj6DbInku7K8EZr6owuH253Xqk9kIl2LMBpvjOkNMaQMxKr2-2YdPEy--fMAPLp_UMy2xjlKLKk7nXIu_H1vRng_VUrVHneGjFan87QEORSV7rTAprO2fT2j_9hh6JmtYkQqgG86YyJksUjWs3xpdi6NPFELjAgyOFC-4kMgKlgI3iTHIBWQ3jjtSe0Gct1K7BpBJRrIAF-1UB6JT6cJ28gMswI98kud5hoXYmT5lA-ZaD-I8dM0qFtHH8kYW_nzzo9m69-iYfV_wsy2mBvueoNQddQKBkmiUMnxV90tAyEg8YrZYL1rOcXqcoeI6_8RetmvYxVM1bpuq_j9fMv-zTA9JCeyJ1qAN5VAaicIgg1JXICLB9jeSOOsQw1avqvM7N1ArwCr6oMHrq5ZCEK85yVb5G8cctewoiHYsuYOOHgH3LnchWzfJ3MiEcM6_V7RdvBQd03kPzGEV8uI2uh9tmLk6F7UKzYM6ExI5mKPC9-QN2Mxe0z46ke2mxGGGw-yqL61GGAiKAcpClK5GxyQmPnDJ8DqJNOVX3h_o7a11Uo32kdtG2huXpDUsay6E8TbyGWEgwfX7ZVvk7UM3ejt3jYpqbdYJPMMBB0gM9OfIQcKITroH0rDlQ6ZkxPc4dpeCmM3875pWNQkg1JJuQg3xpOVgEFjYZlED50EiVJ787qC5aGmjLQZ_r-P7_hI7OepLVgPGHASRLlwGN-FpL78QoUzj_Xu06Pd6AuTLmbjhViDD-udnqu5UGwJ4lYjbjJCA7uPOe_ujsQhYwUGA_XBylnErIlL7OXHOTxaDlJGH4-4wMroanhOY5hgcVdvUBZUgRDUh40l3z8FUbaRlihE1yt0uNoGqwMdrZvhNIwaQcPYPyUwQ7Auhuv_jItUqiFBogryRoscwz2qttjmv8AQYHyAly9ujvbury5LcIh_EQfTzBnJy_p5Yw0CXnBK87fEH8raZHxWETpqlxyfYdVf9PjDXLbLabVCbzMsR2sXfAo6m4VhghF-CGNWymknD00Tme4La4W-A-OeGj72-n8Vc6b9g78wnmbAttdrQ8PYWKQvcuyDlvyEGGH_5UmtlSyj2JltKesw7Wsj-ak8CX1btdsSlhBWcaBttj3RjwlCxhD2MyVttzt207rOB7qtAIyX5zrY1LZHpwEmMx8dZs747ecfaeS4dQBZczSyB4VEYTQXgHygE_q-bw_exj5k9sDGxsSFqyzQBVoU9Kename4DJsLXWZinuPHYQSmX2TdPZmsdHxBkpAprb-H4HgEJpOalBkGwhXskHpb6TNHPxy-oOm-hAizmMVOg9gL2NHzRuAmoI3U4Ewa_GEnowteAQSLecMzZ6qgyudk0pnuRyN6P1m3BSQ184WS3jx1C460LAJ3arI-4Aeuin_0VX3qGva344vet87DR7IbME3KMkYkTuz-hzjnxGUT5qvaZv077PTq1m5CQPTdee6Sg34f-ylxh70j1I-NZvwhP2LVv92duVxJRR7xslJzS575q7ifuPG0Rzt4Ny3YDJz4MeCNNpZIpMBJxdvnG7k8lmyoBUQbdz8xBunXOqlD1GSm93NKc-wo7qfzIjv0Z1zYZp-nK7J64E-Jzx2D1glIDnodl9GmyS9po339IYaOPfRgI3ZwQSVGppBP7GMEGlFEqlo7m5-4SYXG6JdXaNr3iQVghPKdAei-bCLAPlbFJCEAU55r_HEfKlT5-36SydteqaSdGo1XFEzZuaH-_z8BlwXW0N0tRitz7Ixu9NANC8GutgkvXuER_Nnw5UIlarepM6TD_Z_e8rFD7haxV1WtoZd9BSwNbRmIyu6cfZzX2xSOVRUJwVHG-Y3ZDdiqkso_WGBvLRJBTVOsoeVnqe1ZKjoCQK1DaFOopxP7SMhp9YicoWFOUQNN5-DB3-68CmDsv15-s3DTqQC58xiwbY-4nYktySQWayzTobVNXmbvb9K9-uj0aTVFLzH1G0YvLmhSSSwk_3O-ctRPLEnXPSQV6GUOjywLHOXSD6_cYS7RkUtx2g8m_1nhIQm08Wui5MJGPGBDoDf7K3wz22tgQQWL10cbtJUoBF262UiH7LNi22VCkl0IX1UQ7-wpI0p8dWSoWo6SnOa7dQ5iBIbf9P_rQwWaaYu5_ZBZpCM4UqVcgaGSYVsqDzWEV8-tck0X8NuI2rgrR94CJxcJk91l-oz0nWaMAhprnn2_wxRXGNay36bjSq3YxM1stt1M7Rczu7Q2Pz-fdjGYANHvqAKXQ6imJaAsplNtJHuIJujwrNTPwFs4a9l4dXwM04QIfhc4yzmbp9XF7UYU423WMhQSdL5JZNWyAuq8AnG7mwgSP3T24NThuSFzf7uNNrJg_PY9UCVriOKqD7YUKARgQECA-NkalnXSEuTCvk2ifEX8Hzq2Il5wLFr9QJV0fO_DRCrS5sDuZVbwD24cejOybmguUanL8b2IjKxzLUOOke2EO5TQMtPQfcy62vEyscpC2EawzaCvWub1SWKdYVu-qPstUxyiOPsipTwWY3MuMFJprSlqaUP1Iksz3D4TjjHIsoG6MAllTYqB-IjnHHfc26nS7ra1yUcltHEkDwt8GR6ng-6OW5bmOBvTQCjdTP8RmvwokHEvFA9Wlk69VHTZEJSZ4gQeqsqo7HBICHwvUb9mzbHgiNtld5YAGOuuSpNLMTq39-33UVhN0KkHKQvBzr59qfhPHSyUFuLg28ojX0doox2JQDgPhlvUbDwpinDBjTpb07lcODaR7ecv3KC9HIAWkx9aWIskmXoAVaSVL0lgNMC3GVLR1D_pehA6rIk6F_jl647L8HDjDRDn6QFtHkmAamtMOVK7O1-T_-TNWph6waQNu0kWY-ep2DDgt96ztXRFSUgM9rL2y78CN2EEYmfAI-3UcjgTnU1FrWhFwt-I6Uf4Vp6V8_6qN2sT2ryaKXz4cBIcCh6o-KDi9oyH5w0Qyx8VoLS6StaQ2aNEz9Jjg-gCxiZtCRXyigilw549UaV2Wkxtvl6dydffaS3jmaLjh4f9xGkRPEGjffo1V4uCyBB9BChiUBdmjTleVRQ8nBrnVAnjauHa4lWud6HcK59V2MNZMMWmKKooA8qkn35TcnDuynJ2HMCgdIBJuPUOSy25Bxnfp8ENMJVkW_TyOnMy9orm55hlxfJ4D58ZwaQDK4AiEfMHTwIsOngjgSJ4KRCv1QkSUx7XEXMSIMQkTa0jK_Z5-OCVMssAo13W85VQJmZCCKYG6Vm-rnuXIGYfVV-858ow8BYPhCaTaW4dVpKXDCD5_sQljgIJwtVg4ODJcWqzRiYjTis2W5cvPoOXZ5B2fqZU9BXeOAc8Kv6kfCUjt8UyP1Shk07lmgP9onO1btyW9VxPHNnPw166CyrfUW1hAGB0ua1MbkDU7_vN4JZ0cuV5_b-olRo4y_rxd7PdVDBldpVMLlWxZ-XbWUjtZSVwZOMk8KoWatnWz5R4KVK6AgmbELxikS1J61gYI6XSro0Fqu7GM3bWvVPbmqGt8I_Tr3GjiJx6w9HodiKlFPsbLjA79bnHnCpwpHFAXb9wq7vc-H_0MMVTl7xNzo8HgQ_GkOXIu9_n1Rbe-RD4WRiHwTnbnYmzG63xowGNPI7g8Gm7fL_NzCXhox7TIHW28tXQByY8fdw_v-1KoSiaJ3p4pIRyQBmkBzf99FFZOKh5mLK2pkHOH5aenQE6x6pqCjCdqnwS97xbtJJuNAx3UzP7G3iyZSyel8HGtaMTeWHO1nhOedSeq5ahi8tAEyZv0QRqLlA4ZALkThyeCYrJAwW2iBZ9nCEEgzljOMpu2gtzCFy9ZKYYIhifJuT7vPGuXFMKKVX4XU9feh8XH1EVnvxpCnF9yxFgy8nUnBuGlFEV8UBUNh8NApIYcpeL7yCQyl6P7qhrN7HHH4Ih6hKKiUiB-Z4M0rTJOffGz0XFZiZH7XOmJk0MszBlEahAEn2SSRZiQWM8lDTQpGk_JwBJQ_QUNkLfxBpzlK0T0aqKWw3ghXY-OqjzS8q1W8uAc3ZlTT0VGEgVuO26_oEzWNvXbzJ1E_TAqREVKL_9aezms3rjc-FvWRGjLWONMxTtl9g19DWalP6jReRRExH7v0KLGoHuuEnHTsP_hl2vn3NVYiwtQnjQB9zb26JFlpg6EhAuI3xlVL3xpDOjeIO5s72YJcS3r03bB3m5G1IcEU8JDvY1y22Phnb8ef6z5ri8D69rUKY8E9qkhLWaXN24S-6Ab3QeKJrlHGOrhG6fJBtIjL_wFOdZ2j8Z4mPYvbZ5CDQ7g3MraXuiRzqgouy7NIbzjs8FDND8dsLGVt9CKjtU2tykBkIJPfXkgu4-JRTTDN3H4gpzOfwPyW_19tLvPJ4JQlysnxJhJmInSPKTQ9crRGTQeKAwLvYzgB0nPZB1wgPUbGitlhySWZjmjeUNhJsgoFwdtEu9hN4Cz4NYEKgZ3ZpJL-lfeInjtTB07P8ukiWqGxcAiR9L4Ov_xVlMboanWn4CM-8UJvcDhUDkiLktxtI8M7fM5nx-2AR_s0ryCWAubefALQtuDRt51VkfyIfBvQarowH6zH_V_gYIXWNt9oLILOqk4yjrdygFWY9vAvP7V8CYkiFnIUkXcZyClOgfq39mtJxpL3csouZXTHp11gLbmdT5ESn20E8bnZDq5oHEDXlOlfGHOevlzFtB_UxGXtKYX9J1AiKzBrdb7BbozdEp0-xuiy6XDZub79-mKruPL2ZYb1i5hVjQACvFp2PpZOi7xUfJRhOFwf-49JaTOWN3-aXUoCukCi1gj88dCoPYcUuk9ZlMzZdWXIp9gCX27_zSE5YDBaiVCWOsw4CJFbc-kQT9CZ34dSXbs6xKSt9-ahr9osicbGciZ1ICW_6YdK3IzrHuQEzNsCCKDuobUQQdZARQLyaeGl45g37mFoKP7bxoMZcP3F0w37AGLLW1cV-6uNnihYCZtu8YrFPuaxh_UULONMResyLUlDurvlnAUyj1U1MSlC1LkOm_UWoMuPs_UjSc7H77E80rgvBfBA7Z2DP2jV8QQRb6CTbxKiFI9LXfFR729EqDYUuQEI5d3tcyb7u8O2eBv_Tj9O4ODLyZ97gpLuVwuJUoqjARgEOuSiGul1hRqa9y6VtfjL4Njj2Ib1lcbrA.Nqzdpe8b7qsc3BjXFXZYZQ" + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/KeyBackupRestoreTest/d7a019f5da8843aea30722a7edcc37f7", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "v6XXEveP0G4tVvtszozRrSSo6zYDOScH8YBVBBY1CR2MCXBk-iMnKgzUyePi9_ofP3AmOxXx-2AsLC8rxi6n3jQNbGtIvQ4oMdUEhWVcVkmwdl0XyOouofEmIHeSxRg6wXFG4tYAKLmKsO9HqmU5n7ebdDlYngcobc1xHsP0u8e0ltntlgWBlSthmY8AMKW9Sb_teEYhilbkvt_ALr00G_4XHmfq7hSOZePWbGSWQW6yC7__9MrlDfzaSlHyBIyLppPEB7u6Zewrl_eNJWoUVrouIGA32qNETIOr_wxXRVGKoerTt-wFC-CXPn30W_6CmKSxoFBNvnzijg5hAU9V0w", + "e": "AQAB" + }, + "attributes": { + "enabled": false, + "nbf": 1262332800, + "exp": 1893484800, + "created": 1493938217, + "updated": 1493938217, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RestoreSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RestoreSecret-example.json new file mode 100644 index 000000000000..a693df6e7374 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/RestoreSecret-example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "7.0-preview", + "parameters": { + "value": "KUF6dXJlS2V5VmF1bHRTZWNyZXRCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUppTlRjMk5ESTVaaTB5TlRZNExUUTFZbVV0WW1aaFlTMHpOMlZrTURkbVl6QmpPREVpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLmhERDdfVW9aU1ptR2JYN1dYUTU5WDkxZ0FQb05kdDcwZE1BbmgzbjQ3eWNjbkRNOU5vTm1hY0NHZmlNeUwxU0FlZDk0UjhBNDAtVE81TDNfQ05Qal9pdWIyaW03Z21nbHNPNnFFUVVIWU1tOEh2Wl9odFRrdEl4QzRPWEowYTB0S2hscnczZlBvVVFDZHVGcFg0ekEzYTR4VTZXTUNfYjZZVXZqUjZnSGM5TFRUR2tIazh1RTY0aVQ4cmt5RDRrU3RNcXhnU2lfRVZwUUdjWGdfNE9wQ1dBOUFha0N1NkpybGRaQW9BLUtXTWpQbGhaWHFYWGMyVkJlbUJjRTQ1YzY3QWhqYjJrSi1uQ1c5dHBjWS1JZ3JEUHFzWkswOS1WbHVtcl9SbzQzcG5FeW5jVFpTdzZlX1h6VnN0dUFOZHdiM0E2OVR1c1hfYkJKZ0J2SGQ4cDJSUS5WMTlhMVRacjZ2UjJHdEVaWGtOOXJRLmhwMU5IMmwtZklWbVgwWlNfTlRzekJfUEs1aktDUU5rSnJyRUhRQmZjQ2VjdHhmVU5uVlB6MVBqRWNDblZuV0pCUk4zTlFKZm01MjFLRHp1MzBIVUFEUGVmVHJyMFVFS2x5QTM2cThoWFY3VTdoQ0dHNk85NVpYclRsZlVENDI5RTNTNTQxdVBmWGpGR2cxbHlucFNTNnAtVkFzaXFlY1lpQWNuM1hhNzRhUm5xS3N3ZzhyU1ZOX09hSVU3ak1VVUhYZWY1ZmN0NlFrdWFfYkt6Z2dtR2ZiT2RTdVdNRmVQaF9mMkJMUFNGN3k1NThEMFZxSVlNY0JJR0dMU3BQUU93Q094OFF3Y3NVUEp4ZDFuWkVYYjRVNEJZYlhBcmFMX0NwekYxZlhYWVBsdmVUSGdKNVdrR28tWXNJVzAtT3ZqVGdLN2hIamxpR1psd29HOVUtbTJSVDZfbkhseHhVRFMyY3JseGNmay1OOTlXd0tEdUxFMTM5ZE1mN2RCSEl1aTdxd0RXdm1TN2JMTHYzM05Wd19XSl9DT1VGQjgycy1ELXk0UEdIRzVackhsSDgxa25mLVpRblU0SmZfY2lhMWhmWlY3ZFMxb21UZDQtNnJwZmpTMGxFT3VfZTQ5bUpYUGFpZ0hyLWFQYkFzTXJJQ2JvOUVIR2IzMXJ5SlR2QXF2ZmJDbU10bkdLUDV6aUNiZFh3SU5ONzBJTk5lZnJLWGZkZFBUd0RSV3d1ZkxCcGNlU0U0SG5EWVZVQmdkMDl4UUZidG12UDhhTXhhUlpGSTNpWG1fbmpCNmZfdlNhZUNUakdVYVVuRE1QQkdOQWQ5T2xVX3dvUnMtalNCVnVqd1FQSGlGcm5RWElkXzBRdXRYSm54cTU4aUtlTGJvNDJtOHgwaXBRcnB4aEZoUDdHNmZOWXAwVmxXR0RxZ1Q0VlpPQkZsZWRKUU0yaDQtb2xTbXdtUms0M0Y1cjdKd3h4aENqU1JReWx1MGEyQ0ZONWMyZjIxTElZaFliLWNReWFXMDNpV3hsb04zWld5cDJIb1FlUmZPR3lXUzBiU2NBT3JndGpBYnJaUFIwMGRRNnpSOHNBczFYUzh3dzBlaVczbFpsdjJwVWFxOVpTeVhnTS14b2NTOS1ueXRaWGtWWlUwX2dDVXJBV0ZKNG5XdW9oTGM1RkkyRWFQNWR0SXVWa3dnbXlsR1gtYk9ZeHp3dzVGYmI1V3VEbnJ5aDBMSnVic3Q4VXdLdnl3bk1jQ3duMjZSVTNxQVRudGJubVhJS0FyeGkwMldQVk9oTXdpUWZuX2h1TWk5emp3MEVuaXNWdktNWUNnR2xqNWlGZW5Tc0FKUXBiLUY4bng3OWFJQlJaTUc1a0huUDR5dGxmNm9FTkRsRXNJY21aeEtOdEIzcmJPdVROYUhLTXZBNmxSNzlMMDJZSTZrcEdrUUZnaHpIaTBjTWkwbFdCejRTM1AzUEMzZElZSVlQZ0Q2S05kT2FLWHkta0dWdUlsWFNmVlVrMnpzM0NBeTJhZEJjV0NMV094ZkRoQnlwNTl4MHpBRExvdnZySHRLOWF6TGN3N0lTbVl6eUhYMkpobVdReUYtTFd1VzhfcW41SkFVYlB5Z0RTRDYyMi1PTGZQVDZmc2VTWUVBUTFLVWRwZTFnSV9hZWxVT3FaRWN1aE5SckU1YUp0LTN5TEVLVWZIWXF6WTlGbHJrUE5MUC03Y2xRbmEySEhfZmMzZV9LTGtGUDFhQTJjM0RVaERseGhsTzB2bFVmV0c5eXpXaDNZN0NmRFlFMlBaUzZBcFBlYy0wa1NDcEVKMmtCcnFzWG4yeDJDX0FDdTdCTTVGZXNJQkN0M2NqSEdQSVVQRnEteGVmT0RCXzBQcXZDTXpBOHg5Zm10Ny1sNHhVQlJaa0dtZExhZFoxVzdFUXRNRVpsSWMtbDF1V1UzTU15cFZpVWR0OWxJUHVQVUEwc1NrbWxrTGhNSjgyNE5QN0hyVi01dC1ZNDcxaWVKMHdEUjFxMmU4MU8yazdNeTFlTDY3TlY4OVBHYU81SVR5WG1ueUVXMGtVbl9qa3l1UVRkV3dsS09HZVZIYkJWNFpxSXZHWjdQUS02TEE5eXc3a0dyZFRhVFZXOEdOOV9GY1c2VUhjbzA0U3dqTzY2S2x4VlFJWWpBdEZPZlBjWW5xNzF1RndyQS1UZHVDZG1sUFBHOVpjc2tiQmdrbF8wVk90dmhuc0pwYXZKZ2Zka0d3OF9qMkQzd0Jzemd0VndHNk9nNW16eVFwM2pFc0w3UmNtcXd6WFBOaDdKYXdHVDBJMlRvZHYyQ1Z3MDkzWjJlODFXR1NxRnlIejAxdjFBaGN2T2VWdmFjUGM2Y1JJaVduNW93ZF80d2FBdjlyNjVVdmtWa1FLRXpHUmo5eTZILXdZTTMyV1JyMzBlOU9MRTNKUU5POV9kNjRTRmIwSjZHa2VxUmtnNkVXc2xqN1JYLVU1VlhrS1BtMzNpS3c5dGU2NVBqQUNnZThRVDBYVWZEaUx5a1pGeUdpZ09ZMS1TVDFxUlE1eUhMTXhEc3BPRjFXd1lMQ2c2b3hocTlWMm55Z0U1cUJ2ZnYyWUtFaDdjM1dWNjJrYkw3UXJ2d0xkMHVRZ1FwYmUza3E3dGJzcC1lNWlud3cyY0YxQzByeHNScGZJRHlJMmg4b2xHMi1RQUZkWmtlMUlmaE1FZmNfdUdXX2pqSGJSWXVzYnZCRnpKMDdaOVJsVnFMR1A2WXBnTDFsRTFOY09xUVJyYVdxckdDTWZ6SzZMVENQSl93aHJRam9WTzdVRDJIUEVnUjZ2S3U3cWlmTmo3UjE5OUJuRi1EZmlnbk1TYTFKZkZadDNuVXVZOEhMUXRoUzN4MUMxOE50d3dsaDVuNGxYS3d5MERHenljbVNweE05QkdPNTFRckFmSXRfY0xHbUlzMlJ4MzMyeDRIdEZ3Z05nRzFBazNIUno4TlJ4V3lhNWhjb1NoYURXekhES2gyOVp3Vm4wYXVzeWJpal9uNlFGcnZZbjRSOHdPNlRQV3FrS09JcHkxc1lQNWxyNDc1anZSRVZGaFdCWDBiUXdJdnNlM0Q0a0dFQzgzU3FWYkhxY3phZTNwOFNxaG5tQW5ZYzBIbWp4clJfZUMzT0hYVFBGUFZmNDlVWHdrQjIwY1lvcjJ1dzBaTzJ2TUg3S1QwcjBSWDBQVy1qcGpORFpjSGRSNVVCMXFacGlWLWxaYkw0eF9IZW14aWUxY0RPOHNQSXhIOElUSWtOV0tTR1N2eWdraHBBbGl2RzVEZXJObElkeFE2c0tHQ3RtMDEyT2xjN2thaVFaNHh0TjR5ZVpPU2xyS0s0OTlIcWhObzhkNTNsbFFfMW5ncWlHbzhUSDlzWkFrclYwclc3dkJOSF92UlhBdTc2MnlpZGhZUURYYXJXSEFUMm9DU2hEN1lOdnotekoyZGtEajJMcW5CdFNCWFh5T2xsM3o0ZWFITDd2MDZ1QTgxMVBKQU5YZUdoenNaNFVQQUQ2Q0E4cGlxSHB4WGkxODRHNEJETVU4S2VHeHZLWnJiUlNOT2pTOFNrQUJKZERfSklIZ1RhNEFhNzdPUmNZcVY3OWZ5djFZVHNma2lLR2NUYzZIUjZzUVpsamt2U0NQNjdtTTRGUHRqTHlfX1pDQlNwdnRSVWd5UlpNM1dSOUViNHkxa29uRG4zUjMzN2lpSzdfbGtIa1UtZ21VbUpZUVdnUjYzT01pZUdRUHdNR3BSZXlRWE5yckJVTDN2Z2JYdjlac1ZDcDh1NHRwQjBleXJvUXgxZC1KSWJvOWVyR1VlX0ZzU1Fpd0tIaGFIUk02Nzh5dENkcHJFbDBWeG92TFVrX0xNcTFjN1R4MG5jbFl2WE4yUjhEMXNhU2FibkJSd19CU2tZMFNMSXdhb2RpY2o2ZzdLd0ZfMXB2eThhNF9LbnJNLUNkenBvdHA0aTd4QUJuY2JRVUEwWkpsYlp1elRpR0F4ZjFnclk1Z0dZOTVoWi1XZG1lOWlSazBHRTJGN3d4MlJyLUVvS3lZRjNjak0xMWt6MWFmME9fNFdyOXJoU3JrX1NHU3l2a3ZCTW9NZ0xOX0tSS1BlTjlqUnpwRlVST2VnN2NCbGlhdy1odnZhY2lCeDN2UWRqTE5jTldQdU1UbzVmME1QbmU4TUtXcFBoWjBySElMaEVuYW1pcG82X3pzNjczcE9ma09FS0JWWE9mUDEzR0UwS25SWTBab2JPLWRub254LVdBY1dodFZvX08xbkwwTWE5ZXFMMURhRGhJU0JNbVRIM1hkY2dDTnF0emIwcVMtS1l5Mk9zRzZOakRDVEM1aEI3MXIwU09WMUprNFV2QjdYemxTTW9YUXJnTzF2ZFVwSGtxaVhUM1RJZmlQMWRKcDEweDlSMlp5R0lzUzljQUtNMEZyMGRxQmJmQy16NTJpcWZweW4zUVVqb1Fld2hPYnJwUEZGOF9lUmVNRlIwSXZjUkxnMHpwek56UzU1N1pkQkZhemxNTThLcnkwN2QyUDAyTnZtclUtN1ZjOW8wZm1qem9WOHVVTG9PMkJHdmFRdnFJNmtBTmQ5VWo1X2JkY2NVUzBhcklzcGFZa1UtUXQtNnQxYU5YUUdGZEtUbFMwSVowek54bkNIZWRySEE4SkYtOFg3d1ZpRW1McXJQbU1Sd25sbWx3SnhxLVlReWMydmdUallSbUxCVU5TS3VrZkJsa2VnMmlCRWdySksxVlNyRWswX0ZvOXkzV1EwVlZuNXhEZXlGc1JuWDI4Tkl6alFQLVNXaHhYbzdPYm5YY1cxZHlWNE1fYjdzM096cEMwOTJWcGZYQkpaTDhBeHgxNGY2TmJzTEpXLW95VEdsaTJFb2FCZHJKQ2JkQlNOdWJlbGdRRmU2V2hqSjRGdlNrYVJISjFTT3ltbGFtQmYwaVNDOGM2X1g2SkZORjNmOXYuQjc5SDJvbVIyTU52SndydHVzclJ4UQ" + } + }, + "responses": { + "200": { + "body": { + "contentType": "text", + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/SecretBackupRestoreTest/01ddd6e3a0d34d35bb5bccecb1251837", + "attributes": { + "enabled": true, + "nbf": 1262332800, + "exp": 1893484800, + "created": 1493938113, + "updated": 1493938113, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/SetCertificateContacts-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/SetCertificateContacts-example.json new file mode 100644 index 000000000000..1cc9fdfb7f5e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/SetCertificateContacts-example.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "7.0-preview", + "contacts": { + "contacts": [ + { + "email": "admin@contoso.com", + "name": "John Doe", + "phone": "1111111111" + }, + { + "email": "admin@contoso2.com", + "name": "Johnathan Doeman", + "phone": "2222222222" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/contacts", + "contacts": [ + { + "email": "admin@contoso.com", + "name": "John Doe", + "phone": "1111111111" + }, + { + "email": "admin@contoso2.com", + "name": "Johnathan Doeman", + "phone": "2222222222" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/SetCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/SetCertificateIssuer-example.json new file mode 100644 index 000000000000..81e25eb1d4dd --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/SetCertificateIssuer-example.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "issuer-name": "issuer01", + "api-version": "7.0-preview", + "parameters": { + "provider": "Test", + "credentials": { + "account_id": "keyvaultuser", + "pwd": "password" + }, + "org_details": { + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer01", + "provider": "Test", + "credentials": { + "account_id": "keyvaultuser" + }, + "org_details": { + "zip": 0, + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + }, + "attributes": { + "enabled": true, + "created": 1482188806, + "updated": 1482189526 + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/SetSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/SetSecret-example.json new file mode 100644 index 000000000000..0f4feafdc3c0 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/SetSecret-example.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "secret-name": "crpsecret", + "api-version": "7.0-preview", + "parameters": { + "value": "mysecretvalue" + } + }, + "responses": { + "200": { + "body": { + "value": "mysecretvalue", + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441", + "attributes": { + "enabled": true, + "created": 1493938459, + "updated": 1493938459, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateCertificate-example.json new file mode 100644 index 000000000000..a030230642ff --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateCertificate-example.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "certificate-name": "updateCert01", + "certificate-version": "c3d31d7b36c942ad83ef36fc0785a4fc", + "api-version": "7.0-preview", + "parameters": { + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799 + }, + "tags": { + "department": "KeyVaultTest" + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc", + "kid": "https://testvault1021.vault.azure.net/keys/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc", + "sid": "https://testvault1021.vault.azure.net/secrets/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482188981, + "updated": 1482188981 + }, + "tags": { + "department": "KeyVaultTest" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateCertificateIssuer-example.json new file mode 100644 index 000000000000..3b0a4392f6c5 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateCertificateIssuer-example.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "issuer-name": "issuer01", + "api-version": "7.0-preview", + "parameters": { + "provider": "Test", + "credentials": { + "account_id": "newuseraccount", + "pwd": "newpassword" + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer01", + "provider": "Test", + "credentials": { + "account_id": "newuseraccount" + }, + "org_details": { + "zip": 0, + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + }, + "attributes": { + "enabled": true, + "created": 1482188806, + "updated": 1482189526 + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateCertificateOperation-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateCertificateOperation-example.json new file mode 100644 index 000000000000..247f269bea44 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateCertificateOperation-example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "certificate-name": "cancellationRequestedCert01", + "api-version": "7.0-preview", + "certificateOperation": { + "cancellation_requested": true + } + }, + "responses": { + "200": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/cancellationRequestedCert01/pending", + "issuer": { + "name": "issuer02" + }, + "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxxM2zqnPtpH8aiHX5TdEoZLO0Y6fsjk9QcjKgnHomrwUc9vK20UYYEPKt9aGOT7HNx0do8OulPCnLPrKowci8UHu1qRW/qHvsOJQ/UrQoMCHxtXptVc7Avx8WQb045sCdgp/Cl4xO8LMZa70kE4dghZU9zmNZk8wqDIxyYdh1lqqfGe49EWOxcfszTeeKs8KCsQznjExbsudBHLLWoX4VFTGMe3VcIPcV6iFf70buHKznDMXFiRC0IYwkc/GyWIadB1CSEae8k/0evsPI5lYYZLaO/kLffEUtzysqxZNCQR+S0eVPTGTLHa+fndnPPs65XZDzSZi2fZL01oXUfCAQQIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBAKto/ZF9+02fQ3sLuIsRuap/O/AZz3IhAubNfyCaWvVGVAQz/Aqpf5c/liyKhxqRG6LR9Zu50oxRK5222ezR+56vJikjdXRVShf2xYsMm1CbCM1JuzsnkTeoUHHE12xx1srH/9TH+DVZIk6NXxc4wVIagbpwxiS5gR3Nly5k0ZVv7R1B79J0GUqSwK6qjuooWrBsYMEx319hz8fB/Y4jnPE8p+Cnn3AGEqnebVngXncq/QnHxnrRVfvKFVySqRvlsvM8buILmBbIaywEUqwhNtZX2i9E7reEJ8aeZcf+lAeKF3YDvffaXGTc75aiZlBk30Lv/hn0vs9T0/FedUnIae4=", + "cancellation_requested": true, + "status": "inProgress", + "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.", + "request_id": "3dd81d528cc84c5a837c607f1a50f2e1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateCertificatePolicy-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateCertificatePolicy-example.json new file mode 100644 index 000000000000..16789ea4f48f --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateCertificatePolicy-example.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "certificate-name": "updateCert01", + "api-version": "7.0-preview", + "certificatePolicy": { + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297 + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Self" + }, + "attributes": { + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/updateCert01/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297, + "basic_constraints": { + "ca": false + } + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Self" + }, + "attributes": { + "enabled": true, + "created": 1482188947, + "updated": 1482188948 + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateKey-example.json new file mode 100644 index 000000000000..0361f9d2fa1a --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateKey-example.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "key-name": "UpdateKeyAttributesTest", + "key-version": "3d31e6e5c4c14eaf9be8d42c00225088", + "api-version": "7.0-preview", + "parameters": { + "key_ops": [ + "decrypt", + "encrypt" + ], + "attributes": { + "enabled": false, + "nbf": 631180800, + "exp": 662716800 + } + } + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/UpdateKeyAttributesTest/3d31e6e5c4c14eaf9be8d42c00225088", + "kty": "RSA", + "key_ops": [ + "decrypt", + "encrypt" + ], + "n": "tHCSyq1FqGHXIFHs1m4riKYgPFNSTlJGPzxwfUyZJUxxZsFWMxmZRzbM3kcXC5N40AJfeqDOMs0gY0LZEfhw8kJHBf2GEH2Sz923E4OQjLk_ECdAiKPW_8t22cqD_pGIuB7uibjLZgFFRv7oe0t8cTXKn7IwAH5gQBLs8NNV7hx1Ozy82ekCgOovFldmD3c3P1oZQ_v_-jOP6O202aEfDcZut42J6zI8eYwvGiDKmo2fCPPeth1LYBOeUMnrEZGT_f_w3yAgqvuSkHCL0x4MjZzc2EoNI_3ooAHZohDaPHLRfz8neDPADZzbHA6SDn3GgvC1K_Je5GBmqjTH3aIMlw", + "e": "AQAB" + }, + "attributes": { + "enabled": false, + "nbf": 631180800, + "exp": 662716800, + "created": 1493860275, + "updated": 1493860277, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateSecret-example.json new file mode 100644 index 000000000000..8e99d16695dc --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/UpdateSecret-example.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "secret-name": "crpsecret", + "secret-version": "03bcccc7c8cf4546a0e3e21e52560441", + "api-version": "7.0-preview", + "parameters": { + "tags": { "mytag": "myvalue" }, + "contentType": "myContentType", + "attributes": { + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441", + "contentType": "myContentType", + "attributes": { + "enabled": true, + "created": 1493938459, + "updated": 1493938459, + "recoverylevel": "Recoverable+Purgeable" + }, + "tags": { + "mytag": "myvalue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/decrypt-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/decrypt-example.json new file mode 100644 index 000000000000..837a751bc97d --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/decrypt-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "key-name": "sdktestkey", + "key-version": "4eb68492b5f6421e835d961ad2be3155", + "api-version": "7.0-preview", + "parameters": { + "alg": "RSA-OAEP", + "value": "sid-4nG3FzRIFWXLXlG-FZo6H1-kzbNX5Exe0_VRqcGLuJWjI9oSofsn-2IagDsQzkpNAXv9V8aoIizelrK_14darhxaAV8OejO7Oh7spjxa7IxMVS3e-cwcLdEHzMbMfM1uFpDyRFqEUASHI0H8F1M2m1e9TUSXOVW3KMqm7cK94ZQMFvd4AYdLfmfnStMp_MqIQh4kpIkB6h2b1M3possVrLKH_l2L3uT-qFiwQlH9-dt0Cje5mrkpsYCy4hAXNFUPhIyBWAZwOQylIE2sPuopFs55lRIHpWP2CqNe-IK8tX87BRuJ_Vy3GIFxDjD5uu74scIyQCKMImB6xQ_-mQ" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://testvault1021.vault.azure.net/keys/sdktestkey/4eb68492b5f6421e835d961ad2be3155", + "value": "dvDmrSBpjRjtYg" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/encrypt-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/encrypt-example.json new file mode 100644 index 000000000000..bff7837d7d2d --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/encrypt-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "key-name": "sdktestkey", + "key-version": "f6bc1f3d37c14b2bb1a2ebb4b24e9535", + "api-version": "7.0-preview", + "parameters": { + "alg": "RSA1_5", + "value": "5ka5IVsnGrzufA" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/keys/sdktestkey/f6bc1f3d37c14b2bb1a2ebb4b24e9535", + "value": "CR0Hk0z72oOit5TxObqRpo-WFGZkb5BeN1C0xJFKHxzdDCESYPCNB-OkiWVAnMcSyu6g2aC8riVRRxY5MC2CWKj-CJ_SMke5X2kTi5yi4hJ5vuOLzmg_M6Bmqib7LsI-TeJHr9rs3-tZaSCdZ2zICeFWYduWV5rPjTnAD98epTorT8AA1zMaYHMIhKpmttcj18-dHr0E0T55dgRtsjK04uC3FlRd3odl4RhO1UHAmYpDd5FUqN-20R0dK0Zk8F8sOtThLhEmuLvqPHOCUBiGUhHA4nRDq1La4SUbThu2KMQJL6BbxxEymuliaYcNNtW7MxgVOf6V3mFxVNRY622i9g" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/sign-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/sign-example.json new file mode 100644 index 000000000000..0cd7a4b3604e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/sign-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "key-name": "testkey", + "key-version": "9885aa558e8d448789683188f8c194b0", + "api-version": "7.0-preview", + "parameters": { + "alg": "RS512", + "value": "RUE3Nzg4NTQ4QjQ5RjFFN0U2NzAyQzhDNEMwMkJDOTA1MTYyOTUzNjI5NDhBNzZDQTlFOTM1NDA2M0ZGMjk2Mg" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://demo-test-vault.vault.azure.net/keys/testkey/9885aa558e8d448789683188f8c194b0", + "value": "aKFG8NXcfTzqyR44rW42484K_zZI_T7zZuebvWuNgAoEI1gXYmxrshp42CunSmmu4oqo4-IrCikPkNIBkHXnAW2cv03Ad0UpwXhVfepK8zzDBaJPMKVGS-ZRz8CshEyGDKaLlb3J3zEkXpM3RrSEr0mdV6hndHD_mznLB5RmFui5DsKAhez4vUqajgtkgcPfCekMqeSwp6r9ItVL-gEoAohx8XMDsPedqu-7BuZcBcdayaPuBRL4wWoTDULA11P-UN_sJ5qMj3BbiRYhIlBWGR04wIGfZ3pkJjHJUpOvgH2QajdYPzUBauOCewMYbq9XkLRSzI_A7HkkDVycugSeAA" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/unwrapKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/unwrapKey-example.json new file mode 100644 index 000000000000..cf4788e8aa6a --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/unwrapKey-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "key-name": "sdktestkey", + "key-version": "0698c2156c1a4e1da5b6bab6f6422fd6", + "api-version": "7.0-preview", + "parameters": { + "alg": "RSA1_5", + "value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6", + "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/verify-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/verify-example.json new file mode 100644 index 000000000000..a5b2b8cd8b6c --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/verify-example.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "key-name": "testkey", + "key-version": "9885aa558e8d448789683188f8c194b0", + "api-version": "7.0-preview", + "parameters": { + "alg": "RS512", + "value": "RUE3Nzg4NTQ4QjQ5RjFFN0U2NzAyQzhDNEMwMkJDOTA1MTYyOTUzNjI5NDhBNzZDQTlFOTM1NDA2M0ZGMjk2Mg" + } + }, + "responses": { + "200": { + "body": { + "value": true + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/wrapKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/wrapKey-example.json new file mode 100644 index 000000000000..dca7d31b09eb --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/examples/wrapKey-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "key-name": "sdktestkey", + "key-version": "0698c2156c1a4e1da5b6bab6f6422fd6", + "api-version": "7.0-preview", + "parameters": { + "alg": "RSA1_5", + "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6", + "value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/keyvault.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/keyvault.json index 34179af4101f..f50706a58982 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/keyvault.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/keyvault.json @@ -71,6 +71,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "Create key": { + "$ref": "./examples//CreateKey-example.json" + } } } }, @@ -118,6 +123,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "Import key": { + "$ref": "./examples//ImportKey-example.json" + } } }, "delete": { @@ -152,6 +162,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "Delete key": { + "$ref": "./examples//DeleteKey-example.json" + } } } }, @@ -205,6 +220,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "Update key": { + "$ref": "./examples//UpdateKey-example.json" + } } }, "get": { @@ -246,6 +266,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "Get key": { + "$ref": "./examples//GetKey-example.json" + } } } }, @@ -295,6 +320,11 @@ }, "x-ms-pageable": { "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetKeyVersions": { + "$ref": "./examples//GetKeyVersions-example.json" + } } } }, @@ -337,6 +367,11 @@ }, "x-ms-pageable": { "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetKeys": { + "$ref": "./examples//GetKeys-example.json" + } } } }, @@ -373,6 +408,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "BackupKey": { + "$ref": "./examples//BackupKey-example.json" + } } } }, @@ -412,6 +452,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "RestoreKey": { + "$ref": "./examples//RestoreKey-example.json" + } } } }, @@ -465,6 +510,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "Encrypt example": { + "$ref": "./examples//encrypt-example.json" + } } } }, @@ -518,6 +568,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "Decrypt example": { + "$ref": "./examples//decrypt-example.json" + } } } }, @@ -571,6 +626,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "Sign": { + "$ref": "./examples//sign-example.json" + } } } }, @@ -624,6 +684,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "Verify": { + "$ref": "./examples//verify-example.json" + } } } }, @@ -677,6 +742,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "Wrapkey": { + "$ref": "./examples//wrapKey-example.json" + } } } }, @@ -730,6 +800,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "Unwrapkey": { + "$ref": "./examples//unwrapKey-example.json" + } } } }, @@ -772,6 +847,11 @@ }, "x-ms-pageable": { "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetDeletedKeys": { + "$ref": "./examples//GetDeletedKeys-example.json" + } } } }, @@ -808,6 +888,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "GetDeletedKey": { + "$ref": "./examples//GetDeletedKey-example.json" + } } }, "delete": { @@ -839,6 +924,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "PurgeDeletedKey": { + "$ref": "./examples//PurgeDeletedKey-example.json" + } } } }, @@ -875,6 +965,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "RecoverDeletedKey": { + "$ref": "./examples//RecoverDeletedKey-example.json" + } } } }, @@ -922,6 +1017,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "Setsecret": { + "$ref": "./examples//SetSecret-example.json" + } } }, "delete": { @@ -956,6 +1056,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "DeleteSecret": { + "$ref": "./examples//DeleteSecret-example.json" + } } } }, @@ -1009,6 +1114,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "UpdateSecret": { + "$ref": "./examples//UpdateSecret-example.json" + } } }, "get": { @@ -1050,6 +1160,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "GetSecret": { + "$ref": "./examples//GetSecret-example.json" + } } } }, @@ -1092,6 +1207,11 @@ }, "x-ms-pageable": { "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetSecrets": { + "$ref": "./examples//GetSecrets-example.json" + } } } }, @@ -1141,6 +1261,11 @@ }, "x-ms-pageable": { "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetSecretVersions": { + "$ref": "./examples//GetSecretVersions-example.json" + } } } }, @@ -1183,6 +1308,11 @@ }, "x-ms-pageable": { "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetDeletedSecrets": { + "$ref": "./examples//GetDeletedSecrets-example.json" + } } } }, @@ -1219,6 +1349,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "GetDeletedSecret": { + "$ref": "./examples//GetDeletedSecret-example.json" + } } }, "delete": { @@ -1250,6 +1385,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "PurgeDeletedSecret": { + "$ref": "./examples//PurgeDeletedSecret-example.json" + } } } }, @@ -1286,6 +1426,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "RecoverDeletedSecret": { + "$ref": "./examples//RecoverDeletedSecret-example.json" + } } } }, @@ -1322,6 +1467,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "BackupSecret": { + "$ref": "./examples//BackupSecret-example.json" + } } } }, @@ -1361,9 +1511,14 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "RestoreSecret": { + "$ref": "./examples//RestoreSecret-example.json" + } } } - }, + }, "/certificates": { "get": { "tags": [ @@ -1383,6 +1538,13 @@ "maximum": 25, "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." }, + { + "name": "includePending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Specifies whether to include certificates which are not completely provisioned." + }, { "$ref": "#/parameters/ApiVersionParameter" } @@ -1403,6 +1565,11 @@ }, "x-ms-pageable": { "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetCertificates": { + "$ref": "./examples//GetCertificates-example.json" + } } } }, @@ -1439,6 +1606,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "DeleteCertificate": { + "$ref": "./examples//DeleteCertificate-example.json" + } } } }, @@ -1477,6 +1649,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "SetCertificateContacts": { + "$ref": "./examples//SetCertificateContacts-example.json" + } } }, "get": { @@ -1504,6 +1681,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "GetCertificateContacts": { + "$ref": "./examples//GetCertificateContacts-example.json" + } } }, "delete": { @@ -1531,6 +1713,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "DeleteCertificateContacts": { + "$ref": "./examples//DeleteCertificateContacts-example.json" + } } } }, @@ -1573,6 +1760,11 @@ }, "x-ms-pageable": { "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetCertificateIssuers": { + "$ref": "./examples//GetCertificateIssuers-example.json" + } } } }, @@ -1619,6 +1811,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "SetCertificateIssuer": { + "$ref": "./examples//SetCertificateIssuer-example.json" + } } }, "patch": { @@ -1663,6 +1860,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "UpdateCertificateIssuer": { + "$ref": "./examples//UpdateCertificateIssuer-example.json" + } } }, "get": { @@ -1697,6 +1899,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "GetCertificateIssuer": { + "$ref": "./examples//GetCertificateIssuer-example.json" + } } }, "delete": { @@ -1731,6 +1938,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "DeleteCertificateIssuer": { + "$ref": "./examples//DeleteCertificateIssuer-example.json" + } } } }, @@ -1778,6 +1990,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "CreateCertificate": { + "$ref": "./examples//CreateCertificate-example.json" + } } } }, @@ -1825,6 +2042,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "ImportCertificate": { + "$ref": "./examples//ImportCertificate-example.json" + } } } }, @@ -1874,6 +2096,11 @@ }, "x-ms-pageable": { "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetCertificateVersions": { + "$ref": "./examples//GetCertificateVersions-example.json" + } } } }, @@ -1910,6 +2137,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "GetCertificatePolicy": { + "$ref": "./examples//GetCertificatePolicy-example.json" + } } }, "patch": { @@ -1953,6 +2185,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "UpdateCertificatePolicy": { + "$ref": "./examples//UpdateCertificatePolicy-example.json" + } } } }, @@ -2006,6 +2243,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "UpdateCertificate": { + "$ref": "./examples//UpdateCertificate-example.json" + } } }, "get": { @@ -2047,6 +2289,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "GetCertificate": { + "$ref": "./examples//GetCertificate-example.json" + } } } }, @@ -2093,6 +2340,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "UpdateCertificateOperation": { + "$ref": "./examples//UpdateCertificateOperation-example.json" + } } }, "get": { @@ -2127,6 +2379,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "GetCertificateOperation": { + "$ref": "./examples//GetCertificateOperation-example.json" + } } }, "delete": { @@ -2161,6 +2418,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "DeleteCertificateOperation": { + "$ref": "./examples//DeleteCertificateOperation-example.json" + } } } }, @@ -2207,6 +2469,96 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "MergeCertificate": { + "$ref": "./examples//MergeCertificate-example.json" + } + } + } + }, + "/certificates/{certificate-name}/backup": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "BackupCertificate", + "summary": "Backs up the specified certificate.", + "description": "Requests that a backup of the specified certificate be downloaded to the client. All versions of the certificate will be downloaded. This operation requires the certificates/backup permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The backup blob containing the backed up certificate.", + "schema": { + "$ref": "#/definitions/BackupCertificateResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "BackupCertificate": { + "$ref": "./examples//BackupCertificate-example.json" + } + } + } + }, + "/certificates/restore": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "RestoreCertificate", + "summary": "Restores a backed up certificate to a vault.", + "description": "Restores a backed up certificate, and all its versions, to a vault. This operation requires the certificates/restore permission.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateRestoreParameters" + }, + "description": "The parameters to restore the certificate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Restored certificate bundle in the vault.", + "schema": { + "$ref": "#/definitions/CertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "RestoreCertificate": { + "$ref": "./examples//RestoreCertificate-example.json" + } } } }, @@ -2229,6 +2581,13 @@ "maximum": 25, "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." }, + { + "name": "includePending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Specifies whether to include certificates which are not completely provisioned." + }, { "$ref": "#/parameters/ApiVersionParameter" } @@ -2249,6 +2608,11 @@ }, "x-ms-pageable": { "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetDeletedCertificates": { + "$ref": "./examples//GetDeletedCertificates-example.json" + } } } }, @@ -2285,6 +2649,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "GetDeletedCertificate": { + "$ref": "./examples//GetDeletedCertificate-example.json" + } } }, "delete": { @@ -2316,6 +2685,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "PurgeDeletedCertificate": { + "$ref": "./examples//PurgeDeletedCertificate-example.json" + } } } }, @@ -2352,6 +2726,11 @@ "$ref": "#/definitions/KeyVaultError" } } + }, + "x-ms-examples": { + "RecoverDeletedCertificate": { + "$ref": "./examples//RecoverDeletedCertificate-example.json" + } } } }, @@ -2493,7 +2872,7 @@ "tags": [ "DeletedStorage" ], - "operationId": "PurgeDeletedStorgeAccount", + "operationId": "PurgeDeletedStorageAccount", "summary": "Permanently deletes the specified storage account.", "description": "The purge deleted storage account operation removes the secret permanently, without the possibility of recovery. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/purge permission.", "parameters": [ @@ -2653,7 +3032,7 @@ } } } - }, + }, "/storage/{storage-account-name}": { "delete": { "tags": [ @@ -3345,11 +3724,33 @@ }, "kty": { "type": "string", - "description": "JsonWebKey key type (kty).", + "description": "JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.", "enum": [ "EC", "EC-HSM", "RSA", "RSA-HSM", "oct" ], "x-ms-enum": { "name": "JsonWebKeyType", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "EC", + "description": "Elliptic Curve." + }, + { + "value": "EC-HSM", + "description": "Elliptic Curve with a private key which is not exportable from the HSM." + }, + { + "value": "RSA", + "description": "RSA (https://tools.ietf.org/html/rfc3447)" + }, + { + "value": "RSA-HSM", + "description": "RSA with a private key which is not exportable from the HSM." + }, + { + "value": "oct", + "description": "Octet sequence (used to represent symmetric keys)" + } + ] } }, "key_ops": { @@ -3416,10 +3817,28 @@ "crv": { "type": "string", "description": "Elliptic curve name. For valid values, see JsonWebKeyCurveName.", - "enum": [ "P-256", "P-384", "P-521", "SECP256K1" ], + "enum": [ "P-256", "P-384", "P-521", "P-256K" ], "x-ms-enum": { "name": "JsonWebKeyCurveName", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "P-256", + "description": "The NIST P-256 elliptic curve, AKA SECG curve SECP256R1." + }, + { + "value": "P-384", + "description": "The NIST P-384 elliptic curve, AKA SECG curve SECP384R1." + }, + { + "value": "P-521", + "description": "The NIST P-521 elliptic curve, AKA SECG curve SECP521R1." + }, + { + "value": "P-256K", + "description": "The SECG SECP256K1 elliptic curve." + } + ] } }, "x": { @@ -3980,16 +4399,31 @@ "kty": { "x-ms-client-name": "keyType", "type": "string", - "description": "The key type." + "description": "The type of key pair to be used for the certificate.", + "enum": [ "EC", "EC-HSM", "RSA", "RSA-HSM", "oct" ], + "x-ms-enum": { + "name": "JsonWebKeyType", + "modelAsString": true + } }, "key_size": { "type": "integer", "format": "int32", - "description": "The key size in bytes. For example; 1024 or 2048." + "description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA." }, "reuse_key": { "type": "boolean", "description": "Indicates if the same key pair will be used on certificate renewal." + }, + "crv": { + "x-ms-client-name": "curve", + "type": "string", + "description": "Elliptic curve name. For valid values, see JsonWebKeyCurveName.", + "enum": [ "P-256", "P-384", "P-521", "P-256K" ], + "x-ms-enum": { + "name": "JsonWebKeyCurveName", + "modelAsString": true + } } }, "description": "Properties of the key pair backing a certificate." @@ -4053,6 +4487,11 @@ "x-ms-client-name": "CertificateType", "type": "string", "description": "Type of certificate to be requested from the issuer provider." + }, + "cert_transparency": { + "x-ms-client-name": "CertificateTransparency", + "type": "boolean", + "description": "Indicates if the certificates generated under this policy should be published to certificate transparency logs." } }, "description": "Parameters for the issuer of the X509 component of a certificate." @@ -4278,7 +4717,7 @@ "key_size": { "type": "integer", "format": "int32", - "description": "The key size in bytes. For example, 1024 or 2048." + "description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA." }, "key_ops": { "type": "array", @@ -4307,7 +4746,7 @@ "x-ms-client-name": "curve", "type": "string", "description": "Elliptic curve name. For valid values, see JsonWebKeyCurveName.", - "enum": [ "P-256", "P-384", "P-521", "SECP256K1" ], + "enum": [ "P-256", "P-384", "P-521", "P-256K" ], "x-ms-enum": { "name": "JsonWebKeyCurveName", "modelAsString": true @@ -4371,10 +4810,56 @@ "type": "string", "minLength": 1, "description": "The signing/verification algorithm identifier. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm.", - "enum": [ "PS256", "PS384", "PS512", "RS256", "RS384", "RS512", "RSNULL", "ES256", "ES384", "ES512", "ECDSA256" ], + "enum": [ "PS256", "PS384", "PS512", "RS256", "RS384", "RS512", "RSNULL", "ES256", "ES384", "ES512", "ES256K" ], "x-ms-enum": { "name": "JsonWebKeySignatureAlgorithm", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "PS256", + "description": "RSASSA-PSS using SHA-256 and MGF1 with SHA-256, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "PS384", + "description": "RSASSA-PSS using SHA-384 and MGF1 with SHA-384, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "PS512", + "description": "RSASSA-PSS using SHA-512 and MGF1 with SHA-512, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "RS256", + "description": "RSASSA-PKCS1-v1_5 using SHA-256, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "RS384", + "description": "RSASSA-PKCS1-v1_5 using SHA-384, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "RS512", + "description": "RSASSA-PKCS1-v1_5 using SHA-512, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "RSNULL", + "description": "Reserved" + }, + { + "value": "ES256", + "description": "ECDSA using P-256 and SHA-256, as described in https://tools.ietf.org/html/rfc7518." + }, + { + "value": "ES384", + "description": "ECDSA using P-384 and SHA-384, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "ES512", + "description": "ECDSA using P-521 and SHA-512, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "ES256K", + "description": "ECDSA using P-256K and SHA-256, as described in https://tools.ietf.org/html/rfc7518" + } + ] } }, "value": { @@ -4392,7 +4877,7 @@ "type": "string", "minLength": 1, "description": "The signing/verification algorithm. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm.", - "enum": [ "PS256", "PS384", "PS512", "RS256", "RS384", "RS512", "RSNULL", "ES256", "ES384", "ES512", "ECDSA256" ], + "enum": [ "PS256", "PS384", "PS512", "RS256", "RS384", "RS512", "RSNULL", "ES256", "ES384", "ES512", "ES256K" ], "x-ms-enum": { "name": "JsonWebKeySignatureAlgorithm", "modelAsString": true @@ -4832,7 +5317,7 @@ } }, "description": "The backup secret result, containing the backup blob." - }, + }, "BackupStorageResult": { "properties": { "value": { @@ -4843,7 +5328,7 @@ } }, "description": "The backup storage result, containing the backup blob." - }, + }, "PendingCertificateSigningRequestResult": { "properties": { "value": { @@ -4871,7 +5356,7 @@ "format": "unixtime", "readOnly": true, "description": "Last updated time in UTC." - }, + }, "recoveryLevel": { "type": "string", "description": "Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the system can purge the storage account, at the end of the retention interval.", @@ -5135,7 +5620,7 @@ "format": "unixtime", "readOnly": true, "description": "Last updated time in UTC." - }, + }, "recoveryLevel": { "type": "string", "description": "Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only the system can purge the SAS definition, at the end of the retention interval.", @@ -5413,6 +5898,29 @@ } }, "description": "The key vault server error." + }, + "CertificateRestoreParameters": { + "properties": { + "value": { + "type": "string", + "x-ms-client-name": "certificateBundleBackup", + "format": "base64url", + "description": "The backup blob associated with a certificate bundle." + } + }, + "description": "The certificate restore parameters.", + "required": [ "value" ] + }, + "BackupCertificateResult": { + "properties": { + "value": { + "type": "string", + "format": "base64url", + "readOnly": true, + "description": "The backup blob containing the backed up certificate." + } + }, + "description": "The backup certificate result, containing the backup blob." } }, "parameters": { diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2015-06-01/keyvault.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2015-06-01/keyvault.json index 2b02f460cd05..46802fea6fdd 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2015-06-01/keyvault.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2015-06-01/keyvault.json @@ -2246,7 +2246,7 @@ "key_size": { "type": "integer", "format": "int32", - "description": "The key size in bytes. e.g. 2048." + "description": "The key size in bits. e.g. 2048." }, "reuse_key": { "type": "boolean", @@ -2539,7 +2539,7 @@ "key_size": { "type": "integer", "format": "int32", - "description": "The key size in bytes. e.g. 1024 or 2048." + "description": "The key size in bits. e.g. 1024 or 2048." }, "key_ops": { "type": "array", diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2016-10-01/keyvault.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2016-10-01/keyvault.json index d5899637e785..c966bc6e254e 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2016-10-01/keyvault.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2016-10-01/keyvault.json @@ -3011,7 +3011,25 @@ "enum": [ "P-256", "P-384", "P-521", "SECP256K1" ], "x-ms-enum": { "name": "JsonWebKeyCurveName", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "P-256", + "description": "The NIST P-256 elliptic curve, AKA SECG curve SECP256R1." + }, + { + "value": "P-384", + "description": "The NIST P-384 elliptic curve, AKA SECG curve SECP384R1." + }, + { + "value": "P-521", + "description": "The NIST P-521 elliptic curve, AKA SECG curve SECP521R1." + }, + { + "value": "SECP256K1", + "description": "The SECG SECP256K1 elliptic curve." + } + ] } }, "x": { @@ -3040,7 +3058,25 @@ "enum": [ "Purgeable", "Recoverable+Purgeable", "Recoverable", "Recoverable+ProtectedSubscription" ], "x-ms-enum": { "name": "DeletionRecoveryLevel", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Soft-delete is not enabled for this vault. A DELETE operation results in immediate and irreversible data loss." + }, + { + "value": "Recoverable+Purgeable", + "description": "Soft-delete is enabled for this vault; A priveleged user may trigger an immediate, irreversible deletion(purge) of a deleted entity." + }, + { + "value": "Recoverable", + "description": "Soft-delete is enabled for this vault and purge has been disabled. A deleted entity will remain in this state until recovered, or the end of the retention interval." + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Soft-delete is enabled for this vault, and the subscription is protected against immediate deletion." + } + ] }, "readOnly": true, "x-nullable": false @@ -3565,7 +3601,7 @@ "key_size": { "type": "integer", "format": "int32", - "description": "The key size in bytes. For example; 1024 or 2048." + "description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA." }, "reuse_key": { "type": "boolean", @@ -3858,7 +3894,7 @@ "key_size": { "type": "integer", "format": "int32", - "description": "The key size in bytes. For example, 1024 or 2048." + "description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA." }, "key_ops": { "type": "array", @@ -4800,4 +4836,4 @@ "description": "Client API version." } } -} \ No newline at end of file +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/BackupCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/BackupCertificate-example.json new file mode 100644 index 000000000000..67d4a94b4f8b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/BackupCertificate-example.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "certificateName": "testcert", + "api-version": "7.0" + }, + + "responses": { + "200": { + "body": { + "value": "JkF6dXJlS2V5VmF1bHRLZXlCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUkwTXpnMVlqQTNZaTFrTlRRM0xUUXlaVFV0WVdVNVpTMDJNVEJrWXpNNVpHWmhaamdpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLm85bmpNWEFSZWVla2NaRXBsVTNjdUxQcVZlWmxFbGRDM01XOWpYR0h6bnBXRTdHRGVOSXJraGZscHdTWXFnQnBYQkozMFpUQkRpRmpROENXSnJfUGlsUWNDRkZyN0xrdWJhWUs0TW1zcVh5WGIzbkRJcUJkQmZIUVNpZ1ZET0J5Ym9sUlRNNDYzYjBTbXhLVzJheEdFS2NuZzQ5WFkycG1SR0Vrb0plcHJWZ0tyRkpOUGQ3cGJIS3hQSWdDOFlnT2xudnZxR280RlRDSzh0ZWotcUt2UzBfRGV6Uk5vdTZqZ25SekpxX0g2NGxWMk1hQ0NnUy0xbTlyOGVOTVVvSlhTV1hwc0lneng1RzdEbzIya1ZEY25vMW9rajlCMXNvbklkWmtuY1JybDJBVHNRZVlzZXdkUVd1VmhxRzVLN0pNQWo5YzBRdkxhTmlpdl9PY2pFcm5qUS4zbmI4azJ3SEcyNHFJelNNb184WG13LnJzc3NMNjJ1aUNfTm9IbG5zQlgzcEEtck1uY3g5R3V2NmJYSHpKamxwOWNMUnVaSDBSWlJYVXRwU3BPQWdyZ20tU3BxeEdWSjd2bmprbV9FSzJwYy1sZHNjUWtRSDB4bVFVcGZFNzN5b1VTYTNXVVNMS2VIVnJLdUg5MUtJR0tLODE5ejc5d1Y5Y0F3UjlzcHJxbFFWZnlKdlNFM2tnZTh1RVBpRFFVMFl5WnJqVjBsMGJCU3VkeTN1MVlsVHB6Wk1EWmpUcE05ZGtMclgtaGdxZ1FGa2xFa1hNRWlzd0RDZVM3Y3J2bFg1bnVzbWh5SkZCMklCd3dxNWJieHptV1diU3JOc3lFMmJmWEpXOWN4TFlQcnJJZFpfbkd0X29RSGVQcUFZTS1iVnpTdzdBRGJjMU15NTZwclBGLW9PSm40MHptOTBaaFBTVGMyQXNKRGFBa3R5WFU4WktOYUhFVUlHLWI1SGhUdFBuZ20wN0FrWEtQNngwaDhzZ3ZIaGdCeGpfdWRfQVpQc3pLWG1HdUhFTW9lRGhpT3NkQVdRR0pwR2t0NHVlbmZyamNSeXVlaXJiTC1RV3o4MEtZUnk1QklxbzVJc19RVHpWN2dqMGstYS0td24tazNsNTJ4YjhaNkRXd2tWZ3hqUlNXOXZnV0pVd2U5M1ZrVWtHM3NLRW5SOE9ueTNjWlhQVl9LbWtBTEdlR0ZzQm53SmQwY3dueTBCN2I5VWQyQ19kWEZ0N1BvbnFVNldfT016cC1Nb1NtRzRHbEFpUkVfQ3FrWlhkalhIMVItSmpObUNfdXlPUTdaN1BVaDAtNmd2YUxpcE1CamlWR1FwdzlEZDhmVmtCbWk4VW5uOUxPYXJmSXVtcEJyUE43TTJhM05KdjN6b0NkanhZVFVUMTN1aElpYWl3aExoUFZhT2pUbFRmTkpqbHhIbG5lbGJ1RWJsZTk0bVV1bW8wcjhKRlFMSDdfRjhXMVo0OC1BcjhYYXJwMXhIY0FReHk1WWYwclktdUU1dTAyRnRHUHlPZ0JfNV9WdFlNR2VfRE1mdENLOGVMZGFnVllMRDJDNDUxTldZeVVfeHdNUWdQbXBaMWFnSEdCb2s0ejhsSFBndVhCQ3R2WFFuTHBXQTVBamdOLWNoWjNwUGJmc2RkNjBhekJuWDVaVXQza2hYaWNDdWk4b0xidEtzQUdmckNOZzFwT2Q0MHBHMEJlVy1lNVE1WWQydjY4eFh5a2RiTXhFblFCM3Fzd1djVlh1QXBIR18wREZVVmZvSlc2aVBZcDNWVE51amM5M3QtMDcxWnlZbUZ4V0RfVThMYTAtM19RLV8yZ0pwMVBaVV8tMVBRM1huLXdSWk1vb3JkZGZQa1VPZ0lqdWkwa1IwZWt5RjZvdWdLNnJrSVZHaGp3YUp0ekdKczJLdGxncnRCcEs2MXZEaE5zbFR5VHU5OUp2T2RFTXhwRG5lTEg4NnlvVnhxT3lIT3lxNjByXzdpTHgtdy03Q3FzWTloT3dmQlBZZ3BQVlM2bm9oZVBocTkwaGJTX0lrM21YbnRkRUNMREtSMi1wWFh6bjlPRjZIN09EdHB4S0VXQkdCaHJ0Ykxmd2JZS3dmWmZSVTJVUHpkLUxFd1lQdDloU203Z3lSODNoYkZiSFNBV1cySncxRWl1c3FURWRsRW1lQ3k2cFp1MVFZWko0TUQ0OG5rVXMwdmVHUVhTU2Ytb2RhQm1fYjZZdVh1cWcyWk03MlZjUTd4ZzV4MmpFenFqcllmdjdTTGJINFZBcWp0aFg5LUdRaWEwWEZaS18xempIenhkd1B0R2lSOHJfMkFFZTgtRXFoNi1FaTZKdjRFZjYyMnRrNWFJUWx3R1pETWpGSVNuUkpRdV8xcnJiY1E3enZsbWhUSWFQcUJNRFVxeHBEOXNWUlhuSHdIaTl1b1BCUTllbWJIMkV5WDV6MEhWRXlDa1JEbUd3cmR2RGdsOFVzMUhURjVwYXlYZmF2WkZUZjl3WFZyQXpsRFBEQkFJVFMzWnVJMEJWR2pJUGV1SnRiako4S1pTczRFQVNRRTVyVjViTUpNQXcwa19nYkVRTEZGSjJVb0ZzcWU1QUszM2xGXzR5cGMxU0JaWjJfUzYtbEQyNkpyRFVJSjFFRmJhbWtoUk12bWJIT1Utc0hDT0lRcHdadlJzV3Q3NExSQ1ZyQ09jMGpUdE5TT1JPUW5XRHVXRlFXSzk1TkRGMG96WjIyLVFEMU9YOE9iU3daaHdOXzNfS1pHRmtVMEhNdzNjSTI5LWUxbFltRDV3cmJ0ZlRFbllOeHJKOGpuUWFBY2FoNy14Q0JKeUQ3elo1MXIzRVVyY2VnazBzc1dLeHRPVjRLcTZENmxuVmU3bFpUT1dfTU5aZi1JSzJUbnZCaVZIMHk0SkVGaUxzSDJHbTM1d28yYlZVaXJsT1ljVEk1NlZhdDhMRWhGaEotVlUyNk84NHo2dUJFZmJucEZLbmdKc3pfYVlucW1zNWV1bmd3ek5ndjdlT0U0cUdKSURyMTRBUXRWdEYxcWdrZHNnVllWVXg4U29SQ0NobE5VUzRNRGxhc1hwS1VmV19ENWIxbDRkbXZiNEZNRHJqakJ6djk5dGJSeGZFYUVOSFlYTHZFZnJ0b0pMeW9na2tmNkxlbVoxVDZRbnRtNlR4S1IycU81WU1vMnRJZHlQNmZNRmkweEYtdE1IaHNSdVN3VEpybW1nREcteHVpZllVNkpfaElSNkMzVmo2VkFMMW1oZy0xeW1pRXZuanVLbElONzc4NmFWdVNpNmx5TjJJNzZqY0R6SHZ0VW1ibkVvWWtORHNPQXdqQk9MNFBlS0VjR1hWcm5YNDJhNW5IRWM2cmZQdjZ0Q2tVSUI0UldIdzEyUTFiNDM2N1JvRS1PTWN3TnV6ampob1M0S1ZJbHo4UEFMOW9YYTR4NXlQeG1aVzZ0UUVna1pKeFhEcS00SWRtd1UzTnpVZUoxdGpNaXFsc0xRWDdlc29fTHRtTWJ3bm83YkI3bjRlVnZ4aUtQU3p3dW94c25aaGs1b3ZSSE1xU0NtZjU2MjJvUTZvWEdmNUJLWExlQWdqaE1Sd21razEtUzlGajlyc1hlT19VYjJOMF9hVEFLemlidXIxNVcxaHI3Wk1PVFlxOFlSSGVPaWxSX3Bkdjl5NTlDRDQ1WmE0ZXFURHVrNmRxZ1d4YnoyVVVtMnpwM3pvTHVKSVZ1Y3FIaUVRTVNfMnFKcy1xQTAwT2FFY3huZTM2Q1RsZVNwZjF5cjh2VjNWNW1mQU5zRnJBa21CMnBRWTNfZ21UbldTYTJ3UWlMa2RFRllPSExTeEk5UVowNHo4ZFRfbW5QMmIwWV96N3ZLa0VGQmFpNU02UFdPWjVIOUx1M3Rnay1fR0g0ODd6ZHpuQm0weWZZY3ZIOHJUd1QyQl9UZVRFMG4xcWFRdDRiQ0diUkFQNE1DTDl0SGlIcmlzWEllejQzZlZ3b1c4R2x4YmxKanlLWkpXbmlRNjlBYks3SmYyUER6d2NVSHhkZU5HNGxEZmt6WmFxU2lybGRzZlhXOHBGLWZ6WFVVWHR4eDF4Um5nQ1hJVkxLbU5ZbV9CNnNrNGo0VzROVFMwQTBOcFhsZGJCWjZWWmFDMDNvRHVGUFY0MGtwdWQ0WEd3Q1l3M244ZjFHb0Z6Sk42QjFqOTRLeTdtNE5YT1JsQ3ZaRW5qZTl6T241T1d1ZG9USWRoRzBobXVDUTZ6TXI2YkVaTUFoV1ZFdlREY19iXzZsOWdLWmVxNmVtekxvcmptOEQzLXcyLXRBYlE2Tmpjd0J3eEhMZzlCRllRRFdvaU9UVmJKN2VBcUVFMHVxVkhBcE9KbFVIc2tmQy1uV3NzOV9fRTFURHBLcjRfRE93NFhPUGNzT3dlVU9EUWg3cVFXRE1ZcDVHU1poVWE4MVVHczhmemZKU3JPbmtaTmRVTS10Y0h3R01mX3didy11dmt4UFUtV0tvNUNqR2M2aU5KMDB4MjZZdUpCWXd6TVFyeDBJQWgxMjVBWlozX2FvaFFpLWw3a1pZVE82Q0JVOVZsYllNMndrZXp4ZGhrQ1oxd080Z1NNbDlKU3A5ejhxNV84SU1WM1pma00xV1VqSGZMQk4xRXdFMjRxZFVzcWxyU3NZN1hQaVlpcXQ5ZktXVmZDTWw4RU0yd2ZHYlhxMUI4eWl2UlpMcko0eEk2MUdVUWJFVGU4akNTYTF2aUxxZ0FIa25IYjVjVHIwbDRhTW1EZGZKWnJxZEdpb1lPb2IwdHBuc3IxanRfZm1obGhJa1NSQnREUk5XWEU1OXBjVXlULXpyVjBxZl9sOHN2TlNEV2N3d09YQ3lITWZzLWw0T29xMldVWTVLQi1nSG1HYUJod0oxa19ra3V2S0hlMl9TY0loc3JjTXV1eW5aLW14Vzl5NHBBS3pvdVFsQjR0ZGZvbHdSRk5KX0tHYWJPZXJiWFdDT0ZTd0JVTjdNaG0wOXNyVS1VWG5od1IwdTYyTjVvMDlfbGN5eThnWDg1ZUVrenhuOGZ2NHd2T0Y2dUd1cFk5UGxpSTRLMTNqSHlOd0ZuY2VmRlp2b0dxVlhkcUg5RGJkYS0zY1FhbVFlNmlMek0wRDlnLXlFc2NBTkpKS3ltelVzemZZdV8yY0p0TEhsd0I3NVhLeW1EMG9nUkRvRkRwTmNPd1dRRUlwdVJwU0pfdWtzR2EwZkd3MGVBTU4tQmc1OUs3emhRWHJISUZOckN1S1VPMVdvTkV5WkM2UGlKSUwtUlRsTFQ2WlBNZmdSZzZiUl9aQk43X2dseHBIakNDaFZXMkZ3MnJFUDJJX1pSeHFqdS1WbmVwV2o4eU1CaHZXZzdXNm9QWm1odmVtUTBkQUljNVZTbVVaelhvNFVURmJxSFN2MGlyVTNscVk2eUl1MGRPd2t2MlF4ZENfQVdRUmdLSGRUeG1xYXFUSXJwclZyUHZ1MDFQSGlFbVRnaDZZVEZ6Yllqb3JEeFExWDhlTUN5Rl80cWNjMnhOdTJRblBIdUR0RGZkSy1NV2xJUDhHUEhSMmhPMjlCa0JJSEM4TlgxZmxDN1ZSZkZsQ09McGVIeWl0MGRSd1d2S2tieGNIWl9fRE5ZLVBNQlZMZGpyR3lxT2JoQnpQZHZMeFpXWVU3THNRbnM1dmxiMTc5YXczX3VmclRIWGs0MVpjaDY2ekFRRl9tekQ3ZEVuMm1fb2tBaTh6NTRwdzdxUDAwNHkzenNPd0RmR0htYWF2c3dGMW5NMUN2YXhXajRINE45dVNUaV9DM1oza3lTRHlUNGdUZjNqc0FKUEJybXdSQVBpaU5PTTU3c0x2Y3dJRk9ENnA5QkdWbjFwbjQyZGRTU3A1M3JieTZEcnlwcHdDaDFrampQX3lCbTZRZnd6MElGUWJiSG1zVDNVa2RMb1dURjFSMF9sbjJtR1kxU0hHT2o3VHl1YnQ5d2xLVW5nczVMTWhVcHo3NU1LR3F6UkFnWXNKcHVKUVl1RVpKeGFPSHNmY2VwakdrcFdoMEtfWkhZUEJESzIwOFVqb3FqMDdlVVVueTBaXzJrNXUxTjQzWGJ3V0ZvWVBhdndheW1MYkhWdkRwbzdwMU9JT1IyNkt0SzdPeGlnZ0ZybGVISWNaODFwQzRCdlNzRnZsY1BCZEpHLTZxWTU0Q3J0R2xhaDRvQWplUXgxWS1YU0NLNnZLYUIwWnZHc2lIajhRQ0ZURjRuLUJqTWIzWDcycDJ5Q0tPRlpMRk5qcVR1aHJoYXNnMi1pWTNOTWdwVEQ5eVBSdjA2X1VpcEVfYjVsQ0R0Mmx5QU5NYVpZR1RvSmJTSVhBcFlyU1hEM1dFWllhTGUzQmFSUEJUYTAyeWpyVFZPRDRGNHRFR3c5MkZJZThOSk5NYXRXMFhPSFAwVWxKTXlQUDF2MVdvOUh5aFllaDFfdWg3SlRLcS1hWnJjOS1Xd0ItQXBKTHBQeGxmRzlGZkgwdjNwSTl0Z1VndWJmSkJQVjMwNll2MlNqQ0M2MmVYN3VFTUgzcXQ3TmFYcFVsNXZEVHpfMF9Vc3VlWERQcDNqV01XQTMwenFaYTRFT0dXdElMb0tEM1RjRWNVcmJONGV1bHFQSkFNcWdWdmk2YWRGdTgxU2w5cU1rVVUwaWpqMjZhZDFaeVlEUUZtWlJ4NjJYUW9ZdG81bXJ0eFZhYWtNNndqbkVPSUdJaHhBTnJoX0dNVzVxREhzMEV6TDU4b3lOY0Q5dE1MUC03N1FCbTZwUTFsR0swMVJ6Y3FzTk14ZzRMTzl2ZHQ3NFpIdEhMXzA1TjF2TUt4TE5GbkdhZmwxN1E0eEM0Z3NQeXpYdzBjcklyV2tIQlNQX0NoWE94SmZORWdyNjJOMXEzQVJZa0U1TVlCbzctM3djb3dNT09GcTlrakN1ZGpoekplRjRTUHdfMnFVWVhZRTZsNXJTYjYwUFlFSkJxdW82Skh5ZmdlOXFJX0Rzdmg4eEY1STJfLWtLT2pxU3FZam02NjU0cXVES3phQ3JWLUJFLWtQNF9DOU5OQ0xTaEVWUV92Z3hYdDhzbTRWNGNRMElDRmFzaWV6VnNuV1QtYmRQTGxBT2RqOS15RmhYVTRUYVF3YnZqQ0E2UHQ0aDNVWGdnQzNqWU5IMmJtRGpYSzhFdFJYRTV6cmJsTDRKMFZ1OGxHQVBZaGtOcGNOakNrNWhSSW5jT0dybE9aUk9jdTdSeVczR2JWM2Y1MGJKN0xLNHJjMnJCMTZuemhBdk41WXlydWdwQzdCOE9OR3NTY25ha1V1alJzRzZGYVpydDNzTDJMOW5RTUNoNE9INFF3VWpKWFZKUFJ2MHhPTF9jVEQtdjk0QWgwbWdtcFJ2Q1dhUkl5MXRxeDZHTmZ1R1Nyb0tObmtHYjRiRE1oblpZMmwxQWluWHlCMG5uRGlvci1EUmo1cjhRZi1iaUR6cGhTallzZTZrakdLR0ZObzU4WjFfaGxEaGFob1pQX1lRdlBtWi1Tb2pNaGhMRXZqMXEyZzZWRVd6a1FDWTdIWVEwM1Y3cHVCVm4yaXM1NXpBSGV4cGpERWoxWDgxWU92bnVTdXRhMGx3VkFEMkRoNjZDcmM2VVh2SEtUZTBCeFlsQWdVdkhQc1BkSy1OdVk4S3RaeGNqTWNDVWM0OVl6VW43RVBTamFNaHJ2Ni1mM0pwc09Na3JwREpLM0dPTUVRMUV4cnhYV1lGaGtLaHR2UXZkMXZCVS12b0pRcWJveU9vS1hMM29Xb0FRVnljWlR3Y2laeW4wbUtkVF96NDNFZGhNcDNKS3N5blJ3OVZtSzk3Q3lldGl5LV9HaWVMSngtWDladVMzOUdNa0YxaFVmYmkyc3FJZGZMZ0diem5uMTluTlRVUDlOR3dhaWhybU9Ib1lZeUJ6WE4tby1UWUxhSS01bkNuQ2FSSW9QTF9XSVhyWDZPSzdZU21IWjk4a2xJS19JNTlPSXlWSllrMVh6bGVwd1lPLXUwU0x6bTEtN0dKSE54RGVOMlZhUEk3TThVem10X0x5alliWWxocFFJQnNyUktsMmZZeExKaGt6Q3NjcWp2bVhDemRLVDNhNFV3NDJ4eDlsOWl6dFQ0UmtnV21fYV9YWWk0b0gwdjNCUXRSZ3NfUTBPaGo2T2Y2dEtyZU5XZmcxVDRjMk01SERJd3UxTkl2QXBqNzZtOXJWQkdPWTZFUnhfa2Y3d2twb1g5dWRvcjBCbEx4a1FCc0lwZXpUdzc1MTBncU81Nm1UWXlBUzFCUVdOY1Q2aWhfN3F4ZTVoUkVlZVB5YUpFMnhqR2JNWGg3V1hGYjN0ejVWVWJOTFpxMjBiM3E0UFdkdjJXX1Foc2VUY0JTRDY1eVFPYndTai1UcVpNNi1teUZHb3B6dVdfRWcxU3pzNzRaY3RMSUxyN3pMLXRyeC1WTTVfVHllMVZXbG9ZOTZVYUJyUktpQWU1SVhKMlBQd2RIY1p4SWx4N3dBRXdueXVOZXA2b2NKcXRwZUJ1elB0LTFaX3UyWjZrQmR4V0lpYlVEaGxOU3AxM1NkTGw0Z2hkemVqZWFaYVllRDVtTGltWWJ4dEhsQ1ZiTm0yNU1ZbDYxMFU3QlZnNVJJSXB6VUdmZ2Z5NnpJRzRLQjBMR3BISzNhdHRRUExvQ1VlTDRYNVdBUUFsb3BRa0RKOU5lTHFGdHN4cWpZaGJnZ1Z5am9ScjNPOVhzYzlJVEtVaXJaUDlyTVl0eFduT0tUck9YYVk2WVR2Wi05QUhpT3ZfdTRhOElTS01DVng3OUlnXzdqTjFfREhjdGd5cEEzVnpkbjNKdlJJQTlfbHZDV2dTSS1NUjlPQ19xekhIUmU5dENqWklDVzhwRURSYVhZOHc4UUQ0bXJicmFLTTNsWmtTNUF2NVp2WjFRTDJlZkExbXlJdmN2czhmekxRUFM0Nm0xX3ZPVzcxN05ydDQzeUcwbUZxZnk4aExaZEUzQ2RkMzRtVVFXWVdqSkdvQXZ0VHBXRmpwWkwwOERjQUd0RzVzdkU0Mi1WWjRqSVVYQ2JsemZaczl3N2VsNThvRkJLUng5dUJLby1PWmYxTVloVEZrSlU1V3YtUEVreXRPSVpfU09nZVM2RTVMTUZsOVpZenZ0QkJuWWF0bDY4NGpEdWx0STh4LXpmSHdwUEFwNk9CQVpxalk3S3JoSVJuVGRoc2Y1VUpCcmtvU1JGUFlaaXE4RjJLWHA2Nm1PbDMyRm5RTVprMUlDVkxiYVpnUFlWNnl5UXpZdEdhbjhOc3BFTG10RWkwMVlTZE1ySUxkUF9TVTZwXzJ1NU1oY0RPMDF0Y2hwMHp6eUVfTVp4YWJodXpMWUVIeXJvYl83cjFKdWNjZUQ4SlM5T3JBdEk1YXdsbEhGSFRRWExOWGJuTHdTQ2JrdHNiTGFoa05ya0ZXR1RDNFRzUlBfYTlHMVhFTE5DRkhaMVhvS3NsQTdMMzFGaWpyNFpEYjRQeW5hT1BrSlhCcEx6MGNLN2FmeFVxNWlySHhZNEQyVkdNT3gwUmc5UEJJeE1vdzN6TmVGZ3Y5dzRTdkJ5VUpQdjNGV3huX004M3g5dldiWFh3bU9LbHlLNVpWQi11LWxKVno5Rm81YWRfVEtwUkxqSGdNWURKNU9Ka2dhaEFQMmhOaG9lb0FicnBPNzVYT2tYZ3pONDdwVW1kdzhmZV9FN3ZSeUREZi1LNVZNS2UzOXRPSi0xRmxtemJVc0pET0lScHp5WVl0Y2Q4cGtPU3JQYnIzMWdJNFRIUjJHV2xwZWJCZ3VhYmppck9UTjI1Zy02MmRPWWVKNHVwNjI3MjdnbWNQWF9EYmJfSFdrTnVLaXBmdkJ1UmVNN2J1WE9LVzg2bllHSW5ZNzJZZ2lvYVpIaEJnY3pHbktuUUlkWTJ2U3NzQ3E2b1FSUGJqeHRQZ1gxT1h2bXNucmNBencwN01ULTNueWF1RDBfNG90RGJueF92dm1fM203ajBwcjBGUWZ6NWs1UEVNUG1sOFVhenFxX2xEU3djV2JOU21JbWF3OWt3U2NXN2xrOUViNTRLRTRhaWt2bVRxXzRuN3lkSDNQblI3bC1RMXE2X2k5VWdHUVFfSmk5UDZQbmszQzd6TTVYbDBpYllEVXVUV2FUdlRrX2ZjaXo0VUJXWkV1T0lLU2xZaHVBVzFQUTJPU3NiUWxPbDU4U3ZvTEYtS2w3TmNkRXRBODJVWjdkLVFCN2xKNWFCcnd0Vmx6TDFxX2Y1UGd6a2NtcW1pLVViM2tUQ0xlNjJYbzN1MmFvSnNTQ0c4bXhwZkJ6dVFVVkk3WXdTa2ktWUtNUnlJSGhuOG9xRDNQS0xMbHk2LVZkZy1VREE1RWhhLXA0TnZYb2lLb3ptRHdBZFFpeG1IcnJTdUEwWmh0eE14N0FSc0pqc285blZKR1BOSzhCeTMtbXQycnNOOHlMdHpyRXdkUzBtLW1sRHRKak9CWHJ1NmhWOFBPeV9vSWVzYmJtWkcxSk96Tkl5YmhPOWdNakpsNTBSQXVmcW1sSXJpOEVXQk9vdzdVT1RKQjgtTkR6VzVXdWNiS0VLOGotdWtSYXhhQklPcTJBTnI1Tl9hTEF2RFpmalp1cDl1RGNTc2FUOTNWR0dmQlhHX1BYRlhGWnNtd2NnamxsQWN3bkhCS2V6QWd3SnprRXpFaEdEOFhQMVh0dXJPZHh2YTRyd2ZtVG1yM1pHVWFmY0tTUm5malpnVERSVThVRFd4ZjRwMjB1T1h5RzBBUzlJLUF6WGN0Nm5EOFVQUlB1WDQ3UG1fN05mdWFVTkt4SEZ2RFdOdWYwcVE1OFlvZmhydjJlRDlzUFJFWV9CWjhXWm9IYy0tbVZ5MmM0aDdvTTUzQlFKbTQzRzNkaXotclRwWE0xUDExakc4em5XU3RBQkJxbW40LXdKVVl1UGpDV0VtY29qdGtRZEZmcjQzRUNqTzE1SDJaZGN6MkphZmpUcmxPdWlQOG96ZjEwa2RTYjBURTFVOXI1dHRIU0ZzOUxPVlZHVjJnQUxjUGtMU3R0clgwMXZHMWZLS1ZTRVI2TzlZM0pZYW02X0FwU2xONnlRbmlqM3NJTzdKc2xYdHhaMzY2bXI2Vnl6WmphajVVODlJSjdJUlY3eXBkOWtuZy1RRlZMT0FhRGU1eENvZG1jRjY4ZGp4LTZBVWpQWnBHOFYxVG04OXh5c3BTaU40M0lmLURacTlaMXFjSXNDOUJ4XzlxTHE2S3kwNTIydnBKWkw4NEdCZElXM0FuUUdKbFY2dkRXbThpcF9LMjg2NG8zcEg4UTdFWnpqc05KZ3p6RFU2SkU2Y2psTVdhMDR5dkVMa2dnUm9feVM1MWUzam1BNUFFdWpXLUJ6TXlzTjVkeUpiZC1HcnN4VFltck1wMWI0dFNhMXV1ZHBSdWl2cUFLdV9qbTBvYTA4UHZqRjJyNjRXYXZQZHVxcUs2VGUtMDc1RkFQNHFEZE5ocmpJSHpneWEtUWowY2NCRWtZbUo3di1mUWxneUxzaF80bHJZQmVyWnNCMDM1Z2Z2b19CakQ0Q1VWVWFTRkRya2U2OE41N1prblU0UkZXN1NNQXViaE93WjlCd1pmT0tuajV3bDhfemRFTDVLVDBQUm5IejRjQk01OTZGNXhleDFORzNqME80Y3JDbzVod0xMMUVwMnVweVlULXpfTkdkT1MwMG50bGt0dnNKMGFZSURuQy1SSDRYcUdBUXlpY3hJVzNnTXh3LUNvYlIyUGdPa1dLTVBJN2xFelNLN0VKcjZkZENmblhHRF9scE9HSXgtUTROdjFOU3E4VGw1dkRtdmdOXzZCOEhHbmV5bXdpQUlJZ3NpWWhfUmR0NnBrdWJLVF92aFkwMTI1WWZkck9NaW9keTFLbEpNR3NJNGxqX1dJYVRHQjdoY1dtY0stMy1NNWlZVnJUSktaR2RZbUFobXI3bkZVT28zWFFCZkVVZFpKb2Itc1R6eDdNYWttd2JEcHdQdHB5OXFQem03akI0ZC1yYmlncDI3azRTYlVFOXNFWTZVeVVJVk80Y2l5R3ltZThpOEdLY2dSWXJ3YTZmVlItTnNvcm16dmd5eGZVcDFGWDZuR0xNbE5VMDNEblBVU0JLT1RWTzVnM2JuNG1DNWI3anBVQnUwQTk5R2ZkTEJGaXg4dURwR2NsQm51TFhncjcyRFdCRmFKeldkZXNZbTlaLWk0WDBaUTh4cVZwdGpXTnI5Sm5sVDlLeDVKZXdRSHZkeXRRdHRaTXc3TS01Unc5UHJreklWd1JPZE5PVkxwRWl5RmVqM3YyZmJGRFVoRmg2ME00NWRMQ0hqU0k5eC15dDZ6LUVtQlBpdGtkcWpUT3hLam1qVV9WNzIta09tVndhZkY3MzdTcVRKa0lpWlVic002bEJoQ3Rxd2cwNi1DelR4U1pMYVgzOF95dE51aUY1S0JfcXVwcU54SGJ4TTVZN0l5SnJUcGR4MG9qNFZzWDlxWkFjTGxCZnRNaTFUSTVLMkJRSERSNW5FY2UwT2J1SWpjdlNrcjNYMmZwUWQ1cHlLdnBXcXpNbnNuQ3NsVnYyWUY5ZDZHVWFKeHlfQ2MzRVJqOXZIMnRJb2hBckh6VzJlN1lNUTRyQnducnowOXc0aWNnNG11TDdVSnVsVnJLcjdJS3FDYjJyWFViTDBIRUVrTUd3T0pISEVnVWxlYzRGajRNQl9ZNnh4SFJuekVKMVVBRXVTeDJaZG9Bd1JsSjMwRHZYTWMxcFo0NWktYXE5eV9oOFJxaUZSUlQwSktjYzFpeFA1Y1JWRmVpbFhKWXN0cDV6X1pKZ1FrSTdCQlBaR0M2bkZ5RC11LWh4MzhQN0IzQjdUUzdoWVlXdm9ETFpGSkI0a1ZGRUhvNlRKdWNDVlpJaEFMdHlfN3dreFFxdU1mMFNOREQtV0FPWUJkY3JpZzZmYnNKSVhvc2lMSWNDM3hOOGw2X1dzNk1UMXdXODZkcWRUWkJnN1Z6YUlnREJ2RDRNakRLdjk2M0k2c3ZmeG5FWWNEQ3dDalo5M2JwUGRJd0htZEY1ZE0xTGZVLTExMktBN3dCQTJWYjU2cFdBMWk2QXo3Z1N6RXhQRkZvVkNBdFlJUnBFcHh5SVBaQUVHV05zeDNpNEk2Z2lyZi1hUmFWejFXUURCemd3ZDd3TlpqV2xrRVlyRFBBZTFPVnl0bU9HQWlGZmZiQWVPaVF0V1lzMHYzVGFTOGcydk9peXRvakE4ZzM2dDQwQTB6T3pKYnlzUUM0Z0hjODJuVDdQUDJBTFdPU0RLTmxSX2M0eHFWTkxjdlhxZHFBNmpVRlBUY1FONzk4U1FRbGprcmd1bzhEcGxTZTBnODl1VHUwV0ttcFltSFA0WEtmeXRGRWlBR1FDSmIwZUl6NVZsTlAyVnFiRGRMcW1JSzhuNVlNSUtDY2ItY0FUdGFoRXU4QkxQcVE2VC1aa2t4MF93M2RmZjhVX3ZCZUFwS090SERMWUVqcTBnVktxUHhaUWczY3RJS2oxdXJPeTIybnJ5aTlnZWZVc2QzZUYyMnBCQkx2YWVWSk96QUZndk5YdnRiTXFsUW1CXzQxNG1tVGVtaGFlNktjOW9KRF9sLUxKWDZPU1FISlo4MHQ4Ql9VZkdacFZES1NubmFmMmY4UHYyMy1EUmlGNlNyQ0ZKN0d4TEhUNXJSNzU2MW1YUlV5Qy1leWtocVI1ZFZSZDZhOVQwSGY0TlZSbjJiaVdxeWhPR2VUa0hKazE0YllOUFdYTm5XSHl1VTdyNEZoOVVsb2lES2xIQjQ0VjlmYS1YMzE0c2VHZHRqUFNLdWhFRHBMeV90VU95aWU3aThJaGNIaE1XOHlFNi1Oa0lZSnF4cU5EbjAwdUkzSEhEUWtGYzFQV0RYdlVIcnBJUFRJcFFBQ3c1dkNWT2JpUmFoQVBJM2tFRFh4ZkY1S2VLMXRuS1hsZWRxQmRIc3lCUkZuNnp6T1p1UHdOWktKNHlYVDhoS2wyamQtNTlqdWpibDBmNF9WdVJFdmVQOW9FWWtTOHU3UmlBVEVHa1lPVkg3MkZXTzBzLVNJWGVRRkQzX3VvWjdrM0xjSm9GVjlXMDZrQUVWY1dURVZGRUlwamtNMy1FYnJSUVdMcy1heWVYQkNFSUxsQ2t0di1LblA2N0pyZFV0bTI2cnFlVXZ5MzdTMTBCTE53YjRiNHBvREhMS2FveGFuZy1iRjZUb29PR01UU01MWXUzaUlLc0R3Wm9kZG1WR0xyQ3FxNWJJR1BFZTNoMnc1RjFNZ1hyVEU2TmFubXpKckh5eHVPc0VyaGctaEpGeGVCcWE4WjZZWFduTXIxNDhLanNoYVAyeVpFSWV6OG81UEc3cWRWaHFRenhYT1c3eEQwSTUycjBvbkhxM1hzcV9SOGhFby1UYVdPbmY1NW1YYTNWMk81LV9XanZxZThWdzdwTUF5dG95dmh2NTVTVk9xcVdkNXNIdGhITzd0OWlMdDNFYVMxX0ZnaU8zVmVENmlvUVBNNjZsWmhaYkpZZHo4b1RFeU9SR09KbkpjSVpqVm1YSlJIbXF2eXZsUlpjdkVMM19KR1hEOEZGNHlBVE0zaGhlNDN6VEJVdk9oYlRjckhNQTRLZjhWczR4cU02QWFsczVBZzRUbVZSSnVLLUVRWFZCaFE0TEpBbEgxVXZzN3lKYTdLM2hsQlZEMWo5WXRWS2htMVhPNFJySTNrZmVxYmxoMTRHQ1NEdnI2OExyTk53SUZsY1JEY1pKalBOQi1GWGhUd25PbW50ZVItOFY0UTJVa19tczdTTm9ZUElWRnJqY1R6X1ZkQ3dYRTFmMjNocHpqQ2tnWGlsSUlNNEpNMkZmcDNTZTY2c1JHc1RXXzBBbF81R3Fqd3ZfZFBYWDA0RHJNMFI5dGljTHhLczBnM3hkSXF1M0huamxBRFU3S0c1Yl9NUmxUdWJCQ3pEamtJQWRRUEFwcUhaWktnODYyLWloMDE4bERfbFViWEwyMGhFNFBNbTE0eEg3R0dPQ3FWa1o3RVU4ekd5Yl9xWHV4RF9LZHFLSVR5eUc2WC00MHhOeTJ1cWpDMmlvVVpiM25Tam5kZWFiX19kbC1jMDBLWkU4RnhTRnRMN0RreWxpTWM2Yy1VQXBhUlZKQy1aa2NBaXlPZ2NBOVZQa0x5a2xlcGRNYXY1Y1J2a3FvTHhmS3RMU2FhS0taWEdveFd5OWp2am5KZHZfMmZDTXlUeFdOUWl6MzI5NG9mNkNNY09sTmc5VW5iaUlHb1JVX20tMHQzamNRWHBrZ0pDWlMwcmQyZ3RGVExYdUVlYU9ZTnJjZ2dPWkVQMkstc19kNUlCU2JqNXE1QS1HYU9hbzFuRmdFOEFlMDdEVXVzeTBYeVEzd0cxb3JIOXUtSUxpSHpyd01Ickx5ZWkwYmpYSm9HcVBuSWd5d29nWjdZRmF6a1ZSTGE4OTBZQjlXR2p2SEdqZ19yYmVabWRDWkFoalNiTlRveFN3bGkxMnh0bl93WkNWVkhlNzUtSGNkTHZHaGgyekwwVjlROG84NFI1NUFKVV9fNjI2REMxT2w0cXVLcEt1Z1EwMHowZElPbzMwcG5IT3hqa2xlcGRMM0dyN3dHNXZsSUJKbXVWMlBReC1Hc0JmX3lYbUhxOXBZZ2RJeXl3ZjNqSjlDcmROYXM1RGNseUExUS1Sa3MzdWtyU3dublN1ZE5OeTNCRlJ5ZkgtbHhWQmpYSHQxUUlQM2JLbjRvNmRPSHNLclc5XzRPVnBNREQ0UjNMRmpYNFM3MDJ5ZmdXSkk5Wld6TDFadk40X2t0Zy1iVHNYOC1zdzJfa2Y3dXVldmJmMkYzLThmM3lvNDNUZ2dQaDU2TEZjbFNidGdaNE05MDRTLWF5SGQ2NkhVbmU5T1Axc1NldGdKWXdZZVN6TTgzY2FUUXVqRVA4bFhEQWxKZGJ0MTRhZ2FValJkNlBNLVVIUGdGUmNtRTd5Y0k4YzNSdWxrVkU2Wk5qeUU4VkNnaFRoN2JMNTJNYXhUcVMzQWJKNUpHak9ESkk4ZTczV1BFZHZPZ1FPNnZvak0xNDFnSjFtaW9rTFNIbXNwVWRhSFdIdkNkc2VHeTZyZmJfYktmeGJGS3FNTEN6T3VKbjhxd3hlNUxJQms2djJCUmNzM1I4ZnI1VjBSQXB5U3J3bmRuWExFRHdVRU90YzdwSTBqajVNeGFJaWxKU1FMb00ydXpiWXZaVE1INklXSndEdU1hNW04MlFCRnV3TWFZRDd6WmNwM0RGb2dFc0N5YnFjZFd5SFBhV3NxQk5GSDRuYXdwRnMwQ2xZMWMwbGZQR1RnTWZJeTRxRnV5U012cHNkYWZORUdBdVFpYU5zRzROSnNJV2NYbFNFQ1FsLVhRaHF2YkpUWE03NldPVTVld0RneGRGeG5WREVhdFRlQWZZaUVEN1ZBelFNUXNFenU4VUx4VmI3RWJzX3RsUW5hU2hVX3E3RjNUVEV3VUpPdDNCeFdPcWFCbmhNdUdOdU5CNXJabFd3YVhrUTFNdGxwOEFmWTBXSF9kX2F3VXdQbUpCQXFEX0xKRncybWVBS25OZl85NlZiUW5iU2J1ME5uejlvTnVXVmNMcWZIeDIzX1JfVVE5enZibTlkaGlSaUxSMnVDUzN2d21XS1UzVG9vbks2c1NpeWNmYnh2QjE1TnFnN2l4UUV6M2U2emVkX3pQYy1GdF91ckRrR1dOTFJ1d2Zyb001REQ5XzQ0UFVvLU1SQ2NiVGp1emxqQmVjOXRUc1NRdnZWVnp3WHdNY004Zl8yWEJxcU5OVl91b3V6dVRPWkFfbkNVTDV0T1dFSXZIZmlDRWxJV3lrS0U1TUFUUVlUY3FRd0VwNUlBeDFDOXdudnZtVk5NcmFFNHpDSDJuZllsUGNIYWpMUGlXcHpUdUR4anJGeFhIbVBUc1JTM0Q1YU1yTmM5emwyZkR6ckJsbzV0Y1pPT0ladlR4X0ExeFA3RlFnNjMtbUZzTGlRZG16NzM1bWVjUEFmdkROMnV4dWp3YXFITGx5NGlLelljVVRjbHFhYV92X25VM09ESUxkcWt1S1pCZFZzZGwwX19YeDdkSlFHNG5nN3kxU0d1V2Z1NEdRRnV3azE5b1hJM0ptU0c2WVZHSW5wSUlNYjcwSy1BREliMlZBWjlVaUloMW1HNmpUZWRHWHJtMzF5b3Jnak1PUlRERU1rYnZCeTFaazVrR0E0V05aSmRKRnlSQUtXT3VNbVZOVXRWcTFWRHpkTkpNdGhaWUZHQUU5MEtBZVlaZDdmaFRSZlY3ZlFYdzhWOENmM3IxdmdMTXJyZ2JSOGwzeUsybFBLMnhMcFl0cVpRanFaREpvSjlwUHBlcHEwRF9Dc1JEcVlDVi0zNE5GbldXWklZQmtmZTRPSGFFZTRlXzNQOGxNVTFKUWlJY1dXWmJ1ZUJXSnlpNDQ1b24wRm0zVzdlYTRnUUJCN2c1MzU4MUJBZW9ZQVRUYnFFV0J0LWU4OS1YMDd1Nk1vSDVKUU80OV9kSW0wNU11VVlrV3ZQODFHNDMySDFPYmgxRUJBNG1WdHYtM2ZqeGVDRldiZHVzTWxxa3RYbXVodjBEVWdmWGh4OEoxS2JaMUdjN3cyT1E4S29KZXNGM2QyTzIycjFkdHRIamdmbHBUZlVXOGFaN2hPZ2otSy0wRHg5dXV3ZmNVVWMwUnd6bkNMbVdqd0lnZ2NfQWZJbVRpd1ljZWgzQzlpVnpLdkcyV3BfZHpCMjgzM3YycGI3SlRKbmFYT3VSSlhiM1JQS0pONGcyVXV1NnNYc1JBd2FlTnVtVVVpM1B5b0pCY3dhZFRsbVVrQ2JNcjJMQzBzYmZkbjNMOHk0bTd1UGg3VTJ1RE5EaGk1LTZaWUNYZE5SRVNzajVrR0QxNzJoUHRSVEV6RzhUeEN6Nlp4dE5MQ004a3pHVWtjS2FLeVctZFdaaFVWRENsZVdnQ3F0NWdvNUI1OEVaV2RJbi1SRTRxREZ5RlBDNDg3bk9nMUVyVmZBN0NHWldha1F2QXN5ZUhKb3dkc0RrdzZIV0x0Y2ZwQTJENHEyZ1Z2aDdraHVNMmwxSE5DdWxNOWJSXzZZYlhuTGlCMzIzN3Zjc1d2bHpBVmJCd0J3WHRQT3RGWEEwc0V3c3Qtb2N5V3Z4WFNsT19kdlhRNUdHa2pLcjhFX1hzM0dvZmlqaHpsZF91OWFROGNTek1XbE5xRGNPWncxdncxNUtaeFNXR1QzcDJ4S1VHLWtSZW1Jc1h6VW91TFdma2RCbk41Vk1tUTdJTXA1RkFfcmdHWnFwVHByaHJMSlVaeTNZN3I4bG1McW15Z055a2FMNWkyVEpIT3RWVHB2eHVzck1LMnUtSzdpbUJVMHlkQndFaHNOS1RWMXlGZng4Q2JZazJTeUo2QVlWeWZLM1FhVEdqb2FFMGxocGNPRUIycmpfUDhFWHAydlJ3TWZsYjBtc2daYTFCOE93d1BXRUJMdlROVjVzUEYycFpUaFlnM2xWVzFjSlZlTlBLRTJfYU1zS0p3UGVIY19YTTNrdDBXVkpMbTBnZzE2ek5EMjlsaUlfNTBjOW1VN2NpVG1hNEd5ZzJtSkUzVkg3VWxUanVkRldmNTZpSEZHNlJpU0FqVUFtMmtBTkNGMjFyb3ljVUhFTGo1aVlQZF90S09vcmJvRDlWRGcweDRDc3BQMmRKZWVzMVR6aVMwNU5qU096cnd4dG5qMTBBZ3kyd3B5XzUtbVl6dVJvYTUtNXVPSFhDRkFNSW5QQ2doakFudHVYUGw5REJRb1ZSMWYwUS1NdnJWQU1Qc3pfaXMxc2xZaTlFT3NDUWp1R2hsNGlxYmVNWWRhbFVZZllGYnd5dktaTGNlZndjaVdpY3EycWhpM2FxaWQ5WkVwVGRyR0FvRjItdmd5cWVsSjlRb2NfSG8xRldZdjFrVUR3RTBmQ2ZlV1FteHBFMTQyYmlZNVNnV01CaE9tVTBKWkt1c0hCV3B1ZWJ1TDVlc2RHVEJwRWtpcEpHWmtQSlB0YzBvTlJSVU90TVdZTTYxbXZaXzRTTFpqOW9kZ2U1akMwMHBzSHVYTUExTG5USDZ0R3FnSDlTd1Izd08zOTNTQnRMRU5oNy10UEVEVWc0dHpJeXAxTHQ4R2dWS09DTl8tc2RCbnlpSjJaNmYwSThEMXVPQnJYN0JGb3E2aHlkOWtMWnZiX2E1VHFUdzNKZDJCdHRzOHBWS3hhaXFtTW1WUmZPbU4xYmRJSHhlVUNCQzdXdE1LZUc0M2FNLXpYZDBfUmI4MkxJTVVVRDJadUxXb0MwUGZzUmpiYWNpOVhBOFlBVTE1WllTOVh1YV82NUZYT2xxcl9sT1RuUjd5Y0JZY2J5T2tIeGpIWVFmRGkyQmZRV0NkMElXaF9WcUxNZWozT3ZEUW5FZDZvNEU1N21FQ1lQUEJUSkFIZTNHTjU2UEl6T2xLNTRtVV9USUNpX0JKTkRXemJvdl8wSnVEWExZMmUxZnhCOXNURmc4c1hINUozYUhYY2dpYUdSaHlnMjRKZElJV3dkcXFRbmlLZWNfS1IxVTJhbEVqX2xPQTNNb3FadHk5Zzhnc2RCMjRmQlRLOWJZUnc5eW9OVWhrSl9fM2NxNlozVVFvc3VrWklreDJwVlRoTkU3THdEQ2gxbnVRYlpvUlZrN1NKc1pjWkZ1TTd1SUJRWUNVMGRIQzFRS2lublQxc3R5WDduM3RRLXZPWGRsSENaOEtmSERpR2tsemdKUkhVSFUwdU9JQUNuNGtUbkRzN1ZrRGtEZ2YxalBhYXVYLUR4X19Cdm5oWXIxRFp5eS01N2x3SG85c21rZDFNcGFUVGRLR0cxOVktUDh3MmcyNXJCcVlWQjhBZXRlbXQ1bEtZdE8yckhJNmZSSDZrLVhSM2I3WkVlSFA5MV9UTkc4QVZtV1djMUhaMmdYN0gySzgyUzRoUk1JcEItdkxUaFI2QmV4bTdDeXJHSFZqNHN3M0dtZWd0cG1obmJlNEZQRVo1UTZnNGhScUpmYTJvOUswZDI1aktwaURBTFllRVY3Y1VDUjhBVjRYNU5WR3hWdWppOVdYN0gwaU1mUjZHMmpIVkFZSmloSkxOSC1JSENWcVhxdng0ZWNSRmVxNGRqUjNBWjRITm5kNUJBaGlTSHRObkhlM3EzeG93cFduQVh4M0hHeFZKcUozZ0pVdDVtdGcyb29pYnJiTTVFVU1HT290QlZGT0k5eGd4RmZYT3dhYXNPNWxIbTVoQnFWZVczOHlXS1FqYU50VG16TjlITjFrRWFfS0JacHU0d3RGeGswNkdWTmFEUS1QbmZBV0FJalByQ1FjSjJMQ25kS2FBSHJyYTQ3WTI0dWJYd1hPNUZsSVh6NElaZzI3Z3NzTXpVR3kwdUtGc29LdnJrZkFLdjVWblR1WlJ6aklrZzNoZExLR2FMb3RPVmFwZkp5VnNidGh6T0JrSERUMDllcVlOYkFwbWdYWGdoVTZSb05nV3IwOURSMmZQV1FyaUVzbm9Gc21yZWc1MUUtc2JUWjJCb3FqVW1zRnlndjJZdVhpdTVXdFFUNGtKQ1NxczZZVEw0cGhoQy1sTEhubWs3Q0ZKVnNMUHpUM2ZUcVF5M2V6Sno5dUxyUWJKRXVVMGgyWHQtNGwzaENtNU1hQlVVUGU1SU0tWHZhVk5QM3FQUGN6NjEzZkt1WmwzV3NmZVVtYzl4OWhrbElxRlI4RE1aOFdpYnhJSG5CXy1vTnpvcGV3SXZkOU1RV18wQ0hJRlNWWV9lMDNfNlN4SDBiLU5DX1Y3MXZHNXpNTXpqUkc2WXB1d3hMVUQzQnV6cHNWSVR5ZTd4M1RSWFBxNE42aXF4cFlTeWpyMUUwVnk2UXhzWGc1Q0NsZEozN0p0R082b3pTY1gtdDNKOFJBbVk5Zk41WTRURUZCZkxFT3VtdkQ0WXdjd0xuVktKMnVYN3A5MWZjTTUzVVRhTVc4UTZSZ2JFaTlnZjg5SXl1OFc0WTBIQ0REbDE2dVhCSXdZR3IxX1lyRy1zOUU1dU9FbjVpVm9oY1JsX0RrZlNNenBsSUhPWkJzLVM2X0tud2lZMXZYeThhTWlqb2tFaTVOZnBMbUdZdklwdk1MUFViUzBrQXhGTWo3dktnRXR0S09pU2wxVTJleFF5d0tsYnJtUGxFamZ3YnFjRVZkbmZvTFhIYXpfNlhYTE1Qb1FobWhKUWtvVFN6UDFIb2J4UWY4Uk53VmpaeGF0enpxMGtpMjVmUXlTNTlET0wtVGtiWlFqOTByUnpCQ0hVaTZlNWFmNUN2b3p1T2NIdEJmRnJHVkw4R0JQMk1JWi1UTGsxZXcteFpBbE10UVRITEVuUE1US1Q3X0VwY2dJalNDQTVsZHFXQndZVWxJaXZWd3NzNXRlWEswQkNvWjY3OWxyTVdTOEIwUmRwbjM1djlPU1JOejh3TUFTNER4UVV3OXhOTzBrSjdCWHdUM1dOem90dVFFVDFIeWpEcDV0UHY2MVZuVlVDc3pRME1TaTcwakU2OGtnVm9TM0sxaHFxNUhyZlJoYTVEM2MzZDFBWnJzaUVsMXpMNU5OamktNnBpZENKVmxZeFNBa0gyc2VlZ3lGeUVVV2p3ejZRZzBzeWYtUGtCWVFaRGtKOGJsUWFyUjRMdVJGVmViUTZ0bnQtVThmS0M1d3kydzFXMUhiWUZOWHRzUnVkcm03WWVtUDI2eVVNRzNPUEktLS1zV3VEUW1VblIzemNaVGZkcVBkc3ZyRmtES1JESWZfN3hsbDBLVGtIbHEyRjJOTTBiYjlDb281SG5RdERpX1pJZmIxa3pZd1BHTDZMV1hsazdhcENaQ3daWVBLNWNmbHkyWU84QzRuX2w4eDJkLXdkclBMWGNMRi1xZnRtX2RzZmNrNjBrNUtGenozZEJKV0otY2l1ZWM0S010Sm1JMklxUm50MVpJRnNTOGhEcTF3b0ItLXVTX3ZfZ3lMMVRxRklNWE80b1dUZktOV0l6d1NOUVM3UGdCYXdIMHVIemZDeFJ1bmh5enRMTEdMZEtBamZxc3d6R2dDMnV0THcyOVJoZWtLWVNyaElGWFVoNFFjZF9GOUxfNXZyc3pSaXpKekRUMGVkWlhSVkZNdTFsV29zQUs2YV8wUGVZbFI5cC1XMS03eWo3dGJveGZGdzMyd3o2VlNWamJrMHlIUnpRYmtwNkp6QlIwcm1QU3VlU1QtcHNCSWVwSGI3S0dHQjA0ZmJvLXk2N3VSRkxKTHZlcTJua1o3dDFIRGozQ2taVGduUmJ0S0xYRVNkb3RFY0toQ1ZXaXNrTDZabURLVWJJTkF1MXpLMlJhZkJhNzVDNlVPX2llVnAweTBJX1JnT3hEd1Z4QzVReS0zdVZkc2trcFo5VGduUGhXQWlURF9tQlBmeWhQN2NCbFZvUUhoY1lKYWVjQ21jQmtVcTd3cmx1emdEWEduUkFveUp6MXlwZWNjWC1IUnlqOEFFYXhxSkVUeGpWTFpNODBNS0xtRjNXZWt1dVMxSDIxLTFYUFcyaDBfSkE1OTg1cm9uWnBCSUtoaXptUU44YVNndjBIbFlmVi03cTl1Vi0wLXFrNXVQWnljQkRDYnpUZnlGaEdzWGdKU0tPSm5PYkU0QWktMW14NHpJY3FSRmNiWkt1cF80clc5Z2lFX1pfYjBpTWlMTGlBUHJ5dGo5T241ckx1MnJhY2UxUHFvb2VrZzFuWWxCRllTdzA0eHBWSjNGNURCOTBDMHh0SzAyMEtEakpRU1VCZW52dUpsZ3V4WVMwWnQ1N3dKcnVXdmFpYUlIalFBTmRjMU1lSVJEZjF1Z2EwZ1NwVjZPbEltMlY2aTVDMllfcmY1eHJITmVlWjdwU3A1X3c1UTk5YlU4RkdEMHZNbXE5azc1eTdsR3NTMVlwc2stY2RZd0pSek5oa3RPeW5GOFZBNlcxSjkzVmZsa2Q0NTFnMGRJM3dGd05kY0FqWG8xdUMzWF9zdU1JOUl2ZU9jcWFqWlVNcEFCMTZzbU9waHVpQXlBcjNTbTltMTJMMVBvbzVVVDE4V1lEbFl6eXhNYkRmWmRUX0I2R2lNUnpFYVlHSENyQjJoaUhsYXlDdlpCNW9lbkVTUG1rS1c0dFNmOXhRc0R4U2U1ZnR0UGh4enJ4UWxieEM1V2dINlBibzdYdFcxdUpMUEVzVnlwdGRjS2lPSHczQ0d4dXA1NnVNdjhlRW50SGRHdVFERmVfalk5TUJYZXNsdnMtQTdBVzg0VUFvWE0xd0RYUFo0SVZjdmozSWRpbTh1WUVDU0dXMHlPcUo2MEVBYk9nM2ZERW1wbEpNVTBuc2kzREZmbWlqNkVRZ25hdk4yVUN0Z1lKVUUtUVoxU3lHTEY3OVlIRXhFVFRUZ0RheHNIYnZCX2NibWFwNC0zaGhPS041OXlQUmN1ZldZTGtrMUhpODg2c3V6VWJZa2MxTkZRWlBGekdYV28yUUFvUXlCQm5DS01YT2QyZzBPS2RaSFBYRUtVR05FM3A2blo1WVFCMUx4dXJhTVJCSUNqV2lHN1E2cC1XdXRpNHFvNnRvUjgyQlFFZUtqSC1KV2t4a0NoZ2tFaXpUSjFGcjlHRFZ0c3duOUdFcTBKZjJ0aFhKWXZUTkdTY2tTVFEwUzFIa0NlcVNLOXAyN0p3NHl4RTlocmFVdHYzaXl4MEhFZmNnTlNLVTk0WmpFa0R5UFozUXNLUUlCa0xweHJReGRsZ1hSV2ptMEpJSWQ3WmRiT3I0YUZPN2ozZlM2a3EwQk5SVzFBVnhRWXpkLThFWkV3b2w0MFNyNmFfaG5tUUo4WWZvYlFoTDBhZFBfWUNaT3dBc0g3alc4U0lKbGV1b0hLX2hPc2Fha1hkTnJPaFNoQ2VVYjNpNUQxRmxkak12SWFEajJFN1dfUDJodmVna25PNkFhOFJlZ1JRN1dvQkVpdGU4OEszeVdPOWJkdmZ1NjFJaTBIRU1RUm5LQVBILU83RVpMVWdzTmd1ak5YRW1jRmdmRmhmU1Zudko4Vjd1UnNmbE9NcEZkTmZzNU1KUDdEcEF6R3Q0aGRQaG14ZlBseDdqTXh4cnpOQ19GS0tvRDBwcWdJdWtTVnlMZzdrbXkwOE9paTk1QUNMREZsTnlQZjNtaUVUMHRfaHBmWFZrckhCZDB1Qk5Banltb2J6WmF5bW05SFhLTTFVSUFJN21WQWdUZnVUYmQ3eEY5TjlDNUJTZXVyVDJtYnNaY0JtWFNfa3hZTWtSWjFkSkdjN3FwVFBSZUxOVm10UURBVzZWdTZUWlpHNDREMHdRNllKalItNlFiVnNSR2NReGtxR09KQ2MyYm44SEdvMnZCSG50TTdEZVM0RXdLUXh0bVduVXdITTNVT0ZHaWVOVmRvZDhzcllzaE9sM2tvZlN1YUxIUkZiRGdVQlZoaHBFV3dUejF1VlhOd2VVN003N0R1dGJZYTFiRXRJY0hneXJjQUJTVW41dlh4cEhhbVY1RTJHczhEeDhYTmlBaWdYREJfbmhFZEdWWkVqSmd1TDg5VXltR0c0X3Z0cVMtN3hGYmtJaFpPMXBEVHZTMm1KM04zNUduNGI2S1FWcUEyWEY5amJwRFF0VFY0bEgwZWhiLUFyeGtGMkJjbnA0RUdNZWs0eDRXN1RfNEdtNzlFb3V0TjJzSW9iSFhXYi14bURJbUVId3ZHZkFsYkc5ZFFLZ1pDT3Rrb3EzUHJvY0hEMVFUTElpNEpQYU0zc1VFNngwcy00NXR5cEFHQ3N2MDhralVkUW5GbUVTYUhTYzJjSE5CUEFFX2ZzMGU2bm1fakRLektON095RkV5Ymd1bHZ5RTRsb2ZxWkxfcnNxWFlPN3lvT2oxX2FLVHhGa2ptallGNWhiS2FjcDhCNWstRUZUWVZYMzMzWG9OelJreDRnOFNWZW0xVUNibE1QOTJxb3BLUklPaWNJQWpmN2dkS2hhQmZTaE04UUt6bDJBVjBVU3lwMkdrUFRja0NrWEtXUXhhbl9RLWhtZ2l0V2w5ZVpOR3BpUjVSUGxqR3VRaVRYNlJENGZKcUdEQWNMSnEwYjZYZGhva24zMHd0Tmktc2J0RUN6NC1HV1ZOZVVBYThETl9haFNaMXAwT1MwMkRkbGVKOG1ZcW5vYThEbF90ZGZEV0xiNDg4WVplU3JwUmV2WlBJWm5OQ1lQUngxTDdxMVVGcWhfajVrQ1N3Q0VWTEpDUFdzaXlKSzluXzU5c3lUaW9DemxyM2tuTVZ2bDBZSnFYdXF2eW95TUZrcDdGdVdBbWtfYUR4eURaYm1mRGNLNVFnM0c2YlVwVXhPQVJyamgteWtreVpfcmxsa1hLUjVrTnJJMFFKYkw5UHBiWFNtMzZVSTFNajB4alVael9IYmx1Z3J3c2lzRUtGcGw0T0k2bUY1cUNLZVAwWmFmaW1nblhxS0d0RW9wNU9kTHNGRXNoa3BSSWh4Wk02eTVta0RZM0FrX0c5N0FuLUxzaVVWdG5IN2NYNUJPbHZIMVktREFGdzhkQTBpOFhPbkJoWnZ4aFZqdXctbWtHWjBITURVS0RMWk5uUVR1RXNnVEpDT1RQOVc5R0xtaGNfMGRSS1UwQTQ0RFVRU0l4SmxEYzNYWmdYOV9XdWxMY08tdjJib3pvLUhLcTB3blN0dmlPSU9YQ21BRW9PWDFodWROaUJmdktBc2NYTnE1bGc1YmtaN3dDR0xSQWoxUjRSelhDMnVsaUkyZ3lpMTFHZU1VanpoU0h5Ylk4NG5vWGpDODNJcGFTX1FTYl9WUFEyeWhMWExVdnp4SHJ4YldpajQ1a1VEMWJEZUkxOHhhQmd4UzJ6VlRVMF9FcW1WaU9wbjRnTWczd2oxMW5tV0JYOHVHUHlkUENhV2dtbFJTVXNxVXVGQ0dYZ3RNUFN2R09XRkl0LV82YzFWdVlzMGJDNzl3QnhwYy1MdENkRXIweVM4NWZKQTE3aktoclFINUJLQXNneUhKbzFVU21FZGMtTDRweWpkMS1obnZUYzZxRHBXQmhSREhieV9DeXBfc28ycERfYk12eFZ1YnBDX3FIT0dlaVRLSkpTcHdmMC1OdFRLSnAyUzloUXNQYnhIeUFlQy11ZThIMXA0WlcwWVVyWGpJRDVoS2pKRzQ4b1E2THBsaEJTWlNCa0xpczRqNm5nV2ozN0dLZEFNN01jNlpKVFZRdEw4RXZjWWNTSUlEN0liMHAzXzBIQzRKX21NTEtjRlZWWVp4TjlvSkVPZWJLUFVzbndwelVUX05KbjQ4VVZrMGwzeGtDaFlEVDVmMENoNl9MSmhSSzY3ckI0dXk2WTY3N2ZKN3RjRGFfWWsxZlotcmVpSlBRNHhMTnNOZ05hU0FoQ2tqZE5Nb241bmlPUFNhQUtVcWdDbkhsZzN5bDhPOXFhcVk1aXk0TzFlS1hHcmY1THkxV0lNX1luNmcyeFg4aF9TZ3hlcTdRN2ZOYlhIT0Ztd1Ywdk04aXhhRmJZYnF0N2hHT1pjWnVQaFVOaVdDSF8xb0MyUHlIUE1IcEtWcWdaOUNYYkdQNmFhY3J0UmpRMkxZdUZNSnNWRVhlN1gxNm1xMDZpd0dLUWxsUlZxXzZoZGtqUUs2SVpDVTNzMXV3cFlGeHdaTW1CQVVCaG1lb2kzUVItQlhrYnc0RU9nYXllQTJkSUV6a2g3cXFOYmNXNlNBdnp2eXd4cUlQT1FTSWYtMVlSRnZfSDBpYXN2MmQ0R0kxNHpDWXUtXzMwT0hqYzYyX0VMLWg4V29pa2Z3cTNXZWZNMTduN2hGSmZzMFNWNTVHY2U3UTdDQkxxNEVkSTlXc0t1MDlxeWhNWHJwUlZPWTBrZzdsNjYxa281c0VsN1RxYzgxNWl6OU1wS3RZU1RlV1lsd3pnb011clJDNktNYmZEV2poUmlldGo0Z0RkSW9GaUQ0dHJGNjZvU2k0WTE2WkNxYkVPMWVKNGNseWZZWk8zbzBwSk1NQ0gybUlwTVZPMkRueGJSSURIOUxiSEU2VE1qQjYtZkw1a3d3WUVoSHI3UnNaMnFFYUdWMDdXcFkwMUdoTWpEZXE5dGI3Qm0xXzFvcWtsdVcwMjZRUng5Vzcxa0RwU0xPNkxia1RWS2xuMlB4VmdZa3F5V0pHNlZUbU81T21fRWxlblhQMmx0bV9VVXN4MXgwdkxWczR1ejlHV1VYTGZKbVlzZnViQXBwVF85anZyRDlkV2xWc3NKdUMwRlVVNWxOUVUyOEJWSXpycV9ublJVRUJjc3BLR2d1RmN0Mjk0V2xFVjZzNFdTSU5vNG8zaVM1RWtfX1FsZEp3c3JKT3ZQS2M0S05OM1F2cFJDa3hPQ2VwZGpZZEMtbVdfMGxNdWVoVzVmcGUzRnhFMGhjeHFrZmkyUXA1Mk5VYkVZVWpPV2JRZ3UySVVmX3ZBMWpIRW9UTzRQNS1vYTBrRHZaUmxPQldRbTMyS0g0RkhwYWpiNndLTWVIOU1VZ2ZlS0dBNWVJRDRxaWwxWURONkRMa1BKT3FkeU91UGdqMTQ2WWJkZEtQdmFDOF9YS2w5Nm5BV1lfMVo3ZTNKYW9NNzhZR2pMaEV3alFpdHlSOElLRTV1ZmFDZHdYMWNPMG5FQlRnYTZPNzFrSEJkMEpGLTQ5X2FPX2RoWWo0WmVLWVNxOVhkQ1NHNGQzSFNxVGVsT2ozX0tzUGp5dk5ScmkzY0loVmJVWHkwcVoyN1NqdlRRcHFEaW5yMDBra1Q2OC13SXMxcXJhazQtcjZoQUFUeTM4S2FrUFJWYy1WMUQxUVppR3hFYUdrbUg5bF9YT2hFOEtHREIzZFgxNVNOREptRi1PR1dKSlJZNWhqZmpFWVNEVUhmb1NHTElNei01Wk5hVUs5cm42cFBMcWZfcTc1dkZ1TWRISzZhcTl3eWUtQTdLTjZyS0xqMlNfclV3RHk4dnBlbFBBTktNTG5Td09mV2U2eXdFRmFJTDRVLS01Z0NvczJBbGd0OWE4QmRKOVpsUDBUSzZEb0RVY0JTbE9VTWNJNGZXb0lDYkhwc3FnS1d3MUJXc0xGTFU1UnNSZVF0ZHhmSFNZdWs4azFWUlNhQnZnSEh5Uk9NemJXYzhSWmJCVjlQc1doaEpMeVpMM3RldzJ0RkhaM2h2U1A2SUVidWpxSE0tYnRWSXFqb3BEOHFDMG90YkNERnNqdXV0bFdVekgxTXhNVFFGdk1KY1Rfa0swM3NOSVBNTnc1MVlrQm1fV0hiQTNZY1V6d3BPd1JNNnQ4YWFVV2diRUkyNm93Szlhd3BUTzJmVHVncjdzNTJoWTFBNVRpMXRobDM4TU84UGNfeTFyYWJBeEVsMGloTUw3VlRFWmxhUml2VW5JS09ORDdXSXE0U2RHbjZzbXJLWW1LUGRFNy1vZzJfMXVhWkJyblRScHNrd1FiZUVlM09tT0lRUjltb3ZmNkRCdlZlVGtieG4zTHgyM2hwUVRRYlpFSTRORFFHMnlzTXcwSnQ4OHl2dEo3NkpwSEFYbWhkZUpBNWI0QTBYb2JvSW80a1JGTjNlUWlCQlB1eTVsZU1qeEZnVVE0N3Y2M0pyNmtibXpfSEVTZHowOGhNeUozakN4Q3ViNWdJVGhtbVdkQ1lIUjZRYjRtWlowMjhIT0ZCNTl6MkY4QVVENXNwU2wyZmhKZHBtUl9aZ1BsaVBuUm9YNGVPU25Dc2ZLTW95X1YwNk1KRTl3VGZPSXU1ME40cEhoTE9qQXNUX3NCSHBfYWJMb0x1ekpJZXdtV29SRThVR2xWVENOX2hJQk1pdWI1V01lbDgwa09nbHJTNXRMZnNCdW1qTTZXUEladUpjRG1jWlozdXpEeFBkRWdHbFZydXE0ZmpfMFBoUF9uNS1FcEVtYTkzZDFaLURCTXU3Wk54QWYwS1ZBOXVJOXZ1WFNQRDJOVmRpMG5QRFFjbFRCRWhKYW8wM01uc1VGbkxBNVZqQlJnQVV2Y05Cd3ZlYzRfOE9WMDJLRVRxZ0hMZ2tzbkIxdU1jZ0cxYnVQWHF5cmJJelN3WGJiTFViOTFWSkZERl9ZNGFTWGhWR0kyUzFpdGdZOVlsYzl3aFlJYU9pQy1KcTNiRUZiVnZiZnJnemMwOUtiYl9ya214ZjFpWDVRczh0blYybHpSaVB1eExibGx6dmlEYkM4ZkpMRE44VHo4NExMa0lMZHNmdjBHaWtkRThSelU5cFNnMVU5ZURUT0RnVktDRmtzaXdJbEJ5MDRqd0d5NnNwb1BudUxweG53OWhKQnpUc0M5dVRUTmlZeUk0SmxpdWs4Z3ZpR0JTT2lMeGNiRVlXTGFpN2NNQUYtcnI4VTYya2hDYlZZVU1mVGhnQjg5aklmNlZSa3pVSGs0QXVSR1k1QnpraWxBcDhHeHg2M1RacnVXR3ZMa1FKek5wNS1PVGN3V3hEN2N1VlFULU5icVNZRmZYMnZVcEt2Unp0WjNxeTJOMTRIYmdIeUZMYnl6SVVoTXdiNkY2M3dwcnlIN0hfMHp3OGRfb0N3bWVCMVBTQVBUcFhiYjhRZjluQlRXbjFCWlBMbUNVc1ZCaUFYQV8zUWp2SWkwUXlrN3gtb3BGc1E3OFdJUVpadkhsb0NRNWI4UGd0bVdaNUFwVDhPc1dXQU1sYkFzdXRLdXZjTFkzbW9DeFZIOGxzclZxOHVXSjhlQzgxUV9uOG5YNGFqcnZiNm51M2ZXTXRDNmxFeWwzSW1JSHRHd3lvVVZOVW4xZWlBQVpnYzdiQUlnNlBoV1pxS25DMkFyU19lbEVheVFUd0ZTWWxrM2Zjdlo4Z3RMOHB5THY0YkpEalI5NUprM1g4NGJEek5uSndfY2o2Y2Fqb0F3WW9nc3RRZFRnd0pqTU1WaU1Fa2hraVE2SVRUU3lDNUJmOTBCa2VXbWZwM2N3Y3c2cThwMG5NZEdnMjNDc0p4VHNla18zbFotRS1KcHZESHJnVUV4d3g1Z3lCVy1STjdrX2xnaGd3OUw3QUNTbHdGb2pHVzlZSzA4T0J3Tjg4ZEQwLVlmMkZSRmFnaFVQY0RfWXhmaC1qNDkyaGY1SnE1WWtyOGJMZENiZjdBTGgyeUp6UTRoUGREMDdnNW1uNThnT3ZMUWo4Z2tvTTBfMHVGOHBRaHpqenRjVlRaM2NBNkZobEI2a0Zkdk9OQXZVLXI5YkpFb2NOaW5fRTJmb1B4VUxqOVdEdGxaX3N2bWtEVzBjR05fRWRlR1dKLXhLcTdWNDRzck5vd0lCOEprZHE4dUhZXzFadVg3bWV6MHNYc0lNSEFFSWhkSnBJelpYQzVjYW9lTDRfalVxelB3dzJzMG1IU29CSlpQNjNWODhFQVpMVkdtaklwaC1PTkhQeU9QemFlQ21xajFlTVFaODdJSGNhYm1yUGNaWDFITTVvRi1meTZ5RFVzdUJyRkx1dmRyX0VJQ21TM0sxWEZmWVhsMkZCU1ZsRGNpUDJ0YVF1RzR0dHhjaWhoRWpERDVDcEZ4S2dha0lRSWc3VVFBTy1rUTN3THZHdW5CcG4wVy04eGpWRFBoU28zUUNOc29sNF9zWnFqVTBoeEVNTVo3YkVxTzNSVDNTVW1OM3RjdG9LWTBySzBxZmR1bk5iSXNjdG5TcUVPYzg3dWd4VTBXNHlQYjBNOEoyQUwySkV0bXlRZmN5RTBDalkzVjVZMjNlN19UVV83bEk5alBTbnhvVi0wdUhCRjZ0Z2xYN3p1akdJSG82MU5CMHo2MHpXZ01hYklqd0Rha3dPYXV2Uy1yX2RqbEZpeUUyZlJvQnNPNDN5WlI1OGJqcHhpRHJxOWdnMEtJcktBQ0gtWjliTUdxeFBIbHVrb1FGeHAtMWszQjdndE5GdGh4dEJqMng5Q1FBVUJwMFNZYXRhUmgwVlBPRGptMWhLd2FUTnUyNDlxZW0tbERiNTRhNFplaGZqVExkS1RoalFiMktwY2FCbVg4ekpQbnRhVlA2MXdDeVRGVDBSN2RIVHloZUhfS0NYbHA0WDN0ekdoRTg5VDVVWjVxVEZJWmNDR2I4YzM1c0pjYnh5bWZ0aUJJd05sUFRlbkNid3dfQXlOUWhreG95Wk1iai1lQ3NBN1M4V3FaUEp6ZVozWE5iV0ZJeS13S3hFMnVyTTJKRXd4eExXRllwOFQ1cFBQQVF1NG1NT0k3SDlfNzRTcWpMRFpCU1Myd3dUdU1YZW1aSDJuWVI0WmdCUF94UkZENzYyM204ZzRuLUdNNGhibVZPMW1LTllJbDlHdzljbkpQOHpSSWlNbUppWEdXTjktbjRPVHFRWExFVnlKbnlUQ0RCMzFTSFctTThyeUJMemEtOUxOdFZhUzVTWkM1UG1vem9EMFZyY2hFVEZmelhwREJfZGYwNk1aYS1icEpBQklTVWJidi1hM0Zobm9JUU0yRW1uT1N2Rkw1ZFdDRlZMcXAwREJOZEVOS0FiQmJaNGdaaGNEREVoSVQwQzh4dWJ5MjN1MW55ZlowRld0WXFoTTh1TS0xVzVOTlNLZGkwVFVhQ2d5OHhBdEh5Wk9YeWgzVFRMVTh2ME1rbjFRRjh5ODRsOVJlejE5VTR5Z2JqX01CVUJreGYtNnhpSFRVQkNpQmN1UnoxM1pSTkVMNUFzTUZLalQ3Y25zRDJxNS1fdDk4dEZ3SmNQejBTLVctbzFtVnBRSkFjZWZ1ZXBRcUdvVzdLNWIzMWFCVHUwWVc3MTZCeW1pSVEwTU5VdC1Cbnc0VTZtdG9wWWJVRjExVXhSSHl2R050dVVUMlp1MDFJSWlKTVRvYmxoZXlYQkFraEVUaDJTXy1Cckc4cG5oZWFZaE94a2wwZE1nZy1ISlJ6V0RXSHJTZ2tUN2plaThNNnhOY0Nwc19veC1kNkdsX1FwYnRkRGZWaGQ3clRaTzhCNTFQSVN3Yk9aYUhkZHotRlhUZmd1c3p6S0RwZmtSWjN0T010VFJ0U1ZWR2t3eG8wRWdfQW9iRVJSNnBBblRfN1hZQmpFWl9BSVVwQkhmYldjZENyUkN5YnR4b2VUU0RvS0twblJkV0E3cnpiLUtDQmVzNG9mdWhicnNldEdWXy1rT0dLc2FuT0lPbkNPQWdHc2VFb19NTnBvZVpjWmd5QlRlaHFmNXlCQ3FZN2FmM2E2Q0F0V2hfSE1IVzl4cGk1TVlZVk9sRVBWWHZHTFp4bi1xS2hzUDVwM0g4a0VHam10d21CWGFuQVhkNE1HemZtWnA2UkZ2d0VIaFJHNFJQQkZYSkZld3laMW1oSzZZVDZXYnpuUGloTC1PTjJPVnJEc25CSWdEUGVtclpnaVJIVWdnMkk0MXNnX1RMWTQ2N2NYUm1JZUc4NWpUTmRieEhkRkt5UWhNS045UUVBYXhDTGJsaF9FZFF1LWJtcnFfNVZoRmIwSDlocF93S0M2bFlOM3BFR3ZsajN5QzNIYU1LTW8xSVlBTkROcmhGM096U2VHUS1SWmZHeFQtZTNwdmRzc2ROTHE5XzNrdWdGZnB5ck1GY01iMkl5MFk1ajN2bF9vNTFvLVdiYUN1Wl9KZEZfb19JZV9zZ1ZnTUhoTVA0elIzRlBEVjVjVUR0bEtWWldSa25XMTRaZ1hnbFNRRG5kSG5lbmpqR1N0WkZnelh6c0FqX2xibm5BXzZnS2ktZHQ5SXk4aW92cFN1SzhTMmMxRFdqU2xIQ1FMS2tCdWR0REI4RFRaYjZneHJCZ0piNEpFUWp1LV9mUXlPR1NOellNZ01ISHFiVTVVbmpxOFVlQkFlclNnQnEzTWRza0xRNjlRVS04clRZbGszVEVLeFQzS3hhTUx6MmxWTkZSMzRkUDl5Zm9HMnZvOW9PS1VEb3VUaXRwNkdhV29Vdm5jWkdDME52bktJaUIzc1NiQ3pOWFdWbFpDWDhWdFhRQnB4NV9USDNhYi14bUJOUnVQMUZ4dlExNERsanZHQVBOM19DcHhxaHAwTmxzbk9xNzlqYmV0TmtqVHVrUTFZLVVhS1lUVFZOaTlQV21CbWJJTGx6X1FfQ21lSml1M1BwVVUyM28yNHlkR0JFTzZNZFg3aldMdHp5c1hxSVJyV1JUS0g1dG1rT3VwNlQzck03UGotb0NNMURacGZHdFUycU9aVW5hZF9TNGR2V3RBT0EzMVVsLU1DQjlLLUpHZEhyU1NKS0xoODNqM2d1ZDdoTUswVFJmYzVXLWdaZzdiT2xUc2EwcTB5anVKTzAxYmZQdjdQTjN2cTRkT1RabWluNnBJMzJSbzBTQU5NZzlBRkdvR1g3TElaR0Y5bVRMZkZGbkJTUlctaW5taW0yRW1NR1piQV9hNUdvTWxOamhmV2JvLW5aNHZubkI0M1NjZlNwZnI2LWRvRzd2VUZzMHlPUURuM0VvZF9ZcHBwUUwtLWtKR3VlYndlTVk4ZmdtVy14NktjRENjSEl6NU04MzhROC1KTEpPNzVLS0ZqREZGa3JtTGZfTGF5ZTJuekpKVGxhN0NnMUMyWS1kMFJGZnd3ODRHb1JjaGpVS0RPQnlFUDVlNzRpcnVSc2hjQjl4QVUweFpyZlIydmdQM2gwbG9UYjJ5UG9wekVwaXV3N01XZDA0eGhsMWhJUm1haXloRFMxc3R3WFh3aDN5SlNuWE5NMngwdnY5bGpQTmRDTzBiQ1lyZVQ1SXY3eFp0WEl1VW5jaWI3eldUQWZNZHM2cXF6Unp6Wkx5YXFTT0JrQkxJLW82R05SMm9PX3F6dTZteG5tMlJGOUlMcEdxYnRnZHhYTTdScVNkNVBEa1RfVjhrVzdOOXlfTUJuc2RpV05uelo3WndPNldrUlNvbkJPc0licVFVS3NXR1dUZ1E4ajE4dy1hd3hnWVJNQlhrY3lEakt5S0piMjZrWjhnRXNlcVQtM3RPTHdFeGM5cjh1MEtLT1M5YlROZDF3YTRFTWZHMEhFeE1SdmdqQ2N5QTlLa1pnU3Y3eTlNRm1BS2k1M3FXNnVvRHRfX1Bwa0lFLVpqUGhLLTdSa3Y1TmJUQnI1bmctTlR6ekFHc2s2enVPdnBpU05JSWxBRXNlUUJERWNES0c0M1Fsa0N0X3g0VmJ2QW9kQk9lTVJpZWNMeTVtLXo2SVZyME9xX0Jnek16ZW85Wl9xZFhWdFZobTU5ZkhDek1rcEM5WEN2dTVXaVU5UzhsV3Y0VmM1STZXa294QW9vZ081QXJFVVV4T3JsMzlma0ZpR2FvUmNBbWM0dG81anhUUjhuWVJXQ2tFdUQ1dEoxcFFUNkhpaW9XMk1OTXR0OExMTTFpeUMwejI4bWFlcmdBZUxGQ3pTODZ6QnJybXVTWFJEQlhhaW9DWGM3VkoxSEtmSUFYcDY2ZEZ3RjhRUkdUOE9LMm55dlZIMzlvRWhSX2M2T1NiRzJvYkxTOXdWM2RFSUFiY0RhR3hjVUpCU1JXeTdUR0ZhcWdhemlwRVRnejF0NThlNUZhS1AyUnoxMHV3LVRHSWN3VVJtRXhlSzVnbDZJWWdMVThKYmVNdWtpbTM4dVFXaklVQXEwOWhva3RsRFNueG8zRFg2STJjdFYtRk9xYk9rX1dLRURHRG9aRG9neG84UFNELUJWeGJrQldRZEwtTUNENUpzblBGRjZhLV9BdFBaWktKYnZoM0t5bWQwNXVfbk9qTURUdXFKU0xuNUV4MjFPbXAzQW9WZlpNYVlTV1hzaXpOWU10cEVReEMwbWp4aDFFLTNmRm5uOE9GdzVnTXFXNXN5d0ZHRklYcUF5MFlmc0Fsb0ZBTkstRVZvVmpCbjY0b0Q5X1NsNVBwZmxFZVlaSFFRS09IRmxWazVwdUhlZHdpckNfZGhkdGp2TnV2ZlNSb1BLU0VJWGxnV2owRHRrRkFiaXJkd1FNTFBUc21CT2pOYnhSWFkzVG9Qd0RSZGo3eC03VVJxY2Ftbjh2VW9UT1MxYWE4WVRMNm5FNVhsVHpuOW01MEh6ek1Rb2tnemcxQlFLSjRsMFJkbWw1a1RiX2tTRm5XY0hobHp5UGt3RUxvZnZfYnlBN0lSXzV0d21LLUZGcUVsYnE5WW1IaXNrR1BWMlpHTDFmTDFGaU1RSmtxLXNzeFlTNjZJRVZ3b1pCaGw4dUZJbnVidXhFeGJaSEpTX2xQY0pLTnQzcExWazJJSzJpc2duVFgwTnlJRWNzMG9pdDlfQVRERUJ5OHZwWTYyTjIxYk9la1lJM1o1Q0pleFFpVTc5VU1wektndTJvTGlaWnBaeXJ4TnVMa3BWSzJpT2toanNaN3gzNDhRdjBSUjdRN3p1aWM4b2hnbWYySUs5cjltOW93MTg4MlpRNFlETTdlOGlxc0t3dkZkOWZuOERlcWl2cmROQUhRcjFlQTZnN3BVSkpZZTNiUDJKLWpGSnN1azQwWXBFUXZVdGFaZjF0cUpPQlMtWlhvOE00aGEwUE5KTWx0bFhmZGJub2x6aHRnYVF5blR3WHJBRTBSZmtnWjlMaHFtenI3ay16TWEyM0t3UHdncDJmUGgzSmV0Z202Nkp4eHBnVjQ2dVl3UTVwSUFibll3MDFOTUxFTXlQaUNySlFFRWtwaXo4WG9hOGtJMkdRdkh3b1pTYlMtNzFZcHMzQ2oyLVZkRTBNaV8zUnRJUEZyaVVTUERfS2cxQ25pQlduN0IzS1pUYjd1MFFwOXl0VE1TdDNRbUNwcnR4YlktVWFwWEtESUYwYVVCN1RPaDRuN2lFZ0pQYzV5M1A1LVZkQ1VxUHJKS2VwckUxN3AzMmFyWjE4VFFwZE5rRHdXRWJWZFlMZDNvc2tTdkhCMHBmbTFablpMZzNpSGo3SmxFX0VsT0RIOVQ4MXRBS3ZyUFlzZUJsWnZQbEdUbDdRN29XN0tSZ21zVDJHMmlqOW11RlVEWEoyLU9ycFhHTWFURGxpdGNhcmpXR0tjMXFJRWhzQ0IybjI3LUlDX2FnbDdHbG4xUkdCRC02bEZGQjFuTVBWcHJpVGljQjA3THJZblNHSTVRdzFpY0pYNnV1TzYyOHRTMEh6Z0llUEdRVzhPMEtyR0xEZkktX2ozQkphbEN1eEpMeW5sdmE4MDVaWFZ3RUdCcEcyaGFOSlVleXhJeWFSamM2SGdOZzNHXzNIbFItWXhiUjBfSmtEODJwczhfd1VmZTBGOW4yYkUzWEVNeEd1bm9rbWdWbTdxQ3I0TzNxQk1HZ0dvN3ExNFRVTGhndk9GeXVZU3BKdkJ2a290NVptZS02SC1idVYySlVjNENQYUN6Y0pFSnB6QlNmTnk3eEFlQmNvbEN4Q0w2MzZDZS0yeUFGVTFFdjJ0NkN1U1BHZUlyY0RrRlUzT2RWOWxvRVlJaG5nNUdEdDdXUjN1RDJsRkh0M1dWLS1ieHkwSFU4YkZmT0c4b0hoU25NN1hsOWtGR1ROWUVxUndIUjk4eENYeXVlS1ZEMHVlN0ZPNnotY3dxV1NxX3BFb0ZUX0V4OFlHU0EtS1k4N1RCRFY1ODlYSEdMYW05bm43RXJybTdNc1p5Znp4V0NBb0U4YkktX0hRN3dTLVVTc3JuZkh0eVJCVkRMcHRSUDVXWDhTSW5jekUwbTFsZFdRUFRZdDFZTVdld1M1Wk5GWll0SFFVSU9FUzNRVlZ5dWlrcXZQczBQWE5Db1p1ZUJoVVViZlVab0E1WFpDTXFYWVdsQnBUMzRVWkRTV3RxUnRVcXhjZlk5YmpvNzZWNjRfSFAxUHJ4V2NQMFZFVi1QVmhxTE55VmRZd0VsRTB5YnlyWlNsRjRwVlM4VTdsd1VlS01UMnpHNWVDLUktakxpUEU5S1M0eWU5WEdtZjlVZEZjd1V3cXBiMjl0cVFFdXRUNFRmUU54elM1dzFqblUySF9BVmxvNm5LZGJiLWt5RjB5WGZyRXB4VHJtR1VSZTRqMEVzMHBXbU0xOVZxY05yeDJDczh0UDlGTlFxNlptQnJ1QVY5ajE0SlpOdUhvY1ozMmU3cTdsN2tfcWlseEtDN1hjR3lRS3U0YlpXdS1qWUEzdm5OSDVORnAyaEd4aWFLVmRka1pDQVlTUnBqMHVNZ1FuVGNEUkppTTJoV1piaGY0OXBUaUVwak90dmhIbHV0WDdYdmpnTDVZcWtVRzNBbUZVelZIOWs1QkFpUXo2VUtwVVJjUFVNUnFPTG5fbkpMd0VsY2xKUE0xYldZdEhZNHNTdzl0OTMzSjZxdzdENFdNRGJRLVI0QlJubkxwNUZZRUtSY2Z1cHVKWWtxV29xd3dQUzc4b1E1UmZfSF9VbVlBZEFOUXhsLVU0MUw5RTE1TEZqaFBsMUZObFhNLUp5ZVNJNjhlbUJ1NGNWY1l4d0oyMGd6Y2NuSWs5UEtjdXdUWE1IUjVIMmNtZENxRnVBY3lYUlJCaGhGRVBfNjFmbmxnRjMxMFZSdS02c3JmOVhnTGFuMEdtaVNZSC1UaVpmcUFrUjItRVlvdWxFUG9UWUw5OUhTekcwQTBveXhpc2YyaER3Z1NxNDVpbjJaTU9BQnRrNGpGT2ZKQ2kyOVZxMkV5YXVOQmRodkFQeUVzVHJpcV9ydHZPN1phUUs1Ulc3QndPZ0RsY3k5b0ROcmVfRG5mZm9jRUNmc3hMVndab0Z0Sm02eUpoNmU5SDVTOFdMcmF3MEhDTklaR2QyaWNTUTJEMG5oMjh6b3JSY1lfanpIYjBwX0VIZk1iNjhxa1hoQmREVE80ZVQxeGNtRmZuUXRCQnRCMVJYaEd6cW1MRlhTUXJRRWxHWFY0czZxNWFYRlJQNkljdGowQk02VkxHWXVpOUdZb3YxZEVrWVRaS3Y0QUtnQndySWRGazl4N0hOT29YRm8yRlgzY0hWTUpWU0hzck4xY00wekN5SVNGdDNkaHB4TnVsVHY5TkdfQWZmUUg4X3NQa05Ua1R6clcyRlM1RkZpTjVrQXJLeUZRRGlWNEZHZTRxWE5WbFhfOURtLW1Hdk03Q2lPWDg2Q3Z1OEg2c2JEckxFR2VxdVJFSHdxaE9DYnR1VDljczNIYlBsbDlvODhxTkw4TV9CSzc3aUh2a0lSQUc2Qkl3Qkt5ZFo1QUNpVnh0NVhIZ0tEUE05a1VaMTdLM3FwYXFUblk1YWw1QjF3bXVYMkwwSDVGckxxQjJTTFBPUE9zcU1RTlNidGExQXBkai1KMm0ybzFWY1JPaGhWeVJza29iLVNOUDd5WGJrbGlUOWJTSHl5YzFvbzFXcTZKYnNZd2hwdVI5aS1YX1cwYkc5M0hyYS10c2pvYmZPYjFBeW5sRXotRGpqZXl1eEt1UGVtLXVvRVlTWkZfbXRsd1JxbVNFSkFwWmlxQms5VHFTZW04LVBCZWxRR000MVhBOWtFeHc3cm41anROODZEdTdUX3JvRnRTWGxpakFQUm44ZTI4XzcyNEwyTWtrN3FPREpLMkg4Mzdvc3J5bjNXRWE5MW80OTJuTS1BcGNTZ0pfUUEzbURqUTJtaHZNVElPakh5TFRCZlBjaW4tby1UQzRhc28wdmpJUEhLZ3pUeE5oWnpYNHMySjFSRF9ldW91cHhfNXhocDdCTDZSTWt4eWVMd0o3Y2VwZFhDVmNmdzdzRDEwQnlyVGVtSnVoT2oxaWhrc1lVUmdEZFI4M3pweFl1Sk11a0ZqbjlxbEQ2a3c5YndNWnRpU2h4QjFZUHNuV1daV3U0TXFsVTg3SldZQzlEMzFUdXhiNFltYndsd1RsQTV6dFBTS3diTk1fYUI4aXZVUUhUazBPdFFwcndXMTlCdU9FbjFtWnpBYnJ0WkUyZ3NFQ2w3TTREWjZWR29nMGtza3gwSUlDVks3WkxEQmZRYXhIWmxFOFk2SGFCS0JrekhKSHE3MUNfcnMwcEo0UWZRV1NiNGdkRFpIeVpWY3JaNktPbEZsQTBma25LdEN4YnpjM3U2TUM5enFXa1ZYWWZZeWVvM1JSNUg3UVJZaUJqM1R6SjJVMVF4U1VqQjZyU19XeW9vWlhnNHNyeG5QRWdKak01TTdfMC1yY3NWVlVVdVNzT2RXMXFybjRlSy1Kd3Q0elkwUHhLYU5wZzRkMTFLUURIVXJkRjdPbnd4UmJ0NktLSFlGYW03UGh0ZVozV0dGbnBIbktzdHJYOVk2bEREYjBTLW5KQ3o4ODF5cUhUSmZ5YkhfRWFxS3R0ZU5ub3dDc190Nkt4NTVBS3o4c2VaU1psOXJnb0k1V0FrVkR5YmlfSlFFdTJnZnp0YzN0M1hCMnlTVDg4bl9BcDJNbU80X0V4QXBoVEpfNzdrYmJvWkl1Yll2ejA2Sjh5ZjR5Mk1yXzgySlFLVVBQYWhuNEozejR3eS16d2EtaDFLRkkyZThQTDZzODF3YmZ1QndrNlBHNFItZWg4UVhybEJrSXVqMkJ4eGU4VUZ3VUZONW9kbzY4VC1SWTF0bVdPRlZndnpDUkJKc1Zjb3htLU1CTGZsdW5XbTBVdDRvd0F1MlRKQ3lUaTRpWDhIM3E0X1lQTy1zMXBiQnRRaU0wQU01azVFNkdoZlc3MS1lQjJ2cHMtMjRORzE5R2gzTEhvTzNlelJtWmhwX3k3QXYxV0I5OURrbmJ6NXZ6dGxwcW92Y2hNNWRDOFNQalFkMDBDRW5NRmtwaVQ3SDZZTmFKVG5BcnVoanhTU2RKLXUxSmdGSE1ObzJpNEtfR0xxY1BlSGlIaTlPZDM5S2NGdVNQeHAxOV9wc0Z5bHRzWVp5cXhoNldJSG55bkRvdEpiOHd4dFU0bk1FMWFvazFZNk9yc1FUeGFtNnBFQnludFljbzFoLUlhanZHSGliWkV2UGdLNjgyc2RoZ295RjJ5OG1na2JTNWxHVDd6U2tYWm0yeUZwOGk0X0tVUnlYWUtqUndFZWdKTmktQ0gxWWs3ZHgwbExOaElOVzJEWkdyN3RFd1dOd2tFMzFHdWwtaXZWZzdGMTNMN2xXNW9OWTk1WXFXQlh0RzBsRHVoUlduSHg5dTNWV0twSDFmT0xDcnVIS1VXdzM3MmhtX21KS3U5UW1tQjNrWDF3SURXSkQ0SnFfeWlaekMxWEdIOEFzRmJfOFhtTGo3YW1aUmRwRFRRSmV3WlE2NXFJem44VEx0ekFhTUktUUlQZXJDSEZmeDFYWW81ZUpWdHc4MWphVHFRQWJCLVZ5X3ZXMG4zNXhUVklEOGdJUlpYakhRVEg3YTgtaDY3ZVFPdUNtS00yR2NZQjlFSmNRLVRPdUd5ck5Cd0lBckNxSGxDSzF3SjlPZjFYMjQ2cjY3dnd6MkJCQUdRWWp5dF9yZ09PcFFadGthV0pMd25ncXEwRE1pYWt5cE5LSlVJbEViX3ZkUGp6SFFKMV9IVzlMSFB2UWVHUmVJRTY2YzEyWlBBTm5tcndDaXR4M3hzcWNJZVd2d0Vya0ZzcWMteUlZbFd0V1Y4ejVmdklMY2JvSWRxVTJ4c3RqR0lvZDhudEp3RVRMeDJJQTZ6TUZHZ2E1UDZkcVhiMm85TUtxT3U3Z3UxYzBUaGtjVzB1QUFSb1F5ZzhDcnMzX0VfcC1YRXpCZGVWNzBIWUhXNk5CaV91OUVfLWVKVm13Vl9RcmJxanM4bEJxeEhsR1ZyUHVIbjd0ZU1ncXk5cjY4b0c4RVZRRFZUV0tXYWZ1U3Q1bHJpWXlTMlk5QnFqbXduUlBFR3lqTzJtLXVNRTRHQU84d0s2eFZVeWF1emlRQ0FyLnN4blQ5QmJTbklGT0RKQ1Y4WGR3RXc" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/BackupKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/BackupKey-example.json new file mode 100644 index 000000000000..d000715aadfa --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/BackupKey-example.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "key-name": "testkey", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "value": "&AzureKeyVaultKeyBackupV1.microsoft.comeyJraWQiOiJiNTc2NDI5Zi0yNTY4LTQ1YmUtYmZhYS0zN2VkMDdmYzBjODEiLCJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkExMjhDQkMtSFMyNTYifQ.YMIP_MrQq46_fpDL_H3RJJsIJ-3NhyBd1yk9bBKNI8ggN31ah6qehcPHHLgJrx8jkBLLXPqp5f1zlil_rUk-KkOryc8ZI9cssM5_Sy3xpI4Zy6WIc5cjPWuGCCmBpAyrtGOVzhjQxo3rTW1DSqgZUvr8TJly2PKrviI_RgnEd6-RVKuuVN4efVaK9XVTmn1vfygzpTr_TWC9PFmzhOJzgU98_9_nVrWVHNS1uLXJXnWhAOfRYtVRNEQIENeLc-g3cMrK91s6NWxNqfF_GL6Px6qXG2WWCOg357fBgOVStDKiVH6N1MedQ5piadxxTT6LHZokB4x1JlAIfL_bU69PVw.F9Qb3tVlMKprCKK-YEi82w.T0MQiauw0l9Mb_DWDcXoo1jN6IYu59Y7SEL2mgtU0x3XL9yTsjeF4cb44LAh_oP7gmH3n7J-VD_xJ7hWcMW6yS49E_M9iygt9SCl9f4Suki3CYvL0QERTYKImj2-AFDLZIwNmGba8G8axPqGcNKsRgGZgYTToiYLqBryrbvLJudCqgjeQdi5MmtyPFpagHpHvKkucFGp-XmJ1KbO2A2QOWQTQZ9CereBqrCn24IwaQrUC4rND2w0UA1TcwEeuVBGELdJZosXs6CGDfjZHqcvpz74Jwx5OEiq_DPs9TKrkMhowcEplZ8ZJMcNQRfu9J89d7YXgGdB5ikJzp5ZV89w12b0zCHNYJjgddHS62fjVeaE1OOP_7yfX5tJb6d5AXigr-JJ3lb7cba9q64plbiarMKzab5Hm2LMFuKBr5Nako5P00hQBgGc6ipIK8MOcKsdaB2Fr50_Ub6rDS086u37-CHtFFqy-1AhiCixQjCML_kXkI0vDbbjF-_xkMdaBV-Au79O6zWjsDeeWKtUvVQnB0c4By7IWCLeVw22i09Yi72zBqfOF4rNgxU3kJ7_-5boWmyYW6wM8esN4xGY3PhU4yKE_uDg6vNNwt5scWYoS0xx6PCos8KDtcr-UypQ92thU_FXgq9StTYq2YgVWGPns5CDLODAJ-l11I6IitlP7HhyLo39j77iWfTKDgL5kp7D9E3_qdPZktjVPDu3ZQcT739N2zz_1kXrDom-6PPqwVS6mQzAUmqixSivcqbqjZIFtOllKFA6qerh2eSAYzTMSCuwJxDBRB5-n0MQlIHjC17dLZhVqD1Sb6Prq_y9sv2ivWq9La9GfGlHA6VY3T3QdSCukYRjXXq-B-NnVdhFMValVvosrJfnHFaXfLi0gs5U9Ku4yjD7QoW1yR1IY9OrZ4qRQwkpnm9O2rrH1pm_XSzLQT4kZcKbugxsoYtlDOSiobKDXu1MtCqvDnvxz8Fw1GpMrBuLkVQDVeeP2j4ZwLlOnLTNi8bScNm_7vTsTPm4ID9mjpWI8Bap83TKi3dzP1k1i3Ggrr1HJUAOzCCcQ4gilDKZ8RElQe21BAqJ7yEnnVlucyG6AWa7viYYuxxBHkDl7XGdvX0jI26rwcS_FH2yNiafd3wJI1342XAvT7CQeh8dZedJSqXQGjB5BHayV_ofzeUp_8HjFDhKUdrcI4i0kFppHdPXMAu128wDu2LnUzyM4JZwSIum_njbQ3ISTymELNx3wt2WSEOd7AKyKyB4BsSsdPMGewKI1gsj-HCEoNBwxPBAvVqCII3lf94m-EM8-XzNtBUqiOv9dDBkgvzJmI9k2O_VjcmFknGJoi1VzYpiQU4XlIZzjCwsCDqkahubcqXWr08UtPmWHFEy4CKorVL7UHiXlVrOGUGtSvucwKdcKTOzWlRx-DcF0LCzMdGZwcg3ei5mitlYbF2UlbN2bZSCPX9c9lESdAQHqPEl5raT67h9VxlOswhanxJFo4enDCZafNmDFG2La69EqBV6KLz0_4uKZC5mxavDk6WKyfoDNyqsuVLto7YsjRN152X05XHHnESz4ne3c0jwWaz60ZIGD5MHMQHPy7O4WgakaVsJeOfaCskwbb49q_mBsX0NfZPcqabDXhZ7BYLQ9XERGbnwd3JDBh-_TT7k6XDicKTnVPueF7wsV_4hOGRJdTI6PTfWj5uf8u7qEOAuKy6euVMKy97MWKOT8-ZQl0hIj0rbVGZH-R4rqH1v_VgQPdi-qWoqWqky0aZK3CNA3QxWftLGp0qEWpu6OQ-ChN7-vxN0tUeddDZQyWWtwx6TW1KhCBWZGjZm9AC68bU2BuNME55oUWGlncN9EnFzgNmQMTuK5vTgwZBHMjfQzlIG_yfwAumHycK5OOOvx95Hc7wDAD2W1WRohy05yLRdlBv_4DQrrMkadEpf0utvhwUwevR5McVEybOwUL6gf9krC4L4bTumBQloBrx5h3nLxYw90rijlnKj5YbKaejrMwbImyF-qVNMmjSwb52StJ0wOG3xOGfBQDxPXrmIxh0DR8GsK0dy-1HIIej5-oRMd_J9aVKz0Y4wx6V23h-jP3q24JbawvwlA6rV5iUFdh6JQriMNC-_aD_u__5U7t8CH7ZVCuP3nIi5x7gmqalK3egHm3pdb_lowXE4ZEBDLvtkihl-w-PFsuYoUJIFVqFvVs5EnSSMW0PIXOSfVMYmJZekbiG_QjxkB23BhzYrSjCz1qnSMx9kvbp9Qh1ndRXJJIPU2jeHuLB4OgW3hzynCaqAvPEuG2XnKpxXfxAKNzWiLIN-0lQ4_Qt4tw-fjaYRUV5KUjrbVgk2506HPmYTGVQWQ_m7gSASPZj6DbInku7K8EZr6owuH253Xqk9kIl2LMBpvjOkNMaQMxKr2-2YdPEy--fMAPLp_UMy2xjlKLKk7nXIu_H1vRng_VUrVHneGjFan87QEORSV7rTAprO2fT2j_9hh6JmtYkQqgG86YyJksUjWs3xpdi6NPFELjAgyOFC-4kMgKlgI3iTHIBWQ3jjtSe0Gct1K7BpBJRrIAF-1UB6JT6cJ28gMswI98kud5hoXYmT5lA-ZaD-I8dM0qFtHH8kYW_nzzo9m69-iYfV_wsy2mBvueoNQddQKBkmiUMnxV90tAyEg8YrZYL1rOcXqcoeI6_8RetmvYxVM1bpuq_j9fMv-zTA9JCeyJ1qAN5VAaicIgg1JXICLB9jeSOOsQw1avqvM7N1ArwCr6oMHrq5ZCEK85yVb5G8cctewoiHYsuYOOHgH3LnchWzfJ3MiEcM6_V7RdvBQd03kPzGEV8uI2uh9tmLk6F7UKzYM6ExI5mKPC9-QN2Mxe0z46ke2mxGGGw-yqL61GGAiKAcpClK5GxyQmPnDJ8DqJNOVX3h_o7a11Uo32kdtG2huXpDUsay6E8TbyGWEgwfX7ZVvk7UM3ejt3jYpqbdYJPMMBB0gM9OfIQcKITroH0rDlQ6ZkxPc4dpeCmM3875pWNQkg1JJuQg3xpOVgEFjYZlED50EiVJ787qC5aGmjLQZ_r-P7_hI7OepLVgPGHASRLlwGN-FpL78QoUzj_Xu06Pd6AuTLmbjhViDD-udnqu5UGwJ4lYjbjJCA7uPOe_ujsQhYwUGA_XBylnErIlL7OXHOTxaDlJGH4-4wMroanhOY5hgcVdvUBZUgRDUh40l3z8FUbaRlihE1yt0uNoGqwMdrZvhNIwaQcPYPyUwQ7Auhuv_jItUqiFBogryRoscwz2qttjmv8AQYHyAly9ujvbury5LcIh_EQfTzBnJy_p5Yw0CXnBK87fEH8raZHxWETpqlxyfYdVf9PjDXLbLabVCbzMsR2sXfAo6m4VhghF-CGNWymknD00Tme4La4W-A-OeGj72-n8Vc6b9g78wnmbAttdrQ8PYWKQvcuyDlvyEGGH_5UmtlSyj2JltKesw7Wsj-ak8CX1btdsSlhBWcaBttj3RjwlCxhD2MyVttzt207rOB7qtAIyX5zrY1LZHpwEmMx8dZs747ecfaeS4dQBZczSyB4VEYTQXgHygE_q-bw_exj5k9sDGxsSFqyzQBVoU9Kename4DJsLXWZinuPHYQSmX2TdPZmsdHxBkpAprb-H4HgEJpOalBkGwhXskHpb6TNHPxy-oOm-hAizmMVOg9gL2NHzRuAmoI3U4Ewa_GEnowteAQSLecMzZ6qgyudk0pnuRyN6P1m3BSQ184WS3jx1C460LAJ3arI-4Aeuin_0VX3qGva344vet87DR7IbME3KMkYkTuz-hzjnxGUT5qvaZv077PTq1m5CQPTdee6Sg34f-ylxh70j1I-NZvwhP2LVv92duVxJRR7xslJzS575q7ifuPG0Rzt4Ny3YDJz4MeCNNpZIpMBJxdvnG7k8lmyoBUQbdz8xBunXOqlD1GSm93NKc-wo7qfzIjv0Z1zYZp-nK7J64E-Jzx2D1glIDnodl9GmyS9po339IYaOPfRgI3ZwQSVGppBP7GMEGlFEqlo7m5-4SYXG6JdXaNr3iQVghPKdAei-bCLAPlbFJCEAU55r_HEfKlT5-36SydteqaSdGo1XFEzZuaH-_z8BlwXW0N0tRitz7Ixu9NANC8GutgkvXuER_Nnw5UIlarepM6TD_Z_e8rFD7haxV1WtoZd9BSwNbRmIyu6cfZzX2xSOVRUJwVHG-Y3ZDdiqkso_WGBvLRJBTVOsoeVnqe1ZKjoCQK1DaFOopxP7SMhp9YicoWFOUQNN5-DB3-68CmDsv15-s3DTqQC58xiwbY-4nYktySQWayzTobVNXmbvb9K9-uj0aTVFLzH1G0YvLmhSSSwk_3O-ctRPLEnXPSQV6GUOjywLHOXSD6_cYS7RkUtx2g8m_1nhIQm08Wui5MJGPGBDoDf7K3wz22tgQQWL10cbtJUoBF262UiH7LNi22VCkl0IX1UQ7-wpI0p8dWSoWo6SnOa7dQ5iBIbf9P_rQwWaaYu5_ZBZpCM4UqVcgaGSYVsqDzWEV8-tck0X8NuI2rgrR94CJxcJk91l-oz0nWaMAhprnn2_wxRXGNay36bjSq3YxM1stt1M7Rczu7Q2Pz-fdjGYANHvqAKXQ6imJaAsplNtJHuIJujwrNTPwFs4a9l4dXwM04QIfhc4yzmbp9XF7UYU423WMhQSdL5JZNWyAuq8AnG7mwgSP3T24NThuSFzf7uNNrJg_PY9UCVriOKqD7YUKARgQECA-NkalnXSEuTCvk2ifEX8Hzq2Il5wLFr9QJV0fO_DRCrS5sDuZVbwD24cejOybmguUanL8b2IjKxzLUOOke2EO5TQMtPQfcy62vEyscpC2EawzaCvWub1SWKdYVu-qPstUxyiOPsipTwWY3MuMFJprSlqaUP1Iksz3D4TjjHIsoG6MAllTYqB-IjnHHfc26nS7ra1yUcltHEkDwt8GR6ng-6OW5bmOBvTQCjdTP8RmvwokHEvFA9Wlk69VHTZEJSZ4gQeqsqo7HBICHwvUb9mzbHgiNtld5YAGOuuSpNLMTq39-33UVhN0KkHKQvBzr59qfhPHSyUFuLg28ojX0doox2JQDgPhlvUbDwpinDBjTpb07lcODaR7ecv3KC9HIAWkx9aWIskmXoAVaSVL0lgNMC3GVLR1D_pehA6rIk6F_jl647L8HDjDRDn6QFtHkmAamtMOVK7O1-T_-TNWph6waQNu0kWY-ep2DDgt96ztXRFSUgM9rL2y78CN2EEYmfAI-3UcjgTnU1FrWhFwt-I6Uf4Vp6V8_6qN2sT2ryaKXz4cBIcCh6o-KDi9oyH5w0Qyx8VoLS6StaQ2aNEz9Jjg-gCxiZtCRXyigilw549UaV2Wkxtvl6dydffaS3jmaLjh4f9xGkRPEGjffo1V4uCyBB9BChiUBdmjTleVRQ8nBrnVAnjauHa4lWud6HcK59V2MNZMMWmKKooA8qkn35TcnDuynJ2HMCgdIBJuPUOSy25Bxnfp8ENMJVkW_TyOnMy9orm55hlxfJ4D58ZwaQDK4AiEfMHTwIsOngjgSJ4KRCv1QkSUx7XEXMSIMQkTa0jK_Z5-OCVMssAo13W85VQJmZCCKYG6Vm-rnuXIGYfVV-858ow8BYPhCaTaW4dVpKXDCD5_sQljgIJwtVg4ODJcWqzRiYjTis2W5cvPoOXZ5B2fqZU9BXeOAc8Kv6kfCUjt8UyP1Shk07lmgP9onO1btyW9VxPHNnPw166CyrfUW1hAGB0ua1MbkDU7_vN4JZ0cuV5_b-olRo4y_rxd7PdVDBldpVMLlWxZ-XbWUjtZSVwZOMk8KoWatnWz5R4KVK6AgmbELxikS1J61gYI6XSro0Fqu7GM3bWvVPbmqGt8I_Tr3GjiJx6w9HodiKlFPsbLjA79bnHnCpwpHFAXb9wq7vc-H_0MMVTl7xNzo8HgQ_GkOXIu9_n1Rbe-RD4WRiHwTnbnYmzG63xowGNPI7g8Gm7fL_NzCXhox7TIHW28tXQByY8fdw_v-1KoSiaJ3p4pIRyQBmkBzf99FFZOKh5mLK2pkHOH5aenQE6x6pqCjCdqnwS97xbtJJuNAx3UzP7G3iyZSyel8HGtaMTeWHO1nhOedSeq5ahi8tAEyZv0QRqLlA4ZALkThyeCYrJAwW2iBZ9nCEEgzljOMpu2gtzCFy9ZKYYIhifJuT7vPGuXFMKKVX4XU9feh8XH1EVnvxpCnF9yxFgy8nUnBuGlFEV8UBUNh8NApIYcpeL7yCQyl6P7qhrN7HHH4Ih6hKKiUiB-Z4M0rTJOffGz0XFZiZH7XOmJk0MszBlEahAEn2SSRZiQWM8lDTQpGk_JwBJQ_QUNkLfxBpzlK0T0aqKWw3ghXY-OqjzS8q1W8uAc3ZlTT0VGEgVuO26_oEzWNvXbzJ1E_TAqREVKL_9aezms3rjc-FvWRGjLWONMxTtl9g19DWalP6jReRRExH7v0KLGoHuuEnHTsP_hl2vn3NVYiwtQnjQB9zb26JFlpg6EhAuI3xlVL3xpDOjeIO5s72YJcS3r03bB3m5G1IcEU8JDvY1y22Phnb8ef6z5ri8D69rUKY8E9qkhLWaXN24S-6Ab3QeKJrlHGOrhG6fJBtIjL_wFOdZ2j8Z4mPYvbZ5CDQ7g3MraXuiRzqgouy7NIbzjs8FDND8dsLGVt9CKjtU2tykBkIJPfXkgu4-JRTTDN3H4gpzOfwPyW_19tLvPJ4JQlysnxJhJmInSPKTQ9crRGTQeKAwLvYzgB0nPZB1wgPUbGitlhySWZjmjeUNhJsgoFwdtEu9hN4Cz4NYEKgZ3ZpJL-lfeInjtTB07P8ukiWqGxcAiR9L4Ov_xVlMboanWn4CM-8UJvcDhUDkiLktxtI8M7fM5nx-2AR_s0ryCWAubefALQtuDRt51VkfyIfBvQarowH6zH_V_gYIXWNt9oLILOqk4yjrdygFWY9vAvP7V8CYkiFnIUkXcZyClOgfq39mtJxpL3csouZXTHp11gLbmdT5ESn20E8bnZDq5oHEDXlOlfGHOevlzFtB_UxGXtKYX9J1AiKzBrdb7BbozdEp0-xuiy6XDZub79-mKruPL2ZYb1i5hVjQACvFp2PpZOi7xUfJRhOFwf-49JaTOWN3-aXUoCukCi1gj88dCoPYcUuk9ZlMzZdWXIp9gCX27_zSE5YDBaiVCWOsw4CJFbc-kQT9CZ34dSXbs6xKSt9-ahr9osicbGciZ1ICW_6YdK3IzrHuQEzNsCCKDuobUQQdZARQLyaeGl45g37mFoKP7bxoMZcP3F0w37AGLLW1cV-6uNnihYCZtu8YrFPuaxh_UULONMResyLUlDurvlnAUyj1U1MSlC1LkOm_UWoMuPs_UjSc7H77E80rgvBfBA7Z2DP2jV8QQRb6CTbxKiFI9LXfFR729EqDYUuQEI5d3tcyb7u8O2eBv_Tj9O4ODLyZ97gpLuVwuJUoqjARgEOuSiGul1hRqa9y6VtfjL4Njj2Ib1lcbrA.Nqzdpe8b7qsc3BjXFXZYZQ" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/BackupSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/BackupSecret-example.json new file mode 100644 index 000000000000..e7696ecaa99f --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/BackupSecret-example.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "secret-name": "testsecret", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "value": "KUF6dXJlS2V5VmF1bHRTZWNyZXRCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUppTlRjMk5ESTVaaTB5TlRZNExUUTFZbVV0WW1aaFlTMHpOMlZrTURkbVl6QmpPREVpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLmhERDdfVW9aU1ptR2JYN1dYUTU5WDkxZ0FQb05kdDcwZE1BbmgzbjQ3eWNjbkRNOU5vTm1hY0NHZmlNeUwxU0FlZDk0UjhBNDAtVE81TDNfQ05Qal9pdWIyaW03Z21nbHNPNnFFUVVIWU1tOEh2Wl9odFRrdEl4QzRPWEowYTB0S2hscnczZlBvVVFDZHVGcFg0ekEzYTR4VTZXTUNfYjZZVXZqUjZnSGM5TFRUR2tIazh1RTY0aVQ4cmt5RDRrU3RNcXhnU2lfRVZwUUdjWGdfNE9wQ1dBOUFha0N1NkpybGRaQW9BLUtXTWpQbGhaWHFYWGMyVkJlbUJjRTQ1YzY3QWhqYjJrSi1uQ1c5dHBjWS1JZ3JEUHFzWkswOS1WbHVtcl9SbzQzcG5FeW5jVFpTdzZlX1h6VnN0dUFOZHdiM0E2OVR1c1hfYkJKZ0J2SGQ4cDJSUS5WMTlhMVRacjZ2UjJHdEVaWGtOOXJRLmhwMU5IMmwtZklWbVgwWlNfTlRzekJfUEs1aktDUU5rSnJyRUhRQmZjQ2VjdHhmVU5uVlB6MVBqRWNDblZuV0pCUk4zTlFKZm01MjFLRHp1MzBIVUFEUGVmVHJyMFVFS2x5QTM2cThoWFY3VTdoQ0dHNk85NVpYclRsZlVENDI5RTNTNTQxdVBmWGpGR2cxbHlucFNTNnAtVkFzaXFlY1lpQWNuM1hhNzRhUm5xS3N3ZzhyU1ZOX09hSVU3ak1VVUhYZWY1ZmN0NlFrdWFfYkt6Z2dtR2ZiT2RTdVdNRmVQaF9mMkJMUFNGN3k1NThEMFZxSVlNY0JJR0dMU3BQUU93Q094OFF3Y3NVUEp4ZDFuWkVYYjRVNEJZYlhBcmFMX0NwekYxZlhYWVBsdmVUSGdKNVdrR28tWXNJVzAtT3ZqVGdLN2hIamxpR1psd29HOVUtbTJSVDZfbkhseHhVRFMyY3JseGNmay1OOTlXd0tEdUxFMTM5ZE1mN2RCSEl1aTdxd0RXdm1TN2JMTHYzM05Wd19XSl9DT1VGQjgycy1ELXk0UEdIRzVackhsSDgxa25mLVpRblU0SmZfY2lhMWhmWlY3ZFMxb21UZDQtNnJwZmpTMGxFT3VfZTQ5bUpYUGFpZ0hyLWFQYkFzTXJJQ2JvOUVIR2IzMXJ5SlR2QXF2ZmJDbU10bkdLUDV6aUNiZFh3SU5ONzBJTk5lZnJLWGZkZFBUd0RSV3d1ZkxCcGNlU0U0SG5EWVZVQmdkMDl4UUZidG12UDhhTXhhUlpGSTNpWG1fbmpCNmZfdlNhZUNUakdVYVVuRE1QQkdOQWQ5T2xVX3dvUnMtalNCVnVqd1FQSGlGcm5RWElkXzBRdXRYSm54cTU4aUtlTGJvNDJtOHgwaXBRcnB4aEZoUDdHNmZOWXAwVmxXR0RxZ1Q0VlpPQkZsZWRKUU0yaDQtb2xTbXdtUms0M0Y1cjdKd3h4aENqU1JReWx1MGEyQ0ZONWMyZjIxTElZaFliLWNReWFXMDNpV3hsb04zWld5cDJIb1FlUmZPR3lXUzBiU2NBT3JndGpBYnJaUFIwMGRRNnpSOHNBczFYUzh3dzBlaVczbFpsdjJwVWFxOVpTeVhnTS14b2NTOS1ueXRaWGtWWlUwX2dDVXJBV0ZKNG5XdW9oTGM1RkkyRWFQNWR0SXVWa3dnbXlsR1gtYk9ZeHp3dzVGYmI1V3VEbnJ5aDBMSnVic3Q4VXdLdnl3bk1jQ3duMjZSVTNxQVRudGJubVhJS0FyeGkwMldQVk9oTXdpUWZuX2h1TWk5emp3MEVuaXNWdktNWUNnR2xqNWlGZW5Tc0FKUXBiLUY4bng3OWFJQlJaTUc1a0huUDR5dGxmNm9FTkRsRXNJY21aeEtOdEIzcmJPdVROYUhLTXZBNmxSNzlMMDJZSTZrcEdrUUZnaHpIaTBjTWkwbFdCejRTM1AzUEMzZElZSVlQZ0Q2S05kT2FLWHkta0dWdUlsWFNmVlVrMnpzM0NBeTJhZEJjV0NMV094ZkRoQnlwNTl4MHpBRExvdnZySHRLOWF6TGN3N0lTbVl6eUhYMkpobVdReUYtTFd1VzhfcW41SkFVYlB5Z0RTRDYyMi1PTGZQVDZmc2VTWUVBUTFLVWRwZTFnSV9hZWxVT3FaRWN1aE5SckU1YUp0LTN5TEVLVWZIWXF6WTlGbHJrUE5MUC03Y2xRbmEySEhfZmMzZV9LTGtGUDFhQTJjM0RVaERseGhsTzB2bFVmV0c5eXpXaDNZN0NmRFlFMlBaUzZBcFBlYy0wa1NDcEVKMmtCcnFzWG4yeDJDX0FDdTdCTTVGZXNJQkN0M2NqSEdQSVVQRnEteGVmT0RCXzBQcXZDTXpBOHg5Zm10Ny1sNHhVQlJaa0dtZExhZFoxVzdFUXRNRVpsSWMtbDF1V1UzTU15cFZpVWR0OWxJUHVQVUEwc1NrbWxrTGhNSjgyNE5QN0hyVi01dC1ZNDcxaWVKMHdEUjFxMmU4MU8yazdNeTFlTDY3TlY4OVBHYU81SVR5WG1ueUVXMGtVbl9qa3l1UVRkV3dsS09HZVZIYkJWNFpxSXZHWjdQUS02TEE5eXc3a0dyZFRhVFZXOEdOOV9GY1c2VUhjbzA0U3dqTzY2S2x4VlFJWWpBdEZPZlBjWW5xNzF1RndyQS1UZHVDZG1sUFBHOVpjc2tiQmdrbF8wVk90dmhuc0pwYXZKZ2Zka0d3OF9qMkQzd0Jzemd0VndHNk9nNW16eVFwM2pFc0w3UmNtcXd6WFBOaDdKYXdHVDBJMlRvZHYyQ1Z3MDkzWjJlODFXR1NxRnlIejAxdjFBaGN2T2VWdmFjUGM2Y1JJaVduNW93ZF80d2FBdjlyNjVVdmtWa1FLRXpHUmo5eTZILXdZTTMyV1JyMzBlOU9MRTNKUU5POV9kNjRTRmIwSjZHa2VxUmtnNkVXc2xqN1JYLVU1VlhrS1BtMzNpS3c5dGU2NVBqQUNnZThRVDBYVWZEaUx5a1pGeUdpZ09ZMS1TVDFxUlE1eUhMTXhEc3BPRjFXd1lMQ2c2b3hocTlWMm55Z0U1cUJ2ZnYyWUtFaDdjM1dWNjJrYkw3UXJ2d0xkMHVRZ1FwYmUza3E3dGJzcC1lNWlud3cyY0YxQzByeHNScGZJRHlJMmg4b2xHMi1RQUZkWmtlMUlmaE1FZmNfdUdXX2pqSGJSWXVzYnZCRnpKMDdaOVJsVnFMR1A2WXBnTDFsRTFOY09xUVJyYVdxckdDTWZ6SzZMVENQSl93aHJRam9WTzdVRDJIUEVnUjZ2S3U3cWlmTmo3UjE5OUJuRi1EZmlnbk1TYTFKZkZadDNuVXVZOEhMUXRoUzN4MUMxOE50d3dsaDVuNGxYS3d5MERHenljbVNweE05QkdPNTFRckFmSXRfY0xHbUlzMlJ4MzMyeDRIdEZ3Z05nRzFBazNIUno4TlJ4V3lhNWhjb1NoYURXekhES2gyOVp3Vm4wYXVzeWJpal9uNlFGcnZZbjRSOHdPNlRQV3FrS09JcHkxc1lQNWxyNDc1anZSRVZGaFdCWDBiUXdJdnNlM0Q0a0dFQzgzU3FWYkhxY3phZTNwOFNxaG5tQW5ZYzBIbWp4clJfZUMzT0hYVFBGUFZmNDlVWHdrQjIwY1lvcjJ1dzBaTzJ2TUg3S1QwcjBSWDBQVy1qcGpORFpjSGRSNVVCMXFacGlWLWxaYkw0eF9IZW14aWUxY0RPOHNQSXhIOElUSWtOV0tTR1N2eWdraHBBbGl2RzVEZXJObElkeFE2c0tHQ3RtMDEyT2xjN2thaVFaNHh0TjR5ZVpPU2xyS0s0OTlIcWhObzhkNTNsbFFfMW5ncWlHbzhUSDlzWkFrclYwclc3dkJOSF92UlhBdTc2MnlpZGhZUURYYXJXSEFUMm9DU2hEN1lOdnotekoyZGtEajJMcW5CdFNCWFh5T2xsM3o0ZWFITDd2MDZ1QTgxMVBKQU5YZUdoenNaNFVQQUQ2Q0E4cGlxSHB4WGkxODRHNEJETVU4S2VHeHZLWnJiUlNOT2pTOFNrQUJKZERfSklIZ1RhNEFhNzdPUmNZcVY3OWZ5djFZVHNma2lLR2NUYzZIUjZzUVpsamt2U0NQNjdtTTRGUHRqTHlfX1pDQlNwdnRSVWd5UlpNM1dSOUViNHkxa29uRG4zUjMzN2lpSzdfbGtIa1UtZ21VbUpZUVdnUjYzT01pZUdRUHdNR3BSZXlRWE5yckJVTDN2Z2JYdjlac1ZDcDh1NHRwQjBleXJvUXgxZC1KSWJvOWVyR1VlX0ZzU1Fpd0tIaGFIUk02Nzh5dENkcHJFbDBWeG92TFVrX0xNcTFjN1R4MG5jbFl2WE4yUjhEMXNhU2FibkJSd19CU2tZMFNMSXdhb2RpY2o2ZzdLd0ZfMXB2eThhNF9LbnJNLUNkenBvdHA0aTd4QUJuY2JRVUEwWkpsYlp1elRpR0F4ZjFnclk1Z0dZOTVoWi1XZG1lOWlSazBHRTJGN3d4MlJyLUVvS3lZRjNjak0xMWt6MWFmME9fNFdyOXJoU3JrX1NHU3l2a3ZCTW9NZ0xOX0tSS1BlTjlqUnpwRlVST2VnN2NCbGlhdy1odnZhY2lCeDN2UWRqTE5jTldQdU1UbzVmME1QbmU4TUtXcFBoWjBySElMaEVuYW1pcG82X3pzNjczcE9ma09FS0JWWE9mUDEzR0UwS25SWTBab2JPLWRub254LVdBY1dodFZvX08xbkwwTWE5ZXFMMURhRGhJU0JNbVRIM1hkY2dDTnF0emIwcVMtS1l5Mk9zRzZOakRDVEM1aEI3MXIwU09WMUprNFV2QjdYemxTTW9YUXJnTzF2ZFVwSGtxaVhUM1RJZmlQMWRKcDEweDlSMlp5R0lzUzljQUtNMEZyMGRxQmJmQy16NTJpcWZweW4zUVVqb1Fld2hPYnJwUEZGOF9lUmVNRlIwSXZjUkxnMHpwek56UzU1N1pkQkZhemxNTThLcnkwN2QyUDAyTnZtclUtN1ZjOW8wZm1qem9WOHVVTG9PMkJHdmFRdnFJNmtBTmQ5VWo1X2JkY2NVUzBhcklzcGFZa1UtUXQtNnQxYU5YUUdGZEtUbFMwSVowek54bkNIZWRySEE4SkYtOFg3d1ZpRW1McXJQbU1Sd25sbWx3SnhxLVlReWMydmdUallSbUxCVU5TS3VrZkJsa2VnMmlCRWdySksxVlNyRWswX0ZvOXkzV1EwVlZuNXhEZXlGc1JuWDI4Tkl6alFQLVNXaHhYbzdPYm5YY1cxZHlWNE1fYjdzM096cEMwOTJWcGZYQkpaTDhBeHgxNGY2TmJzTEpXLW95VEdsaTJFb2FCZHJKQ2JkQlNOdWJlbGdRRmU2V2hqSjRGdlNrYVJISjFTT3ltbGFtQmYwaVNDOGM2X1g2SkZORjNmOXYuQjc5SDJvbVIyTU52SndydHVzclJ4UQ" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/CreateCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/CreateCertificate-example.json new file mode 100644 index 000000000000..e78ad9711f07 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/CreateCertificate-example.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "certificate-name": "selfSignedCert01", + "api-version": "7.0", + "parameters": { + "policy": { + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=*.microsoft.com", + "sans": { + "dns_names": [ + "onedrive.microsoft.com", + "xbox.microsoft.com" + ] + } + }, + "issuer": { + "name": "Self" + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/selfSignedCert01/pending", + "issuer": { + "name": "Self" + }, + "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=", + "cancellation_requested": false, + "status": "inProgress", + "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.", + "request_id": "6faacd568ab049a2803861e8dd3ae21f" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/CreateKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/CreateKey-example.json new file mode 100644 index 000000000000..aa6484caf148 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/CreateKey-example.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "key-name": "CreateSoftKeyTest", + "api-version": "7.0", + "parameters": { + "kty": "RSA", + "key_size": 2048, + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "attributes": {}, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942451, + "updated": 1493942451, + "recoverylevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteCertificate-example.json new file mode 100644 index 000000000000..947e3c66fd00 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteCertificate-example.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "certificate-name": "importCert01", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedcertificates/importCert01", + "deletedDate": 1493938558, + "scheduledPurgeDate": 1501714558, + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "sid": "https://kv-sdk-test.vault-int.azure-int.net/secrets/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493938557, + "updated": 1493938557, + "recoverylevel": "Recoverable+Purgeable" + }, + "policy": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/importCert01/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297, + "basic_constraints": { + "ca": false + } + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1493938557, + "updated": 1493938557 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteCertificateContacts-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteCertificateContacts-example.json new file mode 100644 index 000000000000..86006c3ddacb --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteCertificateContacts-example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/contacts", + "contacts": [ + { + "email": "admin@contoso.com", + "name": "John Doe", + "phone": "1111111111" + }, + { + "email": "admin@contoso2.com", + "name": "Johnathan Doeman", + "phone": "2222222222" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteCertificateIssuer-example.json new file mode 100644 index 000000000000..6fcc751e9c6c --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteCertificateIssuer-example.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "issuer-name": "issuer01", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer01", + "provider": "Test", + "credentials": { + "account_id": "keyvaultuser" + }, + "org_details": { + "zip": 0, + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + }, + "attributes": { + "enabled": true, + "created": 1482188806, + "updated": 1482189526 + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteCertificateOperation-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteCertificateOperation-example.json new file mode 100644 index 000000000000..f0051d7bc529 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteCertificateOperation-example.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "certificate-name": "deletedRequestedCert01", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/deletedRequestedCert01/pending", + "issuer": { + "name": "issuer03" + }, + "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApf+kGcL+5uivj/ToYbQ15zcx3caEnpzXaX2eJgL0/Kwaz4u2/bNJ9+hoXnlOFFbCp4canVoNvgu8fw5NOu9U3gJNFQwjHeAqfsg8okZGkIk0riIpp4MMb/4GQb2y3B28AcTu2FANdzLoZzBqmQs51KBe1RONkdtqDYXIvnb5G+9+P7PCy5G//Ga0JAP6Y6P8+TrE9JLEj6Sny0ljLMpMyt4rIRAtNfKYSeiWVQmYX4jZfImIW3iq91zwMsRlrzTm80mNfHPCv7V/8NmYuh0MQgCr49lLbbKCgzDyo9h8sblVQvR5TAylpIk7bSQNf4tSdVNHnsF6CJWu6Pg31hyMpQIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBAHVjmYFs3FmecaJ1ExhK1WCFJaQJUTVbPJ1xJ93UJlLivhzI1yhQO9nMC2DKV+E+UCxceqjae6OG5LUhXfYAziS0HTc80+ZcUqrZRb5ZRt+8HU0TPbTDDqjj8wMZ4VlgQ3eXGAGesMfZV3AqWwa5itofvqm8KAmL4Yn/XMSHcKfRx3h9WnC6RXgZ8WNYK+r5o+gHlmuF7/AaNFh8UjIsjjOZQ0Yin/vA4yBEYTt1/OC7pScs3bdL9CIf4rC98qaMSf4B2W/vfrXUo0gGPYcep25jy7xnIltSY80Trn3Mty5YQ0IT+KPQcJKhbryGg6bIy4jJDwS7zkn51MR1q3kNoOA=", + "cancellation_requested": false, + "status": "inProgress", + "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.", + "request_id": "b88791e33d9c4d609d3e3cc3d2d40d11" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteKey-example.json new file mode 100644 index 000000000000..6a5e5fdba65a --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteKey-example.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "key-name": "CreateSoftKeyTest", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedkeys/CreateSoftKeyTest", + "deletedDate": 1493942452, + "scheduledPurgeDate": 1501718452, + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942451, + "updated": 1493942451, + "recoverylevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteSecret-example.json new file mode 100644 index 000000000000..768103bcb343 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/DeleteSecret-example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "secret-name": "GetDeletedSecretTest", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedsecrets/GetDeletedSecretTest", + "deletedDate": 1493938433, + "scheduledPurgeDate": 1501714433, + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/GetDeletedSecretTest/b595353d9c39413d80626575b3b5d865", + "attributes": { + "enabled": true, + "created": 1493938433, + "updated": 1493938433, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificate-example.json new file mode 100644 index 000000000000..2d42bf6712d0 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificate-example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "certificate-name": "selfSignedCert01", + "certificate-version": "pending", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/selfSignedCert01/pending", + "issuer": { + "name": "Self" + }, + "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=", + "cancellation_requested": false, + "status": "completed", + "target": "https://testvault1021.vault.azure.net/certificates/selfSignedCert01", + "request_id": "6faacd568ab049a2803861e8dd3ae21f" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateContacts-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateContacts-example.json new file mode 100644 index 000000000000..86006c3ddacb --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateContacts-example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/contacts", + "contacts": [ + { + "email": "admin@contoso.com", + "name": "John Doe", + "phone": "1111111111" + }, + { + "email": "admin@contoso2.com", + "name": "Johnathan Doeman", + "phone": "2222222222" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateIssuer-example.json new file mode 100644 index 000000000000..6fcc751e9c6c --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateIssuer-example.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "issuer-name": "issuer01", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer01", + "provider": "Test", + "credentials": { + "account_id": "keyvaultuser" + }, + "org_details": { + "zip": 0, + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + }, + "attributes": { + "enabled": true, + "created": 1482188806, + "updated": 1482189526 + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateIssuers-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateIssuers-example.json new file mode 100644 index 000000000000..9a6febee49c8 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateIssuers-example.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer01", + "provider": "Test" + }, + { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer02", + "provider": "Test" + }, + { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer03", + "provider": "Test" + } + ], + "nextLink": null + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateOperation-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateOperation-example.json new file mode 100644 index 000000000000..1303793227ac --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateOperation-example.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "certificate-name": "selfSignedCert01", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/selfSignedCert01/pending", + "issuer": { + "name": "Self" + }, + "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=", + "cancellation_requested": false, + "status": "inProgress", + "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.", + "request_id": "6faacd568ab049a2803861e8dd3ae21f" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificatePolicy-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificatePolicy-example.json new file mode 100644 index 000000000000..efb12883e3e8 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificatePolicy-example.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "certificate-name": "updateCert01", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/updateCert01/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297, + "basic_constraints": { + "ca": false + } + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1482188947, + "updated": 1482188947 + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateVersions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateVersions-example.json new file mode 100644 index 000000000000..73e98f8f892b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificateVersions-example.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "certificate-name": "listVersionsCert01", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/listVersionsCert01/002ade539442463aba45c0efb42e3e84", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482189534, + "updated": 1482189534 + } + }, + { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/listVersionsCert01/7fcb3e9eb8bf43f3a6ff4b9c3740801d", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482189532, + "updated": 1482189532 + } + } + ], + "nextLink": null + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificates-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificates-example.json new file mode 100644 index 000000000000..fd7106a1cab2 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetCertificates-example.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://testvault1021.vault.azure.net/certificates/listCert01", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482188987, + "updated": 1482188987 + } + }, + { + "id": "https://testvault1021.vault.azure.net/certificates/listCert02", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482188988, + "updated": 1482188988 + } + } + ], + "nextLink": null + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedCertificate-example.json new file mode 100644 index 000000000000..080e8768615e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedCertificate-example.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "certificate-name": "getDeletedCert", + "api-version": "7.0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedcertificates/getDeletedCert", + "deletedDate": 1493938292, + "scheduledPurgeDate": 1501714292, + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769", + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769", + "sid": "https://kv-sdk-test.vault-int.azure-int.net/secrets/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493938289, + "updated": 1493938291, + "recoverylevel": "Recoverable+Purgeable" + }, + "policy": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/getDeletedCert/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297, + "basic_constraints": { + "ca": false + } + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1493938289, + "updated": 1493938291 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedCertificates-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedCertificates-example.json new file mode 100644 index 000000000000..e084f4d190ae --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedCertificates-example.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "7.0", + "maxresults": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedcertificates/listdeletedcerttest0", + "deletedDate": 1493937659, + "scheduledPurgeDate": 1501713659, + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/listdeletedcerttest0", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493937658, + "updated": 1493937658, + "recoverylevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://kv-sdk-test.vault-int.azure-int.net:443/deletedcertificates?api-version=7.0&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMTIhTURBd01ETTVJV05sY25ScFptbGpZWFJsTDB4SlUxUkVSVXhGVkVWRVEwVlNWRlJGVTFRd0wxQlBURWxEV1NFd01EQXdNamdoT1RrNU9TMHhNaTB6TVZReU16bzFPVG8xT1M0NU9UazVPVGs1V2lFLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedKey-example.json new file mode 100644 index 000000000000..6a5e5fdba65a --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedKey-example.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "key-name": "CreateSoftKeyTest", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedkeys/CreateSoftKeyTest", + "deletedDate": 1493942452, + "scheduledPurgeDate": 1501718452, + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942451, + "updated": 1493942451, + "recoverylevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedKeys-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedKeys-example.json new file mode 100644 index 000000000000..b776d6034bf6 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedKeys-example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "7.0", + "maxresults": "1", + "$skiptoken": "eyJOZXh0TWFya2VyIjoiMiE5MiFNREF3TURJeklXdGxlUzlNU1ZOVVJFVk1SVlJGUkV0RldWUkZVMVF3SVRBd01EQXlPQ0V5TURFM0xUQTFMVEEwVkRJeU9qRTJPakF5TGpnM09URXpOemxhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedkeys/listdeletedkeytest0", + "deletedDate": 1493938031, + "scheduledPurgeDate": 1501714031, + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/listdeletedkeytest0", + "attributes": { + "enabled": true, + "created": 1493938031, + "updated": 1493938031, + "recoverylevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://kv-sdk-test.vault-int.azure-int.net:443/deletedkeys?api-version=7.0&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVSRVZNUlZSRlJFdEZXVlJGVTFRd0x6RkRRa0ZGTkVaQk5qQTBNelJGTmtZNE9FUXdORE5GTkRFM09FUkNPVFE1SVRBd01EQXlPQ0V5TURFM0xUQTFMVEEwVkRJeU9qUTNPakU1TGpVeU1UZ3dPVEZhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedSecret-example.json new file mode 100644 index 000000000000..768103bcb343 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedSecret-example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "secret-name": "GetDeletedSecretTest", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedsecrets/GetDeletedSecretTest", + "deletedDate": 1493938433, + "scheduledPurgeDate": 1501714433, + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/GetDeletedSecretTest/b595353d9c39413d80626575b3b5d865", + "attributes": { + "enabled": true, + "created": 1493938433, + "updated": 1493938433, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedSecrets-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedSecrets-example.json new file mode 100644 index 000000000000..a23c37805a25 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetDeletedSecrets-example.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "7.0", + "maxresults": "1", + "$skiptoken": "eyJOZXh0TWFya2VyIjoiMiExMDAhTURBd01ESTVJWE5sWTNKbGRDOU1TVk5VUkVWTVJWUkZSRk5GUTFKRlZGUkZVMVF3SVRBd01EQXlPQ0V5TURFM0xUQTFMVEEwVkRFNU9qSTFPakU0TGpJNE5qUXdORFZhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedsecrets/listdeletedsecrettest0", + "deletedDate": 1493937855, + "scheduledPurgeDate": 1501713855, + "contentType": "plainText", + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/listdeletedsecrettest0", + "attributes": { + "enabled": true, + "created": 1493937855, + "updated": 1493937855, + "recoverylevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://kv-sdk-test.vault-int.azure-int.net:443/deletedsecrets?api-version=7.0&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExNDQhTURBd01EWXlJWE5sWTNKbGRDOU1TVk5VUkVWTVJWUkZSRk5GUTFKRlZGUkZVMVF3THpZMU16ZERSRVJGTlRJNU5qUkRSa1pDTVRkQ1JVWXhORGszUXpSQ1JEZEVJVEF3TURBeU9DRXlNREUzTFRBMUxUQTBWREl5T2pRME9qUXdMamsxTnpZeE1UbGFJUS0tIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetKey-example.json new file mode 100644 index 000000000000..e0c83a592ace --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetKey-example.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "key-name": "CreateSoftKeyTest", + "key-version": "78deebed173b48e48f55abf87ed4cf71", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942451, + "updated": 1493942451, + "recoverylevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateGetDeleteKeyTest" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetKeyVersions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetKeyVersions-example.json new file mode 100644 index 000000000000..e459e94c94bc --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetKeyVersions-example.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "key-name": "listkeyversionstest", + "api-version": "7.0", + "maxresults": "1", + "$skiptoken": "eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVTMFZaVmtWU1UwbFBUbE5VUlZOVUx6ZERPVVJETmpjM05VUXdSVFF4TnpjNE1qZERORVk1T0VZME9ESkdRekV5SVRBd01EQXlPQ0U1T1RrNUxURXlMVE14VkRJek9qVTVPalU1TGprNU9UazVPVGxhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/listkeyversionstest/7c9dc6775d0e4177827c4f98f482fc12", + "attributes": { + "enabled": true, + "created": 1493937851, + "updated": 1493937851, + "recoverylevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://kv-sdk-test.vault-int.azure-int.net:443/keys/listkeyversionstest/versions?api-version=7.0&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVTMFZaVmtWU1UwbFBUbE5VUlZOVUwwRXdPRUZDUVVVNE1UZ3pNalF5TVRsQ05EUXpPREZFTWpoRVJURkdSVEJESVRBd01EQXlPQ0U1T1RrNUxURXlMVE14VkRJek9qVTVPalU1TGprNU9UazVPVGxhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetKeys-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetKeys-example.json new file mode 100644 index 000000000000..3d74f2aaf566 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetKeys-example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "7.0", + "maxresults": "1", + "$skiptoken": "eyJOZXh0TWFya2VyIjoiMiE4MCFNREF3TURFMElXdGxlUzlUUkV0VVJWTlVTMFZaSVRBd01EQXlPQ0V5TURFM0xUQXlMVEUzVkRBd09qQXhPakEyTGpnd056azBOemhhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/sdktestkey", + "attributes": { + "enabled": true, + "created": 1493937656, + "updated": 1493937656, + "recoverylevel": "Recoverable+Purgeable" + } + } + ], + "nextLink": "https://kv-sdk-test.vault-int.azure-int.net:443/keys?api-version=7.0&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE5NiFNREF3TURJM0lXdGxlUzlWVUVSQlZFVkxSVmxCVkZSU1NVSlZWRVZUVkVWVFZDRXdNREF3TWpnaE1qQXhOeTB3TlMwd05GUXdNVG94TVRveE5pNDNNekE0TnpReVdpRS0iLCJUYXJnZXRMb2NhdGlvbiI6MH0&maxresults=1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetSecret-example.json new file mode 100644 index 000000000000..985cef6f05ff --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetSecret-example.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "secret-name": "mysecretname", + "secret-version": "4387e9f3d6e14c459867679a90fd0f79", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "value": "mysecretvalue", + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79", + "attributes": { + "enabled": true, + "created": 1493938410, + "updated": 1493938410, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetSecretVersions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetSecretVersions-example.json new file mode 100644 index 000000000000..73edf9b0b491 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetSecretVersions-example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "secret-name": "listsecretversionstest", + "api-version": "7.0", + "maxresults": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "https://testvault1021.vault.azure.net/secrets/listsecretversionstest/11a536561da34d6b8b452d880df58f3a", + "attributes": { + "enabled": true, + "created": 1481851699, + "updated": 1481851699 + } + } + ], + "nextLink": "https://testvault1021.vault.azure.net:443/secrets/listsecretversionstest/versions?api-version=7.0&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExNDQhTURBd01EWXlJWE5sWTNKbGRDOU1TVk5VVTBWRFVrVlVWa1ZTVTBsUFRsTlVSVk5VTHpGRU5EazJNa0l4UlVRM09EUkVRa1k0T1RsR016TXpNa1UwTnpZNFFqY3dJVEF3TURBeU9DRTVPVGs1TFRFeUxUTXhWREl6T2pVNU9qVTVMams1T1RrNU9UbGFJUS0tIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetSecrets-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetSecrets-example.json new file mode 100644 index 000000000000..e214cbdadfde --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/GetSecrets-example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "7.0", + "maxresults": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "contentType": "plainText", + "id": "https://testvault1021.vault.azure.net/secrets/listsecrettest0", + "attributes": { + "enabled": true, + "created": 1482189047, + "updated": 1482189047 + } + } + ], + "nextLink": "https://testvault1021.vault.azure.net:443/secrets?api-version=7.0&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE4OCFNREF3TURJeUlYTmxZM0psZEM5TVNWTlVVMFZEVWtWVVZFVlRWREVoTURBd01ESTRJVEl3TVRZdE1USXRNVGxVTWpNNk1UQTZORFV1T0RneE9ERXhNRm9oIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/ImportCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/ImportCertificate-example.json new file mode 100644 index 000000000000..f15deb95abd0 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/ImportCertificate-example.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "certificate-name": "importCert01", + "api-version": "7.0", + "parameters": { + "value": "MIIJOwIBAzCCCPcGCSqGSIb3DQEHAaCCCOgEggjkMIII4DCCBgkGCSqGSIb3DQEHAaCCBfoEggX2MIIF8jCCBe4GCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAj15YH9pOE58AICB9AEggTYLrI+SAru2dBZRQRlJY7XQ3LeLkah2FcRR3dATDshZ2h0IA2oBrkQIdsLyAAWZ32qYR1qkWxLHn9AqXgu27AEbOk35+pITZaiy63YYBkkpR+pDdngZt19Z0PWrGwHEq5z6BHS2GLyyN8SSOCbdzCz7blj3+7IZYoMj4WOPgOm/tQ6U44SFWek46QwN2zeA4i97v7ftNNns27ms52jqfhOvTA9c/wyfZKAY4aKJfYYUmycKjnnRl012ldS2lOkASFt+lu4QCa72IY6ePtRudPCvmzRv2pkLYS6z3cI7omT8nHP3DymNOqLbFqr5O2M1ZYaLC63Q3xt3eVvbcPh3N08D1hHkhz/KDTvkRAQpvrW8ISKmgDdmzN55Pe55xHfSWGB7gPw8sZea57IxFzWHTK2yvTslooWoosmGxanYY2IG/no3EbPOWDKjPZ4ilYJe5JJ2immlxPz+2e2EOCKpDI+7fzQcRz3PTd3BK+budZ8aXX8aW/lOgKS8WmxZoKnOJBNWeTNWQFugmktXfdPHAdxMhjUXqeGQd8wTvZ4EzQNNafovwkI7IV/ZYoa++RGofVR3ZbRSiBNF6TDj/qXFt0wN/CQnsGAmQAGNiN+D4mY7i25dtTu/Jc7OxLdhAUFpHyJpyrYWLfvOiS5WYBeEDHkiPUa/8eZSPA3MXWZR1RiuDvuNqMjct1SSwdXADTtF68l/US1ksU657+XSC+6ly1A/upz+X71+C4Ho6W0751j5ZMT6xKjGh5pee7MVuduxIzXjWIy3YSd0fIT3U0A5NLEvJ9rfkx6JiHjRLx6V1tqsrtT6BsGtmCQR1UCJPLqsKVDvAINx3cPA/CGqr5OX2BGZlAihGmN6n7gv8w4O0k0LPTAe5YefgXN3m9pE867N31GtHVZaJ/UVgDNYS2jused4rw76ZWN41akx2QN0JSeMJqHXqVz6AKfz8ICS/dFnEGyBNpXiMRxrY/QPKi/wONwqsbDxRW7vZRVKs78pBkE0ksaShlZk5GkeayDWC/7Hi/NqUFtIloK9XB3paLxo1DGu5qqaF34jZdktzkXp0uZqpp+FfKZaiovMjt8F7yHCPk+LYpRsU2Cyc9DVoDA6rIgf+uEP4jppgehsxyT0lJHax2t869R2jYdsXwYUXjgwHIV0voj7bJYPGFlFjXOp6ZW86scsHM5xfsGQoK2Fp838VT34SHE1ZXU/puM7rviREHYW72pfpgGZUILQMohuTPnd8tFtAkbrmjLDo+k9xx7HUvgoFTiNNWuq/cRjr70FKNguMMTIrid+HwfmbRoaxENWdLcOTNeascER2a+37UQolKD5ksrPJG6RdNA7O2pzp3micDYRs/+s28cCIxO//J/d4nsgHp6RTuCu4+Jm9k0YTw2Xg75b2cWKrxGnDUgyIlvNPaZTB5QbMid4x44/lE0LLi9kcPQhRgrK07OnnrMgZvVGjt1CLGhKUv7KFc3xV1r1rwKkosxnoG99oCoTQtregcX5rIMjHgkc1IdflGJkZzaWMkYVFOJ4Weynz008i4ddkske5vabZs37Lb8iggUYNBYZyGzalruBgnQyK4fz38Fae4nWYjyildVfgyo/fCePR2ovOfphx9OQJi+M9BoFmPrAg+8ARDZ+R+5yzYuEc9ZoVX7nkp7LTGB3DANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBXBgkqhkiG9w0BCRQxSh5IAGEAOAAwAGQAZgBmADgANgAtAGUAOQA2AGUALQA0ADIAMgA0AC0AYQBhADEAMQAtAGIAZAAxADkANABkADUAYQA2AGIANwA3MF0GCSsGAQQBgjcRATFQHk4ATQBpAGMAcgBvAHMAbwBmAHQAIABTAHQAcgBvAG4AZwAgAEMAcgB5AHAAdABvAGcAcgBhAHAAaABpAGMAIABQAHIAbwB2AGkAZABlAHIwggLPBgkqhkiG9w0BBwagggLAMIICvAIBADCCArUGCSqGSIb3DQEHATAcBgoqhkiG9w0BDAEGMA4ECNX+VL2MxzzWAgIH0ICCAojmRBO+CPfVNUO0s+BVuwhOzikAGNBmQHNChmJ/pyzPbMUbx7tO63eIVSc67iERda2WCEmVwPigaVQkPaumsfp8+L6iV/BMf5RKlyRXcwh0vUdu2Qa7qadD+gFQ2kngf4Dk6vYo2/2HxayuIf6jpwe8vql4ca3ZtWXfuRix2fwgltM0bMz1g59d7x/glTfNqxNlsty0A/rWrPJjNbOPRU2XykLuc3AtlTtYsQ32Zsmu67A7UNBw6tVtkEXlFDqhavEhUEO3dvYqMY+QLxzpZhA0q44ZZ9/ex0X6QAFNK5wuWxCbupHWsgxRwKftrxyszMHsAvNoNcTlqcctee+ecNwTJQa1/MDbnhO6/qHA7cfG1qYDq8Th635vGNMW1w3sVS7l0uEvdayAsBHWTcOC2tlMa5bfHrhY8OEIqj5bN5H9RdFy8G/W239tjDu1OYjBDydiBqzBn8HG1DSj1Pjc0kd/82d4ZU0308KFTC3yGcRad0GnEH0Oi3iEJ9HbriUbfVMbXNHOF+MktWiDVqzndGMKmuJSdfTBKvGFvejAWVO5E4mgLvoaMmbchc3BO7sLeraHnJN5hvMBaLcQI38N86mUfTR8AP6AJ9c2k514KaDLclm4z6J8dMz60nUeo5D3YD09G6BavFHxSvJ8MF0Lu5zOFzEePDRFm9mH8W0N/sFlIaYfD/GWU/w44mQucjaBk95YtqOGRIj58tGDWr8iUdHwaYKGqU24zGeRae9DhFXPzZshV1ZGsBQFRaoYkyLAwdJWIXTi+c37YaC8FRSEnnNmS79Dou1Kc3BvK4EYKAD2KxjtUebrV174gD0Q+9YuJ0GXOTspBvCFd5VT2Rw5zDNrA/J3F5fMCk4wOzAfMAcGBSsOAwIaBBSxgh2xyF+88V4vAffBmZXv8Txt4AQU4O/NX4MjxSodbE7ApNAMIvrtREwCAgfQ", + "pwd": "123", + "policy": { + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "sid": "https://kv-sdk-test.vault-int.azure-int.net/secrets/importCert01/f00e72f0ddee4dddadc27c0f605d84d7", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493938557, + "updated": 1493938557, + "recoverylevel": "Recoverable+Purgeable" + }, + "policy": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/importCert01/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297, + "basic_constraints": { + "ca": false + } + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1493938557, + "updated": 1493938557 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/ImportKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/ImportKey-example.json new file mode 100644 index 000000000000..4577dad04a41 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/ImportKey-example.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "key-name": "ImportSoftKeyTest", + "api-version": "7.0", + "parameters": { + "key": { + "kty": "RSA", + "n": "nKAwarTrOpzd1hhH4cQNdVTgRF-b0ubPD8ZNVf0UXjb62QuAk3Dn68ESThcF7SoDYRx2QVcfoMC9WCcuQUQDieJF-lvJTSer1TwH72NBovwKlHvrXqEI0a6_uVYY5n-soGt7qFZNbwQLdWWA6PrbqTLIkv6r01dcuhTiQQAn6OWEa0JbFvWfF1kILQIaSBBBaaQ4R7hZs7-VQTHGD7J1xGteof4gw2VTiwNdcE8p5UG5b6S9KQwAeET4yB4KFPwQ3TDdzxJQ89mwYVi_sgAIggN54hTq4oEKYJHBOMtFGIN0_HQ60ZSUnpOi87xNC-8VFqnv4rfTQ7nkK6XMvjMVfw", + "e": "AQAB", + "d": "GeT1_D5LAZa7qlC7WZ0DKJnOth8kcPrN0urTEFtWCbmHQWkAad_px_VUpGp0BWDDzENbXbQcu4QCCdf4crve5eXt8dVI86OSah-RpEdBq8OFsETIhg2Tmq8MbYTJexoynRcIC62xAaCmkFMmu931gQSvWnYWTEuOPgmD2oE_F-bP9TFlGRc69a6MSbtcSRyFTsd5KsUr40QS4zf2W4kZCOWejyLuxk88SXgUqcJx86Ulc1Ol1KkTBLadvReAZCyCMwKBlNRGw46BU_iK0vK7rTD9fmEd639Gjti6eLpnyQYpnVe8uGgwVU1fHBkAKyapWoEG6VMhMntcrvgukKLIsQ", + "dp": "ZGnmWx-Nca71z9a9vvT4g02iv3S-3kSgmhl8JST09YQwK8tfiK7nXnNMtXJi2K4dLKKnLicGtCzB6W3mXdLcP2SUOWDOeStoBt8HEBT4MrI1psCKqnBum78WkHju90rBFj99amkP6UeQy5EASAzgmKQu2nUaUnRV0lYP8LHMCkE", + "dq": "dtpke0foFs04hPS6XYLA5lc7-1MAHfZKN4CkMAofwDqPmRQzCxpDJUk0gMWGJEdU_Lqfbg22Py44cci0dczH36NW3UU5BL86T2_SPPDOuyX7kDscrIJCdowxQCGJHGRBEozM_uTL46wu6UnUIv7m7cuGgodJyZBcdwpo6ziFink", + "qi": "Y9KD5GaHkAYmAqpOfAQUMr71QuAAaBb0APzMuUvoEYw39PD3_vJeh9HZ15QmJ8zCX10-nlzUB-bWwvK-rGcJXbK4pArilr5MiaYv7e8h5eW2zs2_itDJ6Oebi-wVbMhg7DvUTBbkCvPhhIedE4UlDQmMYP7RhzVVs7SfmkGs_DQ", + "p": "v1jeCPnuJQM2PW2690Q9KJk0Ulok8VFGjkcHUHVi3orKdy7y_TCIWM6ZGvgFzI6abinzYbTEPKV4wFdMAwvOWmawXj5YrsoeB44_HXJ0ak_5_iP6XXR8MLGXbd0ZqsxvAZyzMj9vyle7EN2cBod6aenI2QZoRDucPvjPwZsZotk", + "q": "0Yv-Dj6qnvx_LL70lUnKA6MgHE_bUC4drl5ZNDDsUdUUYfxIK4G1rGU45kHGtp-Qg-Uyf9s52ywLylhcVE3jfbjOgEozlSwKyhqfXkLpMLWHqOKj9fcfYd4PWKPOgpzWsqjA6fJbBUMYo0CU2G9cWCtVodO7sBJVSIZunWrAlBc" + }, + "tags": { + "purpose": "unit test" + } + } + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/ImportSoftKeyTest/2eb4a15d74184c6f84159c3ca90f0f4b", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "nKAwarTrOpzd1hhH4cQNdVTgRF-b0ubPD8ZNVf0UXjb62QuAk3Dn68ESThcF7SoDYRx2QVcfoMC9WCcuQUQDieJF-lvJTSer1TwH72NBovwKlHvrXqEI0a6_uVYY5n-soGt7qFZNbwQLdWWA6PrbqTLIkv6r01dcuhTiQQAn6OWEa0JbFvWfF1kILQIaSBBBaaQ4R7hZs7-VQTHGD7J1xGteof4gw2VTiwNdcE8p5UG5b6S9KQwAeET4yB4KFPwQ3TDdzxJQ89mwYVi_sgAIggN54hTq4oEKYJHBOMtFGIN0_HQ60ZSUnpOi87xNC-8VFqnv4rfTQ7nkK6XMvjMVfw", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493942691, + "updated": 1493942691, + "recoverylevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/MergeCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/MergeCertificate-example.json new file mode 100644 index 000000000000..5c046b059ac7 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/MergeCertificate-example.json @@ -0,0 +1,70 @@ +{ + "parameters":{ + "certificate-name":"testcert", + "api-version":"7.0", + "parameters":{ + "x5c":[ + "MIICxTCCAb....trimmed for brevitiy...EPAQj8=" + ] + } + }, + "responses":{ + "201":{ + "body":{ + "id":"https://mykeyvault.vault.azure.net/certificates/mycert1/f366e1a9dd774288ad84a45a5f620352", + "kid":"https:// mykeyvault.vault.azure.net/keys/mycert1/f366e1a9dd774288ad84a45a5f620352", + "sid":" mykeyvault.vault.azure.net/secrets/mycert1/f366e1a9dd774288ad84a45a5f620352", + "cer":"……de34534……", + "x5t":"n14q2wbvyXr71Pcb58NivuiwJKk", + "attributes":{ + "enabled":true, + "exp":1530394215, + "nbf":1435699215, + "created":1435699919, + "updated":1435699919 + }, + "pending":{ + "id":"https:// mykeyvault.vault.azure.net/certificates/mycert1/pending" + }, + "policy":{ + "id":"https:// mykeyvault.vault.azure.net/certificates/mycert1/policy", + "key_props":{ + "exportable":false, + "kty":"RSA", + "key_size":2048, + "reuse_key":false + }, + "secret_props":{ + "contentType":"application/x-pkcs12" + }, + "x509_props":{ + "subject":"CN=Mycert1", + "ekus":[ + "1.3.6.1.5.5.7.3.1", + "1.3.6.1.5.5.7.3.2" + ], + "validity_months":12 + }, + "lifetime_actions":[ + { + "trigger":{ + "lifetime_percentage":80 + }, + "action":{ + "action_type":"EmailContacts" + } + } + ], + "issuer":{ + "name":"Unknown" + }, + "attributes":{ + "enabled":true, + "created":1435699811, + "updated":1435699811 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/PurgeDeletedCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/PurgeDeletedCertificate-example.json new file mode 100644 index 000000000000..c609bf58f407 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/PurgeDeletedCertificate-example.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "certificate-name": "deletedcertificates", + "api-version": "7.0" + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/PurgeDeletedKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/PurgeDeletedKey-example.json new file mode 100644 index 000000000000..b1c7c149998a --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/PurgeDeletedKey-example.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "key-name": "testdeletedkey", + "api-version": "7.0" + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/PurgeDeletedSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/PurgeDeletedSecret-example.json new file mode 100644 index 000000000000..a12ecfc2dfeb --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/PurgeDeletedSecret-example.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "secret-name": "testsecret", + "api-version": "7.0" + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RecoverDeletedCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RecoverDeletedCertificate-example.json new file mode 100644 index 000000000000..a6ae8b7312c7 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RecoverDeletedCertificate-example.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "certificate-name": "CertCreateDeleteRecoverPurgeTest", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d", + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d", + "sid": "https://kv-sdk-test.vault-int.azure-int.net/secrets/CertCreateDeleteRecoverPurgeTest/9ff2572a2c3145679057da8b7f6a4b1d", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1493938486, + "updated": 1493938486, + "recoverylevel": "Recoverable+Purgeable" + }, + "policy": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/CertCreateDeleteRecoverPurgeTest/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297, + "basic_constraints": { + "ca": false + } + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Unknown" + }, + "attributes": { + "enabled": true, + "created": 1493938486, + "updated": 1493938486 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RecoverDeletedKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RecoverDeletedKey-example.json new file mode 100644 index 000000000000..fd15df28c368 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RecoverDeletedKey-example.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "key-name": "CreateDeleteRecoverPurgeTest", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/CreateDeleteRecoverPurgeTest/6fc2be54c6be4a7ea7bbb8a2a99a1996", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "v-SWMCmPNKoK_rB_pNXUl6Iwh9Kqd3XzQlh6SXi_slBishqP7pyKEFjNbUvMSlyvPt21rJupLbJr-yhsK2Rq2V6O0doGuCsoadgNGih1aVAuUJAJls1-b-G1IJjD18ArM4RitnCvJmQFqyK2RVHa3EpEfaQW4gcRrsRAhiJDjc1L1S3skdt-E_rZfL7DIh1ZtqFyQAqIWSAG0BXDdbgfEx1kJKqH-HRokDKeMCIaJtKZof6e-DJr3e9Iy8aAR7V-BsZ7vY7JMjyeEukMzEji4MEsIyOESL67DgFllDEi4OM_3WKyxr6uXxzHDzmppWsk2ykLsYA_ALLnR3ZNZCuL9Q", + "e": "AQAB" + }, + "attributes": { + "enabled": true, + "created": 1493938342, + "updated": 1493938342, + "recoverylevel": "Recoverable+Purgeable" + }, + "tags": { + "purpose": "unit test", + "test name ": "CreateDeleteRecoverPurgeTest" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RecoverDeletedSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RecoverDeletedSecret-example.json new file mode 100644 index 000000000000..58f264b2e79f --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RecoverDeletedSecret-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "secret-name": "SecretCreateDeleteRecoverPurgeTest", + "api-version": "7.0" + }, + "responses": { + "200": { + "body": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/SecretCreateDeleteRecoverPurgeTest/16f5f7feb7004280b7f3b8ac50cd01f9", + "attributes": { + "enabled": true, + "created": 1493937960, + "updated": 1493937960, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RestoreCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RestoreCertificate-example.json new file mode 100644 index 000000000000..a96d63aa61e3 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RestoreCertificate-example.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "certificateName": "testcert", + "api-version": "7.0", + "value": "JkF6dXJlS2V5VmF1bHRLZXlCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUkwTXpnMVlqQTNZaTFrTlRRM0xUUXlaVFV0WVdVNVpTMDJNVEJrWXpNNVpHWmhaamdpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLm85bmpNWEFSZWVla2NaRXBsVTNjdUxQcVZlWmxFbGRDM01XOWpYR0h6bnBXRTdHRGVOSXJraGZscHdTWXFnQnBYQkozMFpUQkRpRmpROENXSnJfUGlsUWNDRkZyN0xrdWJhWUs0TW1zcVh5WGIzbkRJcUJkQmZIUVNpZ1ZET0J5Ym9sUlRNNDYzYjBTbXhLVzJheEdFS2NuZzQ5WFkycG1SR0Vrb0plcHJWZ0tyRkpOUGQ3cGJIS3hQSWdDOFlnT2xudnZxR280RlRDSzh0ZWotcUt2UzBfRGV6Uk5vdTZqZ25SekpxX0g2NGxWMk1hQ0NnUy0xbTlyOGVOTVVvSlhTV1hwc0lneng1RzdEbzIya1ZEY25vMW9rajlCMXNvbklkWmtuY1JybDJBVHNRZVlzZXdkUVd1VmhxRzVLN0pNQWo5YzBRdkxhTmlpdl9PY2pFcm5qUS4zbmI4azJ3SEcyNHFJelNNb184WG13LnJzc3NMNjJ1aUNfTm9IbG5zQlgzcEEtck1uY3g5R3V2NmJYSHpKamxwOWNMUnVaSDBSWlJYVXRwU3BPQWdyZ20tU3BxeEdWSjd2bmprbV9FSzJwYy1sZHNjUWtRSDB4bVFVcGZFNzN5b1VTYTNXVVNMS2VIVnJLdUg5MUtJR0tLODE5ejc5d1Y5Y0F3UjlzcHJxbFFWZnlKdlNFM2tnZTh1RVBpRFFVMFl5WnJqVjBsMGJCU3VkeTN1MVlsVHB6Wk1EWmpUcE05ZGtMclgtaGdxZ1FGa2xFa1hNRWlzd0RDZVM3Y3J2bFg1bnVzbWh5SkZCMklCd3dxNWJieHptV1diU3JOc3lFMmJmWEpXOWN4TFlQcnJJZFpfbkd0X29RSGVQcUFZTS1iVnpTdzdBRGJjMU15NTZwclBGLW9PSm40MHptOTBaaFBTVGMyQXNKRGFBa3R5WFU4WktOYUhFVUlHLWI1SGhUdFBuZ20wN0FrWEtQNngwaDhzZ3ZIaGdCeGpfdWRfQVpQc3pLWG1HdUhFTW9lRGhpT3NkQVdRR0pwR2t0NHVlbmZyamNSeXVlaXJiTC1RV3o4MEtZUnk1QklxbzVJc19RVHpWN2dqMGstYS0td24tazNsNTJ4YjhaNkRXd2tWZ3hqUlNXOXZnV0pVd2U5M1ZrVWtHM3NLRW5SOE9ueTNjWlhQVl9LbWtBTEdlR0ZzQm53SmQwY3dueTBCN2I5VWQyQ19kWEZ0N1BvbnFVNldfT016cC1Nb1NtRzRHbEFpUkVfQ3FrWlhkalhIMVItSmpObUNfdXlPUTdaN1BVaDAtNmd2YUxpcE1CamlWR1FwdzlEZDhmVmtCbWk4VW5uOUxPYXJmSXVtcEJyUE43TTJhM05KdjN6b0NkanhZVFVUMTN1aElpYWl3aExoUFZhT2pUbFRmTkpqbHhIbG5lbGJ1RWJsZTk0bVV1bW8wcjhKRlFMSDdfRjhXMVo0OC1BcjhYYXJwMXhIY0FReHk1WWYwclktdUU1dTAyRnRHUHlPZ0JfNV9WdFlNR2VfRE1mdENLOGVMZGFnVllMRDJDNDUxTldZeVVfeHdNUWdQbXBaMWFnSEdCb2s0ejhsSFBndVhCQ3R2WFFuTHBXQTVBamdOLWNoWjNwUGJmc2RkNjBhekJuWDVaVXQza2hYaWNDdWk4b0xidEtzQUdmckNOZzFwT2Q0MHBHMEJlVy1lNVE1WWQydjY4eFh5a2RiTXhFblFCM3Fzd1djVlh1QXBIR18wREZVVmZvSlc2aVBZcDNWVE51amM5M3QtMDcxWnlZbUZ4V0RfVThMYTAtM19RLV8yZ0pwMVBaVV8tMVBRM1huLXdSWk1vb3JkZGZQa1VPZ0lqdWkwa1IwZWt5RjZvdWdLNnJrSVZHaGp3YUp0ekdKczJLdGxncnRCcEs2MXZEaE5zbFR5VHU5OUp2T2RFTXhwRG5lTEg4NnlvVnhxT3lIT3lxNjByXzdpTHgtdy03Q3FzWTloT3dmQlBZZ3BQVlM2bm9oZVBocTkwaGJTX0lrM21YbnRkRUNMREtSMi1wWFh6bjlPRjZIN09EdHB4S0VXQkdCaHJ0Ykxmd2JZS3dmWmZSVTJVUHpkLUxFd1lQdDloU203Z3lSODNoYkZiSFNBV1cySncxRWl1c3FURWRsRW1lQ3k2cFp1MVFZWko0TUQ0OG5rVXMwdmVHUVhTU2Ytb2RhQm1fYjZZdVh1cWcyWk03MlZjUTd4ZzV4MmpFenFqcllmdjdTTGJINFZBcWp0aFg5LUdRaWEwWEZaS18xempIenhkd1B0R2lSOHJfMkFFZTgtRXFoNi1FaTZKdjRFZjYyMnRrNWFJUWx3R1pETWpGSVNuUkpRdV8xcnJiY1E3enZsbWhUSWFQcUJNRFVxeHBEOXNWUlhuSHdIaTl1b1BCUTllbWJIMkV5WDV6MEhWRXlDa1JEbUd3cmR2RGdsOFVzMUhURjVwYXlYZmF2WkZUZjl3WFZyQXpsRFBEQkFJVFMzWnVJMEJWR2pJUGV1SnRiako4S1pTczRFQVNRRTVyVjViTUpNQXcwa19nYkVRTEZGSjJVb0ZzcWU1QUszM2xGXzR5cGMxU0JaWjJfUzYtbEQyNkpyRFVJSjFFRmJhbWtoUk12bWJIT1Utc0hDT0lRcHdadlJzV3Q3NExSQ1ZyQ09jMGpUdE5TT1JPUW5XRHVXRlFXSzk1TkRGMG96WjIyLVFEMU9YOE9iU3daaHdOXzNfS1pHRmtVMEhNdzNjSTI5LWUxbFltRDV3cmJ0ZlRFbllOeHJKOGpuUWFBY2FoNy14Q0JKeUQ3elo1MXIzRVVyY2VnazBzc1dLeHRPVjRLcTZENmxuVmU3bFpUT1dfTU5aZi1JSzJUbnZCaVZIMHk0SkVGaUxzSDJHbTM1d28yYlZVaXJsT1ljVEk1NlZhdDhMRWhGaEotVlUyNk84NHo2dUJFZmJucEZLbmdKc3pfYVlucW1zNWV1bmd3ek5ndjdlT0U0cUdKSURyMTRBUXRWdEYxcWdrZHNnVllWVXg4U29SQ0NobE5VUzRNRGxhc1hwS1VmV19ENWIxbDRkbXZiNEZNRHJqakJ6djk5dGJSeGZFYUVOSFlYTHZFZnJ0b0pMeW9na2tmNkxlbVoxVDZRbnRtNlR4S1IycU81WU1vMnRJZHlQNmZNRmkweEYtdE1IaHNSdVN3VEpybW1nREcteHVpZllVNkpfaElSNkMzVmo2VkFMMW1oZy0xeW1pRXZuanVLbElONzc4NmFWdVNpNmx5TjJJNzZqY0R6SHZ0VW1ibkVvWWtORHNPQXdqQk9MNFBlS0VjR1hWcm5YNDJhNW5IRWM2cmZQdjZ0Q2tVSUI0UldIdzEyUTFiNDM2N1JvRS1PTWN3TnV6ampob1M0S1ZJbHo4UEFMOW9YYTR4NXlQeG1aVzZ0UUVna1pKeFhEcS00SWRtd1UzTnpVZUoxdGpNaXFsc0xRWDdlc29fTHRtTWJ3bm83YkI3bjRlVnZ4aUtQU3p3dW94c25aaGs1b3ZSSE1xU0NtZjU2MjJvUTZvWEdmNUJLWExlQWdqaE1Sd21razEtUzlGajlyc1hlT19VYjJOMF9hVEFLemlidXIxNVcxaHI3Wk1PVFlxOFlSSGVPaWxSX3Bkdjl5NTlDRDQ1WmE0ZXFURHVrNmRxZ1d4YnoyVVVtMnpwM3pvTHVKSVZ1Y3FIaUVRTVNfMnFKcy1xQTAwT2FFY3huZTM2Q1RsZVNwZjF5cjh2VjNWNW1mQU5zRnJBa21CMnBRWTNfZ21UbldTYTJ3UWlMa2RFRllPSExTeEk5UVowNHo4ZFRfbW5QMmIwWV96N3ZLa0VGQmFpNU02UFdPWjVIOUx1M3Rnay1fR0g0ODd6ZHpuQm0weWZZY3ZIOHJUd1QyQl9UZVRFMG4xcWFRdDRiQ0diUkFQNE1DTDl0SGlIcmlzWEllejQzZlZ3b1c4R2x4YmxKanlLWkpXbmlRNjlBYks3SmYyUER6d2NVSHhkZU5HNGxEZmt6WmFxU2lybGRzZlhXOHBGLWZ6WFVVWHR4eDF4Um5nQ1hJVkxLbU5ZbV9CNnNrNGo0VzROVFMwQTBOcFhsZGJCWjZWWmFDMDNvRHVGUFY0MGtwdWQ0WEd3Q1l3M244ZjFHb0Z6Sk42QjFqOTRLeTdtNE5YT1JsQ3ZaRW5qZTl6T241T1d1ZG9USWRoRzBobXVDUTZ6TXI2YkVaTUFoV1ZFdlREY19iXzZsOWdLWmVxNmVtekxvcmptOEQzLXcyLXRBYlE2Tmpjd0J3eEhMZzlCRllRRFdvaU9UVmJKN2VBcUVFMHVxVkhBcE9KbFVIc2tmQy1uV3NzOV9fRTFURHBLcjRfRE93NFhPUGNzT3dlVU9EUWg3cVFXRE1ZcDVHU1poVWE4MVVHczhmemZKU3JPbmtaTmRVTS10Y0h3R01mX3didy11dmt4UFUtV0tvNUNqR2M2aU5KMDB4MjZZdUpCWXd6TVFyeDBJQWgxMjVBWlozX2FvaFFpLWw3a1pZVE82Q0JVOVZsYllNMndrZXp4ZGhrQ1oxd080Z1NNbDlKU3A5ejhxNV84SU1WM1pma00xV1VqSGZMQk4xRXdFMjRxZFVzcWxyU3NZN1hQaVlpcXQ5ZktXVmZDTWw4RU0yd2ZHYlhxMUI4eWl2UlpMcko0eEk2MUdVUWJFVGU4akNTYTF2aUxxZ0FIa25IYjVjVHIwbDRhTW1EZGZKWnJxZEdpb1lPb2IwdHBuc3IxanRfZm1obGhJa1NSQnREUk5XWEU1OXBjVXlULXpyVjBxZl9sOHN2TlNEV2N3d09YQ3lITWZzLWw0T29xMldVWTVLQi1nSG1HYUJod0oxa19ra3V2S0hlMl9TY0loc3JjTXV1eW5aLW14Vzl5NHBBS3pvdVFsQjR0ZGZvbHdSRk5KX0tHYWJPZXJiWFdDT0ZTd0JVTjdNaG0wOXNyVS1VWG5od1IwdTYyTjVvMDlfbGN5eThnWDg1ZUVrenhuOGZ2NHd2T0Y2dUd1cFk5UGxpSTRLMTNqSHlOd0ZuY2VmRlp2b0dxVlhkcUg5RGJkYS0zY1FhbVFlNmlMek0wRDlnLXlFc2NBTkpKS3ltelVzemZZdV8yY0p0TEhsd0I3NVhLeW1EMG9nUkRvRkRwTmNPd1dRRUlwdVJwU0pfdWtzR2EwZkd3MGVBTU4tQmc1OUs3emhRWHJISUZOckN1S1VPMVdvTkV5WkM2UGlKSUwtUlRsTFQ2WlBNZmdSZzZiUl9aQk43X2dseHBIakNDaFZXMkZ3MnJFUDJJX1pSeHFqdS1WbmVwV2o4eU1CaHZXZzdXNm9QWm1odmVtUTBkQUljNVZTbVVaelhvNFVURmJxSFN2MGlyVTNscVk2eUl1MGRPd2t2MlF4ZENfQVdRUmdLSGRUeG1xYXFUSXJwclZyUHZ1MDFQSGlFbVRnaDZZVEZ6Yllqb3JEeFExWDhlTUN5Rl80cWNjMnhOdTJRblBIdUR0RGZkSy1NV2xJUDhHUEhSMmhPMjlCa0JJSEM4TlgxZmxDN1ZSZkZsQ09McGVIeWl0MGRSd1d2S2tieGNIWl9fRE5ZLVBNQlZMZGpyR3lxT2JoQnpQZHZMeFpXWVU3THNRbnM1dmxiMTc5YXczX3VmclRIWGs0MVpjaDY2ekFRRl9tekQ3ZEVuMm1fb2tBaTh6NTRwdzdxUDAwNHkzenNPd0RmR0htYWF2c3dGMW5NMUN2YXhXajRINE45dVNUaV9DM1oza3lTRHlUNGdUZjNqc0FKUEJybXdSQVBpaU5PTTU3c0x2Y3dJRk9ENnA5QkdWbjFwbjQyZGRTU3A1M3JieTZEcnlwcHdDaDFrampQX3lCbTZRZnd6MElGUWJiSG1zVDNVa2RMb1dURjFSMF9sbjJtR1kxU0hHT2o3VHl1YnQ5d2xLVW5nczVMTWhVcHo3NU1LR3F6UkFnWXNKcHVKUVl1RVpKeGFPSHNmY2VwakdrcFdoMEtfWkhZUEJESzIwOFVqb3FqMDdlVVVueTBaXzJrNXUxTjQzWGJ3V0ZvWVBhdndheW1MYkhWdkRwbzdwMU9JT1IyNkt0SzdPeGlnZ0ZybGVISWNaODFwQzRCdlNzRnZsY1BCZEpHLTZxWTU0Q3J0R2xhaDRvQWplUXgxWS1YU0NLNnZLYUIwWnZHc2lIajhRQ0ZURjRuLUJqTWIzWDcycDJ5Q0tPRlpMRk5qcVR1aHJoYXNnMi1pWTNOTWdwVEQ5eVBSdjA2X1VpcEVfYjVsQ0R0Mmx5QU5NYVpZR1RvSmJTSVhBcFlyU1hEM1dFWllhTGUzQmFSUEJUYTAyeWpyVFZPRDRGNHRFR3c5MkZJZThOSk5NYXRXMFhPSFAwVWxKTXlQUDF2MVdvOUh5aFllaDFfdWg3SlRLcS1hWnJjOS1Xd0ItQXBKTHBQeGxmRzlGZkgwdjNwSTl0Z1VndWJmSkJQVjMwNll2MlNqQ0M2MmVYN3VFTUgzcXQ3TmFYcFVsNXZEVHpfMF9Vc3VlWERQcDNqV01XQTMwenFaYTRFT0dXdElMb0tEM1RjRWNVcmJONGV1bHFQSkFNcWdWdmk2YWRGdTgxU2w5cU1rVVUwaWpqMjZhZDFaeVlEUUZtWlJ4NjJYUW9ZdG81bXJ0eFZhYWtNNndqbkVPSUdJaHhBTnJoX0dNVzVxREhzMEV6TDU4b3lOY0Q5dE1MUC03N1FCbTZwUTFsR0swMVJ6Y3FzTk14ZzRMTzl2ZHQ3NFpIdEhMXzA1TjF2TUt4TE5GbkdhZmwxN1E0eEM0Z3NQeXpYdzBjcklyV2tIQlNQX0NoWE94SmZORWdyNjJOMXEzQVJZa0U1TVlCbzctM3djb3dNT09GcTlrakN1ZGpoekplRjRTUHdfMnFVWVhZRTZsNXJTYjYwUFlFSkJxdW82Skh5ZmdlOXFJX0Rzdmg4eEY1STJfLWtLT2pxU3FZam02NjU0cXVES3phQ3JWLUJFLWtQNF9DOU5OQ0xTaEVWUV92Z3hYdDhzbTRWNGNRMElDRmFzaWV6VnNuV1QtYmRQTGxBT2RqOS15RmhYVTRUYVF3YnZqQ0E2UHQ0aDNVWGdnQzNqWU5IMmJtRGpYSzhFdFJYRTV6cmJsTDRKMFZ1OGxHQVBZaGtOcGNOakNrNWhSSW5jT0dybE9aUk9jdTdSeVczR2JWM2Y1MGJKN0xLNHJjMnJCMTZuemhBdk41WXlydWdwQzdCOE9OR3NTY25ha1V1alJzRzZGYVpydDNzTDJMOW5RTUNoNE9INFF3VWpKWFZKUFJ2MHhPTF9jVEQtdjk0QWgwbWdtcFJ2Q1dhUkl5MXRxeDZHTmZ1R1Nyb0tObmtHYjRiRE1oblpZMmwxQWluWHlCMG5uRGlvci1EUmo1cjhRZi1iaUR6cGhTallzZTZrakdLR0ZObzU4WjFfaGxEaGFob1pQX1lRdlBtWi1Tb2pNaGhMRXZqMXEyZzZWRVd6a1FDWTdIWVEwM1Y3cHVCVm4yaXM1NXpBSGV4cGpERWoxWDgxWU92bnVTdXRhMGx3VkFEMkRoNjZDcmM2VVh2SEtUZTBCeFlsQWdVdkhQc1BkSy1OdVk4S3RaeGNqTWNDVWM0OVl6VW43RVBTamFNaHJ2Ni1mM0pwc09Na3JwREpLM0dPTUVRMUV4cnhYV1lGaGtLaHR2UXZkMXZCVS12b0pRcWJveU9vS1hMM29Xb0FRVnljWlR3Y2laeW4wbUtkVF96NDNFZGhNcDNKS3N5blJ3OVZtSzk3Q3lldGl5LV9HaWVMSngtWDladVMzOUdNa0YxaFVmYmkyc3FJZGZMZ0diem5uMTluTlRVUDlOR3dhaWhybU9Ib1lZeUJ6WE4tby1UWUxhSS01bkNuQ2FSSW9QTF9XSVhyWDZPSzdZU21IWjk4a2xJS19JNTlPSXlWSllrMVh6bGVwd1lPLXUwU0x6bTEtN0dKSE54RGVOMlZhUEk3TThVem10X0x5alliWWxocFFJQnNyUktsMmZZeExKaGt6Q3NjcWp2bVhDemRLVDNhNFV3NDJ4eDlsOWl6dFQ0UmtnV21fYV9YWWk0b0gwdjNCUXRSZ3NfUTBPaGo2T2Y2dEtyZU5XZmcxVDRjMk01SERJd3UxTkl2QXBqNzZtOXJWQkdPWTZFUnhfa2Y3d2twb1g5dWRvcjBCbEx4a1FCc0lwZXpUdzc1MTBncU81Nm1UWXlBUzFCUVdOY1Q2aWhfN3F4ZTVoUkVlZVB5YUpFMnhqR2JNWGg3V1hGYjN0ejVWVWJOTFpxMjBiM3E0UFdkdjJXX1Foc2VUY0JTRDY1eVFPYndTai1UcVpNNi1teUZHb3B6dVdfRWcxU3pzNzRaY3RMSUxyN3pMLXRyeC1WTTVfVHllMVZXbG9ZOTZVYUJyUktpQWU1SVhKMlBQd2RIY1p4SWx4N3dBRXdueXVOZXA2b2NKcXRwZUJ1elB0LTFaX3UyWjZrQmR4V0lpYlVEaGxOU3AxM1NkTGw0Z2hkemVqZWFaYVllRDVtTGltWWJ4dEhsQ1ZiTm0yNU1ZbDYxMFU3QlZnNVJJSXB6VUdmZ2Z5NnpJRzRLQjBMR3BISzNhdHRRUExvQ1VlTDRYNVdBUUFsb3BRa0RKOU5lTHFGdHN4cWpZaGJnZ1Z5am9ScjNPOVhzYzlJVEtVaXJaUDlyTVl0eFduT0tUck9YYVk2WVR2Wi05QUhpT3ZfdTRhOElTS01DVng3OUlnXzdqTjFfREhjdGd5cEEzVnpkbjNKdlJJQTlfbHZDV2dTSS1NUjlPQ19xekhIUmU5dENqWklDVzhwRURSYVhZOHc4UUQ0bXJicmFLTTNsWmtTNUF2NVp2WjFRTDJlZkExbXlJdmN2czhmekxRUFM0Nm0xX3ZPVzcxN05ydDQzeUcwbUZxZnk4aExaZEUzQ2RkMzRtVVFXWVdqSkdvQXZ0VHBXRmpwWkwwOERjQUd0RzVzdkU0Mi1WWjRqSVVYQ2JsemZaczl3N2VsNThvRkJLUng5dUJLby1PWmYxTVloVEZrSlU1V3YtUEVreXRPSVpfU09nZVM2RTVMTUZsOVpZenZ0QkJuWWF0bDY4NGpEdWx0STh4LXpmSHdwUEFwNk9CQVpxalk3S3JoSVJuVGRoc2Y1VUpCcmtvU1JGUFlaaXE4RjJLWHA2Nm1PbDMyRm5RTVprMUlDVkxiYVpnUFlWNnl5UXpZdEdhbjhOc3BFTG10RWkwMVlTZE1ySUxkUF9TVTZwXzJ1NU1oY0RPMDF0Y2hwMHp6eUVfTVp4YWJodXpMWUVIeXJvYl83cjFKdWNjZUQ4SlM5T3JBdEk1YXdsbEhGSFRRWExOWGJuTHdTQ2JrdHNiTGFoa05ya0ZXR1RDNFRzUlBfYTlHMVhFTE5DRkhaMVhvS3NsQTdMMzFGaWpyNFpEYjRQeW5hT1BrSlhCcEx6MGNLN2FmeFVxNWlySHhZNEQyVkdNT3gwUmc5UEJJeE1vdzN6TmVGZ3Y5dzRTdkJ5VUpQdjNGV3huX004M3g5dldiWFh3bU9LbHlLNVpWQi11LWxKVno5Rm81YWRfVEtwUkxqSGdNWURKNU9Ka2dhaEFQMmhOaG9lb0FicnBPNzVYT2tYZ3pONDdwVW1kdzhmZV9FN3ZSeUREZi1LNVZNS2UzOXRPSi0xRmxtemJVc0pET0lScHp5WVl0Y2Q4cGtPU3JQYnIzMWdJNFRIUjJHV2xwZWJCZ3VhYmppck9UTjI1Zy02MmRPWWVKNHVwNjI3MjdnbWNQWF9EYmJfSFdrTnVLaXBmdkJ1UmVNN2J1WE9LVzg2bllHSW5ZNzJZZ2lvYVpIaEJnY3pHbktuUUlkWTJ2U3NzQ3E2b1FSUGJqeHRQZ1gxT1h2bXNucmNBencwN01ULTNueWF1RDBfNG90RGJueF92dm1fM203ajBwcjBGUWZ6NWs1UEVNUG1sOFVhenFxX2xEU3djV2JOU21JbWF3OWt3U2NXN2xrOUViNTRLRTRhaWt2bVRxXzRuN3lkSDNQblI3bC1RMXE2X2k5VWdHUVFfSmk5UDZQbmszQzd6TTVYbDBpYllEVXVUV2FUdlRrX2ZjaXo0VUJXWkV1T0lLU2xZaHVBVzFQUTJPU3NiUWxPbDU4U3ZvTEYtS2w3TmNkRXRBODJVWjdkLVFCN2xKNWFCcnd0Vmx6TDFxX2Y1UGd6a2NtcW1pLVViM2tUQ0xlNjJYbzN1MmFvSnNTQ0c4bXhwZkJ6dVFVVkk3WXdTa2ktWUtNUnlJSGhuOG9xRDNQS0xMbHk2LVZkZy1VREE1RWhhLXA0TnZYb2lLb3ptRHdBZFFpeG1IcnJTdUEwWmh0eE14N0FSc0pqc285blZKR1BOSzhCeTMtbXQycnNOOHlMdHpyRXdkUzBtLW1sRHRKak9CWHJ1NmhWOFBPeV9vSWVzYmJtWkcxSk96Tkl5YmhPOWdNakpsNTBSQXVmcW1sSXJpOEVXQk9vdzdVT1RKQjgtTkR6VzVXdWNiS0VLOGotdWtSYXhhQklPcTJBTnI1Tl9hTEF2RFpmalp1cDl1RGNTc2FUOTNWR0dmQlhHX1BYRlhGWnNtd2NnamxsQWN3bkhCS2V6QWd3SnprRXpFaEdEOFhQMVh0dXJPZHh2YTRyd2ZtVG1yM1pHVWFmY0tTUm5malpnVERSVThVRFd4ZjRwMjB1T1h5RzBBUzlJLUF6WGN0Nm5EOFVQUlB1WDQ3UG1fN05mdWFVTkt4SEZ2RFdOdWYwcVE1OFlvZmhydjJlRDlzUFJFWV9CWjhXWm9IYy0tbVZ5MmM0aDdvTTUzQlFKbTQzRzNkaXotclRwWE0xUDExakc4em5XU3RBQkJxbW40LXdKVVl1UGpDV0VtY29qdGtRZEZmcjQzRUNqTzE1SDJaZGN6MkphZmpUcmxPdWlQOG96ZjEwa2RTYjBURTFVOXI1dHRIU0ZzOUxPVlZHVjJnQUxjUGtMU3R0clgwMXZHMWZLS1ZTRVI2TzlZM0pZYW02X0FwU2xONnlRbmlqM3NJTzdKc2xYdHhaMzY2bXI2Vnl6WmphajVVODlJSjdJUlY3eXBkOWtuZy1RRlZMT0FhRGU1eENvZG1jRjY4ZGp4LTZBVWpQWnBHOFYxVG04OXh5c3BTaU40M0lmLURacTlaMXFjSXNDOUJ4XzlxTHE2S3kwNTIydnBKWkw4NEdCZElXM0FuUUdKbFY2dkRXbThpcF9LMjg2NG8zcEg4UTdFWnpqc05KZ3p6RFU2SkU2Y2psTVdhMDR5dkVMa2dnUm9feVM1MWUzam1BNUFFdWpXLUJ6TXlzTjVkeUpiZC1HcnN4VFltck1wMWI0dFNhMXV1ZHBSdWl2cUFLdV9qbTBvYTA4UHZqRjJyNjRXYXZQZHVxcUs2VGUtMDc1RkFQNHFEZE5ocmpJSHpneWEtUWowY2NCRWtZbUo3di1mUWxneUxzaF80bHJZQmVyWnNCMDM1Z2Z2b19CakQ0Q1VWVWFTRkRya2U2OE41N1prblU0UkZXN1NNQXViaE93WjlCd1pmT0tuajV3bDhfemRFTDVLVDBQUm5IejRjQk01OTZGNXhleDFORzNqME80Y3JDbzVod0xMMUVwMnVweVlULXpfTkdkT1MwMG50bGt0dnNKMGFZSURuQy1SSDRYcUdBUXlpY3hJVzNnTXh3LUNvYlIyUGdPa1dLTVBJN2xFelNLN0VKcjZkZENmblhHRF9scE9HSXgtUTROdjFOU3E4VGw1dkRtdmdOXzZCOEhHbmV5bXdpQUlJZ3NpWWhfUmR0NnBrdWJLVF92aFkwMTI1WWZkck9NaW9keTFLbEpNR3NJNGxqX1dJYVRHQjdoY1dtY0stMy1NNWlZVnJUSktaR2RZbUFobXI3bkZVT28zWFFCZkVVZFpKb2Itc1R6eDdNYWttd2JEcHdQdHB5OXFQem03akI0ZC1yYmlncDI3azRTYlVFOXNFWTZVeVVJVk80Y2l5R3ltZThpOEdLY2dSWXJ3YTZmVlItTnNvcm16dmd5eGZVcDFGWDZuR0xNbE5VMDNEblBVU0JLT1RWTzVnM2JuNG1DNWI3anBVQnUwQTk5R2ZkTEJGaXg4dURwR2NsQm51TFhncjcyRFdCRmFKeldkZXNZbTlaLWk0WDBaUTh4cVZwdGpXTnI5Sm5sVDlLeDVKZXdRSHZkeXRRdHRaTXc3TS01Unc5UHJreklWd1JPZE5PVkxwRWl5RmVqM3YyZmJGRFVoRmg2ME00NWRMQ0hqU0k5eC15dDZ6LUVtQlBpdGtkcWpUT3hLam1qVV9WNzIta09tVndhZkY3MzdTcVRKa0lpWlVic002bEJoQ3Rxd2cwNi1DelR4U1pMYVgzOF95dE51aUY1S0JfcXVwcU54SGJ4TTVZN0l5SnJUcGR4MG9qNFZzWDlxWkFjTGxCZnRNaTFUSTVLMkJRSERSNW5FY2UwT2J1SWpjdlNrcjNYMmZwUWQ1cHlLdnBXcXpNbnNuQ3NsVnYyWUY5ZDZHVWFKeHlfQ2MzRVJqOXZIMnRJb2hBckh6VzJlN1lNUTRyQnducnowOXc0aWNnNG11TDdVSnVsVnJLcjdJS3FDYjJyWFViTDBIRUVrTUd3T0pISEVnVWxlYzRGajRNQl9ZNnh4SFJuekVKMVVBRXVTeDJaZG9Bd1JsSjMwRHZYTWMxcFo0NWktYXE5eV9oOFJxaUZSUlQwSktjYzFpeFA1Y1JWRmVpbFhKWXN0cDV6X1pKZ1FrSTdCQlBaR0M2bkZ5RC11LWh4MzhQN0IzQjdUUzdoWVlXdm9ETFpGSkI0a1ZGRUhvNlRKdWNDVlpJaEFMdHlfN3dreFFxdU1mMFNOREQtV0FPWUJkY3JpZzZmYnNKSVhvc2lMSWNDM3hOOGw2X1dzNk1UMXdXODZkcWRUWkJnN1Z6YUlnREJ2RDRNakRLdjk2M0k2c3ZmeG5FWWNEQ3dDalo5M2JwUGRJd0htZEY1ZE0xTGZVLTExMktBN3dCQTJWYjU2cFdBMWk2QXo3Z1N6RXhQRkZvVkNBdFlJUnBFcHh5SVBaQUVHV05zeDNpNEk2Z2lyZi1hUmFWejFXUURCemd3ZDd3TlpqV2xrRVlyRFBBZTFPVnl0bU9HQWlGZmZiQWVPaVF0V1lzMHYzVGFTOGcydk9peXRvakE4ZzM2dDQwQTB6T3pKYnlzUUM0Z0hjODJuVDdQUDJBTFdPU0RLTmxSX2M0eHFWTkxjdlhxZHFBNmpVRlBUY1FONzk4U1FRbGprcmd1bzhEcGxTZTBnODl1VHUwV0ttcFltSFA0WEtmeXRGRWlBR1FDSmIwZUl6NVZsTlAyVnFiRGRMcW1JSzhuNVlNSUtDY2ItY0FUdGFoRXU4QkxQcVE2VC1aa2t4MF93M2RmZjhVX3ZCZUFwS090SERMWUVqcTBnVktxUHhaUWczY3RJS2oxdXJPeTIybnJ5aTlnZWZVc2QzZUYyMnBCQkx2YWVWSk96QUZndk5YdnRiTXFsUW1CXzQxNG1tVGVtaGFlNktjOW9KRF9sLUxKWDZPU1FISlo4MHQ4Ql9VZkdacFZES1NubmFmMmY4UHYyMy1EUmlGNlNyQ0ZKN0d4TEhUNXJSNzU2MW1YUlV5Qy1leWtocVI1ZFZSZDZhOVQwSGY0TlZSbjJiaVdxeWhPR2VUa0hKazE0YllOUFdYTm5XSHl1VTdyNEZoOVVsb2lES2xIQjQ0VjlmYS1YMzE0c2VHZHRqUFNLdWhFRHBMeV90VU95aWU3aThJaGNIaE1XOHlFNi1Oa0lZSnF4cU5EbjAwdUkzSEhEUWtGYzFQV0RYdlVIcnBJUFRJcFFBQ3c1dkNWT2JpUmFoQVBJM2tFRFh4ZkY1S2VLMXRuS1hsZWRxQmRIc3lCUkZuNnp6T1p1UHdOWktKNHlYVDhoS2wyamQtNTlqdWpibDBmNF9WdVJFdmVQOW9FWWtTOHU3UmlBVEVHa1lPVkg3MkZXTzBzLVNJWGVRRkQzX3VvWjdrM0xjSm9GVjlXMDZrQUVWY1dURVZGRUlwamtNMy1FYnJSUVdMcy1heWVYQkNFSUxsQ2t0di1LblA2N0pyZFV0bTI2cnFlVXZ5MzdTMTBCTE53YjRiNHBvREhMS2FveGFuZy1iRjZUb29PR01UU01MWXUzaUlLc0R3Wm9kZG1WR0xyQ3FxNWJJR1BFZTNoMnc1RjFNZ1hyVEU2TmFubXpKckh5eHVPc0VyaGctaEpGeGVCcWE4WjZZWFduTXIxNDhLanNoYVAyeVpFSWV6OG81UEc3cWRWaHFRenhYT1c3eEQwSTUycjBvbkhxM1hzcV9SOGhFby1UYVdPbmY1NW1YYTNWMk81LV9XanZxZThWdzdwTUF5dG95dmh2NTVTVk9xcVdkNXNIdGhITzd0OWlMdDNFYVMxX0ZnaU8zVmVENmlvUVBNNjZsWmhaYkpZZHo4b1RFeU9SR09KbkpjSVpqVm1YSlJIbXF2eXZsUlpjdkVMM19KR1hEOEZGNHlBVE0zaGhlNDN6VEJVdk9oYlRjckhNQTRLZjhWczR4cU02QWFsczVBZzRUbVZSSnVLLUVRWFZCaFE0TEpBbEgxVXZzN3lKYTdLM2hsQlZEMWo5WXRWS2htMVhPNFJySTNrZmVxYmxoMTRHQ1NEdnI2OExyTk53SUZsY1JEY1pKalBOQi1GWGhUd25PbW50ZVItOFY0UTJVa19tczdTTm9ZUElWRnJqY1R6X1ZkQ3dYRTFmMjNocHpqQ2tnWGlsSUlNNEpNMkZmcDNTZTY2c1JHc1RXXzBBbF81R3Fqd3ZfZFBYWDA0RHJNMFI5dGljTHhLczBnM3hkSXF1M0huamxBRFU3S0c1Yl9NUmxUdWJCQ3pEamtJQWRRUEFwcUhaWktnODYyLWloMDE4bERfbFViWEwyMGhFNFBNbTE0eEg3R0dPQ3FWa1o3RVU4ekd5Yl9xWHV4RF9LZHFLSVR5eUc2WC00MHhOeTJ1cWpDMmlvVVpiM25Tam5kZWFiX19kbC1jMDBLWkU4RnhTRnRMN0RreWxpTWM2Yy1VQXBhUlZKQy1aa2NBaXlPZ2NBOVZQa0x5a2xlcGRNYXY1Y1J2a3FvTHhmS3RMU2FhS0taWEdveFd5OWp2am5KZHZfMmZDTXlUeFdOUWl6MzI5NG9mNkNNY09sTmc5VW5iaUlHb1JVX20tMHQzamNRWHBrZ0pDWlMwcmQyZ3RGVExYdUVlYU9ZTnJjZ2dPWkVQMkstc19kNUlCU2JqNXE1QS1HYU9hbzFuRmdFOEFlMDdEVXVzeTBYeVEzd0cxb3JIOXUtSUxpSHpyd01Ickx5ZWkwYmpYSm9HcVBuSWd5d29nWjdZRmF6a1ZSTGE4OTBZQjlXR2p2SEdqZ19yYmVabWRDWkFoalNiTlRveFN3bGkxMnh0bl93WkNWVkhlNzUtSGNkTHZHaGgyekwwVjlROG84NFI1NUFKVV9fNjI2REMxT2w0cXVLcEt1Z1EwMHowZElPbzMwcG5IT3hqa2xlcGRMM0dyN3dHNXZsSUJKbXVWMlBReC1Hc0JmX3lYbUhxOXBZZ2RJeXl3ZjNqSjlDcmROYXM1RGNseUExUS1Sa3MzdWtyU3dublN1ZE5OeTNCRlJ5ZkgtbHhWQmpYSHQxUUlQM2JLbjRvNmRPSHNLclc5XzRPVnBNREQ0UjNMRmpYNFM3MDJ5ZmdXSkk5Wld6TDFadk40X2t0Zy1iVHNYOC1zdzJfa2Y3dXVldmJmMkYzLThmM3lvNDNUZ2dQaDU2TEZjbFNidGdaNE05MDRTLWF5SGQ2NkhVbmU5T1Axc1NldGdKWXdZZVN6TTgzY2FUUXVqRVA4bFhEQWxKZGJ0MTRhZ2FValJkNlBNLVVIUGdGUmNtRTd5Y0k4YzNSdWxrVkU2Wk5qeUU4VkNnaFRoN2JMNTJNYXhUcVMzQWJKNUpHak9ESkk4ZTczV1BFZHZPZ1FPNnZvak0xNDFnSjFtaW9rTFNIbXNwVWRhSFdIdkNkc2VHeTZyZmJfYktmeGJGS3FNTEN6T3VKbjhxd3hlNUxJQms2djJCUmNzM1I4ZnI1VjBSQXB5U3J3bmRuWExFRHdVRU90YzdwSTBqajVNeGFJaWxKU1FMb00ydXpiWXZaVE1INklXSndEdU1hNW04MlFCRnV3TWFZRDd6WmNwM0RGb2dFc0N5YnFjZFd5SFBhV3NxQk5GSDRuYXdwRnMwQ2xZMWMwbGZQR1RnTWZJeTRxRnV5U012cHNkYWZORUdBdVFpYU5zRzROSnNJV2NYbFNFQ1FsLVhRaHF2YkpUWE03NldPVTVld0RneGRGeG5WREVhdFRlQWZZaUVEN1ZBelFNUXNFenU4VUx4VmI3RWJzX3RsUW5hU2hVX3E3RjNUVEV3VUpPdDNCeFdPcWFCbmhNdUdOdU5CNXJabFd3YVhrUTFNdGxwOEFmWTBXSF9kX2F3VXdQbUpCQXFEX0xKRncybWVBS25OZl85NlZiUW5iU2J1ME5uejlvTnVXVmNMcWZIeDIzX1JfVVE5enZibTlkaGlSaUxSMnVDUzN2d21XS1UzVG9vbks2c1NpeWNmYnh2QjE1TnFnN2l4UUV6M2U2emVkX3pQYy1GdF91ckRrR1dOTFJ1d2Zyb001REQ5XzQ0UFVvLU1SQ2NiVGp1emxqQmVjOXRUc1NRdnZWVnp3WHdNY004Zl8yWEJxcU5OVl91b3V6dVRPWkFfbkNVTDV0T1dFSXZIZmlDRWxJV3lrS0U1TUFUUVlUY3FRd0VwNUlBeDFDOXdudnZtVk5NcmFFNHpDSDJuZllsUGNIYWpMUGlXcHpUdUR4anJGeFhIbVBUc1JTM0Q1YU1yTmM5emwyZkR6ckJsbzV0Y1pPT0ladlR4X0ExeFA3RlFnNjMtbUZzTGlRZG16NzM1bWVjUEFmdkROMnV4dWp3YXFITGx5NGlLelljVVRjbHFhYV92X25VM09ESUxkcWt1S1pCZFZzZGwwX19YeDdkSlFHNG5nN3kxU0d1V2Z1NEdRRnV3azE5b1hJM0ptU0c2WVZHSW5wSUlNYjcwSy1BREliMlZBWjlVaUloMW1HNmpUZWRHWHJtMzF5b3Jnak1PUlRERU1rYnZCeTFaazVrR0E0V05aSmRKRnlSQUtXT3VNbVZOVXRWcTFWRHpkTkpNdGhaWUZHQUU5MEtBZVlaZDdmaFRSZlY3ZlFYdzhWOENmM3IxdmdMTXJyZ2JSOGwzeUsybFBLMnhMcFl0cVpRanFaREpvSjlwUHBlcHEwRF9Dc1JEcVlDVi0zNE5GbldXWklZQmtmZTRPSGFFZTRlXzNQOGxNVTFKUWlJY1dXWmJ1ZUJXSnlpNDQ1b24wRm0zVzdlYTRnUUJCN2c1MzU4MUJBZW9ZQVRUYnFFV0J0LWU4OS1YMDd1Nk1vSDVKUU80OV9kSW0wNU11VVlrV3ZQODFHNDMySDFPYmgxRUJBNG1WdHYtM2ZqeGVDRldiZHVzTWxxa3RYbXVodjBEVWdmWGh4OEoxS2JaMUdjN3cyT1E4S29KZXNGM2QyTzIycjFkdHRIamdmbHBUZlVXOGFaN2hPZ2otSy0wRHg5dXV3ZmNVVWMwUnd6bkNMbVdqd0lnZ2NfQWZJbVRpd1ljZWgzQzlpVnpLdkcyV3BfZHpCMjgzM3YycGI3SlRKbmFYT3VSSlhiM1JQS0pONGcyVXV1NnNYc1JBd2FlTnVtVVVpM1B5b0pCY3dhZFRsbVVrQ2JNcjJMQzBzYmZkbjNMOHk0bTd1UGg3VTJ1RE5EaGk1LTZaWUNYZE5SRVNzajVrR0QxNzJoUHRSVEV6RzhUeEN6Nlp4dE5MQ004a3pHVWtjS2FLeVctZFdaaFVWRENsZVdnQ3F0NWdvNUI1OEVaV2RJbi1SRTRxREZ5RlBDNDg3bk9nMUVyVmZBN0NHWldha1F2QXN5ZUhKb3dkc0RrdzZIV0x0Y2ZwQTJENHEyZ1Z2aDdraHVNMmwxSE5DdWxNOWJSXzZZYlhuTGlCMzIzN3Zjc1d2bHpBVmJCd0J3WHRQT3RGWEEwc0V3c3Qtb2N5V3Z4WFNsT19kdlhRNUdHa2pLcjhFX1hzM0dvZmlqaHpsZF91OWFROGNTek1XbE5xRGNPWncxdncxNUtaeFNXR1QzcDJ4S1VHLWtSZW1Jc1h6VW91TFdma2RCbk41Vk1tUTdJTXA1RkFfcmdHWnFwVHByaHJMSlVaeTNZN3I4bG1McW15Z055a2FMNWkyVEpIT3RWVHB2eHVzck1LMnUtSzdpbUJVMHlkQndFaHNOS1RWMXlGZng4Q2JZazJTeUo2QVlWeWZLM1FhVEdqb2FFMGxocGNPRUIycmpfUDhFWHAydlJ3TWZsYjBtc2daYTFCOE93d1BXRUJMdlROVjVzUEYycFpUaFlnM2xWVzFjSlZlTlBLRTJfYU1zS0p3UGVIY19YTTNrdDBXVkpMbTBnZzE2ek5EMjlsaUlfNTBjOW1VN2NpVG1hNEd5ZzJtSkUzVkg3VWxUanVkRldmNTZpSEZHNlJpU0FqVUFtMmtBTkNGMjFyb3ljVUhFTGo1aVlQZF90S09vcmJvRDlWRGcweDRDc3BQMmRKZWVzMVR6aVMwNU5qU096cnd4dG5qMTBBZ3kyd3B5XzUtbVl6dVJvYTUtNXVPSFhDRkFNSW5QQ2doakFudHVYUGw5REJRb1ZSMWYwUS1NdnJWQU1Qc3pfaXMxc2xZaTlFT3NDUWp1R2hsNGlxYmVNWWRhbFVZZllGYnd5dktaTGNlZndjaVdpY3EycWhpM2FxaWQ5WkVwVGRyR0FvRjItdmd5cWVsSjlRb2NfSG8xRldZdjFrVUR3RTBmQ2ZlV1FteHBFMTQyYmlZNVNnV01CaE9tVTBKWkt1c0hCV3B1ZWJ1TDVlc2RHVEJwRWtpcEpHWmtQSlB0YzBvTlJSVU90TVdZTTYxbXZaXzRTTFpqOW9kZ2U1akMwMHBzSHVYTUExTG5USDZ0R3FnSDlTd1Izd08zOTNTQnRMRU5oNy10UEVEVWc0dHpJeXAxTHQ4R2dWS09DTl8tc2RCbnlpSjJaNmYwSThEMXVPQnJYN0JGb3E2aHlkOWtMWnZiX2E1VHFUdzNKZDJCdHRzOHBWS3hhaXFtTW1WUmZPbU4xYmRJSHhlVUNCQzdXdE1LZUc0M2FNLXpYZDBfUmI4MkxJTVVVRDJadUxXb0MwUGZzUmpiYWNpOVhBOFlBVTE1WllTOVh1YV82NUZYT2xxcl9sT1RuUjd5Y0JZY2J5T2tIeGpIWVFmRGkyQmZRV0NkMElXaF9WcUxNZWozT3ZEUW5FZDZvNEU1N21FQ1lQUEJUSkFIZTNHTjU2UEl6T2xLNTRtVV9USUNpX0JKTkRXemJvdl8wSnVEWExZMmUxZnhCOXNURmc4c1hINUozYUhYY2dpYUdSaHlnMjRKZElJV3dkcXFRbmlLZWNfS1IxVTJhbEVqX2xPQTNNb3FadHk5Zzhnc2RCMjRmQlRLOWJZUnc5eW9OVWhrSl9fM2NxNlozVVFvc3VrWklreDJwVlRoTkU3THdEQ2gxbnVRYlpvUlZrN1NKc1pjWkZ1TTd1SUJRWUNVMGRIQzFRS2lublQxc3R5WDduM3RRLXZPWGRsSENaOEtmSERpR2tsemdKUkhVSFUwdU9JQUNuNGtUbkRzN1ZrRGtEZ2YxalBhYXVYLUR4X19Cdm5oWXIxRFp5eS01N2x3SG85c21rZDFNcGFUVGRLR0cxOVktUDh3MmcyNXJCcVlWQjhBZXRlbXQ1bEtZdE8yckhJNmZSSDZrLVhSM2I3WkVlSFA5MV9UTkc4QVZtV1djMUhaMmdYN0gySzgyUzRoUk1JcEItdkxUaFI2QmV4bTdDeXJHSFZqNHN3M0dtZWd0cG1obmJlNEZQRVo1UTZnNGhScUpmYTJvOUswZDI1aktwaURBTFllRVY3Y1VDUjhBVjRYNU5WR3hWdWppOVdYN0gwaU1mUjZHMmpIVkFZSmloSkxOSC1JSENWcVhxdng0ZWNSRmVxNGRqUjNBWjRITm5kNUJBaGlTSHRObkhlM3EzeG93cFduQVh4M0hHeFZKcUozZ0pVdDVtdGcyb29pYnJiTTVFVU1HT290QlZGT0k5eGd4RmZYT3dhYXNPNWxIbTVoQnFWZVczOHlXS1FqYU50VG16TjlITjFrRWFfS0JacHU0d3RGeGswNkdWTmFEUS1QbmZBV0FJalByQ1FjSjJMQ25kS2FBSHJyYTQ3WTI0dWJYd1hPNUZsSVh6NElaZzI3Z3NzTXpVR3kwdUtGc29LdnJrZkFLdjVWblR1WlJ6aklrZzNoZExLR2FMb3RPVmFwZkp5VnNidGh6T0JrSERUMDllcVlOYkFwbWdYWGdoVTZSb05nV3IwOURSMmZQV1FyaUVzbm9Gc21yZWc1MUUtc2JUWjJCb3FqVW1zRnlndjJZdVhpdTVXdFFUNGtKQ1NxczZZVEw0cGhoQy1sTEhubWs3Q0ZKVnNMUHpUM2ZUcVF5M2V6Sno5dUxyUWJKRXVVMGgyWHQtNGwzaENtNU1hQlVVUGU1SU0tWHZhVk5QM3FQUGN6NjEzZkt1WmwzV3NmZVVtYzl4OWhrbElxRlI4RE1aOFdpYnhJSG5CXy1vTnpvcGV3SXZkOU1RV18wQ0hJRlNWWV9lMDNfNlN4SDBiLU5DX1Y3MXZHNXpNTXpqUkc2WXB1d3hMVUQzQnV6cHNWSVR5ZTd4M1RSWFBxNE42aXF4cFlTeWpyMUUwVnk2UXhzWGc1Q0NsZEozN0p0R082b3pTY1gtdDNKOFJBbVk5Zk41WTRURUZCZkxFT3VtdkQ0WXdjd0xuVktKMnVYN3A5MWZjTTUzVVRhTVc4UTZSZ2JFaTlnZjg5SXl1OFc0WTBIQ0REbDE2dVhCSXdZR3IxX1lyRy1zOUU1dU9FbjVpVm9oY1JsX0RrZlNNenBsSUhPWkJzLVM2X0tud2lZMXZYeThhTWlqb2tFaTVOZnBMbUdZdklwdk1MUFViUzBrQXhGTWo3dktnRXR0S09pU2wxVTJleFF5d0tsYnJtUGxFamZ3YnFjRVZkbmZvTFhIYXpfNlhYTE1Qb1FobWhKUWtvVFN6UDFIb2J4UWY4Uk53VmpaeGF0enpxMGtpMjVmUXlTNTlET0wtVGtiWlFqOTByUnpCQ0hVaTZlNWFmNUN2b3p1T2NIdEJmRnJHVkw4R0JQMk1JWi1UTGsxZXcteFpBbE10UVRITEVuUE1US1Q3X0VwY2dJalNDQTVsZHFXQndZVWxJaXZWd3NzNXRlWEswQkNvWjY3OWxyTVdTOEIwUmRwbjM1djlPU1JOejh3TUFTNER4UVV3OXhOTzBrSjdCWHdUM1dOem90dVFFVDFIeWpEcDV0UHY2MVZuVlVDc3pRME1TaTcwakU2OGtnVm9TM0sxaHFxNUhyZlJoYTVEM2MzZDFBWnJzaUVsMXpMNU5OamktNnBpZENKVmxZeFNBa0gyc2VlZ3lGeUVVV2p3ejZRZzBzeWYtUGtCWVFaRGtKOGJsUWFyUjRMdVJGVmViUTZ0bnQtVThmS0M1d3kydzFXMUhiWUZOWHRzUnVkcm03WWVtUDI2eVVNRzNPUEktLS1zV3VEUW1VblIzemNaVGZkcVBkc3ZyRmtES1JESWZfN3hsbDBLVGtIbHEyRjJOTTBiYjlDb281SG5RdERpX1pJZmIxa3pZd1BHTDZMV1hsazdhcENaQ3daWVBLNWNmbHkyWU84QzRuX2w4eDJkLXdkclBMWGNMRi1xZnRtX2RzZmNrNjBrNUtGenozZEJKV0otY2l1ZWM0S010Sm1JMklxUm50MVpJRnNTOGhEcTF3b0ItLXVTX3ZfZ3lMMVRxRklNWE80b1dUZktOV0l6d1NOUVM3UGdCYXdIMHVIemZDeFJ1bmh5enRMTEdMZEtBamZxc3d6R2dDMnV0THcyOVJoZWtLWVNyaElGWFVoNFFjZF9GOUxfNXZyc3pSaXpKekRUMGVkWlhSVkZNdTFsV29zQUs2YV8wUGVZbFI5cC1XMS03eWo3dGJveGZGdzMyd3o2VlNWamJrMHlIUnpRYmtwNkp6QlIwcm1QU3VlU1QtcHNCSWVwSGI3S0dHQjA0ZmJvLXk2N3VSRkxKTHZlcTJua1o3dDFIRGozQ2taVGduUmJ0S0xYRVNkb3RFY0toQ1ZXaXNrTDZabURLVWJJTkF1MXpLMlJhZkJhNzVDNlVPX2llVnAweTBJX1JnT3hEd1Z4QzVReS0zdVZkc2trcFo5VGduUGhXQWlURF9tQlBmeWhQN2NCbFZvUUhoY1lKYWVjQ21jQmtVcTd3cmx1emdEWEduUkFveUp6MXlwZWNjWC1IUnlqOEFFYXhxSkVUeGpWTFpNODBNS0xtRjNXZWt1dVMxSDIxLTFYUFcyaDBfSkE1OTg1cm9uWnBCSUtoaXptUU44YVNndjBIbFlmVi03cTl1Vi0wLXFrNXVQWnljQkRDYnpUZnlGaEdzWGdKU0tPSm5PYkU0QWktMW14NHpJY3FSRmNiWkt1cF80clc5Z2lFX1pfYjBpTWlMTGlBUHJ5dGo5T241ckx1MnJhY2UxUHFvb2VrZzFuWWxCRllTdzA0eHBWSjNGNURCOTBDMHh0SzAyMEtEakpRU1VCZW52dUpsZ3V4WVMwWnQ1N3dKcnVXdmFpYUlIalFBTmRjMU1lSVJEZjF1Z2EwZ1NwVjZPbEltMlY2aTVDMllfcmY1eHJITmVlWjdwU3A1X3c1UTk5YlU4RkdEMHZNbXE5azc1eTdsR3NTMVlwc2stY2RZd0pSek5oa3RPeW5GOFZBNlcxSjkzVmZsa2Q0NTFnMGRJM3dGd05kY0FqWG8xdUMzWF9zdU1JOUl2ZU9jcWFqWlVNcEFCMTZzbU9waHVpQXlBcjNTbTltMTJMMVBvbzVVVDE4V1lEbFl6eXhNYkRmWmRUX0I2R2lNUnpFYVlHSENyQjJoaUhsYXlDdlpCNW9lbkVTUG1rS1c0dFNmOXhRc0R4U2U1ZnR0UGh4enJ4UWxieEM1V2dINlBibzdYdFcxdUpMUEVzVnlwdGRjS2lPSHczQ0d4dXA1NnVNdjhlRW50SGRHdVFERmVfalk5TUJYZXNsdnMtQTdBVzg0VUFvWE0xd0RYUFo0SVZjdmozSWRpbTh1WUVDU0dXMHlPcUo2MEVBYk9nM2ZERW1wbEpNVTBuc2kzREZmbWlqNkVRZ25hdk4yVUN0Z1lKVUUtUVoxU3lHTEY3OVlIRXhFVFRUZ0RheHNIYnZCX2NibWFwNC0zaGhPS041OXlQUmN1ZldZTGtrMUhpODg2c3V6VWJZa2MxTkZRWlBGekdYV28yUUFvUXlCQm5DS01YT2QyZzBPS2RaSFBYRUtVR05FM3A2blo1WVFCMUx4dXJhTVJCSUNqV2lHN1E2cC1XdXRpNHFvNnRvUjgyQlFFZUtqSC1KV2t4a0NoZ2tFaXpUSjFGcjlHRFZ0c3duOUdFcTBKZjJ0aFhKWXZUTkdTY2tTVFEwUzFIa0NlcVNLOXAyN0p3NHl4RTlocmFVdHYzaXl4MEhFZmNnTlNLVTk0WmpFa0R5UFozUXNLUUlCa0xweHJReGRsZ1hSV2ptMEpJSWQ3WmRiT3I0YUZPN2ozZlM2a3EwQk5SVzFBVnhRWXpkLThFWkV3b2w0MFNyNmFfaG5tUUo4WWZvYlFoTDBhZFBfWUNaT3dBc0g3alc4U0lKbGV1b0hLX2hPc2Fha1hkTnJPaFNoQ2VVYjNpNUQxRmxkak12SWFEajJFN1dfUDJodmVna25PNkFhOFJlZ1JRN1dvQkVpdGU4OEszeVdPOWJkdmZ1NjFJaTBIRU1RUm5LQVBILU83RVpMVWdzTmd1ak5YRW1jRmdmRmhmU1Zudko4Vjd1UnNmbE9NcEZkTmZzNU1KUDdEcEF6R3Q0aGRQaG14ZlBseDdqTXh4cnpOQ19GS0tvRDBwcWdJdWtTVnlMZzdrbXkwOE9paTk1QUNMREZsTnlQZjNtaUVUMHRfaHBmWFZrckhCZDB1Qk5Banltb2J6WmF5bW05SFhLTTFVSUFJN21WQWdUZnVUYmQ3eEY5TjlDNUJTZXVyVDJtYnNaY0JtWFNfa3hZTWtSWjFkSkdjN3FwVFBSZUxOVm10UURBVzZWdTZUWlpHNDREMHdRNllKalItNlFiVnNSR2NReGtxR09KQ2MyYm44SEdvMnZCSG50TTdEZVM0RXdLUXh0bVduVXdITTNVT0ZHaWVOVmRvZDhzcllzaE9sM2tvZlN1YUxIUkZiRGdVQlZoaHBFV3dUejF1VlhOd2VVN003N0R1dGJZYTFiRXRJY0hneXJjQUJTVW41dlh4cEhhbVY1RTJHczhEeDhYTmlBaWdYREJfbmhFZEdWWkVqSmd1TDg5VXltR0c0X3Z0cVMtN3hGYmtJaFpPMXBEVHZTMm1KM04zNUduNGI2S1FWcUEyWEY5amJwRFF0VFY0bEgwZWhiLUFyeGtGMkJjbnA0RUdNZWs0eDRXN1RfNEdtNzlFb3V0TjJzSW9iSFhXYi14bURJbUVId3ZHZkFsYkc5ZFFLZ1pDT3Rrb3EzUHJvY0hEMVFUTElpNEpQYU0zc1VFNngwcy00NXR5cEFHQ3N2MDhralVkUW5GbUVTYUhTYzJjSE5CUEFFX2ZzMGU2bm1fakRLektON095RkV5Ymd1bHZ5RTRsb2ZxWkxfcnNxWFlPN3lvT2oxX2FLVHhGa2ptallGNWhiS2FjcDhCNWstRUZUWVZYMzMzWG9OelJreDRnOFNWZW0xVUNibE1QOTJxb3BLUklPaWNJQWpmN2dkS2hhQmZTaE04UUt6bDJBVjBVU3lwMkdrUFRja0NrWEtXUXhhbl9RLWhtZ2l0V2w5ZVpOR3BpUjVSUGxqR3VRaVRYNlJENGZKcUdEQWNMSnEwYjZYZGhva24zMHd0Tmktc2J0RUN6NC1HV1ZOZVVBYThETl9haFNaMXAwT1MwMkRkbGVKOG1ZcW5vYThEbF90ZGZEV0xiNDg4WVplU3JwUmV2WlBJWm5OQ1lQUngxTDdxMVVGcWhfajVrQ1N3Q0VWTEpDUFdzaXlKSzluXzU5c3lUaW9DemxyM2tuTVZ2bDBZSnFYdXF2eW95TUZrcDdGdVdBbWtfYUR4eURaYm1mRGNLNVFnM0c2YlVwVXhPQVJyamgteWtreVpfcmxsa1hLUjVrTnJJMFFKYkw5UHBiWFNtMzZVSTFNajB4alVael9IYmx1Z3J3c2lzRUtGcGw0T0k2bUY1cUNLZVAwWmFmaW1nblhxS0d0RW9wNU9kTHNGRXNoa3BSSWh4Wk02eTVta0RZM0FrX0c5N0FuLUxzaVVWdG5IN2NYNUJPbHZIMVktREFGdzhkQTBpOFhPbkJoWnZ4aFZqdXctbWtHWjBITURVS0RMWk5uUVR1RXNnVEpDT1RQOVc5R0xtaGNfMGRSS1UwQTQ0RFVRU0l4SmxEYzNYWmdYOV9XdWxMY08tdjJib3pvLUhLcTB3blN0dmlPSU9YQ21BRW9PWDFodWROaUJmdktBc2NYTnE1bGc1YmtaN3dDR0xSQWoxUjRSelhDMnVsaUkyZ3lpMTFHZU1VanpoU0h5Ylk4NG5vWGpDODNJcGFTX1FTYl9WUFEyeWhMWExVdnp4SHJ4YldpajQ1a1VEMWJEZUkxOHhhQmd4UzJ6VlRVMF9FcW1WaU9wbjRnTWczd2oxMW5tV0JYOHVHUHlkUENhV2dtbFJTVXNxVXVGQ0dYZ3RNUFN2R09XRkl0LV82YzFWdVlzMGJDNzl3QnhwYy1MdENkRXIweVM4NWZKQTE3aktoclFINUJLQXNneUhKbzFVU21FZGMtTDRweWpkMS1obnZUYzZxRHBXQmhSREhieV9DeXBfc28ycERfYk12eFZ1YnBDX3FIT0dlaVRLSkpTcHdmMC1OdFRLSnAyUzloUXNQYnhIeUFlQy11ZThIMXA0WlcwWVVyWGpJRDVoS2pKRzQ4b1E2THBsaEJTWlNCa0xpczRqNm5nV2ozN0dLZEFNN01jNlpKVFZRdEw4RXZjWWNTSUlEN0liMHAzXzBIQzRKX21NTEtjRlZWWVp4TjlvSkVPZWJLUFVzbndwelVUX05KbjQ4VVZrMGwzeGtDaFlEVDVmMENoNl9MSmhSSzY3ckI0dXk2WTY3N2ZKN3RjRGFfWWsxZlotcmVpSlBRNHhMTnNOZ05hU0FoQ2tqZE5Nb241bmlPUFNhQUtVcWdDbkhsZzN5bDhPOXFhcVk1aXk0TzFlS1hHcmY1THkxV0lNX1luNmcyeFg4aF9TZ3hlcTdRN2ZOYlhIT0Ztd1Ywdk04aXhhRmJZYnF0N2hHT1pjWnVQaFVOaVdDSF8xb0MyUHlIUE1IcEtWcWdaOUNYYkdQNmFhY3J0UmpRMkxZdUZNSnNWRVhlN1gxNm1xMDZpd0dLUWxsUlZxXzZoZGtqUUs2SVpDVTNzMXV3cFlGeHdaTW1CQVVCaG1lb2kzUVItQlhrYnc0RU9nYXllQTJkSUV6a2g3cXFOYmNXNlNBdnp2eXd4cUlQT1FTSWYtMVlSRnZfSDBpYXN2MmQ0R0kxNHpDWXUtXzMwT0hqYzYyX0VMLWg4V29pa2Z3cTNXZWZNMTduN2hGSmZzMFNWNTVHY2U3UTdDQkxxNEVkSTlXc0t1MDlxeWhNWHJwUlZPWTBrZzdsNjYxa281c0VsN1RxYzgxNWl6OU1wS3RZU1RlV1lsd3pnb011clJDNktNYmZEV2poUmlldGo0Z0RkSW9GaUQ0dHJGNjZvU2k0WTE2WkNxYkVPMWVKNGNseWZZWk8zbzBwSk1NQ0gybUlwTVZPMkRueGJSSURIOUxiSEU2VE1qQjYtZkw1a3d3WUVoSHI3UnNaMnFFYUdWMDdXcFkwMUdoTWpEZXE5dGI3Qm0xXzFvcWtsdVcwMjZRUng5Vzcxa0RwU0xPNkxia1RWS2xuMlB4VmdZa3F5V0pHNlZUbU81T21fRWxlblhQMmx0bV9VVXN4MXgwdkxWczR1ejlHV1VYTGZKbVlzZnViQXBwVF85anZyRDlkV2xWc3NKdUMwRlVVNWxOUVUyOEJWSXpycV9ublJVRUJjc3BLR2d1RmN0Mjk0V2xFVjZzNFdTSU5vNG8zaVM1RWtfX1FsZEp3c3JKT3ZQS2M0S05OM1F2cFJDa3hPQ2VwZGpZZEMtbVdfMGxNdWVoVzVmcGUzRnhFMGhjeHFrZmkyUXA1Mk5VYkVZVWpPV2JRZ3UySVVmX3ZBMWpIRW9UTzRQNS1vYTBrRHZaUmxPQldRbTMyS0g0RkhwYWpiNndLTWVIOU1VZ2ZlS0dBNWVJRDRxaWwxWURONkRMa1BKT3FkeU91UGdqMTQ2WWJkZEtQdmFDOF9YS2w5Nm5BV1lfMVo3ZTNKYW9NNzhZR2pMaEV3alFpdHlSOElLRTV1ZmFDZHdYMWNPMG5FQlRnYTZPNzFrSEJkMEpGLTQ5X2FPX2RoWWo0WmVLWVNxOVhkQ1NHNGQzSFNxVGVsT2ozX0tzUGp5dk5ScmkzY0loVmJVWHkwcVoyN1NqdlRRcHFEaW5yMDBra1Q2OC13SXMxcXJhazQtcjZoQUFUeTM4S2FrUFJWYy1WMUQxUVppR3hFYUdrbUg5bF9YT2hFOEtHREIzZFgxNVNOREptRi1PR1dKSlJZNWhqZmpFWVNEVUhmb1NHTElNei01Wk5hVUs5cm42cFBMcWZfcTc1dkZ1TWRISzZhcTl3eWUtQTdLTjZyS0xqMlNfclV3RHk4dnBlbFBBTktNTG5Td09mV2U2eXdFRmFJTDRVLS01Z0NvczJBbGd0OWE4QmRKOVpsUDBUSzZEb0RVY0JTbE9VTWNJNGZXb0lDYkhwc3FnS1d3MUJXc0xGTFU1UnNSZVF0ZHhmSFNZdWs4azFWUlNhQnZnSEh5Uk9NemJXYzhSWmJCVjlQc1doaEpMeVpMM3RldzJ0RkhaM2h2U1A2SUVidWpxSE0tYnRWSXFqb3BEOHFDMG90YkNERnNqdXV0bFdVekgxTXhNVFFGdk1KY1Rfa0swM3NOSVBNTnc1MVlrQm1fV0hiQTNZY1V6d3BPd1JNNnQ4YWFVV2diRUkyNm93Szlhd3BUTzJmVHVncjdzNTJoWTFBNVRpMXRobDM4TU84UGNfeTFyYWJBeEVsMGloTUw3VlRFWmxhUml2VW5JS09ORDdXSXE0U2RHbjZzbXJLWW1LUGRFNy1vZzJfMXVhWkJyblRScHNrd1FiZUVlM09tT0lRUjltb3ZmNkRCdlZlVGtieG4zTHgyM2hwUVRRYlpFSTRORFFHMnlzTXcwSnQ4OHl2dEo3NkpwSEFYbWhkZUpBNWI0QTBYb2JvSW80a1JGTjNlUWlCQlB1eTVsZU1qeEZnVVE0N3Y2M0pyNmtibXpfSEVTZHowOGhNeUozakN4Q3ViNWdJVGhtbVdkQ1lIUjZRYjRtWlowMjhIT0ZCNTl6MkY4QVVENXNwU2wyZmhKZHBtUl9aZ1BsaVBuUm9YNGVPU25Dc2ZLTW95X1YwNk1KRTl3VGZPSXU1ME40cEhoTE9qQXNUX3NCSHBfYWJMb0x1ekpJZXdtV29SRThVR2xWVENOX2hJQk1pdWI1V01lbDgwa09nbHJTNXRMZnNCdW1qTTZXUEladUpjRG1jWlozdXpEeFBkRWdHbFZydXE0ZmpfMFBoUF9uNS1FcEVtYTkzZDFaLURCTXU3Wk54QWYwS1ZBOXVJOXZ1WFNQRDJOVmRpMG5QRFFjbFRCRWhKYW8wM01uc1VGbkxBNVZqQlJnQVV2Y05Cd3ZlYzRfOE9WMDJLRVRxZ0hMZ2tzbkIxdU1jZ0cxYnVQWHF5cmJJelN3WGJiTFViOTFWSkZERl9ZNGFTWGhWR0kyUzFpdGdZOVlsYzl3aFlJYU9pQy1KcTNiRUZiVnZiZnJnemMwOUtiYl9ya214ZjFpWDVRczh0blYybHpSaVB1eExibGx6dmlEYkM4ZkpMRE44VHo4NExMa0lMZHNmdjBHaWtkRThSelU5cFNnMVU5ZURUT0RnVktDRmtzaXdJbEJ5MDRqd0d5NnNwb1BudUxweG53OWhKQnpUc0M5dVRUTmlZeUk0SmxpdWs4Z3ZpR0JTT2lMeGNiRVlXTGFpN2NNQUYtcnI4VTYya2hDYlZZVU1mVGhnQjg5aklmNlZSa3pVSGs0QXVSR1k1QnpraWxBcDhHeHg2M1RacnVXR3ZMa1FKek5wNS1PVGN3V3hEN2N1VlFULU5icVNZRmZYMnZVcEt2Unp0WjNxeTJOMTRIYmdIeUZMYnl6SVVoTXdiNkY2M3dwcnlIN0hfMHp3OGRfb0N3bWVCMVBTQVBUcFhiYjhRZjluQlRXbjFCWlBMbUNVc1ZCaUFYQV8zUWp2SWkwUXlrN3gtb3BGc1E3OFdJUVpadkhsb0NRNWI4UGd0bVdaNUFwVDhPc1dXQU1sYkFzdXRLdXZjTFkzbW9DeFZIOGxzclZxOHVXSjhlQzgxUV9uOG5YNGFqcnZiNm51M2ZXTXRDNmxFeWwzSW1JSHRHd3lvVVZOVW4xZWlBQVpnYzdiQUlnNlBoV1pxS25DMkFyU19lbEVheVFUd0ZTWWxrM2Zjdlo4Z3RMOHB5THY0YkpEalI5NUprM1g4NGJEek5uSndfY2o2Y2Fqb0F3WW9nc3RRZFRnd0pqTU1WaU1Fa2hraVE2SVRUU3lDNUJmOTBCa2VXbWZwM2N3Y3c2cThwMG5NZEdnMjNDc0p4VHNla18zbFotRS1KcHZESHJnVUV4d3g1Z3lCVy1STjdrX2xnaGd3OUw3QUNTbHdGb2pHVzlZSzA4T0J3Tjg4ZEQwLVlmMkZSRmFnaFVQY0RfWXhmaC1qNDkyaGY1SnE1WWtyOGJMZENiZjdBTGgyeUp6UTRoUGREMDdnNW1uNThnT3ZMUWo4Z2tvTTBfMHVGOHBRaHpqenRjVlRaM2NBNkZobEI2a0Zkdk9OQXZVLXI5YkpFb2NOaW5fRTJmb1B4VUxqOVdEdGxaX3N2bWtEVzBjR05fRWRlR1dKLXhLcTdWNDRzck5vd0lCOEprZHE4dUhZXzFadVg3bWV6MHNYc0lNSEFFSWhkSnBJelpYQzVjYW9lTDRfalVxelB3dzJzMG1IU29CSlpQNjNWODhFQVpMVkdtaklwaC1PTkhQeU9QemFlQ21xajFlTVFaODdJSGNhYm1yUGNaWDFITTVvRi1meTZ5RFVzdUJyRkx1dmRyX0VJQ21TM0sxWEZmWVhsMkZCU1ZsRGNpUDJ0YVF1RzR0dHhjaWhoRWpERDVDcEZ4S2dha0lRSWc3VVFBTy1rUTN3THZHdW5CcG4wVy04eGpWRFBoU28zUUNOc29sNF9zWnFqVTBoeEVNTVo3YkVxTzNSVDNTVW1OM3RjdG9LWTBySzBxZmR1bk5iSXNjdG5TcUVPYzg3dWd4VTBXNHlQYjBNOEoyQUwySkV0bXlRZmN5RTBDalkzVjVZMjNlN19UVV83bEk5alBTbnhvVi0wdUhCRjZ0Z2xYN3p1akdJSG82MU5CMHo2MHpXZ01hYklqd0Rha3dPYXV2Uy1yX2RqbEZpeUUyZlJvQnNPNDN5WlI1OGJqcHhpRHJxOWdnMEtJcktBQ0gtWjliTUdxeFBIbHVrb1FGeHAtMWszQjdndE5GdGh4dEJqMng5Q1FBVUJwMFNZYXRhUmgwVlBPRGptMWhLd2FUTnUyNDlxZW0tbERiNTRhNFplaGZqVExkS1RoalFiMktwY2FCbVg4ekpQbnRhVlA2MXdDeVRGVDBSN2RIVHloZUhfS0NYbHA0WDN0ekdoRTg5VDVVWjVxVEZJWmNDR2I4YzM1c0pjYnh5bWZ0aUJJd05sUFRlbkNid3dfQXlOUWhreG95Wk1iai1lQ3NBN1M4V3FaUEp6ZVozWE5iV0ZJeS13S3hFMnVyTTJKRXd4eExXRllwOFQ1cFBQQVF1NG1NT0k3SDlfNzRTcWpMRFpCU1Myd3dUdU1YZW1aSDJuWVI0WmdCUF94UkZENzYyM204ZzRuLUdNNGhibVZPMW1LTllJbDlHdzljbkpQOHpSSWlNbUppWEdXTjktbjRPVHFRWExFVnlKbnlUQ0RCMzFTSFctTThyeUJMemEtOUxOdFZhUzVTWkM1UG1vem9EMFZyY2hFVEZmelhwREJfZGYwNk1aYS1icEpBQklTVWJidi1hM0Zobm9JUU0yRW1uT1N2Rkw1ZFdDRlZMcXAwREJOZEVOS0FiQmJaNGdaaGNEREVoSVQwQzh4dWJ5MjN1MW55ZlowRld0WXFoTTh1TS0xVzVOTlNLZGkwVFVhQ2d5OHhBdEh5Wk9YeWgzVFRMVTh2ME1rbjFRRjh5ODRsOVJlejE5VTR5Z2JqX01CVUJreGYtNnhpSFRVQkNpQmN1UnoxM1pSTkVMNUFzTUZLalQ3Y25zRDJxNS1fdDk4dEZ3SmNQejBTLVctbzFtVnBRSkFjZWZ1ZXBRcUdvVzdLNWIzMWFCVHUwWVc3MTZCeW1pSVEwTU5VdC1Cbnc0VTZtdG9wWWJVRjExVXhSSHl2R050dVVUMlp1MDFJSWlKTVRvYmxoZXlYQkFraEVUaDJTXy1Cckc4cG5oZWFZaE94a2wwZE1nZy1ISlJ6V0RXSHJTZ2tUN2plaThNNnhOY0Nwc19veC1kNkdsX1FwYnRkRGZWaGQ3clRaTzhCNTFQSVN3Yk9aYUhkZHotRlhUZmd1c3p6S0RwZmtSWjN0T010VFJ0U1ZWR2t3eG8wRWdfQW9iRVJSNnBBblRfN1hZQmpFWl9BSVVwQkhmYldjZENyUkN5YnR4b2VUU0RvS0twblJkV0E3cnpiLUtDQmVzNG9mdWhicnNldEdWXy1rT0dLc2FuT0lPbkNPQWdHc2VFb19NTnBvZVpjWmd5QlRlaHFmNXlCQ3FZN2FmM2E2Q0F0V2hfSE1IVzl4cGk1TVlZVk9sRVBWWHZHTFp4bi1xS2hzUDVwM0g4a0VHam10d21CWGFuQVhkNE1HemZtWnA2UkZ2d0VIaFJHNFJQQkZYSkZld3laMW1oSzZZVDZXYnpuUGloTC1PTjJPVnJEc25CSWdEUGVtclpnaVJIVWdnMkk0MXNnX1RMWTQ2N2NYUm1JZUc4NWpUTmRieEhkRkt5UWhNS045UUVBYXhDTGJsaF9FZFF1LWJtcnFfNVZoRmIwSDlocF93S0M2bFlOM3BFR3ZsajN5QzNIYU1LTW8xSVlBTkROcmhGM096U2VHUS1SWmZHeFQtZTNwdmRzc2ROTHE5XzNrdWdGZnB5ck1GY01iMkl5MFk1ajN2bF9vNTFvLVdiYUN1Wl9KZEZfb19JZV9zZ1ZnTUhoTVA0elIzRlBEVjVjVUR0bEtWWldSa25XMTRaZ1hnbFNRRG5kSG5lbmpqR1N0WkZnelh6c0FqX2xibm5BXzZnS2ktZHQ5SXk4aW92cFN1SzhTMmMxRFdqU2xIQ1FMS2tCdWR0REI4RFRaYjZneHJCZ0piNEpFUWp1LV9mUXlPR1NOellNZ01ISHFiVTVVbmpxOFVlQkFlclNnQnEzTWRza0xRNjlRVS04clRZbGszVEVLeFQzS3hhTUx6MmxWTkZSMzRkUDl5Zm9HMnZvOW9PS1VEb3VUaXRwNkdhV29Vdm5jWkdDME52bktJaUIzc1NiQ3pOWFdWbFpDWDhWdFhRQnB4NV9USDNhYi14bUJOUnVQMUZ4dlExNERsanZHQVBOM19DcHhxaHAwTmxzbk9xNzlqYmV0TmtqVHVrUTFZLVVhS1lUVFZOaTlQV21CbWJJTGx6X1FfQ21lSml1M1BwVVUyM28yNHlkR0JFTzZNZFg3aldMdHp5c1hxSVJyV1JUS0g1dG1rT3VwNlQzck03UGotb0NNMURacGZHdFUycU9aVW5hZF9TNGR2V3RBT0EzMVVsLU1DQjlLLUpHZEhyU1NKS0xoODNqM2d1ZDdoTUswVFJmYzVXLWdaZzdiT2xUc2EwcTB5anVKTzAxYmZQdjdQTjN2cTRkT1RabWluNnBJMzJSbzBTQU5NZzlBRkdvR1g3TElaR0Y5bVRMZkZGbkJTUlctaW5taW0yRW1NR1piQV9hNUdvTWxOamhmV2JvLW5aNHZubkI0M1NjZlNwZnI2LWRvRzd2VUZzMHlPUURuM0VvZF9ZcHBwUUwtLWtKR3VlYndlTVk4ZmdtVy14NktjRENjSEl6NU04MzhROC1KTEpPNzVLS0ZqREZGa3JtTGZfTGF5ZTJuekpKVGxhN0NnMUMyWS1kMFJGZnd3ODRHb1JjaGpVS0RPQnlFUDVlNzRpcnVSc2hjQjl4QVUweFpyZlIydmdQM2gwbG9UYjJ5UG9wekVwaXV3N01XZDA0eGhsMWhJUm1haXloRFMxc3R3WFh3aDN5SlNuWE5NMngwdnY5bGpQTmRDTzBiQ1lyZVQ1SXY3eFp0WEl1VW5jaWI3eldUQWZNZHM2cXF6Unp6Wkx5YXFTT0JrQkxJLW82R05SMm9PX3F6dTZteG5tMlJGOUlMcEdxYnRnZHhYTTdScVNkNVBEa1RfVjhrVzdOOXlfTUJuc2RpV05uelo3WndPNldrUlNvbkJPc0licVFVS3NXR1dUZ1E4ajE4dy1hd3hnWVJNQlhrY3lEakt5S0piMjZrWjhnRXNlcVQtM3RPTHdFeGM5cjh1MEtLT1M5YlROZDF3YTRFTWZHMEhFeE1SdmdqQ2N5QTlLa1pnU3Y3eTlNRm1BS2k1M3FXNnVvRHRfX1Bwa0lFLVpqUGhLLTdSa3Y1TmJUQnI1bmctTlR6ekFHc2s2enVPdnBpU05JSWxBRXNlUUJERWNES0c0M1Fsa0N0X3g0VmJ2QW9kQk9lTVJpZWNMeTVtLXo2SVZyME9xX0Jnek16ZW85Wl9xZFhWdFZobTU5ZkhDek1rcEM5WEN2dTVXaVU5UzhsV3Y0VmM1STZXa294QW9vZ081QXJFVVV4T3JsMzlma0ZpR2FvUmNBbWM0dG81anhUUjhuWVJXQ2tFdUQ1dEoxcFFUNkhpaW9XMk1OTXR0OExMTTFpeUMwejI4bWFlcmdBZUxGQ3pTODZ6QnJybXVTWFJEQlhhaW9DWGM3VkoxSEtmSUFYcDY2ZEZ3RjhRUkdUOE9LMm55dlZIMzlvRWhSX2M2T1NiRzJvYkxTOXdWM2RFSUFiY0RhR3hjVUpCU1JXeTdUR0ZhcWdhemlwRVRnejF0NThlNUZhS1AyUnoxMHV3LVRHSWN3VVJtRXhlSzVnbDZJWWdMVThKYmVNdWtpbTM4dVFXaklVQXEwOWhva3RsRFNueG8zRFg2STJjdFYtRk9xYk9rX1dLRURHRG9aRG9neG84UFNELUJWeGJrQldRZEwtTUNENUpzblBGRjZhLV9BdFBaWktKYnZoM0t5bWQwNXVfbk9qTURUdXFKU0xuNUV4MjFPbXAzQW9WZlpNYVlTV1hzaXpOWU10cEVReEMwbWp4aDFFLTNmRm5uOE9GdzVnTXFXNXN5d0ZHRklYcUF5MFlmc0Fsb0ZBTkstRVZvVmpCbjY0b0Q5X1NsNVBwZmxFZVlaSFFRS09IRmxWazVwdUhlZHdpckNfZGhkdGp2TnV2ZlNSb1BLU0VJWGxnV2owRHRrRkFiaXJkd1FNTFBUc21CT2pOYnhSWFkzVG9Qd0RSZGo3eC03VVJxY2Ftbjh2VW9UT1MxYWE4WVRMNm5FNVhsVHpuOW01MEh6ek1Rb2tnemcxQlFLSjRsMFJkbWw1a1RiX2tTRm5XY0hobHp5UGt3RUxvZnZfYnlBN0lSXzV0d21LLUZGcUVsYnE5WW1IaXNrR1BWMlpHTDFmTDFGaU1RSmtxLXNzeFlTNjZJRVZ3b1pCaGw4dUZJbnVidXhFeGJaSEpTX2xQY0pLTnQzcExWazJJSzJpc2duVFgwTnlJRWNzMG9pdDlfQVRERUJ5OHZwWTYyTjIxYk9la1lJM1o1Q0pleFFpVTc5VU1wektndTJvTGlaWnBaeXJ4TnVMa3BWSzJpT2toanNaN3gzNDhRdjBSUjdRN3p1aWM4b2hnbWYySUs5cjltOW93MTg4MlpRNFlETTdlOGlxc0t3dkZkOWZuOERlcWl2cmROQUhRcjFlQTZnN3BVSkpZZTNiUDJKLWpGSnN1azQwWXBFUXZVdGFaZjF0cUpPQlMtWlhvOE00aGEwUE5KTWx0bFhmZGJub2x6aHRnYVF5blR3WHJBRTBSZmtnWjlMaHFtenI3ay16TWEyM0t3UHdncDJmUGgzSmV0Z202Nkp4eHBnVjQ2dVl3UTVwSUFibll3MDFOTUxFTXlQaUNySlFFRWtwaXo4WG9hOGtJMkdRdkh3b1pTYlMtNzFZcHMzQ2oyLVZkRTBNaV8zUnRJUEZyaVVTUERfS2cxQ25pQlduN0IzS1pUYjd1MFFwOXl0VE1TdDNRbUNwcnR4YlktVWFwWEtESUYwYVVCN1RPaDRuN2lFZ0pQYzV5M1A1LVZkQ1VxUHJKS2VwckUxN3AzMmFyWjE4VFFwZE5rRHdXRWJWZFlMZDNvc2tTdkhCMHBmbTFablpMZzNpSGo3SmxFX0VsT0RIOVQ4MXRBS3ZyUFlzZUJsWnZQbEdUbDdRN29XN0tSZ21zVDJHMmlqOW11RlVEWEoyLU9ycFhHTWFURGxpdGNhcmpXR0tjMXFJRWhzQ0IybjI3LUlDX2FnbDdHbG4xUkdCRC02bEZGQjFuTVBWcHJpVGljQjA3THJZblNHSTVRdzFpY0pYNnV1TzYyOHRTMEh6Z0llUEdRVzhPMEtyR0xEZkktX2ozQkphbEN1eEpMeW5sdmE4MDVaWFZ3RUdCcEcyaGFOSlVleXhJeWFSamM2SGdOZzNHXzNIbFItWXhiUjBfSmtEODJwczhfd1VmZTBGOW4yYkUzWEVNeEd1bm9rbWdWbTdxQ3I0TzNxQk1HZ0dvN3ExNFRVTGhndk9GeXVZU3BKdkJ2a290NVptZS02SC1idVYySlVjNENQYUN6Y0pFSnB6QlNmTnk3eEFlQmNvbEN4Q0w2MzZDZS0yeUFGVTFFdjJ0NkN1U1BHZUlyY0RrRlUzT2RWOWxvRVlJaG5nNUdEdDdXUjN1RDJsRkh0M1dWLS1ieHkwSFU4YkZmT0c4b0hoU25NN1hsOWtGR1ROWUVxUndIUjk4eENYeXVlS1ZEMHVlN0ZPNnotY3dxV1NxX3BFb0ZUX0V4OFlHU0EtS1k4N1RCRFY1ODlYSEdMYW05bm43RXJybTdNc1p5Znp4V0NBb0U4YkktX0hRN3dTLVVTc3JuZkh0eVJCVkRMcHRSUDVXWDhTSW5jekUwbTFsZFdRUFRZdDFZTVdld1M1Wk5GWll0SFFVSU9FUzNRVlZ5dWlrcXZQczBQWE5Db1p1ZUJoVVViZlVab0E1WFpDTXFYWVdsQnBUMzRVWkRTV3RxUnRVcXhjZlk5YmpvNzZWNjRfSFAxUHJ4V2NQMFZFVi1QVmhxTE55VmRZd0VsRTB5YnlyWlNsRjRwVlM4VTdsd1VlS01UMnpHNWVDLUktakxpUEU5S1M0eWU5WEdtZjlVZEZjd1V3cXBiMjl0cVFFdXRUNFRmUU54elM1dzFqblUySF9BVmxvNm5LZGJiLWt5RjB5WGZyRXB4VHJtR1VSZTRqMEVzMHBXbU0xOVZxY05yeDJDczh0UDlGTlFxNlptQnJ1QVY5ajE0SlpOdUhvY1ozMmU3cTdsN2tfcWlseEtDN1hjR3lRS3U0YlpXdS1qWUEzdm5OSDVORnAyaEd4aWFLVmRka1pDQVlTUnBqMHVNZ1FuVGNEUkppTTJoV1piaGY0OXBUaUVwak90dmhIbHV0WDdYdmpnTDVZcWtVRzNBbUZVelZIOWs1QkFpUXo2VUtwVVJjUFVNUnFPTG5fbkpMd0VsY2xKUE0xYldZdEhZNHNTdzl0OTMzSjZxdzdENFdNRGJRLVI0QlJubkxwNUZZRUtSY2Z1cHVKWWtxV29xd3dQUzc4b1E1UmZfSF9VbVlBZEFOUXhsLVU0MUw5RTE1TEZqaFBsMUZObFhNLUp5ZVNJNjhlbUJ1NGNWY1l4d0oyMGd6Y2NuSWs5UEtjdXdUWE1IUjVIMmNtZENxRnVBY3lYUlJCaGhGRVBfNjFmbmxnRjMxMFZSdS02c3JmOVhnTGFuMEdtaVNZSC1UaVpmcUFrUjItRVlvdWxFUG9UWUw5OUhTekcwQTBveXhpc2YyaER3Z1NxNDVpbjJaTU9BQnRrNGpGT2ZKQ2kyOVZxMkV5YXVOQmRodkFQeUVzVHJpcV9ydHZPN1phUUs1Ulc3QndPZ0RsY3k5b0ROcmVfRG5mZm9jRUNmc3hMVndab0Z0Sm02eUpoNmU5SDVTOFdMcmF3MEhDTklaR2QyaWNTUTJEMG5oMjh6b3JSY1lfanpIYjBwX0VIZk1iNjhxa1hoQmREVE80ZVQxeGNtRmZuUXRCQnRCMVJYaEd6cW1MRlhTUXJRRWxHWFY0czZxNWFYRlJQNkljdGowQk02VkxHWXVpOUdZb3YxZEVrWVRaS3Y0QUtnQndySWRGazl4N0hOT29YRm8yRlgzY0hWTUpWU0hzck4xY00wekN5SVNGdDNkaHB4TnVsVHY5TkdfQWZmUUg4X3NQa05Ua1R6clcyRlM1RkZpTjVrQXJLeUZRRGlWNEZHZTRxWE5WbFhfOURtLW1Hdk03Q2lPWDg2Q3Z1OEg2c2JEckxFR2VxdVJFSHdxaE9DYnR1VDljczNIYlBsbDlvODhxTkw4TV9CSzc3aUh2a0lSQUc2Qkl3Qkt5ZFo1QUNpVnh0NVhIZ0tEUE05a1VaMTdLM3FwYXFUblk1YWw1QjF3bXVYMkwwSDVGckxxQjJTTFBPUE9zcU1RTlNidGExQXBkai1KMm0ybzFWY1JPaGhWeVJza29iLVNOUDd5WGJrbGlUOWJTSHl5YzFvbzFXcTZKYnNZd2hwdVI5aS1YX1cwYkc5M0hyYS10c2pvYmZPYjFBeW5sRXotRGpqZXl1eEt1UGVtLXVvRVlTWkZfbXRsd1JxbVNFSkFwWmlxQms5VHFTZW04LVBCZWxRR000MVhBOWtFeHc3cm41anROODZEdTdUX3JvRnRTWGxpakFQUm44ZTI4XzcyNEwyTWtrN3FPREpLMkg4Mzdvc3J5bjNXRWE5MW80OTJuTS1BcGNTZ0pfUUEzbURqUTJtaHZNVElPakh5TFRCZlBjaW4tby1UQzRhc28wdmpJUEhLZ3pUeE5oWnpYNHMySjFSRF9ldW91cHhfNXhocDdCTDZSTWt4eWVMd0o3Y2VwZFhDVmNmdzdzRDEwQnlyVGVtSnVoT2oxaWhrc1lVUmdEZFI4M3pweFl1Sk11a0ZqbjlxbEQ2a3c5YndNWnRpU2h4QjFZUHNuV1daV3U0TXFsVTg3SldZQzlEMzFUdXhiNFltYndsd1RsQTV6dFBTS3diTk1fYUI4aXZVUUhUazBPdFFwcndXMTlCdU9FbjFtWnpBYnJ0WkUyZ3NFQ2w3TTREWjZWR29nMGtza3gwSUlDVks3WkxEQmZRYXhIWmxFOFk2SGFCS0JrekhKSHE3MUNfcnMwcEo0UWZRV1NiNGdkRFpIeVpWY3JaNktPbEZsQTBma25LdEN4YnpjM3U2TUM5enFXa1ZYWWZZeWVvM1JSNUg3UVJZaUJqM1R6SjJVMVF4U1VqQjZyU19XeW9vWlhnNHNyeG5QRWdKak01TTdfMC1yY3NWVlVVdVNzT2RXMXFybjRlSy1Kd3Q0elkwUHhLYU5wZzRkMTFLUURIVXJkRjdPbnd4UmJ0NktLSFlGYW03UGh0ZVozV0dGbnBIbktzdHJYOVk2bEREYjBTLW5KQ3o4ODF5cUhUSmZ5YkhfRWFxS3R0ZU5ub3dDc190Nkt4NTVBS3o4c2VaU1psOXJnb0k1V0FrVkR5YmlfSlFFdTJnZnp0YzN0M1hCMnlTVDg4bl9BcDJNbU80X0V4QXBoVEpfNzdrYmJvWkl1Yll2ejA2Sjh5ZjR5Mk1yXzgySlFLVVBQYWhuNEozejR3eS16d2EtaDFLRkkyZThQTDZzODF3YmZ1QndrNlBHNFItZWg4UVhybEJrSXVqMkJ4eGU4VUZ3VUZONW9kbzY4VC1SWTF0bVdPRlZndnpDUkJKc1Zjb3htLU1CTGZsdW5XbTBVdDRvd0F1MlRKQ3lUaTRpWDhIM3E0X1lQTy1zMXBiQnRRaU0wQU01azVFNkdoZlc3MS1lQjJ2cHMtMjRORzE5R2gzTEhvTzNlelJtWmhwX3k3QXYxV0I5OURrbmJ6NXZ6dGxwcW92Y2hNNWRDOFNQalFkMDBDRW5NRmtwaVQ3SDZZTmFKVG5BcnVoanhTU2RKLXUxSmdGSE1ObzJpNEtfR0xxY1BlSGlIaTlPZDM5S2NGdVNQeHAxOV9wc0Z5bHRzWVp5cXhoNldJSG55bkRvdEpiOHd4dFU0bk1FMWFvazFZNk9yc1FUeGFtNnBFQnludFljbzFoLUlhanZHSGliWkV2UGdLNjgyc2RoZ295RjJ5OG1na2JTNWxHVDd6U2tYWm0yeUZwOGk0X0tVUnlYWUtqUndFZWdKTmktQ0gxWWs3ZHgwbExOaElOVzJEWkdyN3RFd1dOd2tFMzFHdWwtaXZWZzdGMTNMN2xXNW9OWTk1WXFXQlh0RzBsRHVoUlduSHg5dTNWV0twSDFmT0xDcnVIS1VXdzM3MmhtX21KS3U5UW1tQjNrWDF3SURXSkQ0SnFfeWlaekMxWEdIOEFzRmJfOFhtTGo3YW1aUmRwRFRRSmV3WlE2NXFJem44VEx0ekFhTUktUUlQZXJDSEZmeDFYWW81ZUpWdHc4MWphVHFRQWJCLVZ5X3ZXMG4zNXhUVklEOGdJUlpYakhRVEg3YTgtaDY3ZVFPdUNtS00yR2NZQjlFSmNRLVRPdUd5ck5Cd0lBckNxSGxDSzF3SjlPZjFYMjQ2cjY3dnd6MkJCQUdRWWp5dF9yZ09PcFFadGthV0pMd25ncXEwRE1pYWt5cE5LSlVJbEViX3ZkUGp6SFFKMV9IVzlMSFB2UWVHUmVJRTY2YzEyWlBBTm5tcndDaXR4M3hzcWNJZVd2d0Vya0ZzcWMteUlZbFd0V1Y4ejVmdklMY2JvSWRxVTJ4c3RqR0lvZDhudEp3RVRMeDJJQTZ6TUZHZ2E1UDZkcVhiMm85TUtxT3U3Z3UxYzBUaGtjVzB1QUFSb1F5ZzhDcnMzX0VfcC1YRXpCZGVWNzBIWUhXNk5CaV91OUVfLWVKVm13Vl9RcmJxanM4bEJxeEhsR1ZyUHVIbjd0ZU1ncXk5cjY4b0c4RVZRRFZUV0tXYWZ1U3Q1bHJpWXlTMlk5QnFqbXduUlBFR3lqTzJtLXVNRTRHQU84d0s2eFZVeWF1emlRQ0FyLnN4blQ5QmJTbklGT0RKQ1Y4WGR3RXc" + }, + + "responses": { + "200": { + "body": { + "id": "https://demovault-rude-junior-95.vault.azure.net/certificates/testcert/21983500952149bbb3129b0c60e367a6", + "kid": "https://demovault-rude-junior-95.vault.azure.net/keys/testcert/21983500952149bbb3129b0c60e367a6", + "sid": "https://demovault-rude-junior-95.vault.azure.net/secrets/testcert/21983500952149bbb3129b0c60e367a6", + "x5t": "Z-n6Mydb08bmyOgk7bmx5HT8tyo", + "cer": "MIIDMjCCAhqgAwIBAgIQGn/FrGQZT/Cd9kgXIsytEjANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDEwtleGFtcGxlLmNvbTAeFw0xODA0MTcxODI2MjZaFw0xOTA0MTcxODM2MjZaMBYxFDASBgNVBAMTC2V4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsODIu9EJhfnn57k4++j6dC1M6Egi9aZucFQ9Jc29vFG9L9BkzllPGluKKdH1ypsrAUif7yGaq5d1nDyLhZUncU8dV/YIA7oll/fC+d0H4A37kVbM/60zXhXnKRx+DRZ2hJQzNBOodCaZpyZZEuYvtWdSCSILpa0R7yXYevjLaG5LfckOzuurXqeos7WB+l2q1c+6zx1KbNXbBl7QOz2nzk9oJU7CdhPOc+LOLppmsXRwwluKtmCDyKdrKAF/dANp5zGXFsognQcRctLSGQp8FbgBVQyZ+v81n9bPpSaBoUQMcH4uG9jPO6CWwbDSWE+FVYAm5kgjuW/1hqRSnOEV8QIDAQABo3wwejAOBgNVHQ8BAf8EBAMCBaAwCQYDVR0TBAIwADAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwHwYDVR0jBBgwFoAUaYJoBFokrORdsxOTA8sgrosMOmgwHQYDVR0OBBYEFGmCaARaJKzkXbMTkwPLIK6LDDpoMA0GCSqGSIb3DQEBCwUAA4IBAQAxL3t0kV1dq/PGUztjW+qK6Nh4sx7jsU59JtjON6zcibJ4hM+Q3Z+cEvW9zuGkuTbLz6fKNL9VnkF1LnlWTsyRmS7bF15/7iOgfdrr0vkJKVM1Zv/tqKEpBJ7Cbc0vW/VJQxZN+OlqGNc9bcx3cnqkRwpkgM25T0dVpoWtCgMwayUtbPFbTZWHHbpzHLF2BzYf5HyW1BoKXcVPM3r/rS7RETasRRsz2GqXXdfhjCd+HKVyv5kD9N3WcFNUsaq3TqAUZyOx9bO0Cn3gkmgz05JpfhPEylXwVpVAccOoXsNoFdxEKGO0w7pk7PwOhsW8sFprdXWp6OxtL0rrCNFF/llT", + "attributes": { + "enabled": true, + "nbf": 1523989586, + "exp": 1555526186, + "created": 1523990186, + "updated": 1523990186, + "recoveryLevel": "Purgeable" + }, + "policy": { + "id": "https://rude-junior-95.vault.azure.net/certificates/testcert/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=example.com", + "ekus": [ + "1.3.6.1.5.5.7.3.1", + "1.3.6.1.5.5.7.3.2" + ], + "key_usage": [ + "digitalSignature", + "keyEncipherment" + ], + "validity_months": 12, + "basic_constraints": { + "ca": false + } + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "AutoRenew" + } + } + ], + "issuer": { + "name": "Self" + }, + "attributes": { + "enabled": true, + "created": 1523990175, + "updated": 1523990175 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RestoreKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RestoreKey-example.json new file mode 100644 index 000000000000..294bad39a5bf --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RestoreKey-example.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "key-name": "testkey", + "api-version": "7.0", + "value": "&AzureKeyVaultKeyBackupV1.microsoft.comeyJraWQiOiJiNTc2NDI5Zi0yNTY4LTQ1YmUtYmZhYS0zN2VkMDdmYzBjODEiLCJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkExMjhDQkMtSFMyNTYifQ.YMIP_MrQq46_fpDL_H3RJJsIJ-3NhyBd1yk9bBKNI8ggN31ah6qehcPHHLgJrx8jkBLLXPqp5f1zlil_rUk-KkOryc8ZI9cssM5_Sy3xpI4Zy6WIc5cjPWuGCCmBpAyrtGOVzhjQxo3rTW1DSqgZUvr8TJly2PKrviI_RgnEd6-RVKuuVN4efVaK9XVTmn1vfygzpTr_TWC9PFmzhOJzgU98_9_nVrWVHNS1uLXJXnWhAOfRYtVRNEQIENeLc-g3cMrK91s6NWxNqfF_GL6Px6qXG2WWCOg357fBgOVStDKiVH6N1MedQ5piadxxTT6LHZokB4x1JlAIfL_bU69PVw.F9Qb3tVlMKprCKK-YEi82w.T0MQiauw0l9Mb_DWDcXoo1jN6IYu59Y7SEL2mgtU0x3XL9yTsjeF4cb44LAh_oP7gmH3n7J-VD_xJ7hWcMW6yS49E_M9iygt9SCl9f4Suki3CYvL0QERTYKImj2-AFDLZIwNmGba8G8axPqGcNKsRgGZgYTToiYLqBryrbvLJudCqgjeQdi5MmtyPFpagHpHvKkucFGp-XmJ1KbO2A2QOWQTQZ9CereBqrCn24IwaQrUC4rND2w0UA1TcwEeuVBGELdJZosXs6CGDfjZHqcvpz74Jwx5OEiq_DPs9TKrkMhowcEplZ8ZJMcNQRfu9J89d7YXgGdB5ikJzp5ZV89w12b0zCHNYJjgddHS62fjVeaE1OOP_7yfX5tJb6d5AXigr-JJ3lb7cba9q64plbiarMKzab5Hm2LMFuKBr5Nako5P00hQBgGc6ipIK8MOcKsdaB2Fr50_Ub6rDS086u37-CHtFFqy-1AhiCixQjCML_kXkI0vDbbjF-_xkMdaBV-Au79O6zWjsDeeWKtUvVQnB0c4By7IWCLeVw22i09Yi72zBqfOF4rNgxU3kJ7_-5boWmyYW6wM8esN4xGY3PhU4yKE_uDg6vNNwt5scWYoS0xx6PCos8KDtcr-UypQ92thU_FXgq9StTYq2YgVWGPns5CDLODAJ-l11I6IitlP7HhyLo39j77iWfTKDgL5kp7D9E3_qdPZktjVPDu3ZQcT739N2zz_1kXrDom-6PPqwVS6mQzAUmqixSivcqbqjZIFtOllKFA6qerh2eSAYzTMSCuwJxDBRB5-n0MQlIHjC17dLZhVqD1Sb6Prq_y9sv2ivWq9La9GfGlHA6VY3T3QdSCukYRjXXq-B-NnVdhFMValVvosrJfnHFaXfLi0gs5U9Ku4yjD7QoW1yR1IY9OrZ4qRQwkpnm9O2rrH1pm_XSzLQT4kZcKbugxsoYtlDOSiobKDXu1MtCqvDnvxz8Fw1GpMrBuLkVQDVeeP2j4ZwLlOnLTNi8bScNm_7vTsTPm4ID9mjpWI8Bap83TKi3dzP1k1i3Ggrr1HJUAOzCCcQ4gilDKZ8RElQe21BAqJ7yEnnVlucyG6AWa7viYYuxxBHkDl7XGdvX0jI26rwcS_FH2yNiafd3wJI1342XAvT7CQeh8dZedJSqXQGjB5BHayV_ofzeUp_8HjFDhKUdrcI4i0kFppHdPXMAu128wDu2LnUzyM4JZwSIum_njbQ3ISTymELNx3wt2WSEOd7AKyKyB4BsSsdPMGewKI1gsj-HCEoNBwxPBAvVqCII3lf94m-EM8-XzNtBUqiOv9dDBkgvzJmI9k2O_VjcmFknGJoi1VzYpiQU4XlIZzjCwsCDqkahubcqXWr08UtPmWHFEy4CKorVL7UHiXlVrOGUGtSvucwKdcKTOzWlRx-DcF0LCzMdGZwcg3ei5mitlYbF2UlbN2bZSCPX9c9lESdAQHqPEl5raT67h9VxlOswhanxJFo4enDCZafNmDFG2La69EqBV6KLz0_4uKZC5mxavDk6WKyfoDNyqsuVLto7YsjRN152X05XHHnESz4ne3c0jwWaz60ZIGD5MHMQHPy7O4WgakaVsJeOfaCskwbb49q_mBsX0NfZPcqabDXhZ7BYLQ9XERGbnwd3JDBh-_TT7k6XDicKTnVPueF7wsV_4hOGRJdTI6PTfWj5uf8u7qEOAuKy6euVMKy97MWKOT8-ZQl0hIj0rbVGZH-R4rqH1v_VgQPdi-qWoqWqky0aZK3CNA3QxWftLGp0qEWpu6OQ-ChN7-vxN0tUeddDZQyWWtwx6TW1KhCBWZGjZm9AC68bU2BuNME55oUWGlncN9EnFzgNmQMTuK5vTgwZBHMjfQzlIG_yfwAumHycK5OOOvx95Hc7wDAD2W1WRohy05yLRdlBv_4DQrrMkadEpf0utvhwUwevR5McVEybOwUL6gf9krC4L4bTumBQloBrx5h3nLxYw90rijlnKj5YbKaejrMwbImyF-qVNMmjSwb52StJ0wOG3xOGfBQDxPXrmIxh0DR8GsK0dy-1HIIej5-oRMd_J9aVKz0Y4wx6V23h-jP3q24JbawvwlA6rV5iUFdh6JQriMNC-_aD_u__5U7t8CH7ZVCuP3nIi5x7gmqalK3egHm3pdb_lowXE4ZEBDLvtkihl-w-PFsuYoUJIFVqFvVs5EnSSMW0PIXOSfVMYmJZekbiG_QjxkB23BhzYrSjCz1qnSMx9kvbp9Qh1ndRXJJIPU2jeHuLB4OgW3hzynCaqAvPEuG2XnKpxXfxAKNzWiLIN-0lQ4_Qt4tw-fjaYRUV5KUjrbVgk2506HPmYTGVQWQ_m7gSASPZj6DbInku7K8EZr6owuH253Xqk9kIl2LMBpvjOkNMaQMxKr2-2YdPEy--fMAPLp_UMy2xjlKLKk7nXIu_H1vRng_VUrVHneGjFan87QEORSV7rTAprO2fT2j_9hh6JmtYkQqgG86YyJksUjWs3xpdi6NPFELjAgyOFC-4kMgKlgI3iTHIBWQ3jjtSe0Gct1K7BpBJRrIAF-1UB6JT6cJ28gMswI98kud5hoXYmT5lA-ZaD-I8dM0qFtHH8kYW_nzzo9m69-iYfV_wsy2mBvueoNQddQKBkmiUMnxV90tAyEg8YrZYL1rOcXqcoeI6_8RetmvYxVM1bpuq_j9fMv-zTA9JCeyJ1qAN5VAaicIgg1JXICLB9jeSOOsQw1avqvM7N1ArwCr6oMHrq5ZCEK85yVb5G8cctewoiHYsuYOOHgH3LnchWzfJ3MiEcM6_V7RdvBQd03kPzGEV8uI2uh9tmLk6F7UKzYM6ExI5mKPC9-QN2Mxe0z46ke2mxGGGw-yqL61GGAiKAcpClK5GxyQmPnDJ8DqJNOVX3h_o7a11Uo32kdtG2huXpDUsay6E8TbyGWEgwfX7ZVvk7UM3ejt3jYpqbdYJPMMBB0gM9OfIQcKITroH0rDlQ6ZkxPc4dpeCmM3875pWNQkg1JJuQg3xpOVgEFjYZlED50EiVJ787qC5aGmjLQZ_r-P7_hI7OepLVgPGHASRLlwGN-FpL78QoUzj_Xu06Pd6AuTLmbjhViDD-udnqu5UGwJ4lYjbjJCA7uPOe_ujsQhYwUGA_XBylnErIlL7OXHOTxaDlJGH4-4wMroanhOY5hgcVdvUBZUgRDUh40l3z8FUbaRlihE1yt0uNoGqwMdrZvhNIwaQcPYPyUwQ7Auhuv_jItUqiFBogryRoscwz2qttjmv8AQYHyAly9ujvbury5LcIh_EQfTzBnJy_p5Yw0CXnBK87fEH8raZHxWETpqlxyfYdVf9PjDXLbLabVCbzMsR2sXfAo6m4VhghF-CGNWymknD00Tme4La4W-A-OeGj72-n8Vc6b9g78wnmbAttdrQ8PYWKQvcuyDlvyEGGH_5UmtlSyj2JltKesw7Wsj-ak8CX1btdsSlhBWcaBttj3RjwlCxhD2MyVttzt207rOB7qtAIyX5zrY1LZHpwEmMx8dZs747ecfaeS4dQBZczSyB4VEYTQXgHygE_q-bw_exj5k9sDGxsSFqyzQBVoU9Kename4DJsLXWZinuPHYQSmX2TdPZmsdHxBkpAprb-H4HgEJpOalBkGwhXskHpb6TNHPxy-oOm-hAizmMVOg9gL2NHzRuAmoI3U4Ewa_GEnowteAQSLecMzZ6qgyudk0pnuRyN6P1m3BSQ184WS3jx1C460LAJ3arI-4Aeuin_0VX3qGva344vet87DR7IbME3KMkYkTuz-hzjnxGUT5qvaZv077PTq1m5CQPTdee6Sg34f-ylxh70j1I-NZvwhP2LVv92duVxJRR7xslJzS575q7ifuPG0Rzt4Ny3YDJz4MeCNNpZIpMBJxdvnG7k8lmyoBUQbdz8xBunXOqlD1GSm93NKc-wo7qfzIjv0Z1zYZp-nK7J64E-Jzx2D1glIDnodl9GmyS9po339IYaOPfRgI3ZwQSVGppBP7GMEGlFEqlo7m5-4SYXG6JdXaNr3iQVghPKdAei-bCLAPlbFJCEAU55r_HEfKlT5-36SydteqaSdGo1XFEzZuaH-_z8BlwXW0N0tRitz7Ixu9NANC8GutgkvXuER_Nnw5UIlarepM6TD_Z_e8rFD7haxV1WtoZd9BSwNbRmIyu6cfZzX2xSOVRUJwVHG-Y3ZDdiqkso_WGBvLRJBTVOsoeVnqe1ZKjoCQK1DaFOopxP7SMhp9YicoWFOUQNN5-DB3-68CmDsv15-s3DTqQC58xiwbY-4nYktySQWayzTobVNXmbvb9K9-uj0aTVFLzH1G0YvLmhSSSwk_3O-ctRPLEnXPSQV6GUOjywLHOXSD6_cYS7RkUtx2g8m_1nhIQm08Wui5MJGPGBDoDf7K3wz22tgQQWL10cbtJUoBF262UiH7LNi22VCkl0IX1UQ7-wpI0p8dWSoWo6SnOa7dQ5iBIbf9P_rQwWaaYu5_ZBZpCM4UqVcgaGSYVsqDzWEV8-tck0X8NuI2rgrR94CJxcJk91l-oz0nWaMAhprnn2_wxRXGNay36bjSq3YxM1stt1M7Rczu7Q2Pz-fdjGYANHvqAKXQ6imJaAsplNtJHuIJujwrNTPwFs4a9l4dXwM04QIfhc4yzmbp9XF7UYU423WMhQSdL5JZNWyAuq8AnG7mwgSP3T24NThuSFzf7uNNrJg_PY9UCVriOKqD7YUKARgQECA-NkalnXSEuTCvk2ifEX8Hzq2Il5wLFr9QJV0fO_DRCrS5sDuZVbwD24cejOybmguUanL8b2IjKxzLUOOke2EO5TQMtPQfcy62vEyscpC2EawzaCvWub1SWKdYVu-qPstUxyiOPsipTwWY3MuMFJprSlqaUP1Iksz3D4TjjHIsoG6MAllTYqB-IjnHHfc26nS7ra1yUcltHEkDwt8GR6ng-6OW5bmOBvTQCjdTP8RmvwokHEvFA9Wlk69VHTZEJSZ4gQeqsqo7HBICHwvUb9mzbHgiNtld5YAGOuuSpNLMTq39-33UVhN0KkHKQvBzr59qfhPHSyUFuLg28ojX0doox2JQDgPhlvUbDwpinDBjTpb07lcODaR7ecv3KC9HIAWkx9aWIskmXoAVaSVL0lgNMC3GVLR1D_pehA6rIk6F_jl647L8HDjDRDn6QFtHkmAamtMOVK7O1-T_-TNWph6waQNu0kWY-ep2DDgt96ztXRFSUgM9rL2y78CN2EEYmfAI-3UcjgTnU1FrWhFwt-I6Uf4Vp6V8_6qN2sT2ryaKXz4cBIcCh6o-KDi9oyH5w0Qyx8VoLS6StaQ2aNEz9Jjg-gCxiZtCRXyigilw549UaV2Wkxtvl6dydffaS3jmaLjh4f9xGkRPEGjffo1V4uCyBB9BChiUBdmjTleVRQ8nBrnVAnjauHa4lWud6HcK59V2MNZMMWmKKooA8qkn35TcnDuynJ2HMCgdIBJuPUOSy25Bxnfp8ENMJVkW_TyOnMy9orm55hlxfJ4D58ZwaQDK4AiEfMHTwIsOngjgSJ4KRCv1QkSUx7XEXMSIMQkTa0jK_Z5-OCVMssAo13W85VQJmZCCKYG6Vm-rnuXIGYfVV-858ow8BYPhCaTaW4dVpKXDCD5_sQljgIJwtVg4ODJcWqzRiYjTis2W5cvPoOXZ5B2fqZU9BXeOAc8Kv6kfCUjt8UyP1Shk07lmgP9onO1btyW9VxPHNnPw166CyrfUW1hAGB0ua1MbkDU7_vN4JZ0cuV5_b-olRo4y_rxd7PdVDBldpVMLlWxZ-XbWUjtZSVwZOMk8KoWatnWz5R4KVK6AgmbELxikS1J61gYI6XSro0Fqu7GM3bWvVPbmqGt8I_Tr3GjiJx6w9HodiKlFPsbLjA79bnHnCpwpHFAXb9wq7vc-H_0MMVTl7xNzo8HgQ_GkOXIu9_n1Rbe-RD4WRiHwTnbnYmzG63xowGNPI7g8Gm7fL_NzCXhox7TIHW28tXQByY8fdw_v-1KoSiaJ3p4pIRyQBmkBzf99FFZOKh5mLK2pkHOH5aenQE6x6pqCjCdqnwS97xbtJJuNAx3UzP7G3iyZSyel8HGtaMTeWHO1nhOedSeq5ahi8tAEyZv0QRqLlA4ZALkThyeCYrJAwW2iBZ9nCEEgzljOMpu2gtzCFy9ZKYYIhifJuT7vPGuXFMKKVX4XU9feh8XH1EVnvxpCnF9yxFgy8nUnBuGlFEV8UBUNh8NApIYcpeL7yCQyl6P7qhrN7HHH4Ih6hKKiUiB-Z4M0rTJOffGz0XFZiZH7XOmJk0MszBlEahAEn2SSRZiQWM8lDTQpGk_JwBJQ_QUNkLfxBpzlK0T0aqKWw3ghXY-OqjzS8q1W8uAc3ZlTT0VGEgVuO26_oEzWNvXbzJ1E_TAqREVKL_9aezms3rjc-FvWRGjLWONMxTtl9g19DWalP6jReRRExH7v0KLGoHuuEnHTsP_hl2vn3NVYiwtQnjQB9zb26JFlpg6EhAuI3xlVL3xpDOjeIO5s72YJcS3r03bB3m5G1IcEU8JDvY1y22Phnb8ef6z5ri8D69rUKY8E9qkhLWaXN24S-6Ab3QeKJrlHGOrhG6fJBtIjL_wFOdZ2j8Z4mPYvbZ5CDQ7g3MraXuiRzqgouy7NIbzjs8FDND8dsLGVt9CKjtU2tykBkIJPfXkgu4-JRTTDN3H4gpzOfwPyW_19tLvPJ4JQlysnxJhJmInSPKTQ9crRGTQeKAwLvYzgB0nPZB1wgPUbGitlhySWZjmjeUNhJsgoFwdtEu9hN4Cz4NYEKgZ3ZpJL-lfeInjtTB07P8ukiWqGxcAiR9L4Ov_xVlMboanWn4CM-8UJvcDhUDkiLktxtI8M7fM5nx-2AR_s0ryCWAubefALQtuDRt51VkfyIfBvQarowH6zH_V_gYIXWNt9oLILOqk4yjrdygFWY9vAvP7V8CYkiFnIUkXcZyClOgfq39mtJxpL3csouZXTHp11gLbmdT5ESn20E8bnZDq5oHEDXlOlfGHOevlzFtB_UxGXtKYX9J1AiKzBrdb7BbozdEp0-xuiy6XDZub79-mKruPL2ZYb1i5hVjQACvFp2PpZOi7xUfJRhOFwf-49JaTOWN3-aXUoCukCi1gj88dCoPYcUuk9ZlMzZdWXIp9gCX27_zSE5YDBaiVCWOsw4CJFbc-kQT9CZ34dSXbs6xKSt9-ahr9osicbGciZ1ICW_6YdK3IzrHuQEzNsCCKDuobUQQdZARQLyaeGl45g37mFoKP7bxoMZcP3F0w37AGLLW1cV-6uNnihYCZtu8YrFPuaxh_UULONMResyLUlDurvlnAUyj1U1MSlC1LkOm_UWoMuPs_UjSc7H77E80rgvBfBA7Z2DP2jV8QQRb6CTbxKiFI9LXfFR729EqDYUuQEI5d3tcyb7u8O2eBv_Tj9O4ODLyZ97gpLuVwuJUoqjARgEOuSiGul1hRqa9y6VtfjL4Njj2Ib1lcbrA.Nqzdpe8b7qsc3BjXFXZYZQ" + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/KeyBackupRestoreTest/d7a019f5da8843aea30722a7edcc37f7", + "kty": "RSA", + "key_ops": [ + "encrypt", + "decrypt", + "sign", + "verify", + "wrapKey", + "unwrapKey" + ], + "n": "v6XXEveP0G4tVvtszozRrSSo6zYDOScH8YBVBBY1CR2MCXBk-iMnKgzUyePi9_ofP3AmOxXx-2AsLC8rxi6n3jQNbGtIvQ4oMdUEhWVcVkmwdl0XyOouofEmIHeSxRg6wXFG4tYAKLmKsO9HqmU5n7ebdDlYngcobc1xHsP0u8e0ltntlgWBlSthmY8AMKW9Sb_teEYhilbkvt_ALr00G_4XHmfq7hSOZePWbGSWQW6yC7__9MrlDfzaSlHyBIyLppPEB7u6Zewrl_eNJWoUVrouIGA32qNETIOr_wxXRVGKoerTt-wFC-CXPn30W_6CmKSxoFBNvnzijg5hAU9V0w", + "e": "AQAB" + }, + "attributes": { + "enabled": false, + "nbf": 1262332800, + "exp": 1893484800, + "created": 1493938217, + "updated": 1493938217, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RestoreSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RestoreSecret-example.json new file mode 100644 index 000000000000..5245ac675eae --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/RestoreSecret-example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "7.0", + "parameters": { + "value": "KUF6dXJlS2V5VmF1bHRTZWNyZXRCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUppTlRjMk5ESTVaaTB5TlRZNExUUTFZbVV0WW1aaFlTMHpOMlZrTURkbVl6QmpPREVpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLmhERDdfVW9aU1ptR2JYN1dYUTU5WDkxZ0FQb05kdDcwZE1BbmgzbjQ3eWNjbkRNOU5vTm1hY0NHZmlNeUwxU0FlZDk0UjhBNDAtVE81TDNfQ05Qal9pdWIyaW03Z21nbHNPNnFFUVVIWU1tOEh2Wl9odFRrdEl4QzRPWEowYTB0S2hscnczZlBvVVFDZHVGcFg0ekEzYTR4VTZXTUNfYjZZVXZqUjZnSGM5TFRUR2tIazh1RTY0aVQ4cmt5RDRrU3RNcXhnU2lfRVZwUUdjWGdfNE9wQ1dBOUFha0N1NkpybGRaQW9BLUtXTWpQbGhaWHFYWGMyVkJlbUJjRTQ1YzY3QWhqYjJrSi1uQ1c5dHBjWS1JZ3JEUHFzWkswOS1WbHVtcl9SbzQzcG5FeW5jVFpTdzZlX1h6VnN0dUFOZHdiM0E2OVR1c1hfYkJKZ0J2SGQ4cDJSUS5WMTlhMVRacjZ2UjJHdEVaWGtOOXJRLmhwMU5IMmwtZklWbVgwWlNfTlRzekJfUEs1aktDUU5rSnJyRUhRQmZjQ2VjdHhmVU5uVlB6MVBqRWNDblZuV0pCUk4zTlFKZm01MjFLRHp1MzBIVUFEUGVmVHJyMFVFS2x5QTM2cThoWFY3VTdoQ0dHNk85NVpYclRsZlVENDI5RTNTNTQxdVBmWGpGR2cxbHlucFNTNnAtVkFzaXFlY1lpQWNuM1hhNzRhUm5xS3N3ZzhyU1ZOX09hSVU3ak1VVUhYZWY1ZmN0NlFrdWFfYkt6Z2dtR2ZiT2RTdVdNRmVQaF9mMkJMUFNGN3k1NThEMFZxSVlNY0JJR0dMU3BQUU93Q094OFF3Y3NVUEp4ZDFuWkVYYjRVNEJZYlhBcmFMX0NwekYxZlhYWVBsdmVUSGdKNVdrR28tWXNJVzAtT3ZqVGdLN2hIamxpR1psd29HOVUtbTJSVDZfbkhseHhVRFMyY3JseGNmay1OOTlXd0tEdUxFMTM5ZE1mN2RCSEl1aTdxd0RXdm1TN2JMTHYzM05Wd19XSl9DT1VGQjgycy1ELXk0UEdIRzVackhsSDgxa25mLVpRblU0SmZfY2lhMWhmWlY3ZFMxb21UZDQtNnJwZmpTMGxFT3VfZTQ5bUpYUGFpZ0hyLWFQYkFzTXJJQ2JvOUVIR2IzMXJ5SlR2QXF2ZmJDbU10bkdLUDV6aUNiZFh3SU5ONzBJTk5lZnJLWGZkZFBUd0RSV3d1ZkxCcGNlU0U0SG5EWVZVQmdkMDl4UUZidG12UDhhTXhhUlpGSTNpWG1fbmpCNmZfdlNhZUNUakdVYVVuRE1QQkdOQWQ5T2xVX3dvUnMtalNCVnVqd1FQSGlGcm5RWElkXzBRdXRYSm54cTU4aUtlTGJvNDJtOHgwaXBRcnB4aEZoUDdHNmZOWXAwVmxXR0RxZ1Q0VlpPQkZsZWRKUU0yaDQtb2xTbXdtUms0M0Y1cjdKd3h4aENqU1JReWx1MGEyQ0ZONWMyZjIxTElZaFliLWNReWFXMDNpV3hsb04zWld5cDJIb1FlUmZPR3lXUzBiU2NBT3JndGpBYnJaUFIwMGRRNnpSOHNBczFYUzh3dzBlaVczbFpsdjJwVWFxOVpTeVhnTS14b2NTOS1ueXRaWGtWWlUwX2dDVXJBV0ZKNG5XdW9oTGM1RkkyRWFQNWR0SXVWa3dnbXlsR1gtYk9ZeHp3dzVGYmI1V3VEbnJ5aDBMSnVic3Q4VXdLdnl3bk1jQ3duMjZSVTNxQVRudGJubVhJS0FyeGkwMldQVk9oTXdpUWZuX2h1TWk5emp3MEVuaXNWdktNWUNnR2xqNWlGZW5Tc0FKUXBiLUY4bng3OWFJQlJaTUc1a0huUDR5dGxmNm9FTkRsRXNJY21aeEtOdEIzcmJPdVROYUhLTXZBNmxSNzlMMDJZSTZrcEdrUUZnaHpIaTBjTWkwbFdCejRTM1AzUEMzZElZSVlQZ0Q2S05kT2FLWHkta0dWdUlsWFNmVlVrMnpzM0NBeTJhZEJjV0NMV094ZkRoQnlwNTl4MHpBRExvdnZySHRLOWF6TGN3N0lTbVl6eUhYMkpobVdReUYtTFd1VzhfcW41SkFVYlB5Z0RTRDYyMi1PTGZQVDZmc2VTWUVBUTFLVWRwZTFnSV9hZWxVT3FaRWN1aE5SckU1YUp0LTN5TEVLVWZIWXF6WTlGbHJrUE5MUC03Y2xRbmEySEhfZmMzZV9LTGtGUDFhQTJjM0RVaERseGhsTzB2bFVmV0c5eXpXaDNZN0NmRFlFMlBaUzZBcFBlYy0wa1NDcEVKMmtCcnFzWG4yeDJDX0FDdTdCTTVGZXNJQkN0M2NqSEdQSVVQRnEteGVmT0RCXzBQcXZDTXpBOHg5Zm10Ny1sNHhVQlJaa0dtZExhZFoxVzdFUXRNRVpsSWMtbDF1V1UzTU15cFZpVWR0OWxJUHVQVUEwc1NrbWxrTGhNSjgyNE5QN0hyVi01dC1ZNDcxaWVKMHdEUjFxMmU4MU8yazdNeTFlTDY3TlY4OVBHYU81SVR5WG1ueUVXMGtVbl9qa3l1UVRkV3dsS09HZVZIYkJWNFpxSXZHWjdQUS02TEE5eXc3a0dyZFRhVFZXOEdOOV9GY1c2VUhjbzA0U3dqTzY2S2x4VlFJWWpBdEZPZlBjWW5xNzF1RndyQS1UZHVDZG1sUFBHOVpjc2tiQmdrbF8wVk90dmhuc0pwYXZKZ2Zka0d3OF9qMkQzd0Jzemd0VndHNk9nNW16eVFwM2pFc0w3UmNtcXd6WFBOaDdKYXdHVDBJMlRvZHYyQ1Z3MDkzWjJlODFXR1NxRnlIejAxdjFBaGN2T2VWdmFjUGM2Y1JJaVduNW93ZF80d2FBdjlyNjVVdmtWa1FLRXpHUmo5eTZILXdZTTMyV1JyMzBlOU9MRTNKUU5POV9kNjRTRmIwSjZHa2VxUmtnNkVXc2xqN1JYLVU1VlhrS1BtMzNpS3c5dGU2NVBqQUNnZThRVDBYVWZEaUx5a1pGeUdpZ09ZMS1TVDFxUlE1eUhMTXhEc3BPRjFXd1lMQ2c2b3hocTlWMm55Z0U1cUJ2ZnYyWUtFaDdjM1dWNjJrYkw3UXJ2d0xkMHVRZ1FwYmUza3E3dGJzcC1lNWlud3cyY0YxQzByeHNScGZJRHlJMmg4b2xHMi1RQUZkWmtlMUlmaE1FZmNfdUdXX2pqSGJSWXVzYnZCRnpKMDdaOVJsVnFMR1A2WXBnTDFsRTFOY09xUVJyYVdxckdDTWZ6SzZMVENQSl93aHJRam9WTzdVRDJIUEVnUjZ2S3U3cWlmTmo3UjE5OUJuRi1EZmlnbk1TYTFKZkZadDNuVXVZOEhMUXRoUzN4MUMxOE50d3dsaDVuNGxYS3d5MERHenljbVNweE05QkdPNTFRckFmSXRfY0xHbUlzMlJ4MzMyeDRIdEZ3Z05nRzFBazNIUno4TlJ4V3lhNWhjb1NoYURXekhES2gyOVp3Vm4wYXVzeWJpal9uNlFGcnZZbjRSOHdPNlRQV3FrS09JcHkxc1lQNWxyNDc1anZSRVZGaFdCWDBiUXdJdnNlM0Q0a0dFQzgzU3FWYkhxY3phZTNwOFNxaG5tQW5ZYzBIbWp4clJfZUMzT0hYVFBGUFZmNDlVWHdrQjIwY1lvcjJ1dzBaTzJ2TUg3S1QwcjBSWDBQVy1qcGpORFpjSGRSNVVCMXFacGlWLWxaYkw0eF9IZW14aWUxY0RPOHNQSXhIOElUSWtOV0tTR1N2eWdraHBBbGl2RzVEZXJObElkeFE2c0tHQ3RtMDEyT2xjN2thaVFaNHh0TjR5ZVpPU2xyS0s0OTlIcWhObzhkNTNsbFFfMW5ncWlHbzhUSDlzWkFrclYwclc3dkJOSF92UlhBdTc2MnlpZGhZUURYYXJXSEFUMm9DU2hEN1lOdnotekoyZGtEajJMcW5CdFNCWFh5T2xsM3o0ZWFITDd2MDZ1QTgxMVBKQU5YZUdoenNaNFVQQUQ2Q0E4cGlxSHB4WGkxODRHNEJETVU4S2VHeHZLWnJiUlNOT2pTOFNrQUJKZERfSklIZ1RhNEFhNzdPUmNZcVY3OWZ5djFZVHNma2lLR2NUYzZIUjZzUVpsamt2U0NQNjdtTTRGUHRqTHlfX1pDQlNwdnRSVWd5UlpNM1dSOUViNHkxa29uRG4zUjMzN2lpSzdfbGtIa1UtZ21VbUpZUVdnUjYzT01pZUdRUHdNR3BSZXlRWE5yckJVTDN2Z2JYdjlac1ZDcDh1NHRwQjBleXJvUXgxZC1KSWJvOWVyR1VlX0ZzU1Fpd0tIaGFIUk02Nzh5dENkcHJFbDBWeG92TFVrX0xNcTFjN1R4MG5jbFl2WE4yUjhEMXNhU2FibkJSd19CU2tZMFNMSXdhb2RpY2o2ZzdLd0ZfMXB2eThhNF9LbnJNLUNkenBvdHA0aTd4QUJuY2JRVUEwWkpsYlp1elRpR0F4ZjFnclk1Z0dZOTVoWi1XZG1lOWlSazBHRTJGN3d4MlJyLUVvS3lZRjNjak0xMWt6MWFmME9fNFdyOXJoU3JrX1NHU3l2a3ZCTW9NZ0xOX0tSS1BlTjlqUnpwRlVST2VnN2NCbGlhdy1odnZhY2lCeDN2UWRqTE5jTldQdU1UbzVmME1QbmU4TUtXcFBoWjBySElMaEVuYW1pcG82X3pzNjczcE9ma09FS0JWWE9mUDEzR0UwS25SWTBab2JPLWRub254LVdBY1dodFZvX08xbkwwTWE5ZXFMMURhRGhJU0JNbVRIM1hkY2dDTnF0emIwcVMtS1l5Mk9zRzZOakRDVEM1aEI3MXIwU09WMUprNFV2QjdYemxTTW9YUXJnTzF2ZFVwSGtxaVhUM1RJZmlQMWRKcDEweDlSMlp5R0lzUzljQUtNMEZyMGRxQmJmQy16NTJpcWZweW4zUVVqb1Fld2hPYnJwUEZGOF9lUmVNRlIwSXZjUkxnMHpwek56UzU1N1pkQkZhemxNTThLcnkwN2QyUDAyTnZtclUtN1ZjOW8wZm1qem9WOHVVTG9PMkJHdmFRdnFJNmtBTmQ5VWo1X2JkY2NVUzBhcklzcGFZa1UtUXQtNnQxYU5YUUdGZEtUbFMwSVowek54bkNIZWRySEE4SkYtOFg3d1ZpRW1McXJQbU1Sd25sbWx3SnhxLVlReWMydmdUallSbUxCVU5TS3VrZkJsa2VnMmlCRWdySksxVlNyRWswX0ZvOXkzV1EwVlZuNXhEZXlGc1JuWDI4Tkl6alFQLVNXaHhYbzdPYm5YY1cxZHlWNE1fYjdzM096cEMwOTJWcGZYQkpaTDhBeHgxNGY2TmJzTEpXLW95VEdsaTJFb2FCZHJKQ2JkQlNOdWJlbGdRRmU2V2hqSjRGdlNrYVJISjFTT3ltbGFtQmYwaVNDOGM2X1g2SkZORjNmOXYuQjc5SDJvbVIyTU52SndydHVzclJ4UQ" + } + }, + "responses": { + "200": { + "body": { + "contentType": "text", + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/SecretBackupRestoreTest/01ddd6e3a0d34d35bb5bccecb1251837", + "attributes": { + "enabled": true, + "nbf": 1262332800, + "exp": 1893484800, + "created": 1493938113, + "updated": 1493938113, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/SetCertificateContacts-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/SetCertificateContacts-example.json new file mode 100644 index 000000000000..c5d9f697b5aa --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/SetCertificateContacts-example.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "7.0", + "contacts": { + "contacts": [ + { + "email": "admin@contoso.com", + "name": "John Doe", + "phone": "1111111111" + }, + { + "email": "admin@contoso2.com", + "name": "Johnathan Doeman", + "phone": "2222222222" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/contacts", + "contacts": [ + { + "email": "admin@contoso.com", + "name": "John Doe", + "phone": "1111111111" + }, + { + "email": "admin@contoso2.com", + "name": "Johnathan Doeman", + "phone": "2222222222" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/SetCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/SetCertificateIssuer-example.json new file mode 100644 index 000000000000..837f9fe0205d --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/SetCertificateIssuer-example.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "issuer-name": "issuer01", + "api-version": "7.0", + "parameters": { + "provider": "Test", + "credentials": { + "account_id": "keyvaultuser", + "pwd": "password" + }, + "org_details": { + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer01", + "provider": "Test", + "credentials": { + "account_id": "keyvaultuser" + }, + "org_details": { + "zip": 0, + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + }, + "attributes": { + "enabled": true, + "created": 1482188806, + "updated": 1482189526 + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/SetSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/SetSecret-example.json new file mode 100644 index 000000000000..6467da0e8038 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/SetSecret-example.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "secret-name": "crpsecret", + "api-version": "7.0", + "parameters": { + "value": "mysecretvalue" + } + }, + "responses": { + "200": { + "body": { + "value": "mysecretvalue", + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441", + "attributes": { + "enabled": true, + "created": 1493938459, + "updated": 1493938459, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateCertificate-example.json new file mode 100644 index 000000000000..a9482deab881 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateCertificate-example.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "certificate-name": "updateCert01", + "certificate-version": "c3d31d7b36c942ad83ef36fc0785a4fc", + "api-version": "7.0", + "parameters": { + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799 + }, + "tags": { + "department": "KeyVaultTest" + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc", + "kid": "https://testvault1021.vault.azure.net/keys/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc", + "sid": "https://testvault1021.vault.azure.net/secrets/updateCert01/c3d31d7b36c942ad83ef36fc0785a4fc", + "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo", + "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=", + "attributes": { + "enabled": true, + "nbf": 1430344421, + "exp": 2208988799, + "created": 1482188981, + "updated": 1482188981 + }, + "tags": { + "department": "KeyVaultTest" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateCertificateIssuer-example.json new file mode 100644 index 000000000000..38f1c364f7bf --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateCertificateIssuer-example.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "issuer-name": "issuer01", + "api-version": "7.0", + "parameters": { + "provider": "Test", + "credentials": { + "account_id": "newuseraccount", + "pwd": "newpassword" + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer01", + "provider": "Test", + "credentials": { + "account_id": "newuseraccount" + }, + "org_details": { + "zip": 0, + "admin_details": [ + { + "first_name": "John", + "last_name": "Doe", + "email": "admin@microsoft.com", + "phone": "4255555555" + } + ] + }, + "attributes": { + "enabled": true, + "created": 1482188806, + "updated": 1482189526 + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateCertificateOperation-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateCertificateOperation-example.json new file mode 100644 index 000000000000..47805089eeb9 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateCertificateOperation-example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "certificate-name": "cancellationRequestedCert01", + "api-version": "7.0", + "certificateOperation": { + "cancellation_requested": true + } + }, + "responses": { + "200": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/cancellationRequestedCert01/pending", + "issuer": { + "name": "issuer02" + }, + "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxxM2zqnPtpH8aiHX5TdEoZLO0Y6fsjk9QcjKgnHomrwUc9vK20UYYEPKt9aGOT7HNx0do8OulPCnLPrKowci8UHu1qRW/qHvsOJQ/UrQoMCHxtXptVc7Avx8WQb045sCdgp/Cl4xO8LMZa70kE4dghZU9zmNZk8wqDIxyYdh1lqqfGe49EWOxcfszTeeKs8KCsQznjExbsudBHLLWoX4VFTGMe3VcIPcV6iFf70buHKznDMXFiRC0IYwkc/GyWIadB1CSEae8k/0evsPI5lYYZLaO/kLffEUtzysqxZNCQR+S0eVPTGTLHa+fndnPPs65XZDzSZi2fZL01oXUfCAQQIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBAKto/ZF9+02fQ3sLuIsRuap/O/AZz3IhAubNfyCaWvVGVAQz/Aqpf5c/liyKhxqRG6LR9Zu50oxRK5222ezR+56vJikjdXRVShf2xYsMm1CbCM1JuzsnkTeoUHHE12xx1srH/9TH+DVZIk6NXxc4wVIagbpwxiS5gR3Nly5k0ZVv7R1B79J0GUqSwK6qjuooWrBsYMEx319hz8fB/Y4jnPE8p+Cnn3AGEqnebVngXncq/QnHxnrRVfvKFVySqRvlsvM8buILmBbIaywEUqwhNtZX2i9E7reEJ8aeZcf+lAeKF3YDvffaXGTc75aiZlBk30Lv/hn0vs9T0/FedUnIae4=", + "cancellation_requested": true, + "status": "inProgress", + "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.", + "request_id": "3dd81d528cc84c5a837c607f1a50f2e1" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateCertificatePolicy-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateCertificatePolicy-example.json new file mode 100644 index 000000000000..8155acd042ac --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateCertificatePolicy-example.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "certificate-name": "updateCert01", + "api-version": "7.0", + "certificatePolicy": { + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297 + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Self" + }, + "attributes": { + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://testvault1021.vault.azure.net/certificates/updateCert01/policy", + "key_props": { + "exportable": true, + "kty": "RSA", + "key_size": 2048, + "reuse_key": false + }, + "secret_props": { + "contentType": "application/x-pkcs12" + }, + "x509_props": { + "subject": "CN=KeyVaultTest", + "ekus": [], + "key_usage": [], + "validity_months": 297, + "basic_constraints": { + "ca": false + } + }, + "lifetime_actions": [ + { + "trigger": { + "lifetime_percentage": 80 + }, + "action": { + "action_type": "EmailContacts" + } + } + ], + "issuer": { + "name": "Self" + }, + "attributes": { + "enabled": true, + "created": 1482188947, + "updated": 1482188948 + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateKey-example.json new file mode 100644 index 000000000000..1a63522e5d8c --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateKey-example.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "key-name": "UpdateKeyAttributesTest", + "key-version": "3d31e6e5c4c14eaf9be8d42c00225088", + "api-version": "7.0", + "parameters": { + "key_ops": [ + "decrypt", + "encrypt" + ], + "attributes": { + "enabled": false, + "nbf": 631180800, + "exp": 662716800 + } + } + }, + "responses": { + "200": { + "body": { + "key": { + "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/UpdateKeyAttributesTest/3d31e6e5c4c14eaf9be8d42c00225088", + "kty": "RSA", + "key_ops": [ + "decrypt", + "encrypt" + ], + "n": "tHCSyq1FqGHXIFHs1m4riKYgPFNSTlJGPzxwfUyZJUxxZsFWMxmZRzbM3kcXC5N40AJfeqDOMs0gY0LZEfhw8kJHBf2GEH2Sz923E4OQjLk_ECdAiKPW_8t22cqD_pGIuB7uibjLZgFFRv7oe0t8cTXKn7IwAH5gQBLs8NNV7hx1Ozy82ekCgOovFldmD3c3P1oZQ_v_-jOP6O202aEfDcZut42J6zI8eYwvGiDKmo2fCPPeth1LYBOeUMnrEZGT_f_w3yAgqvuSkHCL0x4MjZzc2EoNI_3ooAHZohDaPHLRfz8neDPADZzbHA6SDn3GgvC1K_Je5GBmqjTH3aIMlw", + "e": "AQAB" + }, + "attributes": { + "enabled": false, + "nbf": 631180800, + "exp": 662716800, + "created": 1493860275, + "updated": 1493860277, + "recoverylevel": "Recoverable+Purgeable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateSecret-example.json new file mode 100644 index 000000000000..de1d11d4322c --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/UpdateSecret-example.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "secret-name": "crpsecret", + "secret-version": "03bcccc7c8cf4546a0e3e21e52560441", + "api-version": "7.0", + "parameters": { + "tags": { "mytag": "myvalue" }, + "contentType": "myContentType", + "attributes": { + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441", + "contentType": "myContentType", + "attributes": { + "enabled": true, + "created": 1493938459, + "updated": 1493938459, + "recoverylevel": "Recoverable+Purgeable" + }, + "tags": { + "mytag": "myvalue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/backupStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/backupStorageAccount.json new file mode 100644 index 000000000000..eb965f92f26b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/backupStorageAccount.json @@ -0,0 +1,17 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"backupStrg01", + "api-version":"7.0" + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "value":"KUF6dXJlS2V5VmF1bHRTZWNyZXRCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUkwTXpnMVlqQTNZaTFrTlRRM0xUUXlaVFV0WVdVNVpTMDJNVEJrWXpNNVpHWmhaamdpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLk1JeFMyLXh0eHAxekpaZ3ZrTUY3d2pGMWxiLVJyNWFrbHFMLXpBaVVOODJKZFJNUDFwak5iS0phRktIOXBRcDg4ODBKeERDSmdESUZHc19OOGlnYmdIZ0Q1c0xVMi1pRzdKM29Hc00taFRMb05oaUd6aGY1YVREakYzWjZpZVhxcFMzVFVOVUFkeFhpTkpIYk94YjBmWHNtcWFtNnA0dXJ3Yzl3Qnk1c2pwRnJheHNRM3NRcHBDLXZybXlVZExaelJIWS0xYnhwaFQxVUdiS0Zsd1dSODU5TmFSQ1BZOFhDWUVrX0hxNnc5S0lWSXRTTlRYYWYxUWFzUDJob0NHT19PMzkzVUNzWGp0NzRtOURqdi1vTHRoMUl6TU5sSWp0STg2MTRhTGs0RTFMUXd6ZUx2X2Y1cndKeXJOWkF1c3VWRlRieFp1Zzh6T3BfYTdCOGhGSEJyQS5rc3pPdTN3blllb1ZUUjRLc2dqMUxBLmYyY3huVE1BbU13Ty1RcmdHSUFYUFN2bEdZUDRYWmJvMFVFOGxtY2xZa3ZhRE5ab3E0Wm41MVNKTDNuUFZsVnBaRFlrUmlpd05BSUxvRS12QWtVbmZoLUczOWo3RHhqWm1zZW02bXBmOWxoZjBnZFFNTDdmejBqRDZ0dW1xSVFaWUhFalV3VG5xdDloeEw5N0lnUUV0WmtFV0VnUEJETnJJNFpYWXdNU2ZyR0FfdkgzYXU1MWpabDFTWjlGajJsTHpEblNqbFd0U05QSzc3X2RwbUxrTXNCSmMtamRteUpxYmVxdmdRcGFTSUNsOXpUUXFQM2RxN1VQV2c1R1ZDNmlNZjlTcnBoUVRKX1V2bnp4LWk4ZWR6ZUppd2hYNW9HQ043RDNDWjkxTzNLQkhmYklOX1VvQWlQVWxzazFveU9KOEVjMk5mbHhOaFlrNFRKUTFBN2xnbXlLRlNQeVMyaFlwUDA2VEpTb0JUenVTQk5OTVdmT0RaTDFfV3V5eThJcDktdlVHMW5JOENDQ1hIeEVVN2FVLW5nRVR5aFBfbWt3Q2FGLWx2WTNqZlV1Z29wSllLR3VscXZadk1VZHhLYU1oemR2a05ubFdGeXlJNXdiRUdZcWgzWEJ0MS11TThrOFZVTDdQallzVUt4S1dYbzBMblJPZmFTbTZpTm9ZTmFOTm5YbF9fVW9rd05fSWM0eVVYR3RuMFhUcTZ4anQwZUpEajlET3FyYmdiLTZoclltRmxLTUNqalVxSGtLU1VPaHVYSE9jOFdFa0JEM1hiR29idi03b3c0c0gyN0YxbHh2UVh0OVgtOUl1akN5dHBMYmt6YnJVdHZJT2puY19xTUNjMXFFTG1wZHJCTGFoMzVmWHZQZXotVk9zSXBNOGdsekhWUUgyWWZHU0UwaTJqVkxpVllkZlFHeDNwdTZPamdUc1hPUm5acldlbFExMVlNbUJkWlVqWFNlZkVlQkxuT1lBbUNtYWM0dHNTa2JHTXZzQm92OWNEc1NRLWlsQUhsT1Fsanp3Umt1bnIxdk1ITlFhRDJLUEE5eGxxZ2NKU3FGT3d3RzROSzBxamhyb0NoZDFxM2RHR2V3U2tTd2xZbW44ZlM0VEJ5VjFMYmtWb2NZZHpiWDhiZG54dHRhVDhKS0pUbjJETWxjVFpvR1hFbWQzN2ZZVnlaNm5uMXdxZExtVW9XLW5OQXc3T3RLV3hyMXJUNV9qOHZjRGhTWk1HdTF6aV81NDEyVTRLcG01dlQ3c3BpWXA4aDl3Rk5scmFjYnVjZGVlaS1zMWR6cDlqWGo2NjRuWWxoYzNjOHJubjJ4ZWlna09YLTNUSWxnbmdxeXpJWG5ROHU0dTc5TC1ObXk1VFNjLU4wTnJVTUxQVE51MnhsUlE4Y0VLT0h4QkJGQV80Nk1yVXlhbjUwODFMSlYtTVVyaXAycl9tS3FJRjJET2wxS2V1aGg5am9PeFVybUk0T19MYkduVjJTbUdoZEZSd3FxUS15U2pxcFE2OFBza3hlQmxTdDZnX28tLVl6Qkg3dDI4V3ZYYzdIT3paNFBwa0psTjVmWFRwOXgtOGNuTGptcG5Pc2hUZWxTUXRYaDMwcTU3LXJZbVJzc2t2cFZfaTZFX2JUMTk2VWtTOHo2WUp1QXh3LXdlZ2tPY1ZITUxkeW5vaDU2UUtuWDhMVFdHdjhqWWNQazlaSlNSbXljTExOcWNtRnpUU1JEbzBXMXBkQVJXY2tqRFM2VFZIdTlHSElsTG9oRnpONEU1T3FqdUMxRjEwSFZjUGxoNTc5UmczWk1SNWJoVjltSEZNOFhJZU9HTHAxZFkxbnNLY2dqRVVlUW5qcF9za0RzanJZMVVncXRkTTVNVWhNSHlEZlhaZ3libk1jSDVRaml0YjdWZktrQk1YcGRwU3pLQWx0WDNjelIwODRPVm5nVGtiV2JZQURDTUQ2N1dlLWM1ZDFONHI2WFdFb2RXelNyWlhyZmc0RVRNNG1UZnV3ZjB0d3NORkRJdW5BWDkwbnZJWm1Ualo2RktpTjBiRnVNWmRpR1NKNTZNUEZMcFd3N3p0dmVmN0xENmhjNHJESXBQbEkwTVlVWTJSLWZGakdaZ29JTmdKMkVuMGFFM0c1V1RySjRxcHhhdHB4MVk3ZUgzOUk3WTYzcEJFWEtkRWIwTmstM0tnM0ljbDJPSkp6SU1fM1VHSlJTTmRQWGlfV3ViNGRTMDV4eURzZTR0d1FXdm9rb1QybHlZNGphNlVOc3lvYWN1eGFsTUZvUFR5dHF4YlVTaXFIMEZab0pWcm84amZja2wyYklmSzRqRzN6TnJIOWU1c3VUVWJDV09wYjczeFNMMG9TLVQ0T1JSNnBRbTZHQk05bFJ0eUhtMHJUMy1sNXc0c2ItNnRDcTM4S3FRdURRTGVTcDI1Rk8zMU1uVE5nTFlUeEUwUEZDT3hmRG1RY3BOOFRoWHBGbzZLNHNrd0dmQkpKTU9BTWtIUWZnMUM0c0V5cS1PLS1FWFhjbVV6QjJGRnR4c1gwR3o0aGJSdTFiUlhXcWMxU0IyUk82d0JsWGdPUmJqZjJlLWJQUFFMdmtGcWR3bFpUTE1kaWVUdjQyQmd1SFd3dzI5OEVqcnNNUXg1WG9aRG11MDFRTzlZSjFmTEYtWjkwWEVOU2p5OTM0M3UyUHhrNjhheG10bnp2ZTdwd3Q3Z0ZMMUoxZlZEd3BqMUtBZDdwdGZoWG4yUzJmT1Bfc3JOM3QxNk1qX29qOUVLQm5VNC1jQ3RLWGRkZS1EWk5zQkNhSGZ1bEtHSkFHYmx1UWs2Yi1kQk5oUS05Z19kajdfcjZub2Z2aDRielEybGlQd1E3M1RTazNiQTdzd2EzclZ5ZTVDTVNlOVotNkVKV1phek1sN0w4VUJ3cFllN0J0eHhUNEVBVGo2SXBvYWhGNTgtRHpiMmRsc1c1ZDZIWmpYZUNMTGtVRmQ5Mll3eDBibFlCanc4eTVzM040OEJMME84WG51ak42c0F0eG04Sm9hWXFVUUd3LXNBS1pTZHAzNk1GNlZXYkpUcHBoZHQ2aEhWQjFoRzdpSGN1STBTRzY0WjczNXEzZ0tSYXFHdzhIUXItSWNyeks0VEQwenk5b01NMHpRLVFBSE1PdzAyX0ozU3pVQWZ1bzFWNU42ajB0VGsyeEt0TFp3cmlHOHJNRl9NWTJrN09mdkxqNFlCb3VNN2lBNVM4LnNfM0VabFhIb1lrV283ZzdpRUp1bHc" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/decrypt-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/decrypt-example.json new file mode 100644 index 000000000000..c0959da2b9c2 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/decrypt-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "key-name": "sdktestkey", + "key-version": "4eb68492b5f6421e835d961ad2be3155", + "api-version": "7.0", + "parameters": { + "alg": "RSA-OAEP", + "value": "sid-4nG3FzRIFWXLXlG-FZo6H1-kzbNX5Exe0_VRqcGLuJWjI9oSofsn-2IagDsQzkpNAXv9V8aoIizelrK_14darhxaAV8OejO7Oh7spjxa7IxMVS3e-cwcLdEHzMbMfM1uFpDyRFqEUASHI0H8F1M2m1e9TUSXOVW3KMqm7cK94ZQMFvd4AYdLfmfnStMp_MqIQh4kpIkB6h2b1M3possVrLKH_l2L3uT-qFiwQlH9-dt0Cje5mrkpsYCy4hAXNFUPhIyBWAZwOQylIE2sPuopFs55lRIHpWP2CqNe-IK8tX87BRuJ_Vy3GIFxDjD5uu74scIyQCKMImB6xQ_-mQ" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://testvault1021.vault.azure.net/keys/sdktestkey/4eb68492b5f6421e835d961ad2be3155", + "value": "dvDmrSBpjRjtYg" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/deleteStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/deleteStorageAccount.json new file mode 100644 index 000000000000..175825c1ccc1 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/deleteStorageAccount.json @@ -0,0 +1,31 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"deleteStrg01", + "api-version":"7.0" + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/deleteStrg01", + "resourceId":"/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName":"key1", + "autoRegenerateKey":true, + "regenerationPeriod":"P30D", + "recoveryId":"https://storage-sdk-test.vault-int.azure-int.net/deletedstorage/deleteStrg01", + "scheduledPurgeDate":1490790000, + "deletedDate":1490760000, + "attributes":{ + "enabled":true, + "created":1490738386, + "updated":1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags":{"tag1":"val1", "tag2":"val2"} + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/deleteStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/deleteStorageSasDefinition.json new file mode 100644 index 000000000000..053503f09c2f --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/deleteStorageSasDefinition.json @@ -0,0 +1,31 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"deletesas01", + "sas-definition-name":"deleteStrgSasDef01", + "api-version":"7.0" + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/deletesas01/sas/deleteStrgSasDef01", + "sid":"https://storage-sdk-test.vault-int.azure-int.net/secrets/deletesas01-deleteStrgSasDef01", + "templateUri":"se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=XXFNfuMCHYrBx0bhemJ7PWn0xGfImMXT6LfbXWvtRUk%3D", + "sasType":"service", + "validityPeriod":"P15D", + "recoveryId":"https://storage-sdk-test.vault-int.azure-int.net/deletedstorage/deletesas01/sas/deleteStrgSasDef01", + "scheduledPurgeDate":1490790000, + "deletedDate":1490760000, + "attributes":{ + "enabled":true, + "created":1490738438, + "updated":1490738438, + "recoveryLevel": "Recoverable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/encrypt-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/encrypt-example.json new file mode 100644 index 000000000000..a186a87556b5 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/encrypt-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "key-name": "sdktestkey", + "key-version": "f6bc1f3d37c14b2bb1a2ebb4b24e9535", + "api-version": "7.0", + "parameters": { + "alg": "RSA1_5", + "value": "5ka5IVsnGrzufA" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/keys/sdktestkey/f6bc1f3d37c14b2bb1a2ebb4b24e9535", + "value": "CR0Hk0z72oOit5TxObqRpo-WFGZkb5BeN1C0xJFKHxzdDCESYPCNB-OkiWVAnMcSyu6g2aC8riVRRxY5MC2CWKj-CJ_SMke5X2kTi5yi4hJ5vuOLzmg_M6Bmqib7LsI-TeJHr9rs3-tZaSCdZ2zICeFWYduWV5rPjTnAD98epTorT8AA1zMaYHMIhKpmttcj18-dHr0E0T55dgRtsjK04uC3FlRd3odl4RhO1UHAmYpDd5FUqN-20R0dK0Zk8F8sOtThLhEmuLvqPHOCUBiGUhHA4nRDq1La4SUbThu2KMQJL6BbxxEymuliaYcNNtW7MxgVOf6V3mFxVNRY622i9g" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/getDeletedStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/getDeletedStorageAccount.json new file mode 100644 index 000000000000..43514e8bb095 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/getDeletedStorageAccount.json @@ -0,0 +1,31 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"deleteStrg01", + "api-version":"7.0" + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/deleteStrg01", + "resourceId":"/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName":"key1", + "autoRegenerateKey":true, + "regenerationPeriod":"P30D", + "recoveryId":"https://storage-sdk-test.vault-int.azure-int.net/deletedstorage/deleteStrg01", + "scheduledPurgeDate":1490790000, + "deletedDate":1490760000, + "attributes":{ + "enabled":true, + "created":1490738386, + "updated":1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags":{"tag1":"val1", "tag2":"val2"} + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/getDeletedStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/getDeletedStorageSasDefinition.json new file mode 100644 index 000000000000..053503f09c2f --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/getDeletedStorageSasDefinition.json @@ -0,0 +1,31 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"deletesas01", + "sas-definition-name":"deleteStrgSasDef01", + "api-version":"7.0" + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/deletesas01/sas/deleteStrgSasDef01", + "sid":"https://storage-sdk-test.vault-int.azure-int.net/secrets/deletesas01-deleteStrgSasDef01", + "templateUri":"se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=XXFNfuMCHYrBx0bhemJ7PWn0xGfImMXT6LfbXWvtRUk%3D", + "sasType":"service", + "validityPeriod":"P15D", + "recoveryId":"https://storage-sdk-test.vault-int.azure-int.net/deletedstorage/deletesas01/sas/deleteStrgSasDef01", + "scheduledPurgeDate":1490790000, + "deletedDate":1490760000, + "attributes":{ + "enabled":true, + "created":1490738438, + "updated":1490738438, + "recoveryLevel": "Recoverable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/getStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/getStorageAccount.json new file mode 100644 index 000000000000..abb61618810d --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/getStorageAccount.json @@ -0,0 +1,28 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"readStrg01", + "api-version":"7.0" + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/readStrg01", + "resourceId":"/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName":"key1", + "autoRegenerateKey":true, + "regenerationPeriod":"P30D", + "attributes":{ + "enabled":true, + "created":1490738386, + "updated":1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags":{"tag1":"val1", "tag2":"val2"} + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/getStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/getStorageSasDefinition.json new file mode 100644 index 000000000000..f08f22fb76ab --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/getStorageSasDefinition.json @@ -0,0 +1,28 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"getsas01", + "sas-definition-name":"getStrgSasDef01", + "api-version":"7.0" + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/getsas01/sas/getStrgSasDef01", + "sid":"https://storage-sdk-test.vault-int.azure-int.net/secrets/getsas01-getStrgSasDef01", + "templateUri":"se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=XXFNfuMCHYrBx0bhemJ7PWn0xGfImMXT6LfbXWvtRUk%3D", + "sasType":"service", + "validityPeriod":"P15D", + "attributes":{ + "enabled":true, + "created":1490738438, + "updated":1490738438, + "recoveryLevel": "Recoverable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/listDeletedStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/listDeletedStorageAccount.json new file mode 100644 index 000000000000..4f7d60612485 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/listDeletedStorageAccount.json @@ -0,0 +1,46 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "api-version":"7.0" + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "value":[ + { + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/listDeletedStorage01", + "resourceId":"/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc1", + "recoveryId":"https://storage-sdk-test.vault-int.azure-int.net/deletedstorage/listDeletedStorage01", + "scheduledPurgeDate":1490790000, + "deletedDate":1490760000, + "attributes":{ + "enabled":true, + "created":1490738386, + "updated":1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags":{"tag1":"val1", "tag2":"val2"} + }, + { + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/listDeletedStorage02", + "resourceId":"/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc2", + "recoveryId":"https://storage-sdk-test.vault-int.azure-int.net/deletedstorage/listDeletedStorage02", + "scheduledPurgeDate":1490790000, + "deletedDate":1490760000, + "attributes":{ + "enabled":true, + "created":1490738386, + "updated":1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags":{"tag3":"val3", "tag4":"val4"} + } + ], + "nextLink":"https://{BaseUri}/storage?api-version=7.0&%24skiptoken=" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/listDeletedStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/listDeletedStorageSasDefinition.json new file mode 100644 index 000000000000..4db67f9bef8d --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/listDeletedStorageSasDefinition.json @@ -0,0 +1,45 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"listsas01", + "api-version":"7.0" + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "value":[ + { + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/listsas01/sas/listDeletedSasDef01", + "sid":"https://storage-sdk-test.vault-int.azure-int.net/secrets/listsas01-listDeletedSasDef01", + "recoveryId":"https://storage-sdk-test.vault-int.azure-int.net/deletedstorage/listsas01/sas/listDeletedSasDef01", + "scheduledPurgeDate":1490790000, + "deletedDate":1490760000, + "attributes":{ + "enabled":true, + "created":1490738438, + "updated":1490738438, + "recoveryLevel": "Recoverable" + } + }, + { + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/listsas01/sas/listDeletedSasDef02", + "sid":"https://storage-sdk-test.vault-int.azure-int.net/secrets/listsas01-listDeletedSasDef02", + "recoveryId":"https://storage-sdk-test.vault-int.azure-int.net/deletedstorage/listsas01/sas/listDeletedSasDef02", + "scheduledPurgeDate":1490790000, + "deletedDate":1490760000, + "attributes":{ + "enabled":true, + "created":1490738438, + "updated":1490738438, + "recoveryLevel": "Recoverable" + } + } + ], + "nextLink":"https://{BaseUri}/deletedstorage/listsas01/sas?api-version=7.0&%24skiptoken=" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/listStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/listStorageAccount.json new file mode 100644 index 000000000000..ec4cc42b2ce2 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/listStorageAccount.json @@ -0,0 +1,40 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "api-version":"7.0" + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "value":[ + { + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/listStorage01", + "resourceId":"/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc1", + "attributes":{ + "enabled":true, + "created":1490738386, + "updated":1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags":{"tag1":"val1", "tag2":"val2"} + }, + { + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/listStorage02", + "resourceId":"/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc2", + "attributes":{ + "enabled":true, + "created":1490738386, + "updated":1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags":{"tag3":"val3", "tag4":"val4"} + } + ], + "nextLink":"https://{BaseUri}/storage?api-version=7.0&%24skiptoken=" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/listStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/listStorageSasDefinition.json new file mode 100644 index 000000000000..d2450f508fe4 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/listStorageSasDefinition.json @@ -0,0 +1,39 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"listsas01", + "api-version":"7.0" + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "value":[ + { + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/listsas01/sas/listStrgSasDef01", + "sid":"https://storage-sdk-test.vault-int.azure-int.net/secrets/listsas01-listStrgSasDef01", + "attributes":{ + "enabled":true, + "created":1490738438, + "updated":1490738438, + "recoveryLevel": "Recoverable" + } + }, + { + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/listsas01/sas/listStrgSasDef02", + "sid":"https://storage-sdk-test.vault-int.azure-int.net/secrets/listsas01-listStrgSasDef02", + "attributes":{ + "enabled":true, + "created":1490738438, + "updated":1490738438, + "recoveryLevel": "Recoverable" + } + } + ], + "nextLink":"https://{BaseUri}/storage/listsas01/sas?api-version=7.0&%24skiptoken=" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/purgeStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/purgeStorageAccount.json new file mode 100644 index 000000000000..cf9dd5da07ad --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/purgeStorageAccount.json @@ -0,0 +1,17 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"purgeStrg01", + "api-version":"7.0" + }, + "responses":{ + "204":{ + "headers":{ + + }, + "body":{ + + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/recoverStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/recoverStorageAccount.json new file mode 100644 index 000000000000..a7ef83a8c47c --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/recoverStorageAccount.json @@ -0,0 +1,28 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"recoverStrg01", + "api-version":"7.0" + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/recoverStrg01", + "resourceId":"/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName":"key1", + "autoRegenerateKey":true, + "regenerationPeriod":"P30D", + "attributes":{ + "enabled":true, + "created":1490738386, + "updated":1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags":{"tag1":"val1", "tag2":"val2"} + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/recoverStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/recoverStorageSasDefinition.json new file mode 100644 index 000000000000..4b02d03c5dc1 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/recoverStorageSasDefinition.json @@ -0,0 +1,28 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"recoversas01", + "sas-definition-name":"recoverStrgSasDef01", + "api-version":"7.0" + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/recoversas01/sas/recoverStrgSasDef01", + "sid":"https://storage-sdk-test.vault-int.azure-int.net/secrets/recoversas01-recoverStrgSasDef01", + "templateUri":"se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=XXFNfuMCHYrBx0bhemJ7PWn0xGfImMXT6LfbXWvtRUk%3D", + "sasType":"service", + "validityPeriod":"P15D", + "attributes":{ + "enabled":true, + "created":1490738438, + "updated":1490738438, + "recoveryLevel": "Recoverable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/regenerateStorageAccountKey.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/regenerateStorageAccountKey.json new file mode 100644 index 000000000000..b1389de323b2 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/regenerateStorageAccountKey.json @@ -0,0 +1,31 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"regenerateKey01", + "api-version":"7.0", + "parameters":{ + "keyName":"key2" + } + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/regenerateKey01", + "resourceId":"/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName":"key2", + "autoRegenerateKey":true, + "regenerationPeriod":"P10D", + "attributes":{ + "enabled":true, + "created":1490738386, + "updated":1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags":{"tag1":"val1", "tag2":"val2"} + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/restoreStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/restoreStorageAccount.json new file mode 100644 index 000000000000..9c7b34cf01fb --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/restoreStorageAccount.json @@ -0,0 +1,31 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"readStrg01", + "api-version":"7.0", + "parameters":{ + "value": "KUF6dXJlS2V5VmF1bHRTZWNyZXRCYWNrdXBWMS5taWNyb3NvZnQuY29tZXlKcmFXUWlPaUkwTXpnMVlqQTNZaTFrTlRRM0xUUXlaVFV0WVdVNVpTMDJNVEJrWXpNNVpHWmhaamdpTENKaGJHY2lPaUpTVTBFdFQwRkZVQ0lzSW1WdVl5STZJa0V4TWpoRFFrTXRTRk15TlRZaWZRLk1JeFMyLXh0eHAxekpaZ3ZrTUY3d2pGMWxiLVJyNWFrbHFMLXpBaVVOODJKZFJNUDFwak5iS0phRktIOXBRcDg4ODBKeERDSmdESUZHc19OOGlnYmdIZ0Q1c0xVMi1pRzdKM29Hc00taFRMb05oaUd6aGY1YVREakYzWjZpZVhxcFMzVFVOVUFkeFhpTkpIYk94YjBmWHNtcWFtNnA0dXJ3Yzl3Qnk1c2pwRnJheHNRM3NRcHBDLXZybXlVZExaelJIWS0xYnhwaFQxVUdiS0Zsd1dSODU5TmFSQ1BZOFhDWUVrX0hxNnc5S0lWSXRTTlRYYWYxUWFzUDJob0NHT19PMzkzVUNzWGp0NzRtOURqdi1vTHRoMUl6TU5sSWp0STg2MTRhTGs0RTFMUXd6ZUx2X2Y1cndKeXJOWkF1c3VWRlRieFp1Zzh6T3BfYTdCOGhGSEJyQS5rc3pPdTN3blllb1ZUUjRLc2dqMUxBLmYyY3huVE1BbU13Ty1RcmdHSUFYUFN2bEdZUDRYWmJvMFVFOGxtY2xZa3ZhRE5ab3E0Wm41MVNKTDNuUFZsVnBaRFlrUmlpd05BSUxvRS12QWtVbmZoLUczOWo3RHhqWm1zZW02bXBmOWxoZjBnZFFNTDdmejBqRDZ0dW1xSVFaWUhFalV3VG5xdDloeEw5N0lnUUV0WmtFV0VnUEJETnJJNFpYWXdNU2ZyR0FfdkgzYXU1MWpabDFTWjlGajJsTHpEblNqbFd0U05QSzc3X2RwbUxrTXNCSmMtamRteUpxYmVxdmdRcGFTSUNsOXpUUXFQM2RxN1VQV2c1R1ZDNmlNZjlTcnBoUVRKX1V2bnp4LWk4ZWR6ZUppd2hYNW9HQ043RDNDWjkxTzNLQkhmYklOX1VvQWlQVWxzazFveU9KOEVjMk5mbHhOaFlrNFRKUTFBN2xnbXlLRlNQeVMyaFlwUDA2VEpTb0JUenVTQk5OTVdmT0RaTDFfV3V5eThJcDktdlVHMW5JOENDQ1hIeEVVN2FVLW5nRVR5aFBfbWt3Q2FGLWx2WTNqZlV1Z29wSllLR3VscXZadk1VZHhLYU1oemR2a05ubFdGeXlJNXdiRUdZcWgzWEJ0MS11TThrOFZVTDdQallzVUt4S1dYbzBMblJPZmFTbTZpTm9ZTmFOTm5YbF9fVW9rd05fSWM0eVVYR3RuMFhUcTZ4anQwZUpEajlET3FyYmdiLTZoclltRmxLTUNqalVxSGtLU1VPaHVYSE9jOFdFa0JEM1hiR29idi03b3c0c0gyN0YxbHh2UVh0OVgtOUl1akN5dHBMYmt6YnJVdHZJT2puY19xTUNjMXFFTG1wZHJCTGFoMzVmWHZQZXotVk9zSXBNOGdsekhWUUgyWWZHU0UwaTJqVkxpVllkZlFHeDNwdTZPamdUc1hPUm5acldlbFExMVlNbUJkWlVqWFNlZkVlQkxuT1lBbUNtYWM0dHNTa2JHTXZzQm92OWNEc1NRLWlsQUhsT1Fsanp3Umt1bnIxdk1ITlFhRDJLUEE5eGxxZ2NKU3FGT3d3RzROSzBxamhyb0NoZDFxM2RHR2V3U2tTd2xZbW44ZlM0VEJ5VjFMYmtWb2NZZHpiWDhiZG54dHRhVDhKS0pUbjJETWxjVFpvR1hFbWQzN2ZZVnlaNm5uMXdxZExtVW9XLW5OQXc3T3RLV3hyMXJUNV9qOHZjRGhTWk1HdTF6aV81NDEyVTRLcG01dlQ3c3BpWXA4aDl3Rk5scmFjYnVjZGVlaS1zMWR6cDlqWGo2NjRuWWxoYzNjOHJubjJ4ZWlna09YLTNUSWxnbmdxeXpJWG5ROHU0dTc5TC1ObXk1VFNjLU4wTnJVTUxQVE51MnhsUlE4Y0VLT0h4QkJGQV80Nk1yVXlhbjUwODFMSlYtTVVyaXAycl9tS3FJRjJET2wxS2V1aGg5am9PeFVybUk0T19MYkduVjJTbUdoZEZSd3FxUS15U2pxcFE2OFBza3hlQmxTdDZnX28tLVl6Qkg3dDI4V3ZYYzdIT3paNFBwa0psTjVmWFRwOXgtOGNuTGptcG5Pc2hUZWxTUXRYaDMwcTU3LXJZbVJzc2t2cFZfaTZFX2JUMTk2VWtTOHo2WUp1QXh3LXdlZ2tPY1ZITUxkeW5vaDU2UUtuWDhMVFdHdjhqWWNQazlaSlNSbXljTExOcWNtRnpUU1JEbzBXMXBkQVJXY2tqRFM2VFZIdTlHSElsTG9oRnpONEU1T3FqdUMxRjEwSFZjUGxoNTc5UmczWk1SNWJoVjltSEZNOFhJZU9HTHAxZFkxbnNLY2dqRVVlUW5qcF9za0RzanJZMVVncXRkTTVNVWhNSHlEZlhaZ3libk1jSDVRaml0YjdWZktrQk1YcGRwU3pLQWx0WDNjelIwODRPVm5nVGtiV2JZQURDTUQ2N1dlLWM1ZDFONHI2WFdFb2RXelNyWlhyZmc0RVRNNG1UZnV3ZjB0d3NORkRJdW5BWDkwbnZJWm1Ualo2RktpTjBiRnVNWmRpR1NKNTZNUEZMcFd3N3p0dmVmN0xENmhjNHJESXBQbEkwTVlVWTJSLWZGakdaZ29JTmdKMkVuMGFFM0c1V1RySjRxcHhhdHB4MVk3ZUgzOUk3WTYzcEJFWEtkRWIwTmstM0tnM0ljbDJPSkp6SU1fM1VHSlJTTmRQWGlfV3ViNGRTMDV4eURzZTR0d1FXdm9rb1QybHlZNGphNlVOc3lvYWN1eGFsTUZvUFR5dHF4YlVTaXFIMEZab0pWcm84amZja2wyYklmSzRqRzN6TnJIOWU1c3VUVWJDV09wYjczeFNMMG9TLVQ0T1JSNnBRbTZHQk05bFJ0eUhtMHJUMy1sNXc0c2ItNnRDcTM4S3FRdURRTGVTcDI1Rk8zMU1uVE5nTFlUeEUwUEZDT3hmRG1RY3BOOFRoWHBGbzZLNHNrd0dmQkpKTU9BTWtIUWZnMUM0c0V5cS1PLS1FWFhjbVV6QjJGRnR4c1gwR3o0aGJSdTFiUlhXcWMxU0IyUk82d0JsWGdPUmJqZjJlLWJQUFFMdmtGcWR3bFpUTE1kaWVUdjQyQmd1SFd3dzI5OEVqcnNNUXg1WG9aRG11MDFRTzlZSjFmTEYtWjkwWEVOU2p5OTM0M3UyUHhrNjhheG10bnp2ZTdwd3Q3Z0ZMMUoxZlZEd3BqMUtBZDdwdGZoWG4yUzJmT1Bfc3JOM3QxNk1qX29qOUVLQm5VNC1jQ3RLWGRkZS1EWk5zQkNhSGZ1bEtHSkFHYmx1UWs2Yi1kQk5oUS05Z19kajdfcjZub2Z2aDRielEybGlQd1E3M1RTazNiQTdzd2EzclZ5ZTVDTVNlOVotNkVKV1phek1sN0w4VUJ3cFllN0J0eHhUNEVBVGo2SXBvYWhGNTgtRHpiMmRsc1c1ZDZIWmpYZUNMTGtVRmQ5Mll3eDBibFlCanc4eTVzM040OEJMME84WG51ak42c0F0eG04Sm9hWXFVUUd3LXNBS1pTZHAzNk1GNlZXYkpUcHBoZHQ2aEhWQjFoRzdpSGN1STBTRzY0WjczNXEzZ0tSYXFHdzhIUXItSWNyeks0VEQwenk5b01NMHpRLVFBSE1PdzAyX0ozU3pVQWZ1bzFWNU42ajB0VGsyeEt0TFp3cmlHOHJNRl9NWTJrN09mdkxqNFlCb3VNN2lBNVM4LnNfM0VabFhIb1lrV283ZzdpRUp1bHc" + } + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/restoreStrg01", + "resourceId":"/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName":"key1", + "autoRegenerateKey":true, + "regenerationPeriod":"P30D", + "attributes":{ + "enabled":true, + "created":1490738386, + "updated":1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags":{"tag1":"val1", "tag2":"val2"} + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/setStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/setStorageAccount.json new file mode 100644 index 000000000000..db6474b3796e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/setStorageAccount.json @@ -0,0 +1,38 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"setStrg01", + "api-version":"7.0", + "parameters":{ + "resourceId":"/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName":"key2", + "autoRegenerateKey":true, + "regenerationPeriod":"P15D", + "attributes":{ + "enabled":true + }, + "tags":{"tag1":"val1", "tag2":"val2"} + } + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/setStrg01", + "resourceId":"/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName":"key2", + "autoRegenerateKey":true, + "regenerationPeriod":"P15D", + "attributes":{ + "enabled":true, + "created":1490738386, + "updated":1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags":{"tag1":"val1", "tag2":"val2"} + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/setStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/setStorageSasDefinition.json new file mode 100644 index 000000000000..0552b1f9612a --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/setStorageSasDefinition.json @@ -0,0 +1,36 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"setsas01", + "sas-definition-name":"setStrgSasDef01", + "api-version":"7.0", + "parameters":{ + "templateUri":"se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=XXFNfuMCHYrBx0bhemJ7PWn0xGfImMXT6LfbXWvtRUk%3D", + "sasType":"service", + "validityPeriod":"P15D", + "attributes":{ + "enabled":true + } + } + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/setsas01/sas/setStrgSasDef01", + "sid":"https://storage-sdk-test.vault-int.azure-int.net/secrets/setsas01-setStrgSasDef01", + "templateUri":"se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=XXFNfuMCHYrBx0bhemJ7PWn0xGfImMXT6LfbXWvtRUk%3D", + "sasType":"service", + "validityPeriod":"P15D", + "attributes":{ + "enabled":true, + "created":1490738438, + "updated":1490738438, + "recoveryLevel": "Recoverable" + } + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/sign-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/sign-example.json new file mode 100644 index 000000000000..3ba80b5c4860 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/sign-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "key-name": "testkey", + "key-version": "9885aa558e8d448789683188f8c194b0", + "api-version": "7.0", + "parameters": { + "alg": "RS512", + "value": "RUE3Nzg4NTQ4QjQ5RjFFN0U2NzAyQzhDNEMwMkJDOTA1MTYyOTUzNjI5NDhBNzZDQTlFOTM1NDA2M0ZGMjk2Mg" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://demo-test-vault.vault.azure.net/keys/testkey/9885aa558e8d448789683188f8c194b0", + "value": "aKFG8NXcfTzqyR44rW42484K_zZI_T7zZuebvWuNgAoEI1gXYmxrshp42CunSmmu4oqo4-IrCikPkNIBkHXnAW2cv03Ad0UpwXhVfepK8zzDBaJPMKVGS-ZRz8CshEyGDKaLlb3J3zEkXpM3RrSEr0mdV6hndHD_mznLB5RmFui5DsKAhez4vUqajgtkgcPfCekMqeSwp6r9ItVL-gEoAohx8XMDsPedqu-7BuZcBcdayaPuBRL4wWoTDULA11P-UN_sJ5qMj3BbiRYhIlBWGR04wIGfZ3pkJjHJUpOvgH2QajdYPzUBauOCewMYbq9XkLRSzI_A7HkkDVycugSeAA" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/unwrapKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/unwrapKey-example.json new file mode 100644 index 000000000000..67cb589cd5ff --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/unwrapKey-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "key-name": "sdktestkey", + "key-version": "0698c2156c1a4e1da5b6bab6f6422fd6", + "api-version": "7.0", + "parameters": { + "alg": "RSA1_5", + "value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6", + "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/updateStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/updateStorageAccount.json new file mode 100644 index 000000000000..536fc7cd621b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/updateStorageAccount.json @@ -0,0 +1,32 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"patchStrg01", + "api-version":"7.0", + "parameters":{ + "activeKeyName":"key1", + "regenerationPeriod":"P10D" + } + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/patchStrg01", + "resourceId":"/subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Storage/storageAccounts/kvstorageacc", + "activeKeyName":"key1", + "autoRegenerateKey":true, + "regenerationPeriod":"P10D", + "attributes":{ + "enabled":true, + "created":1490738386, + "updated":1490738386, + "recoveryLevel": "Recoverable+Purgeable" + }, + "tags":{"tag1":"val1", "tag2":"val2"} + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/updateStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/updateStorageSasDefinition.json new file mode 100644 index 000000000000..30d3cb9f8bc8 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/updateStorageSasDefinition.json @@ -0,0 +1,36 @@ +{ + "parameters":{ + "vaultBaseUrl":"https://storage-sdk-test.vault-int.azure-int.net/", + "storage-account-name":"patchsas01", + "sas-definition-name":"patchStrgSasDef01", + "api-version":"7.0", + "parameters":{ + "templateUri":"se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=XXFNfuMCHYrBx0bhemJ7PWn0xGfImMXT6LfbXWvtRUk%3D", + "sasType":"service", + "validityPeriod":"P15D", + "attributes":{ + "enabled":true + } + } + }, + "responses":{ + "200":{ + "headers":{ + + }, + "body":{ + "id":"https://storage-sdk-test.vault-int.azure-int.net/storage/patchsas01/sas/patchStrgSasDef01", + "sid":"https://storage-sdk-test.vault-int.azure-int.net/secrets/patchsas01-patchStrgSasDef01", + "templateUri":"se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=XXFNfuMCHYrBx0bhemJ7PWn0xGfImMXT6LfbXWvtRUk%3D", + "sasType":"service", + "validityPeriod":"P15D", + "attributes":{ + "enabled":true, + "created":1490738438, + "updated":1490738438, + "recoveryLevel": "Recoverable" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/verify-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/verify-example.json new file mode 100644 index 000000000000..fe92a8acccb7 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/verify-example.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "key-name": "testkey", + "key-version": "9885aa558e8d448789683188f8c194b0", + "api-version": "7.0", + "parameters": { + "alg": "RS512", + "value": "RUE3Nzg4NTQ4QjQ5RjFFN0U2NzAyQzhDNEMwMkJDOTA1MTYyOTUzNjI5NDhBNzZDQTlFOTM1NDA2M0ZGMjk2Mg" + } + }, + "responses": { + "200": { + "body": { + "value": true + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/wrapKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/wrapKey-example.json new file mode 100644 index 000000000000..873f5a8f7d99 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/examples/wrapKey-example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "key-name": "sdktestkey", + "key-version": "0698c2156c1a4e1da5b6bab6f6422fd6", + "api-version": "7.0", + "parameters": { + "alg": "RSA1_5", + "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo" + } + }, + "responses": { + "200": { + "body": { + "kid": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6", + "value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw" + } + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/index.md b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/index.md new file mode 100644 index 000000000000..d65bfa10917e --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/index.md @@ -0,0 +1,30 @@ +--- +ms.assetid: 357c9947-1098-4a03-9f1e-7b27e5aa75bf +ms.title: Azure Key Vault REST Reference +ms.prod: +ms.service: azure-keyvault +author: BrucePerlerMS +ms.author: bruceper +ms.manager: mbaldwin +--- + + +# Azure Key Vault + +Azure Key Vault enables users to store and use cryptographic keys within the Microsoft Azure environment. Azure Key Vault supports multiple key types and algorithms, and enables the use of Hardware Security Modules (HSM) for high value customer keys. Key Vault also supports storage of secrets, limited size octet objects. Certificate management is also available through Key Vault including support for renewal processing and workign with a range of certificate authorities. + + +## REST Operation Groups + +| Operation Group | Description | +|-----------------|-------------| +|Keys | Operations for interacting with keys including create, import, update, and delete.| +|Secrets | Operations for interacting with secrets including create, update, and delete.| +|Certificates | Operations for interacting with certificates including create, import, update, delete and a set of contact and renawal management tasks.| +|Storage | Operations for interacting with storage accounts including create, read, update, delete, list, regeneratekey and a set of sas definition related tasks.| + +## See Also + +- [About keys, secrets, certificates and storage](link) + + diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json new file mode 100644 index 000000000000..1ce1520f2a45 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json @@ -0,0 +1,5935 @@ +{ + "swagger": "2.0", + "info": { + "title": "KeyVaultClient", + "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", + "version": "7.0" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{vaultBaseUrl}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "vaultBaseUrl", + "description": "The vault name, for example https://myvault.vault.azure.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/keys/{key-name}/create": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "CreateKey", + "summary": "Creates a new key, stores it, then returns key parameters and attributes to the client.", + "description": "The create key operation can be used to create any key type in Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. It requires the keys/create permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z-]+$", + "description": "The name for the new key. The system will generate the version name for the new key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyCreateParameters" + }, + "description": "The parameters to create a key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A key bundle containing the result of the create key request.", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Create key": { + "$ref": "./examples//CreateKey-example.json" + } + } + } + }, + "/keys/{key-name}": { + "put": { + "tags": [ + "Keys" + ], + "operationId": "ImportKey", + "summary": "Imports an externally created key, stores it, and returns key parameters and attributes to the client.", + "description": "The import key operation may be used to import any key type into an Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the key. This operation requires the keys/import permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z-]+$", + "description": "Name for the imported key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyImportParameters" + }, + "description": "The parameters to import a key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Imported key bundle to the vault.", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Import key": { + "$ref": "./examples//ImportKey-example.json" + } + } + }, + "delete": { + "tags": [ + "Keys" + ], + "operationId": "DeleteKey", + "summary": "Deletes a key of any type from storage in Azure Key Vault.", + "description": "The delete key operation cannot be used to remove individual versions of a key. This operation removes the cryptographic material associated with the key, which means the key is not usable for Sign/Verify, Wrap/Unwrap or Encrypt/Decrypt operations. This operation requires the keys/delete permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The public part of the deleted key and deletion information on when the key will be purged.", + "schema": { + "$ref": "#/definitions/DeletedKeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Delete key": { + "$ref": "./examples//DeleteKey-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}": { + "patch": { + "tags": [ + "Keys" + ], + "operationId": "UpdateKey", + "summary": "The update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault.", + "description": "In order to perform this operation, the key must already exist in the Key Vault. Note: The cryptographic material of a key itself cannot be changed. This operation requires the keys/update permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of key to update." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the key to update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyUpdateParameters" + }, + "description": "The parameters of the key to update." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The updated key.", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Update key": { + "$ref": "./examples//UpdateKey-example.json" + } + } + }, + "get": { + "tags": [ + "Keys" + ], + "operationId": "GetKey", + "summary": "Gets the public part of a stored key.", + "description": "The get key operation is applicable to all key types. If the requested key is symmetric, then no key material is released in the response. This operation requires the keys/get permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key to get." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "Adding the version parameter retrieves a specific version of a key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A key bundle containing the key and its attributes.", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Get key": { + "$ref": "./examples//GetKey-example.json" + } + } + } + }, + "/keys/{key-name}/versions": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "GetKeyVersions", + "summary": "Retrieves a list of individual key versions with the same key name.", + "description": "The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of keys along with a link to the next page of keys.", + "schema": { + "$ref": "#/definitions/KeyListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetKeyVersions": { + "$ref": "./examples//GetKeyVersions-example.json" + } + } + } + }, + "/keys": { + "get": { + "tags": [ + "Keys" + ], + "operationId": "GetKeys", + "summary": "List keys in the specified vault.", + "description": "Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of keys in the vault along with a link to the next page of keys.", + "schema": { + "$ref": "#/definitions/KeyListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetKeys": { + "$ref": "./examples//GetKeys-example.json" + } + } + } + }, + "/keys/{key-name}/backup": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "BackupKey", + "summary": "Requests that a backup of the specified key be downloaded to the client.", + "description": "The Key Backup operation exports a key from Azure Key Vault in a protected form. Note that this operation does NOT return key material in a form that can be used outside the Azure Key Vault system, the returned key material is either protected to a Azure Key Vault HSM or to Azure Key Vault itself. The intent of this operation is to allow a client to GENERATE a key in one Azure Key Vault instance, BACKUP the key, and then RESTORE it into another Azure Key Vault instance. The BACKUP operation may be used to export, in protected form, any key type from Azure Key Vault. Individual versions of a key cannot be backed up. BACKUP / RESTORE can be performed within geographical boundaries only; meaning that a BACKUP from one geographical area cannot be restored to another geographical area. For example, a backup from the US geographical area cannot be restored in an EU geographical area. This operation requires the key/backup permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The backup blob containing the backed up key.", + "schema": { + "$ref": "#/definitions/BackupKeyResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "BackupKey": { + "$ref": "./examples//BackupKey-example.json" + } + } + } + }, + "/keys/restore": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "RestoreKey", + "summary": "Restores a backed up key to a vault.", + "description": "Imports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation may be used to import a previously backed up key. Individual versions of a key cannot be restored. The key is restored in its entirety with the same key name as it had when it was backed up. If the key name is not available in the target Key Vault, the RESTORE operation will be rejected. While the key name is retained during restore, the final key identifier will change if the key is restored to a different vault. Restore will restore all versions and preserve version identifiers. The RESTORE operation is subject to security constraints: The target Key Vault must be owned by the same Microsoft Azure Subscription as the source Key Vault The user must have RESTORE permission in the target Key Vault. This operation requires the keys/restore permission.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyRestoreParameters" + }, + "description": "The parameters to restore the key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Restored key bundle in the vault.", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "RestoreKey": { + "$ref": "./examples//RestoreKey-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}/encrypt": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "encrypt", + "summary": "Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.", + "description": "The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encypt permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyOperationsParameters" + }, + "description": "The parameters for the encryption operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The encryption result.", + "schema": { + "$ref": "#/definitions/KeyOperationResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Encrypt example": { + "$ref": "./examples//encrypt-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}/decrypt": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "decrypt", + "summary": "Decrypts a single block of encrypted data.", + "description": "The DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the ENCRYPT operation; only a single block of data may be decrypted, the size of this block is dependent on the target key and the algorithm to be used. The DECRYPT operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/decrypt permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyOperationsParameters" + }, + "description": "The parameters for the decryption operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The decryption result.", + "schema": { + "$ref": "#/definitions/KeyOperationResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Decrypt example": { + "$ref": "./examples//decrypt-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}/sign": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "sign", + "summary": "Creates a signature from a digest using the specified key.", + "description": "The SIGN operation is applicable to asymmetric and symmetric keys stored in Azure Key Vault since this operation uses the private portion of the key. This operation requires the keys/sign permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeySignParameters" + }, + "description": "The parameters for the signing operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The signature value.", + "schema": { + "$ref": "#/definitions/KeyOperationResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Sign": { + "$ref": "./examples//sign-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}/verify": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "verify", + "summary": "Verifies a signature using a specified key.", + "description": "The VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault since signature verification can be performed using the public portion of the key but this operation is supported as a convenience for callers that only have a key-reference and not the public portion of the key. This operation requires the keys/verify permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyVerifyParameters" + }, + "description": "The parameters for verify operations." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The verification result.", + "schema": { + "$ref": "#/definitions/KeyVerifyResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Verify": { + "$ref": "./examples//verify-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}/wrapkey": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "wrapKey", + "summary": "Wraps a symmetric key using a specified key.", + "description": "The WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using the public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/wrapKey permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyOperationsParameters" + }, + "description": "The parameters for wrap operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The wrapped symmetric key.", + "schema": { + "$ref": "#/definitions/KeyOperationResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Wrapkey": { + "$ref": "./examples//wrapKey-example.json" + } + } + } + }, + "/keys/{key-name}/{key-version}/unwrapkey": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "unwrapKey", + "summary": "Unwraps a symmetric key using the specified key that was initially used for wrapping that key.", + "description": "The UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The UNWRAP operation applies to asymmetric and symmetric keys stored in Azure Key Vault since it uses the private portion of the key. This operation requires the keys/unwrapKey permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "name": "key-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyOperationsParameters" + }, + "description": "The parameters for the key operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The unwrapped symmetric key.", + "schema": { + "$ref": "#/definitions/KeyOperationResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Unwrapkey": { + "$ref": "./examples//unwrapKey-example.json" + } + } + } + }, + "/deletedkeys": { + "get": { + "tags": [ + "DeletedKeys" + ], + "operationId": "GetDeletedKeys", + "summary": "Lists the deleted keys in the specified vault.", + "description": "Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of deleted keys in the vault along with a link to the next page of deleted keys.", + "schema": { + "$ref": "#/definitions/DeletedKeyListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetDeletedKeys": { + "$ref": "./examples//GetDeletedKeys-example.json" + } + } + } + }, + "/deletedkeys/{key-name}": { + "get": { + "tags": [ + "DeletedKeys" + ], + "operationId": "GetDeletedKey", + "summary": "Gets the public part of a deleted key.", + "description": "The Get Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/get permission. ", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion information.", + "schema": { + "$ref": "#/definitions/DeletedKeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetDeletedKey": { + "$ref": "./examples//GetDeletedKey-example.json" + } + } + }, + "delete": { + "tags": [ + "DeletedKeys" + ], + "operationId": "PurgeDeletedKey", + "summary": "Permanently deletes the specified key.", + "description": "The Purge Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/purge permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No content, signaling that the key was permanently purged." + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "PurgeDeletedKey": { + "$ref": "./examples//PurgeDeletedKey-example.json" + } + } + } + }, + "/deletedkeys/{key-name}/recover": { + "post": { + "tags": [ + "DeletedKeys" + ], + "operationId": "RecoverDeletedKey", + "summary": "Recovers the deleted key to its latest version.", + "description": "The Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under /keys. An attempt to recover an non-deleted key will return an error. Consider this the inverse of the delete operation on soft-delete enabled vaults. This operation requires the keys/recover permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deleted key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A Key bundle of the original key and its attributes", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "RecoverDeletedKey": { + "$ref": "./examples//RecoverDeletedKey-example.json" + } + } + } + }, + "/secrets/{secret-name}": { + "put": { + "tags": [ + "Secrets" + ], + "operationId": "SetSecret", + "summary": "Sets a secret in a specified key vault.", + "description": " The SET operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This operation requires the secrets/set permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z-]+$", + "description": "The name of the secret." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/SecretSetParameters" + }, + "description": "The parameters for setting the secret." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A secret bundle containing the result of the set secret request.", + "schema": { + "$ref": "#/definitions/SecretBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Setsecret": { + "$ref": "./examples//SetSecret-example.json" + } + } + }, + "delete": { + "tags": [ + "Secrets" + ], + "operationId": "DeleteSecret", + "summary": "Deletes a secret from a specified key vault.", + "description": "The DELETE operation applies to any secret stored in Azure Key Vault. DELETE cannot be applied to an individual version of a secret. This operation requires the secrets/delete permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted secret and information on when the secret will be deleted, and how to recover the deleted secret.", + "schema": { + "$ref": "#/definitions/DeletedSecretBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "DeleteSecret": { + "$ref": "./examples//DeleteSecret-example.json" + } + } + } + }, + "/secrets/{secret-name}/{secret-version}": { + "patch": { + "tags": [ + "Secrets" + ], + "operationId": "UpdateSecret", + "summary": "Updates the attributes associated with a specified secret in a given key vault.", + "description": "The UPDATE operation changes specified attributes of an existing stored secret. Attributes that are not specified in the request are left unchanged. The value of a secret itself cannot be changed. This operation requires the secrets/set permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "name": "secret-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the secret." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/SecretUpdateParameters" + }, + "description": "The parameters for update secret operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The updated secret.", + "schema": { + "$ref": "#/definitions/SecretBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "UpdateSecret": { + "$ref": "./examples//UpdateSecret-example.json" + } + } + }, + "get": { + "tags": [ + "Secrets" + ], + "operationId": "GetSecret", + "summary": "Get a specified secret from a given key vault.", + "description": "The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "name": "secret-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the secret." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved secret.", + "schema": { + "$ref": "#/definitions/SecretBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetSecret": { + "$ref": "./examples//GetSecret-example.json" + } + } + } + }, + "/secrets": { + "get": { + "tags": [ + "Secrets" + ], + "operationId": "GetSecrets", + "summary": "List secrets in a specified key vault.", + "description": "The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation requires the secrets/list permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified, the service will return up to 25 results." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of secrets in the vault along with a link to the next page of secrets.", + "schema": { + "$ref": "#/definitions/SecretListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetSecrets": { + "$ref": "./examples//GetSecrets-example.json" + } + } + } + }, + "/secrets/{secret-name}/versions": { + "get": { + "tags": [ + "Secrets" + ], + "operationId": "GetSecretVersions", + "summary": "List all versions of the specified secret.", + "description": "The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified, the service will return up to 25 results." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of secrets along with a link to the next page of secrets.", + "schema": { + "$ref": "#/definitions/SecretListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetSecretVersions": { + "$ref": "./examples//GetSecretVersions-example.json" + } + } + } + }, + "/deletedsecrets": { + "get": { + "tags": [ + "DeletedSecrets" + ], + "operationId": "GetDeletedSecrets", + "summary": "Lists deleted secrets for the specified vault.", + "description": "The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of deleted secrets in the vault, along with a link to the next page of deleted secrets.", + "schema": { + "$ref": "#/definitions/DeletedSecretListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetDeletedSecrets": { + "$ref": "./examples//GetDeletedSecrets-example.json" + } + } + } + }, + "/deletedsecrets/{secret-name}": { + "get": { + "tags": [ + "DeletedSecrets" + ], + "operationId": "GetDeletedSecret", + "summary": "Gets the specified deleted secret.", + "description": "The Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A secret bundle of the secret and its attributes.", + "schema": { + "$ref": "#/definitions/DeletedSecretBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetDeletedSecret": { + "$ref": "./examples//GetDeletedSecret-example.json" + } + } + }, + "delete": { + "tags": [ + "DeletedSecrets" + ], + "operationId": "PurgeDeletedSecret", + "summary": "Permanently deletes the specified secret.", + "description": "The purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No content signaling that the secret was purged forever." + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "PurgeDeletedSecret": { + "$ref": "./examples//PurgeDeletedSecret-example.json" + } + } + } + }, + "/deletedsecrets/{secret-name}/recover": { + "post": { + "tags": [ + "DeletedSecrets" + ], + "operationId": "RecoverDeletedSecret", + "summary": "Recovers the deleted secret to the latest version.", + "description": "Recovers the deleted secret in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the secrets/recover permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deleted secret." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A Secret bundle of the original secret and its attributes.", + "schema": { + "$ref": "#/definitions/SecretBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "RecoverDeletedSecret": { + "$ref": "./examples//RecoverDeletedSecret-example.json" + } + } + } + }, + "/secrets/{secret-name}/backup": { + "post": { + "tags": [ + "Secrets" + ], + "operationId": "BackupSecret", + "summary": "Backs up the specified secret.", + "description": "Requests that a backup of the specified secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the secrets/backup permission.", + "parameters": [ + { + "name": "secret-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The backup blob containing the backed up secret.", + "schema": { + "$ref": "#/definitions/BackupSecretResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "BackupSecret": { + "$ref": "./examples//BackupSecret-example.json" + } + } + } + }, + "/secrets/restore": { + "post": { + "tags": [ + "Secrets" + ], + "operationId": "RestoreSecret", + "summary": "Restores a backed up secret to a vault.", + "description": "Restores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/SecretRestoreParameters" + }, + "description": "The parameters to restore the secret." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Restored secret bundle in the vault.", + "schema": { + "$ref": "#/definitions/SecretBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "RestoreSecret": { + "$ref": "./examples//RestoreSecret-example.json" + } + } + } + }, + "/certificates": { + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificates", + "summary": "List certificates in a specified key vault", + "description": "The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "name": "includePending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Specifies whether to include certificates which are not completely provisioned." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of certificates along with a link to the next page of certificates.", + "schema": { + "$ref": "#/definitions/CertificateListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetCertificates": { + "$ref": "./examples//GetCertificates-example.json" + } + } + } + }, + "/certificates/{certificate-name}": { + "delete": { + "tags": [ + "Certificates" + ], + "operationId": "DeleteCertificate", + "summary": "Deletes a certificate from a specified key vault.", + "description": "Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted certificate.", + "schema": { + "$ref": "#/definitions/DeletedCertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "DeleteCertificate": { + "$ref": "./examples//DeleteCertificate-example.json" + } + } + } + }, + "/certificates/contacts": { + "put": { + "tags": [ + "Certificates" + ], + "operationId": "SetCertificateContacts", + "description": "Sets the certificate contacts for the specified key vault. This operation requires the certificates/managecontacts permission.", + "summary": "Sets the certificate contacts for the specified key vault.", + "parameters": [ + { + "name": "contacts", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Contacts" + }, + "description": "The contacts for the key vault certificate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The contacts for the key vault certificate.", + "schema": { + "$ref": "#/definitions/Contacts" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "SetCertificateContacts": { + "$ref": "./examples//SetCertificateContacts-example.json" + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificateContacts", + "summary": "Lists the certificate contacts for a specified key vault.", + "description": "The GetCertificateContacts operation returns the set of certificate contact resources in the specified key vault. This operation requires the certificates/managecontacts permission.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The contacts for the key vault certificate.", + "schema": { + "$ref": "#/definitions/Contacts" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetCertificateContacts": { + "$ref": "./examples//GetCertificateContacts-example.json" + } + } + }, + "delete": { + "tags": [ + "Certificates" + ], + "operationId": "DeleteCertificateContacts", + "description": "Deletes the certificate contacts for a specified key vault certificate. This operation requires the certificates/managecontacts permission.", + "summary": "Deletes the certificate contacts for a specified key vault.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The contacts for the key vault certificate.", + "schema": { + "$ref": "#/definitions/Contacts" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "DeleteCertificateContacts": { + "$ref": "./examples//DeleteCertificateContacts-example.json" + } + } + } + }, + "/certificates/issuers": { + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificateIssuers", + "summary": "List certificate issuers for a specified key vault.", + "description": "The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of certificate issuers in a key vault along with a link to the next page of certificate issuers.", + "schema": { + "$ref": "#/definitions/CertificateIssuerListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetCertificateIssuers": { + "$ref": "./examples//GetCertificateIssuers-example.json" + } + } + } + }, + "/certificates/issuers/{issuer-name}": { + "put": { + "tags": [ + "Certificates" + ], + "operationId": "SetCertificateIssuer", + "summary": "Sets the specified certificate issuer.", + "description": "The SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission.", + "parameters": [ + { + "name": "issuer-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the issuer." + }, + { + "name": "parameter", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateIssuerSetParameters" + }, + "description": "Certificate issuer set parameter." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The issuer for the key vault certificate.", + "schema": { + "$ref": "#/definitions/IssuerBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "SetCertificateIssuer": { + "$ref": "./examples//SetCertificateIssuer-example.json" + } + } + }, + "patch": { + "tags": [ + "Certificates" + ], + "operationId": "UpdateCertificateIssuer", + "summary": "Updates the specified certificate issuer.", + "description": "The UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers permission.", + "parameters": [ + { + "name": "issuer-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the issuer." + }, + { + "name": "parameter", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateIssuerUpdateParameters" + }, + "description": "Certificate issuer update parameter." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The issuer for the key vault certificate.", + "schema": { + "$ref": "#/definitions/IssuerBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "UpdateCertificateIssuer": { + "$ref": "./examples//UpdateCertificateIssuer-example.json" + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificateIssuer", + "summary": "Lists the specified certificate issuer.", + "description": "The GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.", + "parameters": [ + { + "name": "issuer-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the issuer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The issuer for the key vault certificate.", + "schema": { + "$ref": "#/definitions/IssuerBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetCertificateIssuer": { + "$ref": "./examples//GetCertificateIssuer-example.json" + } + } + }, + "delete": { + "tags": [ + "Certificates" + ], + "operationId": "DeleteCertificateIssuer", + "summary": "Deletes the specified certificate issuer.", + "description": "The DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the certificates/manageissuers/deleteissuers permission.", + "parameters": [ + { + "name": "issuer-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the issuer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The issuer for the key vault certificate.", + "schema": { + "$ref": "#/definitions/IssuerBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "DeleteCertificateIssuer": { + "$ref": "./examples//DeleteCertificateIssuer-example.json" + } + } + } + }, + "/certificates/{certificate-name}/create": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "CreateCertificate", + "summary": "Creates a new certificate.", + "description": "If this is the first version, the certificate resource is created. This operation requires the certificates/create permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z-]+$", + "description": "The name of the certificate." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateCreateParameters" + }, + "description": "The parameters to create a certificate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Created certificate bundle.", + "schema": { + "$ref": "#/definitions/CertificateOperation" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "CreateCertificate": { + "$ref": "./examples//CreateCertificate-example.json" + } + } + } + }, + "/certificates/{certificate-name}/import": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "ImportCertificate", + "summary": "Imports a certificate into a specified key vault.", + "description": "Imports an existing valid certificate, containing a private key, into Azure Key Vault. The certificate to be imported can be in either PFX or PEM format. If the certificate is in PEM format the PEM file must contain the key as well as x509 certificates. This operation requires the certificates/import permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z-]+$", + "description": "The name of the certificate." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateImportParameters" + }, + "description": "The parameters to import the certificate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Imported certificate bundle to the vault.", + "schema": { + "$ref": "#/definitions/CertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "ImportCertificate": { + "$ref": "./examples//ImportCertificate-example.json" + } + } + } + }, + "/certificates/{certificate-name}/versions": { + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificateVersions", + "summary": "List the versions of a certificate.", + "description": "The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of certificates in the key vault along with a link to the next page of keys.", + "schema": { + "$ref": "#/definitions/CertificateListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetCertificateVersions": { + "$ref": "./examples//GetCertificateVersions-example.json" + } + } + } + }, + "/certificates/{certificate-name}/policy": { + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificatePolicy", + "summary": "Lists the policy for a certificate.", + "description": "The GetCertificatePolicy operation returns the specified certificate policy resources in the specified key vault. This operation requires the certificates/get permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate in a given key vault." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The certificate policy.", + "schema": { + "$ref": "#/definitions/CertificatePolicy" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetCertificatePolicy": { + "$ref": "./examples//GetCertificatePolicy-example.json" + } + } + }, + "patch": { + "tags": [ + "Certificates" + ], + "operationId": "UpdateCertificatePolicy", + "summary": "Updates the policy for a certificate.", + "description": "Set specified members in the certificate policy. Leave others as null. This operation requires the certificates/update permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate in the given vault." + }, + { + "name": "certificatePolicy", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertificatePolicy" + }, + "description": "The policy for the certificate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The certificate policy", + "schema": { + "$ref": "#/definitions/CertificatePolicy" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "UpdateCertificatePolicy": { + "$ref": "./examples//UpdateCertificatePolicy-example.json" + } + } + } + }, + "/certificates/{certificate-name}/{certificate-version}": { + "patch": { + "tags": [ + "Certificates" + ], + "operationId": "UpdateCertificate", + "summary": "Updates the specified attributes associated with the given certificate.", + "description": "The UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate's attributes. This operation requires the certificates/update permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate in the given key vault." + }, + { + "name": "certificate-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the certificate." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateUpdateParameters" + }, + "description": "The parameters for certificate update." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The updated certificate.", + "schema": { + "$ref": "#/definitions/CertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "UpdateCertificate": { + "$ref": "./examples//UpdateCertificate-example.json" + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificate", + "summary": "Gets information about a certificate.", + "description": "Gets information about a specific certificate. This operation requires the certificates/get permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate in the given vault." + }, + { + "name": "certificate-version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the certificate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved certificate.", + "schema": { + "$ref": "#/definitions/CertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetCertificate": { + "$ref": "./examples//GetCertificate-example.json" + } + } + } + }, + "/certificates/{certificate-name}/pending": { + "patch": { + "tags": [ + "Certificates" + ], + "operationId": "UpdateCertificateOperation", + "summary": "Updates a certificate operation.", + "description": "Updates a certificate creation operation that is already in progress. This operation requires the certificates/update permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "name": "certificateOperation", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateOperationUpdateParameter" + }, + "description": "The certificate operation response." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A message containing the certificate operation response.", + "schema": { + "$ref": "#/definitions/CertificateOperation" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "UpdateCertificateOperation": { + "$ref": "./examples//UpdateCertificateOperation-example.json" + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "operationId": "GetCertificateOperation", + "summary": "Gets the creation operation of a certificate.", + "description": "Gets the creation operation associated with a specified certificate. This operation requires the certificates/get permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The certificate operation response.", + "schema": { + "$ref": "#/definitions/CertificateOperation" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetCertificateOperation": { + "$ref": "./examples//GetCertificateOperation-example.json" + } + } + }, + "delete": { + "tags": [ + "Certificates" + ], + "operationId": "DeleteCertificateOperation", + "summary": "Deletes the creation operation for a specific certificate.", + "description": "Deletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation requires the certificates/update permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A message containing the certificate operation response.", + "schema": { + "$ref": "#/definitions/CertificateOperation" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "DeleteCertificateOperation": { + "$ref": "./examples//DeleteCertificateOperation-example.json" + } + } + } + }, + "/certificates/{certificate-name}/pending/merge": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "MergeCertificate", + "summary": "Merges a certificate or a certificate chain with a key pair existing on the server.", + "description": "The MergeCertificate operation performs the merging of a certificate or certificate chain with a key pair currently available in the service. This operation requires the certificates/create permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateMergeParameters" + }, + "description": "The parameters to merge certificate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Merged certificate bundle to the vault.", + "schema": { + "$ref": "#/definitions/CertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "MergeCertificate": { + "$ref": "./examples//MergeCertificate-example.json" + } + } + } + }, + "/certificates/{certificate-name}/backup": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "BackupCertificate", + "summary": "Backs up the specified certificate.", + "description": "Requests that a backup of the specified certificate be downloaded to the client. All versions of the certificate will be downloaded. This operation requires the certificates/backup permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The backup blob containing the backed up certificate.", + "schema": { + "$ref": "#/definitions/BackupCertificateResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "BackupCertificate": { + "$ref": "./examples//BackupCertificate-example.json" + } + } + } + }, + "/certificates/restore": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "RestoreCertificate", + "summary": "Restores a backed up certificate to a vault.", + "description": "Restores a backed up certificate, and all its versions, to a vault. This operation requires the certificates/restore permission.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CertificateRestoreParameters" + }, + "description": "The parameters to restore the certificate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Restored certificate bundle in the vault.", + "schema": { + "$ref": "#/definitions/CertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "RestoreCertificate": { + "$ref": "./examples//RestoreCertificate-example.json" + } + } + } + }, + "/deletedcertificates": { + "get": { + "tags": [ + "DeletedCertificates" + ], + "operationId": "GetDeletedCertificates", + "summary": "Lists the deleted certificates in the specified vault currently available for recovery.", + "description": "The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "name": "includePending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Specifies whether to include certificates which are not completely provisioned." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of deleted certificates in the vault along with a link to the next page of deleted certificates", + "schema": { + "$ref": "#/definitions/DeletedCertificateListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetDeletedCertificates": { + "$ref": "./examples//GetDeletedCertificates-example.json" + } + } + } + }, + "/deletedcertificates/{certificate-name}": { + "get": { + "tags": [ + "DeletedCertificates" + ], + "operationId": "GetDeletedCertificate", + "summary": "Retrieves information about the specified deleted certificate.", + "description": "The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the certificates/get permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A Certificate bundle of the certificate and its attributes", + "schema": { + "$ref": "#/definitions/DeletedCertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "GetDeletedCertificate": { + "$ref": "./examples//GetDeletedCertificate-example.json" + } + } + }, + "delete": { + "tags": [ + "DeletedCertificates" + ], + "operationId": "PurgeDeletedCertificate", + "summary": "Permanently deletes the specified deleted certificate.", + "description": "The PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not available if the recovery level does not specify 'Purgeable'. This operation requires the certificate/purge permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the certificate" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No content signaling that the certificate was purged forever." + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "PurgeDeletedCertificate": { + "$ref": "./examples//PurgeDeletedCertificate-example.json" + } + } + } + }, + "/deletedcertificates/{certificate-name}/recover": { + "post": { + "tags": [ + "DeletedCertificates" + ], + "operationId": "RecoverDeletedCertificate", + "summary": "Recovers the deleted certificate back to its current version under /certificates.", + "description": "The RecoverDeletedCertificate operation performs the reversal of the Delete operation. The operation is applicable in vaults enabled for soft-delete, and must be issued during the retention interval (available in the deleted certificate's attributes). This operation requires the certificates/recover permission.", + "parameters": [ + { + "name": "certificate-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deleted certificate" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A Certificate bundle of the original certificate and its attributes", + "schema": { + "$ref": "#/definitions/CertificateBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "RecoverDeletedCertificate": { + "$ref": "./examples//RecoverDeletedCertificate-example.json" + } + } + } + }, + "/storage": { + "get": { + "tags": [ + "Storage" + ], + "operationId": "GetStorageAccounts", + "description": "List storage accounts managed by the specified key vault. This operation requires the storage/list permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of storage accounts along with a link to the next page of storage accounts.", + "schema": { + "$ref": "#/definitions/StorageListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Storage account": { + "$ref": "./examples//listStorageAccount.json" + } + } + } + }, + "/deletedstorage": { + "get": { + "tags": [ + "DeletedStorage" + ], + "operationId": "GetDeletedStorageAccounts", + "summary": "Lists deleted storage accounts for the specified vault.", + "description": "The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.", + "parameters": [ + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of deleted storage accounts in the vault, along with a link to the next page of deleted storage accounts.", + "schema": { + "$ref": "#/definitions/DeletedStorageListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Deleted Storage Accounts": { + "$ref": "./examples//listDeletedStorageAccount.json" + } + } + } + }, + "/deletedstorage/{storage-account-name}": { + "get": { + "tags": [ + "DeletedStorage" + ], + "operationId": "GetDeletedStorageAccount", + "summary": "Gets the specified deleted storage account.", + "description": "The Get Deleted Storage Account operation returns the specified deleted storage account along with its attributes. This operation requires the storage/get permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted storage account and information on when it will be purged, and how to recover the deleted storage account.", + "schema": { + "$ref": "#/definitions/DeletedStorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Get Deleted Storage": { + "$ref": "./examples//getDeletedStorageAccount.json" + } + } + }, + "delete": { + "tags": [ + "DeletedStorage" + ], + "operationId": "PurgeDeletedStorageAccount", + "summary": "Permanently deletes the specified storage account.", + "description": "The purge deleted storage account operation removes the secret permanently, without the possibility of recovery. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/purge permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No content signaling that the storage account was purged forever." + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Purge Deleted Storage Account": { + "$ref": "./examples//purgeStorageAccount.json" + } + } + } + }, + "/deletedstorage/{storage-account-name}/recover": { + "post": { + "tags": [ + "DeletedStorage" + ], + "operationId": "RecoverDeletedStorageAccount", + "summary": "Recovers the deleted storage account.", + "description": "Recovers the deleted storage account in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A storage bundle of the original storage account and its attributes.", + "schema": { + "$ref": "#/definitions/StorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Recover Deleted Storage Account": { + "$ref": "./examples//recoverStorageAccount.json" + } + } + } + }, + "/storage/{storage-account-name}/backup": { + "post": { + "tags": [ + "Storage" + ], + "operationId": "BackupStorageAccount", + "summary": "Backs up the specified storage account.", + "description": "Requests that a backup of the specified storage account be downloaded to the client. This operation requires the storage/backup permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The backup blob containing the backed up storage account.", + "schema": { + "$ref": "#/definitions/BackupStorageResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Backup Storage Account": { + "$ref": "./examples//backupStorageAccount.json" + } + } + } + }, + "/storage/restore": { + "post": { + "tags": [ + "Storage" + ], + "operationId": "RestoreStorageAccount", + "summary": "Restores a backed up storage account to a vault.", + "description": "Restores a backed up storage account to a vault. This operation requires the storage/restore permission.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/StorageRestoreParameters" + }, + "description": "The parameters to restore the storage account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Restored storage account bundle in the vault.", + "schema": { + "$ref": "#/definitions/StorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Restore Storage Account": { + "$ref": "./examples//restoreStorageAccount.json" + } + } + } + }, + "/storage/{storage-account-name}": { + "delete": { + "tags": [ + "Storage" + ], + "operationId": "DeleteStorageAccount", + "description": "Deletes a storage account. This operation requires the storage/delete permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted storage account and information on when the storage account will be deleted, and how to recover the deleted storage account.", + "schema": { + "$ref": "#/definitions/DeletedStorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Delete Storage account": { + "$ref": "./examples//deleteStorageAccount.json" + } + } + }, + "get": { + "tags": [ + "Storage" + ], + "operationId": "GetStorageAccount", + "description": "Gets information about a specified storage account. This operation requires the storage/get permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved storage account.", + "schema": { + "$ref": "#/definitions/StorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Get Storage account": { + "$ref": "./examples//getStorageAccount.json" + } + } + }, + "put": { + "tags": [ + "Storage" + ], + "operationId": "SetStorageAccount", + "description": "Creates or updates a new storage account. This operation requires the storage/set permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/StorageAccountCreateParameters" + }, + "description": "The parameters to create a storage account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The created storage account.", + "schema": { + "$ref": "#/definitions/StorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Set Storage account": { + "$ref": "./examples//setStorageAccount.json" + } + } + }, + "patch": { + "tags": [ + "Storage" + ], + "operationId": "UpdateStorageAccount", + "description": "Updates the specified attributes associated with the given storage account. This operation requires the storage/set/update permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/StorageAccountUpdateParameters" + }, + "description": "The parameters to update a storage account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The updated storage account.", + "schema": { + "$ref": "#/definitions/StorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Update Storage account": { + "$ref": "./examples//updateStorageAccount.json" + } + } + } + }, + "/storage/{storage-account-name}/regeneratekey": { + "post": { + "tags": [ + "Storage" + ], + "operationId": "RegenerateStorageAccountKey", + "description": "Regenerates the specified key value for the given storage account. This operation requires the storage/regeneratekey permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/StorageAccountRegenerteKeyParameters" + }, + "description": "The parameters to regenerate storage account key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The updated storage account.", + "schema": { + "$ref": "#/definitions/StorageBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Regenerate Storage account key": { + "$ref": "./examples//regenerateStorageAccountKey.json" + } + } + } + }, + "/storage/{storage-account-name}/sas": { + "get": { + "tags": [ + "Storage" + ], + "operationId": "GetSasDefinitions", + "description": "List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of SAS definitions along with a link to the next page of SAS definitions.", + "schema": { + "$ref": "#/definitions/SasDefinitionListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Storage Sas Definition": { + "$ref": "./examples//listStorageSasDefinition.json" + } + } + } + }, + "/deletedstorage/{storage-account-name}/sas": { + "get": { + "tags": [ + "DeletedStorage" + ], + "operationId": "GetDeletedSasDefinitions", + "summary": "Lists deleted SAS definitions for the specified vault and storage account.", + "description": "The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 25, + "description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A response message containing a list of deleted SAS definitions for the storage account, along with a link to the next page of deleted SAS definitions.", + "schema": { + "$ref": "#/definitions/DeletedSasDefinitionListResult" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Deleted Storage Sas Definitions": { + "$ref": "./examples//listDeletedStorageSasDefinition.json" + } + } + } + }, + "/deletedstorage/{storage-account-name}/sas/{sas-definition-name}": { + "get": { + "tags": [ + "DeletedStorage" + ], + "operationId": "GetDeletedSasDefinition", + "summary": "Gets the specified deleted sas definition.", + "description": "The Get Deleted SAS Definition operation returns the specified deleted SAS definition along with its attributes. This operation requires the storage/getsas permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "sas-definition-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the SAS definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted SAS definition and information on when the it will be purged, and how to recover the deleted SAS definition.", + "schema": { + "$ref": "#/definitions/DeletedSasDefinitionBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Get Deleted Storage Sas Definition": { + "$ref": "./examples//getDeletedStorageSasDefinition.json" + } + } + } + }, + "/deletedstorage/{storage-account-name}/sas/{sas-definition-name}/recover": { + "post": { + "tags": [ + "DeletedStorage" + ], + "operationId": "RecoverDeletedSasDefinition", + "summary": "Recovers the deleted SAS definition.", + "description": "Recovers the deleted SAS definition for the specified storage account. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "sas-definition-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the SAS definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A SAS definition bundle of the original SAS definition and its attributes.", + "schema": { + "$ref": "#/definitions/SasDefinitionBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Recover Deleted Storage Sas Definition": { + "$ref": "./examples//recoverStorageSasDefinition.json" + } + } + } + }, + "/storage/{storage-account-name}/sas/{sas-definition-name}": { + "delete": { + "tags": [ + "Storage" + ], + "operationId": "DeleteSasDefinition", + "description": "Deletes a SAS definition from a specified storage account. This operation requires the storage/deletesas permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "sas-definition-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the SAS definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted SAS definition and information on when the SAS definition will be deleted, and how to recover the deleted SAS definition.", + "schema": { + "$ref": "#/definitions/DeletedSasDefinitionBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Delete Storage Sas Definition": { + "$ref": "./examples//deleteStorageSasDefinition.json" + } + } + }, + "get": { + "tags": [ + "Storage" + ], + "operationId": "GetSasDefinition", + "description": "Gets information about a SAS definition for the specified storage account. This operation requires the storage/getsas permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "sas-definition-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the SAS definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved SAS definition.", + "schema": { + "$ref": "#/definitions/SasDefinitionBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Get Storage Sas Definition": { + "$ref": "./examples//getStorageSasDefinition.json" + } + } + }, + "put": { + "tags": [ + "Storage" + ], + "operationId": "SetSasDefinition", + "description": "Creates or updates a new SAS definition for the specified storage account. This operation requires the storage/setsas permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "sas-definition-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the SAS definition." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/SasDefinitionCreateParameters" + }, + "description": "The parameters to create a SAS definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The created SAS definition.", + "schema": { + "$ref": "#/definitions/SasDefinitionBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Set Storage Sas definition": { + "$ref": "./examples//setStorageSasDefinition.json" + } + } + }, + "patch": { + "tags": [ + "Storage" + ], + "operationId": "UpdateSasDefinition", + "description": "Updates the specified attributes associated with the given SAS definition. This operation requires the storage/setsas permission.", + "parameters": [ + { + "name": "storage-account-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the storage account." + }, + { + "name": "sas-definition-name", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]+$", + "description": "The name of the SAS definition." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/SasDefinitionUpdateParameters" + }, + "description": "The parameters to update a SAS definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The updated SAS definition.", + "schema": { + "$ref": "#/definitions/SasDefinitionBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Update Storage Sas definition": { + "$ref": "./examples//updateStorageSasDefinition.json" + } + } + } + } + }, + "definitions": { + "Attributes": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Determines whether the object is enabled." + }, + "nbf": { + "x-ms-client-name": "NotBefore", + "type": "integer", + "format": "unixtime", + "description": "Not before date in UTC." + }, + "exp": { + "x-ms-client-name": "Expires", + "type": "integer", + "format": "unixtime", + "description": "Expiry date in UTC." + }, + "created": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Creation time in UTC." + }, + "updated": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Last updated time in UTC." + } + }, + "description": "The object attributes managed by the KeyVault service." + }, + "JsonWebKey": { + "properties": { + "kid": { + "type": "string", + "description": "Key identifier." + }, + "kty": { + "type": "string", + "description": "JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.", + "enum": [ "EC", "EC-HSM", "RSA", "RSA-HSM", "oct" ], + "x-ms-enum": { + "name": "JsonWebKeyType", + "modelAsString": true, + "values": [ + { + "value": "EC", + "description": "Elliptic Curve." + }, + { + "value": "EC-HSM", + "description": "Elliptic Curve with a private key which is not exportable from the HSM." + }, + { + "value": "RSA", + "description": "RSA (https://tools.ietf.org/html/rfc3447)" + }, + { + "value": "RSA-HSM", + "description": "RSA with a private key which is not exportable from the HSM." + }, + { + "value": "oct", + "description": "Octet sequence (used to represent symmetric keys)" + } + ] + } + }, + "key_ops": { + "type": "array", + "items": { + "type": "string", + "description": "Supported key operations." + } + }, + "n": { + "type": "string", + "format": "base64url", + "description": "RSA modulus." + }, + "e": { + "type": "string", + "format": "base64url", + "description": "RSA public exponent." + }, + "d": { + "type": "string", + "format": "base64url", + "description": "RSA private exponent, or the D component of an EC private key." + }, + "dp": { + "x-ms-client-name": "DP", + "type": "string", + "format": "base64url", + "description": "RSA private key parameter." + }, + "dq": { + "x-ms-client-name": "DQ", + "type": "string", + "format": "base64url", + "description": "RSA private key parameter." + }, + "qi": { + "x-ms-client-name": "QI", + "type": "string", + "format": "base64url", + "description": "RSA private key parameter." + }, + "p": { + "type": "string", + "format": "base64url", + "description": "RSA secret prime." + }, + "q": { + "type": "string", + "format": "base64url", + "description": "RSA secret prime, with p < q." + }, + "k": { + "type": "string", + "format": "base64url", + "description": "Symmetric key." + }, + "key_hsm": { + "x-ms-client-name": "t", + "type": "string", + "format": "base64url", + "description": "HSM Token, used with 'Bring Your Own Key'." + }, + "crv": { + "type": "string", + "description": "Elliptic curve name. For valid values, see JsonWebKeyCurveName.", + "enum": [ "P-256", "P-384", "P-521", "P-256K" ], + "x-ms-enum": { + "name": "JsonWebKeyCurveName", + "modelAsString": true, + "values": [ + { + "value": "P-256", + "description": "The NIST P-256 elliptic curve, AKA SECG curve SECP256R1." + }, + { + "value": "P-384", + "description": "The NIST P-384 elliptic curve, AKA SECG curve SECP384R1." + }, + { + "value": "P-521", + "description": "The NIST P-521 elliptic curve, AKA SECG curve SECP521R1." + }, + { + "value": "P-256K", + "description": "The SECG SECP256K1 elliptic curve." + } + ] + } + }, + "x": { + "type": "string", + "format": "base64url", + "description": "X component of an EC public key." + }, + "y": { + "type": "string", + "format": "base64url", + "description": "Y component of an EC public key." + } + }, + "description": "As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18" + }, + "KeyAttributes": { + "allOf": [ + { + "$ref": "#/definitions/Attributes" + } + ], + "properties": { + "recoveryLevel": { + "type": "string", + "description": "Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval.", + "enum": [ "Purgeable", "Recoverable+Purgeable", "Recoverable", "Recoverable+ProtectedSubscription" ], + "x-ms-enum": { + "name": "DeletionRecoveryLevel", + "modelAsString": true + }, + "readOnly": true, + "x-nullable": false + } + }, + "description": "The attributes of a key managed by the key vault service." + }, + "KeyBundle": { + "properties": { + "key": { + "$ref": "#/definitions/JsonWebKey", + "description": "The Json web key." + }, + "attributes": { + "$ref": "#/definitions/KeyAttributes", + "description": "The key management attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "managed": { + "type": "boolean", + "readOnly": true, + "description": "True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true." + } + }, + "description": "A KeyBundle consisting of a WebKey plus its attributes." + }, + "KeyItem": { + "properties": { + "kid": { + "type": "string", + "description": "Key identifier." + }, + "attributes": { + "$ref": "#/definitions/KeyAttributes", + "description": "The key management attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "managed": { + "type": "boolean", + "readOnly": true, + "description": "True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true." + } + }, + "description": "The key item containing key metadata." + }, + "DeletedKeyBundle": { + "allOf": [ + { + "$ref": "#/definitions/KeyBundle" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted key." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the key is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the key was deleted, in UTC" + } + }, + "description": "A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion info" + }, + "DeletedKeyItem": { + "allOf": [ + { + "$ref": "#/definitions/KeyItem" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted key." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the key is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the key was deleted, in UTC" + } + }, + "description": "The deleted key item containing the deleted key metadata and information about deletion." + }, + "SecretBundle": { + "properties": { + "value": { + "type": "string", + "description": "The secret value." + }, + "id": { + "type": "string", + "description": "The secret id." + }, + "contentType": { + "type": "string", + "description": "The content type of the secret." + }, + "attributes": { + "$ref": "#/definitions/SecretAttributes", + "description": "The secret management attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "kid": { + "type": "string", + "readOnly": true, + "description": "If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate." + }, + "managed": { + "type": "boolean", + "readOnly": true, + "description": "True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true." + } + }, + "description": "A secret consisting of a value, id and its attributes." + }, + "SecretItem": { + "properties": { + "id": { + "type": "string", + "description": "Secret identifier." + }, + "attributes": { + "$ref": "#/definitions/SecretAttributes", + "description": "The secret management attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "contentType": { + "type": "string", + "description": "Type of the secret value such as a password." + }, + "managed": { + "type": "boolean", + "readOnly": true, + "description": "True if the secret's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true." + } + }, + "description": "The secret item containing secret metadata." + }, + "DeletedSecretBundle": { + "allOf": [ + { + "$ref": "#/definitions/SecretBundle" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted secret." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the secret is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the secret was deleted, in UTC" + } + }, + "description": "A Deleted Secret consisting of its previous id, attributes and its tags, as well as information on when it will be purged." + }, + "DeletedSecretItem": { + "allOf": [ + { + "$ref": "#/definitions/SecretItem" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted secret." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the secret is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the secret was deleted, in UTC" + } + }, + "description": "The deleted secret item containing metadata about the deleted secret." + }, + "SecretAttributes": { + "allOf": [ + { + "$ref": "#/definitions/Attributes" + } + ], + "properties": { + "recoveryLevel": { + "type": "string", + "description": "Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval.", + "enum": [ "Purgeable", "Recoverable+Purgeable", "Recoverable", "Recoverable+ProtectedSubscription" ], + "x-ms-enum": { + "name": "DeletionRecoveryLevel", + "modelAsString": true + }, + "readOnly": true, + "x-nullable": false + } + }, + "description": "The secret management attributes." + }, + "SecretRestoreParameters": { + "properties": { + "value": { + "type": "string", + "x-ms-client-name": "secretBundleBackup", + "format": "base64url", + "description": "The backup blob associated with a secret bundle." + } + }, + "description": "The secret restore parameters.", + "required": [ "value" ] + }, + "StorageRestoreParameters": { + "properties": { + "value": { + "type": "string", + "x-ms-client-name": "storageBundleBackup", + "format": "base64url", + "description": "The backup blob associated with a storage account." + } + }, + "description": "The secret restore parameters.", + "required": [ "value" ] + }, + "CertificateAttributes": { + "allOf": [ + { + "$ref": "#/definitions/Attributes" + } + ], + "properties": { + "recoveryLevel": { + "type": "string", + "description": "Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only the system can purge the certificate, at the end of the retention interval.", + "enum": [ "Purgeable", "Recoverable+Purgeable", "Recoverable", "Recoverable+ProtectedSubscription" ], + "x-ms-enum": { + "name": "DeletionRecoveryLevel", + "modelAsString": true + }, + "readOnly": true, + "x-nullable": false + } + }, + "description": "The certificate management attributes." + }, + "CertificateItem": { + "properties": { + "id": { + "type": "string", + "description": "Certificate identifier." + }, + "attributes": { + "$ref": "#/definitions/CertificateAttributes", + "description": "The certificate management attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "x5t": { + "x-ms-client-name": "X509Thumbprint", + "type": "string", + "format": "base64url", + "description": "Thumbprint of the certificate." + } + }, + "description": "The certificate item containing certificate metadata." + }, + "CertificateIssuerItem": { + "properties": { + "id": { + "type": "string", + "description": "Certificate Identifier." + }, + "provider": { + "type": "string", + "description": "The issuer provider." + } + }, + "description": "The certificate issuer item containing certificate issuer metadata." + }, + "CertificateBundle": { + "properties": { + "id": { + "type": "string", + "description": "The certificate id.", + "readOnly": true + }, + "kid": { + "type": "string", + "description": "The key id.", + "readOnly": true + }, + "sid": { + "type": "string", + "description": "The secret id.", + "readOnly": true + }, + "x5t": { + "x-ms-client-name": "X509Thumbprint", + "type": "string", + "format": "base64url", + "description": "Thumbprint of the certificate.", + "readOnly": true + }, + "policy": { + "$ref": "#/definitions/CertificatePolicy", + "description": "The management policy.", + "readOnly": true + }, + "cer": { + "type": "string", + "format": "byte", + "description": "CER contents of x509 certificate." + }, + "contentType": { + "type": "string", + "description": "The content type of the secret." + }, + "attributes": { + "$ref": "#/definitions/CertificateAttributes", + "description": "The certificate attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs" + } + }, + "description": "A certificate bundle consists of a certificate (X509) plus its attributes." + }, + "DeletedCertificateBundle": { + "allOf": [ + { + "$ref": "#/definitions/CertificateBundle" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted certificate." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the certificate is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the certificate was deleted, in UTC" + } + }, + "description": "A Deleted Certificate consisting of its previous id, attributes and its tags, as well as information on when it will be purged." + }, + "DeletedCertificateItem": { + "allOf": [ + { + "$ref": "#/definitions/CertificateItem" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted certificate." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the certificate is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the certificate was deleted, in UTC" + } + }, + "description": "The deleted certificate item containing metadata about the deleted certificate." + }, + "CertificateOperation": { + "properties": { + "id": { + "type": "string", + "description": "The certificate id.", + "readOnly": true + }, + "issuer": { + "x-ms-client-name": "IssuerParameters", + "$ref": "#/definitions/IssuerParameters", + "description": "Parameters for the issuer of the X509 component of a certificate." + }, + "csr": { + "type": "string", + "format": "byte", + "description": "The certificate signing request (CSR) that is being used in the certificate operation." + }, + "cancellation_requested": { + "type": "boolean", + "description": "Indicates if cancellation was requested on the certificate operation." + }, + "status": { + "type": "string", + "description": "Status of the certificate operation." + }, + "status_details": { + "type": "string", + "description": "The status details of the certificate operation." + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Error encountered, if any, during the certificate operation." + }, + "target": { + "type": "string", + "description": "Location which contains the result of the certificate operation." + }, + "request_id": { + "type": "string", + "description": "Identifier for the certificate operation." + } + }, + "description": "A certificate operation is returned in case of asynchronous requests." + }, + "CertificatePolicy": { + "properties": { + "id": { + "type": "string", + "description": "The certificate id.", + "readOnly": true + }, + "key_props": { + "x-ms-client-name": "KeyProperties", + "$ref": "#/definitions/KeyProperties", + "description": "Properties of the key backing a certificate." + }, + "secret_props": { + "x-ms-client-name": "SecretProperties", + "$ref": "#/definitions/SecretProperties", + "description": "Properties of the secret backing a certificate." + }, + "x509_props": { + "x-ms-client-name": "X509CertificateProperties", + "$ref": "#/definitions/X509CertificateProperties", + "description": "Properties of the X509 component of a certificate." + }, + "lifetime_actions": { + "type": "array", + "items": { + "$ref": "#/definitions/LifetimeAction" + }, + "description": "Actions that will be performed by Key Vault over the lifetime of a certificate." + }, + "issuer": { + "x-ms-client-name": "IssuerParameters", + "$ref": "#/definitions/IssuerParameters", + "description": "Parameters for the issuer of the X509 component of a certificate." + }, + "attributes": { + "$ref": "#/definitions/CertificateAttributes", + "description": "The certificate attributes." + } + }, + "description": "Management policy for a certificate." + }, + "KeyProperties": { + "properties": { + "exportable": { + "type": "boolean", + "description": "Indicates if the private key can be exported." + }, + "kty": { + "x-ms-client-name": "keyType", + "type": "string", + "description": "The type of key pair to be used for the certificate.", + "enum": [ "EC", "EC-HSM", "RSA", "RSA-HSM", "oct" ], + "x-ms-enum": { + "name": "JsonWebKeyType", + "modelAsString": true + } + }, + "key_size": { + "type": "integer", + "format": "int32", + "description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA." + }, + "reuse_key": { + "type": "boolean", + "description": "Indicates if the same key pair will be used on certificate renewal." + }, + "crv": { + "x-ms-client-name": "curve", + "type": "string", + "description": "Elliptic curve name. For valid values, see JsonWebKeyCurveName.", + "enum": [ "P-256", "P-384", "P-521", "P-256K" ], + "x-ms-enum": { + "name": "JsonWebKeyCurveName", + "modelAsString": true + } + } + }, + "description": "Properties of the key pair backing a certificate." + }, + "SecretProperties": { + "properties": { + "contentType": { + "type": "string", + "description": "The media type (MIME type)." + } + }, + "description": "Properties of the key backing a certificate." + }, + "X509CertificateProperties": { + "properties": { + "subject": { + "type": "string", + "description": "The subject name. Should be a valid X509 distinguished Name." + }, + "ekus": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The enhanced key usage." + }, + "sans": { + "x-ms-client-name": "SubjectAlternativeNames", + "$ref": "#/definitions/SubjectAlternativeNames", + "description": "The subject alternative names." + }, + "key_usage": { + "type": "array", + "items": { + "type": "string", + "enum": [ "digitalSignature", "nonRepudiation", "keyEncipherment", "dataEncipherment", "keyAgreement", "keyCertSign", "cRLSign", "encipherOnly", "decipherOnly" ], + "x-ms-enum": { + "name": "KeyUsageType", + "modelAsString": true + } + }, + "description": "List of key usages." + }, + "validity_months": { + "x-ms-client-name": "ValidityInMonths", + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The duration that the ceritifcate is valid in months." + } + }, + "description": "Properties of the X509 component of a certificate." + }, + "IssuerParameters": { + "properties": { + "name": { + "type": "string", + "description": "Name of the referenced issuer object or reserved names; for example, 'Self' or 'Unknown'." + }, + "cty": { + "x-ms-client-name": "CertificateType", + "type": "string", + "description": "Type of certificate to be requested from the issuer provider." + }, + "cert_transparency": { + "x-ms-client-name": "CertificateTransparency", + "type": "boolean", + "description": "Indicates if the certificates generated under this policy should be published to certificate transparency logs." + } + }, + "description": "Parameters for the issuer of the X509 component of a certificate." + }, + "LifetimeAction": { + "properties": { + "trigger": { + "$ref": "#/definitions/Trigger", + "description": "The condition that will execute the action." + }, + "action": { + "$ref": "#/definitions/Action", + "description": "The action that will be executed." + } + }, + "description": "Action and its trigger that will be performed by Key Vault over the lifetime of a certificate." + }, + "Action": { + "properties": { + "action_type": { + "type": "string", + "description": "The type of the action.", + "enum": [ "EmailContacts", "AutoRenew" ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": false + } + } + }, + "description": "The action that will be executed." + }, + "Trigger": { + "properties": { + "lifetime_percentage": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 99, + "description": "Percentage of lifetime at which to trigger. Value should be between 1 and 99." + }, + "days_before_expiry": { + "type": "integer", + "format": "int32", + "description": "Days before expiry to attempt renewal. Value should be between 1 and validity_in_months multiplied by 27. If validity_in_months is 36, then value should be between 1 and 972 (36 * 27)." + } + }, + "description": "A condition to be satisfied for an action to be executed." + }, + "SubjectAlternativeNames": { + "properties": { + "emails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Email addresses." + }, + "dns_names": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Domain names." + }, + "upns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "User principal names." + } + }, + "description": "The subject alternate names of a X509 object." + }, + "IssuerBundle": { + "properties": { + "id": { + "type": "string", + "description": "Identifier for the issuer object.", + "readOnly": true + }, + "provider": { + "type": "string", + "description": "The issuer provider." + }, + "credentials": { + "$ref": "#/definitions/IssuerCredentials", + "description": "The credentials to be used for the issuer." + }, + "org_details": { + "x-ms-client-name": "OrganizationDetails", + "$ref": "#/definitions/OrganizationDetails", + "description": "Details of the organization as provided to the issuer." + }, + "attributes": { + "$ref": "#/definitions/IssuerAttributes", + "description": "Attributes of the issuer object." + } + }, + "description": "The issuer for Key Vault certificate." + }, + "IssuerAttributes": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Determines whether the issuer is enabled." + }, + "created": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Creation time in UTC." + }, + "updated": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Last updated time in UTC." + } + }, + "description": "The attributes of an issuer managed by the Key Vault service." + }, + "IssuerCredentials": { + "properties": { + "account_id": { + "type": "string", + "description": "The user name/account name/account id." + }, + "pwd": { + "x-ms-client-name": "Password", + "type": "string", + "description": "The password/secret/account key." + } + }, + "description": "The credentials to be used for the certificate issuer." + }, + "OrganizationDetails": { + "properties": { + "id": { + "type": "string", + "description": "Id of the organization." + }, + "admin_details": { + "type": "array", + "items": { + "$ref": "#/definitions/AdministratorDetails" + }, + "description": "Details of the organization administrator." + } + }, + "description": "Details of the organization of the certificate issuer." + }, + "AdministratorDetails": { + "properties": { + "first_name": { + "type": "string", + "description": "First name." + }, + "last_name": { + "type": "string", + "description": "Last name." + }, + "email": { + "x-ms-client-name": "EmailAddress", + "type": "string", + "description": "Email addresss." + }, + "phone": { + "type": "string", + "description": "Phone number." + } + }, + "description": "Details of the organization administrator of the certificate issuer." + }, + "Contacts": { + "properties": { + "id": { + "type": "string", + "description": "Identifier for the contacts collection.", + "readOnly": true + }, + "contacts": { + "x-ms-client-name": "ContactList", + "type": "array", + "items": { + "$ref": "#/definitions/Contact" + }, + "description": "The contact list for the vault certificates." + } + }, + "description": "The contacts for the vault certificates." + }, + "Contact": { + "properties": { + "email": { + "x-ms-client-name": "EmailAddress", + "type": "string", + "description": "Email addresss." + }, + "name": { + "type": "string", + "description": "Name." + }, + "phone": { + "type": "string", + "description": "Phone number." + } + }, + "description": "The contact information for the vault certificates." + }, + "KeyCreateParameters": { + "properties": { + "kty": { + "type": "string", + "minLength": 1, + "description": "The type of key to create. For valid values, see JsonWebKeyType.", + "enum": [ "EC", "EC-HSM", "RSA", "RSA-HSM", "oct" ], + "x-ms-enum": { + "name": "JsonWebKeyType", + "modelAsString": true + } + }, + "key_size": { + "type": "integer", + "format": "int32", + "description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA." + }, + "key_ops": { + "type": "array", + "items": { + "type": "string", + "description": "JSON web key operations. For more information, see JsonWebKeyOperation.", + "enum": [ "encrypt", "decrypt", "sign", "verify", "wrapKey", "unwrapKey" ], + "x-ms-enum": { + "name": "JsonWebKeyOperation", + "modelAsString": true + } + } + }, + "attributes": { + "x-ms-client-name": "keyAttributes", + "$ref": "#/definitions/KeyAttributes" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "crv": { + "x-ms-client-name": "curve", + "type": "string", + "description": "Elliptic curve name. For valid values, see JsonWebKeyCurveName.", + "enum": [ "P-256", "P-384", "P-521", "P-256K" ], + "x-ms-enum": { + "name": "JsonWebKeyCurveName", + "modelAsString": true + } + } + }, + "description": "The key create parameters.", + "required": [ "kty" ] + }, + "KeyImportParameters": { + "properties": { + "Hsm": { + "type": "boolean", + "description": "Whether to import as a hardware key (HSM) or software key." + }, + "key": { + "$ref": "#/definitions/JsonWebKey", + "description": "The Json web key" + }, + "attributes": { + "x-ms-client-name": "keyAttributes", + "$ref": "#/definitions/KeyAttributes", + "description": "The key management attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The key import parameters.", + "required": [ "key" ] + }, + "KeyOperationsParameters": { + "properties": { + "alg": { + "x-ms-client-name": "algorithm", + "type": "string", + "minLength": 1, + "description": "algorithm identifier", + "enum": [ "RSA-OAEP", "RSA-OAEP-256", "RSA1_5" ], + "x-ms-enum": { + "name": "JsonWebKeyEncryptionAlgorithm", + "modelAsString": true + } + }, + "value": { + "type": "string", + "format": "base64url" + } + }, + "description": "The key operations parameters.", + "required": [ "alg", "value" ] + }, + "KeySignParameters": { + "properties": { + "alg": { + "x-ms-client-name": "algorithm", + "type": "string", + "minLength": 1, + "description": "The signing/verification algorithm identifier. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm.", + "enum": [ "PS256", "PS384", "PS512", "RS256", "RS384", "RS512", "RSNULL", "ES256", "ES384", "ES512", "ES256K" ], + "x-ms-enum": { + "name": "JsonWebKeySignatureAlgorithm", + "modelAsString": true, + "values": [ + { + "value": "PS256", + "description": "RSASSA-PSS using SHA-256 and MGF1 with SHA-256, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "PS384", + "description": "RSASSA-PSS using SHA-384 and MGF1 with SHA-384, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "PS512", + "description": "RSASSA-PSS using SHA-512 and MGF1 with SHA-512, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "RS256", + "description": "RSASSA-PKCS1-v1_5 using SHA-256, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "RS384", + "description": "RSASSA-PKCS1-v1_5 using SHA-384, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "RS512", + "description": "RSASSA-PKCS1-v1_5 using SHA-512, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "RSNULL", + "description": "Reserved" + }, + { + "value": "ES256", + "description": "ECDSA using P-256 and SHA-256, as described in https://tools.ietf.org/html/rfc7518." + }, + { + "value": "ES384", + "description": "ECDSA using P-384 and SHA-384, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "ES512", + "description": "ECDSA using P-521 and SHA-512, as described in https://tools.ietf.org/html/rfc7518" + }, + { + "value": "ES256K", + "description": "ECDSA using P-256K and SHA-256, as described in https://tools.ietf.org/html/rfc7518" + } + ] + } + }, + "value": { + "type": "string", + "format": "base64url" + } + }, + "description": "The key operations parameters.", + "required": [ "alg", "value" ] + }, + "KeyVerifyParameters": { + "properties": { + "alg": { + "x-ms-client-name": "algorithm", + "type": "string", + "minLength": 1, + "description": "The signing/verification algorithm. For more information on possible algorithm types, see JsonWebKeySignatureAlgorithm.", + "enum": [ "PS256", "PS384", "PS512", "RS256", "RS384", "RS512", "RSNULL", "ES256", "ES384", "ES512", "ES256K" ], + "x-ms-enum": { + "name": "JsonWebKeySignatureAlgorithm", + "modelAsString": true + } + }, + "digest": { + "type": "string", + "format": "base64url", + "description": "The digest used for signing." + }, + "value": { + "x-ms-client-name": "signature", + "type": "string", + "format": "base64url", + "description": "The signature to be verified." + } + }, + "description": "The key verify parameters.", + "required": [ "alg", "digest", "value" ] + }, + "KeyUpdateParameters": { + "properties": { + "key_ops": { + "type": "array", + "items": { + "type": "string", + "enum": [ "encrypt", "decrypt", "sign", "verify", "wrapKey", "unwrapKey" ], + "x-ms-enum": { + "name": "JsonWebKeyOperation", + "modelAsString": true + } + }, + "description": "Json web key operations. For more information on possible key operations, see JsonWebKeyOperation." + }, + "attributes": { + "x-ms-client-name": "keyAttributes", + "$ref": "#/definitions/KeyAttributes" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The key update parameters." + }, + "KeyRestoreParameters": { + "properties": { + "value": { + "type": "string", + "x-ms-client-name": "keyBundleBackup", + "format": "base64url", + "description": "The backup blob associated with a key bundle." + } + }, + "description": "The key restore parameters.", + "required": [ "value" ] + }, + "SecretSetParameters": { + "properties": { + "value": { + "type": "string", + "description": "The value of the secret." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + }, + "contentType": { + "type": "string", + "description": "Type of the secret value such as a password." + }, + "attributes": { + "x-ms-client-name": "secretAttributes", + "$ref": "#/definitions/SecretAttributes", + "description": "The secret management attributes." + } + }, + "description": "The secret set parameters.", + "required": [ "value" ] + }, + "SecretUpdateParameters": { + "properties": { + "contentType": { + "type": "string", + "description": "Type of the secret value such as a password." + }, + "attributes": { + "x-ms-client-name": "secretAttributes", + "$ref": "#/definitions/SecretAttributes", + "description": "The secret management attributes." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The secret update parameters." + }, + "CertificateCreateParameters": { + "properties": { + "policy": { + "x-ms-client-name": "CertificatePolicy", + "$ref": "#/definitions/CertificatePolicy", + "description": "The management policy for the certificate." + }, + "attributes": { + "x-ms-client-name": "CertificateAttributes", + "$ref": "#/definitions/CertificateAttributes", + "description": "The attributes of the certificate (optional)." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The certificate create parameters." + }, + "CertificateImportParameters": { + "properties": { + "value": { + "x-ms-client-name": "base64EncodedCertificate", + "type": "string", + "description": "Base64 encoded representation of the certificate object to import. This certificate needs to contain the private key." + }, + "pwd": { + "x-ms-client-name": "password", + "type": "string", + "description": "If the private key in base64EncodedCertificate is encrypted, the password used for encryption." + }, + "policy": { + "x-ms-client-name": "CertificatePolicy", + "$ref": "#/definitions/CertificatePolicy", + "description": "The management policy for the certificate." + }, + "attributes": { + "x-ms-client-name": "CertificateAttributes", + "$ref": "#/definitions/CertificateAttributes", + "description": "The attributes of the certificate (optional)." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The certificate import parameters.", + "required": [ "value" ] + }, + "CertificateUpdateParameters": { + "properties": { + "policy": { + "x-ms-client-name": "CertificatePolicy", + "$ref": "#/definitions/CertificatePolicy", + "description": "The management policy for the certificate." + }, + "attributes": { + "x-ms-client-name": "CertificateAttributes", + "$ref": "#/definitions/CertificateAttributes", + "description": "The attributes of the certificate (optional)." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The certificate update parameters." + }, + "CertificateMergeParameters": { + "properties": { + "x5c": { + "x-ms-client-name": "x509Certificates", + "type": "array", + "items": { + "type": "string", + "format": "byte" + }, + "description": "The certificate or the certificate chain to merge." + }, + "attributes": { + "x-ms-client-name": "CertificateAttributes", + "$ref": "#/definitions/CertificateAttributes", + "description": "The attributes of the certificate (optional)." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The certificate merge parameters", + "required": [ "x5c" ] + }, + "CertificateIssuerSetParameters": { + "properties": { + "provider": { + "type": "string", + "description": "The issuer provider." + }, + "credentials": { + "$ref": "#/definitions/IssuerCredentials", + "description": "The credentials to be used for the issuer." + }, + "org_details": { + "x-ms-client-name": "OrganizationDetails", + "$ref": "#/definitions/OrganizationDetails", + "description": "Details of the organization as provided to the issuer." + }, + "attributes": { + "$ref": "#/definitions/IssuerAttributes", + "description": "Attributes of the issuer object." + } + }, + "description": "The certificate issuer set parameters.", + "required": [ "provider" ] + }, + "CertificateIssuerUpdateParameters": { + "properties": { + "provider": { + "type": "string", + "description": "The issuer provider." + }, + "credentials": { + "$ref": "#/definitions/IssuerCredentials", + "description": "The credentials to be used for the issuer." + }, + "org_details": { + "x-ms-client-name": "OrganizationDetails", + "$ref": "#/definitions/OrganizationDetails", + "description": "Details of the organization as provided to the issuer." + }, + "attributes": { + "$ref": "#/definitions/IssuerAttributes", + "description": "Attributes of the issuer object." + } + }, + "description": "The certificate issuer update parameters." + }, + "CertificateOperationUpdateParameter": { + "properties": { + "cancellation_requested": { + "type": "boolean", + "description": "Indicates if cancellation was requested on the certificate operation." + } + }, + "description": "The certificate operation update parameters.", + "required": [ "cancellation_requested" ] + }, + "KeyOperationResult": { + "properties": { + "kid": { + "type": "string", + "description": "Key identifier", + "readOnly": true + }, + "value": { + "x-ms-client-name": "result", + "type": "string", + "format": "base64url", + "readOnly": true + } + }, + "description": "The key operation result." + }, + "KeyVerifyResult": { + "properties": { + "value": { + "type": "boolean", + "readOnly": true, + "description": "True if the signature is verified, otherwise false." + } + }, + "description": "The key verify result." + }, + "KeyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/KeyItem" + }, + "readOnly": true, + "description": "A response message containing a list of keys in the key vault along with a link to the next page of keys." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of keys." + } + }, + "description": "The key list result." + }, + "DeletedKeyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedKeyItem" + }, + "readOnly": true, + "description": "A response message containing a list of deleted keys in the vault along with a link to the next page of deleted keys" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of deleted keys." + } + }, + "description": "A list of keys that have been deleted in this vault." + }, + "SecretListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecretItem" + }, + "readOnly": true, + "description": "A response message containing a list of secrets in the key vault along with a link to the next page of secrets." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of secrets." + } + }, + "description": "The secret list result." + }, + "DeletedSecretListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedSecretItem" + }, + "readOnly": true, + "description": "A response message containing a list of the deleted secrets in the vault along with a link to the next page of deleted secrets" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of deleted secrets." + } + }, + "description": "The deleted secret list result" + }, + "CertificateListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateItem" + }, + "readOnly": true, + "description": "A response message containing a list of certificates in the key vault along with a link to the next page of certificates." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of certificates." + } + }, + "description": "The certificate list result." + }, + "DeletedCertificateListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedCertificateItem" + }, + "readOnly": true, + "description": "A response message containing a list of deleted certificates in the vault along with a link to the next page of deleted certificates" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of deleted certificates." + } + }, + "description": "A list of certificates that have been deleted in this vault." + }, + "CertificateIssuerListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateIssuerItem" + }, + "readOnly": true, + "description": "A response message containing a list of certificate issuers in the key vault along with a link to the next page of certificate issuers." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of certificate issuers." + } + }, + "description": "The certificate issuer list result." + }, + "BackupKeyResult": { + "properties": { + "value": { + "type": "string", + "format": "base64url", + "readOnly": true, + "description": "The backup blob containing the backed up key." + } + }, + "description": "The backup key result, containing the backup blob." + }, + "BackupSecretResult": { + "properties": { + "value": { + "type": "string", + "format": "base64url", + "readOnly": true, + "description": "The backup blob containing the backed up secret." + } + }, + "description": "The backup secret result, containing the backup blob." + }, + "BackupStorageResult": { + "properties": { + "value": { + "type": "string", + "format": "base64url", + "readOnly": true, + "description": "The backup blob containing the backed up storage account." + } + }, + "description": "The backup storage result, containing the backup blob." + }, + "PendingCertificateSigningRequestResult": { + "properties": { + "value": { + "type": "string", + "readOnly": true, + "description": "The pending certificate signing request as Base64 encoded string." + } + }, + "description": "The pending certificate signing request result." + }, + "StorageAccountAttributes": { + "properties": { + "enabled": { + "type": "boolean", + "description": "the enabled state of the object." + }, + "created": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Creation time in UTC." + }, + "updated": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Last updated time in UTC." + }, + "recoveryLevel": { + "type": "string", + "description": "Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the system can purge the storage account, at the end of the retention interval.", + "enum": [ "Purgeable", "Recoverable+Purgeable", "Recoverable", "Recoverable+ProtectedSubscription" ], + "x-ms-enum": { + "name": "DeletionRecoveryLevel", + "modelAsString": true + }, + "readOnly": true, + "x-nullable": false + } + }, + "description": "The storage account management attributes." + }, + "StorageBundle": { + "properties": { + "id": { + "type": "string", + "description": "The storage account id.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "The storage account resource id.", + "readOnly": true + }, + "activeKeyName": { + "type": "string", + "description": "The current active storage account key name.", + "readOnly": true + }, + "autoRegenerateKey": { + "type": "boolean", + "description": "whether keyvault should manage the storage account for the user.", + "readOnly": true + }, + "regenerationPeriod": { + "type": "string", + "description": "The key regeneration time duration specified in ISO-8601 format.", + "readOnly": true + }, + "attributes": { + "$ref": "#/definitions/StorageAccountAttributes", + "description": "The storage account attributes.", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs", + "readOnly": true + } + }, + "description": "A Storage account bundle consists of key vault storage account details plus its attributes." + }, + "DeletedStorageBundle": { + "allOf": [ + { + "$ref": "#/definitions/StorageBundle" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted storage account." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the storage account is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the storage account was deleted, in UTC" + } + }, + "description": "A deleted storage account bundle consisting of its previous id, attributes and its tags, as well as information on when it will be purged." + }, + "StorageAccountCreateParameters": { + "properties": { + "resourceId": { + "type": "string", + "description": "Storage account resource id." + }, + "activeKeyName": { + "type": "string", + "description": "Current active storage account key name." + }, + "autoRegenerateKey": { + "type": "boolean", + "description": "whether keyvault should manage the storage account for the user." + }, + "regenerationPeriod": { + "type": "string", + "description": "The key regeneration time duration specified in ISO-8601 format." + }, + "attributes": { + "x-ms-client-name": "StorageAccountAttributes", + "$ref": "#/definitions/StorageAccountAttributes", + "description": "The attributes of the storage account." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The storage account create parameters.", + "required": [ "resourceId", "activeKeyName", "autoRegenerateKey" ] + }, + "StorageAccountUpdateParameters": { + "properties": { + "activeKeyName": { + "type": "string", + "description": "The current active storage account key name." + }, + "autoRegenerateKey": { + "type": "boolean", + "description": "whether keyvault should manage the storage account for the user." + }, + "regenerationPeriod": { + "type": "string", + "description": "The key regeneration time duration specified in ISO-8601 format." + }, + "attributes": { + "x-ms-client-name": "StorageAccountAttributes", + "$ref": "#/definitions/StorageAccountAttributes", + "description": "The attributes of the storage account." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The storage account update parameters." + }, + "StorageAccountRegenerteKeyParameters": { + "properties": { + "keyName": { + "type": "string", + "description": "The storage account key name." + } + }, + "description": "The storage account key regenerate parameters.", + "required": [ "keyName" ] + }, + "StorageAccountItem": { + "properties": { + "id": { + "type": "string", + "description": "Storage identifier.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "Storage account resource Id.", + "readOnly": true + }, + "attributes": { + "$ref": "#/definitions/StorageAccountAttributes", + "description": "The storage account management attributes.", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs.", + "readOnly": true + } + }, + "description": "The storage account item containing storage account metadata." + }, + "DeletedStorageAccountItem": { + "allOf": [ + { + "$ref": "#/definitions/StorageAccountItem" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted storage account." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the storage account is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the storage account was deleted, in UTC" + } + }, + "description": "The deleted storage account item containing metadata about the deleted storage account." + }, + "StorageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountItem" + }, + "readOnly": true, + "description": "A response message containing a list of storage accounts in the key vault along with a link to the next page of storage accounts." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of storage accounts." + } + }, + "description": "The storage accounts list result." + }, + "DeletedStorageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedStorageAccountItem" + }, + "readOnly": true, + "description": "A response message containing a list of the deleted storage accounts in the vault along with a link to the next page of deleted storage accounts" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of deleted storage accounts." + } + }, + "description": "The deleted storage account list result" + }, + "SasDefinitionAttributes": { + "properties": { + "enabled": { + "type": "boolean", + "description": "the enabled state of the object." + }, + "created": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Creation time in UTC." + }, + "updated": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "Last updated time in UTC." + }, + "recoveryLevel": { + "type": "string", + "description": "Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only the system can purge the SAS definition, at the end of the retention interval.", + "enum": [ "Purgeable", "Recoverable+Purgeable", "Recoverable", "Recoverable+ProtectedSubscription" ], + "x-ms-enum": { + "name": "DeletionRecoveryLevel", + "modelAsString": true + }, + "readOnly": true, + "x-nullable": false + } + }, + "description": "The SAS definition management attributes." + }, + "SasDefinitionBundle": { + "properties": { + "id": { + "type": "string", + "description": "The SAS definition id.", + "readOnly": true + }, + "sid": { + "x-ms-client-name": "SecretId", + "type": "string", + "description": "Storage account SAS definition secret id.", + "readOnly": true + }, + "templateUri": { + "type": "string", + "description": "The SAS definition token template signed with an arbitrary key. Tokens created according to the SAS definition will have the same properties as the template.", + "readOnly": true + }, + "sasType": { + "type": "string", + "description": "The type of SAS token the SAS definition will create.", + "enum": [ "account", "service" ], + "x-ms-enum": { + "name": "SasTokenType", + "modelAsString": true + }, + "readOnly": true + }, + "validityPeriod": { + "type": "string", + "description": "The validity period of SAS tokens created according to the SAS definition.", + "readOnly": true + }, + "attributes": { + "$ref": "#/definitions/SasDefinitionAttributes", + "description": "The SAS definition attributes.", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs", + "readOnly": true + } + }, + "description": "A SAS definition bundle consists of key vault SAS definition details plus its attributes." + }, + "DeletedSasDefinitionBundle": { + "allOf": [ + { + "$ref": "#/definitions/SasDefinitionBundle" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted SAS definition." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the SAS definition is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the SAS definition was deleted, in UTC" + } + }, + "description": "A deleted SAS definition bundle consisting of its previous id, attributes and its tags, as well as information on when it will be purged." + }, + "SasDefinitionItem": { + "properties": { + "id": { + "type": "string", + "description": "The storage SAS identifier.", + "readOnly": true + }, + "sid": { + "x-ms-client-name": "SecretId", + "type": "string", + "description": "The storage account SAS definition secret id.", + "readOnly": true + }, + "attributes": { + "$ref": "#/definitions/SasDefinitionAttributes", + "description": "The SAS definition management attributes.", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs.", + "readOnly": true + } + }, + "description": "The SAS definition item containing storage SAS definition metadata." + }, + "DeletedSasDefinitionItem": { + "allOf": [ + { + "$ref": "#/definitions/SasDefinitionItem" + } + ], + "properties": { + "recoveryId": { + "type": "string", + "description": "The url of the recovery object, used to identify and recover the deleted SAS definition." + }, + "scheduledPurgeDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the SAS definition is scheduled to be purged, in UTC" + }, + "deletedDate": { + "type": "integer", + "format": "unixtime", + "readOnly": true, + "description": "The time when the SAS definition was deleted, in UTC" + } + }, + "description": "The deleted SAS definition item containing metadata about the deleted SAS definition." + }, + "SasDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SasDefinitionItem" + }, + "readOnly": true, + "description": "A response message containing a list of SAS definitions along with a link to the next page of SAS definitions." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of SAS defintions." + } + }, + "description": "The storage account SAS definition list result." + }, + "DeletedSasDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeletedSasDefinitionItem" + }, + "readOnly": true, + "description": "A response message containing a list of the deleted SAS definitions in the vault along with a link to the next page of deleted sas definitions" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of deleted SAS definitions." + } + }, + "description": "The deleted SAS definition list result" + }, + "SasDefinitionCreateParameters": { + "properties": { + "templateUri": { + "type": "string", + "description": "The SAS definition token template signed with an arbitrary key. Tokens created according to the SAS definition will have the same properties as the template." + }, + "sasType": { + "type": "string", + "description": "The type of SAS token the SAS definition will create.", + "enum": [ "account", "service" ], + "x-ms-enum": { + "name": "SasTokenType", + "modelAsString": true + } + }, + "validityPeriod": { + "type": "string", + "description": "The validity period of SAS tokens created according to the SAS definition." + }, + "attributes": { + "x-ms-client-name": "SasDefinitionAttributes", + "$ref": "#/definitions/SasDefinitionAttributes", + "description": "The attributes of the SAS definition." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The SAS definition create parameters.", + "required": [ "templateUri", "sasType", "validityPeriod" ] + }, + "SasDefinitionUpdateParameters": { + "properties": { + "templateUri": { + "type": "string", + "description": "The SAS definition token template signed with an arbitrary key. Tokens created according to the SAS definition will have the same properties as the template." + }, + "sasType": { + "type": "string", + "description": "The type of SAS token the SAS definition will create.", + "enum": [ "account", "service" ], + "x-ms-enum": { + "name": "SasTokenType", + "modelAsString": true + } + }, + "validityPeriod": { + "type": "string", + "description": "The validity period of SAS tokens created according to the SAS definition." + }, + "attributes": { + "x-ms-client-name": "SasDefinitionAttributes", + "$ref": "#/definitions/SasDefinitionAttributes", + "description": "The attributes of the SAS definition." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application specific metadata in the form of key-value pairs." + } + }, + "description": "The SAS definition update parameters." + }, + "KeyVaultError": { + "properties": { + "error": { + "readOnly": true, + "$ref": "#/definitions/Error" + } + }, + "description": "The key vault error exception." + }, + "Error": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The error message." + }, + "innererror": { + "x-ms-client-name": "innerError", + "readOnly": true, + "$ref": "#/definitions/Error" + } + }, + "description": "The key vault server error." + }, + "CertificateRestoreParameters": { + "properties": { + "value": { + "type": "string", + "x-ms-client-name": "certificateBundleBackup", + "format": "base64url", + "description": "The backup blob associated with a certificate bundle." + } + }, + "description": "The certificate restore parameters.", + "required": [ "value" ] + }, + "BackupCertificateResult": { + "properties": { + "value": { + "type": "string", + "format": "base64url", + "readOnly": true, + "description": "The backup blob containing the backed up certificate." + } + }, + "description": "The backup certificate result, containing the backup blob." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} \ No newline at end of file diff --git a/specification/keyvault/data-plane/readme.md b/specification/keyvault/data-plane/readme.md index ac6eee85e767..68f9afee7462 100644 --- a/specification/keyvault/data-plane/readme.md +++ b/specification/keyvault/data-plane/readme.md @@ -26,16 +26,16 @@ These are the global settings for the KeyVault API. ``` yaml openapi-type: data-plane -tag: package-2016-10 +tag: package-7.0 ``` -### Tag: package-7.0-preview +### Tag: package-7.0 -These settings apply only when `--tag=package-7.0-preview` is specified on the command line. +These settings apply only when `--tag=package-7.0` is specified on the command line. -``` yaml $(tag) == 'package-7.0-preview' +``` yaml $(tag) == 'package-7.0' input-file: -- Microsoft.KeyVault/preview/7.0/keyvault.json +- Microsoft.KeyVault/stable/7.0/keyvault.json ``` ### Tag: package-2016-10 @@ -102,6 +102,7 @@ python: payload-flattening-threshold: 2 namespace: azure.keyvault package-name: azure-keyvault + package-version: 1.0.0 clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' @@ -131,10 +132,20 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-7.0 - tag: package-2016-10 - tag: package-2015-06 ``` +### Tag: package-7.0 and go + +These settings apply only when `--tag=package-7.0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-7.0' && $(go) +output-folder: $(go-sdk-folder)/services/keyvault/v7.0/keyvault +``` + ### Tag: package-2016-10 and go These settings apply only when `--tag=package-2016-10 --go` is specified on the command line. @@ -164,6 +175,7 @@ java: azure-arm: true namespace: com.microsoft.azure.keyvault license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 + payload-flattening-threshold: 0 output-folder: $(azure-libraries-for-java-folder)/azure-keyvault + override-client-name: KeyVaultClientBase ``` \ No newline at end of file diff --git a/specification/keyvault/data-plane/readme.nodejs.md b/specification/keyvault/data-plane/readme.nodejs.md index 2647db95956f..127a71038e48 100644 --- a/specification/keyvault/data-plane/readme.nodejs.md +++ b/specification/keyvault/data-plane/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder= see https://aka.ms/autorest + +This is the AutoRest configuration file for DNS. + +## Common settings +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true +``` + +``` yaml $(csharp) && !$(multiApi) +namespace: Microsoft.Azure.Management.KeyVault +output-folder: $(csharp-sdks-folder)/KeyVault/Management/Management.KeyVault/Generated +``` + +## Batch settings +These settings are for batch mode only: (ie, add `--MultiApi` to the command line ) + +``` yaml $(multiApi) +namespace: Microsoft.Azure.Management.KeyVault.$(ApiVersionName) +output-folder: $(csharp-sdks-folder)/$(ApiVersionName)/Generated + +batch: + - tag: package-2016-10 + ApiVersionName: Api2016_10_01 +``` \ No newline at end of file diff --git a/specification/keyvault/resource-manager/readme.md b/specification/keyvault/resource-manager/readme.md index 1ab2720d52e9..88d259d36b88 100644 --- a/specification/keyvault/resource-manager/readme.md +++ b/specification/keyvault/resource-manager/readme.md @@ -26,10 +26,22 @@ These are the global settings for the KeyVault API. ``` yaml openapi-type: arm -tag: package-2016-10 +tag: package-2018-02 ``` +### Tag: package-2018-02 + +These settings apply only when `--tag=package-2018-02` is specified on the command line. + +``` yaml $(tag) == 'package-2018-02' +input-file: +- Microsoft.KeyVault/stable/2018-02-14/keyvault.json +- Microsoft.KeyVault/stable/2018-02-14/providers.json +``` + + + ### Tag: package-2016-10 These settings apply only when `--tag=package-2016-10` is specified on the command line. @@ -63,24 +75,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.KeyVault - output-folder: $(csharp-sdks-folder)/KeyVault/Management/Management.KeyVault/Generated - clear-output-folder: true + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_key_vault'] ``` ## Python @@ -97,6 +97,7 @@ python: payload-flattening-threshold: 2 namespace: azure.mgmt.keyvault package-name: azure-mgmt-keyvault + package-version: 1.0.0 clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' @@ -126,10 +127,20 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-02 - tag: package-2016-10 - tag: package-2015-06 ``` +### Tag: package-2018-02 and go + +These settings apply only when `--tag=package-2018-02 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-02' && $(go) +output-folder: $(go-sdk-folder)/services/keyvault/mgmt/2018-02-14/keyvault +``` + ### Tag: package-2016-10 and go These settings apply only when `--tag=package-2016-10 --go` is specified on the command line. @@ -155,10 +166,47 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +namespace: com.microsoft.azure.management.keyvault +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-keyvault +``` + +### Java multi-api + +```yaml $(java) && $(multiapi) +batch: + - tag: package-2016-10 + - tag: package-2015-06 +``` + +### Tag: package-2016-10 and java + +These settings apply only when `--tag=package-2016-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-10' && $(java) && $(multiapi) java: - azure-arm: true - namespace: com.microsoft.azure.management.keyvault - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-keyvault -``` \ No newline at end of file + namespace: com.microsoft.azure.management.keyvault.v2016_10_01 + output-folder: $(azure-libraries-for-java-folder)/keyvault/resource-manager/v2016_10_01 +regenerate-manager: true +generate-interface: true +directive: + from: keyvault.json + where: $.paths["/subscriptions/{subscriptionId}/resources"].get + transform: $['operationId'] = 'Vaults_ListResource' +``` + +### Tag: package-2015-06 and java + +These settings apply only when `--tag=package-2015-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2015-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.keyvault.v2015_06_01 + output-folder: $(azure-libraries-for-java-folder)/keyvault/resource-manager/v2015_06_01 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/keyvault/resource-manager/readme.nodejs.md b/specification/keyvault/resource-manager/readme.nodejs.md index 29b9916000de..c63f2f626ffd 100644 --- a/specification/keyvault/resource-manager/readme.nodejs.md +++ b/specification/keyvault/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-10' && $(ruby) +namespace: "Azure::KeyVault::Mgmt::V2016_10_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_key_vault/lib +``` + +### Tag: package-2015-06 and ruby + +These settings apply only when `--tag=package-2015-06 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-06' && $(ruby) +namespace: "Azure::KeyVault::Mgmt::V2015_06_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_key_vault/lib +``` diff --git a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/CreateAccount.json b/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/CreateAccount.json deleted file mode 100644 index c7d028f5ce43..000000000000 --- a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/CreateAccount.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "api-version": "2017-01-01-preview", - "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", - "resourceGroupName": "myResourceGroup", - "accountName": "myLBSAccount", - "LocationBasedServicesAccountCreateParameters": { - "location": "global", - "sku": { - "name": "S0" - }, - "tags": { - "test": "true" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.LocationBasedServices/accounts/myLBSAccount", - "name": "myLBSAccount", - "type": "Microsoft.LocationBasedServices/accounts", - "location": "global", - "tags": { - "test": "true" - }, - "sku": { - "name": "S0", - "tier": "Standard" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.LocationBasedServices/accounts/myLBSAccount", - "name": "myLBSAccount", - "type": "Microsoft.LocationBasedServices/accounts", - "location": "global", - "tags": { - "test": "true" - }, - "sku": { - "name": "S0", - "tier": "Standard" - } - } - } - } -} diff --git a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/DeleteAccount.json b/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/DeleteAccount.json deleted file mode 100644 index 8568e2d0a606..000000000000 --- a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/DeleteAccount.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "api-version": "2017-01-01-preview", - "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", - "resourceGroupName": "myResourceGroup", - "accountName": "myLBSAccount" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/GetAccount.json b/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/GetAccount.json deleted file mode 100644 index 6916516e550b..000000000000 --- a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/GetAccount.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "api-version": "2017-01-01-preview", - "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", - "resourceGroupName": "myResourceGroup", - "accountName": "myLBSAccount" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.LocationBasedServices/accounts/myLBSAccount", - "name": "myLBSAccount", - "type": "Microsoft.LocationBasedServices/accounts", - "location": "global", - "tags": { - "test": "true" - }, - "sku": { - "name": "S0", - "tier": "Standard" - } - } - }, - "404": {} - } -} diff --git a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/GetOperations.json b/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/GetOperations.json deleted file mode 100644 index 1d1207e5fbf0..000000000000 --- a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/GetOperations.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "parameters": { - "api-version": "2017-01-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.LocationBasedServices/register/action", - "display": { - "provider": "Microsoft Location Based Services", - "resource": "Location Based Services Account", - "operation": "Register the provider", - "description": "Register the provider" - } - }, - { - "name": "Microsoft.LocationBasedServices/accounts/write", - "display": { - "provider": "Microsoft Location Based Services", - "resource": "Location Based Services Account", - "operation": "Create or update a Location Based Services Account.", - "description": "Create or update a Location Based Services Account." - } - }, - { - "name": "Microsoft.LocationBasedServices/accounts/read", - "display": { - "provider": "Microsoft Location Based Services", - "resource": "Location Based Services Account", - "operation": "Get a Location Based Services Account.", - "description": "Get a Location Based Services Account." - } - }, - { - "name": "Microsoft.LocationBasedServices/accounts/delete", - "display": { - "provider": "Microsoft Location Based Services", - "resource": "Location Based Services Account", - "operation": "Delete a Location Based Services Account.", - "description": "Delete a Location Based Services Account." - } - }, - { - "name": "Microsoft.LocationBasedServices/accounts/listKeys/action", - "display": { - "provider": "Microsoft Location Based Services", - "resource": "Location Based Services Account", - "operation": "List keys", - "description": "List Location Based Services Account keys" - } - }, - { - "name": "Microsoft.LocationBasedServices/accounts/regenerateKey/action", - "display": { - "provider": "Microsoft Location Based Services", - "resource": "Location Based Services Account", - "operation": "Generate new primary or secondary key", - "description": "Generate new Location Based Services Account primary or secondary key" - } - } - ] - } - } - } -} diff --git a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/ListAccountsByResourceGroup.json b/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/ListAccountsByResourceGroup.json deleted file mode 100644 index 7c6c29d87f25..000000000000 --- a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/ListAccountsByResourceGroup.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "api-version": "2017-01-01-preview", - "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", - "resourceGroupName": "myResourceGroup" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": - "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.LocationBasedServices/accounts/myLBSAccount2", - "name": "myLBSAccount2", - "type": "Microsoft.LocationBasedServices/accounts", - "location": "global", - "tags": { - "test": "true" - }, - "sku": { - "name": "S0", - "tier": "Standard" - } - }, - { - "id": - "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.LocationBasedServices/accounts/myLBSAccount", - "name": "myLBSAccount", - "type": "Microsoft.LocationBasedServices/accounts", - "location": "global", - "tags": { - "test": "true" - }, - "sku": { - "name": "S0", - "tier": "Standard" - } - } - ] - } - } - } -} diff --git a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/ListAccountsBySubscription.json b/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/ListAccountsBySubscription.json deleted file mode 100644 index aec206866f1e..000000000000 --- a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/ListAccountsBySubscription.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "api-version": "2017-01-01-preview", - "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.LocationBasedServices/accounts/myLBSAccount2", - "name": "myLBSAccount2", - "type": "Microsoft.LocationBasedServices/accounts", - "location": "global", - "tags": { - "test": "true" - }, - "sku": { - "name": "S0", - "tier": "Standard" - } - }, - { - "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.LocationBasedServices/accounts/myLBSAccount", - "name": "myLBSAccount", - "type": "Microsoft.LocationBasedServices/accounts", - "location": "global", - "tags": { - "test": "true" - }, - "sku": { - "name": "S0", - "tier": "Standard" - } - } - ] - } - } - } -} diff --git a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/ListKeys.json b/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/ListKeys.json deleted file mode 100644 index 547be35c4852..000000000000 --- a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/ListKeys.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "api-version": "2017-01-01-preview", - "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", - "resourceGroupName": "myResourceGroup", - "accountName": "myLBSAccount" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.LocationBasedServices/accounts/myLBSAccount", - "primaryKey": "ZiBllKWCwXXLTO13S2TaoHoK8kPFYaoyYlAcnCcE4PQ", - "secondaryKey": "cJHpmUGNaGGO8H59p6NKGhfff9VjD278-2bi5wo0_mU" - } - }, - "404": {} - } -} diff --git a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/MoveAccounts.json b/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/MoveAccounts.json deleted file mode 100644 index a3d981a4815f..000000000000 --- a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/MoveAccounts.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "api-version": "2017-01-01-preview", - "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", - "resourceGroupName": "myResourceGroup", - "moveRequest": { - "targetResourceGroup": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup2", - "resourceIds": [ - "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.LocationBasedServices/accounts/myLBSAccount", - "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.LocationBasedServices/accounts/myLBSAccount2" - ] - } - }, - "responses": { - "200": { - } - } -} diff --git a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/RegenerateKey.json b/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/RegenerateKey.json deleted file mode 100644 index 441feabe1fb2..000000000000 --- a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/RegenerateKey.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "api-version": "2017-01-01-preview", - "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", - "resourceGroupName": "myResourceGroup", - "accountName": "myLBSAccount", - "keySpecification": { - "keyType": "primary" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.LocationBasedServices/accounts/myLBSAccount", - "primaryKey": "uj0yqjjz8zG3IOSWvb_smi1q1QenGtupAqrOA1zCO6s", - "secondaryKey": "cJHpmUGNaGGO8H59p6NKGhfff9VjD278-2bi5wo0_mU" - } - }, - "404": {} - } -} diff --git a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/UpdateAccount.json b/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/UpdateAccount.json deleted file mode 100644 index e40ff9870309..000000000000 --- a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/examples/UpdateAccount.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "api-version": "2017-01-01-preview", - "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", - "resourceGroupName": "myResourceGroup", - "accountName": "myLBSAccount", - "LocationBasedServicesAccountUpdateParameters": { - "tags": { - "specialTag": "true" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.LocationBasedServices/accounts/myLBSAccount", - "name": "myLBSAccount", - "type": "Microsoft.LocationBasedServices/accounts", - "location": "global", - "tags": { - "specialTag": "true" - }, - "sku": { - "name": "S0", - "tier": "Standard" - } - } - }, - "404": {} - } -} diff --git a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/locationbasedservices.json b/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/locationbasedservices.json deleted file mode 100644 index e0dd352a1d05..000000000000 --- a/specification/locationbasedservices/resource-manager/Microsoft.LocationBasedServices/preview/2017-01-01-preview/locationbasedservices.json +++ /dev/null @@ -1,789 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Location Based Services Resource Provider", - "description": "Resource Provider", - "version": "2017-01-01-preview", - "x-ms-code-generation-settings": { - "name": "LocationBasedServicesManagementClient" - } - }, - "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.LocationBasedServices/accounts/{accountName}": { - "put": { - "description": "Create or update a Location Based Services Account. A Location Based Services Account holds the keys which allow access to the Location Based Services REST APIs.", - "operationId": "Accounts_CreateOrUpdate", - "x-ms-examples": { - "CreateAccount": { - "$ref": "./examples/CreateAccount.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "name": "LocationBasedServicesAccountCreateParameters", - "in": "body", - "description": "The new or updated parameters for the Location Based Services Account.", - "required": true, - "schema": { - "$ref": "#/definitions/LocationBasedServicesAccountCreateParameters" - } - } - ], - "responses": { - "200": { - "description": "The Account was successfully updated.", - "schema": { - "$ref": "#/definitions/LocationBasedServicesAccount" - } - }, - "201": { - "description": "The Account was successfully created.", - "schema": { - "$ref": "#/definitions/LocationBasedServicesAccount" - } - }, - "default": { - "description": "An unexpected error occurred.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "patch": { - "description": "Updates a Location Based Services Account. Only a subset of the parameters may be updated after creation, such as Sku and Tags.", - "operationId": "Accounts_Update", - "x-ms-examples": { - "UpdateAccount": { - "$ref": "./examples/UpdateAccount.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "name": "LocationBasedServicesAccountUpdateParameters", - "in": "body", - "description": "The updated parameters for the Location Based Services Account.", - "required": true, - "schema": { - "$ref": "#/definitions/LocationBasedServicesAccountUpdateParameters" - } - } - ], - "responses": { - "200": { - "description": "The Account was successfully updated.", - "schema": { - "$ref": "#/definitions/LocationBasedServicesAccount" - } - }, - "404": { - "description": "The specified Account was not found. Nothing was updated." - }, - "default": { - "description": "An unexpected error occurred.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "delete": { - "description": "Delete a Location Based Services Account", - "operationId": "Accounts_Delete", - "x-ms-examples": { - "DeleteAccount": { - "$ref": "./examples/DeleteAccount.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - } - ], - "responses": { - "200": { - "description": "The Account was deleted successfully." - }, - "204": { - "description": "The specified Account was not found. Nothing was deleted." - }, - "default": { - "description": "An unexpected error occurred.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "get": { - "description": "Get a Location Based Services Account", - "operationId": "Accounts_Get", - "x-ms-examples": { - "GetAccount": { - "$ref": "./examples/GetAccount.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful.", - "schema": { - "$ref": "#/definitions/LocationBasedServicesAccount" - } - }, - "404": { - "description": "The specified Account does not exist." - }, - "default": { - "description": "An unexpected error occurred.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LocationBasedServices/accounts": { - "get": { - "description": "Get all Location Based Services Accounts in a Resource Group", - "operationId": "Accounts_ListByResourceGroup", - "x-ms-examples": { - "ListAccountsByResourceGroup": { - "$ref": "./examples/ListAccountsByResourceGroup.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null, - "itemName": "value" - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful.", - "schema": { - "$ref": "#/definitions/LocationBasedServicesAccounts" - } - }, - "default": { - "description": "An unexpected error occurred.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.LocationBasedServices/accounts": { - "get": { - "description": "Get all Location Based Services Accounts in a Subscription", - "operationId": "Accounts_ListBySubscription", - "x-ms-examples": { - "ListAccountsBySubscription": { - "$ref": "./examples/ListAccountsBySubscription.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null, - "itemName": "value" - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful.", - "schema": { - "$ref": "#/definitions/LocationBasedServicesAccounts" - } - }, - "default": { - "description": "An unexpected error occurred.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources": { - "post": { - "description": "Moves Location Based Services Accounts from one ResourceGroup (or Subscription) to another", - "operationId": "Accounts_Move", - "x-ms-examples": { - "MoveAccounts": { - "$ref": "./examples/MoveAccounts.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group that contains Location Based Services Account to move.", - "required": true, - "type": "string" - }, - { - "name": "moveRequest", - "in": "body", - "description": "The details of the Location Based Services Account move.", - "required": true, - "schema": { - "$ref": "#/definitions/LocationBasedServicesAccountsMoveRequest" - } - } - ], - "responses": { - "200": { - "description": "The Accounts were successfully moved." - }, - "default": { - "description": "An unexpected error occurred.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LocationBasedServices/accounts/{accountName}/listKeys": { - "post": { - "description": "Get the keys to use with the Location Based Services APIs. A key is used to authenticate and authorize access to the Location Based Services REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.", - "operationId": "Accounts_ListKeys", - "x-ms-examples": { - "ListKeys": { - "$ref": "./examples/ListKeys.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful.", - "schema": { - "$ref": "#/definitions/LocationBasedServicesAccountKeys" - } - }, - "404": { - "description": "The specified Account does not exist." - }, - "default": { - "description": "An unexpected error occurred.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LocationBasedServices/accounts/{accountName}/regenerateKey": { - "post": { - "description": "Regenerate either the primary or secondary key for use with the Location Based Services APIs. The old key will stop working immediately.", - "operationId": "Accounts_RegenerateKeys", - "x-ms-examples": { - "RegenerateKey": { - "$ref": "./examples/RegenerateKey.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "name": "keySpecification", - "in": "body", - "required": true, - "description": "Which key to regenerate: primary or secondary.", - "schema": { - "$ref": "#/definitions/LocationBasedServicesKeySpecification" - } - } - ], - "responses": { - "200": { - "description": "The request was successful.", - "schema": { - "$ref": "#/definitions/LocationBasedServicesAccountKeys" - } - }, - "404": { - "description": "The specified Account does not exist." - }, - "default": { - "description": "An unexpected error occurred.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/providers/Microsoft.LocationBasedServices/operations": { - "get": { - "description": "List operations available for the Location Based Services Resource Provider", - "operationId": "Accounts_ListOperations", - "x-ms-examples": { - "GetOperations": { - "$ref": "./examples/GetOperations.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null, - "itemName": "value" - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful.", - "schema": { - "$ref": "#/definitions/LocationBasedServicesOperations" - } - }, - "default": { - "description": "An unexpected error occurred.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - } - }, - "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." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the Azure Resource Group.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AccountNameParameter": { - "name": "accountName", - "in": "path", - "description": "The name of the Location Based Services Account.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "definitions": { - "Error": { - "type": "object", - "description": "This object is returned when an error occurs in the Location Based Service API", - "properties": { - "code": { - "type": "string", - "readOnly": true, - "description": "Error code." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "If available, a human readable description of the error." - }, - "target": { - "type": "string", - "readOnly": true, - "description": "If available, the component generating the error." - }, - "details": { - "type": "array", - "readOnly": true, - "description": "If available, a list of additional details about the error.", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string", - "readOnly": true, - "description": "Error code." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "If available, a human readable description of the error." - }, - "target": { - "type": "string", - "readOnly": true, - "description": "If available, the component generating the error." - } - } - } - } - } - }, - "Resource": { - "description": "An Azure resource", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "The fully qualified Location Based Services Account resource identifier." - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The name of the Location Based Services Account, which is unique within a Resource Group." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Azure resource type." - } - }, - "x-ms-azure-resource": true - }, - "LocationBasedServicesAccount": { - "description": "An Azure resource which represents access to a suite of Location Based Services REST APIs.", - "type": "object", - "properties": { - "location": { - "readOnly": true, - "type": "string", - "description": "The location of the resource." - }, - "tags": { - "readOnly": true, - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." - }, - "sku": { - "readOnly": true, - "description": "The SKU of this account.", - "$ref": "#/definitions/Sku" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "LocationBasedServicesAccountCreateParameters": { - "description": "Parameters used to create a new Location Based Services Account.", - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "The location of the resource." - }, - "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 in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." - }, - "sku": { - "description": "The SKU of this account.", - "$ref": "#/definitions/Sku" - } - }, - "required": [ - "location", - "sku" - ] - }, - "LocationBasedServicesAccountUpdateParameters": { - "description": "Parameters used to update an existing Location Based Services Account.", - "type": "object", - "properties": { - "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 in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." - }, - "sku": { - "description": "The SKU of this account.", - "$ref": "#/definitions/Sku" - } - } - }, - "LocationBasedServicesAccounts": { - "description": "A list of Location Based Services Accounts.", - "type": "object", - "properties": { - "value": { - "description": "A Location Based Services Account.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/LocationBasedServicesAccount" - } - } - } - }, - "Sku": { - "description": "The SKU of the Location Based Services Account.", - "properties": { - "name": { - "description": "The name of the SKU, in standard format (such as S0).", - "type": "string" - }, - "tier": { - "readOnly": true, - "type": "string", - "description": "Gets the sku tier. This is based on the SKU name." - } - }, - "required": [ - "name" - ] - }, - "LocationBasedServicesAccountsMoveRequest": { - "description": "The description of what resources to move between resource groups.", - "type": "object", - "required": [ - "targetResourceGroup", - "resourceIds" - ], - "properties": { - "targetResourceGroup": { - "type": "string", - "description": "The name of the destination resource group." - }, - "resourceIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of resource names to move from the source resource group." - } - } - }, - "LocationBasedServicesKeySpecification": { - "description": "Whether the operation refers to the primary or secondary key.", - "type": "object", - "required": [ - "keyType" - ], - "properties": { - "keyType": { - "type": "string", - "enum": [ - "primary", - "secondary" - ], - "x-ms-enum": { - "name": "KeyType", - "modelAsString": true - }, - "description": "Whether the operation refers to the primary or secondary key." - } - } - }, - "LocationBasedServicesAccountKeys": { - "description": "The set of keys which can be used to access the Location Based Services REST APIs. Two keys are provided for key rotation without interruption.", - "type": "object", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "The full Azure resource identifier of the Location Based Services Account." - }, - "primaryKey": { - "type": "string", - "readOnly": true, - "description": "The primary key for accessing the Location Based Services REST APIs." - }, - "secondaryKey": { - "type": "string", - "readOnly": true, - "description": "The secondary key for accessing the Location Based Services REST APIs." - } - } - }, - "LocationBasedServicesOperations": { - "description": "The set of operations available for Location Based Services.", - "type": "object", - "properties": { - "value": { - "description": "An operation available for Location Based Services.", - "type": "array", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "readOnly": true, - "description": "Operation name: {provider}/{resource}/{operation}." - }, - "display": { - "description": "The human-readable description of the operation.", - "type": "object", - "properties": { - "provider": { - "type": "string", - "readOnly": true, - "description": "Service provider: Microsoft Location Based Services." - }, - "resource": { - "type": "string", - "readOnly": true, - "description": "Resource on which the operation is performed." - }, - "operation": { - "type": "string", - "readOnly": true, - "description": "The action that users can perform, based on their permission level." - }, - "description": { - "type": "string", - "readOnly": true, - "description": "The description of the operation." - } - } - }, - "origin": { - "type": "string", - "readOnly": true, - "description": "The origin of the operation." - } - } - } - } - } - } - } -} diff --git a/specification/locationbasedservices/resource-manager/readme.md b/specification/locationbasedservices/resource-manager/readme.md deleted file mode 100644 index 92ceb6a49d4c..000000000000 --- a/specification/locationbasedservices/resource-manager/readme.md +++ /dev/null @@ -1,115 +0,0 @@ -# LocationBasedServices - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for LocationBasedServices. - ---- -## Getting Started -To build the SDK for LocationBasedServices, 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 LocationBasedServices API. - -``` yaml -openapi-type: arm -tag: package-2017-01 -``` - - -### Tag: package-2017-01 - -These settings apply only when `--tag=package-2017-01` is specified on the command line. - -``` yaml $(tag) == 'package-2017-01' -input-file: -- Microsoft.LocationBasedServices/preview/2017-01-01-preview/locationbasedservices.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-go -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.LocationBasedServices - output-folder: $(csharp-sdks-folder)/LocationBasedServices/Management.LocationBasedServices/Generated - clear-output-folder: true -``` - -## Python - -See configuration in [readme.python.md](./readme.python.md) - -## Go - -These settings apply only when `--go` is specified on the command line. - -``` yaml $(go) -go: - license-header: MICROSOFT_APACHE_NO_VERSION - clear-output-folder: true - namespace: location -``` - -### Go multi-api - -``` yaml $(go) && $(multiapi) -batch: - - tag: package-2017-01 -``` - -### Tag: package-2017-01 and go - -These settings apply only when `--tag=package-2017-01 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag)=='package-2017-01' && $(go) -output-folder: $(go-sdk-folder)/services/location/mgmt/2017-01-01-preview/location -``` - - -## 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 - fluent: true - namespace: com.microsoft.azure.management.location - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-location -``` diff --git a/specification/locationbasedservices/resource-manager/readme.nodejs.md b/specification/locationbasedservices/resource-manager/readme.nodejs.md deleted file mode 100644 index 3c0296c916ac..000000000000 --- a/specification/locationbasedservices/resource-manager/readme.nodejs.md +++ /dev/null @@ -1,15 +0,0 @@ -## Node.js - -These settings apply only when `--nodejs` is specified on the command line. -Please also specify `--node-sdks-folder=`. - -``` yaml $(nodejs) -nodejs: - azure-arm: true - package-name: azure-arm-locationbasedservices - package-version: 1.0.0-preview - output-folder: $(node-sdks-folder)/lib/services/locationbasedservicesManagement - generate-license-txt: true - generate-package-json: true - generate-readme-md: true -``` diff --git a/specification/locationbasedservices/resource-manager/readme.python.md b/specification/locationbasedservices/resource-manager/readme.python.md deleted file mode 100644 index 0f78dcd7bb55..000000000000 --- a/specification/locationbasedservices/resource-manager/readme.python.md +++ /dev/null @@ -1,27 +0,0 @@ -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.locationbasedservices - package-name: azure-mgmt-locationbasedservices - package-version: 0.1.0 - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-locationbasedservices/azure/mgmt/locationbasedservices -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-locationbasedservices -``` diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsCreateOrUpdate.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsCreateOrUpdate.json index 6c089f012391..283e9b65b359 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsCreateOrUpdate.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsCreateOrUpdate.json @@ -1,485 +1,485 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "agreementName":"testAgreement", - "agreement":{ - "properties":{ - "metadata":{}, - "agreementType":"AS2", - "hostPartner":"HostPartner", - "guestPartner":"GuestPartner", - "hostIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "agreementName": "testAgreement", + "agreement": { + "properties": { + "metadata": {}, + "agreementType": "AS2", + "hostPartner": "HostPartner", + "guestPartner": "GuestPartner", + "hostIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + }, + "guestIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "content": { + "aS2": { + "receiveAgreement": { + "protocolSettings": { + "messageConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "acknowledgementConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "mdnSettings": { + "needMdn": true, + "signMdn": true, + "sendMdnAsynchronously": true, + "receiptDeliveryUrl": "http://tempuri.org", + "dispositionNotificationTo": "http://tempuri.org", + "signOutboundMdnIfOptional": true, + "mdnText": "Sample", + "sendInboundMdnToMessageBox": true, + "micHashingAlgorithm": "SHA1" + }, + "securitySettings": { + "overrideGroupSigningCertificate": false, + "enableNrrForInboundEncodedMessages": true, + "enableNrrForInboundDecodedMessages": true, + "enableNrrForOutboundMdn": true, + "enableNrrForOutboundEncodedMessages": true, + "enableNrrForOutboundDecodedMessages": true, + "enableNrrForInboundMdn": true + }, + "validationSettings": { + "overrideMessageProperties": true, + "encryptMessage": false, + "signMessage": false, + "compressMessage": true, + "checkDuplicateMessage": true, + "interchangeDuplicatesValidityDays": 100, + "checkCertificateRevocationListOnSend": true, + "checkCertificateRevocationListOnReceive": true, + "encryptionAlgorithm": "AES128" + }, + "envelopeSettings": { + "messageContentType": "text/plain", + "transmitFileNameInMimeHeader": true, + "fileNameTemplate": "Test", + "suspendMessageOnFileNameGenerationError": true, + "autogenerateFileName": true + }, + "errorSettings": { + "suspendDuplicateMessage": true, + "resendIfMdnNotReceived": true + } + }, + "senderBusinessIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "receiverBusinessIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + } }, - "guestIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "content":{ - "aS2":{ - "receiveAgreement":{ - "protocolSettings":{ - "messageConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "acknowledgementConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "mdnSettings":{ - "needMdn":true, - "signMdn":true, - "sendMdnAsynchronously":true, - "receiptDeliveryUrl":"http://tempuri.org", - "dispositionNotificationTo":"http://tempuri.org", - "signOutboundMdnIfOptional":true, - "mdnText":"Sample", - "sendInboundMdnToMessageBox":true, - "micHashingAlgorithm":"SHA1" - }, - "securitySettings":{ - "overrideGroupSigningCertificate":false, - "enableNrrForInboundEncodedMessages":true, - "enableNrrForInboundDecodedMessages":true, - "enableNrrForOutboundMdn":true, - "enableNrrForOutboundEncodedMessages":true, - "enableNrrForOutboundDecodedMessages":true, - "enableNrrForInboundMdn":true - }, - "validationSettings":{ - "overrideMessageProperties":true, - "encryptMessage":false, - "signMessage":false, - "compressMessage":true, - "checkDuplicateMessage":true, - "interchangeDuplicatesValidityDays":100, - "checkCertificateRevocationListOnSend":true, - "checkCertificateRevocationListOnReceive":true, - "encryptionAlgorithm":"AES128" - }, - "envelopeSettings":{ - "messageContentType":"text/plain", - "transmitFileNameInMimeHeader":true, - "fileNameTemplate":"Test", - "suspendMessageOnFileNameGenerationError":true, - "autogenerateFileName":true - }, - "errorSettings":{ - "suspendDuplicateMessage":true, - "resendIfMdnNotReceived":true - } - }, - "senderBusinessIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "receiverBusinessIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - } - }, - "sendAgreement":{ - "protocolSettings":{ - "messageConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "acknowledgementConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "mdnSettings":{ - "needMdn":true, - "signMdn":true, - "sendMdnAsynchronously":true, - "receiptDeliveryUrl":"http://tempuri.org", - "dispositionNotificationTo":"http://tempuri.org", - "signOutboundMdnIfOptional":true, - "mdnText":"Sample", - "sendInboundMdnToMessageBox":true, - "micHashingAlgorithm":"SHA1" - }, - "securitySettings":{ - "overrideGroupSigningCertificate":false, - "enableNrrForInboundEncodedMessages":true, - "enableNrrForInboundDecodedMessages":true, - "enableNrrForOutboundMdn":true, - "enableNrrForOutboundEncodedMessages":true, - "enableNrrForOutboundDecodedMessages":true, - "enableNrrForInboundMdn":true - }, - "validationSettings":{ - "overrideMessageProperties":true, - "encryptMessage":false, - "signMessage":false, - "compressMessage":true, - "checkDuplicateMessage":true, - "interchangeDuplicatesValidityDays":100, - "checkCertificateRevocationListOnSend":true, - "checkCertificateRevocationListOnReceive":true, - "encryptionAlgorithm":"AES128" - }, - "envelopeSettings":{ - "messageContentType":"text/plain", - "transmitFileNameInMimeHeader":true, - "fileNameTemplate":"Test", - "suspendMessageOnFileNameGenerationError":true, - "autogenerateFileName":true - }, - "errorSettings":{ - "suspendDuplicateMessage":true, - "resendIfMdnNotReceived":true - } - }, - "senderBusinessIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - }, - "receiverBusinessIdentity":{ - "qualifier":"AA", - "value":"AA" - } - } - } - } - }, - "location":"westus", - "tags":{ - "IntegrationAccountAgreement":"" - } + "sendAgreement": { + "protocolSettings": { + "messageConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "acknowledgementConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "mdnSettings": { + "needMdn": true, + "signMdn": true, + "sendMdnAsynchronously": true, + "receiptDeliveryUrl": "http://tempuri.org", + "dispositionNotificationTo": "http://tempuri.org", + "signOutboundMdnIfOptional": true, + "mdnText": "Sample", + "sendInboundMdnToMessageBox": true, + "micHashingAlgorithm": "SHA1" + }, + "securitySettings": { + "overrideGroupSigningCertificate": false, + "enableNrrForInboundEncodedMessages": true, + "enableNrrForInboundDecodedMessages": true, + "enableNrrForOutboundMdn": true, + "enableNrrForOutboundEncodedMessages": true, + "enableNrrForOutboundDecodedMessages": true, + "enableNrrForInboundMdn": true + }, + "validationSettings": { + "overrideMessageProperties": true, + "encryptMessage": false, + "signMessage": false, + "compressMessage": true, + "checkDuplicateMessage": true, + "interchangeDuplicatesValidityDays": 100, + "checkCertificateRevocationListOnSend": true, + "checkCertificateRevocationListOnReceive": true, + "encryptionAlgorithm": "AES128" + }, + "envelopeSettings": { + "messageContentType": "text/plain", + "transmitFileNameInMimeHeader": true, + "fileNameTemplate": "Test", + "suspendMessageOnFileNameGenerationError": true, + "autogenerateFileName": true + }, + "errorSettings": { + "suspendDuplicateMessage": true, + "resendIfMdnNotReceived": true + } + }, + "senderBusinessIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + }, + "receiverBusinessIdentity": { + "qualifier": "AA", + "value": "AA" + } + } + } + } + }, + "location": "westus", + "tags": { + "IntegrationAccountAgreement": "" } - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - "hostPartner":"HostPartner", - "guestPartner":"GuestPartner", - "hostIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - }, - "guestIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "agreementType":"AS2", - "content":{ - "aS2":{ - "receiveAgreement":{ - "protocolSettings":{ - "messageConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "acknowledgementConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "mdnSettings":{ - "needMdn":true, - "signMdn":true, - "sendMdnAsynchronously":true, - "receiptDeliveryUrl":"http://tempuri.org", - "dispositionNotificationTo":"http://tempuri.org", - "signOutboundMdnIfOptional":true, - "mdnText":"Sample", - "sendInboundMdnToMessageBox":true, - "micHashingAlgorithm":"SHA1" - }, - "securitySettings":{ - "overrideGroupSigningCertificate":false, - "enableNrrForInboundEncodedMessages":true, - "enableNrrForInboundDecodedMessages":true, - "enableNrrForOutboundMdn":true, - "enableNrrForOutboundEncodedMessages":true, - "enableNrrForOutboundDecodedMessages":true, - "enableNrrForInboundMdn":true - }, - "validationSettings":{ - "overrideMessageProperties":true, - "encryptMessage":false, - "signMessage":false, - "compressMessage":true, - "checkDuplicateMessage":true, - "interchangeDuplicatesValidityDays":100, - "checkCertificateRevocationListOnSend":true, - "checkCertificateRevocationListOnReceive":true, - "encryptionAlgorithm":"AES128" - }, - "envelopeSettings":{ - "messageContentType":"text/plain", - "transmitFileNameInMimeHeader":true, - "fileNameTemplate":"Test", - "suspendMessageOnFileNameGenerationError":true, - "autogenerateFileName":true - }, - "errorSettings":{ - "suspendDuplicateMessage":true, - "resendIfMdnNotReceived":true - } - }, - "senderBusinessIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "receiverBusinessIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - } - }, - "sendAgreement":{ - "protocolSettings":{ - "messageConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "acknowledgementConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "mdnSettings":{ - "needMdn":true, - "signMdn":true, - "sendMdnAsynchronously":true, - "receiptDeliveryUrl":"http://tempuri.org", - "dispositionNotificationTo":"http://tempuri.org", - "signOutboundMdnIfOptional":true, - "mdnText":"Sample", - "sendInboundMdnToMessageBox":true, - "micHashingAlgorithm":"SHA1" - }, - "securitySettings":{ - "overrideGroupSigningCertificate":false, - "enableNrrForInboundEncodedMessages":true, - "enableNrrForInboundDecodedMessages":true, - "enableNrrForOutboundMdn":true, - "enableNrrForOutboundEncodedMessages":true, - "enableNrrForOutboundDecodedMessages":true, - "enableNrrForInboundMdn":true - }, - "validationSettings":{ - "overrideMessageProperties":true, - "encryptMessage":false, - "signMessage":false, - "compressMessage":true, - "checkDuplicateMessage":true, - "interchangeDuplicatesValidityDays":100, - "checkCertificateRevocationListOnSend":true, - "checkCertificateRevocationListOnReceive":true, - "encryptionAlgorithm":"AES128" - }, - "envelopeSettings":{ - "messageContentType":"text/plain", - "transmitFileNameInMimeHeader":true, - "fileNameTemplate":"Test", - "suspendMessageOnFileNameGenerationError":true, - "autogenerateFileName":true - }, - "errorSettings":{ - "suspendDuplicateMessage":true, - "resendIfMdnNotReceived":true - } - }, - "senderBusinessIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - }, - "receiverBusinessIdentity":{ - "qualifier":"AA", - "value":"AA" - } - } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "hostPartner": "HostPartner", + "guestPartner": "GuestPartner", + "hostIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + }, + "guestIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "agreementType": "AS2", + "content": { + "aS2": { + "receiveAgreement": { + "protocolSettings": { + "messageConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "acknowledgementConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "mdnSettings": { + "needMdn": true, + "signMdn": true, + "sendMdnAsynchronously": true, + "receiptDeliveryUrl": "http://tempuri.org", + "dispositionNotificationTo": "http://tempuri.org", + "signOutboundMdnIfOptional": true, + "mdnText": "Sample", + "sendInboundMdnToMessageBox": true, + "micHashingAlgorithm": "SHA1" + }, + "securitySettings": { + "overrideGroupSigningCertificate": false, + "enableNrrForInboundEncodedMessages": true, + "enableNrrForInboundDecodedMessages": true, + "enableNrrForOutboundMdn": true, + "enableNrrForOutboundEncodedMessages": true, + "enableNrrForOutboundDecodedMessages": true, + "enableNrrForInboundMdn": true + }, + "validationSettings": { + "overrideMessageProperties": true, + "encryptMessage": false, + "signMessage": false, + "compressMessage": true, + "checkDuplicateMessage": true, + "interchangeDuplicatesValidityDays": 100, + "checkCertificateRevocationListOnSend": true, + "checkCertificateRevocationListOnReceive": true, + "encryptionAlgorithm": "AES128" + }, + "envelopeSettings": { + "messageContentType": "text/plain", + "transmitFileNameInMimeHeader": true, + "fileNameTemplate": "Test", + "suspendMessageOnFileNameGenerationError": true, + "autogenerateFileName": true + }, + "errorSettings": { + "suspendDuplicateMessage": true, + "resendIfMdnNotReceived": true } - }, - "createdTime":"2017-03-06T22:32:54.2938748Z", - "changedTime":"2017-03-06T22:32:54.2945291Z", - "metadata":{} - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount4533/agreements/", - "name":"", - "type":"Microsoft.Logic/integrationAccounts/agreements" - } - }, - "201":{ - "body":{ - "properties":{ - "hostPartner":"HostPartner", - "guestPartner":"GuestPartner", - "hostIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - }, - "guestIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "agreementType":"AS2", - "content":{ - "aS2":{ - "receiveAgreement":{ - "protocolSettings":{ - "messageConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "acknowledgementConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "mdnSettings":{ - "needMdn":true, - "signMdn":true, - "sendMdnAsynchronously":true, - "receiptDeliveryUrl":"http://tempuri.org", - "dispositionNotificationTo":"http://tempuri.org", - "signOutboundMdnIfOptional":true, - "mdnText":"Sample", - "sendInboundMdnToMessageBox":true, - "micHashingAlgorithm":"SHA1" - }, - "securitySettings":{ - "overrideGroupSigningCertificate":false, - "enableNrrForInboundEncodedMessages":true, - "enableNrrForInboundDecodedMessages":true, - "enableNrrForOutboundMdn":true, - "enableNrrForOutboundEncodedMessages":true, - "enableNrrForOutboundDecodedMessages":true, - "enableNrrForInboundMdn":true - }, - "validationSettings":{ - "overrideMessageProperties":true, - "encryptMessage":false, - "signMessage":false, - "compressMessage":true, - "checkDuplicateMessage":true, - "interchangeDuplicatesValidityDays":100, - "checkCertificateRevocationListOnSend":true, - "checkCertificateRevocationListOnReceive":true, - "encryptionAlgorithm":"AES128" - }, - "envelopeSettings":{ - "messageContentType":"text/plain", - "transmitFileNameInMimeHeader":true, - "fileNameTemplate":"Test", - "suspendMessageOnFileNameGenerationError":true, - "autogenerateFileName":true - }, - "errorSettings":{ - "suspendDuplicateMessage":true, - "resendIfMdnNotReceived":true - } - }, - "senderBusinessIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "receiverBusinessIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - } - }, - "sendAgreement":{ - "protocolSettings":{ - "messageConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "acknowledgementConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "mdnSettings":{ - "needMdn":true, - "signMdn":true, - "sendMdnAsynchronously":true, - "receiptDeliveryUrl":"http://tempuri.org", - "dispositionNotificationTo":"http://tempuri.org", - "signOutboundMdnIfOptional":true, - "mdnText":"Sample", - "sendInboundMdnToMessageBox":true, - "micHashingAlgorithm":"SHA1" - }, - "securitySettings":{ - "overrideGroupSigningCertificate":false, - "enableNrrForInboundEncodedMessages":true, - "enableNrrForInboundDecodedMessages":true, - "enableNrrForOutboundMdn":true, - "enableNrrForOutboundEncodedMessages":true, - "enableNrrForOutboundDecodedMessages":true, - "enableNrrForInboundMdn":true - }, - "validationSettings":{ - "overrideMessageProperties":true, - "encryptMessage":false, - "signMessage":false, - "compressMessage":true, - "checkDuplicateMessage":true, - "interchangeDuplicatesValidityDays":100, - "checkCertificateRevocationListOnSend":true, - "checkCertificateRevocationListOnReceive":true, - "encryptionAlgorithm":"AES128" - }, - "envelopeSettings":{ - "messageContentType":"text/plain", - "transmitFileNameInMimeHeader":true, - "fileNameTemplate":"Test", - "suspendMessageOnFileNameGenerationError":true, - "autogenerateFileName":true - }, - "errorSettings":{ - "suspendDuplicateMessage":true, - "resendIfMdnNotReceived":true - } - }, - "senderBusinessIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - }, - "receiverBusinessIdentity":{ - "qualifier":"AA", - "value":"AA" - } - } + }, + "senderBusinessIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "receiverBusinessIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + } + }, + "sendAgreement": { + "protocolSettings": { + "messageConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "acknowledgementConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "mdnSettings": { + "needMdn": true, + "signMdn": true, + "sendMdnAsynchronously": true, + "receiptDeliveryUrl": "http://tempuri.org", + "dispositionNotificationTo": "http://tempuri.org", + "signOutboundMdnIfOptional": true, + "mdnText": "Sample", + "sendInboundMdnToMessageBox": true, + "micHashingAlgorithm": "SHA1" + }, + "securitySettings": { + "overrideGroupSigningCertificate": false, + "enableNrrForInboundEncodedMessages": true, + "enableNrrForInboundDecodedMessages": true, + "enableNrrForOutboundMdn": true, + "enableNrrForOutboundEncodedMessages": true, + "enableNrrForOutboundDecodedMessages": true, + "enableNrrForInboundMdn": true + }, + "validationSettings": { + "overrideMessageProperties": true, + "encryptMessage": false, + "signMessage": false, + "compressMessage": true, + "checkDuplicateMessage": true, + "interchangeDuplicatesValidityDays": 100, + "checkCertificateRevocationListOnSend": true, + "checkCertificateRevocationListOnReceive": true, + "encryptionAlgorithm": "AES128" + }, + "envelopeSettings": { + "messageContentType": "text/plain", + "transmitFileNameInMimeHeader": true, + "fileNameTemplate": "Test", + "suspendMessageOnFileNameGenerationError": true, + "autogenerateFileName": true + }, + "errorSettings": { + "suspendDuplicateMessage": true, + "resendIfMdnNotReceived": true } - }, - "createdTime":"2017-03-06T22:32:54.2938748Z", - "changedTime":"2017-03-06T22:32:54.2945291Z", - "metadata":{} - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount4533/agreements/", - "name":"", - "type":"Microsoft.Logic/integrationAccounts/agreements" - } + }, + "senderBusinessIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + }, + "receiverBusinessIdentity": { + "qualifier": "AA", + "value": "AA" + } + } + } + }, + "createdTime": "2017-03-06T22:32:54.2938748Z", + "changedTime": "2017-03-06T22:32:54.2945291Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount4533/agreements/", + "name": "", + "type": "Microsoft.Logic/integrationAccounts/agreements" + } + }, + "201": { + "body": { + "properties": { + "hostPartner": "HostPartner", + "guestPartner": "GuestPartner", + "hostIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + }, + "guestIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "agreementType": "AS2", + "content": { + "aS2": { + "receiveAgreement": { + "protocolSettings": { + "messageConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "acknowledgementConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "mdnSettings": { + "needMdn": true, + "signMdn": true, + "sendMdnAsynchronously": true, + "receiptDeliveryUrl": "http://tempuri.org", + "dispositionNotificationTo": "http://tempuri.org", + "signOutboundMdnIfOptional": true, + "mdnText": "Sample", + "sendInboundMdnToMessageBox": true, + "micHashingAlgorithm": "SHA1" + }, + "securitySettings": { + "overrideGroupSigningCertificate": false, + "enableNrrForInboundEncodedMessages": true, + "enableNrrForInboundDecodedMessages": true, + "enableNrrForOutboundMdn": true, + "enableNrrForOutboundEncodedMessages": true, + "enableNrrForOutboundDecodedMessages": true, + "enableNrrForInboundMdn": true + }, + "validationSettings": { + "overrideMessageProperties": true, + "encryptMessage": false, + "signMessage": false, + "compressMessage": true, + "checkDuplicateMessage": true, + "interchangeDuplicatesValidityDays": 100, + "checkCertificateRevocationListOnSend": true, + "checkCertificateRevocationListOnReceive": true, + "encryptionAlgorithm": "AES128" + }, + "envelopeSettings": { + "messageContentType": "text/plain", + "transmitFileNameInMimeHeader": true, + "fileNameTemplate": "Test", + "suspendMessageOnFileNameGenerationError": true, + "autogenerateFileName": true + }, + "errorSettings": { + "suspendDuplicateMessage": true, + "resendIfMdnNotReceived": true + } + }, + "senderBusinessIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "receiverBusinessIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + } + }, + "sendAgreement": { + "protocolSettings": { + "messageConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "acknowledgementConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "mdnSettings": { + "needMdn": true, + "signMdn": true, + "sendMdnAsynchronously": true, + "receiptDeliveryUrl": "http://tempuri.org", + "dispositionNotificationTo": "http://tempuri.org", + "signOutboundMdnIfOptional": true, + "mdnText": "Sample", + "sendInboundMdnToMessageBox": true, + "micHashingAlgorithm": "SHA1" + }, + "securitySettings": { + "overrideGroupSigningCertificate": false, + "enableNrrForInboundEncodedMessages": true, + "enableNrrForInboundDecodedMessages": true, + "enableNrrForOutboundMdn": true, + "enableNrrForOutboundEncodedMessages": true, + "enableNrrForOutboundDecodedMessages": true, + "enableNrrForInboundMdn": true + }, + "validationSettings": { + "overrideMessageProperties": true, + "encryptMessage": false, + "signMessage": false, + "compressMessage": true, + "checkDuplicateMessage": true, + "interchangeDuplicatesValidityDays": 100, + "checkCertificateRevocationListOnSend": true, + "checkCertificateRevocationListOnReceive": true, + "encryptionAlgorithm": "AES128" + }, + "envelopeSettings": { + "messageContentType": "text/plain", + "transmitFileNameInMimeHeader": true, + "fileNameTemplate": "Test", + "suspendMessageOnFileNameGenerationError": true, + "autogenerateFileName": true + }, + "errorSettings": { + "suspendDuplicateMessage": true, + "resendIfMdnNotReceived": true + } + }, + "senderBusinessIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + }, + "receiverBusinessIdentity": { + "qualifier": "AA", + "value": "AA" + } + } + } + }, + "createdTime": "2017-03-06T22:32:54.2938748Z", + "changedTime": "2017-03-06T22:32:54.2945291Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount4533/agreements/", + "name": "", + "type": "Microsoft.Logic/integrationAccounts/agreements" } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsDelete.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsDelete.json index 9bd3dd90f03d..ad1e9a1788c7 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsDelete.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsDelete.json @@ -1,13 +1,13 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "agreementName":"testAgreement" - }, - "responses":{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "agreementName": "testAgreement" + }, + "responses": { "200": {}, "204": {} - } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsGet.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsGet.json index f54789fa571c..20ba8e5cb95b 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsGet.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsGet.json @@ -1,170 +1,170 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "agreementName":"testAgreement" - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - "hostPartner":"HostPartner", - "guestPartner":"GuestPartner", - "hostIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - }, - "guestIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "agreementType":"AS2", - "content":{ - "aS2":{ - "receiveAgreement":{ - "protocolSettings":{ - "messageConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "acknowledgementConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "mdnSettings":{ - "needMdn":true, - "signMdn":true, - "sendMdnAsynchronously":true, - "receiptDeliveryUrl":"http://tempuri.org", - "dispositionNotificationTo":"http://tempuri.org", - "signOutboundMdnIfOptional":true, - "mdnText":"Sample", - "sendInboundMdnToMessageBox":true, - "micHashingAlgorithm":"SHA1" - }, - "securitySettings":{ - "overrideGroupSigningCertificate":false, - "enableNrrForInboundEncodedMessages":true, - "enableNrrForInboundDecodedMessages":true, - "enableNrrForOutboundMdn":true, - "enableNrrForOutboundEncodedMessages":true, - "enableNrrForOutboundDecodedMessages":true, - "enableNrrForInboundMdn":true - }, - "validationSettings":{ - "overrideMessageProperties":true, - "encryptMessage":false, - "signMessage":false, - "compressMessage":true, - "checkDuplicateMessage":true, - "interchangeDuplicatesValidityDays":100, - "checkCertificateRevocationListOnSend":true, - "checkCertificateRevocationListOnReceive":true, - "encryptionAlgorithm":"AES128" - }, - "envelopeSettings":{ - "messageContentType":"text/plain", - "transmitFileNameInMimeHeader":true, - "fileNameTemplate":"Test", - "suspendMessageOnFileNameGenerationError":true, - "autogenerateFileName":true - }, - "errorSettings":{ - "suspendDuplicateMessage":true, - "resendIfMdnNotReceived":true - } - }, - "senderBusinessIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "receiverBusinessIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - } - }, - "sendAgreement":{ - "protocolSettings":{ - "messageConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "acknowledgementConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "mdnSettings":{ - "needMdn":true, - "signMdn":true, - "sendMdnAsynchronously":true, - "receiptDeliveryUrl":"http://tempuri.org", - "dispositionNotificationTo":"http://tempuri.org", - "signOutboundMdnIfOptional":true, - "mdnText":"Sample", - "sendInboundMdnToMessageBox":true, - "micHashingAlgorithm":"SHA1" - }, - "securitySettings":{ - "overrideGroupSigningCertificate":false, - "enableNrrForInboundEncodedMessages":true, - "enableNrrForInboundDecodedMessages":true, - "enableNrrForOutboundMdn":true, - "enableNrrForOutboundEncodedMessages":true, - "enableNrrForOutboundDecodedMessages":true, - "enableNrrForInboundMdn":true - }, - "validationSettings":{ - "overrideMessageProperties":true, - "encryptMessage":false, - "signMessage":false, - "compressMessage":true, - "checkDuplicateMessage":true, - "interchangeDuplicatesValidityDays":100, - "checkCertificateRevocationListOnSend":true, - "checkCertificateRevocationListOnReceive":true, - "encryptionAlgorithm":"AES128" - }, - "envelopeSettings":{ - "messageContentType":"text/plain", - "transmitFileNameInMimeHeader":true, - "fileNameTemplate":"Test", - "suspendMessageOnFileNameGenerationError":true, - "autogenerateFileName":true - }, - "errorSettings":{ - "suspendDuplicateMessage":true, - "resendIfMdnNotReceived":true - } - }, - "senderBusinessIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - }, - "receiverBusinessIdentity":{ - "qualifier":"AA", - "value":"AA" - } - } + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "agreementName": "testAgreement" + }, + "responses": { + "200": { + "body": { + "properties": { + "hostPartner": "HostPartner", + "guestPartner": "GuestPartner", + "hostIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + }, + "guestIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "agreementType": "AS2", + "content": { + "aS2": { + "receiveAgreement": { + "protocolSettings": { + "messageConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "acknowledgementConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "mdnSettings": { + "needMdn": true, + "signMdn": true, + "sendMdnAsynchronously": true, + "receiptDeliveryUrl": "http://tempuri.org", + "dispositionNotificationTo": "http://tempuri.org", + "signOutboundMdnIfOptional": true, + "mdnText": "Sample", + "sendInboundMdnToMessageBox": true, + "micHashingAlgorithm": "SHA1" + }, + "securitySettings": { + "overrideGroupSigningCertificate": false, + "enableNrrForInboundEncodedMessages": true, + "enableNrrForInboundDecodedMessages": true, + "enableNrrForOutboundMdn": true, + "enableNrrForOutboundEncodedMessages": true, + "enableNrrForOutboundDecodedMessages": true, + "enableNrrForInboundMdn": true + }, + "validationSettings": { + "overrideMessageProperties": true, + "encryptMessage": false, + "signMessage": false, + "compressMessage": true, + "checkDuplicateMessage": true, + "interchangeDuplicatesValidityDays": 100, + "checkCertificateRevocationListOnSend": true, + "checkCertificateRevocationListOnReceive": true, + "encryptionAlgorithm": "AES128" + }, + "envelopeSettings": { + "messageContentType": "text/plain", + "transmitFileNameInMimeHeader": true, + "fileNameTemplate": "Test", + "suspendMessageOnFileNameGenerationError": true, + "autogenerateFileName": true + }, + "errorSettings": { + "suspendDuplicateMessage": true, + "resendIfMdnNotReceived": true } - }, - "createdTime":"2017-03-06T22:32:54.2938748Z", - "changedTime":"2017-03-06T22:32:54.2945291Z", - "metadata":{} - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts//agreements/", - "name":"", - "type":"Microsoft.Logic/integrationAccounts/agreements" - } + }, + "senderBusinessIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "receiverBusinessIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + } + }, + "sendAgreement": { + "protocolSettings": { + "messageConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "acknowledgementConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "mdnSettings": { + "needMdn": true, + "signMdn": true, + "sendMdnAsynchronously": true, + "receiptDeliveryUrl": "http://tempuri.org", + "dispositionNotificationTo": "http://tempuri.org", + "signOutboundMdnIfOptional": true, + "mdnText": "Sample", + "sendInboundMdnToMessageBox": true, + "micHashingAlgorithm": "SHA1" + }, + "securitySettings": { + "overrideGroupSigningCertificate": false, + "enableNrrForInboundEncodedMessages": true, + "enableNrrForInboundDecodedMessages": true, + "enableNrrForOutboundMdn": true, + "enableNrrForOutboundEncodedMessages": true, + "enableNrrForOutboundDecodedMessages": true, + "enableNrrForInboundMdn": true + }, + "validationSettings": { + "overrideMessageProperties": true, + "encryptMessage": false, + "signMessage": false, + "compressMessage": true, + "checkDuplicateMessage": true, + "interchangeDuplicatesValidityDays": 100, + "checkCertificateRevocationListOnSend": true, + "checkCertificateRevocationListOnReceive": true, + "encryptionAlgorithm": "AES128" + }, + "envelopeSettings": { + "messageContentType": "text/plain", + "transmitFileNameInMimeHeader": true, + "fileNameTemplate": "Test", + "suspendMessageOnFileNameGenerationError": true, + "autogenerateFileName": true + }, + "errorSettings": { + "suspendDuplicateMessage": true, + "resendIfMdnNotReceived": true + } + }, + "senderBusinessIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + }, + "receiverBusinessIdentity": { + "qualifier": "AA", + "value": "AA" + } + } + } + }, + "createdTime": "2017-03-06T22:32:54.2938748Z", + "changedTime": "2017-03-06T22:32:54.2945291Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts//agreements/", + "name": "", + "type": "Microsoft.Logic/integrationAccounts/agreements" } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsListByIntegrationAccounts.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsListByIntegrationAccounts.json index 8dc30e8108db..bb0a8abbcb1c 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsListByIntegrationAccounts.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsListByIntegrationAccounts.json @@ -1,606 +1,598 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount" - }, - "responses":{ - "200":{ - "body":{ - "value":[ - { - "properties":{ - "hostPartner":"HostPartner", - "guestPartner":"GuestPartner", - "hostIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - }, - "guestIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "agreementType":"X12", - "content":{ - "x12":{ - "receiveAgreement":{ - "protocolSettings":{ - "validationSettings":{ - "validateCharacterSet":true, - "checkDuplicateInterchangeControlNumber":false, - "interchangeControlNumberValidityDays":30, - "checkDuplicateGroupControlNumber":false, - "checkDuplicateTransactionSetControlNumber":false, - "validateEdiTypes":true, - "validateXsdTypes":false, - "allowLeadingAndTrailingSpacesAndZeroes":false, - "trimLeadingAndTrailingSpacesAndZeroes":false, - "trailingSeparatorPolicy":"NotAllowed" - }, - "framingSettings":{ - "dataElementSeparator":42, - "componentSeparator":58, - "replaceSeparatorsInPayload":false, - "replaceCharacter":36, - "segmentTerminator":126, - "characterSet":"UTF8", - "segmentTerminatorSuffix":"None" - }, - "envelopeSettings":{ - "controlStandardsId":85, - "useControlStandardsIdAsRepetitionCharacter":false, - "senderApplicationId":"BTS-SENDER", - "receiverApplicationId":"RECEIVE-APP", - "controlVersionNumber":"00401", - "interchangeControlNumberLowerBound":1, - "interchangeControlNumberUpperBound":999999999, - "rolloverInterchangeControlNumber":true, - "enableDefaultGroupHeaders":true, - "groupControlNumberLowerBound":1, - "groupControlNumberUpperBound":999999999, - "rolloverGroupControlNumber":true, - "groupHeaderAgencyCode":"T", - "groupHeaderVersion":"00401", - "transactionSetControlNumberLowerBound":1, - "transactionSetControlNumberUpperBound":999999999, - "rolloverTransactionSetControlNumber":true, - "overwriteExistingTransactionSetControlNumber":true, - "groupHeaderDateFormat":"CCYYMMDD", - "groupHeaderTimeFormat":"HHMM", - "usageIndicator":"Test" - }, - "acknowledgementSettings":{ - "needTechnicalAcknowledgement":false, - "batchTechnicalAcknowledgements":true, - "needFunctionalAcknowledgement":false, - "batchFunctionalAcknowledgements":true, - "needImplementationAcknowledgement":false, - "batchImplementationAcknowledgements":false, - "needLoopForValidMessages":false, - "sendSynchronousAcknowledgement":true, - "acknowledgementControlNumberLowerBound":1, - "acknowledgementControlNumberUpperBound":999999999, - "rolloverAcknowledgementControlNumber":true - }, - "messageFilter":{ - "messageFilterType":"Exclude" - }, - "securitySettings":{ - "authorizationQualifier":"00", - "securityQualifier":"00" - }, - "processingSettings":{ - "maskSecurityInfo":true, - "convertImpliedDecimal":true, - "preserveInterchange":true, - "suspendInterchangeOnError":true, - "createEmptyXmlTagsForTrailingSeparators":true, - "useDotAsDecimalSeparator":true - }, - "schemaReferences":[ - - ] - }, - "senderBusinessIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "receiverBusinessIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - } - }, - "sendAgreement":{ - "protocolSettings":{ - "validationSettings":{ - "validateCharacterSet":true, - "checkDuplicateInterchangeControlNumber":false, - "interchangeControlNumberValidityDays":30, - "checkDuplicateGroupControlNumber":false, - "checkDuplicateTransactionSetControlNumber":false, - "validateEdiTypes":true, - "validateXsdTypes":false, - "allowLeadingAndTrailingSpacesAndZeroes":false, - "trimLeadingAndTrailingSpacesAndZeroes":false, - "trailingSeparatorPolicy":"NotAllowed" - }, - "framingSettings":{ - "dataElementSeparator":42, - "componentSeparator":58, - "replaceSeparatorsInPayload":false, - "replaceCharacter":36, - "segmentTerminator":126, - "characterSet":"UTF8", - "segmentTerminatorSuffix":"None" - }, - "envelopeSettings":{ - "controlStandardsId":100, - "useControlStandardsIdAsRepetitionCharacter":true, - "senderApplicationId":"100", - "receiverApplicationId":"100", - "controlVersionNumber":"0.0", - "interchangeControlNumberLowerBound":1, - "interchangeControlNumberUpperBound":999999999, - "rolloverInterchangeControlNumber":true, - "enableDefaultGroupHeaders":true, - "functionalGroupId":"1", - "groupControlNumberLowerBound":1, - "groupControlNumberUpperBound":999999999, - "rolloverGroupControlNumber":true, - "groupHeaderAgencyCode":"T", - "groupHeaderVersion":"0.0", - "transactionSetControlNumberLowerBound":1, - "transactionSetControlNumberUpperBound":999999999, - "rolloverTransactionSetControlNumber":true, - "transactionSetControlNumberPrefix":"", - "transactionSetControlNumberSuffix":"", - "overwriteExistingTransactionSetControlNumber":true, - "groupHeaderDateFormat":"CCYYMMDD", - "groupHeaderTimeFormat":"HHMM", - "usageIndicator":"Information" - }, - "acknowledgementSettings":{ - "needTechnicalAcknowledgement":false, - "batchTechnicalAcknowledgements":true, - "needFunctionalAcknowledgement":false, - "batchFunctionalAcknowledgements":true, - "needImplementationAcknowledgement":false, - "batchImplementationAcknowledgements":false, - "needLoopForValidMessages":false, - "sendSynchronousAcknowledgement":true, - "acknowledgementControlNumberLowerBound":1, - "acknowledgementControlNumberUpperBound":999999999, - "rolloverAcknowledgementControlNumber":true - }, - "messageFilter":{ - "messageFilterType":"Exclude" - }, - "securitySettings":{ - "authorizationQualifier":"00", - "securityQualifier":"00" - }, - "processingSettings":{ - "maskSecurityInfo":true, - "convertImpliedDecimal":true, - "preserveInterchange":true, - "suspendInterchangeOnError":true, - "createEmptyXmlTagsForTrailingSeparators":true, - "useDotAsDecimalSeparator":true - }, - "schemaReferences":[ - - ] - }, - "senderBusinessIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - }, - "receiverBusinessIdentity":{ - "qualifier":"AA", - "value":"AA" - } - } - } - }, - "createdTime":"2017-03-06T22:00:54.1516558Z", - "changedTime":"2017-03-06T22:00:54.1520445Z", - "metadata":{} + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "hostPartner": "HostPartner", + "guestPartner": "GuestPartner", + "hostIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + }, + "guestIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "agreementType": "X12", + "content": { + "x12": { + "receiveAgreement": { + "protocolSettings": { + "validationSettings": { + "validateCharacterSet": true, + "checkDuplicateInterchangeControlNumber": false, + "interchangeControlNumberValidityDays": 30, + "checkDuplicateGroupControlNumber": false, + "checkDuplicateTransactionSetControlNumber": false, + "validateEdiTypes": true, + "validateXsdTypes": false, + "allowLeadingAndTrailingSpacesAndZeroes": false, + "trimLeadingAndTrailingSpacesAndZeroes": false, + "trailingSeparatorPolicy": "NotAllowed" + }, + "framingSettings": { + "dataElementSeparator": 42, + "componentSeparator": 58, + "replaceSeparatorsInPayload": false, + "replaceCharacter": 36, + "segmentTerminator": 126, + "characterSet": "UTF8", + "segmentTerminatorSuffix": "None" + }, + "envelopeSettings": { + "controlStandardsId": 85, + "useControlStandardsIdAsRepetitionCharacter": false, + "senderApplicationId": "BTS-SENDER", + "receiverApplicationId": "RECEIVE-APP", + "controlVersionNumber": "00401", + "interchangeControlNumberLowerBound": 1, + "interchangeControlNumberUpperBound": 999999999, + "rolloverInterchangeControlNumber": true, + "enableDefaultGroupHeaders": true, + "groupControlNumberLowerBound": 1, + "groupControlNumberUpperBound": 999999999, + "rolloverGroupControlNumber": true, + "groupHeaderAgencyCode": "T", + "groupHeaderVersion": "00401", + "transactionSetControlNumberLowerBound": 1, + "transactionSetControlNumberUpperBound": 999999999, + "rolloverTransactionSetControlNumber": true, + "overwriteExistingTransactionSetControlNumber": true, + "groupHeaderDateFormat": "CCYYMMDD", + "groupHeaderTimeFormat": "HHMM", + "usageIndicator": "Test" + }, + "acknowledgementSettings": { + "needTechnicalAcknowledgement": false, + "batchTechnicalAcknowledgements": true, + "needFunctionalAcknowledgement": false, + "batchFunctionalAcknowledgements": true, + "needImplementationAcknowledgement": false, + "batchImplementationAcknowledgements": false, + "needLoopForValidMessages": false, + "sendSynchronousAcknowledgement": true, + "acknowledgementControlNumberLowerBound": 1, + "acknowledgementControlNumberUpperBound": 999999999, + "rolloverAcknowledgementControlNumber": true + }, + "messageFilter": { + "messageFilterType": "Exclude" + }, + "securitySettings": { + "authorizationQualifier": "00", + "securityQualifier": "00" + }, + "processingSettings": { + "maskSecurityInfo": true, + "convertImpliedDecimal": true, + "preserveInterchange": true, + "suspendInterchangeOnError": true, + "createEmptyXmlTagsForTrailingSeparators": true, + "useDotAsDecimalSeparator": true + }, + "schemaReferences": [] + }, + "senderBusinessIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "receiverBusinessIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + } }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts//agreements/", - "name":"", - "type":"Microsoft.Logic/integrationAccounts/agreements" - }, - { - "properties":{ - "hostPartner":"HostPartner", - "guestPartner":"GuestPartner", - "hostIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - }, - "guestIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "agreementType":"AS2", - "content":{ - "aS2":{ - "receiveAgreement":{ - "protocolSettings":{ - "messageConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "acknowledgementConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "mdnSettings":{ - "needMdn":true, - "signMdn":true, - "sendMdnAsynchronously":true, - "receiptDeliveryUrl":"http://tempuri.org", - "dispositionNotificationTo":"http://tempuri.org", - "signOutboundMdnIfOptional":true, - "mdnText":"Sample", - "sendInboundMdnToMessageBox":true, - "micHashingAlgorithm":"None" - }, - "securitySettings":{ - "overrideGroupSigningCertificate":false, - "enableNrrForInboundEncodedMessages":true, - "enableNrrForInboundDecodedMessages":true, - "enableNrrForOutboundMdn":true, - "enableNrrForOutboundEncodedMessages":true, - "enableNrrForOutboundDecodedMessages":true, - "enableNrrForInboundMdn":true - }, - "validationSettings":{ - "overrideMessageProperties":true, - "encryptMessage":false, - "signMessage":false, - "compressMessage":true, - "checkDuplicateMessage":true, - "interchangeDuplicatesValidityDays":100, - "checkCertificateRevocationListOnSend":true, - "checkCertificateRevocationListOnReceive":true, - "encryptionAlgorithm":"AES128" - }, - "envelopeSettings":{ - "messageContentType":"text/plain", - "transmitFileNameInMimeHeader":true, - "fileNameTemplate":"Test", - "suspendMessageOnFileNameGenerationError":true, - "autogenerateFileName":true - }, - "errorSettings":{ - "suspendDuplicateMessage":true, - "resendIfMdnNotReceived":true - } - }, - "senderBusinessIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "receiverBusinessIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - } - }, - "sendAgreement":{ - "protocolSettings":{ - "messageConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "acknowledgementConnectionSettings":{ - "ignoreCertificateNameMismatch":true, - "supportHttpStatusCodeContinue":true, - "keepHttpConnectionAlive":true, - "unfoldHttpHeaders":true - }, - "mdnSettings":{ - "needMdn":true, - "signMdn":true, - "sendMdnAsynchronously":true, - "receiptDeliveryUrl":"http://tempuri.org", - "dispositionNotificationTo":"http://tempuri.org", - "signOutboundMdnIfOptional":true, - "mdnText":"Sample", - "sendInboundMdnToMessageBox":true, - "micHashingAlgorithm":"None" - }, - "securitySettings":{ - "overrideGroupSigningCertificate":false, - "enableNrrForInboundEncodedMessages":true, - "enableNrrForInboundDecodedMessages":true, - "enableNrrForOutboundMdn":true, - "enableNrrForOutboundEncodedMessages":true, - "enableNrrForOutboundDecodedMessages":true, - "enableNrrForInboundMdn":true - }, - "validationSettings":{ - "overrideMessageProperties":true, - "encryptMessage":false, - "signMessage":false, - "compressMessage":true, - "checkDuplicateMessage":true, - "interchangeDuplicatesValidityDays":100, - "checkCertificateRevocationListOnSend":true, - "checkCertificateRevocationListOnReceive":true, - "encryptionAlgorithm":"AES128" - }, - "envelopeSettings":{ - "messageContentType":"text/plain", - "transmitFileNameInMimeHeader":true, - "fileNameTemplate":"Test", - "suspendMessageOnFileNameGenerationError":true, - "autogenerateFileName":true - }, - "errorSettings":{ - "suspendDuplicateMessage":true, - "resendIfMdnNotReceived":true - } - }, - "senderBusinessIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - }, - "receiverBusinessIdentity":{ - "qualifier":"AA", - "value":"AA" - } - } - } - }, - "createdTime":"2017-03-06T22:00:53.4134038Z", - "changedTime":"2017-03-06T22:00:53.4140804Z", - "metadata":{} + "sendAgreement": { + "protocolSettings": { + "validationSettings": { + "validateCharacterSet": true, + "checkDuplicateInterchangeControlNumber": false, + "interchangeControlNumberValidityDays": 30, + "checkDuplicateGroupControlNumber": false, + "checkDuplicateTransactionSetControlNumber": false, + "validateEdiTypes": true, + "validateXsdTypes": false, + "allowLeadingAndTrailingSpacesAndZeroes": false, + "trimLeadingAndTrailingSpacesAndZeroes": false, + "trailingSeparatorPolicy": "NotAllowed" + }, + "framingSettings": { + "dataElementSeparator": 42, + "componentSeparator": 58, + "replaceSeparatorsInPayload": false, + "replaceCharacter": 36, + "segmentTerminator": 126, + "characterSet": "UTF8", + "segmentTerminatorSuffix": "None" + }, + "envelopeSettings": { + "controlStandardsId": 100, + "useControlStandardsIdAsRepetitionCharacter": true, + "senderApplicationId": "100", + "receiverApplicationId": "100", + "controlVersionNumber": "0.0", + "interchangeControlNumberLowerBound": 1, + "interchangeControlNumberUpperBound": 999999999, + "rolloverInterchangeControlNumber": true, + "enableDefaultGroupHeaders": true, + "functionalGroupId": "1", + "groupControlNumberLowerBound": 1, + "groupControlNumberUpperBound": 999999999, + "rolloverGroupControlNumber": true, + "groupHeaderAgencyCode": "T", + "groupHeaderVersion": "0.0", + "transactionSetControlNumberLowerBound": 1, + "transactionSetControlNumberUpperBound": 999999999, + "rolloverTransactionSetControlNumber": true, + "transactionSetControlNumberPrefix": "", + "transactionSetControlNumberSuffix": "", + "overwriteExistingTransactionSetControlNumber": true, + "groupHeaderDateFormat": "CCYYMMDD", + "groupHeaderTimeFormat": "HHMM", + "usageIndicator": "Information" + }, + "acknowledgementSettings": { + "needTechnicalAcknowledgement": false, + "batchTechnicalAcknowledgements": true, + "needFunctionalAcknowledgement": false, + "batchFunctionalAcknowledgements": true, + "needImplementationAcknowledgement": false, + "batchImplementationAcknowledgements": false, + "needLoopForValidMessages": false, + "sendSynchronousAcknowledgement": true, + "acknowledgementControlNumberLowerBound": 1, + "acknowledgementControlNumberUpperBound": 999999999, + "rolloverAcknowledgementControlNumber": true + }, + "messageFilter": { + "messageFilterType": "Exclude" + }, + "securitySettings": { + "authorizationQualifier": "00", + "securityQualifier": "00" + }, + "processingSettings": { + "maskSecurityInfo": true, + "convertImpliedDecimal": true, + "preserveInterchange": true, + "suspendInterchangeOnError": true, + "createEmptyXmlTagsForTrailingSeparators": true, + "useDotAsDecimalSeparator": true + }, + "schemaReferences": [] + }, + "senderBusinessIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + }, + "receiverBusinessIdentity": { + "qualifier": "AA", + "value": "AA" + } + } + } + }, + "createdTime": "2017-03-06T22:00:54.1516558Z", + "changedTime": "2017-03-06T22:00:54.1520445Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts//agreements/", + "name": "", + "type": "Microsoft.Logic/integrationAccounts/agreements" + }, + { + "properties": { + "hostPartner": "HostPartner", + "guestPartner": "GuestPartner", + "hostIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + }, + "guestIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "agreementType": "AS2", + "content": { + "aS2": { + "receiveAgreement": { + "protocolSettings": { + "messageConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "acknowledgementConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "mdnSettings": { + "needMdn": true, + "signMdn": true, + "sendMdnAsynchronously": true, + "receiptDeliveryUrl": "http://tempuri.org", + "dispositionNotificationTo": "http://tempuri.org", + "signOutboundMdnIfOptional": true, + "mdnText": "Sample", + "sendInboundMdnToMessageBox": true, + "micHashingAlgorithm": "None" + }, + "securitySettings": { + "overrideGroupSigningCertificate": false, + "enableNrrForInboundEncodedMessages": true, + "enableNrrForInboundDecodedMessages": true, + "enableNrrForOutboundMdn": true, + "enableNrrForOutboundEncodedMessages": true, + "enableNrrForOutboundDecodedMessages": true, + "enableNrrForInboundMdn": true + }, + "validationSettings": { + "overrideMessageProperties": true, + "encryptMessage": false, + "signMessage": false, + "compressMessage": true, + "checkDuplicateMessage": true, + "interchangeDuplicatesValidityDays": 100, + "checkCertificateRevocationListOnSend": true, + "checkCertificateRevocationListOnReceive": true, + "encryptionAlgorithm": "AES128" + }, + "envelopeSettings": { + "messageContentType": "text/plain", + "transmitFileNameInMimeHeader": true, + "fileNameTemplate": "Test", + "suspendMessageOnFileNameGenerationError": true, + "autogenerateFileName": true + }, + "errorSettings": { + "suspendDuplicateMessage": true, + "resendIfMdnNotReceived": true + } + }, + "senderBusinessIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "receiverBusinessIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + } }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts//agreements/", - "name":"", - "type":"Microsoft.Logic/integrationAccounts/agreements" - }, - { - "properties":{ - "hostPartner":"HostPartner", - "guestPartner":"GuestPartner", - "hostIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - }, - "guestIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "agreementType":"Edifact", - "content":{ - "edifact":{ - "receiveAgreement":{ - "protocolSettings":{ - "validationSettings":{ - "validateCharacterSet":true, - "checkDuplicateInterchangeControlNumber":true, - "interchangeControlNumberValidityDays":30, - "checkDuplicateGroupControlNumber":true, - "checkDuplicateTransactionSetControlNumber":true, - "validateEdiTypes":true, - "validateXsdTypes":true, - "trimLeadingAndTrailingSpacesAndZeroes":true, - "allowLeadingAndTrailingSpacesAndZeroes":true, - "trailingSeparatorPolicy":"Optional" - }, - "framingSettings":{ - "characterEncoding":"UTF", - "protocolVersion":4, - "dataElementSeparator":53, - "componentSeparator":58, - "segmentTerminator":39, - "releaseIndicator":63, - "repetitionSeparator":42, - "characterSet":"UNOC", - "decimalPointIndicator":"Comma", - "segmentTerminatorSuffix":"None" - }, - "envelopeSettings":{ - "groupAssociationAssignedCode":"0", - "communicationAgreementId":"0", - "applyDelimiterStringAdvice":true, - "createGroupingSegments":true, - "enableDefaultGroupHeaders":true, - "recipientReferencePasswordValue":"AA", - "recipientReferencePasswordQualifier":"ZZ", - "applicationReferenceId":"0", - "processingPriorityCode":"0", - "interchangeControlNumberLowerBound":1, - "interchangeControlNumberUpperBound":99999999, - "rolloverInterchangeControlNumber":true, - "interchangeControlNumberPrefix":"CU", - "interchangeControlNumberSuffix":"NUM", - "functionalGroupId":"0", - "groupControllingAgencyCode":"0", - "groupMessageVersion":"0.0", - "groupMessageRelease":"0.0", - "groupControlNumberLowerBound":1, - "groupControlNumberUpperBound":99999999, - "rolloverGroupControlNumber":true, - "groupControlNumberPrefix":"CU", - "groupControlNumberSuffix":"NUM", - "groupApplicationReceiverQualifier":"ZZZ", - "groupApplicationReceiverId":"0", - "groupApplicationSenderQualifier":"ZZZ", - "groupApplicationSenderId":"AAA", - "groupApplicationPassword":"0", - "overwriteExistingTransactionSetControlNumber":true, - "transactionSetControlNumberPrefix":"", - "transactionSetControlNumberSuffix":"", - "transactionSetControlNumberLowerBound":1, - "transactionSetControlNumberUpperBound":99999999, - "rolloverTransactionSetControlNumber":true, - "isTestInterchange":true, - "senderInternalIdentification":"AA", - "senderInternalSubIdentification":"AA", - "receiverInternalIdentification":"0", - "receiverInternalSubIdentification":"0" - }, - "acknowledgementSettings":{ - "needTechnicalAcknowledgement":true, - "batchTechnicalAcknowledgements":true, - "needFunctionalAcknowledgement":false, - "batchFunctionalAcknowledgements":true, - "needLoopForValidMessages":false, - "sendSynchronousAcknowledgement":true, - "acknowledgementControlNumberPrefix":"", - "acknowledgementControlNumberSuffix":"", - "acknowledgementControlNumberLowerBound":1, - "acknowledgementControlNumberUpperBound":99999999, - "rolloverAcknowledgementControlNumber":true - }, - "messageFilter":{ - "messageFilterType":"Exclude" - }, - "processingSettings":{ - "maskSecurityInfo":true, - "preserveInterchange":true, - "suspendInterchangeOnError":true, - "createEmptyXmlTagsForTrailingSeparators":true, - "useDotAsDecimalSeparator":true - }, - "schemaReferences":[ - - ] - }, - "senderBusinessIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "receiverBusinessIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - } - }, - "sendAgreement":{ - "protocolSettings":{ - "validationSettings":{ - "validateCharacterSet":true, - "checkDuplicateInterchangeControlNumber":true, - "interchangeControlNumberValidityDays":30, - "checkDuplicateGroupControlNumber":true, - "checkDuplicateTransactionSetControlNumber":true, - "validateEdiTypes":true, - "validateXsdTypes":true, - "trimLeadingAndTrailingSpacesAndZeroes":true, - "allowLeadingAndTrailingSpacesAndZeroes":true, - "trailingSeparatorPolicy":"Optional" - }, - "framingSettings":{ - "characterEncoding":"UTF", - "protocolVersion":4, - "dataElementSeparator":53, - "componentSeparator":58, - "segmentTerminator":39, - "releaseIndicator":63, - "repetitionSeparator":42, - "characterSet":"UNOC", - "decimalPointIndicator":"Comma", - "segmentTerminatorSuffix":"None" - }, - "envelopeSettings":{ - "groupAssociationAssignedCode":"0", - "communicationAgreementId":"0", - "applyDelimiterStringAdvice":true, - "createGroupingSegments":true, - "enableDefaultGroupHeaders":true, - "recipientReferencePasswordValue":"AA", - "recipientReferencePasswordQualifier":"ZZ", - "applicationReferenceId":"0", - "processingPriorityCode":"0", - "interchangeControlNumberLowerBound":1, - "interchangeControlNumberUpperBound":999999999, - "rolloverInterchangeControlNumber":true, - "interchangeControlNumberPrefix":"CU", - "interchangeControlNumberSuffix":"NUM", - "functionalGroupId":"0", - "groupControllingAgencyCode":"0", - "groupMessageVersion":"0.0", - "groupMessageRelease":"0.0", - "groupControlNumberLowerBound":1, - "groupControlNumberUpperBound":999999999, - "rolloverGroupControlNumber":true, - "groupControlNumberPrefix":"", - "groupControlNumberSuffix":"", - "groupApplicationReceiverQualifier":"ZZ", - "groupApplicationReceiverId":"0", - "groupApplicationSenderQualifier":"ZZ", - "groupApplicationSenderId":"AA", - "groupApplicationPassword":"0", - "overwriteExistingTransactionSetControlNumber":true, - "transactionSetControlNumberPrefix":"", - "transactionSetControlNumberSuffix":"", - "transactionSetControlNumberLowerBound":1, - "transactionSetControlNumberUpperBound":999999999, - "rolloverTransactionSetControlNumber":true, - "isTestInterchange":true, - "senderInternalIdentification":"AA", - "senderInternalSubIdentification":"AA", - "receiverInternalIdentification":"0", - "receiverInternalSubIdentification":"0" - }, - "acknowledgementSettings":{ - "needTechnicalAcknowledgement":true, - "batchTechnicalAcknowledgements":true, - "needFunctionalAcknowledgement":true, - "batchFunctionalAcknowledgements":true, - "needLoopForValidMessages":true, - "sendSynchronousAcknowledgement":true, - "acknowledgementControlNumberPrefix":"CN", - "acknowledgementControlNumberSuffix":"NUM", - "acknowledgementControlNumberLowerBound":1, - "acknowledgementControlNumberUpperBound":999999999, - "rolloverAcknowledgementControlNumber":true - }, - "messageFilter":{ - "messageFilterType":"Exclude" - }, - "processingSettings":{ - "maskSecurityInfo":true, - "preserveInterchange":true, - "suspendInterchangeOnError":true, - "createEmptyXmlTagsForTrailingSeparators":true, - "useDotAsDecimalSeparator":true - }, - "schemaReferences":[ - - ] - }, - "senderBusinessIdentity":{ - "qualifier":"AA", - "value":"AA" - }, - "receiverBusinessIdentity":{ - "qualifier":"ZZ", - "value":"ZZ" - } - } - } - }, - "createdTime":"2017-03-06T22:00:53.8205121Z", - "changedTime":"2017-03-06T22:00:53.8212345Z", - "metadata":{} + "sendAgreement": { + "protocolSettings": { + "messageConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "acknowledgementConnectionSettings": { + "ignoreCertificateNameMismatch": true, + "supportHttpStatusCodeContinue": true, + "keepHttpConnectionAlive": true, + "unfoldHttpHeaders": true + }, + "mdnSettings": { + "needMdn": true, + "signMdn": true, + "sendMdnAsynchronously": true, + "receiptDeliveryUrl": "http://tempuri.org", + "dispositionNotificationTo": "http://tempuri.org", + "signOutboundMdnIfOptional": true, + "mdnText": "Sample", + "sendInboundMdnToMessageBox": true, + "micHashingAlgorithm": "None" + }, + "securitySettings": { + "overrideGroupSigningCertificate": false, + "enableNrrForInboundEncodedMessages": true, + "enableNrrForInboundDecodedMessages": true, + "enableNrrForOutboundMdn": true, + "enableNrrForOutboundEncodedMessages": true, + "enableNrrForOutboundDecodedMessages": true, + "enableNrrForInboundMdn": true + }, + "validationSettings": { + "overrideMessageProperties": true, + "encryptMessage": false, + "signMessage": false, + "compressMessage": true, + "checkDuplicateMessage": true, + "interchangeDuplicatesValidityDays": 100, + "checkCertificateRevocationListOnSend": true, + "checkCertificateRevocationListOnReceive": true, + "encryptionAlgorithm": "AES128" + }, + "envelopeSettings": { + "messageContentType": "text/plain", + "transmitFileNameInMimeHeader": true, + "fileNameTemplate": "Test", + "suspendMessageOnFileNameGenerationError": true, + "autogenerateFileName": true + }, + "errorSettings": { + "suspendDuplicateMessage": true, + "resendIfMdnNotReceived": true + } + }, + "senderBusinessIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + }, + "receiverBusinessIdentity": { + "qualifier": "AA", + "value": "AA" + } + } + } + }, + "createdTime": "2017-03-06T22:00:53.4134038Z", + "changedTime": "2017-03-06T22:00:53.4140804Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts//agreements/", + "name": "", + "type": "Microsoft.Logic/integrationAccounts/agreements" + }, + { + "properties": { + "hostPartner": "HostPartner", + "guestPartner": "GuestPartner", + "hostIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + }, + "guestIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "agreementType": "Edifact", + "content": { + "edifact": { + "receiveAgreement": { + "protocolSettings": { + "validationSettings": { + "validateCharacterSet": true, + "checkDuplicateInterchangeControlNumber": true, + "interchangeControlNumberValidityDays": 30, + "checkDuplicateGroupControlNumber": true, + "checkDuplicateTransactionSetControlNumber": true, + "validateEdiTypes": true, + "validateXsdTypes": true, + "trimLeadingAndTrailingSpacesAndZeroes": true, + "allowLeadingAndTrailingSpacesAndZeroes": true, + "trailingSeparatorPolicy": "Optional" + }, + "framingSettings": { + "characterEncoding": "UTF", + "protocolVersion": 4, + "dataElementSeparator": 53, + "componentSeparator": 58, + "segmentTerminator": 39, + "releaseIndicator": 63, + "repetitionSeparator": 42, + "characterSet": "UNOC", + "decimalPointIndicator": "Comma", + "segmentTerminatorSuffix": "None" + }, + "envelopeSettings": { + "groupAssociationAssignedCode": "0", + "communicationAgreementId": "0", + "applyDelimiterStringAdvice": true, + "createGroupingSegments": true, + "enableDefaultGroupHeaders": true, + "recipientReferencePasswordValue": "AA", + "recipientReferencePasswordQualifier": "ZZ", + "applicationReferenceId": "0", + "processingPriorityCode": "0", + "interchangeControlNumberLowerBound": 1, + "interchangeControlNumberUpperBound": 99999999, + "rolloverInterchangeControlNumber": true, + "interchangeControlNumberPrefix": "CU", + "interchangeControlNumberSuffix": "NUM", + "functionalGroupId": "0", + "groupControllingAgencyCode": "0", + "groupMessageVersion": "0.0", + "groupMessageRelease": "0.0", + "groupControlNumberLowerBound": 1, + "groupControlNumberUpperBound": 99999999, + "rolloverGroupControlNumber": true, + "groupControlNumberPrefix": "CU", + "groupControlNumberSuffix": "NUM", + "groupApplicationReceiverQualifier": "ZZZ", + "groupApplicationReceiverId": "0", + "groupApplicationSenderQualifier": "ZZZ", + "groupApplicationSenderId": "AAA", + "groupApplicationPassword": "0", + "overwriteExistingTransactionSetControlNumber": true, + "transactionSetControlNumberPrefix": "", + "transactionSetControlNumberSuffix": "", + "transactionSetControlNumberLowerBound": 1, + "transactionSetControlNumberUpperBound": 99999999, + "rolloverTransactionSetControlNumber": true, + "isTestInterchange": true, + "senderInternalIdentification": "AA", + "senderInternalSubIdentification": "AA", + "receiverInternalIdentification": "0", + "receiverInternalSubIdentification": "0" + }, + "acknowledgementSettings": { + "needTechnicalAcknowledgement": true, + "batchTechnicalAcknowledgements": true, + "needFunctionalAcknowledgement": false, + "batchFunctionalAcknowledgements": true, + "needLoopForValidMessages": false, + "sendSynchronousAcknowledgement": true, + "acknowledgementControlNumberPrefix": "", + "acknowledgementControlNumberSuffix": "", + "acknowledgementControlNumberLowerBound": 1, + "acknowledgementControlNumberUpperBound": 99999999, + "rolloverAcknowledgementControlNumber": true + }, + "messageFilter": { + "messageFilterType": "Exclude" + }, + "processingSettings": { + "maskSecurityInfo": true, + "preserveInterchange": true, + "suspendInterchangeOnError": true, + "createEmptyXmlTagsForTrailingSeparators": true, + "useDotAsDecimalSeparator": true + }, + "schemaReferences": [] + }, + "senderBusinessIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "receiverBusinessIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + } }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts//agreements/", - "name":"", - "type":"Microsoft.Logic/integrationAccounts/agreements" - } - ] - } + "sendAgreement": { + "protocolSettings": { + "validationSettings": { + "validateCharacterSet": true, + "checkDuplicateInterchangeControlNumber": true, + "interchangeControlNumberValidityDays": 30, + "checkDuplicateGroupControlNumber": true, + "checkDuplicateTransactionSetControlNumber": true, + "validateEdiTypes": true, + "validateXsdTypes": true, + "trimLeadingAndTrailingSpacesAndZeroes": true, + "allowLeadingAndTrailingSpacesAndZeroes": true, + "trailingSeparatorPolicy": "Optional" + }, + "framingSettings": { + "characterEncoding": "UTF", + "protocolVersion": 4, + "dataElementSeparator": 53, + "componentSeparator": 58, + "segmentTerminator": 39, + "releaseIndicator": 63, + "repetitionSeparator": 42, + "characterSet": "UNOC", + "decimalPointIndicator": "Comma", + "segmentTerminatorSuffix": "None" + }, + "envelopeSettings": { + "groupAssociationAssignedCode": "0", + "communicationAgreementId": "0", + "applyDelimiterStringAdvice": true, + "createGroupingSegments": true, + "enableDefaultGroupHeaders": true, + "recipientReferencePasswordValue": "AA", + "recipientReferencePasswordQualifier": "ZZ", + "applicationReferenceId": "0", + "processingPriorityCode": "0", + "interchangeControlNumberLowerBound": 1, + "interchangeControlNumberUpperBound": 999999999, + "rolloverInterchangeControlNumber": true, + "interchangeControlNumberPrefix": "CU", + "interchangeControlNumberSuffix": "NUM", + "functionalGroupId": "0", + "groupControllingAgencyCode": "0", + "groupMessageVersion": "0.0", + "groupMessageRelease": "0.0", + "groupControlNumberLowerBound": 1, + "groupControlNumberUpperBound": 999999999, + "rolloverGroupControlNumber": true, + "groupControlNumberPrefix": "", + "groupControlNumberSuffix": "", + "groupApplicationReceiverQualifier": "ZZ", + "groupApplicationReceiverId": "0", + "groupApplicationSenderQualifier": "ZZ", + "groupApplicationSenderId": "AA", + "groupApplicationPassword": "0", + "overwriteExistingTransactionSetControlNumber": true, + "transactionSetControlNumberPrefix": "", + "transactionSetControlNumberSuffix": "", + "transactionSetControlNumberLowerBound": 1, + "transactionSetControlNumberUpperBound": 999999999, + "rolloverTransactionSetControlNumber": true, + "isTestInterchange": true, + "senderInternalIdentification": "AA", + "senderInternalSubIdentification": "AA", + "receiverInternalIdentification": "0", + "receiverInternalSubIdentification": "0" + }, + "acknowledgementSettings": { + "needTechnicalAcknowledgement": true, + "batchTechnicalAcknowledgements": true, + "needFunctionalAcknowledgement": true, + "batchFunctionalAcknowledgements": true, + "needLoopForValidMessages": true, + "sendSynchronousAcknowledgement": true, + "acknowledgementControlNumberPrefix": "CN", + "acknowledgementControlNumberSuffix": "NUM", + "acknowledgementControlNumberLowerBound": 1, + "acknowledgementControlNumberUpperBound": 999999999, + "rolloverAcknowledgementControlNumber": true + }, + "messageFilter": { + "messageFilterType": "Exclude" + }, + "processingSettings": { + "maskSecurityInfo": true, + "preserveInterchange": true, + "suspendInterchangeOnError": true, + "createEmptyXmlTagsForTrailingSeparators": true, + "useDotAsDecimalSeparator": true + }, + "schemaReferences": [] + }, + "senderBusinessIdentity": { + "qualifier": "AA", + "value": "AA" + }, + "receiverBusinessIdentity": { + "qualifier": "ZZ", + "value": "ZZ" + } + } + } + }, + "createdTime": "2017-03-06T22:00:53.8205121Z", + "changedTime": "2017-03-06T22:00:53.8212345Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts//agreements/", + "name": "", + "type": "Microsoft.Logic/integrationAccounts/agreements" + } + ] } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsListContentCallbackUrl.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsListContentCallbackUrl.json new file mode 100644 index 000000000000..58029a4619fa --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/AgreementsListContentCallbackUrl.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "agreementName": "testAgreement", + "listContentCallbackUrl": { + "notAfter": "2018-04-19T16:00:00Z", + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "value": "https://prod-00.westus.logic.azure.com:443/integrationAccounts/0fdabc3a76514ca48dede71c73d9fe97/agreements/testAgreement/contents/Value?api-version=2015-08-01-preview&sp=%2Fagreements%2FtestAgreement%2Fread&sv=1.0&sig=VK_mbQPTHTa3ezhsrI8IctckwjlL3GdJmroQH_baYj4", + "method": "GET", + "basePath": "https://prod-00.westus.logic.azure.com/integrationAccounts/0fdabc3a76514ca48dede71c73d9fe97/agreements/testAgreement/contents/Value", + "queries": { + "api-version": "2015-08-01-preview" + } + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesCreateOrUpdate.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesCreateOrUpdate.json index c89b48b4349b..d738be2cbc85 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesCreateOrUpdate.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesCreateOrUpdate.json @@ -1,66 +1,66 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "certificateName":"testCertificate", - "certificate":{ - "properties":{ - "key":{ - "keyVault":{ - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testResourceGroup/providers/microsoft.keyvault/vaults/" - }, - "keyName":"", - "keyVersion":"87d9764197604449b9b8eb7bd8710868" + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "certificateName": "testCertificate", + "certificate": { + "properties": { + "key": { + "keyVault": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testResourceGroup/providers/microsoft.keyvault/vaults/" + }, + "keyName": "", + "keyVersion": "87d9764197604449b9b8eb7bd8710868" + }, + "publicCertificate": "" + }, + "location": "brazilsouth" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "key": { + "keyVault": { + "name": "", + "id": "/subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/resourcegroups/flowrg/providers/microsoft.keyvault/vaults/", + "type": "Microsoft.KeyVault/vaults" }, - "publicCertificate":"" - }, - "location":"brazilsouth" + "keyName": "", + "keyVersion": "87d9764197604449b9b8eb7bd8710868" + }, + "publicCertificate": "", + "createdTime": "2017-03-06T20:42:21.0510202Z", + "changedTime": "2017-03-06T20:42:21.051317Z" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/certificates/testCertificate", + "name": "testCertificate", + "type": "Microsoft.Logic/integrationAccounts/certificates" } - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - "key":{ - "keyVault":{ - "name":"", - "id":"/subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/resourcegroups/flowrg/providers/microsoft.keyvault/vaults/", - "type":"Microsoft.KeyVault/vaults" - }, - "keyName":"", - "keyVersion":"87d9764197604449b9b8eb7bd8710868" - }, - "publicCertificate":"", - "createdTime":"2017-03-06T20:42:21.0510202Z", - "changedTime":"2017-03-06T20:42:21.051317Z" - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/certificates/testCertificate", - "name":"testCertificate", - "type":"Microsoft.Logic/integrationAccounts/certificates" - } - }, - "201":{ - "body":{ - "properties":{ - "key":{ - "keyVault":{ - "name":"", - "id":"/subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/resourcegroups/flowrg/providers/microsoft.keyvault/vaults/", - "type":"Microsoft.KeyVault/vaults" - }, - "keyName":"", - "keyVersion":"87d9764197604449b9b8eb7bd8710868" - }, - "publicCertificate":"", - "createdTime":"2017-03-06T20:42:21.0510202Z", - "changedTime":"2017-03-06T20:42:21.051317Z" + }, + "201": { + "body": { + "properties": { + "key": { + "keyVault": { + "name": "", + "id": "/subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/resourcegroups/flowrg/providers/microsoft.keyvault/vaults/", + "type": "Microsoft.KeyVault/vaults" }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/certificates/testCertificate", - "name":"testCertificate", - "type":"Microsoft.Logic/integrationAccounts/certificates" - } + "keyName": "", + "keyVersion": "87d9764197604449b9b8eb7bd8710868" + }, + "publicCertificate": "", + "createdTime": "2017-03-06T20:42:21.0510202Z", + "changedTime": "2017-03-06T20:42:21.051317Z" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/certificates/testCertificate", + "name": "testCertificate", + "type": "Microsoft.Logic/integrationAccounts/certificates" } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesDelete.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesDelete.json index 25df75fef12b..cb164901e351 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesDelete.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesDelete.json @@ -1,13 +1,13 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "certificateName":"testCertificate" - }, - "responses":{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "certificateName": "testCertificate" + }, + "responses": { "200": {}, "204": {} - } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesGet.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesGet.json index e286851d497f..b800699878ae 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesGet.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesGet.json @@ -1,32 +1,32 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "certificateName":"testCertificate" - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - "key":{ - "keyVault":{ - "name":"", - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testResourceGroup/providers/microsoft.keyvault/vaults/", - "type":"Microsoft.KeyVault/vaults" - }, - "keyName":"", - "keyVersion":"87d9764197604449b9b8eb7bd8710868" - }, - "publicCertificate":"", - "createdTime":"2017-03-06T20:42:21.0510202Z", - "changedTime":"2017-03-06T20:42:21.051317Z" + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "certificateName": "testCertificate" + }, + "responses": { + "200": { + "body": { + "properties": { + "key": { + "keyVault": { + "name": "", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testResourceGroup/providers/microsoft.keyvault/vaults/", + "type": "Microsoft.KeyVault/vaults" }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount9472/certificates/testCertificate", - "name":"testCertificate", - "type":"Microsoft.Logic/integrationAccounts/certificates" - } + "keyName": "", + "keyVersion": "87d9764197604449b9b8eb7bd8710868" + }, + "publicCertificate": "", + "createdTime": "2017-03-06T20:42:21.0510202Z", + "changedTime": "2017-03-06T20:42:21.051317Z" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount9472/certificates/testCertificate", + "name": "testCertificate", + "type": "Microsoft.Logic/integrationAccounts/certificates" } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesListByIntegrationAccounts.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesListByIntegrationAccounts.json index 20eecc613c19..decfda80d8cd 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesListByIntegrationAccounts.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/CertificatesListByIntegrationAccounts.json @@ -1,35 +1,35 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount" - }, - "responses":{ - "200":{ - "body":{ - "value":[ - { - "properties":{ - "key":{ - "keyVault":{ - "name":"AzureSdkTestKeyVault", - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testResourceGroup/providers/microsoft.keyvault/vaults/", - "type":"Microsoft.KeyVault/vaults" - }, - "keyName":"", - "keyVersion":"87d9764197604449b9b8eb7bd8710868" - }, - "publicCertificate":"", - "createdTime":"2017-03-06T20:33:09.7022471Z", - "changedTime":"2017-03-06T20:33:09.7032076Z" - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/certificates/", - "name":"", - "type":"Microsoft.Logic/integrationAccounts/certificates" - } - ] - } + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "key": { + "keyVault": { + "name": "AzureSdkTestKeyVault", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testResourceGroup/providers/microsoft.keyvault/vaults/", + "type": "Microsoft.KeyVault/vaults" + }, + "keyName": "", + "keyVersion": "87d9764197604449b9b8eb7bd8710868" + }, + "publicCertificate": "", + "createdTime": "2017-03-06T20:33:09.7022471Z", + "changedTime": "2017-03-06T20:33:09.7032076Z" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/certificates/", + "name": "", + "type": "Microsoft.Logic/integrationAccounts/certificates" + } + ] } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountBatchConfigurationsCreateOrUpdate.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountBatchConfigurationsCreateOrUpdate.json new file mode 100644 index 000000000000..d90909e8e1c7 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountBatchConfigurationsCreateOrUpdate.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "batchConfigurationName": "testBatchConfiguration", + "batchConfiguration": { + "properties": { + "properties": { + "batchGroupName": "DEFAULT", + "releaseCriteria": { + "recurrence": { + "frequency": "Minute", + "interval": 1, + "startTime": "2017-03-24T11:43:00", + "timeZone": "India Standard Time" + }, + "messageCount": 10, + "batchSize": 234567 + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "batchGroupName": "DEFAULT", + "releaseCriteria": { + "recurrence": { + "frequency": "Minute", + "interval": 1, + "startTime": "2017-03-24T11:43:00", + "timeZone": "India Standard Time" + }, + "messageCount": 10, + "batchSize": 234567 + }, + "createdTime": "2018-03-26T06:14:16.6518552Z", + "changedTime": "2018-03-26T06:14:16.7042301Z" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/batchConfigurations/testBatchConfiguration", + "name": "testBatchConfiguration", + "type": "Microsoft.Logic/integrationAccounts/batchConfigurations" + } + }, + "201": { + "body": { + "properties": { + "batchGroupName": "DEFAULT", + "releaseCriteria": { + "recurrence": { + "frequency": "Minute", + "interval": 1, + "startTime": "2017-03-24T11:43:00", + "timeZone": "India Standard Time" + }, + "messageCount": 10, + "batchSize": 234567 + }, + "createdTime": "2018-03-26T06:14:16.6518552Z", + "changedTime": "2018-03-26T06:14:16.7042301Z" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/batchConfigurations/testBatchConfiguration", + "name": "testBatchConfiguration", + "type": "Microsoft.Logic/integrationAccounts/batchConfigurations" + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountBatchConfigurationsDelete.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountBatchConfigurationsDelete.json new file mode 100644 index 000000000000..b6a0db5f1b0d --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountBatchConfigurationsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "batchConfigurationName": "testBatchConfiguration" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountBatchConfigurationsGet.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountBatchConfigurationsGet.json new file mode 100644 index 000000000000..569b275766f9 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountBatchConfigurationsGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "batchConfigurationName": "testBatchConfiguration" + }, + "responses": { + "200": { + "body": { + "properties": { + "batchGroupName": "DEFAULT", + "releaseCriteria": { + "recurrence": { + "frequency": "Minute", + "interval": 1, + "startTime": "2017-03-24T11:43:00", + "timeZone": "India Standard Time" + }, + "messageCount": 10, + "batchSize": 234567 + }, + "createdTime": "2018-03-26T06:14:16.6518552Z", + "changedTime": "2018-03-26T06:14:16.7042301Z" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/batchConfigurations/testBatchConfiguration", + "name": "testBatchConfiguration", + "type": "Microsoft.Logic/integrationAccounts/batchConfigurations" + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountBatchConfigurationsList.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountBatchConfigurationsList.json new file mode 100644 index 000000000000..a673e8adb3f1 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountBatchConfigurationsList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "batchGroupName": "DEFAULT", + "releaseCriteria": { + "recurrence": { + "frequency": "Minute", + "interval": 1, + "startTime": "2017-03-24T11:43:00", + "timeZone": "India Standard Time" + }, + "messageCount": 10, + "batchSize": 234567 + }, + "createdTime": "2018-03-26T06:14:16.6518552Z", + "changedTime": "2018-03-26T06:14:16.7042301Z" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/batchConfigurations/testBatchConfiguration", + "name": "testBatchConfiguration", + "type": "Microsoft.Logic/integrationAccounts/batchConfigurations" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesCreateOrUpdate.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesCreateOrUpdate.json new file mode 100644 index 000000000000..b9d4617037ad --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesCreateOrUpdate.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "assemblyArtifactName": "testAssembly", + "assemblyArtifact": { + "properties": { + "assemblyName": "System.IdentityModel.Tokens.Jwt", + "content": "Base64 encoded Assembly Content", + "metadata": {} + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "assemblyName": "System.IdentityModel.Tokens.Jwt", + "assemblyVersion": "0.0.0.0", + "contentLink": { + "uri": "", + "contentVersion": "\"0x8D45CE54B058881\"", + "contentSize": 3056, + "contentHash": { + "algorithm": "md5", + "value": "A2avz/M0ov2FPI3+Je8vDw==" + } + }, + "createdTime": "2017-02-24T18:45:23.4129778Z", + "changedTime": "2017-02-24T18:45:23.4137139Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/assemblies/testAssembly", + "name": "testAssembly", + "type": "Microsoft.Logic/integrationAccounts/assemblies" + } + }, + "201": { + "body": { + "properties": { + "assemblyName": "System.IdentityModel.Tokens.Jwt", + "assemblyVersion": "0.0.0.0", + "contentLink": { + "uri": "", + "contentVersion": "\"0x8D45CE54B058881\"", + "contentSize": 3056, + "contentHash": { + "algorithm": "md5", + "value": "A2avz/M0ov2FPI3+Je8vDw==" + } + }, + "createdTime": "2017-02-24T18:45:23.4129778Z", + "changedTime": "2017-02-24T18:45:23.4137139Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/assemblies/testAssembly", + "name": "testAssembly", + "type": "Microsoft.Logic/integrationAccounts/assemblies" + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesDelete.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesDelete.json new file mode 100644 index 000000000000..7724d4c45959 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "assemblyArtifactName": "testAssembly" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesGet.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesGet.json new file mode 100644 index 000000000000..c4ff6eeaf470 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "assemblyArtifactName": "testAssembly" + }, + "responses": { + "200": { + "body": { + "properties": { + "assemblyName": "System.IdentityModel.Tokens.Jwt", + "assemblyVersion": "0.0.0.0", + "contentLink": { + "uri": "", + "contentVersion": "\"0x8D45CE54B058881\"", + "contentSize": 3056, + "contentHash": { + "algorithm": "md5", + "value": "A2avz/M0ov2FPI3+Je8vDw==" + } + }, + "createdTime": "2017-02-24T18:45:23.4129778Z", + "changedTime": "2017-02-24T18:45:23.4137139Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/assemblies/testAssembly", + "name": "testAssembly", + "type": "Microsoft.Logic/integrationAccounts/assemblies" + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesList.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesList.json new file mode 100644 index 000000000000..364a8dc15c45 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "assemblyName": "System.IdentityModel.Tokens.Jwt", + "assemblyVersion": "0.0.0.0", + "contentLink": { + "uri": "", + "contentVersion": "\"0x8D45CE54B058881\"", + "contentSize": 3056, + "contentHash": { + "algorithm": "md5", + "value": "A2avz/M0ov2FPI3+Je8vDw==" + } + }, + "createdTime": "2017-02-24T18:45:23.4129778Z", + "changedTime": "2017-02-24T18:45:23.4137139Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/assemblies/testAssembly", + "name": "testAssembly", + "type": "Microsoft.Logic/integrationAccounts/assemblies" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesListContentCallbackUrl.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesListContentCallbackUrl.json new file mode 100644 index 000000000000..70fc6b810cf1 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsAssembliesListContentCallbackUrl.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "assemblyArtifactName": "testAssembly", + "listContentCallbackUrl": { + "notAfter": "2018-04-19T16:00:00Z", + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "value": "https://prod-00.westus.logic.azure.com:443/integrationAccounts/0fdabc3a76514ca48dede71c73d9fe97/assemblies/testAssembly/contents/Value?api-version=2015-08-01-preview&sp=%2Fassemblies%2FtestAssembly%2Fread&sv=1.0&sig=VK_mbQPTHTa3ezhsrI8IctckwjlL3GdJmroQH_baYj4", + "method": "GET", + "basePath": "https://prod-00.westus.logic.azure.com/integrationAccounts/0fdabc3a76514ca48dede71c73d9fe97/assemblies/testAssembly/contents/Value", + "queries": { + "api-version": "2015-08-01-preview" + } + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsCreateOrUpdate.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsCreateOrUpdate.json index 788c32d4c80c..3173331c60fd 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsCreateOrUpdate.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsCreateOrUpdate.json @@ -1,44 +1,41 @@ { - "parameters":{ - "api-version":"2016-06-01", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName":"testResourceGroup", - "integrationAccountName":"testIntegrationAccount", - "integrationAccount":{ - "properties":{ - }, - "sku":{ - "name":"Standard" - }, - "location":"westus" - } - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - }, - "sku":{ - "name":"Standard" - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount", - "name":"testIntegrationAccount", - "type":"Microsoft.Logic/integrationAccounts", - "location":"westus" - } + "parameters": { + "api-version": "2016-06-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testResourceGroup", + "integrationAccountName": "testIntegrationAccount", + "integrationAccount": { + "properties": {}, + "sku": { + "name": "Standard" }, - "201":{ - "body":{ - "properties":{ - }, - "sku":{ - "name":"Standard" - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount", - "name":"testIntegrationAccount", - "type":"Microsoft.Logic/integrationAccounts", - "location":"westus" - } + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": {}, + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount", + "name": "testIntegrationAccount", + "type": "Microsoft.Logic/integrationAccounts", + "location": "westus" + } + }, + "201": { + "body": { + "properties": {}, + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount", + "name": "testIntegrationAccount", + "type": "Microsoft.Logic/integrationAccounts", + "location": "westus" } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsDelete.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsDelete.json index 23d62e5ec9f6..c01d1c1a6024 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsDelete.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsDelete.json @@ -1,10 +1,10 @@ { - "parameters":{ - "api-version":"2016-06-01", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName":"testResourceGroup", - "integrationAccountName":"testIntegrationAccount" - }, + "parameters": { + "api-version": "2016-06-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testResourceGroup", + "integrationAccountName": "testIntegrationAccount" + }, "responses": { "200": {}, "204": {} diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsGet.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsGet.json index bcc28be1a845..529d8d3bb6f7 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsGet.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsGet.json @@ -1,24 +1,22 @@ { - "parameters":{ - "api-version":"2016-06-01", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName":"testResourceGroup", - "integrationAccountName":"testIntegrationAccount" - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - - }, - "sku":{ - "name":"Standard" - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount", - "name":"IntegrationAccount5892", - "type":"Microsoft.Logic/integrationAccounts", - "location":"westus" - } + "parameters": { + "api-version": "2016-06-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testResourceGroup", + "integrationAccountName": "testIntegrationAccount" + }, + "responses": { + "200": { + "body": { + "properties": {}, + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount", + "name": "IntegrationAccount5892", + "type": "Microsoft.Logic/integrationAccounts", + "location": "westus" } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsGetCallbackUrl.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsGetCallbackUrl.json index cfa6f83953c0..87253f73ddc9 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsGetCallbackUrl.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsGetCallbackUrl.json @@ -1,19 +1,19 @@ { - "parameters":{ - "api-version":"2016-06-01", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName":"testResourceGroup", - "integrationAccountName":"testIntegrationAccount", - "parameters":{ - "notAfter":"2017-03-05T08:00:00Z", - "keyType":"Primary" + "parameters": { + "api-version": "2016-06-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testResourceGroup", + "integrationAccountName": "testIntegrationAccount", + "parameters": { + "notAfter": "2017-03-05T08:00:00Z", + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "value": "https://testprod-westus.logic.azure.com:443/integrationAccounts/ce41a499a1e64d95b874f5f14b4bf3b6?api-version=2015-08-01-preview&se=2017-03-17T07%3A00%3A00.0000000Z&sp=%2F%2F%2A&sv=1.0" } - }, - "responses":{ - "200":{ - "body":{ - "value":"https://testprod-westus.logic.azure.com:443/integrationAccounts/ce41a499a1e64d95b874f5f14b4bf3b6?api-version=2015-08-01-preview&se=2017-03-17T07%3A00%3A00.0000000Z&sp=%2F%2F%2A&sv=1.0" - } - } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsListByResourceGroup.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsListByResourceGroup.json index 05c75cbab24d..6d6d97bec930 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsListByResourceGroup.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsListByResourceGroup.json @@ -1,27 +1,25 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345" - }, - "responses":{ - "200":{ - "body":{ - "value":[ - { - "properties":{ - - }, - "sku":{ - "name":"Standard" - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount9020", - "name":"IntegrationAccount9020", - "type":"Microsoft.Logic/integrationAccounts", - "location":"westus" - } - ] - } + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": {}, + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount9020", + "name": "IntegrationAccount9020", + "type": "Microsoft.Logic/integrationAccounts", + "location": "westus" + } + ] } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsListBySubscription.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsListBySubscription.json index 2910c8195d61..d67f9891614d 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsListBySubscription.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsListBySubscription.json @@ -6,18 +6,20 @@ "responses": { "200": { "body": { - "value":[ + "value": [ { - "properties":{}, - "sku":{ - "name":"Free" + "properties": {}, + "sku": { + "name": "Free" }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount", - "name":"daviburgIAFabrikam", - "type":"Microsoft.Logic/integrationAccounts", - "location":"northcentralus"} - ], - "nextLink":"https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Logic/integrationAccounts?api-version=2016-06-01&%24skiptoken="} + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount", + "name": "daviburgIAFabrikam", + "type": "Microsoft.Logic/integrationAccounts", + "location": "northcentralus" + } + ], + "nextLink": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Logic/integrationAccounts?api-version=2016-06-01&%24skiptoken=" + } } } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsListKeyVaultKeys.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsListKeyVaultKeys.json new file mode 100644 index 000000000000..0bcda03a220b --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsListKeyVaultKeys.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "listKeyVaultKeys": { + "keyVault": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.KeyVault/vaults/testKeyVault" + }, + "skipToken": "testSkipToken" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kid": "https://testKeyVault.vault.azure.net/keys/testkey", + "attributes": { + "enabled": true, + "created": 1498072075, + "updated": 1498072075 + } + } + ], + "skipToken": "testSkipToken" + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsLogTrackingEvent.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsLogTrackingEvent.json new file mode 100644 index 000000000000..0d1ab9b75b7c --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsLogTrackingEvent.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "logTrackingEvents": { + "sourceType": "Microsoft.Logic/workflows", + "source": { + "workflow": { + "systemId": "/locations/westus/scaleunits/test-01/workflows/bf501b3fceaa4a858a166aa64768ced5" + }, + "runInstance": { + "runId": "08586772141809790618914792486CU03" + }, + "operation": { + "operationName": "httpgetaction" + } + }, + "events": [ + { + "eventlevel": "Informational", + "eventTime": "2016-08-05T01:54:49.505567Z", + "recordType": "AS2Message", + "record": { + "agreementProperties": { + "senderPartnerName": "testPartner1", + "receiverPartnerName": "testPartner2", + "as2To": "testas2to", + "as2From": "testas2from", + "agreementName": "testAgreement" + }, + "messageProperties": { + "direction": "Receive", + "messageId": "12345", + "dispositionType": "received-success", + "fileName": "test", + "isMessageFailed": false, + "IsMessageEncrypted": false, + "IsMessageSigned": false, + "correlationMessageId": "Unique message identifier", + "isMessageCompressed": false, + "isNrrEnabled": true, + "isMdnExpected": true, + "mdnType": "Async" + } + }, + "error": { + "message": "Some error occurred", + "code": "NotFound" + } + } + ] + } + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsRegenerateAccessKey.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsRegenerateAccessKey.json new file mode 100644 index 000000000000..50f8d244e8af --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsRegenerateAccessKey.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "regenerateAccessKey": { + "KeyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "properties": {}, + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount", + "name": "testIntegrationAccount", + "type": "Microsoft.Logic/integrationAccounts", + "location": "westus" + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsUpdate.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsUpdate.json index 410a0686e14b..9b9f43561c7b 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsUpdate.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/IntegrationAccountsUpdate.json @@ -1,31 +1,29 @@ { - "parameters":{ - "api-version":"2016-06-01", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName":"testResourceGroup", - "integrationAccountName":"testIntegrationAccount", - "integrationAccount":{ - "properties":{ - }, - "sku":{ - "name":"Standard" - }, - "location":"westus" + "parameters": { + "api-version": "2016-06-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testResourceGroup", + "integrationAccountName": "testIntegrationAccount", + "integrationAccount": { + "properties": {}, + "sku": { + "name": "Standard" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": {}, + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount", + "name": "testIntegrationAccount", + "type": "Microsoft.Logic/integrationAccounts", + "location": "westus" } - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - }, - "sku":{ - "name":"Standard" - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount", - "name":"testIntegrationAccount", - "type":"Microsoft.Logic/integrationAccounts", - "location":"westus" - } - } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsCreateOrUpdate.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsCreateOrUpdate.json index 4a49a8311d43..dc257e403b4e 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsCreateOrUpdate.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsCreateOrUpdate.json @@ -1,64 +1,64 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "mapName":"testMap", - "map":{ - "properties":{ - "mapType":"Xslt", - "content":"\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n", - "contentType":"application/xml", - "metadata": {} - }, - "location":"westus" - } - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - "mapType":"Xslt", - "contentLink":{ - "uri":"", - "contentVersion":"\"0x8D464C057F22E5F\"", - "contentSize":3056, - "contentHash":{ - "algorithm":"md5", - "value":"A2avz/M0ov2FPI3+Je8vDw==" - } - }, - "createdTime":"2017-03-06T18:41:03.7366103Z", - "changedTime":"2017-03-06T18:41:04.4088605Z", - "metadata": {} - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups//providers/Microsoft.Logic/integrationAccounts//maps/testMap", - "name":"IntegrationAccountMap291", - "type":"Microsoft.Logic/integrationAccounts/maps" - } + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "mapName": "testMap", + "map": { + "properties": { + "mapType": "Xslt", + "content": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n", + "contentType": "application/xml", + "metadata": {} }, - "201":{ - "body":{ - "properties":{ - "mapType":"Xslt", - "contentLink":{ - "uri":"", - "contentVersion":"\"0x8D464C057F22E5F\"", - "contentSize":3056, - "contentHash":{ - "algorithm":"md5", - "value":"A2avz/M0ov2FPI3+Je8vDw==" - } - }, - "createdTime":"2017-03-06T18:41:03.7366103Z", - "changedTime":"2017-03-06T18:41:04.4088605Z", - "metadata":{} - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups//providers/Microsoft.Logic/integrationAccounts//maps/testMap", - "name":"IntegrationAccountMap291", - "type":"Microsoft.Logic/integrationAccounts/maps" - } + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mapType": "Xslt", + "contentLink": { + "uri": "", + "contentVersion": "\"0x8D464C057F22E5F\"", + "contentSize": 3056, + "contentHash": { + "algorithm": "md5", + "value": "A2avz/M0ov2FPI3+Je8vDw==" + } + }, + "createdTime": "2017-03-06T18:41:03.7366103Z", + "changedTime": "2017-03-06T18:41:04.4088605Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups//providers/Microsoft.Logic/integrationAccounts//maps/testMap", + "name": "IntegrationAccountMap291", + "type": "Microsoft.Logic/integrationAccounts/maps" + } + }, + "201": { + "body": { + "properties": { + "mapType": "Xslt", + "contentLink": { + "uri": "", + "contentVersion": "\"0x8D464C057F22E5F\"", + "contentSize": 3056, + "contentHash": { + "algorithm": "md5", + "value": "A2avz/M0ov2FPI3+Je8vDw==" + } + }, + "createdTime": "2017-03-06T18:41:03.7366103Z", + "changedTime": "2017-03-06T18:41:04.4088605Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups//providers/Microsoft.Logic/integrationAccounts//maps/testMap", + "name": "IntegrationAccountMap291", + "type": "Microsoft.Logic/integrationAccounts/maps" } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsDelete.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsDelete.json index f19759f13100..3478ce4d46c3 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsDelete.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsDelete.json @@ -1,13 +1,13 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "mapName":"testMap" - }, - "responses":{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "mapName": "testMap" + }, + "responses": { "200": {}, "204": {} - } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsGet.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsGet.json index 5a26cd328875..162fc3057cf1 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsGet.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsGet.json @@ -1,33 +1,33 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "mapName":"testMap" - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - "mapType":"Xslt", - "contentLink":{ - "uri":"", - "contentVersion":"\"0x8D45CE54B058881\"", - "contentSize":3056, - "contentHash":{ - "algorithm":"md5", - "value":"A2avz/M0ov2FPI3+Je8vDw==" - } - }, - "createdTime":"2017-02-24T18:45:23.4129778Z", - "changedTime":"2017-02-24T18:45:23.4137139Z", - "metadata": {} - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/maps/testMap", - "name":"testMap", - "type":"Microsoft.Logic/integrationAccounts/maps" - } + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "mapName": "testMap" + }, + "responses": { + "200": { + "body": { + "properties": { + "mapType": "Xslt", + "contentLink": { + "uri": "", + "contentVersion": "\"0x8D45CE54B058881\"", + "contentSize": 3056, + "contentHash": { + "algorithm": "md5", + "value": "A2avz/M0ov2FPI3+Je8vDw==" + } + }, + "createdTime": "2017-02-24T18:45:23.4129778Z", + "changedTime": "2017-02-24T18:45:23.4137139Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/maps/testMap", + "name": "testMap", + "type": "Microsoft.Logic/integrationAccounts/maps" } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsListByIntegrationAccounts.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsListByIntegrationAccounts.json index 1c62ad70622c..3efe1781081c 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsListByIntegrationAccounts.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsListByIntegrationAccounts.json @@ -1,36 +1,36 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount" - }, - "responses":{ - "200":{ - "body":{ - "value":[ - { - "properties":{ - "mapType":"Xslt", - "contentLink":{ - "uri":"", - "contentVersion":"\"0x8D45CE3C6D23B4B\"", - "contentSize":3056, - "contentHash":{ - "algorithm":"md5", - "value":"A2avz/M0ov2FPI3+Je8vDw==" - } - }, - "createdTime":"2017-02-24T18:34:32.3902373Z", - "changedTime":"2017-02-24T18:34:32.390576Z", - "metadata": {} - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/maps/IntegrationAccountMap9943", - "name":"IntegrationAccountMap9943", - "type":"Microsoft.Logic/integrationAccounts/maps" - } - ] - } + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "mapType": "Xslt", + "contentLink": { + "uri": "", + "contentVersion": "\"0x8D45CE3C6D23B4B\"", + "contentSize": 3056, + "contentHash": { + "algorithm": "md5", + "value": "A2avz/M0ov2FPI3+Je8vDw==" + } + }, + "createdTime": "2017-02-24T18:34:32.3902373Z", + "changedTime": "2017-02-24T18:34:32.390576Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/maps/IntegrationAccountMap9943", + "name": "IntegrationAccountMap9943", + "type": "Microsoft.Logic/integrationAccounts/maps" + } + ] } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsListContentCallbackUrl.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsListContentCallbackUrl.json new file mode 100644 index 000000000000..1bc62ce40c21 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/MapsListContentCallbackUrl.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "mapName": "testMap", + "listContentCallbackUrl": { + "notAfter": "2018-04-19T16:00:00Z", + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "value": "https://prod-00.westus.logic.azure.com:443/integrationAccounts/0fdabc3a76514ca48dede71c73d9fe97/maps/testMap/contents/Value?api-version=2015-08-01-preview&sp=%2Fmaps%2Ftestmap%2Fread&sv=1.0&sig=VK_mbQPTHTa3ezhsrI8IctckwjlL3GdJmroQH_baYj4", + "method": "GET", + "basePath": "https://prod-00.brazilus.logic.azure.com/integrationAccounts/0fdabc3a76514ca48dede71c73d9fe97/maps/testmap/contents/Value", + "queries": { + "api-version": "2015-08-01-preview" + } + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersCreateOrUpdate.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersCreateOrUpdate.json index 0b984f39104d..f7cd4009b41e 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersCreateOrUpdate.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersCreateOrUpdate.json @@ -1,76 +1,75 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "partnerName":"testPartner", - "partner":{ - "properties":{ - "partnerType":"B2B", - "metadata":{}, - "content":{ - "b2b":{ - "businessIdentities":[ - { - "qualifier":"AA", - "value":"ZZ" - } - ] - } + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "partnerName": "testPartner", + "partner": { + "properties": { + "partnerType": "B2B", + "metadata": {}, + "content": { + "b2b": { + "businessIdentities": [ + { + "qualifier": "AA", + "value": "ZZ" + } + ] + } + } + }, + "location": "westus", + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "properties": { + "partnerType": "B2B", + "content": { + "b2b": { + "businessIdentities": [ + { + "qualifier": "AA", + "value": "ZZ" + } + ] } - }, - "location":"westus", - "tags":{ - } + }, + "createdTime": "2017-03-06T20:06:23.5895246Z", + "changedTime": "2017-03-06T20:06:23.5904806Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/flowrg/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/partners/testPartner", + "name": "testPartner", + "type": "Microsoft.Logic/integrationAccounts/partners" } - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - "partnerType":"B2B", - "content":{ - "b2b":{ - "businessIdentities":[ - { - "qualifier":"AA", - "value":"ZZ" - } - ] - } - }, - "createdTime":"2017-03-06T20:06:23.5895246Z", - "changedTime":"2017-03-06T20:06:23.5904806Z", - "metadata":{} - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/flowrg/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/partners/testPartner", - "name":"testPartner", - "type":"Microsoft.Logic/integrationAccounts/partners" - } - }, - "201":{ - "body":{ - "properties":{ - "partnerType":"B2B", - "content":{ - "b2b":{ - "businessIdentities":[ - { - "qualifier":"AA", - "value":"ZZ" - } - ] - } - }, - "createdTime":"2017-03-06T20:06:23.5895246Z", - "changedTime":"2017-03-06T20:06:23.5904806Z", - "metadata":{} - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/flowrg/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/partners/testPartner", - "name":"testPartner", - "type":"Microsoft.Logic/integrationAccounts/partners" - } + }, + "201": { + "body": { + "properties": { + "partnerType": "B2B", + "content": { + "b2b": { + "businessIdentities": [ + { + "qualifier": "AA", + "value": "ZZ" + } + ] + } + }, + "createdTime": "2017-03-06T20:06:23.5895246Z", + "changedTime": "2017-03-06T20:06:23.5904806Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/flowrg/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/partners/testPartner", + "name": "testPartner", + "type": "Microsoft.Logic/integrationAccounts/partners" } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersDelete.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersDelete.json index d89a65054c86..3da0e53fda27 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersDelete.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersDelete.json @@ -1,13 +1,13 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "partnerName":"testPartner" - }, - "responses":{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "partnerName": "testPartner" + }, + "responses": { "200": {}, "204": {} - } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersGet.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersGet.json index 0c8bf5cb9d94..84124ab698d3 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersGet.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersGet.json @@ -1,34 +1,34 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "partnerName":"testPartner" - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - "partnerType":"B2B", - "content":{ - "b2b":{ - "businessIdentities":[ - { - "qualifier":"AA", - "value":"ZZ" - } - ] - } - }, - "createdTime":"2017-03-06T20:01:24.0517156Z", - "changedTime":"2017-03-06T20:01:24.0525141Z", - "metadata": {} - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/partners/testPartner", - "name":"testIntegrationAccount", - "type":"Microsoft.Logic/integrationAccounts/partners" - } + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "partnerName": "testPartner" + }, + "responses": { + "200": { + "body": { + "properties": { + "partnerType": "B2B", + "content": { + "b2b": { + "businessIdentities": [ + { + "qualifier": "AA", + "value": "ZZ" + } + ] + } + }, + "createdTime": "2017-03-06T20:01:24.0517156Z", + "changedTime": "2017-03-06T20:01:24.0525141Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/partners/testPartner", + "name": "testIntegrationAccount", + "type": "Microsoft.Logic/integrationAccounts/partners" } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersListByIntegrationAccounts.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersListByIntegrationAccounts.json index 30764697328a..d1a10bbfb0d2 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersListByIntegrationAccounts.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersListByIntegrationAccounts.json @@ -1,37 +1,37 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount" - }, - "responses":{ - "200":{ - "body":{ - "value":[ - { - "properties":{ - "partnerType":"B2B", - "content":{ - "b2b":{ - "businessIdentities":[ - { - "qualifier":"AA", - "value":"ZZ" - } - ] - } - }, - "createdTime":"2017-03-06T19:42:59.197919Z", - "changedTime":"2017-03-06T19:42:59.1987212Z", - "metadata":{} - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount2431/partners/testIntegrationAccount", - "name":"IntegrationAccountPartner947", - "type":"Microsoft.Logic/integrationAccounts/partners" - } - ] - } + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "partnerType": "B2B", + "content": { + "b2b": { + "businessIdentities": [ + { + "qualifier": "AA", + "value": "ZZ" + } + ] + } + }, + "createdTime": "2017-03-06T19:42:59.197919Z", + "changedTime": "2017-03-06T19:42:59.1987212Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount2431/partners/testIntegrationAccount", + "name": "IntegrationAccountPartner947", + "type": "Microsoft.Logic/integrationAccounts/partners" + } + ] } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersListContentCallbackUrl.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersListContentCallbackUrl.json new file mode 100644 index 000000000000..c283a3c523c3 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/PartnersListContentCallbackUrl.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "partnerName": "testPartner", + "listContentCallbackUrl": { + "notAfter": "2018-04-19T16:00:00Z", + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "value": "https://prod-00.westus.logic.azure.com:443/integrationAccounts/0fdabc3a76514ca48dede71c73d9fe97/partners/testPartner/contents/Value?api-version=2015-08-01-preview&sp=%2Fpartners%2FtestPartner%2Fread&sv=1.0&sig=VK_mbQPTHTa3ezhsrI8IctckwjlL3GdJmroQH_baYj4", + "method": "GET", + "basePath": "https://prod-00.westus.logic.azure.com/integrationAccounts/0fdabc3a76514ca48dede71c73d9fe97/partners/testPartner/contents/Value", + "queries": { + "api-version": "2015-08-01-preview" + } + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasCreateOrUpdate.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasCreateOrUpdate.json index 05cb8020b0a7..2b69a68fd9f6 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasCreateOrUpdate.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasCreateOrUpdate.json @@ -1,71 +1,71 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "schemaName":"testSchema", - "schema":{ - "properties":{ - "schemaType":"Xml", - "metadata":{}, - "content": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n", - "contentType":"application/xml" - }, - "location":"westus", - "tags":{ - "integrationAccountSchemaName":"IntegrationAccountSchema8120" - } - } - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - "schemaType":"Xml", - "targetNamespace":"http://Inbound_EDI.OrderFile", - "documentName":"OrderFile", - "contentLink":{ - "uri":"", - "contentVersion":"\"0x8D45C56FEDFCB45\"", - "contentSize":7901, - "contentHash":{ - "algorithm":"md5", - "value":"" - } - }, - "createdTime":"2017-02-24T01:46:48.0837583Z", - "changedTime":"2017-02-24T01:46:48.0847046Z", - "metadata":{} - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/schemas/testSchema", - "name":"IntegrationAccountSchema5349", - "type":"Microsoft.Logic/integrationAccounts/schemas" - } + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "schemaName": "testSchema", + "schema": { + "properties": { + "schemaType": "Xml", + "metadata": {}, + "content": "\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n", + "contentType": "application/xml" }, - "201":{ - "body":{ - "properties":{ - "schemaType":"Xml", - "targetNamespace":"http://Inbound_EDI.OrderFile", - "documentName":"OrderFile", - "contentLink":{ - "uri":"", - "contentVersion":"\"0x8D45C56FEDFCB45\"", - "contentSize":7901, - "contentHash":{ - "algorithm":"md5", - "value":"" - } - }, - "createdTime":"2017-02-24T01:46:48.0837583Z", - "changedTime":"2017-02-24T01:46:48.0847046Z", - "metadata":{} - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/schemas/testSchema", - "name":"IntegrationAccountSchema5349", - "type":"Microsoft.Logic/integrationAccounts/schemas" - } + "location": "westus", + "tags": { + "integrationAccountSchemaName": "IntegrationAccountSchema8120" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "schemaType": "Xml", + "targetNamespace": "http://Inbound_EDI.OrderFile", + "documentName": "OrderFile", + "contentLink": { + "uri": "", + "contentVersion": "\"0x8D45C56FEDFCB45\"", + "contentSize": 7901, + "contentHash": { + "algorithm": "md5", + "value": "" + } + }, + "createdTime": "2017-02-24T01:46:48.0837583Z", + "changedTime": "2017-02-24T01:46:48.0847046Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/schemas/testSchema", + "name": "IntegrationAccountSchema5349", + "type": "Microsoft.Logic/integrationAccounts/schemas" + } + }, + "201": { + "body": { + "properties": { + "schemaType": "Xml", + "targetNamespace": "http://Inbound_EDI.OrderFile", + "documentName": "OrderFile", + "contentLink": { + "uri": "", + "contentVersion": "\"0x8D45C56FEDFCB45\"", + "contentSize": 7901, + "contentHash": { + "algorithm": "md5", + "value": "" + } + }, + "createdTime": "2017-02-24T01:46:48.0837583Z", + "changedTime": "2017-02-24T01:46:48.0847046Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/schemas/testSchema", + "name": "IntegrationAccountSchema5349", + "type": "Microsoft.Logic/integrationAccounts/schemas" } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasDelete.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasDelete.json index cb39c692597d..a5849bf97bb9 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasDelete.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasDelete.json @@ -1,13 +1,13 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "schemaName":"testSchema" - }, - "responses":{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "schemaName": "testSchema" + }, + "responses": { "200": {}, "204": {} - } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasGet.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasGet.json index 56703ec9723c..759cdbba6320 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasGet.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasGet.json @@ -1,35 +1,35 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "integrationAccountName":"testIntegrationAccount", - "schemaName":"testSchema" - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - "schemaType":"Xml", - "targetNamespace":"http://Inbound_EDI.OrderFile", - "documentName":"OrderFile", - "contentLink":{ - "uri":"", - "contentVersion":"\"0x8D45C56FEDFCB45\"", - "contentSize":7901, - "contentHash":{ - "algorithm":"md5", - "value":"" - } - }, - "createdTime":"2017-02-24T01:46:48.0837583Z", - "changedTime":"2017-02-24T01:46:48.0847046Z", - "metadata": {} - }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/schemas/testSchema", - "name":"IntegrationAccountSchema5349", - "type":"Microsoft.Logic/integrationAccounts/schemas" - } + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "schemaName": "testSchema" + }, + "responses": { + "200": { + "body": { + "properties": { + "schemaType": "Xml", + "targetNamespace": "http://Inbound_EDI.OrderFile", + "documentName": "OrderFile", + "contentLink": { + "uri": "", + "contentVersion": "\"0x8D45C56FEDFCB45\"", + "contentSize": 7901, + "contentHash": { + "algorithm": "md5", + "value": "" + } + }, + "createdTime": "2017-02-24T01:46:48.0837583Z", + "changedTime": "2017-02-24T01:46:48.0847046Z", + "metadata": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts/testIntegrationAccount/schemas/testSchema", + "name": "IntegrationAccountSchema5349", + "type": "Microsoft.Logic/integrationAccounts/schemas" } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasListByIntegrationAccounts.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasListByIntegrationAccounts.json index 0da876b778e8..a7fb699daef7 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasListByIntegrationAccounts.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasListByIntegrationAccounts.json @@ -1,38 +1,38 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"", - "integrationAccountName":"" - }, - "responses":{ - "200":{ - "body":{ - "value":[ - { - "properties":{ - "schemaType":"Xml", - "targetNamespace":"http://Inbound_EDI.OrderFile", - "documentName":"OrderFile", - "contentLink":{ - "uri":"", - "contentVersion":"\"0x8D45C553EECEB76\"", - "contentSize":7901, - "contentHash":{ - "algorithm":"md5", - "value":"" - } - }, - "createdTime":"2017-02-24T01:34:16.7088958Z", - "changedTime":"2017-02-24T01:34:16.7098626Z", - "metadata": {} - }, - "id":"/subscriptions//resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts//schemas/IntegrationAccountSchema3944", - "name":"IntegrationAccountSchema3944", - "type":"Microsoft.Logic/integrationAccounts/schemas" - } - ] - } + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "", + "integrationAccountName": "" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "schemaType": "Xml", + "targetNamespace": "http://Inbound_EDI.OrderFile", + "documentName": "OrderFile", + "contentLink": { + "uri": "", + "contentVersion": "\"0x8D45C553EECEB76\"", + "contentSize": 7901, + "contentHash": { + "algorithm": "md5", + "value": "" + } + }, + "createdTime": "2017-02-24T01:34:16.7088958Z", + "changedTime": "2017-02-24T01:34:16.7098626Z", + "metadata": {} + }, + "id": "/subscriptions//resourceGroups/testResourceGroup/providers/Microsoft.Logic/integrationAccounts//schemas/IntegrationAccountSchema3944", + "name": "IntegrationAccountSchema3944", + "type": "Microsoft.Logic/integrationAccounts/schemas" + } + ] } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasListContentCallbackUrl.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasListContentCallbackUrl.json new file mode 100644 index 000000000000..164f81c819df --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SchemasListContentCallbackUrl.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "integrationAccountName": "testIntegrationAccount", + "schemaName": "testSchema", + "listContentCallbackUrl": { + "notAfter": "2018-04-19T16:00:00Z", + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "value": "https://prod-00.westus.logic.azure.com:443/integrationAccounts/0fdabc3a76514ca48dede71c73d9fe97/schemas/testSchema/contents/Value?api-version=2015-08-01-preview&sp=%2Fschemas%2FtestSchema%2Fread&sv=1.0&sig=VK_mbQPTHTa3ezhsrI8IctckwjlL3GdJmroQH_baYj4", + "method": "GET", + "basePath": "https://prod-00.westus.logic.azure.com/integrationAccounts/0fdabc3a76514ca48dede71c73d9fe97/schemas/testSchema/contents/Value", + "queries": { + "api-version": "2015-08-01-preview" + } + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsCreateOrUpdate.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsCreateOrUpdate.json index 3288a68d8a4a..2c0e08993096 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsCreateOrUpdate.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsCreateOrUpdate.json @@ -9,11 +9,11 @@ "session": { "properties": { "content": { - "controlNumber":"1234", - "controlNumberChangedTime":"2017-02-21T22:30:11.9923759Z" + "controlNumber": "1234", + "controlNumberChangedTime": "2017-02-21T22:30:11.9923759Z" } - } -} + } + } }, "responses": { "200": { @@ -27,16 +27,16 @@ }, "body": { "properties": { - "createdTime":"2017-02-21T20:41:35.9789189Z", - "changedTime":"2017-02-21T20:41:35.9796534Z", + "createdTime": "2017-02-21T20:41:35.9789189Z", + "changedTime": "2017-02-21T20:41:35.9796534Z", "content": { - "controlNumber":"1234", - "controlNumberChangedTime":"2017-02-21T22:30:11.9923759Z" + "controlNumber": "1234", + "controlNumberChangedTime": "2017-02-21T22:30:11.9923759Z" } }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Logic/integrationAccounts/testia123/sessions/testsession123-ICN", - "name":"testsession123-ICN", - "type":"Microsoft.Logic/integrationAccounts/sessions" + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Logic/integrationAccounts/testia123/sessions/testsession123-ICN", + "name": "testsession123-ICN", + "type": "Microsoft.Logic/integrationAccounts/sessions" } }, "201": { @@ -49,17 +49,17 @@ }, "body": { "properties": { - "createdTime":"2017-02-21T20:41:35.9789189Z", - "changedTime":"2017-02-21T20:41:35.9796534Z", + "createdTime": "2017-02-21T20:41:35.9789189Z", + "changedTime": "2017-02-21T20:41:35.9796534Z", "content": { - "controlNumber":"1234", - "controlNumberChangedTime":"2017-02-21T22:30:11.9923759Z" + "controlNumber": "1234", + "controlNumberChangedTime": "2017-02-21T22:30:11.9923759Z" } }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Logic/integrationAccounts/testia123/sessions/testsession123-ICN", - "name":"testsession123-ICN", - "type":"Microsoft.Logic/integrationAccounts/sessions" + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Logic/integrationAccounts/testia123/sessions/testsession123-ICN", + "name": "testsession123-ICN", + "type": "Microsoft.Logic/integrationAccounts/sessions" } } } -} +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsDelete.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsDelete.json index c4dbe1f9c433..8b680068bb7c 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsDelete.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsDelete.json @@ -27,4 +27,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsGet.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsGet.json index b6f691cee0d6..8f51e78c451c 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsGet.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsGet.json @@ -19,17 +19,17 @@ }, "body": { "properties": { - "createdTime":"2017-02-21T20:41:35.9789189Z", - "changedTime":"2017-02-21T20:41:35.9796534Z", + "createdTime": "2017-02-21T20:41:35.9789189Z", + "changedTime": "2017-02-21T20:41:35.9796534Z", "content": { - "controlNumber":"1234", - "controlNumberChangedTime":"2017-02-21T22:30:11.9923759Z" + "controlNumber": "1234", + "controlNumberChangedTime": "2017-02-21T22:30:11.9923759Z" } }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Logic/integrationAccounts/testia123/sessions/testsession123-ICN", - "name":"testsession123-ICN", - "type":"Microsoft.Logic/integrationAccounts/sessions" + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Logic/integrationAccounts/testia123/sessions/testsession123-ICN", + "name": "testsession123-ICN", + "type": "Microsoft.Logic/integrationAccounts/sessions" } } } -} +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsListByIntegrationAccounts.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsListByIntegrationAccounts.json index ab38f6078b00..ebf589f11796 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsListByIntegrationAccounts.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/SessionsListByIntegrationAccounts.json @@ -20,37 +20,37 @@ "value": [ { "properties": { - "createdTime":"2017-02-21T23:06:24.0152955Z", - "changedTime":"2017-02-21T23:06:24.0158575Z", + "createdTime": "2017-02-21T23:06:24.0152955Z", + "changedTime": "2017-02-21T23:06:24.0158575Z", "content": { - "controlNumber":"1234", - "controlNumberChangedTime":"2017-02-21T22:30:11.9923759Z" + "controlNumber": "1234", + "controlNumberChangedTime": "2017-02-21T22:30:11.9923759Z" } }, - "id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Logic/integrationAccounts/testia123/sessions/IntegrationAccountSession1662", - "name":"IntegrationAccountSession1662", - "type":"Microsoft.Logic/integrationAccounts/sessions" + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Logic/integrationAccounts/testia123/sessions/IntegrationAccountSession1662", + "name": "IntegrationAccountSession1662", + "type": "Microsoft.Logic/integrationAccounts/sessions" }, { "properties": { "createdTime": "2017-02-21T23:06:23.7535558Z", "changedTime": "2017-02-21T23:06:23.7540113Z", "content": { - "controlNumber":"1234", - "controlNumberChangedTime":"2017-02-21T22:30:11.9923759Z" + "controlNumber": "1234", + "controlNumberChangedTime": "2017-02-21T22:30:11.9923759Z" } }, "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Logic/integrationAccounts/testia123/sessions/IntegrationAccountSession6808", - "name":"IntegrationAccountSession6808", - "type":"Microsoft.Logic/integrationAccounts/sessions" + "name": "IntegrationAccountSession6808", + "type": "Microsoft.Logic/integrationAccounts/sessions" }, { "properties": { - "createdTime":"2017-02-21T23:06:23.8367926Z", - "changedTime":"2017-02-21T23:06:23.8370161Z", + "createdTime": "2017-02-21T23:06:23.8367926Z", + "changedTime": "2017-02-21T23:06:23.8370161Z", "content": { - "controlNumber":"1234", - "controlNumberChangedTime":"2017-02-21T22:30:11.9923759Z" + "controlNumber": "1234", + "controlNumberChangedTime": "2017-02-21T22:30:11.9923759Z" } }, "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Logic/integrationAccounts/testia123/sessions/IntegrationAccountSession7315", @@ -61,4 +61,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRepetitionsGet.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRepetitionsGet.json new file mode 100644 index 000000000000..c39357e542cc --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRepetitionsGet.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "testFlow", + "runName": "08586776228332053161046300351", + "actionName": "testAction", + "repetitionName": "000001" + }, + "responses": { + "200": { + "body": { + "properties": { + "repetitionIndexes": [ + { + "scopeName": "For_each", + "itemIndex": 1 + } + ], + "trackingId": "f84f23eb-b331-4772-9f39-cc307fa83bc3", + "inputsLink": { + "uri": "https://prod-08.northcentralus.logic.azure.com:443/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000001/contents/ActionInputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000001%2Fcontents%2FActionInputs%2Fread&sv=1.0&sig=dLmnt50joimEMK4k9rR6njHQh94iSFJ9rrDxFbkEg5M", + "contentVersion": "OA3i83YHGYVch+N8BQJIRQ==", + "contentSize": 6, + "contentHash": { + "algorithm": "md5", + "value": "OA3i83YHGYVch+N8BQJIRQ==" + } + }, + "outputsLink": { + "uri": "https://prod-08.northcentralus.logic.azure.com:443/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000001/contents/ActionOutputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000001%2Fcontents%2FActionOutputs%2Fread&sv=1.0&sig=B3-X5sqIAv1Lb31GOD34ZgIRUXGuiM2QllWiNwXFYAw", + "contentVersion": "OA3i83YHGYVch+N8BQJIRQ==", + "contentSize": 6, + "contentHash": { + "algorithm": "md5", + "value": "OA3i83YHGYVch+N8BQJIRQ==" + } + }, + "startTime": "2018-04-18T17:05:57.0929911Z", + "endTime": "2018-04-18T17:05:57.1015421Z", + "correlation": { + "actionTrackingId": "f84f23eb-b331-4772-9f39-cc307fa83bc3", + "clientTrackingId": "08586775357427610445444523191" + }, + "status": "Succeeded", + "code": "OK" + }, + "id": "api/management/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testFlow/runs/08586776228332053161046300351/actions/testAction/repetitions/000001", + "name": "000001", + "type": "Microsoft.Logic/workflows/runs/actions/repetitions" + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRepetitionsList.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRepetitionsList.json new file mode 100644 index 000000000000..7501fd2beeb7 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRepetitionsList.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "testFlow", + "runName": "08586776228332053161046300351", + "actionName": "testAction" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "repetitionIndexes": [ + { + "scopeName": "For_each", + "itemIndex": 0 + } + ], + "trackingId": "0d8152bb-e198-44a9-bde8-5138eea16dd4", + "inputsLink": { + "uri": "https://prod-08.northcentralus.logic.azure.com:443/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000000/contents/ActionInputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000000%2Fcontents%2FActionInputs%2Fread&sv=1.0&sig=vw4BDdYp4Ap5RXdM7tY_wl9C38DeAHfnixLBEOpideA", + "contentVersion": "8q1zMKS5ZyHBrPF+qF1xXw==", + "contentSize": 8, + "contentHash": { + "algorithm": "md5", + "value": "8q1zMKS5ZyHBrPF+qF1xXw==" + } + }, + "outputsLink": { + "uri": "https://prod-08.northcentralus.logic.azure.com:443/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000000/contents/ActionOutputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000000%2Fcontents%2FActionOutputs%2Fread&sv=1.0&sig=y8Wq7jbu85tmlMo_1zpRyqNJuoCaQCFQtZ3bgSovLY0", + "contentVersion": "8q1zMKS5ZyHBrPF+qF1xXw==", + "contentSize": 8, + "contentHash": { + "algorithm": "md5", + "value": "8q1zMKS5ZyHBrPF+qF1xXw==" + } + }, + "startTime": "2018-04-18T17:05:57.217991Z", + "endTime": "2018-04-18T17:05:57.2264835Z", + "correlation": { + "actionTrackingId": "0d8152bb-e198-44a9-bde8-5138eea16dd4", + "clientTrackingId": "08586775357427610445444523191" + }, + "status": "Succeeded", + "code": "OK" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testFlow/runs/08586776228332053161046300351/actions/testAction/repetitions/000000", + "name": "000000", + "type": "Microsoft.Logic/workflows/runs/actions/repetitions" + }, + { + "properties": { + "repetitionIndexes": [ + { + "scopeName": "For_each", + "itemIndex": 1 + } + ], + "trackingId": "f84f23eb-b331-4772-9f39-cc307fa83bc3", + "inputsLink": { + "uri": "https://prod-08.northcentralus.logic.azure.com:443/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000001/contents/ActionInputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000001%2Fcontents%2FActionInputs%2Fread&sv=1.0&sig=dLmnt50joimEMK4k9rR6njHQh94iSFJ9rrDxFbkEg5M", + "contentVersion": "OA3i83YHGYVch+N8BQJIRQ==", + "contentSize": 6, + "contentHash": { + "algorithm": "md5", + "value": "OA3i83YHGYVch+N8BQJIRQ==" + } + }, + "outputsLink": { + "uri": "https://prod-08.northcentralus.logic.azure.com:443/workflows/2dfde2fce2584c49bea17ef0b04c95f4/runs/08586776228332053161046300351/actions/testAction/repetitions/000001/contents/ActionOutputs?api-version=2016-10-01&se=2018-04-18T21%3A00%3A00.0000000Z&sp=%2Fruns%2F08586776228332053161046300351%2Factions%2FtestAction%2Frepetitions%2F000001%2Fcontents%2FActionOutputs%2Fread&sv=1.0&sig=B3-X5sqIAv1Lb31GOD34ZgIRUXGuiM2QllWiNwXFYAw", + "contentVersion": "OA3i83YHGYVch+N8BQJIRQ==", + "contentSize": 6, + "contentHash": { + "algorithm": "md5", + "value": "OA3i83YHGYVch+N8BQJIRQ==" + } + }, + "startTime": "2018-04-18T17:05:57.0929911Z", + "endTime": "2018-04-18T17:05:57.1015421Z", + "correlation": { + "actionTrackingId": "f84f23eb-b331-4772-9f39-cc307fa83bc3", + "clientTrackingId": "08586775357427610445444523191" + }, + "status": "Succeeded", + "code": "OK" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testFlow/runs/08586776228332053161046300351/actions/testAction/repetitions/000001", + "name": "000001", + "type": "Microsoft.Logic/workflows/runs/actions/repetitions" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionScopeRepetitionsGet.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionScopeRepetitionsGet.json new file mode 100644 index 000000000000..abb051738459 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionScopeRepetitionsGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "testFlow", + "runName": "08586776228332053161046300351", + "actionName": "for_each", + "repetitionName": "000000" + }, + "responses": { + "200": { + "body": { + "properties": { + "repetitionIndexes": [ + { + "scopeName": "For_each", + "itemIndex": 0 + } + ], + "startTime": "2018-04-18T17:05:57.209588Z", + "endTime": "2018-04-18T17:05:57.6240967Z", + "correlation": { + "actionTrackingId": "5c0e7c24-4891-44e8-b631-8084c5531dd5", + "clientTrackingId": "08586775357427610445444523191" + }, + "status": "Succeeded", + "code": "NotSpecified" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testFlow/runs/08586776228332053161046300351/actions/for_each/scopeRepetitions/000000", + "name": "000000", + "type": "Microsoft.Logic/workflows/runs/actions/scopeRepetitions" + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionScopeRepetitionsList.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionScopeRepetitionsList.json new file mode 100644 index 000000000000..d6f94735aa90 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionScopeRepetitionsList.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "testFlow", + "runName": "08586776228332053161046300351", + "actionName": "for_each" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "repetitionIndexes": [ + { + "scopeName": "For_each", + "itemIndex": 0 + } + ], + "startTime": "2018-04-18T17:05:57.209588Z", + "endTime": "2018-04-18T17:05:57.6240967Z", + "correlation": { + "actionTrackingId": "5c0e7c24-4891-44e8-b631-8084c5531dd5", + "clientTrackingId": "08586775357427610445444523191" + }, + "status": "Succeeded", + "code": "NotSpecified" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testFlow/runs/08586776228332053161046300351/actions/for_each/scopeRepetitions/000000", + "name": "000000", + "type": "Microsoft.Logic/workflows/runs/actions/scopeRepetitions" + }, + { + "properties": { + "repetitionIndexes": [ + { + "scopeName": "For_each", + "itemIndex": 1 + } + ], + "startTime": "2018-04-18T17:05:57.0686808Z", + "endTime": "2018-04-18T17:05:57.2272796Z", + "correlation": { + "actionTrackingId": "1682d0bd-7189-4478-b333-fe364a80bd69", + "clientTrackingId": "08586775357427610445444523191" + }, + "status": "Succeeded", + "code": "NotSpecified" + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testFlow/runs/08586776228332053161046300351/actions/for_each/scopeRepetitions/000001", + "name": "000001", + "type": "Microsoft.Logic/workflows/runs/actions/scopeRepetitions" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionsListExpressionTraces.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionsListExpressionTraces.json new file mode 100644 index 000000000000..347d8d3beeb9 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionsListExpressionTraces.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "testFlow", + "runName": "08586776228332053161046300351", + "actionName": "testAction", + "repetitionName": "000001" + }, + "responses": { + "200": { + "body": { + "inputs": [ + { + "path": "", + "text": "add(4, 4)", + "value": 8 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionsListExpressionTracesRepetition.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionsListExpressionTracesRepetition.json new file mode 100644 index 000000000000..f3bf713296fe --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionsListExpressionTracesRepetition.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "testFlow", + "runName": "08586776228332053161046300351", + "actionName": "testAction", + "repetitionName": "000001" + }, + "responses": { + "200": { + "body": { + "inputs": [ + { + "path": "", + "text": "items('For_each')?['OccuringLocation']?['Environment']", + "value": "PROD" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunOperationsGet.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunOperationsGet.json new file mode 100644 index 000000000000..f984164dbdc2 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunOperationsGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "testFlow", + "runName": "08586774142730039209110422528", + "operationId": "ebdcbbde-c4db-43ec-987c-fd0f7726f43b" + }, + "responses": { + "200": { + "body": { + "properties": { + "waitEndTime": "2018-04-20T02:50:12.4741081Z", + "startTime": "2018-04-20T02:50:12.4741081Z", + "endTime": "2018-04-20T02:50:13.7177644Z", + "status": "Succeeded", + "correlation": { + "clientTrackingId": "08586774142730039209110422528" + }, + "workflow": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testFlow/versions/08586993867806980512", + "name": "08586993867806980512", + "type": "Microsoft.Logic/workflows/versions" + }, + "trigger": { + "name": "Recurrence", + "startTime": "2018-04-20T02:50:12.460076Z", + "endTime": "2018-04-20T02:50:12.460076Z", + "scheduledTime": "2018-04-20T02:50:12.1412543Z", + "correlation": { + "clientTrackingId": "08586774142730039209110422528" + }, + "code": "OK", + "status": "Succeeded" + }, + "outputs": {} + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testFlow/runs/08586774142730039209110422528", + "name": "08586774142730039209110422528", + "type": "Microsoft.Logic/workflows/runs" + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowTriggerHistoriesResubmit.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowTriggerHistoriesResubmit.json index ea0973783062..4089dfb37c4a 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowTriggerHistoriesResubmit.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowTriggerHistoriesResubmit.json @@ -1,13 +1,13 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "workflowName": "testWorkflowName", - "triggerName": "testTriggerName", - "historyName": "testHistoryName" - }, - "responses":{ - "202":{} - } + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "testWorkflowName", + "triggerName": "testTriggerName", + "historyName": "testHistoryName" + }, + "responses": { + "202": {} + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowVersionsListCallbackUrl.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowVersionsListCallbackUrl.json index d726e47b32b2..3deaeabfbb27 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowVersionsListCallbackUrl.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowVersionsListCallbackUrl.json @@ -11,19 +11,19 @@ "keyType": "Primary" } }, - "responses":{ - "200":{ - "body": { - "value": "http://test-host:100/workflows/fb9c8d79b15f41ce9b12861862f43546/versions/08587100027316071865/triggers/manualTrigger/paths/invoke?api-version=2015-08-01-preview&sp=%2Fversions%2F08587100027316071865%2Ftriggers%2FmanualTrigger%2Frun&sv=1.0&sig=IxEQ_ygZf6WNEQCbjV0Vs6p6Y4DyNEJVAa86U5B4xhk", - "method": "POST", - "basePath": "http://test-host:100/workflows/fb9c8d79b15f41ce9b12861862f43546/versions/08587100027316071865/triggers/manualTrigger/paths/invoke", - "queries": { - "api-version": "2015-08-01-preview", - "sp": "/versions/08587100027316071865/triggers/manualTrigger/run", - "sv": "1.0", - "sig": "IxEQ_ygZf6WNEQCbjV0Vs6p6Y4DyNEJVAa86U5B4xhk" - } + "responses": { + "200": { + "body": { + "value": "http://test-host:100/workflows/fb9c8d79b15f41ce9b12861862f43546/versions/08587100027316071865/triggers/manualTrigger/paths/invoke?api-version=2015-08-01-preview&sp=%2Fversions%2F08587100027316071865%2Ftriggers%2FmanualTrigger%2Frun&sv=1.0&sig=IxEQ_ygZf6WNEQCbjV0Vs6p6Y4DyNEJVAa86U5B4xhk", + "method": "POST", + "basePath": "http://test-host:100/workflows/fb9c8d79b15f41ce9b12861862f43546/versions/08587100027316071865/triggers/manualTrigger/paths/invoke", + "queries": { + "api-version": "2015-08-01-preview", + "sp": "/versions/08587100027316071865/triggers/manualTrigger/run", + "sv": "1.0", + "sig": "IxEQ_ygZf6WNEQCbjV0Vs6p6Y4DyNEJVAa86U5B4xhk" } } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsListCallbackUrl.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsListCallbackUrl.json new file mode 100644 index 000000000000..e047718048bd --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsListCallbackUrl.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "testWorkflow", + "listCallbackUrl": { + "notAfter": "2018-04-19T16:00:00Z", + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "value": "https://prod-03.westus.logic.azure.com/workflows/d4690301f3b340de9330256bb2e83974/triggers/requestTrigger/paths/invoke?api-version=2016-06-01&se=2018-04-19T16%3A00%3A00.0000000Z&sp=%2Ftriggers%2FrequestTrigger%2Frun&sv=1.0&sig=JXbHjs3qzLPDyk-IM_VzsN-WL_mNql3v_uWbBbKgtVk", + "method": "POST", + "basePath": "https://prod-03.westus.logic.azure.com/workflows/d4690301f3b340de9330256bb2e83974", + "queries": { + "api-version": "2016-06-01", + "se": "2018-04-19T16:00:00.0000000Z", + "sp": "//*", + "sv": "1.0", + "sig": "JXbHjs3qzLPDyk-IM_VzsN-WL_mNql3v_uWbBbKgtVk" + } + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsListSwagger.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsListSwagger.json index b9ce4505ee14..f4b9e38b677a 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsListSwagger.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsListSwagger.json @@ -1,92 +1,100 @@ { - "parameters":{ - "api-version":"2016-06-01", - "resourceGroupName":"testResourceGroup", - "subscriptionId":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "workflowName":"testWorkflowName" - }, - "responses":{ - "200":{ - "body": { - "swagger": "2.0", - "info": { - "title": "flow", - "description": "Azure Logic App." - }, - "host": "test-host", - "basePath": "/workflows/2e420261710e423490d5d502fe9c4abb/triggers", - "schemes": [ "http" ], - "consumes": [ "application/json" ], - "produces": [ "application/json" ], - "paths": { - "/simpleManualTrigger/paths/invoke": { - "post": { - "description": "Trigger a run of the logic app.", - "operationId": "simpleManualTrigger-invoke", - "parameters": [ - { - "name": "api-version", - "in": "query", - "description": "The service API version.", - "required": true, - "type": "string" - }, - { - "name": "sp", - "in": "query", - "description": "The permissions; generally 'read' or 'write'.", - "required": true, - "type": "string" - }, - { - "name": "sv", - "in": "query", - "description": "The version number of the query parameters.", - "required": true, - "type": "string" - }, - { - "name": "sig", - "in": "query", - "description": "The SHA 256 hash of the entire request URI with an internal key.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "description": "The request body.", - "required": false, - "schema": { - "$ref": "#/definitions/request-simpleManualTrigger" - } - } - ], - "responses": { - "default": { - "description": "The Logic App Response.", - "schema": { "type": "object" } - } + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "testWorkflowName" + }, + "responses": { + "200": { + "body": { + "swagger": "2.0", + "info": { + "title": "flow", + "description": "Azure Logic App." + }, + "host": "test-host", + "basePath": "/workflows/2e420261710e423490d5d502fe9c4abb/triggers", + "schemes": [ + "http" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/simpleManualTrigger/paths/invoke": { + "post": { + "description": "Trigger a run of the logic app.", + "operationId": "simpleManualTrigger-invoke", + "parameters": [ + { + "name": "api-version", + "in": "query", + "description": "The service API version.", + "required": true, + "type": "string" + }, + { + "name": "sp", + "in": "query", + "description": "The permissions; generally 'read' or 'write'.", + "required": true, + "type": "string" + }, + { + "name": "sv", + "in": "query", + "description": "The version number of the query parameters.", + "required": true, + "type": "string" + }, + { + "name": "sig", + "in": "query", + "description": "The SHA 256 hash of the entire request URI with an internal key.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The request body.", + "required": false, + "schema": { + "$ref": "#/definitions/request-simpleManualTrigger" } } - } - }, - "definitions": { - "request-simpleManualTrigger": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title." - }, - "sendEmail": { - "type": "boolean", - "description": "Whether to send email." + ], + "responses": { + "default": { + "description": "The Logic App Response.", + "schema": { + "type": "object" } } } } } + }, + "definitions": { + "request-simpleManualTrigger": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "Title." + }, + "sendEmail": { + "type": "boolean", + "description": "Whether to send email." + } + } + } + } } - } + } + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsMove.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsMove.json new file mode 100644 index 000000000000..46a587c0df85 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsMove.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "testWorkflow", + "move": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/newResourceGroup/providers/Microsoft.Logic/workflows/newWorkflowName" + } + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsRegenerateAccessKey.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsRegenerateAccessKey.json index f933066b9052..e1b25e484914 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsRegenerateAccessKey.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsRegenerateAccessKey.json @@ -4,9 +4,11 @@ "resourceGroupName": "testResourceGroup", "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "workflowName": "testWorkflowName", - "keyType": { "keyType": "Primary" } + "keyType": { + "keyType": "Primary" + } }, - "responses":{ - "200":{} - } + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsTriggerReset.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsTriggerReset.json new file mode 100644 index 000000000000..f3d5ef689136 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsTriggerReset.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "testWorkflow", + "triggerName": "testTrigger" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsTriggerSchemaJson.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsTriggerSchemaJson.json new file mode 100644 index 000000000000..0a6252c631a3 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsTriggerSchemaJson.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "testWorkflow", + "triggerName": "testTrigger" + }, + "responses": { + "200": { + "body": { + "title": "JsonTitle", + "content": "JsonContent" + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsTriggerSetState.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsTriggerSetState.json new file mode 100644 index 000000000000..ae4d178e5837 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowsTriggerSetState.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2016-06-01", + "resourceGroupName": "testResourceGroup", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "testWorkflow", + "triggerName": "testTrigger", + "setState": { + "source": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sourceResGroup/providers/Microsoft.Logic/workflows/sourceWorkflow/triggers/sourceTrigger" + } + } + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/logic.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/logic.json index cec697cbc400..5eab158f4416 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/logic.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/logic.json @@ -58,7 +58,7 @@ }, { "name": "$filter", - "description": "The filter to apply on the operation.", + "description": "The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId.", "in": "query", "required": false, "type": "string" @@ -109,7 +109,7 @@ }, { "name": "$filter", - "description": "The filter to apply on the operation.", + "description": "The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId.", "in": "query", "required": false, "type": "string" @@ -423,6 +423,59 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listCallbackUrl": { + "post": { + "tags": [ + "Workflows" + ], + "operationId": "Workflows_ListCallbackUrl", + "description": "Get the workflow callback Url.", + "x-ms-examples": { + "Get callback url": { + "$ref": "./examples/WorkflowsListCallbackUrl.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "listCallbackUrl", + "description": "Which callback url to list.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetCallbackUrlParameters" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowTriggerCallbackUrl" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listSwagger": { "post": { "tags": [ @@ -462,6 +515,59 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/move": { + "post": { + "tags": [ + "Workflows" + ], + "operationId": "Workflows_Move", + "description": "Moves an existing workflow.", + "x-ms-examples": { + "Move a workflow": { + "$ref": "./examples/WorkflowsMove.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "move", + "description": "The workflow to move.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workflow" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "No Content" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/regenerateAccessKey": { "post": { "tags": [ @@ -512,6 +618,51 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/validate": { + "post": { + "tags": [ + "Workflows" + ], + "operationId": "Workflows_ValidateWorkflow", + "description": "Validates the workflow.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "validate", + "description": "The workflow.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workflow" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions": { "get": { "tags": [ @@ -712,13 +863,18 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/run": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/reset": { "post": { "tags": [ "WorkflowTriggers" ], - "operationId": "WorkflowTriggers_Run", - "description": "Runs a workflow trigger.", + "operationId": "WorkflowTriggers_Reset", + "description": "Resets a workflow trigger.", + "x-ms-examples": { + "Reset trigger": { + "$ref": "./examples/WorkflowsTriggerReset.json" + } + }, "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -749,22 +905,19 @@ } ], "responses": { - "default": { - "description": "All status codes are acceptable.", - "schema": { - "$ref": "#/definitions/Object" - } + "200": { + "description": "OK" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/listCallbackUrl": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/run": { "post": { "tags": [ "WorkflowTriggers" ], - "operationId": "WorkflowTriggers_ListCallbackUrl", - "description": "Gets the callback URL for a workflow trigger.", + "operationId": "WorkflowTriggers_Run", + "description": "Runs a workflow trigger.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -795,25 +948,25 @@ } ], "responses": { - "200": { - "description": "OK", + "default": { + "description": "All status codes are acceptable.", "schema": { - "$ref": "#/definitions/WorkflowTriggerCallbackUrl" + "$ref": "#/definitions/Object" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions/{versionId}/triggers/{triggerName}/listCallbackUrl": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/schemas/json": { + "get": { "tags": [ "WorkflowTriggers" ], - "operationId": "WorkflowVersions_ListCallbackUrl", - "description": "Lists the callback URL for a trigger of a workflow version.", + "operationId": "WorkflowTriggers_GetSchemaJson", + "description": "Get the trigger schema as JSON.", "x-ms-examples": { - "Get callback URL for a trigger of a workflow version": { - "$ref": "./examples/WorkflowVersionsListCallbackUrl.json" + "Get trigger schema": { + "$ref": "./examples/WorkflowsTriggerSchemaJson.json" } }, "parameters": [ @@ -834,13 +987,6 @@ "required": true, "type": "string" }, - { - "name": "versionId", - "description": "The workflow versionId.", - "in": "path", - "required": true, - "type": "string" - }, { "name": "triggerName", "description": "The workflow trigger name.", @@ -848,15 +994,6 @@ "required": true, "type": "string" }, - { - "name": "parameters", - "description": "The callback URL parameters.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/GetCallbackUrlParameters" - } - }, { "$ref": "#/parameters/api-version" } @@ -865,19 +1002,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/WorkflowTriggerCallbackUrl" + "$ref": "#/definitions/JsonSchema" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/setState": { + "post": { "tags": [ - "WorkflowTriggerHistories" + "WorkflowTriggers" ], - "operationId": "WorkflowTriggerHistories_List", - "description": "Gets a list of workflow trigger histories.", + "operationId": "WorkflowTriggers_SetState", + "description": "Sets the state of a workflow trigger.", + "x-ms-examples": { + "Set trigger state": { + "$ref": "./examples/WorkflowsTriggerSetState.json" + } + }, "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -904,45 +1046,32 @@ "type": "string" }, { - "$ref": "#/parameters/api-version" - }, - { - "name": "$top", - "description": "The number of items to be included in the result.", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" + "name": "setState", + "description": "The workflow trigger state.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SetTriggerStateActionDefinition" + } }, { - "name": "$filter", - "description": "The filter to apply on the operation.", - "in": "query", - "required": false, - "type": "string" + "$ref": "#/parameters/api-version" } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WorkflowTriggerHistoryListResult" - } + "description": "OK" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/WorkflowTriggerHistoryFilter" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/listCallbackUrl": { + "post": { "tags": [ - "WorkflowTriggerHistories" + "WorkflowTriggers" ], - "operationId": "WorkflowTriggerHistories_Get", - "description": "Gets a workflow trigger history.", + "operationId": "WorkflowTriggers_ListCallbackUrl", + "description": "Get the callback URL for a workflow trigger.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -968,13 +1097,6 @@ "required": true, "type": "string" }, - { - "name": "historyName", - "description": "The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run.", - "in": "path", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/api-version" } @@ -983,22 +1105,22 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/WorkflowTriggerHistory" + "$ref": "#/definitions/WorkflowTriggerCallbackUrl" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}/resubmit": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions/{versionId}/triggers/{triggerName}/listCallbackUrl": { "post": { "tags": [ - "WorkflowTriggerHistories" + "WorkflowTriggers" ], - "operationId": "WorkflowTriggerHistories_Resubmit", - "description": "Resubmits a workflow run based on the trigger history.", + "operationId": "WorkflowVersions_ListCallbackUrl", + "description": "Get the callback url for a trigger of a workflow version.", "x-ms-examples": { - "Resubmit a workflow run based on the trigger history": { - "$ref": "./examples/WorkflowTriggerHistoriesResubmit.json" + "Get the callback url for a trigger of a workflow version": { + "$ref": "./examples/WorkflowVersionsListCallbackUrl.json" } }, "parameters": [ @@ -1019,6 +1141,13 @@ "required": true, "type": "string" }, + { + "name": "versionId", + "description": "The workflow versionId.", + "in": "path", + "required": true, + "type": "string" + }, { "name": "triggerName", "description": "The workflow trigger name.", @@ -1027,30 +1156,35 @@ "type": "string" }, { - "name": "historyName", - "description": "The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run.", - "in": "path", - "required": true, - "type": "string" + "name": "parameters", + "description": "The callback URL parameters.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/GetCallbackUrlParameters" + } }, { "$ref": "#/parameters/api-version" } ], "responses": { - "202": { - "description": "OK" + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowTriggerCallbackUrl" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories": { "get": { "tags": [ - "WorkflowRuns" + "WorkflowTriggerHistories" ], - "operationId": "WorkflowRuns_List", - "description": "Gets a list of workflow runs.", + "operationId": "WorkflowTriggerHistories_List", + "description": "Gets a list of workflow trigger histories.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1069,6 +1203,13 @@ "required": true, "type": "string" }, + { + "name": "triggerName", + "description": "The workflow trigger name.", + "in": "path", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/api-version" }, @@ -1082,7 +1223,7 @@ }, { "name": "$filter", - "description": "The filter to apply on the operation.", + "description": "The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId.", "in": "query", "required": false, "type": "string" @@ -1092,23 +1233,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/WorkflowRunListResult" + "$ref": "#/definitions/WorkflowTriggerHistoryListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/WorkflowRunFilter" + "x-ms-odata": "#/definitions/WorkflowTriggerHistoryFilter" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}": { "get": { "tags": [ - "WorkflowRuns" + "WorkflowTriggerHistories" ], - "operationId": "WorkflowRuns_Get", - "description": "Gets a workflow run.", + "operationId": "WorkflowTriggerHistories_Get", + "description": "Gets a workflow trigger history.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1128,8 +1269,15 @@ "type": "string" }, { - "name": "runName", - "description": "The workflow run name.", + "name": "triggerName", + "description": "The workflow trigger name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "historyName", + "description": "The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run.", "in": "path", "required": true, "type": "string" @@ -1142,19 +1290,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/WorkflowRun" + "$ref": "#/definitions/WorkflowTriggerHistory" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/cancel": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}/resubmit": { "post": { "tags": [ - "WorkflowRuns" + "WorkflowTriggerHistories" ], - "operationId": "WorkflowRuns_Cancel", - "description": "Cancels a workflow run.", + "operationId": "WorkflowTriggerHistories_Resubmit", + "description": "Resubmits a workflow run based on the trigger history.", + "x-ms-examples": { + "Resubmit a workflow run based on the trigger history": { + "$ref": "./examples/WorkflowTriggerHistoriesResubmit.json" + } + }, "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1174,8 +1327,15 @@ "type": "string" }, { - "name": "runName", - "description": "The workflow run name.", + "name": "triggerName", + "description": "The workflow trigger name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "historyName", + "description": "The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run.", "in": "path", "required": true, "type": "string" @@ -1185,19 +1345,19 @@ } ], "responses": { - "200": { + "202": { "description": "OK" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs": { "get": { "tags": [ - "WorkflowRunActions" + "WorkflowRuns" ], - "operationId": "WorkflowRunActions_List", - "description": "Gets a list of workflow run actions.", + "operationId": "WorkflowRuns_List", + "description": "Gets a list of workflow runs.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1216,13 +1376,6 @@ "required": true, "type": "string" }, - { - "name": "runName", - "description": "The workflow run name.", - "in": "path", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/api-version" }, @@ -1236,7 +1389,7 @@ }, { "name": "$filter", - "description": "The filter to apply on the operation.", + "description": "The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId.", "in": "query", "required": false, "type": "string" @@ -1246,23 +1399,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/WorkflowRunActionListResult" + "$ref": "#/definitions/WorkflowRunListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/WorkflowRunActionFilter" + "x-ms-odata": "#/definitions/WorkflowRunFilter" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}": { "get": { "tags": [ - "WorkflowRunActions" + "WorkflowRuns" ], - "operationId": "WorkflowRunActions_Get", - "description": "Gets a workflow run action.", + "operationId": "WorkflowRuns_Get", + "description": "Gets a workflow run.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1288,13 +1441,6 @@ "required": true, "type": "string" }, - { - "name": "actionName", - "description": "The workflow action name.", - "in": "path", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/api-version" } @@ -1303,19 +1449,19 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/WorkflowRunAction" + "$ref": "#/definitions/WorkflowRun" } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/locations/{location}/workflows/{workflowName}/validate": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/cancel": { "post": { "tags": [ - "Workflows" + "WorkflowRuns" ], - "operationId": "Workflows_Validate", - "description": "Validates the workflow definition.", + "operationId": "WorkflowRuns_Cancel", + "description": "Cancels a workflow run.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1328,30 +1474,21 @@ "type": "string" }, { - "name": "location", - "description": "The workflow location.", + "name": "workflowName", + "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { - "name": "workflowName", - "description": "The workflow name.", + "name": "runName", + "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" - }, - { - "name": "workflow", - "description": "The workflow definition.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Workflow" - } } ], "responses": { @@ -1361,22 +1498,38 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Logic/integrationAccounts": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions": { "get": { "tags": [ - "IntegrationAccounts" + "WorkflowRunActions" ], - "operationId": "IntegrationAccounts_ListBySubscription", - "description": "Gets a list of integration accounts by subscription.", - "x-ms-examples": { - "List IntegrationAccounts by subscription": { - "$ref": "./examples/IntegrationAccountsListBySubscription.json" - } - }, + "operationId": "WorkflowRunActions_List", + "description": "Gets a list of workflow run actions.", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/api-version" }, @@ -1387,33 +1540,36 @@ "required": false, "type": "integer", "format": "int32" + }, + { + "name": "$filter", + "description": "The filter to apply on the operation. Options for filters include: Status.", + "in": "query", + "required": false, + "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountListResult" + "$ref": "#/definitions/WorkflowRunActionListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" - } + }, + "x-ms-odata": "#/definitions/WorkflowRunActionFilter" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}": { "get": { "tags": [ - "IntegrationAccounts" + "WorkflowRunActions" ], - "operationId": "IntegrationAccounts_ListByResourceGroup", - "description": "Gets a list of integration accounts by resource group.", - "x-ms-examples": { - "List IntegrationAccounts by resourcegroup name": { - "$ref": "./examples/IntegrationAccountsListByResourceGroup.json" - } - }, + "operationId": "WorkflowRunActions_Get", + "description": "Gets a workflow run action.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1426,40 +1582,50 @@ "type": "string" }, { - "$ref": "#/parameters/api-version" + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" }, { - "name": "$top", - "description": "The number of items to be included in the result.", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountListResult" + "$ref": "#/definitions/WorkflowRunAction" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/listExpressionTraces": { + "post": { "tags": [ - "IntegrationAccounts" + "WorkflowRunActions" ], - "operationId": "IntegrationAccounts_Get", - "description": "Gets an integration account.", + "operationId": "WorkflowRunActions_ListExpressionTraces", + "description": "Lists a workflow run expression trace.", "x-ms-examples": { - "Get IntegrationAccount by name": { - "$ref": "./examples/IntegrationAccountsGet.json" + "List expression traces": { + "$ref": "./examples/WorkflowRunActionsListExpressionTraces.json" } }, "parameters": [ @@ -1474,91 +1640,54 @@ "type": "string" }, { - "name": "integrationAccountName", - "description": "The integration account name.", + "name": "workflowName", + "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IntegrationAccount" - } - } - } - }, - "put": { - "tags": [ - "IntegrationAccounts" - ], - "operationId": "IntegrationAccounts_CreateOrUpdate", - "description": "Creates or updates an integration account.", - "x-ms-examples": { - "Create or update an IntegrationAccount": { - "$ref": "./examples/IntegrationAccountsCreateOrUpdate.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "description": "The resource group name.", + "name": "runName", + "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { - "name": "integrationAccountName", - "description": "The integration account name.", + "name": "actionName", + "description": "The workflow action name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" - }, - { - "name": "integrationAccount", - "description": "The integration account.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/IntegrationAccount" - } } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccount" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/IntegrationAccount" + "$ref": "#/definitions/ExpressionTraces" } } + }, + "x-ms-pageable": { + "nextLinkName": null, + "itemName": "inputs" } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions": { + "get": { "tags": [ - "IntegrationAccounts" + "WorkflowRunActions" ], - "operationId": "IntegrationAccounts_Update", - "description": "Updates an integration account.", + "operationId": "WorkflowRunActionRepetitions_List", + "description": "Get all of a workflow run action repetitions.", "x-ms-examples": { - "Patch an IntegrationAccount": { - "$ref": "./examples/IntegrationAccountsUpdate.json" + "List repetitions": { + "$ref": "./examples/WorkflowRunActionRepetitionsList.json" } }, "parameters": [ @@ -1573,43 +1702,53 @@ "type": "string" }, { - "name": "integrationAccountName", - "description": "The integration account name.", + "name": "workflowName", + "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { - "$ref": "#/parameters/api-version" + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" }, { - "name": "integrationAccount", - "description": "The integration account.", - "in": "body", + "name": "actionName", + "description": "The workflow action name.", + "in": "path", "required": true, - "schema": { - "$ref": "#/definitions/IntegrationAccount" - } + "type": "string" + }, + { + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccount" + "$ref": "#/definitions/WorkflowRunActionRepetitionDefinitionCollection" } } + }, + "x-ms-pageable": { + "nextLinkName": null } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}": { + "get": { "tags": [ - "IntegrationAccounts" + "WorkflowRunActions" ], - "operationId": "IntegrationAccounts_Delete", - "description": "Deletes an integration account.", + "operationId": "WorkflowRunActionRepetitions_Get", + "description": "Get a workflow run action repetition.", "x-ms-examples": { - "Delete an IntegrationAccount": { - "$ref": "./examples/IntegrationAccountsDelete.json" + "Get a repetition": { + "$ref": "./examples/WorkflowRunActionRepetitionsGet.json" } }, "parameters": [ @@ -1624,8 +1763,29 @@ "type": "string" }, { - "name": "integrationAccountName", - "description": "The integration account name.", + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "repetitionName", + "description": "The workflow repetition.", "in": "path", "required": true, "type": "string" @@ -1636,24 +1796,24 @@ ], "responses": { "200": { - "description": "OK" - }, - "204": { - "description": "No Content" + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowRunActionRepetitionDefinition" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/listCallbackUrl": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/listExpressionTraces": { "post": { "tags": [ - "IntegrationAccounts" + "WorkflowRunActions" ], - "operationId": "IntegrationAccounts_GetCallbackUrl", - "description": "Gets the integration account callback URL.", + "operationId": "WorkflowRunActionRepetitions_ListExpressionTraces", + "description": "Lists a workflow run expression trace.", "x-ms-examples": { - "Get IntegrationAccount callback URL": { - "$ref": "./examples/IntegrationAccountsGetCallbackUrl.json" + "List expression traces": { + "$ref": "./examples/WorkflowRunActionsListExpressionTraces.json" } }, "parameters": [ @@ -1668,45 +1828,61 @@ "type": "string" }, { - "name": "integrationAccountName", - "description": "The integration account name.", + "name": "workflowName", + "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { - "$ref": "#/parameters/api-version" + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" }, { - "name": "parameters", - "description": "The callback URL parameters.", - "in": "body", + "name": "actionName", + "description": "The workflow action name.", + "in": "path", "required": true, - "schema": { - "$ref": "#/definitions/GetCallbackUrlParameters" - } + "type": "string" + }, + { + "name": "repetitionName", + "description": "The workflow repetition.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CallbackUrl" + "$ref": "#/definitions/ExpressionTraces" } } + }, + "x-ms-pageable": { + "nextLinkName": null, + "itemName": "inputs" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions": { "get": { "tags": [ - "IntegrationAccountSchemas" + "WorkflowRunActions" ], - "operationId": "Schemas_ListByIntegrationAccounts", - "description": "Gets a list of integration account schemas.", + "operationId": "WorkflowRunActionScopedRepetitions_List", + "description": "List the workflow run action scoped repetitions.", "x-ms-examples": { - "Get schemas by integration account name": { - "$ref": "./examples/SchemasListByIntegrationAccounts.json" + "List the scoped repetitions": { + "$ref": "./examples/WorkflowRunActionScopeRepetitionsList.json" } }, "parameters": [ @@ -1721,55 +1897,50 @@ "type": "string" }, { - "name": "integrationAccountName", - "description": "The integration account name.", + "name": "workflowName", + "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { - "$ref": "#/parameters/api-version" + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" }, { - "name": "$top", - "description": "The number of items to be included in the result.", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" }, { - "name": "$filter", - "description": "The filter to apply on the operation.", - "in": "query", - "required": false, - "type": "string" + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountSchemaListResult" + "$ref": "#/definitions/WorkflowRunActionRepetitionDefinitionCollection" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/IntegrationAccountSchemaFilter" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas/{schemaName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions/{repetitionName}": { "get": { "tags": [ - "IntegrationAccountSchemas" + "WorkflowRunActions" ], - "operationId": "Schemas_Get", - "description": "Gets an integration account schema.", + "operationId": "WorkflowRunActionScopedRepetitions_Get", + "description": "Get a workflow run action scoped repetition.", "x-ms-examples": { - "Get schema by name": { - "$ref": "./examples/SchemasGet.json" + "Get a scoped repetition": { + "$ref": "./examples/WorkflowRunActionScopeRepetitionsGet.json" } }, "parameters": [ @@ -1784,15 +1955,29 @@ "type": "string" }, { - "name": "integrationAccountName", - "description": "The integration account name.", + "name": "workflowName", + "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { - "name": "schemaName", - "description": "The integration account schema name.", + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "repetitionName", + "description": "The workflow repetition.", "in": "path", "required": true, "type": "string" @@ -1805,20 +1990,22 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountSchema" + "$ref": "#/definitions/WorkflowRunActionRepetitionDefinition" } } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/operations/{operationId}": { + "get": { "tags": [ - "IntegrationAccountSchemas" + "WorkflowRunOperations" ], - "operationId": "Schemas_CreateOrUpdate", - "description": "Creates or updates an integration account schema.", + "operationId": "WorkflowRunOperations_Get", + "description": "Gets an operation for a run.", "x-ms-examples": { - "Create or update schema": { - "$ref": "./examples/SchemasCreateOrUpdate.json" + "Get a run operation": { + "$ref": "./examples/WorkflowRunOperationsGet.json" } }, "parameters": [ @@ -1833,58 +2020,47 @@ "type": "string" }, { - "name": "integrationAccountName", - "description": "The integration account name.", + "name": "workflowName", + "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { - "name": "schemaName", - "description": "The integration account schema name.", + "name": "runName", + "description": "The workflow run name.", "in": "path", "required": true, "type": "string" }, { - "$ref": "#/parameters/api-version" + "name": "operationId", + "description": "The workflow operation id.", + "in": "path", + "required": true, + "type": "string" }, { - "name": "schema", - "description": "The integration account schema.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/IntegrationAccountSchema" - } + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountSchema" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/IntegrationAccountSchema" + "$ref": "#/definitions/WorkflowRun" } } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/locations/{location}/workflows/{workflowName}/validate": { + "post": { "tags": [ - "IntegrationAccountSchemas" + "Workflows" ], - "operationId": "Schemas_Delete", - "description": "Deletes an integration account schema.", - "x-ms-examples": { - "Delete a schema by name": { - "$ref": "./examples/SchemasDelete.json" - } - }, + "operationId": "Workflows_Validate", + "description": "Validates the workflow definition.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1897,43 +2073,90 @@ "type": "string" }, { - "name": "integrationAccountName", - "description": "The integration account name.", + "name": "location", + "description": "The workflow location.", "in": "path", "required": true, "type": "string" }, { - "name": "schemaName", - "description": "The integration account schema name.", + "name": "workflowName", + "description": "The workflow name.", "in": "path", "required": true, "type": "string" }, { "$ref": "#/parameters/api-version" + }, + { + "name": "workflow", + "description": "The workflow definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workflow" + } } ], "responses": { "200": { "description": "OK" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Logic/integrationAccounts": { + "get": { + "tags": [ + "IntegrationAccounts" + ], + "operationId": "IntegrationAccounts_ListBySubscription", + "description": "Gets a list of integration accounts by subscription.", + "x-ms-examples": { + "List IntegrationAccounts by subscription": { + "$ref": "./examples/IntegrationAccountsListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" }, - "204": { - "description": "No Content" + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$top", + "description": "The number of items to be included in the result.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts": { "get": { "tags": [ - "IntegrationAccountMaps" + "IntegrationAccounts" ], - "operationId": "Maps_ListByIntegrationAccounts", - "description": "Gets a list of integration account maps.", + "operationId": "IntegrationAccounts_ListByResourceGroup", + "description": "Gets a list of integration accounts by resource group.", "x-ms-examples": { - "Get maps by integration account name": { - "$ref": "./examples/MapsListByIntegrationAccounts.json" + "List IntegrationAccounts by resource group name": { + "$ref": "./examples/IntegrationAccountsListByResourceGroup.json" } }, "parameters": [ @@ -1947,13 +2170,6 @@ "required": true, "type": "string" }, - { - "name": "integrationAccountName", - "description": "The integration account name.", - "in": "path", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/api-version" }, @@ -1964,39 +2180,31 @@ "required": false, "type": "integer", "format": "int32" - }, - { - "name": "$filter", - "description": "The filter to apply on the operation.", - "in": "query", - "required": false, - "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountMapListResult" + "$ref": "#/definitions/IntegrationAccountListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/IntegrationAccountMapFilter" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps/{mapName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}": { "get": { "tags": [ - "IntegrationAccountMaps" + "IntegrationAccounts" ], - "operationId": "Maps_Get", - "description": "Gets an integration account map.", + "operationId": "IntegrationAccounts_Get", + "description": "Gets an integration account.", "x-ms-examples": { - "Get map by name": { - "$ref": "./examples/MapsGet.json" + "Get IntegrationAccount by name": { + "$ref": "./examples/IntegrationAccountsGet.json" } }, "parameters": [ @@ -2017,13 +2225,6 @@ "required": true, "type": "string" }, - { - "name": "mapName", - "description": "The integration account map name.", - "in": "path", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/api-version" } @@ -2032,20 +2233,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountMap" + "$ref": "#/definitions/IntegrationAccount" } } } }, "put": { "tags": [ - "IntegrationAccountMaps" + "IntegrationAccounts" ], - "operationId": "Maps_CreateOrUpdate", - "description": "Creates or updates an integration account map.", + "operationId": "IntegrationAccounts_CreateOrUpdate", + "description": "Creates or updates an integration account.", "x-ms-examples": { - "Create or update a map": { - "$ref": "./examples/MapsCreateOrUpdate.json" + "Create or update an IntegrationAccount": { + "$ref": "./examples/IntegrationAccountsCreateOrUpdate.json" } }, "parameters": [ @@ -2066,23 +2267,16 @@ "required": true, "type": "string" }, - { - "name": "mapName", - "description": "The integration account map name.", - "in": "path", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/api-version" }, { - "name": "map", - "description": "The integration account map.", + "name": "integrationAccount", + "description": "The integration account.", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/IntegrationAccountMap" + "$ref": "#/definitions/IntegrationAccount" } } ], @@ -2090,26 +2284,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountMap" + "$ref": "#/definitions/IntegrationAccount" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/IntegrationAccountMap" + "$ref": "#/definitions/IntegrationAccount" } } } }, - "delete": { + "patch": { "tags": [ - "IntegrationAccountMaps" + "IntegrationAccounts" ], - "operationId": "Maps_Delete", - "description": "Deletes an integration account map.", + "operationId": "IntegrationAccounts_Update", + "description": "Updates an integration account.", "x-ms-examples": { - "Delete a map": { - "$ref": "./examples/MapsDelete.json" + "Patch an IntegrationAccount": { + "$ref": "./examples/IntegrationAccountsUpdate.json" } }, "parameters": [ @@ -2131,36 +2325,36 @@ "type": "string" }, { - "name": "mapName", - "description": "The integration account map name.", - "in": "path", - "required": true, - "type": "string" + "$ref": "#/parameters/api-version" }, { - "$ref": "#/parameters/api-version" + "name": "integrationAccount", + "description": "The integration account.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IntegrationAccount" + } } ], "responses": { "200": { - "description": "OK" - }, - "204": { - "description": "No Content" + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccount" + } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners": { - "get": { + }, + "delete": { "tags": [ - "IntegrationAccountPartners" + "IntegrationAccounts" ], - "operationId": "Partners_ListByIntegrationAccounts", - "description": "Gets a list of integration account partners.", + "operationId": "IntegrationAccounts_Delete", + "description": "Deletes an integration account.", "x-ms-examples": { - "Get partners by integrationaccount name": { - "$ref": "./examples/PartnersListByIntegrationAccounts.json" + "Delete an IntegrationAccount": { + "$ref": "./examples/IntegrationAccountsDelete.json" } }, "parameters": [ @@ -2183,47 +2377,28 @@ }, { "$ref": "#/parameters/api-version" - }, - { - "name": "$top", - "description": "The number of items to be included in the result.", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$filter", - "description": "The filter to apply on the operation.", - "in": "query", - "required": false, - "type": "string" } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IntegrationAccountPartnerListResult" - } + "description": "OK" + }, + "204": { + "description": "No Content" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/IntegrationAccountPartnerFilter" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners/{partnerName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies": { "get": { "tags": [ - "IntegrationAccountPartners" + "IntegrationAccountAssemblies" ], - "operationId": "Partners_Get", - "description": "Gets an integration account partner.", + "operationId": "IntegrationAccountAssemblies_List", + "description": "List the assemblies for an integration account.", "x-ms-examples": { - "Get partner by name": { - "$ref": "./examples/PartnersGet.json" + "List integration account assemblies.": { + "$ref": "./examples/IntegrationAccountsAssembliesList.json" } }, "parameters": [ @@ -2245,9 +2420,56 @@ "type": "string" }, { - "name": "partnerName", - "description": "The integration account partner name.", - "in": "path", + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssemblyCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies/{assemblyArtifactName}": { + "get": { + "tags": [ + "IntegrationAccountAssemblies" + ], + "operationId": "IntegrationAccountAssemblies_Get", + "description": "Get an assembly for an integration account.", + "x-ms-examples": { + "Get an integration account assembly.": { + "$ref": "./examples/IntegrationAccountsAssembliesGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "assemblyArtifactName", + "description": "The assembly artifact name.", + "in": "path", "required": true, "type": "string" }, @@ -2259,20 +2481,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountPartner" + "$ref": "#/definitions/AssemblyDefinition" } } } }, "put": { "tags": [ - "IntegrationAccountPartners" + "IntegrationAccountAssemblies" ], - "operationId": "Partners_CreateOrUpdate", - "description": "Creates or updates an integration account partner.", + "operationId": "IntegrationAccountAssemblies_CreateOrUpdate", + "description": "Create or update an assembly for an integration account.", "x-ms-examples": { - "Create or update a partner": { - "$ref": "./examples/PartnersCreateOrUpdate.json" + "Create or update an account assembly.": { + "$ref": "./examples/IntegrationAccountsAssembliesCreateOrUpdate.json" } }, "parameters": [ @@ -2294,49 +2516,49 @@ "type": "string" }, { - "name": "partnerName", - "description": "The integration account partner name.", + "name": "assemblyArtifactName", + "description": "The assembly artifact name.", "in": "path", "required": true, "type": "string" }, { - "$ref": "#/parameters/api-version" - }, - { - "name": "partner", - "description": "The integration account partner.", + "name": "assemblyArtifact", + "description": "The assembly artifact.", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/IntegrationAccountPartner" + "$ref": "#/definitions/AssemblyDefinition" } + }, + { + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountPartner" + "$ref": "#/definitions/AssemblyDefinition" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/IntegrationAccountPartner" + "$ref": "#/definitions/AssemblyDefinition" } } } }, "delete": { "tags": [ - "IntegrationAccountPartners" + "IntegrationAccountAssemblies" ], - "operationId": "Partners_Delete", - "description": "Deletes an integration account partner.", + "operationId": "IntegrationAccountAssemblies_Delete", + "description": "Delete an assembly for an integration account.", "x-ms-examples": { - "Delete a partner": { - "$ref": "./examples/PartnersDelete.json" + "Delete an integration account assembly.": { + "$ref": "./examples/IntegrationAccountsAssembliesDelete.json" } }, "parameters": [ @@ -2358,8 +2580,8 @@ "type": "string" }, { - "name": "partnerName", - "description": "The integration account partner name.", + "name": "assemblyArtifactName", + "description": "The assembly artifact name.", "in": "path", "required": true, "type": "string" @@ -2378,16 +2600,16 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies/{assemblyArtifactName}/listContentCallbackUrl": { + "post": { "tags": [ - "IntegrationAccountAgreements" + "IntegrationAccountAssemblies" ], - "operationId": "Agreements_ListByIntegrationAccounts", - "description": "Gets a list of integration account agreements.", + "operationId": "IntegrationAccountAssemblies_ListContentCallbackUrl", + "description": "Get the content callback url for an integration account assembly.", "x-ms-examples": { - "Get agreements by integrationaccount name": { - "$ref": "./examples/AgreementsListByIntegrationAccounts.json" + "Get the callback url for an integration account assembly.": { + "$ref": "./examples/IntegrationAccountsAssembliesListContentCallbackUrl.json" } }, "parameters": [ @@ -2408,49 +2630,84 @@ "required": true, "type": "string" }, + { + "name": "assemblyArtifactName", + "description": "The assembly artifact name.", + "in": "path", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowTriggerCallbackUrl" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/batchConfigurations": { + "get": { + "tags": [ + "IntegrationAccountBatchConfigurations" + ], + "operationId": "IntegrationAccountBatchConfigurations_List", + "description": "List the batch configurations for an integration account.", + "x-ms-examples": { + "List batch configurations.": { + "$ref": "./examples/IntegrationAccountBatchConfigurationsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" }, { - "name": "$top", - "description": "The number of items to be included in the result.", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" }, { - "name": "$filter", - "description": "The filter to apply on the operation.", - "in": "query", - "required": false, + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, "type": "string" + }, + { + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountAgreementListResult" + "$ref": "#/definitions/BatchConfigurationCollection" } } }, "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/IntegrationAccountAgreementFilter" + "nextLinkName": null + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/batchConfigurations/{batchConfigurationName}": { "get": { "tags": [ - "IntegrationAccountAgreements" + "IntegrationAccountBatchConfigurations" ], - "operationId": "Agreements_Get", - "description": "Gets an integration account agreement.", + "operationId": "IntegrationAccountBatchConfigurations_Get", + "description": "Get a batch configuration for an integration account.", "x-ms-examples": { - "Get agreement by name": { - "$ref": "./examples/AgreementsGet.json" + "Get a batch configuration.": { + "$ref": "./examples/IntegrationAccountBatchConfigurationsGet.json" } }, "parameters": [ @@ -2472,8 +2729,8 @@ "type": "string" }, { - "name": "agreementName", - "description": "The integration account agreement name.", + "name": "batchConfigurationName", + "description": "The batch configuration name.", "in": "path", "required": true, "type": "string" @@ -2486,20 +2743,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountAgreement" + "$ref": "#/definitions/BatchConfiguration" } } } }, "put": { "tags": [ - "IntegrationAccountAgreements" + "IntegrationAccountBatchConfigurations" ], - "operationId": "Agreements_CreateOrUpdate", - "description": "Creates or updates an integration account agreement.", + "operationId": "IntegrationAccountBatchConfigurations_CreateOrUpdate", + "description": "Create or update a batch configuration for an integration account.", "x-ms-examples": { - "Create or update an agreement": { - "$ref": "./examples/AgreementsCreateOrUpdate.json" + "Create or update a batch configuration.": { + "$ref": "./examples/IntegrationAccountBatchConfigurationsCreateOrUpdate.json" } }, "parameters": [ @@ -2521,49 +2778,49 @@ "type": "string" }, { - "name": "agreementName", - "description": "The integration account agreement name.", + "name": "batchConfigurationName", + "description": "The batch configuration name.", "in": "path", "required": true, "type": "string" }, { - "$ref": "#/parameters/api-version" - }, - { - "name": "agreement", - "description": "The integration account agreement.", + "name": "batchConfiguration", + "description": "The batch configuration.", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/IntegrationAccountAgreement" + "$ref": "#/definitions/BatchConfiguration" } + }, + { + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountAgreement" + "$ref": "#/definitions/BatchConfiguration" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/IntegrationAccountAgreement" + "$ref": "#/definitions/BatchConfiguration" } } } }, "delete": { "tags": [ - "IntegrationAccountAgreements" + "IntegrationAccountBatchConfigurations" ], - "operationId": "Agreements_Delete", - "description": "Deletes an integration account agreement.", + "operationId": "IntegrationAccountBatchConfigurations_Delete", + "description": "Delete a batch configuration for an integration account.", "x-ms-examples": { - "Delete an agreement": { - "$ref": "./examples/AgreementsDelete.json" + "Delete a batch configuration.": { + "$ref": "./examples/IntegrationAccountBatchConfigurationsDelete.json" } }, "parameters": [ @@ -2585,8 +2842,8 @@ "type": "string" }, { - "name": "agreementName", - "description": "The integration account agreement name.", + "name": "batchConfigurationName", + "description": "The batch configuration name.", "in": "path", "required": true, "type": "string" @@ -2605,16 +2862,16 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/listCallbackUrl": { + "post": { "tags": [ - "IntegrationAccountCertificates" + "IntegrationAccounts" ], - "operationId": "Certificates_ListByIntegrationAccounts", - "description": "Gets a list of integration account certificates.", + "operationId": "IntegrationAccounts_GetCallbackUrl", + "description": "Gets the integration account callback URL.", "x-ms-examples": { - "Get certificates by integrationAccount name": { - "$ref": "./examples/CertificatesListByIntegrationAccounts.json" + "Get IntegrationAccount callback URL": { + "$ref": "./examples/IntegrationAccountsGetCallbackUrl.json" } }, "parameters": [ @@ -2639,37 +2896,35 @@ "$ref": "#/parameters/api-version" }, { - "name": "$top", - "description": "The number of items to be included in the result.", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" + "name": "parameters", + "description": "The callback URL parameters.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetCallbackUrlParameters" + } } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountCertificateListResult" + "$ref": "#/definitions/CallbackUrl" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates/{certificateName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/listKeyVaultKeys": { + "post": { "tags": [ - "IntegrationAccountCertificates" + "IntegrationAccounts" ], - "operationId": "Certificates_Get", - "description": "Gets an integration account certificate.", + "operationId": "IntegrationAccounts_ListKeyVaultKeys", + "description": "Gets the integration account's Key Vault keys.", "x-ms-examples": { - "Get certificate by name": { - "$ref": "./examples/CertificatesGet.json" + "Get Integration Account callback URL": { + "$ref": "./examples/IntegrationAccountsListKeyVaultKeys.json" } }, "parameters": [ @@ -2691,34 +2946,41 @@ "type": "string" }, { - "name": "certificateName", - "description": "The integration account certificate name.", - "in": "path", - "required": true, - "type": "string" + "$ref": "#/parameters/api-version" }, { - "$ref": "#/parameters/api-version" + "name": "listKeyVaultKeys", + "description": "The key vault parameters.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ListKeyVaultKeysDefinition" + } } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountCertificate" + "$ref": "#/definitions/KeyVaultKeyCollection" } } + }, + "x-ms-pageable": { + "nextLinkName": null } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/logTrackingEvents": { + "post": { "tags": [ - "IntegrationAccountCertificates" + "IntegrationAccounts" ], - "operationId": "Certificates_CreateOrUpdate", - "description": "Creates or updates an integration account certificate.", + "operationId": "IntegrationAccounts_LogTrackingEvents", + "description": "Logs the integration account's tracking events.", "x-ms-examples": { - "Create or update a certificate": { - "$ref": "./examples/CertificatesCreateOrUpdate.json" + "Log a tracked event": { + "$ref": "./examples/IntegrationAccountsLogTrackingEvent.json" } }, "parameters": [ @@ -2739,50 +3001,36 @@ "required": true, "type": "string" }, - { - "name": "certificateName", - "description": "The integration account certificate name.", - "in": "path", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/api-version" }, { - "name": "certificate", - "description": "The integration account certificate.", + "name": "logTrackingEvents", + "description": "The callback URL parameters.", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/IntegrationAccountCertificate" + "$ref": "#/definitions/TrackingEventsDefinition" } } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/IntegrationAccountCertificate" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/IntegrationAccountCertificate" - } + "description": "OK" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/regenerateAccessKey": { + "post": { "tags": [ - "IntegrationAccountCertificates" + "IntegrationAccounts" ], - "operationId": "Certificates_Delete", - "description": "Deletes an integration account certificate.", + "operationId": "IntegrationAccounts_RegenerateAccessKey", + "description": "Regenerates the integration account access key.", "x-ms-examples": { - "Delete a certificate": { - "$ref": "./examples/CertificatesDelete.json" + "Regenerate access key": { + "$ref": "./examples/IntegrationAccountsRegenerateAccessKey.json" } }, "parameters": [ @@ -2804,38 +3052,40 @@ "type": "string" }, { - "name": "certificateName", - "description": "The integration account certificate name.", - "in": "path", - "required": true, - "type": "string" + "$ref": "#/parameters/api-version" }, { - "$ref": "#/parameters/api-version" + "name": "regenerateAccessKey", + "description": "The access key type.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateActionParameter" + } } ], "responses": { "200": { - "description": "OK" - }, - "204": { - "description": "No Content" + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccount" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas": { "get": { "tags": [ - "IntegrationAccountSessions" + "IntegrationAccountSchemas" ], - "operationId": "Sessions_ListByIntegrationAccounts", + "operationId": "Schemas_ListByIntegrationAccounts", + "description": "Gets a list of integration account schemas.", "x-ms-examples": { - "SessionsListByIntegrationAccounts": { - "$ref": "./examples/SessionsListByIntegrationAccounts.json" + "Get schemas by integration account name": { + "$ref": "./examples/SchemasListByIntegrationAccounts.json" } }, - "description": "Gets a list of integration account sessions.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2867,7 +3117,7 @@ }, { "name": "$filter", - "description": "The filter to apply on the operation.", + "description": "The filter to apply on the operation. Options for filters include: SchemaType.", "in": "query", "required": false, "type": "string" @@ -2877,34 +3127,28 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountSessionListResult" - } - }, - "default": { - "description": "Logic error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/IntegrationAccountSchemaListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/IntegrationAccountSessionFilter" + "x-ms-odata": "#/definitions/IntegrationAccountSchemaFilter" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions/{sessionName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas/{schemaName}": { "get": { "tags": [ - "IntegrationAccountSessions" + "IntegrationAccountSchemas" ], - "operationId": "Sessions_Get", + "operationId": "Schemas_Get", + "description": "Gets an integration account schema.", "x-ms-examples": { - "SessionsGet": { - "$ref": "./examples/SessionsGet.json" + "Get schema by name": { + "$ref": "./examples/SchemasGet.json" } }, - "description": "Gets an integration account session.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2924,8 +3168,8 @@ "type": "string" }, { - "name": "sessionName", - "description": "The integration account session name.", + "name": "schemaName", + "description": "The integration account schema name.", "in": "path", "required": true, "type": "string" @@ -2938,28 +3182,22 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountSession" - } - }, - "default": { - "description": "Logic error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/IntegrationAccountSchema" } } } }, "put": { "tags": [ - "IntegrationAccountSessions" + "IntegrationAccountSchemas" ], - "operationId": "Sessions_CreateOrUpdate", + "operationId": "Schemas_CreateOrUpdate", + "description": "Creates or updates an integration account schema.", "x-ms-examples": { - "SessionsCreateOrUpdate": { - "$ref": "./examples/SessionsCreateOrUpdate.json" + "Create or update schema": { + "$ref": "./examples/SchemasCreateOrUpdate.json" } }, - "description": "Creates or updates an integration account session.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2979,8 +3217,8 @@ "type": "string" }, { - "name": "sessionName", - "description": "The integration account session name.", + "name": "schemaName", + "description": "The integration account schema name.", "in": "path", "required": true, "type": "string" @@ -2989,12 +3227,12 @@ "$ref": "#/parameters/api-version" }, { - "name": "session", - "description": "The integration account session.", + "name": "schema", + "description": "The integration account schema.", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/IntegrationAccountSession" + "$ref": "#/definitions/IntegrationAccountSchema" } } ], @@ -3002,34 +3240,28 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/IntegrationAccountSession" + "$ref": "#/definitions/IntegrationAccountSchema" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/IntegrationAccountSession" - } - }, - "default": { - "description": "Logic error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/IntegrationAccountSchema" } } } }, "delete": { "tags": [ - "IntegrationAccountSessions" + "IntegrationAccountSchemas" ], - "operationId": "Sessions_Delete", + "operationId": "Schemas_Delete", + "description": "Deletes an integration account schema.", "x-ms-examples": { - "SessionsDelete": { - "$ref": "./examples/SessionsDelete.json" + "Delete a schema by name": { + "$ref": "./examples/SchemasDelete.json" } }, - "description": "Deletes an integration account session.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -3049,8 +3281,8 @@ "type": "string" }, { - "name": "sessionName", - "description": "The integration account session name.", + "name": "schemaName", + "description": "The integration account schema name.", "in": "path", "required": true, "type": "string" @@ -3065,496 +3297,2593 @@ }, "204": { "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas/{schemaName}/listContentCallbackUrl": { + "post": { + "tags": [ + "IntegrationAccountSchemas" + ], + "operationId": "Schemas_ListContentCallbackUrl", + "description": "Get the content callback url.", + "x-ms-examples": { + "Get the content callback url": { + "$ref": "./examples/SchemasListContentCallbackUrl.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" }, - "default": { - "description": "Logic error response describing why the operation failed.", + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "schemaName", + "description": "The integration account schema name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "listContentCallbackUrl", + "in": "body", + "required": true, "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/GetCallbackUrlParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowTriggerCallbackUrl" } } } } }, - "/providers/Microsoft.Logic/operations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps": { "get": { "tags": [ - "Operations" + "IntegrationAccountMaps" ], - "description": "Lists all of the available Logic REST API operations.", - "operationId": "ListOperations", + "operationId": "Maps_ListByIntegrationAccounts", + "description": "Gets a list of integration account maps.", + "x-ms-examples": { + "Get maps by integration account name": { + "$ref": "./examples/MapsListByIntegrationAccounts.json" + } + }, "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/api-version" + }, + { + "name": "$top", + "description": "The number of items to be included in the result.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "description": "The filter to apply on the operation. Options for filters include: MapType.", + "in": "query", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Logic error response describing why the operation failed.", + "description": "OK", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/IntegrationAccountMapListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "Resource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "The resource id." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the resource name." }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the resource type." + "x-ms-odata": "#/definitions/IntegrationAccountMapFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps/{mapName}": { + "get": { + "tags": [ + "IntegrationAccountMaps" + ], + "operationId": "Maps_Get", + "description": "Gets an integration account map.", + "x-ms-examples": { + "Get map by name": { + "$ref": "./examples/MapsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "mapName", + "description": "The integration account map name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountMap" + } + } + } + }, + "put": { + "tags": [ + "IntegrationAccountMaps" + ], + "operationId": "Maps_CreateOrUpdate", + "description": "Creates or updates an integration account map.", + "x-ms-examples": { + "Create or update a map": { + "$ref": "./examples/MapsCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "mapName", + "description": "The integration account map name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "map", + "description": "The integration account map.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IntegrationAccountMap" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountMap" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/IntegrationAccountMap" + } + } + } + }, + "delete": { + "tags": [ + "IntegrationAccountMaps" + ], + "operationId": "Maps_Delete", + "description": "Deletes an integration account map.", + "x-ms-examples": { + "Delete a map": { + "$ref": "./examples/MapsDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "mapName", + "description": "The integration account map name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps/{mapName}/listContentCallbackUrl": { + "post": { + "tags": [ + "IntegrationAccountMaps" + ], + "operationId": "Maps_ListContentCallbackUrl", + "description": "Get the content callback url.", + "x-ms-examples": { + "Get the content callback url": { + "$ref": "./examples/MapsListContentCallbackUrl.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "mapName", + "description": "The integration account map name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "listContentCallbackUrl", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetCallbackUrlParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowTriggerCallbackUrl" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners": { + "get": { + "tags": [ + "IntegrationAccountPartners" + ], + "operationId": "Partners_ListByIntegrationAccounts", + "description": "Gets a list of integration account partners.", + "x-ms-examples": { + "Get partners by integration account name": { + "$ref": "./examples/PartnersListByIntegrationAccounts.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$top", + "description": "The number of items to be included in the result.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "description": "The filter to apply on the operation. Options for filters include: PartnerType.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountPartnerListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/IntegrationAccountPartnerFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners/{partnerName}": { + "get": { + "tags": [ + "IntegrationAccountPartners" + ], + "operationId": "Partners_Get", + "description": "Gets an integration account partner.", + "x-ms-examples": { + "Get partner by name": { + "$ref": "./examples/PartnersGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "partnerName", + "description": "The integration account partner name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountPartner" + } + } + } + }, + "put": { + "tags": [ + "IntegrationAccountPartners" + ], + "operationId": "Partners_CreateOrUpdate", + "description": "Creates or updates an integration account partner.", + "x-ms-examples": { + "Create or update a partner": { + "$ref": "./examples/PartnersCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "partnerName", + "description": "The integration account partner name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "partner", + "description": "The integration account partner.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IntegrationAccountPartner" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountPartner" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/IntegrationAccountPartner" + } + } + } + }, + "delete": { + "tags": [ + "IntegrationAccountPartners" + ], + "operationId": "Partners_Delete", + "description": "Deletes an integration account partner.", + "x-ms-examples": { + "Delete a partner": { + "$ref": "./examples/PartnersDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "partnerName", + "description": "The integration account partner name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners/{partnerName}/listContentCallbackUrl": { + "post": { + "tags": [ + "IntegrationAccountPartners" + ], + "operationId": "Partners_ListContentCallbackUrl", + "description": "Get the content callback url.", + "x-ms-examples": { + "Get the content callback url": { + "$ref": "./examples/PartnersListContentCallbackUrl.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "partnerName", + "description": "The integration account partner name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "listContentCallbackUrl", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetCallbackUrlParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowTriggerCallbackUrl" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements": { + "get": { + "tags": [ + "IntegrationAccountAgreements" + ], + "operationId": "Agreements_ListByIntegrationAccounts", + "description": "Gets a list of integration account agreements.", + "x-ms-examples": { + "Get agreements by integration account name": { + "$ref": "./examples/AgreementsListByIntegrationAccounts.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$top", + "description": "The number of items to be included in the result.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "description": "The filter to apply on the operation. Options for filters include: AgreementType.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountAgreementListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/IntegrationAccountAgreementFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}": { + "get": { + "tags": [ + "IntegrationAccountAgreements" + ], + "operationId": "Agreements_Get", + "description": "Gets an integration account agreement.", + "x-ms-examples": { + "Get agreement by name": { + "$ref": "./examples/AgreementsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "agreementName", + "description": "The integration account agreement name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountAgreement" + } + } + } + }, + "put": { + "tags": [ + "IntegrationAccountAgreements" + ], + "operationId": "Agreements_CreateOrUpdate", + "description": "Creates or updates an integration account agreement.", + "x-ms-examples": { + "Create or update an agreement": { + "$ref": "./examples/AgreementsCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "agreementName", + "description": "The integration account agreement name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "agreement", + "description": "The integration account agreement.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IntegrationAccountAgreement" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountAgreement" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/IntegrationAccountAgreement" + } + } + } + }, + "delete": { + "tags": [ + "IntegrationAccountAgreements" + ], + "operationId": "Agreements_Delete", + "description": "Deletes an integration account agreement.", + "x-ms-examples": { + "Delete an agreement": { + "$ref": "./examples/AgreementsDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "agreementName", + "description": "The integration account agreement name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}/listContentCallbackUrl": { + "post": { + "tags": [ + "IntegrationAccountAgreements" + ], + "operationId": "Agreements_ListContentCallbackUrl", + "description": "Get the content callback url.", + "x-ms-examples": { + "Get the content callback url": { + "$ref": "./examples/AgreementsListContentCallbackUrl.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "agreementName", + "description": "The integration account agreement name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "listContentCallbackUrl", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetCallbackUrlParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkflowTriggerCallbackUrl" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates": { + "get": { + "tags": [ + "IntegrationAccountCertificates" + ], + "operationId": "Certificates_ListByIntegrationAccounts", + "description": "Gets a list of integration account certificates.", + "x-ms-examples": { + "Get certificates by integrationAccount name": { + "$ref": "./examples/CertificatesListByIntegrationAccounts.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$top", + "description": "The number of items to be included in the result.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountCertificateListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates/{certificateName}": { + "get": { + "tags": [ + "IntegrationAccountCertificates" + ], + "operationId": "Certificates_Get", + "description": "Gets an integration account certificate.", + "x-ms-examples": { + "Get certificate by name": { + "$ref": "./examples/CertificatesGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "description": "The integration account certificate name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountCertificate" + } + } + } + }, + "put": { + "tags": [ + "IntegrationAccountCertificates" + ], + "operationId": "Certificates_CreateOrUpdate", + "description": "Creates or updates an integration account certificate.", + "x-ms-examples": { + "Create or update a certificate": { + "$ref": "./examples/CertificatesCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "description": "The integration account certificate name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "certificate", + "description": "The integration account certificate.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IntegrationAccountCertificate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountCertificate" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/IntegrationAccountCertificate" + } + } + } + }, + "delete": { + "tags": [ + "IntegrationAccountCertificates" + ], + "operationId": "Certificates_Delete", + "description": "Deletes an integration account certificate.", + "x-ms-examples": { + "Delete a certificate": { + "$ref": "./examples/CertificatesDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "description": "The integration account certificate name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions": { + "get": { + "tags": [ + "IntegrationAccountSessions" + ], + "operationId": "Sessions_ListByIntegrationAccounts", + "x-ms-examples": { + "SessionsListByIntegrationAccounts": { + "$ref": "./examples/SessionsListByIntegrationAccounts.json" + } + }, + "description": "Gets a list of integration account sessions.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$top", + "description": "The number of items to be included in the result.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "description": "The filter to apply on the operation. Options for filters include: ChangedTime.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountSessionListResult" + } + }, + "default": { + "description": "Logic error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/IntegrationAccountSessionFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions/{sessionName}": { + "get": { + "tags": [ + "IntegrationAccountSessions" + ], + "operationId": "Sessions_Get", + "x-ms-examples": { + "SessionsGet": { + "$ref": "./examples/SessionsGet.json" + } + }, + "description": "Gets an integration account session.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "sessionName", + "description": "The integration account session name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountSession" + } + }, + "default": { + "description": "Logic error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "IntegrationAccountSessions" + ], + "operationId": "Sessions_CreateOrUpdate", + "x-ms-examples": { + "SessionsCreateOrUpdate": { + "$ref": "./examples/SessionsCreateOrUpdate.json" + } + }, + "description": "Creates or updates an integration account session.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "sessionName", + "description": "The integration account session name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "session", + "description": "The integration account session.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IntegrationAccountSession" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IntegrationAccountSession" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/IntegrationAccountSession" + } + }, + "default": { + "description": "Logic error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "IntegrationAccountSessions" + ], + "operationId": "Sessions_Delete", + "x-ms-examples": { + "SessionsDelete": { + "$ref": "./examples/SessionsDelete.json" + } + }, + "description": "Deletes an integration account session.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "integrationAccountName", + "description": "The integration account name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "sessionName", + "description": "The integration account session name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Logic error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Logic/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Logic REST API operations.", + "operationId": "ListOperations", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Logic error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Resource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The resource id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the resource type." }, "location": { "type": "string", - "description": "The resource location." + "description": "The resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true, + "description": "The base resource type." + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The resource id." + } + }, + "x-ms-azure-resource": true, + "description": "The sub resource type." + }, + "Object": { + "type": "object", + "properties": {} + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The resource id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the resource type." + } + }, + "description": "The resource reference." + }, + "Workflow": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowProperties", + "description": "The workflow properties." + } + }, + "description": "The workflow type.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "WorkflowProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/WorkflowProvisioningState", + "readOnly": true, + "description": "Gets the provisioning state." + }, + "createdTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the created time." + }, + "changedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the changed time." + }, + "state": { + "$ref": "#/definitions/WorkflowState", + "description": "The state." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "Gets the version." + }, + "accessEndpoint": { + "type": "string", + "readOnly": true, + "description": "Gets the access endpoint." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku." + }, + "integrationAccount": { + "$ref": "#/definitions/ResourceReference", + "description": "The integration account." + }, + "definition": { + "$ref": "#/definitions/Object", + "description": "The definition." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/WorkflowParameter" + }, + "description": "The parameters." + } + }, + "description": "The workflow properties." + }, + "WorkflowFilter": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/WorkflowState", + "description": "The state of workflows." + } + }, + "description": "The workflow filter." + }, + "WorkflowListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Workflow" + }, + "description": "The list of workflows." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The list of workflows." + }, + "WorkflowVersion": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowVersionProperties", + "description": "The workflow version properties." + } + }, + "description": "The workflow version.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "WorkflowVersionProperties": { + "type": "object", + "properties": { + "createdTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the created time." + }, + "changedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the changed time." + }, + "state": { + "$ref": "#/definitions/WorkflowState", + "description": "The state." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "Gets the version." + }, + "accessEndpoint": { + "type": "string", + "readOnly": true, + "description": "Gets the access endpoint." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku." + }, + "integrationAccount": { + "$ref": "#/definitions/ResourceReference", + "description": "The integration account." + }, + "definition": { + "$ref": "#/definitions/Object", + "description": "The definition." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/WorkflowParameter" + }, + "description": "The parameters." + } + }, + "description": "The workflow version properties." + }, + "WorkflowVersionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowVersion" + }, + "description": "A list of workflow versions." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The list of workflow versions." + }, + "WorkflowTrigger": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowTriggerProperties", + "description": "The workflow trigger properties." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger type." + } + }, + "description": "The workflow trigger.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ] + }, + "WorkflowTriggerProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/WorkflowTriggerProvisioningState", + "readOnly": true, + "description": "Gets the provisioning state." + }, + "createdTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the created time." + }, + "changedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the changed time." + }, + "state": { + "$ref": "#/definitions/WorkflowState", + "readOnly": true, + "description": "Gets the state." + }, + "status": { + "$ref": "#/definitions/WorkflowStatus", + "readOnly": true, + "description": "Gets the status." + }, + "lastExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the last execution time." + }, + "nextExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the next execution time." + }, + "recurrence": { + "$ref": "#/definitions/WorkflowTriggerRecurrence", + "readOnly": true, + "description": "Gets the workflow trigger recurrence." + }, + "workflow": { + "$ref": "#/definitions/ResourceReference", + "readOnly": true, + "description": "Gets the reference to workflow." + } + }, + "description": "The workflow trigger properties." + }, + "WorkflowTriggerFilter": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/WorkflowState", + "description": "The state of workflow trigger." + } + }, + "description": "The workflow trigger filter." + }, + "WorkflowTriggerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowTrigger" + }, + "description": "A list of workflow triggers." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The list of workflow triggers." + }, + "WorkflowTriggerCallbackUrl": { + "type": "object", + "properties": { + "value": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger callback URL." + }, + "method": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger callback URL HTTP method." + }, + "basePath": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger callback URL base path." + }, + "relativePath": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger callback URL relative path." + }, + "relativePathParameters": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets the workflow trigger callback URL relative path parameters." + }, + "queries": { + "$ref": "#/definitions/WorkflowTriggerListCallbackUrlQueries", + "description": "Gets the workflow trigger callback URL query parameters." + } + }, + "description": "The workflow trigger callback URL." + }, + "WorkflowTriggerListCallbackUrlQueries": { + "type": "object", + "properties": { + "api-version": { + "type": "string", + "description": "The api version." }, - "tags": { + "sp": { + "type": "string", + "description": "The SAS permissions." + }, + "sv": { + "type": "string", + "description": "The SAS version." + }, + "sig": { + "type": "string", + "description": "The SAS signature." + }, + "se": { + "type":"string", + "description": "The SAS timestamp." + } + }, + "description": "Gets the workflow trigger callback URL query parameters." + }, + "WorkflowTriggerHistory": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowTriggerHistoryProperties", + "description": "Gets the workflow trigger history properties." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger history name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow trigger history type." + } + }, + "description": "The workflow trigger history.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ] + }, + "WorkflowTriggerHistoryProperties": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the end time." + }, + "status": { + "$ref": "#/definitions/WorkflowStatus", + "readOnly": true, + "description": "Gets the status." + }, + "code": { + "type": "string", + "readOnly": true, + "description": "Gets the code." + }, + "error": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the error." + }, + "trackingId": { + "type": "string", + "readOnly": true, + "description": "Gets the tracking id." + }, + "correlation": { + "$ref": "#/definitions/Correlation", + "description": "The run correlation." + }, + "inputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to input parameters." + }, + "outputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to output parameters." + }, + "fired": { + "type": "boolean", + "readOnly": true, + "description": "Gets a value indicating whether trigger was fired." + }, + "run": { + "$ref": "#/definitions/ResourceReference", + "readOnly": true, + "description": "Gets the reference to workflow run." + } + }, + "description": "The workflow trigger history properties." + }, + "WorkflowTriggerHistoryListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowTriggerHistory" + }, + "description": "A list of workflow trigger histories." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The list of workflow trigger histories." + }, + "WorkflowTriggerHistoryFilter": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/WorkflowStatus", + "description": "The status of workflow trigger history." + } + }, + "description": "The workflow trigger history filter." + }, + "WorkflowRun": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowRunProperties", + "description": "The workflow run properties." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow run name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the workflow run type." + } + }, + "description": "The workflow run.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ] + }, + "WorkflowRunProperties": { + "type": "object", + "properties": { + "waitEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the wait end time." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the end time." + }, + "status": { + "$ref": "#/definitions/WorkflowStatus", + "readOnly": true, + "description": "Gets the status." + }, + "code": { + "type": "string", + "readOnly": true, + "description": "Gets the code." + }, + "error": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the error." + }, + "correlationId": { + "type": "string", + "readOnly": true, + "description": "Gets the correlation id." + }, + "correlation": { + "$ref": "#/definitions/Correlation", + "description": "The run correlation." + }, + "workflow": { + "$ref": "#/definitions/ResourceReference", + "readOnly": true, + "description": "Gets the reference to workflow version." + }, + "trigger": { + "$ref": "#/definitions/WorkflowRunTrigger", + "readOnly": true, + "description": "Gets the fired trigger." + }, + "outputs": { "type": "object", + "readOnly": true, "additionalProperties": { - "type": "string" + "$ref": "#/definitions/WorkflowOutputParameter" }, - "description": "The resource tags." + "description": "Gets the outputs." + }, + "response": { + "$ref": "#/definitions/WorkflowRunTrigger", + "readOnly": true, + "description": "Gets the response of the flow run." } }, - "x-ms-azure-resource": true, - "description": "The base resource type." + "description": "The workflow run properties." }, - "SubResource": { + "WorkflowRunFilter": { + "type": "object", "properties": { - "id": { + "status": { + "$ref": "#/definitions/WorkflowStatus", + "description": "The status of workflow run." + } + }, + "description": "The workflow run filter." + }, + "WorkflowRunListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowRun" + }, + "description": "A list of workflow runs." + }, + "nextLink": { "type": "string", - "readOnly": true, - "description": "The resource id." + "description": "The URL to get the next set of results." } }, - "x-ms-azure-resource": true, - "description": "The sub resource type." - }, - "Object": { - "type": "object", - "properties": {} + "description": "The list of workflow runs." }, - "ResourceReference": { + "WorkflowRunAction": { "type": "object", "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "The resource id." + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowRunActionProperties", + "description": "The workflow run action properties." }, "name": { "type": "string", "readOnly": true, - "description": "Gets the resource name." + "description": "Gets the workflow run action name." }, "type": { "type": "string", "readOnly": true, - "description": "Gets the resource type." - } - }, - "description": "The resource reference." - }, - "Workflow": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkflowProperties", - "description": "The workflow properties." + "description": "Gets the workflow run action type." } }, - "description": "The workflow type.", + "description": "The workflow run action.", "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "#/definitions/SubResource" } ] }, - "WorkflowProperties": { + "WorkflowRunActionProperties": { "type": "object", "properties": { - "provisioningState": { - "$ref": "#/definitions/WorkflowProvisioningState", - "readOnly": true, - "description": "Gets the provisioning state." - }, - "createdTime": { + "startTime": { "type": "string", "format": "date-time", "readOnly": true, - "description": "Gets the created time." + "description": "Gets the start time." }, - "changedTime": { + "endTime": { "type": "string", "format": "date-time", "readOnly": true, - "description": "Gets the changed time." + "description": "Gets the end time." }, - "state": { - "$ref": "#/definitions/WorkflowState", - "description": "The state." + "status": { + "$ref": "#/definitions/WorkflowStatus", + "readOnly": true, + "description": "Gets the status." }, - "version": { + "code": { "type": "string", "readOnly": true, - "description": "Gets the version." + "description": "Gets the code." }, - "accessEndpoint": { + "error": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the error." + }, + "trackingId": { "type": "string", "readOnly": true, - "description": "Gets the access endpoint." + "description": "Gets the tracking id." }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "The sku." + "correlation": { + "$ref": "#/definitions/Correlation", + "description": "The correlation properties." }, - "integrationAccount": { - "$ref": "#/definitions/ResourceReference", - "description": "The integration account." + "inputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to inputs." }, - "definition": { + "outputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to outputs." + }, + "trackedProperties": { "$ref": "#/definitions/Object", - "description": "The definition." + "readOnly": true, + "description": "Gets the tracked properties." }, - "parameters": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/WorkflowParameter" + "retryHistory": { + "type": "array", + "items": { + "$ref": "#/definitions/RetryHistory" }, - "description": "The parameters." + "description": "Gets the retry histories." } }, - "description": "The workflow properties." + "description": "The workflow run action properties." }, - "WorkflowFilter": { + "WorkflowRunActionFilter": { "type": "object", "properties": { - "state": { - "$ref": "#/definitions/WorkflowState", - "description": "The state of workflows." + "status": { + "$ref": "#/definitions/WorkflowStatus", + "description": "The status of workflow run action." } }, - "description": "The workflow filter." + "description": "The workflow run action filter." }, - "WorkflowListResult": { + "WorkflowRunActionListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { - "$ref": "#/definitions/Workflow" + "$ref": "#/definitions/WorkflowRunAction" }, - "description": "The list of workflows." + "description": "A list of workflow run actions." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, - "description": "The list of workflows." + "description": "The list of workflow run actions." }, - "WorkflowVersion": { + "SkuName": { + "type": "string", + "enum": [ + "NotSpecified", + "Free", + "Shared", + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + }, + "description": "The sku name." + }, + "WorkflowState": { + "type": "string", + "enum": [ + "NotSpecified", + "Completed", + "Enabled", + "Disabled", + "Deleted", + "Suspended" + ], + "x-ms-enum": { + "name": "WorkflowState", + "modelAsString": false + } + }, + "WorkflowStatus": { + "type": "string", + "enum": [ + "NotSpecified", + "Paused", + "Running", + "Waiting", + "Succeeded", + "Skipped", + "Suspended", + "Cancelled", + "Failed", + "Faulted", + "TimedOut", + "Aborted", + "Ignored" + ], + "x-ms-enum": { + "name": "WorkflowStatus", + "modelAsString": false + } + }, + "ParameterType": { + "type": "string", + "enum": [ + "NotSpecified", + "String", + "SecureString", + "Int", + "Float", + "Bool", + "Array", + "Object", + "SecureObject" + ], + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": false + } + }, + "KeyType": { + "type": "string", + "enum": [ + "NotSpecified", + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "Sku": { "type": "object", + "required": [ + "name" + ], "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkflowVersionProperties", - "description": "The workflow version properties." + "name": { + "$ref": "#/definitions/SkuName", + "description": "The name." + }, + "plan": { + "$ref": "#/definitions/ResourceReference", + "description": "The reference to plan." } }, - "description": "The workflow version.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] + "description": "The sku type." }, - "WorkflowVersionProperties": { + "ContentLink": { "type": "object", "properties": { - "createdTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the created time." - }, - "changedTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the changed time." - }, - "state": { - "$ref": "#/definitions/WorkflowState", - "description": "The state." - }, - "version": { - "type": "string", - "readOnly": true, - "description": "Gets the version." + "uri": { + "type": "string", + "description": "The content link URI." }, - "accessEndpoint": { + "contentVersion": { "type": "string", - "readOnly": true, - "description": "Gets the access endpoint." + "description": "The content version." }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "The sku." + "contentSize": { + "type": "integer", + "format": "int64", + "description": "The content size." }, - "integrationAccount": { - "$ref": "#/definitions/ResourceReference", - "description": "The integration account." + "contentHash": { + "$ref": "#/definitions/ContentHash", + "description": "The content hash." }, - "definition": { + "metadata": { "$ref": "#/definitions/Object", - "description": "The definition." - }, - "parameters": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/WorkflowParameter" - }, - "description": "The parameters." + "description": "The metadata." } }, - "description": "The workflow version properties." + "description": "The content link." }, - "WorkflowVersionListResult": { + "ContentHash": { "type": "object", "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/WorkflowVersion" - }, - "description": "A list of workflow versions." + "algorithm": { + "type": "string", + "description": "The algorithm of the content hash." }, - "nextLink": { + "value": { "type": "string", - "description": "The URL to get the next set of results." + "description": "The value of the content hash." } }, - "description": "The list of workflow versions." + "description": "The content hash." }, - "WorkflowTrigger": { + "RegenerateActionParameter": { "type": "object", "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkflowTriggerProperties", - "description": "The workflow trigger properties." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the workflow trigger name." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the workflow trigger type." + "keyType": { + "$ref": "#/definitions/KeyType", + "description": "The key type." } }, - "description": "The workflow trigger.", - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ] + "description": "The access key regenerate action content." }, - "WorkflowTriggerProperties": { + "RetryHistory": { "type": "object", "properties": { - "provisioningState": { - "$ref": "#/definitions/WorkflowTriggerProvisioningState", - "readOnly": true, - "description": "Gets the provisioning state." - }, - "createdTime": { + "startTime": { "type": "string", "format": "date-time", - "readOnly": true, - "description": "Gets the created time." + "description": "Gets the start time." }, - "changedTime": { + "endTime": { "type": "string", "format": "date-time", - "readOnly": true, - "description": "Gets the changed time." - }, - "state": { - "$ref": "#/definitions/WorkflowState", - "readOnly": true, - "description": "Gets the state." - }, - "status": { - "$ref": "#/definitions/WorkflowStatus", - "readOnly": true, - "description": "Gets the status." + "description": "Gets the end time." }, - "lastExecutionTime": { + "code": { "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the last execution time." + "description": "Gets the status code." }, - "nextExecutionTime": { + "clientRequestId": { "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the next execution time." + "description": "Gets the client request Id." }, - "recurrence": { - "$ref": "#/definitions/WorkflowTriggerRecurrence", - "readOnly": true, - "description": "Gets the workflow trigger recurrence." + "serviceRequestId": { + "type": "string", + "description": "Gets the service request Id." }, - "workflow": { - "$ref": "#/definitions/ResourceReference", - "readOnly": true, - "description": "Gets the reference to workflow." + "error": { + "$ref": "#/definitions/ErrorResponse", + "description": "Gets the error response." } }, - "description": "The workflow trigger properties." + "description": "The retry history." }, - "WorkflowTriggerFilter": { + "Correlation": { "type": "object", "properties": { - "state": { - "$ref": "#/definitions/WorkflowState", - "description": "The state of workflow trigger." + "clientTrackingId": { + "type": "string", + "description": "The client tracking id." } }, - "description": "The workflow trigger filter." + "description": "The correlation property." }, - "WorkflowTriggerListResult": { + "WorkflowParameter": { "type": "object", "properties": { + "type": { + "$ref": "#/definitions/ParameterType", + "description": "The type." + }, "value": { - "type": "array", - "items": { - "$ref": "#/definitions/WorkflowTrigger" - }, - "description": "A list of workflow triggers." + "$ref": "#/definitions/Object", + "description": "The value." }, - "nextLink": { + "metadata": { + "$ref": "#/definitions/Object", + "description": "The metadata." + }, + "description": { "type": "string", - "description": "The URL to get the next set of results." + "description": "The description." } }, - "description": "The list of workflow triggers." + "description": "The workflow parameters." }, - "WorkflowTriggerCallbackUrl": { + "WorkflowOutputParameter": { "type": "object", "properties": { - "value": { - "type": "string", + "error": { + "$ref": "#/definitions/Object", "readOnly": true, - "description": "Gets the workflow trigger callback URL." + "description": "Gets the error." + } + }, + "description": "The workflow output parameter.", + "allOf": [ + { + "$ref": "#/definitions/WorkflowParameter" + } + ] + }, + "RecurrenceFrequency": { + "type": "string", + "enum": [ + "NotSpecified", + "Second", + "Minute", + "Hour", + "Day", + "Week", + "Month", + "Year" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": false + } + }, + "RecurrenceSchedule": { + "type": "object", + "properties": { + "minutes": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The minutes." }, - "method": { - "type": "string", - "readOnly": true, - "description": "Gets the workflow trigger callback URL HTTP method." + "hours": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The hours." }, - "basePath": { - "type": "string", - "readOnly": true, - "description": "Gets the workflow trigger callback URL base path." + "weekDays": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DaysOfWeek", + "modelAsString": false + } + }, + "description": "The days of the week." }, - "relativePath": { - "type": "string", - "readOnly": true, - "description": "Gets the workflow trigger callback URL relative path." + "monthDays": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The month days." }, - "relativePathParameters": { + "monthlyOccurrences": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/RecurrenceScheduleOccurrence" }, - "description": "Gets the workflow trigger callback URL relative path parameters." + "description": "The monthly occurrences." + } + }, + "description": "The recurrence schedule." + }, + "RecurrenceScheduleOccurrence": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/DayOfWeek", + "description": "The day of the week." }, - "queries": { - "$ref": "#/definitions/WorkflowTriggerListCallbackUrlQueries", - "description": "Gets the workflow trigger callback URL query parameters." + "occurrence": { + "type": "integer", + "format": "int32", + "description": "The occurrence." } }, - "description": "The workflow trigger callback URL." + "description": "The recurrence schedule occurrence." }, - "WorkflowTriggerListCallbackUrlQueries": { + "WorkflowTriggerRecurrence": { "type": "object", "properties": { - "api-version": { - "type": "string", - "description": "The api version." + "frequency": { + "$ref": "#/definitions/RecurrenceFrequency", + "description": "The frequency." }, - "sp": { + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval." + }, + "startTime": { "type": "string", - "description": "The SAS permissions." + "description": "The start time." }, - "sv": { + "endTime": { "type": "string", - "description": "The SAS version." + "description": "The end time." }, - "sig": { + "timeZone": { "type": "string", - "description": "The SAS signature." + "description": "The time zone." + }, + "schedule": { + "$ref": "#/definitions/RecurrenceSchedule", + "description": "The recurrence schedule." } }, - "description": "Gets the workflow trigger callback URL query parameters." + "description": "The workflow trigger recurrence." }, - "WorkflowTriggerHistory": { + "WorkflowRunTrigger": { "type": "object", "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkflowTriggerHistoryProperties", - "description": "Gets the workflow trigger history properties." - }, "name": { "type": "string", "readOnly": true, - "description": "Gets the workflow trigger history name." + "description": "Gets the name." }, - "type": { + "inputs": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the inputs." + }, + "inputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to inputs." + }, + "outputs": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the outputs." + }, + "outputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to outputs." + }, + "scheduledTime": { "type": "string", + "format": "date-time", "readOnly": true, - "description": "Gets the workflow trigger history type." - } - }, - "description": "The workflow trigger history.", - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ] - }, - "WorkflowTriggerHistoryProperties": { - "type": "object", - "properties": { + "description": "Gets the scheduled time." + }, "startTime": { "type": "string", "format": "date-time", @@ -3567,21 +5896,6 @@ "readOnly": true, "description": "Gets the end time." }, - "status": { - "$ref": "#/definitions/WorkflowStatus", - "readOnly": true, - "description": "Gets the status." - }, - "code": { - "type": "string", - "readOnly": true, - "description": "Gets the code." - }, - "error": { - "$ref": "#/definitions/Object", - "readOnly": true, - "description": "Gets the error." - }, "trackingId": { "type": "string", "readOnly": true, @@ -3591,1743 +5905,1904 @@ "$ref": "#/definitions/Correlation", "description": "The run correlation." }, - "inputsLink": { - "$ref": "#/definitions/ContentLink", + "code": { + "type": "string", "readOnly": true, - "description": "Gets the link to input parameters." + "description": "Gets the code." }, - "outputsLink": { - "$ref": "#/definitions/ContentLink", + "status": { + "$ref": "#/definitions/WorkflowStatus", "readOnly": true, - "description": "Gets the link to output parameters." + "description": "Gets the status." }, - "fired": { - "type": "boolean", + "error": { + "$ref": "#/definitions/Object", "readOnly": true, - "description": "Gets a value indicating whether trigger was fired." + "description": "Gets the error." }, - "run": { - "$ref": "#/definitions/ResourceReference", + "trackedProperties": { + "$ref": "#/definitions/Object", "readOnly": true, - "description": "Gets the reference to workflow run." + "description": "Gets the tracked properties." } }, - "description": "The workflow trigger history properties." + "description": "The workflow run trigger." }, - "WorkflowTriggerHistoryListResult": { + "WorkflowTriggerProvisioningState": { + "type": "string", + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Ready", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "Moving", + "Updating", + "Registering", + "Registered", + "Unregistering", + "Unregistered", + "Completed" + ], + "x-ms-enum": { + "name": "WorkflowTriggerProvisioningState", + "modelAsString": false + } + }, + "WorkflowProvisioningState": { + "type": "string", + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Ready", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "Moving", + "Updating", + "Registering", + "Registered", + "Unregistering", + "Unregistered", + "Completed" + ], + "x-ms-enum": { + "name": "WorkflowProvisioningState", + "modelAsString": false + } + }, + "DayOfWeek": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "GenerateUpgradedDefinitionParameters": { + "type": "object", + "properties": { + "targetSchemaVersion": { + "type": "string", + "description": "The target schema version." + } + }, + "description": "The parameters to generate upgraded definition." + }, + "IntegrationAccountSkuName": { + "type": "string", + "enum": [ + "NotSpecified", + "Free", + "Standard" + ], + "x-ms-enum": { + "name": "IntegrationAccountSkuName", + "modelAsString": false + } + }, + "IntegrationAccount": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IntegrationAccountProperties", + "description": "The integration account properties." + }, + "sku": { + "$ref": "#/definitions/IntegrationAccountSku", + "description": "The sku." + } + }, + "description": "The integration account.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "IntegrationAccountProperties": { + "type": "object", + "properties": {} + }, + "IntegrationAccountListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { - "$ref": "#/definitions/WorkflowTriggerHistory" + "$ref": "#/definitions/IntegrationAccount" }, - "description": "A list of workflow trigger histories." + "description": "The list of integration accounts." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, - "description": "The list of workflow trigger histories." + "description": "The list of integration accounts." }, - "WorkflowTriggerHistoryFilter": { + "GetCallbackUrlParameters": { "type": "object", "properties": { - "status": { - "$ref": "#/definitions/WorkflowStatus", - "description": "The status of workflow trigger history." + "notAfter": { + "type": "string", + "format": "date-time", + "description": "The expiry time." + }, + "keyType": { + "$ref": "#/definitions/KeyType", + "description": "The key type." } }, - "description": "The workflow trigger history filter." + "description": "The callback url parameters." }, - "WorkflowRun": { + "CallbackUrl": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The URL value." + } + }, + "description": "The callback url." + }, + "IntegrationAccountSchema": { "type": "object", + "required": [ + "properties" + ], "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkflowRunProperties", - "description": "The workflow run properties." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the workflow run name." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the workflow run type." + "$ref": "#/definitions/IntegrationAccountSchemaProperties", + "description": "The integration account schema properties." } }, - "description": "The workflow run.", + "description": "The integration account schema.", "allOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/Resource" } ] }, - "WorkflowRunProperties": { + "IntegrationAccountSchemaProperties": { "type": "object", + "required": [ + "schemaType" + ], "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the start time." + "schemaType": { + "$ref": "#/definitions/SchemaType", + "description": "The schema type." }, - "endTime": { + "targetNamespace": { "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the end time." + "description": "The target namespace of the schema." }, - "status": { - "$ref": "#/definitions/WorkflowStatus", - "readOnly": true, - "description": "Gets the status." + "documentName": { + "type": "string", + "description": "The document name." }, - "code": { + "fileName": { "type": "string", - "readOnly": true, - "description": "Gets the code." + "description": "The file name." }, - "error": { - "$ref": "#/definitions/Object", + "createdTime": { + "type": "string", + "format": "date-time", "readOnly": true, - "description": "Gets the error." + "description": "The created time." }, - "correlationId": { + "changedTime": { "type": "string", + "format": "date-time", "readOnly": true, - "description": "Gets the correlation id." - }, - "correlation": { - "$ref": "#/definitions/Correlation", - "description": "The run correlation." + "description": "The changed time." }, - "workflow": { - "$ref": "#/definitions/ResourceReference", - "readOnly": true, - "description": "Gets the reference to workflow version." + "metadata": { + "type": "object", + "description": "The metadata.", + "properties": {} }, - "trigger": { - "$ref": "#/definitions/WorkflowRunTrigger", - "readOnly": true, - "description": "Gets the fired trigger." + "content": { + "type": "string", + "description": "The content.", + "properties": {} }, - "outputs": { - "type": "object", - "readOnly": true, - "additionalProperties": { - "$ref": "#/definitions/WorkflowOutputParameter" - }, - "description": "Gets the outputs." + "contentType": { + "type": "string", + "description": "The content type." }, - "response": { - "$ref": "#/definitions/WorkflowRunTrigger", + "contentLink": { + "$ref": "#/definitions/ContentLink", "readOnly": true, - "description": "Gets the response of the flow run." - } - }, - "description": "The workflow run properties." - }, - "WorkflowRunFilter": { - "type": "object", - "properties": { - "status": { - "$ref": "#/definitions/WorkflowStatus", - "description": "The status of workflow run." + "description": "The content link." } }, - "description": "The workflow run filter." + "description": "The integration account schema properties." }, - "WorkflowRunListResult": { + "IntegrationAccountSchemaListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { - "$ref": "#/definitions/WorkflowRun" + "$ref": "#/definitions/IntegrationAccountSchema" }, - "description": "A list of workflow runs." + "description": "The list of integration account schemas." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, - "description": "The list of workflow runs." + "description": "The list of integration account schemas." }, - "WorkflowRunAction": { + "IntegrationAccountSchemaFilter": { + "type": "object", + "required": [ + "schemaType" + ], + "properties": { + "schemaType": { + "$ref": "#/definitions/SchemaType", + "description": "The schema type of integration account schema." + } + }, + "description": "The integration account schema filter for odata query." + }, + "SchemaType": { + "type": "string", + "enum": [ + "NotSpecified", + "Xml" + ], + "x-ms-enum": { + "name": "SchemaType", + "modelAsString": false + } + }, + "IntegrationAccountMap": { "type": "object", + "required": [ + "properties" + ], "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkflowRunActionProperties", - "description": "The workflow run action properties." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the workflow run action name." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the workflow run action type." + "$ref": "#/definitions/IntegrationAccountMapProperties", + "description": "The integration account map properties." } }, - "description": "The workflow run action.", + "description": "The integration account map.", "allOf": [ { - "$ref": "#/definitions/SubResource" + "$ref": "#/definitions/Resource" } ] }, - "WorkflowRunActionProperties": { + "IntegrationAccountMapProperties": { "type": "object", + "required": [ + "mapType" + ], "properties": { - "startTime": { + "mapType": { + "$ref": "#/definitions/MapType", + "description": "The map type." + }, + "parametersSchema": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The reference name." + } + }, + "description": "The parameters schema of integration account map." + }, + "createdTime": { "type": "string", "format": "date-time", "readOnly": true, - "description": "Gets the start time." + "description": "The created time." }, - "endTime": { + "changedTime": { "type": "string", "format": "date-time", "readOnly": true, - "description": "Gets the end time." - }, - "status": { - "$ref": "#/definitions/WorkflowStatus", - "readOnly": true, - "description": "Gets the status." + "description": "The changed time." }, - "code": { + "content": { "type": "string", - "readOnly": true, - "description": "Gets the code." - }, - "error": { - "$ref": "#/definitions/Object", - "readOnly": true, - "description": "Gets the error." + "description": "The content.", + "properties": {} }, - "trackingId": { + "contentType": { "type": "string", - "readOnly": true, - "description": "Gets the tracking id." - }, - "correlation": { - "$ref": "#/definitions/Correlation", - "description": "The correlation properties." - }, - "inputsLink": { - "$ref": "#/definitions/ContentLink", - "readOnly": true, - "description": "Gets the link to inputs." + "description": "The content type." }, - "outputsLink": { + "contentLink": { "$ref": "#/definitions/ContentLink", "readOnly": true, - "description": "Gets the link to outputs." - }, - "trackedProperties": { - "$ref": "#/definitions/Object", - "readOnly": true, - "description": "Gets the tracked properties." + "description": "The content link." }, - "retryHistory": { - "type": "array", - "items": { - "$ref": "#/definitions/RetryHistory" - }, - "description": "Gets the retry histories." - } - }, - "description": "The workflow run action properties." - }, - "WorkflowRunActionFilter": { - "type": "object", - "properties": { - "status": { - "$ref": "#/definitions/WorkflowStatus", - "description": "The status of workflow run action." + "metadata": { + "type": "object", + "description": "The metadata.", + "properties": {} } }, - "description": "The workflow run action filter." + "description": "The integration account map." }, - "WorkflowRunActionListResult": { + "IntegrationAccountMapListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { - "$ref": "#/definitions/WorkflowRunAction" + "$ref": "#/definitions/IntegrationAccountMap" }, - "description": "A list of workflow run actions." + "description": "The list of integration account maps." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, - "description": "The list of workflow run actions." + "description": "The list of integration account maps." }, - "SkuName": { - "type": "string", - "enum": [ - "NotSpecified", - "Free", - "Shared", - "Basic", - "Standard", - "Premium" + "IntegrationAccountMapFilter": { + "type": "object", + "required": [ + "mapType" ], - "x-ms-enum": { - "name": "SkuName", - "modelAsString": false + "properties": { + "mapType": { + "$ref": "#/definitions/MapType", + "description": "The map type of integration account map." + } }, - "description": "The sku name." - }, - "WorkflowState": { - "type": "string", - "enum": [ - "NotSpecified", - "Completed", - "Enabled", - "Disabled", - "Deleted", - "Suspended" - ], - "x-ms-enum": { - "name": "WorkflowState", - "modelAsString": false - } - }, - "WorkflowStatus": { - "type": "string", - "enum": [ - "NotSpecified", - "Paused", - "Running", - "Waiting", - "Succeeded", - "Skipped", - "Suspended", - "Cancelled", - "Failed", - "Faulted", - "TimedOut", - "Aborted", - "Ignored" - ], - "x-ms-enum": { - "name": "WorkflowStatus", - "modelAsString": false - } - }, - "ParameterType": { - "type": "string", - "enum": [ - "NotSpecified", - "String", - "SecureString", - "Int", - "Float", - "Bool", - "Array", - "Object", - "SecureObject" - ], - "x-ms-enum": { - "name": "ParameterType", - "modelAsString": false - } + "description": "The integration account map filter for odata query." }, - "KeyType": { + "MapType": { "type": "string", "enum": [ "NotSpecified", - "Primary", - "Secondary" + "Xslt" ], "x-ms-enum": { - "name": "KeyType", + "name": "MapType", "modelAsString": false } }, - "Sku": { + "IntegrationAccountSku": { "type": "object", "required": [ "name" ], "properties": { "name": { - "$ref": "#/definitions/SkuName", - "description": "The name." - }, - "plan": { - "$ref": "#/definitions/ResourceReference", - "description": "The reference to plan." + "$ref": "#/definitions/IntegrationAccountSkuName", + "description": "The sku name." } }, - "description": "The sku type." + "description": "The integration account sku." }, - "ContentLink": { + "IntegrationAccountPartnerListResult": { "type": "object", "properties": { - "uri": { - "type": "string", - "description": "The content link URI." + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationAccountPartner" + }, + "description": "The list of integration account partners." }, - "contentVersion": { + "nextLink": { "type": "string", - "description": "The content version." - }, - "contentSize": { - "type": "integer", - "format": "int64", - "description": "The content size." - }, - "contentHash": { - "$ref": "#/definitions/ContentHash", - "description": "The content hash." - }, - "metadata": { - "$ref": "#/definitions/Object", - "description": "The metadata." + "description": "The URL to get the next set of results." } }, - "description": "The content link." + "description": "The list of integration account partners." }, - "ContentHash": { + "IntegrationAccountPartnerFilter": { "type": "object", + "required": [ + "partnerType" + ], "properties": { - "algorithm": { - "type": "string", - "description": "The algorithm of the content hash." - }, - "value": { - "type": "string", - "description": "The value of the content hash." + "partnerType": { + "$ref": "#/definitions/PartnerType", + "description": "The partner type of integration account partner." } }, - "description": "The content hash." + "description": "The integration account partner filter for odata query." }, - "RegenerateActionParameter": { + "IntegrationAccountPartner": { "type": "object", + "required": [ + "properties" + ], "properties": { - "keyType": { - "$ref": "#/definitions/KeyType", - "description": "The key type." + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IntegrationAccountPartnerProperties", + "description": "The integration account partner properties." } }, - "description": "The access key regenerate action content." + "description": "The integration account partner.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] }, - "RetryHistory": { + "IntegrationAccountPartnerProperties": { "type": "object", + "required": [ + "partnerType", + "content" + ], "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "description": "Gets the start time." + "partnerType": { + "$ref": "#/definitions/PartnerType", + "description": "The partner type." }, - "endTime": { + "createdTime": { "type": "string", "format": "date-time", - "description": "Gets the end time." - }, - "code": { - "type": "string", - "description": "Gets the status code." - }, - "clientRequestId": { - "type": "string", - "description": "Gets the client request Id." - }, - "serviceRequestId": { - "type": "string", - "description": "Gets the service request Id." - }, - "error": { - "$ref": "#/definitions/ErrorResponse", - "description": "Gets the error response." - } - }, - "description": "The retry history." - }, - "Correlation": { - "type": "object", - "properties": { - "clientTrackingId": { - "type": "string", - "description": "The client tracking id." - } - }, - "description": "The correlation property." - }, - "WorkflowParameter": { - "type": "object", - "properties": { - "type": { - "$ref": "#/definitions/ParameterType", - "description": "The type." + "readOnly": true, + "description": "The created time." }, - "value": { - "$ref": "#/definitions/Object", - "description": "The value." + "changedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The changed time." }, "metadata": { - "$ref": "#/definitions/Object", - "description": "The metadata." + "type": "object", + "description": "The metadata.", + "properties": {} }, - "description": { - "type": "string", - "description": "The description." - } - }, - "description": "The workflow parameters." - }, - "WorkflowOutputParameter": { - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/Object", - "readOnly": true, - "description": "Gets the error." + "content": { + "$ref": "#/definitions/PartnerContent", + "description": "The partner content." } }, - "description": "The workflow output parameter.", - "allOf": [ - { - "$ref": "#/definitions/WorkflowParameter" - } - ] + "description": "The integration account partner properties." }, - "RecurrenceFrequency": { + "PartnerType": { "type": "string", "enum": [ "NotSpecified", - "Second", - "Minute", - "Hour", - "Day", - "Week", - "Month", - "Year" + "B2B" ], "x-ms-enum": { - "name": "RecurrenceFrequency", + "name": "PartnerType", "modelAsString": false } }, - "RecurrenceSchedule": { + "PartnerContent": { "type": "object", "properties": { - "minutes": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "The minutes." - }, - "hours": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "The hours." - }, - "weekDays": { + "b2b": { + "$ref": "#/definitions/B2BPartnerContent", + "description": "The B2B partner content." + } + }, + "description": "The integration account partner content." + }, + "B2BPartnerContent": { + "type": "object", + "properties": { + "businessIdentities": { "type": "array", "items": { - "type": "string", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" - ], - "x-ms-enum": { - "name": "DaysOfWeek", - "modelAsString": false - } + "$ref": "#/definitions/BusinessIdentity" }, - "description": "The days of the week." + "description": "The list of partner business identities." + } + }, + "description": "The B2B partner content." + }, + "BusinessIdentity": { + "type": "object", + "required": [ + "qualifier", + "value" + ], + "properties": { + "qualifier": { + "type": "string", + "description": "The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32" }, - "monthDays": { + "value": { + "type": "string", + "description": "The user defined business identity value." + } + }, + "description": "The integration account partner's business identity." + }, + "IntegrationAccountAgreementListResult": { + "type": "object", + "properties": { + "value": { "type": "array", "items": { - "type": "integer", - "format": "int32" + "$ref": "#/definitions/IntegrationAccountAgreement" }, - "description": "The month days." + "description": "The list of integration account agreements." }, - "monthlyOccurrences": { - "type": "array", - "items": { - "$ref": "#/definitions/RecurrenceScheduleOccurrence" - }, - "description": "The monthly occurrences." + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." } }, - "description": "The recurrence schedule." + "description": "The list of integration account agreements." }, - "RecurrenceScheduleOccurrence": { + "IntegrationAccountAgreementFilter": { "type": "object", + "required": [ + "agreementType" + ], "properties": { - "day": { - "$ref": "#/definitions/DayOfWeek", - "description": "The day of the week." - }, - "occurrence": { - "type": "integer", - "format": "int32", - "description": "The occurrence." + "agreementType": { + "$ref": "#/definitions/AgreementType", + "description": "The agreement type of integration account agreement." } }, - "description": "The recurrence schedule occurence." + "description": "The integration account agreement filter for odata query." }, - "WorkflowTriggerRecurrence": { + "IntegrationAccountAgreement": { "type": "object", + "required": [ + "properties" + ], "properties": { - "frequency": { - "$ref": "#/definitions/RecurrenceFrequency", - "description": "The frequency." - }, - "interval": { - "type": "integer", - "format": "int32", - "description": "The interval." - }, - "startTime": { - "type": "string", - "format": "date-time", - "description": "The start time." - }, - "endTime": { - "type": "string", - "format": "date-time", - "description": "The end time." - }, - "timeZone": { - "type": "string", - "description": "The time zone." - }, - "schedule": { - "$ref": "#/definitions/RecurrenceSchedule", - "description": "The recurrence schedule." + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IntegrationAccountAgreementProperties", + "description": "The integration account agreement properties." } }, - "description": "The workflow trigger recurrence." + "description": "The integration account agreement.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] }, - "WorkflowRunTrigger": { + "IntegrationAccountAgreementProperties": { "type": "object", + "required": [ + "hostPartner", + "guestPartner", + "hostIdentity", + "guestIdentity", + "agreementType", + "content" + ], "properties": { - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the name." - }, - "inputs": { - "$ref": "#/definitions/Object", - "readOnly": true, - "description": "Gets the inputs." - }, - "inputsLink": { - "$ref": "#/definitions/ContentLink", - "readOnly": true, - "description": "Gets the link to inputs." - }, - "outputs": { - "$ref": "#/definitions/Object", - "readOnly": true, - "description": "Gets the outputs." - }, - "outputsLink": { - "$ref": "#/definitions/ContentLink", - "readOnly": true, - "description": "Gets the link to outputs." - }, - "startTime": { + "createdTime": { "type": "string", "format": "date-time", "readOnly": true, - "description": "Gets the start time." + "description": "The created time." }, - "endTime": { + "changedTime": { "type": "string", "format": "date-time", "readOnly": true, - "description": "Gets the end time." + "description": "The changed time." }, - "trackingId": { - "type": "string", - "readOnly": true, - "description": "Gets the tracking id." + "metadata": { + "type": "object", + "description": "The metadata.", + "properties": {} }, - "correlation": { - "$ref": "#/definitions/Correlation", - "description": "The run correlation." + "agreementType": { + "$ref": "#/definitions/AgreementType", + "description": "The agreement type." + }, + "hostPartner": { + "type": "string", + "description": "The integration account partner that is set as host partner for this agreement." }, - "code": { + "guestPartner": { "type": "string", - "readOnly": true, - "description": "Gets the code." + "description": "The integration account partner that is set as guest partner for this agreement." }, - "status": { - "$ref": "#/definitions/WorkflowStatus", - "readOnly": true, - "description": "Gets the status." + "hostIdentity": { + "$ref": "#/definitions/BusinessIdentity", + "description": "The business identity of the host partner." }, - "error": { - "$ref": "#/definitions/Object", - "readOnly": true, - "description": "Gets the error." + "guestIdentity": { + "$ref": "#/definitions/BusinessIdentity", + "description": "The business identity of the guest partner." }, - "trackedProperties": { - "$ref": "#/definitions/Object", - "readOnly": true, - "description": "Gets the tracked properties." + "content": { + "$ref": "#/definitions/AgreementContent", + "description": "The agreement content." } }, - "description": "The workflow run trigger." - }, - "WorkflowTriggerProvisioningState": { - "type": "string", - "enum": [ - "NotSpecified", - "Accepted", - "Running", - "Ready", - "Creating", - "Created", - "Deleting", - "Deleted", - "Canceled", - "Failed", - "Succeeded", - "Moving", - "Updating", - "Registering", - "Registered", - "Unregistering", - "Unregistered", - "Completed" - ], - "x-ms-enum": { - "name": "WorkflowTriggerProvisioningState", - "modelAsString": false - } + "description": "The integration account agreement properties." }, - "WorkflowProvisioningState": { + "AgreementType": { "type": "string", "enum": [ "NotSpecified", - "Accepted", - "Running", - "Ready", - "Creating", - "Created", - "Deleting", - "Deleted", - "Canceled", - "Failed", - "Succeeded", - "Moving", - "Updating", - "Registering", - "Registered", - "Unregistering", - "Unregistered", - "Completed" - ], - "x-ms-enum": { - "name": "WorkflowProvisioningState", - "modelAsString": false - } - }, - "DayOfWeek": { - "type": "string", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" + "AS2", + "X12", + "Edifact" ], "x-ms-enum": { - "name": "DayOfWeek", + "name": "AgreementType", "modelAsString": false } }, - "GenerateUpgradedDefinitionParameters": { + "AgreementContent": { "type": "object", "properties": { - "targetSchemaVersion": { - "type": "string", - "description": "The target schema version." + "aS2": { + "$ref": "#/definitions/AS2AgreementContent", + "description": "The AS2 agreement content." + }, + "x12": { + "$ref": "#/definitions/X12AgreementContent", + "description": "The X12 agreement content." + }, + "edifact": { + "$ref": "#/definitions/EdifactAgreementContent", + "description": "The EDIFACT agreement content." } }, - "description": "The parameters to generate upgraded definition." - }, - "IntegrationAccountSkuName": { - "type": "string", - "enum": [ - "NotSpecified", - "Free", - "Standard" - ], - "x-ms-enum": { - "name": "IntegrationAccountSkuName", - "modelAsString": false - } + "description": "The integration account agreement content." }, - "IntegrationAccount": { + "AS2AgreementContent": { "type": "object", + "required": [ + "receiveAgreement", + "sendAgreement" + ], "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IntegrationAccountProperties", - "description": "The integration account properties." + "receiveAgreement": { + "$ref": "#/definitions/AS2OneWayAgreement", + "description": "The AS2 one-way receive agreement." }, - "sku": { - "$ref": "#/definitions/IntegrationAccountSku", - "description": "The sku." + "sendAgreement": { + "$ref": "#/definitions/AS2OneWayAgreement", + "description": "The AS2 one-way send agreement." } }, - "description": "The integration account.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "IntegrationAccountProperties": { - "type": "object", - "properties": {} + "description": "The integration account AS2 agreement content." }, - "IntegrationAccountListResult": { + "AS2OneWayAgreement": { "type": "object", + "required": [ + "senderBusinessIdentity", + "receiverBusinessIdentity", + "protocolSettings" + ], "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IntegrationAccount" - }, - "description": "The list of integration accounts." + "senderBusinessIdentity": { + "$ref": "#/definitions/BusinessIdentity", + "description": "The sender business identity" }, - "nextLink": { - "type": "string", - "description": "The URL to get the next set of results." + "receiverBusinessIdentity": { + "$ref": "#/definitions/BusinessIdentity", + "description": "The receiver business identity" + }, + "protocolSettings": { + "$ref": "#/definitions/AS2ProtocolSettings", + "description": "The AS2 protocol settings." } }, - "description": "The list of integration accounts." + "description": "The integration account AS2 one-way agreement." }, - "GetCallbackUrlParameters": { + "AS2ProtocolSettings": { "type": "object", + "required": [ + "messageConnectionSettings", + "acknowledgementConnectionSettings", + "mdnSettings", + "securitySettings", + "validationSettings", + "envelopeSettings", + "errorSettings" + ], "properties": { - "notAfter": { - "type": "string", - "format": "date-time", - "description": "The expiry time." + "messageConnectionSettings": { + "$ref": "#/definitions/AS2MessageConnectionSettings", + "description": "The message connection settings." }, - "keyType": { - "$ref": "#/definitions/KeyType", - "description": "The key type." + "acknowledgementConnectionSettings": { + "$ref": "#/definitions/AS2AcknowledgementConnectionSettings", + "description": "The acknowledgement connection settings." + }, + "mdnSettings": { + "$ref": "#/definitions/AS2MdnSettings", + "description": "The MDN settings." + }, + "securitySettings": { + "$ref": "#/definitions/AS2SecuritySettings", + "description": "The security settings." + }, + "validationSettings": { + "$ref": "#/definitions/AS2ValidationSettings", + "description": "The validation settings." + }, + "envelopeSettings": { + "$ref": "#/definitions/AS2EnvelopeSettings", + "description": "The envelope settings." + }, + "errorSettings": { + "$ref": "#/definitions/AS2ErrorSettings", + "description": "The error settings." } }, - "description": "The callback url parameters." + "description": "The AS2 agreement protocol settings." }, - "CallbackUrl": { + "AS2AcknowledgementConnectionSettings": { "type": "object", + "required": [ + "ignoreCertificateNameMismatch", + "supportHttpStatusCodeContinue", + "keepHttpConnectionAlive", + "unfoldHttpHeaders" + ], "properties": { - "value": { - "type": "string", - "description": "The URL value." + "ignoreCertificateNameMismatch": { + "type": "boolean", + "description": "The value indicating whether to ignore mismatch in certificate name." + }, + "supportHttpStatusCodeContinue": { + "type": "boolean", + "description": "The value indicating whether to support HTTP status code 'CONTINUE'." + }, + "keepHttpConnectionAlive": { + "type": "boolean", + "description": "The value indicating whether to keep the connection alive." + }, + "unfoldHttpHeaders": { + "type": "boolean", + "description": "The value indicating whether to unfold the HTTP headers." } }, - "description": "The callback url." + "description": "The AS2 agreement acknowledgement connection settings." }, - "IntegrationAccountSchema": { + "AS2MessageConnectionSettings": { "type": "object", "required": [ - "properties" + "ignoreCertificateNameMismatch", + "supportHttpStatusCodeContinue", + "keepHttpConnectionAlive", + "unfoldHttpHeaders" ], "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IntegrationAccountSchemaProperties", - "description": "The integration account schema properties." + "ignoreCertificateNameMismatch": { + "type": "boolean", + "description": "The value indicating whether to ignore mismatch in certificate name." + }, + "supportHttpStatusCodeContinue": { + "type": "boolean", + "description": "The value indicating whether to support HTTP status code 'CONTINUE'." + }, + "keepHttpConnectionAlive": { + "type": "boolean", + "description": "The value indicating whether to keep the connection alive." + }, + "unfoldHttpHeaders": { + "type": "boolean", + "description": "The value indicating whether to unfold the HTTP headers." } }, - "description": "The integration account schema.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] + "description": "The AS2 agreement message connection settings." }, - "IntegrationAccountSchemaProperties": { + "AS2MdnSettings": { "type": "object", "required": [ - "schemaType" + "needMdn", + "signMdn", + "sendMdnAsynchronously", + "signOutboundMdnIfOptional", + "sendInboundMdnToMessageBox", + "micHashingAlgorithm" ], "properties": { - "schemaType": { - "$ref": "#/definitions/SchemaType", - "description": "The schema type." - }, - "targetNamespace": { - "type": "string", - "description": "The target namespace of the schema." + "needMdn": { + "type": "boolean", + "description": "The value indicating whether to send or request a MDN." }, - "documentName": { - "type": "string", - "description": "The document name." + "signMdn": { + "type": "boolean", + "description": "The value indicating whether the MDN needs to be signed or not." }, - "fileName": { - "type": "string", - "description": "The file name." + "sendMdnAsynchronously": { + "type": "boolean", + "description": "The value indicating whether to send the asynchronous MDN." }, - "createdTime": { + "receiptDeliveryUrl": { "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The created time." + "description": "The receipt delivery URL." }, - "changedTime": { + "dispositionNotificationTo": { "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The changed time." - }, - "metadata": { - "type": "object", - "description": "The metadata.", - "properties": {} + "description": "The disposition notification to header value." }, - "content": { - "type": "string", - "description": "The content.", - "properties": {} + "signOutboundMdnIfOptional": { + "type": "boolean", + "description": "The value indicating whether to sign the outbound MDN if optional." }, - "contentType": { + "mdnText": { "type": "string", - "description": "The content type." + "description": "The MDN text." }, - "contentLink": { - "$ref": "#/definitions/ContentLink", - "readOnly": true, - "description": "The content link." - } - }, - "description": "The integration account schema properties." - }, - "IntegrationAccountSchemaListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IntegrationAccountSchema" - }, - "description": "The list of integration account schemas." + "sendInboundMdnToMessageBox": { + "type": "boolean", + "description": "The value indicating whether to send inbound MDN to message box." }, - "nextLink": { - "type": "string", - "description": "The URL to get the next set of results." - } - }, - "description": "The list of integration account schemas." - }, - "IntegrationAccountSchemaFilter": { - "type": "object", - "required": [ - "schemaType" - ], - "properties": { - "schemaType": { - "$ref": "#/definitions/SchemaType", - "description": "The schema type of integration account schema." + "micHashingAlgorithm": { + "$ref": "#/definitions/HashingAlgorithm", + "description": "The signing or hashing algorithm." } }, - "description": "The integration account schema filter for odata query." - }, - "SchemaType": { - "type": "string", - "enum": [ - "NotSpecified", - "Xml" - ], - "x-ms-enum": { - "name": "SchemaType", - "modelAsString": false - } + "description": "The AS2 agreement mdn settings." }, - "IntegrationAccountMap": { + "AS2SecuritySettings": { "type": "object", "required": [ - "properties" + "overrideGroupSigningCertificate", + "enableNrrForInboundEncodedMessages", + "enableNrrForInboundDecodedMessages", + "enableNrrForOutboundMdn", + "enableNrrForOutboundEncodedMessages", + "enableNrrForOutboundDecodedMessages", + "enableNrrForInboundMdn" ], "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IntegrationAccountMapProperties", - "description": "The integration account map properties." + "overrideGroupSigningCertificate": { + "type": "boolean", + "description": "The value indicating whether to send or request a MDN." + }, + "signingCertificateName": { + "type": "string", + "description": "The name of the signing certificate." + }, + "encryptionCertificateName": { + "type": "string", + "description": "The name of the encryption certificate." + }, + "enableNrrForInboundEncodedMessages": { + "type": "boolean", + "description": "The value indicating whether to enable NRR for inbound encoded messages." + }, + "enableNrrForInboundDecodedMessages": { + "type": "boolean", + "description": "The value indicating whether to enable NRR for inbound decoded messages." + }, + "enableNrrForOutboundMdn": { + "type": "boolean", + "description": "The value indicating whether to enable NRR for outbound MDN." + }, + "enableNrrForOutboundEncodedMessages": { + "type": "boolean", + "description": "The value indicating whether to enable NRR for outbound encoded messages." + }, + "enableNrrForOutboundDecodedMessages": { + "type": "boolean", + "description": "The value indicating whether to enable NRR for outbound decoded messages." + }, + "enableNrrForInboundMdn": { + "type": "boolean", + "description": "The value indicating whether to enable NRR for inbound MDN." + }, + "sha2AlgorithmFormat": { + "type": "string", + "description": "The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize." } }, - "description": "The integration account map.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] + "description": "The AS2 agreement security settings." }, - "IntegrationAccountMapProperties": { + "AS2ValidationSettings": { "type": "object", "required": [ - "mapType" + "overrideMessageProperties", + "encryptMessage", + "signMessage", + "compressMessage", + "checkDuplicateMessage", + "interchangeDuplicatesValidityDays", + "checkCertificateRevocationListOnSend", + "checkCertificateRevocationListOnReceive", + "encryptionAlgorithm" ], "properties": { - "mapType": { - "$ref": "#/definitions/MapType", - "description": "The map type." + "overrideMessageProperties": { + "type": "boolean", + "description": "The value indicating whether to override incoming message properties with those in agreement." }, - "parametersSchema": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The reference name." - } - }, - "description": "The parameters schema of integration account map." + "encryptMessage": { + "type": "boolean", + "description": "The value indicating whether the message has to be encrypted." }, - "createdTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The created time." + "signMessage": { + "type": "boolean", + "description": "The value indicating whether the message has to be signed." }, - "changedTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The changed time." + "compressMessage": { + "type": "boolean", + "description": "The value indicating whether the message has to be compressed." }, - "content": { - "type": "string", - "description": "The content.", - "properties": {} + "checkDuplicateMessage": { + "type": "boolean", + "description": "The value indicating whether to check for duplicate message." }, - "contentType": { - "type": "string", - "description": "The content type." + "interchangeDuplicatesValidityDays": { + "type": "integer", + "format": "int32", + "description": "The number of days to look back for duplicate interchange." }, - "contentLink": { - "$ref": "#/definitions/ContentLink", - "readOnly": true, - "description": "The content link." + "checkCertificateRevocationListOnSend": { + "type": "boolean", + "description": "The value indicating whether to check for certificate revocation list on send." }, - "metadata": { - "type": "object", - "description": "The metadata.", - "properties": {} - } - }, - "description": "The integration account map." - }, - "IntegrationAccountMapListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IntegrationAccountMap" - }, - "description": "The list of integration account maps." + "checkCertificateRevocationListOnReceive": { + "type": "boolean", + "description": "The value indicating whether to check for certificate revocation list on receive." }, - "nextLink": { - "type": "string", - "description": "The URL to get the next set of results." + "encryptionAlgorithm": { + "$ref": "#/definitions/EncryptionAlgorithm", + "description": "The encryption algorithm." + }, + "signingAlgorithm": { + "$ref": "#/definitions/SigningAlgorithm", + "description": "The signing algorithm." } }, - "description": "The list of integration account maps." + "description": "The AS2 agreement validation settings." }, - "IntegrationAccountMapFilter": { + "AS2EnvelopeSettings": { "type": "object", "required": [ - "mapType" + "messageContentType", + "transmitFileNameInMimeHeader", + "fileNameTemplate", + "suspendMessageOnFileNameGenerationError", + "autogenerateFileName" ], "properties": { - "mapType": { - "$ref": "#/definitions/MapType", - "description": "The map type of integration account map." + "messageContentType": { + "type": "string", + "description": "The message content type." + }, + "transmitFileNameInMimeHeader": { + "type": "boolean", + "description": "The value indicating whether to transmit file name in mime header." + }, + "fileNameTemplate": { + "type": "string", + "description": "The template for file name." + }, + "suspendMessageOnFileNameGenerationError": { + "type": "boolean", + "description": "The value indicating whether to suspend message on file name generation error." + }, + "autogenerateFileName": { + "type": "boolean", + "description": "The value indicating whether to auto generate file name." } }, - "description": "The integration account map filter for odata query." - }, - "MapType": { - "type": "string", - "enum": [ - "NotSpecified", - "Xslt" - ], - "x-ms-enum": { - "name": "MapType", - "modelAsString": false - } + "description": "The AS2 agreement envelope settings." }, - "IntegrationAccountSku": { + "AS2ErrorSettings": { "type": "object", "required": [ - "name" + "suspendDuplicateMessage", + "resendIfMdnNotReceived" ], "properties": { - "name": { - "$ref": "#/definitions/IntegrationAccountSkuName", - "description": "The sku name." - } - }, - "description": "The integration account sku." - }, - "IntegrationAccountPartnerListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IntegrationAccountPartner" - }, - "description": "The list of integration account partners." + "suspendDuplicateMessage": { + "type": "boolean", + "description": "The value indicating whether to suspend duplicate message." }, - "nextLink": { - "type": "string", - "description": "The URL to get the next set of results." + "resendIfMdnNotReceived": { + "type": "boolean", + "description": "The value indicating whether to resend message If MDN is not received." } }, - "description": "The list of integration account partners." + "description": "The AS2 agreement error settings." }, - "IntegrationAccountPartnerFilter": { + "X12AgreementContent": { "type": "object", "required": [ - "partnerType" + "receiveAgreement", + "sendAgreement" ], "properties": { - "partnerType": { - "$ref": "#/definitions/PartnerType", - "description": "The partner type of integration account partner." + "receiveAgreement": { + "$ref": "#/definitions/X12OneWayAgreement", + "description": "The X12 one-way receive agreement." + }, + "sendAgreement": { + "$ref": "#/definitions/X12OneWayAgreement", + "description": "The X12 one-way send agreement." } }, - "description": "The integration account partner filter for odata query." + "description": "The X12 agreement content." }, - "IntegrationAccountPartner": { + "X12OneWayAgreement": { "type": "object", "required": [ - "properties" + "senderBusinessIdentity", + "receiverBusinessIdentity", + "protocolSettings" ], "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IntegrationAccountPartnerProperties", - "description": "The integration account partner properties." + "senderBusinessIdentity": { + "$ref": "#/definitions/BusinessIdentity", + "description": "The sender business identity" + }, + "receiverBusinessIdentity": { + "$ref": "#/definitions/BusinessIdentity", + "description": "The receiver business identity" + }, + "protocolSettings": { + "$ref": "#/definitions/X12ProtocolSettings", + "description": "The X12 protocol settings." } }, - "description": "The integration account partner.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] + "description": "The X12 one-way agreement." }, - "IntegrationAccountPartnerProperties": { + "X12ProtocolSettings": { "type": "object", "required": [ - "partnerType", - "content" + "validationSettings", + "framingSettings", + "envelopeSettings", + "acknowledgementSettings", + "messageFilter", + "securitySettings", + "processingSettings", + "schemaReferences" ], "properties": { - "partnerType": { - "$ref": "#/definitions/PartnerType", - "description": "The partner type." + "validationSettings": { + "$ref": "#/definitions/X12ValidationSettings", + "description": "The X12 validation settings." }, - "createdTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The created time." + "framingSettings": { + "$ref": "#/definitions/X12FramingSettings", + "description": "The X12 framing settings." }, - "changedTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The changed time." + "envelopeSettings": { + "$ref": "#/definitions/X12EnvelopeSettings", + "description": "The X12 envelope settings." }, - "metadata": { - "type": "object", - "description": "The metadata.", - "properties": {} + "acknowledgementSettings": { + "$ref": "#/definitions/X12AcknowledgementSettings", + "description": "The X12 acknowledgment settings." }, - "content": { - "$ref": "#/definitions/PartnerContent", - "description": "The partner content." - } - }, - "description": "The integration account partner properties." - }, - "PartnerType": { - "type": "string", - "enum": [ - "NotSpecified", - "B2B" - ], - "x-ms-enum": { - "name": "PartnerType", - "modelAsString": false - } - }, - "PartnerContent": { - "type": "object", - "properties": { - "b2b": { - "$ref": "#/definitions/B2BPartnerContent", - "description": "The B2B partner content." - } - }, - "description": "The integration account partner content." - }, - "B2BPartnerContent": { - "type": "object", - "properties": { - "businessIdentities": { + "messageFilter": { + "$ref": "#/definitions/X12MessageFilter", + "description": "The X12 message filter." + }, + "securitySettings": { + "$ref": "#/definitions/X12SecuritySettings", + "description": "The X12 security settings." + }, + "processingSettings": { + "$ref": "#/definitions/X12ProcessingSettings", + "description": "The X12 processing settings." + }, + "envelopeOverrides": { + "type": "array", + "items": { + "$ref": "#/definitions/X12EnvelopeOverride" + }, + "description": "The X12 envelope override settings." + }, + "validationOverrides": { "type": "array", "items": { - "$ref": "#/definitions/BusinessIdentity" + "$ref": "#/definitions/X12ValidationOverride" }, - "description": "The list of partner business identities." - } - }, - "description": "The B2B partner content." - }, - "BusinessIdentity": { - "type": "object", - "required": [ - "qualifier", - "value" - ], - "properties": { - "qualifier": { - "type": "string", - "description": "The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32" + "description": "The X12 validation override settings." }, - "value": { - "type": "string", - "description": "The user defined business identity value." - } - }, - "description": "The integration account partner's business identity." - }, - "IntegrationAccountAgreementListResult": { - "type": "object", - "properties": { - "value": { + "messageFilterList": { "type": "array", "items": { - "$ref": "#/definitions/IntegrationAccountAgreement" + "$ref": "#/definitions/X12MessageIdentifier" }, - "description": "The list of integration account agreements." + "description": "The X12 message filter list." }, - "nextLink": { - "type": "string", - "description": "The URL to get the next set of results." + "schemaReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/X12SchemaReference" + }, + "description": "The X12 schema references." + }, + "x12DelimiterOverrides": { + "type": "array", + "items": { + "$ref": "#/definitions/X12DelimiterOverrides" + }, + "description": "The X12 delimiter override settings." } }, - "description": "The list of integration account agreements." + "description": "The X12 agreement protocol settings." }, - "IntegrationAccountAgreementFilter": { + "X12ValidationSettings": { "type": "object", "required": [ - "agreementType" + "validateCharacterSet", + "checkDuplicateInterchangeControlNumber", + "interchangeControlNumberValidityDays", + "checkDuplicateGroupControlNumber", + "checkDuplicateTransactionSetControlNumber", + "validateEdiTypes", + "validateXsdTypes", + "allowLeadingAndTrailingSpacesAndZeroes", + "trimLeadingAndTrailingSpacesAndZeroes", + "trailingSeparatorPolicy" ], "properties": { - "agreementType": { - "$ref": "#/definitions/AgreementType", - "description": "The agreement type of integration account agreement." + "validateCharacterSet": { + "type": "boolean", + "description": "The value indicating whether to validate character set in the message." + }, + "checkDuplicateInterchangeControlNumber": { + "type": "boolean", + "description": "The value indicating whether to check for duplicate interchange control number." + }, + "interchangeControlNumberValidityDays": { + "type": "integer", + "format": "int32", + "description": "The validity period of interchange control number." + }, + "checkDuplicateGroupControlNumber": { + "type": "boolean", + "description": "The value indicating whether to check for duplicate group control number." + }, + "checkDuplicateTransactionSetControlNumber": { + "type": "boolean", + "description": "The value indicating whether to check for duplicate transaction set control number." + }, + "validateEdiTypes": { + "type": "boolean", + "description": "The value indicating whether to Whether to validate EDI types." + }, + "validateXsdTypes": { + "type": "boolean", + "description": "The value indicating whether to Whether to validate XSD types." + }, + "allowLeadingAndTrailingSpacesAndZeroes": { + "type": "boolean", + "description": "The value indicating whether to allow leading and trailing spaces and zeroes." + }, + "trimLeadingAndTrailingSpacesAndZeroes": { + "type": "boolean", + "description": "The value indicating whether to trim leading and trailing spaces and zeroes." + }, + "trailingSeparatorPolicy": { + "$ref": "#/definitions/TrailingSeparatorPolicy", + "description": "The trailing separator policy." } }, - "description": "The integration account agreement filter for odata query." + "description": "The X12 agreement validation settings." }, - "IntegrationAccountAgreement": { + "X12FramingSettings": { "type": "object", "required": [ - "properties" + "dataElementSeparator", + "componentSeparator", + "replaceSeparatorsInPayload", + "replaceCharacter", + "segmentTerminator", + "characterSet", + "segmentTerminatorSuffix" ], "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IntegrationAccountAgreementProperties", - "description": "The integration account agreement properties." + "dataElementSeparator": { + "type": "integer", + "format": "int32", + "description": "The data element separator." + }, + "componentSeparator": { + "type": "integer", + "format": "int32", + "description": "The component separator." + }, + "replaceSeparatorsInPayload": { + "type": "boolean", + "description": "The value indicating whether to replace separators in payload." + }, + "replaceCharacter": { + "type": "integer", + "format": "int32", + "description": "The replacement character." + }, + "segmentTerminator": { + "type": "integer", + "format": "int32", + "description": "The segment terminator." + }, + "characterSet": { + "$ref": "#/definitions/X12CharacterSet", + "description": "The X12 character set." + }, + "segmentTerminatorSuffix": { + "$ref": "#/definitions/SegmentTerminatorSuffix", + "description": "The segment terminator suffix." } }, - "description": "The integration account agreement.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] + "description": "The X12 agreement framing settings." }, - "IntegrationAccountAgreementProperties": { + "X12EnvelopeSettings": { "type": "object", "required": [ - "hostPartner", - "guestPartner", - "hostIdentity", - "guestIdentity", - "agreementType", - "content" + "controlStandardsId", + "useControlStandardsIdAsRepetitionCharacter", + "senderApplicationId", + "receiverApplicationId", + "controlVersionNumber", + "interchangeControlNumberLowerBound", + "interchangeControlNumberUpperBound", + "rolloverInterchangeControlNumber", + "enableDefaultGroupHeaders", + "groupControlNumberLowerBound", + "groupControlNumberUpperBound", + "rolloverGroupControlNumber", + "groupHeaderAgencyCode", + "groupHeaderVersion", + "transactionSetControlNumberLowerBound", + "transactionSetControlNumberUpperBound", + "rolloverTransactionSetControlNumber", + "overwriteExistingTransactionSetControlNumber", + "groupHeaderDateFormat", + "groupHeaderTimeFormat", + "usageIndicator" ], "properties": { - "createdTime": { + "controlStandardsId": { + "type": "integer", + "format": "int32", + "description": "The controls standards id." + }, + "useControlStandardsIdAsRepetitionCharacter": { + "type": "boolean", + "description": "The value indicating whether to use control standards id as repetition character." + }, + "senderApplicationId": { "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The created time." + "description": "The sender application id." + }, + "receiverApplicationId": { + "type": "string", + "description": "The receiver application id." + }, + "controlVersionNumber": { + "type": "string", + "description": "The control version number." + }, + "interchangeControlNumberLowerBound": { + "type": "integer", + "format": "int32", + "description": "The interchange control number lower bound." + }, + "interchangeControlNumberUpperBound": { + "type": "integer", + "format": "int32", + "description": "The interchange control number upper bound." + }, + "rolloverInterchangeControlNumber": { + "type": "boolean", + "description": "The value indicating whether to rollover interchange control number." + }, + "enableDefaultGroupHeaders": { + "type": "boolean", + "description": "The value indicating whether to enable default group headers." + }, + "functionalGroupId": { + "type": "string", + "description": "The functional group id." + }, + "groupControlNumberLowerBound": { + "type": "integer", + "format": "int32", + "description": "The group control number lower bound." + }, + "groupControlNumberUpperBound": { + "type": "integer", + "format": "int32", + "description": "The group control number upper bound." + }, + "rolloverGroupControlNumber": { + "type": "boolean", + "description": "The value indicating whether to rollover group control number." + }, + "groupHeaderAgencyCode": { + "type": "string", + "description": "The group header agency code." }, - "changedTime": { + "groupHeaderVersion": { "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The changed time." + "description": "The group header version." }, - "metadata": { - "type": "object", - "description": "The metadata.", - "properties": {} + "transactionSetControlNumberLowerBound": { + "type": "integer", + "format": "int32", + "description": "The transaction set control number lower bound." }, - "agreementType": { - "$ref": "#/definitions/AgreementType", - "description": "The agreement type." + "transactionSetControlNumberUpperBound": { + "type": "integer", + "format": "int32", + "description": "The transaction set control number upper bound." }, - "hostPartner": { - "type": "string", - "description": "The integration account partner that is set as host partner for this agreement." + "rolloverTransactionSetControlNumber": { + "type": "boolean", + "description": "The value indicating whether to rollover transaction set control number." }, - "guestPartner": { + "transactionSetControlNumberPrefix": { "type": "string", - "description": "The integration account partner that is set as guest partner for this agreement." + "description": "The transaction set control number prefix." }, - "hostIdentity": { - "$ref": "#/definitions/BusinessIdentity", - "description": "The business identity of the host partner." + "transactionSetControlNumberSuffix": { + "type": "string", + "description": "The transaction set control number suffix." }, - "guestIdentity": { - "$ref": "#/definitions/BusinessIdentity", - "description": "The business identity of the guest partner." + "overwriteExistingTransactionSetControlNumber": { + "type": "boolean", + "description": "The value indicating whether to overwrite existing transaction set control number." }, - "content": { - "$ref": "#/definitions/AgreementContent", - "description": "The agreement content." - } - }, - "description": "The integration account agreement properties." - }, - "AgreementType": { - "type": "string", - "enum": [ - "NotSpecified", - "AS2", - "X12", - "Edifact" - ], - "x-ms-enum": { - "name": "AgreementType", - "modelAsString": false - } - }, - "AgreementContent": { - "type": "object", - "properties": { - "aS2": { - "$ref": "#/definitions/AS2AgreementContent", - "description": "The AS2 agreement content." + "groupHeaderDateFormat": { + "$ref": "#/definitions/X12DateFormat", + "description": "The group header date format." }, - "x12": { - "$ref": "#/definitions/X12AgreementContent", - "description": "The X12 agreement content." + "groupHeaderTimeFormat": { + "$ref": "#/definitions/X12TimeFormat", + "description": "The group header time format." }, - "edifact": { - "$ref": "#/definitions/EdifactAgreementContent", - "description": "The EDIFACT agreement content." + "usageIndicator": { + "$ref": "#/definitions/UsageIndicator", + "description": "The usage indicator." } }, - "description": "The integration account agreement content." + "description": "The X12 agreement envelope settings." }, - "AS2AgreementContent": { + "X12AcknowledgementSettings": { "type": "object", "required": [ - "receiveAgreement", - "sendAgreement" + "needTechnicalAcknowledgement", + "batchTechnicalAcknowledgements", + "needFunctionalAcknowledgement", + "batchFunctionalAcknowledgements", + "needImplementationAcknowledgement", + "batchImplementationAcknowledgements", + "needLoopForValidMessages", + "sendSynchronousAcknowledgement", + "acknowledgementControlNumberLowerBound", + "acknowledgementControlNumberUpperBound", + "rolloverAcknowledgementControlNumber" ], "properties": { - "receiveAgreement": { - "$ref": "#/definitions/AS2OneWayAgreement", - "description": "The AS2 one-way receive agreement." + "needTechnicalAcknowledgement": { + "type": "boolean", + "description": "The value indicating whether technical acknowledgement is needed." }, - "sendAgreement": { - "$ref": "#/definitions/AS2OneWayAgreement", - "description": "The AS2 one-way send agreement." - } - }, - "description": "The integration account AS2 agreement content." - }, - "AS2OneWayAgreement": { - "type": "object", - "required": [ - "senderBusinessIdentity", - "receiverBusinessIdentity", - "protocolSettings" - ], - "properties": { - "senderBusinessIdentity": { - "$ref": "#/definitions/BusinessIdentity", - "description": "The sender business identity" + "batchTechnicalAcknowledgements": { + "type": "boolean", + "description": "The value indicating whether to batch the technical acknowledgements." }, - "receiverBusinessIdentity": { - "$ref": "#/definitions/BusinessIdentity", - "description": "The receiver business identity" + "needFunctionalAcknowledgement": { + "type": "boolean", + "description": "The value indicating whether functional acknowledgement is needed." }, - "protocolSettings": { - "$ref": "#/definitions/AS2ProtocolSettings", - "description": "The AS2 protocol settings." + "functionalAcknowledgementVersion": { + "type": "string", + "description": "The functional acknowledgement version." + }, + "batchFunctionalAcknowledgements": { + "type": "boolean", + "description": "The value indicating whether to batch functional acknowledgements." + }, + "needImplementationAcknowledgement": { + "type": "boolean", + "description": "The value indicating whether implementation acknowledgement is needed." + }, + "implementationAcknowledgementVersion": { + "type": "string", + "description": "The implementation acknowledgement version." + }, + "batchImplementationAcknowledgements": { + "type": "boolean", + "description": "The value indicating whether to batch implementation acknowledgements." + }, + "needLoopForValidMessages": { + "type": "boolean", + "description": "The value indicating whether a loop is needed for valid messages." + }, + "sendSynchronousAcknowledgement": { + "type": "boolean", + "description": "The value indicating whether to send synchronous acknowledgement." + }, + "acknowledgementControlNumberPrefix": { + "type": "string", + "description": "The acknowledgement control number prefix." + }, + "acknowledgementControlNumberSuffix": { + "type": "string", + "description": "The acknowledgement control number suffix." + }, + "acknowledgementControlNumberLowerBound": { + "type": "integer", + "format": "int32", + "description": "The acknowledgement control number lower bound." + }, + "acknowledgementControlNumberUpperBound": { + "type": "integer", + "format": "int32", + "description": "The acknowledgement control number upper bound." + }, + "rolloverAcknowledgementControlNumber": { + "type": "boolean", + "description": "The value indicating whether to rollover acknowledgement control number." } }, - "description": "The integration account AS2 oneway agreement." + "description": "The X12 agreement acknowledgement settings." }, - "AS2ProtocolSettings": { + "X12MessageFilter": { "type": "object", "required": [ - "messageConnectionSettings", - "acknowledgementConnectionSettings", - "mdnSettings", - "securitySettings", - "validationSettings", - "envelopeSettings", - "errorSettings" + "messageFilterType" ], "properties": { - "messageConnectionSettings": { - "$ref": "#/definitions/AS2MessageConnectionSettings", - "description": "The message connection settings." - }, - "acknowledgementConnectionSettings": { - "$ref": "#/definitions/AS2AcknowledgementConnectionSettings", - "description": "The acknowledgement connection settings." - }, - "mdnSettings": { - "$ref": "#/definitions/AS2MdnSettings", - "description": "The MDN settings." - }, - "securitySettings": { - "$ref": "#/definitions/AS2SecuritySettings", - "description": "The security settings." - }, - "validationSettings": { - "$ref": "#/definitions/AS2ValidationSettings", - "description": "The validation settings." - }, - "envelopeSettings": { - "$ref": "#/definitions/AS2EnvelopeSettings", - "description": "The envelope settings." - }, - "errorSettings": { - "$ref": "#/definitions/AS2ErrorSettings", - "description": "The error settings." + "messageFilterType": { + "$ref": "#/definitions/MessageFilterType", + "description": "The message filter type." } }, - "description": "The AS2 agreement protocol settings." + "description": "The X12 message filter for odata query." }, - "AS2AcknowledgementConnectionSettings": { + "X12SecuritySettings": { "type": "object", "required": [ - "ignoreCertificateNameMismatch", - "supportHttpStatusCodeContinue", - "keepHttpConnectionAlive", - "unfoldHttpHeaders" + "authorizationQualifier", + "securityQualifier" ], "properties": { - "ignoreCertificateNameMismatch": { - "type": "boolean", - "description": "The value indicating whether to ignore mismatch in certificate name." + "authorizationQualifier": { + "type": "string", + "description": "The authorization qualifier." }, - "supportHttpStatusCodeContinue": { - "type": "boolean", - "description": "The value indicating whether to support HTTP status code 'CONTINUE'." + "authorizationValue": { + "type": "string", + "description": "The authorization value." }, - "keepHttpConnectionAlive": { - "type": "boolean", - "description": "The value indicating whether to keep the connection alive." + "securityQualifier": { + "type": "string", + "description": "The security qualifier." }, - "unfoldHttpHeaders": { - "type": "boolean", - "description": "The value indicating whether to unfold the HTTP headers." + "passwordValue": { + "type": "string", + "description": "The password value." } }, - "description": "The AS2 agreement acknowledegment connection settings." + "description": "The X12 agreement security settings." }, - "AS2MessageConnectionSettings": { + "X12ProcessingSettings": { "type": "object", "required": [ - "ignoreCertificateNameMismatch", - "supportHttpStatusCodeContinue", - "keepHttpConnectionAlive", - "unfoldHttpHeaders" + "maskSecurityInfo", + "convertImpliedDecimal", + "preserveInterchange", + "suspendInterchangeOnError", + "createEmptyXmlTagsForTrailingSeparators", + "useDotAsDecimalSeparator" ], "properties": { - "ignoreCertificateNameMismatch": { + "maskSecurityInfo": { "type": "boolean", - "description": "The value indicating whether to ignore mismatch in certificate name." + "description": "The value indicating whether to mask security information." }, - "supportHttpStatusCodeContinue": { + "convertImpliedDecimal": { "type": "boolean", - "description": "The value indicating whether to support HTTP status code 'CONTINUE'." + "description": "The value indicating whether to convert numerical type to implied decimal." }, - "keepHttpConnectionAlive": { + "preserveInterchange": { "type": "boolean", - "description": "The value indicating whether to keep the connection alive." + "description": "The value indicating whether to preserve interchange." }, - "unfoldHttpHeaders": { + "suspendInterchangeOnError": { "type": "boolean", - "description": "The value indicating whether to unfold the HTTP headers." + "description": "The value indicating whether to suspend interchange on error." + }, + "createEmptyXmlTagsForTrailingSeparators": { + "type": "boolean", + "description": "The value indicating whether to create empty xml tags for trailing separators." + }, + "useDotAsDecimalSeparator": { + "type": "boolean", + "description": "The value indicating whether to use dot as decimal separator." } }, - "description": "The AS2 agreement message connection settings." + "description": "The X12 processing settings." }, - "AS2MdnSettings": { + "X12EnvelopeOverride": { "type": "object", "required": [ - "needMdn", - "signMdn", - "sendMdnAsynchronously", - "signOutboundMdnIfOptional", - "sendInboundMdnToMessageBox", - "micHashingAlgorithm" + "targetNamespace", + "protocolVersion", + "messageId", + "responsibleAgencyCode", + "headerVersion", + "senderApplicationId", + "receiverApplicationId", + "dateFormat", + "timeFormat" ], "properties": { - "needMdn": { - "type": "boolean", - "description": "The value indicating whether to send or request a MDN." + "targetNamespace": { + "type": "string", + "description": "The target namespace on which this envelope settings has to be applied." }, - "signMdn": { - "type": "boolean", - "description": "The value indicating whether the MDN needs to be signed or not." + "protocolVersion": { + "type": "string", + "description": "The protocol version on which this envelope settings has to be applied." }, - "sendMdnAsynchronously": { - "type": "boolean", - "description": "The value indicating whether to send the asynchronous MDN." + "messageId": { + "type": "string", + "description": "The message id on which this envelope settings has to be applied." }, - "receiptDeliveryUrl": { + "responsibleAgencyCode": { "type": "string", - "description": "The receipt delivery URL." + "description": "The responsible agency code." }, - "dispositionNotificationTo": { + "headerVersion": { "type": "string", - "description": "The disposition notification to header value." + "description": "The header version." }, - "signOutboundMdnIfOptional": { - "type": "boolean", - "description": "The value indicating whether to sign the outbound MDN if optional." + "senderApplicationId": { + "type": "string", + "description": "The sender application id." }, - "mdnText": { + "receiverApplicationId": { "type": "string", - "description": "The MDN text." + "description": "The receiver application id." }, - "sendInboundMdnToMessageBox": { - "type": "boolean", - "description": "The value indicating whether to send inbound MDN to message box." + "functionalIdentifierCode": { + "type": "string", + "description": "The functional identifier code." }, - "micHashingAlgorithm": { - "$ref": "#/definitions/HashingAlgorithm", - "description": "The signing or hashing algorithm." + "dateFormat": { + "$ref": "#/definitions/X12DateFormat", + "description": "The date format." + }, + "timeFormat": { + "$ref": "#/definitions/X12TimeFormat", + "description": "The time format." } }, - "description": "The AS2 agreement mdn settings." + "description": "The X12 envelope override settings." }, - "AS2SecuritySettings": { + "X12ValidationOverride": { "type": "object", "required": [ - "overrideGroupSigningCertificate", - "enableNrrForInboundEncodedMessages", - "enableNrrForInboundDecodedMessages", - "enableNrrForOutboundMdn", - "enableNrrForOutboundEncodedMessages", - "enableNrrForOutboundDecodedMessages", - "enableNrrForInboundMdn" + "messageId", + "validateEdiTypes", + "validateXsdTypes", + "allowLeadingAndTrailingSpacesAndZeroes", + "validateCharacterSet", + "trimLeadingAndTrailingSpacesAndZeroes", + "trailingSeparatorPolicy" ], "properties": { - "overrideGroupSigningCertificate": { - "type": "boolean", - "description": "The value indicating whether to send or request a MDN." - }, - "signingCertificateName": { - "type": "string", - "description": "The name of the signing certificate." - }, - "encryptionCertificateName": { + "messageId": { "type": "string", - "description": "The name of the encryption certificate." - }, - "enableNrrForInboundEncodedMessages": { - "type": "boolean", - "description": "The value indicating whether to enable NRR for inbound encoded messages." + "description": "The message id on which the validation settings has to be applied." }, - "enableNrrForInboundDecodedMessages": { + "validateEdiTypes": { "type": "boolean", - "description": "The value indicating whether to enable NRR for inbound decoded messages." + "description": "The value indicating whether to validate EDI types." }, - "enableNrrForOutboundMdn": { + "validateXsdTypes": { "type": "boolean", - "description": "The value indicating whether to enable NRR for outbound MDN." + "description": "The value indicating whether to validate XSD types." }, - "enableNrrForOutboundEncodedMessages": { + "allowLeadingAndTrailingSpacesAndZeroes": { "type": "boolean", - "description": "The value indicating whether to enable NRR for outbound encoded messages." + "description": "The value indicating whether to allow leading and trailing spaces and zeroes." }, - "enableNrrForOutboundDecodedMessages": { + "validateCharacterSet": { "type": "boolean", - "description": "The value indicating whether to enable NRR for outbound decoded messages." + "description": "The value indicating whether to validate character Set." }, - "enableNrrForInboundMdn": { + "trimLeadingAndTrailingSpacesAndZeroes": { "type": "boolean", - "description": "The value indicating whether to enable NRR for inbound MDN." + "description": "The value indicating whether to trim leading and trailing spaces and zeroes." }, - "sha2AlgorithmFormat": { - "type": "string", - "description": "The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize." + "trailingSeparatorPolicy": { + "$ref": "#/definitions/TrailingSeparatorPolicy", + "description": "The trailing separator policy." } }, - "description": "The AS2 agreement security settings." + "description": "The X12 validation override settings." }, - "AS2ValidationSettings": { + "X12MessageIdentifier": { "type": "object", "required": [ - "overrideMessageProperties", - "encryptMessage", - "signMessage", - "compressMessage", - "checkDuplicateMessage", - "interchangeDuplicatesValidityDays", - "checkCertificateRevocationListOnSend", - "checkCertificateRevocationListOnReceive", - "encryptionAlgorithm" + "messageId" ], "properties": { - "overrideMessageProperties": { - "type": "boolean", - "description": "The value indicating whether to override incoming message properties with those in agreement." - }, - "encryptMessage": { - "type": "boolean", - "description": "The value indicating whether the message has to be encrypted." - }, - "signMessage": { - "type": "boolean", - "description": "The value indicating whether the message has to be signed." - }, - "compressMessage": { - "type": "boolean", - "description": "The value indicating whether the message has to be compressed." - }, - "checkDuplicateMessage": { - "type": "boolean", - "description": "The value indicating whether to check for duplicate message." - }, - "interchangeDuplicatesValidityDays": { - "type": "integer", - "format": "int32", - "description": "The number of days to look back for duplicate interchange." - }, - "checkCertificateRevocationListOnSend": { - "type": "boolean", - "description": "The value indicating whether to check for certificate revocation list on send." - }, - "checkCertificateRevocationListOnReceive": { - "type": "boolean", - "description": "The value indicating whether to check for certificate revocation list on receive." - }, - "encryptionAlgorithm": { - "$ref": "#/definitions/EncryptionAlgorithm", - "description": "The encryption algorithm." - }, - "signingAlgorithm": { - "$ref": "#/definitions/SigningAlgorithm", - "description": "The signing algorithm." + "messageId": { + "type": "string", + "description": "The message id." } }, - "description": "The AS2 agreement validation settings." + "description": "The X12 message identifier." }, - "AS2EnvelopeSettings": { + "X12SchemaReference": { "type": "object", "required": [ - "messageContentType", - "transmitFileNameInMimeHeader", - "fileNameTemplate", - "suspendMessageOnFileNameGenerationError", - "autogenerateFileName" + "messageId", + "schemaVersion", + "schemaName" ], "properties": { - "messageContentType": { + "messageId": { "type": "string", - "description": "The message content type." - }, - "transmitFileNameInMimeHeader": { - "type": "boolean", - "description": "The value indicating whether to transmit file name in mime header." + "description": "The message id." }, - "fileNameTemplate": { + "senderApplicationId": { "type": "string", - "description": "The template for file name." + "description": "The sender application id." }, - "suspendMessageOnFileNameGenerationError": { - "type": "boolean", - "description": "The value indicating whether to suspend message on file name generation error." + "schemaVersion": { + "type": "string", + "description": "The schema version." }, - "autogenerateFileName": { - "type": "boolean", - "description": "The value indicating whether to auto generate file name." + "schemaName": { + "type": "string", + "description": "The schema name." } }, - "description": "The AS2 agreement envelope settings." + "description": "The X12 schema reference." }, - "AS2ErrorSettings": { + "X12DelimiterOverrides": { "type": "object", "required": [ - "suspendDuplicateMessage", - "resendIfMdnNotReceived" + "dataElementSeparator", + "componentSeparator", + "segmentTerminator", + "segmentTerminatorSuffix", + "replaceCharacter", + "replaceSeparatorsInPayload" ], "properties": { - "suspendDuplicateMessage": { - "type": "boolean", - "description": "The value indicating whether to suspend duplicate message." + "protocolVersion": { + "type": "string", + "description": "The protocol version." }, - "resendIfMdnNotReceived": { + "messageId": { + "type": "string", + "description": "The message id." + }, + "dataElementSeparator": { + "type": "integer", + "format": "int32", + "description": "The data element separator." + }, + "componentSeparator": { + "type": "integer", + "format": "int32", + "description": "The component separator." + }, + "segmentTerminator": { + "type": "integer", + "format": "int32", + "description": "The segment terminator." + }, + "segmentTerminatorSuffix": { + "$ref": "#/definitions/SegmentTerminatorSuffix", + "description": "The segment terminator suffix." + }, + "replaceCharacter": { + "type": "integer", + "format": "int32", + "description": "The replacement character." + }, + "replaceSeparatorsInPayload": { "type": "boolean", - "description": "The value indicating whether to resend message If MDN is not received." + "description": "The value indicating whether to replace separators in payload." + }, + "targetNamespace": { + "type": "string", + "description": "The target namespace on which this delimiter settings has to be applied." } }, - "description": "The AS2 agreement error settings." + "description": "The X12 delimiter override settings." }, - "X12AgreementContent": { + "X12CharacterSet": { + "type": "string", + "enum": [ + "NotSpecified", + "Basic", + "Extended", + "UTF8" + ], + "x-ms-enum": { + "name": "X12CharacterSet", + "modelAsString": false + } + }, + "SegmentTerminatorSuffix": { + "type": "string", + "enum": [ + "NotSpecified", + "None", + "CR", + "LF", + "CRLF" + ], + "x-ms-enum": { + "name": "SegmentTerminatorSuffix", + "modelAsString": false + } + }, + "X12DateFormat": { + "type": "string", + "enum": [ + "NotSpecified", + "CCYYMMDD", + "YYMMDD" + ], + "x-ms-enum": { + "name": "X12DateFormat", + "modelAsString": false + } + }, + "X12TimeFormat": { + "type": "string", + "enum": [ + "NotSpecified", + "HHMM", + "HHMMSS", + "HHMMSSdd", + "HHMMSSd" + ], + "x-ms-enum": { + "name": "X12TimeFormat", + "modelAsString": false + } + }, + "UsageIndicator": { + "type": "string", + "enum": [ + "NotSpecified", + "Test", + "Information", + "Production" + ], + "x-ms-enum": { + "name": "UsageIndicator", + "modelAsString": false + } + }, + "MessageFilterType": { + "type": "string", + "enum": [ + "NotSpecified", + "Include", + "Exclude" + ], + "x-ms-enum": { + "name": "MessageFilterType", + "modelAsString": false + } + }, + "HashingAlgorithm": { + "type": "string", + "enum": [ + "NotSpecified", + "None", + "MD5", + "SHA1", + "SHA2256", + "SHA2384", + "SHA2512" + ], + "x-ms-enum": { + "name": "HashingAlgorithm", + "modelAsString": false + } + }, + "EncryptionAlgorithm": { + "type": "string", + "enum": [ + "NotSpecified", + "None", + "DES3", + "RC2", + "AES128", + "AES192", + "AES256" + ], + "x-ms-enum": { + "name": "EncryptionAlgorithm", + "modelAsString": false + } + }, + "SigningAlgorithm": { + "type": "string", + "enum": [ + "NotSpecified", + "Default", + "SHA1", + "SHA2256", + "SHA2384", + "SHA2512" + ], + "x-ms-enum": { + "name": "SigningAlgorithm", + "modelAsString": true + } + }, + "TrailingSeparatorPolicy": { + "type": "string", + "enum": [ + "NotSpecified", + "NotAllowed", + "Optional", + "Mandatory" + ], + "x-ms-enum": { + "name": "TrailingSeparatorPolicy", + "modelAsString": false + } + }, + "EdifactAgreementContent": { "type": "object", "required": [ "receiveAgreement", @@ -5335,17 +7810,17 @@ ], "properties": { "receiveAgreement": { - "$ref": "#/definitions/X12OneWayAgreement", - "description": "The X12 one-way receive agreement." + "$ref": "#/definitions/EdifactOneWayAgreement", + "description": "The EDIFACT one-way receive agreement." }, "sendAgreement": { - "$ref": "#/definitions/X12OneWayAgreement", - "description": "The X12 one-way send agreement." + "$ref": "#/definitions/EdifactOneWayAgreement", + "description": "The EDIFACT one-way send agreement." } }, - "description": "The X12 agreement content." + "description": "The Edifact agreement content." }, - "X12OneWayAgreement": { + "EdifactOneWayAgreement": { "type": "object", "required": [ "senderBusinessIdentity", @@ -5362,13 +7837,13 @@ "description": "The receiver business identity" }, "protocolSettings": { - "$ref": "#/definitions/X12ProtocolSettings", - "description": "The X12 protocol settings." + "$ref": "#/definitions/EdifactProtocolSettings", + "description": "The EDIFACT protocol settings." } }, - "description": "The X12 oneway agreement." + "description": "The Edifact one way agreement." }, - "X12ProtocolSettings": { + "EdifactProtocolSettings": { "type": "object", "required": [ "validationSettings", @@ -5376,78 +7851,73 @@ "envelopeSettings", "acknowledgementSettings", "messageFilter", - "securitySettings", "processingSettings", "schemaReferences" ], "properties": { "validationSettings": { - "$ref": "#/definitions/X12ValidationSettings", - "description": "The X12 validation settings." + "$ref": "#/definitions/EdifactValidationSettings", + "description": "The EDIFACT validation settings." }, "framingSettings": { - "$ref": "#/definitions/X12FramingSettings", - "description": "The X12 framing settings." + "$ref": "#/definitions/EdifactFramingSettings", + "description": "The EDIFACT framing settings." }, "envelopeSettings": { - "$ref": "#/definitions/X12EnvelopeSettings", - "description": "The X12 envelope settings." + "$ref": "#/definitions/EdifactEnvelopeSettings", + "description": "The EDIFACT envelope settings." }, "acknowledgementSettings": { - "$ref": "#/definitions/X12AcknowledgementSettings", - "description": "The X12 acknowledgment settings." + "$ref": "#/definitions/EdifactAcknowledgementSettings", + "description": "The EDIFACT acknowledgement settings." }, "messageFilter": { - "$ref": "#/definitions/X12MessageFilter", - "description": "The X12 message filter." - }, - "securitySettings": { - "$ref": "#/definitions/X12SecuritySettings", - "description": "The X12 security settings." + "$ref": "#/definitions/EdifactMessageFilter", + "description": "The EDIFACT message filter." }, "processingSettings": { - "$ref": "#/definitions/X12ProcessingSettings", - "description": "The X12 processing settings." + "$ref": "#/definitions/EdifactProcessingSettings", + "description": "The EDIFACT processing Settings." }, "envelopeOverrides": { "type": "array", "items": { - "$ref": "#/definitions/X12EnvelopeOverride" + "$ref": "#/definitions/EdifactEnvelopeOverride" }, - "description": "The X12 envelope override settings." + "description": "The EDIFACT envelope override settings." }, - "validationOverrides": { + "messageFilterList": { "type": "array", "items": { - "$ref": "#/definitions/X12ValidationOverride" + "$ref": "#/definitions/EdifactMessageIdentifier" }, - "description": "The X12 validation override settings." + "description": "The EDIFACT message filter list." }, - "messageFilterList": { + "schemaReferences": { "type": "array", "items": { - "$ref": "#/definitions/X12MessageIdentifier" + "$ref": "#/definitions/EdifactSchemaReference" }, - "description": "The X12 message filter list." + "description": "The EDIFACT schema references." }, - "schemaReferences": { + "validationOverrides": { "type": "array", "items": { - "$ref": "#/definitions/X12SchemaReference" + "$ref": "#/definitions/EdifactValidationOverride" }, - "description": "The X12 schema references." + "description": "The EDIFACT validation override settings." }, - "x12DelimiterOverrides": { + "edifactDelimiterOverrides": { "type": "array", "items": { - "$ref": "#/definitions/X12DelimiterOverrides" + "$ref": "#/definitions/EdifactDelimiterOverride" }, - "description": "The X12 delimiter override settings." + "description": "The EDIFACT delimiter override settings." } }, - "description": "The X12 agreement protocol settings." + "description": "The Edifact agreement protocol settings." }, - "X12ValidationSettings": { + "EdifactValidationSettings": { "type": "object", "required": [ "validateCharacterSet", @@ -5504,877 +7974,561 @@ "description": "The trailing separator policy." } }, - "description": "The X12 agreement validation settings." + "description": "The Edifact agreement validation settings." }, - "X12FramingSettings": { + "EdifactFramingSettings": { "type": "object", "required": [ + "protocolVersion", "dataElementSeparator", "componentSeparator", - "replaceSeparatorsInPayload", - "replaceCharacter", "segmentTerminator", + "releaseIndicator", + "repetitionSeparator", "characterSet", + "decimalPointIndicator", "segmentTerminatorSuffix" ], "properties": { - "dataElementSeparator": { - "type": "integer", - "format": "int32", - "description": "The data element separator." - }, - "componentSeparator": { - "type": "integer", - "format": "int32", - "description": "The component separator." - }, - "replaceSeparatorsInPayload": { - "type": "boolean", - "description": "The value indicating whether to replace separators in payload." - }, - "replaceCharacter": { - "type": "integer", - "format": "int32", - "description": "The replacement character." - }, - "segmentTerminator": { - "type": "integer", - "format": "int32", - "description": "The segment terminator." - }, - "characterSet": { - "$ref": "#/definitions/X12CharacterSet", - "description": "The X12 character set." - }, - "segmentTerminatorSuffix": { - "$ref": "#/definitions/SegmentTerminatorSuffix", - "description": "The segment terminator suffix." - } - }, - "description": "The X12 agreement framing settings." - }, - "X12EnvelopeSettings": { - "type": "object", - "required": [ - "controlStandardsId", - "useControlStandardsIdAsRepetitionCharacter", - "senderApplicationId", - "receiverApplicationId", - "controlVersionNumber", - "interchangeControlNumberLowerBound", - "interchangeControlNumberUpperBound", - "rolloverInterchangeControlNumber", - "enableDefaultGroupHeaders", - "groupControlNumberLowerBound", - "groupControlNumberUpperBound", - "rolloverGroupControlNumber", - "groupHeaderAgencyCode", - "groupHeaderVersion", - "transactionSetControlNumberLowerBound", - "transactionSetControlNumberUpperBound", - "rolloverTransactionSetControlNumber", - "overwriteExistingTransactionSetControlNumber", - "groupHeaderDateFormat", - "groupHeaderTimeFormat", - "usageIndicator" - ], - "properties": { - "controlStandardsId": { - "type": "integer", - "format": "int32", - "description": "The controls standards id." - }, - "useControlStandardsIdAsRepetitionCharacter": { - "type": "boolean", - "description": "The value indicating whether to use control standards id as repetition character." - }, - "senderApplicationId": { - "type": "string", - "description": "The sender application id." - }, - "receiverApplicationId": { - "type": "string", - "description": "The receiver application id." - }, - "controlVersionNumber": { - "type": "string", - "description": "The control version number." - }, - "interchangeControlNumberLowerBound": { - "type": "integer", - "format": "int32", - "description": "The interchange control number lower bound." - }, - "interchangeControlNumberUpperBound": { - "type": "integer", - "format": "int32", - "description": "The interchange control number upper bound." - }, - "rolloverInterchangeControlNumber": { - "type": "boolean", - "description": "The value indicating whether to rollover interchange control number." - }, - "enableDefaultGroupHeaders": { - "type": "boolean", - "description": "The value indicating whether to enable default group headers." - }, - "functionalGroupId": { - "type": "string", - "description": "The functional group id." - }, - "groupControlNumberLowerBound": { - "type": "integer", - "format": "int32", - "description": "The group control number lower bound." - }, - "groupControlNumberUpperBound": { - "type": "integer", - "format": "int32", - "description": "The group control number upper bound." - }, - "rolloverGroupControlNumber": { - "type": "boolean", - "description": "The value indicating whether to rollover group control number." - }, - "groupHeaderAgencyCode": { - "type": "string", - "description": "The group header agency code." - }, - "groupHeaderVersion": { - "type": "string", - "description": "The group header version." - }, - "transactionSetControlNumberLowerBound": { - "type": "integer", - "format": "int32", - "description": "The transaction set control number lower bound." - }, - "transactionSetControlNumberUpperBound": { - "type": "integer", - "format": "int32", - "description": "The transaction set control number upper bound." - }, - "rolloverTransactionSetControlNumber": { - "type": "boolean", - "description": "The value indicating whether to rollover transaction set control number." - }, - "transactionSetControlNumberPrefix": { - "type": "string", - "description": "The transaction set control number prefix." - }, - "transactionSetControlNumberSuffix": { - "type": "string", - "description": "The transaction set control number suffix." - }, - "overwriteExistingTransactionSetControlNumber": { - "type": "boolean", - "description": "The value indicating whether to overwrite existing transaction set control number." - }, - "groupHeaderDateFormat": { - "$ref": "#/definitions/X12DateFormat", - "description": "The group header date format." - }, - "groupHeaderTimeFormat": { - "$ref": "#/definitions/X12TimeFormat", - "description": "The group header time format." - }, - "usageIndicator": { - "$ref": "#/definitions/UsageIndicator", - "description": "The usage indicator." - } - }, - "description": "The X12 agreement envelope settings." - }, - "X12AcknowledgementSettings": { - "type": "object", - "required": [ - "needTechnicalAcknowledgement", - "batchTechnicalAcknowledgements", - "needFunctionalAcknowledgement", - "batchFunctionalAcknowledgements", - "needImplementationAcknowledgement", - "batchImplementationAcknowledgements", - "needLoopForValidMessages", - "sendSynchronousAcknowledgement", - "acknowledgementControlNumberLowerBound", - "acknowledgementControlNumberUpperBound", - "rolloverAcknowledgementControlNumber" - ], - "properties": { - "needTechnicalAcknowledgement": { - "type": "boolean", - "description": "The value indicating whether technical acknowledgement is needed." - }, - "batchTechnicalAcknowledgements": { - "type": "boolean", - "description": "The value indicating whether to batch the technical acknowledgements." - }, - "needFunctionalAcknowledgement": { - "type": "boolean", - "description": "The value indicating whether functional acknowledgement is needed." - }, - "functionalAcknowledgementVersion": { + "serviceCodeListDirectoryVersion": { "type": "string", - "description": "The functional acknowledgement version." - }, - "batchFunctionalAcknowledgements": { - "type": "boolean", - "description": "The value indicating whether to batch functional acknowledgements." - }, - "needImplementationAcknowledgement": { - "type": "boolean", - "description": "The value indicating whether implementation acknowledgement is needed." + "description": "The service code list directory version." }, - "implementationAcknowledgementVersion": { + "characterEncoding": { "type": "string", - "description": "The implementation acknowledgement version." - }, - "batchImplementationAcknowledgements": { - "type": "boolean", - "description": "The value indicating whether to batch implementation acknowledgements." + "description": "The character encoding." }, - "needLoopForValidMessages": { - "type": "boolean", - "description": "The value indicating whether a loop is needed for valid messages." + "protocolVersion": { + "type": "integer", + "format": "int32", + "description": "The protocol version." }, - "sendSynchronousAcknowledgement": { - "type": "boolean", - "description": "The value indicating whether to send synchronous acknowledgement." + "dataElementSeparator": { + "type": "integer", + "format": "int32", + "description": "The data element separator." }, - "acknowledgementControlNumberPrefix": { - "type": "string", - "description": "The acknowledgement control number prefix." + "componentSeparator": { + "type": "integer", + "format": "int32", + "description": "The component separator." }, - "acknowledgementControlNumberSuffix": { - "type": "string", - "description": "The acknowledgement control number suffix." + "segmentTerminator": { + "type": "integer", + "format": "int32", + "description": "The segment terminator." }, - "acknowledgementControlNumberLowerBound": { + "releaseIndicator": { "type": "integer", "format": "int32", - "description": "The acknowledgement control number lower bound." + "description": "The release indicator." }, - "acknowledgementControlNumberUpperBound": { + "repetitionSeparator": { "type": "integer", "format": "int32", - "description": "The acknowledgement control number upper bound." + "description": "The repetition separator." }, - "rolloverAcknowledgementControlNumber": { - "type": "boolean", - "description": "The value indicating whether to rollover acknowledgement control number." - } - }, - "description": "The X12 agreement acknowledgement settings." - }, - "X12MessageFilter": { - "type": "object", - "required": [ - "messageFilterType" - ], - "properties": { - "messageFilterType": { - "$ref": "#/definitions/MessageFilterType", - "description": "The message filter type." + "characterSet": { + "$ref": "#/definitions/EdifactCharacterSet", + "description": "The EDIFACT frame setting characterSet." + }, + "decimalPointIndicator": { + "$ref": "#/definitions/EdifactDecimalIndicator", + "description": "The EDIFACT frame setting decimal indicator." + }, + "segmentTerminatorSuffix": { + "$ref": "#/definitions/SegmentTerminatorSuffix", + "description": "The EDIFACT frame setting segment terminator suffix." } }, - "description": "The X12 message filter for odata query." + "description": "The Edifact agreement framing settings." }, - "X12SecuritySettings": { + "EdifactEnvelopeSettings": { "type": "object", "required": [ - "authorizationQualifier", - "securityQualifier" + "applyDelimiterStringAdvice", + "createGroupingSegments", + "enableDefaultGroupHeaders", + "interchangeControlNumberLowerBound", + "interchangeControlNumberUpperBound", + "rolloverInterchangeControlNumber", + "groupControlNumberLowerBound", + "groupControlNumberUpperBound", + "rolloverGroupControlNumber", + "overwriteExistingTransactionSetControlNumber", + "transactionSetControlNumberLowerBound", + "transactionSetControlNumberUpperBound", + "rolloverTransactionSetControlNumber", + "isTestInterchange" ], "properties": { - "authorizationQualifier": { - "type": "string", - "description": "The authorization qualifier." - }, - "authorizationValue": { + "groupAssociationAssignedCode": { "type": "string", - "description": "The authorization value." + "description": "The group association assigned code." }, - "securityQualifier": { + "communicationAgreementId": { "type": "string", - "description": "The security qualifier." + "description": "The communication agreement id." }, - "passwordValue": { - "type": "string", - "description": "The password value." - } - }, - "description": "The X12 agreement security settings." - }, - "X12ProcessingSettings": { - "type": "object", - "required": [ - "maskSecurityInfo", - "convertImpliedDecimal", - "preserveInterchange", - "suspendInterchangeOnError", - "createEmptyXmlTagsForTrailingSeparators", - "useDotAsDecimalSeparator" - ], - "properties": { - "maskSecurityInfo": { + "applyDelimiterStringAdvice": { "type": "boolean", - "description": "The value indicating whether to mask security information." + "description": "The value indicating whether to apply delimiter string advice." }, - "convertImpliedDecimal": { + "createGroupingSegments": { "type": "boolean", - "description": "The value indicating whether to convert numerical type to implied decimal." + "description": "The value indicating whether to create grouping segments." }, - "preserveInterchange": { + "enableDefaultGroupHeaders": { "type": "boolean", - "description": "The value indicating whether to preserve interchange." + "description": "The value indicating whether to enable default group headers." }, - "suspendInterchangeOnError": { - "type": "boolean", - "description": "The value indicating whether to suspend interchange on error." + "recipientReferencePasswordValue": { + "type": "string", + "description": "The recipient reference password value." }, - "createEmptyXmlTagsForTrailingSeparators": { - "type": "boolean", - "description": "The value indicating whether to create empty xml tags for trailing separators." + "recipientReferencePasswordQualifier": { + "type": "string", + "description": "The recipient reference password qualifier." }, - "useDotAsDecimalSeparator": { - "type": "boolean", - "description": "The value indicating whether to use dot as decimal separator." - } - }, - "description": "The X12 processing settings." - }, - "X12EnvelopeOverride": { - "type": "object", - "required": [ - "targetNamespace", - "protocolVersion", - "messageId", - "responsibleAgencyCode", - "headerVersion", - "senderApplicationId", - "receiverApplicationId", - "dateFormat", - "timeFormat" - ], - "properties": { - "targetNamespace": { + "applicationReferenceId": { "type": "string", - "description": "The target namespace on which this envelope settings has to be applied." + "description": "The application reference id." }, - "protocolVersion": { + "processingPriorityCode": { "type": "string", - "description": "The protocol version on which this envelope settings has to be applied." + "description": "The processing priority code." }, - "messageId": { + "interchangeControlNumberLowerBound": { + "type": "integer", + "format": "int64", + "description": "The interchange control number lower bound." + }, + "interchangeControlNumberUpperBound": { + "type": "integer", + "format": "int64", + "description": "The interchange control number upper bound." + }, + "rolloverInterchangeControlNumber": { + "type": "boolean", + "description": "The value indicating whether to rollover interchange control number." + }, + "interchangeControlNumberPrefix": { "type": "string", - "description": "The message id on which this envelope settings has to be applied." + "description": "The interchange control number prefix." }, - "responsibleAgencyCode": { + "interchangeControlNumberSuffix": { "type": "string", - "description": "The responsible agency code." + "description": "The interchange control number suffix." }, - "headerVersion": { + "senderReverseRoutingAddress": { "type": "string", - "description": "The header version." + "description": "The sender reverse routing address." }, - "senderApplicationId": { + "receiverReverseRoutingAddress": { "type": "string", - "description": "The sender application id." + "description": "The receiver reverse routing address." }, - "receiverApplicationId": { + "functionalGroupId": { "type": "string", - "description": "The receiver application id." + "description": "The functional group id." }, - "functionalIdentifierCode": { + "groupControllingAgencyCode": { "type": "string", - "description": "The functional identifier code." + "description": "The group controlling agency code." }, - "dateFormat": { - "$ref": "#/definitions/X12DateFormat", - "description": "The date format." + "groupMessageVersion": { + "type": "string", + "description": "The group message version." }, - "timeFormat": { - "$ref": "#/definitions/X12TimeFormat", - "description": "The time format." - } - }, - "description": "The X12 envelope override settings." - }, - "X12ValidationOverride": { - "type": "object", - "required": [ - "messageId", - "validateEdiTypes", - "validateXsdTypes", - "allowLeadingAndTrailingSpacesAndZeroes", - "validateCharacterSet", - "trimLeadingAndTrailingSpacesAndZeroes", - "trailingSeparatorPolicy" - ], - "properties": { - "messageId": { + "groupMessageRelease": { "type": "string", - "description": "The message id on which the validation settings has to be applied." + "description": "The group message release." }, - "validateEdiTypes": { - "type": "boolean", - "description": "The value indicating whether to validate EDI types." + "groupControlNumberLowerBound": { + "type": "integer", + "format": "int64", + "description": "The group control number lower bound." }, - "validateXsdTypes": { - "type": "boolean", - "description": "The value indicating whether to validate XSD types." + "groupControlNumberUpperBound": { + "type": "integer", + "format": "int64", + "description": "The group control number upper bound." }, - "allowLeadingAndTrailingSpacesAndZeroes": { + "rolloverGroupControlNumber": { "type": "boolean", - "description": "The value indicating whether to allow leading and trailing spaces and zeroes." + "description": "The value indicating whether to rollover group control number." }, - "validateCharacterSet": { - "type": "boolean", - "description": "The value indicating whether to validate character Set." + "groupControlNumberPrefix": { + "type": "string", + "description": "The group control number prefix." }, - "trimLeadingAndTrailingSpacesAndZeroes": { - "type": "boolean", - "description": "The value indicating whether to trim leading and trailing spaces and zeroes." + "groupControlNumberSuffix": { + "type": "string", + "description": "The group control number suffix." }, - "trailingSeparatorPolicy": { - "$ref": "#/definitions/TrailingSeparatorPolicy", - "description": "The trailing separator policy." - } - }, - "description": "The X12 validation override settings." - }, - "X12MessageIdentifier": { - "type": "object", - "required": [ - "messageId" - ], - "properties": { - "messageId": { + "groupApplicationReceiverQualifier": { "type": "string", - "description": "The message id." - } - }, - "description": "The X12 message identifier." - }, - "X12SchemaReference": { - "type": "object", - "required": [ - "messageId", - "schemaVersion", - "schemaName" - ], - "properties": { - "messageId": { + "description": "The group application receiver qualifier." + }, + "groupApplicationReceiverId": { "type": "string", - "description": "The message id." + "description": "The group application receiver id." }, - "senderApplicationId": { + "groupApplicationSenderQualifier": { "type": "string", - "description": "The sender application id." + "description": "The group application sender qualifier." }, - "schemaVersion": { + "groupApplicationSenderId": { "type": "string", - "description": "The schema version." + "description": "The group application sender id." }, - "schemaName": { + "groupApplicationPassword": { "type": "string", - "description": "The schema name." - } - }, - "description": "The X12 schema reference." - }, - "X12DelimiterOverrides": { - "type": "object", - "required": [ - "dataElementSeparator", - "componentSeparator", - "segmentTerminator", - "segmentTerminatorSuffix", - "replaceCharacter", - "replaceSeparatorsInPayload" - ], - "properties": { - "protocolVersion": { + "description": "The group application password." + }, + "overwriteExistingTransactionSetControlNumber": { + "type": "boolean", + "description": "The value indicating whether to overwrite existing transaction set control number." + }, + "transactionSetControlNumberPrefix": { "type": "string", - "description": "The protocol version." + "description": "The transaction set control number prefix." }, - "messageId": { + "transactionSetControlNumberSuffix": { "type": "string", - "description": "The message id." + "description": "The transaction set control number suffix." }, - "dataElementSeparator": { + "transactionSetControlNumberLowerBound": { "type": "integer", - "format": "int32", - "description": "The data element separator." + "format": "int64", + "description": "The transaction set control number lower bound." }, - "componentSeparator": { + "transactionSetControlNumberUpperBound": { "type": "integer", - "format": "int32", - "description": "The component separator." + "format": "int64", + "description": "The transaction set control number upper bound." }, - "segmentTerminator": { - "type": "integer", - "format": "int32", - "description": "The segment terminator." + "rolloverTransactionSetControlNumber": { + "type": "boolean", + "description": "The value indicating whether to rollover transaction set control number." }, - "segmentTerminatorSuffix": { - "$ref": "#/definitions/SegmentTerminatorSuffix", - "description": "The segment terminator suffix." + "isTestInterchange": { + "type": "boolean", + "description": "The value indicating whether the message is a test interchange." }, - "replaceCharacter": { - "type": "integer", - "format": "int32", - "description": "The replacement character." + "senderInternalIdentification": { + "type": "string", + "description": "The sender internal identification." }, - "replaceSeparatorsInPayload": { - "type": "boolean", - "description": "The value indicating whether to replace separators in payload." + "senderInternalSubIdentification": { + "type": "string", + "description": "The sender internal sub identification." }, - "targetNamespace": { + "receiverInternalIdentification": { "type": "string", - "description": "The target namespace on which this delimiter settings has to be applied." - } - }, - "description": "The X12 delimiter override settings." - }, - "X12CharacterSet": { - "type": "string", - "enum": [ - "NotSpecified", - "Basic", - "Extended", - "UTF8" - ], - "x-ms-enum": { - "name": "X12CharacterSet", - "modelAsString": false - } - }, - "SegmentTerminatorSuffix": { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "CR", - "LF", - "CRLF" - ], - "x-ms-enum": { - "name": "SegmentTerminatorSuffix", - "modelAsString": false - } - }, - "X12DateFormat": { - "type": "string", - "enum": [ - "NotSpecified", - "CCYYMMDD", - "YYMMDD" - ], - "x-ms-enum": { - "name": "X12DateFormat", - "modelAsString": false - } - }, - "X12TimeFormat": { - "type": "string", - "enum": [ - "NotSpecified", - "HHMM", - "HHMMSS", - "HHMMSSdd", - "HHMMSSd" - ], - "x-ms-enum": { - "name": "X12TimeFormat", - "modelAsString": false - } - }, - "UsageIndicator": { - "type": "string", - "enum": [ - "NotSpecified", - "Test", - "Information", - "Production" - ], - "x-ms-enum": { - "name": "UsageIndicator", - "modelAsString": false - } - }, - "MessageFilterType": { - "type": "string", - "enum": [ - "NotSpecified", - "Include", - "Exclude" - ], - "x-ms-enum": { - "name": "MessageFilterType", - "modelAsString": false - } - }, - "HashingAlgorithm": { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "MD5", - "SHA1", - "SHA2256", - "SHA2384", - "SHA2512" - ], - "x-ms-enum": { - "name": "HashingAlgorithm", - "modelAsString": false - } - }, - "EncryptionAlgorithm": { - "type": "string", - "enum": [ - "NotSpecified", - "None", - "DES3", - "RC2", - "AES128", - "AES192", - "AES256" - ], - "x-ms-enum": { - "name": "EncryptionAlgorithm", - "modelAsString": false - } - }, - "SigningAlgorithm": { - "type": "string", - "enum": [ - "NotSpecified", - "Default", - "SHA1", - "SHA2256", - "SHA2384", - "SHA2512" - ], - "x-ms-enum": { - "name": "SigningAlgorithm", - "modelAsString": true - } + "description": "The receiver internal identification." + }, + "receiverInternalSubIdentification": { + "type": "string", + "description": "The receiver internal sub identification." + } + }, + "description": "The Edifact agreement envelope settings." }, - "TrailingSeparatorPolicy": { - "type": "string", - "enum": [ - "NotSpecified", - "NotAllowed", - "Optional", - "Mandatory" + "EdifactAcknowledgementSettings": { + "type": "object", + "required": [ + "needTechnicalAcknowledgement", + "batchTechnicalAcknowledgements", + "needFunctionalAcknowledgement", + "batchFunctionalAcknowledgements", + "needLoopForValidMessages", + "sendSynchronousAcknowledgement", + "acknowledgementControlNumberLowerBound", + "acknowledgementControlNumberUpperBound", + "rolloverAcknowledgementControlNumber" ], - "x-ms-enum": { - "name": "TrailingSeparatorPolicy", - "modelAsString": false - } + "properties": { + "needTechnicalAcknowledgement": { + "type": "boolean", + "description": "The value indicating whether technical acknowledgement is needed." + }, + "batchTechnicalAcknowledgements": { + "type": "boolean", + "description": "The value indicating whether to batch the technical acknowledgements." + }, + "needFunctionalAcknowledgement": { + "type": "boolean", + "description": "The value indicating whether functional acknowledgement is needed." + }, + "batchFunctionalAcknowledgements": { + "type": "boolean", + "description": "The value indicating whether to batch functional acknowledgements." + }, + "needLoopForValidMessages": { + "type": "boolean", + "description": "The value indicating whether a loop is needed for valid messages." + }, + "sendSynchronousAcknowledgement": { + "type": "boolean", + "description": "The value indicating whether to send synchronous acknowledgement." + }, + "acknowledgementControlNumberPrefix": { + "type": "string", + "description": "The acknowledgement control number prefix." + }, + "acknowledgementControlNumberSuffix": { + "type": "string", + "description": "The acknowledgement control number suffix." + }, + "acknowledgementControlNumberLowerBound": { + "type": "integer", + "format": "int32", + "description": "The acknowledgement control number lower bound." + }, + "acknowledgementControlNumberUpperBound": { + "type": "integer", + "format": "int32", + "description": "The acknowledgement control number upper bound." + }, + "rolloverAcknowledgementControlNumber": { + "type": "boolean", + "description": "The value indicating whether to rollover acknowledgement control number." + } + }, + "description": "The Edifact agreement acknowledgement settings." }, - "EdifactAgreementContent": { + "EdifactMessageFilter": { "type": "object", "required": [ - "receiveAgreement", - "sendAgreement" + "messageFilterType" ], "properties": { - "receiveAgreement": { - "$ref": "#/definitions/EdifactOneWayAgreement", - "description": "The EDIFACT one-way receive agreement." - }, - "sendAgreement": { - "$ref": "#/definitions/EdifactOneWayAgreement", - "description": "The EDIFACT one-way send agreement." + "messageFilterType": { + "$ref": "#/definitions/MessageFilterType", + "description": "The message filter type." } }, - "description": "The Edifact agreement content." + "description": "The Edifact message filter for odata query." }, - "EdifactOneWayAgreement": { + "EdifactProcessingSettings": { "type": "object", "required": [ - "senderBusinessIdentity", - "receiverBusinessIdentity", - "protocolSettings" + "maskSecurityInfo", + "preserveInterchange", + "suspendInterchangeOnError", + "createEmptyXmlTagsForTrailingSeparators", + "useDotAsDecimalSeparator" ], "properties": { - "senderBusinessIdentity": { - "$ref": "#/definitions/BusinessIdentity", - "description": "The sender business identity" + "maskSecurityInfo": { + "type": "boolean", + "description": "The value indicating whether to mask security information." }, - "receiverBusinessIdentity": { - "$ref": "#/definitions/BusinessIdentity", - "description": "The receiver business identity" + "preserveInterchange": { + "type": "boolean", + "description": "The value indicating whether to preserve interchange." }, - "protocolSettings": { - "$ref": "#/definitions/EdifactProtocolSettings", - "description": "The EDIFACT protocol settings." + "suspendInterchangeOnError": { + "type": "boolean", + "description": "The value indicating whether to suspend interchange on error." + }, + "createEmptyXmlTagsForTrailingSeparators": { + "type": "boolean", + "description": "The value indicating whether to create empty xml tags for trailing separators." + }, + "useDotAsDecimalSeparator": { + "type": "boolean", + "description": "The value indicating whether to use dot as decimal separator." } }, - "description": "The Edifact one way agreement." + "description": "The Edifact agreement protocol settings." }, - "EdifactProtocolSettings": { + "EdifactEnvelopeOverride": { "type": "object", - "required": [ - "validationSettings", - "framingSettings", - "envelopeSettings", - "acknowledgementSettings", - "messageFilter", - "processingSettings", - "schemaReferences" - ], "properties": { - "validationSettings": { - "$ref": "#/definitions/EdifactValidationSettings", - "description": "The EDIFACT validation settings." + "messageId": { + "type": "string", + "description": "The message id on which this envelope settings has to be applied." }, - "framingSettings": { - "$ref": "#/definitions/EdifactFramingSettings", - "description": "The EDIFACT framing settings." + "messageVersion": { + "type": "string", + "description": "The message version on which this envelope settings has to be applied." }, - "envelopeSettings": { - "$ref": "#/definitions/EdifactEnvelopeSettings", - "description": "The EDIFACT envelope settings." + "messageRelease": { + "type": "string", + "description": "The message release version on which this envelope settings has to be applied." }, - "acknowledgementSettings": { - "$ref": "#/definitions/EdifactAcknowledgementSettings", - "description": "The EDIFACT acknowledgement settings." + "messageAssociationAssignedCode": { + "type": "string", + "description": "The message association assigned code." }, - "messageFilter": { - "$ref": "#/definitions/EdifactMessageFilter", - "description": "The EDIFACT message filter." + "targetNamespace": { + "type": "string", + "description": "The target namespace on which this envelope settings has to be applied." }, - "processingSettings": { - "$ref": "#/definitions/EdifactProcessingSettings", - "description": "The EDIFACT processing Settings." + "functionalGroupId": { + "type": "string", + "description": "The functional group id." }, - "envelopeOverrides": { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactEnvelopeOverride" - }, - "description": "The EDIFACT envelope override settings." + "senderApplicationQualifier": { + "type": "string", + "description": "The sender application qualifier." }, - "messageFilterList": { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactMessageIdentifier" - }, - "description": "The EDIFACT message filter list." + "senderApplicationId": { + "type": "string", + "description": "The sender application id." + }, + "receiverApplicationQualifier": { + "type": "string", + "description": "The receiver application qualifier." + }, + "receiverApplicationId": { + "type": "string", + "description": "The receiver application id." + }, + "controllingAgencyCode": { + "type": "string", + "description": "The controlling agency code." + }, + "groupHeaderMessageVersion": { + "type": "string", + "description": "The group header message version." + }, + "groupHeaderMessageRelease": { + "type": "string", + "description": "The group header message release." + }, + "associationAssignedCode": { + "type": "string", + "description": "The association assigned code." + }, + "applicationPassword": { + "type": "string", + "description": "The application password." + } + }, + "description": "The Edifact envelope override settings." + }, + "EdifactMessageIdentifier": { + "type": "object", + "required": [ + "messageId" + ], + "properties": { + "messageId": { + "type": "string", + "description": "The message id on which this envelope settings has to be applied." + } + }, + "description": "The Edifact message identifier." + }, + "EdifactSchemaReference": { + "type": "object", + "required": [ + "messageId", + "messageVersion", + "messageRelease", + "schemaName" + ], + "properties": { + "messageId": { + "type": "string", + "description": "The message id." + }, + "messageVersion": { + "type": "string", + "description": "The message version." + }, + "messageRelease": { + "type": "string", + "description": "The message release version." }, - "schemaReferences": { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactSchemaReference" - }, - "description": "The EDIFACT schema references." + "senderApplicationId": { + "type": "string", + "description": "The sender application id." }, - "validationOverrides": { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactValidationOverride" - }, - "description": "The EDIFACT validation override settings." + "senderApplicationQualifier": { + "type": "string", + "description": "The sender application qualifier." }, - "edifactDelimiterOverrides": { - "type": "array", - "items": { - "$ref": "#/definitions/EdifactDelimiterOverride" - }, - "description": "The EDIFACT delimiter override settings." + "associationAssignedCode": { + "type": "string", + "description": "The association assigned code." + }, + "schemaName": { + "type": "string", + "description": "The schema name." } }, - "description": "The Edifact agreement protocol settings." + "description": "The Edifact schema reference." }, - "EdifactValidationSettings": { + "EdifactValidationOverride": { "type": "object", "required": [ - "validateCharacterSet", - "checkDuplicateInterchangeControlNumber", - "interchangeControlNumberValidityDays", - "checkDuplicateGroupControlNumber", - "checkDuplicateTransactionSetControlNumber", + "messageId", + "enforceCharacterSet", "validateEdiTypes", "validateXsdTypes", "allowLeadingAndTrailingSpacesAndZeroes", - "trimLeadingAndTrailingSpacesAndZeroes", - "trailingSeparatorPolicy" + "trailingSeparatorPolicy", + "trimLeadingAndTrailingSpacesAndZeroes" ], "properties": { - "validateCharacterSet": { - "type": "boolean", - "description": "The value indicating whether to validate character set in the message." - }, - "checkDuplicateInterchangeControlNumber": { - "type": "boolean", - "description": "The value indicating whether to check for duplicate interchange control number." - }, - "interchangeControlNumberValidityDays": { - "type": "integer", - "format": "int32", - "description": "The validity period of interchange control number." - }, - "checkDuplicateGroupControlNumber": { - "type": "boolean", - "description": "The value indicating whether to check for duplicate group control number." + "messageId": { + "type": "string", + "description": "The message id on which the validation settings has to be applied." }, - "checkDuplicateTransactionSetControlNumber": { + "enforceCharacterSet": { "type": "boolean", - "description": "The value indicating whether to check for duplicate transaction set control number." + "description": "The value indicating whether to validate character Set." }, "validateEdiTypes": { "type": "boolean", - "description": "The value indicating whether to Whether to validate EDI types." + "description": "The value indicating whether to validate EDI types." }, "validateXsdTypes": { "type": "boolean", - "description": "The value indicating whether to Whether to validate XSD types." + "description": "The value indicating whether to validate XSD types." }, "allowLeadingAndTrailingSpacesAndZeroes": { "type": "boolean", "description": "The value indicating whether to allow leading and trailing spaces and zeroes." }, - "trimLeadingAndTrailingSpacesAndZeroes": { - "type": "boolean", - "description": "The value indicating whether to trim leading and trailing spaces and zeroes." - }, "trailingSeparatorPolicy": { "$ref": "#/definitions/TrailingSeparatorPolicy", "description": "The trailing separator policy." + }, + "trimLeadingAndTrailingSpacesAndZeroes": { + "type": "boolean", + "description": "The value indicating whether to trim leading and trailing spaces and zeroes." } }, - "description": "The Edifact agreement validation settings." + "description": "The Edifact validation override settings." }, - "EdifactFramingSettings": { + "EdifactDelimiterOverride": { "type": "object", "required": [ - "protocolVersion", "dataElementSeparator", "componentSeparator", "segmentTerminator", - "releaseIndicator", "repetitionSeparator", - "characterSet", + "segmentTerminatorSuffix", "decimalPointIndicator", - "segmentTerminatorSuffix" + "releaseIndicator" ], "properties": { - "serviceCodeListDirectoryVersion": { + "messageId": { "type": "string", - "description": "The service code list directory version." + "description": "The message id." }, - "characterEncoding": { + "messageVersion": { "type": "string", - "description": "The character encoding." + "description": "The message version." }, - "protocolVersion": { - "type": "integer", - "format": "int32", - "description": "The protocol version." + "messageRelease": { + "type": "string", + "description": "The message release." }, "dataElementSeparator": { "type": "integer", @@ -6391,839 +8545,1015 @@ "format": "int32", "description": "The segment terminator." }, - "releaseIndicator": { - "type": "integer", - "format": "int32", - "description": "The release indicator." - }, "repetitionSeparator": { "type": "integer", "format": "int32", "description": "The repetition separator." }, - "characterSet": { - "$ref": "#/definitions/EdifactCharacterSet", - "description": "The EDIFACT frame setting characterSet." - }, - "decimalPointIndicator": { - "$ref": "#/definitions/EdifactDecimalIndicator", - "description": "The EDIFACT frame setting decimal indicator." - }, "segmentTerminatorSuffix": { "$ref": "#/definitions/SegmentTerminatorSuffix", - "description": "The EDIFACT frame setting segment terminator suffix." - } - }, - "description": "The Edifact agreement framing settings." - }, - "EdifactEnvelopeSettings": { - "type": "object", - "required": [ - "applyDelimiterStringAdvice", - "createGroupingSegments", - "enableDefaultGroupHeaders", - "interchangeControlNumberLowerBound", - "interchangeControlNumberUpperBound", - "rolloverInterchangeControlNumber", - "groupControlNumberLowerBound", - "groupControlNumberUpperBound", - "rolloverGroupControlNumber", - "overwriteExistingTransactionSetControlNumber", - "transactionSetControlNumberLowerBound", - "transactionSetControlNumberUpperBound", - "rolloverTransactionSetControlNumber", - "isTestInterchange" - ], - "properties": { - "groupAssociationAssignedCode": { - "type": "string", - "description": "The group association assigned code." - }, - "communicationAgreementId": { - "type": "string", - "description": "The communication agreement id." - }, - "applyDelimiterStringAdvice": { - "type": "boolean", - "description": "The value indicating whether to apply delimiter string advice." - }, - "createGroupingSegments": { - "type": "boolean", - "description": "The value indicating whether to create grouping segments." - }, - "enableDefaultGroupHeaders": { - "type": "boolean", - "description": "The value indicating whether to enable default group headers." - }, - "recipientReferencePasswordValue": { - "type": "string", - "description": "The recipient reference password value." - }, - "recipientReferencePasswordQualifier": { - "type": "string", - "description": "The recipient reference password qualifier." - }, - "applicationReferenceId": { - "type": "string", - "description": "The application reference id." - }, - "processingPriorityCode": { - "type": "string", - "description": "The processing priority code." + "description": "The segment terminator suffix." }, - "interchangeControlNumberLowerBound": { - "type": "integer", - "format": "int64", - "description": "The interchange control number lower bound." + "decimalPointIndicator": { + "$ref": "#/definitions/EdifactDecimalIndicator", + "description": "The decimal point indicator." }, - "interchangeControlNumberUpperBound": { + "releaseIndicator": { "type": "integer", - "format": "int64", - "description": "The interchange control number upper bound." - }, - "rolloverInterchangeControlNumber": { - "type": "boolean", - "description": "The value indicating whether to rollover interchange control number." - }, - "interchangeControlNumberPrefix": { - "type": "string", - "description": "The interchange control number prefix." - }, - "interchangeControlNumberSuffix": { - "type": "string", - "description": "The interchange control number suffix." - }, - "senderReverseRoutingAddress": { - "type": "string", - "description": "The sender reverse routing address." + "format": "int32", + "description": "The release indicator." }, - "receiverReverseRoutingAddress": { + "messageAssociationAssignedCode": { "type": "string", - "description": "The receiver reverse routing address." + "description": "The message association assigned code." }, - "functionalGroupId": { + "targetNamespace": { "type": "string", - "description": "The functional group id." + "description": "The target namespace on which this delimiter settings has to be applied." + } + }, + "description": "The Edifact delimiter override settings." + }, + "EdifactCharacterSet": { + "type": "string", + "enum": [ + "NotSpecified", + "UNOB", + "UNOA", + "UNOC", + "UNOD", + "UNOE", + "UNOF", + "UNOG", + "UNOH", + "UNOI", + "UNOJ", + "UNOK", + "UNOX", + "UNOY", + "KECA" + ], + "x-ms-enum": { + "name": "EdifactCharacterSet", + "modelAsString": false + } + }, + "EdifactDecimalIndicator": { + "type": "string", + "enum": [ + "NotSpecified", + "Comma", + "Decimal" + ], + "x-ms-enum": { + "name": "EdifactDecimalIndicator", + "modelAsString": false + } + }, + "IntegrationAccountCertificateListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationAccountCertificate" + }, + "description": "The list of integration account certificates." }, - "groupControllingAgencyCode": { + "nextLink": { "type": "string", - "description": "The group controlling agency code." - }, - "groupMessageVersion": { + "description": "The URL to get the next set of results." + } + }, + "description": "The list of integration account certificates." + }, + "IntegrationAccountCertificate": { + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IntegrationAccountCertificateProperties", + "description": "The integration account certificate properties." + } + }, + "description": "The integration account certificate.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "IntegrationAccountCertificateProperties": { + "type": "object", + "properties": { + "createdTime": { "type": "string", - "description": "The group message version." + "format": "date-time", + "readOnly": true, + "description": "The created time." }, - "groupMessageRelease": { + "changedTime": { "type": "string", - "description": "The group message release." - }, - "groupControlNumberLowerBound": { - "type": "integer", - "format": "int64", - "description": "The group control number lower bound." - }, - "groupControlNumberUpperBound": { - "type": "integer", - "format": "int64", - "description": "The group control number upper bound." - }, - "rolloverGroupControlNumber": { - "type": "boolean", - "description": "The value indicating whether to rollover group control number." + "format": "date-time", + "readOnly": true, + "description": "The changed time." }, - "groupControlNumberPrefix": { - "type": "string", - "description": "The group control number prefix." + "metadata": { + "type": "object", + "description": "The metadata.", + "properties": {} }, - "groupControlNumberSuffix": { - "type": "string", - "description": "The group control number suffix." + "key": { + "$ref": "#/definitions/KeyVaultKeyReference", + "description": "The key details in the key vault." }, - "groupApplicationReceiverQualifier": { + "publicCertificate": { "type": "string", - "description": "The group application receiver qualifier." + "description": "The public certificate." + } + }, + "description": "The integration account certificate properties." + }, + "KeyVaultKeyReference": { + "type": "object", + "required": [ + "keyVault", + "keyName" + ], + "properties": { + "keyVault": { + "type": "object", + "description": "The key vault reference.", + "properties": { + "id": { + "type": "string", + "description": "The resource id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The resource type." + } + } }, - "groupApplicationReceiverId": { + "keyName": { "type": "string", - "description": "The group application receiver id." + "description": "The private key name in key vault." }, - "groupApplicationSenderQualifier": { + "keyVersion": { "type": "string", - "description": "The group application sender qualifier." - }, - "groupApplicationSenderId": { + "description": "The private key version in key vault." + } + }, + "description": "The reference to the key vault key." + }, + "IntegrationAccountSessionFilter": { + "type": "object", + "required": [ + "changedTime" + ], + "properties": { + "changedTime": { "type": "string", - "description": "The group application sender id." + "format": "date-time", + "description": "The changed time of integration account sessions." + } + }, + "description": "The integration account session filter." + }, + "IntegrationAccountSessionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationAccountSession" + }, + "description": "The list of integration account sessions." }, - "groupApplicationPassword": { + "nextLink": { "type": "string", - "description": "The group application password." - }, - "overwriteExistingTransactionSetControlNumber": { - "type": "boolean", - "description": "The value indicating whether to overwrite existing transaction set control number." - }, - "transactionSetControlNumberPrefix": { + "description": "The URL to get the next set of results." + } + }, + "description": "The list of integration account sessions." + }, + "IntegrationAccountSession": { + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IntegrationAccountSessionProperties", + "description": "The integration account session properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The integration account session." + }, + "IntegrationAccountSessionProperties": { + "type": "object", + "properties": { + "createdTime": { "type": "string", - "description": "The transaction set control number prefix." + "format": "date-time", + "readOnly": true, + "description": "The created time." }, - "transactionSetControlNumberSuffix": { + "changedTime": { "type": "string", - "description": "The transaction set control number suffix." - }, - "transactionSetControlNumberLowerBound": { - "type": "integer", - "format": "int64", - "description": "The transaction set control number lower bound." - }, - "transactionSetControlNumberUpperBound": { - "type": "integer", - "format": "int64", - "description": "The transaction set control number upper bound." + "format": "date-time", + "readOnly": true, + "description": "The changed time." }, - "rolloverTransactionSetControlNumber": { - "type": "boolean", - "description": "The value indicating whether to rollover transaction set control number." + "content": { + "$ref": "#/definitions/Object", + "description": "The session content." + } + }, + "description": "The integration account session properties." + }, + "Operation": { + "description": "Logic REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" }, - "isTestInterchange": { - "type": "boolean", - "description": "The value indicating whether the message is a test interchange." + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Logic", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: Profile, endpoint, etc.", + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "Result of the request to list Logic 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 Logic operations supported by the Logic resource provider." }, - "senderInternalIdentification": { + "nextLink": { "type": "string", - "description": "The sender internal identification." + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "ErrorResponse": { + "description": "Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorProperties", + "description": "The error properties." + } + } + }, + "ErrorProperties": { + "description": "Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" }, - "senderInternalSubIdentification": { - "type": "string", - "description": "The sender internal sub identification." + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "ListKeyVaultKeysDefinition": { + "type": "object", + "description": "The list key vault keys definition.", + "additionalProperties": false, + "required": [ + "keyVault" + ], + "properties": { + "keyVault": { + "$ref": "#/definitions/KeyVaultReference", + "description": "The key vault reference." }, - "receiverInternalIdentification": { + "skipToken": { "type": "string", - "description": "The receiver internal identification." - }, - "receiverInternalSubIdentification": { + "description": "The skip token." + } + } + }, + "KeyVaultReference": { + "type": "object", + "description": "The key vault reference.", + "additionalProperties": false, + "properties": { + "name": { "type": "string", - "description": "The receiver internal sub identification." + "description": "The key vault name." } }, - "description": "The Edifact agreement envelope settings." + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ] }, - "EdifactAcknowledgementSettings": { + "KeyVaultKeyCollection": { "type": "object", - "required": [ - "needTechnicalAcknowledgement", - "batchTechnicalAcknowledgements", - "needFunctionalAcknowledgement", - "batchFunctionalAcknowledgements", - "needLoopForValidMessages", - "sendSynchronousAcknowledgement", - "acknowledgementControlNumberLowerBound", - "acknowledgementControlNumberUpperBound", - "rolloverAcknowledgementControlNumber" - ], + "description": "Collection of key vault keys.", "properties": { - "needTechnicalAcknowledgement": { - "type": "boolean", - "description": "The value indicating whether technical acknowledgement is needed." - }, - "batchTechnicalAcknowledgements": { - "type": "boolean", - "description": "The value indicating whether to batch the technical acknowledgements." - }, - "needFunctionalAcknowledgement": { - "type": "boolean", - "description": "The value indicating whether functional acknowledgement is needed." - }, - "batchFunctionalAcknowledgements": { - "type": "boolean", - "description": "The value indicating whether to batch functional acknowledgements." - }, - "needLoopForValidMessages": { - "type": "boolean", - "description": "The value indicating whether a loop is needed for valid messages." - }, - "sendSynchronousAcknowledgement": { - "type": "boolean", - "description": "The value indicating whether to send synchronous acknowledgement." + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/KeyVaultKey" + }, + "description": "The key vault keys." }, - "acknowledgementControlNumberPrefix": { + "skipToken": { "type": "string", - "description": "The acknowledgement control number prefix." - }, - "acknowledgementControlNumberSuffix": { + "description": "The skip token." + } + } + }, + "KeyVaultKey": { + "type": "object", + "description": "The key vault key.", + "properties": { + "kid": { "type": "string", - "description": "The acknowledgement control number suffix." - }, - "acknowledgementControlNumberLowerBound": { - "type": "integer", - "format": "int32", - "description": "The acknowledgement control number lower bound." - }, - "acknowledgementControlNumberUpperBound": { - "type": "integer", - "format": "int32", - "description": "The acknowledgement control number upper bound." + "description": "The key id." }, - "rolloverAcknowledgementControlNumber": { - "type": "boolean", - "description": "The value indicating whether to rollover acknowledgement control number." + "attributes": { + "type": "object", + "description": "The key attributes.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the key is enabled or not." + }, + "created": { + "type": "integer", + "format": "int64", + "description": "When the key was created." + }, + "updated": { + "type": "integer", + "format": "int64", + "description": "When the key was updated." + } + } } - }, - "description": "The Edifact agreement acknowledgement settings." + } }, - "EdifactMessageFilter": { + "TrackingEventsDefinition": { "type": "object", + "additionalProperties": false, "required": [ - "messageFilterType" + "sourceType", + "events" ], "properties": { - "messageFilterType": { - "$ref": "#/definitions/MessageFilterType", - "description": "The message filter type." + "sourceType": { + "type": "string" + }, + "trackEventsOptions": { + "$ref": "#/definitions/TrackEventsOperationOptions" + }, + "events": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackingEvent" + } } + } + }, + "TrackEventsOperationOptions": { + "type": "string", + "enum": [ + "None", + "DisableSourceInfoEnrich" + ], + "x-ms-enum": { + "name": "TrackEventsOperationOptions", + "modelAsString": false }, - "description": "The Edifact message filter for odata query." + "description": "The track events operation options." }, - "EdifactProcessingSettings": { + "TrackingEvent": { "type": "object", + "additionalProperties": false, "required": [ - "maskSecurityInfo", - "preserveInterchange", - "suspendInterchangeOnError", - "createEmptyXmlTagsForTrailingSeparators", - "useDotAsDecimalSeparator" + "eventLevel", + "eventTime", + "recordType" ], "properties": { - "maskSecurityInfo": { - "type": "boolean", - "description": "The value indicating whether to mask security information." - }, - "preserveInterchange": { - "type": "boolean", - "description": "The value indicating whether to preserve interchange." + "eventLevel": { + "$ref": "#/definitions/EventLevel" }, - "suspendInterchangeOnError": { - "type": "boolean", - "description": "The value indicating whether to suspend interchange on error." + "eventTime": { + "type": "string", + "format": "date-time" }, - "createEmptyXmlTagsForTrailingSeparators": { - "type": "boolean", - "description": "The value indicating whether to create empty xml tags for trailing separators." + "recordType": { + "$ref": "#/definitions/TrackingRecordType" }, - "useDotAsDecimalSeparator": { - "type": "boolean", - "description": "The value indicating whether to use dot as decimal separator." + "error": { + "$ref": "#/definitions/TrackingEventErrorInfo" } + } + }, + "EventLevel": { + "type": "string", + "enum": [ + "LogAlways", + "Critical", + "Error", + "Warning", + "Informational", + "Verbose" + ], + "x-ms-enum": { + "name": "EventLevel", + "modelAsString": false }, - "description": "The Edifact agreement protocol settings." + "description": "The event level." }, - "EdifactEnvelopeOverride": { + "TrackingRecordType": { + "type": "string", + "enum": [ + "NotSpecified", + "Custom", + "AS2Message", + "AS2MDN", + "X12Interchange", + "X12FunctionalGroup", + "X12TransactionSet", + "X12InterchangeAcknowledgment", + "X12FunctionalGroupAcknowledgment", + "X12TransactionSetAcknowledgment", + "EdifactInterchange", + "EdifactFunctionalGroup", + "EdifactTransactionSet", + "EdifactInterchangeAcknowledgment", + "EdifactFunctionalGroupAcknowledgment", + "EdifactTransactionSetAcknowledgment" + ], + "x-ms-enum": { + "name": "TrackingRecordType", + "modelAsString": false + }, + "description": "The tracking record type." + }, + "TrackingEventErrorInfo": { "type": "object", + "additionalProperties": false, "properties": { - "messageId": { - "type": "string", - "description": "The message id on which this envelope settings has to be applied." - }, - "messageVersion": { - "type": "string", - "description": "The message version on which this envelope settings has to be applied." - }, - "messageRelease": { - "type": "string", - "description": "The message release version on which this envelope settings has to be applied." - }, - "messageAssociationAssignedCode": { - "type": "string", - "description": "The message association assigned code." - }, - "targetNamespace": { - "type": "string", - "description": "The target namespace on which this envelope settings has to be applied." - }, - "functionalGroupId": { - "type": "string", - "description": "The functional group id." - }, - "senderApplicationQualifier": { - "type": "string", - "description": "The sender application qualifier." - }, - "senderApplicationId": { - "type": "string", - "description": "The sender application id." - }, - "receiverApplicationQualifier": { - "type": "string", - "description": "The receiver application qualifier." - }, - "receiverApplicationId": { - "type": "string", - "description": "The receiver application id." - }, - "controllingAgencyCode": { - "type": "string", - "description": "The controlling agency code." - }, - "groupHeaderMessageVersion": { - "type": "string", - "description": "The group header message version." - }, - "groupHeaderMessageRelease": { - "type": "string", - "description": "The group header message release." - }, - "associationAssignedCode": { - "type": "string", - "description": "The association assigned code." + "message": { + "type": "string" }, - "applicationPassword": { - "type": "string", - "description": "The application password." + "code": { + "type": "string" + } + } + }, + "AccessKeyRegenerateActionDefinition": { + "type": "object", + "additionalProperties": false, + "required": [ + "keyType" + ], + "properties": { + "keyType": { + "$ref": "#/definitions/AccessKeyType" } + } + }, + "AccessKeyType": { + "type": "string", + "enum": [ + "NotSpecified", + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "AccessKeyType", + "modelAsString": false }, - "description": "The Edifact enevlope override settings." + "description": "The access key type." }, - "EdifactMessageIdentifier": { + "SetTriggerStateActionDefinition": { "type": "object", + "additionalProperties": false, "required": [ - "messageId" + "source" ], "properties": { - "messageId": { + "source": { + "$ref": "#/definitions/WorkflowTrigger" + } + } + }, + "ExpressionTraces": { + "type": "object", + "properties": { + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressionRoot" + } + } + } + }, + "ExpressionRoot": { + "type": "object", + "properties": { + "path": { "type": "string", - "description": "The message id on which this envelope settings has to be applied." + "description": "The path." } }, - "description": "The Edifact message identifier." + "allOf": [ + { + "$ref": "#/definitions/Expression" + } + ] }, - "EdifactSchemaReference": { + "Expression": { "type": "object", - "required": [ - "messageId", - "messageVersion", - "messageRelease", - "schemaName" - ], + "additionalProperties": false, "properties": { - "messageId": { - "type": "string", - "description": "The message id." - }, - "messageVersion": { - "type": "string", - "description": "The message version." - }, - "messageRelease": { - "type": "string", - "description": "The message release version." - }, - "senderApplicationId": { - "type": "string", - "description": "The sender application id." + "text": { + "type": "string" }, - "senderApplicationQualifier": { - "type": "string", - "description": "The sender application qualifier." + "value": {}, + "subexpressions": { + "type": "array", + "items": { + "$ref": "#/definitions/Expression" + } }, - "associationAssignedCode": { + "error": { + "$ref": "#/definitions/AzureResourceErrorInfo" + } + } + }, + "AzureResourceErrorInfo": { + "type": "object", + "description": "The azure resource error info.", + "additionalProperties": false, + "required": [ + "message" + ], + "properties": { + "message": { "type": "string", - "description": "The association assigned code." + "description": "The error message." }, - "schemaName": { - "type": "string", - "description": "The schema name." + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureResourceErrorInfo" + }, + "description": "The error details." } }, - "description": "The Edifact schema reference." + "allOf": [ + { + "$ref": "#/definitions/ErrorInfo" + } + ] }, - "EdifactValidationOverride": { + "ErrorInfo": { "type": "object", + "description": "The error info.", + "additionalProperties": false, "required": [ - "messageId", - "enforceCharacterSet", - "validateEdiTypes", - "validateXsdTypes", - "allowLeadingAndTrailingSpacesAndZeroes", - "trailingSeparatorPolicy", - "trimLeadingAndTrailingSpacesAndZeroes" + "code" ], "properties": { - "messageId": { + "code": { "type": "string", - "description": "The message id on which the validation settings has to be applied." - }, - "enforceCharacterSet": { - "type": "boolean", - "description": "The value indicating whether to validate character Set." - }, - "validateEdiTypes": { - "type": "boolean", - "description": "The value indicating whether to validate EDI types." - }, - "validateXsdTypes": { - "type": "boolean", - "description": "The value indicating whether to validate XSD types." - }, - "allowLeadingAndTrailingSpacesAndZeroes": { - "type": "boolean", - "description": "The value indicating whether to allow leading and trailing spaces and zeroes." - }, - "trailingSeparatorPolicy": { - "$ref": "#/definitions/TrailingSeparatorPolicy", - "description": "The trailing separator policy." - }, - "trimLeadingAndTrailingSpacesAndZeroes": { - "type": "boolean", - "description": "The value indicating whether to trim leading and trailing spaces and zeroes." + "description": "The error code." + } + } + }, + "WorkflowRunActionRepetitionDefinitionCollection": { + "type": "object", + "description": "A collection of workflow run action repetitions.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowRunActionRepetitionDefinition" + } + } + } + }, + "WorkflowRunActionRepetitionDefinition": { + "type": "object", + "description": "The workflow run action repetition definition.", + "additionalProperties": false, + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkflowRunActionRepetitionProperties", + "description": "The workflow run action repetition properties definition.", + "x-ms-client-flatten": true } }, - "description": "The Edifact validation override settings." + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] }, - "EdifactDelimiterOverride": { + "WorkflowRunActionRepetitionProperties": { + "type": "object", + "description": "The workflow run action repetition properties definition.", + "additionalProperties": false, + "properties": { + "repetitionIndexes": { + "type": "array", + "description": "The repetition indexes.", + "items": { + "$ref": "#/definitions/RepetitionIndex" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/OperationResult" + } + ] + }, + "RepetitionIndex": { "type": "object", + "description": "The workflow run action repetition index.", + "additionalProperties": false, "required": [ - "dataElementSeparator", - "componentSeparator", - "segmentTerminator", - "repetitionSeparator", - "segmentTerminatorSuffix", - "decimalPointIndicator", - "releaseIndicator" + "itemIndex" ], "properties": { - "messageId": { + "scopeName": { "type": "string", - "description": "The message id." + "description": "The scope." }, - "messageVersion": { + "itemIndex": { + "type": "integer", + "format": "int32", + "description": "The index." + } + } + }, + "OperationResult": { + "type": "object", + "description": "The operation result definition.", + "additionalProperties": false, + "properties": { + "trackingId": { "type": "string", - "description": "The message version." + "readOnly": true, + "description": "Gets the tracking id." }, - "messageRelease": { - "type": "string", - "description": "The message releaseversion." + "inputs": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the inputs." }, - "dataElementSeparator": { - "type": "integer", - "format": "int32", - "description": "The data element separator." + "inputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to inputs." }, - "componentSeparator": { - "type": "integer", - "format": "int32", - "description": "The component separator." + "outputs": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the outputs." }, - "segmentTerminator": { - "type": "integer", - "format": "int32", - "description": "The segment terminator." + "outputsLink": { + "$ref": "#/definitions/ContentLink", + "readOnly": true, + "description": "Gets the link to outputs." }, - "repetitionSeparator": { + "trackedProperties": { + "$ref": "#/definitions/Object", + "readOnly": true, + "description": "Gets the tracked properties." + }, + "retryHistory": { + "type": "array", + "items": { + "$ref": "#/definitions/RetryHistory" + }, + "description": "Gets the retry histories." + }, + "iterationCount": { "type": "integer", - "format": "int32", - "description": "The repetition separator." + "format": "int32" + } + }, + "allOf": [ + { + "$ref": "#/definitions/OperationResultProperties" + } + ] + }, + "OperationResultProperties": { + "type": "object", + "x-abstract": true, + "description": "The run operation result properties.", + "additionalProperties": false, + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the workflow scope repetition." }, - "segmentTerminatorSuffix": { - "$ref": "#/definitions/SegmentTerminatorSuffix", - "description": "The segment terminator suffix." + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the workflow scope repetition." }, - "decimalPointIndicator": { - "$ref": "#/definitions/EdifactDecimalIndicator", - "description": "The decimal point indicator." + "correlation": { + "$ref": "#/definitions/RunActionCorrelation", + "description": "The correlation properties." }, - "releaseIndicator": { - "type": "integer", - "format": "int32", - "description": "The release indicator." + "status": { + "$ref": "#/definitions/WorkflowStatus", + "description": "The status of the workflow scope repetition." }, - "messageAssociationAssignedCode": { + "code": { "type": "string", - "description": "The message association assigned code." + "description": "The workflow scope repetition code." }, - "targetNamespace": { + "error": {} + } + }, + "RunActionCorrelation": { + "type": "object", + "description": "The workflow run action correlation properties.", + "additionalProperties": false, + "properties": { + "actionTrackingId": { "type": "string", - "description": "The target namespace on which this delimiter settings has to be applied." + "description": "The action tracking identifier." } }, - "description": "The Edifact delimiter override settings." + "allOf": [ + { + "$ref": "#/definitions/RunCorrelation" + } + ] }, - "EdifactCharacterSet": { - "type": "string", - "enum": [ - "NotSpecified", - "UNOB", - "UNOA", - "UNOC", - "UNOD", - "UNOE", - "UNOF", - "UNOG", - "UNOH", - "UNOI", - "UNOJ", - "UNOK", - "UNOX", - "UNOY", - "KECA" - ], - "x-ms-enum": { - "name": "EdifactCharacterSet", - "modelAsString": false + "RunCorrelation": { + "type": "object", + "description": "The correlation properties.", + "additionalProperties": false, + "properties": { + "clientTrackingId": { + "type": "string", + "description": "The client tracking identifier." + }, + "clientKeywords": { + "type": "array", + "description": "The client keywords.", + "items": { + "type": "string" + } + } } }, - "EdifactDecimalIndicator": { - "type": "string", - "enum": [ - "NotSpecified", - "Comma", - "Decimal" - ], - "x-ms-enum": { - "name": "EdifactDecimalIndicator", - "modelAsString": false + "JsonSchema": { + "type": "object", + "description": "The JSON schema.", + "properties": { + "title": { + "type": "string", + "description": "The JSON title." + }, + "content": { + "type": "string", + "description": "The JSON content." + } } }, - "IntegrationAccountCertificateListResult": { + "AssemblyCollection": { "type": "object", + "description": "A collection of assembly definitions.", "properties": { "value": { "type": "array", "items": { - "$ref": "#/definitions/IntegrationAccountCertificate" - }, - "description": "The list of integration account certificates." - }, - "nextLink": { - "type": "string", - "description": "The URL to get the next set of results." + "$ref": "#/definitions/AssemblyDefinition" + } } - }, - "description": "The list of integration account certificates." + } }, - "IntegrationAccountCertificate": { + "AssemblyDefinition": { "type": "object", + "description": "The assembly definition.", + "additionalProperties": false, "required": [ "properties" ], "properties": { "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IntegrationAccountCertificateProperties", - "description": "The integration account certificate properties." + "$ref": "#/definitions/AssemblyProperties", + "description": "The assembly properties." } }, - "description": "The integration account certificate.", "allOf": [ { "$ref": "#/definitions/Resource" } ] }, - "IntegrationAccountCertificateProperties": { + "AssemblyProperties": { "type": "object", + "description": "The assembly properties definition.", + "additionalProperties": false, + "required": [ + "assemblyName" + ], "properties": { - "createdTime": { + "assemblyName": { "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The created time." + "description": "The assembly name." }, - "changedTime": { + "assemblyVersion": { "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The changed time." - }, - "metadata": { - "type": "object", - "description": "The metadata.", - "properties": {} + "description": "The assembly version." }, - "key": { - "$ref": "#/definitions/KeyVaultKeyReference", - "description": "The key details in the key vault." + "assemblyCulture": { + "type": "string", + "description": "The assembly culture." }, - "publicCertificate": { + "assemblyPublicKeyToken": { "type": "string", - "description": "The public certificate." + "description": "The assembly public key token." } }, - "description": "The integration account certificate properties." + "allOf": [ + { + "$ref": "#/definitions/ArtifactContentPropertiesDefinition" + } + ] }, - "KeyVaultKeyReference": { + "ArtifactContentPropertiesDefinition": { "type": "object", - "required": [ - "keyVault", - "keyName" - ], + "additionalProperties": false, + "description": "The artifact content properties definition.", "properties": { - "keyVault": { - "type": "object", - "description": "The key vault reference.", - "properties": { - "id": { - "type": "string", - "description": "The resource id." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "The resource name." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "The resource type." - } - } - }, - "keyName": { + "content": {}, + "contentType": { "type": "string", - "description": "The private key name in key vault." + "description": "The content type." }, - "keyVersion": { - "type": "string", - "description": "The private key version in key vault." + "contentLink": { + "$ref": "#/definitions/ContentLink", + "description": "The content link." } }, - "description": "The reference to the key vault key." + "allOf": [ + { + "$ref": "#/definitions/ArtifactProperties" + } + ] }, - "IntegrationAccountSessionFilter": { + "ArtifactProperties": { "type": "object", - "required": [ - "changedTime" - ], + "additionalProperties": false, + "description": "The artifact properties definition.", "properties": { + "createdTime": { + "type": "string", + "format": "date-time", + "description": "The artifact creation time." + }, "changedTime": { "type": "string", "format": "date-time", - "description": "The changed time of integration account sessions." - } - }, - "description": "The integration account session filter." + "description": "The artifact changed time." + }, + "metadata": {} + } }, - "IntegrationAccountSessionListResult": { + "BatchConfigurationCollection": { "type": "object", + "description": "A collection of batch configurations.", "properties": { "value": { "type": "array", "items": { - "$ref": "#/definitions/IntegrationAccountSession" - }, - "description": "The list of integration account sessions." - }, - "nextLink": { - "type": "string", - "description": "The URL to get the next set of results." + "$ref": "#/definitions/BatchConfiguration" + } } - }, - "description": "The list of integration account sessions." + } }, - "IntegrationAccountSession": { + "BatchConfiguration": { "type": "object", + "description": "The batch configuration resource definition.", + "additionalProperties": false, "required": [ "properties" ], "properties": { "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/IntegrationAccountSessionProperties", - "description": "The integration account session properties." + "$ref": "#/definitions/BatchConfigurationProperties", + "description": "The batch configuration properties." } }, "allOf": [ { "$ref": "#/definitions/Resource" } - ], - "description": "The integration account session." + ] }, - "IntegrationAccountSessionProperties": { + "BatchConfigurationProperties": { "type": "object", + "description": "The batch configuration properties definition.", + "additionalProperties": false, + "required": [ + "batchGroupName", + "releaseCriteria" + ], "properties": { + "batchGroupName": { + "type": "string", + "description": "The name of the batch group." + }, + "releaseCriteria": { + "$ref": "#/definitions/BatchReleaseCriteria", + "description": "The batch release criteria." + }, "createdTime": { "type": "string", "format": "date-time", - "readOnly": true, "description": "The created time." }, "changedTime": { "type": "string", "format": "date-time", - "readOnly": true, "description": "The changed time." - }, - "content": { - "$ref": "#/definitions/Object", - "description": "The session content." } }, - "description": "The integration account session properties." - }, - "Operation": { - "description": "Logic REST API operation", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "The object that represents the operation.", - "properties": { - "provider": { - "description": "Service provider: Microsoft.Logic", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed: Profile, endpoint, etc.", - "type": "string" - }, - "operation": { - "description": "Operation type: Read, write, delete, etc.", - "type": "string" - } - } - } - } - }, - "OperationListResult": { - "description": "Result of the request to list Logic 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 Logic operations supported by the Logic resource provider." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any." - } - } - }, - "ErrorResponse": { - "description": "Error reponse indicates Logic service is not able to process the incoming request. The error property contains the error details.", - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/ErrorProperties", - "description": "The error properties." + "allOf": [ + { + "$ref": "#/definitions/ArtifactProperties" } - } + ] }, - "ErrorProperties": { - "description": "Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.", + "BatchReleaseCriteria": { "type": "object", + "additionalProperties": false, + "description": "The batch release criteria.", "properties": { - "code": { - "description": "Error code.", - "type": "string" + "messageCount": { + "type": "integer", + "format": "int32", + "description": "The message count." }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" + "batchSize": { + "type": "integer", + "format": "int32", + "description": "The batch size in bytes." + }, + "recurrence": { + "$ref": "#/definitions/WorkflowTriggerRecurrence", + "description": "The recurrence." } } } @@ -7244,4 +9574,4 @@ "type": "string" } } -} +} \ No newline at end of file diff --git a/specification/logic/resource-manager/readme.md b/specification/logic/resource-manager/readme.md index 1d52c860913d..9326548bd6cc 100644 --- a/specification/logic/resource-manager/readme.md +++ b/specification/logic/resource-manager/readme.md @@ -27,6 +27,17 @@ These are the global settings for the Logic API. ``` yaml openapi-type: arm tag: package-2016-06 + +directive: + - where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/listExpressionTraces"].post.responses["200"].schema + suppress: + - CollectionObjectPropertiesNaming + - where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/listExpressionTraces"].post.responses["200"].schema + suppress: + - CollectionObjectPropertiesNaming + ``` @@ -70,9 +81,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_logic'] ``` @@ -153,7 +167,7 @@ These settings apply only when `--tag=package-2015-08-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-08-preview' && $(go) -output-folder: $(go-sdk-folder)/services/logic/mgmt/2015-08-01-preview/logic +output-folder: $(go-sdk-folder)/services/preview/logic/mgmt/2015-08-01-preview/logic ``` ### Tag: package-2015-02-preview and go @@ -162,7 +176,7 @@ These settings apply only when `--tag=package-2015-02-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-02-preview' && $(go) -output-folder: $(go-sdk-folder)/services/logic/mgmt/2015-02-01-preview/logic +output-folder: $(go-sdk-folder)/services/preview/logic/mgmt/2015-02-01-preview/logic ``` @@ -172,11 +186,30 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.logic +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-logic +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-06 +``` + +### Tag: package-2016-06 and java + +These settings apply only when `--tag=package-2016-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-06' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.logic - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-logic + namespace: com.microsoft.azure.management.logic.v2016_06_01 + output-folder: $(azure-libraries-for-java-folder)/logic/resource-manager/v2016_06_01 +regenerate-manager: true +generate-interface: true ``` diff --git a/specification/logic/resource-manager/readme.nodejs.md b/specification/logic/resource-manager/readme.nodejs.md index 9c8a2c858182..cea7e9ffdca4 100644 --- a/specification/logic/resource-manager/readme.nodejs.md +++ b/specification/logic/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-06' && $(ruby) +namespace: "Azure::Logic::Mgmt::V2016_06_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_logic/lib +``` + +### Tag: package-2015-02-preview and ruby + +These settings apply only when `--tag=package-2015-02-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-02-preview' && $(ruby) +namespace: "Azure::Logic::Mgmt::V2015_02_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_logic/lib +``` diff --git a/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2016-04-01/swagger/workspaces.json b/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2016-04-01/workspaces.json similarity index 97% rename from specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2016-04-01/swagger/workspaces.json rename to specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2016-04-01/workspaces.json index 8deae5dddad0..7e5aa1ff2f35 100644 --- a/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2016-04-01/swagger/workspaces.json +++ b/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2016-04-01/workspaces.json @@ -88,7 +88,7 @@ ], "x-ms-examples": { "WorkspaceGet": { - "$ref": "../examples/GetWorkspace.json" + "$ref": "./examples/GetWorkspace.json" } }, "responses": { @@ -137,7 +137,7 @@ ], "x-ms-examples": { "WorkspaceCreate": { - "$ref": "../examples/CreateWorkspace.json" + "$ref": "./examples/CreateWorkspace.json" } }, "responses": { @@ -177,7 +177,7 @@ ], "x-ms-examples": { "WorkspaceDelere": { - "$ref": "../examples/DeleteWorkspace.json" + "$ref": "./examples/DeleteWorkspace.json" } }, "responses": { @@ -226,7 +226,7 @@ ], "x-ms-examples": { "WorkspaceUpdate": { - "$ref": "../examples/UpdateWorkspace.json" + "$ref": "./examples/UpdateWorkspace.json" } }, "responses": { @@ -268,7 +268,7 @@ ], "x-ms-examples": { "ResyncStorageKeys": { - "$ref": "../examples/ResyncStorageKeys.json" + "$ref": "./examples/ResyncStorageKeys.json" } }, "responses": { @@ -307,7 +307,7 @@ ], "x-ms-examples": { "ListWorkspaceKeys": { - "$ref": "../examples/ListWorkspaceKeys.json" + "$ref": "./examples/ListWorkspaceKeys.json" } }, "responses": { @@ -346,7 +346,7 @@ ], "x-ms-examples": { "WorkspaceListResourceGroup": { - "$ref": "../examples/ListWorkspaceResourceGroup.json" + "$ref": "./examples/ListWorkspaceResourceGroup.json" } }, "responses": { @@ -385,7 +385,7 @@ ], "x-ms-examples": { "WorkspaceGetBySubscription": { - "$ref": "../examples/ListWorkspaces.json" + "$ref": "./examples/ListWorkspaces.json" } }, "responses": { diff --git a/specification/machinelearning/resource-manager/readme.md b/specification/machinelearning/resource-manager/readme.md index b4b6c3a24b39..9035176ae8d8 100644 --- a/specification/machinelearning/resource-manager/readme.md +++ b/specification/machinelearning/resource-manager/readme.md @@ -90,6 +90,9 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_machine_learning'] ``` @@ -133,6 +136,7 @@ go: batch: - tag: package-webservices-2017-01 - tag: package-webservices-2016-05-preview + - tag: package-workspaces-2016-04 - tag: package-commitmentPlans-2016-05-preview ``` @@ -153,7 +157,17 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-workspaces-2016-04' && $(go) +namespace: workspaces +output-folder: $(go-sdk-folder)/services/machinelearning/mgmt/2016-04-01/workspaces ``` ### Tag: package-commitmentPlans-2016-05-preview and go @@ -163,7 +177,7 @@ Please also specify `--go-sdk-folder=`. ``` yaml $(java) -java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.machinelearning - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-machinelearning +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.machinelearning +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-machinelearning ``` # Validation @@ -191,4 +204,68 @@ batch: - package-webservices: true - package-commitmentPlans: true - package-workspaces: true -``` \ No newline at end of file +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-webservices-2017-01 + - tag: package-commitmentPlans-2016-05-preview + - tag: package-webservices-2016-05-preview + - tag: package-workspaces-2016-04 +``` + +### Tag: package-webservices-2017-01 and java + +These settings apply only when `--tag=package-webservices-2017-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-webservices-2017-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.machinelearning.v2017_01_01 + output-folder: $(azure-libraries-for-java-folder)/machinelearning/resource-manager/v2017_01_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-commitmentPlans-2016-05-preview and java + +These settings apply only when `--tag=package-commitmentPlans-2016-05-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-commitmentPlans-2016-05-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.machinelearning.v2016_05_01_preview + output-folder: $(azure-libraries-for-java-folder)/machinelearning/resource-manager/v2016_05_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-webservices-2016-05-preview and java + +These settings apply only when `--tag=package-webservices-2016-05-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-webservices-2016-05-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.machinelearning.v2016_05_01_preview + output-folder: $(azure-libraries-for-java-folder)/machinelearning/resource-manager/v2016_05_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-workspaces-2016-04 and java + +These settings apply only when `--tag=package-workspaces-2016-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-workspaces-2016-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.machinelearning.v2016_04_01 + output-folder: $(azure-libraries-for-java-folder)/machinelearning/resource-manager/v2016_04_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/machinelearning/resource-manager/readme.ruby.md b/specification/machinelearning/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..8a84eb29141c --- /dev/null +++ b/specification/machinelearning/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_machine_learning +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-webservices-2017-01 +``` + +### Tag: package-webservices-2017-01 and ruby + +These settings apply only when `--tag=package-webservices-2017-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-webservices-2017-01' && $(ruby) +namespace: "Azure::MachineLearning::Mgmt::V2017_01_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_machine_learning/lib +``` diff --git a/specification/machinelearningcompute/resource-manager/readme.md b/specification/machinelearningcompute/resource-manager/readme.md index d4c7d5b15110..573f91990c05 100644 --- a/specification/machinelearningcompute/resource-manager/readme.md +++ b/specification/machinelearningcompute/resource-manager/readme.md @@ -62,7 +62,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node ``` @@ -133,7 +133,7 @@ These settings apply only when `--tag=package-2017-08-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2017-08-preview' && $(go) -output-folder: $(go-sdk-folder)/services/machinelearning/mgmt/2017-08-01-preview/compute +output-folder: $(go-sdk-folder)/services/preview/machinelearning/mgmt/2017-08-01-preview/compute ``` ### Tag: package-2017-06-preview and go @@ -142,7 +142,7 @@ These settings apply only when `--tag=package-package-2017-06-preview --go` is s Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2017-06-preview' && $(go) -output-folder: $(go-sdk-folder)/services/machinelearning/mgmt/2017-06-01-preview/compute +output-folder: $(go-sdk-folder)/services/preview/machinelearning/mgmt/2017-06-01-preview/compute ``` @@ -152,11 +152,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.machinelearning.compute +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-machinelearning/compute +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-08-preview +``` + +### Tag: package-2017-08-preview and java + +These settings apply only when `--tag=package-2017-08-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-08-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.machinelearning.compute - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-machinelearning/compute + namespace: com.microsoft.azure.management.machinelearningcompute.v2017_08_01_preview + output-folder: $(azure-libraries-for-java-folder)/machinelearningcompute/resource-manager/v2017_08_01_preview +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/machinelearningexperimentation/resource-manager/readme.md b/specification/machinelearningexperimentation/resource-manager/readme.md index 8c525e985a48..2db43935130b 100644 --- a/specification/machinelearningexperimentation/resource-manager/readme.md +++ b/specification/machinelearningexperimentation/resource-manager/readme.md @@ -91,7 +91,7 @@ These settings apply only when `--tag=package-2017-05-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2017-05-preview' && $(go) -output-folder: $(go-sdk-folder)/services/machinelearning/mgmt/2017-05-01-preview/experimentation +output-folder: $(go-sdk-folder)/services/preview/machinelearning/mgmt/2017-05-01-preview/experimentation ``` @@ -101,11 +101,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.machinelearning.experimentation +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-machinelearning/experimentation +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-05-preview +``` + +### Tag: package-2017-05-preview and java + +These settings apply only when `--tag=package-2017-05-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-05-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.machinelearning.experimentation - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-machinelearning/experimentation + namespace: com.microsoft.azure.management.machinelearningexperimentation.v2017_05_01_preview + output-folder: $(azure-libraries-for-java-folder)/machinelearningexperimentation/resource-manager/v2017_05_01_preview +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/createBasicAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/createBasicAKSCompute.json new file mode 100644 index 000000000000..1b668ec3065d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/createBasicAKSCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-03-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AKS" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/createBasicBatchAICompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/createBasicBatchAICompute.json new file mode 100644 index 000000000000..7a1eec345fce --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/createBasicBatchAICompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-03-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "BatchAI" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "BatchAI", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "BatchAI", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/createBasicDataFactoryCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/createBasicDataFactoryCompute.json new file mode 100644 index 000000000000..d23cfe7e2d97 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/createBasicDataFactoryCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-03-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "DataFactory" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/createWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/createWorkspace.json new file mode 100644 index 000000000000..ca4b0e52ff1e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/createWorkspace.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2018-03-01-preview", + "parameters": { + "location": "eastus2euap", + "properties": { + "friendlyName": "HelloName", + "description": "test description", + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/deleteCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/deleteCompute.json new file mode 100644 index 000000000000..e0b596696809 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/deleteCompute.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/deleteWorkspace.json new file mode 100644 index 000000000000..307b6e2f6f86 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/deleteWorkspace.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getAKSCompute.json new file mode 100644 index 000000000000..f8aee325bc18 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getAKSCompute.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded", + "properties": { + "clusterFqdn": "compute123-56826-c9b00420020b2-6a3f9fd6.hcp.eastus.azmk8s.io", + "systemServices": [ + { + "systemServiceType": "ScoringFrontEnd", + "publicIpAddress": "1.1.1.1", + "version": "prod/1.20180420.3/v1.0.preview/c8aeb0be7644c2107855662bcc5471ab2b2d5521" + } + ], + "agentCount": 4, + "agentVmSize": "Standard_D3_v2", + "sslConfiguration": { + "status": "Disabled" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getBatchAICompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getBatchAICompute.json new file mode 100644 index 000000000000..c3da36c97832 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getBatchAICompute.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.BatchAI/clusters/compute123-ccb488844dcc2", + "computeType": "BatchAI", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "dedicated", + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "autoScaleEnabled": false + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getComputes.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getComputes.json new file mode 100644 index 000000000000..efa83159b759 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getComputes.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded", + "properties": { + "clusterFqdn": "compute123-56826-c9b00420020b2-6a3f9fd6.hcp.eastus.azmk8s.io", + "systemServices": [ + { + "systemServiceType": "ScoringFrontEnd", + "publicIpAddress": "1.1.1.1", + "version": "prod/1.20180420.3/v1.0.preview/c8aeb0be7644c2107855662bcc5471ab2b2d5521" + } + ], + "agentCount": 4, + "agentVmSize": "Standard_D3_v2", + "sslConfiguration": { + "status": "Disabled" + } + } + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute1234", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute1234", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute1234-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded", + "properties": { + "clusterFqdn": "compute123-56826-c9b00420020b2-6a3f9fd6.hcp.eastus.azmk8s.io", + "systemServices": [ + { + "systemServiceType": "ScoringFrontEnd", + "publicIpAddress": "1.1.1.1", + "version": "prod/1.20180420.3/v1.0.preview/c8aeb0be7644c2107855662bcc5471ab2b2d5521" + } + ], + "agentCount": 4, + "agentVmSize": "Standard_D3_v2", + "sslConfiguration": { + "status": "Disabled" + } + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getWorkspace.json new file mode 100644 index 000000000000..2af5a5f603a6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getWorkspace.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getWorkspacesByResourceGroup.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getWorkspacesByResourceGroup.json new file mode 100644 index 000000000000..783a31999115 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getWorkspacesByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace1", + "name": "testworkspace1", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName 1", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getWorkspacesBySubscription.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getWorkspacesBySubscription.json new file mode 100644 index 000000000000..0f9049ce8995 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/getWorkspacesBySubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-5678/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/listKeysAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/listKeysAKSCompute.json new file mode 100644 index 000000000000..13cd68b7fb4b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/listKeysAKSCompute.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + "body": { + "computeType": "AKS", + "userKubeConfig": "user kube config...", + "adminKubeConfig": "admin kube config...", + "imagePullSecretName": "the image pull secret name" + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/listKeysVirtualMachine.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/listKeysVirtualMachine.json new file mode 100644 index 000000000000..12035705d05a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/listKeysVirtualMachine.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + "body": { + "computeType": "AKS", + "administratorAccount": { + "username": "the user name", + "password": "the password", + "publicKeyData": "public key...", + "privateKeyData": "private key..." + } + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/listWorkspaceKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/listWorkspaceKeys.json new file mode 100644 index 000000000000..36c1dba479fe --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/listWorkspaceKeys.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + "body": + { + "userStorageKey": "r5rKCJ018TLk+bdAi/9YaVzgcQ0nkLsUqGyUN03KsdCFtqG0SjFGPV8+vT1frWqkvBL0bGoPpLc1BlZSSaZmOA==", + "userStorageResourceId": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/ragargeastus2euap/providers/Microsoft.Storage/storageAccounts/testdemoworkazashomr", + "appInsightsInstrumentationKey": null, + "containerRegistryCredentials": { + "location": null, + "username": "testdemoworkjmjmeykp", + "passwords": [ + { + "name": "password", + "value": "vBvVhYgAGtUSewVCUv3w95p4/q5Yrsnw" + }, + { + "name": "password2", + "value": "0KARRQoQHSUq1yViPWg7YFernOS=Ic/t" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/resyncWorkspaceKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/resyncWorkspaceKeys.json new file mode 100644 index 000000000000..110e00eddc38 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/resyncWorkspaceKeys.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateAKSCompute.json new file mode 100644 index 000000000000..0009bddaa08c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateAKSCompute.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-03-01-preview", + "parameters": { + "id": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "properties": { + "agentCount": 4 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded", + "properties": { + "clusterFqdn": "compute123-56826-c9b00420020b2-6a3f9fd6.hcp.eastus.azmk8s.io", + "systemServices": [ + { + "systemServiceType": "ScoringFrontEnd", + "publicIpAddress": "1.1.1.1", + "version": "prod/1.20180420.3/v1.0.preview/c8aeb0be7644c2107855662bcc5471ab2b2d5521" + } + ], + "agentCount": 4, + "agentVmSize": "Standard_D3_v2", + "sslConfiguration": { + "status": "Disabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Updating", + "properties": { + "clusterFqdn": "compute123-56826-c9b00420020b2-6a3f9fd6.hcp.eastus.azmk8s.io", + "systemServices": [ + { + "systemServiceType": "ScoringFrontEnd", + "publicIpAddress": "1.1.1.1", + "version": "prod/1.20180420.3/v1.0.preview/c8aeb0be7644c2107855662bcc5471ab2b2d5521" + } + ], + "agentCount": 4, + "agentVmSize": "Standard_D3_v2", + "sslConfiguration": { + "status": "Disabled" + } + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateBatchAICompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateBatchAICompute.json new file mode 100644 index 000000000000..48e76ab7ced7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateBatchAICompute.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-03-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "BatchAI", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.BatchAI/clusters/compute123-ccb488844dcc2", + "computeType": "BatchAI", + "properties": { + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "autoScaleEnabled": false + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.BatchAI/clusters/compute123-ccb488844dcc2", + "computeType": "BatchAI", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "dedicated", + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "autoScaleEnabled": false + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.BatchAI/clusters/compute123-ccb488844dcc2", + "computeType": "BatchAI", + "provisioningState": "Updating", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "dedicated", + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "autoScaleEnabled": false + } + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateWorkspace.json new file mode 100644 index 000000000000..a325e9656ffe --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateWorkspace.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2018-03-01-preview", + "parameters": { + "properties": { + "friendlyName": "New friendly name", + "description": "new description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "New friendly name", + "description": "new description" + } + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json new file mode 100644 index 000000000000..7ea8fbb05e33 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json @@ -0,0 +1,1464 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Workspaces", + "description": "These APIs allow end users to operate on Azure Machine Learning Workspace resources.", + "version": "2018-03-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.MachineLearningServices/operations": { + "get": { + "tags": [ + "Operation" + ], + "description": "Lists all of the available Azure Machine Learning Workspaces REST API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Gets the properties of the specified machine learning workspace.", + "operationId": "Workspaces_Get", + "x-ms-examples": { + "Get Workspace": { "$ref": "./examples/getWorkspace.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "put": { + "tags": [ + "Workspaces" + ], + "description": "Creates or updates a workspace with the specified parameters.", + "operationId": "Workspaces_CreateOrUpdate", + "x-ms-examples": { + "Create Workspace": { "$ref": "./examples/createWorkspace.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for creating or updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "delete": { + "tags": [ + "Workspaces" + ], + "description": "Deletes a machine learning workspace.", + "operationId": "Workspaces_Delete", + "x-ms-examples": { + "Delete Workspace": { "$ref": "./examples/deleteWorkspace.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "204": { + "description": "The machine learning workspace does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "patch": { + "tags": [ + "Workspaces" + ], + "description": "Updates a machine learning workspace with the specified parameters.", + "operationId": "Workspaces_Update", + "x-ms-examples": { + "Update Workspace": { "$ref": "./examples/updateWorkspace.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available machine learning workspaces under the specified resource group.", + "operationId": "Workspaces_ListByResourceGroup", + "x-ms-examples": { + "Get Workspaces by Resource Group": { "$ref": "./examples/getWorkspacesByResourceGroup.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ListKeys", + "x-ms-examples": { + "List Workspace Keys": { "$ref": "./examples/listWorkspaceKeys.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListWorkspaceKeysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ResyncKeys", + "x-ms-examples": { + "Resync Workspace Keys": { "$ref": "./examples/resyncWorkspaceKeys.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available machine learning workspaces under the specified subscription.", + "operationId": "Workspaces_ListBySubscription", + "x-ms-examples": { + "Get Workspaces by subscription": { "$ref": "./examples/getWorkspacesBySubscription.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroup/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "MachineLearningCompute_ListByWorkspace", + "description": "Gets computes in specified workspace.", + "x-ms-examples": { + "Get Computes": { "$ref": "./examples/getComputes.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The response includes a paginated array of Machine Learning computes and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.", + "schema": { + "$ref": "#/definitions/PaginatedComputeResourcesList" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroup/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Get", + "description": "Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.", + "x-ms-examples": { + "Get a AKS Compute": { "$ref": "./examples/getAKSCompute.json" }, + "Get a BatchAI Compute": { "$ref": "./examples/getBatchAICompute.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "put": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_CreateOrUpdate", + "x-ms-long-running-operation": true, + "description": "Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.", + "x-ms-examples": { + "Create a BatchAI Compute": { "$ref": "./examples/createBasicBatchAICompute.json" }, + "Create AKS Compute": { "$ref": "./examples/createBasicAKSCompute.json" }, + "Create a DataFactory Compute": { "$ref": "./examples/createBasicDataFactoryCompute.json" }, + "Update a BatchAI Compute": { "$ref": "./examples/updateBatchAICompute.json" }, + "Update a AKS Compute": { "$ref": "./examples/updateAKSCompute.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/ComputeDefinitionParameter" + } + ], + "responses": { + "200": { + "description": "Compute creation or update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "201": { + "description": "Compute creation or update initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "delete": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Delete", + "x-ms-long-running-operation": true, + "description": "Deletes specified Machine Learning compute.", + "x-ms-examples": { + "Delete Compute": { "$ref": "./examples/deleteCompute.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "Compute deletion initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroup/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listKeys": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_GetKeys", + "description": "Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).", + "x-ms-examples": { + "List AKS Compute Keys": { "$ref": "./examples/listKeysAKSCompute.json" }, + "List BatchAI Compute Keys": { "$ref": "./examples/listKeysAKSCompute.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeSecrets" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "description": "Azure subscription identifier.", + "in": "path", + "type": "string", + "required": true + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "description": "Name of the resource group in which workspace is located.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "description": "Name of Azure Machine Learning workspace.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "ComputeNameParameter": { + "name": "computeName", + "description": "Name of the Azure Machine Learning compute.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "AsyncOperationIdParameter": { + "name": "asyncOperationId", + "description": "Identifier of an asynchronous Azure Machine Learning compute operation.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "description": "The name of the Azure location/region.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "APIVersionParameter": { + "in": "query", + "name": "api-version", + "type": "string", + "description": "Version of Azure Machine Learning resource provider API.", + "required": true + }, + "PaginationParameter": { + "in": "query", + "name": "$skiptoken", + "type": "string", + "description": "Continuation token for pagination.", + "required": false, + "x-ms-parameter-location": "method" + }, + "ComputeDefinitionParameter": { + "in": "body", + "name": "parameters", + "description": "Payload with Machine Learning compute definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ComputeResource" + }, + "x-ms-parameter-location": "method" + }, + "ComputeTypeParameter": { + "in": "query", + "name": "compute-type", + "type": "string", + "description": "Type of compute to filter by.", + "required": false, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "Operation": { + "description": "Azure Machine Learning workspace REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display name of operation", + "properties": { + "provider": { + "description": "The resource provider name: Microsoft.MachineLearningExperimentation", + "type": "string" + }, + "resource": { + "description": "The resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The operation that users can perform.", + "type": "string" + }, + "description": { + "description": "The description for the operation.", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "An array of operations supported by the resource provider.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of AML workspace operations supported by the AML workspace resource provider." + } + } + }, + "Workspace": { + "type": "object", + "description": "An object that represents a machine learning workspace.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceProperties", + "description": "The properties of the machine learning workspace.", + "x-ms-client-flatten": true + } + } + }, + "WorkspaceProperties": { + "type": "object", + "description": "The properties of a machine learning workspace.", + "properties": { + "workspaceId": { + "description": "The immutable id associated with this workspace.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for this workspace. This name in mutable", + "type": "string" + }, + "creationTime": { + "format": "date-time", + "description": "The creation time of the machine learning workspace in ISO8601 format.", + "type": "string", + "readOnly": true + }, + "keyVault": { + "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "storageAccount": { + "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "discoveryUrl": { + "description": "Url for the discovery service to identify regional endpoints for machine learning experimentation services", + "type": "string" + }, + "provisioningState": { + "type": "string", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true, + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning." + } + } + }, + "WorkspaceUpdateParameters": { + "description": "The parameters for updating a machine learning workspace.", + "properties": { + "tags": { + "description": "The resource tags for the machine learning workspace.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", + "description": "The properties that the machine learning workspace will be updated with.", + "x-ms-client-flatten": true + } + } + }, + "WorkspacePropertiesUpdateParameters": { + "description": "The parameters for updating the properties of a machine learning workspace.", + "properties": { + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for this workspace.", + "type": "string" + } + } + }, + "WorkspaceListResult": { + "description": "The result of a request to list machine learning workspaces.", + "properties": { + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of machine learning workspaces.", + "type": "string" + } + } + }, + "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" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + }, + "description": "Identity for the resource." + }, + "Resource": { + "description": "Azure Resource Manager resource envelope.", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "Specifies the resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Specifies the name of the resource.", + "type": "string", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/Identity", + "readOnly": true, + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "type": { + "description": "Specifies the type of the resource.", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ListWorkspaceKeysResult": { + "type": "object", + "properties": { + "userStorageKey": { + "readOnly": true, + "type": "string" + }, + "userStorageResourceId": { + "readOnly": true, + "type": "string" + }, + "appInsightsInstrumentationKey": { + "readOnly": true, + "type": "string" + }, + "containerRegistryCredentials": { + "readOnly": true, + "$ref": "#/definitions/RegistryListCredentialsResult" + } + } + }, + "RegistryListCredentialsResult": { + "type": "object", + "properties": { + "location": { + "readOnly": true, + "type": "string" + }, + "username": { + "readOnly": true, + "type": "string" + }, + "passwords": { + "type": "array", + "items": { + "$ref": "#/definitions/Password" + } + } + } + }, + "Password": { + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string" + }, + "value": { + "readOnly": true, + "type": "string" + } + } + }, + "PaginatedComputeResourcesList": { + "type": "object", + "description": "Paginated list of Machine Learning compute objects wrapped in ARM resource envelope.", + "properties": { + "value": { + "type": "array", + "description": "An array of Machine Learning compute objects wrapped in ARM resource envelope.", + "items": { + "$ref": "#/definitions/ComputeResource" + } + }, + "nextLink": { + "type": "string", + "description": "A continuation link (absolute URI) to the next page of results in the list." + } + } + }, + "ComputeResource": { + "type": "object", + "description": "Machine Learning compute object wrapped into ARM resource envelope.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "type": "object", + "properties":{ + "properties": { + "description": "Compute properties", + "$ref": "#/definitions/Compute" + } + } + } + ] + }, + "Compute": { + "type": "object", + "description": "Machine Learning compute object.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + }, + "provisioningState": { + "type": "string", + "description": "The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description of the Machine Learning compute." + }, + "createdOn": { + "type": "string", + "description": "The date and time when the compute was created.", + "format": "date-time", + "readOnly": true + }, + "modifiedOn": { + "type": "string", + "description": "The date and time when the compute was last modified.", + "format": "date-time", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "ARM resource id of the compute" + }, + "provisioningErrors": { + "type": "array", + "description": "Errors during provisioning", + "items": { + "$ref": "#/definitions/MachineLearningServiceError" + }, + "readOnly": true + } + }, + "required": [ + "computeType" + ] + }, + "AKS": { + "description": "A Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "description": "AKS properties", + "properties": { + "clusterFqdn": { + "description": "Cluster full qualified domain name", + "type": "string" + }, + "systemServices": { + "type": "array", + "description": "System services", + "items": { + "$ref": "#/definitions/SystemService" + } + }, + "agentCount": { + "description": "Number of agents", + "type": "integer", + "minimum": 1 + }, + "agentVMSize": { + "description": "Agent virtual machine size", + "type": "string" + }, + "sslConfiguration": { + "description": "SSL configuration", + "$ref": "#/definitions/SslConfiguration" + } + } + } + } + } + ], + "x-ms-discriminator-value": "AKS" + }, + "BatchAI": { + "description": "A Machine Learning compute based on Azure BatchAI.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "description": "BatchAI properties", + "type": "object", + "properties": { + "vmSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "vmPriority": { + "description": "Virtual Machine priority", + "type": "string" + }, + "scaleSettings": { + "description": "Scale settings for BatchAI", + "$ref": "#/definitions/ScaleSettings" + } + } + } + } + } + ], + "x-ms-discriminator-value": "BatchAI" + }, + "VirtualMachine": { + "description": "A Machine Learning compute based on Azure Virtual Machines.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "virtualMachineSize": { + "description": "Virtual Machine size", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for virtual machine", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + } + } + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "DataFactory": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + } + ], + "x-ms-discriminator-value": "DataFactory" + }, + "ServicePrincipalCredentials": { + "type": "object", + "description": "Service principal credentials.", + "properties": { + "clientId": { + "description": "Client Id", + "type": "string" + }, + "clientSecret": { + "description": "Client secret", + "type": "string" + } + }, + "required": [ + "clientId", + "clientSecret" + ] + }, + "SystemService": { + "type": "object", + "description": "A system service running on a compute.", + "properties": { + "systemServiceType": { + "description": "The type of this system service.", + "readOnly": true, + "type": "string" + }, + "publicIpAddress": { + "type": "string", + "description": "Public IP address", + "readOnly": true + }, + "version": { + "description": "The version for this type.", + "readOnly": true, + "type": "string" + } + } + }, + "SslConfiguration": { + "type": "object", + "description": "The ssl configugation for scoring", + "properties": { + "status": { + "description": "Enable or disable ssl for scoring", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ] + }, + "cert": { + "description": "Cert data", + "type": "string" + }, + "key": { + "description": "Key data", + "type": "string" + }, + "cname": { + "description": "CNAME of the cert", + "type": "string" + } + } + }, + "ScaleSettings": { + "type": "object", + "description": "scale settings for BatchAI Compute", + "properties": { + "maxNodeCount": { + "description": "Max number of nodes to use", + "type": "integer" + }, + "minNodeCount": { + "description": "Min number of nodes to use", + "type": "integer" + }, + "autoScaleEnabled": { + "description": "Enable or disable auto scale", + "type": "boolean" + } + } + }, + "VirtualMachineSshCredentials": { + "type": "object", + "description": "Admin credentials for virtual machine", + "properties": { + "username": { + "description": "Username of admin account", + "type": "string" + }, + "password": { + "description": "Password of admin account", + "type": "string" + }, + "publicKeyData": { + "description": "Public key data", + "type": "string" + }, + "privateKeyData": { + "description": "Private key data", + "type": "string" + } + } + }, + "ComputeSecrets": { + "type": "object", + "description": "Secrets related to a Machine Learning compute. Might differ for every type of compute.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + } + }, + "required": [ + "computeType" + ] + }, + "AksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "type": "object", + "properties": { + "userKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "adminKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "imagePullSecretName": { + "type": "string", + "description": "Image registry pull secret." + } + } + } + ], + "x-ms-discriminator-value": "AKS" + }, + "VirtualMachineSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "type": "object", + "properties": { + "administratorAccount": { + "description": "Admin creadentials for virtual machine.", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "ComputeType": { + "type": "string", + "description": "The type of compute", + "enum": [ + "AKS", + "BatchAI", + "DataFactory", + "VirtualMachine" + ], + "x-ms-enum": { + "name": "ComputeType", + "modelAsString": true + } + }, + "MachineLearningServiceError": { + "type": "object", + "description": "Wrapper for error response to follow ARM guidelines.", + "properties": { + "error": { + "description": "The error response.", + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response information.", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "array", + "description": "An array of error detail objects.", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorDetail": { + "type": "object", + "description": "Error detail information.", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + } + }, + "required": [ + "code", + "message" + ] + } + } +} diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md new file mode 100644 index 000000000000..a916d4644c31 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/readme.md @@ -0,0 +1,162 @@ +# MachineLearningServices + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Machine Learning Services. + + + +--- +## Getting Started +To build the SDK for EventHub, 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 Machine Learning Services API. + +``` yaml +openapi-type: arm +tag: package-2018-03-preview +``` + + +### Tag: package-2018-03-preview + +These settings apply only when `--tag=package-2018-03-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03-preview' +input-file: +- Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.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-go + - repo: azure-sdk-for-python +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.MachineLearningServices + output-folder: $(csharp-sdks-folder)/MachineLearningServices/Management.MachineLearningServices/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.machinelearningservices + package-name: azure-mgmt-machinelearningservices + package-version: 0.1.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-machinelearningservices/azure/mgmt/machinelearningservices +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-machinelearningservices +``` + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + clear-output-folder: true + namespace: services +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-03-preview +``` + +### Tag: package-2018-03-preview and go + +These settings apply only when `--tag=package-2018-03-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2018-03-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/machinelearning/mgmt/2018-03-01-preview/services +``` + + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.machinelearning.services +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-machinelearning/services +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-03-preview +``` + +### Tag: package-2018-03-preview and java + +These settings apply only when `--tag=package-2018-03-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-03-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.machinelearningservices.v2018_03_01_preview + output-folder: $(azure-libraries-for-java-folder)/machinelearningservices/resource-manager/v2018_03_01_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/machinelearningservices/resource-manager/readme.nodejs.md b/specification/machinelearningservices/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..179dbe77d266 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/readme.nodejs.md @@ -0,0 +1,15 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-machinelearningservices + package-version: 1.0.0-preview + output-folder: $(node-sdks-folder)/lib/services/machinelearningservicesManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json index 86bfac102124..321145c03d1d 100644 --- a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json @@ -1125,14 +1125,14 @@ "type": { "type": "string", "enum": [ - "/providers/Microsoft.Management/managementGroup" + "/providers/Microsoft.Management/managementGroups" ], "x-ms-enum": { "name": "Type", "modelAsString": false, "values": [ { - "value": "/providers/Microsoft.Management/managementGroup" + "value": "/providers/Microsoft.Management/managementGroups" } ] }, diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/AddManagementGroupSubscription.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/AddManagementGroupSubscription.json new file mode 100644 index 000000000000..906b8ea35511 --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/AddManagementGroupSubscription.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview", + "groupId": "Group", + "subscriptionId": "728bcbe4-8d56-4510-86c2-4921b8beefbc", + "Cache-Control": "no-cache" + }, + "responses": { + "204": { + } + } +} diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/CheckManagementGroupNameAvailability.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/CheckManagementGroupNameAvailability.json new file mode 100644 index 000000000000..77b5436cb7bc --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/CheckManagementGroupNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview", + "checkNameAvailabilityRequest": { + "name": "nameTocheck", + "type": "/providers/Microsoft.Management/managementGroups" + }, + "Cache-Control": "no-cache" + }, + "responses": { + "200": { + "nameAvailable": "true|false", + "reason": "Invalid|AlreadyExists", + "message": "" + } + } +} \ No newline at end of file diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/DeleteManagementGroup.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/DeleteManagementGroup.json new file mode 100644 index 000000000000..dce84439f257 --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/DeleteManagementGroup.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview", + "groupId": "GroupToDelete", + "Cache-Control": "no-cache" + }, + "responses": { + "202": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/GroupToDelete", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "GroupToDelete", + "properties": { + "provisioningState": "Updating" + } + } + }, + "204": { + } + } +} diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/EntitiesGetHierarchy.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/EntitiesGetHierarchy.json new file mode 100644 index 000000000000..2bf318b90cee --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/EntitiesGetHierarchy.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview", + "view": "hierarchy", + "Cache-Control": "no-cache" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/87063dd2-ab5a-438b-909a-09c03a9018ab", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "87063dd2-ab5a-438b-909a-09c03a9018ab", + "properties": { + "displayName": "87063dd2-ab5a-438b-909a-09c03a9018ab", + "permissions": "read", + "children": [ + { + "id": "/providers/Microsoft.Management/managementGroups/Root", + "type": "/providers/Microsoft.Management/managementGroup", + "name": "Root", + "properties": { + "displayName": "Root", + "permissions": "read", + "children": [ + { + "id": "/providers/Microsoft.Management/managementGroups/Child", + "type": "/providers/Microsoft.Management/managementGroup", + "name": "Child", + "properties": { + "displayName": "Child", + "permissions": "read", + "children": [] + } + } + ] + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetEntities.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetEntities.json new file mode 100644 index 000000000000..d233d7d30ea0 --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetEntities.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2018-01-01-preview", + "Cache-Control": "no-cache" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "20000000-0001-0000-0000-000000000000", + "properties": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "displayName": "Group 1 Tenant 2", + "parent": { + "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000" + }, + "permissions": "view", + "inheritedPermissions": "view", + "parentDisplayNameChain": ["Tenant Root Group", "Group 1 Tenant 2 Parent"], + "parentNameChain": ["TenantRootGroup", "Group1Tenant2Parent"], + "numberOfDescendants": 3, + "numberOfChildren": 2, + "numberOfChildGroups": 1 + } + }, + { + "id": "/providers/Microsoft.Management/managementGroups/20000000-0004-0000-0000-000000000000", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "20000000-0004-0000-0000-000000000000", + "properties": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "displayName": "Group 4 Tenant 2", + "parent": { + "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000" + }, + "permissions": "delete", + "inheritedPermissions": "delete", + "parentDisplayNameChain": ["Tenant Root Group", "Group 4 Tenant 2 Parent"], + "parentNameChain": ["TenantRootGroup", "Group4 Tenant2Parent"], + "numberOfDescendants": 0, + "numberOfChildren": 0, + "numberOfChildGroups": 0 } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetManagementGroup.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetManagementGroup.json new file mode 100644 index 000000000000..1927554effa6 --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetManagementGroup.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview", + "groupId": "20000000-0001-0000-0000-000000000000", + "Cache-Control": "no-cache" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "20000000-0001-0000-0000-000000000000", + "properties": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "displayName": "Group 1 Tenant 2", + "details": { + "version": 1, + "updatedTime": "2018-01-01T00:00:00.00Z", + "updatedBy": "16b8ef21-5c9f-420c-bcc9-e4f8c9f30b4b", + "parent": { + "id": "/providers/Microsoft.Management/managementGroups/RootGroup", + "name": "RootGroup", + "displayName": "RootGroup" + } + } + } + } + } + } +} diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetManagementGroupWithExpand.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetManagementGroupWithExpand.json new file mode 100644 index 000000000000..a08e4241dfe9 --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetManagementGroupWithExpand.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview", + "groupId": "20000000-0001-0000-0000-000000000000", + "$expand": "children", + "Cache-Control": "no-cache" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "20000000-0001-0000-0000-000000000000", + "properties": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "displayName": "Group 1 Tenant 2", + "details": { + "version": 1, + "updatedTime": "2018-01-01T00:00:00.00Z", + "updatedBy": "Test", + "parent": { + "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000", + "name": "20000000-0000-0000-0000-000000000000", + "displayName": "20000000-0000-0000-0000-000000000000" + } + }, + "children": [ + { + "id": "/providers/Microsoft.Management/managementGroups/20000000-0002-0000-0000-000000000000", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "20000000-0002-0000-0000-000000000000", + "displayName": "Group 2 Tenant 2" + }, + { + "id": "/providers/Microsoft.Management/managementGroups/20000000-0003-0000-0000-000000000000", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "20000000-0003-0000-0000-000000000000", + "displayName": "Group 3 Tenant 2" + }, + { + "id": "/subscriptions/10000000-F004-0000-0000-000000000000", + "type": "/subscriptions", + "name": "10000000-F004-0000-0000-000000000000", + "displayName": "Subscription 4 Tenant 1" + }, + { + "id": "/subscriptions/20000000-F005-0000-0000-000000000000", + "type": "/subscriptions", + "name": "20000000-F005-0000-0000-000000000000", + "displayName": "Subscription 5 Tenant 2" + }, + { + "id": "/subscriptions/30000000-F003-0000-0000-000000000000", + "type": "/subscriptions", + "name": "30000000-F003-0000-0000-000000000000", + "displayName": "Subscription 3 Tenant 3" + } + ] + } + } + } + } +} diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetManagementGroupWithExpandAndRecurse.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetManagementGroupWithExpandAndRecurse.json new file mode 100644 index 000000000000..01bc140ad49e --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetManagementGroupWithExpandAndRecurse.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview", + "groupId": "20000000-0001-0000-0000-000000000000", + "$expand": "children", + "$recurse": true, + "Cache-Control": "no-cache" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/RootGroup", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "RootGroup", + "properties": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "displayName": "RootGroup", + "details": { + "version": 2, + "updatedTime": "2018-01-25T02:26:49.0022093Z", + "updatedBy": "bd490e30-04cb-433e-b8c8-6066959a8bab", + "parent": { + "id": "/providers/Microsoft.Management/managementGroups/20000000-0000-0000-0000-000000000000", + "name": "20000000-0000-0000-0000-000000000000", + "displayName": "20000000-0000-0000-0000-000000000000" + } + }, + "children": [ + { + "id": "/providers/Microsoft.Management/managementGroups/Child", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "Child", + "displayName": "Child", + "roles": [ + "/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635" + ], + "children": [ + { + "id": "/providers/Microsoft.Management/managementGroups/Leaf", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "Leaf", + "displayName": "Leaf", + "roles": [ + "/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635" + ], + "children": [ + { + "id": "/subscriptions/728bcbe4-8d56-4510-86c2-4921b8beefbc", + "type": "/subscriptions", + "name": "728bcbe4-8d56-4510-86c2-4921b8beefbc", + "displayName": "Pay-As-You-Go", + "roles": [ + "/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635" + ] + } + ] + } + ] + }, + { + "id": "/providers/Microsoft.Management/managementGroups/AnotherChild", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "AnotherChild", + "displayName": "Leaf", + "roles": [ + "/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635" + ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetOperationResult.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetOperationResult.json new file mode 100644 index 000000000000..74f24b6cf461 --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/GetOperationResult.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview", + "operationResultsId": "7db49d55-a1f3-4abb-8c3e-94d1092a38c0" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/ChildGroup", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "ChildGroup", + "properties": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "displayName": "AlternateDisplayName", + "details": { + "version": 2, + "updatedTime": "2018-01-25T02:46:59.0545645Z", + "updatedBy": "bd490e30-04cb-433e-b8c8-6066959a8bab", + "parent": { + "id": "/providers/Microsoft.Management/managementGroups/AlternateRootGroup", + "name": "AlternateRootGroup", + "displayName": "AlternateRootGroup" + } + } + } + } + }, + "404": { + } + } +} diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/ListManagementGroups.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/ListManagementGroups.json new file mode 100644 index 000000000000..bdf8360c63b2 --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/ListManagementGroups.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview", + "Cache-Control": "no-cache" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Management/managementGroups/20000000-0001-0000-0000-000000000000", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "20000000-0001-0000-0000-000000000000", + "properties": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "displayName": "Group 1 Tenant 2" + } + }, + { + "id": "/providers/Microsoft.Management/managementGroups/20000000-0004-0000-0000-000000000000", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "20000000-0004-0000-0000-000000000000", + "properties": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "displayName": "Group 4 Tenant 2" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/PatchManagementGroup.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/PatchManagementGroup.json new file mode 100644 index 000000000000..df933c959b63 --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/PatchManagementGroup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview", + "groupId": "ChildGroup", + "patchGroupRequest": { + "displayName": "AlternateDisplayName", + "parentGroupId": "/providers/Microsoft.Management/managementGroups/AlternateRootGroup" + }, + "Cache-Control": "no-cache" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/ChildGroup", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "ChildGroup", + "properties": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "displayName": "AlternateDisplayName", + "details": { + "version": 2, + "updatedTime": "2018-01-25T02:46:59.0545645Z", + "updatedBy": "bd490e30-04cb-433e-b8c8-6066959a8bab", + "parent": { + "id": "/providers/Microsoft.Management/managementGroups/AlternateRootGroup", + "name": "AlternateRootGroup", + "displayName": "AlternateRootGroup" + } + } + } + } + } + } +} diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/PutManagementGroup.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/PutManagementGroup.json new file mode 100644 index 000000000000..0a75e97d54c8 --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/PutManagementGroup.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview", + "groupId": "ChildGroup", + "createManagementGroupRequest": { + "id": "/providers/Microsoft.Management/managementGroups/ChildGroup", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "ChildGroup", + "properties": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "displayName": "ChildGroup", + "details": { + "parent": { + "id": "/providers/Microsoft.Management/managementGroups/RootGroup" + } + } + } + }, + "Cache-Control": "no-cache" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/ChildGroup", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "ChildGroup", + "properties": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "displayName": "ChildGroup", + "details": { + "version": 1, + "updatedTime": "2018-01-01T00:00:00.00Z", + "updatedBy": "16b8ef21-5c9f-420c-bcc9-e4f8c9f30b4b", + "parent": { + "id": "/providers/Microsoft.Management/managementGroups/RootGroup", + "name": "RootGroup", + "displayName": "RootGroup" + } + } + } + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/ChildGroup", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "ChildGroup", + "properties": { + "provisioningState": "Updating" + } + } + } + } +} \ No newline at end of file diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/RemoveManagementGroupSubscription.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/RemoveManagementGroupSubscription.json new file mode 100644 index 000000000000..906b8ea35511 --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/RemoveManagementGroupSubscription.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview", + "groupId": "Group", + "subscriptionId": "728bcbe4-8d56-4510-86c2-4921b8beefbc", + "Cache-Control": "no-cache" + }, + "responses": { + "204": { + } + } +} diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/StartTenantBackfillRequest.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/StartTenantBackfillRequest.json new file mode 100644 index 000000000000..6638cf8528fb --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/StartTenantBackfillRequest.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview", + "startTenantBackfillRequest": { + } + }, + "responses": { + "200": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "status": "Started" + } + } +} \ No newline at end of file diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/TenantBackfillStatusRequest.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/TenantBackfillStatusRequest.json new file mode 100644 index 000000000000..ad04f5604af0 --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/examples/TenantBackfillStatusRequest.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview", + "tenantBackfillStatusRequest": { + } + }, + "responses": { + "200": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "status": "Started" + } + } +} diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/management.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/management.json new file mode 100644 index 000000000000..f517d090124c --- /dev/null +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/management.json @@ -0,0 +1,1511 @@ +{ + "swagger": "2.0", + "host": "management.azure.com", + "info": { + "version": "2018-03-01-preview", + "title": "Management Groups API", + "description": "The Azure Management Groups API enables consolidation of multiple subscriptions/resources into an organizational hierarchy and centrally manage access control, policies, alerting and reporting for those resources." + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ManagementGroups", + "description": "A Management Group is a customer defined scope (grouping mechanism) that provides access control (authorization), policy management and reporting. Management Groups are organized in a strictly tree-based hierarchy." + }, + { + "name": "Operations", + "description": "Management operations supported by the Microsoft.Management resource provider." + }, + { + "name": "Entities", + "description": "A list of entities that belong to the Management Groups." + } + ], + "paths": { + "/providers/Microsoft.Management/managementGroups": { + "get": { + "tags": [ + "ManagementGroups" + ], + "operationId": "ManagementGroups_List", + "description": "List management groups for the authenticated user.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CacheControlHeader" + }, + { + "$ref": "#/parameters/SkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagementGroupListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListManagementGroups": { + "$ref": "./examples/ListManagementGroups.json" + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{groupId}": { + "get": { + "tags": [ + "ManagementGroups" + ], + "operationId": "ManagementGroups_Get", + "description": "Get the details of the management group.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + }, + { + "$ref": "#/parameters/RecurseParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/CacheControlHeader" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagementGroup" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetManagementGroup": { + "$ref": "./examples/GetManagementGroup.json" + }, + "GetManagementGroupWithExpand": { + "$ref": "./examples/GetManagementGroupWithExpand.json" + }, + "GetManagementGroupsWithExpandAndRecurse": { + "$ref": "./examples/GetManagementGroupWithExpandAndRecurse.json" + } + } + }, + "put": { + "tags": [ + "ManagementGroups" + ], + "operationId": "ManagementGroups_CreateOrUpdate", + "description": "Create or update a management group. If a management group is already created and a subsequent create request is issued with different properties, the management group properties will be updated.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CacheControlHeader" + }, + { + "$ref": "#/parameters/CreateManagementGroupRequestParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagementGroup" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/OperationResults" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PutManagementGroup": { + "$ref": "./examples/PutManagementGroup.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "ManagementGroups" + ], + "operationId": "ManagementGroups_Update", + "description": "Update a management group.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CacheControlHeader" + }, + { + "$ref": "#/parameters/PatchGroupRequestParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagementGroup" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PatchManagementGroup": { + "$ref": "./examples/PatchManagementGroup.json" + } + } + }, + "delete": { + "tags": [ + "ManagementGroups" + ], + "operationId": "ManagementGroups_Delete", + "description": "Delete management group. If a management group contains child resources, the request will fail.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CacheControlHeader" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/OperationResults" + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteManagementGroup": { + "$ref": "./examples/DeleteManagementGroup.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.Management/managementGroups/{groupId}/subscriptions/{subscriptionId}": { + "put": { + "tags": [ + "ManagementGroups" + ], + "operationId": "ManagementGroupSubscriptions_Create", + "description": "Associates existing subscription with the management group.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CacheControlHeader" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AddSubscriptionToManagementGroup": { + "$ref": "./examples/AddManagementGroupSubscription.json" + } + } + }, + "delete": { + "tags": [ + "ManagementGroups" + ], + "operationId": "ManagementGroupSubscriptions_Delete", + "description": "De-associates subscription from the management group.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CacheControlHeader" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteSubscriptionFromManagementGroup": { + "$ref": "./examples/RemoveManagementGroupSubscription.json" + } + } + } + }, + "/providers/Microsoft.Management/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available Management REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Management/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "CheckNameAvailability", + "description": "Checks if the specified management group name is valid and unique", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CheckNameAvailabilityParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckManagementGroupNameAvailability": { + "$ref": "./examples/CheckManagementGroupNameAvailability.json" + } + } + } + }, + "/providers/Microsoft.Management/getEntities": { + "post": { + "tags": [ + "Entities" + ], + "operationId": "Entities_List", + "description": "List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SkipTokenParameter" + }, + { + "$ref": "#/parameters/SkipParameter" + }, + { + "$ref": "#/parameters/TopParameter" + }, + { + "$ref": "#/parameters/SelectParameter" + }, + { + "$ref": "#/parameters/SearchParameter" + }, + { + "$ref": "#/parameters/EntityFilterParameter" + }, + { + "$ref": "#/parameters/EntityViewParameter" + }, + { + "$ref": "#/parameters/GroupNameParameter" + }, + { + "$ref": "#/parameters/CacheControlHeader" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetEntities": { + "$ref": "./examples/GetEntities.json" + } + } + } + }, + "/providers/Microsoft.Management/startTenantBackfill": { + "post": { + "tags": [ + "TenantBackfill" + ], + "operationId": "StartTenantBackfill", + "description": "Starts backfilling subscriptions for the Tenant.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/TenantBackfillStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "StartTenantBackfill": { + "$ref": "./examples/StartTenantBackfillRequest.json" + } + } + } + }, + "/providers/Microsoft.Management/tenantBackfillStatus": { + "post": { + "tags": [ + "TenantBackfill" + ], + "operationId": "TenantBackfillStatus", + "description": "Gets tenant backfill status", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/TenantBackfillStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TenantBackfillStatus": { + "$ref": "./examples/TenantBackfillStatusRequest.json" + } + } + } + } + }, + "definitions": { + "ErrorResponse": { + "description": "The error object.", + "properties": { + "error": { + "title": "Error", + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "One of a server-defined set of error codes.", + "type": "string" + }, + "message": { + "description": "A human-readable representation of the error.", + "type": "string" + }, + "details": { + "description": "A human-readable representation of the error's details.", + "type": "string" + } + } + }, + "Operation": { + "description": "Operation supported by the Microsoft.Management resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + }, + "display": { + "title": "Display", + "$ref": "#/definitions/OperationDisplayProperties" + } + } + }, + "OperationDisplayProperties": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "The name of the provider.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The resource on which the operation is performed.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The operation that can be performed.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "Operation description.", + "type": "string", + "readOnly": true + } + } + }, + "OperationListResult": { + "description": "Describes the result of the request to list Microsoft.Management operations.", + "properties": { + "value": { + "description": "List of operations supported by the Microsoft.Management 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 + } + } + }, + "CheckNameAvailabilityResult": { + "description": "Describes the result of the request to check management group name availability.", + "properties": { + "nameAvailable": { + "description": "Required. True indicates name is valid and available. False indicates the name is invalid, unavailable, or both.", + "type": "boolean", + "readOnly": true + }, + "reason": { + "description": "Required if nameAvailable == false. Invalid indicates the name provided does not match the resource provider's naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.", + "type": "string", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": false, + "values": [ + { + "value": "Invalid" + }, + { + "value": "AlreadyExists" + } + ] + }, + "readOnly": true + }, + "message": { + "description": "Required if nameAvailable == false. Localized. If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name.", + "type": "string", + "readOnly": true + } + } + }, + "TenantBackfillStatusResult": { + "description": "The tenant backfill status", + "properties": { + "tenantId": { + "type": "string", + "description": "The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000", + "readOnly": true + }, + "status": { + "description": "The status of the Tenant Backfill", + "type": "string", + "enum": [ + "NotStarted", + "NotStartedButGroupsExist", + "Started", + "Failed", + "Cancelled", + "Completed" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": false, + "values": [ + { + "value": "NotStarted" + }, + { + "value": "NotStartedButGroupsExist" + }, + { + "value": "Started" + }, + { + "value": "Failed" + }, + { + "value": "Cancelled" + }, + { + "value": "Completed" + } + ] + }, + "readOnly": true + } + } + }, + "ManagementGroupListResult": { + "description": "Describes the result of the request to list management groups.", + "properties": { + "value": { + "description": "The list of management groups.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagementGroupInfo" + } + }, + "nextLink": { + "description": "The URL to use for getting the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ManagementGroupInfo": { + "description": "The management group resource.", + "properties": { + "id": { + "type": "string", + "description": "The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the resource. For example, /providers/Microsoft.Management/managementGroups", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the management group. For example, 00000000-0000-0000-0000-000000000000", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "title": "Properties", + "$ref": "#/definitions/ManagementGroupInfoProperties" + } + } + }, + "ManagementGroupInfoProperties": { + "description": "The generic properties of a management group.", + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000" + }, + "displayName": { + "type": "string", + "description": "The friendly name of the management group." + } + } + }, + "ManagementGroup": { + "description": "The management group details.", + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "description": "The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the resource. For example, /providers/Microsoft.Management/managementGroups", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the management group. For example, 00000000-0000-0000-0000-000000000000", + "readOnly": true + }, + "properties": { + "title": "Properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagementGroupProperties" + } + } + }, + "ManagementGroupProperties": { + "description": "The generic properties of a management group.", + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000" + }, + "displayName": { + "type": "string", + "description": "The friendly name of the management group." + }, + "roles": { + "description": "The role definitions associated with the management group.", + "type": "array", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "details": { + "title": "Details", + "$ref": "#/definitions/ManagementGroupDetails" + }, + "children": { + "description": "The list of children.", + "x-nullable": true, + "type": "array", + "items": { + "$ref": "#/definitions/ManagementGroupChildInfo" + } + } + } + }, + "ManagementGroupDetails": { + "description": "The details of a management group.", + "type": "object", + "properties": { + "version": { + "type": "number", + "format": "int32", + "description": "The version number of the object." + }, + "updatedTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when this object was last updated." + }, + "updatedBy": { + "type": "string", + "description": "The identity of the principal or process that updated the object." + }, + "parent": { + "title": "Parent", + "$ref": "#/definitions/ParentGroupInfo" + } + } + }, + "ManagementGroupChildInfo": { + "description": "The child information of a management group.", + "properties": { + "type": { + "title": "The type of child resource.", + "$ref": "#/definitions/ManagementGroupChildType", + "description": "The fully qualified resource type which includes provider namespace (e.g. /providers/Microsoft.Management/managementGroups)" + }, + "id": { + "type": "string", + "description": "The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000" + }, + "name": { + "type": "string", + "description": "The name of the child entity." + }, + "displayName": { + "type": "string", + "description": "The friendly name of the child resource." + }, + "roles": { + "description": "The roles definitions associated with the management group.", + "type": "array", + "items": { + "type": "string" + } + }, + "children": { + "description": "The list of children.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagementGroupChildInfo" + } + } + } + }, + "ParentGroupInfo": { + "description": "(Optional) The ID of the parent management group.", + "properties": { + "id": { + "type": "string", + "description": "The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000" + }, + "name": { + "type": "string", + "description": "The name of the parent management group" + }, + "displayName": { + "type": "string", + "description": "The friendly name of the parent management group." + } + } + }, + "ManagementGroupChildType": { + "type": "string", + "enum": [ + "/providers/Microsoft.Management/managementGroups", + "/subscriptions" + ], + "description": "The type of child resource." + }, + "OperationResults": { + "description": "The results of an asynchronous operation.", + "properties": { + "id": { + "type": "string", + "description": "The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the resource. For example, /providers/Microsoft.Management/managementGroups", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the management group. For example, 00000000-0000-0000-0000-000000000000", + "readOnly": true + }, + "properties": { + "title": "Properties", + "x-ms-client-flatten": true, + "type": "object", + "properties": { + "provisioningState": { + "title": "Provisioning State", + "$ref": "#/definitions/ProvisioningState" + } + } + } + } + }, + "EntityListResult": { + "description": "Describes the result of the request to view entities.", + "properties": { + "value": { + "description": "The list of entities.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityInfo" + } + }, + "count": { + "description": "Total count of records that match the filter", + "type": "integer", + "readOnly": true + }, + "nextLink": { + "description": "The URL to use for getting the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "EntityInfo": { + "description": "The entity.", + "properties": { + "id": { + "type": "string", + "description": "The fully qualified ID for the entity. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000", + "readOnly": true, + "x-nullable": true + }, + "type": { + "type": "string", + "description": "The type of the resource. For example, /providers/Microsoft.Management/managementGroups", + "readOnly": true, + "x-nullable": true + }, + "name": { + "type": "string", + "description": "The name of the entity. For example, 00000000-0000-0000-0000-000000000000", + "readOnly": true + }, + "properties": { + "title": "Properties", + "x-ms-client-flatten": true, + "x-nullable": true, + "$ref": "#/definitions/EntityInfoProperties" + } + } + }, + "EntityInfoProperties": { + "description": "The generic properties of an entity.", + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000", + "x-nullable": true + }, + "displayName": { + "type": "string", + "description": "The friendly name of the management group.", + "x-nullable": true + }, + "parent": { + "title": "Parent", + "$ref": "#/definitions/EntityParentGroupInfo", + "x-nullable": true + }, + "permissions": { + "title": "Permissions", + "x-nullable": true, + "$ref": "#/definitions/Permissions" + }, + "inheritedPermissions": { + "title": "Inherited Permissions", + "x-nullable": true, + "$ref": "#/definitions/Permissions" + }, + "numberOfDescendants": { + "title": "Number of Descendants", + "type": "integer", + "x-nullable": true + }, + "numberOfChildren": { + "title": "Number of Children", + "description": "Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group.", + "type": "integer", + "x-nullable": true + }, + "numberOfChildGroups": { + "title": "Number of Child Groups", + "description": "Number of child groups is the number of Groups that are exactly one level underneath the current Group.", + "type": "integer", + "x-nullable": true + }, + "parentDisplayNameChain": { + "type": "array", + "description": "The parent display name chain from the root group to the immediate parent", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "parentNameChain": { + "type": "array", + "description": "The parent name chain from the root group to the immediate parent", + "x-nullable": true, + "items": { + "type": "string" + } + } + } + }, + "EntityParentGroupInfo": { + "description": "(Optional) The ID of the parent management group.", + "properties": { + "id": { + "type": "string", + "description": "The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000" + } + } + }, + "EntityHierarchyItem": { + "description": "The management group details for the hierarchy view.", + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "description": "The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the resource. For example, /providers/Microsoft.Management/managementGroups", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the management group. For example, 00000000-0000-0000-0000-000000000000", + "readOnly": true + }, + "properties": { + "title": "Properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/EntityHierarchyItemProperties" + } + } + }, + "EntityHierarchyItemProperties": { + "description": "The generic properties of a management group.", + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "The friendly name of the management group." + }, + "permissions": { + "title": "Permissions", + "$ref": "#/definitions/Permissions" + }, + "children": { + "type": "array", + "description": "The list of children.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/EntityHierarchyItem" + } + } + } + }, + "PatchManagementGroupRequest": { + "description": "Management group patch parameters.", + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "The friendly name of the management group.", + "x-nullable": true + }, + "parentId": { + "type": "string", + "description": "(Optional) The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000", + "x-nullable": true + } + } + }, + "CreateManagementGroupRequest": { + "description": "Management group creation parameters.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "description": "The fully qualified ID for the management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the resource. For example, /providers/Microsoft.Management/managementGroups", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the management group. For example, 00000000-0000-0000-0000-000000000000" + }, + "properties": { + "title": "Properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CreateManagementGroupProperties" + } + } + }, + "CreateManagementGroupProperties": { + "description": "The generic properties of a management group used during creation.", + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "readOnly": true, + "description": "The AAD Tenant ID associated with the management group. For example, 00000000-0000-0000-0000-000000000000" + }, + "displayName": { + "type": "string", + "description": "The friendly name of the management group. If no value is passed then this field will be set to the groupId.", + "x-nullable": true + }, + "roles": { + "description": "The roles definitions associated with the management group.", + "readOnly": true, + "type": "array", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "details": { + "title": "Details", + "$ref": "#/definitions/CreateManagementGroupDetails" + }, + "children": { + "description": "The list of children.", + "readOnly": true, + "x-nullable": true, + "type": "array", + "items": { + "$ref": "#/definitions/CreateManagementGroupChildInfo" + } + } + } + }, + "CreateManagementGroupDetails": { + "description": "The details of a management group used during creation.", + "type": "object", + "properties": { + "version": { + "type": "number", + "readOnly": true, + "format": "int32", + "description": "The version number of the object." + }, + "updatedTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date and time when this object was last updated." + }, + "updatedBy": { + "type": "string", + "readOnly": true, + "description": "The identity of the principal or process that updated the object." + }, + "parent": { + "title": "Parent", + "$ref": "#/definitions/CreateParentGroupInfo" + } + } + }, + "CreateManagementGroupChildInfo": { + "description": "The child information of a management group used during creation.", + "properties": { + "type": { + "title": "The type of child resource.", + "readOnly": true, + "$ref": "#/definitions/ManagementGroupChildType", + "description": "The fully qualified resource type which includes provider namespace (e.g. /providers/Microsoft.Management/managementGroups)" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the child entity." + }, + "displayName": { + "type": "string", + "readOnly": true, + "description": "The friendly name of the child resource." + }, + "roles": { + "description": "The roles definitions associated with the management group.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "children": { + "description": "The list of children.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CreateManagementGroupChildInfo" + } + } + } + }, + "CreateParentGroupInfo": { + "description": "(Optional) The ID of the parent management group used during creation.", + "properties": { + "id": { + "type": "string", + "description": "The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the parent management group" + }, + "displayName": { + "type": "string", + "readOnly": true, + "description": "The friendly name of the parent management group." + } + } + }, + "Permissions": { + "type": "string", + "enum": [ + "noaccess", + "view", + "edit", + "delete" + ], + "description": "The users specific permissions to this item." + }, + "CheckNameAvailabilityRequest": { + "description": "Management group name availability check parameters.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "the name to check for availability" + }, + "type": { + "type": "string", + "enum": [ + "/providers/Microsoft.Management/managementGroups" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false, + "values": [ + { + "value": "/providers/Microsoft.Management/managementGroups" + } + ] + }, + "description": "fully qualified resource type which includes provider namespace" + } + } + }, + "ProvisioningState": { + "title": "Provisioning State", + "type": "string", + "enum": [ + "Updating" + ], + "description": "The provisioning status." + } + }, + "parameters": { + "GroupIdParameter": { + "name": "groupId", + "in": "path", + "required": true, + "type": "string", + "description": "Management Group ID.", + "x-ms-parameter-location": "method" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription ID.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. The current version is 2018-01-01-preview." + }, + "ExpandParameter": { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "children" + ], + "x-ms-parameter-location": "method", + "description": "The $expand=children query string parameter allows clients to request inclusion of children in the response payload." + }, + "RecurseParameter": { + "name": "$recurse", + "in": "query", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "The $recurse=true query string parameter allows clients to request inclusion of entire hierarchy in the response payload. Note that $expand=children must be passed up if $recurse is set to true." + }, + "CreateManagementGroupRequestParameter": { + "name": "createManagementGroupRequest", + "in": "body", + "required": true, + "description": "Management group creation parameters.", + "schema": { + "$ref": "#/definitions/CreateManagementGroupRequest" + }, + "x-ms-parameter-location": "method" + }, + "PatchGroupRequestParameter": { + "name": "patchGroupRequest", + "in": "body", + "required": true, + "description": "Management group patch parameters.", + "schema": { + "$ref": "#/definitions/PatchManagementGroupRequest" + }, + "x-ms-parameter-location": "method" + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "description": "A filter which allows the exclusion of subscriptions from results (i.e. '$filter=children.childType ne Subscription')", + "type": "string", + "x-ms-parameter-location": "method" + }, + "EntityFilterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "description": "The filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}') and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "SelectParameter": { + "name": "$select", + "in": "query", + "required": false, + "description": "This parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "SearchParameter": { + "name": "$search", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "AllowedParents", + "AllowedChildren", + "ParentAndFirstLevelChildren", + "ParentOnly", + "ChildrenOnly" + ], + "x-ms-parameter-location": "method", + "description": "The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions. With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity. With $search=ParentAndFirstLevelChildren the API will return the parent and first level of children that the user has either direct access to or indirect access via one of their descendants." + }, + "GroupNameParameter": { + "name": "groupName", + "in": "query", + "required": false, + "description": "A filter which allows the get entities call to focus on a particular group (i.e. \"$filter=name eq 'groupName'\")", + "type": "string", + "x-ms-parameter-location": "method" + }, + "OperationResultIdParameter": { + "name": "operationResultId", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "create", + "delete" + ], + "description": "The id of the operation result.", + "x-ms-parameter-location": "method" + }, + "CheckNameAvailabilityParameter": { + "name": "checkNameAvailabilityRequest", + "in": "body", + "required": true, + "description": "Management group name availability check parameters.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityRequest" + }, + "x-ms-parameter-location": "method" + }, + "SkipParameter": { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "Number of entities to skip over when retrieving results. Passing this in will override $skipToken.", + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Number of elements to return when retrieving results. Passing this in will override $skipToken.", + "x-ms-parameter-location": "method" + }, + "SkipTokenParameter": { + "name": "$skiptoken", + "in": "query", + "required": false, + "type": "string", + "description": "Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.", + "x-ms-parameter-location": "method" + }, + "CacheControlHeader": { + "name": "Cache-Control", + "in": "header", + "default": "no-cache", + "description": "Indicates that the request shouldn't utilize any caches.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "EntityViewParameter": { + "name": "$view", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "FullHierarchy", + "GroupsOnly", + "SubscriptionsOnly", + "Audit" + ], + "x-ms-parameter-location": "method", + "description": "The view parameter allows clients to filter the type of data that is returned by the getEntities call." + } + } +} \ No newline at end of file diff --git a/specification/managementgroups/resource-manager/readme.md b/specification/managementgroups/resource-manager/readme.md index 19b0d5b80f3c..a0b29d07e017 100644 --- a/specification/managementgroups/resource-manager/readme.md +++ b/specification/managementgroups/resource-manager/readme.md @@ -24,7 +24,14 @@ These are the global settings for the API. ``` yaml openapi-type: arm -tag: package-2017-11 +tag: package-2018-03 +``` +### Tag: package-2018-03 +These settings apply only when `--tag=package-2018-03` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03' +input-file: + - Microsoft.Management/preview/2018-03-01-preview/management.json ``` ### Tag: package-2018-01 @@ -63,7 +70,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go ``` @@ -123,18 +130,28 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-03 - tag: package-2018-01 - tag: package-2017-11 - tag: package-2017-08 ``` +### Tag: package-2018-03 and go + +These settings apply only when `--tag=package-2018-03 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2018-03' && $(go) +output-folder: $(go-sdk-folder)/services/preview/resources/mgmt/2018-03-01-preview/management +``` + ### Tag: package-2018-01 and go These settings apply only when `--tag=package-2018-01 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2018-01' && $(go) -output-folder: $(go-sdk-folder)/services/resources/mgmt/2018-01-01-preview/management +output-folder: $(go-sdk-folder)/services/preview/resources/mgmt/2018-01-01-preview/management ``` ### Tag: package-2017-11 and go @@ -143,7 +160,7 @@ These settings apply only when `--tag=package-2017-11 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2017-11' && $(go) -output-folder: $(go-sdk-folder)/services/resources/mgmt/2017-11-01-preview/management +output-folder: $(go-sdk-folder)/services/preview/resources/mgmt/2017-11-01-preview/management ``` ### Tag: package-2017-08 and go @@ -152,7 +169,7 @@ These settings apply only when `--tag=package-2017-08 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2017-08' && $(go) -output-folder: $(go-sdk-folder)/services/resources/mgmt/2017-08-31-preview/management +output-folder: $(go-sdk-folder)/services/preview/resources/mgmt/2017-08-31-preview/management ``` ## Java @@ -161,11 +178,74 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.managementgroups +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-managementgroups +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-08 + - tag: package-2017-11 + - tag: package-2018-01 + - tag: package-2018-03 +``` + +### Tag: package-2017-08 and java + +These settings apply only when `--tag=package-2017-08 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-08' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.managementgroups - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-managementgroups + namespace: com.microsoft.azure.management.managementgroups.v2017_08_31_preview + output-folder: $(azure-libraries-for-java-folder)/managementgroups/resource-manager/v2017_08_31_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-11 and java + +These settings apply only when `--tag=package-2017-11 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-11' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.managementgroups.v2017_11_01_preview + output-folder: $(azure-libraries-for-java-folder)/managementgroups/resource-manager/v2017_11_01_preview +regenerate-manager: true +generate-interface: true ``` + +### Tag: package-2018-01 and java + +These settings apply only when `--tag=package-2018-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.managementgroups.v2018_01_01_preview + output-folder: $(azure-libraries-for-java-folder)/managementgroups/resource-manager/v2018_01_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-03 and java + +These settings apply only when `--tag=package-2018-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.managementgroups.v2018_03_01_preview + output-folder: $(azure-libraries-for-java-folder)/managementgroups/resource-manager/v2018_03_01_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/managementgroups/resource-manager/readme.ruby.md b/specification/managementgroups/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..98710115a068 --- /dev/null +++ b/specification/managementgroups/resource-manager/readme.ruby.md @@ -0,0 +1,37 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_resources_management +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2017-11 + - tag: package-2017-08 +``` + +### Tag: package-2017-11 and ruby + +These settings apply only when `--tag=package-2017-11 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-11' && $(ruby) +namespace: "Azure::ResourcesManagement::Mgmt::V2017_11_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_resources_management/lib +``` + +### Tag: package-2017-08 and ruby + +These settings apply only when `--tag=package-2017-08 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-08' && $(ruby) +namespace: "Azure::ResourcesManagement::Mgmt::V2017_08_31_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_resources_management/lib +``` \ No newline at end of file diff --git a/specification/managementpartner/resource-manager/readme.md b/specification/managementpartner/resource-manager/readme.md index 87cf9a786402..942cfb72fcca 100644 --- a/specification/managementpartner/resource-manager/readme.md +++ b/specification/managementpartner/resource-manager/readme.md @@ -7,6 +7,28 @@ This is the AutoRest configuration file for ManagementPartner RP. --- + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-02 +``` + +### Tag: package-2018-02 and java + +These settings apply only when `--tag=package-2018-02 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-02' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.managementpartner.v2018_02_01 + output-folder: $(azure-libraries-for-java-folder)/managementpartner/resource-manager/v2018_02_01 +regenerate-manager: true +generate-interface: true +``` + + ## Getting Started To build the SDK for ManagementPartner, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: @@ -91,7 +113,7 @@ These settings apply only when `--tag=package-2018-02 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2018-02' && $(go) -output-folder: $(go-sdk-folder)/services/managementpartner/mgmt/2018-02-01/managementpartner +output-folder: $(go-sdk-folder)/services/preview/managementpartner/mgmt/2018-02-01/managementpartner ``` ## Python diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/CreateAccount.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/CreateAccount.json new file mode 100644 index 000000000000..9a5e50f533fa --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/CreateAccount.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2017-01-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "MapsAccountCreateParameters": { + "location": "global", + "sku": { + "name": "S0" + }, + "tags": { + "test": "true" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/DeleteAccount.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/DeleteAccount.json new file mode 100644 index 000000000000..6d0fee2de058 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/DeleteAccount.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2017-01-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/GetAccount.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/GetAccount.json new file mode 100644 index 000000000000..1901bd642252 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/GetAccount.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2017-01-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + } + }, + "404": {} + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/GetOperations.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/GetOperations.json new file mode 100644 index 000000000000..21771c94016a --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/GetOperations.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2017-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Maps/register/action", + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Register the provider", + "description": "Register the provider" + } + }, + { + "name": "Microsoft.Maps/accounts/write", + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Create or update a Maps Account.", + "description": "Create or update a Maps Account." + } + }, + { + "name": "Microsoft.Maps/accounts/read", + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Get a Maps Account.", + "description": "Get a Maps Account." + } + }, + { + "name": "Microsoft.Maps/accounts/delete", + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Delete a Maps Account.", + "description": "Delete a Maps Account." + } + }, + { + "name": "Microsoft.Maps/accounts/listKeys/action", + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "List keys", + "description": "List Maps Account keys" + } + }, + { + "name": "Microsoft.Maps/accounts/regenerateKey/action", + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Generate new primary or secondary key", + "description": "Generate new Maps Account primary or secondary key" + } + } + ] + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/ListAccountsByResourceGroup.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/ListAccountsByResourceGroup.json new file mode 100644 index 000000000000..c0f6026804f1 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/ListAccountsByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2017-01-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": + "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount2", + "name": "myMapsAccount2", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + }, + { + "id": + "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/ListAccountsBySubscription.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/ListAccountsBySubscription.json new file mode 100644 index 000000000000..6186f5bac989 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/ListAccountsBySubscription.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2017-01-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount2", + "name": "myMapsAccount2", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + }, + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/ListKeys.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/ListKeys.json new file mode 100644 index 000000000000..17c743fcc2fb --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/ListKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2017-01-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "primaryKey": "ZiBllKWCwXXLTO13S2TaoHoK8kPFYaoyYlAcnCcE4PQ", + "secondaryKey": "cJHpmUGNaGGO8H59p6NKGhfff9VjD278-2bi5wo0_mU" + } + }, + "404": {} + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/MoveAccounts.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/MoveAccounts.json new file mode 100644 index 000000000000..b9ccb514ea02 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/MoveAccounts.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2017-01-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "moveRequest": { + "targetResourceGroup": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup2", + "resourceIds": [ + "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount2" + ] + } + }, + "responses": { + "200": { + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/RegenerateKey.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/RegenerateKey.json new file mode 100644 index 000000000000..cc6bfd5624dc --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/RegenerateKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2017-01-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "keySpecification": { + "keyType": "primary" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "primaryKey": "uj0yqjjz8zG3IOSWvb_smi1q1QenGtupAqrOA1zCO6s", + "secondaryKey": "cJHpmUGNaGGO8H59p6NKGhfff9VjD278-2bi5wo0_mU" + } + }, + "404": {} + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/UpdateAccount.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/UpdateAccount.json new file mode 100644 index 000000000000..1f6fda9553a5 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/examples/UpdateAccount.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2017-01-01-preview", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "MapsAccountUpdateParameters": { + "tags": { + "specialTag": "true" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "specialTag": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + } + }, + "404": {} + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/maps-management.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/maps-management.json new file mode 100644 index 000000000000..df159a8856bf --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2017-01-01-preview/maps-management.json @@ -0,0 +1,789 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Resource Provider", + "description": "Resource Provider", + "version": "2017-01-01-preview", + "x-ms-code-generation-settings": { + "name": "MapsManagementClient" + } + }, + "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.Maps/accounts/{accountName}": { + "put": { + "description": "Create or update a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs.", + "operationId": "Accounts_CreateOrUpdate", + "x-ms-examples": { + "CreateAccount": { + "$ref": "./examples/CreateAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "MapsAccountCreateParameters", + "in": "body", + "description": "The new or updated parameters for the Maps Account.", + "required": true, + "schema": { + "$ref": "#/definitions/MapsAccountCreateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Account was successfully updated.", + "schema": { + "$ref": "#/definitions/MapsAccount" + } + }, + "201": { + "description": "The Account was successfully created.", + "schema": { + "$ref": "#/definitions/MapsAccount" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "description": "Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku and Tags.", + "operationId": "Accounts_Update", + "x-ms-examples": { + "UpdateAccount": { + "$ref": "./examples/UpdateAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "MapsAccountUpdateParameters", + "in": "body", + "description": "The updated parameters for the Maps Account.", + "required": true, + "schema": { + "$ref": "#/definitions/MapsAccountUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Account was successfully updated.", + "schema": { + "$ref": "#/definitions/MapsAccount" + } + }, + "404": { + "description": "The specified Account was not found. Nothing was updated." + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "delete": { + "description": "Delete a Maps Account.", + "operationId": "Accounts_Delete", + "x-ms-examples": { + "DeleteAccount": { + "$ref": "./examples/DeleteAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + } + ], + "responses": { + "200": { + "description": "The Account was deleted successfully." + }, + "204": { + "description": "The specified Account was not found. Nothing was deleted." + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "get": { + "description": "Get a Maps Account.", + "operationId": "Accounts_Get", + "x-ms-examples": { + "GetAccount": { + "$ref": "./examples/GetAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccount" + } + }, + "404": { + "description": "The specified Account does not exist." + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts": { + "get": { + "description": "Get all Maps Accounts in a Resource Group", + "operationId": "Accounts_ListByResourceGroup", + "x-ms-examples": { + "ListAccountsByResourceGroup": { + "$ref": "./examples/ListAccountsByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null, + "itemName": "value" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccounts" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maps/accounts": { + "get": { + "description": "Get all Maps Accounts in a Subscription", + "operationId": "Accounts_ListBySubscription", + "x-ms-examples": { + "ListAccountsBySubscription": { + "$ref": "./examples/ListAccountsBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null, + "itemName": "value" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccounts" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources": { + "post": { + "description": "Moves Maps Accounts from one ResourceGroup (or Subscription) to another", + "operationId": "Accounts_Move", + "x-ms-examples": { + "MoveAccounts": { + "$ref": "./examples/MoveAccounts.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains Maps Account to move.", + "required": true, + "type": "string" + }, + { + "name": "moveRequest", + "in": "body", + "description": "The details of the Maps Account move.", + "required": true, + "schema": { + "$ref": "#/definitions/MapsAccountsMoveRequest" + } + } + ], + "responses": { + "200": { + "description": "The Accounts were successfully moved." + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/listKeys": { + "post": { + "description": "Get the keys to use with the Maps APIs. A key is used to authenticate and authorize access to the Maps REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.", + "operationId": "Accounts_ListKeys", + "x-ms-examples": { + "ListKeys": { + "$ref": "./examples/ListKeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccountKeys" + } + }, + "404": { + "description": "The specified Account does not exist." + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/regenerateKey": { + "post": { + "description": "Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately.", + "operationId": "Accounts_RegenerateKeys", + "x-ms-examples": { + "RegenerateKey": { + "$ref": "./examples/RegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "keySpecification", + "in": "body", + "required": true, + "description": "Which key to regenerate: primary or secondary.", + "schema": { + "$ref": "#/definitions/MapsKeySpecification" + } + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccountKeys" + } + }, + "404": { + "description": "The specified Account does not exist." + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.Maps/operations": { + "get": { + "description": "List operations available for the Maps Resource Provider", + "operationId": "Accounts_ListOperations", + "x-ms-examples": { + "GetOperations": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null, + "itemName": "value" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsOperations" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + } + }, + "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." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the Azure Resource Group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AccountNameParameter": { + "name": "accountName", + "in": "path", + "description": "The name of the Maps Account.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "Error": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the component generating the error." + }, + "details": { + "type": "array", + "readOnly": true, + "description": "If available, a list of additional details about the error.", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the component generating the error." + } + } + } + } + } + }, + "Resource": { + "description": "An Azure resource", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The fully qualified Maps Account resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the Maps Account, which is unique within a Resource Group." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Azure resource type." + } + }, + "x-ms-azure-resource": true + }, + "MapsAccount": { + "description": "An Azure resource which represents access to a suite of Maps REST APIs.", + "type": "object", + "properties": { + "location": { + "readOnly": true, + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." + }, + "sku": { + "readOnly": true, + "description": "The SKU of this account.", + "$ref": "#/definitions/Sku" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "MapsAccountCreateParameters": { + "description": "Parameters used to create a new Maps Account.", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The location of the resource." + }, + "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 in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." + }, + "sku": { + "description": "The SKU of this account.", + "$ref": "#/definitions/Sku" + } + }, + "required": [ + "location", + "sku" + ] + }, + "MapsAccountUpdateParameters": { + "description": "Parameters used to update an existing Maps Account.", + "type": "object", + "properties": { + "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 in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." + }, + "sku": { + "description": "The SKU of this account.", + "$ref": "#/definitions/Sku" + } + } + }, + "MapsAccounts": { + "description": "A list of Maps Accounts.", + "type": "object", + "properties": { + "value": { + "description": "a Maps Account.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MapsAccount" + } + } + } + }, + "Sku": { + "description": "The SKU of the Maps Account.", + "properties": { + "name": { + "description": "The name of the SKU, in standard format (such as S0).", + "type": "string" + }, + "tier": { + "readOnly": true, + "type": "string", + "description": "Gets the sku tier. This is based on the SKU name." + } + }, + "required": [ + "name" + ] + }, + "MapsAccountsMoveRequest": { + "description": "The description of what resources to move between resource groups.", + "type": "object", + "required": [ + "targetResourceGroup", + "resourceIds" + ], + "properties": { + "targetResourceGroup": { + "type": "string", + "description": "The name of the destination resource group." + }, + "resourceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of resource names to move from the source resource group." + } + } + }, + "MapsKeySpecification": { + "description": "Whether the operation refers to the primary or secondary key.", + "type": "object", + "required": [ + "keyType" + ], + "properties": { + "keyType": { + "type": "string", + "enum": [ + "primary", + "secondary" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + }, + "description": "Whether the operation refers to the primary or secondary key." + } + } + }, + "MapsAccountKeys": { + "description": "The set of keys which can be used to access the Maps REST APIs. Two keys are provided for key rotation without interruption.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The full Azure resource identifier of the Maps Account." + }, + "primaryKey": { + "type": "string", + "readOnly": true, + "description": "The primary key for accessing the Maps REST APIs." + }, + "secondaryKey": { + "type": "string", + "readOnly": true, + "description": "The secondary key for accessing the Maps REST APIs." + } + } + }, + "MapsOperations": { + "description": "The set of operations available for Maps.", + "type": "object", + "properties": { + "value": { + "description": "An operation available for Maps.", + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Operation name: {provider}/{resource}/{operation}." + }, + "display": { + "description": "The human-readable description of the operation.", + "type": "object", + "properties": { + "provider": { + "type": "string", + "readOnly": true, + "description": "Service provider: Microsoft Maps." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "readOnly": true, + "description": "The action that users can perform, based on their permission level." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + } + } + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the operation." + } + } + } + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/CreateAccount.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/CreateAccount.json new file mode 100644 index 000000000000..2dbcc7a19085 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/CreateAccount.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2018-05-01", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "MapsAccountCreateParameters": { + "location": "global", + "sku": { + "name": "S0" + }, + "tags": { + "test": "true" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/DeleteAccount.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/DeleteAccount.json new file mode 100644 index 000000000000..3d6c171b6268 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/DeleteAccount.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2018-05-01", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/GetAccount.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/GetAccount.json new file mode 100644 index 000000000000..f1406936717a --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/GetAccount.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2018-05-01", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + } + }, + "404": {} + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/GetOperations.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/GetOperations.json new file mode 100644 index 000000000000..c2c0326eaa84 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/GetOperations.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2018-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Maps/register/action", + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Register the provider", + "description": "Register the provider" + } + }, + { + "name": "Microsoft.Maps/accounts/write", + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Create or update a Maps Account.", + "description": "Create or update a Maps Account." + } + }, + { + "name": "Microsoft.Maps/accounts/read", + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Get a Maps Account.", + "description": "Get a Maps Account." + } + }, + { + "name": "Microsoft.Maps/accounts/delete", + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Delete a Maps Account.", + "description": "Delete a Maps Account." + } + }, + { + "name": "Microsoft.Maps/accounts/listKeys/action", + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "List keys", + "description": "List Maps Account keys" + } + }, + { + "name": "Microsoft.Maps/accounts/regenerateKey/action", + "display": { + "provider": "Microsoft Maps", + "resource": "Maps Account", + "operation": "Generate new primary or secondary key", + "description": "Generate new Maps Account primary or secondary key" + } + } + ] + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/ListAccountsByResourceGroup.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/ListAccountsByResourceGroup.json new file mode 100644 index 000000000000..5edf2f5ba938 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/ListAccountsByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2018-05-01", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": + "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount2", + "name": "myMapsAccount2", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + }, + { + "id": + "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/ListAccountsBySubscription.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/ListAccountsBySubscription.json new file mode 100644 index 000000000000..832171fa4c53 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/ListAccountsBySubscription.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2018-05-01", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount2", + "name": "myMapsAccount2", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + }, + { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "test": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/ListKeys.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/ListKeys.json new file mode 100644 index 000000000000..bfd3a40fc666 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/ListKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2018-05-01", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "primaryKey": "ZiBllKWCwXXLTO13S2TaoHoK8kPFYaoyYlAcnCcE4PQ", + "secondaryKey": "cJHpmUGNaGGO8H59p6NKGhfff9VjD278-2bi5wo0_mU" + } + }, + "404": {} + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/MoveAccounts.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/MoveAccounts.json new file mode 100644 index 000000000000..53ddfa258409 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/MoveAccounts.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2018-05-01", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "moveRequest": { + "targetResourceGroup": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup2", + "resourceIds": [ + "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount2" + ] + } + }, + "responses": { + "200": { + } + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/RegenerateKey.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/RegenerateKey.json new file mode 100644 index 000000000000..698a8020ae34 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/RegenerateKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2018-05-01", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "keySpecification": { + "keyType": "primary" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "primaryKey": "uj0yqjjz8zG3IOSWvb_smi1q1QenGtupAqrOA1zCO6s", + "secondaryKey": "cJHpmUGNaGGO8H59p6NKGhfff9VjD278-2bi5wo0_mU" + } + }, + "404": {} + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/UpdateAccount.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/UpdateAccount.json new file mode 100644 index 000000000000..97e96b0acb1d --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/examples/UpdateAccount.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2018-05-01", + "subscriptionId": "21a9967a-e8a9-4656-a70b-96ff1c4d05a0", + "resourceGroupName": "myResourceGroup", + "accountName": "myMapsAccount", + "MapsAccountUpdateParameters": { + "tags": { + "specialTag": "true" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount", + "name": "myMapsAccount", + "type": "Microsoft.Maps/accounts", + "location": "global", + "tags": { + "specialTag": "true" + }, + "sku": { + "name": "S0", + "tier": "Standard" + } + } + }, + "404": {} + } +} diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/maps-management.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/maps-management.json new file mode 100644 index 000000000000..727b920e3175 --- /dev/null +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/maps-management.json @@ -0,0 +1,789 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Resource Provider", + "description": "Resource Provider", + "version": "2018-05-01", + "x-ms-code-generation-settings": { + "name": "MapsManagementClient" + } + }, + "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.Maps/accounts/{accountName}": { + "put": { + "description": "Create or update a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs.", + "operationId": "Accounts_CreateOrUpdate", + "x-ms-examples": { + "CreateAccount": { + "$ref": "./examples/CreateAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "MapsAccountCreateParameters", + "in": "body", + "description": "The new or updated parameters for the Maps Account.", + "required": true, + "schema": { + "$ref": "#/definitions/MapsAccountCreateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Account was successfully updated.", + "schema": { + "$ref": "#/definitions/MapsAccount" + } + }, + "201": { + "description": "The Account was successfully created.", + "schema": { + "$ref": "#/definitions/MapsAccount" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "description": "Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku and Tags.", + "operationId": "Accounts_Update", + "x-ms-examples": { + "UpdateAccount": { + "$ref": "./examples/UpdateAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "MapsAccountUpdateParameters", + "in": "body", + "description": "The updated parameters for the Maps Account.", + "required": true, + "schema": { + "$ref": "#/definitions/MapsAccountUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Account was successfully updated.", + "schema": { + "$ref": "#/definitions/MapsAccount" + } + }, + "404": { + "description": "The specified Account was not found. Nothing was updated." + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "delete": { + "description": "Delete a Maps Account.", + "operationId": "Accounts_Delete", + "x-ms-examples": { + "DeleteAccount": { + "$ref": "./examples/DeleteAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + } + ], + "responses": { + "200": { + "description": "The Account was deleted successfully." + }, + "204": { + "description": "The specified Account was not found. Nothing was deleted." + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "get": { + "description": "Get a Maps Account.", + "operationId": "Accounts_Get", + "x-ms-examples": { + "GetAccount": { + "$ref": "./examples/GetAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccount" + } + }, + "404": { + "description": "The specified Account does not exist." + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts": { + "get": { + "description": "Get all Maps Accounts in a Resource Group", + "operationId": "Accounts_ListByResourceGroup", + "x-ms-examples": { + "ListAccountsByResourceGroup": { + "$ref": "./examples/ListAccountsByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null, + "itemName": "value" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccounts" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maps/accounts": { + "get": { + "description": "Get all Maps Accounts in a Subscription", + "operationId": "Accounts_ListBySubscription", + "x-ms-examples": { + "ListAccountsBySubscription": { + "$ref": "./examples/ListAccountsBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null, + "itemName": "value" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccounts" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources": { + "post": { + "description": "Moves Maps Accounts from one ResourceGroup (or Subscription) to another", + "operationId": "Accounts_Move", + "x-ms-examples": { + "MoveAccounts": { + "$ref": "./examples/MoveAccounts.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains Maps Account to move.", + "required": true, + "type": "string" + }, + { + "name": "moveRequest", + "in": "body", + "description": "The details of the Maps Account move.", + "required": true, + "schema": { + "$ref": "#/definitions/MapsAccountsMoveRequest" + } + } + ], + "responses": { + "200": { + "description": "The Accounts were successfully moved." + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/listKeys": { + "post": { + "description": "Get the keys to use with the Maps APIs. A key is used to authenticate and authorize access to the Maps REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.", + "operationId": "Accounts_ListKeys", + "x-ms-examples": { + "ListKeys": { + "$ref": "./examples/ListKeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccountKeys" + } + }, + "404": { + "description": "The specified Account does not exist." + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/regenerateKey": { + "post": { + "description": "Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately.", + "operationId": "Accounts_RegenerateKeys", + "x-ms-examples": { + "RegenerateKey": { + "$ref": "./examples/RegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "keySpecification", + "in": "body", + "required": true, + "description": "Which key to regenerate: primary or secondary.", + "schema": { + "$ref": "#/definitions/MapsKeySpecification" + } + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsAccountKeys" + } + }, + "404": { + "description": "The specified Account does not exist." + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.Maps/operations": { + "get": { + "description": "List operations available for the Maps Resource Provider", + "operationId": "Accounts_ListOperations", + "x-ms-examples": { + "GetOperations": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null, + "itemName": "value" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful.", + "schema": { + "$ref": "#/definitions/MapsOperations" + } + }, + "default": { + "description": "An unexpected error occurred.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + } + }, + "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." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the Azure Resource Group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AccountNameParameter": { + "name": "accountName", + "in": "path", + "description": "The name of the Maps Account.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "Error": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the component generating the error." + }, + "details": { + "type": "array", + "readOnly": true, + "description": "If available, a list of additional details about the error.", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the component generating the error." + } + } + } + } + } + }, + "Resource": { + "description": "An Azure resource", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The fully qualified Maps Account resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the Maps Account, which is unique within a Resource Group." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Azure resource type." + } + }, + "x-ms-azure-resource": true + }, + "MapsAccount": { + "description": "An Azure resource which represents access to a suite of Maps REST APIs.", + "type": "object", + "properties": { + "location": { + "readOnly": true, + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." + }, + "sku": { + "readOnly": true, + "description": "The SKU of this account.", + "$ref": "#/definitions/Sku" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "MapsAccountCreateParameters": { + "description": "Parameters used to create a new Maps Account.", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The location of the resource." + }, + "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 in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." + }, + "sku": { + "description": "The SKU of this account.", + "$ref": "#/definitions/Sku" + } + }, + "required": [ + "location", + "sku" + ] + }, + "MapsAccountUpdateParameters": { + "description": "Parameters used to update an existing Maps Account.", + "type": "object", + "properties": { + "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 in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters." + }, + "sku": { + "description": "The SKU of this account.", + "$ref": "#/definitions/Sku" + } + } + }, + "MapsAccounts": { + "description": "A list of Maps Accounts.", + "type": "object", + "properties": { + "value": { + "description": "a Maps Account.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MapsAccount" + } + } + } + }, + "Sku": { + "description": "The SKU of the Maps Account.", + "properties": { + "name": { + "description": "The name of the SKU, in standard format (such as S0).", + "type": "string" + }, + "tier": { + "readOnly": true, + "type": "string", + "description": "Gets the sku tier. This is based on the SKU name." + } + }, + "required": [ + "name" + ] + }, + "MapsAccountsMoveRequest": { + "description": "The description of what resources to move between resource groups.", + "type": "object", + "required": [ + "targetResourceGroup", + "resourceIds" + ], + "properties": { + "targetResourceGroup": { + "type": "string", + "description": "The name of the destination resource group." + }, + "resourceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of resource names to move from the source resource group." + } + } + }, + "MapsKeySpecification": { + "description": "Whether the operation refers to the primary or secondary key.", + "type": "object", + "required": [ + "keyType" + ], + "properties": { + "keyType": { + "type": "string", + "enum": [ + "primary", + "secondary" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + }, + "description": "Whether the operation refers to the primary or secondary key." + } + } + }, + "MapsAccountKeys": { + "description": "The set of keys which can be used to access the Maps REST APIs. Two keys are provided for key rotation without interruption.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The full Azure resource identifier of the Maps Account." + }, + "primaryKey": { + "type": "string", + "readOnly": true, + "description": "The primary key for accessing the Maps REST APIs." + }, + "secondaryKey": { + "type": "string", + "readOnly": true, + "description": "The secondary key for accessing the Maps REST APIs." + } + } + }, + "MapsOperations": { + "description": "The set of operations available for Maps.", + "type": "object", + "properties": { + "value": { + "description": "An operation available for Maps.", + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Operation name: {provider}/{resource}/{operation}." + }, + "display": { + "description": "The human-readable description of the operation.", + "type": "object", + "properties": { + "provider": { + "type": "string", + "readOnly": true, + "description": "Service provider: Microsoft Maps." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "readOnly": true, + "description": "The action that users can perform, based on their permission level." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + } + } + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the operation." + } + } + } + } + } + } + } +} diff --git a/specification/maps/resource-manager/readme.md b/specification/maps/resource-manager/readme.md new file mode 100644 index 000000000000..a57263546a2f --- /dev/null +++ b/specification/maps/resource-manager/readme.md @@ -0,0 +1,169 @@ +# Maps + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Maps. + +--- +## Getting Started +To build the SDK for Maps, 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 Maps API. + +``` yaml +openapi-type: arm +tag: package-2018-05 +``` + + +### Tag: package-2017-01 + +These settings apply only when `--tag=package-2017-01` is specified on the command line. + +``` yaml $(tag) == 'package-2017-01' +input-file: +- Microsoft.Maps/stable/2017-01-01-preview/maps-management.json +``` + +### Tag: package-2018-05 + +These settings apply only when `--tag=package-2018-05` is specified on the command line. + +``` yaml $(tag) == 'package-2018-05' +input-file: +- Microsoft.Maps/stable/2018-05-01/maps-management.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-go +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Maps + output-folder: $(csharp-sdks-folder)/Maps/Management.Maps/Generated + clear-output-folder: true +``` + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + clear-output-folder: true + namespace: maps +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-05 + - tag: package-2017-01 +``` + +### Tag: package-2018-05 and go + +These settings apply only when `--tag=package-2018-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2018-05' && $(go) +output-folder: $(go-sdk-folder)/services/maps/mgmt/2018-05-01/maps +``` + +### Tag: package-2017-01 and go + +These settings apply only when `--tag=package-2017-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2017-01' && $(go) +output-folder: $(go-sdk-folder)/services/maps/mgmt/2017-01-01-preview/maps +``` + + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.maps +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-maps +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-01 + - tag: package-2018-05 +``` + +### Tag: package-2017-01 and java + +These settings apply only when `--tag=package-2017-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.maps.v2017_01_01_preview + output-folder: $(azure-libraries-for-java-folder)/maps/resource-manager/v2017_01_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-05 and java + +These settings apply only when `--tag=package-2018-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.maps.v2018_05_01 + output-folder: $(azure-libraries-for-java-folder)/maps/resource-manager/v2018_05_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/maps/resource-manager/readme.nodejs.md b/specification/maps/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..e2b2ad0eb1ea --- /dev/null +++ b/specification/maps/resource-manager/readme.nodejs.md @@ -0,0 +1,15 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-maps + package-version: 1.0.0-preview + output-folder: $(node-sdks-folder)/lib/services/maps/Management + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/maps/resource-manager/readme.python.md b/specification/maps/resource-manager/readme.python.md new file mode 100644 index 000000000000..40ea066ad247 --- /dev/null +++ b/specification/maps/resource-manager/readme.python.md @@ -0,0 +1,27 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.maps + package-name: azure-mgmt-maps + package-version: 0.1.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-maps/azure/mgmt/maps +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-maps +``` diff --git a/specification/marketplaceordering/resource-manager/readme.md b/specification/marketplaceordering/resource-manager/readme.md index 07808636094e..db60e8a525ba 100644 --- a/specification/marketplaceordering/resource-manager/readme.md +++ b/specification/marketplaceordering/resource-manager/readme.md @@ -76,6 +76,9 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_marketplace_ordering'] ``` @@ -183,11 +186,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.marketplaceordering +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-marketplaceordering +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-06-01 +``` + +### Tag: package-2015-06-01 and java + +These settings apply only when `--tag=package-2015-06-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-06-01' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.marketplaceordering - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-marketplaceordering + namespace: com.microsoft.azure.management.marketplaceagreementsapi.v2015_06_01 + output-folder: $(azure-libraries-for-java-folder)/marketplaceagreementsapi/resource-manager/v2015_06_01 +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/marketplaceordering/resource-manager/readme.ruby.md b/specification/marketplaceordering/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..0d918a552139 --- /dev/null +++ b/specification/marketplaceordering/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_marketplace_ordering +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2015-06-01 +``` + +### Tag: package-2015-06-01 and ruby + +These settings apply only when `--tag=package-2015-06-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-06-01' && $(ruby) +namespace: "Azure::MarketplaceOrdering::Mgmt::V2015_06_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_marketplace_ordering/lib +``` diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Accounts.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Accounts.json new file mode 100644 index 000000000000..3a1564f14a8d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Accounts.json @@ -0,0 +1,744 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2018-03-30-preview" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "Provider": { + "description": "A resource provider.", + "properties": { + "providerName": { + "description": "The provider name.", + "type": "string" + } + }, + "type": "object", + "required": [ + "providerName" + ] + }, + "OperationDisplay": { + "properties": { + "provider": { + "type": "string", + "description": "The service provider." + }, + "resource": { + "type": "string", + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "description": "The operation type." + }, + "description": { + "type": "string", + "description": "The operation description." + } + }, + "type": "object", + "description": "Operation details." + }, + "Operation": { + "description": "An operation.", + "properties": { + "name": { + "type": "string", + "description": "The operation name." + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The operation display name." + } + }, + "type": "object", + "required": [ + "name" + ] + }, + "Location": { + "properties": { + "name": { + "type": "string" + } + }, + "type": "object", + "required": [ + "name" + ] + }, + "EntityNameAvailabilityCheckOutput": { + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Specifies if the name is available." + }, + "reason": { + "type": "string", + "description": "Specifies the reason if the name is not available." + }, + "message": { + "type": "string", + "description": "Specifies the detailed reason if the name is not available." + } + }, + "type": "object", + "required": [ + "nameAvailable" + ], + "description": "The response from the check name availability request." + }, + "StorageAccount": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts." + }, + "type": { + "type": "string", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "values": [ + { + "value": "Primary", + "description": "The primary storage account for the Media Services account." + }, + { + "value": "Secondary", + "description": "A secondary storage account for the Media Services account." + } + ], + "modelAsExtensible": true + }, + "description": "The type of the storage account." + } + }, + "type": "object", + "required": [ + "type" + ], + "description": "The storage account details." + }, + "SyncStorageKeysInput": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the storage account resource." + } + }, + "type": "object", + "description": "The input to the sync storage keys request." + }, + "MediaServiceProperties": { + "properties": { + "mediaServiceId": { + "type": "string", + "format": "uuid", + "description": "The Media Services account ID.", + "readOnly": true, + "x-nullable": false + }, + "storageAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "The storage accounts for this resource." + } + }, + "type": "object", + "description": "Properties of the Media Services account." + }, + "MediaService": { + "description": "A Media Services account.", + "allOf": [ + { + "$ref": "./Common.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MediaServiceProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "SubscriptionMediaService": { + "description": "A Media Services account.", + "allOf": [ + { + "$ref": "./Common.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MediaServiceProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "OperationCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "A collection of Operation items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Operation items." + }, + "MediaServiceCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MediaService" + }, + "description": "A collection of MediaService items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of MediaService items." + }, + "CheckNameAvailabilityInput": { + "description": "The input to the check name availability request.", + "properties": { + "name": { + "description": "The account name.", + "type": "string" + }, + "type": { + "description": "The account type. For a Media Services account, this should be 'MediaServices'.", + "type": "string" + } + }, + "type": "object" + }, + "SubscriptionMediaServiceCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionMediaService" + }, + "description": "A collection of SubscriptionMediaService items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of SubscriptionMediaService items." + } + }, + "paths": { + "/providers/Microsoft.Media/operations": { + "get": { + "summary": "List Operations", + "description": "Lists all the Media Services operations.", + "operationId": "Operations_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List Operations": { + "$ref": "examples/operations-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices": { + "get": { + "summary": "List Media Services accounts", + "description": "List Media Services accounts in the resource group", + "operationId": "Mediaservices_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaServiceCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all Media Services accounts": { + "$ref": "examples/accounts-list-all-accounts.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}": { + "get": { + "summary": "Get a Media Services account", + "description": "Get the details of a Media Services account", + "operationId": "Mediaservices_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Media Services account by name": { + "$ref": "examples/accounts-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update a Media Services account", + "description": "Creates or updates a Media Services account", + "operationId": "Mediaservices_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MediaService" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create a Media Services account": { + "$ref": "examples/accounts-create.json" + } + } + }, + "delete": { + "summary": "Delete a Media Services account.", + "description": "Deletes a Media Services account", + "operationId": "Mediaservices_Delete", + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Media Services account": { + "$ref": "examples/accounts-delete.json" + } + } + }, + "patch": { + "summary": "Update a Media Services account", + "description": "Updates an existing Media Services account", + "operationId": "Mediaservices_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MediaService" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update a Media Services accounts": { + "$ref": "examples/accounts-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/syncStorageKeys": { + "post": { + "summary": "Synchronizes Storage Account Keys", + "description": "Synchronizes storage account keys for a storage account associated with the Media Service account.", + "operationId": "Mediaservices_SyncStorageKeys", + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SyncStorageKeysInput" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Synchronizes Storage Account Keys": { + "$ref": "examples/accounts-sync-storage-keys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Media/locations/{locationName}/checkNameAvailability": { + "post": { + "summary": "Check Name Availability", + "description": "Checks whether the Media Service resource name is available.", + "operationId": "Locations_CheckNameAvailability", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityNameAvailabilityCheckOutput" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Check Name Availability": { + "$ref": "examples/accounts-check-name-availability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Media/mediaservices": { + "get": { + "summary": "List Media Services accounts", + "description": "List Media Services accounts in the subscription.", + "operationId": "Mediaservices_ListBySubscription", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionMediaServiceCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all Media Services accounts": { + "$ref": "examples/accounts-subscription-list-all-accounts.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Media/mediaservices/{accountName}": { + "get": { + "summary": "Get a Media Services account", + "description": "Get the details of a Media Services account", + "operationId": "Mediaservices_GetBySubscription", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionMediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "description": "The Media Services account name.", + "name": "accountName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Media Services account by name": { + "$ref": "examples/accounts-subscription-get-by-name.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Assets.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Assets.json new file mode 100644 index 000000000000..66688d763279 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Assets.json @@ -0,0 +1,608 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2018-03-30-preview" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "AssetProperties": { + "properties": { + "assetId": { + "type": "string", + "format": "uuid", + "description": "The Asset ID.", + "readOnly": true, + "x-nullable": false + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The creation date of the Asset.", + "readOnly": true, + "x-nullable": false + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The last modified date of the Asset.", + "readOnly": true, + "x-nullable": false + }, + "alternateId": { + "type": "string", + "description": "The alternate ID of the Asset." + }, + "description": { + "type": "string", + "description": "The Asset description." + }, + "container": { + "type": "string", + "description": "The name of the asset blob container." + }, + "storageAccountName": { + "type": "string", + "description": "The name of the storage account." + }, + "storageEncryptionFormat": { + "type": "string", + "enum": [ + "None", + "MediaStorageClientEncryption" + ], + "x-ms-enum": { + "name": "AssetStorageEncryptionFormat", + "values": [ + { + "value": "None", + "description": "The Asset does not use client-side storage encryption (this is the only allowed value for new Assets)." + }, + { + "value": "MediaStorageClientEncryption", + "description": "The Asset is encrypted with Media Services client-side encryption." + } + ], + "modelAsExtensible": true + }, + "description": "The Asset encryption format. One of None or MediaStorageEncryption.", + "readOnly": true, + "x-nullable": false + } + }, + "type": "object", + "description": "The Asset properties." + }, + "AssetContainerSas": { + "properties": { + "assetContainerSasUrls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Asset container SAS URLs." + } + }, + "type": "object", + "description": "The Asset Storage container SAS URLs." + }, + "AssetStorageEncryptionKey": { + "properties": { + "storageEncryptionKey": { + "type": "string", + "description": "The Asset storage encryption key." + } + }, + "type": "object", + "description": "The Asset Storage encryption key." + }, + "Asset": { + "description": "An Asset.", + "allOf": [ + { + "$ref": "./Common.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AssetProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "AssetCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Asset" + }, + "description": "A collection of Asset items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Asset items." + }, + "ListContainerSasInput": { + "description": "The parameters to the list SAS requet.", + "properties": { + "permissions": { + "description": "The permissions to set on the SAS URL.", + "type": "string", + "enum": [ + "Read", + "ReadWrite", + "ReadWriteDelete" + ], + "x-ms-enum": { + "name": "AssetContainerPermission", + "values": [ + { + "value": "Read", + "description": "The SAS URL will allow read access to the container." + }, + { + "value": "ReadWrite", + "description": "The SAS URL will allow read and write access to the container." + }, + { + "value": "ReadWriteDelete", + "description": "The SAS URL will allow read, write and delete access to the container." + } + ], + "modelAsExtensible": true + } + }, + "expiryTime": { + "description": "The SAS URL expiration time. This must be less than 24 hours from the current time.", + "type": "string", + "format": "date-time" + } + }, + "type": "object" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets": { + "get": { + "summary": "List Assets", + "description": "List Assets in the Media Services account with optional filtering and ordering", + "operationId": "Assets_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/Asset", + "x-ms-examples": { + "List all Assets": { + "$ref": "examples/assets-list-all.json" + }, + "List Asset ordered by date": { + "$ref": "examples/assets-list-by-date.json" + }, + "List Asset created in a date range": { + "$ref": "examples/assets-list-in-date-range.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}": { + "get": { + "summary": "Get an Asset", + "description": "Get the details of an Asset in the Media Services account", + "operationId": "Assets_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get an Asset by name": { + "$ref": "examples/assets-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update an Asset", + "description": "Creates or updates an Asset in the Media Services account", + "operationId": "Assets_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Asset" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create an Asset": { + "$ref": "examples/assets-create.json" + } + } + }, + "delete": { + "summary": "Delete an Asset.", + "description": "Deletes an Asset in the Media Services account", + "operationId": "Assets_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete an Asset": { + "$ref": "examples/assets-delete.json" + } + } + }, + "patch": { + "summary": "Update an Asset", + "description": "Updates an existing Asset in the Media Services account", + "operationId": "Assets_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Asset" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update an Asset": { + "$ref": "examples/assets-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/listContainerSas": { + "post": { + "summary": "List the Asset URLs", + "description": "Lists storage container URLs with shared access signatures (SAS) for uploading and downloading Asset content. The signatures are derived from the storage account keys.", + "operationId": "Assets_ListContainerSas", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetContainerSas" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ListContainerSasInput" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Asset SAS URLs": { + "$ref": "examples/assets-list-sas-urls.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/getEncryptionKey": { + "post": { + "summary": "Gets the Asset storage key", + "description": "Gets the Asset storage encryption keys used to decrypt content created by version 2 of the Media Services API", + "operationId": "Assets_GetEncryptionKey", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetStorageEncryptionKey" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get Asset Storage Encryption Keys": { + "$ref": "examples/assets-get-encryption-keys.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Common.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Common.json new file mode 100644 index 000000000000..32f0e829b2f9 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Common.json @@ -0,0 +1,80 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "version": "2018-03-30-preview" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "Resource": { + "description": "The core properties of ARM resources.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource ID for the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked resource.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region of the resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/ContentKeyPolicies.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/ContentKeyPolicies.json new file mode 100644 index 000000000000..ce7149eb0e28 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/ContentKeyPolicies.json @@ -0,0 +1,1132 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2018-03-30-preview" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction": { + "properties": { + "bestEffort": { + "type": "boolean", + "description": "Indicates whether this restriction is enforced on a Best Effort basis." + }, + "configurationData": { + "type": "integer", + "format": "int32", + "description": "Configures the restriction control bits. Must be between 0 and 3 inclusive." + } + }, + "type": "object", + "required": [ + "bestEffort", + "configurationData" + ], + "description": "Configures the Explicit Analog Television Output Restriction control bits. For further details see the PlayReady Compliance Rules." + }, + "ContentKeyPolicyPlayReadyContentKeyLocation": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for content key ID location. A derived class must be used to represent the location." + }, + "ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation" + } + ], + "properties": {}, + "type": "object", + "description": "Specifies that the content key ID is in the PlayReady header." + }, + "ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation" + } + ], + "properties": { + "keyId": { + "type": "string", + "format": "uuid", + "description": "The content key ID." + } + }, + "type": "object", + "required": [ + "keyId" + ], + "description": "Specifies that the content key ID is specified in the PlayReady configuration." + }, + "ContentKeyPolicyPlayReadyPlayRight": { + "properties": { + "firstPlayExpiration": { + "type": "string", + "format": "duration", + "description": "The amount of time that the license is valid after the license is first used to play content." + }, + "scmsRestriction": { + "type": "integer", + "format": "int32", + "description": "Configures the Serial Copy Management System (SCMS) in the license. Must be between 0 and 3 inclusive." + }, + "agcAndColorStripeRestriction": { + "type": "integer", + "format": "int32", + "description": "Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive." + }, + "explicitAnalogTelevisionOutputRestriction": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction", + "description": "Configures the Explicit Analog Television Output Restriction in the license. Configuration data must be between 0 and 3 inclusive." + }, + "digitalVideoOnlyContentRestriction": { + "type": "boolean", + "description": "Enables the Image Constraint For Analog Component Video Restriction in the license." + }, + "imageConstraintForAnalogComponentVideoRestriction": { + "type": "boolean", + "description": "Enables the Image Constraint For Analog Component Video Restriction in the license." + }, + "imageConstraintForAnalogComputerMonitorRestriction": { + "type": "boolean", + "description": "Enables the Image Constraint For Analog Component Video Restriction in the license." + }, + "allowPassingVideoContentToUnknownOutput": { + "type": "string", + "enum": [ + "Unknown", + "NotAllowed", + "Allowed", + "AllowedWithVideoConstriction" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyPlayReadyUnknownOutputPassingOption", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyPlayReadyUnknownOutputPassingOption that is unavailable in current API version." + }, + { + "value": "NotAllowed", + "description": "Passing the video portion of protected content to an Unknown Output is not allowed." + }, + { + "value": "Allowed", + "description": "Passing the video portion of protected content to an Unknown Output is allowed." + }, + { + "value": "AllowedWithVideoConstriction", + "description": "Passing the video portion of protected content to an Unknown Output is allowed but with constrained resolution." + } + ], + "modelAsExtensible": true + }, + "description": "Configures Unknown output handling settings of the license." + }, + "uncompressedDigitalVideoOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for uncompressed digital video." + }, + "compressedDigitalVideoOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for compressed digital video." + }, + "analogVideoOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for compressed digital audio." + }, + "compressedDigitalAudioOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for compressed digital audio." + }, + "uncompressedDigitalAudioOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for uncompressed digital audio." + } + }, + "type": "object", + "required": [ + "digitalVideoOnlyContentRestriction", + "imageConstraintForAnalogComponentVideoRestriction", + "imageConstraintForAnalogComputerMonitorRestriction", + "allowPassingVideoContentToUnknownOutput" + ], + "description": "Configures the Play Right in the PlayReady license." + }, + "ContentKeyPolicyTokenClaim": { + "properties": { + "claimType": { + "type": "string", + "description": "Token claim type." + }, + "claimValue": { + "type": "string", + "description": "Token claim value." + } + }, + "type": "object", + "description": "Represents a token claim." + }, + "ContentKeyPolicyPlayReadyLicense": { + "properties": { + "allowTestDevices": { + "type": "boolean", + "description": "A flag indicating whether test devices can use the license." + }, + "beginDate": { + "type": "string", + "format": "date-time", + "description": "The begin date of license" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The expiration date of license." + }, + "relativeBeginDate": { + "type": "string", + "format": "duration", + "description": "The relative begin date of license." + }, + "relativeExpirationDate": { + "type": "string", + "format": "duration", + "description": "The relative expiration date of license." + }, + "gracePeriod": { + "type": "string", + "format": "duration", + "description": "The grace period of license." + }, + "playRight": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyPlayRight", + "description": "The license PlayRight" + }, + "licenseType": { + "type": "string", + "enum": [ + "Unknown", + "NonPersistent", + "Persistent" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyPlayReadyLicenseType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyPlayReadyLicenseType that is unavailable in current API version." + }, + { + "value": "NonPersistent", + "description": "Non persistent license." + }, + { + "value": "Persistent", + "description": "Persistent license. Allows offline playback." + } + ], + "modelAsExtensible": true + }, + "description": "The license type." + }, + "contentKeyLocation": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation", + "description": "The content key location." + }, + "contentType": { + "type": "string", + "enum": [ + "Unknown", + "Unspecified", + "UltraVioletDownload", + "UltraVioletStreaming" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyPlayReadyContentType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyPlayReadyContentType that is unavailable in current API version." + }, + { + "value": "Unspecified", + "description": "Unspecified content type." + }, + { + "value": "UltraVioletDownload", + "description": "Ultraviolet download content type." + }, + { + "value": "UltraVioletStreaming", + "description": "Ultraviolet streaming content type." + } + ], + "modelAsExtensible": true + }, + "description": "The PlayReady content type." + } + }, + "type": "object", + "required": [ + "allowTestDevices", + "licenseType", + "contentKeyLocation", + "contentType" + ], + "description": "The PlayReady license" + }, + "ContentKeyPolicyRestriction": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for Content Key Policy restrictions. A derived class must be used to create a restriction." + }, + "ContentKeyPolicyOpenRestriction": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyOpenRestriction", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestriction" + } + ], + "properties": {}, + "type": "object", + "description": "Represents an open restriction. License or key will be delivered on every request." + }, + "ContentKeyPolicyUnknownRestriction": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyUnknownRestriction", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestriction" + } + ], + "properties": {}, + "type": "object", + "description": "Represents a ContentKeyPolicyRestriction that is unavailable in the current API version." + }, + "ContentKeyPolicyConfiguration": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for Content Key Policy configuration. A derived class must be used to create a configuration." + }, + "ContentKeyPolicyRestrictionTokenKey": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for Content Key Policy key for token validation. A derived class must be used to create a token key." + }, + "ContentKeyPolicySymmetricTokenKey": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + } + ], + "properties": { + "keyValue": { + "type": "string", + "format": "byte", + "description": "The key value of the key" + } + }, + "type": "object", + "required": [ + "keyValue" + ], + "description": "Specifies a symmetric key for token validation." + }, + "ContentKeyPolicyRsaTokenKey": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + } + ], + "properties": { + "exponent": { + "type": "string", + "format": "byte", + "description": "The RSA Parameter exponent" + }, + "modulus": { + "type": "string", + "format": "byte", + "description": "The RSA Parameter modulus" + } + }, + "type": "object", + "required": [ + "exponent", + "modulus" + ], + "description": "Specifies a RSA key for token validation" + }, + "ContentKeyPolicyX509CertificateTokenKey": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKey", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + } + ], + "properties": { + "rawBody": { + "type": "string", + "format": "byte", + "description": "The raw data field of a certificate in PKCS 12 format (X509Certificate2 in .NET)" + } + }, + "type": "object", + "required": [ + "rawBody" + ], + "description": "Specifies a certificate for token validation." + }, + "ContentKeyPolicyTokenRestriction": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestriction" + } + ], + "properties": { + "issuer": { + "type": "string", + "description": "The token issuer." + }, + "audience": { + "type": "string", + "description": "The audience for the token." + }, + "primaryVerificationKey": { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey", + "description": "The primary verification key." + }, + "alternateVerificationKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + }, + "description": "A list of alternative verification keys." + }, + "requiredClaims": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyTokenClaim" + }, + "description": "A list of required token claims." + }, + "restrictionTokenType": { + "type": "string", + "enum": [ + "Unknown", + "Swt", + "Jwt" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyRestrictionTokenType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyRestrictionTokenType that is unavailable in current API version." + }, + { + "value": "Swt", + "description": "Simple Web Token." + }, + { + "value": "Jwt", + "description": "JSON Web Token." + } + ], + "modelAsExtensible": true + }, + "description": "The type of token." + }, + "openIdConnectDiscoveryDocument": { + "type": "string", + "description": "The OpenID connect discovery document." + } + }, + "type": "object", + "required": [ + "issuer", + "audience", + "primaryVerificationKey", + "restrictionTokenType" + ], + "description": "Represents a token restriction. Provided token must match these requirements for successful license or key delivery." + }, + "ContentKeyPolicyClearKeyConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": {}, + "type": "object", + "description": "Represents a configuration for non-DRM keys." + }, + "ContentKeyPolicyUnknownConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyUnknownConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": {}, + "type": "object", + "description": "Represents a ContentKeyPolicyConfiguration that is unavailable in the current API version." + }, + "ContentKeyPolicyWidevineConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": { + "widevineTemplate": { + "type": "string", + "description": "The Widevine template." + } + }, + "type": "object", + "required": [ + "widevineTemplate" + ], + "description": "Specifies a configuration for Widevine licenses." + }, + "ContentKeyPolicyPlayReadyConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": { + "licenses": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyLicense" + }, + "description": "The PlayReady licenses." + }, + "responseCustomData": { + "type": "string", + "description": "The custom response data." + } + }, + "type": "object", + "required": [ + "licenses" + ], + "description": "Specifies a configuration for PlayReady licenses." + }, + "ContentKeyPolicyFairPlayConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyFairPlayConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": { + "ask": { + "type": "string", + "format": "byte", + "description": "The key that must be used as FairPlay ASk." + }, + "fairPlayPfxPassword": { + "type": "string", + "description": "The password encrypting FairPlay certificate in PKCS 12 (pfx) format." + }, + "fairPlayPfx": { + "type": "string", + "description": "The Base64 representation of FairPlay certificate in PKCS 12 (pfx) format (including private key)." + }, + "rentalAndLeaseKeyType": { + "type": "string", + "enum": [ + "Unknown", + "Undefined", + "PersistentUnlimited", + "PersistentLimited" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyFairPlayRentalAndLeaseKeyType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyFairPlayRentalAndLeaseKeyType that is unavailable in current API version." + }, + { + "value": "Undefined", + "description": "Key duration is not specified." + }, + { + "value": "PersistentUnlimited", + "description": "Content key can be persisted with an unlimited duration" + }, + { + "value": "PersistentLimited", + "description": "Content key can be persisted and the valid duration is limited by the Rental Duration value" + } + ], + "modelAsExtensible": true + }, + "description": "The rental and lease key type." + }, + "rentalDuration": { + "type": "integer", + "format": "int64", + "description": "The rental duration. Must be greater than or equal to 0." + } + }, + "type": "object", + "required": [ + "ask", + "fairPlayPfxPassword", + "fairPlayPfx", + "rentalAndLeaseKeyType", + "rentalDuration" + ], + "description": "Specifies a configuration for FairPlay licenses." + }, + "ContentKeyPolicyOption": { + "properties": { + "policyOptionId": { + "type": "string", + "format": "uuid", + "description": "The legacy Policy Option ID.", + "readOnly": true, + "x-nullable": false + }, + "name": { + "type": "string", + "description": "The Policy Option description." + }, + "configuration": { + "$ref": "#/definitions/ContentKeyPolicyConfiguration", + "description": "The key delivery configuration." + }, + "restriction": { + "$ref": "#/definitions/ContentKeyPolicyRestriction", + "description": "The requirements that must be met to deliver keys with this configuration" + } + }, + "type": "object", + "required": [ + "configuration", + "restriction" + ], + "description": "Represents a policy option." + }, + "ContentKeyPolicyProperties": { + "properties": { + "policyId": { + "type": "string", + "format": "uuid", + "description": "The legacy Policy ID.", + "readOnly": true, + "x-nullable": false + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The creation date of the Policy", + "readOnly": true, + "x-nullable": false + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The last modified date of the Policy", + "readOnly": true, + "x-nullable": false + }, + "description": { + "type": "string", + "description": "A description for the Policy." + }, + "options": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyOption" + }, + "description": "The Key Policy options." + } + }, + "type": "object", + "required": [ + "options" + ], + "description": "The properties of the Content Key Policy." + }, + "ContentKeyPolicy": { + "allOf": [ + { + "$ref": "./Common.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ContentKeyPolicyProperties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Content Key Policy resource." + }, + "ContentKeyPolicyCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicy" + }, + "description": "A collection of ContentKeyPolicy items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of ContentKeyPolicy items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies": { + "get": { + "summary": "List Content Key Policies", + "description": "Lists the Content Key Policies in the account", + "operationId": "ContentKeyPolicies_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicyCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/ContentKeyPolicy", + "x-ms-examples": { + "Lists all Content Key Policies": { + "$ref": "examples/content-key-policies-list-all.json" + }, + "Lists Content Key Policies ordered by last modifed.": { + "$ref": "examples/content-key-policies-list-by-lastModified.json" + }, + "Lists Content Key Policies with created and last modified filters.": { + "$ref": "examples/content-key-policies-list-in-date-range.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}": { + "get": { + "summary": "Get a Content Key Policy", + "description": "Get the details of a Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Content Key Policy by name": { + "$ref": "examples/content-key-policies-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update an Content Key Policy", + "description": "Create or update a Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Creates a Content Key Policy with PlayReady option and Open Restriction": { + "$ref": "examples/content-key-policies-create-playready-open.json" + }, + "Creates a Content Key Policy with Widevine option and Token Restriction": { + "$ref": "examples/content-key-policies-create-widevine-token.json" + }, + "Creates a Content Key Policy with ClearKey option and Token Restriction": { + "$ref": "examples/content-key-policies-create-nodrm-token.json" + }, + "Creates a Content Key Policy with multiple options": { + "$ref": "examples/content-key-policies-create-multiple-options.json" + } + } + }, + "delete": { + "summary": "Delete a Content Key Policy", + "description": "Deletes a Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Key Policy": { + "$ref": "examples/content-key-policies-delete.json" + } + } + }, + "patch": { + "summary": "Update a Content Key Policy", + "description": "Updates an existing Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update a Content Key Policy": { + "$ref": "examples/content-key-policies-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}/getPolicyPropertiesWithSecrets": { + "post": { + "summary": "Get a Content Key Policy with secrets", + "description": "Get a Content Key Policy including secret values", + "operationId": "ContentKeyPolicies_GetPolicyPropertiesWithSecrets", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicyProperties" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get an Content Key Policy with secrets": { + "$ref": "examples/content-key-policies-get-with-secrets.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Encoding.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Encoding.json new file mode 100644 index 000000000000..49043394a155 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Encoding.json @@ -0,0 +1,2183 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2018-03-30-preview" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "Preset": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base type for all Presets, which define the recipe or instructions on how the input media files should be processed." + }, + "Codec": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "label": { + "type": "string", + "description": "An optional label for the codec. The label can be used to control muxing behavior." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Describes the basic properties of all codecs." + }, + "Audio": { + "x-ms-discriminator-value": "#Microsoft.Media.Audio", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": { + "channels": { + "type": "integer", + "format": "int32", + "description": "The number of channels in the audio." + }, + "samplingRate": { + "type": "integer", + "format": "int32", + "description": "The sampling rate to use for encoding in hertz." + }, + "bitrate": { + "type": "integer", + "format": "int32", + "description": "The bitrate, in bits per second, of the output encoded audio." + } + }, + "type": "object", + "description": "Defines the common properties for all audio codecs." + }, + "AacAudio": { + "x-ms-discriminator-value": "#Microsoft.Media.AacAudio", + "allOf": [ + { + "$ref": "#/definitions/Audio" + } + ], + "properties": { + "profile": { + "type": "string", + "enum": [ + "AacLc", + "HeAacV1", + "HeAacV2" + ], + "x-ms-enum": { + "name": "AacAudioProfile", + "values": [ + { + "value": "AacLc", + "description": "Specifies that the output audio is to be encoded into AAC Low Complexity profile (AAC-LC)." + }, + { + "value": "HeAacV1", + "description": "Specifies that the output audio is to be encoded into HE-AAC v1 profile." + }, + { + "value": "HeAacV2", + "description": "Specifies that the output audio is to be encoded into HE-AAC v2 profile." + } + ], + "modelAsExtensible": true + }, + "description": "The encoding profile to be used when encoding audio with AAC." + } + }, + "type": "object", + "description": "Describes Advanced Audio Codec (AAC) audio encoding settings." + }, + "AudioAnalyzerPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.AudioAnalyzerPreset", + "allOf": [ + { + "$ref": "#/definitions/Preset" + } + ], + "properties": { + "audioLanguage": { + "type": "string", + "description": "The language for the audio payload in the input using the BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are, 'en-US', 'en-GB', 'es-ES', 'es-MX', 'fr-FR', 'it-IT', 'ja-JP', 'pt-BR', 'zh-CN'." + } + }, + "type": "object", + "description": "The Audio Analyzer preset applies a pre-defined set of AI-based analysis operations, including speech transcription. Currently, the preset supports processing of content with a single audio track." + }, + "Overlay": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "inputLabel": { + "type": "string", + "description": "The label of the job input which is to be used as an overlay. The Input must specify exactly one file. You can specify an image file in JPG or PNG formats, or an audio file (such as a WAV, MP3, WMA or M4A file), or a video file. See https://aka.ms/mesformats for the complete list of supported audio and video file formats." + }, + "start": { + "type": "string", + "format": "duration", + "description": "The start position, with reference to the input video, at which the overlay starts. The value should be in ISO 8601 format. For example, PT05S to start the overlay at 5 seconds in to the input video. If not specified the overlay starts from the beginning of the input video." + }, + "end": { + "type": "string", + "format": "duration", + "description": "The position in the input video at which the overlay ends. The value should be in ISO 8601 duration format. For example, PT30S to end the overlay at 30 seconds in to the input video. If not specified the overlay will be applied until the end of the input video if inputLoop is true. Else, if inputLoop is false, then overlay will last as long as the duration of the overlay media." + }, + "fadeInDuration": { + "type": "string", + "format": "duration", + "description": "The duration over which the overlay fades in onto the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade in (same as PT0S)." + }, + "fadeOutDuration": { + "type": "string", + "format": "duration", + "description": "The duration over which the overlay fades out of the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade out (same as PT0S)." + }, + "audioGainLevel": { + "type": "number", + "format": "double", + "description": "The gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default is 1.0." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base type for all overlays - image, audio or video." + }, + "AudioOverlay": { + "x-ms-discriminator-value": "#Microsoft.Media.AudioOverlay", + "allOf": [ + { + "$ref": "#/definitions/Overlay" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties of an audio overlay." + }, + "CopyVideo": { + "x-ms-discriminator-value": "#Microsoft.Media.CopyVideo", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": {}, + "type": "object", + "description": "A codec flag, which tells the encoder to copy the input video bitstream without re-encoding." + }, + "Video": { + "x-ms-discriminator-value": "#Microsoft.Media.Video", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": { + "keyFrameInterval": { + "type": "string", + "format": "duration", + "description": "The distance between two key frames, thereby defining a group of pictures (GOP). The value should be a non-zero integer in the range [1, 30] seconds, specified in ISO 8601 format. The default is 2 seconds (PT2S)." + }, + "stretchMode": { + "type": "string", + "enum": [ + "None", + "AutoSize", + "AutoFit" + ], + "x-ms-enum": { + "name": "StretchMode", + "values": [ + { + "value": "None", + "description": "Strictly respect the output resolution without considering the pixel aspect ratio or display aspect ratio of the input video." + }, + { + "value": "AutoSize", + "description": "Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9." + }, + { + "value": "AutoFit", + "description": "Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right." + } + ], + "modelAsExtensible": true + }, + "description": "The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize" + } + }, + "type": "object", + "description": "Describes the basic properties for encoding the input video." + }, + "Image": { + "x-ms-discriminator-value": "#Microsoft.Media.Image", + "allOf": [ + { + "$ref": "#/definitions/Video" + } + ], + "properties": { + "start": { + "type": "string", + "description": "The position in the input video from where to start generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT05S), or a frame count (For example, 10 for the 10th frame), or a relative value (For example, 1%). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video." + }, + "step": { + "type": "string", + "description": "The intervals at which thumbnails are generated. The value can be in absolute timestamp (ISO 8601, e.g: PT05S for one image every 5 seconds), or a frame count (For example, 30 for every 30 frames), or a relative value (For example, 1%)." + }, + "range": { + "type": "string", + "description": "The position in the input video at which to stop generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT5M30S to stop at 5 minutes and 30 seconds), or a frame count (For example, 300 to stop at the 300th frame), or a relative value (For example, 100%)." + } + }, + "type": "object", + "description": "Describes the basic properties for generating thumbnails from the input video" + }, + "Format": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "filenamePattern": { + "type": "string", + "description": "The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - The base name of the input video {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {Bitrate} - The audio/video bitrate. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. Any unsubstituted macros will be collapsed and removed from the filename." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for output." + }, + "ImageFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.ImageFormat", + "allOf": [ + { + "$ref": "#/definitions/Format" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties for an output image file." + }, + "JpgFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.JpgFormat", + "allOf": [ + { + "$ref": "#/definitions/ImageFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the settings for producing JPEG thumbnails." + }, + "PngFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.PngFormat", + "allOf": [ + { + "$ref": "#/definitions/ImageFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the settings for producing PNG thumbnails." + }, + "CopyAudio": { + "x-ms-discriminator-value": "#Microsoft.Media.CopyAudio", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": {}, + "type": "object", + "description": "A codec flag, which tells the encoder to copy the input audio bitstream." + }, + "Deinterlace": { + "properties": { + "parity": { + "type": "string", + "enum": [ + "Auto", + "TopFieldFirst", + "BottomFieldFirst" + ], + "x-ms-enum": { + "name": "DeinterlaceParity", + "values": [ + { + "value": "Auto", + "description": "Automatically detect the order of fields" + }, + { + "value": "TopFieldFirst", + "description": "Apply top field first processing of input video." + }, + { + "value": "BottomFieldFirst", + "description": "Apply bottom field first processing of input video." + } + ], + "modelAsExtensible": true + }, + "description": "The field parity for de-interlacing, defaults to Auto." + }, + "mode": { + "type": "string", + "enum": [ + "Off", + "AutoPixelAdaptive" + ], + "x-ms-enum": { + "name": "DeinterlaceMode", + "values": [ + { + "value": "Off", + "description": "Disables de-interlacing of the source video." + }, + { + "value": "AutoPixelAdaptive", + "description": "Apply automatic pixel adaptive de-interlacing on each frame in the input video." + } + ], + "modelAsExtensible": true + }, + "description": "The deinterlacing mode. Defaults to AutoPixelAdaptive." + } + }, + "type": "object", + "description": "Describes the de-interlacing settings." + }, + "Rectangle": { + "properties": { + "left": { + "type": "string", + "description": "The number of pixels from the left-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "top": { + "type": "string", + "description": "The number of pixels from the top-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "width": { + "type": "string", + "description": "The width of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "height": { + "type": "string", + "description": "The height of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + } + }, + "type": "object", + "description": "Describes the properties of a rectangular window applied to the input media before processing it." + }, + "Filters": { + "properties": { + "deinterlace": { + "$ref": "#/definitions/Deinterlace", + "description": "The de-interlacing settings." + }, + "rotation": { + "type": "string", + "enum": [ + "Auto", + "None", + "Rotate0", + "Rotate90", + "Rotate180", + "Rotate270" + ], + "x-ms-enum": { + "name": "Rotation", + "values": [ + { + "value": "Auto", + "description": "Automatically detect and rotate as needed." + }, + { + "value": "None", + "description": "Do not rotate the video. If the output format supports it, any metadata about rotation is kept intact." + }, + { + "value": "Rotate0", + "description": "Do not rotate the video but remove any metadata about the rotation." + }, + { + "value": "Rotate90", + "description": "Rotate 90 degrees clockwise." + }, + { + "value": "Rotate180", + "description": "Rotate 180 degrees clockwise." + }, + { + "value": "Rotate270", + "description": "Rotate 270 degrees clockwise." + } + ], + "modelAsExtensible": true + }, + "description": "The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto" + }, + "crop": { + "$ref": "#/definitions/Rectangle", + "description": "The parameters for the rectangular window with which to crop the input video." + }, + "overlays": { + "type": "array", + "items": { + "$ref": "#/definitions/Overlay" + }, + "description": "The properties of overlays to be applied to the input video. These could be audio, image or video overlays." + } + }, + "type": "object", + "description": "Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding." + }, + "Layer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "width": { + "type": "string", + "description": "The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input." + }, + "height": { + "type": "string", + "description": "The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input." + }, + "label": { + "type": "string", + "description": "The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "The encoder can be configured to produce video and/or images (thumbnails) at different resolutions, by specifying a layer for each desired resolution. A layer represents the properties for the video or image at a resolution." + }, + "VideoLayer": { + "x-ms-discriminator-value": "#Microsoft.Media.VideoLayer", + "allOf": [ + { + "$ref": "#/definitions/Layer" + } + ], + "properties": { + "bitrate": { + "type": "integer", + "format": "int32", + "description": "The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field." + }, + "maxBitrate": { + "type": "integer", + "format": "int32", + "description": "The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate." + }, + "bFrames": { + "type": "integer", + "format": "int32", + "description": "The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level." + }, + "frameRate": { + "type": "string", + "description": "The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video." + }, + "slices": { + "type": "integer", + "format": "int32", + "description": "The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame." + }, + "adaptiveBFrame": { + "type": "boolean", + "description": "Whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use." + } + }, + "type": "object", + "description": "Describes the settings to be used when encoding the input video into a desired output bitrate layer." + }, + "H264Layer": { + "x-ms-discriminator-value": "#Microsoft.Media.H264Layer", + "allOf": [ + { + "$ref": "#/definitions/VideoLayer" + } + ], + "properties": { + "profile": { + "type": "string", + "enum": [ + "Auto", + "Baseline", + "Main", + "High", + "High422", + "High444" + ], + "x-ms-enum": { + "name": "H264VideoProfile", + "values": [ + { + "value": "Auto", + "description": "Tells the encoder to automatically determine the appropriate H.264 profile." + }, + { + "value": "Baseline", + "description": "Baseline profile" + }, + { + "value": "Main", + "description": "Main profile" + }, + { + "value": "High", + "description": "High profile." + }, + { + "value": "High422", + "description": "High 4:2:2 profile." + }, + { + "value": "High444", + "description": "High 4:4:4 predictive profile." + } + ], + "modelAsExtensible": true + }, + "description": "Which profile of the H.264 standard should be used when encoding this layer. Default is Auto." + }, + "level": { + "type": "string", + "description": "Which level of the H.264 standard should be used when encoding this layer. The value can be Auto, or a number that matches the H.264 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer." + }, + "bufferWindow": { + "type": "string", + "format": "duration", + "description": "The VBV buffer window length. The value should be in ISO 8601 format. The value should be in the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S)." + }, + "referenceFrames": { + "type": "integer", + "format": "int32", + "description": "The number of reference frames to be used when encoding this layer. If not specified, the encoder determines an appropriate number based on the encoder complexity setting." + }, + "entropyMode": { + "type": "string", + "enum": [ + "Cabac", + "Cavlc" + ], + "x-ms-enum": { + "name": "EntropyMode", + "values": [ + { + "value": "Cabac", + "description": "Context Adaptive Binary Arithmetic Coder (CABAC) entropy encoding." + }, + { + "value": "Cavlc", + "description": "Context Adaptive Variable Length Coder (CAVLC) entropy encoding." + } + ], + "modelAsExtensible": true + }, + "description": "The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level." + } + }, + "type": "object", + "description": "Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.264 video codec." + }, + "H264Video": { + "x-ms-discriminator-value": "#Microsoft.Media.H264Video", + "allOf": [ + { + "$ref": "#/definitions/Video" + } + ], + "properties": { + "sceneChangeDetection": { + "type": "boolean", + "description": "Whether or not the encoder should insert key frames at scene changes. If not specified, the default is false. This flag should be set to true only when the encoder is being configured to produce a single output video." + }, + "complexity": { + "type": "string", + "enum": [ + "Speed", + "Balanced", + "Quality" + ], + "x-ms-enum": { + "name": "H264Complexity", + "values": [ + { + "value": "Speed", + "description": "Tells the encoder to use settings that are optimized for faster encoding. Quality is sacrificed to decrease encoding time." + }, + { + "value": "Balanced", + "description": "Tells the encoder to use settings that achieve a balance between speed and quality." + }, + { + "value": "Quality", + "description": "Tells the encoder to use settings that are optimized to produce higher quality output at the expense of slower overall encode time." + } + ], + "modelAsExtensible": true + }, + "description": "Tells the encoder how to choose its encoding settings. The default value is Balanced." + }, + "layers": { + "type": "array", + "items": { + "$ref": "#/definitions/H264Layer" + }, + "description": "The collection of output H.264 layers to be produced by the encoder." + } + }, + "type": "object", + "description": "Describes all the properties for encoding a video with the H.264 codec." + }, + "JpgImage": { + "x-ms-discriminator-value": "#Microsoft.Media.JpgImage", + "allOf": [ + { + "$ref": "#/definitions/Image" + } + ], + "properties": { + "layers": { + "type": "array", + "items": { + "$ref": "#/definitions/JpgLayer" + }, + "description": "A collection of output JPEG image layers to be produced by the encoder." + } + }, + "type": "object", + "description": "Describes the properties for producing a series of JPEG images from the input video." + }, + "JpgLayer": { + "x-ms-discriminator-value": "#Microsoft.Media.JpgLayer", + "allOf": [ + { + "$ref": "#/definitions/Layer" + } + ], + "properties": { + "quality": { + "type": "integer", + "format": "int32", + "description": "The compression quality of the JPEG output. Range is from 0-100 and the default is 70." + } + }, + "type": "object", + "description": "Describes the settings to produce a JPEG image from the input video." + }, + "OutputFile": { + "properties": { + "labels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of labels that describe how the encoder should multiplex video and audio into an output file. For example, if the encoder is producing two video layers with labels v1 and v2, and one audio layer with label a1, then an array like '[v1, a1]' tells the encoder to produce an output file with the video track represented by v1 and the audio track represented by a1." + } + }, + "type": "object", + "description": "Represents an output file produced." + }, + "MultiBitrateFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.MultiBitrateFormat", + "allOf": [ + { + "$ref": "#/definitions/Format" + } + ], + "properties": { + "outputFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "description": "The list of output files to produce. Each entry in the list is a set of audio and video layer labels to be muxed together ." + } + }, + "type": "object", + "description": "Describes the properties for producing a collection of GOP aligned multi-bitrate files. The default behavior is to produce one output file for each video layer which is muxed together with all the audios. The exact output files produced can be controlled by specifying the outputFiles collection." + }, + "Mp4Format": { + "x-ms-discriminator-value": "#Microsoft.Media.Mp4Format", + "allOf": [ + { + "$ref": "#/definitions/MultiBitrateFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties for an output ISO MP4 file." + }, + "PngImage": { + "x-ms-discriminator-value": "#Microsoft.Media.PngImage", + "allOf": [ + { + "$ref": "#/definitions/Image" + } + ], + "properties": { + "layers": { + "type": "array", + "items": { + "$ref": "#/definitions/PngLayer" + }, + "description": "A collection of output PNG image layers to be produced by the encoder." + } + }, + "type": "object", + "description": "Describes the properties for producing a series of PNG images from the input video." + }, + "PngLayer": { + "x-ms-discriminator-value": "#Microsoft.Media.PngLayer", + "allOf": [ + { + "$ref": "#/definitions/Layer" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the settings to produce a PNG image from the input video." + }, + "BuiltInStandardEncoderPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "allOf": [ + { + "$ref": "#/definitions/Preset" + } + ], + "properties": { + "presetName": { + "type": "string", + "enum": [ + "AdaptiveStreaming", + "AACGoodQualityAudio", + "H264MultipleBitrate1080p", + "H264MultipleBitrate720p", + "H264MultipleBitrateSD" + ], + "x-ms-enum": { + "name": "EncoderNamedPreset", + "values": [ + { + "value": "AdaptiveStreaming", + "description": "Produces a set of GOP aligned MP4 files with H.264 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution and bitrate. The auto-generated preset will never exceed the input resolution and bitrate. For example, if the input is 720p at 3 Mbps, output will remain 720p at best, and will start at rates lower than 3 Mbps. The output will will have video and audio in separate MP4 files, which is optimal for adaptive streaming." + }, + { + "value": "AACGoodQualityAudio", + "description": "Produces a single MP4 file containing only stereo audio encoded at 192 kbps." + }, + { + "value": "H264MultipleBitrate1080p", + "description": "Produces a set of 8 GOP-aligned MP4 files, ranging from 6000 kbps to 400 kbps, and stereo AAC audio. Resolution starts at 1080p and goes down to 360p." + }, + { + "value": "H264MultipleBitrate720p", + "description": "Produces a set of 6 GOP-aligned MP4 files, ranging from 3400 kbps to 400 kbps, and stereo AAC audio. Resolution starts at 720p and goes down to 360p." + }, + { + "value": "H264MultipleBitrateSD", + "description": "Produces a set of 5 GOP-aligned MP4 files, ranging from 1600kbps to 400 kbps, and stereo AAC audio. Resolution starts at 480p and goes down to 360p." + } + ], + "modelAsExtensible": true + }, + "description": "The built-in preset to be used for encoding videos." + } + }, + "type": "object", + "required": [ + "presetName" + ], + "description": "Describes a built-in preset for encoding the input video with the Standard Encoder." + }, + "StandardEncoderPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.StandardEncoderPreset", + "allOf": [ + { + "$ref": "#/definitions/Preset" + } + ], + "properties": { + "filters": { + "$ref": "#/definitions/Filters", + "description": "One or more filtering operations that are applied to the input media before encoding." + }, + "codecs": { + "type": "array", + "items": { + "$ref": "#/definitions/Codec" + }, + "description": "The list of codecs to be used when encoding the input video." + }, + "formats": { + "type": "array", + "items": { + "$ref": "#/definitions/Format" + }, + "description": "The list of outputs to be produced by the encoder." + } + }, + "type": "object", + "description": "Describes all the settings to be used when encoding the input video with the Standard Encoder." + }, + "VideoAnalyzerPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.VideoAnalyzerPreset", + "allOf": [ + { + "$ref": "#/definitions/AudioAnalyzerPreset" + } + ], + "properties": { + "audioInsightsOnly": { + "type": "boolean", + "description": "Whether to only extract audio insights when processing a video file." + } + }, + "type": "object", + "description": "A video analyzer preset that extracts insights (rich metadata) from both audio and video, and outputs a JSON format file." + }, + "TransportStreamFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.TransportStreamFormat", + "allOf": [ + { + "$ref": "#/definitions/MultiBitrateFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties for generating an MPEG-2 Transport Stream (ISO/IEC 13818-1) output video file(s)." + }, + "VideoOverlay": { + "x-ms-discriminator-value": "#Microsoft.Media.VideoOverlay", + "allOf": [ + { + "$ref": "#/definitions/Overlay" + } + ], + "properties": { + "position": { + "$ref": "#/definitions/Rectangle", + "description": "The location in the input video where the overlay is applied." + }, + "opacity": { + "type": "number", + "format": "double", + "description": "The opacity of the overlay. This is a value in the range [0 - 1.0]. Default is 1.0 which mean the overlay is opaque." + }, + "cropRectangle": { + "$ref": "#/definitions/Rectangle", + "description": "An optional rectangular window used to crop the overlay image or video." + } + }, + "type": "object", + "description": "Describes the properties of a video overlay." + }, + "TransformOutput": { + "properties": { + "onError": { + "type": "string", + "enum": [ + "StopProcessingJob", + "ContinueJob" + ], + "x-ms-enum": { + "name": "OnErrorType", + "values": [ + { + "value": "StopProcessingJob", + "description": "Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped." + }, + { + "value": "ContinueJob", + "description": "Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue." + } + ], + "modelAsExtensible": true + }, + "description": "A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The default is stop." + }, + "relativePriority": { + "type": "string", + "enum": [ + "Low", + "Normal", + "High" + ], + "x-ms-enum": { + "name": "Priority", + "values": [ + { + "value": "Low", + "description": "Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs." + }, + { + "value": "Normal", + "description": "Used for TransformOutputs that can be generated at Normal priority." + }, + { + "value": "High", + "description": "Used for TransformOutputs that should take precedence over others." + } + ], + "modelAsExtensible": true + }, + "description": "Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal." + }, + "preset": { + "$ref": "#/definitions/Preset", + "description": "Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output." + } + }, + "type": "object", + "required": [ + "preset" + ], + "description": "Describes the properties of a TransformOutput, which are the rules to be applied while generating the desired output." + }, + "TransformProperties": { + "properties": { + "created": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "description": { + "type": "string", + "description": "An optional verbose description of the Transform." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/TransformOutput" + }, + "description": "An array of one or more TransformOutputs that the Transform should generate." + } + }, + "type": "object", + "required": [ + "outputs" + ], + "description": "A Transform." + }, + "Transform": { + "allOf": [ + { + "$ref": "./Common.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TransformProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Transform encapsulates the rules or instructions for generating desired outputs from input media, such as by transcoding or by extracting insights. After the Transform is created, it can be applied to input media by creating Jobs." + }, + "JobInput": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "label": { + "type": "string", + "description": "A label that is assigned to a JobInput, that is used to satisfy a reference used in the Transform. For example, a Transform can be authored so as to take an image file with the label 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a Job, exactly one of the JobInputs should be the image file, and it should have the label 'xyz'." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for inputs to a Job." + }, + "JobInputClip": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputClip", + "allOf": [ + { + "$ref": "#/definitions/JobInput" + } + ], + "properties": { + "files": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of files. Required for JobInputHttp." + } + }, + "type": "object", + "description": "Represents input files for a Job." + }, + "JobInputs": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputs", + "allOf": [ + { + "$ref": "#/definitions/JobInput" + } + ], + "properties": { + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/JobInput" + }, + "description": "List of inputs to a Job." + } + }, + "type": "object", + "description": "Describes a list of of inputs to a Job." + }, + "JobInputAsset": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputAsset", + "allOf": [ + { + "$ref": "#/definitions/JobInputClip" + } + ], + "properties": { + "assetName": { + "type": "string", + "description": "The name of the input Asset." + } + }, + "type": "object", + "required": [ + "assetName" + ], + "description": "Represents an Asset for input into a Job." + }, + "JobInputHttp": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputHttp", + "allOf": [ + { + "$ref": "#/definitions/JobInputClip" + } + ], + "properties": { + "baseUri": { + "type": "string", + "description": "Base URI for HTTPS job input. It will be concatenated with provided file names. If no base uri is given, then the provided file list is assumed to be fully qualified uris." + } + }, + "type": "object", + "description": "Represents HTTPS job input." + }, + "JobOutput": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "error": { + "$ref": "#/definitions/JobError", + "description": "If the JobOutput is in the Error state, it contains the details of the error.", + "readOnly": true + }, + "state": { + "type": "string", + "enum": [ + "Canceled", + "Canceling", + "Error", + "Finished", + "Processing", + "Queued", + "Scheduled" + ], + "x-ms-enum": { + "name": "JobState", + "values": [ + { + "value": "Canceled", + "description": "The job was canceled. This is a final state for the job." + }, + { + "value": "Canceling", + "description": "The job is in the process of being canceled. This is a transient state for the job." + }, + { + "value": "Error", + "description": "The job has encountered an error. This is a final state for the job." + }, + { + "value": "Finished", + "description": "The job is finished. This is a final state for the job." + }, + { + "value": "Processing", + "description": "The job is processing. This is a transient state for the job." + }, + { + "value": "Queued", + "description": "The job is in a queued state, waiting for resources to become available. This is a transient state." + }, + { + "value": "Scheduled", + "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." + } + ], + "modelAsExtensible": true + }, + "description": "Describes the state of the JobOutput.", + "readOnly": true, + "x-nullable": false + }, + "progress": { + "type": "integer", + "format": "int32", + "description": "If the JobOutput is in a Processing state, this contains the job completion percentage. The value is an estimate and not intended to be used to predict job completion times. To determine if the JobOutput is complete, use the State property.", + "readOnly": true, + "x-nullable": false + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Describes all the properties of a JobOutput." + }, + "JobError": { + "properties": { + "code": { + "type": "string", + "enum": [ + "ServiceError", + "ServiceTransientError", + "DownloadNotAccessible", + "DownloadTransientError", + "UploadNotAccessible", + "UploadTransientError", + "ConfigurationUnsupported", + "ContentMalformed", + "ContentUnsupported" + ], + "x-ms-enum": { + "name": "JobErrorCode", + "values": [ + { + "value": "ServiceError", + "description": "Fatal service error, please contact support." + }, + { + "value": "ServiceTransientError", + "description": "Transient error, please retry, if retry is unsuccessful, please contact support." + }, + { + "value": "DownloadNotAccessible", + "description": "While trying to download the input files, the files were not accessible, please check the availability of the source." + }, + { + "value": "DownloadTransientError", + "description": "While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source." + }, + { + "value": "UploadNotAccessible", + "description": "While trying to upload the output files, the destination was not reachable, please check the availability of the destination." + }, + { + "value": "UploadTransientError", + "description": "While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination." + }, + { + "value": "ConfigurationUnsupported", + "description": "There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration." + }, + { + "value": "ContentMalformed", + "description": "There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files." + }, + { + "value": "ContentUnsupported", + "description": "There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files." + } + ], + "modelAsExtensible": true + }, + "description": "Error code describing the error.", + "readOnly": true, + "x-nullable": false + }, + "message": { + "type": "string", + "description": "A human-readable language-dependent representation of the error.", + "readOnly": true + }, + "category": { + "type": "string", + "enum": [ + "Service", + "Download", + "Upload", + "Configuration", + "Content" + ], + "x-ms-enum": { + "name": "JobErrorCategory", + "values": [ + { + "value": "Service", + "description": "The error is service related." + }, + { + "value": "Download", + "description": "The error is download related." + }, + { + "value": "Upload", + "description": "The error is upload related." + }, + { + "value": "Configuration", + "description": "The error is configuration related." + }, + { + "value": "Content", + "description": "The error is related to data in the input files." + } + ], + "modelAsExtensible": true + }, + "description": "Helps with categorization of errors.", + "readOnly": true, + "x-nullable": false + }, + "retry": { + "type": "string", + "enum": [ + "DoNotRetry", + "MayRetry" + ], + "x-ms-enum": { + "name": "JobRetry", + "values": [ + { + "value": "DoNotRetry", + "description": "Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected." + }, + { + "value": "MayRetry", + "description": "Issue may be resolved after waiting for a period of time and resubmitting the same Job." + } + ], + "modelAsExtensible": true + }, + "description": "Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal.", + "readOnly": true, + "x-nullable": false + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetail" + }, + "description": "An array of details about specific errors that led to this reported error.", + "readOnly": true + } + }, + "type": "object", + "description": "Details of JobOutput errors." + }, + "JobOutputAsset": { + "x-ms-discriminator-value": "#Microsoft.Media.JobOutputAsset", + "allOf": [ + { + "$ref": "#/definitions/JobOutput" + } + ], + "properties": { + "assetName": { + "type": "string", + "description": "The name of the output Asset." + } + }, + "type": "object", + "required": [ + "assetName" + ], + "description": "Represents an Asset used as a JobOutput." + }, + "JobErrorDetail": { + "properties": { + "code": { + "type": "string", + "description": "Code describing the error detail.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error.", + "readOnly": true + } + }, + "type": "object", + "description": "Details of JobOutput errors." + }, + "JobProperties": { + "properties": { + "created": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "state": { + "type": "string", + "enum": [ + "Canceled", + "Canceling", + "Error", + "Finished", + "Processing", + "Queued", + "Scheduled" + ], + "x-ms-enum": { + "name": "JobState", + "values": [ + { + "value": "Canceled", + "description": "The job was canceled. This is a final state for the job." + }, + { + "value": "Canceling", + "description": "The job is in the process of being canceled. This is a transient state for the job." + }, + { + "value": "Error", + "description": "The job has encountered an error. This is a final state for the job." + }, + { + "value": "Finished", + "description": "The job is finished. This is a final state for the job." + }, + { + "value": "Processing", + "description": "The job is processing. This is a transient state for the job." + }, + { + "value": "Queued", + "description": "The job is in a queued state, waiting for resources to become available. This is a transient state." + }, + { + "value": "Scheduled", + "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." + } + ], + "modelAsExtensible": true + }, + "description": "The current state of the job.", + "readOnly": true, + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Optional customer supplied description of the Job." + }, + "input": { + "$ref": "#/definitions/JobInput", + "description": "The inputs for the Job." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/JobOutput" + }, + "description": "The outputs for the Job." + }, + "priority": { + "type": "string", + "enum": [ + "Low", + "Normal", + "High" + ], + "x-ms-enum": { + "name": "Priority", + "values": [ + { + "value": "Low", + "description": "Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs." + }, + { + "value": "Normal", + "description": "Used for TransformOutputs that can be generated at Normal priority." + }, + { + "value": "High", + "description": "Used for TransformOutputs that should take precedence over others." + } + ], + "modelAsExtensible": true + }, + "description": "Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal." + } + }, + "type": "object", + "required": [ + "input", + "outputs" + ], + "description": "Properties of the Job." + }, + "Job": { + "allOf": [ + { + "$ref": "./Common.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Job resource type. The progress and state can be obtained by polling a Job or subscribing to events using EventGrid." + }, + "ODataError": { + "properties": { + "code": { + "type": "string", + "description": "A language-independent error name." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "target": { + "type": "string", + "description": "The target of the error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + }, + "description": "The error details." + } + }, + "type": "object", + "description": "Information about an error." + }, + "ApiError": { + "properties": { + "error": { + "$ref": "#/definitions/ODataError", + "description": "The error properties." + } + }, + "type": "object", + "description": "The API error." + }, + "TransformCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Transform" + }, + "description": "A collection of Transform items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Transform items." + }, + "JobCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Job" + }, + "description": "A collection of Job items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Job items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms": { + "get": { + "summary": "List Transforms", + "description": "Lists the Transforms in the account.", + "operationId": "Transforms_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransformCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that excludes the first n items of the queried collection from the result. The service returns items starting at position n+1." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/Transform", + "x-ms-examples": { + "Lists the Transforms": { + "$ref": "examples/transforms-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}": { + "get": { + "summary": "Get Transform", + "description": "Gets a Transform.", + "operationId": "Transforms_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Transform by name": { + "$ref": "examples/transforms-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or Update Transform", + "description": "Creates or updates a new Transform.", + "operationId": "Transforms_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Transform" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create or update a Transform": { + "$ref": "examples/transforms-create.json" + } + } + }, + "delete": { + "summary": "Delete Transform", + "description": "Deletes a Transform.", + "operationId": "Transforms_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Transform": { + "$ref": "examples/transforms-delete.json" + } + } + }, + "patch": { + "summary": "Update Transform", + "description": "Updates a Transform.", + "operationId": "Transforms_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Transform" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update a Transform.": { + "$ref": "examples/transforms-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs": { + "get": { + "summary": "List Jobs", + "description": "Lists all of the Jobs for the Transform.", + "operationId": "Jobs_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that excludes the first n items of the queried collection from the result. The service returns items starting at position n+1." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/Job", + "x-ms-examples": { + "Lists all of the Jobs for the Transform.": { + "$ref": "examples/jobs-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}": { + "get": { + "summary": "Get Job", + "description": "Gets a Job.", + "operationId": "Jobs_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Job by name": { + "$ref": "examples/jobs-get-by-name.json" + } + } + }, + "put": { + "summary": "Create Job", + "description": "Creates a Job.", + "operationId": "Jobs_Create", + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Job" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create a Job": { + "$ref": "examples/jobs-create.json" + } + } + }, + "delete": { + "summary": "Delete Job", + "description": "Deletes a Job.", + "operationId": "Jobs_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Job": { + "$ref": "examples/jobs-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}/cancelJob": { + "post": { + "summary": "Cancel Job", + "description": "Cancel a Job.", + "operationId": "Jobs_CancelJob", + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Cancel a Job": { + "$ref": "examples/jobs-cancel.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/StreamingPoliciesAndStreamingLocators.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/StreamingPoliciesAndStreamingLocators.json new file mode 100644 index 000000000000..384052416c3c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/StreamingPoliciesAndStreamingLocators.json @@ -0,0 +1,1261 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2018-03-30-preview" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "TrackPropertyCondition": { + "properties": { + "property": { + "type": "string", + "enum": [ + "Unknown", + "FourCC" + ], + "x-ms-enum": { + "name": "TrackPropertyType", + "values": [ + { + "value": "Unknown", + "description": "Unknown track property" + }, + { + "value": "FourCC", + "description": "Track FourCC" + } + ], + "modelAsExtensible": true + }, + "description": "Track property type" + }, + "operation": { + "type": "string", + "enum": [ + "Unknown", + "Equal" + ], + "x-ms-enum": { + "name": "TrackPropertyCompareOperation", + "values": [ + { + "value": "Unknown", + "description": "Unknown track property compare operation" + }, + { + "value": "Equal", + "description": "Equal operation" + } + ], + "modelAsExtensible": true + }, + "description": "Track property condition operation" + }, + "value": { + "type": "string", + "description": "Track proprty value" + } + }, + "type": "object", + "required": [ + "property", + "operation" + ], + "description": "Class to specify one track property condition" + }, + "TrackSelection": { + "properties": { + "trackSelections": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackPropertyCondition" + }, + "description": "TrackSelections is a track property condition list which can specify track(s)" + } + }, + "type": "object", + "description": "Class to select a track" + }, + "DefaultKey": { + "properties": { + "label": { + "type": "string", + "description": "Label can be used to specify Content Key when creating Stremaing Locator" + }, + "policyName": { + "type": "string", + "description": "Policy used by Default Key" + } + }, + "type": "object", + "description": "Class to specify properties of default content key for each encryption scheme" + }, + "StreamingPolicyContentKey": { + "properties": { + "label": { + "type": "string", + "description": "Label can be used to specify Content Key when creating Stremaing Locator" + }, + "policyName": { + "type": "string", + "description": "Policy used by Content Key" + }, + "tracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Tracks which use this content key" + } + }, + "type": "object", + "description": "Class to specify properties of content key" + }, + "StreamingPolicyContentKeys": { + "properties": { + "defaultKey": { + "$ref": "#/definitions/DefaultKey", + "description": "Default content key for an encryption scheme" + }, + "keyToTrackMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingPolicyContentKey" + }, + "description": "Representing tracks needs sepearete content key" + } + }, + "type": "object", + "description": "Class to specify properties of all content keys in Streaming Policy" + }, + "StreamingPolicyPlayReadyConfiguration": { + "properties": { + "customLicenseAcquisitionUrlTemplate": { + "type": "string", + "description": "The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys." + }, + "playReadyCustomAttributes": { + "type": "string", + "description": "Custom attributes for PlayReady" + } + }, + "type": "object", + "description": "Class to specify configurations of PlayReady in Streaming Policy" + }, + "StreamingPolicyWidevineConfiguration": { + "properties": { + "customLicenseAcquisitionUrlTemplate": { + "type": "string", + "description": "The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys." + } + }, + "type": "object", + "description": "Class to specify configurations of Widevine in Streaming Policy" + }, + "StreamingPolicyFairPlayConfiguration": { + "properties": { + "customLicenseAcquisitionUrlTemplate": { + "type": "string", + "description": "The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys." + }, + "allowPersistentLicense": { + "type": "boolean", + "description": "All license to be persistent or not" + } + }, + "type": "object", + "required": [ + "allowPersistentLicense" + ], + "description": "Class to specify configurations of FairPlay in Streaming Policy" + }, + "CbcsDrmConfiguration": { + "properties": { + "fairPlay": { + "$ref": "#/definitions/StreamingPolicyFairPlayConfiguration", + "description": "Fairplay configurations" + }, + "playReady": { + "$ref": "#/definitions/StreamingPolicyPlayReadyConfiguration", + "description": "PlayReady configurations" + }, + "widevine": { + "$ref": "#/definitions/StreamingPolicyWidevineConfiguration", + "description": "Widevine configurations" + } + }, + "type": "object", + "description": "Class to specify drm configurations of CommonEncryptionCbcs scheme in Streaming Policy" + }, + "CencDrmConfiguration": { + "properties": { + "playReady": { + "$ref": "#/definitions/StreamingPolicyPlayReadyConfiguration", + "description": "PlayReady configurations" + }, + "widevine": { + "$ref": "#/definitions/StreamingPolicyWidevineConfiguration", + "description": "Widevine configurations" + } + }, + "type": "object", + "description": "Class to specify drm configurations of CommonEncryptionCenc scheme in Streaming Policy" + }, + "EnabledProtocols": { + "properties": { + "download": { + "type": "boolean", + "description": "Enable Download protocol or not" + }, + "dash": { + "type": "boolean", + "description": "Enable Dash protocol or not" + }, + "hls": { + "type": "boolean", + "description": "Enable Hls protocol or not" + }, + "smoothStreaming": { + "type": "boolean", + "description": "Enable SmoothStreaming protocol or not" + } + }, + "type": "object", + "required": [ + "download", + "dash", + "hls", + "smoothStreaming" + ], + "description": "Class to specify which protocols are enabled" + }, + "NoEncryption": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + } + }, + "type": "object", + "description": "Class for NoEncryption scheme" + }, + "EnvelopeEncryption": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + }, + "clearTracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Representing which tracks should not be encrypted" + }, + "contentKeys": { + "$ref": "#/definitions/StreamingPolicyContentKeys", + "description": "Representing default content key for each encryption scheme and separate content keys for specific tracks" + }, + "customLicenseAcquisitionUrlTemplate": { + "type": "string", + "description": "LicenseAcquistionUrlTemplate is used to point to user speicified service to delivery content keys" + } + }, + "type": "object", + "description": "Class for EnvelopeEncryption encryption scheme" + }, + "CommonEncryptionCenc": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + }, + "clearTracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Representing which tracks should not be encrypted" + }, + "contentKeys": { + "$ref": "#/definitions/StreamingPolicyContentKeys", + "description": "Representing default content key for each encryption scheme and separate content keys for specific tracks" + }, + "drm": { + "$ref": "#/definitions/CencDrmConfiguration", + "description": "Configuration of DRMs for CommonEncryptionCenc encryption scheme" + } + }, + "type": "object", + "description": "Class for envelope encryption scheme" + }, + "CommonEncryptionCbcs": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + }, + "clearTracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Representing which tracks should not be encrypted" + }, + "contentKeys": { + "$ref": "#/definitions/StreamingPolicyContentKeys", + "description": "Representing default content key for each encryption scheme and separate content keys for specific tracks" + }, + "drm": { + "$ref": "#/definitions/CbcsDrmConfiguration", + "description": "Configuration of DRMs for current encryption scheme" + } + }, + "type": "object", + "description": "Class for CommonEncryptionCbcs encryption scheme" + }, + "StreamingPolicyProperties": { + "properties": { + "created": { + "type": "string", + "format": "date-time", + "description": "Creation time of Streaming Policy", + "readOnly": true, + "x-nullable": false + }, + "defaultContentKeyPolicyName": { + "type": "string", + "description": "Default ContentKey used by current Streaming Policy" + }, + "envelopeEncryption": { + "$ref": "#/definitions/EnvelopeEncryption", + "description": "Configuration of EnvelopeEncryption" + }, + "commonEncryptionCenc": { + "$ref": "#/definitions/CommonEncryptionCenc", + "description": "Configuration of CommonEncryptionCenc" + }, + "commonEncryptionCbcs": { + "$ref": "#/definitions/CommonEncryptionCbcs", + "description": "Configuration of CommonEncryptionCbcs" + }, + "noEncryption": { + "$ref": "#/definitions/NoEncryption", + "description": "Configuations of NoEncryption" + } + }, + "type": "object", + "description": "Class to specify properties of Streaming Policy" + }, + "StreamingPolicy": { + "allOf": [ + { + "$ref": "./Common.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StreamingPolicyProperties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Streaming Policy resource" + }, + "StreamingLocatorUserDefinedContentKey": { + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID of Content Key" + }, + "label": { + "type": "string", + "description": "The Content Key description" + }, + "value": { + "type": "string", + "description": "The Content Key secret" + } + }, + "type": "object", + "required": [ + "id" + ], + "description": "Describes the properties of a user-defined content key in the Streaming Locator" + }, + "StreamingLocatorContentKey": { + "properties": { + "label": { + "type": "string", + "description": "Label of Content Key" + }, + "type": { + "type": "string", + "enum": [ + "CommonEncryptionCenc", + "CommonEncryptionCbcs", + "EnvelopeEncryption" + ], + "x-ms-enum": { + "name": "StreamingLocatorContentKeyType", + "values": [ + { + "value": "CommonEncryptionCenc", + "description": "Common Encryption using CENC" + }, + { + "value": "CommonEncryptionCbcs", + "description": "Common Encryption using CBCS" + }, + { + "value": "EnvelopeEncryption", + "description": "Envelope Encryption" + } + ], + "modelAsExtensible": true + }, + "description": "Encryption type of Content Key" + }, + "id": { + "type": "string", + "format": "uuid", + "description": "ID of Content Key" + }, + "value": { + "type": "string", + "description": "Value of of Content Key" + }, + "policyName": { + "type": "string", + "description": "ContentKeyPolicy used by Content Key" + }, + "tracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Tracks which use this Content Key" + } + }, + "type": "object", + "required": [ + "type", + "id" + ], + "description": "Class for content key in Streaming Locator" + }, + "StreamingPath": { + "properties": { + "streamingProtocol": { + "type": "string", + "enum": [ + "Hls", + "Dash", + "SmoothStreaming", + "Download" + ], + "x-ms-enum": { + "name": "StreamingPolicyStreamingProtocol", + "values": [ + { + "value": "Hls", + "description": "HLS protocol" + }, + { + "value": "Dash", + "description": "DASH protocol" + }, + { + "value": "SmoothStreaming", + "description": "SmoothStreaming protocol" + }, + { + "value": "Download", + "description": "Download protocol" + } + ], + "modelAsExtensible": true + }, + "description": "Streaming protocol" + }, + "encryptionScheme": { + "type": "string", + "enum": [ + "NoEncryption", + "EnvelopeEncryption", + "CommonEncryptionCenc", + "CommonEncryptionCbcs" + ], + "x-ms-enum": { + "name": "EncryptionScheme", + "values": [ + { + "value": "NoEncryption", + "description": "NoEncryption scheme" + }, + { + "value": "EnvelopeEncryption", + "description": "EnvelopeEncryption scheme" + }, + { + "value": "CommonEncryptionCenc", + "description": "CommonEncryptionCenc scheme" + }, + { + "value": "CommonEncryptionCbcs", + "description": "CommonEncryptionCbcs scheme" + } + ], + "modelAsExtensible": true + }, + "description": "Encryption scheme" + }, + "paths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Streaming paths for each protocol and encryptionScheme pair" + } + }, + "type": "object", + "required": [ + "streamingProtocol", + "encryptionScheme" + ], + "description": "Class of paths for streaming" + }, + "StreamingLocatorProperties": { + "properties": { + "assetName": { + "type": "string", + "description": "Asset Name" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "Creation time of Streaming Locator", + "readOnly": true, + "x-nullable": false + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "StartTime of Streaming Locator" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "EndTime of Streaming Locator" + }, + "streamingLocatorId": { + "type": "string", + "format": "uuid", + "description": "StreamingLocatorId of Streaming Locator" + }, + "streamingPolicyName": { + "type": "string", + "description": "Streaming policy name used by this streaming locator. Either specify the name of streaming policy you created or use one of the predefined streaming polices. The predefined streaming policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_SecureStreaming' and 'Predefined_SecureStreamingWithFairPlay'" + }, + "defaultContentKeyPolicyName": { + "type": "string", + "description": "Default ContentKeyPolicy used by this Streaming Locator" + }, + "contentKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingLocatorUserDefinedContentKey" + }, + "description": "ContentKeys used by this Streaming Locator" + } + }, + "type": "object", + "required": [ + "assetName", + "streamingPolicyName" + ], + "description": "Class to specify properties of Streaming Locator" + }, + "ListContentKeysResponse": { + "properties": { + "contentKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingLocatorContentKey" + }, + "description": "ContentKeys used by current Streaming Locator" + } + }, + "type": "object", + "description": "Class of response for listContentKeys action" + }, + "ListPathsResponse": { + "properties": { + "streamingPaths": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingPath" + }, + "description": "Streaming Paths supported by current Streaming Locator" + }, + "downloadPaths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Download Paths supported by current Streaming Locator" + } + }, + "type": "object", + "description": "Class of response for listPaths action" + }, + "StreamingLocator": { + "allOf": [ + { + "$ref": "./Common.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StreamingLocatorProperties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Streaming Locator resource" + }, + "StreamingPolicyCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingPolicy" + }, + "description": "A collection of StreamingPolicy items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of StreamingPolicy items." + }, + "StreamingLocatorCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingLocator" + }, + "description": "A collection of StreamingLocator items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of StreamingLocator items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies": { + "get": { + "summary": "List Streaming Policies", + "description": "Lists the Streaming Policies in the account", + "operationId": "StreamingPolicies_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingPolicyCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/StreamingPolicy", + "x-ms-examples": { + "Lists Streaming Policies": { + "$ref": "examples/streaming-policies-list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies/{streamingPolicyName}": { + "get": { + "summary": "Get a Streaming Policy", + "description": "Get the details of a Streaming Policy in the Media Services account", + "operationId": "StreamingPolicies_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingPolicy" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Streaming Policy by name": { + "$ref": "examples/streaming-policy-get-by-name.json" + } + } + }, + "put": { + "summary": "Create a Streaming Policy", + "description": "Create a Streaming Policy in the Media Services account", + "operationId": "StreamingPolicies_Create", + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/StreamingPolicy" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Policy name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingPolicy" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Creates a Streaming Policy with clear streaming": { + "$ref": "examples/streaming-policies-create-clear.json" + }, + "Creates a Streaming Policy with envelopeEncryption only": { + "$ref": "examples/streaming-policies-create-envelopeEncryption-only.json" + }, + "Creates a Streaming Policy with commonEncryptionCenc only": { + "$ref": "examples/streaming-policies-create-commonEncryptionCenc-only.json" + }, + "Creates a Streaming Policy with commonEncryptionCbcs only": { + "$ref": "examples/streaming-policies-create-commonEncryptionCbcs-only.json" + }, + "Creates a Streaming Policy with secure streaming": { + "$ref": "examples/streaming-policies-create-secure-streaming.json" + } + } + }, + "delete": { + "summary": "Delete a Streaming Policy", + "description": "Deletes a Streaming Policy in the Media Services account", + "operationId": "StreamingPolicies_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Streaming Policy": { + "$ref": "examples/streaming-policies-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators": { + "get": { + "summary": "List Streaming Locators", + "description": "Lists the Streaming Locators in the account", + "operationId": "StreamingLocators_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingLocatorCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/StreamingLocator", + "x-ms-examples": { + "Lists Streaming Locators": { + "$ref": "examples/streaming-locators-list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}": { + "get": { + "summary": "Get a Streaming Locator", + "description": "Get the details of a Streaming Locator in the Media Services account", + "operationId": "StreamingLocators_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingLocator" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Streaming Locator by name": { + "$ref": "examples/streaming-locators-get-by-name.json" + } + } + }, + "put": { + "summary": "Create a Streaming Locator", + "description": "Create a Streaming Locator in the Media Services account", + "operationId": "StreamingLocators_Create", + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/StreamingLocator" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingLocator" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Creates a Streaming Locator with clear streaming": { + "$ref": "examples/streaming-locators-create-clear.json" + }, + "Creates a Streaming Locator with secure streaming": { + "$ref": "examples/streaming-locators-create-secure.json" + }, + "Creates a Streaming Locator with user defined content keys": { + "$ref": "examples/streaming-locators-create-secure-userDefinedContentKeys.json" + } + } + }, + "delete": { + "summary": "Delete a Streaming Locator", + "description": "Deletes a Streaming Locator in the Media Services account", + "operationId": "StreamingLocators_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Streaming Locator": { + "$ref": "examples/streaming-locators-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listContentKeys": { + "post": { + "summary": "List Content Keys", + "description": "List Content Keys used by this Streaming Locator", + "operationId": "StreamingLocators_ListContentKeys", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListContentKeysResponse" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Content Keys": { + "$ref": "examples/streaming-locators-list-content-keys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listPaths": { + "post": { + "summary": "List Paths", + "description": "List Paths supported by this Streaming Locator", + "operationId": "StreamingLocators_ListPaths", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListPathsResponse" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Paths which has streaming paths only": { + "$ref": "examples/streaming-locators-list-paths-streaming-only.json" + }, + "List Paths which has streaming paths and download paths": { + "$ref": "examples/streaming-locators-list-paths-streaming-and-download.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-check-name-availability.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-check-name-availability.json new file mode 100644 index 000000000000..9aad81eaa24d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-check-name-availability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "locationName": "japaneast", + "parameters": { + "name": "contosonew", + "type": "Microsoft.Media/MediaService" + }, + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-create.json new file mode 100644 index 000000000000..e45eecd0de39 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-create.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2018-03-30-preview", + "parameters": { + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "contososports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contososports", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "42bea25f-1aa9-4f7a-82af-5a417592f22d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + }, + "200": { + "body": { + "name": "contososports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contososports", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "42bea25f-1aa9-4f7a-82af-5a417592f22d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-delete.json new file mode 100644 index 000000000000..a593d19bc763 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-get-by-name.json new file mode 100644 index 000000000000..0f3507993b5a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-get-by-name.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosotv", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "name": "contosotv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosotv", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "6ac94f91-283c-4492-85a7-57976928c17d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosotvstore", + "type": "Primary" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-list-all-accounts.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-list-all-accounts.json new file mode 100644 index 000000000000..a2b39638396a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-list-all-accounts.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contosotv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosotv", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "6ac94f91-283c-4492-85a7-57976928c17d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosotvstore", + "type": "Primary" + } + ] + } + }, + { + "name": "contosomovies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomovies", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "72681c0f-9dd1-4f1c-95c9-8a8d7d31c4ee", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosomoviesstore", + "type": "Primary" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-subscription-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-subscription-get-by-name.json new file mode 100644 index 000000000000..294acb38dda4 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-subscription-get-by-name.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "name": "contososports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contososports", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "42bea25f-1aa9-4f7a-82af-5a417592f22d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-subscription-list-all-accounts.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-subscription-list-all-accounts.json new file mode 100644 index 000000000000..4e934468d15f --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-subscription-list-all-accounts.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contosotv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosotv", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "6ac94f91-283c-4492-85a7-57976928c17d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosotvstore", + "type": "Primary" + } + ] + } + }, + { + "name": "contosomovies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomovies", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "72681c0f-9dd1-4f1c-95c9-8a8d7d31c4ee", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosomoviesstore", + "type": "Primary" + } + ] + } + }, + { + "name": "fabrikamnews", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/fabrikamnews", + "type": "Microsoft.Media/mediaservices", + "location": "East US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "d96036f9-4e37-491d-8c29-5bc53a29dfcd", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Storage/storageAccounts/fabrikamnewsstore", + "type": "Primary" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-sync-storage-keys.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-sync-storage-keys.json new file mode 100644 index 000000000000..5cc591cd0c8e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-sync-storage-keys.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2018-03-30-preview", + "parameters": { + "id": "contososportsstore" + } + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-update.json new file mode 100644 index 000000000000..311521534af8 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/accounts-update.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2018-03-30-preview", + "parameters": { + "tags": { + "key1": "value3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "contososports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contososports", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value3" + }, + "properties": { + "mediaServiceId": "42bea25f-1aa9-4f7a-82af-5a417592f22d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-create.json new file mode 100644 index 000000000000..6030d2cfaf61 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountLogan", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "description": "A documentary showing the ascent of Mount Logan", + "storageAccountName": "storage0" + } + } + }, + "responses": { + "201": { + "body": { + "name": "ClimbingMountLogan", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountLogan", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "5dfc98fa-24e4-48b6-a166-a3ff29e5987b", + "created": "2018-04-20T13:44:29.03Z", + "lastModified": "2018-04-20T13:44:29.03Z", + "alternateId": null, + "description": "A documentary showing the ascent of Mount Logan", + "container": null, + "storageAccountName": "storage0", + "storageEncryptionFormat": "None" + } + } + }, + "200": { + "body": { + "name": "ClimbingMountLogan", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountLogan", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "5dfc98fa-24e4-48b6-a166-a3ff29e5987b", + "created": "2018-04-20T13:44:29.03Z", + "lastModified": "2018-04-20T13:44:29.083Z", + "alternateId": null, + "description": "A documentary showing the ascent of Mount Logan", + "container": null, + "storageAccountName": "storage0", + "storageEncryptionFormat": "None" + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-delete.json new file mode 100644 index 000000000000..f421538b2777 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountAdams", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-get-by-name.json new file mode 100644 index 000000000000..559f24ed6e8d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-get-by-name.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountAdams", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-get-encryption-keys.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-get-encryption-keys.json new file mode 100644 index 000000000000..a37c1a437f7c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-get-encryption-keys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountAdams", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "storageEncryptionKey": null + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-list-all.json new file mode 100644 index 000000000000..02277422b47c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-list-all.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ClimbingLittleTahoma", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingLittleTahoma", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "e6c7ee55-d1f5-48bc-9c36-2d2157aadbbe", + "created": "2012-04-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00003", + "description": "A documentary showing the ascent of Little Tahoma", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountBaker", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountBaker", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "89af1750-e681-4fbe-8c4c-9a5567867a6b", + "created": "2011-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00004", + "description": "A documentary showing the ascent of Mount Baker", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountRainier", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainier", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "alternateId": "CLIMB00001", + "description": "A documentary showing the ascent of Mount Rainier", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-list-by-date.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-list-by-date.json new file mode 100644 index 000000000000..5e2e5e25d6dc --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-list-by-date.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-03-30-preview", + "$orderby": "properties/created" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ClimbingMountBaker", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountBaker", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "89af1750-e681-4fbe-8c4c-9a5567867a6b", + "created": "2011-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00004", + "description": "A documentary showing the ascent of Mount Baker", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingLittleTahoma", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingLittleTahoma", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "e6c7ee55-d1f5-48bc-9c36-2d2157aadbbe", + "created": "2012-04-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00003", + "description": "A documentary showing the ascent of Little Tahoma", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountRainier", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainier", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "alternateId": "CLIMB00001", + "description": "A documentary showing the ascent of Mount Rainier", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-list-in-date-range.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-list-in-date-range.json new file mode 100644 index 000000000000..41346fb9dfec --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-list-in-date-range.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-03-30-preview", + "$orderby": "properties/created", + "$filter": "properties/created gt 2012-06-01 and properties/created lt 2013-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ClimbingMountRainier", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainier", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "alternateId": "CLIMB00001", + "description": "A documentary showing the ascent of Mount Rainier", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-list-sas-urls.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-list-sas-urls.json new file mode 100644 index 000000000000..c76387b456da --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-list-sas-urls.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountBaker", + "api-version": "2018-03-30-preview", + "parameters": { + "permissions": "ReadWrite", + "expiryTime": "2018-01-01T10:00:00.007Z" + } + }, + "responses": { + "200": { + "body": { + "assetContainerSasUrls": [ + "https://storage0.blob.core.windows.net/asset-89af1750-e681-4fbe-8c4c-9a5567867a6b?sr=b&sig=&se=2018-01-01T10:00:00Z&sp=lrw", + "https://storage0.blob.core.windows.net/asset-89af1750-e681-4fbe-8c4c-9a5567867a6b?sr=b&sig=&se=2018-01-01T10:00:00Z&sp=lrw" + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-update.json new file mode 100644 index 000000000000..f364c58cad97 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/assets-update.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountBaker", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "description": "A documentary showing the ascent of Mount Baker in HD" + } + } + }, + "responses": { + "200": { + "body": { + "name": "ClimbingMountBaker", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountBaker", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "89af1750-e681-4fbe-8c4c-9a5567867a6b", + "created": "2011-02-01T00:00:00Z", + "lastModified": "2018-04-20T13:44:29.27Z", + "alternateId": "CLIMB00004", + "description": "A documentary showing the ascent of Mount Baker in HD", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-create-multiple-options.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-create-multiple-options.json new file mode 100644 index 000000000000..d28b0de1b976 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-create-multiple-options.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyCreatedWithMultipleOptions", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "description": "ArmPolicyDescription", + "options": [ + { + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAAAAAAAAAAAAAAAAAAAAA==" + }, + "restrictionTokenType": "Swt" + } + }, + { + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyCreatedWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyCreatedWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "720ef07f-a2bd-4d02-89ca-e31177e9517e", + "created": "2018-03-07T18:49:21.16Z", + "lastModified": "2018-03-07T18:49:21.16Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "3f114e9c-4b81-48ac-a7c4-79bb2bc58224", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt", + "openIdConnectDiscoveryDocument": null + } + }, + { + "policyOptionId": "7fc39d0a-1a75-4109-acf8-3fa6a6cdb041", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyCreatedWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyCreatedWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "720ef07f-a2bd-4d02-89ca-e31177e9517e", + "created": "2018-03-07T18:49:21.16Z", + "lastModified": "2018-03-07T18:49:21.16Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "3f114e9c-4b81-48ac-a7c4-79bb2bc58224", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt", + "openIdConnectDiscoveryDocument": null + } + }, + { + "policyOptionId": "7fc39d0a-1a75-4109-acf8-3fa6a6cdb041", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-create-nodrm-token.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-create-nodrm-token.json new file mode 100644 index 000000000000..0e549a219813 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-create-nodrm-token.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithClearKeyOptionAndSwtTokenRestriction", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "description": "ArmPolicyDescription", + "options": [ + { + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAAAAAAAAAAAAAAAAAAAAA==" + }, + "restrictionTokenType": "Swt" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithClearKeyOptionAndSwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndSwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "cb77b46c-f120-4e28-ae45-11be48aea02c", + "created": "2018-03-07T18:49:21.103Z", + "lastModified": "2018-03-07T18:49:21.103Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "5fa6f216-bfdb-4e3f-9ea5-d8dcc023ed7f", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt", + "openIdConnectDiscoveryDocument": null + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyWithClearKeyOptionAndSwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndSwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "cb77b46c-f120-4e28-ae45-11be48aea02c", + "created": "2018-03-07T18:49:21.103Z", + "lastModified": "2018-03-07T18:49:21.103Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "5fa6f216-bfdb-4e3f-9ea5-d8dcc023ed7f", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt", + "openIdConnectDiscoveryDocument": null + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-create-playready-open.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-create-playready-open.json new file mode 100644 index 000000000000..7ff95f2e2cc3 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-create-playready-open.json @@ -0,0 +1,157 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "policyId": "00000000-0000-0000-0000-000000000000", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "00000000-0000-0000-0000-000000000000", + "name": "ArmPolicyOptionName", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": true, + "beginDate": "2017-10-16T18:22:53.46Z", + "playRight": { + "scmsRestriction": 2, + "imageConstraintForAnalogComponentVideoRestriction": true, + "allowPassingVideoContentToUnknownOutput": "NotAllowed" + }, + "licenseType": "Persistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "UltraVioletDownload" + } + ] + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2018-03-07T18:49:20.94Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "9f60df33-124b-4590-94c8-f00d92107187", + "name": "ArmPolicyOptionName", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": true, + "beginDate": "2017-10-16T18:22:53.46Z", + "expirationDate": null, + "relativeBeginDate": null, + "relativeExpirationDate": null, + "gracePeriod": null, + "playRight": { + "firstPlayExpiration": null, + "scmsRestriction": 2, + "agcAndColorStripeRestriction": null, + "explicitAnalogTelevisionOutputRestriction": null, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": true, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed", + "uncompressedDigitalVideoOpl": null, + "compressedDigitalVideoOpl": null, + "analogVideoOpl": null, + "compressedDigitalAudioOpl": null, + "uncompressedDigitalAudioOpl": null + }, + "licenseType": "Persistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "UltraVioletDownload" + } + ], + "responseCustomData": null + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2018-03-07T18:49:20.94Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "9f60df33-124b-4590-94c8-f00d92107187", + "name": "ArmPolicyOptionName", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": true, + "beginDate": "2017-10-16T18:22:53.46Z", + "expirationDate": null, + "relativeBeginDate": null, + "relativeExpirationDate": null, + "gracePeriod": null, + "playRight": { + "firstPlayExpiration": null, + "scmsRestriction": 2, + "agcAndColorStripeRestriction": null, + "explicitAnalogTelevisionOutputRestriction": null, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": true, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed", + "uncompressedDigitalVideoOpl": null, + "compressedDigitalVideoOpl": null, + "analogVideoOpl": null, + "compressedDigitalAudioOpl": null, + "uncompressedDigitalAudioOpl": null + }, + "licenseType": "Persistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "UltraVioletDownload" + } + ], + "responseCustomData": null + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-create-widevine-token.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-create-widevine-token.json new file mode 100644 index 000000000000..040b101db20a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-create-widevine-token.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithWidevineOptionAndJwtTokenRestriction", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "description": "ArmPolicyDescription", + "options": [ + { + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "exponent": "AQAB", + "modulus": "AQAD" + }, + "alternateVerificationKeys": [ + { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAAAAAAAAAAAAAAAAAAAAA==" + } + ], + "restrictionTokenType": "Jwt" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithWidevineOptionAndJwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithWidevineOptionAndJwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "f5f2f742-e073-4a7a-8663-09ffdad9d2c0", + "created": "2018-03-07T18:49:21.007Z", + "lastModified": "2018-03-07T18:49:21.007Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "56af71e4-6e97-4588-a162-bad1f5b03074", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "exponent": "", + "modulus": "" + }, + "alternateVerificationKeys": [ + { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + } + ], + "requiredClaims": [], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyWithWidevineOptionAndJwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithWidevineOptionAndJwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "f5f2f742-e073-4a7a-8663-09ffdad9d2c0", + "created": "2018-03-07T18:49:21.007Z", + "lastModified": "2018-03-07T18:49:21.007Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "56af71e4-6e97-4588-a162-bad1f5b03074", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "exponent": "", + "modulus": "" + }, + "alternateVerificationKeys": [ + { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + } + ], + "requiredClaims": [], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-delete.json new file mode 100644 index 000000000000..3a62484b13ce --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-get-by-name.json new file mode 100644 index 000000000000..37ecf53dd233 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-get-by-name.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithMultipleOptions", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-get-with-secrets.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-get-with-secrets.json new file mode 100644 index 000000000000..72108574dc0a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-get-with-secrets.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithMultipleOptions", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAA=" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-list-all.json new file mode 100644 index 000000000000..376d4d470ebe --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-list-all.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "PolicyWithClearKeyOptionAndTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "8352435b-ebea-4681-aae7-e19277771f64", + "created": "2017-12-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "description": "A policy with one ClearKey option and Open Restriction.", + "options": [ + { + "policyOptionId": "a3448d09-567a-4642-8309-d17e846be59f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + } + ] + } + }, + { + "name": "PolicyWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "description": "A policy with one PlayReady option and Open Restriction.", + "options": [ + { + "policyOptionId": "294a833f-f128-48be-9edf-8d1bb5b35ff3", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": false, + "beginDate": null, + "expirationDate": null, + "relativeBeginDate": null, + "relativeExpirationDate": null, + "gracePeriod": null, + "playRight": { + "firstPlayExpiration": null, + "scmsRestriction": null, + "agcAndColorStripeRestriction": null, + "explicitAnalogTelevisionOutputRestriction": null, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": false, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed", + "uncompressedDigitalVideoOpl": null, + "compressedDigitalVideoOpl": null, + "analogVideoOpl": null, + "compressedDigitalAudioOpl": null, + "uncompressedDigitalAudioOpl": null + }, + "licenseType": "NonPersistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "Unspecified" + } + ], + "responseCustomData": "testCustomData" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-list-by-lastModified.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-list-by-lastModified.json new file mode 100644 index 000000000000..1664dc22f8d8 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-list-by-lastModified.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-03-30-preview", + "$orderby": "properties/lastModified" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "description": "A policy with one PlayReady option and Open Restriction.", + "options": [ + { + "policyOptionId": "294a833f-f128-48be-9edf-8d1bb5b35ff3", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": false, + "beginDate": null, + "expirationDate": null, + "relativeBeginDate": null, + "relativeExpirationDate": null, + "gracePeriod": null, + "playRight": { + "firstPlayExpiration": null, + "scmsRestriction": null, + "agcAndColorStripeRestriction": null, + "explicitAnalogTelevisionOutputRestriction": null, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": false, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed", + "uncompressedDigitalVideoOpl": null, + "compressedDigitalVideoOpl": null, + "analogVideoOpl": null, + "compressedDigitalAudioOpl": null, + "uncompressedDigitalAudioOpl": null + }, + "licenseType": "NonPersistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "Unspecified" + } + ], + "responseCustomData": "testCustomData" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + { + "name": "PolicyWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + { + "name": "PolicyWithClearKeyOptionAndTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "8352435b-ebea-4681-aae7-e19277771f64", + "created": "2017-12-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "description": "A policy with one ClearKey option and Open Restriction.", + "options": [ + { + "policyOptionId": "a3448d09-567a-4642-8309-d17e846be59f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-list-in-date-range.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-list-in-date-range.json new file mode 100644 index 000000000000..ed8ce398dad1 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-list-in-date-range.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-03-30-preview", + "$filter": "properties/lastModified gt 2016-06-01 and properties/created lt 2013-07-01" + }, + "responses": { + "200": { + "body": { + "value": [] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-update.json new file mode 100644 index 000000000000..b948d59eaac4 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/content-key-policies-update.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "description": "Updated Policy", + "options": [ + { + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithClearKeyOptionAndTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "8352435b-ebea-4681-aae7-e19277771f64", + "created": "2017-12-01T00:00:00Z", + "lastModified": "2018-03-07T18:49:21.33Z", + "description": "Updated Policy", + "options": [ + { + "policyOptionId": "50159d89-f0ce-4ec2-80e5-86ee54dba014", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-cancel.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-cancel.json new file mode 100644 index 000000000000..6c4837424e0e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-cancel.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-03-30-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "ExampleTransform", + "jobName": "job1" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-create.json new file mode 100644 index 000000000000..74d038f1e020 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-create.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2018-03-30-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "ExampleTransform", + "jobName": "job1", + "parameters": { + "properties": { + "input": { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "assetName": "job1-InputAsset" + }, + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "assetName": "job1-OutputAsset" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/ExampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2018-03-05T23:52:20.0364205Z", + "state": "Queued", + "description": null, + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "label": null, + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "label": null, + "files": [], + "assetName": "job1-InputAsset" + } + ] + }, + "lastModified": "2018-03-05T23:52:20.0364205Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "error": null, + "state": "Queued", + "progress": 0, + "assetName": "job1-OutputAsset" + } + ], + "priority": "Normal" + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-delete.json new file mode 100644 index 000000000000..a8953bb8464e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2018-03-30-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "ExampleTransform", + "jobName": "jobToDelete" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-get-by-name.json new file mode 100644 index 000000000000..fb2d9650f6dd --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-get-by-name.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2018-03-30-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "ExampleTransform", + "jobName": "job1" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/ExampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2018-03-05T23:52:20.0074211Z", + "state": "Queued", + "description": null, + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "label": null, + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "label": null, + "files": [], + "assetName": "job1 input" + } + ] + }, + "lastModified": "2018-03-05T23:52:20.0074211Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "error": null, + "state": "Queued", + "progress": 0, + "assetName": "job1 output" + } + ], + "priority": "Low" + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-list-all.json new file mode 100644 index 000000000000..737ff0387a52 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/jobs-list-all.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2018-03-30-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "ExampleTransform" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/ExampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2018-03-05T23:52:19.9449439Z", + "state": "Queued", + "description": null, + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "label": null, + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "label": null, + "files": [], + "assetName": "job1 input" + } + ] + }, + "lastModified": "2018-03-05T23:52:19.9449439Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "error": null, + "state": "Queued", + "progress": 0, + "assetName": "job1 output" + } + ], + "priority": "Low" + } + }, + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/ExampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2018-03-05T23:52:19.9459101Z", + "state": "Processing", + "description": null, + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "label": null, + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "label": null, + "files": [], + "assetName": "job2 input" + } + ] + }, + "lastModified": "2018-03-05T23:52:19.9459101Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "error": null, + "state": "Processing", + "progress": 50, + "assetName": "job2 output" + } + ], + "priority": "Low" + } + }, + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/ExampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2018-03-05T23:52:19.9459101Z", + "state": "Finished", + "description": null, + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "label": null, + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "label": null, + "files": [], + "assetName": "job3 input" + } + ] + }, + "lastModified": "2018-03-05T23:52:19.9459101Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "error": null, + "state": "Finished", + "progress": 100, + "assetName": "job3 output" + } + ], + "priority": "Low" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-create.json new file mode 100644 index 000000000000..07d8578572d6 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-create.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-03-30-preview", + "parameters": { + "id": "nb:chid:UUID:00000001-2000-0000-0000-000000000000", + "name": "myLiveEvent1", + "location": "West US", + "type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "input": { + "streamingProtocol": "RTMP", + "keyFrameIntervalDuration": "PT2S" + }, + "preview": { + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0" + } + ] + } + } + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "resourceState": "Stopped", + "provisioningState": "InProgress", + "created": "2018-03-03T02:25:06.0982751Z", + "lastModified": "2018-03-03T02:25:06.0982751Z", + "vanityUrl": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "0abf356884d74b4aacbd7b1ebd3da0f7", + "endpoints": [] + }, + "preview": { + "previewLocator": "c91726b4-880c-4090-94aa-e6ddb1384b37", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": null + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": null, + "crossDomainPolicy": null + } + } + } + }, + "200": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "resourceState": "Stopped", + "provisioningState": "InProgress", + "created": "2018-03-03T02:25:06.0982751Z", + "lastModified": "2018-03-03T02:25:06.0982751Z", + "vanityUrl": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "0abf356884d74b4aacbd7b1ebd3da0f7", + "endpoints": [] + }, + "preview": { + "previewLocator": "c91726b4-880c-4090-94aa-e6ddb1384b37", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": null + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": null, + "crossDomainPolicy": null + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-delete.json new file mode 100644 index 000000000000..ccc70906235e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-delete.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-03-30-preview", + "parameters": { + "Id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "Name": "myLiveEvent1", + "Type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents", + "Location": "West US", + "Tags": { + "DynamicProperties": { + "tag1": "value1", + "tag2": "value2" + } + }, + "Properties": { + "Description": "test event updated", + "Input": { + "StreamingProtocol": "FragmentedMP4", + "KeyFrameIntervalDuration": "PT6S", + "Endpoints": [], + "AccessToken": null + }, + "Preview": { + "Endpoints": [], + "AccessControl": { + "IP": { + "Allow": [ + { + "Name": "AllowOne", + "Address": "192.1.1.0", + "SubnetPrefixLength": null + } + ] + } + }, + "PreviewLocator": null, + "StreamingPolicyName": null + }, + "Encoding": { + "EncodingType": "None", + "PresetName": null + }, + "ProvisioningState": null, + "ResourceState": "Stopped", + "CrossSiteAccessPolicies": null, + "VanityUrl": false, + "StreamOptions": [], + "Created": "2018-03-02T18:25:07.5748853-08:00", + "LastModified": "2018-03-02T18:25:07.5748853-08:00" + } + } + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-list-all.json new file mode 100644 index 000000000000..12a9f113030c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-list-all.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "resourceState": "Stopped", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:08.5564064Z", + "lastModified": "2018-03-03T02:25:08.5564064Z", + "vanityUrl": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "de153bb0814542d9b7e2339ce9430dc4", + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "http://clouddeployment.media-test.net/de153bb0814542d9b7e2339ce9430dc4/ingest.isml" + } + ] + }, + "preview": { + "previewLocator": "a220e223-faf8-4e03-b9a9-2c2432f48025", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": null + } + ] + } + }, + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "https://myliveevent1-slitestmedia10.preview-usso.channel.mediaservices.windows.net/a220e223-faf8-4e03-b9a9-2c2432f48025/preview.ism/manifest" + } + ] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": null, + "crossDomainPolicy": null + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-list-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-list-by-name.json new file mode 100644 index 000000000000..b17b37239b60 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-list-by-name.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-03-30-preview" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": {}, + "properties": { + "description": "", + "resourceState": "Stopped", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:08.3474032Z", + "lastModified": "2018-03-03T02:25:08.3474032Z", + "vanityUrl": false, + "streamOptions": [ + "Default" + ], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": null, + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "http://clouddeployment.media-test.net/ingest.isml" + } + ] + }, + "preview": { + "previewLocator": "763f3ea4-d94f-441c-a634-c833f61a4e04", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + }, + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "https://testeventopito4idh2r-weibzmedia05.preview-ts051.channel.media-test.windows-int.net/763f3ea4-d94f-441c-a634-c833f61a4e04/preview.ism/manifest" + } + ] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": "", + "crossDomainPolicy": "" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-reset.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-reset.json new file mode 100644 index 000000000000..f6bdc3bb200c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-reset.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-03-30-preview" + }, + "responses": { + "202": {}, + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-start.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-start.json new file mode 100644 index 000000000000..f6bdc3bb200c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-start.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-03-30-preview" + }, + "responses": { + "202": {}, + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-stop.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-stop.json new file mode 100644 index 000000000000..6f8396ac56d7 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-stop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-03-30-preview", + "parameters": { + "removeOutputsOnStop": false + } + }, + "responses": { + "202": {}, + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-update.json new file mode 100644 index 000000000000..b88fe16c6755 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveevent-update.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-03-30-preview", + "parameters": { + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "name": "myLiveEvent1", + "location": "West US", + "type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "properties": { + "description": "test event updated", + "input": { + "streamingProtocol": "FragmentedMP4", + "keyFrameIntervalDuration": "PT6S" + }, + "preview": { + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0" + } + ] + } + } + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "properties": { + "description": "test event updated", + "resourceState": "Running", + "provisioningState": "InProgress", + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z", + "vanityUrl": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "c638baac3195406a84d7ff3bcba8bde4", + "endpoints": [] + }, + "preview": { + "previewLocator": "c10ea3fc-587f-4daf-b2b2-fa8f647a9ed2", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0", + "subnetPrefixLength": null + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + } + } + } + }, + "200": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "properties": { + "description": "test event updated", + "resourceState": "Running", + "provisioningState": "InProgress", + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z", + "vanityUrl": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "c638baac3195406a84d7ff3bcba8bde4", + "endpoints": [] + }, + "preview": { + "previewLocator": "c10ea3fc-587f-4daf-b2b2-fa8f647a9ed2", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0", + "subnetPrefixLength": null + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveoutput-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveoutput-create.json new file mode 100644 index 000000000000..cc03b1310c27 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveoutput-create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "liveOutputName": "myLiveOutput1", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "description": "test live output 1", + "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212", + "archiveWindowLength": "PT5M", + "manifestName": "testmanifest", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myLiveOutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": "test live output 1", + "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212", + "archiveWindowLength": "PT5M", + "manifestName": "testmanifest", + "outputSnapTime": 0, + "resourceState": "Creating", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:09.9431835Z", + "lastModified": "2018-03-03T02:25:09.9431835Z", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + }, + "202": { + "body": { + "name": "myLiveOutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": "test live output 1", + "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212", + "archiveWindowLength": "PT5M", + "manifestName": "testmanifest", + "outputSnapTime": 0, + "resourceState": "Creating", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:09.9431835Z", + "lastModified": "2018-03-03T02:25:09.9431835Z", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveoutput-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveoutput-delete.json new file mode 100644 index 000000000000..5de0349ad5d5 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveoutput-delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "liveOutputName": "myLiveOutput1", + "api-version": "2018-03-30-preview" + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveoutput-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveoutput-list-all.json new file mode 100644 index 000000000000..3545c1448292 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveoutput-list-all.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "liveoutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": null, + "assetName": "95dafce4-5320-464c-8597-909373854119", + "archiveWindowLength": "PT30S", + "manifestName": "c3a23d4b-02a6-4937-a1ad-6416f463fdca", + "outputSnapTime": 0, + "resourceState": "Running", + "provisioningState": "Succeeded", + "created": "0001-01-01T00:00:00-08:00", + "lastModified": "0001-01-01T00:00:00-08:00", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveoutput-list-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveoutput-list-by-name.json new file mode 100644 index 000000000000..16a359f44592 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/liveoutput-list-by-name.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "liveOutputName": "myLiveOutput1", + "api-version": "2018-03-30-preview" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "myLiveOutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": null, + "assetName": "cb2ae0bc-677a-4830-9c8e-06ce4c4cb607", + "archiveWindowLength": "PT30S", + "manifestName": "fc7096f5-c488-4b86-8302-f3bfde53fc27", + "outputSnapTime": 0, + "resourceState": "Running", + "provisioningState": "Succeeded", + "created": "0001-01-01T00:00:00-08:00", + "lastModified": "0001-01-01T00:00:00-08:00", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/operations-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/operations-list-all.json new file mode 100644 index 000000000000..3a7ff0ba371a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/operations-list-all.json @@ -0,0 +1,285 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Media/register/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Microsoft Media Services", + "operation": "Registers the Media Services Resource Provider", + "description": "Registers the subscription for the Media Services resource provider and enables the creation of Media Services accounts" + } + }, + { + "name": "Microsoft.Media/checknameavailability/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Microsoft Media Services", + "operation": "Check Name Availability", + "description": "Checks if a Media Services account name is available" + } + }, + { + "name": "Microsoft.Media/operations/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Available Operations", + "operation": "Read Media Services Account", + "description": "Read any Media Services Account" + } + }, + { + "name": "Microsoft.Media/mediaservices/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Read Media Services Account", + "description": "Read any Media Services Account" + } + }, + { + "name": "Microsoft.Media/mediaservices/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Create or Update Media Services Account", + "description": "Create or Update any Media Services Account" + } + }, + { + "name": "Microsoft.Media/mediaservices/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Delete Media Services Account", + "description": "Delete any Media Services Account" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Read Asset", + "description": "Read any Asset" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Create or Update Asset", + "description": "Create or Update any Asset" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Delete Asset", + "description": "Delete any Asset" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/listContainerSas/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "List Asset Container SAS URLs", + "description": "List Asset Container SAS URLs" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/getEncryptionKey/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Get Asset Encryption Key", + "description": "Get Asset Encryption Key" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingPolicies/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Policy", + "operation": "Read Streaming Policy", + "description": "Read any Streaming Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingPolicies/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Policy", + "operation": "Create or Update Streaming Policy", + "description": "Create or Update any Streaming Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingPolicies/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Policy", + "operation": "Delete Streaming Policy", + "description": "Delete any Streaming Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "Read Streaming Locator", + "description": "Read any Streaming Locator" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "Create or Update Streaming Locator", + "description": "Create or Update any Streaming Locator" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "Delete Streaming Locator", + "description": "Delete any Streaming Locator" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/listContentKeys/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "List Content Keys", + "description": "List Content Keys" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/listPaths/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "List Paths", + "description": "List Paths" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Read Content Key Policy", + "description": "Read any Content Key Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Create or Update Content Key Policy", + "description": "Create or Update any Content Key Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Delete Content Key Policy", + "description": "Delete any Content Key Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/getPolicyPropertiesWithSecrets/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Get Policy Properties With Secrets", + "description": "Get Policy Properties With Secrets" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Transform", + "operation": "Read Transform", + "description": "Read any Transform" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Transform", + "operation": "Create or Update Transform", + "description": "Create or Update any Transform" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Transform", + "operation": "Delete Transform", + "description": "Delete any Transform" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Read Job", + "description": "Read any Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Create or Update Job", + "description": "Create or Update any Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Delete Job", + "description": "Delete any Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/cancelJob/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Cancel Job", + "description": "Cancel Job" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-create-clear.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-create-clear.json new file mode 100644 index 000000000000..103434801d22 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-create-clear.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "UserCreatedClearStreamingLocator", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "StreamingPolicyName": "clearStreamingPolicy", + "AssetName": "ClimbingMountRainier" + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedClearStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedClearStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-03-07T18:49:22.3643095Z", + "startTime": null, + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "fb694b0b-8ce5-45ef-a384-85766e03ef5c", + "streamingPolicyName": "clearStreamingPolicy", + "defaultContentKeyPolicyName": null, + "contentKeys": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-create-secure-userDefinedContentKeys.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-create-secure-userDefinedContentKeys.json new file mode 100644 index 000000000000..9de3dfdafc7c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-create-secure-userDefinedContentKeys.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "assetName": "ClimbingMountRainier", + "streamingPolicyName": "secureStreamingPolicy", + "StreamingLocatorId": "90000000-0000-0000-0000-00000000000A", + "ContentKeys": [ + { + "Label": "aesDefaultKey", + "Id": "60000000-0000-0000-0000-000000000001", + "Value": "1UqLohAfWsEGkULYxHjYZg==" + }, + { + "Label": "cencDefaultKey", + "Id": "60000000-0000-0000-0000-000000000004", + "Value": "4UqLohAfWsEGkULYxHjYZg==" + }, + { + "Label": "cbcsDefaultKey", + "Id": "60000000-0000-0000-0000-000000000007", + "Value": "7UqLohAfWsEGkULYxHjYZg==" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-03-07T18:49:22.5133542Z", + "startTime": null, + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "90000000-0000-0000-0000-00000000000a", + "streamingPolicyName": "secureStreamingPolicy", + "defaultContentKeyPolicyName": null, + "contentKeys": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-create-secure.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-create-secure.json new file mode 100644 index 000000000000..9138dce3a7a6 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-create-secure.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "UserCreatedSecureStreamingLocator", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "StreamingPolicyName": "secureStreamingPolicy", + "AssetName": "ClimbingMountRainier", + "StartTime": "2018-03-01T00:00:00Z", + "EndTime": "2028-12-31T23:59:59.9999999Z" + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedSecureStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-03-07T18:49:22.4378101Z", + "startTime": "2018-03-01T00:00:00Z", + "endTime": "2028-12-31T23:59:59.9999999Z", + "streamingLocatorId": "01fd96cf-95a8-4f71-a8e7-87d184d11902", + "streamingPolicyName": "secureStreamingPolicy", + "defaultContentKeyPolicyName": null, + "contentKeys": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-delete.json new file mode 100644 index 000000000000..712cafeac16c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "clearStreamingLocator", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-get-by-name.json new file mode 100644 index 000000000000..f2c0f95e24d6 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-get-by-name.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "clearStreamingLocator", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "name": "clearStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/clearStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-03-07T18:49:22.2003058Z", + "startTime": null, + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "2a7bd2f4-6675-45fd-a94a-4b7cec995591", + "streamingPolicyName": "clearStreamingPolicy", + "defaultContentKeyPolicyName": null, + "contentKeys": [] + } + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-list-content-keys.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-list-content-keys.json new file mode 100644 index 000000000000..dc3b9c0cc892 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-list-content-keys.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "secureStreamingLocator", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "contentKeys": [ + { + "label": "aesDefaultKey", + "type": "EnvelopeEncryption", + "id": "88424f84-3309-430d-aab4-25be8dba8540", + "value": "0GFWlqk+7i5upxzFe/xDPA==", + "policyName": "PolicyWithMultipleOptions", + "tracks": [] + }, + { + "label": "cencDefaultKey", + "type": "CommonEncryptionCenc", + "id": "82572a27-e4c3-4cd9-be77-f64821fcd4e7", + "value": "5NRozVA5Egz0zrI7PsU2Tg==", + "policyName": "PolicyWithMultipleOptions", + "tracks": [] + }, + { + "label": "cbcsDefaultKey", + "type": "CommonEncryptionCbcs", + "id": "baea7a00-ab4e-4dfa-afb7-1c72b39368d9", + "value": "da2Q113M/HCI5pOKAe1XOg==", + "policyName": "PolicyWithMultipleOptions", + "tracks": [] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-list-paths-streaming-and-download.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-list-paths-streaming-and-download.json new file mode 100644 index 000000000000..968c00a670ae --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-list-paths-streaming-and-download.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "clearStreamingLocator", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "streamingPaths": [ + { + "streamingProtocol": "Hls", + "encryptionScheme": "NoEncryption", + "paths": [ + "/4388089d-846d-4eed-83e3-9a227cd44c33/videoManifest1.ism/manifest(format=m3u8-aapl)", + "/4388089d-846d-4eed-83e3-9a227cd44c33/videoManifest2.ism/manifest(format=m3u8-aapl)", + "/4388089d-846d-4eed-83e3-9a227cd44c33/videoManifest3.ism/manifest(format=m3u8-aapl)" + ] + }, + { + "streamingProtocol": "Dash", + "encryptionScheme": "NoEncryption", + "paths": [ + "/4388089d-846d-4eed-83e3-9a227cd44c33/videoManifest1.ism/manifest(format=mpd-time-csf)", + "/4388089d-846d-4eed-83e3-9a227cd44c33/videoManifest2.ism/manifest(format=mpd-time-csf)", + "/4388089d-846d-4eed-83e3-9a227cd44c33/videoManifest3.ism/manifest(format=mpd-time-csf)" + ] + }, + { + "streamingProtocol": "SmoothStreaming", + "encryptionScheme": "NoEncryption", + "paths": [ + "/4388089d-846d-4eed-83e3-9a227cd44c33/videoManifest1.ism/manifest", + "/4388089d-846d-4eed-83e3-9a227cd44c33/videoManifest2.ism/manifest", + "/4388089d-846d-4eed-83e3-9a227cd44c33/videoManifest3.ism/manifest" + ] + } + ], + "downloadPaths": [ + "/4388089d-846d-4eed-83e3-9a227cd44c33/textTrack.vtt", + "/4388089d-846d-4eed-83e3-9a227cd44c33/video1.mp4", + "/4388089d-846d-4eed-83e3-9a227cd44c33/video2.mp4", + "/4388089d-846d-4eed-83e3-9a227cd44c33/video3.mp4" + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-list-paths-streaming-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-list-paths-streaming-only.json new file mode 100644 index 000000000000..6f6ec79a6910 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-list-paths-streaming-only.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "secureStreamingLocator", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "streamingPaths": [ + { + "streamingProtocol": "Hls", + "encryptionScheme": "EnvelopeEncryption", + "paths": [ + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest1.ism/manifest(format=m3u8-aapl,encryption=cbc)", + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest2.ism/manifest(format=m3u8-aapl,encryption=cbc)", + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest3.ism/manifest(format=m3u8-aapl,encryption=cbc)" + ] + }, + { + "streamingProtocol": "Dash", + "encryptionScheme": "EnvelopeEncryption", + "paths": [ + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest1.ism/manifest(format=mpd-time-csf,encryption=cbc)", + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest2.ism/manifest(format=mpd-time-csf,encryption=cbc)", + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest3.ism/manifest(format=mpd-time-csf,encryption=cbc)" + ] + }, + { + "streamingProtocol": "SmoothStreaming", + "encryptionScheme": "EnvelopeEncryption", + "paths": [ + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest1.ism/manifest(encryption=cbc)", + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest2.ism/manifest(encryption=cbc)", + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest3.ism/manifest(encryption=cbc)" + ] + }, + { + "streamingProtocol": "Dash", + "encryptionScheme": "CommonEncryptionCenc", + "paths": [ + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest1.ism/manifest(format=mpd-time-csf,encryption=cenc)", + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest2.ism/manifest(format=mpd-time-csf,encryption=cenc)", + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest3.ism/manifest(format=mpd-time-csf,encryption=cenc)" + ] + }, + { + "streamingProtocol": "SmoothStreaming", + "encryptionScheme": "CommonEncryptionCenc", + "paths": [ + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest1.ism/manifest(encryption=cenc)", + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest2.ism/manifest(encryption=cenc)", + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest3.ism/manifest(encryption=cenc)" + ] + }, + { + "streamingProtocol": "Hls", + "encryptionScheme": "CommonEncryptionCbcs", + "paths": [ + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest1.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)", + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest2.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)", + "/3b077902-e89d-48bc-b8e5-61e9b3c0f7e1/videoManifest3.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)" + ] + } + ], + "downloadPaths": [] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-list.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-list.json new file mode 100644 index 000000000000..4a5d0b17ca6b --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-locators-list.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "secureStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/secureStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-03-07T18:49:22.1523049Z", + "startTime": null, + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "afdab5d8-1119-40ce-a952-c6872f1e9825", + "streamingPolicyName": "secureStreamingPolicy", + "defaultContentKeyPolicyName": null, + "contentKeys": [] + } + }, + { + "name": "clearStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/clearStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-03-07T18:49:22.1333042Z", + "startTime": null, + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "c130eb5b-9034-4990-ba4d-1cdba4c14d57", + "streamingPolicyName": "clearStreamingPolicy", + "defaultContentKeyPolicyName": null, + "contentKeys": [] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-clear.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-clear.json new file mode 100644 index 000000000000..4623cd02a1ec --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-clear.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedClearStreamingPolicy", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedClearStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedClearStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-03-07T18:49:21.8092978Z", + "defaultContentKeyPolicyName": null, + "envelopeEncryption": null, + "commonEncryptionCenc": null, + "commonEncryptionCbcs": null, + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-commonEncryptionCbcs-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-commonEncryptionCbcs-only.json new file mode 100644 index 000000000000..479bebc0c6b8 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-commonEncryptionCbcs-only.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCbcsOnly", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + } + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCbcsOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicyWithCommonEncryptionCbcsOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-03-07T18:49:21.9843003Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": null, + "commonEncryptionCenc": null, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + }, + "playReady": null, + "widevine": null + } + }, + "noEncryption": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-commonEncryptionCenc-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-commonEncryptionCenc-only.json new file mode 100644 index 000000000000..a95e8ca8ecd7 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-commonEncryptionCenc-only.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCencOnly", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + } + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCencOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicyWithCommonEncryptionCencOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-03-07T18:49:21.922799Z", + "defaultContentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "envelopeEncryption": null, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + }, + "commonEncryptionCbcs": null, + "noEncryption": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-envelopeEncryption-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-envelopeEncryption-only.json new file mode 100644 index 000000000000..ecacf2b9ad98 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-envelopeEncryption-only.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicyWithEnvelopeEncryptionOnly", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "envelopeEncryption": { + "enabledProtocols": { + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + } + }, + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicyWithEnvelopeEncryptionOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicyWithEnvelopeEncryptionOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-03-07T18:49:21.8642989Z", + "defaultContentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + }, + "commonEncryptionCenc": null, + "commonEncryptionCbcs": null, + "noEncryption": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-secure-streaming.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-secure-streaming.json new file mode 100644 index 000000000000..e4fd7183e756 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-create-secure-streaming.json @@ -0,0 +1,170 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicy", + "api-version": "2018-03-30-preview", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + } + }, + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + }, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + } + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + }, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + } + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-03-07T18:49:22.0443025Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + }, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + }, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + }, + "playReady": null, + "widevine": null + } + }, + "noEncryption": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-delete.json new file mode 100644 index 000000000000..c5ea443b34b1 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "secureStreamingPolicyWithCommonEncryptionCbcsOnly", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-list.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-list.json new file mode 100644 index 000000000000..ecc90cd1fb0c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policies-list.json @@ -0,0 +1,234 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "secureStreamingPolicyWithCommonEncryptionCbcsOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithCommonEncryptionCbcsOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-03-07T18:49:21.5362931Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": null, + "commonEncryptionCenc": null, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + }, + "playReady": null, + "widevine": null + } + }, + "noEncryption": null + } + }, + { + "name": "secureStreamingPolicyWithCommonEncryptionCencOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithCommonEncryptionCencOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-03-07T18:49:21.5342919Z", + "defaultContentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "envelopeEncryption": null, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + }, + "commonEncryptionCbcs": null, + "noEncryption": null + } + }, + { + "name": "secureStreamingPolicyWithEnvelopeEncryptionOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithEnvelopeEncryptionOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-03-07T18:49:21.531793Z", + "defaultContentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + }, + "commonEncryptionCenc": null, + "commonEncryptionCbcs": null, + "noEncryption": null + } + }, + { + "name": "secureStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-03-07T18:49:21.5302928Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + }, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + }, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + }, + "playReady": null, + "widevine": null + } + }, + "noEncryption": null + } + }, + { + "name": "clearStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/clearStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-03-07T18:49:21.5282927Z", + "defaultContentKeyPolicyName": null, + "envelopeEncryption": null, + "commonEncryptionCenc": null, + "commonEncryptionCbcs": null, + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policy-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policy-get-by-name.json new file mode 100644 index 000000000000..66380bf55ac3 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streaming-policy-get-by-name.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "clearStreamingPolicy", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "name": "clearStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/clearStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-03-07T18:49:21.6217953Z", + "defaultContentKeyPolicyName": null, + "envelopeEncryption": null, + "commonEncryptionCenc": null, + "commonEncryptionCbcs": null, + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-create.json new file mode 100644 index 000000000000..93a632a26c56 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-create.json @@ -0,0 +1,157 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2018-03-30-preview", + "parameters": { + "id": null, + "name": "myStreamingEndpoint1", + "location": "West US", + "type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "accessControl": { + "akamai": { + "akamaiSignatureHeaderAuthenticationKeyList": [ + { + "identifier": "id1", + "expiration": "2029-12-31T16:00:00-08:00", + "base64Key": "dGVzdGlkMQ==" + }, + { + "identifier": "id2", + "expiration": "2030-12-31T16:00:00-08:00", + "base64Key": "dGVzdGlkMQ==" + } + ] + }, + "ip": { + "allow": [ + { + "name": "AllowedIp", + "address": "192.168.1.1" + } + ] + } + }, + "cdnEnabled": false + } + } + }, + "responses": { + "202": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "accessControl": { + "akamai": { + "akamaiSignatureHeaderAuthenticationKeyList": [ + { + "identifier": "id1", + "expiration": "2030-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + }, + { + "identifier": "id2", + "expiration": "2031-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + } + ] + }, + "ip": { + "allow": [ + { + "name": "AllowedIp", + "address": "192.168.1.1", + "subnetPrefixLength": null + } + ] + } + }, + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T00:00:00-08:00", + "provisioningState": "InProgress", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.7561389Z", + "lastModified": "2018-03-03T02:25:09.7561389Z" + } + } + }, + "200": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "accessControl": { + "akamai": { + "akamaiSignatureHeaderAuthenticationKeyList": [ + { + "identifier": "id1", + "expiration": "2030-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + }, + { + "identifier": "id2", + "expiration": "2031-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + } + ] + }, + "ip": { + "allow": [ + { + "name": "AllowedIp", + "address": "192.168.1.1", + "subnetPrefixLength": null + } + ] + } + }, + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T00:00:00-08:00", + "provisioningState": "InProgress", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.7561389Z", + "lastModified": "2018-03-03T02:25:09.7561389Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-delete.json new file mode 100644 index 000000000000..e532a6ae1216 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-delete.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2018-03-30-preview", + "parameters": { + "Id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "Name": "myStreamingEndpoint1", + "Type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints", + "Location": "West US", + "Tags": { + "DynamicProperties": { + "tag1": "value1", + "tag2": "value2" + } + }, + "Properties": { + "Description": "test event 1", + "ScaleUnits": 1, + "AccessControl": null, + "AvailabilitySetName": "availableset", + "MaxCacheAge": null, + "CrossSiteAccessPolicies": null, + "CustomHostNames": [], + "HostName": null, + "CdnEnabled": false, + "CdnProvider": null, + "CdnProfile": null, + "FreeTrialEndTime": "0001-01-01T00:00:00-08:00", + "ProvisioningState": null, + "ResourceState": "Stopped", + "Created": "2018-03-02T18:25:09.4897514-08:00", + "LastModified": "2018-03-02T18:25:09.4897514-08:00" + } + } + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-list-all.json new file mode 100644 index 000000000000..f60c33a79cde --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-list-all.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "api-version": "2018-03-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T08:00:00Z", + "provisioningState": "Succeeded", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.202013Z", + "lastModified": "2018-03-03T02:25:09.202013Z" + } + }, + { + "name": "default", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/default", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": {}, + "properties": { + "description": "", + "scaleUnits": 0, + "availabilitySetName": null, + "cdnEnabled": true, + "cdnProvider": "StandardVerizon", + "cdnProfile": "AzureMediaStreamingPlatformCdnProfile-StandardVerizon", + "customHostNames": [], + "maxCacheAge": null, + "hostName": "slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T00:00:00-08:00", + "provisioningState": "InProgress", + "resourceState": "Starting", + "created": "2018-03-03T02:25:09.2310128Z", + "lastModified": "2018-03-03T02:25:09.2310128Z" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-list-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-list-by-name.json new file mode 100644 index 000000000000..a802c913a87f --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-list-by-name.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2018-03-30-preview" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T08:00:00Z", + "provisioningState": "Succeeded", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.3500423Z", + "lastModified": "2018-03-03T02:25:09.3500423Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-scale.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-scale.json new file mode 100644 index 000000000000..e273ce6e4363 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-scale.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2018-03-30-preview", + "parameters": { + "scaleUnit": 5 + } + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-start.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-start.json new file mode 100644 index 000000000000..962923ef6cee --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-start.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2018-03-30-preview" + }, + "responses": { + "202": {}, + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-stop.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-stop.json new file mode 100644 index 000000000000..962923ef6cee --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-stop.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2018-03-30-preview" + }, + "responses": { + "202": {}, + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-update.json new file mode 100644 index 000000000000..c0e8fd319d63 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/streamingendpoint-update.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2018-03-30-preview", + "parameters": { + "id": null, + "name": "myStreamingEndpoint1", + "location": "West US", + "type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints", + "tags": { + "tag3": "value3", + "tag5": "value5" + }, + "properties": { + "description": "test event 2", + "scaleUnits": 5, + "availabilitySetName": "availableset" + } + } + }, + "responses": { + "200": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag3": "value3", + "tag5": "value5" + }, + "properties": { + "description": "test event 2", + "scaleUnits": 5, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": null, + "customHostNames": [], + "maxCacheAge": null, + "hostName": null, + "freeTrialEndTime": "0001-01-01T00:00:00Z", + "provisioningState": "Succeeded", + "resourceState": null, + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z" + } + } + }, + "202": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag3": "value3", + "tag5": "value5" + }, + "properties": { + "description": "test event 2", + "scaleUnits": 5, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": null, + "customHostNames": [], + "maxCacheAge": null, + "hostName": null, + "freeTrialEndTime": "0001-01-01T00:00:00Z", + "provisioningState": "Succeeded", + "resourceState": null, + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-create.json new file mode 100644 index 000000000000..43271891927c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-create.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2018-03-30-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "CreatedTransform", + "parameters": { + "properties": { + "description": "Example transform to illustrate create and update.", + "created": "0001-01-01T00:00:00-05:00", + "lastModified": "0001-01-01T00:00:00-05:00", + "outputs": [ + { + "relativePriority": null, + "onError": null, + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "CreatedTransform", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/CreatedTransform", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-03-20T13:33:30.1276806-04:00", + "description": "Example transform to illustrate create and update.", + "lastModified": "2018-03-20T13:33:30.1276806-04:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + } + }, + "200": { + "body": { + "name": "CreatedTransform", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/CreatedTransform", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-03-20T13:33:30.1276806-04:00", + "description": "Example transform to illustrate create and update.", + "lastModified": "2018-03-20T13:33:30.144677-04:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-delete.json new file mode 100644 index 000000000000..35c7f090b821 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-03-30-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "SampleTransform" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-get-by-name.json new file mode 100644 index 000000000000..348878740740 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-get-by-name.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-03-30-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "SampleTransform" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "SampleTransform", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/SampleTransform", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-03-05T23:52:19.6921412-05:00", + "description": "A sample transform using the standard encoder with a built in preset.", + "lastModified": "2018-03-05T23:52:19.6921412-05:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "H264MultipleBitrate1080p" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-list-all.json new file mode 100644 index 000000000000..5dea1ab618ac --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-list-all.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2018-03-30-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "SampleEncode", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/SampleEncode", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-03-20T13:33:29.4642953-04:00", + "description": "A sample transform using the standard encoder with a built in preset.", + "lastModified": "2018-03-20T13:33:29.4642953-04:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + }, + { + "name": "SampleEncodeAndVideoIndex", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/SampleEncodeAndVideoIndex", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-03-20T13:33:29.4682947-04:00", + "description": "A sample transform using the standard encoder with a built in preset and the video indexer.", + "lastModified": "2018-03-20T13:33:29.4682947-04:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + }, + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.VideoAnalyzerPreset", + "audioLanguage": "en-US", + "audioInsightsOnly": false + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-update.json new file mode 100644 index 000000000000..109314fe7765 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/examples/transforms-update.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2018-03-30-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "TransformToUpdate", + "parameters": { + "properties": { + "description": "Example transform to illustrate update.", + "created": "0001-01-01T00:00:00-05:00", + "lastModified": "0001-01-01T00:00:00-05:00", + "outputs": [ + { + "relativePriority": null, + "onError": null, + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "H264MultipleBitrate720p" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "TransformToUpdate", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/TransformToUpdate", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-03-05T23:52:19.9109582-05:00", + "description": "Example transform to illustrate update.", + "lastModified": "2018-03-05T23:52:19.9149613-05:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "H264MultipleBitrate720p" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/streamingservice.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/streamingservice.json new file mode 100644 index 000000000000..7b8f3c334c1c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/streamingservice.json @@ -0,0 +1,1728 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "Streaming resource management client for Azure Media Services", + "version": "2018-03-30-preview" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents": { + "get": { + "tags": [ + "LiveEvents" + ], + "summary": "List Live Events", + "description": "Lists the Live Events in the account.", + "operationId": "LiveEvents_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEventListResult" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all LiveEvents": { + "$ref": "examples/liveevent-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}": { + "get": { + "tags": [ + "LiveEvents" + ], + "summary": "Get Live Event", + "description": "Gets a Live Event.", + "operationId": "LiveEvents_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "Get a LiveEvent by name": { + "$ref": "examples/liveevent-list-by-name.json" + } + } + }, + "put": { + "tags": [ + "LiveEvents" + ], + "summary": "Create Live Event", + "description": "Creates a Live Event.", + "operationId": "LiveEvents_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StreamingResourceAutoStart" + }, + { + "name": "parameters", + "description": "Live Event properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveEvent" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a LiveEvent": { + "$ref": "examples/liveevent-create.json" + } + } + }, + "patch": { + "tags": [ + "LiveEvents" + ], + "description": "Updates a existing Live Event.", + "operationId": "LiveEvents_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "Live Event properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveEvent" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a LiveEvent": { + "$ref": "examples/liveevent-update.json" + } + } + }, + "delete": { + "tags": [ + "LiveEvents" + ], + "summary": "Delete Live Event", + "description": "Deletes a Live Event.", + "operationId": "LiveEvents_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "204": { + "description": "No content. The request has been accepted but the Live Event was not found." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a LiveEvent": { + "$ref": "examples/liveevent-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/start": { + "post": { + "tags": [ + "LiveEvents" + ], + "summary": "Start Live Event", + "description": "Starts an existing Live Event.", + "operationId": "LiveEvents_Start", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start a LiveEvent": { + "$ref": "examples/liveevent-start.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/stop": { + "post": { + "tags": [ + "LiveEvents" + ], + "summary": "Stop Live Event", + "description": "Stops an existing Live Event.", + "operationId": "LiveEvents_Stop", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "LiveEvent stop parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveEventActionInput" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Stop a LiveEvent": { + "$ref": "examples/liveevent-stop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/reset": { + "post": { + "tags": [ + "LiveEvents" + ], + "summary": "Reset Live Event", + "description": "Resets an existing Live Event.", + "operationId": "LiveEvents_Reset", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset a LiveEvent": { + "$ref": "examples/liveevent-reset.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs": { + "get": { + "tags": [ + "LiveOutputs" + ], + "summary": "List Live Outputs", + "description": "Lists the Live Outputs in the Live Event.", + "operationId": "LiveOutputs_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveOutputListResult" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all LiveOutputs": { + "$ref": "examples/liveoutput-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs/{liveOutputName}": { + "get": { + "tags": [ + "LiveOutputs" + ], + "summary": "Get Live Output", + "description": "Gets a Live Output.", + "operationId": "LiveOutputs_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/LiveOutputName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveOutput" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "Get a LiveOutput by name": { + "$ref": "examples/liveoutput-list-by-name.json" + } + } + }, + "put": { + "tags": [ + "LiveOutputs" + ], + "summary": "Create Live Output", + "description": "Creates a Live Output.", + "operationId": "LiveOutputs_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/LiveOutputName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "Live Output properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveOutput" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveOutput" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/LiveOutput" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a LiveOutput": { + "$ref": "examples/liveoutput-create.json" + } + } + }, + "delete": { + "tags": [ + "LiveOutputs" + ], + "summary": "Delete Live Output", + "description": "Deletes a Live Output.", + "operationId": "LiveOutputs_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/LiveOutputName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "204": { + "description": "No content. The request has been accepted but the Live Output was not found." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a LiveOutput": { + "$ref": "examples/liveoutput-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints": { + "get": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "List StreamingEndpoints", + "description": "Lists the StreamingEndpoints in the account.", + "operationId": "StreamingEndpoints_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpointListResult" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all StreamingEndpoints": { + "$ref": "examples/streamingendpoint-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}": { + "get": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Get StreamingEndpoint", + "description": "Gets a StreamingEndpoint.", + "operationId": "StreamingEndpoints_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "Get a StreamingEndpoint by name": { + "$ref": "examples/streamingendpoint-list-by-name.json" + } + } + }, + "put": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Create StreamingEndpoint", + "description": "Creates a StreamingEndpoint.", + "operationId": "StreamingEndpoints_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StreamingResourceAutoStart" + }, + { + "name": "parameters", + "description": "StreamingEndpoint properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-create.json" + } + } + }, + "patch": { + "tags": [ + "StreamingEndpoint" + ], + "summary": "Update StreamingEndpoint", + "description": "Updates a existing StreamingEndpoint.", + "operationId": "StreamingEndpoints_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "StreamingEndpoint properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-update.json" + } + } + }, + "delete": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Delete StreamingEndpoint", + "description": "Deletes a StreamingEndpoint.", + "operationId": "StreamingEndpoints_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "204": { + "description": "No content. The request has been accepted but the Streaming Endpoint was not found." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/start": { + "post": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Start StreamingEndpoint", + "description": "Starts an existing StreamingEndpoint.", + "operationId": "StreamingEndpoints_Start", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-start.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/stop": { + "post": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Stop StreamingEndpoint", + "description": "Stops an existing StreamingEndpoint.", + "operationId": "StreamingEndpoints_Stop", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Stop a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-stop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/scale": { + "post": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Scale StreamingEndpoint", + "description": "Scales an existing StreamingEndpoint.", + "operationId": "StreamingEndpoints_Scale", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "StreamingEndpoint scale parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingEntityScaleUnit" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Encoding.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Scale a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-scale.json" + } + } + } + } + }, + "definitions": { + "Hls": { + "properties": { + "fragmentsPerTsSegment": { + "format": "int32", + "type": "integer", + "description": "The amount of fragments per HTTP Live Streaming (HLS) segment." + } + }, + "description": "The HLS configuration." + }, + "LiveOutputProperties": { + "required": ["assetName","archiveWindowLength"], + "properties": { + "description": { + "type": "string", + "description": "The description of the Live Output." + }, + "assetName": { + "type": "string", + "description": "The asset name." + }, + "archiveWindowLength": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content." + }, + "manifestName": { + "type": "string", + "description": "The manifest file name." + }, + "hls": { + "type": "object", + "$ref": "#/definitions/Hls", + "description": "The HLS configuration." + }, + "outputSnapTime": { + "type": "integer", + "format": "int64", + "description": "The output snapshot time." + }, + "created": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the Live Output was created." + }, + "lastModified": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the Live Output was last modified." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the Live Output." + }, + "resourceState": { + "description": "The resource state of the Live Output.", + "readOnly": true, + "type": "string", + "enum": [ + "Creating", + "Running", + "Deleting" + ], + "x-ms-enum": { + "name": "LiveOutputResourceState", + "modelAsString": false + } + } + }, + "description": "The JSON object that contains the properties required to create a Live Output." + }, + "LiveOutput": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LiveOutputProperties", + "description": "The Live Output properties." + } + }, + "allOf": [ + { + "$ref": "./Common.json#/definitions/ProxyResource" + } + ], + "description": "The Live Output." + }, + "LiveOutputListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveOutput" + }, + "description": "The result of the List Live Output operation." + }, + "@odata.count": { + "type": "integer", + "format": "int32", + "description": "The number of result." + }, + "@odata.nextLink": { + "type": "string", + "description": "Th link to the next set of results. Not empty if value contains incomplete list of Live Outputs." + } + }, + "description": "The LiveOutput list result.", + "title": "LiveOutputListResult" + }, + "LiveEventEndpoint": { + "properties": { + "protocol": { + "type": "string", + "description": "The endpoint protocol." + }, + "url": { + "type": "string", + "description": "The endpoint URL." + } + }, + "description": "The Live Event endpoint." + }, + "LiveEventInput": { + "required": ["streamingProtocol"], + "properties": { + "streamingProtocol": { + "type": "string", + "description": "The streaming protocol for the Live Event.", + "enum": [ + "FragmentedMP4", + "RTMP" + ], + "x-ms-enum": { + "name": "LiveEventInputProtocol", + "modelAsString": false + } + }, + "keyFrameIntervalDuration": { + "type": "string", + "description": "ISO 8601 timespan duration of the key frame interval duration." + }, + "accessToken": { + "type": "string", + "description": "The access token." + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveEventEndpoint" + }, + "description": "The input endpoints for the Live Event." + } + }, + "description": "The Live Event input." + }, + "IPRange": { + "properties": { + "name": { + "type": "string", + "description": "The friendly name for the IP address range." + }, + "address": { + "type": "string", + "description": "The IP address." + }, + "subnetPrefixLength": { + "format": "int32", + "type": "integer", + "description": "The subnet mask prefix length (see CIDR notation)." + } + }, + "description": "The IP address range in the CIDR scheme." + }, + "IPAccessControl": { + "properties": { + "allow": { + "type": "array", + "items": { + "$ref": "#/definitions/IPRange" + }, + "description": "The IP allow list." + } + }, + "description": "The IP access control." + }, + "LiveEventPreviewAccessControl": { + "properties": { + "ip": { + "type": "object", + "$ref": "#/definitions/IPAccessControl", + "description": "The IP access control properties." + } + }, + "description": "The IP access control for Live Event preview." + }, + "LiveEventPreview": { + "properties": { + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveEventEndpoint" + }, + "description": "The endpoints for preview." + }, + "accessControl": { + "type": "object", + "$ref": "#/definitions/LiveEventPreviewAccessControl", + "description": "The access control for LiveEvent preview." + }, + "previewLocator": { + "type": "string", + "description": "The preview locator Guid." + }, + "streamingPolicyName": { + "type": "string", + "description": "The name of streaming policy used for LiveEvent preview" + } + }, + "description": "The Live Event preview." + }, + "LiveEventEncoding": { + "properties": { + "encodingType": { + "type": "string", + "description": "The encoding type for Live Event.", + "enum": [ + "None", + "Basic" + ], + "x-ms-enum": { + "name": "LiveEventEncodingType", + "modelAsString": false + } + }, + "presetName": { + "type": "string", + "description": "The encoding preset name." + } + }, + "description": "The Live Event encoding." + }, + "CrossSiteAccessPolicies": { + "properties": { + "clientAccessPolicy": { + "type": "string", + "description": "The content of clientaccesspolicy.xml used by Silverlight." + }, + "crossDomainPolicy": { + "type": "string", + "description": "The content of crossdomain.xml used by Silverlight." + } + }, + "description": "The client access policy." + }, + "LiveEventActionInput": { + "properties": { + "removeOutputsOnStop": { + "type": "boolean", + "description": "The flag indicates if remove LiveOutputs on Stop." + } + }, + "description": "The LiveEvent action input parameter definition." + }, + "LiveEventProperties": { + "required": ["input"], + "properties": { + "description": { + "type": "string", + "description": "The Live Event description." + }, + "input": { + "type": "object", + "$ref": "#/definitions/LiveEventInput", + "description": "The Live Event input." + }, + "preview": { + "type": "object", + "$ref": "#/definitions/LiveEventPreview", + "description": "The Live Event preview." + }, + "encoding": { + "type": "object", + "$ref": "#/definitions/LiveEventEncoding", + "description": "The Live Event encoding." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the Live Event." + }, + "resourceState": { + "readOnly": true, + "type": "string", + "description": "The resource state of the Live Event.", + "enum": [ + "Stopped", + "Starting", + "Running", + "Stopping", + "Deleting" + ], + "x-ms-enum": { + "name": "LiveEventResourceState", + "modelAsString": false + } + }, + "crossSiteAccessPolicies": { + "type": "object", + "$ref": "#/definitions/CrossSiteAccessPolicies", + "description": "The Live Event access policies." + }, + "vanityUrl": { + "type": "boolean", + "description": "The Live Event vanity URL flag." + }, + "streamOptions": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Default", + "LowLatency" + ], + "x-ms-enum": { + "name": "StreamOptionsFlag", + "modelAsString": false + } + }, + "description": "The stream options." + }, + "created": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the Live Event was created." + }, + "lastModified": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the Live Event was last modified." + } + }, + "description": "The Live Event properties." + }, + "LiveEvent": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LiveEventProperties", + "description": "The Live Event properties." + } + }, + "allOf": [ + { + "$ref": "./Common.json#/definitions/TrackedResource" + } + ], + "description": "The Live Event." + }, + "LiveEventListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveEvent" + }, + "description": "The result of the List Live Event operation." + }, + "@odata.count": { + "type": "integer", + "format": "int32", + "description": "The number of result." + }, + "@odata.nextLink": { + "type": "string", + "description": "Th link to the next set of results. Not empty if value contains incomplete list of Live Outputs." + } + }, + "description": "The LiveEvent list result.", + "title": "LiveEventListResult" + }, + "AkamaiSignatureHeaderAuthenticationKey": { + "properties": { + "identifier": { + "type": "string", + "description": "identifier of the key" + }, + "base64Key": { + "type": "string", + "description": "authentication key" + }, + "expiration": { + "format": "date-time", + "type": "string", + "description": "The exact time the authentication key." + } + }, + "description": "Akamai Signature Header authentication key." + }, + "AkamaiAccessControl": { + "properties": { + "akamaiSignatureHeaderAuthenticationKeyList": { + "type": "array", + "items": { + "$ref": "#/definitions/AkamaiSignatureHeaderAuthenticationKey" + }, + "description": "authentication key list" + } + }, + "description": "Akamai access control" + }, + "StreamingEndpointAccessControl": { + "properties": { + "akamai": { + "type": "object", + "$ref": "#/definitions/AkamaiAccessControl", + "description": "The access control of Akamai" + }, + "ip": { + "type": "object", + "$ref": "#/definitions/IPAccessControl", + "description": "The IP access control of the StreamingEndpoint." + } + }, + "description": "StreamingEndpoint access control definition." + }, + "StreamingEntityScaleUnit": { + "properties": { + "scaleUnit": { + "type": "integer", + "format": "int32", + "description": "The scale unit number of the StreamingEndpoint.", + "title": "ScaleUnit" + } + }, + "description": "scale units definition" + }, + "StreamingEndpointProperties": { + "properties": { + "description": { + "type": "string", + "description": "The StreamingEndpoint description." + }, + "scaleUnits": { + "type": "integer", + "format": "int32", + "description": "The number of scale units.", + "x-nullable": false + }, + "availabilitySetName": { + "type": "string", + "description": "AvailabilitySet name" + }, + "accessControl": { + "type": "object", + "$ref": "#/definitions/StreamingEndpointAccessControl", + "description": "The access control definition of the StreamingEndpoint." + }, + "maxCacheAge": { + "type": "integer", + "format": "int64", + "description": "Max cache age" + }, + "customHostNames": { + "type": "array", + "items": { + "type": "string", + "description": "custom host name" + }, + "description": "The custom host names of the StreamingEndpoint" + }, + "hostName": { + "readOnly": true, + "type": "string", + "description": "The StreamingEndpoint host name." + }, + "cdnEnabled": { + "type": "boolean", + "description": "The CDN enabled flag." + }, + "cdnProvider": { + "type": "string", + "description": "The CDN provider name." + }, + "cdnProfile": { + "type": "string", + "description": "The CDN profile name." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the StreamingEndpoint." + }, + "resourceState": { + "readOnly": true, + "type": "string", + "description": "The resource state of the StreamingEndpoint.", + "enum": [ + "Stopped", + "Starting", + "Running", + "Stopping", + "Deleting", + "Scaling" + ], + "x-ms-enum": { + "name": "StreamingEndpointResourceState", + "modelAsString": false + } + }, + "crossSiteAccessPolicies": { + "type": "object", + "$ref": "#/definitions/CrossSiteAccessPolicies", + "description": "The StreamingEndpoint access policies." + }, + "freeTrialEndTime": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The free trial expiration time." + }, + "created": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the StreamingEndpoint was created." + }, + "lastModified": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the StreamingEndpoint was last modified." + } + }, + "description": "The StreamingEndpoint properties." + }, + "StreamingEndpoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StreamingEndpointProperties", + "description": "The StreamingEndpoint properties." + } + }, + "allOf": [ + { + "$ref": "./Common.json#/definitions/TrackedResource" + } + ], + "description": "The StreamingEndpoint." + }, + "StreamingEndpointListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingEndpoint" + }, + "description": "The result of the List StreamingEndpoint operation." + }, + "@odata.count": { + "type": "integer", + "format": "int32", + "description": "The number of result." + }, + "@odata.nextLink": { + "type": "string", + "description": "Th link to the next set of results. Not empty if value contains incomplete list of StreamingEndpoints." + } + }, + "description": "The StreamingEndpoint list result.", + "title": "StreamingEndpointListResult" + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "description": "The unique identifier for a Microsoft Azure subscription.", + "in": "path", + "required": true, + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "description": "The Version of the API to be used with the client request.", + "in": "query", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "description": "The name of the resource group within the Azure subscription.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "description": "The Media Services account name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "LiveEventName": { + "name": "liveEventName", + "description": "The name of the Live Event.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 32, + "x-ms-parameter-location": "method" + }, + "StreamingResourceAutoStart": { + "name": "autoStart", + "description": "The flag indicates if auto start the Live Event.", + "in": "query", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "LiveOutputName": { + "name": "liveOutputName", + "description": "The name of the Live Output.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^([a-zA-Z0-9])+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 256, + "x-ms-parameter-location": "method" + }, + "StreamingEndpointName": { + "name": "streamingEndpointName", + "description": "The name of the StreamingEndpoint.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 24, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Accounts.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Accounts.json new file mode 100644 index 000000000000..0571041d0296 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Accounts.json @@ -0,0 +1,780 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "Provider": { + "description": "A resource provider.", + "properties": { + "providerName": { + "description": "The provider name.", + "type": "string" + } + }, + "type": "object", + "required": [ + "providerName" + ] + }, + "OperationDisplay": { + "properties": { + "provider": { + "type": "string", + "description": "The service provider." + }, + "resource": { + "type": "string", + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "description": "The operation type." + }, + "description": { + "type": "string", + "description": "The operation description." + } + }, + "type": "object", + "description": "Operation details." + }, + "Operation": { + "description": "An operation.", + "properties": { + "name": { + "type": "string", + "description": "The operation name." + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The operation display name." + } + }, + "type": "object", + "required": [ + "name" + ] + }, + "Location": { + "properties": { + "name": { + "type": "string" + } + }, + "type": "object", + "required": [ + "name" + ] + }, + "EntityNameAvailabilityCheckOutput": { + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Specifies if the name is available." + }, + "reason": { + "type": "string", + "description": "Specifies the reason if the name is not available." + }, + "message": { + "type": "string", + "description": "Specifies the detailed reason if the name is not available." + } + }, + "type": "object", + "required": [ + "nameAvailable" + ], + "description": "The response from the check name availability request." + }, + "StorageAccount": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts." + }, + "type": { + "type": "string", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "values": [ + { + "value": "Primary", + "description": "The primary storage account for the Media Services account." + }, + { + "value": "Secondary", + "description": "A secondary storage account for the Media Services account." + } + ], + "modelAsExtensible": true + }, + "description": "The type of the storage account." + } + }, + "type": "object", + "required": [ + "type" + ], + "description": "The storage account details." + }, + "SyncStorageKeysInput": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the storage account resource." + } + }, + "type": "object", + "description": "The input to the sync storage keys request." + }, + "MediaServiceProperties": { + "properties": { + "mediaServiceId": { + "type": "string", + "format": "uuid", + "description": "The Media Services account ID.", + "readOnly": true, + "x-nullable": false + }, + "storageAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "The storage accounts for this resource." + } + }, + "type": "object", + "description": "Properties of the Media Services account." + }, + "MediaService": { + "description": "A Media Services account.", + "allOf": [ + { + "$ref": "./Common.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MediaServiceProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "SubscriptionMediaService": { + "description": "A Media Services account.", + "allOf": [ + { + "$ref": "./Common.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MediaServiceProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "ODataError": { + "properties": { + "code": { + "type": "string", + "description": "A language-independent error name." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "target": { + "type": "string", + "description": "The target of the error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + }, + "description": "The error details." + } + }, + "type": "object", + "description": "Information about an error." + }, + "ApiError": { + "properties": { + "error": { + "$ref": "#/definitions/ODataError", + "description": "The error properties." + } + }, + "type": "object", + "description": "The API error." + }, + "OperationCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "A collection of Operation items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Operation items." + }, + "MediaServiceCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MediaService" + }, + "description": "A collection of MediaService items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of MediaService items." + }, + "CheckNameAvailabilityInput": { + "description": "The input to the check name availability request.", + "properties": { + "name": { + "description": "The account name.", + "type": "string" + }, + "type": { + "description": "The account type. For a Media Services account, this should be 'MediaServices'.", + "type": "string" + } + }, + "type": "object" + }, + "SubscriptionMediaServiceCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionMediaService" + }, + "description": "A collection of SubscriptionMediaService items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of SubscriptionMediaService items." + } + }, + "paths": { + "/providers/Microsoft.Media/operations": { + "get": { + "summary": "List Operations", + "description": "Lists all the Media Services operations.", + "operationId": "Operations_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List Operations": { + "$ref": "examples/operations-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices": { + "get": { + "summary": "List Media Services accounts", + "description": "List Media Services accounts in the resource group", + "operationId": "Mediaservices_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaServiceCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all Media Services accounts": { + "$ref": "examples/accounts-list-all-accounts.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}": { + "get": { + "summary": "Get a Media Services account", + "description": "Get the details of a Media Services account", + "operationId": "Mediaservices_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Media Services account by name": { + "$ref": "examples/accounts-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update a Media Services account", + "description": "Creates or updates a Media Services account", + "operationId": "Mediaservices_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MediaService" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create a Media Services account": { + "$ref": "examples/accounts-create.json" + } + } + }, + "delete": { + "summary": "Delete a Media Services account.", + "description": "Deletes a Media Services account", + "operationId": "Mediaservices_Delete", + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Media Services account": { + "$ref": "examples/accounts-delete.json" + } + } + }, + "patch": { + "summary": "Update a Media Services account", + "description": "Updates an existing Media Services account", + "operationId": "Mediaservices_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MediaService" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update a Media Services accounts": { + "$ref": "examples/accounts-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/syncStorageKeys": { + "post": { + "summary": "Synchronizes Storage Account Keys", + "description": "Synchronizes storage account keys for a storage account associated with the Media Service account.", + "operationId": "Mediaservices_SyncStorageKeys", + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SyncStorageKeysInput" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Synchronizes Storage Account Keys": { + "$ref": "examples/accounts-sync-storage-keys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Media/locations/{locationName}/checkNameAvailability": { + "post": { + "summary": "Check Name Availability", + "description": "Checks whether the Media Service resource name is available.", + "operationId": "Locations_CheckNameAvailability", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityNameAvailabilityCheckOutput" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Check Name Availability": { + "$ref": "examples/accounts-check-name-availability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Media/mediaservices": { + "get": { + "summary": "List Media Services accounts", + "description": "List Media Services accounts in the subscription.", + "operationId": "Mediaservices_ListBySubscription", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionMediaServiceCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all Media Services accounts": { + "$ref": "examples/accounts-subscription-list-all-accounts.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Media/mediaservices/{accountName}": { + "get": { + "summary": "Get a Media Services account", + "description": "Get the details of a Media Services account", + "operationId": "Mediaservices_GetBySubscription", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionMediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "description": "The Media Services account name.", + "name": "accountName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Media Services account by name": { + "$ref": "examples/accounts-subscription-get-by-name.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Assets.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Assets.json new file mode 100644 index 000000000000..bf61c2602048 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Assets.json @@ -0,0 +1,644 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "AssetProperties": { + "properties": { + "assetId": { + "type": "string", + "format": "uuid", + "description": "The Asset ID.", + "readOnly": true, + "x-nullable": false + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The creation date of the Asset.", + "readOnly": true, + "x-nullable": false + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The last modified date of the Asset.", + "readOnly": true, + "x-nullable": false + }, + "alternateId": { + "type": "string", + "description": "The alternate ID of the Asset." + }, + "description": { + "type": "string", + "description": "The Asset description." + }, + "container": { + "type": "string", + "description": "The name of the asset blob container." + }, + "storageAccountName": { + "type": "string", + "description": "The name of the storage account." + }, + "storageEncryptionFormat": { + "type": "string", + "enum": [ + "None", + "MediaStorageClientEncryption" + ], + "x-ms-enum": { + "name": "AssetStorageEncryptionFormat", + "values": [ + { + "value": "None", + "description": "The Asset does not use client-side storage encryption (this is the only allowed value for new Assets)." + }, + { + "value": "MediaStorageClientEncryption", + "description": "The Asset is encrypted with Media Services client-side encryption." + } + ], + "modelAsExtensible": true + }, + "description": "The Asset encryption format. One of None or MediaStorageEncryption.", + "readOnly": true, + "x-nullable": false + } + }, + "type": "object", + "description": "The Asset properties." + }, + "AssetContainerSas": { + "properties": { + "assetContainerSasUrls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Asset container SAS URLs." + } + }, + "type": "object", + "description": "The Asset Storage container SAS URLs." + }, + "AssetStorageEncryptionKey": { + "properties": { + "storageEncryptionKey": { + "type": "string", + "description": "The Asset storage encryption key." + } + }, + "type": "object", + "description": "The Asset Storage encryption key." + }, + "Asset": { + "description": "An Asset.", + "allOf": [ + { + "$ref": "./Common.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AssetProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "ODataError": { + "properties": { + "code": { + "type": "string", + "description": "A language-independent error name." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "target": { + "type": "string", + "description": "The target of the error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + }, + "description": "The error details." + } + }, + "type": "object", + "description": "Information about an error." + }, + "ApiError": { + "properties": { + "error": { + "$ref": "#/definitions/ODataError", + "description": "The error properties." + } + }, + "type": "object", + "description": "The API error." + }, + "AssetCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Asset" + }, + "description": "A collection of Asset items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Asset items." + }, + "ListContainerSasInput": { + "description": "The parameters to the list SAS requet.", + "properties": { + "permissions": { + "description": "The permissions to set on the SAS URL.", + "type": "string", + "enum": [ + "Read", + "ReadWrite", + "ReadWriteDelete" + ], + "x-ms-enum": { + "name": "AssetContainerPermission", + "values": [ + { + "value": "Read", + "description": "The SAS URL will allow read access to the container." + }, + { + "value": "ReadWrite", + "description": "The SAS URL will allow read and write access to the container." + }, + { + "value": "ReadWriteDelete", + "description": "The SAS URL will allow read, write and delete access to the container." + } + ], + "modelAsExtensible": true + } + }, + "expiryTime": { + "description": "The SAS URL expiration time. This must be less than 24 hours from the current time.", + "type": "string", + "format": "date-time" + } + }, + "type": "object" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets": { + "get": { + "summary": "List Assets", + "description": "List Assets in the Media Services account with optional filtering and ordering", + "operationId": "Assets_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/Asset", + "x-ms-examples": { + "List all Assets": { + "$ref": "examples/assets-list-all.json" + }, + "List Asset ordered by date": { + "$ref": "examples/assets-list-by-date.json" + }, + "List Asset created in a date range": { + "$ref": "examples/assets-list-in-date-range.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}": { + "get": { + "summary": "Get an Asset", + "description": "Get the details of an Asset in the Media Services account", + "operationId": "Assets_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get an Asset by name": { + "$ref": "examples/assets-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update an Asset", + "description": "Creates or updates an Asset in the Media Services account", + "operationId": "Assets_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Asset" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create an Asset": { + "$ref": "examples/assets-create.json" + } + } + }, + "delete": { + "summary": "Delete an Asset.", + "description": "Deletes an Asset in the Media Services account", + "operationId": "Assets_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete an Asset": { + "$ref": "examples/assets-delete.json" + } + } + }, + "patch": { + "summary": "Update an Asset", + "description": "Updates an existing Asset in the Media Services account", + "operationId": "Assets_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Asset" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update an Asset": { + "$ref": "examples/assets-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/listContainerSas": { + "post": { + "summary": "List the Asset URLs", + "description": "Lists storage container URLs with shared access signatures (SAS) for uploading and downloading Asset content. The signatures are derived from the storage account keys.", + "operationId": "Assets_ListContainerSas", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetContainerSas" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ListContainerSasInput" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Asset SAS URLs": { + "$ref": "examples/assets-list-sas-urls.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/getEncryptionKey": { + "post": { + "summary": "Gets the Asset storage key", + "description": "Gets the Asset storage encryption keys used to decrypt content created by version 2 of the Media Services API", + "operationId": "Assets_GetEncryptionKey", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetStorageEncryptionKey" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get Asset Storage Encryption Keys": { + "$ref": "examples/assets-get-encryption-keys.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Common.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Common.json new file mode 100644 index 000000000000..b5f79e9a09f1 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Common.json @@ -0,0 +1,80 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "version": "2018-06-01-preview" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "Resource": { + "description": "The core properties of ARM resources.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource ID for the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked resource.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region of the resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/ContentKeyPolicies.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/ContentKeyPolicies.json new file mode 100644 index 000000000000..92c70482a054 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/ContentKeyPolicies.json @@ -0,0 +1,1168 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction": { + "properties": { + "bestEffort": { + "type": "boolean", + "description": "Indicates whether this restriction is enforced on a Best Effort basis." + }, + "configurationData": { + "type": "integer", + "format": "int32", + "description": "Configures the restriction control bits. Must be between 0 and 3 inclusive." + } + }, + "type": "object", + "required": [ + "bestEffort", + "configurationData" + ], + "description": "Configures the Explicit Analog Television Output Restriction control bits. For further details see the PlayReady Compliance Rules." + }, + "ContentKeyPolicyPlayReadyContentKeyLocation": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for content key ID location. A derived class must be used to represent the location." + }, + "ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation" + } + ], + "properties": {}, + "type": "object", + "description": "Specifies that the content key ID is in the PlayReady header." + }, + "ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation" + } + ], + "properties": { + "keyId": { + "type": "string", + "format": "uuid", + "description": "The content key ID." + } + }, + "type": "object", + "required": [ + "keyId" + ], + "description": "Specifies that the content key ID is specified in the PlayReady configuration." + }, + "ContentKeyPolicyPlayReadyPlayRight": { + "properties": { + "firstPlayExpiration": { + "type": "string", + "format": "duration", + "description": "The amount of time that the license is valid after the license is first used to play content." + }, + "scmsRestriction": { + "type": "integer", + "format": "int32", + "description": "Configures the Serial Copy Management System (SCMS) in the license. Must be between 0 and 3 inclusive." + }, + "agcAndColorStripeRestriction": { + "type": "integer", + "format": "int32", + "description": "Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive." + }, + "explicitAnalogTelevisionOutputRestriction": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction", + "description": "Configures the Explicit Analog Television Output Restriction in the license. Configuration data must be between 0 and 3 inclusive." + }, + "digitalVideoOnlyContentRestriction": { + "type": "boolean", + "description": "Enables the Image Constraint For Analog Component Video Restriction in the license." + }, + "imageConstraintForAnalogComponentVideoRestriction": { + "type": "boolean", + "description": "Enables the Image Constraint For Analog Component Video Restriction in the license." + }, + "imageConstraintForAnalogComputerMonitorRestriction": { + "type": "boolean", + "description": "Enables the Image Constraint For Analog Component Video Restriction in the license." + }, + "allowPassingVideoContentToUnknownOutput": { + "type": "string", + "enum": [ + "Unknown", + "NotAllowed", + "Allowed", + "AllowedWithVideoConstriction" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyPlayReadyUnknownOutputPassingOption", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyPlayReadyUnknownOutputPassingOption that is unavailable in current API version." + }, + { + "value": "NotAllowed", + "description": "Passing the video portion of protected content to an Unknown Output is not allowed." + }, + { + "value": "Allowed", + "description": "Passing the video portion of protected content to an Unknown Output is allowed." + }, + { + "value": "AllowedWithVideoConstriction", + "description": "Passing the video portion of protected content to an Unknown Output is allowed but with constrained resolution." + } + ], + "modelAsExtensible": true + }, + "description": "Configures Unknown output handling settings of the license." + }, + "uncompressedDigitalVideoOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for uncompressed digital video." + }, + "compressedDigitalVideoOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for compressed digital video." + }, + "analogVideoOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for compressed digital audio." + }, + "compressedDigitalAudioOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for compressed digital audio." + }, + "uncompressedDigitalAudioOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for uncompressed digital audio." + } + }, + "type": "object", + "required": [ + "digitalVideoOnlyContentRestriction", + "imageConstraintForAnalogComponentVideoRestriction", + "imageConstraintForAnalogComputerMonitorRestriction", + "allowPassingVideoContentToUnknownOutput" + ], + "description": "Configures the Play Right in the PlayReady license." + }, + "ContentKeyPolicyTokenClaim": { + "properties": { + "claimType": { + "type": "string", + "description": "Token claim type." + }, + "claimValue": { + "type": "string", + "description": "Token claim value." + } + }, + "type": "object", + "description": "Represents a token claim." + }, + "ContentKeyPolicyPlayReadyLicense": { + "properties": { + "allowTestDevices": { + "type": "boolean", + "description": "A flag indicating whether test devices can use the license." + }, + "beginDate": { + "type": "string", + "format": "date-time", + "description": "The begin date of license" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The expiration date of license." + }, + "relativeBeginDate": { + "type": "string", + "format": "duration", + "description": "The relative begin date of license." + }, + "relativeExpirationDate": { + "type": "string", + "format": "duration", + "description": "The relative expiration date of license." + }, + "gracePeriod": { + "type": "string", + "format": "duration", + "description": "The grace period of license." + }, + "playRight": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyPlayRight", + "description": "The license PlayRight" + }, + "licenseType": { + "type": "string", + "enum": [ + "Unknown", + "NonPersistent", + "Persistent" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyPlayReadyLicenseType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyPlayReadyLicenseType that is unavailable in current API version." + }, + { + "value": "NonPersistent", + "description": "Non persistent license." + }, + { + "value": "Persistent", + "description": "Persistent license. Allows offline playback." + } + ], + "modelAsExtensible": true + }, + "description": "The license type." + }, + "contentKeyLocation": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation", + "description": "The content key location." + }, + "contentType": { + "type": "string", + "enum": [ + "Unknown", + "Unspecified", + "UltraVioletDownload", + "UltraVioletStreaming" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyPlayReadyContentType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyPlayReadyContentType that is unavailable in current API version." + }, + { + "value": "Unspecified", + "description": "Unspecified content type." + }, + { + "value": "UltraVioletDownload", + "description": "Ultraviolet download content type." + }, + { + "value": "UltraVioletStreaming", + "description": "Ultraviolet streaming content type." + } + ], + "modelAsExtensible": true + }, + "description": "The PlayReady content type." + } + }, + "type": "object", + "required": [ + "allowTestDevices", + "licenseType", + "contentKeyLocation", + "contentType" + ], + "description": "The PlayReady license" + }, + "ContentKeyPolicyRestriction": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for Content Key Policy restrictions. A derived class must be used to create a restriction." + }, + "ContentKeyPolicyOpenRestriction": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyOpenRestriction", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestriction" + } + ], + "properties": {}, + "type": "object", + "description": "Represents an open restriction. License or key will be delivered on every request." + }, + "ContentKeyPolicyUnknownRestriction": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyUnknownRestriction", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestriction" + } + ], + "properties": {}, + "type": "object", + "description": "Represents a ContentKeyPolicyRestriction that is unavailable in the current API version." + }, + "ContentKeyPolicyConfiguration": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for Content Key Policy configuration. A derived class must be used to create a configuration." + }, + "ContentKeyPolicyRestrictionTokenKey": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for Content Key Policy key for token validation. A derived class must be used to create a token key." + }, + "ContentKeyPolicySymmetricTokenKey": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + } + ], + "properties": { + "keyValue": { + "type": "string", + "format": "byte", + "description": "The key value of the key" + } + }, + "type": "object", + "required": [ + "keyValue" + ], + "description": "Specifies a symmetric key for token validation." + }, + "ContentKeyPolicyRsaTokenKey": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + } + ], + "properties": { + "exponent": { + "type": "string", + "format": "byte", + "description": "The RSA Parameter exponent" + }, + "modulus": { + "type": "string", + "format": "byte", + "description": "The RSA Parameter modulus" + } + }, + "type": "object", + "required": [ + "exponent", + "modulus" + ], + "description": "Specifies a RSA key for token validation" + }, + "ContentKeyPolicyX509CertificateTokenKey": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKey", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + } + ], + "properties": { + "rawBody": { + "type": "string", + "format": "byte", + "description": "The raw data field of a certificate in PKCS 12 format (X509Certificate2 in .NET)" + } + }, + "type": "object", + "required": [ + "rawBody" + ], + "description": "Specifies a certificate for token validation." + }, + "ContentKeyPolicyTokenRestriction": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestriction" + } + ], + "properties": { + "issuer": { + "type": "string", + "description": "The token issuer." + }, + "audience": { + "type": "string", + "description": "The audience for the token." + }, + "primaryVerificationKey": { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey", + "description": "The primary verification key." + }, + "alternateVerificationKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + }, + "description": "A list of alternative verification keys." + }, + "requiredClaims": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyTokenClaim" + }, + "description": "A list of required token claims." + }, + "restrictionTokenType": { + "type": "string", + "enum": [ + "Unknown", + "Swt", + "Jwt" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyRestrictionTokenType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyRestrictionTokenType that is unavailable in current API version." + }, + { + "value": "Swt", + "description": "Simple Web Token." + }, + { + "value": "Jwt", + "description": "JSON Web Token." + } + ], + "modelAsExtensible": true + }, + "description": "The type of token." + }, + "openIdConnectDiscoveryDocument": { + "type": "string", + "description": "The OpenID connect discovery document." + } + }, + "type": "object", + "required": [ + "issuer", + "audience", + "primaryVerificationKey", + "restrictionTokenType" + ], + "description": "Represents a token restriction. Provided token must match these requirements for successful license or key delivery." + }, + "ContentKeyPolicyClearKeyConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": {}, + "type": "object", + "description": "Represents a configuration for non-DRM keys." + }, + "ContentKeyPolicyUnknownConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyUnknownConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": {}, + "type": "object", + "description": "Represents a ContentKeyPolicyConfiguration that is unavailable in the current API version." + }, + "ContentKeyPolicyWidevineConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": { + "widevineTemplate": { + "type": "string", + "description": "The Widevine template." + } + }, + "type": "object", + "required": [ + "widevineTemplate" + ], + "description": "Specifies a configuration for Widevine licenses." + }, + "ContentKeyPolicyPlayReadyConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": { + "licenses": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyLicense" + }, + "description": "The PlayReady licenses." + }, + "responseCustomData": { + "type": "string", + "description": "The custom response data." + } + }, + "type": "object", + "required": [ + "licenses" + ], + "description": "Specifies a configuration for PlayReady licenses." + }, + "ContentKeyPolicyFairPlayConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyFairPlayConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": { + "ask": { + "type": "string", + "format": "byte", + "description": "The key that must be used as FairPlay ASk." + }, + "fairPlayPfxPassword": { + "type": "string", + "description": "The password encrypting FairPlay certificate in PKCS 12 (pfx) format." + }, + "fairPlayPfx": { + "type": "string", + "description": "The Base64 representation of FairPlay certificate in PKCS 12 (pfx) format (including private key)." + }, + "rentalAndLeaseKeyType": { + "type": "string", + "enum": [ + "Unknown", + "Undefined", + "PersistentUnlimited", + "PersistentLimited" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyFairPlayRentalAndLeaseKeyType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyFairPlayRentalAndLeaseKeyType that is unavailable in current API version." + }, + { + "value": "Undefined", + "description": "Key duration is not specified." + }, + { + "value": "PersistentUnlimited", + "description": "Content key can be persisted with an unlimited duration" + }, + { + "value": "PersistentLimited", + "description": "Content key can be persisted and the valid duration is limited by the Rental Duration value" + } + ], + "modelAsExtensible": true + }, + "description": "The rental and lease key type." + }, + "rentalDuration": { + "type": "integer", + "format": "int64", + "description": "The rental duration. Must be greater than or equal to 0." + } + }, + "type": "object", + "required": [ + "ask", + "fairPlayPfxPassword", + "fairPlayPfx", + "rentalAndLeaseKeyType", + "rentalDuration" + ], + "description": "Specifies a configuration for FairPlay licenses." + }, + "ContentKeyPolicyOption": { + "properties": { + "policyOptionId": { + "type": "string", + "format": "uuid", + "description": "The legacy Policy Option ID.", + "readOnly": true, + "x-nullable": false + }, + "name": { + "type": "string", + "description": "The Policy Option description." + }, + "configuration": { + "$ref": "#/definitions/ContentKeyPolicyConfiguration", + "description": "The key delivery configuration." + }, + "restriction": { + "$ref": "#/definitions/ContentKeyPolicyRestriction", + "description": "The requirements that must be met to deliver keys with this configuration" + } + }, + "type": "object", + "required": [ + "configuration", + "restriction" + ], + "description": "Represents a policy option." + }, + "ContentKeyPolicyProperties": { + "properties": { + "policyId": { + "type": "string", + "format": "uuid", + "description": "The legacy Policy ID.", + "readOnly": true, + "x-nullable": false + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The creation date of the Policy", + "readOnly": true, + "x-nullable": false + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The last modified date of the Policy", + "readOnly": true, + "x-nullable": false + }, + "description": { + "type": "string", + "description": "A description for the Policy." + }, + "options": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyOption" + }, + "description": "The Key Policy options." + } + }, + "type": "object", + "required": [ + "options" + ], + "description": "The properties of the Content Key Policy." + }, + "ContentKeyPolicy": { + "allOf": [ + { + "$ref": "./Common.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ContentKeyPolicyProperties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Content Key Policy resource." + }, + "ODataError": { + "properties": { + "code": { + "type": "string", + "description": "A language-independent error name." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "target": { + "type": "string", + "description": "The target of the error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + }, + "description": "The error details." + } + }, + "type": "object", + "description": "Information about an error." + }, + "ApiError": { + "properties": { + "error": { + "$ref": "#/definitions/ODataError", + "description": "The error properties." + } + }, + "type": "object", + "description": "The API error." + }, + "ContentKeyPolicyCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicy" + }, + "description": "A collection of ContentKeyPolicy items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of ContentKeyPolicy items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies": { + "get": { + "summary": "List Content Key Policies", + "description": "Lists the Content Key Policies in the account", + "operationId": "ContentKeyPolicies_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicyCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/ContentKeyPolicy", + "x-ms-examples": { + "Lists all Content Key Policies": { + "$ref": "examples/content-key-policies-list-all.json" + }, + "Lists Content Key Policies ordered by last modifed.": { + "$ref": "examples/content-key-policies-list-by-lastModified.json" + }, + "Lists Content Key Policies with created and last modified filters.": { + "$ref": "examples/content-key-policies-list-in-date-range.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}": { + "get": { + "summary": "Get a Content Key Policy", + "description": "Get the details of a Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Content Key Policy by name": { + "$ref": "examples/content-key-policies-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update an Content Key Policy", + "description": "Create or update a Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Creates a Content Key Policy with PlayReady option and Open Restriction": { + "$ref": "examples/content-key-policies-create-playready-open.json" + }, + "Creates a Content Key Policy with Widevine option and Token Restriction": { + "$ref": "examples/content-key-policies-create-widevine-token.json" + }, + "Creates a Content Key Policy with ClearKey option and Token Restriction": { + "$ref": "examples/content-key-policies-create-nodrm-token.json" + }, + "Creates a Content Key Policy with multiple options": { + "$ref": "examples/content-key-policies-create-multiple-options.json" + } + } + }, + "delete": { + "summary": "Delete a Content Key Policy", + "description": "Deletes a Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Key Policy": { + "$ref": "examples/content-key-policies-delete.json" + } + } + }, + "patch": { + "summary": "Update a Content Key Policy", + "description": "Updates an existing Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update a Content Key Policy": { + "$ref": "examples/content-key-policies-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}/getPolicyPropertiesWithSecrets": { + "post": { + "summary": "Get a Content Key Policy with secrets", + "description": "Get a Content Key Policy including secret values", + "operationId": "ContentKeyPolicies_GetPolicyPropertiesWithSecrets", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicyProperties" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get an Content Key Policy with secrets": { + "$ref": "examples/content-key-policies-get-with-secrets.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Encoding.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Encoding.json new file mode 100644 index 000000000000..5114222ff953 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Encoding.json @@ -0,0 +1,2191 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "Preset": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base type for all Presets, which define the recipe or instructions on how the input media files should be processed." + }, + "Codec": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "label": { + "type": "string", + "description": "An optional label for the codec. The label can be used to control muxing behavior." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Describes the basic properties of all codecs." + }, + "Audio": { + "x-ms-discriminator-value": "#Microsoft.Media.Audio", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": { + "channels": { + "type": "integer", + "format": "int32", + "description": "The number of channels in the audio." + }, + "samplingRate": { + "type": "integer", + "format": "int32", + "description": "The sampling rate to use for encoding in hertz." + }, + "bitrate": { + "type": "integer", + "format": "int32", + "description": "The bitrate, in bits per second, of the output encoded audio." + } + }, + "type": "object", + "description": "Defines the common properties for all audio codecs." + }, + "AacAudio": { + "x-ms-discriminator-value": "#Microsoft.Media.AacAudio", + "allOf": [ + { + "$ref": "#/definitions/Audio" + } + ], + "properties": { + "profile": { + "type": "string", + "enum": [ + "AacLc", + "HeAacV1", + "HeAacV2" + ], + "x-ms-enum": { + "name": "AacAudioProfile", + "values": [ + { + "value": "AacLc", + "description": "Specifies that the output audio is to be encoded into AAC Low Complexity profile (AAC-LC)." + }, + { + "value": "HeAacV1", + "description": "Specifies that the output audio is to be encoded into HE-AAC v1 profile." + }, + { + "value": "HeAacV2", + "description": "Specifies that the output audio is to be encoded into HE-AAC v2 profile." + } + ], + "modelAsExtensible": true + }, + "description": "The encoding profile to be used when encoding audio with AAC." + } + }, + "type": "object", + "description": "Describes Advanced Audio Codec (AAC) audio encoding settings." + }, + "AudioAnalyzerPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.AudioAnalyzerPreset", + "allOf": [ + { + "$ref": "#/definitions/Preset" + } + ], + "properties": { + "audioLanguage": { + "type": "string", + "description": "The language for the audio payload in the input using the BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are, 'en-US', 'en-GB', 'es-ES', 'es-MX', 'fr-FR', 'it-IT', 'ja-JP', 'pt-BR', 'zh-CN'." + } + }, + "type": "object", + "description": "The Audio Analyzer preset applies a pre-defined set of AI-based analysis operations, including speech transcription. Currently, the preset supports processing of content with a single audio track." + }, + "Overlay": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "inputLabel": { + "type": "string", + "description": "The label of the job input which is to be used as an overlay. The Input must specify exactly one file. You can specify an image file in JPG or PNG formats, or an audio file (such as a WAV, MP3, WMA or M4A file), or a video file. See https://aka.ms/mesformats for the complete list of supported audio and video file formats." + }, + "start": { + "type": "string", + "format": "duration", + "description": "The start position, with reference to the input video, at which the overlay starts. The value should be in ISO 8601 format. For example, PT05S to start the overlay at 5 seconds in to the input video. If not specified the overlay starts from the beginning of the input video." + }, + "end": { + "type": "string", + "format": "duration", + "description": "The position in the input video at which the overlay ends. The value should be in ISO 8601 duration format. For example, PT30S to end the overlay at 30 seconds in to the input video. If not specified the overlay will be applied until the end of the input video if inputLoop is true. Else, if inputLoop is false, then overlay will last as long as the duration of the overlay media." + }, + "fadeInDuration": { + "type": "string", + "format": "duration", + "description": "The duration over which the overlay fades in onto the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade in (same as PT0S)." + }, + "fadeOutDuration": { + "type": "string", + "format": "duration", + "description": "The duration over which the overlay fades out of the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade out (same as PT0S)." + }, + "audioGainLevel": { + "type": "number", + "format": "double", + "description": "The gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default is 1.0." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base type for all overlays - image, audio or video." + }, + "AudioOverlay": { + "x-ms-discriminator-value": "#Microsoft.Media.AudioOverlay", + "allOf": [ + { + "$ref": "#/definitions/Overlay" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties of an audio overlay." + }, + "CopyVideo": { + "x-ms-discriminator-value": "#Microsoft.Media.CopyVideo", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": {}, + "type": "object", + "description": "A codec flag, which tells the encoder to copy the input video bitstream without re-encoding." + }, + "Video": { + "x-ms-discriminator-value": "#Microsoft.Media.Video", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": { + "keyFrameInterval": { + "type": "string", + "format": "duration", + "description": "The distance between two key frames, thereby defining a group of pictures (GOP). The value should be a non-zero integer in the range [1, 30] seconds, specified in ISO 8601 format. The default is 2 seconds (PT2S)." + }, + "stretchMode": { + "type": "string", + "enum": [ + "None", + "AutoSize", + "AutoFit" + ], + "x-ms-enum": { + "name": "StretchMode", + "values": [ + { + "value": "None", + "description": "Strictly respect the output resolution without considering the pixel aspect ratio or display aspect ratio of the input video." + }, + { + "value": "AutoSize", + "description": "Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9." + }, + { + "value": "AutoFit", + "description": "Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right." + } + ], + "modelAsExtensible": true + }, + "description": "The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize" + } + }, + "type": "object", + "description": "Describes the basic properties for encoding the input video." + }, + "Image": { + "x-ms-discriminator-value": "#Microsoft.Media.Image", + "allOf": [ + { + "$ref": "#/definitions/Video" + } + ], + "properties": { + "start": { + "type": "string", + "description": "The position in the input video from where to start generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT05S), or a frame count (For example, 10 for the 10th frame), or a relative value (For example, 1%). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video." + }, + "step": { + "type": "string", + "description": "The intervals at which thumbnails are generated. The value can be in absolute timestamp (ISO 8601, e.g: PT05S for one image every 5 seconds), or a frame count (For example, 30 for every 30 frames), or a relative value (For example, 1%)." + }, + "range": { + "type": "string", + "description": "The position in the input video at which to stop generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT5M30S to stop at 5 minutes and 30 seconds), or a frame count (For example, 300 to stop at the 300th frame), or a relative value (For example, 100%)." + } + }, + "type": "object", + "description": "Describes the basic properties for generating thumbnails from the input video" + }, + "Format": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "filenamePattern": { + "type": "string", + "description": "The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - The base name of the input video {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {Bitrate} - The audio/video bitrate. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. Any unsubstituted macros will be collapsed and removed from the filename." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for output." + }, + "ImageFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.ImageFormat", + "allOf": [ + { + "$ref": "#/definitions/Format" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties for an output image file." + }, + "JpgFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.JpgFormat", + "allOf": [ + { + "$ref": "#/definitions/ImageFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the settings for producing JPEG thumbnails." + }, + "PngFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.PngFormat", + "allOf": [ + { + "$ref": "#/definitions/ImageFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the settings for producing PNG thumbnails." + }, + "CopyAudio": { + "x-ms-discriminator-value": "#Microsoft.Media.CopyAudio", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": {}, + "type": "object", + "description": "A codec flag, which tells the encoder to copy the input audio bitstream." + }, + "Deinterlace": { + "properties": { + "parity": { + "type": "string", + "enum": [ + "Auto", + "TopFieldFirst", + "BottomFieldFirst" + ], + "x-ms-enum": { + "name": "DeinterlaceParity", + "values": [ + { + "value": "Auto", + "description": "Automatically detect the order of fields" + }, + { + "value": "TopFieldFirst", + "description": "Apply top field first processing of input video." + }, + { + "value": "BottomFieldFirst", + "description": "Apply bottom field first processing of input video." + } + ], + "modelAsExtensible": true + }, + "description": "The field parity for de-interlacing, defaults to Auto." + }, + "mode": { + "type": "string", + "enum": [ + "Off", + "AutoPixelAdaptive" + ], + "x-ms-enum": { + "name": "DeinterlaceMode", + "values": [ + { + "value": "Off", + "description": "Disables de-interlacing of the source video." + }, + { + "value": "AutoPixelAdaptive", + "description": "Apply automatic pixel adaptive de-interlacing on each frame in the input video." + } + ], + "modelAsExtensible": true + }, + "description": "The deinterlacing mode. Defaults to AutoPixelAdaptive." + } + }, + "type": "object", + "description": "Describes the de-interlacing settings." + }, + "Rectangle": { + "properties": { + "left": { + "type": "string", + "description": "The number of pixels from the left-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "top": { + "type": "string", + "description": "The number of pixels from the top-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "width": { + "type": "string", + "description": "The width of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "height": { + "type": "string", + "description": "The height of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + } + }, + "type": "object", + "description": "Describes the properties of a rectangular window applied to the input media before processing it." + }, + "Filters": { + "properties": { + "deinterlace": { + "$ref": "#/definitions/Deinterlace", + "description": "The de-interlacing settings." + }, + "rotation": { + "type": "string", + "enum": [ + "Auto", + "None", + "Rotate0", + "Rotate90", + "Rotate180", + "Rotate270" + ], + "x-ms-enum": { + "name": "Rotation", + "values": [ + { + "value": "Auto", + "description": "Automatically detect and rotate as needed." + }, + { + "value": "None", + "description": "Do not rotate the video. If the output format supports it, any metadata about rotation is kept intact." + }, + { + "value": "Rotate0", + "description": "Do not rotate the video but remove any metadata about the rotation." + }, + { + "value": "Rotate90", + "description": "Rotate 90 degrees clockwise." + }, + { + "value": "Rotate180", + "description": "Rotate 180 degrees clockwise." + }, + { + "value": "Rotate270", + "description": "Rotate 270 degrees clockwise." + } + ], + "modelAsExtensible": true + }, + "description": "The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto" + }, + "crop": { + "$ref": "#/definitions/Rectangle", + "description": "The parameters for the rectangular window with which to crop the input video." + }, + "overlays": { + "type": "array", + "items": { + "$ref": "#/definitions/Overlay" + }, + "description": "The properties of overlays to be applied to the input video. These could be audio, image or video overlays." + } + }, + "type": "object", + "description": "Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding." + }, + "Layer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "width": { + "type": "string", + "description": "The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input." + }, + "height": { + "type": "string", + "description": "The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input." + }, + "label": { + "type": "string", + "description": "The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "The encoder can be configured to produce video and/or images (thumbnails) at different resolutions, by specifying a layer for each desired resolution. A layer represents the properties for the video or image at a resolution." + }, + "VideoLayer": { + "x-ms-discriminator-value": "#Microsoft.Media.VideoLayer", + "allOf": [ + { + "$ref": "#/definitions/Layer" + } + ], + "properties": { + "bitrate": { + "type": "integer", + "format": "int32", + "description": "The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field." + }, + "maxBitrate": { + "type": "integer", + "format": "int32", + "description": "The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate." + }, + "bFrames": { + "type": "integer", + "format": "int32", + "description": "The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level." + }, + "frameRate": { + "type": "string", + "description": "The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video." + }, + "slices": { + "type": "integer", + "format": "int32", + "description": "The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame." + }, + "adaptiveBFrame": { + "type": "boolean", + "description": "Whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use." + } + }, + "type": "object", + "description": "Describes the settings to be used when encoding the input video into a desired output bitrate layer." + }, + "H264Layer": { + "x-ms-discriminator-value": "#Microsoft.Media.H264Layer", + "allOf": [ + { + "$ref": "#/definitions/VideoLayer" + } + ], + "properties": { + "profile": { + "type": "string", + "enum": [ + "Auto", + "Baseline", + "Main", + "High", + "High422", + "High444" + ], + "x-ms-enum": { + "name": "H264VideoProfile", + "values": [ + { + "value": "Auto", + "description": "Tells the encoder to automatically determine the appropriate H.264 profile." + }, + { + "value": "Baseline", + "description": "Baseline profile" + }, + { + "value": "Main", + "description": "Main profile" + }, + { + "value": "High", + "description": "High profile." + }, + { + "value": "High422", + "description": "High 4:2:2 profile." + }, + { + "value": "High444", + "description": "High 4:4:4 predictive profile." + } + ], + "modelAsExtensible": true + }, + "description": "Which profile of the H.264 standard should be used when encoding this layer. Default is Auto." + }, + "level": { + "type": "string", + "description": "Which level of the H.264 standard should be used when encoding this layer. The value can be Auto, or a number that matches the H.264 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer." + }, + "bufferWindow": { + "type": "string", + "format": "duration", + "description": "The VBV buffer window length. The value should be in ISO 8601 format. The value should be in the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S)." + }, + "referenceFrames": { + "type": "integer", + "format": "int32", + "description": "The number of reference frames to be used when encoding this layer. If not specified, the encoder determines an appropriate number based on the encoder complexity setting." + }, + "entropyMode": { + "type": "string", + "enum": [ + "Cabac", + "Cavlc" + ], + "x-ms-enum": { + "name": "EntropyMode", + "values": [ + { + "value": "Cabac", + "description": "Context Adaptive Binary Arithmetic Coder (CABAC) entropy encoding." + }, + { + "value": "Cavlc", + "description": "Context Adaptive Variable Length Coder (CAVLC) entropy encoding." + } + ], + "modelAsExtensible": true + }, + "description": "The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level." + } + }, + "type": "object", + "description": "Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.264 video codec." + }, + "H264Video": { + "x-ms-discriminator-value": "#Microsoft.Media.H264Video", + "allOf": [ + { + "$ref": "#/definitions/Video" + } + ], + "properties": { + "sceneChangeDetection": { + "type": "boolean", + "description": "Whether or not the encoder should insert key frames at scene changes. If not specified, the default is false. This flag should be set to true only when the encoder is being configured to produce a single output video." + }, + "complexity": { + "type": "string", + "enum": [ + "Speed", + "Balanced", + "Quality" + ], + "x-ms-enum": { + "name": "H264Complexity", + "values": [ + { + "value": "Speed", + "description": "Tells the encoder to use settings that are optimized for faster encoding. Quality is sacrificed to decrease encoding time." + }, + { + "value": "Balanced", + "description": "Tells the encoder to use settings that achieve a balance between speed and quality." + }, + { + "value": "Quality", + "description": "Tells the encoder to use settings that are optimized to produce higher quality output at the expense of slower overall encode time." + } + ], + "modelAsExtensible": true + }, + "description": "Tells the encoder how to choose its encoding settings. The default value is Balanced." + }, + "layers": { + "type": "array", + "items": { + "$ref": "#/definitions/H264Layer" + }, + "description": "The collection of output H.264 layers to be produced by the encoder." + } + }, + "type": "object", + "description": "Describes all the properties for encoding a video with the H.264 codec." + }, + "JpgImage": { + "x-ms-discriminator-value": "#Microsoft.Media.JpgImage", + "allOf": [ + { + "$ref": "#/definitions/Image" + } + ], + "properties": { + "layers": { + "type": "array", + "items": { + "$ref": "#/definitions/JpgLayer" + }, + "description": "A collection of output JPEG image layers to be produced by the encoder." + } + }, + "type": "object", + "description": "Describes the properties for producing a series of JPEG images from the input video." + }, + "JpgLayer": { + "x-ms-discriminator-value": "#Microsoft.Media.JpgLayer", + "allOf": [ + { + "$ref": "#/definitions/Layer" + } + ], + "properties": { + "quality": { + "type": "integer", + "format": "int32", + "description": "The compression quality of the JPEG output. Range is from 0-100 and the default is 70." + } + }, + "type": "object", + "description": "Describes the settings to produce a JPEG image from the input video." + }, + "OutputFile": { + "properties": { + "labels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of labels that describe how the encoder should multiplex video and audio into an output file. For example, if the encoder is producing two video layers with labels v1 and v2, and one audio layer with label a1, then an array like '[v1, a1]' tells the encoder to produce an output file with the video track represented by v1 and the audio track represented by a1." + } + }, + "type": "object", + "description": "Represents an output file produced." + }, + "MultiBitrateFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.MultiBitrateFormat", + "allOf": [ + { + "$ref": "#/definitions/Format" + } + ], + "properties": { + "outputFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "description": "The list of output files to produce. Each entry in the list is a set of audio and video layer labels to be muxed together ." + } + }, + "type": "object", + "description": "Describes the properties for producing a collection of GOP aligned multi-bitrate files. The default behavior is to produce one output file for each video layer which is muxed together with all the audios. The exact output files produced can be controlled by specifying the outputFiles collection." + }, + "Mp4Format": { + "x-ms-discriminator-value": "#Microsoft.Media.Mp4Format", + "allOf": [ + { + "$ref": "#/definitions/MultiBitrateFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties for an output ISO MP4 file." + }, + "PngImage": { + "x-ms-discriminator-value": "#Microsoft.Media.PngImage", + "allOf": [ + { + "$ref": "#/definitions/Image" + } + ], + "properties": { + "layers": { + "type": "array", + "items": { + "$ref": "#/definitions/PngLayer" + }, + "description": "A collection of output PNG image layers to be produced by the encoder." + } + }, + "type": "object", + "description": "Describes the properties for producing a series of PNG images from the input video." + }, + "PngLayer": { + "x-ms-discriminator-value": "#Microsoft.Media.PngLayer", + "allOf": [ + { + "$ref": "#/definitions/Layer" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the settings to produce a PNG image from the input video." + }, + "BuiltInStandardEncoderPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "allOf": [ + { + "$ref": "#/definitions/Preset" + } + ], + "properties": { + "presetName": { + "type": "string", + "enum": [ + "AdaptiveStreaming", + "AACGoodQualityAudio", + "H264MultipleBitrate1080p", + "H264MultipleBitrate720p", + "H264MultipleBitrateSD" + ], + "x-ms-enum": { + "name": "EncoderNamedPreset", + "values": [ + { + "value": "AdaptiveStreaming", + "description": "Produces a set of GOP aligned MP4 files with H.264 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution and bitrate. The auto-generated preset will never exceed the input resolution and bitrate. For example, if the input is 720p at 3 Mbps, output will remain 720p at best, and will start at rates lower than 3 Mbps. The output will will have video and audio in separate MP4 files, which is optimal for adaptive streaming." + }, + { + "value": "AACGoodQualityAudio", + "description": "Produces a single MP4 file containing only stereo audio encoded at 192 kbps." + }, + { + "value": "H264MultipleBitrate1080p", + "description": "Produces a set of 8 GOP-aligned MP4 files, ranging from 6000 kbps to 400 kbps, and stereo AAC audio. Resolution starts at 1080p and goes down to 360p." + }, + { + "value": "H264MultipleBitrate720p", + "description": "Produces a set of 6 GOP-aligned MP4 files, ranging from 3400 kbps to 400 kbps, and stereo AAC audio. Resolution starts at 720p and goes down to 360p." + }, + { + "value": "H264MultipleBitrateSD", + "description": "Produces a set of 5 GOP-aligned MP4 files, ranging from 1600kbps to 400 kbps, and stereo AAC audio. Resolution starts at 480p and goes down to 360p." + } + ], + "modelAsExtensible": true + }, + "description": "The built-in preset to be used for encoding videos." + } + }, + "type": "object", + "required": [ + "presetName" + ], + "description": "Describes a built-in preset for encoding the input video with the Standard Encoder." + }, + "StandardEncoderPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.StandardEncoderPreset", + "allOf": [ + { + "$ref": "#/definitions/Preset" + } + ], + "properties": { + "filters": { + "$ref": "#/definitions/Filters", + "description": "One or more filtering operations that are applied to the input media before encoding." + }, + "codecs": { + "type": "array", + "items": { + "$ref": "#/definitions/Codec" + }, + "description": "The list of codecs to be used when encoding the input video." + }, + "formats": { + "type": "array", + "items": { + "$ref": "#/definitions/Format" + }, + "description": "The list of outputs to be produced by the encoder." + } + }, + "type": "object", + "description": "Describes all the settings to be used when encoding the input video with the Standard Encoder." + }, + "VideoAnalyzerPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.VideoAnalyzerPreset", + "allOf": [ + { + "$ref": "#/definitions/AudioAnalyzerPreset" + } + ], + "properties": { + "audioInsightsOnly": { + "type": "boolean", + "description": "Whether to only extract audio insights when processing a video file." + } + }, + "type": "object", + "description": "A video analyzer preset that extracts insights (rich metadata) from both audio and video, and outputs a JSON format file." + }, + "TransportStreamFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.TransportStreamFormat", + "allOf": [ + { + "$ref": "#/definitions/MultiBitrateFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties for generating an MPEG-2 Transport Stream (ISO/IEC 13818-1) output video file(s)." + }, + "VideoOverlay": { + "x-ms-discriminator-value": "#Microsoft.Media.VideoOverlay", + "allOf": [ + { + "$ref": "#/definitions/Overlay" + } + ], + "properties": { + "position": { + "$ref": "#/definitions/Rectangle", + "description": "The location in the input video where the overlay is applied." + }, + "opacity": { + "type": "number", + "format": "double", + "description": "The opacity of the overlay. This is a value in the range [0 - 1.0]. Default is 1.0 which mean the overlay is opaque." + }, + "cropRectangle": { + "$ref": "#/definitions/Rectangle", + "description": "An optional rectangular window used to crop the overlay image or video." + } + }, + "type": "object", + "description": "Describes the properties of a video overlay." + }, + "TransformOutput": { + "properties": { + "onError": { + "type": "string", + "enum": [ + "StopProcessingJob", + "ContinueJob" + ], + "x-ms-enum": { + "name": "OnErrorType", + "values": [ + { + "value": "StopProcessingJob", + "description": "Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped." + }, + { + "value": "ContinueJob", + "description": "Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue." + } + ], + "modelAsExtensible": true + }, + "description": "A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The default is stop." + }, + "relativePriority": { + "type": "string", + "enum": [ + "Low", + "Normal", + "High" + ], + "x-ms-enum": { + "name": "Priority", + "values": [ + { + "value": "Low", + "description": "Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs." + }, + { + "value": "Normal", + "description": "Used for TransformOutputs that can be generated at Normal priority." + }, + { + "value": "High", + "description": "Used for TransformOutputs that should take precedence over others." + } + ], + "modelAsExtensible": true + }, + "description": "Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal." + }, + "preset": { + "$ref": "#/definitions/Preset", + "description": "Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output." + } + }, + "type": "object", + "required": [ + "preset" + ], + "description": "Describes the properties of a TransformOutput, which are the rules to be applied while generating the desired output." + }, + "TransformProperties": { + "properties": { + "created": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "description": { + "type": "string", + "description": "An optional verbose description of the Transform." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/TransformOutput" + }, + "description": "An array of one or more TransformOutputs that the Transform should generate." + } + }, + "type": "object", + "required": [ + "outputs" + ], + "description": "A Transform." + }, + "Transform": { + "allOf": [ + { + "$ref": "./Common.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TransformProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Transform encapsulates the rules or instructions for generating desired outputs from input media, such as by transcoding or by extracting insights. After the Transform is created, it can be applied to input media by creating Jobs." + }, + "JobInput": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "label": { + "type": "string", + "description": "A label that is assigned to a JobInput, that is used to satisfy a reference used in the Transform. For example, a Transform can be authored so as to take an image file with the label 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a Job, exactly one of the JobInputs should be the image file, and it should have the label 'xyz'." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for inputs to a Job." + }, + "JobInputClip": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputClip", + "allOf": [ + { + "$ref": "#/definitions/JobInput" + } + ], + "properties": { + "files": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of files. Required for JobInputHttp." + } + }, + "type": "object", + "description": "Represents input files for a Job." + }, + "JobInputs": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputs", + "allOf": [ + { + "$ref": "#/definitions/JobInput" + } + ], + "properties": { + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/JobInput" + }, + "description": "List of inputs to a Job." + } + }, + "type": "object", + "description": "Describes a list of of inputs to a Job." + }, + "JobInputAsset": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputAsset", + "allOf": [ + { + "$ref": "#/definitions/JobInputClip" + } + ], + "properties": { + "assetName": { + "type": "string", + "description": "The name of the input Asset." + } + }, + "type": "object", + "required": [ + "assetName" + ], + "description": "Represents an Asset for input into a Job." + }, + "JobInputHttp": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputHttp", + "allOf": [ + { + "$ref": "#/definitions/JobInputClip" + } + ], + "properties": { + "baseUri": { + "type": "string", + "description": "Base URI for HTTPS job input. It will be concatenated with provided file names. If no base uri is given, then the provided file list is assumed to be fully qualified uris." + } + }, + "type": "object", + "description": "Represents HTTPS job input." + }, + "JobOutput": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "error": { + "$ref": "#/definitions/JobError", + "description": "If the JobOutput is in the Error state, it contains the details of the error.", + "readOnly": true + }, + "state": { + "type": "string", + "enum": [ + "Canceled", + "Canceling", + "Error", + "Finished", + "Processing", + "Queued", + "Scheduled" + ], + "x-ms-enum": { + "name": "JobState", + "values": [ + { + "value": "Canceled", + "description": "The job was canceled. This is a final state for the job." + }, + { + "value": "Canceling", + "description": "The job is in the process of being canceled. This is a transient state for the job." + }, + { + "value": "Error", + "description": "The job has encountered an error. This is a final state for the job." + }, + { + "value": "Finished", + "description": "The job is finished. This is a final state for the job." + }, + { + "value": "Processing", + "description": "The job is processing. This is a transient state for the job." + }, + { + "value": "Queued", + "description": "The job is in a queued state, waiting for resources to become available. This is a transient state." + }, + { + "value": "Scheduled", + "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." + } + ], + "modelAsExtensible": true + }, + "description": "Describes the state of the JobOutput.", + "readOnly": true, + "x-nullable": false + }, + "progress": { + "type": "integer", + "format": "int32", + "description": "If the JobOutput is in a Processing state, this contains the job completion percentage. The value is an estimate and not intended to be used to predict job completion times. To determine if the JobOutput is complete, use the State property.", + "readOnly": true, + "x-nullable": false + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Describes all the properties of a JobOutput." + }, + "JobError": { + "properties": { + "code": { + "type": "string", + "enum": [ + "ServiceError", + "ServiceTransientError", + "DownloadNotAccessible", + "DownloadTransientError", + "UploadNotAccessible", + "UploadTransientError", + "ConfigurationUnsupported", + "ContentMalformed", + "ContentUnsupported" + ], + "x-ms-enum": { + "name": "JobErrorCode", + "values": [ + { + "value": "ServiceError", + "description": "Fatal service error, please contact support." + }, + { + "value": "ServiceTransientError", + "description": "Transient error, please retry, if retry is unsuccessful, please contact support." + }, + { + "value": "DownloadNotAccessible", + "description": "While trying to download the input files, the files were not accessible, please check the availability of the source." + }, + { + "value": "DownloadTransientError", + "description": "While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source." + }, + { + "value": "UploadNotAccessible", + "description": "While trying to upload the output files, the destination was not reachable, please check the availability of the destination." + }, + { + "value": "UploadTransientError", + "description": "While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination." + }, + { + "value": "ConfigurationUnsupported", + "description": "There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration." + }, + { + "value": "ContentMalformed", + "description": "There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files." + }, + { + "value": "ContentUnsupported", + "description": "There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files." + } + ], + "modelAsExtensible": true + }, + "description": "Error code describing the error.", + "readOnly": true, + "x-nullable": false + }, + "message": { + "type": "string", + "description": "A human-readable language-dependent representation of the error.", + "readOnly": true + }, + "category": { + "type": "string", + "enum": [ + "Service", + "Download", + "Upload", + "Configuration", + "Content" + ], + "x-ms-enum": { + "name": "JobErrorCategory", + "values": [ + { + "value": "Service", + "description": "The error is service related." + }, + { + "value": "Download", + "description": "The error is download related." + }, + { + "value": "Upload", + "description": "The error is upload related." + }, + { + "value": "Configuration", + "description": "The error is configuration related." + }, + { + "value": "Content", + "description": "The error is related to data in the input files." + } + ], + "modelAsExtensible": true + }, + "description": "Helps with categorization of errors.", + "readOnly": true, + "x-nullable": false + }, + "retry": { + "type": "string", + "enum": [ + "DoNotRetry", + "MayRetry" + ], + "x-ms-enum": { + "name": "JobRetry", + "values": [ + { + "value": "DoNotRetry", + "description": "Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected." + }, + { + "value": "MayRetry", + "description": "Issue may be resolved after waiting for a period of time and resubmitting the same Job." + } + ], + "modelAsExtensible": true + }, + "description": "Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal.", + "readOnly": true, + "x-nullable": false + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetail" + }, + "description": "An array of details about specific errors that led to this reported error.", + "readOnly": true + } + }, + "type": "object", + "description": "Details of JobOutput errors." + }, + "JobOutputAsset": { + "x-ms-discriminator-value": "#Microsoft.Media.JobOutputAsset", + "allOf": [ + { + "$ref": "#/definitions/JobOutput" + } + ], + "properties": { + "assetName": { + "type": "string", + "description": "The name of the output Asset." + } + }, + "type": "object", + "required": [ + "assetName" + ], + "description": "Represents an Asset used as a JobOutput." + }, + "JobErrorDetail": { + "properties": { + "code": { + "type": "string", + "description": "Code describing the error detail.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error.", + "readOnly": true + } + }, + "type": "object", + "description": "Details of JobOutput errors." + }, + "JobProperties": { + "properties": { + "created": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "state": { + "type": "string", + "enum": [ + "Canceled", + "Canceling", + "Error", + "Finished", + "Processing", + "Queued", + "Scheduled" + ], + "x-ms-enum": { + "name": "JobState", + "values": [ + { + "value": "Canceled", + "description": "The job was canceled. This is a final state for the job." + }, + { + "value": "Canceling", + "description": "The job is in the process of being canceled. This is a transient state for the job." + }, + { + "value": "Error", + "description": "The job has encountered an error. This is a final state for the job." + }, + { + "value": "Finished", + "description": "The job is finished. This is a final state for the job." + }, + { + "value": "Processing", + "description": "The job is processing. This is a transient state for the job." + }, + { + "value": "Queued", + "description": "The job is in a queued state, waiting for resources to become available. This is a transient state." + }, + { + "value": "Scheduled", + "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." + } + ], + "modelAsExtensible": true + }, + "description": "The current state of the job.", + "readOnly": true, + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Optional customer supplied description of the Job." + }, + "input": { + "$ref": "#/definitions/JobInput", + "description": "The inputs for the Job." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/JobOutput" + }, + "description": "The outputs for the Job." + }, + "priority": { + "type": "string", + "enum": [ + "Low", + "Normal", + "High" + ], + "x-ms-enum": { + "name": "Priority", + "values": [ + { + "value": "Low", + "description": "Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs." + }, + { + "value": "Normal", + "description": "Used for TransformOutputs that can be generated at Normal priority." + }, + { + "value": "High", + "description": "Used for TransformOutputs that should take precedence over others." + } + ], + "modelAsExtensible": true + }, + "description": "Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal." + }, + "correlationData": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Customer provided correlation data that will be returned in Job completed events." + } + }, + "type": "object", + "required": [ + "input", + "outputs" + ], + "description": "Properties of the Job." + }, + "Job": { + "allOf": [ + { + "$ref": "./Common.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Job resource type. The progress and state can be obtained by polling a Job or subscribing to events using EventGrid." + }, + "ODataError": { + "properties": { + "code": { + "type": "string", + "description": "A language-independent error name." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "target": { + "type": "string", + "description": "The target of the error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + }, + "description": "The error details." + } + }, + "type": "object", + "description": "Information about an error." + }, + "ApiError": { + "properties": { + "error": { + "$ref": "#/definitions/ODataError", + "description": "The error properties." + } + }, + "type": "object", + "description": "The API error." + }, + "TransformCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Transform" + }, + "description": "A collection of Transform items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Transform items." + }, + "JobCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Job" + }, + "description": "A collection of Job items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Job items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms": { + "get": { + "summary": "List Transforms", + "description": "Lists the Transforms in the account.", + "operationId": "Transforms_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransformCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that excludes the first n items of the queried collection from the result. The service returns items starting at position n+1." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/Transform", + "x-ms-examples": { + "Lists the Transforms": { + "$ref": "examples/transforms-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}": { + "get": { + "summary": "Get Transform", + "description": "Gets a Transform.", + "operationId": "Transforms_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Transform by name": { + "$ref": "examples/transforms-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or Update Transform", + "description": "Creates or updates a new Transform.", + "operationId": "Transforms_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Transform" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create or update a Transform": { + "$ref": "examples/transforms-create.json" + } + } + }, + "delete": { + "summary": "Delete Transform", + "description": "Deletes a Transform.", + "operationId": "Transforms_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Transform": { + "$ref": "examples/transforms-delete.json" + } + } + }, + "patch": { + "summary": "Update Transform", + "description": "Updates a Transform.", + "operationId": "Transforms_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Transform" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update a Transform.": { + "$ref": "examples/transforms-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs": { + "get": { + "summary": "List Jobs", + "description": "Lists all of the Jobs for the Transform.", + "operationId": "Jobs_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that excludes the first n items of the queried collection from the result. The service returns items starting at position n+1." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/Job", + "x-ms-examples": { + "Lists all of the Jobs for the Transform.": { + "$ref": "examples/jobs-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}": { + "get": { + "summary": "Get Job", + "description": "Gets a Job.", + "operationId": "Jobs_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Job by name": { + "$ref": "examples/jobs-get-by-name.json" + } + } + }, + "put": { + "summary": "Create Job", + "description": "Creates a Job.", + "operationId": "Jobs_Create", + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Job" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create a Job": { + "$ref": "examples/jobs-create.json" + } + } + }, + "delete": { + "summary": "Delete Job", + "description": "Deletes a Job.", + "operationId": "Jobs_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Job": { + "$ref": "examples/jobs-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}/cancelJob": { + "post": { + "summary": "Cancel Job", + "description": "Cancel a Job.", + "operationId": "Jobs_CancelJob", + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Cancel a Job": { + "$ref": "examples/jobs-cancel.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/StreamingPoliciesAndStreamingLocators.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/StreamingPoliciesAndStreamingLocators.json new file mode 100644 index 000000000000..4dc3ca242d4a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/StreamingPoliciesAndStreamingLocators.json @@ -0,0 +1,1281 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "TrackPropertyCondition": { + "properties": { + "property": { + "type": "string", + "enum": [ + "Unknown", + "FourCC" + ], + "x-ms-enum": { + "name": "TrackPropertyType", + "values": [ + { + "value": "Unknown", + "description": "Unknown track property" + }, + { + "value": "FourCC", + "description": "Track FourCC" + } + ], + "modelAsExtensible": true + }, + "description": "Track property type" + }, + "operation": { + "type": "string", + "enum": [ + "Unknown", + "Equal" + ], + "x-ms-enum": { + "name": "TrackPropertyCompareOperation", + "values": [ + { + "value": "Unknown", + "description": "Unknown track property compare operation" + }, + { + "value": "Equal", + "description": "Equal operation" + } + ], + "modelAsExtensible": true + }, + "description": "Track property condition operation" + }, + "value": { + "type": "string", + "description": "Track property value" + } + }, + "type": "object", + "required": [ + "property", + "operation" + ], + "description": "Class to specify one track property condition" + }, + "TrackSelection": { + "properties": { + "trackSelections": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackPropertyCondition" + }, + "description": "TrackSelections is a track property condition list which can specify track(s)" + } + }, + "type": "object", + "description": "Class to select a track" + }, + "DefaultKey": { + "properties": { + "label": { + "type": "string", + "description": "Label can be used to specify Content Key when creating a Streaming Locator" + }, + "policyName": { + "type": "string", + "description": "Policy used by Default Key" + } + }, + "type": "object", + "description": "Class to specify properties of default content key for each encryption scheme" + }, + "StreamingPolicyContentKey": { + "properties": { + "label": { + "type": "string", + "description": "Label can be used to specify Content Key when creating a Streaming Locator" + }, + "policyName": { + "type": "string", + "description": "Policy used by Content Key" + }, + "tracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Tracks which use this content key" + } + }, + "type": "object", + "description": "Class to specify properties of content key" + }, + "StreamingPolicyContentKeys": { + "properties": { + "defaultKey": { + "$ref": "#/definitions/DefaultKey", + "description": "Default content key for an encryption scheme" + }, + "keyToTrackMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingPolicyContentKey" + }, + "description": "Representing tracks needs separate content key" + } + }, + "type": "object", + "description": "Class to specify properties of all content keys in Streaming Policy" + }, + "StreamingPolicyPlayReadyConfiguration": { + "properties": { + "customLicenseAcquisitionUrlTemplate": { + "type": "string", + "description": "The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys." + }, + "playReadyCustomAttributes": { + "type": "string", + "description": "Custom attributes for PlayReady" + } + }, + "type": "object", + "description": "Class to specify configurations of PlayReady in Streaming Policy" + }, + "StreamingPolicyWidevineConfiguration": { + "properties": { + "customLicenseAcquisitionUrlTemplate": { + "type": "string", + "description": "The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys." + } + }, + "type": "object", + "description": "Class to specify configurations of Widevine in Streaming Policy" + }, + "StreamingPolicyFairPlayConfiguration": { + "properties": { + "customLicenseAcquisitionUrlTemplate": { + "type": "string", + "description": "The template for a customer service to deliver keys to end users. Not needed when using Azure Media Services for issuing keys." + }, + "allowPersistentLicense": { + "type": "boolean", + "description": "All license to be persistent or not" + } + }, + "type": "object", + "required": [ + "allowPersistentLicense" + ], + "description": "Class to specify configurations of FairPlay in Streaming Policy" + }, + "CbcsDrmConfiguration": { + "properties": { + "fairPlay": { + "$ref": "#/definitions/StreamingPolicyFairPlayConfiguration", + "description": "FairPlay configurations" + }, + "playReady": { + "$ref": "#/definitions/StreamingPolicyPlayReadyConfiguration", + "description": "PlayReady configurations" + }, + "widevine": { + "$ref": "#/definitions/StreamingPolicyWidevineConfiguration", + "description": "Widevine configurations" + } + }, + "type": "object", + "description": "Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy" + }, + "CencDrmConfiguration": { + "properties": { + "playReady": { + "$ref": "#/definitions/StreamingPolicyPlayReadyConfiguration", + "description": "PlayReady configurations" + }, + "widevine": { + "$ref": "#/definitions/StreamingPolicyWidevineConfiguration", + "description": "Widevine configurations" + } + }, + "type": "object", + "description": "Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy" + }, + "EnabledProtocols": { + "properties": { + "download": { + "type": "boolean", + "description": "Enable Download protocol or not" + }, + "dash": { + "type": "boolean", + "description": "Enable DASH protocol or not" + }, + "hls": { + "type": "boolean", + "description": "Enable HLS protocol or not" + }, + "smoothStreaming": { + "type": "boolean", + "description": "Enable SmoothStreaming protocol or not" + } + }, + "type": "object", + "required": [ + "download", + "dash", + "hls", + "smoothStreaming" + ], + "description": "Class to specify which protocols are enabled" + }, + "NoEncryption": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + } + }, + "type": "object", + "description": "Class for NoEncryption scheme" + }, + "EnvelopeEncryption": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + }, + "clearTracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Representing which tracks should not be encrypted" + }, + "contentKeys": { + "$ref": "#/definitions/StreamingPolicyContentKeys", + "description": "Representing default content key for each encryption scheme and separate content keys for specific tracks" + }, + "customKeyAcquisitionUrlTemplate": { + "type": "string", + "description": "KeyAcquistionUrlTemplate is used to point to user specified service to delivery content keys" + } + }, + "type": "object", + "description": "Class for EnvelopeEncryption encryption scheme" + }, + "CommonEncryptionCenc": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + }, + "clearTracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Representing which tracks should not be encrypted" + }, + "contentKeys": { + "$ref": "#/definitions/StreamingPolicyContentKeys", + "description": "Representing default content key for each encryption scheme and separate content keys for specific tracks" + }, + "drm": { + "$ref": "#/definitions/CencDrmConfiguration", + "description": "Configuration of DRMs for CommonEncryptionCenc encryption scheme" + } + }, + "type": "object", + "description": "Class for envelope encryption scheme" + }, + "CommonEncryptionCbcs": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + }, + "clearTracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Representing which tracks should not be encrypted" + }, + "contentKeys": { + "$ref": "#/definitions/StreamingPolicyContentKeys", + "description": "Representing default content key for each encryption scheme and separate content keys for specific tracks" + }, + "drm": { + "$ref": "#/definitions/CbcsDrmConfiguration", + "description": "Configuration of DRMs for current encryption scheme" + } + }, + "type": "object", + "description": "Class for CommonEncryptionCbcs encryption scheme" + }, + "StreamingPolicyProperties": { + "properties": { + "created": { + "type": "string", + "format": "date-time", + "description": "Creation time of Streaming Policy", + "readOnly": true, + "x-nullable": false + }, + "defaultContentKeyPolicyName": { + "type": "string", + "description": "Default ContentKey used by current Streaming Policy" + }, + "envelopeEncryption": { + "$ref": "#/definitions/EnvelopeEncryption", + "description": "Configuration of EnvelopeEncryption" + }, + "commonEncryptionCenc": { + "$ref": "#/definitions/CommonEncryptionCenc", + "description": "Configuration of CommonEncryptionCenc" + }, + "commonEncryptionCbcs": { + "$ref": "#/definitions/CommonEncryptionCbcs", + "description": "Configuration of CommonEncryptionCbcs" + }, + "noEncryption": { + "$ref": "#/definitions/NoEncryption", + "description": "Configurations of NoEncryption" + } + }, + "type": "object", + "description": "Class to specify properties of Streaming Policy" + }, + "StreamingPolicy": { + "allOf": [ + { + "$ref": "./Common.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StreamingPolicyProperties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Streaming Policy resource" + }, + "StreamingLocatorContentKey": { + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID of Content Key" + }, + "type": { + "type": "string", + "enum": [ + "CommonEncryptionCenc", + "CommonEncryptionCbcs", + "EnvelopeEncryption" + ], + "x-ms-enum": { + "name": "StreamingLocatorContentKeyType", + "values": [ + { + "value": "CommonEncryptionCenc", + "description": "Common Encryption using CENC" + }, + { + "value": "CommonEncryptionCbcs", + "description": "Common Encryption using CBCS" + }, + { + "value": "EnvelopeEncryption", + "description": "Envelope Encryption" + } + ], + "modelAsExtensible": true + }, + "description": "Encryption type of Content Key", + "readOnly": true, + "x-nullable": false + }, + "label": { + "type": "string", + "description": "Label of Content Key" + }, + "value": { + "type": "string", + "description": "Value of of Content Key" + }, + "policyName": { + "type": "string", + "description": "ContentKeyPolicy used by Content Key", + "readOnly": true + }, + "tracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Tracks which use this Content Key" + } + }, + "type": "object", + "required": [ + "id" + ], + "description": "Class for content key in Streaming Locator" + }, + "StreamingPath": { + "properties": { + "streamingProtocol": { + "type": "string", + "enum": [ + "Hls", + "Dash", + "SmoothStreaming", + "Download" + ], + "x-ms-enum": { + "name": "StreamingPolicyStreamingProtocol", + "values": [ + { + "value": "Hls", + "description": "HLS protocol" + }, + { + "value": "Dash", + "description": "DASH protocol" + }, + { + "value": "SmoothStreaming", + "description": "SmoothStreaming protocol" + }, + { + "value": "Download", + "description": "Download protocol" + } + ], + "modelAsExtensible": true + }, + "description": "Streaming protocol" + }, + "encryptionScheme": { + "type": "string", + "enum": [ + "NoEncryption", + "EnvelopeEncryption", + "CommonEncryptionCenc", + "CommonEncryptionCbcs" + ], + "x-ms-enum": { + "name": "EncryptionScheme", + "values": [ + { + "value": "NoEncryption", + "description": "NoEncryption scheme" + }, + { + "value": "EnvelopeEncryption", + "description": "EnvelopeEncryption scheme" + }, + { + "value": "CommonEncryptionCenc", + "description": "CommonEncryptionCenc scheme" + }, + { + "value": "CommonEncryptionCbcs", + "description": "CommonEncryptionCbcs scheme" + } + ], + "modelAsExtensible": true + }, + "description": "Encryption scheme" + }, + "paths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Streaming paths for each protocol and encryptionScheme pair" + } + }, + "type": "object", + "required": [ + "streamingProtocol", + "encryptionScheme" + ], + "description": "Class of paths for streaming" + }, + "StreamingLocatorProperties": { + "properties": { + "assetName": { + "type": "string", + "description": "Asset Name" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "Creation time of Streaming Locator", + "readOnly": true, + "x-nullable": false + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "StartTime of Streaming Locator" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "EndTime of Streaming Locator" + }, + "streamingLocatorId": { + "type": "string", + "format": "uuid", + "description": "StreamingLocatorId of Streaming Locator" + }, + "streamingPolicyName": { + "type": "string", + "description": "Streaming policy name used by this streaming locator. Either specify the name of streaming policy you created or use one of the predefined streaming polices. The predefined streaming policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_SecureStreaming' and 'Predefined_SecureStreamingWithFairPlay'" + }, + "defaultContentKeyPolicyName": { + "type": "string", + "description": "Default ContentKeyPolicy used by this Streaming Locator" + }, + "contentKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingLocatorContentKey" + }, + "description": "ContentKeys used by this Streaming Locator" + }, + "alternativeMediaId": { + "type": "string", + "description": "An Alternative Media Identifier associated with the StreamingLocator. This identifier can be used to distinguish different StreamingLocators for the same Asset for authorization purposes in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field." + } + }, + "type": "object", + "required": [ + "assetName", + "streamingPolicyName" + ], + "description": "Class to specify properties of Streaming Locator" + }, + "ListContentKeysResponse": { + "properties": { + "contentKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingLocatorContentKey" + }, + "description": "ContentKeys used by current Streaming Locator" + } + }, + "type": "object", + "description": "Class of response for listContentKeys action" + }, + "ListPathsResponse": { + "properties": { + "streamingPaths": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingPath" + }, + "description": "Streaming Paths supported by current Streaming Locator" + }, + "downloadPaths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Download Paths supported by current Streaming Locator" + } + }, + "type": "object", + "description": "Class of response for listPaths action" + }, + "StreamingLocator": { + "allOf": [ + { + "$ref": "./Common.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StreamingLocatorProperties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Streaming Locator resource" + }, + "ODataError": { + "properties": { + "code": { + "type": "string", + "description": "A language-independent error name." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "target": { + "type": "string", + "description": "The target of the error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + }, + "description": "The error details." + } + }, + "type": "object", + "description": "Information about an error." + }, + "ApiError": { + "properties": { + "error": { + "$ref": "#/definitions/ODataError", + "description": "The error properties." + } + }, + "type": "object", + "description": "The API error." + }, + "StreamingPolicyCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingPolicy" + }, + "description": "A collection of StreamingPolicy items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of StreamingPolicy items." + }, + "StreamingLocatorCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingLocator" + }, + "description": "A collection of StreamingLocator items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of StreamingLocator items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies": { + "get": { + "summary": "List Streaming Policies", + "description": "Lists the Streaming Policies in the account", + "operationId": "StreamingPolicies_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingPolicyCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/StreamingPolicy", + "x-ms-examples": { + "Lists Streaming Policies": { + "$ref": "examples/streaming-policies-list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies/{streamingPolicyName}": { + "get": { + "summary": "Get a Streaming Policy", + "description": "Get the details of a Streaming Policy in the Media Services account", + "operationId": "StreamingPolicies_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingPolicy" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Streaming Policy by name": { + "$ref": "examples/streaming-policy-get-by-name.json" + } + } + }, + "put": { + "summary": "Create a Streaming Policy", + "description": "Create a Streaming Policy in the Media Services account", + "operationId": "StreamingPolicies_Create", + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/StreamingPolicy" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Policy name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingPolicy" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Creates a Streaming Policy with clear streaming": { + "$ref": "examples/streaming-policies-create-clear.json" + }, + "Creates a Streaming Policy with envelopeEncryption only": { + "$ref": "examples/streaming-policies-create-envelopeEncryption-only.json" + }, + "Creates a Streaming Policy with commonEncryptionCenc only": { + "$ref": "examples/streaming-policies-create-commonEncryptionCenc-only.json" + }, + "Creates a Streaming Policy with commonEncryptionCbcs only": { + "$ref": "examples/streaming-policies-create-commonEncryptionCbcs-only.json" + }, + "Creates a Streaming Policy with secure streaming": { + "$ref": "examples/streaming-policies-create-secure-streaming.json" + } + } + }, + "delete": { + "summary": "Delete a Streaming Policy", + "description": "Deletes a Streaming Policy in the Media Services account", + "operationId": "StreamingPolicies_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Streaming Policy": { + "$ref": "examples/streaming-policies-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators": { + "get": { + "summary": "List Streaming Locators", + "description": "Lists the Streaming Locators in the account", + "operationId": "StreamingLocators_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingLocatorCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/StreamingLocator", + "x-ms-examples": { + "Lists Streaming Locators": { + "$ref": "examples/streaming-locators-list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}": { + "get": { + "summary": "Get a Streaming Locator", + "description": "Get the details of a Streaming Locator in the Media Services account", + "operationId": "StreamingLocators_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingLocator" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Streaming Locator by name": { + "$ref": "examples/streaming-locators-get-by-name.json" + } + } + }, + "put": { + "summary": "Create a Streaming Locator", + "description": "Create a Streaming Locator in the Media Services account", + "operationId": "StreamingLocators_Create", + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/StreamingLocator" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingLocator" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Creates a Streaming Locator with clear streaming": { + "$ref": "examples/streaming-locators-create-clear.json" + }, + "Creates a Streaming Locator with secure streaming": { + "$ref": "examples/streaming-locators-create-secure.json" + }, + "Creates a Streaming Locator with user defined content keys": { + "$ref": "examples/streaming-locators-create-secure-userDefinedContentKeys.json" + } + } + }, + "delete": { + "summary": "Delete a Streaming Locator", + "description": "Deletes a Streaming Locator in the Media Services account", + "operationId": "StreamingLocators_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Streaming Locator": { + "$ref": "examples/streaming-locators-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listContentKeys": { + "post": { + "summary": "List Content Keys", + "description": "List Content Keys used by this Streaming Locator", + "operationId": "StreamingLocators_ListContentKeys", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListContentKeysResponse" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Content Keys": { + "$ref": "examples/streaming-locators-list-content-keys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listPaths": { + "post": { + "summary": "List Paths", + "description": "List Paths supported by this Streaming Locator", + "operationId": "StreamingLocators_ListPaths", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListPathsResponse" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Paths which has streaming paths only": { + "$ref": "examples/streaming-locators-list-paths-streaming-only.json" + }, + "List Paths which has streaming paths and download paths": { + "$ref": "examples/streaming-locators-list-paths-streaming-and-download.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-check-name-availability.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-check-name-availability.json new file mode 100644 index 000000000000..c4d155d2e2d0 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-check-name-availability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "locationName": "japaneast", + "parameters": { + "name": "contosonew", + "type": "Microsoft.Media/MediaService" + }, + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-create.json new file mode 100644 index 000000000000..a07945d423e8 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-create.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2018-06-01-preview", + "parameters": { + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "contososports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contososports", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "42bea25f-1aa9-4f7a-82af-5a417592f22d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + }, + "200": { + "body": { + "name": "contososports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contososports", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "42bea25f-1aa9-4f7a-82af-5a417592f22d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-delete.json new file mode 100644 index 000000000000..013be2cb9959 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-get-by-name.json new file mode 100644 index 000000000000..e095ffaaeb46 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-get-by-name.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosotv", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "contosotv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosotv", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "6ac94f91-283c-4492-85a7-57976928c17d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosotvstore", + "type": "Primary" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-list-all-accounts.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-list-all-accounts.json new file mode 100644 index 000000000000..1f3402d2111c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-list-all-accounts.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contosotv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosotv", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "6ac94f91-283c-4492-85a7-57976928c17d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosotvstore", + "type": "Primary" + } + ] + } + }, + { + "name": "contosomovies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomovies", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "72681c0f-9dd1-4f1c-95c9-8a8d7d31c4ee", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosomoviesstore", + "type": "Primary" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-subscription-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-subscription-get-by-name.json new file mode 100644 index 000000000000..dcdb73b08a18 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-subscription-get-by-name.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "contososports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contososports", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "42bea25f-1aa9-4f7a-82af-5a417592f22d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-subscription-list-all-accounts.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-subscription-list-all-accounts.json new file mode 100644 index 000000000000..1589d46d80f1 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-subscription-list-all-accounts.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contosotv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosotv", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "6ac94f91-283c-4492-85a7-57976928c17d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosotvstore", + "type": "Primary" + } + ] + } + }, + { + "name": "contosomovies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomovies", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "72681c0f-9dd1-4f1c-95c9-8a8d7d31c4ee", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosomoviesstore", + "type": "Primary" + } + ] + } + }, + { + "name": "fabrikamnews", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/fabrikamnews", + "type": "Microsoft.Media/mediaservices", + "location": "East US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "d96036f9-4e37-491d-8c29-5bc53a29dfcd", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Storage/storageAccounts/fabrikamnewsstore", + "type": "Primary" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-sync-storage-keys.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-sync-storage-keys.json new file mode 100644 index 000000000000..b7a116ae3766 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-sync-storage-keys.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2018-06-01-preview", + "parameters": { + "id": "contososportsstore" + } + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-update.json new file mode 100644 index 000000000000..0beb3a4f9ad0 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/accounts-update.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2018-06-01-preview", + "parameters": { + "tags": { + "key1": "value3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "contososports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contososports", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value3" + }, + "properties": { + "mediaServiceId": "42bea25f-1aa9-4f7a-82af-5a417592f22d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-create.json new file mode 100644 index 000000000000..a61e1e8aac85 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountLogan", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "description": "A documentary showing the ascent of Mount Logan", + "storageAccountName": "storage0" + } + } + }, + "responses": { + "201": { + "body": { + "name": "ClimbingMountLogan", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountLogan", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "6b4ec0a2-546f-4cc2-a000-6a46f9aec67f", + "created": "2018-05-31T21:08:47.903Z", + "lastModified": "2018-05-31T21:08:47.903Z", + "alternateId": null, + "description": "A documentary showing the ascent of Mount Logan", + "container": null, + "storageAccountName": "storage0", + "storageEncryptionFormat": "None" + } + } + }, + "200": { + "body": { + "name": "ClimbingMountLogan", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountLogan", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "6b4ec0a2-546f-4cc2-a000-6a46f9aec67f", + "created": "2018-05-31T21:08:47.903Z", + "lastModified": "2018-05-31T21:08:47.957Z", + "alternateId": null, + "description": "A documentary showing the ascent of Mount Logan", + "container": null, + "storageAccountName": "storage0", + "storageEncryptionFormat": "None" + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-delete.json new file mode 100644 index 000000000000..9911dace2279 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountAdams", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-get-by-name.json new file mode 100644 index 000000000000..f1d65ce5bfe6 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-get-by-name.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountAdams", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-get-encryption-keys.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-get-encryption-keys.json new file mode 100644 index 000000000000..636528ef24de --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-get-encryption-keys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountAdams", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "storageEncryptionKey": null + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-list-all.json new file mode 100644 index 000000000000..79e3aa6a38ec --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-list-all.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ClimbingLittleTahoma", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingLittleTahoma", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "e6c7ee55-d1f5-48bc-9c36-2d2157aadbbe", + "created": "2012-04-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00003", + "description": "A documentary showing the ascent of Little Tahoma", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountBaker", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountBaker", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "89af1750-e681-4fbe-8c4c-9a5567867a6b", + "created": "2011-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00004", + "description": "A documentary showing the ascent of Mount Baker", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountRainier", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainier", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "alternateId": "CLIMB00001", + "description": "A documentary showing the ascent of Mount Rainier", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-list-by-date.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-list-by-date.json new file mode 100644 index 000000000000..5e7189e5e1aa --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-list-by-date.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-06-01-preview", + "$orderby": "properties/created" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ClimbingMountBaker", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountBaker", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "89af1750-e681-4fbe-8c4c-9a5567867a6b", + "created": "2011-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00004", + "description": "A documentary showing the ascent of Mount Baker", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingLittleTahoma", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingLittleTahoma", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "e6c7ee55-d1f5-48bc-9c36-2d2157aadbbe", + "created": "2012-04-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00003", + "description": "A documentary showing the ascent of Little Tahoma", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountRainier", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainier", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "alternateId": "CLIMB00001", + "description": "A documentary showing the ascent of Mount Rainier", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-list-in-date-range.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-list-in-date-range.json new file mode 100644 index 000000000000..80afef55c969 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-list-in-date-range.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-06-01-preview", + "$orderby": "properties/created", + "$filter": "properties/created gt 2012-06-01 and properties/created lt 2013-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ClimbingMountRainier", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainier", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "alternateId": "CLIMB00001", + "description": "A documentary showing the ascent of Mount Rainier", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-list-sas-urls.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-list-sas-urls.json new file mode 100644 index 000000000000..fbf0ccb18508 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-list-sas-urls.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountBaker", + "api-version": "2018-06-01-preview", + "parameters": { + "permissions": "ReadWrite", + "expiryTime": "2018-01-01T10:00:00.007Z" + } + }, + "responses": { + "200": { + "body": { + "assetContainerSasUrls": [ + "https://storage0.blob.core.windows.net/asset-89af1750-e681-4fbe-8c4c-9a5567867a6b?sr=b&sig=&se=2018-01-01T10:00:00Z&sp=lrw", + "https://storage0.blob.core.windows.net/asset-89af1750-e681-4fbe-8c4c-9a5567867a6b?sr=b&sig=&se=2018-01-01T10:00:00Z&sp=lrw" + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-update.json new file mode 100644 index 000000000000..d86cf01440d8 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/assets-update.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountBaker", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "description": "A documentary showing the ascent of Mount Baker in HD" + } + } + }, + "responses": { + "200": { + "body": { + "name": "ClimbingMountBaker", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountBaker", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "89af1750-e681-4fbe-8c4c-9a5567867a6b", + "created": "2011-02-01T00:00:00Z", + "lastModified": "2018-05-31T21:08:48.143Z", + "alternateId": "CLIMB00004", + "description": "A documentary showing the ascent of Mount Baker in HD", + "container": null, + "storageAccountName": null, + "storageEncryptionFormat": "None" + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-create-multiple-options.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-create-multiple-options.json new file mode 100644 index 000000000000..db98a8275870 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-create-multiple-options.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyCreatedWithMultipleOptions", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "description": "ArmPolicyDescription", + "options": [ + { + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAAAAAAAAAAAAAAAAAAAAA==" + }, + "restrictionTokenType": "Swt" + } + }, + { + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyCreatedWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyCreatedWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "720ef07f-a2bd-4d02-89ca-e31177e9517e", + "created": "2018-03-07T18:49:21.16Z", + "lastModified": "2018-03-07T18:49:21.16Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "3f114e9c-4b81-48ac-a7c4-79bb2bc58224", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt", + "openIdConnectDiscoveryDocument": null + } + }, + { + "policyOptionId": "7fc39d0a-1a75-4109-acf8-3fa6a6cdb041", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyCreatedWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyCreatedWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "720ef07f-a2bd-4d02-89ca-e31177e9517e", + "created": "2018-03-07T18:49:21.16Z", + "lastModified": "2018-03-07T18:49:21.16Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "3f114e9c-4b81-48ac-a7c4-79bb2bc58224", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt", + "openIdConnectDiscoveryDocument": null + } + }, + { + "policyOptionId": "7fc39d0a-1a75-4109-acf8-3fa6a6cdb041", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-create-nodrm-token.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-create-nodrm-token.json new file mode 100644 index 000000000000..c4d93e6c4857 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-create-nodrm-token.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithClearKeyOptionAndSwtTokenRestriction", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "description": "ArmPolicyDescription", + "options": [ + { + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAAAAAAAAAAAAAAAAAAAAA==" + }, + "restrictionTokenType": "Swt" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithClearKeyOptionAndSwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndSwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "cb77b46c-f120-4e28-ae45-11be48aea02c", + "created": "2018-03-07T18:49:21.103Z", + "lastModified": "2018-03-07T18:49:21.103Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "5fa6f216-bfdb-4e3f-9ea5-d8dcc023ed7f", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt", + "openIdConnectDiscoveryDocument": null + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyWithClearKeyOptionAndSwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndSwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "cb77b46c-f120-4e28-ae45-11be48aea02c", + "created": "2018-03-07T18:49:21.103Z", + "lastModified": "2018-03-07T18:49:21.103Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "5fa6f216-bfdb-4e3f-9ea5-d8dcc023ed7f", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt", + "openIdConnectDiscoveryDocument": null + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-create-playready-open.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-create-playready-open.json new file mode 100644 index 000000000000..4a5c5ecc3e84 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-create-playready-open.json @@ -0,0 +1,157 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "policyId": "00000000-0000-0000-0000-000000000000", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "00000000-0000-0000-0000-000000000000", + "name": "ArmPolicyOptionName", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": true, + "beginDate": "2017-10-16T18:22:53.46Z", + "playRight": { + "scmsRestriction": 2, + "imageConstraintForAnalogComponentVideoRestriction": true, + "allowPassingVideoContentToUnknownOutput": "NotAllowed" + }, + "licenseType": "Persistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "UltraVioletDownload" + } + ] + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2018-03-07T18:49:20.94Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "9f60df33-124b-4590-94c8-f00d92107187", + "name": "ArmPolicyOptionName", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": true, + "beginDate": "2017-10-16T18:22:53.46Z", + "expirationDate": null, + "relativeBeginDate": null, + "relativeExpirationDate": null, + "gracePeriod": null, + "playRight": { + "firstPlayExpiration": null, + "scmsRestriction": 2, + "agcAndColorStripeRestriction": null, + "explicitAnalogTelevisionOutputRestriction": null, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": true, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed", + "uncompressedDigitalVideoOpl": null, + "compressedDigitalVideoOpl": null, + "analogVideoOpl": null, + "compressedDigitalAudioOpl": null, + "uncompressedDigitalAudioOpl": null + }, + "licenseType": "Persistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "UltraVioletDownload" + } + ], + "responseCustomData": null + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2018-03-07T18:49:20.94Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "9f60df33-124b-4590-94c8-f00d92107187", + "name": "ArmPolicyOptionName", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": true, + "beginDate": "2017-10-16T18:22:53.46Z", + "expirationDate": null, + "relativeBeginDate": null, + "relativeExpirationDate": null, + "gracePeriod": null, + "playRight": { + "firstPlayExpiration": null, + "scmsRestriction": 2, + "agcAndColorStripeRestriction": null, + "explicitAnalogTelevisionOutputRestriction": null, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": true, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed", + "uncompressedDigitalVideoOpl": null, + "compressedDigitalVideoOpl": null, + "analogVideoOpl": null, + "compressedDigitalAudioOpl": null, + "uncompressedDigitalAudioOpl": null + }, + "licenseType": "Persistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "UltraVioletDownload" + } + ], + "responseCustomData": null + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-create-widevine-token.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-create-widevine-token.json new file mode 100644 index 000000000000..a749d7e2a053 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-create-widevine-token.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithWidevineOptionAndJwtTokenRestriction", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "description": "ArmPolicyDescription", + "options": [ + { + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "exponent": "AQAB", + "modulus": "AQAD" + }, + "alternateVerificationKeys": [ + { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAAAAAAAAAAAAAAAAAAAAA==" + } + ], + "restrictionTokenType": "Jwt" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithWidevineOptionAndJwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithWidevineOptionAndJwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "f5f2f742-e073-4a7a-8663-09ffdad9d2c0", + "created": "2018-03-07T18:49:21.007Z", + "lastModified": "2018-03-07T18:49:21.007Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "56af71e4-6e97-4588-a162-bad1f5b03074", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "exponent": "", + "modulus": "" + }, + "alternateVerificationKeys": [ + { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + } + ], + "requiredClaims": [], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyWithWidevineOptionAndJwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithWidevineOptionAndJwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "f5f2f742-e073-4a7a-8663-09ffdad9d2c0", + "created": "2018-03-07T18:49:21.007Z", + "lastModified": "2018-03-07T18:49:21.007Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "56af71e4-6e97-4588-a162-bad1f5b03074", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "exponent": "", + "modulus": "" + }, + "alternateVerificationKeys": [ + { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + } + ], + "requiredClaims": [], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-delete.json new file mode 100644 index 000000000000..7a56da4ed983 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-get-by-name.json new file mode 100644 index 000000000000..006e7ff3d0a5 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-get-by-name.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithMultipleOptions", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-get-with-secrets.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-get-with-secrets.json new file mode 100644 index 000000000000..3f71f2d56986 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-get-with-secrets.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithMultipleOptions", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAA=" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-list-all.json new file mode 100644 index 000000000000..3a77fb2f317e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-list-all.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "PolicyWithClearKeyOptionAndTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "8352435b-ebea-4681-aae7-e19277771f64", + "created": "2017-12-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "description": "A policy with one ClearKey option and Open Restriction.", + "options": [ + { + "policyOptionId": "a3448d09-567a-4642-8309-d17e846be59f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + } + ] + } + }, + { + "name": "PolicyWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "description": "A policy with one PlayReady option and Open Restriction.", + "options": [ + { + "policyOptionId": "294a833f-f128-48be-9edf-8d1bb5b35ff3", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": false, + "beginDate": null, + "expirationDate": null, + "relativeBeginDate": null, + "relativeExpirationDate": null, + "gracePeriod": null, + "playRight": { + "firstPlayExpiration": null, + "scmsRestriction": null, + "agcAndColorStripeRestriction": null, + "explicitAnalogTelevisionOutputRestriction": null, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": false, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed", + "uncompressedDigitalVideoOpl": null, + "compressedDigitalVideoOpl": null, + "analogVideoOpl": null, + "compressedDigitalAudioOpl": null, + "uncompressedDigitalAudioOpl": null + }, + "licenseType": "NonPersistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "Unspecified" + } + ], + "responseCustomData": "testCustomData" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-list-by-lastModified.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-list-by-lastModified.json new file mode 100644 index 000000000000..d5f52a4a9601 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-list-by-lastModified.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-06-01-preview", + "$orderby": "properties/lastModified" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "description": "A policy with one PlayReady option and Open Restriction.", + "options": [ + { + "policyOptionId": "294a833f-f128-48be-9edf-8d1bb5b35ff3", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": false, + "beginDate": null, + "expirationDate": null, + "relativeBeginDate": null, + "relativeExpirationDate": null, + "gracePeriod": null, + "playRight": { + "firstPlayExpiration": null, + "scmsRestriction": null, + "agcAndColorStripeRestriction": null, + "explicitAnalogTelevisionOutputRestriction": null, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": false, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed", + "uncompressedDigitalVideoOpl": null, + "compressedDigitalVideoOpl": null, + "analogVideoOpl": null, + "compressedDigitalAudioOpl": null, + "uncompressedDigitalAudioOpl": null + }, + "licenseType": "NonPersistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "Unspecified" + } + ], + "responseCustomData": "testCustomData" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + { + "name": "PolicyWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + { + "name": "PolicyWithClearKeyOptionAndTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "8352435b-ebea-4681-aae7-e19277771f64", + "created": "2017-12-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "description": "A policy with one ClearKey option and Open Restriction.", + "options": [ + { + "policyOptionId": "a3448d09-567a-4642-8309-d17e846be59f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-list-in-date-range.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-list-in-date-range.json new file mode 100644 index 000000000000..a06a45cfa1f3 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-list-in-date-range.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-06-01-preview", + "$filter": "properties/lastModified gt 2016-06-01 and properties/created lt 2013-07-01" + }, + "responses": { + "200": { + "body": { + "value": [] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-update.json new file mode 100644 index 000000000000..4c46b1735b58 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/content-key-policies-update.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "description": "Updated Policy", + "options": [ + { + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithClearKeyOptionAndTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "8352435b-ebea-4681-aae7-e19277771f64", + "created": "2017-12-01T00:00:00Z", + "lastModified": "2018-03-07T18:49:21.33Z", + "description": "Updated Policy", + "options": [ + { + "policyOptionId": "50159d89-f0ce-4ec2-80e5-86ee54dba014", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-cancel.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-cancel.json new file mode 100644 index 000000000000..7a80feb79c4b --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-cancel.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "ExampleTransform", + "jobName": "job1" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-create.json new file mode 100644 index 000000000000..43b43b964fb1 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-create.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "ExampleTransform", + "jobName": "job1", + "parameters": { + "properties": { + "input": { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "assetName": "job1-InputAsset" + }, + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "assetName": "job1-OutputAsset" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/ExampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2018-05-31T21:08:32.3513266Z", + "state": "Queued", + "description": null, + "input": { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "label": null, + "files": [], + "assetName": "job1-InputAsset" + }, + "lastModified": "2018-05-31T21:08:32.3513266Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "error": null, + "state": "Queued", + "progress": 0, + "assetName": "job1-OutputAsset" + } + ], + "priority": "Normal", + "correlationData": {} + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-delete.json new file mode 100644 index 000000000000..3abfca49aa8e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "ExampleTransform", + "jobName": "jobToDelete" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-get-by-name.json new file mode 100644 index 000000000000..c9685745227e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-get-by-name.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "ExampleTransform", + "jobName": "job1" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/ExampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2018-05-31T21:08:32.3153342Z", + "state": "Queued", + "description": null, + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "label": null, + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "label": null, + "files": [], + "assetName": "job1 input" + } + ] + }, + "lastModified": "2018-05-31T21:08:32.3153342Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "error": null, + "state": "Queued", + "progress": 0, + "assetName": "job1 output" + } + ], + "priority": "Low", + "correlationData": {} + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-list-all.json new file mode 100644 index 000000000000..62c223520a2c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/jobs-list-all.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "ExampleTransform" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/ExampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2018-05-31T21:08:32.1913235Z", + "state": "Queued", + "description": null, + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "label": null, + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "label": null, + "files": [], + "assetName": "job1 input" + } + ] + }, + "lastModified": "2018-05-31T21:08:32.1913235Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "error": null, + "state": "Queued", + "progress": 0, + "assetName": "job1 output" + } + ], + "priority": "Low", + "correlationData": {} + } + }, + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/ExampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2018-05-31T21:08:32.1933236Z", + "state": "Processing", + "description": null, + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "label": null, + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "label": null, + "files": [], + "assetName": "job2 input" + } + ] + }, + "lastModified": "2018-05-31T21:08:32.1933236Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "error": null, + "state": "Processing", + "progress": 50, + "assetName": "job2 output" + } + ], + "priority": "Low", + "correlationData": {} + } + }, + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/ExampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2018-05-31T21:08:32.1943231Z", + "state": "Finished", + "description": null, + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "label": null, + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "label": null, + "files": [], + "assetName": "job3 input" + } + ] + }, + "lastModified": "2018-05-31T21:08:32.1943231Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "error": null, + "state": "Finished", + "progress": 100, + "assetName": "job3 output" + } + ], + "priority": "Low", + "correlationData": {} + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-create.json new file mode 100644 index 000000000000..2ecef28601e3 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-create.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-06-01-preview", + "parameters": { + "id": "nb:chid:UUID:00000001-2000-0000-0000-000000000000", + "name": "myLiveEvent1", + "location": "West US", + "type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "input": { + "streamingProtocol": "RTMP", + "keyFrameIntervalDuration": "PT2S" + }, + "preview": { + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0" + } + ] + } + } + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "resourceState": "Stopped", + "provisioningState": "InProgress", + "created": "2018-03-03T02:25:06.0982751Z", + "lastModified": "2018-03-03T02:25:06.0982751Z", + "vanityUrl": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "0abf356884d74b4aacbd7b1ebd3da0f7", + "endpoints": [] + }, + "preview": { + "previewLocator": "c91726b4-880c-4090-94aa-e6ddb1384b37", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": null + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": null, + "crossDomainPolicy": null + } + } + } + }, + "200": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "resourceState": "Stopped", + "provisioningState": "InProgress", + "created": "2018-03-03T02:25:06.0982751Z", + "lastModified": "2018-03-03T02:25:06.0982751Z", + "vanityUrl": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "0abf356884d74b4aacbd7b1ebd3da0f7", + "endpoints": [] + }, + "preview": { + "previewLocator": "c91726b4-880c-4090-94aa-e6ddb1384b37", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": null + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": null, + "crossDomainPolicy": null + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-delete.json new file mode 100644 index 000000000000..4fa2565c2920 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-delete.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-06-01-preview", + "parameters": { + "Id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "Name": "myLiveEvent1", + "Type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents", + "Location": "West US", + "Tags": { + "DynamicProperties": { + "tag1": "value1", + "tag2": "value2" + } + }, + "Properties": { + "Description": "test event updated", + "Input": { + "StreamingProtocol": "FragmentedMP4", + "KeyFrameIntervalDuration": "PT6S", + "Endpoints": [], + "AccessToken": null + }, + "Preview": { + "Endpoints": [], + "AccessControl": { + "IP": { + "Allow": [ + { + "Name": "AllowOne", + "Address": "192.1.1.0", + "SubnetPrefixLength": null + } + ] + } + }, + "PreviewLocator": null, + "StreamingPolicyName": null + }, + "Encoding": { + "EncodingType": "None", + "PresetName": null + }, + "ProvisioningState": null, + "ResourceState": "Stopped", + "CrossSiteAccessPolicies": null, + "VanityUrl": false, + "StreamOptions": [], + "Created": "2018-03-02T18:25:07.5748853-08:00", + "LastModified": "2018-03-02T18:25:07.5748853-08:00" + } + } + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-list-all.json new file mode 100644 index 000000000000..54d4d9242136 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-list-all.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "resourceState": "Stopped", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:08.5564064Z", + "lastModified": "2018-03-03T02:25:08.5564064Z", + "vanityUrl": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "de153bb0814542d9b7e2339ce9430dc4", + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "http://clouddeployment.media-test.net/de153bb0814542d9b7e2339ce9430dc4/ingest.isml" + } + ] + }, + "preview": { + "previewLocator": "a220e223-faf8-4e03-b9a9-2c2432f48025", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": null + } + ] + } + }, + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "https://myliveevent1-slitestmedia10.preview-usso.channel.mediaservices.windows.net/a220e223-faf8-4e03-b9a9-2c2432f48025/preview.ism/manifest" + } + ] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": null, + "crossDomainPolicy": null + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-list-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-list-by-name.json new file mode 100644 index 000000000000..52d683ac3c20 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-list-by-name.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-06-01-preview" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": {}, + "properties": { + "description": "", + "resourceState": "Stopped", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:08.3474032Z", + "lastModified": "2018-03-03T02:25:08.3474032Z", + "vanityUrl": false, + "streamOptions": [ + "Default" + ], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": null, + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "http://clouddeployment.media-test.net/ingest.isml" + } + ] + }, + "preview": { + "previewLocator": "763f3ea4-d94f-441c-a634-c833f61a4e04", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + }, + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "https://testeventopito4idh2r-weibzmedia05.preview-ts051.channel.media-test.windows-int.net/763f3ea4-d94f-441c-a634-c833f61a4e04/preview.ism/manifest" + } + ] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": "", + "crossDomainPolicy": "" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-reset.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-reset.json new file mode 100644 index 000000000000..03df7fcc6963 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-reset.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-06-01-preview" + }, + "responses": { + "202": {}, + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-start.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-start.json new file mode 100644 index 000000000000..03df7fcc6963 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-start.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-06-01-preview" + }, + "responses": { + "202": {}, + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-stop.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-stop.json new file mode 100644 index 000000000000..7d4f7edbb688 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-stop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-06-01-preview", + "parameters": { + "removeOutputsOnStop": false + } + }, + "responses": { + "202": {}, + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-update.json new file mode 100644 index 000000000000..516aa9233361 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveevent-update.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-06-01-preview", + "parameters": { + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "name": "myLiveEvent1", + "location": "West US", + "type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "properties": { + "description": "test event updated", + "input": { + "streamingProtocol": "FragmentedMP4", + "keyFrameIntervalDuration": "PT6S" + }, + "preview": { + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0" + } + ] + } + } + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "properties": { + "description": "test event updated", + "resourceState": "Running", + "provisioningState": "InProgress", + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z", + "vanityUrl": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "c638baac3195406a84d7ff3bcba8bde4", + "endpoints": [] + }, + "preview": { + "previewLocator": "c10ea3fc-587f-4daf-b2b2-fa8f647a9ed2", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0", + "subnetPrefixLength": null + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + } + } + } + }, + "200": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "properties": { + "description": "test event updated", + "resourceState": "Running", + "provisioningState": "InProgress", + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z", + "vanityUrl": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "c638baac3195406a84d7ff3bcba8bde4", + "endpoints": [] + }, + "preview": { + "previewLocator": "c10ea3fc-587f-4daf-b2b2-fa8f647a9ed2", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0", + "subnetPrefixLength": null + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveoutput-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveoutput-create.json new file mode 100644 index 000000000000..b9ddd9ceec43 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveoutput-create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "liveOutputName": "myLiveOutput1", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "description": "test live output 1", + "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212", + "archiveWindowLength": "PT5M", + "manifestName": "testmanifest", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myLiveOutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": "test live output 1", + "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212", + "archiveWindowLength": "PT5M", + "manifestName": "testmanifest", + "outputSnapTime": 0, + "resourceState": "Creating", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:09.9431835Z", + "lastModified": "2018-03-03T02:25:09.9431835Z", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + }, + "202": { + "body": { + "name": "myLiveOutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": "test live output 1", + "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212", + "archiveWindowLength": "PT5M", + "manifestName": "testmanifest", + "outputSnapTime": 0, + "resourceState": "Creating", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:09.9431835Z", + "lastModified": "2018-03-03T02:25:09.9431835Z", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveoutput-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveoutput-delete.json new file mode 100644 index 000000000000..d95aec17f1b5 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveoutput-delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "liveOutputName": "myLiveOutput1", + "api-version": "2018-06-01-preview" + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveoutput-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveoutput-list-all.json new file mode 100644 index 000000000000..36db1ae31638 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveoutput-list-all.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "liveoutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": null, + "assetName": "95dafce4-5320-464c-8597-909373854119", + "archiveWindowLength": "PT30S", + "manifestName": "c3a23d4b-02a6-4937-a1ad-6416f463fdca", + "outputSnapTime": 0, + "resourceState": "Running", + "provisioningState": "Succeeded", + "created": "0001-01-01T00:00:00-08:00", + "lastModified": "0001-01-01T00:00:00-08:00", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveoutput-list-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveoutput-list-by-name.json new file mode 100644 index 000000000000..0f2f40e1f579 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/liveoutput-list-by-name.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "liveOutputName": "myLiveOutput1", + "api-version": "2018-06-01-preview" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "myLiveOutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": null, + "assetName": "cb2ae0bc-677a-4830-9c8e-06ce4c4cb607", + "archiveWindowLength": "PT30S", + "manifestName": "fc7096f5-c488-4b86-8302-f3bfde53fc27", + "outputSnapTime": 0, + "resourceState": "Running", + "provisioningState": "Succeeded", + "created": "0001-01-01T00:00:00-08:00", + "lastModified": "0001-01-01T00:00:00-08:00", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/operations-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/operations-list-all.json new file mode 100644 index 000000000000..26e68293f502 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/operations-list-all.json @@ -0,0 +1,501 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Media/register/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Microsoft Media Services", + "operation": "Registers the Media Services Resource Provider", + "description": "Registers the subscription for the Media Services resource provider and enables the creation of Media Services accounts" + } + }, + { + "name": "Microsoft.Media/unregister/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Microsoft Media Services", + "operation": "Unregisters the Media Services Resource Provider", + "description": "Unregisters the subscription for the Media Services resource provider" + } + }, + { + "name": "Microsoft.Media/checknameavailability/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Microsoft Media Services", + "operation": "Check Name Availability", + "description": "Checks if a Media Services account name is available" + } + }, + { + "name": "Microsoft.Media/operations/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Available Operations", + "operation": "Get Available Operations", + "description": "Get Available Operations" + } + }, + { + "name": "Microsoft.Media/mediaservices/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Read Media Services Account", + "description": "Read any Media Services Account" + } + }, + { + "name": "Microsoft.Media/mediaservices/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Create or Update Media Services Account", + "description": "Create or Update any Media Services Account" + } + }, + { + "name": "Microsoft.Media/mediaservices/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Delete Media Services Account", + "description": "Delete any Media Services Account" + } + }, + { + "name": "Microsoft.Media/mediaservices/syncStorageKeys/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Synchronize Storage Keys", + "description": "Synchronize the Storage Keys for an attached Azure Storage account" + } + }, + { + "name": "Microsoft.Media/mediaservices/eventGridFilters/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Event Grid Filter", + "operation": "Read Event Grid Filter", + "description": "Read any Event Grid Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/eventGridFilters/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Event Grid Filter", + "operation": "Create or Update Event Grid Filter", + "description": "Create or Update any Event Grid Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/eventGridFilters/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Event Grid Filter", + "operation": "Delete Event Grid Filter", + "description": "Delete any Event Grid Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Read Asset", + "description": "Read any Asset" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Create or Update Asset", + "description": "Create or Update any Asset" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Delete Asset", + "description": "Delete any Asset" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/listContainerSas/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "List Asset Container SAS URLs", + "description": "List Asset Container SAS URLs" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/getEncryptionKey/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Get Asset Encryption Key", + "description": "Get Asset Encryption Key" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingPolicies/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Policy", + "operation": "Read Streaming Policy", + "description": "Read any Streaming Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingPolicies/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Policy", + "operation": "Create or Update Streaming Policy", + "description": "Create or Update any Streaming Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingPolicies/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Policy", + "operation": "Delete Streaming Policy", + "description": "Delete any Streaming Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "Read Streaming Locator", + "description": "Read any Streaming Locator" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "Create or Update Streaming Locator", + "description": "Create or Update any Streaming Locator" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "Delete Streaming Locator", + "description": "Delete any Streaming Locator" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/listContentKeys/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "List Content Keys", + "description": "List Content Keys" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/listPaths/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "List Paths", + "description": "List Paths" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Read Content Key Policy", + "description": "Read any Content Key Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Create or Update Content Key Policy", + "description": "Create or Update any Content Key Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Delete Content Key Policy", + "description": "Delete any Content Key Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/getPolicyPropertiesWithSecrets/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Get Policy Properties With Secrets", + "description": "Get Policy Properties With Secrets" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Transform", + "operation": "Read Transform", + "description": "Read any Transform" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Transform", + "operation": "Create or Update Transform", + "description": "Create or Update any Transform" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Transform", + "operation": "Delete Transform", + "description": "Delete any Transform" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Read Job", + "description": "Read any Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Create or Update Job", + "description": "Create or Update any Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Delete Job", + "description": "Delete any Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/cancelJob/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Cancel Job", + "description": "Cancel Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Read Streaming Endpoint", + "description": "Read any Streaming Endpoint" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Create or Update Streaming Endpoint", + "description": "Create or Update any Streaming Endpoint" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Delete Streaming Endpoint", + "description": "Delete any Streaming Endpoint" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/start/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Start Streaming Endpoint Operation", + "description": "Start any Streaming Endpoint Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/stop/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Stop Streaming Endpoint Operation", + "description": "Stop any Streaming Endpoint Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/scale/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Scale Streaming Endpoint Operation", + "description": "Scale any Streaming Endpoint Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Read Live Event", + "description": "Read any Live Event" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Create or Update Live Event", + "description": "Create or Update any Live Event" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Delete Live Event", + "description": "Delete any Live Event" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/start/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Start Live Event Operation", + "description": "Start any Live Event Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/stop/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Stop Live Event Operation", + "description": "Stop any Live Event Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/reset/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Reset Live Event Operation", + "description": "Reset any Live Event Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/liveOutputs/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Output", + "operation": "Read Live Output", + "description": "Read any Live Output" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/liveOutputs/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Output", + "operation": "Create or Update Live Output", + "description": "Create or Update any Live Output" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/liveOutputs/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Output", + "operation": "Delete Live Output", + "description": "Delete any Live Output" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpointOperations/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint Operation", + "operation": "Read Streaming Endpoint Operation", + "description": "Read any Streaming Endpoint Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEventOperations/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event Operation", + "operation": "Read Live Event Operation", + "description": "Read any Live Event Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveOutputOperations/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Output Operation", + "operation": "Read Live Output Operation", + "description": "Read any Live Output Operation" + } + }, + { + "name": "Microsoft.Media/locations/checkNameAvailability/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Microsoft Media Services", + "operation": "Check Name Availability", + "description": "Checks if a Media Services account name is available" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-create-clear.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-create-clear.json new file mode 100644 index 000000000000..0e11d877520b --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-create-clear.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "UserCreatedClearStreamingLocator", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "StreamingPolicyName": "clearStreamingPolicy", + "AssetName": "ClimbingMountRainier" + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedClearStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedClearStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-05-31T21:08:50.3245738Z", + "startTime": null, + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "05f25fe8-d945-46b5-927e-6d25f2ee6c44", + "streamingPolicyName": "clearStreamingPolicy", + "defaultContentKeyPolicyName": null, + "contentKeys": [], + "alternativeMediaId": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-create-secure-userDefinedContentKeys.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-create-secure-userDefinedContentKeys.json new file mode 100644 index 000000000000..3cbab7cf9583 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-create-secure-userDefinedContentKeys.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "assetName": "ClimbingMountRainier", + "streamingPolicyName": "secureStreamingPolicy", + "StreamingLocatorId": "90000000-0000-0000-0000-00000000000A", + "ContentKeys": [ + { + "Label": "aesDefaultKey", + "Id": "60000000-0000-0000-0000-000000000001", + "Value": "1UqLohAfWsEGkULYxHjYZg==" + }, + { + "Label": "cencDefaultKey", + "Id": "60000000-0000-0000-0000-000000000004", + "Value": "4UqLohAfWsEGkULYxHjYZg==" + }, + { + "Label": "cbcsDefaultKey", + "Id": "60000000-0000-0000-0000-000000000007", + "Value": "7UqLohAfWsEGkULYxHjYZg==" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-05-31T21:08:50.4586288Z", + "startTime": null, + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "90000000-0000-0000-0000-00000000000a", + "streamingPolicyName": "secureStreamingPolicy", + "defaultContentKeyPolicyName": null, + "contentKeys": [ + { + "id": "60000000-0000-0000-0000-000000000007", + "type": "CommonEncryptionCbcs", + "label": "cbcsDefaultKey", + "value": null, + "policyName": null, + "tracks": [] + }, + { + "id": "60000000-0000-0000-0000-000000000004", + "type": "CommonEncryptionCenc", + "label": "cencDefaultKey", + "value": null, + "policyName": null, + "tracks": [] + }, + { + "id": "60000000-0000-0000-0000-000000000001", + "type": "EnvelopeEncryption", + "label": "aesDefaultKey", + "value": null, + "policyName": null, + "tracks": [] + } + ], + "alternativeMediaId": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-create-secure.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-create-secure.json new file mode 100644 index 000000000000..c98cae2f9386 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-create-secure.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "UserCreatedSecureStreamingLocator", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "StreamingPolicyName": "secureStreamingPolicy", + "AssetName": "ClimbingMountRainier", + "StartTime": "2018-03-01T00:00:00Z", + "EndTime": "2028-12-31T23:59:59.9999999Z" + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedSecureStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-05-31T21:08:50.3885741Z", + "startTime": "2018-03-01T00:00:00Z", + "endTime": "2028-12-31T23:59:59.9999999Z", + "streamingLocatorId": "436213ed-b205-4635-9218-faae77e95802", + "streamingPolicyName": "secureStreamingPolicy", + "defaultContentKeyPolicyName": null, + "contentKeys": [ + { + "id": "453cf220-04c6-4996-9355-199630850c6c", + "type": "CommonEncryptionCbcs", + "label": "cbcsDefaultKey", + "value": null, + "policyName": null, + "tracks": [] + }, + { + "id": "a8e02c6e-442c-47f3-bf28-ce892ecbefdb", + "type": "CommonEncryptionCenc", + "label": "cencDefaultKey", + "value": null, + "policyName": null, + "tracks": [] + }, + { + "id": "cfff3213-8ced-443d-bf2e-888b5cf4c1d8", + "type": "EnvelopeEncryption", + "label": "aesDefaultKey", + "value": null, + "policyName": null, + "tracks": [] + } + ], + "alternativeMediaId": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-delete.json new file mode 100644 index 000000000000..103ee8162976 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "clearStreamingLocator", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-get-by-name.json new file mode 100644 index 000000000000..7cf317734fa0 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-get-by-name.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "clearStreamingLocator", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "clearStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/clearStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-05-31T21:08:50.2245724Z", + "startTime": null, + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "0f3ab7d6-7f68-4e19-8bfe-2a132627969a", + "streamingPolicyName": "clearStreamingPolicy", + "defaultContentKeyPolicyName": null, + "contentKeys": [], + "alternativeMediaId": null + } + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-list-content-keys.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-list-content-keys.json new file mode 100644 index 000000000000..3cea4f5a0e46 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-list-content-keys.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "secureStreamingLocator", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "contentKeys": [ + { + "id": "b005b37f-3fbc-4c1f-87a9-36cea4098ab8", + "type": "EnvelopeEncryption", + "label": "aesDefaultKey", + "value": "4ucbVJ+zAhPqG2YEOEt7Fg==", + "policyName": "PolicyWithMultipleOptions", + "tracks": [] + }, + { + "id": "aa2bb110-5b5d-4cd8-a58f-d33ddd8531e5", + "type": "CommonEncryptionCenc", + "label": "cencDefaultKey", + "value": "PC9D2B6XMccrr32Cuurh4A==", + "policyName": "PolicyWithMultipleOptions", + "tracks": [] + }, + { + "id": "6104fdb7-03ab-4d35-bb62-2215a8ddce2d", + "type": "CommonEncryptionCbcs", + "label": "cbcsDefaultKey", + "value": "9gloyO4Wo/7TWrWeOkjKGQ==", + "policyName": "PolicyWithMultipleOptions", + "tracks": [] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-list-paths-streaming-and-download.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-list-paths-streaming-and-download.json new file mode 100644 index 000000000000..e3ce4ad16047 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-list-paths-streaming-and-download.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "clearStreamingLocator", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "streamingPaths": [ + { + "streamingProtocol": "Hls", + "encryptionScheme": "NoEncryption", + "paths": [ + "/3e4570a3-977a-432e-87bf-57bf505e400e/videoManifest1.ism/manifest(format=m3u8-aapl)", + "/3e4570a3-977a-432e-87bf-57bf505e400e/videoManifest2.ism/manifest(format=m3u8-aapl)", + "/3e4570a3-977a-432e-87bf-57bf505e400e/videoManifest3.ism/manifest(format=m3u8-aapl)" + ] + }, + { + "streamingProtocol": "Dash", + "encryptionScheme": "NoEncryption", + "paths": [ + "/3e4570a3-977a-432e-87bf-57bf505e400e/videoManifest1.ism/manifest(format=mpd-time-csf)", + "/3e4570a3-977a-432e-87bf-57bf505e400e/videoManifest2.ism/manifest(format=mpd-time-csf)", + "/3e4570a3-977a-432e-87bf-57bf505e400e/videoManifest3.ism/manifest(format=mpd-time-csf)" + ] + }, + { + "streamingProtocol": "SmoothStreaming", + "encryptionScheme": "NoEncryption", + "paths": [ + "/3e4570a3-977a-432e-87bf-57bf505e400e/videoManifest1.ism/manifest", + "/3e4570a3-977a-432e-87bf-57bf505e400e/videoManifest2.ism/manifest", + "/3e4570a3-977a-432e-87bf-57bf505e400e/videoManifest3.ism/manifest" + ] + } + ], + "downloadPaths": [ + "/3e4570a3-977a-432e-87bf-57bf505e400e/textTrack.vtt", + "/3e4570a3-977a-432e-87bf-57bf505e400e/video1.mp4", + "/3e4570a3-977a-432e-87bf-57bf505e400e/video2.mp4", + "/3e4570a3-977a-432e-87bf-57bf505e400e/video3.mp4" + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-list-paths-streaming-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-list-paths-streaming-only.json new file mode 100644 index 000000000000..e598f984f93d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-list-paths-streaming-only.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "secureStreamingLocator", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "streamingPaths": [ + { + "streamingProtocol": "Hls", + "encryptionScheme": "EnvelopeEncryption", + "paths": [ + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest1.ism/manifest(format=m3u8-aapl,encryption=cbc)", + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest2.ism/manifest(format=m3u8-aapl,encryption=cbc)", + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest3.ism/manifest(format=m3u8-aapl,encryption=cbc)" + ] + }, + { + "streamingProtocol": "Dash", + "encryptionScheme": "EnvelopeEncryption", + "paths": [ + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest1.ism/manifest(format=mpd-time-csf,encryption=cbc)", + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest2.ism/manifest(format=mpd-time-csf,encryption=cbc)", + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest3.ism/manifest(format=mpd-time-csf,encryption=cbc)" + ] + }, + { + "streamingProtocol": "SmoothStreaming", + "encryptionScheme": "EnvelopeEncryption", + "paths": [ + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest1.ism/manifest(encryption=cbc)", + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest2.ism/manifest(encryption=cbc)", + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest3.ism/manifest(encryption=cbc)" + ] + }, + { + "streamingProtocol": "Dash", + "encryptionScheme": "CommonEncryptionCenc", + "paths": [ + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest1.ism/manifest(format=mpd-time-csf,encryption=cenc)", + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest2.ism/manifest(format=mpd-time-csf,encryption=cenc)", + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest3.ism/manifest(format=mpd-time-csf,encryption=cenc)" + ] + }, + { + "streamingProtocol": "SmoothStreaming", + "encryptionScheme": "CommonEncryptionCenc", + "paths": [ + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest1.ism/manifest(encryption=cenc)", + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest2.ism/manifest(encryption=cenc)", + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest3.ism/manifest(encryption=cenc)" + ] + }, + { + "streamingProtocol": "Hls", + "encryptionScheme": "CommonEncryptionCbcs", + "paths": [ + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest1.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)", + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest2.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)", + "/75177b56-66c4-4043-9ec9-37c325e5fd6c/videoManifest3.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)" + ] + } + ], + "downloadPaths": [] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-list.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-list.json new file mode 100644 index 000000000000..3fe5359b9a4d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-locators-list.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "clearStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/clearStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-05-31T21:08:50.153589Z", + "startTime": null, + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "8f6c2c3b-1650-4771-af9f-79312e6b2ded", + "streamingPolicyName": "clearStreamingPolicy", + "defaultContentKeyPolicyName": null, + "contentKeys": [], + "alternativeMediaId": null + } + }, + { + "name": "secureStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/secureStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-05-31T21:08:50.1715732Z", + "startTime": null, + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "1b4ba7ed-c100-40aa-8722-a86839c9f887", + "streamingPolicyName": "secureStreamingPolicy", + "defaultContentKeyPolicyName": null, + "contentKeys": [], + "alternativeMediaId": null + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-clear.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-clear.json new file mode 100644 index 000000000000..3abecb479631 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-clear.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedClearStreamingPolicy", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedClearStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedClearStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-05-31T21:08:49.8305711Z", + "defaultContentKeyPolicyName": null, + "envelopeEncryption": null, + "commonEncryptionCenc": null, + "commonEncryptionCbcs": null, + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-commonEncryptionCbcs-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-commonEncryptionCbcs-only.json new file mode 100644 index 000000000000..d15e58b288eb --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-commonEncryptionCbcs-only.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCbcsOnly", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + } + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCbcsOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicyWithCommonEncryptionCbcsOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-05-31T21:08:50.0065803Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": null, + "commonEncryptionCenc": null, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + }, + "playReady": null, + "widevine": null + } + }, + "noEncryption": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-commonEncryptionCenc-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-commonEncryptionCenc-only.json new file mode 100644 index 000000000000..f874620125b1 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-commonEncryptionCenc-only.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCencOnly", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + } + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCencOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicyWithCommonEncryptionCencOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-05-31T21:08:49.9556087Z", + "defaultContentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "envelopeEncryption": null, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + }, + "commonEncryptionCbcs": null, + "noEncryption": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-envelopeEncryption-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-envelopeEncryption-only.json new file mode 100644 index 000000000000..b300ca3fe7a6 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-envelopeEncryption-only.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicyWithEnvelopeEncryptionOnly", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "envelopeEncryption": { + "enabledProtocols": { + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + } + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicyWithEnvelopeEncryptionOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicyWithEnvelopeEncryptionOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-03-07T18:49:21.8642989Z", + "defaultContentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + }, + "commonEncryptionCenc": null, + "commonEncryptionCbcs": null, + "noEncryption": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-secure-streaming.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-secure-streaming.json new file mode 100644 index 000000000000..adab37a61e20 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-create-secure-streaming.json @@ -0,0 +1,170 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicy", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + } + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + }, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + } + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId}" + } + } + }, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + } + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-03-07T18:49:22.0443025Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + }, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId}" + } + } + }, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + }, + "playReady": null, + "widevine": null + } + }, + "noEncryption": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-delete.json new file mode 100644 index 000000000000..8fc0c1a0349a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "secureStreamingPolicyWithCommonEncryptionCbcsOnly", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-list.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-list.json new file mode 100644 index 000000000000..64d265289d93 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policies-list.json @@ -0,0 +1,235 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "clearStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/clearStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-05-31T21:08:49.6326323Z", + "defaultContentKeyPolicyName": null, + "envelopeEncryption": null, + "commonEncryptionCenc": null, + "commonEncryptionCbcs": null, + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + }, + { + "name": "secureStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-05-31T21:08:49.6345711Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "customKeyAcquisitionUrlTemplate": null + }, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Unknown", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + }, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + }, + "playReady": null, + "widevine": null + } + }, + "noEncryption": null + } + }, + { + "name": "secureStreamingPolicyWithCommonEncryptionCbcsOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithCommonEncryptionCbcsOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-05-31T21:08:49.6395697Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": null, + "commonEncryptionCenc": null, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + }, + "playReady": null, + "widevine": null + } + }, + "noEncryption": null + } + }, + { + "name": "secureStreamingPolicyWithCommonEncryptionCencOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithCommonEncryptionCencOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-05-31T21:08:49.6375711Z", + "defaultContentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "envelopeEncryption": null, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Unknown", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + }, + "commonEncryptionCbcs": null, + "noEncryption": null + } + }, + { + "name": "secureStreamingPolicyWithEnvelopeEncryptionOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithEnvelopeEncryptionOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-05-31T21:08:49.6355747Z", + "defaultContentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey", + "policyName": null + }, + "keyToTrackMappings": [] + }, + "customKeyAcquisitionUrlTemplate": null + }, + "commonEncryptionCenc": null, + "commonEncryptionCbcs": null, + "noEncryption": null + } + } + ], + "@odata.nextLink": "http://server/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaServices/contosomedia/streamingPolicies?api-version=2018-06-01-preview&$skiptoken=secureStreamingPolicyWithEnvelopeEncryptionOnly" + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policy-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policy-get-by-name.json new file mode 100644 index 000000000000..b90bdad10ff2 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streaming-policy-get-by-name.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "clearStreamingPolicy", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "clearStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/clearStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-05-31T21:08:49.7205706Z", + "defaultContentKeyPolicyName": null, + "envelopeEncryption": null, + "commonEncryptionCenc": null, + "commonEncryptionCbcs": null, + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-create.json new file mode 100644 index 000000000000..d336524c9417 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-create.json @@ -0,0 +1,157 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2018-06-01-preview", + "parameters": { + "id": null, + "name": "myStreamingEndpoint1", + "location": "West US", + "type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "accessControl": { + "akamai": { + "akamaiSignatureHeaderAuthenticationKeyList": [ + { + "identifier": "id1", + "expiration": "2029-12-31T16:00:00-08:00", + "base64Key": "dGVzdGlkMQ==" + }, + { + "identifier": "id2", + "expiration": "2030-12-31T16:00:00-08:00", + "base64Key": "dGVzdGlkMQ==" + } + ] + }, + "ip": { + "allow": [ + { + "name": "AllowedIp", + "address": "192.168.1.1" + } + ] + } + }, + "cdnEnabled": false + } + } + }, + "responses": { + "202": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "accessControl": { + "akamai": { + "akamaiSignatureHeaderAuthenticationKeyList": [ + { + "identifier": "id1", + "expiration": "2030-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + }, + { + "identifier": "id2", + "expiration": "2031-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + } + ] + }, + "ip": { + "allow": [ + { + "name": "AllowedIp", + "address": "192.168.1.1", + "subnetPrefixLength": null + } + ] + } + }, + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T00:00:00-08:00", + "provisioningState": "InProgress", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.7561389Z", + "lastModified": "2018-03-03T02:25:09.7561389Z" + } + } + }, + "200": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "accessControl": { + "akamai": { + "akamaiSignatureHeaderAuthenticationKeyList": [ + { + "identifier": "id1", + "expiration": "2030-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + }, + { + "identifier": "id2", + "expiration": "2031-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + } + ] + }, + "ip": { + "allow": [ + { + "name": "AllowedIp", + "address": "192.168.1.1", + "subnetPrefixLength": null + } + ] + } + }, + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T00:00:00-08:00", + "provisioningState": "InProgress", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.7561389Z", + "lastModified": "2018-03-03T02:25:09.7561389Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-delete.json new file mode 100644 index 000000000000..fc2f1ee3d946 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-delete.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2018-06-01-preview", + "parameters": { + "Id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "Name": "myStreamingEndpoint1", + "Type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints", + "Location": "West US", + "Tags": { + "DynamicProperties": { + "tag1": "value1", + "tag2": "value2" + } + }, + "Properties": { + "Description": "test event 1", + "ScaleUnits": 1, + "AccessControl": null, + "AvailabilitySetName": "availableset", + "MaxCacheAge": null, + "CrossSiteAccessPolicies": null, + "CustomHostNames": [], + "HostName": null, + "CdnEnabled": false, + "CdnProvider": null, + "CdnProfile": null, + "FreeTrialEndTime": "0001-01-01T00:00:00-08:00", + "ProvisioningState": null, + "ResourceState": "Stopped", + "Created": "2018-03-02T18:25:09.4897514-08:00", + "LastModified": "2018-03-02T18:25:09.4897514-08:00" + } + } + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-list-all.json new file mode 100644 index 000000000000..85a9badc34a7 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-list-all.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T08:00:00Z", + "provisioningState": "Succeeded", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.202013Z", + "lastModified": "2018-03-03T02:25:09.202013Z" + } + }, + { + "name": "default", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/default", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": {}, + "properties": { + "description": "", + "scaleUnits": 0, + "availabilitySetName": null, + "cdnEnabled": true, + "cdnProvider": "StandardVerizon", + "cdnProfile": "AzureMediaStreamingPlatformCdnProfile-StandardVerizon", + "customHostNames": [], + "maxCacheAge": null, + "hostName": "slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T00:00:00-08:00", + "provisioningState": "InProgress", + "resourceState": "Starting", + "created": "2018-03-03T02:25:09.2310128Z", + "lastModified": "2018-03-03T02:25:09.2310128Z" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-list-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-list-by-name.json new file mode 100644 index 000000000000..1f9dbdce3552 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-list-by-name.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2018-06-01-preview" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T08:00:00Z", + "provisioningState": "Succeeded", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.3500423Z", + "lastModified": "2018-03-03T02:25:09.3500423Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-scale.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-scale.json new file mode 100644 index 000000000000..bb3194bc81a8 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-scale.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2018-06-01-preview", + "parameters": { + "scaleUnit": 5 + } + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-start.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-start.json new file mode 100644 index 000000000000..b960e18206f5 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-start.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2018-06-01-preview" + }, + "responses": { + "202": {}, + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-stop.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-stop.json new file mode 100644 index 000000000000..b960e18206f5 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-stop.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2018-06-01-preview" + }, + "responses": { + "202": {}, + "200": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-update.json new file mode 100644 index 000000000000..a22f51b3657b --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/streamingendpoint-update.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2018-06-01-preview", + "parameters": { + "id": null, + "name": "myStreamingEndpoint1", + "location": "West US", + "type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints", + "tags": { + "tag3": "value3", + "tag5": "value5" + }, + "properties": { + "description": "test event 2", + "scaleUnits": 5, + "availabilitySetName": "availableset" + } + } + }, + "responses": { + "200": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag3": "value3", + "tag5": "value5" + }, + "properties": { + "description": "test event 2", + "scaleUnits": 5, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": null, + "customHostNames": [], + "maxCacheAge": null, + "hostName": null, + "freeTrialEndTime": "0001-01-01T00:00:00Z", + "provisioningState": "Succeeded", + "resourceState": null, + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z" + } + } + }, + "202": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag3": "value3", + "tag5": "value5" + }, + "properties": { + "description": "test event 2", + "scaleUnits": 5, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": null, + "customHostNames": [], + "maxCacheAge": null, + "hostName": null, + "freeTrialEndTime": "0001-01-01T00:00:00Z", + "provisioningState": "Succeeded", + "resourceState": null, + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-create.json new file mode 100644 index 000000000000..cfb560f28e43 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-create.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "CreatedTransform", + "parameters": { + "properties": { + "description": "Example transform to illustrate create and update.", + "created": "0001-01-01T00:00:00-05:00", + "lastModified": "0001-01-01T00:00:00-05:00", + "outputs": [ + { + "relativePriority": null, + "onError": null, + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "CreatedTransform", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/CreatedTransform", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-05-31T21:08:32.0783474-04:00", + "description": "Example transform to illustrate create and update.", + "lastModified": "2018-05-31T21:08:32.0783474-04:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + } + }, + "200": { + "body": { + "name": "CreatedTransform", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/CreatedTransform", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-05-31T21:08:32.0783474-04:00", + "description": "Example transform to illustrate create and update.", + "lastModified": "2018-05-31T21:08:32.1023592-04:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-delete.json new file mode 100644 index 000000000000..407300c86a51 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "SampleTransform" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-get-by-name.json new file mode 100644 index 000000000000..1191595b52bb --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-get-by-name.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "SampleTransform" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "SampleTransform", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/SampleTransform", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-05-31T21:08:31.8853222-04:00", + "description": "A sample transform using the standard encoder with a built in preset.", + "lastModified": "2018-05-31T21:08:31.8853222-04:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "H264MultipleBitrate1080p" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-list-all.json new file mode 100644 index 000000000000..87167e023f06 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-list-all.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "SampleEncode", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/SampleEncode", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-05-31T21:08:31.4763344-04:00", + "description": "A sample transform using the standard encoder with a built in preset.", + "lastModified": "2018-05-31T21:08:31.4763344-04:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + }, + { + "name": "SampleEncodeAndVideoIndex", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/SampleEncodeAndVideoIndex", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-05-31T21:08:31.4803629-04:00", + "description": "A sample transform using the standard encoder with a built in preset and the video indexer.", + "lastModified": "2018-05-31T21:08:31.4803629-04:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + }, + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.VideoAnalyzerPreset", + "audioLanguage": "en-US", + "audioInsightsOnly": false + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-update.json new file mode 100644 index 000000000000..0e244b8bf60c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/examples/transforms-update.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "TransformToUpdate", + "parameters": { + "properties": { + "description": "Example transform to illustrate update.", + "created": "0001-01-01T00:00:00-05:00", + "lastModified": "0001-01-01T00:00:00-05:00", + "outputs": [ + { + "relativePriority": null, + "onError": null, + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "H264MultipleBitrate720p" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "TransformToUpdate", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/TransformToUpdate", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-03-05T23:52:19.9109582-05:00", + "description": "Example transform to illustrate update.", + "lastModified": "2018-03-05T23:52:19.9149613-05:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "H264MultipleBitrate720p" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/streamingservice.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/streamingservice.json new file mode 100644 index 000000000000..8de9f4a1b6bc --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/streamingservice.json @@ -0,0 +1,1767 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "Streaming resource management client for Azure Media Services", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents": { + "get": { + "tags": [ + "LiveEvents" + ], + "summary": "List Live Events", + "description": "Lists the Live Events in the account.", + "operationId": "LiveEvents_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEventListResult" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all LiveEvents": { + "$ref": "examples/liveevent-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}": { + "get": { + "tags": [ + "LiveEvents" + ], + "summary": "Get Live Event", + "description": "Gets a Live Event.", + "operationId": "LiveEvents_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "Get a LiveEvent by name": { + "$ref": "examples/liveevent-list-by-name.json" + } + } + }, + "put": { + "tags": [ + "LiveEvents" + ], + "summary": "Create Live Event", + "description": "Creates a Live Event.", + "operationId": "LiveEvents_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StreamingResourceAutoStart" + }, + { + "name": "parameters", + "description": "Live Event properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveEvent" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a LiveEvent": { + "$ref": "examples/liveevent-create.json" + } + } + }, + "patch": { + "tags": [ + "LiveEvents" + ], + "description": "Updates a existing Live Event.", + "operationId": "LiveEvents_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "Live Event properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveEvent" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a LiveEvent": { + "$ref": "examples/liveevent-update.json" + } + } + }, + "delete": { + "tags": [ + "LiveEvents" + ], + "summary": "Delete Live Event", + "description": "Deletes a Live Event.", + "operationId": "LiveEvents_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "204": { + "description": "No content. The request has been accepted but the Live Event was not found." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a LiveEvent": { + "$ref": "examples/liveevent-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/start": { + "post": { + "tags": [ + "LiveEvents" + ], + "summary": "Start Live Event", + "description": "Starts an existing Live Event.", + "operationId": "LiveEvents_Start", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start a LiveEvent": { + "$ref": "examples/liveevent-start.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/stop": { + "post": { + "tags": [ + "LiveEvents" + ], + "summary": "Stop Live Event", + "description": "Stops an existing Live Event.", + "operationId": "LiveEvents_Stop", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "LiveEvent stop parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveEventActionInput" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Stop a LiveEvent": { + "$ref": "examples/liveevent-stop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/reset": { + "post": { + "tags": [ + "LiveEvents" + ], + "summary": "Reset Live Event", + "description": "Resets an existing Live Event.", + "operationId": "LiveEvents_Reset", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset a LiveEvent": { + "$ref": "examples/liveevent-reset.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs": { + "get": { + "tags": [ + "LiveOutputs" + ], + "summary": "List Live Outputs", + "description": "Lists the Live Outputs in the Live Event.", + "operationId": "LiveOutputs_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveOutputListResult" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all LiveOutputs": { + "$ref": "examples/liveoutput-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs/{liveOutputName}": { + "get": { + "tags": [ + "LiveOutputs" + ], + "summary": "Get Live Output", + "description": "Gets a Live Output.", + "operationId": "LiveOutputs_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/LiveOutputName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveOutput" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "Get a LiveOutput by name": { + "$ref": "examples/liveoutput-list-by-name.json" + } + } + }, + "put": { + "tags": [ + "LiveOutputs" + ], + "summary": "Create Live Output", + "description": "Creates a Live Output.", + "operationId": "LiveOutputs_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/LiveOutputName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "Live Output properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveOutput" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveOutput" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/LiveOutput" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a LiveOutput": { + "$ref": "examples/liveoutput-create.json" + } + } + }, + "delete": { + "tags": [ + "LiveOutputs" + ], + "summary": "Delete Live Output", + "description": "Deletes a Live Output.", + "operationId": "LiveOutputs_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/LiveOutputName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "204": { + "description": "No content. The request has been accepted but the Live Output was not found." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a LiveOutput": { + "$ref": "examples/liveoutput-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints": { + "get": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "List StreamingEndpoints", + "description": "Lists the StreamingEndpoints in the account.", + "operationId": "StreamingEndpoints_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpointListResult" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all StreamingEndpoints": { + "$ref": "examples/streamingendpoint-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}": { + "get": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Get StreamingEndpoint", + "description": "Gets a StreamingEndpoint.", + "operationId": "StreamingEndpoints_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "Get a StreamingEndpoint by name": { + "$ref": "examples/streamingendpoint-list-by-name.json" + } + } + }, + "put": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Create StreamingEndpoint", + "description": "Creates a StreamingEndpoint.", + "operationId": "StreamingEndpoints_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StreamingResourceAutoStart" + }, + { + "name": "parameters", + "description": "StreamingEndpoint properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-create.json" + } + } + }, + "patch": { + "tags": [ + "StreamingEndpoint" + ], + "summary": "Update StreamingEndpoint", + "description": "Updates a existing StreamingEndpoint.", + "operationId": "StreamingEndpoints_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "StreamingEndpoint properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-update.json" + } + } + }, + "delete": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Delete StreamingEndpoint", + "description": "Deletes a StreamingEndpoint.", + "operationId": "StreamingEndpoints_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "204": { + "description": "No content. The request has been accepted but the Streaming Endpoint was not found." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/start": { + "post": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Start StreamingEndpoint", + "description": "Starts an existing StreamingEndpoint.", + "operationId": "StreamingEndpoints_Start", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-start.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/stop": { + "post": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Stop StreamingEndpoint", + "description": "Stops an existing StreamingEndpoint.", + "operationId": "StreamingEndpoints_Stop", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Stop a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-stop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/scale": { + "post": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Scale StreamingEndpoint", + "description": "Scales an existing StreamingEndpoint.", + "operationId": "StreamingEndpoints_Scale", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "StreamingEndpoint scale parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingEntityScaleUnit" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Scale a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-scale.json" + } + } + } + } + }, + "definitions": { + "Hls": { + "properties": { + "fragmentsPerTsSegment": { + "format": "int32", + "type": "integer", + "description": "The amount of fragments per HTTP Live Streaming (HLS) segment." + } + }, + "description": "The HLS configuration." + }, + "LiveOutputProperties": { + "required": ["assetName","archiveWindowLength"], + "properties": { + "description": { + "type": "string", + "description": "The description of the Live Output." + }, + "assetName": { + "type": "string", + "description": "The asset name." + }, + "archiveWindowLength": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content." + }, + "manifestName": { + "type": "string", + "description": "The manifest file name." + }, + "hls": { + "type": "object", + "$ref": "#/definitions/Hls", + "description": "The HLS configuration." + }, + "outputSnapTime": { + "type": "integer", + "format": "int64", + "description": "The output snapshot time." + }, + "created": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the Live Output was created." + }, + "lastModified": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the Live Output was last modified." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the Live Output." + }, + "resourceState": { + "description": "The resource state of the Live Output.", + "readOnly": true, + "type": "string", + "enum": [ + "Creating", + "Running", + "Deleting" + ], + "x-ms-enum": { + "name": "LiveOutputResourceState", + "modelAsString": false + } + } + }, + "description": "The JSON object that contains the properties required to create a Live Output." + }, + "LiveOutput": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LiveOutputProperties", + "description": "The Live Output properties." + } + }, + "allOf": [ + { + "$ref": "./Common.json#/definitions/ProxyResource" + } + ], + "description": "The Live Output." + }, + "LiveOutputListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveOutput" + }, + "description": "The result of the List Live Output operation." + }, + "@odata.count": { + "type": "integer", + "format": "int32", + "description": "The number of result." + }, + "@odata.nextLink": { + "type": "string", + "description": "Th link to the next set of results. Not empty if value contains incomplete list of Live Outputs." + } + }, + "description": "The LiveOutput list result.", + "title": "LiveOutputListResult" + }, + "LiveEventEndpoint": { + "properties": { + "protocol": { + "type": "string", + "description": "The endpoint protocol." + }, + "url": { + "type": "string", + "description": "The endpoint URL." + } + }, + "description": "The Live Event endpoint." + }, + "LiveEventInput": { + "required": ["streamingProtocol"], + "properties": { + "streamingProtocol": { + "type": "string", + "description": "The streaming protocol for the Live Event.", + "enum": [ + "FragmentedMP4", + "RTMP" + ], + "x-ms-enum": { + "name": "LiveEventInputProtocol", + "modelAsString": false + } + }, + "keyFrameIntervalDuration": { + "type": "string", + "description": "ISO 8601 timespan duration of the key frame interval duration." + }, + "accessToken": { + "type": "string", + "description": "The access token." + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveEventEndpoint" + }, + "description": "The input endpoints for the Live Event." + } + }, + "description": "The Live Event input." + }, + "IPRange": { + "properties": { + "name": { + "type": "string", + "description": "The friendly name for the IP address range." + }, + "address": { + "type": "string", + "description": "The IP address." + }, + "subnetPrefixLength": { + "format": "int32", + "type": "integer", + "description": "The subnet mask prefix length (see CIDR notation)." + } + }, + "description": "The IP address range in the CIDR scheme." + }, + "IPAccessControl": { + "properties": { + "allow": { + "type": "array", + "items": { + "$ref": "#/definitions/IPRange" + }, + "description": "The IP allow list." + } + }, + "description": "The IP access control." + }, + "LiveEventPreviewAccessControl": { + "properties": { + "ip": { + "type": "object", + "$ref": "#/definitions/IPAccessControl", + "description": "The IP access control properties." + } + }, + "description": "The IP access control for Live Event preview." + }, + "LiveEventPreview": { + "properties": { + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveEventEndpoint" + }, + "description": "The endpoints for preview." + }, + "accessControl": { + "type": "object", + "$ref": "#/definitions/LiveEventPreviewAccessControl", + "description": "The access control for LiveEvent preview." + }, + "previewLocator": { + "type": "string", + "description": "The preview locator Guid." + }, + "streamingPolicyName": { + "type": "string", + "description": "The name of streaming policy used for LiveEvent preview" + }, + "alternativeMediaId": { + "type": "string", + "description": "An Alternative Media Identifier associated with the preview url. This identifier can be used to distinguish the preview of different live events for authorization purposes in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field." + } + }, + "description": "The Live Event preview." + }, + "LiveEventEncoding": { + "properties": { + "encodingType": { + "type": "string", + "description": "The encoding type for Live Event.", + "enum": [ + "None", + "Basic" + ], + "x-ms-enum": { + "name": "LiveEventEncodingType", + "modelAsString": false + } + }, + "presetName": { + "type": "string", + "description": "The encoding preset name." + } + }, + "description": "The Live Event encoding." + }, + "CrossSiteAccessPolicies": { + "properties": { + "clientAccessPolicy": { + "type": "string", + "description": "The content of clientaccesspolicy.xml used by Silverlight." + }, + "crossDomainPolicy": { + "type": "string", + "description": "The content of crossdomain.xml used by Silverlight." + } + }, + "description": "The client access policy." + }, + "LiveEventActionInput": { + "properties": { + "removeOutputsOnStop": { + "type": "boolean", + "description": "The flag indicates if remove LiveOutputs on Stop." + } + }, + "description": "The LiveEvent action input parameter definition." + }, + "LiveEventProperties": { + "required": ["input"], + "properties": { + "description": { + "type": "string", + "description": "The Live Event description." + }, + "input": { + "type": "object", + "$ref": "#/definitions/LiveEventInput", + "description": "The Live Event input." + }, + "preview": { + "type": "object", + "$ref": "#/definitions/LiveEventPreview", + "description": "The Live Event preview." + }, + "encoding": { + "type": "object", + "$ref": "#/definitions/LiveEventEncoding", + "description": "The Live Event encoding." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the Live Event." + }, + "resourceState": { + "readOnly": true, + "type": "string", + "description": "The resource state of the Live Event.", + "enum": [ + "Stopped", + "Starting", + "Running", + "Stopping", + "Deleting" + ], + "x-ms-enum": { + "name": "LiveEventResourceState", + "modelAsString": false + } + }, + "crossSiteAccessPolicies": { + "type": "object", + "$ref": "#/definitions/CrossSiteAccessPolicies", + "description": "The Live Event access policies." + }, + "vanityUrl": { + "type": "boolean", + "description": "The Live Event vanity URL flag." + }, + "streamOptions": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Default", + "LowLatency" + ], + "x-ms-enum": { + "name": "StreamOptionsFlag", + "modelAsString": false + } + }, + "description": "The stream options." + }, + "created": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the Live Event was created." + }, + "lastModified": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the Live Event was last modified." + } + }, + "description": "The Live Event properties." + }, + "LiveEvent": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LiveEventProperties", + "description": "The Live Event properties." + } + }, + "allOf": [ + { + "$ref": "./Common.json#/definitions/TrackedResource" + } + ], + "description": "The Live Event." + }, + "LiveEventListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveEvent" + }, + "description": "The result of the List Live Event operation." + }, + "@odata.count": { + "type": "integer", + "format": "int32", + "description": "The number of result." + }, + "@odata.nextLink": { + "type": "string", + "description": "Th link to the next set of results. Not empty if value contains incomplete list of Live Outputs." + } + }, + "description": "The LiveEvent list result.", + "title": "LiveEventListResult" + }, + "AkamaiSignatureHeaderAuthenticationKey": { + "properties": { + "identifier": { + "type": "string", + "description": "identifier of the key" + }, + "base64Key": { + "type": "string", + "description": "authentication key" + }, + "expiration": { + "format": "date-time", + "type": "string", + "description": "The exact time the authentication key." + } + }, + "description": "Akamai Signature Header authentication key." + }, + "AkamaiAccessControl": { + "properties": { + "akamaiSignatureHeaderAuthenticationKeyList": { + "type": "array", + "items": { + "$ref": "#/definitions/AkamaiSignatureHeaderAuthenticationKey" + }, + "description": "authentication key list" + } + }, + "description": "Akamai access control" + }, + "StreamingEndpointAccessControl": { + "properties": { + "akamai": { + "type": "object", + "$ref": "#/definitions/AkamaiAccessControl", + "description": "The access control of Akamai" + }, + "ip": { + "type": "object", + "$ref": "#/definitions/IPAccessControl", + "description": "The IP access control of the StreamingEndpoint." + } + }, + "description": "StreamingEndpoint access control definition." + }, + "StreamingEntityScaleUnit": { + "properties": { + "scaleUnit": { + "type": "integer", + "format": "int32", + "description": "The scale unit number of the StreamingEndpoint.", + "title": "ScaleUnit" + } + }, + "description": "scale units definition" + }, + "StreamingEndpointProperties": { + "properties": { + "description": { + "type": "string", + "description": "The StreamingEndpoint description." + }, + "scaleUnits": { + "type": "integer", + "format": "int32", + "description": "The number of scale units.", + "x-nullable": false + }, + "availabilitySetName": { + "type": "string", + "description": "AvailabilitySet name" + }, + "accessControl": { + "type": "object", + "$ref": "#/definitions/StreamingEndpointAccessControl", + "description": "The access control definition of the StreamingEndpoint." + }, + "maxCacheAge": { + "type": "integer", + "format": "int64", + "description": "Max cache age" + }, + "customHostNames": { + "type": "array", + "items": { + "type": "string", + "description": "custom host name" + }, + "description": "The custom host names of the StreamingEndpoint" + }, + "hostName": { + "readOnly": true, + "type": "string", + "description": "The StreamingEndpoint host name." + }, + "cdnEnabled": { + "type": "boolean", + "description": "The CDN enabled flag." + }, + "cdnProvider": { + "type": "string", + "description": "The CDN provider name." + }, + "cdnProfile": { + "type": "string", + "description": "The CDN profile name." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the StreamingEndpoint." + }, + "resourceState": { + "readOnly": true, + "type": "string", + "description": "The resource state of the StreamingEndpoint.", + "enum": [ + "Stopped", + "Starting", + "Running", + "Stopping", + "Deleting", + "Scaling" + ], + "x-ms-enum": { + "name": "StreamingEndpointResourceState", + "modelAsString": false + } + }, + "crossSiteAccessPolicies": { + "type": "object", + "$ref": "#/definitions/CrossSiteAccessPolicies", + "description": "The StreamingEndpoint access policies." + }, + "freeTrialEndTime": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The free trial expiration time." + }, + "created": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the StreamingEndpoint was created." + }, + "lastModified": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the StreamingEndpoint was last modified." + } + }, + "description": "The StreamingEndpoint properties." + }, + "StreamingEndpoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StreamingEndpointProperties", + "description": "The StreamingEndpoint properties." + } + }, + "allOf": [ + { + "$ref": "./Common.json#/definitions/TrackedResource" + } + ], + "description": "The StreamingEndpoint." + }, + "StreamingEndpointListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingEndpoint" + }, + "description": "The result of the List StreamingEndpoint operation." + }, + "@odata.count": { + "type": "integer", + "format": "int32", + "description": "The number of result." + }, + "@odata.nextLink": { + "type": "string", + "description": "Th link to the next set of results. Not empty if value contains incomplete list of StreamingEndpoints." + } + }, + "description": "The StreamingEndpoint list result.", + "title": "StreamingEndpointListResult" + }, + "ODataError": { + "properties": { + "code": { + "type": "string", + "description": "A language-independent error name." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "target": { + "type": "string", + "description": "The target of the error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + }, + "description": "The error details." + } + }, + "type": "object", + "description": "Information about an error." + }, + "ApiError": { + "properties": { + "error": { + "$ref": "#/definitions/ODataError", + "description": "The error properties." + } + }, + "type": "object", + "description": "The API error." + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "description": "The unique identifier for a Microsoft Azure subscription.", + "in": "path", + "required": true, + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "description": "The Version of the API to be used with the client request.", + "in": "query", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "description": "The name of the resource group within the Azure subscription.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "description": "The Media Services account name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "LiveEventName": { + "name": "liveEventName", + "description": "The name of the Live Event.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 32, + "x-ms-parameter-location": "method" + }, + "StreamingResourceAutoStart": { + "name": "autoStart", + "description": "The flag indicates if auto start the Live Event.", + "in": "query", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "LiveOutputName": { + "name": "liveOutputName", + "description": "The name of the Live Output.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^([a-zA-Z0-9])+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 256, + "x-ms-parameter-location": "method" + }, + "StreamingEndpointName": { + "name": "streamingEndpointName", + "description": "The name of the StreamingEndpoint.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 24, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/mediaservices/resource-manager/readme.md b/specification/mediaservices/resource-manager/readme.md index 8930dcf8b178..33dcf9041953 100644 --- a/specification/mediaservices/resource-manager/readme.md +++ b/specification/mediaservices/resource-manager/readme.md @@ -1,5 +1,5 @@ # MediaServices - + > see https://aka.ms/autorest This is the AutoRest configuration file for MediaServices. @@ -7,7 +7,7 @@ This is the AutoRest configuration file for MediaServices. --- -## Getting Started +## Getting Started To build the SDK for MediaServices, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -21,12 +21,12 @@ To see additional help and options, run: -### Basic Information +### Basic Information These are the global settings for the MediaServices API. ``` yaml openapi-type: arm -tag: package-2015-10 +tag: package-2018-06-preview ``` @@ -39,6 +39,34 @@ input-file: - Microsoft.Media/stable/2015-10-01/media.json ``` +### Tag: package-2018-03-preview + +These settings apply only when `--tag=package-2018-03-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03-preview' +input-file: +- Microsoft.Media/preview/2018-03-30-preview/Accounts.json +- Microsoft.Media/preview/2018-03-30-preview/Assets.json +- Microsoft.Media/preview/2018-03-30-preview/ContentKeyPolicies.json +- Microsoft.Media/preview/2018-03-30-preview/Encoding.json +- Microsoft.Media/preview/2018-03-30-preview/StreamingPoliciesAndStreamingLocators.json +- Microsoft.Media/preview/2018-03-30-preview/streamingservice.json +``` + +### Tag: package-2018-06-preview + +These settings apply only when `--tag=package-2018-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06-preview' +input-file: +- Microsoft.Media/preview/2018-06-01-preview/Accounts.json +- Microsoft.Media/preview/2018-06-01-preview/Assets.json +- Microsoft.Media/preview/2018-06-01-preview/ContentKeyPolicies.json +- Microsoft.Media/preview/2018-06-01-preview/Encoding.json +- Microsoft.Media/preview/2018-06-01-preview/StreamingPoliciesAndStreamingLocators.json +- Microsoft.Media/preview/2018-06-01-preview/streamingservice.json +``` + --- # Code Generation @@ -51,13 +79,16 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_media_services'] ``` -## C# +## C# These settings apply only when `--csharp` is specified on the command line. Please also specify `--csharp-sdks-folder=`. @@ -117,6 +148,8 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2015-10 + - tag: package-2018-03-preview + - tag: package-2018-06-preview ``` ### Tag: package-2015-10 and go @@ -127,6 +160,23 @@ Please also specify the `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-03-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/mediaservices/mgmt/2018-03-30-preview/media +``` + +### Tag: package-2018-06-preview and go + +These settings apply only when `--tag=package-2018-06-preview --go` is specified on the command line. +Please also specify the `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-06-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/mediaservices/mgmt/2018-06-01-preview/media +``` ## Java @@ -135,11 +185,57 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.mediaservices +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-mediaservices +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-10 + - tag: package-2018-03-preview + - tag: package-2018-06-preview +``` + +### Tag: package-2015-10 and java + +These settings apply only when `--tag=package-2015-10 --java` is specified on the command line. +Please also specify the `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2015-10' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.mediaservices - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-mediaservices + namespace: com.microsoft.azure.management.mediaservices.v2015_10_01 + output-folder: $(azure-libraries-for-java-folder)/mediaservices/resource-manager/v2015_10_01 +regenerate-manager: true +generate-interface: true +``` +### Tag: package-2018-03-preview and java + +These settings apply only when `--tag=package-2018-03-preview --java` is specified on the command line. +Please also specify the `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-03-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.mediaservices.v2018_03_30_preview + output-folder: $(azure-libraries-for-java-folder)/mediaservices/resource-manager/v2018_03_30_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-06-preview and java + +These settings apply only when `--tag=package-2018-06-preview --java` is specified on the command line. +Please also specify the `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-06-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.mediaservices.v2018_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/mediaservices/resource-manager/v2018_06_01_preview +regenerate-manager: true +generate-interface: true ``` diff --git a/specification/mediaservices/resource-manager/readme.nodejs.md b/specification/mediaservices/resource-manager/readme.nodejs.md index c563681f30d2..b6b9ff253892 100644 --- a/specification/mediaservices/resource-manager/readme.nodejs.md +++ b/specification/mediaservices/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-06-preview' && $(ruby) +namespace: "Azure::MediaServices::Mgmt::V2018_06_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_media_services/lib +``` + +### Tag: package-2018-03-preview and ruby + +These settings apply only when `--tag=package-2018-03-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-03-preview' && $(ruby) +namespace: "Azure::MediaServices::Mgmt::V2018_03_30_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_media_services/lib +``` + +### Tag: package-2015-10 and ruby + +These settings apply only when `--tag=package-2015-10 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-10' && $(ruby) +namespace: "Azure::MediaServices::Mgmt::V2015_10_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_media_services/lib +``` diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessedMachines_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessedMachines_Get.json index 0d9ad439cfc9..683af7ae4267 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessedMachines_Get.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessedMachines_Get.json @@ -95,11 +95,6 @@ "suitabilityExplanation": "WindowsServerVersionConditionallySupported" } } - }, - "401": {}, - "404": {}, - "500": {}, - "503": {} + } } } - diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessedMachines_ListByAssessment.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessedMachines_ListByAssessment.json index 08e7085ef405..81c959782b7f 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessedMachines_ListByAssessment.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessedMachines_ListByAssessment.json @@ -183,11 +183,6 @@ } ] } - }, - "401": {}, - "404": {}, - "500": {}, - "503": {} + } } } - diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessmentOptions_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessmentOptions_Get.json new file mode 100644 index 000000000000..c509994ed896 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessmentOptions_Get.json @@ -0,0 +1,680 @@ +{ + "parameters": { + "locationName": "SoutheastAsia", + "api-version": "2018-02-02", + "subscriptionId": "75dd7e42-4fd1-4512-af04-83ad9864335b" + }, + "responses": { + "200": { + "body": { + "vmFamilies": [ + { + "familyName": "Standard_A0_A7", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "WestCentralUs", + "ChinaNorth", + "ChinaEast", + "GermanyNortheast", + "GermanyCentral", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USDoDCentral", + "USDoDEast" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Basic_A0_A4", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "WestCentralUs", + "ChinaNorth", + "ChinaEast", + "GermanyNortheast", + "GermanyCentral", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USDoDCentral", + "USDoDEast" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv2_series", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "WestCentralUs", + "ChinaNorth", + "ChinaEast", + "GermanyNortheast", + "GermanyCentral", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USDoDCentral", + "USDoDEast" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized" + ] + }, + { + "familyName": "F_series", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "WestCentralUs", + "ChinaNorth", + "ChinaEast", + "GermanyNortheast", + "GermanyCentral", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USDoDCentral", + "USDoDEast" + ], + "category": [ + "ComputeOptimized" + ] + }, + { + "familyName": "Av2_series", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "WestCentralUs", + "ChinaNorth", + "ChinaEast", + "GermanyNortheast", + "GermanyCentral", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USDoDCentral", + "USDoDEast" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv3_series", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "WestCentralUs", + "GermanyNortheast", + "GermanyCentral", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "DS_series", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "ChinaNorth", + "ChinaEast", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "DSv2_series", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "WestCentralUs", + "ChinaNorth", + "ChinaEast", + "GermanyNortheast", + "GermanyCentral", + "USGovTexas", + "USGovArizona", + "USGovVirginia", + "USDoDCentral", + "USDoDEast" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "WestCentralUs", + "ChinaNorth", + "ChinaEast", + "GermanyNortheast", + "GermanyCentral", + "USGovTexas", + "USGovArizona", + "USGovVirginia", + "USDoDCentral", + "USDoDEast" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "WestCentralUs", + "GermanyNortheast", + "GermanyCentral", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev3_series", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "GermanyNortheast", + "GermanyCentral", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "GermanyNortheast", + "GermanyCentral", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "D_series", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "ChinaNorth", + "ChinaEast", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "WestEurope", + "JapanEast", + "JapanWest", + "UkSouth", + "EastUs", + "WestUs2", + "EastUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "G_series", + "targetLocations": [ + "SoutheastAsia", + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "JapanEast", + "UkSouth", + "WestUs2", + "EastUs2", + "WestUs", + "GermanyCentral", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "GS_series", + "targetLocations": [ + "SoutheastAsia", + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "JapanEast", + "UkSouth", + "WestUs2", + "EastUs2", + "WestUs", + "GermanyCentral", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ls_series", + "targetLocations": [ + "SoutheastAsia", + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "JapanEast", + "UkSouth", + "WestUs2", + "EastUs2", + "WestUs", + "GermanyCentral", + "USGovVirginia" + ], + "category": [ + "StorageOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "SoutheastAsia", + "CanadaEast", + "WestEurope", + "NorthEurope", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "H_series", + "targetLocations": [ + "SoutheastAsia", + "AustraliaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "WestUs", + "USGovArizona" + ], + "category": [ + "HighPerformanceCompute" + ] + }, + { + "familyName": "Standard_A8_A11", + "targetLocations": [ + "WestEurope", + "NorthEurope", + "JapanEast", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "WestUs" + ], + "category": [ + "HighPerformanceCompute" + ] + } + ], + "reservedInstanceVmFamilies": [ + "Dv2_series", + "F_series", + "Dv3_series", + "DS_series", + "DSv2_series", + "Fs_series", + "Dsv3_series", + "Ev3_series", + "Esv3_series", + "D_series", + "M_series", + "Ls_series", + "Fsv2_series", + "H_series" + ] + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Create.json index e5526d3e5b35..2ea3b71bfe3a 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Create.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Create.json @@ -86,10 +86,6 @@ "numberOfMachines": 4 } } - }, - "401": {}, - "400": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Delete.json index 9bb865108097..dd98fc1a2446 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Delete.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Delete.json @@ -8,11 +8,6 @@ "assessmentName": "assessment01" }, "responses": { - "204": {}, - "200": {}, - "400": {}, - "401": {}, - "500": {}, - "503": {} + "200": {} } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Get.json index fea561ac5d49..7a2754b539af 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Get.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Get.json @@ -38,10 +38,6 @@ "numberOfMachines": 4 } } - }, - "401": {}, - "404": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_GetReportDownloadUrl.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_GetReportDownloadUrl.json index 0fa576d5b5da..bfef10804468 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_GetReportDownloadUrl.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_GetReportDownloadUrl.json @@ -13,10 +13,6 @@ "assessmentReportUrl": "link-to-download-assessment-report", "expirationTime": "2018-02-02T13:17:23.5437337Z" } - }, - "401": {}, - "404": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_ListByGroup.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_ListByGroup.json index ce1f9ce0c682..e9456efe3700 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_ListByGroup.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_ListByGroup.json @@ -70,10 +70,6 @@ } ] } - }, - "401": {}, - "404": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_ListByProject.json index 3cb703e6c29c..f4bc67987dd8 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_ListByProject.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_ListByProject.json @@ -69,10 +69,6 @@ } ] } - }, - "401": {}, - "404": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Create.json index e84a07ead2f0..2ba43d2bbc52 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Create.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Create.json @@ -58,10 +58,6 @@ "updatedTimestamp": "2018-02-02T09:13:02.7580235Z" } } - }, - "401": {}, - "400": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Delete.json index 334d65a859cd..c9009ba03fed 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Delete.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Delete.json @@ -7,11 +7,6 @@ "groupName": "group01" }, "responses": { - "204": {}, - "200": {}, - "401": {}, - "404": {}, - "500": {}, - "503": {} + "200": {} } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Get.json index bf56233d45c4..5f72c0a57451 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Get.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Get.json @@ -26,10 +26,6 @@ "updatedTimestamp": "2018-02-02T09:13:02.7580235Z" } } - }, - "401": {}, - "404": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_ListByProject.json index 64a95ec7248a..49e47f536355 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_ListByProject.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_ListByProject.json @@ -45,10 +45,6 @@ } ] } - }, - "401": {}, - "404": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Machines_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Machines_Get.json index 40d972a1b09c..df57b3d08e83 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Machines_Get.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Machines_Get.json @@ -50,10 +50,6 @@ "updatedTimestamp": "2018-02-02T10:11:25.7585427Z" } } - }, - "401": {}, - "404": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Machines_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Machines_ListByProject.json index 8d7085665d98..66c24331720e 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Machines_ListByProject.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Machines_ListByProject.json @@ -94,10 +94,6 @@ } ] } - }, - "401": {}, - "404": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/ProjectsInSubscription_List.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/ProjectsInSubscription_List.json new file mode 100644 index 000000000000..99d38d17f493 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/ProjectsInSubscription_List.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2018-02-02", + "subscriptionId": "75dd7e42-4fd1-4512-af04-83ad9864335b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "numberOfGroups": 2, + "numberOfMachines": 5, + "numberOfAssessments": 5, + "createdTimestamp": "2018-02-02T13:11:30.8808917Z", + "updatedTimestamp": "2018-02-02T13:11:30.8848966Z", + "discoveryStatus": "NotStarted", + "customerWorkspaceId": "url-to-customers-service-map", + "customerWorkspaceLocation": "West Us", + "lastDiscoveryTimestamp": "2018-02-02T13:11:30.8808917Z", + "lastDiscoverySessionId": "2c213c69-e2d3-4c3e-b871-83e5f42f3299", + "lastAssessmentTimestamp": "2018-02-02T13:11:30.8808917Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/projects/project01", + "name": "project01", + "type": "Microsoft.Migrate/projects", + "eTag": "\"b701c73a-0000-0000-0000-59c12ff00000\"", + "location": "West Us", + "tags": {} + }, + { + "properties": { + "numberOfGroups": 4, + "numberOfMachines": 6, + "numberOfAssessments": 4, + "createdTimestamp": "2018-02-02T10:50:05.3206647Z", + "updatedTimestamp": "2018-02-02T10:50:05.3236679Z", + "discoveryStatus": "NotStarted", + "customerWorkspaceId": "url-to-customers-service-map", + "customerWorkspaceLocation": "West Us", + "lastDiscoveryTimestamp": "2018-02-02T13:11:30.8808917Z", + "lastDiscoverySessionId": "2c213c69-e2d3-4c3e-b871-83e5f42f3299", + "lastAssessmentTimestamp": "2018-02-02T13:11:30.8808917Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/projects/project02", + "name": "project02", + "type": "Microsoft.Migrate/projects", + "eTag": "\"b701c73a-0000-1111-0000-59c12ff02222\"", + "location": "West Us", + "tags": {} + } + ] + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Create.json index 2a6a3a23d608..7b257d40e0f8 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Create.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Create.json @@ -65,10 +65,6 @@ "location": "West Us", "tags": {} } - }, - "400": {}, - "401": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Delete.json index 0723b134b09c..f8f3ad390b55 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Delete.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Delete.json @@ -6,11 +6,6 @@ "projectName": "project01" }, "responses": { - "200": {}, - "204": {}, - "400": {}, - "401": {}, - "500": {}, - "503": {} + "200": {} } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Get.json index 694496398074..048cdd59dc15 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Get.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Get.json @@ -29,10 +29,6 @@ "location": "West Us", "tags": {} } - }, - "401": {}, - "404": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_GetKeys.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_GetKeys.json index 6b963ed9426c..6b0d28bcb8d3 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_GetKeys.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_GetKeys.json @@ -11,10 +11,6 @@ "workspaceId": "migrationProjectId", "workspaceKey": "migrationProjectKey" } - }, - "401": {}, - "404": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_List.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_List.json index a47e8934f652..954d558c4e4f 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_List.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_List.json @@ -54,10 +54,6 @@ } ] } - }, - "401": {}, - "404": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Update.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Update.json index b203e804ec6a..d9d5b6086d0b 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Update.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Update.json @@ -41,11 +41,6 @@ "location": "West Us", "tags": {} } - }, - "400": {}, - "401": {}, - "404": {}, - "500": {}, - "503": {} + } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/migrate.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/migrate.json index 2776562901b2..80b82e574a6b 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/migrate.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/migrate.json @@ -91,6 +91,14 @@ "type": "string", "in": "header", "x-ms-parameter-location": "client" + }, + "locationName": { + "name": "locationName", + "description": "Azure region in which the project is created.", + "type": "string", + "in": "path", + "x-ms-parameter-location": "method", + "required": true } }, "securityDefinitions": { @@ -1593,6 +1601,37 @@ } } }, + "VmFamily": { + "type": "object", + "description": "VM family name, the list of targeted azure locations and the category of the family.", + "properties": { + "familyName": { + "type": "string", + "description": "Name of the VM family.", + "readOnly": true + }, + "targetLocations": { + "type": "array", + "description": "List of Azure regions.", + "readOnly": true, + "items": { + "type": "string", + "description": "Azure region name.", + "readOnly": true + } + }, + "category": { + "type": "array", + "description": "Category of the VM family.", + "readOnly": true, + "items": { + "type": "string", + "description": "VM family Category.", + "readOnly": true + } + } + } + }, "ProjectResultList": { "type": "object", "description": "List of projects.", @@ -1670,14 +1709,158 @@ } } } + }, + "AssessmentOptionsResultList": { + "type": "object", + "description": "List of assessment options.", + "properties": { + "vmFamilies": { + "type": "array", + "description": "Dictionary of VM families grouped by vm family name describing the targeted azure locations of VM family and the category of the family.", + "readOnly": true, + "items": { + "$ref": "#/definitions/VmFamily" + } + }, + "reservedInstanceVmFamilies": { + "type": "array", + "description": "List of supported VM Families.", + "readOnly": true, + "items": { + "type": "string", + "description": "Azure VM family name.", + "readOnly": true + } + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Azure Migrate 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 Azure Migrate service." } }, "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Migrate/locations/{locationName}/assessmentOptions": { + "get": { + "summary": "Get the assessment options.", + "description": "Get the available options for the properties of an assessment.", + "operationId": "AssessmentOptions_Get", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/locationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/acceptLanguage" + } + ], + "responses": { + "200": { + "description": "OK. Returns assessment options.", + "schema": { + "$ref": "#/definitions/AssessmentOptionsResultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AssessmentOptions_Get": { + "$ref": "./examples/AssessmentOptions_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Migrate/projects": { + "get": { + "summary": "Get all projects.", + "description": "Get all the projects in the subscription.", + "operationId": "Projects_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/acceptLanguage" + } + ], + "responses": { + "200": { + "description": "OK.", + "headers": { + "x-ms-request-id": { + "type": "string", + "description": "Service generated Request ID." + } + }, + "schema": { + "$ref": "#/definitions/ProjectResultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Projects_List": { + "$ref": "./examples/ProjectsInSubscription_List.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Migrate/projects": { "get": { "summary": "Get all projects.", "description": "Get all the projects in the resource group.", - "operationId": "Projects_List", + "operationId": "Projects_ListByResourceGroup", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1705,17 +1888,11 @@ "$ref": "#/definitions/ProjectResultList" } }, - "401": { - "description": "Not authorized (No access to subscription or resource group)." - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -1763,17 +1940,11 @@ "$ref": "#/definitions/Project" } }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName, projectName)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -1836,17 +2007,11 @@ "$ref": "#/definitions/Project" } }, - "400": { - "description": "Bad Request (Read only settings of an existing project cannot be changed)." - }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -1897,20 +2062,11 @@ "$ref": "#/definitions/Project" } }, - "400": { - "description": "Bad Request (Read only settings of an existing project cannot be changed)." - }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName, or nestName)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -1950,20 +2106,11 @@ } } }, - "204": { - "description": "No content. No project with specified name was found." - }, - "400": { - "description": "Bad request. (Invalid subscriptionId or resourceGroupName)." - }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)" - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -2008,17 +2155,11 @@ "$ref": "#/definitions/ProjectKey" } }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName, projectName)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -2063,17 +2204,11 @@ "$ref": "#/definitions/MachineResultList" } }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName, projectName)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -2124,17 +2259,11 @@ "$ref": "#/definitions/Machine" } }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName, projectName, or machineName)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -2179,17 +2308,11 @@ "$ref": "#/definitions/GroupResultList" } }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName, projectName)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -2240,17 +2363,11 @@ "$ref": "#/definitions/Group" } }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName, projectName, or groupName)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -2316,17 +2433,11 @@ "$ref": "#/definitions/Group" } }, - "400": { - "description": "Bad Request (Read only settings of an existing group cannot be changed)." - }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -2369,20 +2480,11 @@ } } }, - "204": { - "description": "No content. No group with specified name was found." - }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)" - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName)" - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -2430,17 +2532,11 @@ "$ref": "#/definitions/AssessmentResultList" } }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName, assessmentName)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -2488,17 +2584,11 @@ "$ref": "#/definitions/AssessmentResultList" } }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName, assessmentName)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -2552,17 +2642,11 @@ "$ref": "#/definitions/Assessment" } }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName, projectName, or assesmentName)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -2631,17 +2715,11 @@ "$ref": "#/definitions/Assessment" } }, - "400": { - "description": "Bad Request. Assessment is under computation and cannot be updated yet." - }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -2687,20 +2765,11 @@ } } }, - "204": { - "description": "No content. No assessment with specified name was found." - }, - "400": { - "description": "Bad Request. Assessment is under computation and cannot be deleted yet." - }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)" - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -2751,17 +2820,11 @@ "$ref": "#/definitions/DownloadUrl" } }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName, projectName)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -2812,17 +2875,11 @@ "$ref": "#/definitions/AssessedMachineResultList" } }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName, projectName, or assessmentName)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -2879,17 +2936,11 @@ "$ref": "#/definitions/AssessedMachine" } }, - "401": { - "description": "Not authorized (No access to subscription, resource group, or project)." - }, - "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName, projectName, groupName, assessmentName, or machineId)." - }, - "500": { - "description": "Internal Server Error." - }, - "503": { - "description": "Service Unavailable." + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -2923,4 +2974,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/migrate/resource-manager/readme.md b/specification/migrate/resource-manager/readme.md index 603a01ccbf44..1f8e8fbb65b6 100644 --- a/specification/migrate/resource-manager/readme.md +++ b/specification/migrate/resource-manager/readme.md @@ -5,6 +5,28 @@ This is the AutoRest configuration file for Azure Migrate. --- + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-02 +``` + +### Tag: package-2018-02 and java + +These settings apply only when `--tag=package-2018-02 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-02' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.azuremigrate.v2018_02_02 + output-folder: $(azure-libraries-for-java-folder)/azuremigrate/resource-manager/v2018_02_02 +regenerate-manager: true +generate-interface: true +``` + + ## Getting Started To build the SDK for Migrate, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json index 176ea80dbd94..7e157fe7d64c 100644 --- a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json @@ -65,19 +65,6 @@ "description": "Successful request to get more information about diagnostic setting category", "schema": { "$ref": "#/definitions/DiagnosticSettingsCategoryResource" - }, - "examples": { - "application/json": - { - "id":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettingsCategories/WorkflowRuntime", - "type":"microsoft.insights/diagnosticSettingsCategories", - "name":"WorkflowRuntime", - "location":"eastus", - "tags":null, - "properties": { - "categoryType":"Logs" - } - } } } }, @@ -114,32 +101,6 @@ "description": "Successful request to get more information about diagnostic setting category", "schema": { "$ref": "#/definitions/DiagnosticSettingsCategoryResourceCollection" - }, - "examples": { - "application/json": { - "value": [ - { - "id":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettingsCategories/WorkflowRuntime", - "type":"microsoft.insights/diagnosticSettingsCategories", - "name":"WorkflowRuntime", - "location":"eastus", - "tags":null, - "properties": { - "categoryType":"Logs" - } - }, - { - "id":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettingsCategories/WorkflowMetric", - "type":"microsoft.insights/diagnosticSettingsCategories", - "name":"WorkflowMetric", - "location":"eastus", - "tags":null, - "properties": { - "categoryType":"Metrics" - } - } - ] - } } } }, @@ -197,7 +158,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/DiagnosticSettingsCategory" + "$ref": "#/definitions/DiagnosticSettingsCategory", + "description": "The properties of a Diagnostic Settings Category." } }, "description": "The diagnostic settings category resource." diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json index 080b2b9bf56d..79f598ce5f07 100644 --- a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json @@ -65,40 +65,6 @@ "description": "Successful request to get more information about diagnostic setting", "schema": { "$ref": "#/definitions/DiagnosticSettingsResource" - }, - "examples": { - "application/json": { - "id":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/mysetting", - "type":"microsoft.logic/workflows", - "name":"mysetting", - "location":"eastus", - "tags":null, - "properties": { - "storageAccountId":"/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1", - "eventHubAuthorizationRuleId":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/andy1101/providers/Microsoft.EventHub/namespaces/andy1101/authorizationrules/RootManageSharedAccessKey", - "workspaceId":"", - "metrics": [ - { - "category":"WorkflowMetrics", - "enabled":true, - "retentionPolicy": { - "enabled":false, - "days":0 - } - } - ], - "logs": [ - { - "category":"WorkflowRuntime", - "enabled":true, - "retentionPolicy": { - "enabled":false, - "days":0 - } - } - ] - } - } } } }, @@ -145,40 +111,6 @@ "description": "Successful request to create a diagnostic setting", "schema": { "$ref": "#/definitions/DiagnosticSettingsResource" - }, - "examples": { - "application/json": { - "id":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/mysetting", - "type":"microsoft.logic/workflows", - "name":"mysetting", - "location":"eastus", - "tags":null, - "properties": { - "storageAccountId":"/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1", - "eventHubAuthorizationRuleId":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/andy1101/providers/Microsoft.EventHub/namespaces/andy1101/authorizationrules/RootManageSharedAccessKey", - "workspaceId":"", - "metrics": [ - { - "category":"WorkflowMetrics", - "enabled":true, - "retentionPolicy": { - "enabled":false, - "days":0 - } - } - ], - "logs": [ - { - "category":"WorkflowRuntime", - "enabled":true, - "retentionPolicy": { - "enabled":false, - "days":0 - } - } - ] - } - } } } }, @@ -252,44 +184,6 @@ "description": "Successful request to get more information about diagnostic setting", "schema": { "$ref": "#/definitions/DiagnosticSettingsResourceCollection" - }, - "examples": { - "application/json": { - "value": [ - { - "id":"/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/mysetting", - "type":"microsoft.logic/workflows", - "name":"mysetting", - "location":"eastus", - "tags":null, - "properties": { - "storageAccountId":"/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1", - "eventHubAuthorizationRuleId":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/andy1101/providers/Microsoft.EventHub/namespaces/andy1101/authorizationrules/RootManageSharedAccessKey", - "workspaceId":"", - "metrics": [ - { - "category":"WorkflowMetrics", - "enabled":true, - "retentionPolicy": { - "enabled":false, - "days":0 - } - } - ], - "logs": [ - { - "category":"WorkflowRuntime", - "enabled":true, - "retentionPolicy": { - "enabled":false, - "days":0 - } - } - ] - } - } - ] - } } } }, @@ -386,6 +280,10 @@ "type": "string", "description": "The resource ID of the storage account to which you would like to send Diagnostic Logs." }, + "serviceBusRuleId": { + "type": "string", + "description": "The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility." + }, "eventHubAuthorizationRuleId": { "type": "string", "description": "The resource Id for the event hub authorization rule." @@ -425,7 +323,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/DiagnosticSettings" + "$ref": "#/definitions/DiagnosticSettings", + "description": "Properties of a Diagnostic Settings Resource." } }, "description": "The diagnostic setting resource." diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/createOrUpdateDiagnosticSetting.json b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/createOrUpdateDiagnosticSetting.json index c5fb7418762a..8335a4ec33e1 100644 --- a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/createOrUpdateDiagnosticSetting.json +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/createOrUpdateDiagnosticSetting.json @@ -1,6 +1,6 @@ { "parameters": { - "resourceUri": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", + "resourceUri": "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", "name": "mysetting", "api-version": "2017-05-01-preview", "parameters": { diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/deleteDiagnosticSetting.json b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/deleteDiagnosticSetting.json index cfac0670258c..c7468e7ff795 100644 --- a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/deleteDiagnosticSetting.json +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/deleteDiagnosticSetting.json @@ -1,6 +1,6 @@ { "parameters" : { - "resourceUri" : "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", + "resourceUri" : "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", "name": "mysetting", "api-version" : "2017-05-01-preview" }, diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/getDiagnosticSetting.json b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/getDiagnosticSetting.json index 60b2c10c802b..03603e23f20d 100644 --- a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/getDiagnosticSetting.json +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/getDiagnosticSetting.json @@ -1,6 +1,6 @@ { "parameters" : { - "resourceUri" : "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", + "resourceUri" : "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", "name": "mysetting", "api-version" : "2017-05-01-preview" }, diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/getDiagnosticSettingsCategory.json b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/getDiagnosticSettingsCategory.json index 88b1e7c4ffaa..c8d94c67c36f 100644 --- a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/getDiagnosticSettingsCategory.json +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/getDiagnosticSettingsCategory.json @@ -1,6 +1,6 @@ { "parameters" : { - "resourceUri" : "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", + "resourceUri" : "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", "name": "WorkflowRuntime", "api-version" : "2017-05-01-preview" }, diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/listDiagnosticSettings.json b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/listDiagnosticSettings.json index 98009ba4687c..3a54aca66177 100644 --- a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/listDiagnosticSettings.json +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/listDiagnosticSettings.json @@ -1,6 +1,6 @@ { "parameters" : { - "resourceUri" : "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", + "resourceUri" : "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", "api-version" : "2017-05-01-preview" }, "responses" : { diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/listDiagnosticSettingsCategories.json b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/listDiagnosticSettingsCategories.json index 3ae589ec215f..2b915de05f31 100644 --- a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/listDiagnosticSettingsCategories.json +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/listDiagnosticSettingsCategories.json @@ -1,6 +1,6 @@ { "parameters" : { - "resourceUri" : "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", + "resourceUri" : "subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", "api-version" : "2017-05-01-preview" }, "responses" : { diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/baseline_API.json b/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/baseline_API.json index fadcfa344ccc..003d8a45ad34 100644 --- a/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/baseline_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/baseline_API.json @@ -80,48 +80,6 @@ "description": "Successful request to get the list of metric values.", "schema": { "$ref": "#/definitions/BaselineResponse" - }, - "examples": { - "application/json": { - "id": "/subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Insights/baseline/PercentageCpu", - "type": "Microsoft.Insights/baseline", - "name": { - "value": "PercentageCpu" - }, - "properties": { - "timespan": "2017-04-14T02:20:00Z/2017-04-14T04:20:00Z", - "aggregation": "Average", - "interval": "PT1H", - "timestamps": [ - "2017-04-14T02:20:00Z", - "2017-04-14T03:20:00Z" - ], - "baseline": [ - { - "sensitivity": "Low", - "lowThresholds": [ - 30.0, - 31.1 - ], - "highThresholds": [ - 90.3453, - 91.3453 - ] - }, - { - "sensitivity": "Medium", - "lowThresholds": [ - 50.0, - 51.1 - ], - "highThresholds": [ - 70.3453, - 71.3453 - ] - } - ] - } - } } } }, diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json b/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json index 4720f7a4c3a9..57463504ac45 100644 --- a/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json @@ -71,39 +71,6 @@ "description": "Successful request to get the list of metric values.", "schema": { "$ref": "#/definitions/CalculateBaselineResponse" - }, - "examples": { - "application/json": { - "type": "Microsoft.Insights/calculatebaseline", - "timestamps": [ - "2017-04-14T02:20:00Z", - "2017-04-14T03:20:00Z" - ], - "baseline": [ - { - "sensitivity": "Low", - "lowThresholds": [ - 30.0, - 31.1 - ], - "highThresholds": [ - 90.3453, - 91.3453 - ] - }, - { - "sensitivity": "Medium", - "lowThresholds": [ - 50.0, - 51.1 - ], - "highThresholds": [ - 70.3453, - 71.3453 - ] - } - ] - } } } }, diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettings.json b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettings.json new file mode 100644 index 000000000000..e57cc6ec6235 --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettings.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "subscriptionId": "187f412d-1758-44d9-b052-169e2564721d", + "resourceGroupName": "Default-ResourceGroup", + "diagnosticSettingsName": "SampleDiagSetting", + "api-version": "2018-06-01-preview", + "diagnosticSettings": { + "location": "Global", + "tags": {}, + "properties": { + "osType": "Windows", + "dataSources": [ + { + "kind": "PerformanceCounter", + "configuration": { + "perfCounters": [ + { + "name": "\\Process(_Total)\\%Processor Time", + "samplingPeriod": "PT1M" + }, + { + "name": "\\Process(_Total)\\Working Set", + "samplingPeriod": "PT1M" + } + ] + }, + "sinks": [ + { + "kind": "LogAnalytics" + } + ] + }, + { + "kind": "ETWProviders", + "configuration": { + "providers": [ + { + "name": "AuditLog", + "id": 1, + "filter": "filter exp" + }, + { + "name": "TraceLog", + "id": 2 + } + ] + }, + "sinks": [ + { + "kind": "LogAnalytics" + } + ] + }, + { + "kind": "WindowsEventLogs", + "configuration": { + "eventLogs": [ + { + "logName": "Application", + "filter": "SourceName == Xyz AND EventId = \"100\" AND $Xpath/Column=\"DCName\" = \"CatWoman\"" + + }, + { + "logName": "Application", + "filter": "SourceName == Xyz AND EventId = \"100\" AND $Xpath/Column=\"DCName\" = \"BatMan\"" + } + + ] + }, + "sinks": [ + { + "kind": "LogAnalytics" + } + ] + } + + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-ResourceGroup/providers/microsoft.insights/guestDiagnosticSettings/SampleDiagSetting", + "name": "productionMachineSetting", + "type": "Microsoft.Insights/guestDiagnosticSettings", + "location": "West US", + "tags": {}, + "properties": { + "osType": "Windows", + "dataSources": [ + { + "kind": "PerformanceCounter", + "configuration": { + "perfCounters": [ + { + "name": "\\Process(_Total)\\%Processor Time", + "samplingPeriod": "PT1M" + }, + { + "name": "\\Process(_Total)\\Working Set", + "samplingPeriod": "PT1M" + } + ] + }, + "sinks": [ + { + "kind": "LogAnalytics" + } + ] + } + ] + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-ResourceGroup/providers/microsoft.insights/guestDiagnosticSettings/SampleDiagSetting", + "name": "SampleDiagSetting", + "type": "Microsoft.Insights/guestDiagnosticSettings", + "location": "West US", + "tags": {}, + "properties": { + "osType": "Windows", + "dataSources": [ + { + "kind": "PerformanceCounter", + "configuration": { + "perfCounters": [ + { + "name": "\\Process(_Total)\\%Processor Time", + "samplingPeriod": "PT1M" + }, + { + "name": "\\Process(_Total)\\Working Set", + "samplingPeriod": "PT1M" + } + ] + }, + "sinks": [ + { + "kind": "LogAnalytics" + } + ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettingsAssociation.json b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettingsAssociation.json new file mode 100644 index 000000000000..c35cff6c5de2 --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettingsAssociation.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "resourceUri":"subscriptions/8498f01b-8064-4e37-856e-318f3c6c685f/resourceGroups/healthsystem/providers/Microsoft.Compute/virtualMachines/eastussojai", + "associationName": "healthSystemMachineConfigAssociation", + "api-version": "2018-06-01-preview", + "diagnosticSettingsAssociation": { + "location": "Global", + "tags": {}, + "properties": { + "guestDiagnosticSettingsName": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-Association-ResourceGroup/providers/providers/microsoft.insights/guestDiagnosticSettings/vmSettingForSecurity" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8498f01b-8064-4e37-856e-318f3c6c685f/resourceGroups/healthsystem/providers/Microsoft.Compute/virtualMachines/eastussojai/providers/microsoft.insights/guestDiagnosticSettingsAssociation/healthSystemMachineConfigAssociation", + "type": "Microsoft.Insights/GuestDiagnosticSettingsAssociation", + "name": "healthSystemMachineConfigAssociation", + "location": "Global", + "tags": {}, + "properties": { + "guestDiagnosticSettingsName": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-Association-ResourceGroup/providers/providers/microsoft.insights/guestDiagnosticSettings/vmSettingForSecurity" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/8498f01b-8064-4e37-856e-318f3c6c685f/resourceGroups/healthsystem/providers/Microsoft.Compute/virtualMachines/eastussojai/providers/microsoft.insights/guestDiagnosticSettingsAssociation/healthSystemMachineConfigAssociation", + "type": "Microsoft.Insights/GuestDiagnosticSettingsAssociation", + "name": "healthSystemMachineConfigAssociation", + "location": "Global", + "tags": {}, + "properties": { + "guestDiagnosticSettingsName": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-Association-ResourceGroup/providers/providers/microsoft.insights/guestDiagnosticSettings/vmSettingForSecurity" + } + } + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/deleteGuestDiagnosticSettingsAssociation.json b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/deleteGuestDiagnosticSettingsAssociation.json new file mode 100644 index 000000000000..2de5c4bb50ef --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/deleteGuestDiagnosticSettingsAssociation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceUri":"subscriptions/8498f01b-8064-4e37-856e-318f3c6c685f/resourceGroups/healthsystem/providers/Microsoft.Compute/virtualMachines/eastussojai", + "associationName": "healthSystemMachineConfigAssociation", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": null + }, + "204": { + "headers": {}, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/getGuestDiagnosticSettings.json b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/getGuestDiagnosticSettings.json new file mode 100644 index 000000000000..09a003c11131 --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/getGuestDiagnosticSettings.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "187f412d-1758-44d9-b052-169e2564721d", + "resourceGroupName": "Default-ResourceGroup", + "diagnosticSettingsName": "productionMachineSetting", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-ResourceGroup/providers/microsoft.insights/guestDiagnosticSettings/productionMachineSetting", + "name": "productionMachineSetting", + "type": "Microsoft.Insights/guestDiagnosticSettings", + "location": "West US", + "tags": {}, + "properties": { + "osType": "windows", + "dataSources": [ + { + "kind": "PerformanceCounter", + "configuration": { + "perfCounters": [ + { + "name": "\\Process(_Total)\\%Processor Time", + "samplingPeriod": "PT1M" + }, + { + "name": "\\Process(_Total)\\Working Set", + "samplingPeriod": "PT1M" + } + ] + }, + "sinks": [ + { + "kind": "LogAnalytics" + } + ] + }, + { + "kind": "ETWProviders", + "configuration": { + "providers": [ + { + "name": "AuditLog", + "id": 1, + "filter": "filter exp" + }, + { + "name": "TraceLog", + "id": 2 + } + ] + }, + "sinks": [ + { + "kind": "LogAnalytics" + } + ] + }, + { + "kind": "WindowsEventLogs", + "configuration": { + "eventLogs": [ + { + "logName": "Application", + "filter": "SourceName == Xyz AND EventId = \"100\" AND $Xpath/Column=\"DCName\" = \"CatWoman\"" + + }, + { + "logName": "Application", + "filter": "SourceName == Xyz AND EventId = \"100\" AND $Xpath/Column=\"DCName\" = \"BatMan\"" + } + + ] + }, + "sinks": [ + { + "kind": "LogAnalytics" + } + ] + } + + ] + } + } + }, + "202": { + "headers": {}, + "body": { + "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-ResourceGroup/providers/microsoft.insights/guestDiagnosticSettings/productionMachineSetting", + "name": "productionMachineSetting", + "type": "Microsoft.Insights/guestDiagnosticSettings", + "location": "West US", + "tags": {}, + "properties": { + "osType": "windows", + "dataSources": [ + { + "kind": "PerformanceCounter", + "configuration": { + "perfCounters": [ + { + "name": "\\Process(_Total)\\%Processor Time", + "samplingPeriod": "PT1M" + }, + { + "name": "\\Process(_Total)\\Working Set", + "samplingPeriod": "PT1M" + } + ] + }, + "sinks": [ + { + "kind": "LogAnalytics" + } + ] + }, + { + "kind": "ETWProviders", + "configuration": { + "providers": [ + { + "name": "AuditLog", + "id": 1, + "filter": "filter exp" + }, + { + "name": "TraceLog", + "id": 2 + } + ] + }, + "sinks": [ + { + "kind": "LogAnalytics" + } + ] + }, + { + "kind": "WindowsEventLogs", + "configuration": { + "eventLogs": [ + { + "logName": "Application", + "filter": "SourceName == Xyz AND EventId = \"100\" AND $Xpath/Column=\"DCName\" = \"CatWoman\"" + + }, + { + "logName": "Application", + "filter": "SourceName == Xyz AND EventId = \"100\" AND $Xpath/Column=\"DCName\" = \"BatMan\"" + } + + ] + }, + "sinks": [ + { + "kind": "LogAnalytics" + } + ] + } + + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/getGuestDiagnosticSettingsAssociation.json b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/getGuestDiagnosticSettingsAssociation.json new file mode 100644 index 000000000000..5ee3afd4ef02 --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/getGuestDiagnosticSettingsAssociation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "resourceUri":"subscriptions/8498f01b-8064-4e37-856e-318f3c6c685f/resourceGroups/healthsystem/providers/Microsoft.Compute/virtualMachines/eastussojai", + "associationName": "healthSystemMachineConfigAssociation", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8498f01b-8064-4e37-856e-318f3c6c685f/resourceGroups/healthsystem/providers/Microsoft.Compute/virtualMachines/eastussojai/providers/microsoft.insights/guestDiagnosticSettingsAssociation/healthSystemMachineConfigAssociation", + "type": "Microsoft.Insights/GuestDiagnosticSettingsAssociation", + "name": "healthSystemMachineConfigAssociation", + "location": "Global", + "tags": {}, + "properties": { + "guestDiagnosticSettingsName": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-Association-ResourceGroup/providers/providers/microsoft.insights/guestDiagnosticSettings/SampleDiagnosticSettingsName" + } + } + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/updateGuestDiagnosticSettingsAssociation.json b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/updateGuestDiagnosticSettingsAssociation.json new file mode 100644 index 000000000000..e33341549273 --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/updateGuestDiagnosticSettingsAssociation.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceUri":"subscriptions/8498f01b-8064-4e37-856e-318f3c6c685f/resourceGroups/healthsystem/providers/Microsoft.Compute/virtualMachines/eastussojai", + "associationName": "healthSystemMachineConfigAssociation", + "api-version": "2018-06-01-preview", + "parameters": { + "tags": null, + "properties": { + "guestDiagnosticSettingsName": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-Association-ResourceGroup/providers/providers/microsoft.insights/guestDiagnosticSettings/vmSettingForSecurity" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8498f01b-8064-4e37-856e-318f3c6c685f/resourceGroups/healthsystem/providers/Microsoft.Compute/virtualMachines/eastussojai/providers/microsoft.insights/guestDiagnosticSettingsAssociation/healthSystemMachineConfigAssociation", + "type": "Microsoft.Insights/GuestDiagnosticSettingsAssociation", + "name": "healthSystemMachineConfigAssociation", + "location": "Global", + "tags": null, + "properties": { + "guestDiagnosticSettingsName": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-Association-ResourceGroup/providers/providers/microsoft.insights/guestDiagnosticSettings/vmSettingForSecurity" + } + } + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/guestDiagnosticSettingsAssociation_API.json b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/guestDiagnosticSettingsAssociation_API.json new file mode 100644 index 000000000000..80487b3dc64d --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/guestDiagnosticSettingsAssociation_API.json @@ -0,0 +1,444 @@ +{ + "swagger": "2.0", + "info": { + "title": "Guest Diagnostic Settings Association API", + "description": "API to Add/Remove/List Guest Diagnostics Settings Association for Azure Resources", + "x-ms-code-generation-settings": { + "name": "MonitorManagementClient" + }, + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{resourceUri}/providers/microsoft.insights/guestDiagnosticSettingsAssociation/{associationName}": { + "put": { + "description": "Creates or updates guest diagnostics settings association.", + "tags": [ + "GuestDiagnosticsSettingsAssociation" + ], + "operationId": "guestDiagnosticsSettingsAssociation_CreateOrUpdate", + "x-ms-examples": { + "Create or update an guest diagnostic settings association": { + "$ref": "./examples/createOrUpdateGuestDiagnosticSettingsAssociation.json" + } + }, + "parameters": [ + { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/DiagnosticSettingsAssociationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "diagnosticSettingsAssociation", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsAssociationResource" + }, + "description": "The diagnostic settings association to create or update." + } + ], + "responses": { + "200": { + "description": "An existing guest diagnostic settings association was successfully updated.", + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsAssociationResource" + } + }, + "201": { + "description": "A new guest diagnostic settings association was successfully created.", + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsAssociationResource" + } + }, + "default": { + "description": "An error occurred and the guest diagnostic settings association could not be created or updated.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "description": "Gets guest diagnostics association settings.", + "tags": [ + "GuestDiagnosticsSettingsAssociation" + ], + "operationId": "guestDiagnosticsSettingsAssociation_Get", + "x-ms-examples": { + "Create or update an guest diagnostic settings association": { + "$ref": "./examples/getGuestDiagnosticSettingsAssociation.json" + } + }, + "parameters": [ + { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/DiagnosticSettingsAssociationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request succeeded.", + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsAssociationResource" + } + }, + "default": { + "description": "An error occurred and the diagnostic settings association could not be retrieved.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "description": "Delete guest diagnostics association settings.", + "tags": [ + "GuestDiagnosticsSettingsAssociation" + ], + "x-ms-examples": { + "Create or update an guest diagnostic settings association": { + "$ref": "./examples/deleteGuestDiagnosticSettingsAssociation.json" + } + }, + "operationId": "GuestDiagnosticsSettingsAssociation_Delete", + "parameters": [ + { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/DiagnosticSettingsAssociationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The diagnostic settings association was successfully deleted." + }, + "204": { + "description": "The diagnostic settings association does not exist. It may have already been deleted." + }, + "default": { + "description": "An error occurred and the diagnostic settings association could not be deleted.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "description": "Updates an existing guestDiagnosticsSettingsAssociation Resource. To update other fields use the CreateOrUpdate method", + "operationId": "guestDiagnosticsSettingsAssociation_Update", + "parameters": [ + { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/DiagnosticSettingsAssociationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsAssociationResourcePatch" + }, + "description": "Parameters supplied to the operation." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "An existing guest diagnostics setting resource was successfully updated.", + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsAssociationResource" + } + } + }, + "x-ms-examples": { + "Update a service diagnostic setting": { "$ref": "./examples/updateGuestDiagnosticSettingsAssociation.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/microsoft.insights/guestDiagnosticSettingsAssociations": { + "get": { + "description": "Get a list of all guest diagnostic settings association in a subscription.", + "operationId": "guestDiagnosticsSettingsAssociation_List", + "x-ms-pageable": { + "nextLinkName": null + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request succeeded.", + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsAssociationList" + } + }, + "default": { + "description": "An error occurred and the list of guest diagnostic settings association could not be retrieved.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/guestDiagnosticSettingsAssociations": { + "get": { + "description": "Get a list of all guest diagnostic settings association in a resource group.", + "operationId": "guestDiagnosticsSettingsAssociation_ListByResourceGroup", + "x-ms-pageable": { + "nextLinkName": null + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request succeeded.", + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsAssociationList" + } + }, + "default": { + "description": "An error occurred and the list of guest diagnostic settings association could not be retrieved.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "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" + } + } + }, + "GuestDiagnosticSettingsAssociationList": { + "description": "A list of guest diagnostic settings association.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GuestDiagnosticSettingsAssociationResource" + }, + "description": "The list of guest diagnostic settings association." + }, + "nextLink": { + "type": "string", + "description": "Provides the link to retrieve the next set of elements." + } + } + }, + "GuestDiagnosticSettingsAssociationResourcePatch": { + "description": "Guest diagnostic setting resource for patch operations", + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GuestDiagnosticSettingsAssociation", + "description": "The service diagnostics settings for an update operation." + } + } + }, + "GuestDiagnosticSettingsAssociation": { + "description": "A guest diagnostic settings association.", + "properties": { + "guestDiagnosticSettingsName": { + "type": "string", + "description": "The guest diagnostic settings name." + } + }, + "required": [ + "guestDiagnosticSettingsName" + ] + }, + "GuestDiagnosticSettingsAssociationResource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GuestDiagnosticSettingsAssociation", + "description": "The diagnostics settings associations of the resource." + } + }, + "description": "Virtual machine guest diagnostic settings resource." + }, + "Resource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true, + "description": "An azure resource object" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription Id." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "DiagnosticSettingsAssociationNameParameter": { + "name": "associationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the diagnostic settings association.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } + } \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/guestDiagnosticSettings_API.json b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/guestDiagnosticSettings_API.json new file mode 100644 index 000000000000..092ba0613f6f --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/guestDiagnosticSettings_API.json @@ -0,0 +1,580 @@ +{ + "swagger": "2.0", + "info": { + "title": "Guest Diagnostic Settings API", + "description": "API to Add/Remove/List Guest Diagnostics Configuration to Azure Resources", + "x-ms-code-generation-settings": { + "name": "MonitorManagementClient" + }, + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/guestDiagnosticSettings/{diagnosticSettingsName}": { + "put": { + "description": "Creates or updates guest diagnostics settings.", + "tags": [ + "GuestDiagnosticsSettings" + ], + "operationId": "guestDiagnosticsSettings_CreateOrUpdate", + "x-ms-examples": { + "Create or update a guest diagnostic settings": { + "$ref": "./examples/createOrUpdateGuestDiagnosticSettings.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiagnosticSettingNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "diagnosticSettings", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsResource" + }, + "description": "The configuration to create or update." + } + ], + "responses": { + "200": { + "description": "An existing guest diagnostic settings was successfully updated.", + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsResource" + } + }, + "201": { + "description": "A new guest diagnostic settings was successfully created.", + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsResource" + } + }, + "default": { + "description": "An error occurred and the guest diagnostic settings could not be created or updated.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "description": "Gets guest diagnostics settings.", + "tags": [ + "GuestDiagnosticsSettings" + ], + "operationId": "guestDiagnosticsSettings_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiagnosticSettingNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request succeeded.", + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsResource" + } + }, + "default": { + "description": "An error occurred and the diagnostic settings could not be retrieved.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "description": "Updates guest diagnostics settings.", + "operationId": "guestDiagnosticsSettings_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiagnosticSettingNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsPatchResource" + }, + "description": "The configuration to patch." + } + ], + "responses": { + "200": { + "description": "An existing guest diagnostic settings was successfully updated.", + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsResource" + } + }, + "201": { + "description": "A new guest diagnostic settings was successfully created.", + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsResource" + } + }, + "default": { + "description": "An error occurred and the guest diagnostic settings could not be created or updated.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "description": "Delete guest diagnostics settings.", + "tags": [ + "GuestDiagnosticsSettings" + ], + "operationId": "guestDiagnosticsSettings_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiagnosticSettingNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The diagnostic settings was successfully deleted." + }, + "204": { + "description": "The diagnostic settings does not exist. It may have already been deleted." + }, + "default": { + "description": "An error occurred and the diagnostic settings could not be deleted.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/microsoft.insights/guestDiagnosticSettings": { + "get": { + "description": "Get a list of all guest diagnostic settings in a subscription.", + "operationId": "guestDiagnosticsSettings_List", + "x-ms-pageable": { + "nextLinkName": null + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request succeeded.", + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsList" + } + }, + "default": { + "description": "An error occurred and the list of guest diagnostic settings could not be retrieved.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/guestDiagnosticSettings": { + "get": { + "description": "Get a list of all guest diagnostic settings in a resource group.", + "operationId": "guestDiagnosticsSettings_ListByResourceGroup", + "x-ms-pageable": { + "nextLinkName": null + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request succeeded.", + "schema": { + "$ref": "#/definitions/GuestDiagnosticSettingsList" + } + }, + "default": { + "description": "An error occurred and the list of guest diagnostic settings could not be retrieved.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "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" + } + } + }, + "GuestDiagnosticSettingsList": { + "description": "A list of guest diagnostic settings.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GuestDiagnosticSettingsResource" + }, + "description": "The list of guest diagnostic settings." + }, + "nextLink": { + "type": "string", + "description": "Provides the link to retrieve the next set of elements." + } + } + }, + "GuestDiagnosticSettingsResource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GuestDiagnosticSettings", + "description": "The diagnostic settings to be applied to azure resources." + } + }, + "description": "Virtual machine guest diagnostics settings resource." + }, + "GuestDiagnosticSettings": { + "description": "Virtual machine diagnostic settings", + "properties": { + "osType": { + "type": "string", + "enum": [ + "Windows", + "Linux" + ], + "description" : "Operating system type for the configuration" + }, + "dataSources": { + "type": "array", + "items": { + "$ref": "#/definitions/DataSource" + }, + "description": "the array of data source object which are configured to collect and send data" + }, + "proxySetting": { + "type": "string" + } + } + }, + "GuestDiagnosticSettingsPatchResource": { + "description": "An diagnostic settings object for the body of patch operations.", + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GuestDiagnosticSettings", + "description": "The diagnostic settings for an update operation." + } + } + }, + "DataSource": { + "type": "object", + "required": [ + "kind", + "configuration", + "sinks" + ], + "properties": { + "kind": { + "type": "string", + "enum": [ + "PerformanceCounter", + "ETWProviders", + "WindowsEventLogs" + ], + "description": "Datasource kind" + }, + "configuration": { + "type": "object", + "$ref": "#/definitions/DataSourceConfiguration" + }, + "sinks": { + "type": "array", + "items": { + "$ref": "#/definitions/SinkConfiguration" + } + } + }, + "description": "Data source object contains configuration to collect telemetry and one or more sinks to send that telemetry data to" + }, + "SinkConfiguration": { + "type": "object", + "required": [ + "kind" + ], + "properties": { + "kind": { + "type": "string", + "enum": [ + "EventHub", + "ApplicationInsights", + "LogAnalytics" + ] + } + } + }, + "DataSourceConfiguration": { + "type": "object", + "properties": { + "providers": { + "type": "array", + "items": { + "$ref": "#/definitions/EtwProviderConfiguration" + }, + "description": "ETW providers configuration" + }, + "perfCounters": { + "type": "array", + "items": { + "$ref": "#/definitions/PerformanceCounterConfiguration" + }, + "description": "Performance counter configuration" + }, + "eventLogs": { + "type": "array", + "items": { + "$ref": "#/definitions/EventLogConfiguration" + }, + "description": "Windows event logs configuration." + } + } + }, + "EtwEventConfiguration": { + "type": "object", + "required": [ + "name", + "id" + ], + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "filter": { + "type": "string" + } + } + }, + "EtwProviderConfiguration": { + "type": "object", + "required": [ + "id", + "events" + ], + "properties": { + "id": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "$ref": "#/definitions/EtwEventConfiguration" + } + } + } + }, + "PerformanceCounterConfiguration": { + "type": "object", + "required": [ + "name", + "samplingPeriod" + ], + "properties": { + "name": { + "type": "string" + }, + "samplingPeriod": { + "type": "string" + }, + "instance": { + "type": "string" + } + } + }, + "EventLogConfiguration": { + "type": "object", + "required": [ + "logName" + ], + "properties": { + "logName": { + "type": "string" + }, + "filter": { + "type": "string" + } + } + }, + "Resource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true, + "description": "An azure resource object" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription Id." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "DiagnosticSettingNameParameter": { + "name": "diagnosticSettingsName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the diagnostic setting.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } + } \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/activityLogs_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/activityLogs_API.json index 016d1aa9f4e8..cccfc164c41b 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/activityLogs_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/activityLogs_API.json @@ -72,80 +72,6 @@ "description": "Successful request to get a page of events in the activity logs", "schema": { "$ref": "#/definitions/EventDataCollection" - }, - "examples": { - "application/json": { - "value": [ { - "authorization": { - "action": "microsoft.support/supporttickets/write", - "role": "Subscription Admin", - "scope": "/subscriptions/089bd33f-d4ec-47fe-8ba5-0753aa5c5b33/resourceGroups/MSSupportGroup/providers/microsoft.support/supporttickets/115012112305841" - }, - "caller": "admin@contoso.com", - "claims": { - "aud": "https://management.core.windows.net/", - "iss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", - "iat": "1421876371", - "nbf": "1421876371", - "exp": "1421880271", - "ver": "1.0", - "http://schemas.microsoft.com/identity/claims/tenantid": "1e8d8218-c5e7-4578-9acc-9abbd5d23315 ", - "http://schemas.microsoft.com/claims/authnmethodsreferences": "pwd", - "http://schemas.microsoft.com/identity/claims/objectidentifier": "2468adf0-8211-44e3-95xq-85137af64708", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn": "admin@contoso.com", - "puid": "20030000801A118C", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier": "9vckmEGF7zDKk1YzIY8k0t1_EAPaXoeHyPRn6f413zM", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname": "John", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname": "Smith", - "name": "John Smith", - "groups": "cacfe77c-e058-4712-83qw-f9b08849fd60,7f71d11d-4c41-4b23-99d2-d32ce7aa621c,31522864-0578-4ea0-9gdc-e66cc564d18c", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name": " admin@contoso.com", - "appid": "c44b4083-3bq0-49c1-b47d-974e53cbdf3c", - "appidacr": "2", - "http://schemas.microsoft.com/identity/claims/scope": "user_impersonation", - "http://schemas.microsoft.com/claims/authnclassreference": "1" - }, - "correlationId": "1e121103-0ba6-4300-ac9d-952bb5d0c80f", - "description": "", - "eventDataId": "44ade6b4-3813-45e6-ae27-7420a95fa2f8", - "eventName": { - "value": "EndRequest", - "localizedValue": "End request" - }, - "httpRequest": { - "clientRequestId": "27003b25-91d3-418f-8eb1-29e537dcb249", - "clientIpAddress": "192.168.35.115", - "method": "PUT" - }, - "id": "/subscriptions/089bd33f-d4ec-47fe-8ba5-0753aa5c5b33/resourceGroups/MSSupportGroup/providers/microsoft.support/supporttickets/115012112305841/events/44ade6b4-3813-45e6-ae27-7420a95fa2f8/ticks/635574752669792776", - "level": "Informational", - "resourceGroupName": "MSSupportGroup", - "resourceProviderName": { - "value": "microsoft.support", - "localizedValue": "microsoft.support" - }, - "operationId": "1e121103-0ba6-4300-ac9d-952bb5d0c80f", - "operationName": { - "value": "microsoft.support/supporttickets/write", - "localizedValue": "microsoft.support/supporttickets/write" - }, - "properties": { - "statusCode": "Created" - }, - "status": { - "value": "Succeeded", - "localizedValue": "Succeeded" - }, - "subStatus": { - "value": "Created", - "localizedValue": "Created (HTTP Status Code: 201)" - }, - "eventTimestamp": "2015-01-21T22:14:26.9792776Z", - "submissionTimestamp": "2015-01-21T22:14:39.9936304Z", - "subscriptionId": "089bd33f-d4ec-47fe-8ba5-0753aa5c5b33" - } ], - "nextLink": "https://management.azure.com/########-####-####-####-############$skiptoken=######" - } } } }, @@ -219,7 +145,8 @@ "properties": { "authorization": { "readOnly": true, - "$ref": "#/definitions/SenderAuthorization" + "$ref": "#/definitions/SenderAuthorization", + "description": "The sender authorization information." }, "claims": { "readOnly": true, diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/autoscale_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/autoscale_API.json index 598d6defb9df..8f10d6e0e042 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/autoscale_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/autoscale_API.json @@ -65,143 +65,6 @@ "description": "Successful request for a list of autoscale settings", "schema": { "$ref": "#/definitions/AutoscaleSettingResourceCollection" - }, - "examples": { - "application/json": { - "value" : [ - { - "id" : "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/microsoft.insights/autoscalesettings/MySetting", - "name" : "MySetting", - "type" : "Microsoft.Insights/autoscaleSettings", - "location" : "West US", - "tags" : { - "$type" : "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage" - }, - "properties" : { - "profiles" : [{ - "name" : "adios", - "capacity" : { - "minimum" : "1", - "maximum" : "10", - "default" : "1" - }, - "rules" : [{ - "metricTrigger" : { - "metricName" : "Percentage CPU", - "metricResourceUri" : "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain" : "PT1M", - "statistic" : "Average", - "timeWindow" : "PT5M", - "timeAggregation" : "Average", - "operator" : "GreaterThan", - "threshold" : 10.0 - }, - "scaleAction" : { - "direction" : "Increase", - "type" : "ChangeCount", - "value" : "1", - "cooldown" : "PT5M" - } - }, { - "metricTrigger" : { - "metricName" : "Percentage CPU", - "metricResourceUri" : "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain" : "PT2M", - "statistic" : "Average", - "timeWindow" : "PT5M", - "timeAggregation" : "Average", - "operator" : "GreaterThan", - "threshold" : 15.0 - }, - "scaleAction" : { - "direction" : "Decrease", - "type" : "ChangeCount", - "value" : "2", - "cooldown" : "PT6M" - } - } - ], - "fixedDate" : { - "timeZone" : "UTC", - "start" : "2015-03-05T14:00:00Z", - "end" : "2015-03-05T14:30:00Z" - } - }, { - "name" : "saludos", - "capacity" : { - "minimum" : "1", - "maximum" : "10", - "default" : "1" - }, - "rules" : [{ - "metricTrigger" : { - "metricName" : "Percentage CPU", - "metricResourceUri" : "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain" : "PT1M", - "statistic" : "Average", - "timeWindow" : "PT5M", - "timeAggregation" : "Average", - "operator" : "GreaterThan", - "threshold" : 10.0 - }, - "scaleAction" : { - "direction" : "Increase", - "type" : "ChangeCount", - "value" : "1", - "cooldown" : "PT5M" - } - }, { - "metricTrigger" : { - "metricName" : "Percentage CPU", - "metricResourceUri" : "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain" : "PT2M", - "statistic" : "Average", - "timeWindow" : "PT5M", - "timeAggregation" : "Average", - "operator" : "GreaterThan", - "threshold" : 15.0 - }, - "scaleAction" : { - "direction" : "Decrease", - "type" : "ChangeCount", - "value" : "2", - "cooldown" : "PT6M" - } - } - ], - "recurrence" : { - "frequency" : "Week", - "schedule" : { - "timeZone" : "UTC", - "days" : ["1"], - "hours" : [5], - "minutes" : [15] - } - } - } - ], - "enabled" : true, - "name" : "MySetting", - "targetResourceUri" : "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "notifications" : [{ - "operation" : "Scale", - "email" : { - "sendToSubscriptionAdministrator" : true, - "sendToSubscriptionCoAdministrators" : true, - "customEmails" : ["gu@ms.com", "ge@ns.net"] - }, - "webhooks" : [{ - "serviceUri" : "http://myservice.com", - "properties" : {} - } - ] - } - ] - } - } - ], - "nextLink": "https://management.azure.com/########-####-####-####-############$skiptoken=######" - } } } }, @@ -254,310 +117,12 @@ "description": "Successful request to create or update an autoscale setting", "schema": { "$ref": "#/definitions/AutoscaleSettingResource" - }, - "examples": { - "application/json": { - "id":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/microsoft.insights/autoscalesettings/MySetting", - "name":"MySetting", - "type":"Microsoft.Insights/autoscaleSettings", - "location":"West US", - "tags": { - "$type":"Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage" - }, - "properties": { - "profiles": [ - { - "name":"adios", - "capacity": { - "minimum":"1", - "maximum":"10", - "default":"1" - }, - "rules": [ - { - "metricTrigger": { - "metricName":"Percentage CPU", - "metricResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain":"PT1M", - "statistic":"Average", - "timeWindow":"PT5M", - "timeAggregation":"Average", - "operator":"GreaterThan", - "threshold":10.0 - }, - "scaleAction": { - "direction":"Increase", - "type":"ChangeCount", - "value":"1", - "cooldown":"PT5M" - } - }, - { - "metricTrigger": { - "metricName":"Percentage CPU", - "metricResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain":"PT2M", - "statistic":"Average", - "timeWindow":"PT5M", - "timeAggregation":"Average", - "operator":"GreaterThan", - "threshold":15.0 - }, - "scaleAction": { - "direction":"Decrease", - "type":"ChangeCount", - "value":"2", - "cooldown":"PT6M" - } - } - ], - "fixedDate": { - "timeZone":"UTC", - "start":"2015-03-05T14:00:00Z", - "end":"2015-03-05T14:30:00Z" - } - }, - { - "name":"saludos", - "capacity": { - "minimum":"1", - "maximum":"10", - "default":"1" - }, - "rules": [ - { - "metricTrigger": { - "metricName":"Percentage CPU", - "metricResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain":"PT1M", - "statistic":"Average", - "timeWindow":"PT5M", - "timeAggregation":"Average", - "operator":"GreaterThan", - "threshold":10.0 - }, - "scaleAction": { - "direction":"Increase", - "type":"ChangeCount", - "value":"1", - "cooldown":"PT5M" - } - }, - { - "metricTrigger": { - "metricName":"Percentage CPU", - "metricResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain":"PT2M", - "statistic":"Average", - "timeWindow":"PT5M", - "timeAggregation":"Average", - "operator":"GreaterThan", - "threshold":15.0 - }, - "scaleAction": { - "direction":"Decrease", - "type":"ChangeCount", - "value":"2", - "cooldown":"PT6M" - } - } - ], - "recurrence": { - "frequency":"Week", - "schedule": { - "timeZone":"UTC", - "days": [ - "1" - ], - "hours": [ - 5 - ], - "minutes": [ - 15 - ] - } - } - } - ], - "enabled":true, - "name":"MySetting", - "targetResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "notifications": [ - { - "operation":"Scale", - "email": { - "sendToSubscriptionAdministrator":true, - "sendToSubscriptionCoAdministrators":true, - "customEmails": [ - "gu@ms.com", - "ge@ns.net" - ] - }, - "webhooks": [ - { - "serviceUri":"http://myservice.com", - "properties":{} - } - ] - } - ] - } - } } }, "201": { "description": "Created autoscale setting", "schema": { "$ref": "#/definitions/AutoscaleSettingResource" - }, - "examples": { - "application/json": { - "id":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/microsoft.insights/autoscalesettings/MySetting", - "name":"MySetting", - "type":"Microsoft.Insights/autoscaleSettings", - "location":"West US", - "tags": { - "$type":"Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage" - }, - "properties": { - "profiles": [ - { - "name":"adios", - "capacity": { - "minimum":"1", - "maximum":"10", - "default":"1" - }, - "rules": [ - { - "metricTrigger": { - "metricName":"Percentage CPU", - "metricResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain":"PT1M", - "statistic":"Average", - "timeWindow":"PT5M", - "timeAggregation":"Average", - "operator":"GreaterThan", - "threshold":10.0 - }, - "scaleAction": { - "direction":"Increase", - "type":"ChangeCount", - "value":"1", - "cooldown":"PT5M" - } - }, - { - "metricTrigger": { - "metricName":"Percentage CPU", - "metricResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain":"PT2M", - "statistic":"Average", - "timeWindow":"PT5M", - "timeAggregation":"Average", - "operator":"GreaterThan", - "threshold":15.0 - }, - "scaleAction": { - "direction":"Decrease", - "type":"ChangeCount", - "value":"2", - "cooldown":"PT6M" - } - } - ], - "fixedDate": { - "timeZone":"UTC", - "start":"2015-03-05T14:00:00Z", - "end":"2015-03-05T14:30:00Z" - } - }, - { - "name":"saludos", - "capacity": { - "minimum":"1", - "maximum":"10", - "default":"1" - }, - "rules": [ - { - "metricTrigger": { - "metricName":"Percentage CPU", - "metricResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain":"PT1M", - "statistic":"Average", - "timeWindow":"PT5M", - "timeAggregation":"Average", - "operator":"GreaterThan", - "threshold":10.0 - }, - "scaleAction": { - "direction":"Increase", - "type":"ChangeCount", - "value":"1", - "cooldown":"PT5M" - } - }, - { - "metricTrigger": { - "metricName":"Percentage CPU", - "metricResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain":"PT2M", - "statistic":"Average", - "timeWindow":"PT5M", - "timeAggregation":"Average", - "operator":"GreaterThan", - "threshold":15.0 - }, - "scaleAction": { - "direction":"Decrease", - "type":"ChangeCount", - "value":"2", - "cooldown":"PT6M" - } - } - ], - "recurrence": { - "frequency":"Week", - "schedule": { - "timeZone":"UTC", - "days": [ - "1" - ], - "hours": [ - 5 - ], - "minutes": [ - 15 - ] - } - } - } - ], - "enabled":true, - "name":"MySetting", - "targetResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "notifications": [ - { - "operation":"Scale", - "email": { - "sendToSubscriptionAdministrator":true, - "sendToSubscriptionCoAdministrators":true, - "customEmails": [ - "gu@ms.com", - "ge@ns.net" - ] - }, - "webhooks": [ - { - "serviceUri":"http://myservice.com", - "properties":{} - } - ] - } - ] - } - } } } }, @@ -634,155 +199,6 @@ "description": "Successful request to get one autoscale setting", "schema": { "$ref": "#/definitions/AutoscaleSettingResource" - }, - "examples": { - "application/json": { - "id":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/microsoft.insights/autoscalesettings/MySetting", - "name":"MySetting", - "type":"Microsoft.Insights/autoscaleSettings", - "location":"West US", - "tags": { - "$type":"Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage" - }, - "properties": { - "profiles": [ - { - "name":"adios", - "capacity": { - "minimum":"1", - "maximum":"10", - "default":"1" - }, - "rules": [ - { - "metricTrigger": { - "metricName":"Percentage CPU", - "metricResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain":"PT1M", - "statistic":"Average", - "timeWindow":"PT5M", - "timeAggregation":"Average", - "operator":"GreaterThan", - "threshold":10.0 - }, - "scaleAction": { - "direction":"Increase", - "type":"ChangeCount", - "value":"1", - "cooldown":"PT5M" - } - }, - { - "metricTrigger": { - "metricName":"Percentage CPU", - "metricResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain":"PT2M", - "statistic":"Average", - "timeWindow":"PT5M", - "timeAggregation":"Average", - "operator":"GreaterThan", - "threshold":15.0 - }, - "scaleAction": { - "direction":"Decrease", - "type":"ChangeCount", - "value":"2", - "cooldown":"PT6M" - } - } - ], - "fixedDate": { - "timeZone":"UTC", - "start":"2015-03-05T14:00:00Z", - "end":"2015-03-05T14:30:00Z" - } - }, - { - "name":"saludos", - "capacity": { - "minimum":"1", - "maximum":"10", - "default":"1" - }, - "rules": [ - { - "metricTrigger": { - "metricName":"Percentage CPU", - "metricResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain":"PT1M", - "statistic":"Average", - "timeWindow":"PT5M", - "timeAggregation":"Average", - "operator":"GreaterThan", - "threshold":10.0 - }, - "scaleAction": { - "direction":"Increase", - "type":"ChangeCount", - "value":"1", - "cooldown":"PT5M" - } - }, - { - "metricTrigger": { - "metricName":"Percentage CPU", - "metricResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "timeGrain":"PT2M", - "statistic":"Average", - "timeWindow":"PT5M", - "timeAggregation":"Average", - "operator":"GreaterThan", - "threshold":15.0 - }, - "scaleAction": { - "direction":"Decrease", - "type":"ChangeCount", - "value":"2", - "cooldown":"PT6M" - } - } - ], - "recurrence": { - "frequency":"Week", - "schedule": { - "timeZone":"UTC", - "days": [ - "1" - ], - "hours": [ - 5 - ], - "minutes": [ - 15 - ] - } - } - } - ], - "enabled":true, - "name":"MySetting", - "targetResourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", - "notifications": [ - { - "operation":"Scale", - "email": { - "sendToSubscriptionAdministrator":true, - "sendToSubscriptionCoAdministrators":true, - "customEmails": [ - "gu@ms.com", - "ge@ns.net" - ] - }, - "webhooks": [ - { - "serviceUri":"http://myservice.com", - "properties":{} - } - ] - } - ] - } - } } } }, @@ -834,6 +250,43 @@ "Patch an autoscale setting": { "$ref": "./examples/patchAutoscaleSetting.json" } } } + }, + "/subscriptions/{subscriptionId}/providers/microsoft.insights/autoscalesettings": { + "get": { + "description": "Lists the autoscale settings for a subscription", + "tags": [ + "AutoscaleSettings" + ], + "operationId": "AutoscaleSettings_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request for a list of autoscale settings", + "schema": { + "$ref": "#/definitions/AutoscaleSettingResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List autoscale settings": { "$ref": "./examples/listAutoscaleSettingBySubscription.json" } + } + } } }, "definitions": { @@ -1091,16 +544,9 @@ "properties": { "frequency": { "type": "string", - "description": "the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles.", + "description": "the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set **schedule** to every day of the week. The frequency property specifies that the schedule is repeated weekly.", "enum": [ - "None", - "Second", - "Minute", - "Hour", - "Day", - "Week", - "Month", - "Year" + "Week" ], "x-ms-enum": { "name": "RecurrenceFrequency", diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/listAutoscaleSettingBySubscription.json b/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/listAutoscaleSettingBySubscription.json new file mode 100644 index 000000000000..134f3ed6bb91 --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/listAutoscaleSettingBySubscription.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "subscriptionId": "b67f7fec-69fc-4974-9099-a26bd6ffeda3", + "api-version": "2015-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value" : [ + { + "id" : "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/microsoft.insights/autoscalesettings/MySetting", + "name" : "MySetting", + "type" : "Microsoft.Insights/autoscaleSettings", + "location" : "West US", + "tags" : { + "$type" : "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage" + }, + "properties" : { + "profiles" : [{ + "name" : "adios", + "capacity" : { + "minimum" : "1", + "maximum" : "10", + "default" : "1" + }, + "rules" : [{ + "metricTrigger" : { + "metricName" : "Percentage CPU", + "metricResourceUri" : "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain" : "PT1M", + "statistic" : "Average", + "timeWindow" : "PT5M", + "timeAggregation" : "Average", + "operator" : "GreaterThan", + "threshold" : 10.0 + }, + "scaleAction" : { + "direction" : "Increase", + "type" : "ChangeCount", + "value" : "1", + "cooldown" : "PT5M" + } + }, { + "metricTrigger" : { + "metricName" : "Percentage CPU", + "metricResourceUri" : "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain" : "PT2M", + "statistic" : "Average", + "timeWindow" : "PT5M", + "timeAggregation" : "Average", + "operator" : "GreaterThan", + "threshold" : 15.0 + }, + "scaleAction" : { + "direction" : "Decrease", + "type" : "ChangeCount", + "value" : "2", + "cooldown" : "PT6M" + } + } + ], + "fixedDate" : { + "timeZone" : "UTC", + "start" : "2015-03-05T14:00:00Z", + "end" : "2015-03-05T14:30:00Z" + } + }, { + "name" : "saludos", + "capacity" : { + "minimum" : "1", + "maximum" : "10", + "default" : "1" + }, + "rules" : [{ + "metricTrigger" : { + "metricName" : "Percentage CPU", + "metricResourceUri" : "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain" : "PT1M", + "statistic" : "Average", + "timeWindow" : "PT5M", + "timeAggregation" : "Average", + "operator" : "GreaterThan", + "threshold" : 10.0 + }, + "scaleAction" : { + "direction" : "Increase", + "type" : "ChangeCount", + "value" : "1", + "cooldown" : "PT5M" + } + }, { + "metricTrigger" : { + "metricName" : "Percentage CPU", + "metricResourceUri" : "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "timeGrain" : "PT2M", + "statistic" : "Average", + "timeWindow" : "PT5M", + "timeAggregation" : "Average", + "operator" : "GreaterThan", + "threshold" : 15.0 + }, + "scaleAction" : { + "direction" : "Decrease", + "type" : "ChangeCount", + "value" : "2", + "cooldown" : "PT6M" + } + } + ], + "recurrence" : { + "frequency" : "Week", + "schedule" : { + "timeZone" : "UTC", + "days" : ["1"], + "hours" : [5], + "minutes" : [15] + } + } + } + ], + "enabled" : true, + "name" : "MySetting", + "targetResourceUri" : "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/TestingMetricsScaleSet/providers/Microsoft.Compute/virtualMachineScaleSets/testingsc", + "notifications" : [{ + "operation" : "Scale", + "email" : { + "sendToSubscriptionAdministrator" : true, + "sendToSubscriptionCoAdministrators" : true, + "customEmails" : ["gu@ms.com", "ge@ns.net"] + }, + "webhooks" : [{ + "serviceUri" : "http://myservice.com", + "properties" : {} + } + ] + } + ] + } + } + ], + "nextLink": "https://management.azure.com/########-####-####-####-############$skiptoken=######" + } + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/tenantActivityLogs_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/tenantActivityLogs_API.json index b5de6e1a953d..3a4bbdb55dc4 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/tenantActivityLogs_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/tenantActivityLogs_API.json @@ -69,80 +69,6 @@ "description": "Successful request to get a page of events in the tenant activity logs", "schema": { "$ref": "#/definitions/EventDataCollection" - }, - "examples": { - "application/json": { - "value": [ { - "authorization": { - "action": "microsoft.support/supporttickets/write", - "role": "Subscription Admin", - "scope": "/subscriptions/089bd33f-d4ec-47fe-8ba5-0753aa5c5b33/resourceGroups/MSSupportGroup/providers/microsoft.support/supporttickets/115012112305841" - }, - "caller": "admin@contoso.com", - "claims": { - "aud": "https://management.core.windows.net/", - "iss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", - "iat": "1421876371", - "nbf": "1421876371", - "exp": "1421880271", - "ver": "1.0", - "http://schemas.microsoft.com/identity/claims/tenantid": "1e8d8218-c5e7-4578-9acc-9abbd5d23315 ", - "http://schemas.microsoft.com/claims/authnmethodsreferences": "pwd", - "http://schemas.microsoft.com/identity/claims/objectidentifier": "2468adf0-8211-44e3-95xq-85137af64708", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn": "admin@contoso.com", - "puid": "20030000801A118C", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier": "9vckmEGF7zDKk1YzIY8k0t1_EAPaXoeHyPRn6f413zM", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname": "John", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname": "Smith", - "name": "John Smith", - "groups": "cacfe77c-e058-4712-83qw-f9b08849fd60,7f71d11d-4c41-4b23-99d2-d32ce7aa621c,31522864-0578-4ea0-9gdc-e66cc564d18c", - "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name": " admin@contoso.com", - "appid": "c44b4083-3bq0-49c1-b47d-974e53cbdf3c", - "appidacr": "2", - "http://schemas.microsoft.com/identity/claims/scope": "user_impersonation", - "http://schemas.microsoft.com/claims/authnclassreference": "1" - }, - "correlationId": "1e121103-0ba6-4300-ac9d-952bb5d0c80f", - "description": "", - "eventDataId": "44ade6b4-3813-45e6-ae27-7420a95fa2f8", - "eventName": { - "value": "EndRequest", - "localizedValue": "End request" - }, - "httpRequest": { - "clientRequestId": "27003b25-91d3-418f-8eb1-29e537dcb249", - "clientIpAddress": "192.168.35.115", - "method": "PUT" - }, - "id": "/subscriptions/089bd33f-d4ec-47fe-8ba5-0753aa5c5b33/resourceGroups/MSSupportGroup/providers/microsoft.support/supporttickets/115012112305841/events/44ade6b4-3813-45e6-ae27-7420a95fa2f8/ticks/635574752669792776", - "level": "Informational", - "resourceGroupName": "MSSupportGroup", - "resourceProviderName": { - "value": "microsoft.support", - "localizedValue": "microsoft.support" - }, - "operationId": "1e121103-0ba6-4300-ac9d-952bb5d0c80f", - "operationName": { - "value": "microsoft.support/supporttickets/write", - "localizedValue": "microsoft.support/supporttickets/write" - }, - "properties": { - "statusCode": "Created" - }, - "status": { - "value": "Succeeded", - "localizedValue": "Succeeded" - }, - "subStatus": { - "value": "Created", - "localizedValue": "Created (HTTP Status Code: 201)" - }, - "eventTimestamp": "2015-01-21T22:14:26.9792776Z", - "submissionTimestamp": "2015-01-21T22:14:39.9936304Z", - "subscriptionId": "089bd33f-d4ec-47fe-8ba5-0753aa5c5b33" - } ], - "nextLink": "https://management.azure.com/########-####-####-####-############$skiptoken=######" - } } } }, @@ -216,7 +142,8 @@ "properties": { "authorization": { "readOnly": true, - "$ref": "#/definitions/SenderAuthorization" + "$ref": "#/definitions/SenderAuthorization", + "description": "The sender authorization information." }, "claims": { "readOnly": true, diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/alertRules_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/alertRules_API.json index 91a8f5860eae..c7d1732feece 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/alertRules_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/alertRules_API.json @@ -77,72 +77,12 @@ "description": "Successful request to update an alert rule", "schema": { "$ref": "#/definitions/AlertRuleResource" - }, - "examples": { - "application/json": { - "id":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin", - "name":"chiricutin", - "type":"Microsoft.Insights/alertRules", - "location":"West US", - "tags": { - "$type":"Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage","hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest":"Resource" - }, - "properties": { - "name":"chiricutin", - "description":"Pura Vida", - "isEnabled":true, - "condition": { - "odata.type":"Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition", - "dataSource": { - "odata.type":"Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource", - "resourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest", - "metricName":"Requests" - }, - "operator":"GreaterThan", - "threshold":3.0, - "windowSize":"PT5M", - "timeAggregation":"Total" - }, - "lastUpdatedTime":"2016-11-23T21:23:52.0221265Z", - "actions":[] - } - } } }, "201": { "description": "Created alert rule", "schema": { "$ref": "#/definitions/AlertRuleResource" - }, - "examples": { - "application/json": { - "id":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin", - "name":"chiricutin", - "type":"Microsoft.Insights/alertRules", - "location":"West US", - "tags": { - "$type":"Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage","hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest":"Resource" - }, - "properties": { - "name":"chiricutin", - "description":"Pura Vida", - "isEnabled":true, - "condition": { - "odata.type":"Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition", - "dataSource": { - "odata.type":"Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource", - "resourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest", - "metricName":"Requests" - }, - "operator":"GreaterThan", - "threshold":2.0, - "windowSize":"PT5M", - "timeAggregation":"Total" - }, - "lastUpdatedTime":"2016-11-23T21:21:40.3097118Z", - "actions":[] - } - } } } }, @@ -207,36 +147,6 @@ "description": "Successful request to get an alert rule", "schema": { "$ref": "#/definitions/AlertRuleResource" - }, - "examples": { - "application/json": { - "id":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin0", - "name":"chiricutin0", - "type":"Microsoft.Insights/alertRules", - "location":"West US", - "tags": { - "$type":"Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage","hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest":"Resource" - }, - "properties": { - "name":"chiricutin0", - "description":"Pura Vida 0", - "isEnabled":true, - "condition": { - "odata.type":"Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition", - "dataSource": { - "odata.type":"Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource", - "resourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest", - "metricName":"Requests" - }, - "operator":"GreaterThan", - "threshold":2.0, - "windowSize":"PT5M", - "timeAggregation":"Total" - }, - "lastUpdatedTime":"2016-11-10T21:04:39.1082596Z", - "actions":[] - } - } } } }, @@ -281,72 +191,12 @@ "description": "Successful request to update an alert rule", "schema": { "$ref": "#/definitions/AlertRuleResource" - }, - "examples": { - "application/json": { - "id":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin", - "name":"chiricutin", - "type":"Microsoft.Insights/alertRules", - "location":"West US", - "tags": { - "$type":"Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage","hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest2":"Resource" - }, - "properties": { - "name":"chiricutin", - "description":"Pura Vida", - "isEnabled":false, - "condition": { - "odata.type":"Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition", - "dataSource": { - "odata.type":"Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource", - "resourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest", - "metricName":"Requests" - }, - "operator":"GreaterThan", - "threshold":3.0, - "windowSize":"PT5M", - "timeAggregation":"Total" - }, - "lastUpdatedTime":"2016-11-23T21:23:52.0221265Z", - "actions":[] - } - } } }, "201": { "description": "Successful request to update an alert rule that resulted in a creation of the alert rule", "schema": { "$ref": "#/definitions/AlertRuleResource" - }, - "examples": { - "application/json": { - "id":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin", - "name":"chiricutin", - "type":"Microsoft.Insights/alertRules", - "location":"West US", - "tags": { - "$type":"Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage","hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest2":"Resource" - }, - "properties": { - "name":"chiricutin", - "description":"Pura Vida", - "isEnabled":false, - "condition": { - "odata.type":"Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition", - "dataSource": { - "odata.type":"Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource", - "resourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest", - "metricName":"Requests" - }, - "operator":"GreaterThan", - "threshold":3.0, - "windowSize":"PT5M", - "timeAggregation":"Total" - }, - "lastUpdatedTime":"2016-11-23T21:23:52.0221265Z", - "actions":[] - } - } } } }, @@ -378,77 +228,6 @@ "description": "Successful request for a list of alert rules", "schema": { "$ref": "#/definitions/AlertRuleResourceCollection" - }, - "examples": { - "application/json": { - "value": [ - { - "id":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/{ruleName}", - "name":"{ruleName}", - "type":"Microsoft.Insights/alertRules", - "location":"West US", - "tags": { - "$type":"Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage","hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest":"Resource" - }, - "properties": { - "name":"{ruleName}", - "description":"Pura Vida", - "isEnabled":true, - "condition": { - "odata.type":"Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition", - "dataSource": { - "odata.type":"Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource", - "resourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest", - "metricName":"Requests" - }, - "operator":"GreaterThan", - "threshold":2.0, - "windowSize":"PT5M", - "timeAggregation":"Total" - }, - "lastUpdatedTime":"2016-11-10T21:04:39.0005255Z", - "actions": [ - { - "odata.type":"Microsoft.Azure.Management.Insights.Models.RuleEmailAction", - "sendToServiceOwners":true, - "customEmails": [ - "gu@ms.com", - "su@ms.net" - ] - } - ] - } - }, - { - "id":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin0", - "name":"chiricutin0", - "type":"Microsoft.Insights/alertRules", - "location":"West US", - "tags": { - "$type":"Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage","hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest":"Resource" - }, - "properties": { - "name":"chiricutin0", - "description":"Pura Vida 0", - "isEnabled":true, - "condition": { - "odata.type":"Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition", - "dataSource": { - "odata.type":"Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource", - "resourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest", - "metricName":"Requests" - }, - "operator":"GreaterThan", - "threshold":2.0, - "windowSize":"PT5M", - "timeAggregation":"Total" - }, - "lastUpdatedTime":"2016-11-10T21:04:39.1082596Z", - "actions":[] - } - } - ] - } } } }, @@ -459,6 +238,37 @@ "List alert rules": { "$ref": "./examples/listAlertRule.json" } } } + }, + "/subscriptions/{subscriptionId}/providers/microsoft.insights/alertrules": { + "get": { + "tags": [ + "AlertRules" + ], + "operationId": "AlertRules_ListBySubscription", + "description": "List the alert rules within a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for a list of alert rules", + "schema": { + "$ref": "#/definitions/AlertRuleResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List alert rules": { "$ref": "./examples/listAlertRuleBySubscription.json" } + } + } } }, "definitions": { diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/listAlertRuleBySubscription.json b/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/listAlertRuleBySubscription.json new file mode 100644 index 000000000000..bd048421d8cc --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/listAlertRuleBySubscription.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "b67f7fec-69fc-4974-9099-a26bd6ffeda3", + "api-version": "2016-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/myRuleName", + "name":"myRuleName", + "type":"Microsoft.Insights/alertRules", + "location":"West US", + "tags": { + "$type":"Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage","hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest":"Resource" + }, + "properties": { + "name":"myRuleName", + "description":"Pura Vida", + "isEnabled":true, + "condition": { + "odata.type":"Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition", + "dataSource": { + "odata.type":"Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource", + "resourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest", + "metricName":"Requests" + }, + "operator":"GreaterThan", + "threshold":2.0, + "windowSize":"PT5M", + "timeAggregation":"Total" + }, + "lastUpdatedTime":"2016-11-10T21:04:39.0005255Z", + "actions": [ + { + "odata.type":"Microsoft.Azure.Management.Insights.Models.RuleEmailAction", + "sendToServiceOwners":true, + "customEmails": [ + "gu@ms.com", + "su@ms.net" + ] + } + ] + } + }, + { + "id":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin0", + "name":"chiricutin0", + "type":"Microsoft.Insights/alertRules", + "location":"West US", + "tags": { + "$type":"Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage","hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest":"Resource" + }, + "properties": { + "name":"chiricutin0", + "description":"Pura Vida 0", + "isEnabled":true, + "condition": { + "odata.type":"Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition", + "dataSource": { + "odata.type":"Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource", + "resourceUri":"/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest", + "metricName":"Requests" + }, + "operator":"GreaterThan", + "threshold":2.0, + "windowSize":"PT5M", + "timeAggregation":"Total" + }, + "lastUpdatedTime":"2016-11-10T21:04:39.1082596Z", + "actions":[] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/logProfiles_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/logProfiles_API.json index 18d1866bf8c4..b7a79b53ef2c 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/logProfiles_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/logProfiles_API.json @@ -91,31 +91,6 @@ "description": "Successful request to get more information about a log profile.", "schema": { "$ref": "#/definitions/LogProfileResource" - }, - "examples": { - "application/json": { - "id":"/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/providers/microsoft.insights/logprofiles/default", - "type":"", - "name":"default", - "location":"", - "tags":null, - "properties": { - "storageAccountId":"/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8162", - "serviceBusRuleId":"", - "locations": [ - "global" - ], - "categories": [ - "Delete", - "Write", - "Action" - ], - "retentionPolicy": { - "enabled":true, - "days":3 - } - } - } } } }, @@ -154,31 +129,6 @@ "description": "Successful request to create or update a log profile", "schema": { "$ref": "#/definitions/LogProfileResource" - }, - "examples": { - "application/json": { - "id":"/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/providers/microsoft.insights/logprofiles/default", - "type":"", - "name":"default", - "location":"", - "tags":null, - "properties": { - "storageAccountId":"/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8162", - "serviceBusRuleId":"", - "locations":[ - "global" - ], - "categories": [ - "Delete", - "Write", - "Action" - ], - "retentionPolicy": { - "enabled":true, - "days":3 - } - } - } } } }, diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/examples/updateServiceDiagnosticSetting.json b/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/examples/updateServiceDiagnosticSetting.json index 9dc9115491a0..da047720e4ff 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/examples/updateServiceDiagnosticSetting.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/examples/updateServiceDiagnosticSetting.json @@ -2,7 +2,7 @@ "parameters": { "resourceUri": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6", "api-version": "2016-09-01", - "serviceDiagnosticSettingsResource": { + "parameters": { "tags": null, "properties": { "storageAccountId":"/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1", diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/metrics_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/metrics_API.json index 88d7c33ef9f3..061139f29e94 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/metrics_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/metrics_API.json @@ -42,7 +42,7 @@ "description": "Lists the metric values for a resource.", "parameters": [ { - "$ref": "#/parameters/ResourceUriParameter" + "$ref": "./serviceDiagnosticsSettings_API.json#/parameters/ResourceUriParameter" }, { "name": "$filter", @@ -265,15 +265,6 @@ "required": true, "type": "string", "description": "Client Api Version." - }, - "ResourceUriParameter": { - "name": "resourceUri", - "in": "path", - "required": true, - "type": "string", - "description": "The identifier of the resource.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true } } } diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json index a5a55eb54865..4918d221fd0f 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json @@ -398,7 +398,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 } } } diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/UpdateMetricAlert.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/UpdateMetricAlert.json index e613029a2077..f99acfe16e6b 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/UpdateMetricAlert.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/UpdateMetricAlert.json @@ -29,6 +29,7 @@ } ] }, + "autoMitigate": false, "actions": [ { "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/notificationgroups/group2", @@ -74,6 +75,7 @@ } ] }, + "autoMitigate":false, "actions": [ { "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/notificationgroups/group2", diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/createOrUpdateMetricAlert.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/createOrUpdateMetricAlert.json index d74cb3b9b49d..3865f1ac124c 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/createOrUpdateMetricAlert.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/createOrUpdateMetricAlert.json @@ -30,6 +30,7 @@ } ] }, + "autoMitigate": false, "actions": [ { "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/notificationgroups/group2", @@ -75,6 +76,7 @@ } ] }, + "autoMitigate":false, "actions": [ { "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/notificationgroups/group2", diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlert.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlert.json index 7c71d90e8512..25da26847945 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlert.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlert.json @@ -38,6 +38,7 @@ } ] }, + "autoMitigate": false, "actions": [ { "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/notificationgroups/group2", diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/metricAlert_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/metricAlert_API.json index 730a008970ae..3bed1aba4066 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/metricAlert_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/metricAlert_API.json @@ -45,58 +45,6 @@ "description": "Successful request for a list of metric alerts", "schema": { "$ref": "#/definitions/MetricAlertResourceCollection" - }, - "examples": { - "application/json": { - "value": [ - { - "location": "global", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/test/providers/microsoft.insights/metricalerts/storageTest", - "name": "storageTest", - "properties": { - "description": "This is the description of the xstore multidim rule1", - "severity": 3, - "enabled": true, - "scopes": [ - "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/testmultidim/blobServices/default" - ], - "evaluationFrequency": "PT1M", - "windowSize": "PT15M", - "criteria": { - "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria", - "allOf": [ - { - "name": "HowManyBytes", - "metricName": "BlobCapacity", - "dimensions": [ - { - "name": "BlobType", - "operator": "Include", - "values": [ - "BlockBlob", - "PageBlob" - ] - } - ], - "operator": "GreaterThanOrEqual", - "threshold": 5.0, - "timeAggregation": "Maximum" - } - ] - }, - "actions": [ - { - "actionGroupId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/test/providers/microsoft.insights/actionGroups/testActionGroup" - } - ] - } - } - ] - } } }, "default": { @@ -127,58 +75,6 @@ "description": "Successful request for a list of metric alerts", "schema": { "$ref": "#/definitions/MetricAlertResourceCollection" - }, - "examples": { - "application/json": { - "value": [ - { - "location": "global", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/test/providers/microsoft.insights/metricalerts/storageTest", - "name": "storageTest", - "properties": { - "description": "This is the description of the xstore multidim rule1", - "severity": 3, - "enabled": true, - "scopes": [ - "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/testmultidim/blobServices/default" - ], - "evaluationFrequency": "PT1M", - "windowSize": "PT15M", - "criteria": { - "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria", - "allOf": [ - { - "name": "HowManyBytes", - "metricName": "BlobCapacity", - "dimensions": [ - { - "name": "BlobType", - "operator": "Include", - "values": [ - "BlockBlob", - "PageBlob" - ] - } - ], - "operator": "GreaterThanOrEqual", - "threshold": 5.0, - "timeAggregation": "Maximum" - } - ] - }, - "actions": [ - { - "actionGroupId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/test/providers/microsoft.insights/actionGroups/testActionGroup" - } - ] - } - } - ] - } } }, "default": { @@ -210,54 +106,6 @@ "description": "Successful request for a list of metric alerts", "schema": { "$ref": "#/definitions/MetricAlertResource" - }, - "examples": { - "application/json": { - "location": "global", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/test/providers/microsoft.insights/metricalerts/storageTest", - "name": "storageTest", - "properties": { - "description": "This is the description of the xstore multidim rule1", - "severity": 3, - "enabled": true, - "scopes": [ - "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/testmultidim/blobServices/default" - ], - "evaluationFrequency": "PT1M", - "windowSize": "PT15M", - "criteria": { - "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria", - "allOf": [ - { - "name": "HowManyBytes", - "metricName": "BlobCapacity", - "dimensions": [ - { - "name": "BlobType", - "operator": "Include", - "values": [ - "BlockBlob", - "PageBlob" - ] - } - ], - "operator": "GreaterThanOrEqual", - "threshold": 5.0, - "timeAggregation": "Maximum" - } - ] - }, - "actions": [ - { - "actionGroupId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/test/providers/microsoft.insights/actionGroups/testActionGroup" - } - ] - } - } } }, "default": { @@ -293,57 +141,6 @@ "description": "OK", "schema": { "$ref": "#/definitions/MetricAlertResource" - }, - "examples": { - "application/json": { - "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/metricalerts/chiricutin", - "name": "chiricutin", - "type": "Microsoft.Insights/metricalerts", - "location": "West US", - "tags": { - "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource" - }, - "properties": { - "description": "This is the description of the rule1", - "severity": 0, - "enabled": true, - "scopes": [ - "/subscriptions/3b7f8a43-4372-4be1-9853-9e51f243d9be/resourceGroups/test/providers/Microsoft.Compute/virtualMachines/testVmLin" - ], - "evaluationFrequency": "Pt1m", - "windowSize": "Pt15m", - "criteria": { - "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria", - "allOf": [ - { - "name": "High_CPU_80", - "metricName": "Percentage CPU", - "dimensions": [], - "operator": "GreaterThan", - "threshold": 80.50, - "timeAggregation": "Total" - }, - { - "name": "High_Disk_50", - "metricName": "Disk Write Operations/Sec", - "dimensions": [], - "operator": "GreaterThanOrEqual", - "threshold": 0.55, - "timeAggregation": "Maximum" - } - ] - }, - "actions": [ - { - "actionGroupId": "/subscriptions/3b7f8a43-4372-4be1-9853-9e51f243d9be/resourceGroups/test/providers/microsoft.insights/actionGroups/TestActionGroup", - "webhookProperties": { - "key01": "value01", - "key02": "value02" - } - } - ] - } - } } }, "default": { @@ -379,57 +176,6 @@ "description": "OK", "schema": { "$ref": "#/definitions/MetricAlertResource" - }, - "examples": { - "application/json": { - "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/metricalerts/chiricutin", - "name": "chiricutin", - "type": "Microsoft.Insights/metricalerts", - "location": "global", - "tags": { - "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource" - }, - "properties": { - "description": "This is the description of the rule1", - "severity": 0, - "enabled": true, - "scopes": [ - "/subscriptions/3b7f8a43-4372-4be1-9853-9e51f243d9be/resourceGroups/test/providers/Microsoft.Compute/virtualMachines/testVmLin" - ], - "evaluationFrequency": "Pt1m", - "windowSize": "Pt15m", - "criteria": { - "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria", - "allOf": [ - { - "name": "High_CPU_80", - "metricName": "Percentage CPU", - "dimensions": [], - "operator": "GreaterThan", - "threshold": 80.50, - "timeAggregation": "Total" - }, - { - "name": "High_Disk_50", - "metricName": "Disk Write Operations/Sec", - "dimensions": [], - "operator": "GreaterThanOrEqual", - "threshold": 0.55, - "timeAggregation": "Maximum" - } - ] - }, - "actions": [ - { - "actionGroupId": "/subscriptions/3b7f8a43-4372-4be1-9853-9e51f243d9be/resourceGroups/test/providers/microsoft.insights/actionGroups/TestActionGroup", - "webhookProperties": { - "key01": "value01", - "key02": "value02" - } - } - ] - } - } } }, "default": { @@ -480,24 +226,6 @@ "description": "Successful request for a list of metric alerts", "schema": { "$ref": "#/definitions/MetricAlertStatusCollection" - }, - "examples": { - "application/json": { - "value": [ - { - "id": "/subscriptions/009f6022-67ec-423e-9aa7-691182870588/resourceGroups/EastUs/providers/microsoft.insights/metricAlerts/LeoAlert_custom1", - "name": "cmVzb3VyY2VJZD0vc3Vic2NyaXB0aW9ucy8xNGRkZjBjNS03N2M1LTRiNTMtODRmNi1lMWZhNDNhZDY4ZjcvcmVzb3VyY2VHcm91cHMvZ2lndGVzdC9wcm92aWRlcnMvTWljcm9zb2Z0LkNvbXB1dGUvdmlydHVhbE1hY2hpbmVzL2dpZ3dhZG1l", - "type": "Microsoft.Insights/metricAlerts/status", - "properties": { - "dimensions": { - "resourceId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme" - }, - "status": "Healthy", - "timestamp": "2018-01-17T20:17:25.6293237Z" - } - } - ] - } } }, "default": { @@ -527,24 +255,6 @@ "description": "Successful request for a list of metric alerts", "schema": { "$ref": "#/definitions/MetricAlertStatusCollection" - }, - "examples": { - "application/json": { - "value": [ - { - "id": "/subscriptions/009f6022-67ec-423e-9aa7-691182870588/resourceGroups/EastUs/providers/microsoft.insights/metricAlerts/LeoAlert_custom1", - "name": "cmVzb3VyY2VJZD0vc3Vic2NyaXB0aW9ucy8xNGRkZjBjNS03N2M1LTRiNTMtODRmNi1lMWZhNDNhZDY4ZjcvcmVzb3VyY2VHcm91cHMvZ2lndGVzdC9wcm92aWRlcnMvTWljcm9zb2Z0LkNvbXB1dGUvdmlydHVhbE1hY2hpbmVzL2dpZ3dhZG1l", - "type": "Microsoft.Insights/metricAlerts/status", - "properties": { - "dimensions": { - "resourceId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme" - }, - "status": "Healthy", - "timestamp": "2018-01-17T20:17:25.6293237Z" - } - } - ] - } } }, "default": { @@ -597,7 +307,7 @@ "x-ms-azure-resource": true, "description": "An azure resource object" }, - "Action": { + "MetricAlertAction": { "description": "An alert action.", "properties": { "actionGroupId": { @@ -609,7 +319,8 @@ "additionalProperties": { "type": "string", "description": "the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload." - } + }, + "description": "The properties of a webhook object." } } }, @@ -656,10 +367,14 @@ "$ref": "#/definitions/MetricAlertCriteria", "description": "defines the specific alert criteria information." }, + "autoMitigate": { + "type": "boolean", + "description":"the flag that indicates whether the alert should be auto resolved or not." + }, "actions": { "type": "array", "items": { - "$ref": "#/definitions/Action" + "$ref": "#/definitions/MetricAlertAction" }, "description": "the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved." }, @@ -738,7 +453,8 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "An object describing the type of the dimensions." }, "status": { "type": "string", @@ -782,8 +498,7 @@ "properties": { "odata.type": { "enum": [ - "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria", - "Microsoft.Azure.Monitor.DefaultCriteria" + "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" ], "x-ms-enum": { "name": "odatatype", @@ -875,7 +590,8 @@ }, "description": "List of dimension conditions." } - } + }, + "description": "Criterion to filter metrics." }, "MetricDimension": { "required": [ @@ -899,7 +615,8 @@ }, "description": "list of dimension values." } - } + }, + "description": "Specifies a metric dimension." } }, "parameters": { diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRules.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRules.json new file mode 100644 index 000000000000..c22fd5e8c4aa --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRules.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "b67f7fec-69fc-4974-9099-a26bd6ffeda3", + "resourceGroupName": "Rac46PostSwapRG", + "ruleName": "logalertfoo", + "api-version": "2018-04-16", + "parameters": { + "location": "West US", + "tags": { + "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI": "Resource" + }, + "properties": { + "description": "log alert description", + "enabled": "true", + "lastUpdatedTime": "2017-06-23T21:23:52.0221265Z", + "provisioningState": "Succeeded", + "source": { + "query": "requests", + "dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI", + "queryType": "ResultCount" + }, + "schedule": { + "frequencyInMinutes": 15, + "timeWindowInMinutes": 15 + }, + "action": { + "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction", + "severity": "1", + "aznsAction": { + "actionGroup": [], + "emailSubject": "Email Header", + "customWebhookPayload": "{}" + }, + "trigger": { + "thresholdOperator": "GreaterThan", + "threshold": 3, + "metricTrigger": { + "thresholdOperator": "GreaterThan", + "threshold": 5, + "metricTriggerType": "Consecutive", + "metricColumn": "ColumnName" + } + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/logalertfoo", + "name": "logalertfoo", + "type": "Microsoft.Insights/scheduledQueryRules", + "location": "West US", + "tags": { + "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI": "Resource" + }, + "properties": { + "description": "log alert description", + "enabled": "true", + "lastUpdatedTime": "2017-06-23T21:23:52.0221265Z", + "provisioningState": "Succeeded", + "source": { + "query": "requests", + "dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI", + "queryType": "ResultCount" + }, + "schedule": { + "frequencyInMinutes": 15, + "timeWindowInMinutes": 15 + }, + "action": { + "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction", + "severity": "1", + "aznsAction": { + "actionGroup": [], + "emailSubject": "Email Header", + "customWebhookPayload": "{}" + }, + "trigger": { + "thresholdOperator": "GreaterThan", + "threshold": 3, + "metricTrigger": { + "thresholdOperator": "GreaterThan", + "threshold": 5, + "metricTriggerType": "Consecutive", + "metricColumn": "ColumnName" + } + } + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/logalertfoo", + "name": "logalertfoo", + "type": "Microsoft.Insights/scheduledQueryRules", + "location": "West US", + "tags": { + "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI": "Resource" + }, + "properties": { + "description": "log alert description", + "enabled": "true", + "lastUpdatedTime": "2017-06-23T21:23:52.0221265Z", + "provisioningState": "Succeeded", + "source": { + "query": "requests", + "queryType": "ResultCount", + "dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI" + }, + "schedule": { + "frequencyInMinutes": 15, + "timeWindowInMinutes": 15 + }, + "action": { + "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction", + "severity": "1", + "trigger": { + "thresholdOperator": "GreaterThan", + "threshold": 3 + }, + "aznsAction": { + "actionGroup": [], + "emailSubject": "Email Header", + "customWebhookPayload": "{}" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/deleteScheduledQueryRules.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/deleteScheduledQueryRules.json new file mode 100644 index 000000000000..f9fba36800dd --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/deleteScheduledQueryRules.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "b67f7fec-69fc-4974-9099-a26bd6ffeda3", + "resourceGroupName": "Rac46PostSwapRG", + "ruleName": "logalertfoo", + "api-version": "2018-04-16" + }, + "responses": { + "200": { + "headers": {}, + "body": null + }, + "204": { + "headers": {}, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/getScheduledQueryRules.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/getScheduledQueryRules.json new file mode 100644 index 000000000000..d76619f03ad3 --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/getScheduledQueryRules.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "b67f7fec-69fc-4974-9099-a26bd6ffeda3", + "resourceGroupName": "Rac46PostSwapRG", + "ruleName": "logalertfoo", + "api-version": "2018-04-16" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/logalertfoo", + "name": "logalertfoo", + "type": "Microsoft.Insights/scheduledQueryRules", + "location": "West US", + "tags": { + "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI": "Resource" + }, + "properties": { + "description": "log alert description", + "enabled": "true", + "lastUpdatedTime": "2017-06-23T21:23:52.0221265Z", + "provisioningState": "Succeeded", + "source": { + "query": "requests", + "queryType": "ResultCount", + "dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI" + }, + "schedule": { + "frequencyInMinutes": 15, + "timeWindowInMinutes": 15 + }, + "action": { + "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction", + "severity": "1", + "trigger": { + "thresholdOperator": "GreaterThan", + "threshold": 3 + }, + "aznsAction": { + "actionGroup": [], + "emailSubject": "Email Header", + "customWebhookPayload": "{}" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/listScheduledQueryRules.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/listScheduledQueryRules.json new file mode 100644 index 000000000000..81c5d1757134 --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/listScheduledQueryRules.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7", + "resourceGroupName": "gigtest", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/logalertfoo", + "name": "logalertfoo", + "type": "Microsoft.Insights/scheduledQueryRules", + "location": "West US", + "tags": { + "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI": "Resource" + }, + "properties": { + "description": "log alert description", + "enabled": "false", + "lastUpdatedTime": "2017-06-23T21:23:52.0221265Z", + "provisioningState": "Succeeded", + "source": { + "query": "requests", + "queryType": "ResultCount", + "dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI" + }, + "schedule": { + "frequencyInMinutes": 15, + "timeWindowInMinutes": 15 + }, + "action": { + "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction", + "severity": "1", + "trigger": { + "thresholdOperator": "GreaterThan", + "threshold": 2, + "metricTrigger": { + "thresholdOperator": "LessThan", + "threshold": 2, + "metricTriggerType": "Total", + "metricColumn": "user_Id" + } + }, + "aznsAction": { + "actionGroup": [], + "emailSubject": "Email Header", + "customWebhookPayload": "{}" + } + } + } + }, + { + "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/logalertfoo", + "name": "logalertfoo", + "type": "Microsoft.Insights/scheduledQueryRules", + "location": "West US", + "tags": { + "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI": "Resource" + }, + "properties": { + "description": "log alert description", + "enabled": "true", + "lastUpdatedTime": "2017-06-23T21:23:52.0221265Z", + "provisioningState": "Succeeded", + "source": { + "query": "requests", + "queryType": "ResultCount", + "dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI" + }, + "schedule": { + "frequencyInMinutes": 10, + "timeWindowInMinutes": 30 + }, + "action": { + "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction", + "severity": "1", + "trigger": { + "thresholdOperator": "GreaterThan", + "threshold": 3 + }, + "aznsAction": { + "actionGroup": [], + "emailSubject": "Email Header", + "customWebhookPayload": "{}" + } + } + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/patchScheduledQueryRules.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/patchScheduledQueryRules.json new file mode 100644 index 000000000000..a7275bfcf41d --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/patchScheduledQueryRules.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2018-04-16", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "ruleName": "logalertfoo", + "parameters": { + "properties": { + "enabled": "true" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/logalertfoo", + "name": "logalertfoo", + "type": "Microsoft.Insights/scheduledQueryRules", + "location": "West US", + "tags": { + "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI": "Resource" + }, + "properties": { + "description": "log alert description", + "enabled": "true", + "lastUpdatedTime": "2017-06-23T21:23:52.0221265Z", + "provisioningState": "Succeeded", + "source": { + "query": "requests", + "dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI", + "queryType": "ResultCount" + }, + "schedule": { + "frequencyInMinutes": 15, + "timeWindowInMinutes": 15 + }, + "action": { + "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction", + "severity": "1", + "aznsAction": { + "actionGroup": [], + "emailSubject": "Email Header", + "customWebhookPayload": "{}" + }, + "trigger": { + "thresholdOperator": "GreaterThan", + "threshold": 3, + "metricTrigger": { + "thresholdOperator": "GreaterThan", + "threshold": 5, + "metricTriggerType": "Consecutive", + "metricColumn": "ColumnName" + } + } + } + } + } + } + } +} diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/scheduledQueryRule_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/scheduledQueryRule_API.json new file mode 100644 index 000000000000..d92f0c77b3db --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/scheduledQueryRule_API.json @@ -0,0 +1,723 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Insights API", + "version": "2018-04-16", + "description": "Azure Monitor client to create/update/delete Scheduled Query Rules" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/scheduledQueryRules/{ruleName}": { + "put": { + "description": "Creates or updates an log search rule.", + "tags": [ + "scheduledQueryRules" + ], + "operationId": "ScheduledQueryRules_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RuleNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LogSearchRuleResource" + }, + "description": "The parameters of the rule to create or update." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to update an Log Search rule", + "schema": { + "$ref": "#/definitions/LogSearchRuleResource" + } + }, + "201": { + "description": "Created alert rule", + "schema": { + "$ref": "#/definitions/LogSearchRuleResource" + } + } + }, + "x-ms-examples": { + "Create or Update rule": { "$ref": "./examples/createOrUpdateScheduledQueryRules.json" } + } + }, + "get": { + "description": "Gets an Log Search rule", + "tags": [ + "scheduledQueryRules" + ], + "operationId": "ScheduledQueryRules_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RuleNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get a Log Search rule", + "schema": { + "$ref": "#/definitions/LogSearchRuleResource" + } + } + }, + "x-ms-examples": { + "Get rule": { "$ref": "./examples/getScheduledQueryRules.json" } + } + }, + "patch": { + "tags": [ "scheduledQueryRules" ], + "description": "Update log search Rule.", + "operationId": "ScheduledQueryRules_Update", + "parameters": [ + { "$ref": "#/parameters/SubscriptionIdParameter" }, + { "$ref": "#/parameters/ResourceGroupNameParameter" }, + { "$ref": "#/parameters/RuleNameParameter" }, + { "$ref": "#/parameters/ApiVersionParameter" }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LogSearchRuleResourcePatch" + }, + "description": "The parameters of the rule to update." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to update an Log Search rule", + "schema": { + "$ref": "#/definitions/LogSearchRuleResource" + } + } + }, + "x-ms-examples": { + "Patch Log Search Rule": { "$ref": "./examples/patchScheduledQueryRules.json" } + } + }, + "delete": { + "description": "Deletes a Log Search rule", + "tags": [ + "scheduledQueryRules" + ], + "operationId": "ScheduledQueryRules_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RuleNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to delete a Log Search rule" + }, + "204": { + "description": "No Content. Resource not found" + } + }, + "x-ms-examples": { + "Delete rule": { "$ref": "./examples/deleteScheduledQueryRules.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/microsoft.insights/scheduledQueryRules": { + "get": { + "tags": [ + "scheduledQueryRules" + ], + "operationId": "ScheduledQueryRules_ListBySubscription", + "description": "List the Log Search rules within a subscription group.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request for a list of alert rules", + "schema": { + "$ref": "#/definitions/LogSearchRuleResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List rules": { "$ref": "./examples/listScheduledQueryRules.json" } + }, + "x-ms-odata": "#/definitions/LogSearchRuleResource" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/scheduledQueryRules": { + "get": { + "tags": [ + "scheduledQueryRules" + ], + "operationId": "ScheduledQueryRules_ListByResourceGroup", + "description": "List the Log Search rules within a resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request for a list of alert rules", + "schema": { + "$ref": "#/definitions/LogSearchRuleResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List rules": { "$ref": "./examples/listScheduledQueryRules.json" } + }, + "x-ms-odata": "#/definitions/LogSearchRuleResource" + } + } + }, + "definitions": { + "Resource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true, + "description": "An azure resource object" + }, + "LogSearchRuleResource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LogSearchRule", + "description": "The rule properties of the resource." + } + }, + "description": "The Log Search Rule resource." + }, + "LogSearchRuleResourcePatch": { + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LogSearchRulePatch", + "description": "The log search rule properties of the resource." + } + }, + "description": "The log search rule resource for patch operations." + }, + "LogSearchRuleResourceCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LogSearchRuleResource" + }, + "description": "The values for the Log Search Rule resources." + } + }, + "description": "Represents a collection of Log Search rule resources." + }, + "Source": { + "type": "object", + "description": "Specifies the log search query.", + "properties": { + "query": { + "type": "string", + "description": "Log search query." + }, + "authorizedResources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Resource referred into query" + }, + "dataSourceId": { + "type": "string", + "description": "The resource uri over which log search query is to be run." + }, + "queryType": { + "$ref": "#/definitions/QueryType", + "description": "Set value to 'ResultCount' ." + } + }, + "required": [ + "query", + "dataSourceId" + ] + }, + "Schedule": { + "type": "object", + "description": "Defines how often to run the search and the time interval.", + "properties": { + "frequencyInMinutes": { + "type": "integer", + "format": "int32", + "description": "frequency (in minutes) at which rule condition should be evaluated." + }, + "timeWindowInMinutes": { + "type": "integer", + "format": "int32", + "description": "Time window for which data needs to be fetched for query (should be greater than or equal to frequencyInMinutes)." + } + }, + "required": [ + "frequencyInMinutes", + "timeWindowInMinutes" + ] + }, + "TriggerCondition": { + "description": "The condition that results in the Log Search rule.", + "properties": { + "thresholdOperator": { + "$ref": "#/definitions/ConditionalOperator", + "description": "Evaluation operation for rule - 'GreaterThan' or 'LessThan." + }, + "threshold": { + "description": "Result or count threshold based on which rule should be triggered.", + "format": "double", + "type": "number" + }, + "metricTrigger": { + "$ref": "#/definitions/LogMetricTrigger", + "description": "Trigger condition for metric query rule" + } + }, + "required": [ + "thresholdOperator", + "threshold" + ], + "type": "object" + }, + "AzNsActionGroup": { + "type": "object", + "properties": { + "actionGroup": { + "type": "array", + "description": "Azure Action Group reference.", + "items": { + "type": "string" + } + }, + "emailSubject": { + "type": "string", + "description": "Custom subject override for all email ids in Azure action group" + }, + "customWebhookPayload": { + "type": "string", + "description": "Custom payload to be sent for all webook URI in Azure action group" + } + }, + "description": "Azure action group" + }, + "LogMetricTrigger": { + "type": "object", + "properties": { + "thresholdOperator": { + "$ref": "#/definitions/ConditionalOperator", + "description": "Evaluation operation for Metric -'GreaterThan' or 'LessThan' or 'Equal'." + }, + "threshold": { + "format": "double", + "type": "number", + "description": "The threshold of the metric trigger." + }, + "metricTriggerType": { + "$ref": "#/definitions/MetricTriggerType", + "description": "Metric Trigger Type - 'Consecutive' or 'Total'" + }, + "metricColumn": { + "type": "string", + "description": "Evaluation of metric on a particular column" + } + }, + "description": "A log metrics trigger descriptor." + }, + "ConditionalOperator": { + "type": "string", + "enum": [ + "GreaterThan", + "LessThan", + "Equal" + ], + "x-ms-enum": { + "name": "ConditionalOperator", + "modelAsString": true + }, + "description": "Result Condition Evaluation criteria. Supported Values - 'GreaterThan' or 'LessThan' or 'Equal'." + }, + "MetricTriggerType": { + "type": "string", + "enum": [ + "Consecutive", + "Total" + ], + "x-ms-enum": { + "name": "metricTriggerType", + "modelAsString": true + }, + "description": "Metric Trigger Evaluation Type" + }, + "AlertSeverity": { + "type": "string", + "enum": [ + "0", + "1", + "2", + "3", + "4" + ], + "x-ms-enum": { + "name": "AlertSeverity", + "modelAsString": true + }, + "description": "Severity Level of Alert" + }, + "QueryType": { + "type": "string", + "enum": [ + "ResultCount" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": true + }, + "description": "Set value to 'ResultAcount'" + }, + "LogSearchRule": { + "description": "Log Search Rule Definition", + "properties": { + "description": { + "type": "string", + "description": "The description of the Log Search rule." + }, + "enabled": { + "type": "string", + "description": "The flag which indicates whether the Log Search rule is enabled. Value should be true or false", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "enabled", + "modelAsString": true + } + }, + "lastUpdatedTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Last time the rule was updated in IS08601 format." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "enum": [ + "Succeeded", + "Deploying", + "Canceled", + "Failed" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "description": "Provisioning state of the scheduledquery rule" + }, + "source": { + "$ref": "#/definitions/Source", + "description": "Data Source against which rule will Query Data" + }, + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "Schedule (Frequnecy, Time Window) for rule." + }, + "action": { + "$ref": "#/definitions/Action", + "description": "Action needs to be taken on rule execution." + } + }, + "required": [ + "schedule", + "source", + "action" + ] + }, + "LogSearchRulePatch": { + "description": "Log Search Rule Definition for Patching", + "properties": { + "enabled": { + "type": "string", + "description": "The flag which indicates whether the Log Search rule is enabled. Value should be true or false", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "enabled", + "modelAsString": true + } + } + } + }, + "Action": { + "type": "object", + "discriminator": "odata.type", + "properties": { + "odata.type": { + "type": "string", + "description": "Specifies the action. Only supported value - AlertingAction " + } + }, + "required": [ + "odata.type" + ], + "description": "Action descriptor." + }, + "AlertingAction": { + "description": "Specifiy action need to be taken when rule type is Alert", + "x-ms-discriminator-value": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Action" + } + ], + "properties": { + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "Severity of the alert" + }, + "aznsAction": { + "$ref": "#/definitions/AzNsActionGroup", + "description": "Azure action group reference." + }, + "throttlingInMin": { + "type": "integer", + "format": "int32", + "description": "time (in minutes) for which Alerts should be throttled or suppressed." + }, + "trigger": { + "$ref": "#/definitions/TriggerCondition", + "description": "The trigger condition that results in the alert rule being." + } + }, + "required": [ + "aznsAction", + "trigger", + "severity" + ] + }, + "ErrorResponse": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription Id." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "RuleNameParameter": { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the rule.", + "x-ms-parameter-location": "method" + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. For more information please see https://msdn.microsoft.com/en-us/library/azure/dn931934.aspx", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index 4e7602b9fb14..da9c50da17e8 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -54,6 +54,7 @@ input-file: - microsoft.insights/preview/2017-11-01-preview/baseline_API.json - microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json - microsoft.insights/stable/2018-03-01/metricAlert_API.json +- microsoft.insights/stable/2018-04-16/scheduledQueryRule_API.json ``` @@ -147,6 +148,102 @@ input-file: - microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json ``` +### Tag: package-2018-01-01-only + +These settings apply only when `--tag=package-2018-01-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-01-01-only' +input-file: +- microsoft.insights/stable/2018-01-01/metricDefinitions_API.json +- microsoft.insights/stable/2018-01-01/metrics_API.json +``` + +### Tag: package-2018-03-01-only + +These settings apply only when `--tag=package-2018-03-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03-01-only' +input-file: +- microsoft.insights/stable/2018-03-01/metricAlert_API.json +- microsoft.insights/stable/2018-03-01/actionGroups_API.json +``` + +### Tag: package-2018-04-16-only + +These settings apply only when `--tag=package-2018-04-16-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-04-16-only' +input-file: +- microsoft.insights/stable/2018-04-16/scheduledQueryRule_API.json +``` + +### Tag: package-2015-04-01-only + +These settings apply only when `--tag=package-2015-04-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2015-04-01-only' +input-file: +- microsoft.insights/stable/2015-04-01/activityLogs_API.json +- microsoft.insights/stable/2015-04-01/autoscale_API.json +- microsoft.insights/stable/2015-04-01/eventCategories_API.json +- microsoft.insights/stable/2015-04-01/operations_API.json +- microsoft.insights/stable/2015-04-01/tenantActivityLogs_API.json +``` + +### Tag: package-2016-03-01-only + +These settings apply only when `--tag=package-2016-03-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2016-03-01-only' +input-file: +- microsoft.insights/stable/2016-03-01/alertRules_API.json +- microsoft.insights/stable/2016-03-01/alertRulesIncidents_API.json +- microsoft.insights/stable/2016-03-01/logProfiles_API.json +- microsoft.insights/stable/2016-03-01/metricDefinitions_API.json +``` + +### Tag: package-2016-09-01-only + +These settings apply only when `--tag=package-2016-09-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2016-09-01-only' +input-file: +- microsoft.insights/stable/2016-09-01/metrics_API.json +- microsoft.insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json +``` + +### Tag: package-2017-04-01-only + +These settings apply only when `--tag=package-2017-04-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-04-01-only' +input-file: +- microsoft.insights/stable/2017-04-01/actionGroups_API.json +- microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json +``` + +### Tag: package-2017-05-01-preview-only + +These settings apply only when `--tag=package-2017-05-01-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-05-01-preview-only' +input-file: +- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- microsoft.insights/preview/2017-05-01-preview/metricDefinitions_API.json +- microsoft.insights/preview/2017-05-01-preview/metrics_API.json +``` + +### Tag: package-2017-11-01-preview-only + +These settings apply only when `--tag=package-2017-11-01-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-11-01-preview-only' +input-file: +- microsoft.insights/preview/2017-11-01-preview/baseline_API.json +- microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json +``` + --- # Code Generation @@ -159,9 +256,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_monitor'] ``` @@ -198,6 +298,7 @@ go: batch: - tag: package-2017-08 - tag: package-2017-09 + - tag: package-2018-03 ``` ### Tag: package-2017-09 and go @@ -206,7 +307,7 @@ These settings apply only when `--tag=package-2017-09 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-09' && $(go) -output-folder: $(go-sdk-folder)/services/monitor/mgmt/2018-03-01/insights +output-folder: $(go-sdk-folder)/services/preview/monitor/mgmt/2018-03-01/insights ``` ### Tag: package-2017-08 and go @@ -215,9 +316,17 @@ These settings apply only when `--tag=package-2017-08 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-08' && $(go) -output-folder: $(go-sdk-folder)/services/monitor/mgmt/2017-05-01-preview/insights +output-folder: $(go-sdk-folder)/services/preview/monitor/mgmt/2017-05-01-preview/insights ``` +### Tag: package-2018-03 and go + +These settings apply only when `--tag=package-2018-03 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-03' && $(go) +output-folder: $(go-sdk-folder)/services/preview/monitor/mgmt/2018-03-01/insights +``` ## Python @@ -229,13 +338,12 @@ 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 - fluent: true - namespace: com.microsoft.azure.management.monitor - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-monitor +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.monitor +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-monitor ``` # Validation diff --git a/specification/monitor/resource-manager/readme.nodejs.md b/specification/monitor/resource-manager/readme.nodejs.md index 13e9d5f732e8..6f43fe9ef3c2 100644 --- a/specification/monitor/resource-manager/readme.nodejs.md +++ b/specification/monitor/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-04-01-only' && $(ruby) +namespace: "Azure::Monitor::Mgmt::V2015_04_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_monitor/lib +``` + +### Tag: package-2016-03-01-only and ruby + +These settings apply only when `--tag=package-2016-03-01-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-03-01-only' && $(ruby) +namespace: "Azure::Monitor::Mgmt::V2016_03_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_monitor/lib +``` + +### Tag: package-2016-09-01-only and ruby + +These settings apply only when `--tag=package-2016-09-01-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-09-01-only' && $(ruby) +namespace: "Azure::Monitor::Mgmt::V2016_09_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_monitor/lib +``` + +### Tag: package-2017-04-01-only and ruby + +These settings apply only when `--tag=package-2017-04-01-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-04-01-only' && $(ruby) +namespace: "Azure::Monitor::Mgmt::V2017_04_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_monitor/lib +``` + +### Tag: package-2017-05-01-preview-only and ruby + +These settings apply only when `--tag=package-2017-05-01-preview-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-05-01-preview-only' && $(ruby) +namespace: "Azure::Monitor::Mgmt::V2017_05_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_monitor/lib +``` + +### Tag: package-2017-11-01-preview-only and ruby + +These settings apply only when `--tag=package-2017-11-01-preview-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-11-01-preview-only' && $(ruby) +namespace: "Azure::Monitor::Mgmt::V2017_11_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_monitor/lib +``` \ No newline at end of file diff --git a/specification/msi/resource-manager/readme.md b/specification/msi/resource-manager/readme.md index 593052f1c868..71d08c613f60 100644 --- a/specification/msi/resource-manager/readme.md +++ b/specification/msi/resource-manager/readme.md @@ -47,8 +47,11 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_msi'] ``` @@ -117,7 +120,7 @@ These settings apply only when `--tag=package-2015-08-31-preview --go` is specif Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-08-31-preview' && $(go) -output-folder: $(go-sdk-folder)/services/msi/mgmt/2015-08-31-preview/msi +output-folder: $(go-sdk-folder)/services/preview/msi/mgmt/2015-08-31-preview/msi ``` @@ -127,11 +130,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.msi +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-msi +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-08-31-preview +``` + +### Tag: package-2015-08-31-preview and java + +These settings apply only when `--tag=package-2015-08-31-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-08-31-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.msi - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-msi + namespace: com.microsoft.azure.management.managedserviceidentity.v2015_08_31_preview + output-folder: $(azure-libraries-for-java-folder)/managedserviceidentity/resource-manager/v2015_08_31_preview +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/msi/resource-manager/readme.ruby.md b/specification/msi/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..37dc383b121c --- /dev/null +++ b/specification/msi/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_msi +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2015-08-31-preview +``` + +### Tag: package-2015-08-31-preview and ruby + +These settings apply only when `--tag=package-2015-08-31-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-08-31-preview' && $(ruby) +namespace: "Azure::ManagedServiceIdentity::Mgmt::V2015_08_31_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_msi/lib +``` diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/VirtualNetworkRulesCreateOrUpdate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/VirtualNetworkRulesCreateOrUpdate.json new file mode 100644 index 000000000000..e7baa8266bbd --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/VirtualNetworkRulesCreateOrUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestGroup", + "serverName": "vnet-test-svr", + "virtualNetworkRuleName": "vnet-firewall-rule", + "api-version": "2017-12-01", + "parameters": { + "properties": { + "ignoreMissingVnetServiceEndpoint": false, + "virtualNetworkSubnetId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/vnet-test-svr/virtualNetworkRules/vnet-firewall-rule", + "name": "vnet-firewall-rule", + "type": "Microsoft.DBforMySQL/servers/virtualNetworkRules", + "properties": { + "ignoreMissingVnetServiceEndpoint": false, + "virtualNetworkSubnetId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/vnet-test-svr/virtualNetworkRules/vnet-firewall-rule", + "name": "vnet-firewall-rule", + "type": "Microsoft.DBforMySQL/servers/virtualNetworkRules", + "properties": { + "ignoreMissingVnetServiceEndpoint": false, + "virtualNetworkSubnetId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/VirtualNetworkRulesDelete.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/VirtualNetworkRulesDelete.json new file mode 100644 index 000000000000..fb3336a3e4b5 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/VirtualNetworkRulesDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestGroup", + "serverName": "vnet-test-svr", + "virtualNetworkRuleName": "vnet-firewall-rule", + "api-version": "2017-12-01" + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/VirtualNetworkRulesGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/VirtualNetworkRulesGet.json new file mode 100644 index 000000000000..50f18a6578e2 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/VirtualNetworkRulesGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestGroup", + "serverName": "vnet-test-svr", + "virtualNetworkRuleName": "vnet-firewall-rule", + "api-version": "2017-12-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/vnet-test-svr/virtualNetworkRules/vnet-firewall-rule", + "name": "vnet-firewall-rule", + "type": "Microsoft.DBforMySQL/servers/virtualNetworkRules", + "properties": { + "ignoreMissingVnetServiceEndpoint": false, + "state": "Ready", + "virtualNetworkSubnetId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + } + } + } + } +} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/VirtualNetworkRulesList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/VirtualNetworkRulesList.json new file mode 100644 index 000000000000..459eed49d500 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/VirtualNetworkRulesList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestGroup", + "serverName": "vnet-test-svr", + "virtualNetworkRuleName": "vnet-firewall-rule", + "api-version": "2017-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/vnet-test-svr/virtualNetworkRules/vnet-firewall-rule", + "name": "vnet-firewall-rule", + "type": "Microsoft.DBforMySQL/servers/virtualNetworkRules", + "properties": { + "ignoreMissingVnetServiceEndpoint": false, + "state": "Ready", + "virtualNetworkSubnetId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/vnet-test-svr/virtualNetworkRules/vnet-firewall-rule", + "name": "vnet-firewall-rule", + "type": "Microsoft.DBforMySQL/servers/virtualNetworkRules", + "properties": { + "ignoreMissingVnetServiceEndpoint": false, + "state": "Ready", + "virtualNetworkSubnetId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json index 369f3e3e2c83..4c49d15bb9b1 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "MySQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules, log files and configurations with new business model.", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules, VNET rules, log files and configurations with new business model.", "version": "2017-12-01" }, "host": "management.azure.com", @@ -458,6 +458,193 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "get": { + "tags": [ + "VirtualNetworkRules" + ], + "description": "Gets a virtual network rule.", + "operationId": "VirtualNetworkRules_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/virtualNetworkRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified virtual network rule.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Gets a virtual network rule": { + "$ref": "./examples/VirtualNetworkRulesGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualNetworkRules" + ], + "description": "Creates or updates an existing virtual network rule.", + "operationId": "VirtualNetworkRules_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/virtualNetworkRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested virtual Network Rule Resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated a virtual network rule.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 NullVirtualNetworkRequest - Virtual Network Request is Null\n\n * 400 NullVirtualNetworkRequestParameters - Virtual Network Request Parameters are Null\n\n * 400 NullVirtualNetworkSubnetId - The Virtual Network Subnet Id is null\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 VirtualNetworkRuleNotEnabled - Azure SQL Server Virtual Network Rule feature is not enabled\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation." + }, + "202": { + "description": "Accepted" + }, + "201": { + "description": "Successfully created a virtual network rule.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a virtual network rule": { + "$ref": "./examples/VirtualNetworkRulesCreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "VirtualNetworkRules" + ], + "description": "Deletes the virtual network rule with the given name.", + "operationId": "VirtualNetworkRules_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/virtualNetworkRuleNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the virtual network rule." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 NullVirtualNetworkRequest - Virtual Network Request is Null\n\n * 400 NullVirtualNetworkRequestParameters - Virtual Network Request Parameters are Null\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation." + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "The specified virtual network rule does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a virtual network rule": { + "$ref": "./examples/VirtualNetworkRulesDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/virtualNetworkRules": { + "get": { + "tags": [ + "VirtualNetworkRules" + ], + "description": "Gets a list of virtual network rules in a server.", + "operationId": "VirtualNetworkRules_ListByServer", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of virtual network rules.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRuleListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List virtual network rules": { + "$ref": "./examples/VirtualNetworkRulesList.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ @@ -1326,6 +1513,74 @@ }, "description": "A list of firewall rules." }, + "VirtualNetworkRuleProperties": { + "description": "Properties of a virtual network rule.", + "required": [ + "virtualNetworkSubnetId" + ], + "type": "object", + "properties": { + "virtualNetworkSubnetId": { + "description": "The ARM resource id of the virtual network subnet.", + "type": "string" + }, + "ignoreMissingVnetServiceEndpoint": { + "description": "Create firewall rule before the virtual network has vnet service endpoint enabled.", + "type": "boolean" + }, + "state": { + "description": "Virtual Network Rule State", + "enum": [ + "Initializing", + "InProgress", + "Ready", + "Deleting", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VirtualNetworkRuleState", + "modelAsString": true + } + } + } + }, + "VirtualNetworkRule": { + "description": "A virtual network rule.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VirtualNetworkRuleProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "VirtualNetworkRuleListResult": { + "description": "A list of virtual network rules.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, "DatabaseProperties": { "properties": { "charset": { @@ -1702,6 +1957,14 @@ "description": "The name of the server firewall rule.", "x-ms-parameter-location": "method" }, + "virtualNetworkRuleNameParameter": { + "name": "virtualNetworkRuleName", + "in": "path", + "description": "The name of the virtual network rule.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, "DatabaseNameParameter": { "name": "databaseName", "in": "path", diff --git a/specification/mysql/resource-manager/readme.md b/specification/mysql/resource-manager/readme.md index 299a7e33322a..b217c7331710 100644 --- a/specification/mysql/resource-manager/readme.md +++ b/specification/mysql/resource-manager/readme.md @@ -72,7 +72,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node ``` @@ -145,7 +145,7 @@ These settings apply only when `--tag=package-2017-04-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-04-preview' && $(go) -output-folder: $(go-sdk-folder)/services/mysql/mgmt/2017-04-30-preview/mysql +output-folder: $(go-sdk-folder)/services/preview/mysql/mgmt/2017-04-30-preview/mysql ``` ### Tag: package-2017-12-01-preview and go @@ -154,7 +154,7 @@ These settings apply only when `--tag=package-2017-12-01-preview --go` is specif Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-12-01-preview' && $(go) -output-folder: $(go-sdk-folder)/services/mysql/mgmt/2017-12-01-preview/mysql +output-folder: $(go-sdk-folder)/services/preview/mysql/mgmt/2017-12-01-preview/mysql ``` ### Tag: package-2017-12-01 and go @@ -172,11 +172,30 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.mysql +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-mysql +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-12-01 +``` + +### Tag: package-2017-12-01 and java + +These settings apply only when `--tag=package-2017-12-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-12-01' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.mysql - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-mysql + namespace: com.microsoft.azure.management.mysql.v2017_12_01 + output-folder: $(azure-libraries-for-java-folder)/mysql/resource-manager/v2017_12_01 +regenerate-manager: true +generate-interface: true ``` diff --git a/specification/network/resource-manager/Microsoft.Network/preview/2015-05-01-preview/network.json b/specification/network/resource-manager/Microsoft.Network/preview/2015-05-01-preview/network.json index cdcd9cfde9f6..7670c459eeeb 100644 --- a/specification/network/resource-manager/Microsoft.Network/preview/2015-05-01-preview/network.json +++ b/specification/network/resource-manager/Microsoft.Network/preview/2015-05-01-preview/network.json @@ -6592,7 +6592,7 @@ "properties": { "status": { "type": "string", - "description": "Status of the AzureAsuncOperation", + "description": "Status of the AzureAsyncOperation", "enum": [ "InProgress", "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/networkInterface.json index 5d400c4e2d32..020bb5848db4 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/networkInterface.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/networkInterface.json @@ -275,6 +275,10 @@ "subnet": { "$ref": "./virtualNetwork.json#/definitions/Subnet" }, + "primary": { + "type": "boolean", + "description": "Gets whether this is a primary customer address on the network interface." + }, "publicIPAddress": { "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress" }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-03-30/network.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-03-30/network.json index ffc2a4a654cb..29c35410d609 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-03-30/network.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-03-30/network.json @@ -7327,7 +7327,7 @@ "properties": { "status": { "type": "string", - "description": "Status of the AzureAsuncOperation", + "description": "Status of the AzureAsyncOperation", "enum": [ "InProgress", "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-06-01/network.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-06-01/network.json index 3acd7c3286fe..052f39f7d580 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-06-01/network.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-06-01/network.json @@ -8117,7 +8117,7 @@ "properties": { "status": { "type": "string", - "description": "Status of the AzureAsuncOperation", + "description": "Status of the AzureAsyncOperation", "enum": [ "InProgress", "Succeeded", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/ddosProtectionPlan.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/ddosProtectionPlan.json index 765a2acb0fe8..a37aeb78c57e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/ddosProtectionPlan.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/ddosProtectionPlan.json @@ -334,4 +334,4 @@ "description": "Client API version." } } -} +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/loadBalancer.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/loadBalancer.json index 9a4ca3e2c4ee..4eca08ecf581 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/loadBalancer.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/loadBalancer.json @@ -1208,10 +1208,11 @@ }, "protocol": { "type": "string", - "description": "The protocol of the end point. Possible values are: 'Http' or 'Tcp'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.", + "description": "The protocol of the end point. Possible values are: 'Http', 'Tcp' or 'Https'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.", "enum": [ "Http", - "Tcp" + "Tcp", + "Https" ], "x-ms-enum": { "name": "ProbeProtocol", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/applicationGateway.json new file mode 100644 index 000000000000..a6b9a1f1ba1d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/applicationGateway.json @@ -0,0 +1,2138 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}": { + "delete": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Delete", + "x-ms-examples": { + "Delete ApplicationGateway": { + "$ref": "./examples/ApplicationGatewayDelete.json" + } + }, + "description": "Deletes the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist" + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Get", + "x-ms-examples": { + "Get ApplicationGateway": { + "$ref": "./examples/ApplicationGatewayGet.json" + } + }, + "description": "Gets the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns an ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + } + } + }, + "put": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_CreateOrUpdate", + "x-ms-examples": { + "Create Application Gateway": { + "$ref": "./examples/ApplicationGatewayCreate.json" + } + }, + "description": "Creates or updates the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGateway" + }, + "description": "Parameters supplied to the create or update application gateway operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_UpdateTags", + "x-ms-examples": { + "Update Application Gateway tags": { + "$ref": "./examples/ApplicationGatewayUpdateTags.json" + } + }, + "description": "Updates the specified application gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update application gateway tags." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_List", + "x-ms-examples": { + "Lists all application gateways in a resource group": { + "$ref": "./examples/ApplicationGatewayList.json" + } + }, + "description": "Lists all application gateways in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of ApplicationGateway resources.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGateways": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAll", + "x-ms-examples": { + "Lists all application gateways in a subscription": { + "$ref": "./examples/ApplicationGatewayListAll.json" + } + }, + "description": "Gets all the application gateways in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of ApplicationGateway resources.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/start": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Start", + "x-ms-examples": { + "Start Application Gateway": { + "$ref": "./examples/ApplicationGatewayStart.json" + } + }, + "description": "Starts the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation starts the ApplicationGateway resource." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/stop": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Stop", + "x-ms-examples": { + "Stop Application Gateway": { + "$ref": "./examples/ApplicationGatewayStop.json" + } + }, + "description": "Stops the specified application gateway in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the ApplicationGateway resource." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendhealth": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_BackendHealth", + "description": "Gets the backend health of the specified application gateway in a resource group.", + "x-ms-examples": { + "Get Backend Health": { + "$ref": "./examples/ApplicationGatewayBackendHealthGet.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands BackendAddressPool and BackendHttpSettings referenced in backend health." + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayBackendHealth" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableWafRuleSets", + "x-ms-examples": { + "Get Available Waf Rule Sets": { + "$ref": "./examples/ApplicationGatewayAvailableWafRuleSetsGet.json" + } + }, + "description": "Lists all available web application firewall rule sets.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available web application firewall rule sets.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableWafRuleSetsResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableSslOptions", + "x-ms-examples": { + "Get Available Ssl Options": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsGet.json" + } + }, + "description": "Lists available Ssl options for configuring Ssl policy.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns all available Ssl options for configuring Ssl policy.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableSslOptions" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableSslPredefinedPolicies", + "x-ms-examples": { + "Get Available Ssl Predefined Policies": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "description": "Lists all SSL predefined policies for configuring Ssl policy.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a lists of all Ssl predefined policies for configuring Ssl policy.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableSslPredefinedPolicies" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies/{predefinedPolicyName}": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_GetSslPredefinedPolicy", + "x-ms-examples": { + "Get Available Ssl Predefined Policy by name": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json" + } + }, + "description": "Gets Ssl predefined policy with the specified policy name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "predefinedPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of Ssl predefined policy." + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a Ssl predefined policy with the specified policy name.", + "schema": { + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy" + } + } + } + } + } + }, + "definitions": { + "ApplicationGatewayBackendHealth": { + "properties": { + "backendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthPool" + } + } + }, + "description": "List of ApplicationGatewayBackendHealthPool resources." + }, + "ApplicationGatewayBackendHealthPool": { + "properties": { + "backendAddressPool": { + "$ref": "#/definitions/ApplicationGatewayBackendAddressPool", + "description": "Reference of an ApplicationGatewayBackendAddressPool resource." + }, + "backendHttpSettingsCollection": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings" + }, + "description": "List of ApplicationGatewayBackendHealthHttpSettings resources." + } + }, + "description": "Application gateway BackendHealth pool." + }, + "ApplicationGatewayBackendHealthHttpSettings": { + "properties": { + "backendHttpSettings": { + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings", + "description": "Reference of an ApplicationGatewayBackendHttpSettings resource." + }, + "servers": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthServer" + }, + "description": "List of ApplicationGatewayBackendHealthServer resources." + } + }, + "description": "Application gateway BackendHealthHttp settings." + }, + "ApplicationGatewayBackendHealthServer": { + "properties": { + "address": { + "type": "string", + "description": "IP address or FQDN of backend server." + }, + "ipConfiguration": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "description": "Reference of IP configuration of backend server." + }, + "health": { + "type": "string", + "description": "Health of backend server.", + "enum": [ + "Unknown", + "Up", + "Down", + "Partial", + "Draining" + ], + "x-ms-enum": { + "name": "ApplicationGatewayBackendHealthServerHealth", + "modelAsString": true + } + } + }, + "description": "Application gateway backendhealth http settings." + }, + "ApplicationGatewaySku": { + "properties": { + "name": { + "type": "string", + "description": "Name of an application gateway SKU.", + "enum": [ + "Standard_Small", + "Standard_Medium", + "Standard_Large", + "WAF_Medium", + "WAF_Large", + "Standard_v2", + "WAF_v2" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of an application gateway.", + "enum": [ + "Standard", + "WAF", + "Standard_v2", + "WAF_v2" + ], + "x-ms-enum": { + "name": "ApplicationGatewayTier", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Capacity (instance count) of an application gateway." + } + }, + "description": "SKU of an application gateway" + }, + "ApplicationGatewaySslPolicy": { + "properties": { + "disabledSslProtocols": { + "type": "array", + "description": "Ssl protocols to be disabled on application gateway.", + "items": { + "type": "string", + "$ref": "#/definitions/ProtocolsEnum", + "x-ms-enum": { + "name": "ApplicationGatewaySslProtocol", + "modelAsString": true + } + } + }, + "policyType": { + "type": "string", + "description": "Type of Ssl Policy", + "enum": [ + "Predefined", + "Custom" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslPolicyType", + "modelAsString": true + } + }, + "policyName": { + "$ref": "#/definitions/PolicyNameEnum", + "description": "Name of Ssl predefined policy" + }, + "cipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "Ssl cipher suites to be enabled in the specified order to application gateway." + }, + "minProtocolVersion": { + "$ref": "#/definitions/ProtocolsEnum", + "description": "Minimum version of Ssl protocol to be supported on application gateway." + } + }, + "description": "Application Gateway Ssl policy." + }, + "ApplicationGatewayIPConfigurationPropertiesFormat": { + "properties": { + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference of the subnet resource. A subnet from where application gateway gets its private address." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of IP configuration of an application gateway." + }, + "ApplicationGatewayIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the IP configuration that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed." + }, + "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Certificate public data." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Authentication certificates properties of an application gateway." + }, + "ApplicationGatewayAuthenticationCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the authentication certificate that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Authentication certificates of an application gateway." + }, + "ApplicationGatewaySslCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request." + }, + "password": { + "type": "string", + "description": "Password for the pfx file specified in data. Only applicable in PUT request." + }, + "publicCertData": { + "type": "string", + "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of SSL certificates of an application gateway." + }, + "ApplicationGatewaySslCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the SSL certificate that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "SSL certificates of an application gateway." + }, + "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "PrivateIPAddress of the network interface IP Configuration." + }, + "privateIPAllocationMethod": { + "type": "string", + "description": "PrivateIP allocation method.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference of the subnet resource." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference of the PublicIP resource." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of Frontend IP configuration of an application gateway." + }, + "ApplicationGatewayFrontendIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the frontend IP configuration that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Frontend IP configuration of an application gateway." + }, + "ApplicationGatewayFrontendPortPropertiesFormat": { + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "Frontend port" + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of Frontend port of an application gateway." + }, + "ApplicationGatewayFrontendPort": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the frontend port that is unique within an Application Gateway" + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Frontend port of an application gateway." + }, + "ApplicationGatewayBackendAddress": { + "properties": { + "fqdn": { + "type": "string", + "description": "Fully qualified domain name (FQDN)." + }, + "ipAddress": { + "type": "string", + "description": "IP address" + } + }, + "description": "Backend address of an application gateway." + }, + "ApplicationGatewayBackendAddressPoolPropertiesFormat": { + "properties": { + "backendIPConfigurations": { + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "Collection of references to IPs defined in network interfaces." + }, + "backendAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendAddress" + }, + "description": "Backend addresses" + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of Backend Address Pool of an application gateway." + }, + "ApplicationGatewayBackendAddressPool": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the backend address pool that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Backend Address Pool of an application gateway." + }, + "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "The destination port on the backend." + }, + "protocol": { + "type": "string", + "description": "The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'.", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ApplicationGatewayProtocol", + "modelAsString": true + } + }, + "cookieBasedAffinity": { + "type": "string", + "description": "Cookie based affinity.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ApplicationGatewayCookieBasedAffinity", + "modelAsString": true + } + }, + "requestTimeout": { + "type": "integer", + "format": "int32", + "description": "Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds." + }, + "probe": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Probe resource of an application gateway." + }, + "authenticationCertificates": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of references to application gateway authentication certificates." + }, + "connectionDraining": { + "$ref": "#/definitions/ApplicationGatewayConnectionDraining", + "description": "Connection draining of the backend http settings resource." + }, + "hostName": { + "type": "string", + "description": "Host header to be sent to the backend servers." + }, + "pickHostNameFromBackendAddress": { + "type": "boolean", + "description": "Whether to pick host header should be picked from the host name of the backend server. Default value is false." + }, + "affinityCookieName": { + "type": "string", + "description": "Cookie name to use for the affinity cookie." + }, + "probeEnabled": { + "type": "boolean", + "description": "Whether the probe is enabled. Default value is false." + }, + "path": { + "type": "string", + "description": "Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of Backend address pool settings of an application gateway." + }, + "ApplicationGatewayBackendHttpSettings": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the backend http settings that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Backend address pool settings of an application gateway." + }, + "ApplicationGatewayHttpListenerPropertiesFormat": { + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Frontend IP configuration resource of an application gateway." + }, + "frontendPort": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Frontend port resource of an application gateway." + }, + "protocol": { + "type": "string", + "description": "Protocol of the HTTP listener. Possible values are 'Http' and 'Https'.", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ApplicationGatewayProtocol", + "modelAsString": true + } + }, + "hostName": { + "type": "string", + "description": "Host name of HTTP listener." + }, + "sslCertificate": { + "$ref": "./network.json#/definitions/SubResource", + "description": "SSL certificate resource of an application gateway." + }, + "requireServerNameIndication": { + "type": "boolean", + "description": "Applicable only if protocol is https. Enables SNI for multi-hosting." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of HTTP listener of an application gateway." + }, + "ApplicationGatewayHttpListener": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the HTTP listener that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Http listener of an application gateway." + }, + "ApplicationGatewayPathRulePropertiesFormat": { + "properties": { + "paths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Path rules of URL path map." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend address pool resource of URL path map path rule." + }, + "backendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend http settings resource of URL path map path rule." + }, + "redirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Redirect configuration resource of URL path map path rule." + }, + "provisioningState": { + "type": "string", + "description": "Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of path rule of an application gateway." + }, + "ApplicationGatewayPathRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the path rule that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Path rule of URL path map of an application gateway." + }, + "ApplicationGatewayProbePropertiesFormat": { + "properties": { + "protocol": { + "type": "string", + "description": "The protocol used for the probe. Possible values are 'Http' and 'Https'.", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ApplicationGatewayProtocol", + "modelAsString": true + } + }, + "host": { + "type": "string", + "description": "Host name to send the probe to." + }, + "path": { + "type": "string", + "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:" + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds." + }, + "timeout": { + "type": "integer", + "format": "int32", + "description": "the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds." + }, + "unhealthyThreshold": { + "type": "integer", + "format": "int32", + "description": "The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20." + }, + "pickHostNameFromBackendHttpSettings": { + "type": "boolean", + "description": "Whether the host header should be picked from the backend http settings. Default value is false." + }, + "minServers": { + "type": "integer", + "format": "int32", + "description": "Minimum number of servers that are always marked healthy. Default value is 0." + }, + "match": { + "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch", + "description": "Criterion for classifying a healthy probe response." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of probe of an application gateway." + }, + "ApplicationGatewayProbeHealthResponseMatch": { + "properties": { + "body": { + "type": "string", + "description": "Body that must be contained in the health response. Default value is empty." + }, + "statusCodes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399." + } + }, + "description": "Application gateway probe health response match" + }, + "ApplicationGatewayProbe": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the probe that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Probe of the application gateway." + }, + "ApplicationGatewayRequestRoutingRulePropertiesFormat": { + "properties": { + "ruleType": { + "type": "string", + "description": "Rule type.", + "enum": [ + "Basic", + "PathBasedRouting" + ], + "x-ms-enum": { + "name": "ApplicationGatewayRequestRoutingRuleType", + "modelAsString": true + } + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend address pool resource of the application gateway. " + }, + "backendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend http settings resource of the application gateway." + }, + "httpListener": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Http listener resource of the application gateway. " + }, + "urlPathMap": { + "$ref": "./network.json#/definitions/SubResource", + "description": "URL path map resource of the application gateway." + }, + "redirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Redirect configuration resource of the application gateway." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of request routing rule of the application gateway." + }, + "ApplicationGatewayRequestRoutingRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the request routing rule that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Request routing rule of an application gateway." + }, + "ApplicationGatewayRedirectConfigurationPropertiesFormat": { + "properties": { + "redirectType": { + "type": "string", + "$ref": "#/definitions/RedirectTypeEnum", + "description": "Supported http redirection types - Permanent, Temporary, Found, SeeOther.", + "x-ms-enum": { + "name": "ApplicationGatewayRedirectType", + "modelAsString": true + } + }, + "targetListener": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to a listener to redirect the request to." + }, + "targetUrl": { + "type": "string", + "description": "Url to redirect the request to." + }, + "includePath": { + "type": "boolean", + "description": "Include path in the redirected url." + }, + "includeQueryString": { + "type": "boolean", + "description": "Include query string in the redirected url." + }, + "requestRoutingRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Request routing specifying redirect configuration." + }, + "urlPathMaps": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Url path maps specifying default redirect configuration." + }, + "pathRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Path rules specifying redirect configuration." + } + }, + "description": "Properties of redirect configuration of the application gateway." + }, + "ApplicationGatewayRedirectConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the redirect configuration that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Redirect configuration of an application gateway." + }, + "ApplicationGatewayPropertiesFormat": { + "properties": { + "sku": { + "$ref": "#/definitions/ApplicationGatewaySku", + "description": "SKU of the application gateway resource." + }, + "sslPolicy": { + "$ref": "#/definitions/ApplicationGatewaySslPolicy", + "description": "SSL policy of the application gateway resource." + }, + "operationalState": { + "readOnly": true, + "type": "string", + "description": "Operational state of the application gateway resource.", + "enum": [ + "Stopped", + "Starting", + "Running", + "Stopping" + ], + "x-ms-enum": { + "name": "ApplicationGatewayOperationalState", + "modelAsString": true + } + }, + "gatewayIPConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayIPConfiguration" + }, + "description": "Subnets of application the gateway resource." + }, + "authenticationCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" + }, + "description": "Authentication certificates of the application gateway resource." + }, + "sslCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewaySslCertificate" + }, + "description": "SSL certificates of the application gateway resource." + }, + "frontendIPConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" + }, + "description": "Frontend IP addresses of the application gateway resource." + }, + "frontendPorts": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFrontendPort" + }, + "description": "Frontend ports of the application gateway resource." + }, + "probes": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayProbe" + }, + "description": "Probes of the application gateway resource." + }, + "backendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" + }, + "description": "Backend address pool of the application gateway resource." + }, + "backendHttpSettingsCollection": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" + }, + "description": "Backend http settings of the application gateway resource." + }, + "httpListeners": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayHttpListener" + }, + "description": "Http listeners of the application gateway resource." + }, + "urlPathMaps": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayUrlPathMap" + }, + "description": "URL path map of the application gateway resource." + }, + "requestRoutingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" + }, + "description": "Request routing rules of the application gateway resource." + }, + "redirectConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRedirectConfiguration" + }, + "description": "Redirect configurations of the application gateway resource." + }, + "webApplicationFirewallConfiguration": { + "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration", + "description": "Web application firewall configuration." + }, + "enableHttp2": { + "type": "boolean", + "description": "Whether HTTP2 is enabled on the application gateway resource." + }, + "enableFips": { + "type": "boolean", + "description": "Whether FIPS is enabled on the application gateway resource." + }, + "autoscaleConfiguration": { + "$ref": "#/definitions/ApplicationGatewayAutoscaleConfiguration", + "description": "Autoscale Configuration." + }, + "resourceGuid": { + "type": "string", + "description": "Resource GUID property of the application gateway resource." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of the application gateway." + }, + "ApplicationGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPropertiesFormat" + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Application gateway resource" + }, + "ApplicationGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGateway" + }, + "description": "List of an application gateways in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListApplicationGateways API service call." + }, + "ApplicationGatewayUrlPathMapPropertiesFormat": { + "properties": { + "defaultBackendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default backend address pool resource of URL path map." + }, + "defaultBackendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default backend http settings resource of URL path map." + }, + "defaultRedirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default redirect configuration resource of URL path map." + }, + "pathRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPathRule" + }, + "description": "Path rule of URL path map resource." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of UrlPathMap of the application gateway." + }, + "ApplicationGatewayUrlPathMap": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the URL path map that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting." + }, + "ApplicationGatewayWebApplicationFirewallConfiguration": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the web application firewall is enabled or not." + }, + "firewallMode": { + "type": "string", + "description": "Web application firewall mode.", + "enum": [ + "Detection", + "Prevention" + ], + "x-ms-enum": { + "name": "ApplicationGatewayFirewallMode", + "modelAsString": true + } + }, + "ruleSetType": { + "type": "string", + "description": "The type of the web application firewall rule set. Possible values are: 'OWASP'." + }, + "ruleSetVersion": { + "type": "string", + "description": "The version of the rule set type." + }, + "disabledRuleGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallDisabledRuleGroup" + }, + "description": "The disabled rule groups." + }, + "requestBodyCheck": { + "type": "boolean", + "description": "Whether allow WAF to check request Body." + }, + "maxRequestBodySize": { + "type": "integer", + "format": "int32", + "maximum": 128, + "exclusiveMaximum": false, + "minimum": 8, + "exclusiveMinimum": false, + "description": "Maxium request body size for WAF." + } + }, + "required": [ + "enabled", + "firewallMode", + "ruleSetType", + "ruleSetVersion" + ], + "description": "Application gateway web application firewall configuration." + }, + "ApplicationGatewayAutoscaleConfiguration": { + "properties": { + "bounds": { + "$ref": "#/definitions/ApplicationGatewayAutoscaleBounds", + "description": "Autoscale bounds" + } + }, + "required": [ + "bounds" + ], + "description": "Application Gateway autoscale configuration." + }, + "ApplicationGatewayAutoscaleBounds": { + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "Lower bound on number of Application Gateway instances." + }, + "max": { + "type": "integer", + "format": "int32", + "description": "Upper bound on number of Application Gateway instances." + } + }, + "required": [ + "min", + "max" + ], + "description": "Application Gateway autoscale bounds on number of Application Gateway instance." + }, + "ApplicationGatewayConnectionDraining": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether connection draining is enabled or not." + }, + "drainTimeoutInSec": { + "type": "integer", + "format": "int32", + "maximum": 3600, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "description": "The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds." + } + }, + "required": [ + "enabled", + "drainTimeoutInSec" + ], + "description": "Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration." + }, + "ApplicationGatewayFirewallDisabledRuleGroup": { + "properties": { + "ruleGroupName": { + "type": "string", + "description": "The name of the rule group that will be disabled." + }, + "rules": { + "type": "array", + "items": { + "type": "integer", + "format": "int32", + "x-nullable": false + }, + "description": "The list of rules that will be disabled. If null, all rules of the rule group will be disabled." + } + }, + "required": [ + "ruleGroupName" + ], + "description": "Allows to disable rules within a rule group or an entire rule group." + }, + "ApplicationGatewayAvailableWafRuleSetsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRuleSet" + }, + "description": "The list of application gateway rule sets." + } + }, + "description": "Response for ApplicationGatewayAvailableWafRuleSets API service call." + }, + "ApplicationGatewayFirewallRuleSet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFirewallRuleSetPropertiesFormat" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A web application firewall rule set." + }, + "ApplicationGatewayFirewallRuleSetPropertiesFormat": { + "properties": { + "provisioningState": { + "type": "string", + "description": "The provisioning state of the web application firewall rule set." + }, + "ruleSetType": { + "type": "string", + "description": "The type of the web application firewall rule set." + }, + "ruleSetVersion": { + "type": "string", + "description": "The version of the web application firewall rule set type." + }, + "ruleGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRuleGroup" + }, + "description": "The rule groups of the web application firewall rule set." + } + }, + "required": [ + "ruleSetType", + "ruleSetVersion", + "ruleGroups" + ], + "description": "Properties of the web application firewall rule set." + }, + "ApplicationGatewayFirewallRuleGroup": { + "properties": { + "ruleGroupName": { + "type": "string", + "description": "The name of the web application firewall rule group." + }, + "description": { + "type": "string", + "description": "The description of the web application firewall rule group." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRule" + }, + "description": "The rules of the web application firewall rule group." + } + }, + "required": [ + "ruleGroupName", + "rules" + ], + "description": "A web application firewall rule group." + }, + "ApplicationGatewayFirewallRule": { + "properties": { + "ruleId": { + "type": "integer", + "format": "int32", + "description": "The identifier of the web application firewall rule." + }, + "description": { + "type": "string", + "description": "The description of the web application firewall rule." + } + }, + "required": [ + "ruleId" + ], + "description": "A web application firewall rule." + }, + "ApplicationGatewayAvailableSslOptions": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayAvailableSslOptionsPropertiesFormat" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Response for ApplicationGatewayAvailableSslOptions API service call." + }, + "ApplicationGatewayAvailableSslOptionsPropertiesFormat": { + "properties": { + "predefinedPolicies": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of available Ssl predefined policy." + }, + "defaultPolicy": { + "$ref": "#/definitions/PolicyNameEnum", + "description": "Name of the Ssl predefined policy applied by default to application gateway" + }, + "availableCipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "List of available Ssl cipher suites." + }, + "availableProtocols": { + "type": "array", + "items": { + "$ref": "#/definitions/ProtocolsEnum" + }, + "description": "List of available Ssl protocols." + } + }, + "description": "Properties of ApplicationGatewayAvailableSslOptions" + }, + "ApplicationGatewayAvailableSslPredefinedPolicies": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy" + }, + "description": "List of available Ssl predefined policy." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ApplicationGatewayAvailableSslOptions API service call." + }, + "ApplicationGatewaySslPredefinedPolicy": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Ssl predefined policy." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicyPropertiesFormat" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "An Ssl predefined policy" + }, + "ApplicationGatewaySslPredefinedPolicyPropertiesFormat": { + "properties": { + "cipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "Ssl cipher suites to be enabled in the specified order for application gateway." + }, + "minProtocolVersion": { + "$ref": "#/definitions/ProtocolsEnum", + "description": "Minimum version of Ssl protocol to be supported on application gateway." + } + }, + "description": "Properties of ApplicationGatewaySslPredefinedPolicy" + }, + "PolicyNameEnum": { + "type": "string", + "description": "Ssl predefined policy name enums.", + "enum": [ + "AppGwSslPolicy20150501", + "AppGwSslPolicy20170401", + "AppGwSslPolicy20170401S" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslPolicyName", + "modelAsString": true + } + }, + "ProtocolsEnum": { + "type": "string", + "description": "Ssl protocol enums.", + "enum": [ + "TLSv1_0", + "TLSv1_1", + "TLSv1_2" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslProtocol", + "modelAsString": true + } + }, + "CipherSuitesEnum": { + "type": "string", + "description": "Ssl cipher suites enums.", + "enum": [ + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_3DES_EDE_CBC_SHA" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslCipherSuite", + "modelAsString": true + } + }, + "RedirectTypeEnum": { + "type": "string", + "enum": [ + "Permanent", + "Found", + "SeeOther", + "Temporary" + ], + "x-ms-enum": { + "name": "ApplicationGatewayRedirectType", + "modelAsString": true + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/applicationSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/applicationSecurityGroup.json new file mode 100644 index 000000000000..128753640a8d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/applicationSecurityGroup.json @@ -0,0 +1,319 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}": { + "delete": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_Delete", + "description": "Deletes the specified application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete application security group": { "$ref": "./examples/ApplicationSecurityGroupDelete.json" } + } + }, + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_Get", + "description": "Gets information about the specified application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the specified application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + } + }, + "x-ms-examples": { + "Get application security group": { "$ref": "./examples/ApplicationSecurityGroupGet.json" } + } + }, + "put": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_CreateOrUpdate", + "description": "Creates or updates an application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + }, + "description": "Parameters supplied to the create or update ApplicationSecurityGroup operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create application security group": { "$ref": "./examples/ApplicationSecurityGroupCreate.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationSecurityGroups": { + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_ListAll", + "description": "Gets all application security groups in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of application security group resources.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List all application security groups": { "$ref": "./examples/ApplicationSecurityGroupListAll.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups": { + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_List", + "description": "Gets all the application security groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of application security group resources.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroupListResult" + } + } + }, + "x-ms-examples": { + "List load balancers in resource group": { "$ref": "./examples/ApplicationSecurityGroupList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ApplicationSecurityGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationSecurityGroupPropertiesFormat", + "description": "Properties of the application security group." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "An application security group in a resource group." + }, + "ApplicationSecurityGroupPropertiesFormat": { + "properties": { + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Application security group properties." + }, + "ApplicationSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationSecurityGroup" + }, + "description": "A list of application security groups." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of application security groups." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/azureFirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/azureFirewall.json new file mode 100644 index 000000000000..eceba3ee3fc6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/azureFirewall.json @@ -0,0 +1,648 @@ +{ + "swagger":"2.0", + "info":{ + "title":"NetworkManagementClient", + "description":"The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version":"2018-04-01" + }, + "host":"management.azure.com", + "schemes":[ + "https" + ], + "consumes":[ + "application/json" + ], + "produces":[ + "application/json" + ], + "security":[ + { + "azure_auth":[ + "user_impersonation" + ] + } + ], + "securityDefinitions":{ + "azure_auth":{ + "type":"oauth2", + "authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize", + "flow":"implicit", + "description":"Azure Active Directory OAuth2 Flow", + "scopes":{ + "user_impersonation":"impersonate your user account" + } + } + }, + "paths":{ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}":{ + "delete":{ + "tags":[ + "AzureFirewalls" + ], + "operationId":"AzureFirewalls_Delete", + "description":"Deletes the specified Azure Firewall.", + "parameters":[ + { + "name":"resourceGroupName", + "in":"path", + "required":true, + "type":"string", + "description":"The name of the resource group." + }, + { + "name":"azureFirewallName", + "in":"path", + "required":true, + "type":"string", + "description":"The name of the Azure Firewall." + }, + { + "$ref":"#/parameters/ApiVersionParameter" + }, + { + "$ref":"#/parameters/SubscriptionIdParameter" + } + ], + "responses":{ + "202":{ + "description":"Accepted and the operation will complete asynchronously." + }, + "204":{ + "description":"Request successful. Resource with the specified name does not exist" + }, + "200":{ + "description":"Delete successful." + } + }, + "x-ms-examples":{ + "Delete Azure Firewall":{ + "$ref":"./examples/AzureFirewallDelete.json" + } + }, + "x-ms-long-running-operation":true + }, + "get":{ + "tags":[ + "AzureFirewalls" + ], + "operationId":"AzureFirewalls_Get", + "description":"Gets the specified Azure Firewall.", + "parameters":[ + { + "name":"resourceGroupName", + "in":"path", + "required":true, + "type":"string", + "description":"The name of the resource group." + }, + { + "name":"azureFirewallName", + "in":"path", + "required":true, + "type":"string", + "description":"The name of the Azure Firewall." + }, + { + "$ref":"#/parameters/ApiVersionParameter" + }, + { + "$ref":"#/parameters/SubscriptionIdParameter" + } + ], + "responses":{ + "200":{ + "description":"Request successful. The operation returns a AzureFirewall resource.", + "schema":{ + "$ref":"#/definitions/AzureFirewall" + } + } + }, + "x-ms-examples":{ + "Get Azure Firewall":{ + "$ref":"./examples/AzureFirewallGet.json" + } + } + }, + "put":{ + "tags":[ + "AzureFirewalls" + ], + "operationId":"AzureFirewalls_CreateOrUpdate", + "description":"Creates or updates the specified Azure Firewall.", + "parameters":[ + { + "name":"resourceGroupName", + "in":"path", + "required":true, + "type":"string", + "description":"The name of the resource group." + }, + { + "name":"azureFirewallName", + "in":"path", + "required":true, + "type":"string", + "description":"The name of the Azure Firewall." + }, + { + "name":"parameters", + "in":"body", + "required":true, + "schema":{ + "$ref":"#/definitions/AzureFirewall" + }, + "description":"Parameters supplied to the create or update Azure Firewall operation." + }, + { + "$ref":"#/parameters/ApiVersionParameter" + }, + { + "$ref":"#/parameters/SubscriptionIdParameter" + } + ], + "responses":{ + "201":{ + "description":"Create successful. The operation returns the resulting AzureFirewall resource.", + "schema":{ + "$ref":"#/definitions/AzureFirewall" + } + }, + "200":{ + "description":"Update successful. The operation returns the resulting AzureFirewall resource.", + "schema":{ + "$ref":"#/definitions/AzureFirewall" + } + } + }, + "x-ms-examples":{ + "Create Azure Firewall":{ + "$ref":"./examples/AzureFirewallPut.json" + } + }, + "x-ms-long-running-operation":true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ + "AzureFirewalls" + ], + "operationId":"AzureFirewalls_List", + "description":"Lists all Azure Firewalls in a resource group.", + "parameters":[ + { + "name":"resourceGroupName", + "in":"path", + "required":true, + "type":"string", + "description":"The name of the resource group." + }, + { + "$ref":"#/parameters/ApiVersionParameter" + }, + { + "$ref":"#/parameters/SubscriptionIdParameter" + } + ], + "responses":{ + "200":{ + "description":"Success. The operation returns a list of AzureFirewall resources.", + "schema":{ + "$ref":"#/definitions/AzureFirewallListResult" + } + } + }, + "x-ms-examples":{ + "List all Azure Firewalls for a given resource group":{ + "$ref":"./examples/AzureFirewallListByResourceGroup.json" + } + }, + "x-ms-pageable":{ + "nextLinkName":"nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ + "AzureFirewalls" + ], + "operationId":"AzureFirewalls_ListAll", + "description":"Gets all the Azure Firewalls in a subscription.", + "parameters":[ + { + "$ref":"#/parameters/ApiVersionParameter" + }, + { + "$ref":"#/parameters/SubscriptionIdParameter" + } + ], + "responses":{ + "200":{ + "description":"Success. The operation returns a list of AzureFirewall resources.", + "schema":{ + "$ref":"#/definitions/AzureFirewallListResult" + } + } + }, + "x-ms-examples":{ + "List all Azure Firewalls for a given subscription":{ + "$ref":"./examples/AzureFirewallListBySubscription.json" + } + }, + "x-ms-pageable":{ + "nextLinkName":"nextLink" + } + } + } + }, + "definitions":{ + "AzureFirewallIPConfigurationPropertiesFormat":{ + "properties":{ + "privateIPAddress": { + "type": "string", + "description": "The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes." + }, + "subnet":{ + "$ref":"./network.json#/definitions/SubResource", + "description":"Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'." + }, + "internalPublicIpAddress":{ + "$ref":"./network.json#/definitions/SubResource", + "description":"Reference of the PublicIP resource. This field is a mandatory input." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference of the PublicIP resource. This field is populated in the output." + }, + "provisioningState":{ + "description":"The provisioning state of the resource.", + "$ref":"#/definitions/ProvisioningState" + } + }, + "description":"Properties of IP configuration of an Azure Firewall." + }, + "AzureFirewallIPConfiguration":{ + "properties":{ + "properties":{ + "x-ms-client-flatten":true, + "$ref":"#/definitions/AzureFirewallIPConfigurationPropertiesFormat" + }, + "name":{ + "type":"string", + "description":"Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag":{ + "type":"string", + "description":"A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf":[ + { + "$ref":"./network.json#/definitions/SubResource" + } + ], + "description":"IP configuration of an Azure Firewall." + }, + "AzureFirewallPropertiesFormat":{ + "properties":{ + "applicationRuleCollections":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallApplicationRuleCollection" + }, + "description":"Collection of application rule collections used by a Azure Firewall." + }, + "networkRuleCollections":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallNetworkRuleCollection" + }, + "description":"Collection of network rule collections used by a Azure Firewall." + }, + "ipConfigurations":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallIPConfiguration" + }, + "description":"IP configuration of the Azure Firewall resource." + }, + "provisioningState":{ + "description":"The provisioning state of the resource.", + "$ref":"#/definitions/ProvisioningState" + } + }, + "description":"Properties of the Azure Firewall." + }, + "AzureFirewall":{ + "properties":{ + "properties":{ + "x-ms-client-flatten":true, + "$ref":"#/definitions/AzureFirewallPropertiesFormat" + }, + "etag":{ + "type":"string", + "readOnly":true, + "description":"Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf":[ + { + "$ref":"./network.json#/definitions/Resource" + } + ], + "description":"Azure Firewall resource" + }, + "AzureFirewallListResult":{ + "properties":{ + "value":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewall" + }, + "description":"List of a Azure Firewalls in a resource group." + }, + "nextLink":{ + "type":"string", + "description":"URL to get the next set of results." + } + }, + "description":"Response for ListAzureFirewalls API service call." + }, + "AzureFirewallApplicationRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ + "type":"integer", + "format":"int32", + "maximum":65000, + "exclusiveMaximum":false, + "minimum":100, + "exclusiveMinimum":false, + "description":"Priority of the application rule collection resource." + }, + "action":{ + "$ref":"#/definitions/AzureFirewallRCAction", + "description":"The action type of a rule collection" + }, + "rules":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallApplicationRule" + }, + "description":"Collection of rules used by a application rule collection." + }, + "provisioningState":{ + "description":"The provisioning state of the resource.", + "$ref":"#/definitions/ProvisioningState" + } + }, + "description":"Properties of the application rule collection." + }, + "AzureFirewallApplicationRuleCollection":{ + "properties":{ + "properties":{ + "x-ms-client-flatten":true, + "$ref":"#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat" + }, + "name":{ + "type":"string", + "description":"Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag":{ + "type":"string", + "readOnly":true, + "description":"Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf":[ + { + "$ref":"./network.json#/definitions/SubResource" + } + ], + "description":"Application rule collection resource" + }, + "AzureFirewallApplicationRuleProtocol":{ + "properties":{ + "protocolType":{ + "description":"Protocol type", + "$ref":"#/definitions/AzureFirewallApplicationRuleProtocolType" + }, + "port":{ + "type":"integer", + "format":"int32", + "maximum":64000, + "exclusiveMaximum":false, + "minimum":0, + "exclusiveMinimum":false, + "description":"Port number for the protocol, cannot be greater than 64000. This field is optional." + } + }, + "description":"Properties of the application rule protocol." + }, + "AzureFirewallApplicationRule":{ + "properties":{ + "name":{ + "type":"string", + "description":"Name of the application rule." + }, + "description":{ + "type":"string", + "description":"Description of the rule." + }, + "sourceAddresses":{ + "type":"array", + "description":"List of source IP addresses for this rule.", + "items":{ + "type":"string" + } + }, + "protocols":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallApplicationRuleProtocol" + }, + "description":"Array of ApplicationRuleProtocols." + }, + "targetUrls":{ + "type":"array", + "description":"List of URLs for this rule.", + "items":{ + "type":"string" + } + } + }, + "description":"Properties of an application rule." + }, + "AzureFirewallNetworkRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ + "type":"integer", + "format":"int32", + "maximum":65000, + "exclusiveMaximum":false, + "minimum":100, + "exclusiveMinimum":false, + "description":"Priority of the network rule collection resource." + }, + "action":{ + "$ref":"#/definitions/AzureFirewallRCAction", + "description":"The action type of a rule collection" + }, + "rules":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallNetworkRule" + }, + "description":"Collection of rules used by a network rule collection." + }, + "provisioningState":{ + "description":"The provisioning state of the resource.", + "$ref":"#/definitions/ProvisioningState" + } + }, + "description":"Properties of the network rule collection." + }, + "AzureFirewallNetworkRuleCollection":{ + "properties":{ + "properties":{ + "x-ms-client-flatten":true, + "$ref":"#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat" + }, + "name":{ + "type":"string", + "description":"Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag":{ + "type":"string", + "readOnly":true, + "description":"Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf":[ + { + "$ref":"./network.json#/definitions/SubResource" + } + ], + "description":"Network rule collection resource" + }, + "AzureFirewallNetworkRule":{ + "properties":{ + "name":{ + "type":"string", + "description":"Name of the network rule." + }, + "description":{ + "type":"string", + "description":"Description of the rule." + }, + "protocols":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallNetworkRuleProtocol" + }, + "description":"Array of AzureFirewallNetworkRuleProtocols." + }, + "sourceAddresses":{ + "type":"array", + "description":"List of source IP addresses for this rule.", + "items":{ + "type":"string" + } + }, + "destinationAddresses":{ + "type":"array", + "description":"List of destination IP addresses.", + "items":{ + "type":"string" + } + }, + "destinationPorts":{ + "type":"array", + "description":"List of destination ports.", + "items":{ + "type":"string" + } + } + }, + "description":"Properties of the network rule." + }, + "AzureFirewallRCAction":{ + "properties":{ + "type":{ + "description":"The type of action.", + "$ref":"#/definitions/AzureFirewallRCActionType" + } + }, + "description":"Properties of the AzureFirewallRCAction." + }, + "AzureFirewallRCActionType":{ + "type":"string", + "description":"The action type of a rule collection", + "enum":[ + "Allow", + "Deny" + ], + "x-ms-enum":{ + "name":"AzureFirewallRCActionType", + "modelAsString":true + } + }, + "ProvisioningState":{ + "type":"string", + "readOnly":true, + "description":"The current provisisoning state.", + "enum":[ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum":{ + "name":"ProvisioningState", + "modelAsString":true + } + }, + "AzureFirewallNetworkRuleProtocol":{ + "type":"string", + "description":"The protocol of a Network Rule resource", + "enum":[ + "TCP", + "UDP", + "Any", + "ICMP" + ], + "x-ms-enum":{ + "name":"AzureFirewallNetworkRuleProtocol", + "modelAsString":true + } + }, + "AzureFirewallApplicationRuleProtocolType":{ + "type":"string", + "description":"The protocol type of a Application Rule resource", + "enum":[ + "Http", + "Https" + ], + "x-ms-enum":{ + "name":"AzureFirewallApplicationRuleProtocolType", + "modelAsString":true + } + } + }, + "parameters":{ + "SubscriptionIdParameter":{ + "name":"subscriptionId", + "in":"path", + "required":true, + "type":"string", + "description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter":{ + "name":"api-version", + "in":"query", + "required":true, + "type":"string", + "description":"Client API version." + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/checkDnsAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/checkDnsAvailability.json new file mode 100644 index 000000000000..636e77579382 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/checkDnsAvailability.json @@ -0,0 +1,104 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/CheckDnsNameAvailability": { + "get": { + "operationId": "CheckDnsNameAvailability", + "description": "Checks whether a domain name in the cloudapp.azure.com zone is available for use.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "domainNameLabel", + "in": "query", + "required": true, + "type": "string", + "description": "The domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}[a-z0-9]$." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns whether the DNS name is available.", + "schema": { + "$ref": "#/definitions/DnsNameAvailabilityResult" + } + } + }, + "x-ms-examples": { + "Check Dns Name Availability": { "$ref": "./examples/CheckDnsNameAvailability.json" } + } + } + } + }, + "definitions": { + "DnsNameAvailabilityResult": { + "properties": { + "available": { + "type": "boolean", + "description": "Domain availability (True/False)." + } + }, + "description": "Response for the CheckDnsNameAvailability API service call." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/ddosProtectionPlan.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/ddosProtectionPlan.json new file mode 100644 index 000000000000..8f8f469923e5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/ddosProtectionPlan.json @@ -0,0 +1,359 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans/{ddosProtectionPlanName}": { + "delete": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_Delete", + "description": "Deletes the specified DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanDelete.json" + } + } + }, + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_Get", + "description": "Gets information about the specified DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the specified DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + } + }, + "x-ms-examples": { + "Get DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanGet.json" + } + } + }, + "put": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_CreateOrUpdate", + "description": "Creates or updates a DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + }, + "description": "Parameters supplied to the create or update operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ddosProtectionPlans": { + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_List", + "description": "Gets all DDoS protection plans in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of DDoS protection plan resources.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlanListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List all DDoS protection plans": { + "$ref": "./examples/DdosProtectionPlanListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans": { + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_ListByResourceGroup", + "description": "Gets all the DDoS protection plans in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of DDoS protection plan resources.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlanListResult" + } + } + }, + "x-ms-examples": { + "List DDoS protection plans in resource group": { + "$ref": "./examples/DdosProtectionPlanList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DdosProtectionPlan": { + "description": "A DDoS protection plan in a resource group.", + "x-ms-azure-resource": true, + "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." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DdosProtectionPlanPropertiesFormat", + "description": "Properties of the DDoS protection plan." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + } + }, + "DdosProtectionPlanPropertiesFormat": { + "properties": { + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." + }, + "virtualNetworks": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The list of virtual networks associated with the DDoS protection plan resource. This list is read-only." + } + }, + "description": "DDoS protection plan properties." + }, + "DdosProtectionPlanListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DdosProtectionPlan" + }, + "description": "A list of DDoS protection plans." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of DDoS protection plans." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/endpointService.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/endpointService.json new file mode 100644 index 000000000000..02778d39d370 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/endpointService.json @@ -0,0 +1,127 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/virtualNetworkAvailableEndpointServices": { + "get": { + "operationId": "AvailableEndpointServices_List", + "description": "List what values of endpoint services are available for use.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location to check available endpoint services." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns list of available endpoint services.", + "schema": { + "$ref": "#/definitions/EndpointServicesListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EndpointServicesList": { "$ref": "./examples/EndpointServicesList.json" } + } + } + } + }, + "definitions": { + "EndpointServicesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointServiceResult" + }, + "description": "List of available endpoint services in a region." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListAvailableEndpointServices API service call." + }, + "EndpointServiceResult": { + "properties": { + "name": { + "type": "string", + "description": "Name of the endpoint service.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the endpoint service.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Endpoint service." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayAvailableSslOptionsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayAvailableSslOptionsGet.json new file mode 100644 index 000000000000..70871349b5dc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayAvailableSslOptionsGet.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json new file mode 100644 index 000000000000..70871349b5dc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json new file mode 100644 index 000000000000..5c317334e8b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "predefinedPolicyName": "AppGwSslPolicy20150501" + }, + "responses": { + "200": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json new file mode 100644 index 000000000000..202301c85fb9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "OWASP_3.0", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets/", + "type": "Microsoft.Network/applicationGatewayAvailableWafRuleSets", + "properties": { + "provisioningState": "Succeeded", + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0", + "ruleGroups": [ + { + "ruleGroupName": "General", + "description": "", + "rules": [ + { + "ruleId": 200004, + "description": "Possible Multipart Unmatched Boundary." + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayBackendHealthGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayBackendHealthGet.json new file mode 100644 index 000000000000..247ea1c6de74 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayBackendHealthGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "appgw", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "backendAddressPools": [ + { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" + }, + "backendHttpSettingsCollection": [ + { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.8", + "health": "Up" + } + ] + } + ] + }, + { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFPool" + }, + "backendHttpSettingsCollection": [ + { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.4", + "health": "Up" + }, + { + "address": "10.220.1.5", + "health": "Up" + } + ] + } + ] + } + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayCreate.json new file mode 100644 index 000000000000..0bb257a5c6a9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayCreate.json @@ -0,0 +1,371 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "parameters": { + "properties": { + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "properties": { + "data": "****", + "password": "****" + } + } + ], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "properties": { + "port": 443 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "properties": { + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "properties": { + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "properties": { + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + } + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + } + ], + "urlPathMaps": [], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + } + } + } + ], + "probes": [] + } + } + }, + "200": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + } + ], + "urlPathMaps": [], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + } + } + } + ], + "probes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayDelete.json new file mode 100644 index 000000000000..c4262e835113 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayGet.json new file mode 100644 index 000000000000..84698463e9cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayGet.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + } + ], + "urlPathMaps": [], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + } + } + } + ], + "probes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayList.json new file mode 100644 index 000000000000..1fcaa4bc56d5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayList.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "properties": { + "data": "base64-pfxData", + "password": "pass1" + } + } + ], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "properties": { + "port": 443 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "properties": { + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "properties": { + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "properties": { + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayListAll.json new file mode 100644 index 000000000000..3f5cabb26c1a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayListAll.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "properties": { + "data": "base64-pfxData", + "password": "pass1" + } + } + ], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "properties": { + "port": 443 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "properties": { + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "properties": { + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "properties": { + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayStart.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayStart.json new file mode 100644 index 000000000000..d76feab8ea72 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayStart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayStop.json new file mode 100644 index 000000000000..d76feab8ea72 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayStop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayUpdateTags.json new file mode 100644 index 000000000000..17618e3c253a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationGatewayUpdateTags.json @@ -0,0 +1,148 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "applicationGatewayName" : "AppGw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "AppGw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw", + "type": "Microsoft.Network/applicationGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "sku": { + "name": "Standard_Small", + "tier": "Standard", + "capacity": 2 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "GatewayIp01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/gatewayIPConfigurations/GatewayIp01", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet1" + } + } + } + ], + "sslCertificates": [], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "FrontEndConfig01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicIp1" + } + } + } + ], + "frontendPorts": [ + { + "name": "FrontEndPort01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "Pool01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.10.10.1" + }, + { + "ipAddress": "10.10.10.2" + }, + { + "ipAddress": "10.10.10.3" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "PoolSetting01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "pickHostNameFromBackendAddress": false, + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "listener1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01" + }, + "protocol": "Http", + "requireServerNameIndication": false + } + } + ], + "urlPathMaps": [], + "requestRoutingRules": [ + { + "name": "Rule01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/requestRoutingRules/Rule01", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01" + } + } + } + ], + "probes": [], + "redirectConfigurations": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupCreate.json new file mode 100644 index 000000000000..23300bac1318 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupCreate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg", + "parameters": { + "location": "westus", + "properties": { } + } + }, + "responses": { + "200": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupDelete.json new file mode 100644 index 000000000000..0ea3b665c62f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupGet.json new file mode 100644 index 000000000000..d7b89e5e49c5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg" + }, + "responses": { + "200": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupList.json new file mode 100644 index 000000000000..22e2caa551b5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupList.json @@ -0,0 +1,35 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg1", + "name": "asg1", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg2", + "name": "asg2", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } + } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupListAll.json new file mode 100644 index 000000000000..23521f7a16b5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ApplicationSecurityGroupListAll.json @@ -0,0 +1,34 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg1", + "name": "asg1", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg2", + "name": "asg2", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallDelete.json new file mode 100644 index 000000000000..167811354c32 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version" : "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "azureFirewallName" : "azurefirewall" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallGet.json new file mode 100644 index 000000000000..ba2f51902412 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallGet.json @@ -0,0 +1,100 @@ +{ + "parameters":{ + "api-version":"2018-04-01", + "subscriptionId":"subid", + "resourceGroupName":"rg1", + "azureFirewallName":"azurefirewall" + }, + "responses":{ + "200":{ + "body":{ + "name":"azurefirewall", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type":"Microsoft.Network/azureFirewalls", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "location":"West US", + "tags":{ + "key1":"value1" + }, + "properties":{ + "provisioningState":"Succeeded", + "ipConfigurations":[ + { + "name":"azureFirewallIpConfiguration", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "properties":{ + "provisioningState":"Succeeded", + "privateIPAddress":"10.0.0.0", + "subnet":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections":[ + { + "name":"apprulecoll", + "properties":{ + "priority":110, + "action":"Deny", + "rules":[ + { + "name":"rule1", + "description":"Deny inbound rule", + "protocols":[ + { + "protocolType":"Https", + "port":443 + } + ], + "targetUrls":[ + "www.test.com" + ], + "sourceAddresses":[ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "networkRuleCollections":[ + { + "name":"netrulecoll", + "properties":{ + "priority":112, + "action":"Deny", + "rules":[ + { + "name":"D-NAT-web-traffic", + "description":"D-NAT all outbound web traffic for inspection", + "sourceAddresses":[ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts":[ + "443-444", + "8443" + ], + "destinationAddresses":[ + "*" + ], + "protocols":[ + "TCP", + "ICMP" + ] + } + ] + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallListByResourceGroup.json new file mode 100644 index 000000000000..fb8b0e08fc53 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallListByResourceGroup.json @@ -0,0 +1,103 @@ +{ + "parameters":{ + "api-version":"2018-04-01", + "subscriptionId":"subid", + "resourceGroupName":"rg1" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "name":"azurefirewall", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type":"Microsoft.Network/azureFirewalls", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "location":"West US", + "tags":{ + "key1":"value1" + }, + "properties":{ + "provisioningState":"Succeeded", + "ipConfigurations":[ + { + "name":"azureFirewallIpConfiguration", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "properties":{ + "provisioningState":"Succeeded", + "privateIPAddress":"10.0.0.0", + "subnet":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections":[ + { + "name":"apprulecoll", + "properties":{ + "priority":110, + "action":"Deny", + "rules":[ + { + "name":"rule1", + "description":"Deny inbound rule", + "protocols":[ + { + "protocolType":"Https", + "port":443 + } + ], + "targetUrls":[ + "www.test.com" + ], + "sourceAddresses":[ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "networkRuleCollections":[ + { + "name":"netrulecoll", + "properties":{ + "priority":112, + "action":"Deny", + "rules":[ + { + "name":"D-NAT-web-traffic", + "description":"D-NAT all outbound web traffic for inspection", + "sourceAddresses":[ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts":[ + "443-444", + "8443" + ], + "destinationAddresses":[ + "*" + ], + "protocols":[ + "TCP", + "ICMP" + ] + } + ] + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallListBySubscription.json new file mode 100644 index 000000000000..bc84e6b8e7af --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallListBySubscription.json @@ -0,0 +1,102 @@ +{ + "parameters":{ + "api-version":"2018-04-01", + "subscriptionId":"subid" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "name":"azurefirewall", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type":"Microsoft.Network/azureFirewalls", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "location":"West US", + "tags":{ + "key1":"value1" + }, + "properties":{ + "provisioningState":"Succeeded", + "ipConfigurations":[ + { + "name":"azureFirewallIpConfiguration", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "properties":{ + "provisioningState":"Succeeded", + "privateIPAddress":"10.0.0.0", + "subnet":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections":[ + { + "name":"apprulecoll", + "properties":{ + "priority":110, + "action":"Deny", + "rules":[ + { + "name":"rule1", + "description":"Deny inbound rule", + "protocols":[ + { + "protocolType":"Https", + "port":443 + } + ], + "targetUrls":[ + "www.test.com" + ], + "sourceAddresses":[ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "networkRuleCollections":[ + { + "name":"netrulecoll", + "properties":{ + "priority":112, + "action":"Deny", + "rules":[ + { + "name":"D-NAT-web-traffic", + "description":"D-NAT all outbound web traffic for inspection", + "sourceAddresses":[ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts":[ + "443-444", + "8443" + ], + "destinationAddresses":[ + "*" + ], + "protocols":[ + "TCP", + "ICMP" + ] + } + ] + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallPut.json new file mode 100644 index 000000000000..faf18175d030 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/AzureFirewallPut.json @@ -0,0 +1,268 @@ +{ + "parameters":{ + "api-version":"2018-04-01", + "subscriptionId":"subid", + "resourceGroupName":"rg1", + "azureFirewallName":"azurefirewall", + "parameters":{ + "tags":{ + "key1":"value1" + }, + "properties":{ + "ipConfigurations":[ + { + "name":"azureFirewallIpConfiguration", + "properties":{ + "subnet":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "internalPublicIpAddress":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections":[ + { + "name":"apprulecoll", + "properties":{ + "priority":110, + "action":"Deny", + "rules":[ + { + "name":"rule1", + "description":"Deny inbound rule", + "protocols":[ + { + "protocolType":"Https", + "port":443 + } + ], + "targetUrls":[ + "www.test.com" + ], + "sourceAddresses":[ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "networkRuleCollections":[ + { + "name":"netrulecoll", + "properties":{ + "priority":112, + "action":"Deny", + "rules":[ + { + "name":"D-NAT-web-traffic", + "description":"D-NAT all outbound web traffic for inspection", + "sourceAddresses":[ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts":[ + "443-444", + "8443" + ], + "destinationAddresses":[ + "*" + ], + "protocols":[ + "TCP", + "ICMP" + ] + } + ] + } + } + ] + } + } + }, + "responses":{ + "200":{ + "body":{ + "name":"azurefirewall", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type":"Microsoft.Network/azureFirewalls", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "location":"West US", + "tags":{ + "key1":"value1" + }, + "properties":{ + "provisioningState":"Succeeded", + "ipConfigurations":[ + { + "name":"azureFirewallIpConfiguration", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "properties":{ + "provisioningState":"Succeeded", + "privateIPAddress":"10.0.0.0", + "subnet":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections":[ + { + "name":"apprulecoll", + "properties":{ + "priority":110, + "action":"Deny", + "rules":[ + { + "name":"rule1", + "description":"Deny inbound rule", + "protocols":[ + { + "protocolType":"Https", + "port":443 + } + ], + "targetUrls":[ + "www.test.com" + ], + "sourceAddresses":[ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "networkRuleCollections":[ + { + "name":"netrulecoll", + "properties":{ + "priority":112, + "action":"Deny", + "rules":[ + { + "name":"D-NAT-web-traffic", + "description":"D-NAT all outbound web traffic for inspection", + "sourceAddresses":[ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts":[ + "443-444", + "8443" + ], + "destinationAddresses":[ + "*" + ], + "protocols":[ + "TCP", + "ICMP" + ] + } + ] + } + } + ] + } + } + }, + "201":{ + "body":{ + "name":"azurefirewall", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type":"Microsoft.Network/azureFirewalls", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "location":"West US", + "tags":{ + "key1":"value1" + }, + "properties":{ + "provisioningState":"Succeeded", + "ipConfigurations":[ + { + "name":"azureFirewallIpConfiguration", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "properties":{ + "provisioningState":"Succeeded", + "privateIPAddress":"10.0.0.0", + "subnet":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections":[ + { + "name":"apprulecoll", + "properties":{ + "priority":110, + "action":"Deny", + "rules":[ + { + "name":"rule1", + "description":"Deny inbound rule", + "protocols":[ + { + "protocolType":"Https", + "port":443 + } + ], + "targetUrls":[ + "www.test.com" + ], + "sourceAddresses":[ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "networkRuleCollections":[ + { + "name":"netrulecoll", + "properties":{ + "priority":112, + "action":"Deny", + "rules":[ + { + "name":"D-NAT-web-traffic", + "description":"D-NAT all outbound web traffic for inspection", + "sourceAddresses":[ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts":[ + "443-444", + "8443" + ], + "destinationAddresses":[ + "*" + ], + "protocols":[ + "TCP", + "ICMP" + ] + } + ] + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/CheckDnsNameAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/CheckDnsNameAvailability.json new file mode 100644 index 000000000000..59c3eaaf4d6c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/CheckDnsNameAvailability.json @@ -0,0 +1,15 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "location" : "westus", + "domainNameLabel" : "testdns" + }, + "responses" : { + "200" : { + "body": { + "available": false + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanCreate.json new file mode 100644 index 000000000000..79caeac051fa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan", + "parameters": { + "location": "westus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [] + } + } + }, + "201": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanDelete.json new file mode 100644 index 000000000000..4065052471f4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanGet.json new file mode 100644 index 000000000000..8cd61c17d545 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan" + }, + "responses": { + "200": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanList.json new file mode 100644 index 000000000000..65d6e4550846 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan1", + "name": "plan1", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan2", + "name": "plan2", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanListAll.json new file mode 100644 index 000000000000..041d75311c08 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DdosProtectionPlanListAll.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan1", + "name": "plan1", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet1" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan2", + "name": "plan2", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet3" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DefaultSecurityRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DefaultSecurityRuleGet.json new file mode 100644 index 000000000000..4f8e0c3fcc19 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DefaultSecurityRuleGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "networkSecurityGroupName": "nsg1", + "defaultSecurityRuleName": "AllowVnetInBound" + }, + "responses": { + "200": { + "body": { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DefaultSecurityRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DefaultSecurityRuleList.json new file mode 100644 index 000000000000..a8a9851d6093 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/DefaultSecurityRuleList.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "networkSecurityGroupName": "nsg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/EndpointServicesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/EndpointServicesList.json new file mode 100644 index 000000000000..4fc4f55b981a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/EndpointServicesList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Storage", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Storage", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + }, + { + "name": "Microsoft.Sql", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Sql", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + }, + { + "name": "Microsoft.AzureActiveDirectory", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.AzureActiveDirectory", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitARPTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitARPTableList.json new file mode 100644 index 000000000000..6e1e0f530837 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitARPTableList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "value": [ + { + "age": 0, + "interface": "Microsoft", + "ipAddress": "IPAddress", + "macAddress": "macAddress" + } + ] + }, + "202": { + "value": [ + { + "age": 0, + "interface": "Microsoft", + "ipAddress": "IPAddress", + "macAddress": "macAddress" + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitAuthorizationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitAuthorizationCreate.json new file mode 100644 index 000000000000..e710dbb3843b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitAuthorizationCreate.json @@ -0,0 +1,39 @@ +{ + "parameters":{ + "circuitName":"circuitName", + "resourceGroupName":"rg1", + "authorizationName":"authorizatinName", + "api-version": "2018-04-01", + "subscriptionId":"subid", + "authorizationParameters":{ + "properties": { + "authorizationKey": "authKey", + "authorizationUseStatus":"Available" + } + } + }, + "responses":{ + "201":{ + "body":{ + "name":"authorizationName", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag":"W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", + "properties":{ + "provisioningState":"Updating", + "authorizationUseStatus":"Available" + } + } + }, + "200":{ + "body":{ + "name":"authorizationName", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/authorizations/authorizationName", + "etag":"W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", + "properties":{ + "provisioningState":"Updating", + "authorizationUseStatus":"Available" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitAuthorizationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitAuthorizationDelete.json new file mode 100644 index 000000000000..378de4d55604 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitAuthorizationDelete.json @@ -0,0 +1,20 @@ +{ + "parameters":{ + "circuitName":"circuitName", + "resourceGroupName":"rg1", + "api-version": "2018-04-01", + "subscriptionId":"subid", + "authorizationName":"authorizationName" + }, + "responses":{ + "200":{ + + }, + "202":{ + + }, + "204":{ + + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitAuthorizationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitAuthorizationGet.json new file mode 100644 index 000000000000..a26fc0af9808 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitAuthorizationGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "authorizationName": "authorizationName" + }, + "responses": { + "200": { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authKey", + "authorizationUseStatus": "Available" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitAuthorizationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitAuthorizationList.json new file mode 100644 index 000000000000..ee9bb3ccb1ef --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitAuthorizationList.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "value": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authKey", + "authorizationUseStatus": "Available" + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitConnectionCreate.json new file mode 100644 index 000000000000..841ec6d79694 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitConnectionCreate.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering", + "type": "Microsoft.Network/expressRouteCircuits/peerings/connections", + "expressRouteCircuitConnectionParameters": { + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/29" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState":"Succeeded" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState":"Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitConnectionDelete.json new file mode 100644 index 000000000000..580b10b1f815 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitConnectionDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering", + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitConnectionGet.json new file mode 100644 index 000000000000..3e72f72c3e76 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitConnectionGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState":"Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitCreate.json new file mode 100644 index 000000000000..24feb838cd09 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitCreate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "parameters": { + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + }, + "properties": { + "authorizations": [], + "peerings": [], + "allowClassicOperations": false, + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + } + }, + "location": "West US" + } + }, + "responses": { + "201": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + }, + "200": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitDelete.json new file mode 100644 index 000000000000..77cb90065bf4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitGet.json new file mode 100644 index 000000000000..1688a13fa37b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitListByResourceGroup.json new file mode 100644 index 000000000000..ac4e95f8bc75 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitListByResourceGroup.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "value": [ + { + "name": "circuitName1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "262effd3-248d-4754-9068-0a89260dd918", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "113", + "serviceKey": "a1410692-ed3b-4ceb-b94a-b90b95d398d1", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + }, + { + "name": "circuitName2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "47853fd2-9261-4670-b7c3-2debcf9b88da", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2/authorizations/MyAuthorization2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "6569625a-9ba4-498b-9719-14d778eef609", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitListBySubscription.json new file mode 100644 index 000000000000..f95ab5abc92f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitListBySubscription.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "value": [ + { + "name": "circuitName1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "262effd3-248d-4754-9068-0a89260dd918", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "113", + "serviceKey": "a1410692-ed3b-4ceb-b94a-b90b95d398d1", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + }, + { + "name": "circuitName2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "47853fd2-9261-4670-b7c3-2debcf9b88da", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2/authorizations/MyAuthorization2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "6569625a-9ba4-498b-9719-14d778eef609", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringCreate.json new file mode 100644 index 000000000000..8e3a8308570f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringCreate.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "peeringParameters": { + "properties": { + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "vlanId": 200 + } + } + }, + "responses": { + "201": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer" + } + } + }, + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringDelete.json new file mode 100644 index 000000000000..d033380f2531 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "peeringName": "peeringName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringGet.json new file mode 100644 index 000000000000..b9f7b177afe7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringGet.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "peeringName": "MicrosoftPeering" + }, + "responses": { + "200": { + "name": "MicrosoftPeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "MicrosoftPeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "123.0.0.0/30", + "secondaryPeerAddressPrefix": "123.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 300, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "123.1.0.0/24" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + }, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "3FFE:FFFF:0:CD31::/120" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringList.json new file mode 100644 index 000000000000..06f6d429b076 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringList.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "value": [ + { + "name": "MicrosoftPeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "MicrosoftPeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "123.0.0.0/30", + "secondaryPeerAddressPrefix": "123.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 300, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "123.1.0.0/24" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + }, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "3FFE:FFFF:0:CD31::/120" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + } + } + } + }, + { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "10.0.0.0/30", + "secondaryPeerAddressPrefix": "10.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer" + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringStats.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringStats.json new file mode 100644 index 000000000000..39b7a0bde33c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitPeeringStats.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "peeringName": "peeringName" + }, + "responses": { + "200": { + "primaryBytesIn": 537408, + "primaryBytesOut": 44032550, + "secondaryBytesIn": 0, + "secondaryBytesOut": 39002500 + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitRouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitRouteTableList.json new file mode 100644 index 000000000000..d41bf7e1c65c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitRouteTableList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "value": [ + { + "network": "", + "nextHop": "", + "locPrf": "", + "weight": 0, + "path": "" + } + ] + }, + "202": { + "value": [ + { + "network": "", + "nextHop": "", + "locPrf": "", + "weight": 0, + "path": "" + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitRouteTableSummaryList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitRouteTableSummaryList.json new file mode 100644 index 000000000000..dcaab7547981 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitRouteTableSummaryList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "value": [ + { + "neighbor": "100.65.171.1", + "v": 4, + "as": 9583, + "upDown": "never", + "statePfxRcd": "Idle" + } + ] + }, + "202": { + "value": [ + { + "neighbor": "100.65.171.1", + "v": 4, + "as": 9583, + "upDown": "never", + "statePfxRcd": "Idle" + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitStats.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitStats.json new file mode 100644 index 000000000000..7b47169865b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitStats.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "primaryBytesIn": 537408, + "primaryBytesOut": 44032550, + "secondaryBytesIn": 0, + "secondaryBytesOut": 39002500 + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitUpdateTags.json new file mode 100644 index 000000000000..5027cc796e81 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCircuitUpdateTags.json @@ -0,0 +1,48 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "ertest", + "circuitName" : "er1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "er1", + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Failed", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 1000 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "0b392c2e-1e9d-46d7-b5e0-9ce90ca6b60c", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json new file mode 100644 index 000000000000..ce15a8418b25 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "peeringParameters": { + "properties": { + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "vlanId": 200 + } + } + }, + "responses": { + "201": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer" + } + } + }, + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-Boydton1DC/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json new file mode 100644 index 000000000000..47d85095ef25 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + }, + "202": { + }, + "204": { + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json new file mode 100644 index 000000000000..e2d2c07b53d1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-Boydton1DC/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json new file mode 100644 index 000000000000..2b3a604b5eb8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionGet.json new file mode 100644 index 000000000000..ef78ed532bb8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionGet.json @@ -0,0 +1,32 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "CrossConnection-SiliconValley", + "crossConnectionName" : "" + }, + "responses" : { + "200" : { + "body" : { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionList.json new file mode 100644 index 000000000000..c02c6f30bc81 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json new file mode 100644 index 000000000000..4b2bdaf1ed82 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "resourceGroupName": "CrossConnection-SiliconValley", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSilicon-Valley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionUpdate.json new file mode 100644 index 000000000000..6cb3c11f3751 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "CrossConnection-SiliconValley", + "crossConnectionName" : "", + "parameters": { + "properties": { + "serviceProviderProvisioningState": "NotProvisioned" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionUpdateTags.json new file mode 100644 index 000000000000..0247242c02b1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionUpdateTags.json @@ -0,0 +1,41 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "CrossConnection-SiliconValley", + "crossConnectionName" : "", + "crossConnectionParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "er1", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Failed", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionsArpTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionsArpTable.json new file mode 100644 index 000000000000..3684c3940655 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionsArpTable.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "age": 0, + "interface": "Microsoft" , + "ipAddress": "192.116.14.254", + "macAddress": "885a.9269.9110" + } + ] + } + }, + "202": { + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionsRouteTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionsRouteTable.json new file mode 100644 index 000000000000..7d7a02eceb70 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionsRouteTable.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "network": "10.6.0.0/16", + "nextHop": "10.6.1.12" , + "locPrf": "", + "weight": 0, + "path": "65514" + }, + { + "network": "10.7.0.0/16", + "nextHop": "10.7.1.13" , + "locPrf": "", + "weight": 0, + "path": "65514" + } + ] + } + }, + "202": { + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json new file mode 100644 index 000000000000..c82f6900a27e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "neighbor": "10.6.1.112", + "asn": 65514, + "upDown": "1d14h", + "stateOrPrefixesReceived": "Active" + }, + { + "neighbor": "10.6.1.113", + "asn": 65514, + "upDown": "1d14h", + "stateOrPrefixesReceived": "1" + } + ] + } + }, + "202": { + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteProviderList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteProviderList.json new file mode 100644 index 000000000000..23bbcec21f8a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ExpressRouteProviderList.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "value": [ + { + "name": "providerName", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/expressRouteServiceProviders/", + "type": "Microsoft.Network/expressRouteServiceProviders", + "properties": { + "provisioningState": "Succeeded", + "peeringLocations": [ + "peeringLocation1", + "peeringLocation2" + ], + "bandwidthsOffered": [ + { + "offerName": "50Mbps", + "valueInMbps": 50 + }, + { + "offerName": "100Mbps", + "valueInMbps": 100 + }, + { + "offerName": "200Mbps", + "valueInMbps": 200 + }, + { + "offerName": "500Mbps", + "valueInMbps": 500 + }, + { + "offerName": "1Gbps", + "valueInMbps": 1000 + }, + { + "offerName": "2Gbps", + "valueInMbps": 2000 + }, + { + "offerName": "5Gbps", + "valueInMbps": 5000 + }, + { + "offerName": "10Gbps", + "valueInMbps": 10000 + } + ] + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HubVirtualNetworkConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HubVirtualNetworkConnectionDelete.json new file mode 100644 index 000000000000..c0e167e880c1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HubVirtualNetworkConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HubVirtualNetworkConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HubVirtualNetworkConnectionGet.json new file mode 100644 index 000000000000..77d363a345c5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HubVirtualNetworkConnectionGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualNetworks/vnet1" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HubVirtualNetworkConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HubVirtualNetworkConnectionList.json new file mode 100644 index 000000000000..4b38d3df51df --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HubVirtualNetworkConnectionList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualNetworks/vnet1" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + }, + { + "name": "connection2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualNetworks/vnet2" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + ] + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HubVirtualNetworkConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HubVirtualNetworkConnectionPut.json new file mode 100644 index 000000000000..477754977bca --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HubVirtualNetworkConnectionPut.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "hubVirtualNetworkConnectionParameters": { + "properties": { + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + }, + "responses": { + "200": { + "body": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualNetworks/vnet1" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + ] + }, + "201": { + "body": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualNetworks/vnet1" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + ] + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/InboundNatRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/InboundNatRuleCreate.json new file mode 100644 index 000000000000..199642615bea --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/InboundNatRuleCreate.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1", + "inboundNatRuleParameters": { + "properties": { + "protocol": "Tcp", + "frontendIPConfiguration": { "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1"}, + "frontendPort": 3390, + "backendPort": 3389, + "idleTimeoutInMinutes": 4, + "enableFloatingIP": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + }, + "201": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/InboundNatRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/InboundNatRuleDelete.json new file mode 100644 index 000000000000..b5465b1e2db7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/InboundNatRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/InboundNatRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/InboundNatRuleGet.json new file mode 100644 index 000000000000..d9b79b945efb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/InboundNatRuleGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1" + }, + "responses": { + "200": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/InboundNatRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/InboundNatRuleList.json new file mode 100644 index 000000000000..21c5bc3e3a47 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/InboundNatRuleList.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + }, + { + "name": "natRule1.3", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.3", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3392, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerBackendAddressPoolGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerBackendAddressPoolGet.json new file mode 100644 index 000000000000..aa298f07906f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerBackendAddressPoolGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic/ipConfigurations/default-ip-config" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerBackendAddressPoolList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerBackendAddressPoolList.json new file mode 100644 index 000000000000..82536e80b3c0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerBackendAddressPoolList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic/ipConfigurations/default-ip-config" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerCreate.json new file mode 100644 index 000000000000..75bb03258ca7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerCreate.json @@ -0,0 +1,332 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundNatRules": [] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + }, + "201" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerCreateStandardSku.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerCreateStandardSku.json new file mode 100644 index 000000000000..ab8c7bad3063 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerCreateStandardSku.json @@ -0,0 +1,335 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundNatRules": [] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + }, + "201" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerCreateWithInboundNatPool.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerCreateWithInboundNatPool.json new file mode 100644 index 000000000000..756abc1d18cb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerCreateWithInboundNatPool.json @@ -0,0 +1,165 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "properties": { + "frontendIPConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "properties": { + "serviceEndpoints": [], + "resourceNavigationLinks": [] + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + } + }, + "name": "test", + "zones": [], + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "inboundNatPools": [ + { + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + }, + "protocol": "Tcp", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true + }, + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ], + "outboundNatRules": [] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + }, + "inboundNatPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ] + } + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundNatRules": [], + "inboundNatPools": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test", + "properties": { + "provisioningState": "Succeeded", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true, + "protocol": "Tcp", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + } + } + ] + } + } + }, + "201" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + }, + "inboundNatPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ] + } + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundNatRules": [], + "inboundNatPools": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test", + "properties": { + "provisioningState": "Succeeded", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true, + "protocol": "Tcp", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerCreateWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerCreateWithZones.json new file mode 100644 index 000000000000..8fc74d0eb940 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerCreateWithZones.json @@ -0,0 +1,335 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + }, + "zones": [ "1" ] + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundNatRules": [] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "zones": [ "1" ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + }, + "201" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "zones": [ "1" ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerDelete.json new file mode 100644 index 000000000000..44754489e8ac --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerFrontendIPConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerFrontendIPConfigurationGet.json new file mode 100644 index 000000000000..3ea4e48f7f97 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerFrontendIPConfigurationGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "frontendIPConfigurationName": "frontend", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "name": "frontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/frontend", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerFrontendIPConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerFrontendIPConfigurationList.json new file mode 100644 index 000000000000..f5704da312c1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerFrontendIPConfigurationList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "loadBalancerName": "lb" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "frontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/frontend", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerGet.json new file mode 100644 index 000000000000..3ad0daf3331e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerGet.json @@ -0,0 +1,125 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb" + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerList.json new file mode 100644 index 000000000000..e9d0204503fb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerList.json @@ -0,0 +1,140 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "felb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "belb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration":{ + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb" + } + } + } + ], + "probes": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inrlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + }, + { + "name": "lb2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb2", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerListAll.json new file mode 100644 index 000000000000..314a53d440b2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerListAll.json @@ -0,0 +1,139 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "felb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "belb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration":{ + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb" + } + } + } + ], + "probes": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inrlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + }, + { + "name": "lb3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb3", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerLoadBalancingRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerLoadBalancingRuleGet.json new file mode 100644 index 000000000000..2d75428234bb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerLoadBalancingRuleGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "loadBalancingRuleName": "rule1", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/loadBalancingRules/rule1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/probes/probe1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerLoadBalancingRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerLoadBalancingRuleList.json new file mode 100644 index 000000000000..5bc9da10b42e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerLoadBalancingRuleList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/loadBalancingRules/rule1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/probes/probe1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerNetworkInterfaceListSimple.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerNetworkInterfaceListSimple.json new file mode 100644 index 000000000000..0086d72ae024 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerNetworkInterfaceListSimple.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mynic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/frontendSubnet" + }, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inbound1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": false, + "enableIPForwarding": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerNetworkInterfaceListVmss.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerNetworkInterfaceListVmss.json new file mode 100644 index 000000000000..f9e0137e6c4f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerNetworkInterfaceListVmss.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vmss1Nic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/vmss1Nic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "vmss1IpConfig", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/vmss1Nic/ipConfigurations/vmss1IpConfig", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vmss1Vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/natpool.0" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "aaaaaaaaaaaaaaaaaaaaaaaaaa.dx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0" + } + } + }, + { + "name": "vmss1Nic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/vmss1Nic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "vmss1IpConfig", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/vmss1Nic/ipConfigurations/vmss1IpConfig", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vmss1Vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool" + } + ], + "loadBalancerInboundNatRules":[ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/natpool.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "aaaaaaaaaaaaaaaaaaaaaaaaaa.dx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerProbeGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerProbeGet.json new file mode 100644 index 000000000000..4ae762ca5c79 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerProbeGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "probeName": "probe1", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "name": "probe1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/probe1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerProbeList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerProbeList.json new file mode 100644 index 000000000000..5d4cd2851e81 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerProbeList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerUpdateTags.json new file mode 100644 index 000000000000..5550089f7aab --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LoadBalancerUpdateTags.json @@ -0,0 +1,132 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayCreate.json new file mode 100644 index 000000000000..ab202a28276e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayCreate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName" : "localgw", + "parameters": { + "properties": { + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + }, + "location": "Central US" + } + }, + "responses" : { + "201" : { + "body" : { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + } + }, + "200" : { + "body" : { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayDelete.json new file mode 100644 index 000000000000..9b526cc76dd4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName" : "localgw" + }, + "responses" : { + "202" : { }, + "200" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayGet.json new file mode 100644 index 000000000000..9889abd0421d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName" : "localgw" + }, + "responses" : { + "200" : { + "body" : { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayList.json new file mode 100644 index 000000000000..f01666556343 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "localgw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + }, + { + "name": "localgw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.2.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayUpdateTags.json new file mode 100644 index 000000000000..6b5d99b60f10 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/LocalNetworkGatewayUpdateTags.json @@ -0,0 +1,38 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "localNetworkGatewayName": "lgw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw", + "type": "Microsoft.Network/localNetworkGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "gatewayIpAddress": "12.0.0.1" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceCreate.json new file mode 100644 index 000000000000..f5739e83f8e0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceCreate.json @@ -0,0 +1,98 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "properties": { + "enableAcceleratedNetworking": true, + "ipConfigurations": [ + { + "name": "ipconfig1", + "properties": { + "publicIPAddress": { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + } + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + }, + "201" : { + "body" : { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceDelete.json new file mode 100644 index 000000000000..f907c20b88cf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceEffectiveNSGList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceEffectiveNSGList.json new file mode 100644 index 000000000000..5eca0a4b2182 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceEffectiveNSGList.json @@ -0,0 +1,71 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/test-nsg" + }, + "association" : { + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "networkInterface" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1" + } + }, + "effectiveSecurityRules" : [ + { + "name" : "securityRules/rule1", + "protocol" : "Tcp", + "sourcePortRange" : "456-456", + "destinationPortRange" : "6579-6579", + "sourceAddressPrefix" : "0.0.0.0/32", + "destinationAddressPrefix" : "0.0.0.0/32", + "access" : "Allow", + "priority" : 234, + "direction" : "Inbound" + }, + { + "name" : "securityRules/default-allow-rdp", + "protocol" : "Tcp", + "sourcePortRange" : "0-65535", + "destinationPortRange" : "3389-3389", + "sourceAddressPrefix" : "1.1.1.1/32", + "destinationAddressPrefix" : "0.0.0.0/0", + "access" : "Allow", + "priority" : 1000, + "direction" : "Inbound" + }, + { + "name" : "defaultSecurityRules/AllowInternetOutBound", + "protocol" : "All", + "sourcePortRange" : "0-65535", + "destinationPortRange" : "0-65535", + "sourceAddressPrefix" : "0.0.0.0/0", + "destinationAddressPrefix" : "Internet", + "expandedDestinationAddressPrefix" : [ + "32.0.0.0/3", + "4.0.0.0/6", + "2.0.0.0/7", + "1.0.0.0/8" + ], + "access" : "Allow", + "priority" : 65001, + "direction" : "Outbound" + } + ] + } + ] + } + }, + "202" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceEffectiveRouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceEffectiveRouteTableList.json new file mode 100644 index 000000000000..4553afb2b6d9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceEffectiveRouteTableList.json @@ -0,0 +1,71 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "172.20.2.0/24" + ], + "nextHopType": "VnetLocal", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "0.0.0.0/0" + ], + "nextHopType": "Internet", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "10.0.0.0/8" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "100.64.0.0/10" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "172.16.0.0/12" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "192.168.0.0/16" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + } + ] + } + }, + "202" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceGet.json new file mode 100644 index 000000000000..b819b9285181 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceGet.json @@ -0,0 +1,54 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic" + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [], + "internalDomainNameSuffix" : "test.bx.internal.cloudapp.net" + }, + "macAddress" : "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false, + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary" : true, + "virtualMachine" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type" : "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceIPConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceIPConfigurationGet.json new file mode 100644 index 000000000000..573dac3a5afe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceIPConfigurationGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic", + "ipConfigurationName": "ipconfig1", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/frontendSubnet" + }, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceIPConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceIPConfigurationList.json new file mode 100644 index 000000000000..3bbf9644fc05 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceIPConfigurationList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "nic1", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet12/subnets/subnet12" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceList.json new file mode 100644 index 000000000000..a8f70cd2a533 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceList.json @@ -0,0 +1,90 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [], + "internalDomainNameSuffix" : "test.bx.internal.cloudapp.net" + }, + "macAddress" : "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false, + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary" : true, + "virtualMachine" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type" : "Microsoft.Network/networkInterfaces" + }, + { + "name" : "test-nic2", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip2" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet2/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceListAll.json new file mode 100644 index 000000000000..ed2a27fe9c11 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceListAll.json @@ -0,0 +1,89 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [], + "internalDomainNameSuffix" : "test.bx.internal.cloudapp.net" + }, + "macAddress" : "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false, + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary" : true, + "virtualMachine" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type" : "Microsoft.Network/networkInterfaces" + }, + { + "name" : "test-nic2", + "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/networkInterfaces/test-nic2", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/networkInterfaces/test-nic2/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/publicIPAddresses/test-ip2" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/virtualNetworks/rgnew-vnet2/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceLoadBalancerList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceLoadBalancerList.json new file mode 100644 index 000000000000..67dd67806a2a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceLoadBalancerList.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "nic1", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "lbname1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "frontendIPConfigurations": [ + { + "name": "lbfrontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/publicIPAddresses/myDynamicPublicIP" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "bepool1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/probes/probe1" + } + } + } + ], + "probes": [ + { + "name": "probe1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/probes/probe1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inbound1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1" + } + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceUpdateTags.json new file mode 100644 index 000000000000..f10f69e651ad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkInterfaceUpdateTags.json @@ -0,0 +1,55 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupCreate.json new file mode 100644 index 000000000000..603e6e07b780 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupCreate.json @@ -0,0 +1,231 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "parameters": {} + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + }, + "201" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupCreateWithRule.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupCreateWithRule.json new file mode 100644 index 000000000000..032ea84374b6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupCreateWithRule.json @@ -0,0 +1,281 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "parameters": { + "properties": { + "securityRules": [ + { + "name": "rule1", + "properties": { + "protocol": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "destinationPortRange": "80", + "sourcePortRange": "*", + "priority": 130, + "direction": "Inbound" + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + }, + "201" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupDelete.json new file mode 100644 index 000000000000..e26f8a45a229 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupGet.json new file mode 100644 index 000000000000..10d9e1fb778b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupGet.json @@ -0,0 +1,136 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg" + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupList.json new file mode 100644 index 000000000000..971da4645623 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupList.json @@ -0,0 +1,231 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "nsg1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + }, + { + "name": "nsg3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupListAll.json new file mode 100644 index 000000000000..3c9e8166b3e9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupListAll.json @@ -0,0 +1,230 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "nsg1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + }, + { + "name": "nsg3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupRuleCreate.json new file mode 100644 index 000000000000..e08386f9e279 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupRuleCreate.json @@ -0,0 +1,57 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "securityRuleName": "rule1", + "securityRuleParameters": { + "properties": { + "protocol": "*", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "destinationPortRange": "8080", + "sourcePortRange": "*", + "priority": 100, + "direction": "Outbound" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "rule1", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "8080", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "priority": 100, + "direction": "Outbound" + } + } + }, + "201" : { + "body" : { + "name": "rule1", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "8080", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "priority": 100, + "direction": "Outbound" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupRuleDelete.json new file mode 100644 index 000000000000..298eb9e63d5e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "securityRuleName": "rule1" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupRuleGet.json new file mode 100644 index 000000000000..c1ec6f16b507 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupRuleGet.json @@ -0,0 +1,28 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "securityRuleName": "rule1" + }, + "responses" : { + "200" : { + "body" : { + "name": "rule1", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupRuleList.json new file mode 100644 index 000000000000..ee31c2ff05ca --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupRuleList.json @@ -0,0 +1,31 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "rule1", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupUpdateTags.json new file mode 100644 index 000000000000..5ab8c67136c3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkSecurityGroupUpdateTags.json @@ -0,0 +1,130 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherAvailableProvidersListGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherAvailableProvidersListGet.json new file mode 100644 index 000000000000..383495c61180 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherAvailableProvidersListGet.json @@ -0,0 +1,66 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "azureLocations" : [ "West US" ], + "country" : "United States", + "state" : "washington", + "city" : "seattle" + } + }, + "responses" : { + "200" : { + "body" : { + "countries" : [ + { + "countryName" : "United States", + "states" : [ + { + "stateName" : "washington", + "cities" : [ + { + "cityName" : "seattle", + "providers" : [ + "Comcast Cable Communications, Inc. - ASN 7922", + "Comcast Cable Communications, LLC - ASN 7922", + "Level 3 Communications, Inc. (GBLX) - ASN 3549", + "Qwest Communications Company, LLC - ASN 209" + ] + } + ] + } + ] + } + ] + } + }, + "202" : { + "body" : { + "countries" : [ + { + "countryName" : "United States", + "states" : [ + { + "stateName" : "washington", + "cities" : [ + { + "cityName" : "seattle", + "providers" : [ + "Comcast Cable Communications, Inc. - ASN 7922", + "Comcast Cable Communications, LLC - ASN 7922", + "Level 3 Communications, Inc. (GBLX) - ASN 3549", + "Qwest Communications Company, LLC - ASN 209" + ] + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherAzureReachabilityReportGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherAzureReachabilityReportGet.json new file mode 100644 index 000000000000..37f3319d9c90 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherAzureReachabilityReportGet.json @@ -0,0 +1,82 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "providerLocation" : { + "country" : "United States", + "state" : "washington" + }, + "providers" : [ + "Frontier Communications of America, Inc. - ASN 5650" + ], + "azureLocations" : [ + "West US" + ], + "startTime": "2017-09-07T00:00:00Z", + "endTime": "2017-09-10T00:00:00Z" + } + }, + "responses" : { + "200" : { + "body" : { + "aggregationLevel" : "State", + "providerLocation" : { + "country" : "United States", + "state" : "washington" + }, + "reachabilityReport" : [ + { + "provider" : "Frontier Communications of America, Inc. - ASN 5650", + "azureLocation": "West US", + "latencies": [ + { + "timeStamp": "2017-09-07T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-08T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-09T00:00:00Z", + "score": 94 + } + ] + } + ] + } + }, + "202" : { + "body" : { + "aggregationLevel" : "State", + "providerLocation" : { + "country" : "United States", + "state" : "washington" + }, + "reachabilityReport" : [ + { + "provider" : "Frontier Communications of America, Inc. - ASN 5650", + "azureLocation": "West US", + "latencies": [ + { + "timeStamp": "2017-09-07T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-08T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-09T00:00:00Z", + "score": 94 + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorCreate.json new file mode 100644 index 000000000000..e8615587e0c7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorCreate.json @@ -0,0 +1,70 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "connectionMonitorName" : "cm1", + "location": "centraluseuap", + "parameters" : { + "properties": { + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60 + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "cm1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag" : "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties" : { + "provisioningState": "Updating", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "monitoringStatus": "NotStarted" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + }, + "201" : { + "body" : { + "name" : "cm1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag" : "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties" : { + "provisioningState": "Updating", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "monitoringStatus": "NotStarted" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorDelete.json new file mode 100644 index 000000000000..473bdcbe3212 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "connectionMonitorName" : "cm1" + }, + "responses" : { + "204" : {}, + "202" : {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorGet.json new file mode 100644 index 000000000000..9c2c252dbea4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorGet.json @@ -0,0 +1,35 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "connectionMonitorName" : "cm1" + }, + "responses" : { + "200" : { + "body" : { + "name" : "cm1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Succeeded", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "startTime": "2018-01-08T03:42:33.3387305Z", + "monitoringStatus": "Running" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorList.json new file mode 100644 index 000000000000..a1624cdd6b57 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorList.json @@ -0,0 +1,60 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "cm1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Succeeded", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "startTime": "2018-01-08T03:42:33.3387305Z", + "monitoringStatus": "Running" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + }, + { + "name" : "cm2", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm2", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Succeeded", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm2", + "port": 0 + }, + "destination": { + "address": "google.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 30, + "autoStart": true, + "startTime": "2018-01-08T05:42:33.3387305Z", + "monitoringStatus": "Running" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorQuery.json new file mode 100644 index 000000000000..4d3db38b07c0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorQuery.json @@ -0,0 +1,77 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "connectionMonitorName" : "cm1" + }, + "responses" : { + "200" : { + "body" : { + "sourceStatus": "Active", + "states" : [ + { + "connectionState" : "Reachable", + "startTime" : "2018-01-08T03:42:33.3387305Z", + "endTime" : "2018-01-08T05:12:41.5265438Z", + "evaluationState" : "Completed", + "hops" : [ + { + "type" : "Source", + "id" : "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address" : "10.1.1.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds" : [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues" : [] + }, + { + "type" : "VirtualNetwork", + "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", + "address" : "192.168.100.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds" : [], + "issues" : [] + } + ] + } + ] + } + }, + "202" : { + "body" : { + "sourceStatus": "Active", + "states" : [ + { + "connectionState" : "Reachable", + "startTime" : "2018-01-08T03:42:33.3387305Z", + "endTime" : "2018-01-08T05:12:41.5265438Z", + "evaluationState" : "Completed", + "hops" : [ + { + "type" : "Source", + "id" : "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address" : "10.1.1.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds" : [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues" : [] + }, + { + "type" : "VirtualNetwork", + "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", + "address" : "192.168.100.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds" : [], + "issues" : [] + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorStart.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorStart.json new file mode 100644 index 000000000000..3c45c95ad806 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorStart.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "connectionMonitorName" : "cm1" + }, + "responses" : { + "200" : {}, + "202" : {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorStop.json new file mode 100644 index 000000000000..3c45c95ad806 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectionMonitorStop.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "connectionMonitorName" : "cm1" + }, + "responses" : { + "200" : {}, + "202" : {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectivityCheck.json new file mode 100644 index 000000000000..e494fa8653f2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectivityCheck.json @@ -0,0 +1,79 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "source" : { + "resourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "destination" : { + "address" : "192.168.100.4", + "port" : 3389 + } + } + }, + "responses" : { + "200" : { + "body" : { + "hops" : [ + { + "type" : "Source", + "id" : "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address" : "10.1.1.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds" : [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues" : [] + }, + { + "type" : "VirtualNetwork", + "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", + "address" : "192.168.100.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds" : [], + "issues" : [] + } + ], + "connectionStatus" : "Connected", + "avgLatencyInMs" : 1, + "minLatencyInMs" : 1, + "maxLatencyInMs" : 4, + "probesSent" : 100, + "probesFailed" : 0 + } + }, + "202" : { + "body" : { + "hops" : [ + { + "type" : "Source", + "id" : "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address" : "10.1.1.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds" : [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues" : [] + }, + { + "type" : "VirtualNetwor", + "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", + "address" : "192.168.100.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds" : [], + "issues" : [] + } + ], + "connectionStatus" : "Connected", + "avgLatencyInMs" : 1, + "minLatencyInMs" : 1, + "maxLatencyInMs" : 4, + "probesSent" : 100, + "probesFailed" : 0 + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherCreate.json new file mode 100644 index 000000000000..deca4e9a7f50 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherCreate.json @@ -0,0 +1,41 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "location" : "eastus", + "properties" : { + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "nw1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags" : {}, + "properties" : { + "provisioningState" : "Succeeded" + } + } + }, + "201" : { + "body" : { + "name" : "nw1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags" : {}, + "properties" : { + "provisioningState" : "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherDelete.json new file mode 100644 index 000000000000..5db75e973ce0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherDelete.json @@ -0,0 +1,12 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1" + }, + "responses" : { + "202" : {}, + "204" : {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherFlowLogConfigure.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherFlowLogConfigure.json new file mode 100644 index 000000000000..2a0035e63a99 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherFlowLogConfigure.json @@ -0,0 +1,35 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled" : true + } + } + }, + "responses" : { + "200" : { + "body" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled" : true + } + } + }, + "202" : { + "body" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled" : true + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherFlowLogStatusQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherFlowLogStatusQuery.json new file mode 100644 index 000000000000..7856538feebb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherFlowLogStatusQuery.json @@ -0,0 +1,31 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + } + }, + "responses" : { + "200" : { + "body" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled" : true + } + } + }, + "202" : { + "body" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled" : true + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherGet.json new file mode 100644 index 000000000000..ee2b0a9a73a3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherGet.json @@ -0,0 +1,23 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1" + }, + "responses" : { + "200" : { + "body" : { + "name" : "nw1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags" : {}, + "properties" : { + "provisioningState" : "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherIpFlowVerify.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherIpFlowVerify.json new file mode 100644 index 000000000000..2a565bad20a9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherIpFlowVerify.json @@ -0,0 +1,31 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "direction" : "Outbound", + "protocol" : "TCP", + "localPort" : "80", + "remotePort" : "80", + "localIPAddress" : "10.2.0.4", + "remoteIPAddress" : "121.10.1.1" + } + }, + "responses" : { + "200" : { + "body" : { + "access" : "Allow", + "ruleName" : "Rule1" + } + }, + "202" : { + "body" : { + "access" : "Allow", + "ruleName" : "Rule1" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherList.json new file mode 100644 index 000000000000..8e14bbd0a089 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherList.json @@ -0,0 +1,37 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "nw1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags" : {}, + "properties" : { + "provisioningState" : "Succeeded" + } + }, + { + "name" : "nw2", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags" : {}, + "properties" : { + "provisioningState" : "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherListAll.json new file mode 100644 index 000000000000..03e8b5e8fb99 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherListAll.json @@ -0,0 +1,36 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "nw1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags" : {}, + "properties" : { + "provisioningState" : "Succeeded" + } + }, + { + "name" : "nw2", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "westus", + "tags" : {}, + "properties" : { + "provisioningState" : "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherNextHopGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherNextHopGet.json new file mode 100644 index 000000000000..c6453304e8f9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherNextHopGet.json @@ -0,0 +1,30 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "sourceIPAddress" : "10.0.0.5", + "destinationIPAddress" : "10.0.0.10", + "targetNicResourceId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1" + } + }, + "responses" : { + "200" : { + "body" : { + "nextHopType" : "VnetLocal", + "nextHopIpAddress" : "10.0.0.1", + "routeTableId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/rt1" + } + }, + "202" : { + "body" : { + "nextHopType" : "VnetLocal", + "nextHopIpAddress" : "10.0.0.1", + "routeTableId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/rt1" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureCreate.json new file mode 100644 index 000000000000..5d6f4226650e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureCreate.json @@ -0,0 +1,56 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "packetCaptureName" : "pc1", + "parameters" : { + "properties" : { + "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, + "storageLocation" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath" : "D:\\capture\\pc1.cap" + }, + "filters" : [ + { + "protocol" : "TCP", + "localIPAddress" : "10.0.0.4", + "localPort" : "80" + } + ] + } + } + }, + "responses" : { + "201" : { + "body" : { + "name" : "pc1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "properties" : { + "provisioningState" : "Updating", + "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, + "storageLocation" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath" : "D:\\capture\\pc1.cap" + }, + "filters" : [ + { + "protocol" : "TCP", + "localIPAddress" : "10.0.0.4", + "localPort" : "80" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureDelete.json new file mode 100644 index 000000000000..91ff7458dfe9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "packetCaptureName" : "pc1" + }, + "responses" : { + "204" : {}, + "202" : {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureGet.json new file mode 100644 index 000000000000..275294221bd4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureGet.json @@ -0,0 +1,37 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "packetCaptureName" : "pc1" + }, + "responses" : { + "200" : { + "body" : { + "name" : "pc1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Updating", + "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, + "storageLocation" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath" : "D:\\capture\\pc1.cap" + }, + "filters" : [ + { + "protocol" : "TCP", + "localIPAddress" : "10.0.0.4", + "localPort" : "80" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureQueryStatus.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureQueryStatus.json new file mode 100644 index 000000000000..a7e85ac407d0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureQueryStatus.json @@ -0,0 +1,31 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "packetCaptureName" : "pc1" + }, + "responses" : { + "200" : { + "body" : { + "name" : "pc1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "captureStartTime" : "2016-09-07T12:35:24Z", + "packetCaptureStatus" : "Stopped", + "stopReason" : "TimeExceeded", + "packetCaptureError" : [] + } + }, + "202" : { + "body" : { + "name" : "pc1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "captureStartTime" : "2016-09-07T12:35:24Z", + "packetCaptureStatus" : "Stopped", + "stopReason" : "TimeExceeded", + "packetCaptureError" : [] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureStop.json new file mode 100644 index 000000000000..8c322f419e81 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCaptureStop.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "packetCaptureName" : "pc1" + }, + "responses" : { + "200" : {}, + "202" : {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCapturesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCapturesList.json new file mode 100644 index 000000000000..b7c7e06aced2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherPacketCapturesList.json @@ -0,0 +1,58 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "pc1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Updating", + "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, + "storageLocation" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath" : "D:\\capture\\pc1.cap" + }, + "filters" : [ + { + "protocol" : "TCP", + "localIPAddress" : "10.0.0.4", + "localPort" : "80" + } + ] + } + }, + { + "name" : "pc2", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc2", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Succeeded", + "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, + "storageLocation" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc2.cap", + "filePath" : "D:\\capture\\pc2.cap" + }, + "filters" : [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherSecurityGroupViewGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherSecurityGroupViewGet.json new file mode 100644 index 000000000000..02970e9ba634 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherSecurityGroupViewGet.json @@ -0,0 +1,141 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "responses" : { + "200" : { + "body" : { + "networkInterfaces" : [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1", + "securityRuleAssociations" : { + "subnetAssociation" : { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "securityRules" : [ + { + "name" : "fe_rule", + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/AppNSG/securityRules/fe_rule", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Succeeded", + "description" : "Allow Frontend", + "protocol" : "Tcp", + "sourcePortRange" : "*", + "destinationPortRange" : "*", + "sourceAddressPrefix" : "10.1.0.0/24", + "destinationAddressPrefix" : "*", + "access" : "Allow", + "priority" : 100, + "direction" : "Inbound" + } + } + ] + }, + "defaultSecurityRules" : [ + { + "name" : "AllowVnetInBound", + "id" : "/subscriptions//resourceGroups//providers/Microsoft.Network/networkSecurityGroups//defaultSecurityRules/", + "properties" : { + "provisioningState" : "Succeeded", + "description" : "Allow inbound traffic from all VMs in VNET", + "protocol" : "*", + "sourcePortRange" : "*", + "destinationPortRange" : "*", + "sourceAddressPrefix" : "VirtualNetwork", + "destinationAddressPrefix" : "VirtualNetwork", + "access" : "Allow", + "priority" : 65000, + "direction" : "Inbound" + } + } + ], + "effectiveSecurityRules" : [ + { + "name" : "DefaultOutboundDenyAll", + "protocol" : "All", + "sourcePortRange" : "0-65535", + "destinationPortRange" : "0-65535", + "sourceAddressPrefix" : "*", + "destinationAddressPrefix" : "*", + "access" : "Deny", + "priority" : 65500, + "direction" : "Outbound" + } + ] + } + } + ] + } + }, + "202" : { + "body" : { + "networkInterfaces": [ + { + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1", + "securityRuleAssociations" : { + "subnetAssociation" : { + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "securityRules" : [ + { + "name" : "fe_rule", + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/AppNSG/securityRules/fe_rule", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Succeeded", + "description" : "Allow Frontend", + "protocol" : "Tcp", + "sourcePortRange" : "*", + "destinationPortRange" : "*", + "sourceAddressPrefix" : "10.1.0.0/24", + "destinationAddressPrefix" : "*", + "access" : "Allow", + "priority" : 100, + "direction" : "Inbound" + } + } + ] + }, + "defaultSecurityRules" : [ + { + "name" : "AllowVnetInBound", + "id" : "/subscriptions//resourceGroups//providers/Microsoft.Network/networkSecurityGroups//defaultSecurityRules/", + "properties" : { + "provisioningState" : "Succeeded", + "description" : "Allow inbound traffic from all VMs in VNET", + "protocol" : "*", + "sourcePortRange" : "*", + "destinationPortRange" : "*", + "sourceAddressPrefix" : "VirtualNetwork", + "destinationAddressPrefix" : "VirtualNetwork", + "access" : "Allow", + "priority" : 65000, + "direction" : "Inbound" + } + } + ], + "effectiveSecurityRules" : [ + { + "name" : "DefaultOutboundDenyAll", + "protocol" : "All", + "sourcePortRange" : "0-65535", + "destinationPortRange" : "0-65535", + "sourceAddressPrefix" : "*", + "destinationAddressPrefix" : "*", + "access" : "Deny", + "priority" : 65500, + "direction" : "Outbound" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherTopologyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherTopologyGet.json new file mode 100644 index 000000000000..9faa611f1bba --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherTopologyGet.json @@ -0,0 +1,39 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceGroupName": "rg2" + } + }, + "responses" : { + "200" : { + "body" : { + "id" : "ce592f46-8164-4bf2-ad36-b8e4acf6fb68", + "createdDateTime" : "2017-08-02T19:31:55.9461781Z", + "lastModified" : "2017-05-27T00:00:13.2005337Z", + "resources" : [ + { + "name" : "MultiTierApp0", + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/MultiTierApp0", + "location" : "westus", + "associations" : [ + { + "name" : "appNic0", + "resourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/appNic0", + "associationType" : "Contains" + }, + { + "name" : "appNic10", + "resourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/appNic10", + "associationType" : "Contains" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherTroubleshootGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherTroubleshootGet.json new file mode 100644 index 000000000000..177ce66eba7f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherTroubleshootGet.json @@ -0,0 +1,71 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "properties" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "storagePath" : "https://st1.blob.core.windows.net/cn1" + } + } + }, + "responses" : { + "200" : { + "body" : { + "startTime" : "2017-01-12T00:19:47.0442834Z", + "endTime" : "2017-01-12T00:20:09.914Z", + "code" : "UnHealthy", + "results" : [ + { + "id": "000000", + "reasonType" : "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + }, + "202" : { + "body" : { + "startTime" : "2017-01-12T00:19:47.0442834Z", + "endTime" : "2017-01-12T00:20:09.914Z", + "code" : "UnHealthy", + "results" : [ + { + "id": "000000", + "reasonType" : "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherTroubleshootResultQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherTroubleshootResultQuery.json new file mode 100644 index 000000000000..6290cbab5390 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherTroubleshootResultQuery.json @@ -0,0 +1,67 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "responses" : { + "200" : { + "body" : { + "startTime" : "2017-01-12T00:19:47.0442834Z", + "endTime" : "2017-01-12T00:20:09.914Z", + "code" : "UnHealthy", + "results" : [ + { + "id": "000000", + "reasonType" : "VipUnResponsive", + "summary" : "We are sorry, your VPN gateway is unreachable from the Internet", + "detail" : "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions" : [ + { + "actionText" : "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri" : "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText" : "Verify" + }, + { + "actionText" : "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri" : "http://azure.microsoft.com/support", + "actionUriText" : "contact support" + } + ] + } + ] + } + }, + "202" : { + "body" : { + "startTime" : "2017-01-12T00:19:47.0442834Z", + "endTime" : "2017-01-12T00:20:09.914Z", + "code" : "UnHealthy", + "results" : [ + { + "id" : "000000", + "reasonType" : "VipUnResponsive", + "summary" : "We are sorry, your VPN gateway is unreachable from the Internet", + "detail" : "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions" : [ + { + "actionText" : "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri" : "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText" : "Verify" + }, + { + "actionText" : "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri" : "http://azure.microsoft.com/support", + "actionUriText" : "contact support" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherUpdateTags.json new file mode 100644 index 000000000000..2846eb7f9fb7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "nw1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "provisioningState" : "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/OperationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/OperationList.json new file mode 100644 index 000000000000..105b250ee250 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/OperationList.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Network/localnetworkgateways/read", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Get LocalNetworkGateway", + "description": "Gets LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/localnetworkgateways/write", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Create or update LocalNetworkGateway", + "description": "Creates or updates an existing LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/localnetworkgateways/delete", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Delete LocalNetworkGateway", + "description": "Deletes LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/networkInterfaces/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Network", + "resource": "Network Interface metric definition", + "operation": "Read Network Interface metric definitions", + "description": "Gets available metrics for the Network Interface" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "BytesSentRate", + "displayName": "Bytes Sent", + "displayDescription": "Number of bytes the Network Interface sent", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "00:01:00", + "retention": "00:00:00", + "blobDuration": "01:00:00" + }, + { + "timeGrain": "01:00:00", + "retention": "00:00:00", + "blobDuration": "1.00:00:00" + } + ], + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^__Ready__$", + "fillGapWithZero": false, + "dimensions": [], + "isInternal": false + }, + { + "name": "BytesReceivedRate", + "displayName": "Bytes Received", + "displayDescription": "Number of bytes the Network Interface received", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "00:01:00", + "retention": "00:00:00", + "blobDuration": "01:00:00" + }, + { + "timeGrain": "01:00:00", + "retention": "00:00:00", + "blobDuration": "1.00:00:00" + } + ], + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^__Ready__$", + "fillGapWithZero": false, + "dimensions": [], + "isInternal": false + } + ] + } + } + }, + { + "name": "Microsoft.Network/networksecuritygroups/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Network", + "resource": "Network Security Groups Log Definitions", + "operation": "Get Network Security Group Event Log Definitions", + "description": "Gets the events for network security group" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "NetworkSecurityGroupEvent", + "displayName": "Network Security Group Event", + "blobDuration": "PT1H" + }, + { + "name": "NetworkSecurityGroupRuleCounter", + "displayName": "Network Security Group Rule Counter", + "blobDuration": "PT1H" + }, + { + "name": "NetworkSecurityGroupFlowEvent", + "displayName": "Network Security Group Rule Flow Event", + "blobDuration": "PT1H" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressCreateCustomizedValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressCreateCustomizedValues.json new file mode 100644 index 000000000000..cd9a0c1f9494 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressCreateCustomizedValues.json @@ -0,0 +1,63 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "zones": [ "1" ], + "parameters": { + "properties": { + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "publicIPAddressVersion": "IPv4" + }, + "sku": { + "name": "Standard" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "zones": [ "1" ], + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Static", + "idleTimeoutInMinutes" : 10, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Standard" + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + }, + "201" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "zones": [ "1" ], + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Static", + "idleTimeoutInMinutes" : 10, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Standard" + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressCreateDefaults.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressCreateDefaults.json new file mode 100644 index 000000000000..8acb1aaebca4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressCreateDefaults.json @@ -0,0 +1,51 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": {} + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Basic" + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + }, + "201" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Basic" + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressCreateDns.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressCreateDns.json new file mode 100644 index 000000000000..07fac0d9d280 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressCreateDns.json @@ -0,0 +1,59 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "properties": { + "dnsSettings": { + "domainNameLabel": "dnslbl" + } + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "dnsSettings" : { + "domainNameLabel" : "dnslbl", + "fqdn" : "dnslbl.westus.cloudapp.azure.com" + }, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + }, + "201" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "dnsSettings" : { + "domainNameLabel" : "dnslbl", + "fqdn" : "dnslbl.westus.cloudapp.azure.com" + }, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressDelete.json new file mode 100644 index 000000000000..9223deeeb0a1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressGet.json new file mode 100644 index 000000000000..f5061b98ea0f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressGet.json @@ -0,0 +1,37 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "testDNS-ip" + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ipTags" : [ + { + "ipTagType" : "FirstPartyUsage", + "tag" : "SQL" + }, + { + "ipTagType" : "FirstPartyUsage", + "tag" : "Storage" + } + ] + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressList.json new file mode 100644 index 000000000000..edbb9b8e6899 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressList.json @@ -0,0 +1,60 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ipTags" : [ + { + "ipTagType" : "FirstPartyUsage", + "tag" : "SQL" + }, + { + "ipTagType" : "FirstPartyUsage", + "tag" : "Storage" + } + ] + }, + "type" : "Microsoft.Network/publicIPAddresses" + }, + { + "name" : "ip03", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/ip03", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "ipAddress" : "40.85.154.247", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "dnsSettings" : { + "domainNameLabel" : "testlbl", + "fqdn" : "testlbl.westus.cloudapp.azure.com" + }, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressListAll.json new file mode 100644 index 000000000000..db24c0ba1b6b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressListAll.json @@ -0,0 +1,49 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + }, + { + "name" : "ip01", + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/ip01", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "ipAddress" : "40.85.154.247", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "dnsSettings" : { + "domainNameLabel" : "testlbl", + "fqdn" : "testlbl.westus.cloudapp.azure.com" + }, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressUpdateTags.json new file mode 100644 index 000000000000..f2f11aabee83 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/PublicIpAddressUpdateTags.json @@ -0,0 +1,37 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Static", + "idleTimeoutInMinutes" : 10, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterCreate.json new file mode 100644 index 000000000000..e198ad36304c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterCreate.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "routeFilterParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "rules": [ + { + "name": "ruleName", + "properties": { + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [ ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsofot.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [ ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsofot.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [ ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterDelete.json new file mode 100644 index 000000000000..c368f9277ac5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterGet.json new file mode 100644 index 000000000000..c9895845fe08 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsofot.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterList.json new file mode 100644 index 000000000000..feb0d638bb7e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsofot.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterListByResourceGroup.json new file mode 100644 index 000000000000..f2ef40db0858 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterListByResourceGroup.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsofot.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleCreate.json new file mode 100644 index 000000000000..4c55b39259d7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleCreate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "ruleName": "ruleName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "routeFilterRuleParameters": { + "properties": { + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleDelete.json new file mode 100644 index 000000000000..bb50b1a314e4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "ruleName": "ruleName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleGet.json new file mode 100644 index 000000000000..a26e66404ade --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "ruleName": "filterName", + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleListByRouteFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleListByRouteFilter.json new file mode 100644 index 000000000000..d8d532974930 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleListByRouteFilter.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "routeFilterName": "filterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleUpdate.json new file mode 100644 index 000000000000..2add49457c70 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterRuleUpdate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "ruleName": "ruleName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "routeFilterRuleParameters": { + "properties": { + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterUpdate.json new file mode 100644 index 000000000000..f5d87626a5be --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteFilterUpdate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "routeFilterParameters": { + "tags": { + "key1": "value1" + }, + "properties": { + "rules": [ + { + "name": "ruleName", + "properties": { + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030" + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsofot.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030" + ] + } + } + ], + "peerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableCreate.json new file mode 100644 index 000000000000..93ff693354d0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableCreate.json @@ -0,0 +1,37 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "parameters": {} + }, + "responses" : { + "200" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ ], + "disableBgpRoutePropagation": true + } + } + }, + "201" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [ ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableCreateWithRoute.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableCreateWithRoute.json new file mode 100644 index 000000000000..ca121dfcb3a5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableCreateWithRoute.json @@ -0,0 +1,69 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "parameters": { + "properties": { + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "properties": { + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + }, + "201" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableDelete.json new file mode 100644 index 000000000000..84fdbab7af61 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableGet.json new file mode 100644 index 000000000000..7e6e7e60da0b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableGet.json @@ -0,0 +1,33 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt" + }, + "responses" : { + "200" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": false, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableList.json new file mode 100644 index 000000000000..b678eef7f39c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableList.json @@ -0,0 +1,47 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + }, + { + "name": "testrt2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt2", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "disableBgpRoutePropagation": true, + "provisioningState": "Succeeded", + "routes": [ ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableListAll.json new file mode 100644 index 000000000000..ae3575eb034f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableListAll.json @@ -0,0 +1,44 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + }, + { + "name": "testrt3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/testrt3", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableRouteCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableRouteCreate.json new file mode 100644 index 000000000000..0a8479680e29 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableRouteCreate.json @@ -0,0 +1,39 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "routeName": "route1", + "routeParameters": { + "properties": { + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + }, + "201" : { + "body" : { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableRouteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableRouteDelete.json new file mode 100644 index 000000000000..51729e03218b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableRouteDelete.json @@ -0,0 +1,14 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "routeName": "route1" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableRouteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableRouteGet.json new file mode 100644 index 000000000000..668f10bbb869 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableRouteGet.json @@ -0,0 +1,22 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "routeName": "route1" + }, + "responses" : { + "200" : { + "body" : { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "Internet" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableRouteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableRouteList.json new file mode 100644 index 000000000000..4e4380abc83e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableRouteList.json @@ -0,0 +1,34 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "Internet" + } + }, + { + "name": "route2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route2", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.2.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableUpdateTags.json new file mode 100644 index 000000000000..313c6b9a2a8b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/RouteTableUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "routes": [ ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ServiceCommunityList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ServiceCommunityList.json new file mode 100644 index 000000000000..aff02ba682cf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/ServiceCommunityList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsofot.Network/bgpServiceCommunities/skype", + "name": "skype", + "type": "Microsofot.Network/bgpServiceCommunities", + "properties": { + "serviceName" : "skype", + "bgpCommunities": [ + { + "serviceSupportedRegion": "Global", + "communityName": "Skype For Business Online", + "communityValue": "12076:5030", + "communityPrefixes": [ + "13.67.56.225/32", + "13.67.186.105/32" + ], + "isAuthorizedToUse": true, + "serviceGroup" : "O365" + } + ] + } + }, + { + "id": "/subscriptions/subid/providers/Microsofot.Network/bgpServiceCommunities/exchange", + "name": "exchange", + "type": "Microsofot.Network/bgpServiceCommunities", + "properties": { + "serviceName" : "exchange", + "bgpCommunities": [ + { + "serviceSupportedRegion": "Global", + "communityName": "Exchange Online", + "communityValue": "12076:5040", + "communityPrefixes": [ + "13.67.56.225/32", + "13.67.186.105/32" + ], + "isAuthorizedToUse": true, + "serviceGroup" : "O365" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetCreate.json new file mode 100644 index 000000000000..433f924e127d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetCreate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetCreateServiceEndpoint.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetCreateServiceEndpoint.json new file mode 100644 index 000000000000..590a1be58718 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetCreateServiceEndpoint.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { "service": "Microsoft.Storage" } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [{ + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + }], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [{ + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + }], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetDelete.json new file mode 100644 index 000000000000..61a9b316701b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetGet.json new file mode 100644 index 000000000000..70c51c9ef91f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetList.json new file mode 100644 index 000000000000..15e5688f35c7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/SubnetList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet2", + "name": "subnet2", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/UsageList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/UsageList.json new file mode 100644 index 000000000000..081d6650b0f2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/UsageList.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 8.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/VirtualNetworks", + "limit": 50.0, + "name": { + "localizedValue": "Virtual Networks", + "value": "VirtualNetworks" + }, + "unit": "Count" + }, + { + "currentValue": 3.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/StaticPublicIPAddresses", + "limit": 20.0, + "name": { + "localizedValue": "Static Public IP Addresses", + "value": "StaticPublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkSecurityGroups", + "limit": 100.0, + "name": { + "localizedValue": "Network Security Groups", + "value": "NetworkSecurityGroups" + }, + "unit": "Count" + }, + { + "currentValue": 8.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PublicIPAddresses", + "limit": 60.0, + "name": { + "localizedValue": "Public IP Addresses", + "value": "PublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkInterfaces", + "limit": 350.0, + "name": { + "localizedValue": "Network Interfaces", + "value": "NetworkInterfaces" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/LoadBalancers", + "limit": 100.0, + "name": { + "localizedValue": "Load Balancers", + "value": "LoadBalancers" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/ApplicationGateways", + "limit": 50.0, + "name": { + "localizedValue": "Application Gateways", + "value": "ApplicationGateways" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteTables", + "limit": 100.0, + "name": { + "localizedValue": "Route Tables", + "value": "RouteTables" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilters", + "limit": 1000.0, + "name": { + "localizedValue": "Route Filters", + "value": "RouteFilters" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkWatchers", + "limit": 1.0, + "name": { + "localizedValue": "Network Watchers", + "value": "NetworkWatchers" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PacketCaptures", + "limit": 10.0, + "name": { + "localizedValue": "Packet Captures", + "value": "PacketCaptures" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/DnsServersPerVirtualNetwork", + "limit": 9.0, + "name": { + "localizedValue": "DNS servers per Virtual Network", + "value": "DnsServersPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SubnetsPerVirtualNetwork", + "limit": 1000.0, + "name": { + "localizedValue": "Subnets per Virtual Network", + "value": "SubnetsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/IPConfigurationsPerVirtualNetwork", + "limit": 4096.0, + "name": { + "localizedValue": "IP Configurations per Virtual Network", + "value": "IPConfigurationsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PeeringsPerVirtualNetwork", + "limit": 10.0, + "name": { + "localizedValue": "Peerings per Virtual Network", + "value": "PeeringsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRulesPerNetworkSecurityGroup", + "limit": 200.0, + "name": { + "localizedValue": "Security rules per Network Security Group", + "value": "SecurityRulesPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRuleAddressesOrPortsPerNetworkSecurityGroup", + "limit": 2000.0, + "name": { + "localizedValue": "Security rules addresses or ports per Network Security Group", + "value": "SecurityRuleAddressesOrPortsPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerLoadBalancer", + "limit": 150.0, + "name": { + "localizedValue": "Inbound Rules per Load Balancer", + "value": "InboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/FrontendIPConfigurationPerLoadBalancer", + "limit": 10.0, + "name": { + "localizedValue": "Frontend IP Configurations per Load Balancer", + "value": "FrontendIPConfigurationPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/OutboundNatRulesPerLoadBalancer", + "limit": 5.0, + "name": { + "localizedValue": "Outbound NAT Rules per Load Balancer", + "value": "OutboundNatRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RoutesPerRouteTable", + "limit": 100.0, + "name": { + "localizedValue": "Routes per Route Table", + "value": "RoutesPerRouteTable" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecondaryIPConfigurationsPerNetworkInterface", + "limit": 256.0, + "name": { + "localizedValue": "Secondary IP Configurations per Network Interface", + "value": "SecondaryIPConfigurationsPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerNetworkInterface", + "limit": 500.0, + "name": { + "localizedValue": "Inbound rules per Network Interface", + "value": "InboundRulesPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilterRulesPerRouteFilter", + "limit": 1.0, + "name": { + "localizedValue": "Route filter rules per Route Filter", + "value": "RouteFilterRulesPerRouteFilter" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFiltersPerExpressRouteBgpPeering", + "limit": 1.0, + "name": { + "localizedValue": "Route filters per Express route BGP Peering", + "value": "RouteFiltersPerExpressRouteBgpPeering" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubDelete.json new file mode 100644 index 000000000000..c73a8f76538e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubGet.json new file mode 100644 index 000000000000..7ea04dfaa35f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "hubVirtualNetworkConnections": [ ], + "addressPrefix": "10.10.1.0/24" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubList.json new file mode 100644 index 000000000000..19404ea8c6a4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubList.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "hubVirtualNetworkConnections": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualNetworks/SpokeVnet1" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + ], + "addressPrefix": "10.10.1.0/24" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "hubVirtualNetworkConnections": [ + { + "name": "connection2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsofot.Network/virtualHubs/virtualHub2/hubVirtualNetworkConnections/connection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsofot.Network/virtualNetworks/SpokeVnet2" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + ], + "addressPrefix": "210.10.1.0/24" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubListByResourceGroup.json new file mode 100644 index 000000000000..4ba8c4380ff2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubListByResourceGroup.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "hubVirtualNetworkConnections": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualNetworks/SpokeVnet1" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + ], + "addressPrefix": "10.10.1.0/24" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "hubVirtualNetworkConnections": [ + { + "name": "connection2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub2/hubVirtualNetworkConnections/connection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsofot.Network/virtualNetworks/SpokeVnet2" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + ], + "addressPrefix": "210.10.1.0/24" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubPut.json new file mode 100644 index 000000000000..ef16ae8c7a59 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubPut.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "virtualHubName": "virtualHub2", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "virtualHubParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "addressPrefix": "10.168.0.0/24" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "hubVirtualNetworkConnections": [ ], + "addressPrefix": "10.168.0.0/24" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "hubVirtualNetworkConnections": [ ], + "addressPrefix": "10.168.0.0/24" + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubUpdateTags.json new file mode 100644 index 000000000000..2a1eb64d295d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualHubUpdateTags.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "virtualHubName": "virtualHub2", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "virtualHubParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "hubVirtualNetworkConnections": [ ], + "addressPrefix": "10.168.0.0/24" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "hubVirtualNetworkConnections": [ ], + "addressPrefix": "10.168.0.0/24" + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkCheckIPAddressAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkCheckIPAddressAvailability.json new file mode 100644 index 000000000000..cfd0fcd3b5d8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkCheckIPAddressAvailability.json @@ -0,0 +1,23 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "IPAddress": "10.0.1.4" + }, + "responses" : { + "200" : { + "body" : { + "available": false, + "availableIPAddresses": [ + "10.0.1.5", + "10.0.1.6", + "10.0.1.7", + "10.0.1.8", + "10.0.1.9" + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkCreate.json new file mode 100644 index 000000000000..69da1d5b6e87 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkCreate.json @@ -0,0 +1,56 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "location": "westus", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + } + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets" : [], + "virtualNetworkPeerings" : [] + } + } + }, + "201" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets" : [], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkCreateServiceEndpoints.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkCreateServiceEndpoints.json new file mode 100644 index 000000000000..c3db16f6c536 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkCreateServiceEndpoints.json @@ -0,0 +1,110 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "vnetTest", + "virtualNetworkName" : "vnet1", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage" + } + ] + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "vnet1", + "id" : "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + }, + "201" : { + "body" : { + "name" : "vnet1", + "id" : "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkCreateSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkCreateSubnet.json new file mode 100644 index 000000000000..f415a3a1e907 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkCreateSubnet.json @@ -0,0 +1,81 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24" + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + }, + "201" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkDelete.json new file mode 100644 index 000000000000..99fdccef587b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionCreate.json new file mode 100644 index 000000000000..0a0288a1af78 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionCreate.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName" : "connS2S", + "parameters": { + "properties": { + "virtualNetworkGateway1": { + "properties": { + "ipConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + } + }, + "name": "gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1" + } + ], + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "resourceGuid": "00000000-0000-0000-0000-000000000000" + }, + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "location": "centralus", + "tags": {} + }, + "localNetworkGateway2": { + "properties": { + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + }, + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "location": "centralus", + "tags": {} + }, + "connectionType": "IPsec", + "routingWeight": 0, + "sharedKey": "Abc123", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [] + }, + "location": "centralus" + } + }, + "responses" : { + "201" : { + "body" : { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "connectionType": "IPsec", + "routingWeight": 0, + "sharedKey": "Abc123", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + }, + "200" : { + "body" : { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "connectionType": "IPsec", + "routingWeight": 0, + "sharedKey": "Abc123", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionDelete.json new file mode 100644 index 000000000000..dbef03bc1bc0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName" : "conn1" + }, + "responses" : { + "202" : { }, + "200" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionGet.json new file mode 100644 index 000000000000..ce44ad6950b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName" : "connS2S" + }, + "responses" : { + "200" : { + "body" : { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "connectionType": "IPsec", + "routingWeight": 0, + "sharedKey": "Abc123", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "connectionStatus": "Connecting", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json new file mode 100644 index 000000000000..d19940007040 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName" : "connS2S" + }, + "responses" : { + "200" : { + "body" : { + "value": "AzureAbc123" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json new file mode 100644 index 000000000000..3626f7c949eb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName" : "conn1", + "parameters": { + "keyLength": 128 + } + }, + "responses" : { + "200" : { + "body" : { + "keyLength": 128 + } + }, + "202" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json new file mode 100644 index 000000000000..da036e9b9da3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName" : "connS2S", + "parameters": { + "value": "AzureAbc123" + } + }, + "responses" : { + "200" : { + "body" : { + "value": "AzureAbc123" + } + }, + "201" : { + "body" : { + "value": "AzureAbc123" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json new file mode 100644 index 000000000000..bb2db0931fbd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json @@ -0,0 +1,47 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkGatewayConnectionName": "test", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/test", + "type": "Microsoft.Network/connections", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw" + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw" + }, + "connectionType": "IPsec", + "routingWeight": 0, + "sharedKey": "temp1234", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "connectionStatus": "Unknown", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionsList.json new file mode 100644 index 000000000000..f4fe1401e2d1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayConnectionsList.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/conn1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw1", + "properties": {} + }, + "connectionType": "IPsec", + "routingWeight": 0, + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + }, + { + "name": "conn2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/conn2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2", + "properties": {} + }, + "localNetworkGateway2": { + "properties": {}, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw2" + }, + "connectionType": "IPsec", + "routingWeight": 0, + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayDelete.json new file mode 100644 index 000000000000..606d75f6b772 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "202" : { }, + "200" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json new file mode 100644 index 000000000000..028f589a8a9c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw", + "parameters": { + } + }, + "responses" : { + "200" : { + "body" : "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json new file mode 100644 index 000000000000..aa1593ce9865 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw", + "parameters": {} + }, + "responses" : { + "202" : { + }, + "200" : { + "body" : "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGet.json new file mode 100644 index 000000000000..69aaf1d319c0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGet.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "200" : { + "body" : { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json new file mode 100644 index 000000000000..decbe8ddd879 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw", + "peer": "test" + }, + "responses" : { + "202" : { }, + "200" : { + "body" : { + + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json new file mode 100644 index 000000000000..27c7416aec32 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "202" : { }, + "200" : { + "body" : { + + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json new file mode 100644 index 000000000000..eeef10d50bf1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "200" : { + "saLifeTimeSeconds": 86473, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup2", + "pfsGroup": "PFS2" + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json new file mode 100644 index 000000000000..84518d8cf6d1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "202" : { }, + "200" : { + "body" : "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayLearnedRoutes.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayLearnedRoutes.json new file mode 100644 index 000000000000..1aca9bbfc638 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayLearnedRoutes.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "202" : {}, + "200" : { + "body" : { + + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayList.json new file mode 100644 index 000000000000..269fff556bb3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayList.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "vpngw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "loc1", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/vpngw1-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.0.14", + "peerWeight": 0 + } + } + }, + { + "name": "vpngw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "loc2", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/vpngw2-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.1.0.46", + "peerWeight": 0 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayReset.json new file mode 100644 index 000000000000..7ed85b334236 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayReset.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "202" : { }, + "200" : { + "body" : { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json new file mode 100644 index 000000000000..81c78799aaf5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw", + "vpnclientIpsecParams": { + "saLifeTimeSeconds": 86473, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup2", + "pfsGroup": "PFS2" + } + }, + "responses" : { + "202" : { + }, + "200" : { + "body" : "" + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json new file mode 100644 index 000000000000..9106efb056a4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "200" : { + "body" : "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayUpdate.json new file mode 100644 index 000000000000..b0c24307cc7b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayUpdate.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw", + "parameters": { + "properties": { + "ipConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + } + }, + "name": "gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1" + } + ], + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "resourceGuid": "00000000-0000-0000-0000-000000000000" + }, + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "location": "centralus" + } + }, + "responses" : { + "200" : { + "body" : { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "SSTP", + "IkeV2" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + } + }, + "201" : { + "body" : { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "SSTP", + "IkeV2" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayUpdateTags.json new file mode 100644 index 000000000000..ffc897d6bc08 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayUpdateTags.json @@ -0,0 +1,62 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkGatewayName" : "vpngw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testpub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.0.254", + "peerWeight": 0 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json new file mode 100644 index 000000000000..2d38a89b39c5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName" : "vpngw", + "parameters": { + "vendor": "Cisco", + "deviceFamily": "ISR", + "firmwareVersion": "IOS 15.1 (Preview)" + } + }, + "responses" : { + "200" : { + "body" : "! Microsoft Corporation\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Sample VPN tunnel configuration template for IOS-based devices\r\n!\r\n! This configuration template applies to Cisco VPN devices running IOS 15.1 or beyond (ISR or ASR)\r\n!\r\n\r\n\r\n\t\t\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! ACL rules\r\n!\r\n! Some VPN devices require explicit ACL rules to allow cross-premises traffic:\r\n!\r\n! 1. Allow traffic between on premises address ranges and VNet address ranges\r\n! 2. Allow IKE traffic (UDP:500) between on premises VPN devices and Azure VPN gateway\r\n! 3. Allow IPsec traffic (Proto:ESP) between on premises VPN devices and Azure VPN gateway\r\n!\r\n\t\t\r\naccess-list 101 permit ip 10.1.0.0 0.0.255.255 10.0.0.0 0.0.255.255\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Internet Key Exchange (IKE) configuration\r\n!\r\n! This section specifies the authentication, encryption, hashing, and Diffie-Hellman group parameters for IKE\r\n! main mode or phase 1\r\n!\r\n\r\ncrypto ikev2 proposal SwaggerS2S-proposal\r\n encryption DES3\r\n integrity SHA384\r\n group DHGroup24\r\n lifetime 3600\r\n exit\r\n\r\ncrypto ikev2 policy SwaggerS2S-policy\r\n proposal SwaggerS2S-proposal\r\n exit\r\n\r\ncrypto ikev2 keyring SwaggerBranch-keyring\r\n\t\t\r\n\t\tpeer 52.173.199.254\r\n\t\taddress 52.173.199.254\r\n\t\tpre-shared-key lALEHuppeopJmA94exRNiRr2QzuZ6lOsvzu5IlJUEA6LthbTc8g5MTT86MCsGNMzGkTAaLuLnEJoD1Cn4cIlr94qKZm9drsgllzWvsPNezS71stAkaW1Bb7h6GBnDlDP\r\n exit\r\n\r\ncrypto ikev2 profile SwaggerS2S-profile\r\n match address local 10.3.0.0\r\n\tmatch identity remote address 52.173.199.254 255.255.255.255\r\n\t\t\r\n authentication remote pre-share\r\n authentication local pre-share\r\n keyring SwaggerBranch-keyring\r\n exit\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! IPsec configuration\r\n!\r\n! This section specifies encryption, authentication, tunnel mode properties for the Phase 2 negotiation\r\n!\r\ncrypto ipsec transform-set SwaggerS2S-TransformSet DES3 DES3\r\n mode tunnel\r\n exit\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Crypto map configuration\r\n!\r\n! This section defines a crypto profile that binds the cross-premises network traffic to the IPsec and IKE\r\n! policy profiles for this connection. Then defines the VTI (virtual tunnel interface) with the crypto\r\n! profile. A random interface number (tunnel 1) was used with a random link local address (169.254.0.1/28)\r\n! for the tunnel interface. If either selection is already used in the VPN device, please select another\r\n! interface number or address. The only requirement is that they must not overlap with another interface\r\n! on the same VPN device.\r\n!\r\ncrypto ipsec profile SwaggerS2S-IPsecProfile\r\n set transform-set SwaggerS2S-TransformSet\r\n set ikev2-profile SwaggerS2S-profile\r\n set pfs None\r\n set security-association lifetime 3600\r\n exit\r\n\r\n\r\nint tunnel 52.173.199.254\r\n ip address 169.254.0.1 255.255.255.252\r\n ip tcp adjust-mss 1350\r\n tunnel source 10.3.0.0\r\n tunnel mode ipsec ipv4\r\n tunnel destination 52.173.199.254\r\n tunnel protection ipsec profile SwaggerS2S-IPsecProfile\r\n exit\r\n\r\n\tip route 10.0.0.0 255.255.0.0 tunnel 52.173.199.254 " + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewaysListConnections.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewaysListConnections.json new file mode 100644 index 000000000000..3a144fcf9901 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGatewaysListConnections.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "virtualNetworkGatewayName": "test-vpn-gateway-1", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vpn-connection", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/connections/test-vpn-connection", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "type": "Microsoft.Network/connections", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-1" + }, + "virtualNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/testrg-2/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-2" + }, + "connectionType": "Vnet2Vnet", + "routingWeight": 22, + "enableBgp": true, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGet.json new file mode 100644 index 000000000000..1ef53a1229a9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkGet.json @@ -0,0 +1,41 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet" + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets" : [{ + "name" : "subnet1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "properties" : { + "provisioningState" : "Succeeded", + + "addressPrefix" : "10.0.1.0/24", + "ipConfigurations" : [{ + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" + } + ] + } + } + ], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkList.json new file mode 100644 index 000000000000..5fd4e997175a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkList.json @@ -0,0 +1,64 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1", + "name": "vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/8" + ] + }, + "dhcpOptions": { + "dnsServers": [] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2", + "name": "vnet2", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "dhcpOptions": { + "dnsServers": [ + "8.8.8.8" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkListAll.json new file mode 100644 index 000000000000..a935ec49dfcc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkListAll.json @@ -0,0 +1,63 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1", + "name": "vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/8" + ] + }, + "dhcpOptions": { + "dnsServers": [] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2", + "name": "vnet2", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "dhcpOptions": { + "dnsServers": [ + "8.8.8.8" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkListUsage.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkListUsage.json new file mode 100644 index 000000000000..3787bed904fa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkListUsage.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "virtualNetworkName": "vnetName", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": -1.0, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetName/subnets/GatewaySubnet", + "limit": -1.0, + "name": { + "localizedValue": "Subnet size and usage", + "value": "SubnetSpace" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetName/subnets/newSubnet", + "limit": 3.0, + "name": { + "localizedValue": "Subnet size and usage", + "value": "SubnetSpace" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkPeeringCreate.json new file mode 100644 index 000000000000..f15cb9001f07 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkPeeringCreate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkPeeringDelete.json new file mode 100644 index 000000000000..d462f95e65e8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkPeeringDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkPeeringGet.json new file mode 100644 index 000000000000..4ebe78e2a823 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkPeeringGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkPeeringList.json new file mode 100644 index 000000000000..3eb50f6fd42a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkPeeringList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer2", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet3" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "13.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkUpdateTags.json new file mode 100644 index 000000000000..cd0f35443f87 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualNetworkUpdateTags.json @@ -0,0 +1,39 @@ +{ + "parameters" : { + "api-version": "2018-04-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "location": "westus", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets" : [], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANDelete.json new file mode 100644 index 000000000000..b1851c6c1f4e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "VirtualWANName": "virtualWan1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANGet.json new file mode 100644 index 000000000000..80f04e81ec26 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANList.json new file mode 100644 index 000000000000..0ac4c3dc4592 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANList.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "wan2", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANListByResourceGroup.json new file mode 100644 index 000000000000..363638f463be --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "wan2", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub3", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub4" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite3", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite4" + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANPut.json new file mode 100644 index 000000000000..b42945cf6a81 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANPut.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "WANParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "disableVpnEncryption": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANUpdateTags.json new file mode 100644 index 000000000000..01ec0d575ebe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VirtualWANUpdateTags.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "WANParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssNetworkInterfaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssNetworkInterfaceGet.json new file mode 100644 index 000000000000..de8b2d4a7ec5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssNetworkInterfaceGet.json @@ -0,0 +1,65 @@ +{ + "parameters" : { + "api-version": "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkInterfaceName" : "nic1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "1" + }, + "responses" : { + "200" : { + "body" : { + "name" : "nic1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [ + { + "name" : "ip1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "10.0.0.5", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4", + "loadBalancerBackendAddressPools" : [ + { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules" : [ + { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [], + "internalDomainNameSuffix" : "dns.cdmx.internal.cloudapp.net" + }, + "macAddress" : "00-00-00-00-00-00", + "enableAcceleratedNetworking" : false, + "enableIPForwarding" : false, + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary" : true, + "virtualMachine" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssNetworkInterfaceIpConfigGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssNetworkInterfaceIpConfigGet.json new file mode 100644 index 000000000000..445dae399b7d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssNetworkInterfaceIpConfigGet.json @@ -0,0 +1,39 @@ +{ + "parameters" : { + "api-version": "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "2", + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses" : { + "200" : { + "body" : { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.6", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssNetworkInterfaceIpConfigList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssNetworkInterfaceIpConfigList.json new file mode 100644 index 000000000000..1758de1ee444 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssNetworkInterfaceIpConfigList.json @@ -0,0 +1,42 @@ +{ + "parameters" : { + "api-version": "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "2", + "networkInterfaceName": "nic1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.6", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssNetworkInterfaceList.json new file mode 100644 index 000000000000..aa3be3aba845 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssNetworkInterfaceList.json @@ -0,0 +1,118 @@ +{ + "parameters" : { + "api-version": "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualMachineScaleSetName": "vmss1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.0" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0" + } + } + }, + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssPublicIpGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssPublicIpGet.json new file mode 100644 index 000000000000..6163cda40a8d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssPublicIpGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2017-03-30", + "subscriptionId": "subid", + "virtualmachineIndex": 1, + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1", + "publicIpAddressName": "pub1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssPublicIpListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssPublicIpListAll.json new file mode 100644 index 000000000000..5d20af64ab0e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssPublicIpListAll.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2017-03-30", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm3.testvmssacc", + "fqdn": "vm3.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.118.216", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssVmNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssVmNetworkInterfaceList.json new file mode 100644 index 000000000000..e44ecaa437fd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssVmNetworkInterfaceList.json @@ -0,0 +1,68 @@ +{ + "parameters" : { + "api-version": "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssVmPublicIpList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssVmPublicIpList.json new file mode 100644 index 000000000000..5f179ef0a801 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VmssVmPublicIpList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2017-03-30", + "subscriptionId": "subid", + "virtualmachineIndex": 1, + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnConnectionDelete.json new file mode 100644 index 000000000000..299700927116 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "connectionName": "vpnConnection1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnConnectionGet.json new file mode 100644 index 000000000000..0524e60d8ca1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnConnectionGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnConnectionList.json new file mode 100644 index 000000000000..def53bb66bbb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnConnectionList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "api-version": "2018-04-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnConnectionPut.json new file mode 100644 index 000000000000..09a8a18817fc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnConnectionPut.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "connectionName": "vpnConnection1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "VpnConnectionParameters": { + "tags": { + "key1": "value1" + }, + "properties": { + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "sharedKey": "key" + } + } + }, + "responses": { + "200": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + }, + "201": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayDelete.json new file mode 100644 index 000000000000..cc017f463539 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayGet.json new file mode 100644 index 000000000000..84175643821d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayGet.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "policies": { + "allowBranchToBranchTraffic": true, + "allowVnetToVnetTraffic": false + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayList.json new file mode 100644 index 000000000000..b12679a8e4ad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayList.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "policies": { + "allowBranchToBranchTraffic": true, + "allowVnetToVnetTraffic": false + } + } + }, + { + "name": "gateway2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2/vpnConnections/vpnConnection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "policies": { + "allowBranchToBranchTraffic": true, + "allowVnetToVnetTraffic": false + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayListByResourceGroup.json new file mode 100644 index 000000000000..84c0c124c306 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayListByResourceGroup.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "policies": { + "allowBranchToBranchTraffic": true, + "allowVnetToVnetTraffic": false + } + } + }, + { + "name": "gateway2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway2/vpnConnections/vpnConnection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "policies": { + "allowBranchToBranchTraffic": true, + "allowVnetToVnetTraffic": false + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayPut.json new file mode 100644 index 000000000000..aea9e0d800bc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayPut.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "vpnGatewayParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "properties": { + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "sharedKey": "key" + } + } + ], + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "policies": { + "allowBranchToBranchTraffic": true, + "allowVnetToVnetTraffic": false + } + } + } + }, + "responses": { + "200": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "policies": { + "allowBranchToBranchTraffic": true, + "allowVnetToVnetTraffic": false + } + } + }, + "201": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "policies": { + "allowBranchToBranchTraffic": true, + "allowVnetToVnetTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayUpdateTags.json new file mode 100644 index 000000000000..bc0284b4c145 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnGatewayUpdateTags.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "vpnGatewayParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "policies": { + "allowBranchToBranchTraffic": true, + "allowVnetToVnetTraffic": false + } + } + }, + "201": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "policies": { + "allowBranchToBranchTraffic": true, + "allowVnetToVnetTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteDelete.json new file mode 100644 index 000000000000..4ba1c2e1a1a3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteGet.json new file mode 100644 index 000000000000..31a122a924c8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWAN": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + } + } + } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteList.json new file mode 100644 index 000000000000..e84f52f1a0d8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteList.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWAN": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "vpnSite2", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWAN": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteListByResourceGroup.json new file mode 100644 index 000000000000..85625fa30d75 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteListByResourceGroup.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWAN": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite2", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWAN": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSitePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSitePut.json new file mode 100644 index 000000000000..02dfb5f780d0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSitePut.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "VpnSiteParameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "virtualWAN": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/VirtualWans/virtualWan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWAN": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/VirtualWans/virtualWan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWAN": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/VirtualWans/virtualWan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteUpdateTags.json new file mode 100644 index 000000000000..1347e30587bb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSiteUpdateTags.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "subscriptionId": "subid", + "VpnSiteParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWAN": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWAN": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSitesConfigurationDownload.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSitesConfigurationDownload.json new file mode 100644 index 000000000000..f420bfea4d38 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/VpnSitesConfigurationDownload.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2018-04-01", + "virtualWANName": "wan1", + "request": { + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/abc" + ], + "outputBlobSasUrl": "https://blobcortextesturl.blob.core.windows.net/folderforconfig/vpnFile?sp=rw&se=2018-01-10T03%3A42%3A04Z&sv=2017-04-17&sig=WvXrT5bDmDFfgHs%2Brz%2BjAu123eRCNE9BO0eQYcPDT7pY%3D&sr=b" + } + }, + "responses": { + "200": { + "description": "Request successful. Follow the location header for sas-url to output blob." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/expressRouteCircuit.json new file mode 100644 index 000000000000..95244bffc142 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/expressRouteCircuit.json @@ -0,0 +1,1944 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_Delete", + "description": "Deletes the specified authorization from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationDelete.json" } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_Get", + "description": "Gets the specified authorization from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationGet.json" } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_CreateOrUpdate", + "description": "Creates or updates an authorization in the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "name": "authorizationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "Parameters supplied to the create or update express route circuit authorization operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationCreate.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations": { + "get": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_List", + "description": "Gets all authorizations in an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuitAuthorization resources.", + "schema": { + "$ref": "#/definitions/AuthorizationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_Delete", + "description": "Deletes the specified peering from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete ExpressRouteCircuit Peerings": { "$ref": "./examples/ExpressRouteCircuitPeeringDelete.json" } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_Get", + "description": "Gets the specified peering for the express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit Peering": { "$ref": "./examples/ExpressRouteCircuitPeeringGet.json" } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified express route circuits.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "peeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "Parameters supplied to the create or update express route circuit peering operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create ExpressRouteCircuit Peerings": { "$ref": "./examples/ExpressRouteCircuitPeeringCreate.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings": { + "get": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_List", + "description": "Gets all peerings in a specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuitPeering resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples":{ + "List ExpressRouteCircuit Peerings": { "$ref": "./examples/ExpressRouteCircuitPeeringList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections/{connectionName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_Delete", + "description": "Deletes the specified Express Route Circuit Connection from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "Delete ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitConnectionDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_Get", + "description": "Gets the specified Express Route Circuit Connection from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Express Route Circuit Connection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + } + }, + "x-ms-examples": { + "ExpressRouteCircuitConnectionGet": { + "$ref": "./examples/ExpressRouteCircuitConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_CreateOrUpdate", + "description": "Creates or updates a Express Route Circuit Connection in the specified express route circuits.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "name": "expressRouteCircuitConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + }, + "description": "Parameters supplied to the create or update express route circuit circuit connection operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + } + }, + "x-ms-examples": { + "ExpressRouteCircuitConnectionCreate": { + "$ref": "./examples/ExpressRouteCircuitConnectionCreate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}": { + "delete": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_Delete", + "description": "Deletes the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Disabling' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitDelete.json" } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_Get", + "description": "Gets information about the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of express route circuit." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitGet.json" } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_CreateOrUpdate", + "description": "Creates or updates an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + }, + "description": "Parameters supplied to the create or update express route circuit operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitCreate.json" } + } + }, + "patch": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_UpdateTags", + "description": "Updates an express route circuit tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update express route circuit tags." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + } + }, + "x-ms-examples": { + "Update Express Route Circuit Tags": { + "$ref": "./examples/ExpressRouteCircuitUpdateTags.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/arpTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitArpTable" + ], + "operationId": "ExpressRouteCircuits_ListArpTable", + "description": "Gets the currently advertised ARP table associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsArpTable resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsArpTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "List ARP Table": { "$ref": "./examples/ExpressRouteCircuitARPTableList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitRoutesTable" + ], + "operationId": "ExpressRouteCircuits_ListRoutesTable", + "description": "Gets the currently advertised routes table associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsRouteTable resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsRoutesTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "List Route Tables": { "$ref": "./examples/ExpressRouteCircuitRouteTableList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTablesSummary/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitRoutesTableSummary" + ], + "operationId": "ExpressRouteCircuits_ListRoutesTableSummary", + "description": "Gets the currently advertised routes table summary associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsRoutesTableSummary resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsRoutesTableSummaryListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "List Route Table Summary": { "$ref": "./examples/ExpressRouteCircuitRouteTableSummaryList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/stats": { + "get": { + "tags": [ + "ExpressRouteCircuitStats" + ], + "operationId": "ExpressRouteCircuits_GetStats", + "description": "Gets all the stats from an express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitStats resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitStats" + } + } + }, + "x-ms-examples": { + "Get ExpressRoute Circuit Traffic Stats": { "$ref": "./examples/ExpressRouteCircuitStats.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/stats": { + "get": { + "tags": [ + "ExpressRouteCircuitStats" + ], + "operationId": "ExpressRouteCircuits_GetPeeringStats", + "description": "Gets all stats from an express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitStats resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitStats" + } + } + }, + "x-ms-examples": { + "Get ExpressRoute Circuit Peering Traffic Stats": { "$ref": "./examples/ExpressRouteCircuitPeeringStats.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits": { + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_List", + "description": "Gets all the express route circuits in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuits in a resource group": { "$ref": "./examples/ExpressRouteCircuitListByResourceGroup.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCircuits": { + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_ListAll", + "description": "Gets all the express route circuits in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuit resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuits in a subscription": { "$ref": "./examples/ExpressRouteCircuitListBySubscription.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteServiceProviders": { + "get": { + "tags": [ + "ExpressRouteServiceProviders" + ], + "operationId": "ExpressRouteServiceProviders_List", + "description": "Gets all the available express route service providers.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteServiceProviderListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRoute providers": { "$ref": "./examples/ExpressRouteProviderList.json" } + } + } + } + }, + "definitions": { + "AuthorizationPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorization key." + }, + "authorizationUseStatus": { + "type": "string", + "description": "AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.", + "enum": [ + "Available", + "InUse" + ], + "x-ms-enum": { + "name": "AuthorizationUseStatus", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + } + }, + "ExpressRouteCircuitAuthorization": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AuthorizationPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Authorization in an ExpressRouteCircuit resource." + }, + "AuthorizationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "The authorizations in an ExpressRoute Circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListAuthorizations API service call retrieves all authorizations that belongs to an ExpressRouteCircuit." + }, + "ExpressRouteCircuitPeeringConfig": { + "properties": { + "advertisedPublicPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The reference of AdvertisedPublicPrefixes." + }, + "advertisedCommunities": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The communities of bgp peering. Spepcified for microsoft peering" + }, + "advertisedPublicPrefixesState": { + "type": "string", + "description": "AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.", + "enum": [ + "NotConfigured", + "Configuring", + "Configured", + "ValidationNeeded" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitPeeringAdvertisedPublicPrefixState", + "modelAsString": true + } + }, + "legacyMode": { + "type": "integer", + "format": "int32", + "description": "The legacy mode of the peering." + }, + "customerASN": { + "type": "integer", + "format": "int32", + "description": "The CustomerASN of the peering." + }, + "routingRegistryName": { + "type": "string", + "description": "The RoutingRegistryName of the configuration." + } + }, + "description": "Specifies the peering configuration." + }, + "Ipv6ExpressRouteCircuitPeeringConfig": { + "properties": { + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "microsoftPeeringConfig": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "routeFilter": { + "$ref": "./routeFilter.json#/definitions/RouteFilter", + "description": "The reference of the RouteFilter resource." + }, + "state": { + "type": "string", + "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitPeeringState", + "modelAsString": true + } + } + }, + "description": "Contains IPv6 peering config." + }, + "ExpressRouteCircuitStats": { + "properties": { + "primarybytesIn": { + "type": "integer", + "format": "int64", + "description": "Gets BytesIn of the peering." + }, + "primarybytesOut": { + "type": "integer", + "format": "int64", + "description": "Gets BytesOut of the peering." + }, + "secondarybytesIn": { + "type": "integer", + "format": "int64", + "description": "Gets BytesIn of the peering." + }, + "secondarybytesOut": { + "type": "integer", + "format": "int64", + "description": "Gets BytesOut of the peering." + } + }, + "description": "Contains stats associated with the peering." + }, + "ExpressRouteCircuitPeeringPropertiesFormat": { + "properties": { + "peeringType": { + "$ref": "#/definitions/ExpressRoutePeeringType", + "description": "The peering type." + }, + "state": { + "$ref": "#/definitions/ExpressRoutePeeringState", + "description": "The peering state." + }, + "azureASN": { + "type": "integer", + "format": "int32", + "description": "The Azure ASN." + }, + "peerASN": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 4294967295, + "description": "The peer ASN." + }, + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "primaryAzurePort": { + "type": "string", + "description": "The primary port." + }, + "secondaryAzurePort": { + "type": "string", + "description": "The secondary port." + }, + "sharedKey": { + "type": "string", + "description": "The shared key." + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "The VLAN ID." + }, + "microsoftPeeringConfig": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "stats": { + "$ref": "#/definitions/ExpressRouteCircuitStats", + "description": "Gets peering stats." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + }, + "lastModifiedBy": { + "type": "string", + "description": "Gets whether the provider or the customer last modified the peering." + }, + "routeFilter": { + "$ref": "./routeFilter.json#/definitions/RouteFilter", + "description": "The reference of the RouteFilter resource." + }, + "ipv6PeeringConfig": { + "$ref": "#/definitions/Ipv6ExpressRouteCircuitPeeringConfig", + "description": "The IPv6 peering configuration." + }, + "connections": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + }, + "description": "The list of circuit connections associated with Azure Private Peering for this circuit." + } + } + }, + "ExpressRouteCircuitPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peering in an ExpressRouteCircuit resource." + }, + "ExpressRouteCircuitPeeringListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "The peerings in an express route circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCircuit." + }, + "ExpressRoutePeeringType": { + "type": "string", + "description": "The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'.", + "enum": [ + "AzurePublicPeering", + "AzurePrivatePeering", + "MicrosoftPeering" + ], + "x-ms-enum": { + "name": "ExpressRoutePeeringType", + "modelAsString": true + } + }, + "ExpressRoutePeeringState": { + "type": "string", + "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ExpressRoutePeeringState", + "modelAsString": true + } + }, + "ExpressRouteCircuitConnectionPropertiesFormat": { + "properties": { + "expressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection." + }, + "peerExpressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the peered circuit." + }, + "addressPrefix": { + "type": "string", + "description": "/29 IP address space to carve out Customer addresses for tunnels." + }, + "authorizationKey": { + "type": "string", + "description": "The authorization key." + }, + "circuitConnectionStatus": { + "type": "string", + "description": "Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'.", + "enum": [ + "Connected", + "Connecting", + "Disconnected" + ], + "readOnly": true, + "x-ms-enum": { + "name": "circuitConnectionStatus", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeded', 'Updating', 'Deleting', and 'Failed'." + } + } + }, + "ExpressRouteCircuitConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitConnectionPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Express Route Circuit Connection in an ExpressRouteCircuitPeering resource." + }, + "ExpressRouteCircuitSku": { + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU." + }, + "tier": { + "type": "string", + "description": "The tier of the SKU. Possible values are 'Standard' and 'Premium'.", + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitSkuTier", + "modelAsString": true + } + }, + "family": { + "type": "string", + "description": "The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'.", + "enum": [ + "UnlimitedData", + "MeteredData" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitSkuFamily", + "modelAsString": true + } + } + }, + "description": "Contains SKU in an ExpressRouteCircuit." + }, + "ExpressRouteCircuitServiceProviderProperties": { + "properties": { + "serviceProviderName": { + "type": "string", + "description": "The serviceProviderName." + }, + "peeringLocation": { + "type": "string", + "description": "The peering location." + }, + "bandwidthInMbps": { + "type": "integer", + "format": "int32", + "description": "The BandwidthInMbps." + } + }, + "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit." + }, + "ExpressRouteCircuitPropertiesFormat": { + "properties": { + "allowClassicOperations": { + "type": "boolean", + "description": "Allow classic operations" + }, + "circuitProvisioningState": { + "type": "string", + "description": "The CircuitProvisioningState state of the resource." + }, + "serviceProviderProvisioningState": { + "type": "string", + "description": "The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'.", + "enum": [ + "NotProvisioned", + "Provisioning", + "Provisioned", + "Deprovisioning" + ], + "x-ms-enum": { + "name": "ServiceProviderProvisioningState", + "modelAsString": true + } + }, + "authorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "The list of authorizations." + }, + "peerings": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "The list of peerings." + }, + "serviceKey": { + "type": "string", + "description": "The ServiceKey." + }, + "serviceProviderNotes": { + "type": "string", + "description": "The ServiceProviderNotes." + }, + "serviceProviderProperties": { + "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties", + "description": "The ServiceProviderProperties." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + } + }, + "description": "Properties of ExpressRouteCircuit." + }, + "ExpressRouteCircuit": { + "properties": { + "sku": { + "$ref": "#/definitions/ExpressRouteCircuitSku", + "description": "The SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRouteCircuit resource" + }, + "ExpressRouteCircuitArpTable": { + "properties": { + "age": { + "type": "integer", + "format": "int32", + "description": "Entry age in minutes" + }, + "interface": { + "type": "string", + "description": "Interface address" + }, + "ipAddress": { + "type": "string", + "description": "The IP address." + }, + "macAddress": { + "type": "string", + "description": "The MAC address." + } + }, + "description": "The ARP table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCircuitsArpTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitArpTable" + }, + "description": "Gets list of the ARP table." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListArpTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitRoutesTable": { + "properties": { + "network": { + "type": "string", + "description": "IP address of a network entity" + }, + "nextHop": { + "type": "string", + "description": "NextHop address" + }, + "locPrf": { + "type": "string", + "description": "Local preference value as set with the set local-preference route-map configuration command" + }, + "weight": { + "type": "integer", + "format": "int32", + "description": "Route Weight." + }, + "path": { + "type": "string", + "description": "Autonomous system paths to the destination network." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit" + }, + "ExpressRouteCircuitsRoutesTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitRoutesTable" + }, + "description": "The list of routes table." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitRoutesTableSummary": { + "properties": { + "neighbor": { + "type": "string", + "description": "IP address of the neighbor." + }, + "v": { + "type": "integer", + "format": "int32", + "description": "BGP version number spoken to the neighbor." + }, + "as": { + "type": "integer", + "format": "int32", + "description": "Autonomous system number." + }, + "upDown": { + "type": "string", + "description": "The length of time that the BGP session has been in the Established state, or the current status if not in the Established state." + }, + "statePfxRcd": { + "type": "string", + "description": "Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCircuitsRoutesTableSummaryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitRoutesTableSummary" + }, + "description": "A list of the routes table." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuit" + }, + "description": "A list of ExpressRouteCircuits in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListExpressRouteCircuit API service call." + }, + "ExpressRouteServiceProviderBandwidthsOffered": { + "properties": { + "offerName": { + "type": "string", + "description": "The OfferName." + }, + "valueInMbps": { + "type": "integer", + "format": "int32", + "description": "The ValueInMbps." + } + }, + "description": "Contains bandwidths offered in ExpressRouteServiceProvider resources." + }, + "ExpressRouteServiceProviderPropertiesFormat": { + "properties": { + "peeringLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Get a list of peering locations." + }, + "bandwidthsOffered": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteServiceProviderBandwidthsOffered" + }, + "description": "Gets bandwidths offered." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the resource." + } + }, + "description": "Properties of ExpressRouteServiceProvider." + }, + "ExpressRouteServiceProvider": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteServiceProviderPropertiesFormat" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A ExpressRouteResourceProvider object." + }, + "ExpressRouteServiceProviderListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteServiceProvider" + }, + "description": "A list of ExpressRouteResourceProvider resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListExpressRouteServiceProvider API service call." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/expressRouteCrossConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/expressRouteCrossConnection.json new file mode 100644 index 000000000000..034066568076 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/expressRouteCrossConnection.json @@ -0,0 +1,938 @@ +{ + "swagger": "2.0", + "info": { + "title": "ExpressRouteCrossConnection REST APIs", + "description": "The Microsoft Azure ExpressRouteCrossConnection Resource Provider REST APIs describes the operations for the connectivity provider to provision ExpressRoute circuit, create and modify BGP peering entities and troubleshoot connectivity on customer's ExpressRoute circuit. ", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCrossConnections": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_List", + "description": "Retrieves all the ExpressRouteCrossConnections in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionList": { + "$ref": "./examples/ExpressRouteCrossConnectionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_ListByResourceGroup", + "description": "Retrieves all the ExpressRouteCrossConnections in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionListByResourceGroup": { + "$ref": "./examples/ExpressRouteCrossConnectionListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_Get", + "description": "Gets details about the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group (peering location of the circuit)." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection (service key of the circuit)." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnection": { + "$ref": "./examples/ExpressRouteCrossConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_CreateOrUpdate", + "description": "Update the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + }, + "description": "Parameters supplied to the update express route crossConnection operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + } + }, + "x-ms-examples": { + "UpdateExpressRouteCrossConnection": { + "$ref": "./examples/ExpressRouteCrossConnectionUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_UpdateTags", + "description": "Updates an express route cross connection tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cross connection." + }, + { + "name": "crossConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update express route cross connection tags." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + } + }, + "x-ms-examples": { + "UpdateExpressRouteCrossConnectionTags": { + "$ref": "./examples/ExpressRouteCrossConnectionUpdateTags.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings": { + "get": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_List", + "description": "Gets all peerings in a specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnectionPeering resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeeringList" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionBgpPeeringList": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}": { + "delete": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_Delete", + "description": "Deletes the specified peering from the ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "DeleteExpressRouteCrossConnectionBgpPeering": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringDelete.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_Get", + "description": "Gets the specified peering for the ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionBgpPeering": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "peeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "Parameters supplied to the create or update ExpressRouteCrossConnection peering operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionBgpPeeringCreate": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringCreate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/arpTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionArpTable" + ], + "operationId": "ExpressRouteCrossConnections_ListArpTable", + "description": "Gets the currently advertised ARP table associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsArpTable resource.", + "schema": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitsArpTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsArpTable": { + "$ref": "./examples/ExpressRouteCrossConnectionsArpTable.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/routeTablesSummary/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionRouteTableSummary" + ], + "operationId": "ExpressRouteCrossConnections_ListRoutesTableSummary", + "description": "Gets the route table summary associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsRouteTableSummary resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionsRoutesTableSummaryListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsRouteTableSummary": { + "$ref": "./examples/ExpressRouteCrossConnectionsRouteTableSummary.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/routeTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionRouteTable" + ], + "operationId": "ExpressRouteCrossConnections_ListRoutesTable", + "description": "Gets the currently advertised routes table associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsRouteTable resource.", + "schema": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitsRoutesTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsRouteTable": { + "$ref": "./examples/ExpressRouteCrossConnectionsRouteTable.json" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ExpressRouteCrossConnectionRoutesTableSummary": { + "properties": { + "neighbor": { + "type": "string", + "description": "IP address of Neighbor router" + }, + "asn": { + "type": "integer", + "format": "int32", + "description": "Autonomous system number." + }, + "upDown": { + "type": "string", + "description": "The length of time that the BGP session has been in the Established state, or the current status if not in the Established state." + }, + "stateOrPrefixesReceived": { + "type": "string", + "description": "Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCrossConnectionsRoutesTableSummaryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionRoutesTableSummary" + }, + "description": "A list of the routes table." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Cross Connections." + }, + "ExpressRouteCircuitReference": { + "properties": { + "id": { + "type":"string", + "description": "Corresponding Express Route Circuit Id." + } + } + }, + "ExpressRouteCrossConnectionProperties": { + "properties": { + "primaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The name of the primary port." + }, + "secondaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The name of the secondary port." + }, + "sTag": { + "readOnly": true, + "type": "integer", + "description": "The identifier of the circuit traffic." + }, + "peeringLocation": { + "type": "string", + "description": "The peering location of the ExpressRoute circuit." + }, + "bandwidthInMbps": { + "type": "integer", + "format": "int32", + "description": "The circuit bandwidth In Mbps." + }, + "expressRouteCircuit": { + "$ref": "#/definitions/ExpressRouteCircuitReference", + "description": "The ExpressRouteCircuit" + }, + "serviceProviderProvisioningState": { + "type": "string", + "description": "The provisioning state of the circuit in the connectivity provider system. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned'.", + "enum": [ + "NotProvisioned", + "Provisioning", + "Provisioned", + "Deprovisioning" + ], + "x-ms-enum": { + "name": "ServiceProviderProvisioningState", + "modelAsString": true + } + }, + "serviceProviderNotes": { + "type": "string", + "description": "Additional read only notes set by the connectivity provider." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "peerings": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "The list of peerings." + } + }, + "description": "Properties of ExpressRouteCrossConnection." + }, + "ExpressRouteCrossConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCrossConnectionProperties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRouteCrossConnection resource" + }, + "ExpressRouteCrossConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + }, + "description": "A list of ExpressRouteCrossConnection resources." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListExpressRouteCrossConnection API service call." + }, + "ExpressRouteCrossConnectionPeeringProperties": { + "properties": { + "peeringType": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRoutePeeringType", + "description": "The peering type." + }, + "state": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRoutePeeringState", + "description": "The peering state." + }, + "azureASN": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The Azure ASN." + }, + "peerASN": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 4294967295, + "description": "The peer ASN." + }, + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "primaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The primary port." + }, + "secondaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The secondary port." + }, + "sharedKey": { + "type": "string", + "description": "The shared key." + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "The VLAN ID." + }, + "microsoftPeeringConfig": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + }, + "lastModifiedBy": { + "type": "string", + "description": "Gets whether the provider or the customer last modified the peering." + }, + "ipv6PeeringConfig": { + "$ref": "./expressRouteCircuit.json#/definitions/Ipv6ExpressRouteCircuitPeeringConfig", + "description": "The IPv6 peering configuration." + } + } + }, + "ExpressRouteCrossConnectionPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCrossConnectionPeeringProperties" + }, + "name": { + "type": "string", + "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peering in an ExpressRoute Cross Connection resource." + }, + "ExpressRouteCrossConnectionPeeringList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "The peerings in an express route cross connection." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCrossConnection." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/loadBalancer.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/loadBalancer.json new file mode 100644 index 000000000000..4cf81c59cd61 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/loadBalancer.json @@ -0,0 +1,1673 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}": { + "delete": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_Delete", + "description": "Deletes the specified load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "Delete load balancer": { "$ref": "./examples/LoadBalancerDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_Get", + "description": "Gets the specified load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting LoadBalancer resource.", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + } + }, + "x-ms-examples": { + "Get load balancer": { "$ref": "./examples/LoadBalancerGet.json" } + } + }, + "put": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_CreateOrUpdate", + "description": "Creates or updates a load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LoadBalancer" + }, + "description": "Parameters supplied to the create or update load balancer operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting LoadBalancer resource.", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting LoadBalancer resource.", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + } + }, + "x-ms-examples": { + "Create load balancer": { "$ref": "./examples/LoadBalancerCreate.json" }, + "Create load balancer with inbound nat pool": { "$ref": "./examples/LoadBalancerCreateWithInboundNatPool.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_UpdateTags", + "description": "Updates a load balancer tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update load balancer tags." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting LoadBalancer resource.", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + } + }, + "x-ms-examples": { + "Update load balancer tags": { "$ref": "./examples/LoadBalancerUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/loadBalancers": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_ListAll", + "description": "Gets all the load balancers in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerListResult" + } + } + }, + "x-ms-examples": { + "List all load balancers": { "$ref": "./examples/LoadBalancerListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_List", + "description": "Gets all the load balancers in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerListResult" + } + } + }, + "x-ms-examples": { + "List load balancers in resource group": { "$ref": "./examples/LoadBalancerList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerBackendAddressPools_List", + "description": "Gets all the load balancer backed address pools.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer BackendAddressPool resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerBackendAddressPoolListResult" + } + } + }, + "x-ms-examples": { + "LoadBalancerBackendAddressPoolList": { "$ref": "./examples/LoadBalancerBackendAddressPoolList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerBackendAddressPools_Get", + "description": "Gets load balancer backend address pool.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "backendAddressPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the backend address pool." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns LoadBalancer BackendAddressPool resource.", + "schema": { + "$ref": "#/definitions/BackendAddressPool" + } + } + }, + "x-ms-examples": { + "LoadBalancerBackendAddressPoolGet": { "$ref": "./examples/LoadBalancerBackendAddressPoolGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/frontendIPConfigurations": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerFrontendIPConfigurations_List", + "description": "Gets all the load balancer frontend IP configurations.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer FrontendIPConfiguration resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerFrontendIPConfigurationListResult" + } + } + }, + "x-ms-examples": { + "LoadBalancerFrontendIPConfigurationList": { "$ref": "./examples/LoadBalancerFrontendIPConfigurationList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/frontendIPConfigurations/{frontendIPConfigurationName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerFrontendIPConfigurations_Get", + "description": "Gets load balancer frontend IP configuration.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "frontendIPConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the frontend IP configuration." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns LoadBalancer FrontendIPConfiguration resource.", + "schema": { + "$ref": "#/definitions/FrontendIPConfiguration" + } + } + }, + "x-ms-examples": { + "LoadBalancerFrontendIPConfigurationGet": { "$ref": "./examples/LoadBalancerFrontendIPConfigurationGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "InboundNatRules_List", + "description": "Gets all the inbound nat rules in a load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer InboundNatRule resources.", + "schema": { + "$ref": "#/definitions/InboundNatRuleListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "InboundNatRuleList": { "$ref": "./examples/InboundNatRuleList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}": { + "delete": { + "tags": [ + "LoadBalancers" + ], + "operationId": "InboundNatRules_Delete", + "description": "Deletes the specified load balancer inbound nat rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "inboundNatRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the inbound nat rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "InboundNatRuleDelete": { "$ref": "./examples/InboundNatRuleDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "InboundNatRules_Get", + "description": "Gets the specified load balancer inbound nat rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "inboundNatRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the inbound nat rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting InboundNatRule resource.", + "schema": { + "$ref": "#/definitions/InboundNatRule" + } + } + }, + "x-ms-examples": { + "InboundNatRuleGet": { "$ref": "./examples/InboundNatRuleGet.json" } + } + }, + "put": { + "tags": [ + "LoadBalancers" + ], + "operationId": "InboundNatRules_CreateOrUpdate", + "description": "Creates or updates a load balancer inbound nat rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "inboundNatRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the inbound nat rule." + }, + { + "name": "inboundNatRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InboundNatRule" + }, + "description": "Parameters supplied to the create or update inbound nat rule operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting InboundNatRule resource.", + "schema": { + "$ref": "#/definitions/InboundNatRule" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting InboundNatRule resource.", + "schema": { + "$ref": "#/definitions/InboundNatRule" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "InboundNatRuleCreate": { "$ref": "./examples/InboundNatRuleCreate.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/loadBalancingRules": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerLoadBalancingRules_List", + "description": "Gets all the load balancing rules in a load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer LoadBalancingRule resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerLoadBalancingRuleListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "LoadBalancerLoadBalancingRuleList": { "$ref": "./examples/LoadBalancerLoadBalancingRuleList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/loadBalancingRules/{loadBalancingRuleName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerLoadBalancingRules_Get", + "description": "Gets the specified load balancer load balancing rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "loadBalancingRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancing rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting LoadBalancingRule resource.", + "schema": { + "$ref": "#/definitions/LoadBalancingRule" + } + } + }, + "x-ms-examples": { + "LoadBalancerLoadBalancingRuleGet": { "$ref": "./examples/LoadBalancerLoadBalancingRuleGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/networkInterfaces": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerNetworkInterfaces_List", + "description": "Gets associated load balancer network interfaces.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + } + }, + "x-ms-examples": { + "LoadBalancerNetworkInterfaceListVmss": { "$ref": "./examples/LoadBalancerNetworkInterfaceListVmss.json" }, + "LoadBalancerNetworkInterfaceListSimple": { "$ref": "./examples/LoadBalancerNetworkInterfaceListSimple.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerProbes_List", + "description": "Gets all the load balancer probes.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer Probe resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerProbeListResult" + } + } + }, + "x-ms-examples": { + "LoadBalancerProbeList": { "$ref": "./examples/LoadBalancerProbeList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerProbes_Get", + "description": "Gets load balancer probe.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "probeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the probe." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns LoadBalancer Probe resource.", + "schema": { + "$ref": "#/definitions/Probe" + } + } + }, + "x-ms-examples": { + "LoadBalancerProbeGet": { "$ref": "./examples/LoadBalancerProbeGet.json" } + } + } + } + }, + "definitions": { + "LoadBalancerSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of a load balancer SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "LoadBalancerSkuName", + "modelAsString": true + } + } + }, + "description": "SKU of a load balancer" + }, + "FrontendIPConfigurationPropertiesFormat": { + "properties": { + "inboundNatRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Read only. Inbound rules URIs that use this frontend IP." + }, + "inboundNatPools": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Read only. Inbound pools URIs that use this frontend IP." + }, + "outboundNatRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Read only. Outbound rules URIs that use this frontend IP." + }, + "loadBalancingRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Gets load balancing rules URIs that use this frontend IP." + }, + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "type": "string", + "description": "The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference of the subnet resource." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "The reference of the Public IP resource." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of Frontend IP Configuration of the load balancer." + }, + "FrontendIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FrontendIPConfigurationPropertiesFormat", + "description": "Properties of the load balancer probe." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Frontend IP address of the load balancer." + }, + "BackendAddressPoolPropertiesFormat": { + "properties": { + "backendIPConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "Gets collection of references to IP addresses defined in network interfaces." + }, + "loadBalancingRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Gets load balancing rules that use this backend address pool." + }, + "outboundNatRule": { + "readOnly": true, + "$ref": "./network.json#/definitions/SubResource", + "description": "Gets outbound rules that use this backend address pool." + }, + "provisioningState": { + "type": "string", + "description": "Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of the backend address pool." + }, + "BackendAddressPool": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BackendAddressPoolPropertiesFormat", + "description": "Properties of load balancer backend address pool." + }, + "name": { + "type": "string", + "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Pool of backend IP addresses." + }, + "LoadBalancingRulePropertiesFormat": { + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to frontend IP addresses." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs." + }, + "probe": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of the load balancer probe used by the load balancing rule." + }, + "protocol": { + "$ref": "#/definitions/TransportProtocol" + }, + "loadDistribution": { + "type": "string", + "description": "The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.", + "enum": [ + "Default", + "SourceIP", + "SourceIPProtocol" + ], + "x-ms-enum": { + "name": "LoadDistribution", + "modelAsString": true + } + }, + "frontendPort": { + "type": "integer", + "format": "int32", + "description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables \"Any Port\"" + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables \"Any Port\"" + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." + }, + "enableFloatingIP": { + "type": "boolean", + "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." + }, + "disableOutboundSnat": { + "type": "boolean", + "description": "Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "protocol", + "frontendPort" + ], + "description": "Properties of the load balancer." + }, + "LoadBalancingRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LoadBalancingRulePropertiesFormat", + "description": "Properties of load balancer load balancing rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "A load balancing rule for a load balancer." + }, + "ProbePropertiesFormat": { + "properties": { + "loadBalancingRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The load balancer rules that use this probe." + }, + "protocol": { + "type": "string", + "description": "The protocol of the end point. Possible values are: 'Http', 'Tcp', or 'Https'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.", + "enum": [ + "Http", + "Tcp", + "Https" + ], + "x-ms-enum": { + "name": "ProbeProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port for communicating the probe. Possible values range from 1 to 65535, inclusive." + }, + "intervalInSeconds": { + "type": "integer", + "format": "int32", + "description": "The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5." + }, + "numberOfProbes": { + "type": "integer", + "format": "int32", + "description": "The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure." + }, + "requestPath": { + "type": "string", + "description": "The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "protocol", + "port" + ], + "description": "Load balancer probe resource." + }, + "Probe": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProbePropertiesFormat", + "description": "Properties of load balancer probe." + }, + "name": { + "type": "string", + "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "A load balancer probe." + }, + "InboundNatRulePropertiesFormat": { + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to frontend IP addresses." + }, + "backendIPConfiguration": { + "readOnly": true, + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "description": "A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP." + }, + "protocol": { + "$ref": "#/definitions/TransportProtocol" + }, + "frontendPort": { + "type": "integer", + "format": "int32", + "description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The port used for the internal endpoint. Acceptable values range from 1 to 65535." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." + }, + "enableFloatingIP": { + "type": "boolean", + "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of the inbound NAT rule." + }, + "InboundNatRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/InboundNatRulePropertiesFormat", + "description": "Properties of load balancer inbound nat rule." + }, + "name": { + "type": "string", + "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Inbound NAT rule of the load balancer." + }, + "InboundNatPoolPropertiesFormat": { + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to frontend IP addresses." + }, + "protocol": { + "$ref": "#/definitions/TransportProtocol" + }, + "frontendPortRangeStart": { + "type": "integer", + "format": "int32", + "description": "The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534." + }, + "frontendPortRangeEnd": { + "type": "integer", + "format": "int32", + "description": "The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." + }, + "enableFloatingIP": { + "type": "boolean", + "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "protocol", + "frontendPortRangeStart", + "frontendPortRangeEnd", + "backendPort" + ], + "description": "Properties of Inbound NAT pool." + }, + "InboundNatPool": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/InboundNatPoolPropertiesFormat", + "description": "Properties of load balancer inbound nat pool." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Inbound NAT pool of the load balancer." + }, + "OutboundNatRulePropertiesFormat": { + "properties": { + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "description": "The number of outbound ports to be used for NAT." + }, + "frontendIPConfigurations": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The Frontend IP addresses of the load balancer." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "backendAddressPool" + ], + "description": "Outbound NAT pool of the load balancer." + }, + "OutboundNatRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OutboundNatRulePropertiesFormat", + "description": "Properties of load balancer outbound nat rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Outbound NAT pool of the load balancer." + }, + "LoadBalancerPropertiesFormat": { + "properties": { + "frontendIPConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/FrontendIPConfiguration" + }, + "description": "Object representing the frontend IPs to be used for the load balancer" + }, + "backendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/BackendAddressPool" + }, + "description": "Collection of backend address pools used by a load balancer" + }, + "loadBalancingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancingRule" + }, + "description": "Object collection representing the load balancing rules Gets the provisioning " + }, + "probes": { + "type": "array", + "items": { + "$ref": "#/definitions/Probe" + }, + "description": "Collection of probe objects used in the load balancer" + }, + "inboundNatRules": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNatRule" + }, + "description": "Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules." + }, + "inboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNatPool" + }, + "description": "Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules." + }, + "outboundNatRules": { + "type": "array", + "items": { + "$ref": "#/definitions/OutboundNatRule" + }, + "description": "The outbound NAT rules." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the load balancer resource." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of the load balancer." + }, + "LoadBalancer": { + "properties": { + "sku": { + "$ref": "#/definitions/LoadBalancerSku", + "description": "The load balancer SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LoadBalancerPropertiesFormat", + "description": "Properties of load balancer." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "LoadBalancer resource" + }, + "LoadBalancerListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancer" + }, + "description": "A list of load balancers in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListLoadBalancers API service call." + }, + "InboundNatRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNatRule" + }, + "description": "A list of inbound nat rules in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListInboundNatRule API service call." + }, + "LoadBalancerBackendAddressPoolListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BackendAddressPool" + }, + "description": "A list of backend address pools in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListBackendAddressPool API service call." + }, + "LoadBalancerFrontendIPConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FrontendIPConfiguration" + }, + "description": "A list of frontend IP configurations in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListFrontendIPConfiguration API service call." + }, + "LoadBalancerLoadBalancingRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancingRule" + }, + "description": "A list of load balancing rules in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListLoadBalancingRule API service call." + }, + "LoadBalancerProbeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Probe" + }, + "description": "A list of probes in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListProbe API service call." + }, + "TransportProtocol": { + "type": "string", + "description": "The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'.", + "enum": [ + "Udp", + "Tcp", + "All" + ], + "x-ms-enum": { + "name": "TransportProtocol", + "modelAsString": true + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/network.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/network.json new file mode 100644 index 000000000000..11635c9ec142 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/network.json @@ -0,0 +1,165 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + }, + "definitions": { + "ErrorDetails": { + "properties": { + "code": { + "type": "string" + }, + "target": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "Error": { + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "target": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetails" + } + }, + "innerError": { + "type": "string" + } + } + }, + "AzureAsyncOperationResult": { + "properties": { + "status": { + "type": "string", + "description": "Status of the Azure async operation. Possible values are: 'InProgress', 'Succeeded', and 'Failed'.", + "enum": [ + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "NetworkOperationStatus", + "modelAsString": true + } + }, + "error": { + "$ref": "#/definitions/Error" + } + }, + "description": "The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure." + }, + "Resource": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Common resource representation.", + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/networkInterface.json new file mode 100644 index 000000000000..d7e7f76e24fd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/networkInterface.json @@ -0,0 +1,1111 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}": { + "delete": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_Delete", + "description": "Deletes the specified network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "Delete network interface": { "$ref": "./examples/NetworkInterfaceDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_Get", + "description": "Gets information about the specified network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + } + }, + "x-ms-examples": { + "Get network interface": { "$ref": "./examples/NetworkInterfaceGet.json" } + } + }, + "put": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_CreateOrUpdate", + "description": "Creates or updates a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterface" + }, + "description": "Parameters supplied to the create or update network interface operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + } + }, + "x-ms-examples": { + "Create network interface": { "$ref": "./examples/NetworkInterfaceCreate.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_UpdateTags", + "description": "Updates a network interface tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network interface tags." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + } + }, + "x-ms-examples": { + "Update network interface tags": { "$ref": "./examples/NetworkInterfaceUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListAll", + "description": "Gets all network interfaces in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceListResult" + } + } + }, + "x-ms-examples": { + "List all network interfaces": { "$ref": "./examples/NetworkInterfaceListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_List", + "description": "Gets all network interfaces in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceListResult" + } + } + }, + "x-ms-examples": { + "List network interfaces in resource group": { "$ref": "./examples/NetworkInterfaceList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/effectiveRouteTable": { + "post": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetEffectiveRouteTable", + "description": "Gets all route tables applied to a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of EffectRoute resources.", + "schema": { + "$ref": "#/definitions/EffectiveRouteListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "Show network interface effective route tables": { "$ref": "./examples/NetworkInterfaceEffectiveRouteTableList.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/effectiveNetworkSecurityGroups": { + "post": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListEffectiveNetworkSecurityGroups", + "description": "Gets all network security groups applied to a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", + "schema": { + "$ref": "#/definitions/EffectiveNetworkSecurityGroupListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "List network interface effective network security groups": { "$ref": "./examples/NetworkInterfaceEffectiveNSGList.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaceIPConfigurations_List", + "description": "Get all ip configurations in a network interface", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface IPConfiguration resources.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceIPConfigurationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NetworkInterfaceIPConfigurationList": { "$ref": "./examples/NetworkInterfaceIPConfigurationList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaceIPConfigurations_Get", + "description": "Gets the specified network interface ip configuration.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ip configuration name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterface IPConfiguration resource.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" + } + } + }, + "x-ms-examples": { + "NetworkInterfaceIPConfigurationGet": { "$ref": "./examples/NetworkInterfaceIPConfigurationGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/loadBalancers": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaceLoadBalancers_List", + "description": "List all load balancers in a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface LoadBalancer resources.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceLoadBalancerListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NetworkInterfaceLoadBalancerList": { "$ref": "./examples/NetworkInterfaceLoadBalancerList.json" } + } + } + } + }, + "definitions": { + "NetworkInterfaceIPConfigurationPropertiesFormat": { + "properties": { + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "./applicationGateway.json#/definitions/ApplicationGatewayBackendAddressPool" + }, + "description": "The reference of ApplicationGatewayBackendAddressPool resource." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "./loadBalancer.json#/definitions/BackendAddressPool" + }, + "description": "The reference of LoadBalancerBackendAddressPool resource." + }, + "loadBalancerInboundNatRules": { + "type": "array", + "items": { + "$ref": "./loadBalancer.json#/definitions/InboundNatRule" + }, + "description": "A list of references of LoadBalancerInboundNatRules." + }, + "privateIPAddress": { + "type": "string", + "description": "Private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "type": "string", + "description": "Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "Subnet bound to the IP configuration." + }, + "primary": { + "type": "boolean", + "description": "Gets whether this is a primary customer address on the network interface." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "Public IP address bound to the IP configuration." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "Application security groups in which the IP configuration is included." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of IP configuration." + }, + "NetworkInterfaceIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat", + "description": "Network interface IP configuration properties." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IPConfiguration in a network interface." + }, + "NetworkInterfaceDnsSettings": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection." + }, + "appliedDnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs." + }, + "internalDnsNameLabel": { + "type": "string", + "description": "Relative DNS name for this NIC used for internal communications between VMs in the same virtual network." + }, + "internalFqdn": { + "type": "string", + "description": "Fully qualified DNS name supporting internal communications between VMs in the same virtual network." + }, + "internalDomainNameSuffix": { + "type": "string", + "description": "Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix." + } + }, + "description": "DNS settings of a network interface." + }, + "NetworkInterfacePropertiesFormat": { + "properties": { + "virtualMachine": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of a virtual machine." + }, + "networkSecurityGroup": { + "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup", + "description": "The reference of the NetworkSecurityGroup resource." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "A list of IPConfigurations of the network interface." + }, + "dnsSettings": { + "$ref": "#/definitions/NetworkInterfaceDnsSettings", + "description": "The DNS settings in network interface." + }, + "macAddress": { + "type": "string", + "description": "The MAC address of the network interface." + }, + "primary": { + "type": "boolean", + "description": "Gets whether this is a primary network interface on a virtual machine." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "If the network interface is accelerated networking enabled." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Indicates whether IP forwarding is enabled on this network interface." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the network interface resource." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "NetworkInterface properties. " + }, + "NetworkInterface": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfacePropertiesFormat", + "description": "Properties of the network interface." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A network interface in a resource group." + }, + "NetworkInterfaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "description": "A list of network interfaces in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListNetworkInterface API service call." + }, + "NetworkInterfaceIPConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "A list of ip configurations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list ip configurations API service call." + }, + "NetworkInterfaceLoadBalancerListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "./loadBalancer.json#/definitions/LoadBalancer" + }, + "description": "A list of load balancers." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list ip configurations API service call." + }, + "EffectiveNetworkSecurityGroup": { + "properties": { + "networkSecurityGroup": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of network security group that is applied." + }, + "association": { + "$ref": "#/definitions/EffectiveNetworkSecurityGroupAssociation", + "description": "Associated resources." + }, + "effectiveSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveNetworkSecurityRule" + }, + "description": "A collection of effective security rules." + }, + "tagMap": { + "type": "string", + "additionalProperties": { + "type":"array", + "items": { + "type": "string" + }, + "description": "List of IP Addresses within the tag (key)" + }, + "description": "Mapping of tags to list of IP Addresses included within the tag." + } + }, + "description": "Effective network security group." + }, + "EffectiveNetworkSecurityGroupAssociation": { + "properties": { + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of the subnet if assigned." + }, + "networkInterface": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of the network interface if assigned." + } + }, + "description": "The effective network security group association." + }, + "EffectiveNetworkSecurityRule": { + "properties": { + "name": { + "type": "string", + "description": "The name of the security rule specified by the user (if created by the user)." + }, + "protocol": { + "type": "string", + "description": "The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and 'All'.", + "enum": [ + "Tcp", + "Udp", + "All" + ], + "x-ms-enum": { + "name": "EffectiveSecurityRuleProtocol", + "modelAsString": true + } + }, + "sourcePortRange": { + "type": "string", + "description": "The source port or range." + }, + "destinationPortRange": { + "type": "string", + "description": "The destination port or range." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as seperator (e.g. 100-400), or an asterix (*)" + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as seperator (e.g. 100-400), or an asterix (*)" + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The source address prefix." + }, + "destinationAddressPrefix": { + "type": "string", + "description": "The destination address prefix." + }, + "sourceAddressPrefixes" : { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + }, + "destinationAddressPrefixes" : { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + }, + "expandedSourceAddressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The expanded source address prefix." + }, + "expandedDestinationAddressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Expanded destination address prefix." + }, + "access": { + "type": "string", + "description": "Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "SecurityRuleAccess", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule." + }, + "direction": { + "type": "string", + "description": "The direction of the rule. Possible values are: 'Inbound and Outbound'.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "SecurityRuleDirection", + "modelAsString": true + } + } + }, + "description": "Effective network security rules." + }, + "EffectiveNetworkSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveNetworkSecurityGroup" + }, + "description": "A list of effective network security groups." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list effective network security groups API service call." + }, + "EffectiveRoute": { + "properties": { + "name": { + "type": "string", + "description": "The name of the user defined route. This is optional." + }, + "source": { + "type": "string", + "description": "Who created the route. Possible values are: 'Unknown', 'User', 'VirtualNetworkGateway', and 'Default'.", + "enum": [ + "Unknown", + "User", + "VirtualNetworkGateway", + "Default" + ], + "x-ms-enum": { + "name": "EffectiveRouteSource", + "modelAsString": true + } + }, + "state": { + "type": "string", + "description": "The value of effective route. Possible values are: 'Active' and 'Invalid'.", + "enum": [ + "Active", + "Invalid" + ], + "x-ms-enum": { + "name": "EffectiveRouteState", + "modelAsString": true + } + }, + "addressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The address prefixes of the effective routes in CIDR notation." + }, + "nextHopIpAddress": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IP address of the next hop of the effective route." + }, + "nextHopType": { + "type": "string", + "description": "The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.", + "enum": [ + "VirtualNetworkGateway", + "VnetLocal", + "Internet", + "VirtualAppliance", + "None" + ], + "x-ms-enum": { + "name": "RouteNextHopType", + "modelAsString": true + } + } + }, + "description": "Effective Route" + }, + "EffectiveRouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveRoute" + }, + "description": "A list of effective routes." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list effective route API service call." + }, + "IPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "type": "string", + "description": "The private IP allocation method. Possible values are 'Static' and 'Dynamic'.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference of the subnet resource." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "The reference of the public IP resource." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of IP configuration." + }, + "IPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IPConfigurationPropertiesFormat", + "description": "Properties of the IP configuration" + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/networkSecurityGroup.json new file mode 100644 index 000000000000..a784e9ef217d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/networkSecurityGroup.json @@ -0,0 +1,864 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}": { + "delete": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_Delete", + "description": "Deletes the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + } + }, + "x-ms-examples": { + "Delete network security group": { "$ref": "./examples/NetworkSecurityGroupDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_Get", + "description": "Gets the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + } + }, + "x-ms-examples": { + "Get network security group": { "$ref": "./examples/NetworkSecurityGroupGet.json" } + } + }, + "put": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "description": "Creates or updates a network security group in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + }, + "description": "Parameters supplied to the create or update network security group operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + } + }, + "x-ms-examples": { + "Create network security group": { "$ref": "./examples/NetworkSecurityGroupCreate.json" }, + "Create network security group with rule": { "$ref": "./examples/NetworkSecurityGroupCreateWithRule.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_UpdateTags", + "description": "Updates a network security group tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network security group tags." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + } + }, + "x-ms-examples": { + "Update network security group tags": { "$ref": "./examples/NetworkSecurityGroupUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkSecurityGroups": { + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_ListAll", + "description": "Gets all network security groups in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupListResult" + } + } + }, + "x-ms-examples": { + "List all network security groups": { "$ref": "./examples/NetworkSecurityGroupListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups": { + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_List", + "description": "Gets all network security groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupListResult" + } + } + }, + "x-ms-examples": { + "List network security groups in resource group": { "$ref": "./examples/NetworkSecurityGroupList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}": { + "delete": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_Delete", + "description": "Deletes the specified network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "Delete network security rule from network security group": { "$ref": "./examples/NetworkSecurityGroupRuleDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_Get", + "description": "Get the specified network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + } + }, + "x-ms-examples": { + "Get network security rule in network security group": { "$ref": "./examples/NetworkSecurityGroupRuleGet.json" } + } + }, + "put": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_CreateOrUpdate", + "description": "Creates or updates a security rule in the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "name": "securityRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "Parameters supplied to the create or update network security rule operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + } + }, + "x-ms-examples": { + "Create security rule": { "$ref": "./examples/NetworkSecurityGroupRuleCreate.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules": { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_List", + "description": "Gets all security rules in a network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of SecurityRule resources.", + "schema": { + "$ref": "#/definitions/SecurityRuleListResult" + } + } + }, + "x-ms-examples": { + "List network security rules in network security group": { "$ref": "./examples/NetworkSecurityGroupRuleList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules": { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "DefaultSecurityRules_List", + "description": "Gets all default security rules in a network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of SecurityRule resources.", + "schema": { + "$ref": "#/definitions/SecurityRuleListResult" + } + } + }, + "x-ms-examples": { + "DefaultSecurityRuleList": { "$ref": "./examples/DefaultSecurityRuleList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules/{defaultSecurityRuleName}" : { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "DefaultSecurityRules_Get", + "description": "Get the specified default network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "defaultSecurityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the default security rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + } + }, + "x-ms-examples": { + "DefaultSecurityRuleGet": { "$ref": "./examples/DefaultSecurityRuleGet.json" } + } + } + } + }, + "definitions": { + "SecurityRulePropertiesFormat": { + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "protocol": { + "type": "string", + "description": "Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.", + "enum": [ + "Tcp", + "Udp", + "*" + ], + "x-ms-enum": { + "name": "SecurityRuleProtocol", + "modelAsString": true + } + }, + "sourcePortRange": { + "type": "string", + "description": "The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." + }, + "destinationPortRange": { + "type": "string", + "description": "The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. " + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR or source IP ranges." + }, + "sourceApplicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "The application security group specified as source." + }, + "destinationAddressPrefix": { + "type": "string", + "description": "The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "destinationApplicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "The application security group specified as destination." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The source port." + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The destination port." + }, + "description": "The destination port ranges." + }, + "access": { + "type": "string", + "description": "The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "SecurityRuleAccess", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule." + }, + "direction": { + "type": "string", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "SecurityRuleDirection", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "protocol", + "access", + "direction" + ], + "description": "Security rule resource." + }, + "SecurityRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityRulePropertiesFormat", + "description": "Properties of the security rule" + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Network security rule." + }, + "SecurityRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "The security rules in a network security group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSecurityRule API service call. Retrieves all security rules that belongs to a network security group." + }, + "NetworkSecurityGroupPropertiesFormat": { + "properties": { + "securityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "A collection of security rules of the network security group." + }, + "defaultSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "The default security rules of network security group." + }, + "networkInterfaces": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "description": "A collection of references to network interfaces." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualNetwork.json#/definitions/Subnet" + }, + "description": "A collection of references to subnets." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the network security group resource." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Network Security Group resource." + }, + "NetworkSecurityGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat", + "description": "Properties of the network security group" + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "NetworkSecurityGroup resource." + }, + "NetworkSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityGroup" + }, + "description": "A list of NetworkSecurityGroup resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListNetworkSecurityGroups API service call." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/networkWatcher.json new file mode 100644 index 000000000000..e18511ce20d3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/networkWatcher.json @@ -0,0 +1,3169 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}": { + "put": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_CreateOrUpdate", + "description": "Creates or updates a network watcher in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkWatcher" + }, + "description": "Parameters that define the network watcher resource." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + } + }, + "x-ms-examples": { + "Create network watcher": { "$ref": "./examples/NetworkWatcherCreate.json" } + } + }, + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_Get", + "description": "Gets the specified network watcher by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + } + }, + "x-ms-examples": { + "Get network watcher": { "$ref": "./examples/NetworkWatcherGet.json" } + } + }, + "delete": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_Delete", + "x-ms-long-running-operation": true, + "description": "Deletes the specified network watcher resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "Delete network watcher": { "$ref": "./examples/NetworkWatcherDelete.json" } + } + }, + "patch": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_UpdateTags", + "description": "Updates a network watcher tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network watcher tags." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + } + }, + "x-ms-examples": { + "Update network watcher tags": { "$ref": "./examples/NetworkWatcherUpdateTags.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers": { + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_List", + "description": "Gets all network watchers by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of network watcher resources.", + "schema": { + "$ref": "#/definitions/NetworkWatcherListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List network watchers": { "$ref": "./examples/NetworkWatcherList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkWatchers": { + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_ListAll", + "description": "Gets all network watchers by subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of network watcher resources.", + "schema": { + "$ref": "#/definitions/NetworkWatcherListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List all network watchers": { "$ref": "./examples/NetworkWatcherListAll.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/topology": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTopology", + "description": "Gets the current network topology by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TopologyParameters" + }, + "description": "Parameters that define the representation of topology." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the topology of resource group.", + "schema": { + "$ref": "#/definitions/Topology" + } + } + }, + "x-ms-examples": { + "Get Topology": { + "$ref": "./examples/NetworkWatcherTopologyGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/ipFlowVerify": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_VerifyIPFlow", + "x-ms-long-running-operation": true, + "description": "Verify IP flow from the specified VM to a location given the currently configured NSG rules.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VerificationIPFlowParameters" + }, + "description": "Parameters that define the IP flow to be verified." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the result of IP flow verification.", + "schema": { + "$ref": "#/definitions/VerificationIPFlowResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/VerificationIPFlowResult" + } + } + }, + "x-ms-examples": { + "Ip flow verify": { "$ref": "./examples/NetworkWatcherIpFlowVerify.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/nextHop": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetNextHop", + "x-ms-long-running-operation": true, + "description": "Gets the next hop from the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NextHopParameters" + }, + "description": "Parameters that define the source and destination endpoint." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the next hop from the VM.", + "schema": { + "$ref": "#/definitions/NextHopResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NextHopResult" + } + } + }, + "x-ms-examples": { + "Get next hop": { "$ref": "./examples/NetworkWatcherNextHopGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/securityGroupView": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetVMSecurityRules", + "x-ms-long-running-operation": true, + "description": "Gets the configured and effective security group rules on the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityGroupViewParameters" + }, + "description": "Parameters that define the VM to check security groups for." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns security group rules on the VM.", + "schema": { + "$ref": "#/definitions/SecurityGroupViewResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/SecurityGroupViewResult" + } + } + }, + "x-ms-examples": { + "Get security group view": { "$ref": "./examples/NetworkWatcherSecurityGroupViewGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}": { + "put": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Create", + "x-ms-long-running-operation": true, + "description": "Create and start a packet capture on the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PacketCapture" + }, + "description": "Parameters that define the create packet capture operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request successful. The operation returns the resulting packet capture session.", + "schema": { + "$ref": "#/definitions/PacketCaptureResult" + } + } + }, + "x-ms-examples": { + "Create packet capture": { "$ref": "./examples/NetworkWatcherPacketCaptureCreate.json" } + } + }, + "get": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Get", + "description": "Gets a packet capture session by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a packet capture session.", + "schema": { + "$ref": "#/definitions/PacketCaptureResult" + } + } + }, + "x-ms-examples": { + "Get packet capture": { "$ref": "./examples/NetworkWatcherPacketCaptureGet.json" } + } + }, + "delete": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Delete", + "x-ms-long-running-operation": true, + "description": "Deletes the specified packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "Delete packet capture": { "$ref": "./examples/NetworkWatcherPacketCaptureDelete.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/stop": { + "post": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Stop", + "x-ms-long-running-operation": true, + "description": "Stops a specified packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the packet capture session." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "Stop packet capture": { "$ref": "./examples/NetworkWatcherPacketCaptureStop.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/queryStatus": { + "post": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_GetStatus", + "x-ms-long-running-operation": true, + "description": "Query the status of a running packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name given to the packet capture session." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful query of packet capture status.", + "schema": { + "$ref": "#/definitions/PacketCaptureQueryStatusResult" + } + }, + "202": { + "description": "Accepted query status of packet capture.", + "schema": { + "$ref": "#/definitions/PacketCaptureQueryStatusResult" + } + } + }, + "x-ms-examples": { + "Query packet capture status": { "$ref": "./examples/NetworkWatcherPacketCaptureQueryStatus.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures": { + "get": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_List", + "description": "Lists all packet capture sessions within the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful packet capture enumeration request.", + "schema": { + "$ref": "#/definitions/PacketCaptureListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List packet captures": { "$ref": "./examples/NetworkWatcherPacketCapturesList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/troubleshoot": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTroubleshooting", + "x-ms-long-running-operation": true, + "description": "Initiate troubleshooting on a specified resource", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TroubleshootingParameters" + }, + "description": "Parameters that define the resource to troubleshoot." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful troubleshooting request", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "202": { + "description": "Accepted get troubleshooting request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + } + }, + "x-ms-examples": { + "Get troubleshooting": { "$ref": "./examples/NetworkWatcherTroubleshootGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryTroubleshootResult": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTroubleshootingResult", + "x-ms-long-running-operation": true, + "description": "Get the last completed troubleshooting result on a specified resource", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryTroubleshootingParameters" + }, + "description": "Parameters that define the resource to query the troubleshooting result." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful get troubleshooting result request", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "202": { + "description": "Accepted get troubleshooting result request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + } + }, + "x-ms-examples": { + "Get troubleshoot result": { "$ref": "./examples/NetworkWatcherTroubleshootResultQuery.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/configureFlowLog": { + "post": { + "tags": [ + "NetworkWatchers", + "TrafficAnalytics" + ], + "operationId": "NetworkWatchers_SetFlowLogConfiguration", + "x-ms-long-running-operation": true, + "description": "Configures flow log and traffic analytics (optional) on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlowLogInformation" + }, + "description": "Parameters that define the configuration of flow log." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for setting flow log and traffic analytics (optional) configuration.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + } + }, + "x-ms-examples": { + "Configure flow log": { "$ref": "./examples/NetworkWatcherFlowLogConfigure.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryFlowLogStatus": { + "post": { + "tags": [ + "NetworkWatchers", + "TrafficAnalytics" + ], + "operationId": "NetworkWatchers_GetFlowLogStatus", + "x-ms-long-running-operation": true, + "description": "Queries status of flow log and traffic analytics (optional) on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlowLogStatusParameters" + }, + "description": "Parameters that define a resource to query flow log and traffic analytics (optional) status." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for query flow log and traffic analytics (optional) status.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + } + }, + "x-ms-examples": { + "Get flow log status": { "$ref": "./examples/NetworkWatcherFlowLogStatusQuery.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectivityCheck": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_CheckConnectivity", + "x-ms-long-running-operation": true, + "description": "Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectivityParameters" + }, + "description": "Parameters that determine how the connectivity check will be performed." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for checking connectivity.", + "schema": { + "$ref": "#/definitions/ConnectivityInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ConnectivityInformation" + } + } + }, + "x-ms-examples": { + "Check connectivity": { "$ref": "./examples/NetworkWatcherConnectivityCheck.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/azureReachabilityReport": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetAzureReachabilityReport", + "x-ms-long-running-operation": true, + "description": "Gets the relative latency score for internet service providers from a specified location to Azure regions.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AzureReachabilityReportParameters" + }, + "description": "Parameters that determine Azure reachability report configuration." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for Azure reachability report.", + "schema": { + "$ref": "#/definitions/AzureReachabilityReport" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AzureReachabilityReport" + } + } + }, + "x-ms-examples": { + "Get Azure Reachability Report": { + "$ref": "./examples/NetworkWatcherAzureReachabilityReportGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/availableProvidersList": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_ListAvailableProviders", + "x-ms-long-running-operation": true, + "description": "Lists all available internet service providers for a specified Azure region.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailableProvidersListParameters" + }, + "description": "Parameters that scope the list of available providers." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for list of available providers.", + "schema": { + "$ref": "#/definitions/AvailableProvidersList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AvailableProvidersList" + } + } + }, + "x-ms-examples": { + "Get Available Providers List": { + "$ref": "./examples/NetworkWatcherAvailableProvidersListGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}": { + "put": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_CreateOrUpdate", + "x-ms-long-running-operation": true, + "description": "Create or update a connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionMonitor" + }, + "description": "Parameters that define the operation to create a connection monitor." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + } + }, + "x-ms-examples": { + "Create connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorCreate.json" } + } + }, + "get": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Get", + "description": "Gets a connection monitor by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a connection monitor.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + } + }, + "x-ms-examples": { + "Get connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorGet.json" } + } + }, + "delete": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Delete", + "x-ms-long-running-operation": true, + "description": "Deletes the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + } + }, + "x-ms-examples": { + "Delete connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorDelete.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/stop": { + "post": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Stop", + "x-ms-long-running-operation": true, + "description": "Stops the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the connection monitor." + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + } + }, + "x-ms-examples": { + "Stop connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorStop.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/start": { + "post": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Start", + "x-ms-long-running-operation": true, + "description": "Starts the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation starts the connection monitor." + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + } + }, + "x-ms-examples": { + "Start connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorStart.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/query": { + "post": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Query", + "x-ms-long-running-operation": true, + "description": "Query a snapshot of the most recent connection states.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name given to the connection monitor." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful query of connection states.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorQueryResult" + } + }, + "202": { + "description": "Accepted query of connection states.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorQueryResult" + } + } + }, + "x-ms-examples": { + "Query connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorQuery.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors": { + "get": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_List", + "description": "Lists all connection monitors for the specified Network Watcher.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful connection monitor enumeration request.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List connection monitors": { "$ref": "./examples/NetworkWatcherConnectionMonitorList.json" } + } + } + } + }, + "definitions": { + "NetworkWatcher": { + "properties": { + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkWatcherPropertiesFormat" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Network watcher in a resource group." + }, + "NetworkWatcherPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The provisioning state of the resource." + } + }, + "description": "The network watcher properties." + }, + "NetworkWatcherListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkWatcher" + } + } + }, + "description": "List of network watcher resources." + }, + "TopologyParameters": { + "properties": { + "targetResourceGroupName": { + "type": "string", + "description": "The name of the target resource group to perform topology on." + }, + "targetVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of the Virtual Network resource." + }, + "targetSubnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of the Subnet resource." + } + }, + "description": "Parameters that define the representation of topology." + }, + "Topology": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "GUID representing the operation id." + }, + "createdDateTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The datetime when the topology was initially created for the resource group." + }, + "lastModified": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The datetime when the topology was last modified." + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/TopologyResource" + } + } + }, + "description": "Topology of the specified resource group." + }, + "TopologyResource": { + "properties": { + "name": { + "type": "string", + "description": "Name of the resource." + }, + "id": { + "type": "string", + "description": "ID of the resource." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "associations": { + "type": "array", + "description": "Holds the associations the resource has with other resources in the resource group.", + "items": { + "$ref": "#/definitions/TopologyAssociation" + } + } + }, + "description": "The network resource topology information for the given resource group." + }, + "TopologyAssociation": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource that is associated with the parent resource." + }, + "resourceId": { + "type": "string", + "description": "The ID of the resource that is associated with the parent resource." + }, + "associationType": { + "type": "string", + "enum": [ + "Associated", + "Contains" + ], + "x-ms-enum": { + "name": "AssociationType", + "modelAsString": true + }, + "description": "The association type of the child resource to the parent resource." + } + }, + "description": "Resources that have an association with the parent resource." + }, + "VerificationIPFlowParameters": { + "description": "Parameters that define the IP flow to be verified.", + "required": [ + "targetResourceId", + "direction", + "protocol", + "localPort", + "remotePort", + "localIPAddress", + "remoteIPAddress" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "The ID of the target resource to perform next-hop on." + }, + "direction": { + "type": "string", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true + }, + "description": "The direction of the packet represented as a 5-tuple." + }, + "protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "IpFlowProtocol", + "modelAsString": true + }, + "description": "Protocol to be verified on." + }, + "localPort": { + "type": "string", + "description": "The local port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction." + }, + "remotePort": { + "type": "string", + "description": "The remote port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction." + }, + "localIPAddress": { + "type": "string", + "description": "The local IP address. Acceptable values are valid IPv4 addresses." + }, + "remoteIPAddress": { + "type": "string", + "description": "The remote IP address. Acceptable values are valid IPv4 addresses." + }, + "targetNicResourceId": { + "type": "string", + "description": "The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of them, then this parameter must be specified. Otherwise optional)." + } + } + }, + "VerificationIPFlowResult": { + "description": "Results of IP flow verification on the target resource.", + "properties": { + "access": { + "type": "string", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "Access", + "modelAsString": true + }, + "description": "Indicates whether the traffic is allowed or denied." + }, + "ruleName": { + "type": "string", + "description": "Name of the rule. If input is not matched against any security rule, it is not displayed." + } + } + }, + "NextHopParameters": { + "description": "Parameters that define the source and destination endpoint.", + "required": [ + "targetResourceId", + "sourceIPAddress", + "destinationIPAddress" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "The resource identifier of the target resource against which the action is to be performed." + }, + "sourceIPAddress": { + "type": "string", + "description": "The source IP address." + }, + "destinationIPAddress": { + "type": "string", + "description": "The destination IP address." + }, + "targetNicResourceId": { + "type": "string", + "description": "The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of the nics, then this parameter must be specified. Otherwise optional)." + } + } + }, + "NextHopResult": { + "description": "The information about next hop from the specified VM.", + "properties": { + "nextHopType": { + "type": "string", + "enum": [ + "Internet", + "VirtualAppliance", + "VirtualNetworkGateway", + "VnetLocal", + "HyperNetGateway", + "None" + ], + "x-ms-enum": { + "name": "NextHopType", + "modelAsString": true + }, + "description": "Next hop type." + }, + "nextHopIpAddress": { + "type": "string", + "description": "Next hop IP Address" + }, + "routeTableId": { + "type": "string", + "description": "The resource identifier for the route table associated with the route being returned. If the route being returned does not correspond to any user created routes then this field will be the string 'System Route'." + } + } + }, + "SecurityGroupViewParameters": { + "description": "Parameters that define the VM to check security groups for.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "ID of the target VM." + } + } + }, + "SecurityGroupViewResult": { + "description": "The information about security rules applied to the specified VM.", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "List of network interfaces on the specified VM.", + "items": { + "$ref": "#/definitions/SecurityGroupNetworkInterface" + } + } + } + }, + "SecurityGroupNetworkInterface": { + "description": "Network interface and all its associated security rules.", + "properties": { + "id": { + "type": "string", + "description": "ID of the network interface." + }, + "securityRuleAssociations": { + "$ref": "#/definitions/SecurityRuleAssociations" + } + } + }, + "SecurityRuleAssociations": { + "description": "All security rules associated with the network interface.", + "properties": { + "networkInterfaceAssociation": { + "$ref": "#/definitions/NetworkInterfaceAssociation" + }, + "subnetAssociation": { + "$ref": "#/definitions/SubnetAssociation" + }, + "defaultSecurityRules": { + "type": "array", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + }, + "description": "Collection of default security rules of the network security group." + }, + "effectiveSecurityRules": { + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/EffectiveNetworkSecurityRule" + }, + "description": "Collection of effective security rules." + } + } + }, + "NetworkInterfaceAssociation": { + "description": "Network interface and its custom security rules.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Network interface ID." + }, + "securityRules": { + "type": "array", + "description": "Collection of custom security rules.", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + } + } + } + }, + "SubnetAssociation": { + "description": "Network interface and its custom security rules.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Subnet ID." + }, + "securityRules": { + "type": "array", + "description": "Collection of custom security rules.", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + } + } + } + }, + "PacketCapture": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PacketCaptureParameters" + } + }, + "required": [ + "properties" + ], + "description": "Parameters that define the create packet capture operation." + }, + "PacketCaptureParameters": { + "properties": { + "target": { + "type": "string", + "description": "The ID of the targeted resource, only VM is currently supported." + }, + "bytesToCapturePerPacket": { + "type": "integer", + "default": 0, + "description": "Number of bytes captured per packet, the remaining bytes are truncated." + }, + "totalBytesPerSession": { + "type": "integer", + "default": 1073741824, + "description": "Maximum size of the capture output." + }, + "timeLimitInSeconds": { + "type": "integer", + "default": 18000, + "description": "Maximum duration of the capture session in seconds." + }, + "storageLocation": { + "$ref": "#/definitions/PacketCaptureStorageLocation" + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/definitions/PacketCaptureFilter" + } + } + }, + "required": [ + "target", + "storageLocation" + ], + "description": "Parameters that define the create packet capture operation." + }, + "PacketCaptureStorageLocation": { + "properties": { + "storageId": { + "type": "string", + "description": "The ID of the storage account to save the packet capture session. Required if no local file path is provided." + }, + "storagePath": { + "type": "string", + "description": "The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture." + }, + "filePath": { + "type": "string", + "description": "A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional." + } + }, + "description": "Describes the storage location for a packet capture session." + }, + "PacketCaptureFilter": { + "properties": { + "protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP", + "Any" + ], + "x-ms-enum": { + "name": "PcProtocol", + "modelAsString": true + }, + "default": "Any", + "description": "Protocol to be filtered on." + }, + "localIPAddress": { + "type": "string", + "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5\"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "remoteIPAddress": { + "type": "string", + "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "localPort": { + "type": "string", + "description": "Local port to be filtered on. Notation: \"80\" for single port entry.\"80-85\" for range. \"80;443;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "remotePort": { + "type": "string", + "description": "Remote port to be filtered on. Notation: \"80\" for single port entry.\"80-85\" for range. \"80;443;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + } + }, + "description": "Filter that is applied to packet capture request. Multiple filters can be applied." + }, + "PacketCaptureListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PacketCaptureResult" + }, + "description": "Information about packet capture sessions." + } + }, + "description": "List of packet capture sessions." + }, + "PacketCaptureResult": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the packet capture session." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "ID of the packet capture operation." + }, + "etag": { + "type": "string", + "default": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PacketCaptureResultProperties" + } + }, + "description": "Information about packet capture session." + }, + "PacketCaptureResultProperties": { + "properties": { + "provisioningState": { + "type": "string", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The provisioning state of the packet capture session." + } + }, + "allOf": [ + { + "$ref": "#/definitions/PacketCaptureParameters" + } + ], + "description": "Describes the properties of a packet capture session." + }, + "PacketCaptureQueryStatusResult": { + "properties": { + "name": { + "type": "string", + "description": "The name of the packet capture resource." + }, + "id": { + "type": "string", + "description": "The ID of the packet capture resource." + }, + "captureStartTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the packet capture session." + }, + "packetCaptureStatus": { + "type": "string", + "enum": [ + "NotStarted", + "Running", + "Stopped", + "Error", + "Unknown" + ], + "x-ms-enum": { + "name": "PcStatus", + "modelAsString": true + }, + "description": "The status of the packet capture session." + }, + "stopReason": { + "type": "string", + "description": "The reason the current packet capture session was stopped." + }, + "packetCaptureError": { + "type": "array", + "description": "List of errors of packet capture session.", + "items": { + "type": "string", + "enum": [ + "InternalError", + "AgentStopped", + "CaptureFailed", + "LocalFileFailed", + "StorageFailed" + ], + "x-ms-enum": { + "name": "PcError", + "modelAsString": true + } + } + } + }, + "description": "Status of packet capture session." + }, + "TroubleshootingParameters": { + "description": "Parameters that define the resource to troubleshoot.", + "required": [ + "targetResourceId", + "properties" + ], + "properties": { + "targetResourceId": { + "description": "The target resource to troubleshoot.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TroubleshootingProperties" + } + } + }, + "QueryTroubleshootingParameters": { + "description": "Parameters that define the resource to query the troubleshooting result.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "description": "The target resource ID to query the troubleshooting result.", + "type": "string" + } + } + }, + "TroubleshootingProperties": { + "description": "Storage location provided for troubleshoot.", + "required": [ + "storageId", + "storagePath" + ], + "properties": { + "storageId": { + "description": "The ID for the storage account to save the troubleshoot result.", + "type": "string" + }, + "storagePath": { + "description": "The path to the blob to save the troubleshoot result in.", + "type": "string" + } + } + }, + "TroubleshootingResult": { + "description": "Troubleshooting information gained from specified resource.", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the troubleshooting." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the troubleshooting." + }, + "code": { + "type": "string", + "description": "The result code of the troubleshooting." + }, + "results": { + "type": "array", + "description": "Information from troubleshooting.", + "items": { + "$ref": "#/definitions/TroubleshootingDetails" + } + } + } + }, + "TroubleshootingDetails": { + "description": "Information gained from troubleshooting of specified resource.", + "properties": { + "id": { + "type": "string", + "description": "The id of the get troubleshoot operation." + }, + "reasonType": { + "type": "string", + "description": "Reason type of failure." + }, + "summary": { + "type": "string", + "description": "A summary of troubleshooting." + }, + "detail": { + "type": "string", + "description": "Details on troubleshooting results." + }, + "recommendedActions": { + "type": "array", + "description": "List of recommended actions.", + "items": { + "$ref": "#/definitions/TroubleshootingRecommendedActions" + } + } + } + }, + "TroubleshootingRecommendedActions": { + "description": "Recommended actions based on discovered issues.", + "properties": { + "actionId": { + "description": "ID of the recommended action.", + "type": "string" + }, + "actionText": { + "description": "Description of recommended actions.", + "type": "string" + }, + "actionUri": { + "description": "The uri linking to a documentation for the recommended troubleshooting actions.", + "type": "string" + }, + "actionUriText": { + "description": "The information from the URI for the recommended troubleshooting actions.", + "type": "string" + } + } + }, + "FlowLogProperties": { + "description": "Parameters that define the configuration of flow log.", + "required": [ + "storageId", + "enabled" + ], + "properties": { + "storageId": { + "description": "ID of the storage account which is used to store the flow log.", + "type": "string" + }, + "enabled": { + "description": "Flag to enable/disable flow logging.", + "type": "boolean" + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicyParameters" + } + } + }, + "FlowLogStatusParameters": { + "description": "Parameters that define a resource to query flow log and traffic analytics (optional) status.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "description": "The target resource where getting the flow log and traffic analytics (optional) status.", + "type": "string" + } + } + }, + "RetentionPolicyParameters": { + "description": "Parameters that define the retention policy for flow log.", + "properties": { + "days": { + "description": "Number of days to retain flow log records.", + "type": "integer", + "default": 0 + }, + "enabled": { + "description": "Flag to enable/disable retention.", + "type": "boolean", + "default": false + } + } + }, + "FlowLogInformation": { + "description": "Information on the configuration of flow log and traffic analytics (optional) .", + "required": [ + "targetResourceId", + "properties" + ], + "properties": { + "targetResourceId": { + "description": "The ID of the resource to configure for flow log and traffic analytics (optional) .", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FlowLogProperties" + }, + "flowAnalyticsConfiguration": { + "$ref": "#/definitions/TrafficAnalyticsProperties" + } + } + }, + "TrafficAnalyticsProperties": { + "description": "Parameters that define the configuration of traffic analytics.", + "required": [ + "networkWatcherFlowAnalyticsConfiguration" + ], + "properties": { + "networkWatcherFlowAnalyticsConfiguration": { + "$ref": "#/definitions/TrafficAnalyticsConfigurationProperties" + } + } + }, + "TrafficAnalyticsConfigurationProperties": { + "description": "Parameters that define the configuration of traffic analytics.", + "required": [ + "enabled", + "workspaceId", + "workspaceRegion", + "workspaceResourceId" + ], + "properties": { + "enabled": { + "description": "Flag to enable/disable traffic analytics.", + "type": "boolean" + }, + "workspaceId": { + "description": "The resource guid of the attached workspace", + "type": "string" + }, + "workspaceRegion": { + "description": "The location of the attached workspace", + "type": "string" + }, + "workspaceResourceId": { + "description": "Resource Id of the attached workspace ", + "type": "string" + } + } + }, + "ConnectivityParameters": { + "description": "Parameters that determine how the connectivity check will be performed.", + "required": [ + "source", + "destination" + ], + "properties": { + "source": { + "$ref": "#/definitions/ConnectivitySource" + }, + "destination": { + "$ref": "#/definitions/ConnectivityDestination" + }, + "protocol": { + "type": "string", + "description": "Network protocol.", + "enum": [ + "Tcp", + "Http", + "Https", + "Icmp" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true + } + }, + "protocolConfiguration": { + "$ref": "#/definitions/ProtocolConfiguration" + } + } + }, + "ConnectivitySource": { + "description": "Parameters that define the source of the connection.", + "required": [ + "resourceId" + ], + "properties": { + "resourceId": { + "description": "The ID of the resource from which a connectivity check will be initiated.", + "type": "string" + }, + "port": { + "description": "The source port from which a connectivity check will be performed.", + "type": "integer" + } + } + }, + "ConnectivityDestination": { + "description": "Parameters that define destination of connection.", + "properties": { + "resourceId": { + "description": "The ID of the resource to which a connection attempt will be made.", + "type": "string" + }, + "address": { + "description": "The IP address or URI the resource to which a connection attempt will be made.", + "type": "string" + }, + "port": { + "description": "Port on which check connectivity will be performed.", + "type": "integer" + } + } + }, + "ConnectivityInformation": { + "description": "Information on the connectivity status.", + "properties": { + "hops": { + "readOnly": true, + "type": "array", + "description": "List of hops between the source and the destination.", + "items": { + "$ref": "#/definitions/ConnectivityHop" + } + }, + "connectionStatus": { + "readOnly": true, + "type": "string", + "enum": [ + "Unknown", + "Connected", + "Disconnected", + "Degraded" + ], + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + }, + "description": "The connection status." + }, + "avgLatencyInMs": { + "description": "Average latency in milliseconds.", + "readOnly": true, + "type": "integer" + }, + "minLatencyInMs": { + "description": "Minimum latency in milliseconds.", + "readOnly": true, + "type": "integer" + }, + "maxLatencyInMs": { + "description": "Maximum latency in milliseconds.", + "readOnly": true, + "type": "integer" + }, + "probesSent": { + "description": "Total number of probes sent.", + "readOnly": true, + "type": "integer" + }, + "probesFailed": { + "description": "Number of failed probes.", + "readOnly": true, + "type": "integer" + } + } + }, + "ConnectivityHop": { + "description": "Information about a hop between the source and the destination.", + "properties": { + "type": { + "description": "The type of the hop.", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The ID of the hop.", + "readOnly": true, + "type": "string" + }, + "address": { + "description": "The IP address of the hop.", + "readOnly": true, + "type": "string" + }, + "resourceId": { + "description": "The ID of the resource corresponding to this hop.", + "readOnly": true, + "type": "string" + }, + "nextHopIds": { + "readOnly": true, + "type": "array", + "description": "List of next hop identifiers.", + "items": { + "type": "string" + } + }, + "issues": { + "readOnly": true, + "type": "array", + "description": "List of issues.", + "items": { + "$ref": "#/definitions/ConnectivityIssue" + } + } + } + }, + "ConnectivityIssue": { + "description": "Information about an issue encountered in the process of checking for connectivity.", + "properties": { + "origin": { + "readOnly": true, + "type": "string", + "enum": [ + "Local", + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true + }, + "description": "The origin of the issue." + }, + "severity": { + "readOnly": true, + "type": "string", + "enum": [ + "Error", + "Warning" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + }, + "description": "The severity of the issue." + }, + "type": { + "readOnly": true, + "type": "string", + "enum": [ + "Unknown", + "AgentStopped", + "GuestFirewall", + "DnsResolution", + "SocketBind", + "NetworkSecurityRule", + "UserDefinedRoute", + "PortThrottled", + "Platform" + ], + "x-ms-enum": { + "name": "IssueType", + "modelAsString": true + }, + "description": "The type of issue." + }, + "context": { + "readOnly": true, + "type": "array", + "description": "Provides additional context on the issue.", + "items": { + "$ref": "#/definitions/IssueContext" + } + } + } + }, + "IssueContext": { + "description": "A key-value pair that provides additional context on the issue.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "ProtocolConfiguration": { + "description": "Configuration of the protocol.", + "properties": { + "HTTPConfiguration": { + "$ref": "#/definitions/HTTPConfiguration" + } + } + }, + "HTTPConfiguration": { + "properties": { + "method": { + "type": "string", + "description": "HTTP method.", + "enum": [ + "Get" + ], + "x-ms-enum": { + "name": "HTTPMethod", + "modelAsString": true + } + }, + "headers": { + "type": "array", + "description": "List of HTTP headers.", + "items": { + "$ref": "#/definitions/HTTPHeader" + } + }, + "validStatusCodes": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Valid status codes." + } + }, + "description": "HTTP configuration of the connectivity check." + }, + "HTTPHeader": { + "properties": { + "name": { + "type": "string", + "description": "The name in HTTP header." + }, + "value": { + "type": "string", + "description": "The value in HTTP header." + } + }, + "description": "Describes the HTTP header." + }, + "AzureReachabilityReportParameters": { + "properties": { + "providerLocation": { + "$ref": "#/definitions/AzureReachabilityReportLocation" + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Internet service providers." + }, + "azureLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional Azure regions to scope the query to." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the Azure reachability report." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the Azure reachability report." + } + }, + "required": [ + "providerLocation", + "startTime", + "endTime" + ], + "description": "Geographic and time constraints for Azure reachability report." + }, + "AzureReachabilityReportLocation": { + "properties": { + "country": { + "type": "string", + "description": "The name of the country." + }, + "state": { + "type": "string", + "description": "The name of the state." + }, + "city": { + "type": "string", + "description": "The name of the city or town." + } + }, + "required": [ + "country" + ], + "description": "Parameters that define a geographic location." + }, + "AzureReachabilityReport": { + "properties": { + "aggregationLevel": { + "type": "string", + "description": "The aggregation level of Azure reachability report. Can be Country, State or City." + }, + "providerLocation": { + "$ref": "#/definitions/AzureReachabilityReportLocation" + }, + "reachabilityReport": { + "type": "array", + "description": "List of Azure reachability report items.", + "items": { + "$ref": "#/definitions/AzureReachabilityReportItem" + } + } + }, + "required": [ + "aggregationLevel", + "providerLocation", + "reachabilityReport" + ], + "description": "Azure reachability report details." + }, + "AzureReachabilityReportItem": { + "properties": { + "provider": { + "type": "string", + "description": "The Internet service provider." + }, + "azureLocation": { + "type": "string", + "description": "The Azure region." + }, + "latencies": { + "type": "array", + "description": "List of latency details for each of the time series.", + "items": { + "$ref": "#/definitions/AzureReachabilityReportLatencyInfo" + } + } + }, + "description": "Azure reachability report details for a given provider location." + }, + "AzureReachabilityReportLatencyInfo": { + "properties": { + "timeStamp": { + "type": "string", + "format": "date-time", + "description": "The time stamp." + }, + "score": { + "type": "integer", + "description": "The relative latency score between 1 and 100, higher values indicating a faster connection.", + "minimum": 1, + "maximum": 100 + } + }, + "description": "Details on latency for a time series." + }, + "AvailableProvidersListParameters": { + "properties": { + "azureLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Azure regions." + }, + "country": { + "type": "string", + "description": "The country for available providers list." + }, + "state": { + "type": "string", + "description": "The state for available providers list." + }, + "city": { + "type": "string", + "description": "The city or town for available providers list." + } + }, + "description": "Constraints that determine the list of available Internet service providers." + }, + "AvailableProvidersList": { + "properties": { + "countries": { + "type": "array", + "description": "List of available countries.", + "items": { + "$ref": "#/definitions/AvailableProvidersListCountry" + } + } + }, + "required": [ + "countries" + ], + "description": "List of available countries with details." + }, + "AvailableProvidersListCountry": { + "properties": { + "countryName": { + "type": "string", + "description": "The country name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + }, + "states": { + "type": "array", + "description": "List of available states in the country.", + "items": { + "$ref": "#/definitions/AvailableProvidersListState" + } + } + }, + "description": "Country details." + }, + "AvailableProvidersListState": { + "properties": { + "stateName": { + "type": "string", + "description": "The state name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + }, + "cities": { + "type": "array", + "description": "List of available cities or towns in the state.", + "items": { + "$ref": "#/definitions/AvailableProvidersListCity" + } + } + }, + "description": "State details." + }, + "AvailableProvidersListCity": { + "properties": { + "cityName": { + "type": "string", + "description": "The city or town name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + } + }, + "description": "City or town details." + }, + "ConnectionMonitor": { + "properties": { + "location": { + "type": "string", + "description": "Connection monitor location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Connection monitor tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectionMonitorParameters" + } + }, + "required": [ + "properties" + ], + "description": "Parameters that define the operation to create a connection monitor." + }, + "ConnectionMonitorParameters": { + "properties": { + "source": { + "$ref": "#/definitions/ConnectionMonitorSource" + }, + "destination": { + "$ref": "#/definitions/ConnectionMonitorDestination" + }, + "autoStart": { + "type": "boolean", + "default": true, + "description": "Determines if the connection monitor will start automatically once created." + }, + "monitoringIntervalInSeconds": { + "type": "integer", + "default": 60, + "description": "Monitoring interval in seconds." + } + }, + "required": [ + "source", + "destination" + ], + "description": "Parameters that define the operation to create a connection monitor." + }, + "ConnectionMonitorSource": { + "properties": { + "resourceId": { + "type": "string", + "description": "The ID of the resource used as the source by connection monitor." + }, + "port": { + "type": "integer", + "description": "The source port used by connection monitor." + } + }, + "required": [ + "resourceId" + ], + "description": "Describes the source of connection monitor." + }, + "ConnectionMonitorDestination": { + "properties": { + "resourceId": { + "type": "string", + "description": "The ID of the resource used as the destination by connection monitor." + }, + "address": { + "type": "string", + "description": "Address of the connection monitor destination (IP or domain name)." + }, + "port": { + "type": "integer", + "description": "The destination port used by connection monitor." + } + }, + "description": "Describes the destination of connection monitor." + }, + "ConnectionMonitorListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionMonitorResult" + }, + "description": "Information about connection monitors." + } + }, + "description": "List of connection monitors." + }, + "ConnectionMonitorResult": { + "x-ms-azure-resource": true, + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the connection monitor." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "ID of the connection monitor." + }, + "etag": { + "type": "string", + "default": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Connection monitor type." + }, + "location": { + "type": "string", + "description": "Connection monitor location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Connection monitor tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectionMonitorResultProperties" + } + }, + "description": "Information about the connection monitor." + }, + "ConnectionMonitorResultProperties": { + "properties": { + "provisioningState": { + "type": "string", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The provisioning state of the connection monitor." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the connection monitor was started." + }, + "monitoringStatus": { + "type": "string", + "description": "The monitoring status of the connection monitor." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionMonitorParameters" + } + ], + "description": "Describes the properties of a connection monitor." + }, + "ConnectionMonitorQueryResult": { + "properties": { + "sourceStatus": { + "type": "string", + "enum": [ + "Uknown", + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "ConnectionMonitorSourceStatus", + "modelAsString": true + }, + "description": "Status of connection monitor source." + }, + "states": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionStateSnapshot" + }, + "description": "Information about connection states." + } + }, + "description": "List of connection states snaphots." + }, + "ConnectionStateSnapshot": { + "properties": { + "connectionState": { + "type": "string", + "enum": [ + "Reachable", + "Unreachable", + "Unknown" + ], + "x-ms-enum": { + "name": "ConnectionState", + "modelAsString": true + }, + "description": "The connection state." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the connection snapshot." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the connection snapshot." + }, + "evaluationState": { + "type": "string", + "enum": [ + "NotStarted", + "InProgress", + "Completed" + ], + "x-ms-enum": { + "name": "EvaluationState", + "modelAsString": true + }, + "description": "Connectivity analysis evaluation state." + }, + "hops": { + "readOnly": true, + "type": "array", + "description": "List of hops between the source and the destination.", + "items": { + "$ref": "#/definitions/ConnectivityHop" + } + } + }, + "description": "Connection state snapshot." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/operation.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/operation.json new file mode 100644 index 000000000000..4e095ff89155 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/operation.json @@ -0,0 +1,279 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Network/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists all of the available Network Rest API operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of operations for a resource provider": { "$ref": "./examples/OperationList.json" } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Network 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 Network operations supported by the Network resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "Network REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Network.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of the operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation.", + "type": "string" + } + } + }, + "origin": { + "description": "Origin of the operation.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationPropertiesFormat", + "description": "Operation properties format." + } + } + }, + "OperationPropertiesFormat": { + "description": "Description of operation properties format.", + "properties": { + "serviceSpecification": { + "description": "Specification of the service.", + "properties": { + "metricSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "description": "Operation service specification." + }, + "logSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "description": "Operation log specification." + } + } + } + } + }, + "LogSpecification": { + "description": "Description of logging specification.", + "properties": { + "name": { + "type": "string", + "description": "The name of the specification." + }, + "displayName": { + "type": "string", + "description": "The display name of the specification." + }, + "blobDuration": { + "type": "string", + "description": "Duration of the blob." + } + } + }, + "MetricSpecification": { + "description": "Description of metrics specification.", + "properties": { + "name": { + "type": "string", + "description": "The name of the metric." + }, + "displayName": { + "type": "string", + "description": "The display name of the metric." + }, + "displayDescription": { + "type": "string", + "description": "The description of the metric." + }, + "unit": { + "type": "string", + "description": "Units the metric to be displayed in." + }, + "aggregationType": { + "type": "string", + "description": "The aggregation type." + }, + "availabilities": { + "type": "array", + "items": { + "$ref": "#/definitions/Availability" + }, + "description": "List of availability." + }, + "enableRegionalMdmAccount": { + "type": "boolean", + "description": "Whether regional MDM account enabled." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Whether gaps would be filled with zeros." + }, + "metricFilterPattern": { + "type": "string", + "description": "Pattern for the filter of the metric." + }, + "dimensions": { + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "description": "List of dimensions." + }, + "isInternal": { + "type": "boolean", + "description": "Whether the metric is internal." + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "The resource Id dimension name override." + } + } + }, + "Dimension": { + "description": "Dimension of the metric.", + "properties": { + "name": { + "type": "string", + "description": "The name of the dimension." + }, + "displayName": { + "type": "string", + "description": "The display name of the dimension." + }, + "internalName": { + "type": "string", + "description": "The internal name of the dimension." + } + } + }, + "Availability": { + "description": "Availability of the metric.", + "properties": { + "timeGrain": { + "type": "string", + "description": "The time grain of the availability." + }, + "retention": { + "type": "string", + "description": "The retention of the availability." + }, + "blobDuration": { + "type": "string", + "description": "Duration of the availability blob." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/publicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/publicIpAddress.json new file mode 100644 index 000000000000..1aa007479d83 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/publicIpAddress.json @@ -0,0 +1,481 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}": { + "delete": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_Delete", + "description": "Deletes the specified public IP address.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "Delete public IP address": { "$ref": "./examples/PublicIpAddressDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_Get", + "description": "Gets the specified public IP address in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + } + }, + "x-ms-examples": { + "Get public IP address": { "$ref": "./examples/PublicIpAddressGet.json" } + } + }, + "put": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_CreateOrUpdate", + "description": "Creates or updates a static or dynamic public IP address.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PublicIPAddress" + }, + "description": "Parameters supplied to the create or update public IP address operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + } + }, + "x-ms-examples": { + "Create public IP address defaults": { "$ref": "./examples/PublicIpAddressCreateDefaults.json" }, + "Create public IP address allocation method": { "$ref": "./examples/PublicIpAddressCreateCustomizedValues.json" }, + "Create public IP address DNS": { "$ref": "./examples/PublicIpAddressCreateDns.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_UpdateTags", + "description": "Updates public IP address tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update public IP address tags." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + } + }, + "x-ms-examples": { + "Update public IP address tags": { "$ref": "./examples/PublicIpAddressUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPAddresses": { + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_ListAll", + "description": "Gets all the public IP addresses in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "#/definitions/PublicIPAddressListResult" + } + } + }, + "x-ms-examples": { + "List all public IP addresses": { "$ref": "./examples/PublicIpAddressListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses": { + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_List", + "description": "Gets all public IP addresses in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "#/definitions/PublicIPAddressListResult" + } + } + }, + "x-ms-examples": { + "List resource group public IP addresses": { "$ref": "./examples/PublicIpAddressList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PublicIPAddressSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of a public IP address SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuName", + "modelAsString": true + } + } + }, + "description": "SKU of a public IP address" + }, + "PublicIPAddressPropertiesFormat": { + "properties": { + "publicIPAllocationMethod": { + "type": "string", + "description": "The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "publicIPAddressVersion": { + "type": "string", + "description": "The public IP address version. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "ipConfiguration": { + "readOnly": true, + "$ref": "./networkInterface.json#/definitions/IPConfiguration", + "description": "The IP configuration associated with the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/PublicIPAddressDnsSettings", + "description": "The FQDN of the DNS record associated with the public IP address." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IpTag" + }, + "description": "The list of tags associated with the public IP address." + }, + "ipAddress": { + "type": "string", + "description": "The IP address associated with the public IP address resource." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the public IP resource." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Public IP address properties." + }, + "PublicIPAddress": { + "properties": { + "sku": { + "$ref": "#/definitions/PublicIPAddressSku", + "description": "The public IP address SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PublicIPAddressPropertiesFormat", + "description": "Public IP address properties." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Public IP address resource." + }, + "PublicIPAddressListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PublicIPAddress" + }, + "description": "A list of public IP addresses that exists in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPublicIpAddresses API service call." + }, + "PublicIPAddressDnsSettings": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system." + }, + "fqdn": { + "type": "string", + "description": "Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone." + }, + "reverseFqdn": { + "type": "string", + "description": "Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. " + } + }, + "description": "Contains FQDN of the DNS record associated with the public IP address" + }, + "IpTag": { + "properties": { + "ipTagType": { + "type": "string", + "description": "Gets or sets the ipTag type: Example FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc" + } + }, + "description": "Contains the IpTag associated with the public IP address" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/routeFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/routeFilter.json new file mode 100644 index 000000000000..e43c1542d453 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/routeFilter.json @@ -0,0 +1,799 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}": { + "delete": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_Delete", + "x-ms-examples": { + "RouteFilterDelete": { "$ref": "./examples/RouteFilterDelete.json" } + }, + "description": "Deletes the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_Get", + "x-ms-examples": { + "RouteFilterGet": { "$ref": "./examples/RouteFilterGet.json" } + }, + "description": "Gets the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced express route bgp peering resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + } + } + }, + "put": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_CreateOrUpdate", + "x-ms-examples": { + "RouteFilterCreate": { "$ref": "./examples/RouteFilterCreate.json" } + }, + "description": "Creates or updates a route filter in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "routeFilterParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteFilter" + }, + "description": "Parameters supplied to the create or update route filter operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_Update", + "x-ms-examples": { + "RouteFilterUpdate": { "$ref": "./examples/RouteFilterUpdate.json" } + }, + "description": "Updates a route filter in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "routeFilterParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchRouteFilter" + }, + "description": "Parameters supplied to the update route filter operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters": { + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_ListByResourceGroup", + "x-ms-examples": { + "RouteFilterListByResourceGroup": { "$ref": "./examples/RouteFilterListByResourceGroup.json" } + }, + "description": "Gets all route filters in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter resources.", + "schema": { + "$ref": "#/definitions/RouteFilterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeFilters": { + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_List", + "x-ms-examples": { + "RouteFilterList": { "$ref": "./examples/RouteFilterList.json" } + }, + "description": "Gets all route filters in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter resources.", + "schema": { + "$ref": "#/definitions/RouteFilterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}": { + "delete": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_Delete", + "x-ms-examples": { + "RouteFilterRuleDelete": { "$ref": "./examples/RouteFilterRuleDelete.json" } + }, + "description": "Deletes the specified rule from a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Accepted." + }, + "204": { + "description": "Rule was deleted or not found." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_Get", + "x-ms-examples": { + "RouteFilterRuleGet": { "$ref": "./examples/RouteFilterRuleGet.json" } + }, + "description": "Gets the specified rule from a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + } + } + }, + "put": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_CreateOrUpdate", + "x-ms-examples": { + "RouteFilterRuleCreate": { "$ref": "./examples/RouteFilterRuleCreate.json" } + }, + "description": "Creates or updates a route in the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter rule." + }, + { + "name": "routeFilterRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "Parameters supplied to the create or update route filter rule operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_Update", + "x-ms-examples": { + "RouteFilterRuleUpdate": { "$ref": "./examples/RouteFilterRuleUpdate.json" } + }, + "description": "Updates a route in the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter rule." + }, + { + "name": "routeFilterRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchRouteFilterRule" + }, + "description": "Parameters supplied to the update route filter rule operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules": { + "get": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_ListByRouteFilter", + "x-ms-examples": { + "RouteFilterRuleListByRouteFilter": { "$ref": "./examples/RouteFilterRuleListByRouteFilter.json" } + }, + "description": "Gets all RouteFilterRules in a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter Rule resources.", + "schema": { + "$ref": "#/definitions/RouteFilterRuleListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "RouteFilterRulePropertiesFormat": { + "required": [ + "access", + "routeFilterRuleType", + "communities" + ], + "properties": { + "access": { + "type": "string", + "description": "The access type of the rule. Valid values are: 'Allow', 'Deny'", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "Access", + "modelAsString": true + } + }, + "routeFilterRuleType": { + "type": "string", + "description": "The rule type of the rule. Valid value is: 'Community'", + "enum": [ + "Community" + ], + "x-ms-enum": { + "name": "RouteFilterRuleType", + "modelAsString": true + } + }, + "communities": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'." + } + }, + "description": "Route Filter Rule Resource" + }, + "RouteFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterRulePropertiesFormat" + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Rule Resource" + }, + "PatchRouteFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterRulePropertiesFormat" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Rule Resource" + }, + "RouteFilterPropertiesFormat": { + "properties": { + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "Collection of RouteFilterRules contained within a route filter." + }, + "peerings": { + "type": "array", + "items": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitPeering" + }, + "description": "A collection of references to express route circuit peerings." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'." + } + }, + "description": "Route Filter Resource" + }, + "RouteFilter": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterPropertiesFormat" + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Route Filter Resource." + }, + "PatchRouteFilter": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterPropertiesFormat" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Resource." + }, + "RouteFilterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilter" + }, + "description": "Gets a list of route filters in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteFilters API service call." + }, + "RouteFilterRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "Gets a list of RouteFilterRules in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteFilterRules API service call" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/routeTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/routeTable.json new file mode 100644 index 000000000000..b9f94093c36b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/routeTable.json @@ -0,0 +1,670 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}": { + "delete": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_Delete", + "description": "Deletes the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "200": { + "description": "Request successful. Operation to delete was accepted." + }, + "202": { + "description": "Accepted. If route table not found returned synchronously, otherwise if found returned asynchronously." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete route table": { "$ref": "./examples/RouteTableDelete.json" } + } + }, + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_Get", + "description": "Gets the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + } + }, + "x-ms-examples": { + "Get route table": { "$ref": "./examples/RouteTableGet.json" } + } + }, + "put": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_CreateOrUpdate", + "description": "Create or updates a route table in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteTable" + }, + "description": "Parameters supplied to the create or update route table operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + } + }, + "x-ms-examples": { + "Create route table": { "$ref": "./examples/RouteTableCreate.json" }, + "Create route table with route": { "$ref": "./examples/RouteTableCreateWithRoute.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_UpdateTags", + "description": "Updates a route table tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update route table tags." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + } + }, + "x-ms-examples": { + "Update route table tags": { "$ref": "./examples/RouteTableUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables": { + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_List", + "description": "Gets all route tables in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of RouteTable resources.", + "schema": { + "$ref": "#/definitions/RouteTableListResult" + } + } + }, + "x-ms-examples": { + "List route tables in resource group": { "$ref": "./examples/RouteTableList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeTables": { + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_ListAll", + "description": "Gets all route tables in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of RouteTable resources.", + "schema": { + "$ref": "#/definitions/RouteTableListResult" + } + } + }, + "x-ms-examples": { + "List all route tables": { "$ref": "./examples/RouteTableListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}": { + "delete": { + "tags": [ + "Routes" + ], + "operationId": "Routes_Delete", + "description": "Deletes the specified route from a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Accepted." + }, + "204": { + "description": "Route was deleted or not found." + } + }, + "x-ms-examples": { + "Delete route": { "$ref": "./examples/RouteTableRouteDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Routes" + ], + "operationId": "Routes_Get", + "description": "Gets the specified route from a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + } + }, + "x-ms-examples": { + "Get route": { "$ref": "./examples/RouteTableRouteGet.json" } + } + }, + "put": { + "tags": [ + "Routes" + ], + "operationId": "Routes_CreateOrUpdate", + "description": "Creates or updates a route in the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "name": "routeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Route" + }, + "description": "Parameters supplied to the create or update route operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + } + }, + "x-ms-examples": { + "Create route": { "$ref": "./examples/RouteTableRouteCreate.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes": { + "get": { + "tags": [ + "Routes" + ], + "operationId": "Routes_List", + "description": "Gets all routes in a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route resources.", + "schema": { + "$ref": "#/definitions/RouteListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List routes": { "$ref": "./examples/RouteTableRouteList.json" } + } + } + } + }, + "definitions": { + "RoutePropertiesFormat": { + "properties": { + "addressPrefix": { + "type": "string", + "description": "The destination CIDR to which the route applies." + }, + "nextHopType": { + "type": "string", + "description": "The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'", + "enum": [ + "VirtualNetworkGateway", + "VnetLocal", + "Internet", + "VirtualAppliance", + "None" + ], + "x-ms-enum": { + "name": "RouteNextHopType", + "modelAsString": true + } + }, + "nextHopIpAddress": { + "type": "string", + "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "nextHopType" + ], + "description": "Route resource" + }, + "Route": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoutePropertiesFormat", + "description": "Properties of the route." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route resource" + }, + "RouteTablePropertiesFormat": { + "properties": { + "routes": { + "type": "array", + "items": { + "$ref": "#/definitions/Route" + }, + "description": "Collection of routes contained within a route table." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualNetwork.json#/definitions/Subnet" + }, + "description": "A collection of references to subnets." + }, + "disableBgpRoutePropagation": { + "type": "boolean", + "description": "Gets or sets whether to disable the routes learned by BGP on that route table. True means disable." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Route Table resource" + }, + "RouteTable": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteTablePropertiesFormat", + "description": "Properties of the route table." + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Route table resource." + }, + "RouteTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteTable" + }, + "description": "Gets a list of route tables in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteTable API service call." + }, + "RouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Route" + }, + "description": "Gets a list of routes in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRoute API service call" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/serviceCommunity.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/serviceCommunity.json new file mode 100644 index 000000000000..3de2f711af2d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/serviceCommunity.json @@ -0,0 +1,165 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/bgpServiceCommunities": { + "get": { + "tags": [ + "BgpServiceCommunities" + ], + "operationId": "BgpServiceCommunities_List", + "x-ms-examples": { + "ServiceCommunityList": { "$ref": "./examples/ServiceCommunityList.json" } + }, + "description": "Gets all the available bgp service communities.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of BgpServiceCommunity resources.", + "schema": { + "$ref": "#/definitions/BgpServiceCommunityListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "BGPCommunity": { + "properties": { + "serviceSupportedRegion": { + "type": "string", + "description": "The region which the service support. e.g. For O365, region is Global." + }, + "communityName": { + "type": "string", + "description": "The name of the bgp community. e.g. Skype." + }, + "communityValue": { + "type": "string", + "description": "The value of the bgp community. For more information: https://docs.microsoft.com/en-us/azure/expressroute/expressroute-routing." + }, + "communityPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The prefixes that the bgp community contains." + }, + "isAuthorizedToUse": { + "type": "boolean", + "description": "Customer is authorized to use bgp community or not." + }, + "serviceGroup": { + "type": "string", + "description": "The service group of the bgp community contains." + } + }, + "description": "Contains bgp community information offered in Service Community resources." + }, + "BgpServiceCommunityPropertiesFormat": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the bgp community. e.g. Skype." + }, + "bgpCommunities": { + "type": "array", + "items": { + "$ref": "#/definitions/BGPCommunity" + }, + "description": "Get a list of bgp communities." + } + }, + "description": "Properties of Service Community." + }, + "BgpServiceCommunity": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BgpServiceCommunityPropertiesFormat" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Service Community Properties." + }, + "BgpServiceCommunityListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BgpServiceCommunity" + }, + "description": "A list of service community resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListServiceCommunity API service call." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/usage.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/usage.json new file mode 100644 index 000000000000..296ccee52f17 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/usage.json @@ -0,0 +1,165 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/usages": { + "get": { + "tags": [ + "Usages" + ], + "operationId": "Usages_List", + "description": "List network usages for a subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location where resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Usage resources.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + } + }, + "x-ms-examples": { + "List usages": { "$ref": "./examples/UsageList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "A string describing the resource name." + }, + "localizedValue": { + "type": "string", + "description": "A localized string describing the resource name." + } + }, + "description": "The usage names." + }, + "Usage": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource identifier." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "type": "integer", + "format": "int64", + "description": "The current value of the usage." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The limit of usage." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes network resource usage." + }, + "UsagesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list network resource usages." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "The list usages operation response." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/virtualNetwork.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/virtualNetwork.json new file mode 100644 index 000000000000..0fe56a89334b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/virtualNetwork.json @@ -0,0 +1,1256 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}": { + "delete": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_Delete", + "description": "Deletes the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete virtual network": { "$ref": "./examples/VirtualNetworkDelete.json" } + } + }, + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_Get", + "description": "Gets the specified virtual network by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + } + }, + "x-ms-examples": { + "Get virtual network": { "$ref": "./examples/VirtualNetworkGet.json" } + } + }, + "put": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_CreateOrUpdate", + "description": "Creates or updates a virtual network in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetwork" + }, + "description": "Parameters supplied to the create or update virtual network operation" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create virtual network": { "$ref": "./examples/VirtualNetworkCreate.json" }, + "Create virtual network with subnet": { "$ref": "./examples/VirtualNetworkCreateSubnet.json" }, + "Create virtual network with service endpoints": { "$ref": "./examples/VirtualNetworkCreateServiceEndpoints.json" } + } + }, + "patch": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_UpdateTags", + "description": "Updates a virtual network tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network tags." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update virtual network tags": { "$ref": "./examples/VirtualNetworkUpdateTags.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworks": { + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_ListAll", + "description": "Gets all virtual networks in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetwork resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListResult" + } + } + }, + "x-ms-examples": { + "List all virtual networks": { "$ref": "./examples/VirtualNetworkListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks": { + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_List", + "description": "Gets all virtual networks in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetwork resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListResult" + } + } + }, + "x-ms-examples": { + "List virtual networks in resource group": { "$ref": "./examples/VirtualNetworkList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}": { + "delete": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_Delete", + "description": "Deletes the specified subnet.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "Delete subnet": { "$ref": "./examples/SubnetDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_Get", + "description": "Gets the specified subnet by virtual network and resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + } + }, + "x-ms-examples": { + "Get subnet": { "$ref": "./examples/SubnetGet.json" } + } + }, + "put": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_CreateOrUpdate", + "description": "Creates or updates a subnet in the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "name": "subnetParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Subnet" + }, + "description": "Parameters supplied to the create or update subnet operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create subnet": { "$ref": "./examples/SubnetCreate.json" }, + "Create subnet with service endpoints": { "$ref": "./examples/SubnetCreateServiceEndpoint.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets": { + "get": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_List", + "description": "Gets all subnets in a virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Subnet resources.", + "schema": { + "$ref": "#/definitions/SubnetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List subnets": { "$ref": "./examples/SubnetList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}": { + "delete": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_Delete", + "description": "Deletes the specified virtual network peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network peering." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "Delete peering": { "$ref": "./examples/VirtualNetworkPeeringDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_Get", + "description": "Gets the specified virtual network peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network peering." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + } + }, + "x-ms-examples": { + "Get peering": { "$ref": "./examples/VirtualNetworkPeeringGet.json" } + } + }, + "put": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "VirtualNetworkPeeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "Parameters supplied to the create or update virtual network peering operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + } + }, + "x-ms-examples": { + "Create peering": { "$ref": "./examples/VirtualNetworkPeeringCreate.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings": { + "get": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_List", + "description": "Gets all virtual network peerings in a virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkPeering resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeeringListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List peerings": { "$ref": "./examples/VirtualNetworkPeeringList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/CheckIPAddressAvailability": { + "get": { + "operationId": "VirtualNetworks_CheckIPAddressAvailability", + "description": "Checks whether a private IP address is available for use.", + "parameters": [ + { + "name": "ipAddress", + "in": "query", + "required": false, + "type": "string", + "description": "The private IP address to be verified." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Private IP address availability and list of other free addresses if the requested one is not available.", + "schema": { + "$ref": "#/definitions/IPAddressAvailabilityResult" + } + } + }, + "x-ms-examples": { + "Check IP address availability": { "$ref": "./examples/VirtualNetworkCheckIPAddressAvailability.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/usages": { + "get": { + "operationId": "VirtualNetworks_ListUsage", + "description": "Lists usage stats.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Usage stats for vnet.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListUsageResult" + } + } + }, + "x-ms-examples": { + "VnetGetUsage": { "$ref": "./examples/VirtualNetworkListUsage.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ResourceNavigationLinkFormat": { + "properties": { + "linkedResourceType": { + "type": "string", + "description": "Resource type of the linked resource." + }, + "link": { + "type": "string", + "description": "Link to the external resource" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the ResourceNavigationLink resource." + } + }, + "description": "Properties of ResourceNavigationLink." + }, + "ResourceNavigationLink": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ResourceNavigationLinkFormat", + "description": "Resource navigation link properties format." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "ResourceNavigationLink resource." + }, + "SubnetPropertiesFormat": { + "properties": { + "addressPrefix": { + "type": "string", + "description": "The address prefix for the subnet." + }, + "networkSecurityGroup": { + "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup", + "description": "The reference of the NetworkSecurityGroup resource." + }, + "routeTable": { + "$ref": "./routeTable.json#/definitions/RouteTable", + "description": "The reference of the RouteTable resource." + }, + "serviceEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPropertiesFormat" + }, + "description": "An array of service endpoints." + }, + "ipConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/IPConfiguration" + }, + "description": "Gets an array of references to the network interface IP configurations using subnet." + }, + "resourceNavigationLinks": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceNavigationLink" + }, + "description": "Gets an array of references to the external resources using subnet." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the resource." + } + }, + "description": "Properties of the subnet." + }, + "ServiceEndpointPropertiesFormat": { + "properties": { + "service": { + "type": "string", + "description": "The type of the endpoint service." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of locations." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the resource." + } + }, + "description": "The service endpoint properties." + }, + "VirtualNetworkPeeringPropertiesFormat": { + "properties": { + "allowVirtualNetworkAccess": { + "type": "boolean", + "description": "Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space." + }, + "allowForwardedTraffic": { + "type": "boolean", + "description": "Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed." + }, + "allowGatewayTransit": { + "type": "boolean", + "description": "If gateway links can be used in remote virtual networking to link to this virtual network." + }, + "useRemoteGateways": { + "type": "boolean", + "description": "If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway." + }, + "remoteVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering)." + }, + "remoteAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference of the remote virtual network address space." + }, + "peeringState": { + "type": "string", + "description": "The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.", + "enum": [ + "Initiated", + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "VirtualNetworkPeeringState", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the resource." + } + }, + "description": "Properties of the virtual network peering." + }, + "Subnet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubnetPropertiesFormat", + "description": "Properties of the subnet." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Subnet in a virtual network resource." + }, + "VirtualNetworkPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat", + "description": "Properties of the virtual network peering." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peerings in a virtual network resource." + }, + "SubnetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + }, + "description": "The subnets in a virtual network." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSubnets API service callRetrieves all subnet that belongs to a virtual network" + }, + "VirtualNetworkPeeringListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "The peerings in a virtual network." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSubnets API service call. Retrieves all subnets that belong to a virtual network." + }, + "VirtualNetworkPropertiesFormat": { + "properties": { + "addressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The AddressSpace that contains an array of IP address ranges that can be used by subnets." + }, + "dhcpOptions": { + "$ref": "#/definitions/DhcpOptions", + "description": "The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network." + }, + "subnets": { + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + }, + "description": "A list of subnets in a Virtual Network." + }, + "virtualNetworkPeerings": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "A list of peerings in a Virtual Network." + }, + "resourceGuid": { + "type": "string", + "description": "The resourceGuid property of the Virtual Network resource." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "enableDdosProtection": { + "type": "boolean", + "default": false, + "description": "Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource." + }, + "enableVmProtection": { + "type": "boolean", + "default": false, + "description": "Indicates if VM protection is enabled for all the subnets in the virtual network." + }, + "ddosProtectionPlan": { + "$ref": "./network.json#/definitions/SubResource", + "default": null, + "description": "The DDoS protection plan associated with the virtual network." + } + }, + "description": "Properties of the virtual network." + }, + "VirtualNetwork": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkPropertiesFormat", + "description": "Properties of the virtual network." + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Virtual Network resource." + }, + "VirtualNetworkListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetwork" + }, + "description": "Gets a list of VirtualNetwork resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworks API service call." + }, + "AddressSpace": { + "properties": { + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of address blocks reserved for this virtual network in CIDR notation." + } + }, + "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." + }, + "DhcpOptions": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of DNS servers IP addresses." + } + }, + "description": "DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options." + }, + "IPAddressAvailabilityResult": { + "properties": { + "available": { + "type": "boolean", + "description": "Private IP address availability." + }, + "availableIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Contains other available private IP addresses if the asked for address is taken." + } + }, + "description": "Response for CheckIPAddressAvailability API service call" + }, + "VirtualNetworkListUsageResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/VirtualNetworkUsage" + }, + "description": "VirtualNetwork usage stats." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the virtual networks GetUsage API service call." + }, + "VirtualNetworkUsage": { + "properties": { + "currentValue": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "Indicates number of IPs used from the Subnet." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Subnet identifier." + }, + "limit": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "Indicates the size of the subnet." + }, + "name": { + "$ref": "#/definitions/VirtualNetworkUsageName", + "readOnly": true, + "description": "The name containing common and localized value for usage." + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "Usage units. Returns 'Count'" + } + }, + "description": "Usage details for subnet." + }, + "VirtualNetworkUsageName": { + "properties": { + "localizedValue": { + "type": "string", + "readOnly": true, + "description": "Localized subnet size and usage string." + }, + "value": { + "type": "string", + "readOnly": true, + "description": "Subnet size and usage string." + } + }, + "description": "Usage strings container." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/virtualNetworkGateway.json new file mode 100644 index 000000000000..54768e633518 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/virtualNetworkGateway.json @@ -0,0 +1,2762 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}": { + "put": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_CreateOrUpdate", + "description": "Creates or updates a virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + }, + "description": "Parameters supplied to create or update virtual network gateway operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGateway": { "$ref": "./examples/VirtualNetworkGatewayUpdate.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Get", + "description": "Gets the specified virtual network gateway by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGateway": { "$ref": "./examples/VirtualNetworkGatewayGet.json" } + } + }, + "delete": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Delete", + "description": "Deletes the specified virtual network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "DeleteVirtualNetworkGateway": { "$ref": "./examples/VirtualNetworkGatewayDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_UpdateTags", + "description": "Updates a virtual network gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network gateway tags." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGatewayTags": { "$ref": "./examples/VirtualNetworkGatewayUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways": { + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_List", + "description": "Gets all virtual network gateways by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGateway resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayListResult" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewaysinResourceGroup": { "$ref": "./examples/VirtualNetworkGatewayList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/connections": { + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_ListConnections", + "description": "Gets all the connections in a virtual network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayListConnectionsResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualNetworkGatewaysListConnections": { "$ref": "./examples/VirtualNetworkGatewaysListConnections.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/reset": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Reset", + "description": "Resets the primary of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "gatewayVip", + "in": "query", + "required": false, + "type": "string", + "description": "Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation reset the primary of the virtual network gateway.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + } + }, + "x-ms-examples": { + "ResetVirtualNetworkGateway": { "$ref": "./examples/VirtualNetworkGatewayReset.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnclientpackage": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Generatevpnclientpackage", + "description": "Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientParameters" + }, + "description": "Parameters supplied to the generate virtual network gateway VPN client package operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN client package URL.", + "schema": { + "type": "string" + } + } + }, + "x-ms-examples": { + "GenerateVPNClientPackage": { "$ref": "./examples/VirtualNetworkGatewayGenerateVpnClientPackage.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnprofile": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GenerateVpnProfile", + "description": "Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientParameters" + }, + "description": "Parameters supplied to the generate virtual network gateway VPN client package operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GenerateVirtualNetworkGatewayVPNProfile": { "$ref": "./examples/VirtualNetworkGatewayGenerateVpnProfile.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnprofilepackageurl": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetVpnProfilePackageUrl", + "description": "Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayVPNProfilePackageURL": { "$ref": "./examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetBgpPeerStatus", + "description": "The GetBgpPeerStatus operation retrieves the status of all BGP peers.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "peer", + "in": "query", + "required": false, + "type": "string", + "description": "The IP address of the peer to retrieve the status of." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of BGP peer statuses", + "schema": { + "$ref": "#/definitions/BgpPeerStatusListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayBGPPeerStatus": { "$ref": "./examples/VirtualNetworkGatewayGetBGPPeerStatus.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/supportedvpndevices": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_SupportedVpnDevices", + "description": "Gets a xml format representation for supported vpn devices.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Xml format representation for supported vpn devices.", + "schema": { + "type": "string" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewaySupportedVPNDevices": { "$ref": "./examples/VirtualNetworkGatewaySupportedVpnDevice.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getLearnedRoutes": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetLearnedRoutes", + "description": "This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of advertised BGP routes", + "schema": { + "$ref": "#/definitions/GatewayRouteListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayLearnedRoutes": { "$ref": "./examples/VirtualNetworkGatewayLearnedRoutes.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getAdvertisedRoutes": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetAdvertisedRoutes", + "description": "This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "peer", + "in": "query", + "required": true, + "type": "string", + "description": "The IP address of the peer" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of learned BGP routes", + "schema": { + "$ref": "#/definitions/GatewayRouteListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayAdvertisedRoutes": { "$ref": "./examples/VirtualNetworkGatewayGetAdvertisedRoutes.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/setvpnclientipsecparameters": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_SetVpnclientIpsecParameters", + "description": "The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "vpnclientIpsecParams", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + }, + "description": "Parameters supplied to the Begin Set vpnclient ipsec parameters of Virtual Network Gateway P2S client operation through Network resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation sets the specificed vpnclient ipsec parameters for P2S client of the virtual network gateway.", + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Set VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnclientipsecparameters": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetVpnclientIpsecParameters", + "description": "The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the set vpnclient ipsec parameters for P2S client of VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Get VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" } + } + + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/vpndeviceconfigurationscript": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_VpnDeviceConfigurationScript", + "description": "Gets a xml format representation for vpn device configuration script.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection for which the configuration script is generated." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnDeviceScriptParameters" + }, + "description": "Parameters supplied to the generate vpn device script operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Xml format representation for vpn device configuration script.", + "schema": { + "type": "string" + } + } + }, + "x-ms-examples": { + "GetVPNDeviceConfigurationScript": { "$ref": "./examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}": { + "put": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_CreateOrUpdate", + "description": "Creates or updates a virtual network gateway connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + }, + "description": "Parameters supplied to the create or update virtual network gateway connection operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + } + }, + "x-ms-examples": { + "CreateVirtualNetworkGatewayConnection_S2S": { "$ref": "./examples/VirtualNetworkGatewayConnectionCreate.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_Get", + "description": "Gets the specified virtual network gateway connection by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayConnection": { "$ref": "./examples/VirtualNetworkGatewayConnectionGet.json" } + } + }, + "delete": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_Delete", + "description": "Deletes the specified virtual network Gateway connection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "DeleteVirtualNetworkGatewayConnection": { "$ref": "./examples/VirtualNetworkGatewayConnectionDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_UpdateTags", + "description": "Updates a virtual network gateway connection tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network gateway connection tags." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGatewayConnectionTags": { "$ref": "./examples/VirtualNetworkGatewayConnectionUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey": { + "put": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_SetSharedKey", + "description": "The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + }, + "description": "Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting ConnectionSharedKey resource.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + } + }, + "x-ms-examples": { + "SetVirtualNetworkGatewayConnectionSharedKey": { "$ref": "./examples/VirtualNetworkGatewayConnectionSetSharedKey.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_GetSharedKey", + "description": "The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection shared key name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGatewayConnection resources.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayConnectionSharedKey": { "$ref": "./examples/VirtualNetworkGatewayConnectionGetSharedKey.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections": { + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_List", + "description": "The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation resets the virtual network gateway connection shared key.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListResult" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewayConnectionsinResourceGroup": { "$ref": "./examples/VirtualNetworkGatewayConnectionsList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey/reset": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_ResetSharedKey", + "description": "The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection reset shared key Name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionResetSharedKey" + }, + "description": "Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation sets the virtual network gateway connection shared key.", + "schema": { + "$ref": "#/definitions/ConnectionResetSharedKey" + } + }, + "202": { + "description": "" + } + }, + "x-ms-examples": { + "ResetVirtualNetworkGatewayConnectionSharedKey": { "$ref": "./examples/VirtualNetworkGatewayConnectionResetSharedKey.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}": { + "put": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_CreateOrUpdate", + "description": "Creates or updates a local network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + }, + "description": "Parameters supplied to the create or update local network gateway operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + } + }, + "x-ms-examples": { + "CreateLocalNetworkGateway": { "$ref": "./examples/LocalNetworkGatewayCreate.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_Get", + "description": "Gets the specified local network gateway in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + } + }, + "x-ms-examples": { + "GetLocalNetworkGateway": { "$ref": "./examples/LocalNetworkGatewayGet.json" } + } + }, + "delete": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_Delete", + "description": "Deletes the specified local network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "DeleteLocalNetworkGateway": { "$ref": "./examples/LocalNetworkGatewayDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_UpdateTags", + "description": "Updates a local network gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update local network gateway tags." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + } + }, + "x-ms-examples": { + "UpdateLocalNetworkGatewayTags": { "$ref": "./examples/LocalNetworkGatewayUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways": { + "get": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_List", + "description": "Gets all the local network gateways in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LocalNetworkGateway resources.", + "schema": { + "$ref": "#/definitions/LocalNetworkGatewayListResult" + } + } + }, + "x-ms-examples": { + "ListLocalNetworkGateways": { "$ref": "./examples/LocalNetworkGatewayList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAllocationMethod": { + "type": "string", + "description": "The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of the subnet resource." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of the public IP resource." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of VirtualNetworkGatewayIPConfiguration" + }, + "VirtualNetworkGatewayIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat", + "description": "Properties of the virtual network gateway ip configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration for virtual network gateway" + }, + "VirtualNetworkGatewayPropertiesFormat": { + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" + }, + "description": "IP configurations for virtual network gateway." + }, + "gatewayType": { + "type": "string", + "description": "The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.", + "enum": [ + "Vpn", + "ExpressRoute" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayType", + "modelAsString": true + } + }, + "vpnType": { + "type": "string", + "description": "The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.", + "enum": [ + "PolicyBased", + "RouteBased" + ], + "x-ms-enum": { + "name": "VpnType", + "modelAsString": true + } + }, + "enableBgp": { + "type": "boolean", + "description": "Whether BGP is enabled for this virtual network gateway or not." + }, + "activeActive": { + "type": "boolean", + "description": "ActiveActive flag" + }, + "gatewayDefaultSite": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting." + }, + "sku": { + "$ref": "#/definitions/VirtualNetworkGatewaySku", + "description": "The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway." + }, + "vpnClientConfiguration": { + "$ref": "#/definitions/VpnClientConfiguration", + "description": "The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations." + }, + "bgpSettings": { + "$ref": "#/definitions/BgpSettings", + "description": "Virtual network gateway's BGP speaker settings." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the VirtualNetworkGateway resource." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "VirtualNetworkGateway properties" + }, + "VpnClientRootCertificatePropertiesFormat": { + "properties": { + "publicCertData": { + "type": "string", + "description": "The certificate public data." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "publicCertData" + ], + "description": "Properties of SSL certificates of application gateway" + }, + "VpnClientRootCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat", + "description": "Properties of the vpn client root certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "required": [ + "properties" + ], + "description": "VPN client root certificate of virtual network gateway" + }, + "VpnClientRevokedCertificatePropertiesFormat": { + "properties": { + "thumbprint": { + "type": "string", + "description": "The revoked VPN client certificate thumbprint." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of the revoked VPN client certificate of virtual network gateway." + }, + "VpnClientRevokedCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat", + "description": "Properties of the vpn client revoked certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VPN client revoked certificate of virtual network gateway." + }, + "VpnClientConfiguration": { + "properties": { + "vpnClientAddressPool": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The reference of the address space resource which represents Address space for P2S VpnClient." + }, + "vpnClientRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnClientRootCertificate" + }, + "description": "VpnClientRootCertificate for virtual network gateway." + }, + "vpnClientRevokedCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnClientRevokedCertificate" + }, + "description": "VpnClientRevokedCertificate for Virtual network gateway." + }, + "vpnClientProtocols": { + "type": "array", + "items": { + "type": "string", + "description": "VPN client protocol enabled for the virtual network gateway.", + "enum": [ + "IkeV2", + "SSTP", + "OpenVPN" + ], + "x-ms-enum": { + "name": "VpnClientProtocol", + "modelAsString": true + } + }, + "description": "VpnClientProtocols for Virtual network gateway." + }, + "vpnClientIpsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "VpnClientIpsecPolicies for virtual network gateway P2S client." + }, + "radiusServerAddress": { + "type": "string", + "description": "The radius server address property of the VirtualNetworkGateway resource for vpn client connection." + }, + "radiusServerSecret": { + "type": "string", + "description": "The radius secret property of the VirtualNetworkGateway resource for vpn client connection." + } + }, + "description": "VpnClientConfiguration for P2S client." + }, + "VirtualNetworkGatewaySku": { + "properties": { + "name": { + "type": "string", + "description": "Gateway SKU name.", + "enum": [ + "Basic", + "HighPerformance", + "Standard", + "UltraPerformance", + "VpnGw1", + "VpnGw2", + "VpnGw3", + "VpnGw1AZ", + "VpnGw2AZ", + "VpnGw3AZ", + "ErGw1AZ", + "ErGw2AZ", + "ErGw3AZ" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewaySkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Gateway SKU tier.", + "enum": [ + "Basic", + "HighPerformance", + "Standard", + "UltraPerformance", + "VpnGw1", + "VpnGw2", + "VpnGw3", + "VpnGw1AZ", + "VpnGw2AZ", + "VpnGw3AZ", + "ErGw1AZ", + "ErGw2AZ", + "ErGw3AZ" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewaySkuTier", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The capacity." + } + }, + "description": "VirtualNetworkGatewaySku details" + }, + "BgpSettings": { + "properties": { + "asn": { + "type": "integer", + "format": "int64", + "description": "The BGP speaker's ASN." + }, + "bgpPeeringAddress": { + "type": "string", + "description": "The BGP peering address and BGP identifier of this BGP speaker." + }, + "peerWeight": { + "type": "integer", + "format": "int32", + "description": "The weight added to routes learned from this BGP speaker." + } + }, + "description": "BGP settings details" + }, + "BgpPeerStatus": { + "properties": { + "localAddress": { + "type": "string", + "readOnly": true, + "description": "The virtual network gateway's local address" + }, + "neighbor": { + "type": "string", + "readOnly": true, + "description": "The remote BGP peer" + }, + "asn": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The autonomous system number of the remote BGP peer" + }, + "state": { + "type": "string", + "readOnly": true, + "description": "The BGP peer state", + "enum": [ + "Unknown", + "Stopped", + "Idle", + "Connecting", + "Connected" + ], + "x-ms-enum": { + "name": "BgpPeerState", + "modelAsString": true + } + }, + "connectedDuration": { + "type": "string", + "readOnly": true, + "description": "For how long the peering has been up" + }, + "routesReceived": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of routes learned from this peer" + }, + "messagesSent": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of BGP messages sent" + }, + "messagesReceived": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of BGP messages received" + } + }, + "description": "BGP peer status details" + }, + "GatewayRoute": { + "properties": { + "localAddress": { + "type": "string", + "readOnly": true, + "description": "The gateway's local address" + }, + "network": { + "type": "string", + "readOnly": true, + "description": "The route's network prefix" + }, + "nextHop": { + "type": "string", + "readOnly": true, + "description": "The route's next hop" + }, + "sourcePeer": { + "type": "string", + "readOnly": true, + "description": "The peer this route was learned from" + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The source this route was learned from" + }, + "asPath": { + "type": "string", + "readOnly": true, + "description": "The route's AS path sequence" + }, + "weight": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The route's weight" + } + }, + "description": "Gateway routing details" + }, + "VirtualNetworkGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat", + "description": "Properties of the virtual network gateway." + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information" + }, + "VpnClientParameters": { + "properties": { + "processorArchitecture": { + "type": "string", + "description": "VPN client Processor Architecture. Possible values are: 'AMD64' and 'X86'.", + "enum": [ + "Amd64", + "X86" + ], + "x-ms-enum": { + "name": "ProcessorArchitecture", + "modelAsString": true + } + }, + "authenticationMethod": { + "type": "string", + "description": "VPN client Authentication Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'.", + "enum": [ + "EAPTLS", + "EAPMSCHAPv2" + ], + "x-ms-enum": { + "name": "AuthenticationMethod", + "modelAsString": true + } + }, + "radiusServerAuthCertificate": { + "type": "string", + "description": "The public certificate data for the radius server authentication certificate as a Base-64 encoded string. Required only if external radius authentication has been configured with EAPTLS authentication." + }, + "clientRootCertificates": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of client root certificates public certificate data encoded as Base-64 strings. Optional parameter for external radius based authentication with EAPTLS." + } + }, + "description": "Vpn Client Parameters for package generation" + }, + "VirtualNetworkGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGateway" + }, + "description": "Gets a list of VirtualNetworkGateway resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworkGateways API service call." + }, + "BgpPeerStatusListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BgpPeerStatus" + }, + "description": "List of BGP peers" + } + }, + "description": "Response for list BGP peer status API service call" + }, + "GatewayRouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayRoute" + }, + "description": "List of gateway routes" + } + }, + "description": "List of virtual network gateway routes" + }, + "TunnelConnectionHealth": { + "properties": { + "tunnel": { + "readOnly": true, + "type": "string", + "description": "Tunnel name." + }, + "connectionStatus": { + "readOnly": true, + "type": "string", + "description": "Virtual network Gateway connection status", + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionStatus", + "modelAsString": true + } + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The Ingress Bytes Transferred in this connection" + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The Egress Bytes Transferred in this connection" + }, + "lastConnectionEstablishedUtcTime": { + "readOnly": true, + "type": "string", + "description": "The time at which connection was established in Utc format." + } + }, + "description": "VirtualNetworkGatewayConnection properties" + }, + "VirtualNetworkGatewayConnectionPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorizationKey." + }, + "virtualNetworkGateway1": { + "$ref": "#/definitions/VirtualNetworkGateway", + "description": "The reference to virtual network gateway resource." + }, + "virtualNetworkGateway2": { + "$ref": "#/definitions/VirtualNetworkGateway", + "description": "The reference to virtual network gateway resource." + }, + "localNetworkGateway2": { + "$ref": "#/definitions/LocalNetworkGateway", + "description": "The reference to local network gateway resource." + }, + "connectionType": { + "type": "string", + "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "enum": [ + "IPsec", + "Vnet2Vnet", + "ExpressRoute", + "VPNClient" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionType", + "modelAsString": true + } + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "The routing weight." + }, + "sharedKey": { + "type": "string", + "description": "The IPSec shared key." + }, + "connectionStatus": { + "readOnly": true, + "type": "string", + "description": "Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'.", + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionStatus", + "modelAsString": true + } + }, + "tunnelConnectionStatus": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TunnelConnectionHealth" + }, + "description": "Collection of all tunnels' connection health status." + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The egress bytes transferred in this connection." + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The ingress bytes transferred in this connection." + }, + "peer": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to peerings resource." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag" + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the VirtualNetworkGatewayConnection resource." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "virtualNetworkGateway1", + "connectionType" + ], + "description": "VirtualNetworkGatewayConnection properties" + }, + "VirtualNetworkGatewayConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat", + "description": "Properties of the virtual network gateway connection." + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information" + }, + "VirtualNetworkGatewayConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + }, + "description": "Gets a list of VirtualNetworkGatewayConnection resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworkGatewayConnections API service call" + }, + "ConnectionResetSharedKey": { + "properties": { + "keyLength": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 128, + "description": "The virtual network connection reset shared key length, should between 1 and 128." + } + }, + "required": [ + "keyLength" + ], + "description": "The virtual network connection reset shared key" + }, + "ConnectionSharedKey": { + "properties": { + "value": { + "type": "string", + "description": "The virtual network connection shared key value." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "required": [ + "value" + ], + "description": "Response for GetConnectionSharedKey API service call" + }, + "IpsecPolicy": { + "properties": { + "saLifeTimeSeconds": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel." + }, + "saDataSizeKilobytes": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel." + }, + "ipsecEncryption": { + "type": "string", + "description": "The IPSec encryption algorithm (IKE phase 1).", + "enum": [ + "None", + "DES", + "DES3", + "AES128", + "AES192", + "AES256", + "GCMAES128", + "GCMAES192", + "GCMAES256" + ], + "x-ms-enum": { + "name": "IpsecEncryption", + "modelAsString": true + } + }, + "ipsecIntegrity": { + "type": "string", + "description": "The IPSec integrity algorithm (IKE phase 1).", + "enum": [ + "MD5", + "SHA1", + "SHA256", + "GCMAES128", + "GCMAES192", + "GCMAES256" + ], + "x-ms-enum": { + "name": "IpsecIntegrity", + "modelAsString": true + } + }, + "ikeEncryption": { + "type": "string", + "description": "The IKE encryption algorithm (IKE phase 2).", + "enum": [ + "DES", + "DES3", + "AES128", + "AES192", + "AES256", + "GCMAES256", + "GCMAES128" + ], + "x-ms-enum": { + "name": "IkeEncryption", + "modelAsString": true + } + }, + "ikeIntegrity": { + "type": "string", + "description": "The IKE integrity algorithm (IKE phase 2).", + "enum": [ + "MD5", + "SHA1", + "SHA256", + "SHA384", + "GCMAES256", + "GCMAES128" + ], + "x-ms-enum": { + "name": "IkeIntegrity", + "modelAsString": true + } + }, + "dhGroup": { + "type": "string", + "description": "The DH Groups used in IKE Phase 1 for initial SA.", + "enum": [ + "None", + "DHGroup1", + "DHGroup2", + "DHGroup14", + "DHGroup2048", + "ECP256", + "ECP384", + "DHGroup24" + ], + "x-ms-enum": { + "name": "DhGroup", + "modelAsString": true + } + }, + "pfsGroup": { + "type": "string", + "description": "The Pfs Groups used in IKE Phase 2 for new child SA.", + "enum": [ + "None", + "PFS1", + "PFS2", + "PFS2048", + "ECP256", + "ECP384", + "PFS24", + "PFS14", + "PFSMM" + ], + "x-ms-enum": { + "name": "PfsGroup", + "modelAsString": true + } + } + }, + "required": [ + "saLifeTimeSeconds", + "saDataSizeKilobytes", + "ipsecEncryption", + "ipsecIntegrity", + "ikeEncryption", + "ikeIntegrity", + "dhGroup", + "pfsGroup" + ], + "description": "An IPSec Policy configuration for a virtual network gateway connection" + }, + "VpnClientIPsecParameters": { + "properties": { + "saLifeTimeSeconds": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for P2S client." + }, + "saDataSizeKilobytes": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for P2S client.." + }, + "ipsecEncryption": { + "type": "string", + "description": "The IPSec encryption algorithm (IKE phase 1).", + "enum": [ + "None", + "DES", + "DES3", + "AES128", + "AES192", + "AES256", + "GCMAES128", + "GCMAES192", + "GCMAES256" + ], + "x-ms-enum": { + "name": "IpsecEncryption", + "modelAsString": true + } + }, + "ipsecIntegrity": { + "type": "string", + "description": "The IPSec integrity algorithm (IKE phase 1).", + "enum": [ + "MD5", + "SHA1", + "SHA256", + "GCMAES128", + "GCMAES192", + "GCMAES256" + ], + "x-ms-enum": { + "name": "IpsecIntegrity", + "modelAsString": true + } + }, + "ikeEncryption": { + "type": "string", + "description": "The IKE encryption algorithm (IKE phase 2).", + "enum": [ + "DES", + "DES3", + "AES128", + "AES192", + "AES256", + "GCMAES256", + "GCMAES128" + ], + "x-ms-enum": { + "name": "IkeEncryption", + "modelAsString": true + } + }, + "ikeIntegrity": { + "type": "string", + "description": "The IKE integrity algorithm (IKE phase 2).", + "enum": [ + "MD5", + "SHA1", + "SHA256", + "SHA384", + "GCMAES256", + "GCMAES128" + ], + "x-ms-enum": { + "name": "IkeIntegrity", + "modelAsString": true + } + }, + "dhGroup": { + "type": "string", + "description": "The DH Groups used in IKE Phase 1 for initial SA.", + "enum": [ + "None", + "DHGroup1", + "DHGroup2", + "DHGroup14", + "DHGroup2048", + "ECP256", + "ECP384", + "DHGroup24" + ], + "x-ms-enum": { + "name": "DhGroup", + "modelAsString": true + } + }, + "pfsGroup": { + "type": "string", + "description": "The Pfs Groups used in IKE Phase 2 for new child SA.", + "enum": [ + "None", + "PFS1", + "PFS2", + "PFS2048", + "ECP256", + "ECP384", + "PFS24", + "PFS14", + "PFSMM" + ], + "x-ms-enum": { + "name": "PfsGroup", + "modelAsString": true + } + } + }, + "required": [ + "saLifeTimeSeconds", + "saDataSizeKilobytes", + "ipsecEncryption", + "ipsecIntegrity", + "ikeEncryption", + "ikeIntegrity", + "dhGroup", + "pfsGroup" + ], + "description": "An IPSec parameters for a virtual network gateway P2S connection." + }, + "LocalNetworkGatewayPropertiesFormat": { + "properties": { + "localNetworkAddressSpace": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "Local network site address space." + }, + "gatewayIpAddress": { + "type": "string", + "description": "IP address of local network gateway." + }, + "bgpSettings": { + "$ref": "#/definitions/BgpSettings", + "description": "Local network gateway's BGP speaker settings." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the LocalNetworkGateway resource." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "LocalNetworkGateway properties" + }, + "LocalNetworkGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat", + "description": "Properties of the local network gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information" + }, + "LocalNetworkGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LocalNetworkGateway" + }, + "description": "A list of local network gateways that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListLocalNetworkGateways API service call." + }, + "virtualNetworkConnectionGatewayReference": { + "properties": { + "id": { + "type": "string", + "description": "The ID of VirtualNetworkGateway or LocalNetworkGateway resource." + } + }, + "required": [ + "id" + ], + "description": "A reference to VirtualNetworkGateway or LocalNetworkGateway resource." + }, + "VirtualNetworkGatewayConnectionListEntityPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorizationKey." + }, + "virtualNetworkGateway1": { + "$ref": "#/definitions/virtualNetworkConnectionGatewayReference", + "description": "The reference to virtual network gateway resource." + }, + "virtualNetworkGateway2": { + "$ref": "#/definitions/virtualNetworkConnectionGatewayReference", + "description": "The reference to virtual network gateway resource." + }, + "localNetworkGateway2": { + "$ref": "#/definitions/virtualNetworkConnectionGatewayReference", + "description": "The reference to local network gateway resource." + }, + "connectionType": { + "type": "string", + "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "enum": [ + "IPsec", + "Vnet2Vnet", + "ExpressRoute", + "VPNClient" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionType", + "modelAsString": true + } + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "The routing weight." + }, + "sharedKey": { + "type": "string", + "description": "The IPSec shared key." + }, + "connectionStatus": { + "readOnly": true, + "type": "string", + "description": "Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'.", + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionStatus", + "modelAsString": true + } + }, + "tunnelConnectionStatus": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TunnelConnectionHealth" + }, + "description": "Collection of all tunnels' connection health status." + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The egress bytes transferred in this connection." + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The ingress bytes transferred in this connection." + }, + "peer": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to peerings resource." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag" + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the VirtualNetworkGatewayConnection resource." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "virtualNetworkGateway1", + "connectionType" + ], + "description": "VirtualNetworkGatewayConnection properties" + }, + "VirtualNetworkGatewayConnectionListEntity": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListEntityPropertiesFormat", + "description": "Properties of the virtual network gateway connection." + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information" + }, + "VirtualNetworkGatewayListConnectionsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListEntity" + }, + "description": "Gets a list of VirtualNetworkGatewayConnection resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the VirtualNetworkGatewayListConnections API service call" + }, + "VpnDeviceScriptParameters": { + "properties": { + "vendor": { + "type": "string", + "description": "The vendor for the vpn device." + }, + "deviceFamily": { + "type": "string", + "description": "The device family for the vpn device." + }, + "firmwareVersion": { + "type": "string", + "description": "The firmware version for the vpn device." + } + }, + "description": "Vpn device configuration script generation parameters" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/virtualWan.json new file mode 100644 index 000000000000..d7ddb5eb1fc4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/virtualWan.json @@ -0,0 +1,2132 @@ +{ + "swagger": "2.0", + "info": { + "title": "VirtualWANAsAServiceManagementClient", + "description": "REST API for Azure VirtualWAN As a Service.", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}": { + "get": { + "operationId": "VirtualWANs_Get", + "x-ms-examples": { + "VirtualWANGet": { "$ref": "./examples/VirtualWANGet.json" } + }, + "description": "Retrieves the details of a VirtualWAN.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN retrieved.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "VirtualWANs_CreateOrUpdate", + "x-ms-examples": { + "VirtualWANCreate": { "$ref": "./examples/VirtualWANPut.json" } + }, + "description": "Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being created or updated." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "WANParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualWAN" + }, + "description": "Parameters supplied to create or update VirtualWAN." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN created or updated.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualWAN resource.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualWANs" + ], + "operationId": "VirtualWANs_UpdateTags", + "x-ms-examples": { + "VirtualWANUpdate": { "$ref": "./examples/VirtualWANUpdateTags.json" } + }, + "description": "Updates a VirtualWAN tags.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being updated." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "WANParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to Update VirtualWAN tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN updated.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VirtualWAN updated.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualWANs_Delete", + "x-ms-examples": { + "VirtualWANDelete": { "$ref": "./examples/VirtualWANDelete.json" } + }, + "description": "Deletes a VirtualWAN.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualWAN deleted." + }, + "202": { + "description": "Request received successfully. VirtualWAN deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualWANs exist by the name provided." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans": { + "get": { + "operationId": "VirtualWANs_ListByResourceGroup", + "x-ms-examples": { + "VirtualWANListByResourceGroup": { "$ref": "./examples/VirtualWANListByResourceGroup.json" } + }, + "description": "Lists all the VirtualWANs in a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualWANs in the resource group.", + "schema": { + "$ref": "#/definitions/ListVirtualWANsResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualWans": { + "get": { + "operationId": "VirtualWANs_List", + "x-ms-examples": { + "VirtualWANList": { "$ref": "./examples/VirtualWANList.json" } + }, + "description": "Lists all the VirtualWANs in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualWANs in the subscription.", + "schema": { + "$ref": "#/definitions/ListVirtualWANsResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}": { + "get": { + "operationId": "VpnSites_Get", + "x-ms-examples": { + "VpnSiteGet": { "$ref": "./examples/VpnSiteGet.json" } + }, + "description": "Retrieves the details of a VPNsite.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite retrieved.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "VpnSites_CreateOrUpdate", + "x-ms-examples": { + "VpnSiteCreate": { "$ref": "./examples/VpnSitePut.json" } + }, + "description": "Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being created or updated." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "VpnSiteParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnSite" + }, + "description": "Parameters supplied to create or update VpnSite." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite created or updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VpnSite created or updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VpnSites" + ], + "operationId": "VpnSites_UpdateTags", + "x-ms-examples": { + "VpnSiteUpdate": { "$ref": "./examples/VpnSiteUpdateTags.json" } + }, + "description": "Updates VpnSite tags.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being updated." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "VpnSiteParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VpnSite tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VpnSite updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VpnSites_Delete", + "x-ms-examples": { + "VpnSiteDelete": { "$ref": "./examples/VpnSiteDelete.json" } + }, + "description": "Deletes a VpnSite.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VpnSite deleted." + }, + "202": { + "description": "Request received successfully. VpnSite deletion is in progress" + }, + "204": { + "description": "No VpnSites exist by the name provided." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites": { + "get": { + "operationId": "VpnSites_ListByResourceGroup", + "x-ms-examples": { + "VpnSiteListByResourceGroup": { "$ref": "./examples/VpnSiteListByResourceGroup.json" } + }, + "description": "Lists all the vpnSites in a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the vpnSites in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnSitesResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites": { + "get": { + "operationId": "VpnSites_List", + "x-ms-examples": { + "VpnSiteList": { "$ref": "./examples/VpnSiteList.json" } + }, + "description": "Lists all the VpnSites in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnSites in the subscription.", + "schema": { + "$ref": "#/definitions/ListVpnSitesResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnConfiguration": { + "post": { + "operationId": "VpnSitesConfiguration_Download", + "x-ms-examples": { + "VpnSitesConfigurationDownload": { "$ref": "./examples/VpnSitesConfigurationDownload.json" } + }, + "description": "Gives the sas-url to download the configurations for vpn-sites in a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN for which configuration of all vpn-sites is needed." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetVpnSitesConfigurationRequest" + }, + "description": "Parameters supplied to download vpn-sites configuration." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Follow the location header for sas-url to output blob." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously. Follow the location header for sas-url to output blob." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}": { + "get": { + "operationId": "VirtualHubs_Get", + "x-ms-examples": { + "VirtualHubGet": { "$ref": "./examples/VirtualHubGet.json" } + }, + "description": "Retrieves the details of a VirtualHub.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub retrieved.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "VirtualHubs_CreateOrUpdate", + "x-ms-examples": { + "VirtualHubPut": { "$ref": "./examples/VirtualHubPut.json" } + }, + "description": "Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "virtualHubParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHub" + }, + "description": "Parameters supplied to create or update VirtualHub." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VirtualHub created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualWANs" + ], + "operationId": "VirtualHubs_UpdateTags", + "x-ms-examples": { + "VirtualHubUpdate": { "$ref": "./examples/VirtualHubUpdateTags.json" } + }, + "description": "Updates VirtualHub tags.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "virtualHubParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VirtualHub tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VirtualHub updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualHubs_Delete", + "x-ms-examples": { + "VirtualHubDelete": { "$ref": "./examples/VirtualHubDelete.json" } + }, + "description": "Deletes a VirtualHub.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualHub deleted." + }, + "202": { + "description": "Request received successfully. VirtualHub deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualHubs exist by the name provided." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs": { + "get": { + "operationId": "VirtualHubs_ListByResourceGroup", + "x-ms-examples": { + "VirtualHubListByResourceGroup": { "$ref": "./examples/VirtualHubListByResourceGroup.json" } + }, + "description": "Lists all the VirtualHubs in a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubs in the resource group.", + "schema": { + "$ref": "#/definitions/ListVirtualHubsResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs": { + "get": { + "operationId": "VirtualHubs_List", + "x-ms-examples": { + "VirtualHubList": { "$ref": "./examples/VirtualHubList.json" } + }, + "description": "Lists all the VirtualHubs in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubs in the subscription.", + "schema": { + "$ref": "#/definitions/ListVirtualHubsResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}": { + "get": { + "operationId": "HubVirtualNetworkConnections_Get", + "x-ms-examples": { + "HubVirtualNetworkConnectionGet": { "$ref": "./examples/HubVirtualNetworkConnectionGet.json" } + }, + "description": "Retrieves the details of a HubVirtualNetworkConnection.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the HubVirtualNetworkConnection retrieved.", + "schema": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections": { + "get": { + "operationId": "HubVirtualNetworkConnections_List", + "x-ms-examples": { + "HubVirtualNetworkConnectionList": { "$ref": "./examples/HubVirtualNetworkConnectionList.json" } + }, + "description": "Retrieves the details of all HubVirtualNetworkConnections.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the HubVirtualNetworkConnections for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListHubVirtualNetworkConnectionsResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}": { + "get": { + "operationId": "VpnGateways_Get", + "x-ms-examples": { + "VpnGatewayGet": { "$ref": "./examples/VpnGatewayGet.json" } + }, + "description": "Retrieves the details of a virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "VpnGateways_CreateOrUpdate", + "x-ms-examples": { + "VpnGatewayPut": { "$ref": "./examples/VpnGatewayPut.json" } + }, + "description": "Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "vpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnGateway" + }, + "description": "Parameters supplied to create or Update a virtual wan vpn gateway." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan vpn Gateway created or updated.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "201": { + "description": "Request successful. Returns the details of the virtual wan vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VpnGateways" + ], + "operationId": "VpnGateways_UpdateTags", + "x-ms-examples": { + "VpnGatewayUpdate": { "$ref": "./examples/VpnGatewayUpdateTags.json" } + }, + "description": "Updates virtual wan vpn gateway tags.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "vpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update a virtual wan vpn gateway tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the updated gateway.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the updated gateway.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VpnGateways_Delete", + "x-ms-examples": { + "VpnGatewayDelete": { "$ref": "./examples/VpnGatewayDelete.json" } + }, + "description": "Deletes a virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Vpn Gateway deleted." + }, + "202": { + "description": "Request received successfully. Vpn Gateway deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No vpn gateways exist by the name provided." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways": { + "get": { + "operationId": "VpnGateways_ListByResourceGroup", + "x-ms-examples": { + "VpnGatewayListByResourceGroup": { "$ref": "./examples/VpnGatewayListByResourceGroup.json" } + }, + "description": "Lists all the VpnGateways in a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnGateways in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnGatewaysResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnGateways": { + "get": { + "operationId": "VpnGateways_List", + "x-ms-examples": { + "VpnGatewayListBySubscription": { "$ref": "./examples/VpnGatewayList.json" } + }, + "description": "Lists all the VpnGateways in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnGateways in the subscription.", + "schema": { + "$ref": "#/definitions/ListVpnGatewaysResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}": { + "get": { + "operationId": "VpnConnections_Get", + "x-ms-examples": { + "VpnConnectionGet": { "$ref": "./examples/VpnConnectionGet.json" } + }, + "description": "Retrieves the details of a vpn connection.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the vpn connection.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "VpnConnections_CreateOrUpdate", + "x-ms-examples": { + "VpnConnectionPut": { "$ref": "./examples/VpnConnectionPut.json" } + }, + "description": "Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "VpnConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnConnection" + }, + "description": "Parameters supplied to create or Update a VPN Connection." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the vpn connection created or updated.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "201": { + "description": "Request successful. Returns the details of the vpn connection created or updated.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VpnConnections_Delete", + "x-ms-examples": { + "VpnConnectionDelete": { "$ref": "./examples/VpnConnectionDelete.json" } + }, + "description": "Deletes a vpn connection.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Vpn Connection deleted." + }, + "202": { + "description": "Request received successfully. Vpn Connection deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No vpn connections exist by the name provided." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections": { + "get": { + "operationId": "VpnConnections_ListByVpnGateway", + "x-ms-examples": { + "VpnConnectionList": { "$ref": "./examples/VpnConnectionList.json" } + }, + "description": "Retrieves all vpn connections for a particular virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all Vpn connections for a virtual wan vpn gateway.", + "schema": { + "$ref": "#/definitions/ListVpnConnectionsResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VirtualWanProperties": { + "properties": { + "disableVpnEncryption": { + "type": "boolean", + "description": "Vpn encryption to be disabled or not." + }, + "virtualHubs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of VirtualHubs in the VirtualWAN." + }, + "vpnSites": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + } + }, + "description": "Parameters for VirtualWAN" + }, + "VirtualWAN": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualWanProperties" + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VirtualWAN Resource." + }, + "ListVirtualWANsResult": { + "description": "Result of the request to list VirtualWANs. It contains a list of VirtualWANs and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualWAN" + }, + "description": "List of VirtualWANs." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnSiteProperties": { + "properties": { + "virtualWAN": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualWAN to which the vpnSite belongs" + }, + "deviceProperties": { + "description": "The device properties", + "$ref": "#/definitions/DeviceProperties" + }, + "ipAddress": { + "type": "string", + "description": "The ip-address for the vpn-site." + }, + "siteKey": { + "type": "string", + "description": "The key for vpn-site that can be used for connections." + }, + "addressSpace": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The AddressSpace that contains an array of IP address ranges." + }, + "bgpProperties": { + "$ref": "./virtualNetworkGateway.json#/definitions/BgpSettings", + "description": "The set of bgp properties." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + } + }, + "description": "Parameters for VpnSite" + }, + "VpnSite": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnSiteProperties" + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VpnSite Resource." + }, + "ListVpnSitesResult": { + "description": "Result of the request to list VpnSites. It contains a list of VpnSites and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnSite" + }, + "description": "List of VpnSites." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "GetVpnSitesConfigurationRequest": { + "properties": { + "vpnSites": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of resource-ids of the vpn-sites for which config is to be downloaded." + }, + "outputBlobSasUrl": { + "type": "string", + "description": "The sas-url to download the configurations for vpn-sites" + } + }, + "description": "List of Vpn-Sites" + }, + "VirtualHubProperties": { + "properties": { + "virtualWan": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualWAN to which the VirtualHub belongs" + }, + "hubVirtualNetworkConnections": { + "type": "array", + "description": "list of all vnet connections with this VirtualHub.", + "items": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + } + }, + "addressPrefix": { + "type": "string", + "description": "Address-prefix for this VirtualHub." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + } + }, + "description": "Parameters for VirtualHub" + }, + "VirtualHub": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualHubProperties" + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VirtualHub Resource." + }, + "ListVirtualHubsResult": { + "description": "Result of the request to list VirtualHubs. It contains a list of VirtualHubs and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualHub" + }, + "description": "List of VirtualHubs." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnGatewayProperties": { + "properties": { + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualHub to which the gateway belongs" + }, + "connections": { + "type": "array", + "description": "list of all vpn connections to the gateway.", + "items": { + "$ref": "#/definitions/VpnConnection" + } + }, + "bgpSettings": { + "$ref": "./virtualNetworkGateway.json#/definitions/BgpSettings", + "description": "Local network gateway's BGP speaker settings." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "policies": { + "description": "The policies applied to this vpn gateway.", + "$ref": "#/definitions/Policies" + } + }, + "description": "Parameters for VpnGateway" + }, + "VpnGateway": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnGatewayProperties" + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VpnGateway Resource." + }, + "ListVpnGatewaysResult": { + "description": "Result of the request to list VpnGateways. It contains a list of VpnGateways and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnGateway" + }, + "description": "List of VpnGateways." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnConnectionProperties": { + "properties": { + "remoteVpnSite": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Id of the connected vpn site." + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "routing weight for vpn connection." + }, + "connectionStatus": { + "description": "The connection status.", + "$ref": "#/definitions/VpnConnectionStatus" + }, + "ingressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Ingress bytes transferred." + }, + "egressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Egress bytes transferred." + }, + "connectionBandwidth": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Expected bandwidth in MBPS." + }, + "sharedKey": { + "type": "string", + "description": "SharedKey for the vpn connection." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag" + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + } + }, + "description": "Parameters for VpnConnection" + }, + "VpnConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnConnectionProperties" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VpnConnection Resource." + }, + "ListVpnConnectionsResult": { + "description": "Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnConnection" + }, + "description": "List of Vpn Connections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "HubVirtualNetworkConnectionProperties": { + "properties": { + "remoteVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the remote virtual network." + }, + "allowHubToRemoteVnetTransit": { + "type": "boolean", + "description": "VirtualHub to RemoteVnet transit to enabled or not." + }, + "allowRemoteVnetToUseHubVnetGateways": { + "type": "boolean", + "description": "Allow RemoteVnet to use Virtual Hub's gateways." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + } + }, + "description": "Parameters for HubVirtualNetworkConnection" + }, + "HubVirtualNetworkConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubVirtualNetworkConnectionProperties" + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "HubVirtualNetworkConnection Resource." + }, + "ListHubVirtualNetworkConnectionsResult": { + "description": "List of HubVirtualNetworkConnections and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + }, + "description": "List of HubVirtualNetworkConnections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnSiteId": { + "properties": { + "vpnSite": { + "type": "string", + "readOnly": true, + "description": "The resource-uri of the vpn-site for which config is to be fetched." + } + }, + "description": "VpnSite Resource." + }, + "DeviceProperties": { + "properties": { + "deviceVendor": { + "type": "string", + "description": "Name of the device Vendor." + }, + "deviceModel": { + "type": "string", + "description": "Model of the device." + }, + "linkSpeedInMbps": { + "type": "integer", + "format": "int32", + "description": "Link speed." + } + }, + "description": "List of properties of the device." + }, + "Policies": { + "properties": { + "allowBranchToBranchTraffic": { + "type": "boolean", + "description": "True if branch to branch traffic is allowed." + }, + "allowVnetToVnetTraffic": { + "type": "boolean", + "description": "True if Vnet to Vnet traffic is allowed." + } + }, + "description": "Policies for vpn gateway." + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisisoning state.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "VpnConnectionStatus": { + "type": "string", + "description": "The current state of the vpn connection.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "vpnConnectionStatus", + "modelAsString": true + } + }, + "TunnelConnectionStatus": { + "type": "string", + "description": "The current state of the tunnel.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "tunnelConnectionStatus", + "modelAsString": true + } + }, + "HubVirtualNetworkConnectionStatus": { + "type": "string", + "description": "The current state of the VirtualHub to vnet connection.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "HubVirtualNetworkConnectionStatus", + "modelAsString": true + } + }, + "disableVpnEncryption": { + "type": "boolean", + "description": "Vpn encryption to be disabled or not." + }, + "access": { + "type": "string", + "description": "Access to be allowed or denied.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "access", + "modelAsString": true + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/vmssNetworkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/vmssNetworkInterface.json new file mode 100644 index 000000000000..274762b6147f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/vmssNetworkInterface.json @@ -0,0 +1,405 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2017-03-30" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetVMNetworkInterfaces", + "description": "Gets information about all network interfaces in a virtual machine in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set vm network interfaces": { "$ref": "./examples/VmssVmNetworkInterfaceList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetNetworkInterfaces", + "description": "Gets all network interfaces in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set network interfaces": { "$ref": "./examples/VmssNetworkInterfaceList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetVirtualMachineScaleSetNetworkInterface", + "description": "Get the specified network interface in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + } + } + }, + "x-ms-examples": { + "Get virtual machine scale set network interface": { "$ref": "./examples/VmssNetworkInterfaceGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipConfigurations": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetIpConfigurations", + "description": "Get the specified network interface ip configuration in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the list of resulting NetworkInterfaceIPConfigurations resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfigurationListResult" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set network interface ip configurations": { "$ref": "./examples/VmssNetworkInterfaceIpConfigList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetVirtualMachineScaleSetIpConfiguration", + "description": "Get the specified network interface ip configuration in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ip configuration." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterfaceIPConfiguration resource.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + } + } + }, + "x-ms-examples": { + "Get virtual machine scale set network interface": { "$ref": "./examples/VmssNetworkInterfaceIpConfigGet.json" } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/vmssPublicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/vmssPublicIpAddress.json new file mode 100644 index 000000000000..c28e7e415513 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/vmssPublicIpAddress.json @@ -0,0 +1,266 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2017-03-30" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/publicipaddresses": { + "get": { + "operationId": "PublicIPAddresses_ListVirtualMachineScaleSetPublicIPAddresses", + "description": "Gets information about all public IP addresses on a virtual machine scale set level.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPInterface resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + } + }, + "x-ms-examples": { + "ListVMSSPublicIP": { "$ref": "./examples/VmssPublicIpListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses" : { + "get": { + "operationId": "PublicIPAddresses_ListVirtualMachineScaleSetVMPublicIPAddresses", + "description": "Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The network interface name." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The IP configuration name." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + } + }, + "x-ms-examples": { + "ListVMSSVMPublicIP": { "$ref": "./examples/VmssVmPublicIpList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses/{publicIpAddressName}": { + "get": { + "operationId": "PublicIPAddresses_GetVirtualMachineScaleSetPublicIPAddress", + "description": "Get the specified public IP address in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the IP configuration." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP Address." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "x-ms-examples": { + "GetVMSSPublicIP": { "$ref": "./examples/VmssPublicIpGet.json" } + }, + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress" + } + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/readme.csharp.md b/specification/network/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..1a63171a11af --- /dev/null +++ b/specification/network/resource-manager/readme.csharp.md @@ -0,0 +1,38 @@ +# C# Network + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DNS. + +## Common Settings + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +## Common Settings +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true +``` + +``` yaml $(csharp) && !$(multiApi) +namespace: Microsoft.Azure.Management.Network +output-folder: $(csharp-sdks-folder)/Network/Management.Network/Generated +``` + +## MultiApi settings +These settings are for batch mode only: (ie, add `--MultiApi` to the command line ) + +``` yaml $(multiApi) +namespace: Microsoft.Azure.Management.Network.$(ApiVersionName) +output-folder: $(csharp-sdks-folder)/$(ApiVersionName)/Generated + +batch: + - tag: package-2017-10 + ApiVersionName: Api2017_10_01 + + - tag: package-2015-06split + ApiVersionName: Api2016_06_15 +``` \ No newline at end of file diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index 0975e00a24fc..cb86027ff016 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -1,4 +1,4 @@ -# Network +# Network > see https://aka.ms/autorest @@ -28,7 +28,40 @@ These are the global settings for the Network API. title: NetworkManagementClient description: Network Client openapi-type: arm -tag: package-2018-02 +tag: package-2018-04 +``` + +### Tag: package-2018-04 + +These settings apply only when `--tag=package-2018-04` is specified on the command line. + +``` yaml $(tag) == 'package-2018-04' + +input-file: +- Microsoft.Network/stable/2018-04-01/azureFirewall.json +- Microsoft.Network/stable/2018-04-01/applicationGateway.json +- Microsoft.Network/stable/2018-04-01/applicationSecurityGroup.json +- Microsoft.Network/stable/2018-04-01/checkDnsAvailability.json +- Microsoft.Network/stable/2018-04-01/ddosProtectionPlan.json +- Microsoft.Network/stable/2018-04-01/endpointService.json +- Microsoft.Network/stable/2018-04-01/expressRouteCircuit.json +- Microsoft.Network/stable/2018-04-01/expressRouteCrossConnection.json +- Microsoft.Network/stable/2018-04-01/loadBalancer.json +- Microsoft.Network/stable/2018-04-01/network.json +- Microsoft.Network/stable/2018-04-01/networkInterface.json +- Microsoft.Network/stable/2018-04-01/networkSecurityGroup.json +- Microsoft.Network/stable/2018-04-01/networkWatcher.json +- Microsoft.Network/stable/2018-04-01/operation.json +- Microsoft.Network/stable/2018-04-01/publicIpAddress.json +- Microsoft.Network/stable/2018-04-01/routeFilter.json +- Microsoft.Network/stable/2018-04-01/routeTable.json +- Microsoft.Network/stable/2018-04-01/serviceCommunity.json +- Microsoft.Network/stable/2018-04-01/usage.json +- Microsoft.Network/stable/2018-04-01/virtualNetwork.json +- Microsoft.Network/stable/2018-04-01/virtualNetworkGateway.json +- Microsoft.Network/stable/2018-04-01/virtualWan.json +- Microsoft.Network/stable/2018-04-01/vmssNetworkInterface.json +- Microsoft.Network/stable/2018-04-01/vmssPublicIpAddress.json ``` ### Tag: package-2018-02 @@ -90,6 +123,32 @@ input-file: - Microsoft.Network/stable/2018-01-01/vmssPublicIpAddress.json ``` +### Tag: package-2018-01-only + +These settings apply only when `--tag=package-2018-01` is specified on the command line. + +``` yaml $(tag) == 'package-2018-01-only' +input-file: +- Microsoft.Network/stable/2018-01-01/applicationGateway.json +- Microsoft.Network/stable/2018-01-01/applicationSecurityGroup.json +- Microsoft.Network/stable/2018-01-01/checkDnsAvailability.json +- Microsoft.Network/stable/2018-01-01/endpointService.json +- Microsoft.Network/stable/2018-01-01/expressRouteCircuit.json +- Microsoft.Network/stable/2018-01-01/loadBalancer.json +- Microsoft.Network/stable/2018-01-01/network.json +- Microsoft.Network/stable/2018-01-01/networkInterface.json +- Microsoft.Network/stable/2018-01-01/networkSecurityGroup.json +- Microsoft.Network/stable/2018-01-01/networkWatcher.json +- Microsoft.Network/stable/2018-01-01/operation.json +- Microsoft.Network/stable/2018-01-01/publicIpAddress.json +- Microsoft.Network/stable/2018-01-01/routeFilter.json +- Microsoft.Network/stable/2018-01-01/routeTable.json +- Microsoft.Network/stable/2018-01-01/serviceCommunity.json +- Microsoft.Network/stable/2018-01-01/usage.json +- Microsoft.Network/stable/2018-01-01/virtualNetwork.json +- Microsoft.Network/stable/2018-01-01/virtualNetworkGateway.json +``` + ### Tag: package-2017-11 These settings apply only when `--tag=package-2017-11` is specified on the command line. @@ -118,6 +177,32 @@ input-file: - Microsoft.Network/stable/2017-11-01/vmssPublicIpAddress.json ``` +### Tag: package-2017-11-only + +These settings apply only when `--tag=package-2017-11-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-11-only' +input-file: +- Microsoft.Network/stable/2017-11-01/applicationGateway.json +- Microsoft.Network/stable/2017-11-01/applicationSecurityGroup.json +- Microsoft.Network/stable/2017-11-01/checkDnsAvailability.json +- Microsoft.Network/stable/2017-11-01/endpointService.json +- Microsoft.Network/stable/2017-11-01/expressRouteCircuit.json +- Microsoft.Network/stable/2017-11-01/loadBalancer.json +- Microsoft.Network/stable/2017-11-01/network.json +- Microsoft.Network/stable/2017-11-01/networkInterface.json +- Microsoft.Network/stable/2017-11-01/networkSecurityGroup.json +- Microsoft.Network/stable/2017-11-01/networkWatcher.json +- Microsoft.Network/stable/2017-11-01/operation.json +- Microsoft.Network/stable/2017-11-01/publicIpAddress.json +- Microsoft.Network/stable/2017-11-01/routeFilter.json +- Microsoft.Network/stable/2017-11-01/routeTable.json +- Microsoft.Network/stable/2017-11-01/serviceCommunity.json +- Microsoft.Network/stable/2017-11-01/usage.json +- Microsoft.Network/stable/2017-11-01/virtualNetwork.json +- Microsoft.Network/stable/2017-11-01/virtualNetworkGateway.json +``` + ### Tag: package-2017-10 These settings apply only when `--tag=package-2017-10` is specified on the command line. @@ -146,6 +231,32 @@ input-file: - Microsoft.Network/stable/2017-10-01/vmssPublicIpAddress.json ``` +### Tag: package-2017-10-only + +These settings apply only when `--tag=package-2017-10-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-10-only' +input-file: +- Microsoft.Network/stable/2017-10-01/applicationGateway.json +- Microsoft.Network/stable/2017-10-01/applicationSecurityGroup.json +- Microsoft.Network/stable/2017-10-01/checkDnsAvailability.json +- Microsoft.Network/stable/2017-10-01/endpointService.json +- Microsoft.Network/stable/2017-10-01/expressRouteCircuit.json +- Microsoft.Network/stable/2017-10-01/loadBalancer.json +- Microsoft.Network/stable/2017-10-01/network.json +- Microsoft.Network/stable/2017-10-01/networkInterface.json +- Microsoft.Network/stable/2017-10-01/networkSecurityGroup.json +- Microsoft.Network/stable/2017-10-01/networkWatcher.json +- Microsoft.Network/stable/2017-10-01/operation.json +- Microsoft.Network/stable/2017-10-01/publicIpAddress.json +- Microsoft.Network/stable/2017-10-01/routeFilter.json +- Microsoft.Network/stable/2017-10-01/routeTable.json +- Microsoft.Network/stable/2017-10-01/serviceCommunity.json +- Microsoft.Network/stable/2017-10-01/usage.json +- Microsoft.Network/stable/2017-10-01/virtualNetwork.json +- Microsoft.Network/stable/2017-10-01/virtualNetworkGateway.json +``` + ### Tag: package-2017-09 These settings apply only when `--tag=package-2017-09` is specified on the command line. @@ -174,6 +285,32 @@ input-file: - Microsoft.Network/stable/2017-09-01/vmssPublicIpAddress.json ``` +### Tag: package-2017-09-only + +These settings apply only when `--tag=package-2017-09-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-09-only' +input-file: +- Microsoft.Network/stable/2017-09-01/applicationGateway.json +- Microsoft.Network/stable/2017-09-01/applicationSecurityGroup.json +- Microsoft.Network/stable/2017-09-01/checkDnsAvailability.json +- Microsoft.Network/stable/2017-09-01/endpointService.json +- Microsoft.Network/stable/2017-09-01/expressRouteCircuit.json +- Microsoft.Network/stable/2017-09-01/loadBalancer.json +- Microsoft.Network/stable/2017-09-01/network.json +- Microsoft.Network/stable/2017-09-01/networkInterface.json +- Microsoft.Network/stable/2017-09-01/networkSecurityGroup.json +- Microsoft.Network/stable/2017-09-01/networkWatcher.json +- Microsoft.Network/stable/2017-09-01/operation.json +- Microsoft.Network/stable/2017-09-01/publicIpAddress.json +- Microsoft.Network/stable/2017-09-01/routeFilter.json +- Microsoft.Network/stable/2017-09-01/routeTable.json +- Microsoft.Network/stable/2017-09-01/serviceCommunity.json +- Microsoft.Network/stable/2017-09-01/usage.json +- Microsoft.Network/stable/2017-09-01/virtualNetwork.json +- Microsoft.Network/stable/2017-09-01/virtualNetworkGateway.json +``` + ### Tag: package-2017-08 These settings apply only when `--tag=package-2017-08` is specified on the command line. @@ -253,6 +390,39 @@ input-file: - Microsoft.Network/stable/2017-03-01/vmssPublicIpAddress.json ``` +### Tag: package-2017-03-only + +These settings apply only when `--tag=package-2017-03-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-03-only' +input-file: +- Microsoft.Network/stable/2017-03-01/applicationGateway.json +- Microsoft.Network/stable/2017-03-01/checkDnsAvailability.json +- Microsoft.Network/stable/2017-03-01/expressRouteCircuit.json +- Microsoft.Network/stable/2017-03-01/loadBalancer.json +- Microsoft.Network/stable/2017-03-01/network.json +- Microsoft.Network/stable/2017-03-01/networkInterface.json +- Microsoft.Network/stable/2017-03-01/networkSecurityGroup.json +- Microsoft.Network/stable/2017-03-01/networkWatcher.json +- Microsoft.Network/stable/2017-03-01/publicIpAddress.json +- Microsoft.Network/stable/2017-03-01/routeFilter.json +- Microsoft.Network/stable/2017-03-01/routeTable.json +- Microsoft.Network/stable/2017-03-01/serviceCommunity.json +- Microsoft.Network/stable/2017-03-01/usage.json +- Microsoft.Network/stable/2017-03-01/virtualNetwork.json +- Microsoft.Network/stable/2017-03-01/virtualNetworkGateway.json +``` + +### Tag: package-2017-03-30-only + +These settings apply only when `--tag=package-2017-03-30-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-03-30-only' +input-file: +- Microsoft.Network/stable/2017-09-01/vmssNetworkInterface.json +- Microsoft.Network/stable/2017-09-01/vmssPublicIpAddress.json +``` + ### Tag: package-2016-12 These settings apply only when `--tag=package-2016-12` is specified on the command line. @@ -347,6 +517,102 @@ input-file: - Microsoft.Network/preview/2015-05-01-preview/network.json ``` +## Suppression +``` yaml +directive: + - suppress: RequiredPropertiesMissingInResourceModel + from: applicationGateway.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: applicationSecurityGroup.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: azureFirewall.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: checkDnsAvailability.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: ddosProtectionPlan.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: endpointService.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: expressRouteCircuit.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: expressRouteCrossConnection.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: loadBalancer.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: networkInterface.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: networkSecurityGroup.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: networkWatcher.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: operation.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: publicIpAddress.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: routeFilter.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: routeTable.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: serviceCommunity.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: usage.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: virtualNetwork.json + reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: virtualNetworkGateway.json + reason: name, id and type properties are inherited from the upper level + - suppress: TrackedResourceListByImmediateParent + reason: Another list APIs naming approach is used over the specs + - suppress: EnumInsteadOfBoolean + reason: Booleans are used by networking APIs + - suppress: GetInOperationName + where: $.paths["/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/CheckDnsNameAvailability"].get.operationId + reason: Customized verb is used for API + - suppress: GetInOperationName + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/CheckIPAddressAvailability"].get.operationId + reason: Customized verb is used for API + - suppress: PutInOperationName + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey"].put.operationId + reason: Customized verb is used for API + - suppress: PostOperationIdContainsUrlVerb + from: networkWatcher.json + reason: Customized verbs are used for API + - suppress: PostOperationIdContainsUrlVerb + from: expressRouteCircuit.json + reason: Customized verbs are used for API + - suppress: PostOperationIdContainsUrlVerb + from: expressRouteCrossConnection.json + reason: Customized verbs are used for API + - suppress: OperationIdNounVerb + from: vmssPublicIpAddress.json + reason: VMSS specs have custom naming + - suppress: OperationIdNounVerb + from: vmssNetworkInterface.json + reason: VMSS specs have custom naming + - suppress: BodyTopLevelProperties + from: virtualNetworkGateway.json + reason: shipped. fixing this causes breaking change in resource +``` + --- # Code Generation @@ -361,27 +627,14 @@ swagger-to-sdk: - repo: azure-sdk-for-python after_scripts: - python ./scripts/multiapi_init_gen.py azure-mgmt-network - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_network'] ``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Network - output-folder: $(csharp-sdks-folder)/Network/Management.Network/Generated - clear-output-folder: true -``` - - ## Go These settings apply only when `--go` is specified on the command line. @@ -397,6 +650,8 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-05 + - tag: package-2018-04 - tag: package-2018-02 - tag: package-2018-01 - tag: package-2017-11 @@ -413,6 +668,24 @@ batch: - tag: package-2015-05-preview ``` +### Tag: package-2018-05 and go + +These settings apply only when `--tag=package-2018-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-05' && $(go) +output-folder: $(go-sdk-folder)/services/network/mgmt/2018-05-01/network +``` + +### Tag: package-2018-04 and go + +These settings apply only when `--tag=package-2018-04 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-04' && $(go) +output-folder: $(go-sdk-folder)/services/network/mgmt/2018-04-01/network +``` + ### Tag: package-2018-02 and go These settings apply only when `--tag=package-2018-02 --go` is specified on the command line. @@ -422,6 +695,26 @@ Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-05-preview' && $(go) -output-folder: $(go-sdk-folder)/services/network/mgmt/2015-05-01-preview/network +output-folder: $(go-sdk-folder)/services/preview/network/mgmt/2015-05-01-preview/network ``` @@ -560,6 +853,7 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: + - tag: package-2018-04 - tag: package-2018-02 - tag: package-2018-01 - tag: package-2017-11 @@ -573,6 +867,17 @@ batch: - tag: package-2015-06split ``` +### Tag: package-2018-04 and python + +These settings apply only when `--tag=package-2018-04 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-04' && $(python) +python: + namespace: azure.mgmt.network.v2018_04_01 + output-folder: $(python-sdks-folder)/azure-mgmt-network/azure/mgmt/network/v2018_04_01 +``` + ### Tag: package-2018-02 and python These settings apply only when `--tag=package-2018-02 --python` is specified on the command line. @@ -701,11 +1006,58 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.network +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-network +``` + +### Java multi-api + +```yaml $(java) && $(multiapi) +batch: + - tag: package-2018-04 + - tag: package-2018-05 + - tag: package-2017-10 +``` + +### Tag: package-2018-04 and java + +These settings apply only when `--tag=package-2018-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-04' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.network - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-network + namespace: com.microsoft.azure.management.network.v2018_04_01 + output-folder: $(azure-libraries-for-java-folder)/network/resource-manager/v2018_04_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-05 and java + +These settings apply only when `--tag=package-2018-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.network.v2018_05_01 + output-folder: $(azure-libraries-for-java-folder)/network/resource-manager/v2018_05_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-10 and java + +These settings apply only when `--tag=package-2017-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.network.v2017_10_01 + output-folder: $(azure-libraries-for-java-folder)/network/resource-manager/v2017_10_01 +regenerate-manager: true +generate-interface: true ``` diff --git a/specification/network/resource-manager/readme.ruby.md b/specification/network/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..468105cf3705 --- /dev/null +++ b/specification/network/resource-manager/readme.ruby.md @@ -0,0 +1,147 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_network +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2015-05-preview + - tag: package-2015-06split + - tag: package-2016-03 + - tag: package-2016-06 + - tag: package-2016-09 + - tag: package-2016-12 + - tag: package-2017-03-only + - tag: package-2017-03-30-only + - tag: package-2017-09-only + - tag: package-2017-10-only + - tag: package-2017-11-only + - tag: package-2018-01-only +``` + +### Tag: package-2015-05-preview and ruby + +These settings apply only when `--tag=package-2015-05-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-05-preview' && $(ruby) +namespace: "Azure::Network::Mgmt::V2015_05_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_network/lib +``` + +### Tag: package-2015-06split and ruby + +These settings apply only when `--tag=package-2015-06split --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-06split' && $(ruby) +namespace: "Azure::Network::Mgmt::V2015_06_15" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_network/lib +``` + +### Tag: package-2016-03 and ruby + +These settings apply only when `--tag=package-2016-03 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-03' && $(ruby) +namespace: "Azure::Network::Mgmt::V2016_03_30" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_network/lib +``` + +### Tag: package-2016-06 and ruby + +These settings apply only when `--tag=package-2016-06 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-06' && $(ruby) +namespace: "Azure::Network::Mgmt::V2016_06_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_network/lib +``` + +### Tag: package-2016-09 and ruby + +These settings apply only when `--tag=package-2016-09 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-09' && $(ruby) +namespace: "Azure::Network::Mgmt::V2016_09_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_network/lib +``` + +### Tag: package-2016-12 and ruby + +These settings apply only when `--tag=package-2016-12 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-12' && $(ruby) +namespace: "Azure::Network::Mgmt::V2016_12_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_network/lib +``` + +### Tag: package-2017-03-only and ruby + +These settings apply only when `--tag=package-2017-03-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-03-only' && $(ruby) +namespace: "Azure::Network::Mgmt::V2017_03_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_network/lib +``` + +### Tag: package-2017-03-30-only and ruby + +These settings apply only when `--tag=package-2017-03-30-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-03-30-only' && $(ruby) +namespace: "Azure::Network::Mgmt::V2017_03_30" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_network/lib +``` + +### Tag: package-2017-09-only and ruby + +These settings apply only when `--tag=package-2017-09-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-09-only' && $(ruby) +namespace: "Azure::Network::Mgmt::V2017_09_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_network/lib +``` + +### Tag: package-2017-10-only and ruby + +These settings apply only when `--tag=package-2017-10-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-10-only' && $(ruby) +namespace: "Azure::Network::Mgmt::V2017_10_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_network/lib +``` + +### Tag: package-2017-11-only and ruby + +These settings apply only when `--tag=package-2017-11-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-11-only' && $(ruby) +namespace: "Azure::Network::Mgmt::V2017_11_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_network/lib +``` + +### Tag: package-2018-01-only and ruby + +These settings apply only when `--tag=package-2018-01-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-01-only' && $(ruby) +namespace: "Azure::Network::Mgmt::V2018_01_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_network/lib +``` diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NHOperationsList.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NHOperationsList.json new file mode 100644 index 000000000000..b5fe90e25f3a --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NHOperationsList.json @@ -0,0 +1,247 @@ +{ + "parameters": { + "api-version": "2017-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.NotificationHubs/register/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Microsoft Azure Notification Hub", + "operation": "Registers the NotificationHubs Provider", + "description": "Registers the subscription for the NotifciationHubs resource provider and enables the creation of Namespaces and NotificationHubs" + } + }, + { + "name": "Microsoft.NotificationHubs/unregister/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Microsoft Azure Notification Hub", + "operation": "Unregisters the NotificationHubs Provider", + "description": "Unregisters the subscription for the NotifciationHubs resource provider and enables the creation of Namespaces and NotificationHubs" + } + }, + { + "name": "Microsoft.NotificationHubs/operationResults/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Microsoft Azure Notification Hub", + "operation": "Operation results for Notification Hubs provider", + "description": "Returns operation results for Notification Hubs provider" + } + }, + { + "name": "Microsoft.NotificationHubs/CheckNamespaceAvailability/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Microsoft Azure Notification Hub", + "operation": "Get namespace availability.", + "description": "Checks availability of namespace under given subscription." + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/write", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace", + "operation": "Create Or Update Namespace ", + "description": "Create a Namespace Resource and Update its properties. Tags and status of the Namespace are the properties which can be updated." + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/read", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "Namespace", + "operation": "Get Namespace Resource", + "description": "Get the list of Namespace Resource Description" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/Delete", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "Namespace", + "operation": "Delete Namespace", + "description": "Delete Namespace Resource" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/authorizationRules/write", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "AuthorizationRules", + "operation": "Create or Update Namespace Authorization Rules", + "description": "Create a Namespace level Authorization Rules and update its properties. The Authorization Rules Access Rights, the Primary and Secondary Keys can be updated." + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/authorizationRules/action", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "AuthorizationRules", + "operation": "Get Namespace Authorization Rules", + "description": "Get the list of Namespaces Authorization Rules description." + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/authorizationRules/read", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "AuthorizationRules", + "operation": "Get Namespace Authorization Rules", + "description": "Get the list of Namespaces Authorization Rules description." + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "AuthorizationRules", + "operation": "Delete Namespace Authorization Rule", + "description": "Delete Namespace Authorization Rule. The Default Namespace Authorization Rule cannot be deleted. " + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "AuthorizationRules", + "operation": "Get Namespace Listkeys", + "description": "Get the Connection String to the Namespace" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "AuthorizationRules", + "operation": "Resource Regeneratekeys", + "description": "Regenerate the Primary or Secondary key to the Resource" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/CheckNotificationHubAvailability/action", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "AuthorizationRules", + "operation": "CheckNotificationHubAvailability", + "description": "Checks whether or not a given NotificationHub name is available inside a Namespace" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/notificationHubs/write", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "NotificationHub", + "operation": "Create or Update notification hub", + "description": "Create or Update notificationHub properties." + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/notificationHubs/read", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "NotificationHub", + "operation": "Get notification hub", + "description": "Get notification hub resource" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/notificationHubs/Delete", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "NotificationHub", + "operation": "Delete notification hub", + "description": "Operation to delete notification hub resource" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules/write", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "NotificationHub Authorization Rule", + "operation": "Create or Update NotificationHub Authorization Rule", + "description": "Create NotificationHub Authorization Rules and Update its properties. The Authorization Rules Access Rights, the Primary and Secondary Keys can be updated." + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules/action", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "NotificationHub AuthorizationRules", + "operation": " Get NotificationHub Authorization Rules", + "description": " Get the list of NotificationHub Authorization Rules" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules/read", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "NotificationHub AuthorizationRules", + "operation": " Get NotificationHub Authorization Rules", + "description": " Get the list of NotificationHub Authorization Rules" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "NotificationHub AuthorizationRules", + "operation": "Delete NotificationHub Authorization Rules", + "description": "Operation to delete NotificationHub Authorization Rules" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "NotificationHub AuthorizationRules", + "operation": "List NotificationHub keys", + "description": "Get the Connection String to NotificationHub" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "NotificationHub AuthorizationRules", + "operation": "Resource Regeneratekeys", + "description": "Regenerate the Primary or Secondary key to the Resource" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/pnsCredentials/action", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "NotificationHub PnsCredential", + "operation": "Resource Get Notification Hub PNS Credentials", + "description": "Get All Notification Hub PNS Credentials. This includes, WNS, MPNS, APNS, GCM and Baidu credentials" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/debugSend/action", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "NotificationHub resource", + "operation": "Send a test push notification", + "description": "Send a test push notification" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/metricDefinitions/read", + "display": { + "provider": "Microsoft Azure NotificationHubs", + "resource": "NotificationHub metrics", + "operation": "Get NotificationHub metrics", + "description": "Get list of Namespace metrics Resource Descriptions" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleCreate.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleCreate.json new file mode 100644 index 000000000000..84d19ba9971a --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleCreate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "5ktrial", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "location": "West Europe", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/ArunMonocle/providers/Microsoft.NotificationHubs/namespaces/sdk-Namespace-6914/AuthorizationRules/sdk-AuthRules-1788", + "name": "sdk-AuthRules-1788", + "type": "Microsoft.NotificationHubs/Namespaces/AuthorizationRules", + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleDelete.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleDelete.json new file mode 100644 index 000000000000..e86818c2347b --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "authorizationRuleName": "RootManageSharedAccessKey", + "resourceGroupName": "5ktrial", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleGet.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleGet.json new file mode 100644 index 000000000000..4c291461aac0 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "authorizationRuleName": "RootManageSharedAccessKey", + "resourceGroupName": "5ktrial", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/AuthorizationRules/RootManageSharedAccessKey", + "name": "RootManageSharedAccessKey", + "type": "Microsoft.NotificationHubs/Namespaces/AuthorizationRules", + "location": "South Central US", + "tags": null, + "properties": { + "keyName": "RootManageSharedAccessKey", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "claimType": "SharedAccessKey", + "claimValue": "None", + "rights": [ + "Listen", + "Manage", + "Send" + ], + "createdTime": "2018-05-02T18:24:51.0690674Z", + "modifiedTime": "2018-05-02T18:24:51.0690674Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleListAll.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleListAll.json new file mode 100644 index 000000000000..74949466bb05 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleListAll.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/AuthorizationRules/RootManageSharedAccessKey", + "name": "RootManageSharedAccessKey", + "type": "Microsoft.NotificationHubs/Namespaces/AuthorizationRules", + "location": null, + "tags": null, + "properties": { + "keyName": "RootManageSharedAccessKey", + "primaryKey": "e5FIqldZtpiWCwXfFn/MfofvpaqRpB2NzAlq+kGtoZ8=", + "secondaryKey": "p88zp8l/FSPLQyzOj2t2jMZk1k463SoFcQ13ritYjmI=", + "claimType": "SharedAccessKey", + "claimValue": "None", + "rights": [ + "Listen", + "Manage", + "Send" + ], + "createdTime": "2018-05-02T18:24:51.0690674Z", + "modifiedTime": "2018-05-02T18:31:28.5201555Z", + "revision": 1 + } + } + ], + "nextLink": null + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleListKey.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleListKey.json new file mode 100644 index 000000000000..f5b04f9c6ae9 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleListKey.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "authorizationRuleName": "RootManageSharedAccessKey", + "resourceGroupName": "5ktrial", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/AuthorizationRules/RootManageSharedAccessKey", + "name": "RootManageSharedAccessKey", + "type": "Microsoft.NotificationHubs/Namespaces/AuthorizationRules", + "location": null, + "tags": null, + "properties": { + "keyName": "RootManageSharedAccessKey", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "claimType": "SharedAccessKey", + "claimValue": "None", + "rights": [ + "Listen", + "Manage", + "Send" + ], + "createdTime": "2018-05-02T18:24:51.0690674Z", + "modifiedTime": "2018-05-02T18:24:51.0690674Z" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleRegenrateKey.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleRegenrateKey.json new file mode 100644 index 000000000000..be2d6daa5c4a --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleRegenrateKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "authorizationRuleName": "RootManageSharedAccessKey", + "resourceGroupName": "5ktrial", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "policyKey": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################", + "secondaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "RootManageSharedAccessKey" + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleUpdate.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleUpdate.json new file mode 100644 index 000000000000..24dbdc12a059 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceAuthorizationRuleUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "authorizationRuleName": "MyManageSharedAccessKey", + "resourceGroupName": "5ktrial", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "properties": { + "rights": [ + "Listen" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/AuthorizationRules/MyManageSharedAccessKey", + "name": "MyManageSharedAccessKey", + "type": "Microsoft.NotificationHubs/Namespaces/AuthorizationRules", + "location": null, + "tags": null, + "properties": { + "keyName": "MyManageSharedAccessKey", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "claimType": "SharedAccessKey", + "claimValue": "None", + "rights": [ + "Listen" + ], + "createdTime": "2018-05-02T18:24:51.0690674Z", + "modifiedTime": "2018-05-02T18:24:51.0690674Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceCheckNameAvailability.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceCheckNameAvailability.json new file mode 100644 index 000000000000..404417e9d9b4 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceCheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "name": "sdk-Namespace-2924" + } + }, + "responses": { + "200": { + "body": { + "isAvailiable": false, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/providers/Microsoft.NotificationHubs/CheckNamespaceAvailability", + "name": "mytestnamespace", + "type": "Microsoft.NotificationHubs/namespaces/checkNamespaceAvailability", + "location": "West Europe", + "tags": null + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceCreate.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceCreate.json new file mode 100644 index 000000000000..f4a97d74f754 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceCreate.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/ArunMonocle/providers/Microsoft.NotificationHubs/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Created", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:36.76Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/" + } + } + }, + "201": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/ArunMonocle/providers/Microsoft.NotificationHubs/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Created", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:36.76Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/" + } + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceDelete.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceDelete.json new file mode 100644 index 000000000000..6b3fb662c4c2 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceGet.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceGet.json new file mode 100644 index 000000000000..68bf51348d1f --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns", + "name": "nh-sdk-ns", + "type": "Microsoft.NotificationHubs/namespaces", + "location": "South Central US", + "sku": { + "name": "Basic" + }, + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": null, + "status": "Active", + "createdAt": "2018-05-02T00:44:56.58Z", + "serviceBusEndpoint": "https://nh-sdk-ns.servicebus.windows.net:443/", + "enabled": true, + "critical": false, + "scaleUnit": "SN1-001", + "dataCenter": "SN1", + "updatedAt": "2018-05-02T01:02:19.79Z", + "namespaceType": "NotificationHub" + } + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceList.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceList.json new file mode 100644 index 000000000000..0aaeb2151247 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceList.json @@ -0,0 +1,773 @@ +{ + "parameters": { + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-91f08e47-2b04-4943-b0cd-a5fb02b88f20", + "name": "NS-91f08e47-2b04-4943-b0cd-a5fb02b88f20", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-91f08e47-2b04-4943-b0cd-a5fb02b88f20", + "createdAt": "2016-08-23T02:40:17.27Z", + "updatedAt": "2017-02-11T07:15:30.78Z", + "serviceBusEndpoint": "https://NS-91f08e47-2b04-4943-b0cd-a5fb02b88f20.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-41dc63f4-0b08-4029-b3ef-535a131bfa65", + "name": "NS-41dc63f4-0b08-4029-b3ef-535a131bfa65", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-41dc63f4-0b08-4029-b3ef-535a131bfa65", + "createdAt": "2016-08-23T03:50:38.98Z", + "updatedAt": "2017-02-11T10:42:58.003Z", + "serviceBusEndpoint": "https://NS-41dc63f4-0b08-4029-b3ef-535a131bfa65.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-df52cf51-e831-4bf2-bd92-e9885f68a996", + "name": "NS-df52cf51-e831-4bf2-bd92-e9885f68a996", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-df52cf51-e831-4bf2-bd92-e9885f68a996", + "createdAt": "2016-09-16T01:17:54.997Z", + "updatedAt": "2017-02-11T06:44:39.737Z", + "serviceBusEndpoint": "https://NS-df52cf51-e831-4bf2-bd92-e9885f68a996.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/sadfsadfsadf/providers/Microsoft.NotificationHubs/namespaces/rrama-ns2", + "name": "rrama-ns2", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:rrama-ns2", + "createdAt": "2016-08-23T04:14:00.013Z", + "updatedAt": "2017-02-03T22:53:32.927Z", + "serviceBusEndpoint": "https://rrama-ns2.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-20e57600-29d0-4035-ac85-74f4c54dcda1", + "name": "NS-20e57600-29d0-4035-ac85-74f4c54dcda1", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-20e57600-29d0-4035-ac85-74f4c54dcda1", + "createdAt": "2016-08-23T03:30:49.16Z", + "updatedAt": "2017-02-11T04:17:58.483Z", + "serviceBusEndpoint": "https://NS-20e57600-29d0-4035-ac85-74f4c54dcda1.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-3e538a1a-58fb-4315-b2ce-76f5c944114c", + "name": "NS-3e538a1a-58fb-4315-b2ce-76f5c944114c", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-3e538a1a-58fb-4315-b2ce-76f5c944114c", + "createdAt": "2016-09-16T18:07:30.05Z", + "updatedAt": "2017-02-11T10:42:57.747Z", + "serviceBusEndpoint": "https://NS-3e538a1a-58fb-4315-b2ce-76f5c944114c.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-4e1bfdf1-0cff-4e86-ae80-cdcac4873039", + "name": "NS-4e1bfdf1-0cff-4e86-ae80-cdcac4873039", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-4e1bfdf1-0cff-4e86-ae80-cdcac4873039", + "createdAt": "2016-09-16T01:01:58.73Z", + "updatedAt": "2017-02-11T03:02:59.8Z", + "serviceBusEndpoint": "https://NS-4e1bfdf1-0cff-4e86-ae80-cdcac4873039.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03", + "name": "NS-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03", + "createdAt": "2016-08-23T03:22:45.327Z", + "updatedAt": "2017-02-11T06:08:01.207Z", + "serviceBusEndpoint": "https://NS-6b90b7f3-7aa0-48c9-bc30-b299dcb66c03.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-c05e9df3-7737-44ee-a321-15f6e0545b97", + "name": "NS-c05e9df3-7737-44ee-a321-15f6e0545b97", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-c05e9df3-7737-44ee-a321-15f6e0545b97", + "createdAt": "2016-08-05T03:29:19.75Z", + "updatedAt": "2017-02-11T08:10:35.527Z", + "serviceBusEndpoint": "https://NS-c05e9df3-7737-44ee-a321-15f6e0545b97.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-dcb4152c-231b-4c16-a683-07cc6b38fa46", + "name": "NS-dcb4152c-231b-4c16-a683-07cc6b38fa46", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-dcb4152c-231b-4c16-a683-07cc6b38fa46", + "createdAt": "2016-08-05T03:34:35.363Z", + "updatedAt": "2017-02-11T05:33:00.957Z", + "serviceBusEndpoint": "https://NS-dcb4152c-231b-4c16-a683-07cc6b38fa46.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-f501f5e6-1f24-439b-8982-9af665156d40", + "name": "NS-f501f5e6-1f24-439b-8982-9af665156d40", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-f501f5e6-1f24-439b-8982-9af665156d40", + "createdAt": "2016-09-16T01:25:55.707Z", + "updatedAt": "2017-02-11T07:42:59.687Z", + "serviceBusEndpoint": "https://NS-f501f5e6-1f24-439b-8982-9af665156d40.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30", + "name": "NS-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30", + "createdAt": "2016-08-23T02:32:08.227Z", + "updatedAt": "2017-02-11T06:32:57.77Z", + "serviceBusEndpoint": "https://NS-fe2ed660-2cd6-46f2-a9c3-7e11551a1f30.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-8a5e3b4e-4e97-4d85-9083-cd33536c9d71", + "name": "NS-8a5e3b4e-4e97-4d85-9083-cd33536c9d71", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-8a5e3b4e-4e97-4d85-9083-cd33536c9d71", + "createdAt": "2016-09-16T00:54:05.103Z", + "updatedAt": "2017-02-11T10:43:50.313Z", + "serviceBusEndpoint": "https://NS-8a5e3b4e-4e97-4d85-9083-cd33536c9d71.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-6520cc09-01ac-40a3-bc09-c5c431116e92", + "name": "NS-6520cc09-01ac-40a3-bc09-c5c431116e92", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-6520cc09-01ac-40a3-bc09-c5c431116e92", + "createdAt": "2016-09-16T01:49:59.243Z", + "updatedAt": "2017-02-11T08:15:36.95Z", + "serviceBusEndpoint": "https://NS-6520cc09-01ac-40a3-bc09-c5c431116e92.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-bfba6d5c-a425-42d9-85db-0f4da770e29a", + "name": "NS-bfba6d5c-a425-42d9-85db-0f4da770e29a", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-bfba6d5c-a425-42d9-85db-0f4da770e29a", + "createdAt": "2016-08-05T03:23:32.083Z", + "updatedAt": "2017-02-11T09:02:57.433Z", + "serviceBusEndpoint": "https://NS-bfba6d5c-a425-42d9-85db-0f4da770e29a.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-43b136b4-8716-40b2-97c5-0d77cac0062c", + "name": "NS-43b136b4-8716-40b2-97c5-0d77cac0062c", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-43b136b4-8716-40b2-97c5-0d77cac0062c", + "createdAt": "2016-08-23T03:14:50.577Z", + "updatedAt": "2017-02-11T09:23:01.067Z", + "serviceBusEndpoint": "https://NS-43b136b4-8716-40b2-97c5-0d77cac0062c.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-7c0443de-5f88-450c-b574-83f60a097dd1", + "name": "NS-7c0443de-5f88-450c-b574-83f60a097dd1", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-7c0443de-5f88-450c-b574-83f60a097dd1", + "createdAt": "2016-08-23T04:07:15.397Z", + "updatedAt": "2017-02-11T04:03:03.097Z", + "serviceBusEndpoint": "https://NS-7c0443de-5f88-450c-b574-83f60a097dd1.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-62dd7753-a5f9-42fd-a354-ca38a4505d69", + "name": "NS-62dd7753-a5f9-42fd-a354-ca38a4505d69", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-62dd7753-a5f9-42fd-a354-ca38a4505d69", + "createdAt": "2016-09-16T01:33:50.45Z", + "updatedAt": "2017-02-11T05:35:33.053Z", + "serviceBusEndpoint": "https://NS-62dd7753-a5f9-42fd-a354-ca38a4505d69.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-ae18a18c-97ab-4089-965d-8acbf4794091", + "name": "NS-ae18a18c-97ab-4089-965d-8acbf4794091", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-ae18a18c-97ab-4089-965d-8acbf4794091", + "createdAt": "2016-08-23T02:43:36.517Z", + "updatedAt": "2017-02-11T12:40:30.587Z", + "serviceBusEndpoint": "https://NS-ae18a18c-97ab-4089-965d-8acbf4794091.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11", + "name": "NS-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11", + "createdAt": "2016-09-16T00:46:03.773Z", + "updatedAt": "2017-02-11T04:43:54.56Z", + "serviceBusEndpoint": "https://NS-8e3b56c1-0ee8-4e13-ae88-5cadf6e2ce11.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44", + "name": "NS-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44", + "createdAt": "2016-08-23T03:59:12.1Z", + "updatedAt": "2017-02-11T06:33:52.23Z", + "serviceBusEndpoint": "https://NS-7ffca4b4-4728-4fb0-b2d0-1e7c016e3a44.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-d9337efd-9b27-454c-b2a5-dcfea56920d9", + "name": "NS-d9337efd-9b27-454c-b2a5-dcfea56920d9", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-d9337efd-9b27-454c-b2a5-dcfea56920d9", + "createdAt": "2016-08-05T03:45:09.27Z", + "updatedAt": "2017-02-11T06:20:31.863Z", + "serviceBusEndpoint": "https://NS-d9337efd-9b27-454c-b2a5-dcfea56920d9.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-ad5ae732-abea-4e62-9de0-c90de0ddec0a", + "name": "NS-ad5ae732-abea-4e62-9de0-c90de0ddec0a", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-ad5ae732-abea-4e62-9de0-c90de0ddec0a", + "createdAt": "2016-08-23T02:34:36.447Z", + "updatedAt": "2017-02-11T06:15:31.607Z", + "serviceBusEndpoint": "https://NS-ad5ae732-abea-4e62-9de0-c90de0ddec0a.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-d447fb03-c7da-40fe-b5eb-14f36888837b", + "name": "NS-d447fb03-c7da-40fe-b5eb-14f36888837b", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-d447fb03-c7da-40fe-b5eb-14f36888837b", + "createdAt": "2016-08-05T00:53:46.697Z", + "updatedAt": "2017-02-11T11:09:41.26Z", + "serviceBusEndpoint": "https://NS-d447fb03-c7da-40fe-b5eb-14f36888837b.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/RapscallionResources/providers/Microsoft.NotificationHubs/namespaces/ReproSB", + "name": "ReproSB", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:reprosb", + "createdAt": "2017-02-27T19:29:34.523Z", + "updatedAt": "2017-02-27T19:29:58.64Z", + "serviceBusEndpoint": "https://ReproSB.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-4c90097f-19a8-42e7-bb3c-4ac088994719", + "name": "NS-4c90097f-19a8-42e7-bb3c-4ac088994719", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-4c90097f-19a8-42e7-bb3c-4ac088994719", + "createdAt": "2016-09-16T17:35:32.61Z", + "updatedAt": "2017-02-11T09:13:52.27Z", + "serviceBusEndpoint": "https://NS-4c90097f-19a8-42e7-bb3c-4ac088994719.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/rrama-1-23-17", + "name": "rrama-1-23-17", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:rrama-1-23-17", + "createdAt": "2017-01-23T22:54:40.907Z", + "updatedAt": "2017-02-04T00:53:28.777Z", + "serviceBusEndpoint": "https://rrama-1-23-17.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-5191e541-8e4e-4229-9fdc-b89f6c3e7f12", + "name": "NS-5191e541-8e4e-4229-9fdc-b89f6c3e7f12", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-5191e541-8e4e-4229-9fdc-b89f6c3e7f12", + "createdAt": "2016-09-16T17:43:25.71Z", + "updatedAt": "2017-02-11T11:05:31.89Z", + "serviceBusEndpoint": "https://NS-5191e541-8e4e-4229-9fdc-b89f6c3e7f12.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-be903820-3533-46e8-90e4-72c132411848", + "name": "NS-be903820-3533-46e8-90e4-72c132411848", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-be903820-3533-46e8-90e4-72c132411848", + "createdAt": "2016-08-05T03:24:01.923Z", + "updatedAt": "2017-02-11T10:09:42.513Z", + "serviceBusEndpoint": "https://NS-be903820-3533-46e8-90e4-72c132411848.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/rrama-namespace1", + "name": "rrama-namespace1", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:rrama-namespace1", + "createdAt": "2016-08-05T00:47:22.963Z", + "updatedAt": "2016-08-05T00:47:27.297Z", + "serviceBusEndpoint": "https://rrama-namespace1.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-a3c38e9b-32a3-4c51-85d7-263150a8dda9", + "name": "NS-a3c38e9b-32a3-4c51-85d7-263150a8dda9", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-a3c38e9b-32a3-4c51-85d7-263150a8dda9", + "createdAt": "2016-09-16T00:38:02.517Z", + "updatedAt": "2017-02-11T05:03:55.96Z", + "serviceBusEndpoint": "https://NS-a3c38e9b-32a3-4c51-85d7-263150a8dda9.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6", + "name": "NS-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6", + "createdAt": "2016-08-23T03:42:40.01Z", + "updatedAt": "2017-02-11T06:33:02.363Z", + "serviceBusEndpoint": "https://NS-70d3fa25-6bbe-4a6b-a381-a52cf0d539e6.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-e6536f77-0d1b-4a6b-8f42-29cc15b2930a", + "name": "NS-e6536f77-0d1b-4a6b-8f42-29cc15b2930a", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-e6536f77-0d1b-4a6b-8f42-29cc15b2930a", + "createdAt": "2016-08-05T04:28:10.71Z", + "updatedAt": "2017-02-11T08:43:51.587Z", + "serviceBusEndpoint": "https://NS-e6536f77-0d1b-4a6b-8f42-29cc15b2930a.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/ArunMonocle/providers/Microsoft.NotificationHubs/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:59.35Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/rrama-sb1", + "name": "rrama-sb1", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:rrama-sb1", + "createdAt": "2017-05-01T21:47:34.903Z", + "updatedAt": "2017-05-02T02:10:03.083Z", + "serviceBusEndpoint": "https://rrama-sb1.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/RapscallionResources/providers/Microsoft.NotificationHubs/namespaces/WhackWhack", + "name": "WhackWhack", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:whackwhack", + "createdAt": "2016-10-10T23:39:01.347Z", + "updatedAt": "2017-02-04T00:56:32.687Z", + "serviceBusEndpoint": "https://WhackWhack.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c", + "name": "NS-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c", + "createdAt": "2016-09-16T17:51:27.73Z", + "updatedAt": "2017-02-11T08:19:43.383Z", + "serviceBusEndpoint": "https://NS-66ed32d6-611e-4bb0-8e1a-a6d0fc65427c.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/NS-e0cab401-6df8-465d-8d4a-da9a9e55cf0e", + "name": "NS-e0cab401-6df8-465d-8d4a-da9a9e55cf0e", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:ns-e0cab401-6df8-465d-8d4a-da9a9e55cf0e", + "createdAt": "2016-08-05T01:14:25.613Z", + "updatedAt": "2017-02-11T12:33:01.727Z", + "serviceBusEndpoint": "https://NS-e0cab401-6df8-465d-8d4a-da9a9e55cf0e.servicebus.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/bn3-rrama-foo1", + "name": "bn3-rrama-foo1", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "East US 2", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:bn3-rrama-foo1", + "createdAt": "2017-04-28T23:54:26.927Z", + "updatedAt": "2017-04-28T23:54:26.927Z", + "serviceBusEndpoint": "https://bn3-rrama-foo1.servicebus.int7.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/bn3-rrama-foo3", + "name": "bn3-rrama-foo3", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "East US 2", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:bn3-rrama-foo3", + "createdAt": "2017-04-29T00:24:09.907Z", + "updatedAt": "2017-04-29T00:24:33.233Z", + "serviceBusEndpoint": "https://bn3-rrama-foo3.servicebus.int7.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/bn3-rrama-foo2", + "name": "bn3-rrama-foo2", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "East US 2", + "tags": {}, + "properties": { + "provisioningState": "Created", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:bn3-rrama-foo2", + "createdAt": "2017-04-28T23:57:40.82Z", + "updatedAt": "2017-04-28T23:57:40.82Z", + "serviceBusEndpoint": "https://bn3-rrama-foo2.servicebus.int7.windows-int.net:443/" + } + }, + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/Default-ServiceBus-SouthCentralUS/providers/Microsoft.NotificationHubs/namespaces/db3-rrama-foo2", + "name": "db3-rrama-foo2", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "North Europe", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:db3-rrama-foo2", + "createdAt": "2017-04-29T00:10:43.463Z", + "updatedAt": "2017-04-29T00:11:09.133Z", + "serviceBusEndpoint": "https://db3-rrama-foo2.servicebus.int7.windows-int.net:443/" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceListByResourceGroup.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceListByResourceGroup.json new file mode 100644 index 000000000000..a791caa3bee4 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceListByResourceGroup.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "resourceGroupName": "5ktrial" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/ArunMonocle/providers/Microsoft.NotificationHubs/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "metricId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40:sdk-namespace-2924", + "createdAt": "2017-05-25T22:26:36.76Z", + "updatedAt": "2017-05-25T22:26:59.35Z", + "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceUpdate.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceUpdate.json new file mode 100644 index 000000000000..be0099342fc8 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/Namespaces/NHNameSpaceUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/ArunMonocle/providers/Microsoft.NotificationHubs/namespaces/sdk-Namespace-3285", + "name": "sdk-Namespace-3285", + "type": "Microsoft.NotificationHubs/Namespaces", + "location": "South Central US", + "tags": { + "tag3": "value3", + "tag4": "value4" + }, + "properties": { + "provisioningState": "Updating", + "createdAt": "2017-05-25T23:07:58.17Z", + "serviceBusEndpoint": "https://sdk-Namespace-3285.servicebus.windows-int.net:443/" + } + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleCreate.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleCreate.json new file mode 100644 index 000000000000..d18a966e0c69 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleCreate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "authorizationRuleName": "DefaultListenSharedAccessSignature", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/NotificationHubs/nh-sdk-hub/AuthorizationRules/DefaultListenSharedAccessSignature", + "name": "DefaultListenSharedAccessSignature", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules", + "location": "West Europe", + "tags": null, + "properties": { + "keyName": "DefaultListenSharedAccessSignature", + "primaryKey": "#################################", + "secondaryKey": "#################################", + "claimType": "SharedAccessKey", + "claimValue": "None", + "rights": [ + "Listen" + ], + "createdTime": "2018-05-02T00:45:22.0150024Z", + "modifiedTime": "2018-05-02T00:45:22.0150024Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleDelete.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleDelete.json new file mode 100644 index 000000000000..9ef8936a3515 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "authorizationRuleName": "DefaultListenSharedAccessSignature", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleGet.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleGet.json new file mode 100644 index 000000000000..244bc2963e3b --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "authorizationRuleName": "DefaultListenSharedAccessSignature", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/NotificationHubs/nh-sdk-hub/AuthorizationRules/DefaultListenSharedAccessSignature", + "name": "DefaultListenSharedAccessSignature", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules", + "location": "West Europe", + "tags": null, + "properties": { + "keyName": "DefaultListenSharedAccessSignature", + "primaryKey": "#################################", + "secondaryKey": "#################################", + "claimType": "SharedAccessKey", + "claimValue": "None", + "rights": [ + "Listen" + ], + "createdTime": "2018-05-02T00:45:22.0150024Z", + "modifiedTime": "2018-05-02T00:45:22.0150024Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleListAll.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleListAll.json new file mode 100644 index 000000000000..50dacd68f559 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleListAll.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/NotificationHubs/nh-sdk-hub/AuthorizationRules/DefaultListenSharedAccessSignature", + "name": "DefaultListenSharedAccessSignature", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules", + "location": "West Europe", + "tags": null, + "properties": { + "keyName": "DefaultListenSharedAccessSignature", + "primaryKey": "#################################", + "secondaryKey": "#################################", + "claimType": "SharedAccessKey", + "claimValue": "None", + "rights": [ + "Listen" + ], + "createdTime": "2018-05-02T00:45:22.0150024Z", + "modifiedTime": "2018-05-02T00:45:22.0150024Z" + } + }, + { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/NotificationHubs/nh-sdk-hub/AuthorizationRules/DefaultFullSharedAccessSignature", + "name": "DefaultFullSharedAccessSignature", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules", + "location": "West Europe", + "tags": null, + "properties": { + "keyName": "DefaultFullSharedAccessSignature", + "primaryKey": "#################################", + "secondaryKey": "#################################", + "claimType": "SharedAccessKey", + "claimValue": "None", + "rights": [ + "Listen", + "Manage", + "Send" + ], + "createdTime": "2018-05-02T00:45:22.0150024Z", + "modifiedTime": "2018-05-02T00:45:22.0150024Z" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleListKey.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleListKey.json new file mode 100644 index 000000000000..d59024e1591c --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleListKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-notificationHubs-2317", + "secondaryConnectionString": "Endpoint=sb://sdk-namespace-7982.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-notificationHubs-2317", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-AuthRules-5800" + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleRegenrateKey.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleRegenrateKey.json new file mode 100644 index 000000000000..8c83650c1015 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleRegenrateKey.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "authorizationRuleName": "DefaultListenSharedAccessSignature", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "policyKey": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=DefaultListenSharedAccessSignature;SharedAccessKey=#################################", + "secondaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=DefaultListenSharedAccessSignature;SharedAccessKey=#################################", + "primaryKey": "#################################", + "secondaryKey": "#################################", + "keyName": "DefaultListenSharedAccessSignature" + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleUpdate.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleUpdate.json new file mode 100644 index 000000000000..f4efc20bd184 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubAuthorizationRuleUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "authorizationRuleName": "DefaultListenSharedAccessSignature", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "properties": { + "rights": [ + "Listen" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/NotificationHubs/nh-sdk-hub/AuthorizationRules/DefaultListenSharedAccessSignature", + "name": "DefaultListenSharedAccessSignature", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules", + "location": null, + "tags": null, + "properties": { + "keyName": "DefaultListenSharedAccessSignature", + "primaryKey": "#################################", + "secondaryKey": "#################################", + "claimType": "SharedAccessKey", + "claimValue": "None", + "rights": [ + "Listen" + ], + "createdTime": "2018-05-02T00:45:22.0150024Z", + "modifiedTime": "2018-05-02T00:45:22.0150024Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubCheckNameAvailability.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubCheckNameAvailability.json new file mode 100644 index 000000000000..3c74dbc0c57b --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubCheckNameAvailability.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "namespaceName": "locp-newns", + "resourceGroupName": "5ktrial", + "parameters": { + "name": "sdktest", + "location": "West Europe" + } + }, + "responses": { + "200": { + "body": { + "isAvailiable": true, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourcegroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/locp-newns/CheckNotificationHubAvailability", + "name": "sdktest", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/checkNotificationHubAvailability", + "location": "West Europe", + "tags": null + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubCreate.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubCreate.json new file mode 100644 index 000000000000..759bf43b86df --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "notificationHubName": "nh-sdk-hub", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/sdkresourceGroup/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/nh-sdk-hub", + "name": "nh-sdk-hub", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs", + "location": "South Central US", + "tags": null, + "properties": { + "registrationTtl": "10675199.02:48:05.4775807", + "authorizationRules": [] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/sdkresourceGroup/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/nh-sdk-hub", + "name": "nh-sdk-hub", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs", + "location": "South Central US", + "tags": null, + "properties": { + "registrationTtl": "10675199.02:48:05.4775807", + "authorizationRules": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubDebugSend.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubDebugSend.json new file mode 100644 index 000000000000..938171fc063c --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubDebugSend.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "notificationHubName": "nh-sdk-hub", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "data": { + "message": "Hello" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/sdkresourceGroup/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/nh-sdk-hub", + "name": "nh-sdk-hub", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs", + "location": "South Central US", + "tags": null, + "properties": { + "success": 1, + "failure": 0, + "results": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubDelete.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubDelete.json new file mode 100644 index 000000000000..5ad65b1529a5 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "notificationHubName": "nh-sdk-hub", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubGet.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubGet.json new file mode 100644 index 000000000000..3d7eedffabc9 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "notificationHubName": "nh-sdk-hub", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/sdkresourceGroup/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/nh-sdk-hub", + "name": "nh-sdk-hub", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs", + "location": "South Central US", + "tags": null, + "properties": { + "registrationTtl": "10675199.02:48:05.4775807", + "authorizationRules": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubListByNameSpace.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubListByNameSpace.json new file mode 100644 index 000000000000..40af498162f9 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubListByNameSpace.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/NotificationHubs/nh-sdk-hub", + "name": "nh-sdk-hub", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs", + "location": "South Central US", + "tags": null, + "properties": { + "registrationTtl": "10675199.02:48:05.4775807", + "authorizationRules": [] + } + } + ], + "nextLink": null + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubPatch.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubPatch.json new file mode 100644 index 000000000000..fddb1ce919ef --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubPatch.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "sdkresourceGroup", + "notificationHubName": "sdk-notificationHubs-8708", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/sdkresourceGroup/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/nh-sdk-hub", + "name": "nh-sdk-hub", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs", + "location": "South Central US", + "tags": null, + "properties": { + "registrationTtl": "10675199.02:48:05.4775807", + "authorizationRules": [] + } + } + } + } + } \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubPnsCredentials.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubPnsCredentials.json new file mode 100644 index 000000000000..080b5b54c577 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubPnsCredentials.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/nh-sdk-hub/pnsCredentials", + "name": "nh-sdk-hub", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/pnsCredentials", + "location": "West Europe", + "tags": null, + "properties": { + "mpnsCredential": { + "properties": { + "thumbprint": "#################################" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubUpdate.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubUpdate.json new file mode 100644 index 000000000000..7fff0cc3a6fb --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/examples/NotificationHubs/NotificationHubUpdate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "sdkresourceGroup", + "notificationHubName": "sdk-notificationHubs-8708", + "api-version": "2017-04-01", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "properties": { + "properties": { + "maxSizeInMegabytes": 1024, + "maxDeliveryCount": 5, + "enableExpress": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/sdkresourceGroup/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/nh-sdk-hub", + "name": "nh-sdk-hub", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs", + "location": "South Central US", + "tags": null, + "properties": { + "registrationTtl": "10675199.02:48:05.4775807", + "authorizationRules": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json index fd16cb9a3ee2..4b324fbb5659 100644 --- a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json @@ -34,11 +34,52 @@ } }, "paths": { + "/providers/Microsoft.NotificationHubs/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/NHOperationsList.json" + } + }, + "description": "Lists all of the available NotificationHubs REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "NotificationHubs error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/checkNamespaceAvailability": { "post": { "tags": [ "Namespaces" ], + "x-ms-examples": { + "NameSpaceCheckNameAvailability": { + "$ref": "./examples/Namespaces/NHNameSpaceCheckNameAvailability.json" + } + }, "operationId": "Namespaces_CheckAvailability", "description": "Checks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.", "parameters": [ @@ -68,1972 +109,2253 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/checkNameAvailability": { - "post": { - "tags": [ - "Namespaces" - ], - "operationId": "Name_CheckAvailability", - "description": "Checks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.", - "parameters": [ - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityRequestParameters" - }, - "description": "The namespace name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Checks if the Namespace name is a valid availabile name", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdate", - "description": "Creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", - "externalDocs": { - "url": "http://msdn.microsoft.com/en-us/library/windowsazure/jj856303.aspx" - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NamespaceCreateOrUpdateParameters" - }, - "description": "Parameters supplied to create a Namespace Resource." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Namespace is Create/Update", - "schema": { - "$ref": "#/definitions/NamespaceResource" - } - }, - "200": { - "description": "Namespace is Create/Update", - "schema": { - "$ref": "#/definitions/NamespaceResource" - } - } + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}": { + "put": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceCreate": { + "$ref": "./examples/Namespaces/NHNameSpaceCreate.json" } }, - "patch": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Patch", - "description": "Patches the existing namespace", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NamespacePatchParameters" - }, - "description": "Parameters supplied to patch a Namespace Resource." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace is Updated", - "schema": { - "$ref": "#/definitions/NamespaceResource" - } - } - } + "operationId": "Namespaces_CreateOrUpdate", + "description": "Creates/Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "externalDocs": { + "url": "http://msdn.microsoft.com/en-us/library/windowsazure/jj856303.aspx" }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Delete", - "description": "Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.", - "externalDocs": { - "url": "http://msdn.microsoft.com/en-us/library/windowsazure/jj856296.aspx" + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "Namespace is already Deleted" - }, - "200": { - "description": "Namespace is deleted" - }, - "202": { - "description": "Namespace delete request has been accepted" - } + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Get", - "description": "Returns the description for the specified namespace.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NamespaceCreateOrUpdateParameters" }, - { - "$ref": "#/parameters/SubscriptionIdParameter" + "description": "Parameters supplied to create a Namespace Resource." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace is Create/Update", + "schema": { + "$ref": "#/definitions/NamespaceResource" } - ], - "responses": { - "200": { - "description": "Get Namespace", - "schema": { - "$ref": "#/definitions/NamespaceResource" - } + }, + "201": { + "description": "Namespace is Create/Update", + "schema": { + "$ref": "#/definitions/NamespaceResource" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdateAuthorizationRule", - "description": "Creates an authorization rule for a namespace", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "authorizationRuleName", - "in": "path", - "required": true, - "type": "string", - "description": "Aauthorization Rule Name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SharedAccessAuthorizationRuleCreateOrUpdateParameters" - }, - "description": "The shared access authorization rule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace Authorization Rule is Created/Updated", - "schema": { - "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" - } - } + "patch": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceUpdate": { + "$ref": "./examples/Namespaces/NHNameSpaceUpdate.json" } }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_DeleteAuthorizationRule", - "description": "Deletes a namespace authorization rule", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "authorizationRuleName", - "in": "path", - "required": true, - "type": "string", - "description": "Authorization Rule Name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "Namespace AuthorizationRule is already deleted" + "operationId": "Namespaces_Patch", + "description": "Patches the existing namespace", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NamespacePatchParameters" }, - "200": { - "description": "Namespace AuthorizationRule is deleted" - } + "description": "Parameters supplied to patch a Namespace Resource." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_GetAuthorizationRule", - "description": "Gets an authorization rule for a namespace by name.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name" - }, - { - "name": "authorizationRuleName", - "in": "path", - "required": true, - "type": "string", - "description": "Authorization rule name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Get the Namespace AuthorizationRule", - "schema": { - "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" - } + ], + "responses": { + "200": { + "description": "Namespace is Updated", + "schema": { + "$ref": "#/definitions/NamespaceResource" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_List", - "description": "Lists the available namespaces within a resourceGroup.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. If resourceGroupName value is null the method lists all the namespaces within subscription" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Lists all Namespaces with the ResourceGroup", - "schema": { - "$ref": "#/definitions/NamespaceListResult" - } - } + "delete": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceDelete": { + "$ref": "./examples/Namespaces/NHNameSpaceDelete.json" + } + }, + "operationId": "Namespaces_Delete", + "description": "Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.", + "externalDocs": { + "url": "http://msdn.microsoft.com/en-us/library/windowsazure/jj856296.aspx" + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + { + "$ref": "#/parameters/SubscriptionIdParameter" } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/namespaces": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListAll", - "description": "Lists all the available namespaces within the subscription irrespective of the resourceGroups.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets all the Namespaces within the subscription irrespective of the ResourceGroup", - "schema": { - "$ref": "#/definitions/NamespaceListResult" - } - } + ], + "responses": { + "200": { + "description": "Namespace is deleted" }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "202": { + "description": "Namespace delete request has been accepted" + }, + "204": { + "description": "Namespace is already Deleted" } - } + }, + "x-ms-long-running-operation": true }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListAuthorizationRules", - "description": "Gets the authorization rules for a namespace.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Get the List of AuthorizationRules of a Namespace", - "schema": { - "$ref": "#/definitions/SharedAccessAuthorizationRuleListResult" - } - } + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceGet": { + "$ref": "./examples/Namespaces/NHNameSpaceGet.json" + } + }, + "operationId": "Namespaces_Get", + "description": "Returns the description for the specified namespace.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys": { - "post": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListKeys", - "description": "Gets the Primary and Secondary ConnectionStrings to the namespace ", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "authorizationRuleName", - "in": "path", - "required": true, - "type": "string", - "description": "The connection string of the namespace for the specified authorizationRule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the Namespace AuthorizationRule's Primary keys and Secondary keys along with the ConnectionStrings", - "schema": { - "$ref": "#/definitions/ResourceListKeys" - } + ], + "responses": { + "200": { + "description": "Get Namespace", + "schema": { + "$ref": "#/definitions/NamespaceResource" } } } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys": { - "post": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_RegenerateKeys", - "description": "Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "authorizationRuleName", - "in": "path", - "required": true, - "type": "string", - "description": "The connection string of the namespace for the specified authorizationRule." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PolicykeyResource" - }, - "description": "Parameters supplied to regenerate the Namespace Authorization Rule Key." - }, - { - "$ref": "#/parameters/ApiVersionParameter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceAuthorizationRuleCreate": { + "$ref": "./examples/Namespaces/NHNameSpaceAuthorizationRuleCreate.json" + } + }, + "operationId": "Namespaces_CreateOrUpdateAuthorizationRule", + "description": "Creates an authorization rule for a namespace", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "authorizationRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "Aauthorization Rule Name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleCreateOrUpdateParameters" }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Regenerate the Primary/Secondary Key and returns the Keys and the connection string", - "schema": { - "$ref": "#/definitions/ResourceListKeys" - } + "description": "The shared access authorization rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace Authorization Rule is Created/Updated", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/checkNotificationHubAvailability": { - "post": { - "tags": [ - "NotificationHubs" - ], - "operationId": "NotificationHubs_CheckAvailability", - "description": "Checks the availability of the given notificationHub in a namespace.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CheckAvailabilityParameters" - }, - "description": "The notificationHub name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" + "delete": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceAuthorizationRuleDelete": { + "$ref": "./examples/Namespaces/NHNameSpaceAuthorizationRuleDelete.json" + } + }, + "operationId": "Namespaces_DeleteAuthorizationRule", + "description": "Deletes a namespace authorization rule", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "authorizationRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "Authorization Rule Name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace AuthorizationRule is deleted" + }, + "204": { + "description": "Namespace AuthorizationRule is already deleted" + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceAuthorizationRuleGet": { + "$ref": "./examples/Namespaces/NHNameSpaceAuthorizationRuleGet.json" + } + }, + "operationId": "Namespaces_GetAuthorizationRule", + "description": "Gets an authorization rule for a namespace by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name" + }, + { + "name": "authorizationRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "Authorization rule name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get the Namespace AuthorizationRule", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" } - ], - "responses": { - "200": { - "description": "Checks if the NotificationHub name is a valid availabile name", - "schema": { - "$ref": "#/definitions/CheckAvailabilityResult" - } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceListByResourceGroup": { + "$ref": "./examples/Namespaces/NHNameSpaceListByResourceGroup.json" + } + }, + "operationId": "Namespaces_List", + "description": "Lists the available namespaces within a resourceGroup.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. If resourceGroupName value is null the method lists all the namespaces within subscription" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists all Namespaces with the ResourceGroup", + "schema": { + "$ref": "#/definitions/NamespaceListResult" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/checkHubAvailability": { - "post": { - "tags": [ - "NotificationHubs" - ], - "operationId": "Hubs_CheckAvailability", - "description": "Checks the availability of the given notificationHub in a namespace.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceList": { + "$ref": "./examples/Namespaces/NHNameSpaceList.json" + } + }, + "operationId": "Namespaces_ListAll", + "description": "Lists all the available namespaces within the subscription irrespective of the resourceGroups.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets all the Namespaces within the subscription irrespective of the ResourceGroup", + "schema": { + "$ref": "#/definitions/NamespaceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules": { + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceAuthorizationRuleListAll": { + "$ref": "./examples/Namespaces/NHNameSpaceAuthorizationRuleListAll.json" + } + }, + "operationId": "Namespaces_ListAuthorizationRules", + "description": "Gets the authorization rules for a namespace.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get the List of AuthorizationRules of a Namespace", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceAuthorizationRuleListKey": { + "$ref": "./examples/Namespaces/NHNameSpaceAuthorizationRuleListKey.json" + } + }, + "operationId": "Namespaces_ListKeys", + "description": "Gets the Primary and Secondary ConnectionStrings to the namespace ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "authorizationRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The connection string of the namespace for the specified authorizationRule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the Namespace AuthorizationRule's Primary keys and Secondary keys along with the ConnectionStrings", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceAuthorizationRuleRegenrateKey": { + "$ref": "./examples/Namespaces/NHNameSpaceAuthorizationRuleRegenrateKey.json" + } + }, + "operationId": "Namespaces_RegenerateKeys", + "description": "Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "authorizationRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The connection string of the namespace for the specified authorizationRule." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicykeyResource" }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityRequestParameters" - }, - "description": "The notificationHub name." + "description": "Parameters supplied to regenerate the Namespace Authorization Rule Key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Regenerate the Primary/Secondary Key and returns the Keys and the connection string", + "schema": { + "$ref": "#/definitions/ResourceListKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/checkNotificationHubAvailability": { + "post": { + "tags": [ + "NotificationHubs" + ], + "x-ms-examples": { + "notificationHubCheckNameAvailability": { + "$ref": "./examples/NotificationHubs/NotificationHubCheckNameAvailability.json" + } + }, + "operationId": "NotificationHubs_CheckNotificationHubAvailability", + "description": "Checks the availability of the given notificationHub in a namespace.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckAvailabilityParameters" }, - { - "$ref": "#/parameters/ApiVersionParameter" + "description": "The notificationHub name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Checks if the NotificationHub name is a valid availabile name", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}": { + "put": { + "tags": [ + "NotificationHubs" + ], + "x-ms-examples": { + "notificationhubCreate": { + "$ref": "./examples/NotificationHubs/NotificationHubCreate.json" + } + }, + "operationId": "NotificationHubs_CreateOrUpdate", + "description": "Creates/Update a NotificationHub in a namespace.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "notificationHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The notification hub name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NotificationHubCreateOrUpdateParameters" }, - { - "$ref": "#/parameters/SubscriptionIdParameter" + "description": "Parameters supplied to the create/update a NotificationHub Resource." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "NotificationHub is Created/Updated", + "schema": { + "$ref": "#/definitions/NotificationHubResource" } - ], - "responses": { - "200": { - "description": "Checks if the NotificationHub name is a valid availabile name", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityResponse" - } + }, + "201": { + "description": "NotificationHub is Created/Updated", + "schema": { + "$ref": "#/definitions/NotificationHubResource" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}": { - "put": { - "tags": [ - "NotificationHubs" - ], - "operationId": "NotificationHubs_CreateOrUpdate", - "description": "Creates/Update a NotificationHub in a namespace.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "notificationHubName", - "in": "path", - "required": true, - "type": "string", - "description": "The notification hub name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NotificationHubCreateOrUpdateParameters" - }, - "description": "Parameters supplied to the create/update a NotificationHub Resource." - }, - { - "$ref": "#/parameters/ApiVersionParameter" + "patch": { + "tags": [ + "NotificationHubs" + ], + "x-ms-examples": { + "notificationhubPatch": { + "$ref": "./examples/NotificationHubs/NotificationHubPatch.json" + } + }, + "operationId": "NotificationHubs_Patch", + "description": "Patch a NotificationHub in a namespace.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "notificationHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The notification hub name." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NotificationHubPatchParameters" }, - { - "$ref": "#/parameters/SubscriptionIdParameter" + "description": "Parameters supplied to patch a NotificationHub Resource." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "NotificationHub is patched", + "schema": { + "$ref": "#/definitions/NotificationHubResource" } - ], - "responses": { - "200": { - "description": "NotificationHub is Created/Updated", - "schema": { - "$ref": "#/definitions/NotificationHubResource" - } - }, - "201": { - "description": "NotificationHub is Created/Updated", - "schema": { - "$ref": "#/definitions/NotificationHubResource" - } + } + } + }, + "delete": { + "tags": [ + "NotificationHubs" + ], + "x-ms-examples": { + "notificationhubDelete": { + "$ref": "./examples/NotificationHubs/NotificationHubDelete.json" + } + }, + "operationId": "NotificationHubs_Delete", + "description": "Deletes a notification hub associated with a namespace.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "notificationHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The notification hub name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace is deleted" + } + } + }, + "get": { + "tags": [ + "NotificationHubs" + ], + "x-ms-examples": { + "notificationhubGet": { + "$ref": "./examples/NotificationHubs/NotificationHubGet.json" + } + }, + "operationId": "NotificationHubs_Get", + "description": "Lists the notification hubs associated with a namespace.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "notificationHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The notification hub name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get the NotificationHub", + "schema": { + "$ref": "#/definitions/NotificationHubResource" } } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/debugsend": { + "post": { + "tags": [ + "NotificationHubs" + ], + "x-ms-examples": { + "debugsend": { + "$ref": "./examples/NotificationHubs/NotificationHubDebugSend.json" + } }, - "delete": { - "tags": [ - "NotificationHubs" - ], - "operationId": "NotificationHubs_Delete", - "description": "Deletes a notification hub associated with a namespace.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "notificationHubName", - "in": "path", - "required": true, - "type": "string", - "description": "The notification hub name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" + "operationId": "NotificationHubs_DebugSend", + "description": "test send a push notification", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "notificationHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The notification hub name." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DebugSendParameters" }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace is deleted" - } + "description": "Debug send parameters" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } - }, - "get": { - "tags": [ - "NotificationHubs" - ], - "operationId": "NotificationHubs_Get", - "description": "Lists the notification hubs associated with a namespace.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "notificationHubName", - "in": "path", - "required": true, - "type": "string", - "description": "The notification hub name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Get the NotificationHub", - "schema": { - "$ref": "#/definitions/NotificationHubResource" - } + ], + "responses": { + "201": { + "description": "push send status", + "schema": { + "$ref": "#/definitions/DebugSendResponse" } } } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}": { - "put": { - "tags": [ - "NotificationHubs" - ], - "operationId": "NotificationHubs_CreateOrUpdateAuthorizationRule", - "description": "Creates/Updates an authorization rule for a NotificationHub", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "notificationHubName", - "in": "path", - "required": true, - "type": "string", - "description": "The notification hub name." - }, - { - "name": "authorizationRuleName", - "in": "path", - "required": true, - "type": "string", - "description": "Authorization Rule Name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SharedAccessAuthorizationRuleCreateOrUpdateParameters" - }, - "description": "The shared access authorization rule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "NotificationHub AuthorizationRule is Created/Updated", - "schema": { - "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" - } - } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "NotificationHubs" + ], + "x-ms-examples": { + "notificationhubAuthorizationRuleCreate": { + "$ref": "./examples/NotificationHubs/NotificationHubAuthorizationRuleCreate.json" } }, - "delete": { - "tags": [ - "NotificationHubs" - ], - "operationId": "NotificationHubs_DeleteAuthorizationRule", - "description": "Deletes a notificationHub authorization rule", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "notificationHubName", - "in": "path", - "required": true, - "type": "string", - "description": "The notification hub name." - }, - { - "name": "authorizationRuleName", - "in": "path", - "required": true, - "type": "string", - "description": "Authorization Rule Name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "NotificationHub AuthorizationRule is already deleted" + "operationId": "NotificationHubs_CreateOrUpdateAuthorizationRule", + "description": "Creates/Updates an authorization rule for a NotificationHub", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "notificationHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The notification hub name." + }, + { + "name": "authorizationRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "Authorization Rule Name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleCreateOrUpdateParameters" }, - "200": { - "description": "NotificationHub AuthorizationRule is deleted" - } + "description": "The shared access authorization rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } - }, - "get": { - "tags": [ - "NotificationHubs" - ], - "operationId": "NotificationHubs_GetAuthorizationRule", - "description": "Gets an authorization rule for a NotificationHub by name.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name" - }, - { - "name": "notificationHubName", - "in": "path", - "required": true, - "type": "string", - "description": "The notification hub name." - }, - { - "name": "authorizationRuleName", - "in": "path", - "required": true, - "type": "string", - "description": "authorization rule name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Get NotificationHub AuthorizationRule", - "schema": { - "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" - } + ], + "responses": { + "200": { + "description": "NotificationHub AuthorizationRule is Created/Updated", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs": { - "get": { - "tags": [ - "NotificationHubs" - ], - "operationId": "NotificationHubs_List", - "description": "Lists the notification hubs associated with a namespace.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Get all NotificationHubs within a Namespace", - "schema": { - "$ref": "#/definitions/NotificationHubListResult" - } - } + "delete": { + "tags": [ + "NotificationHubs" + ], + "x-ms-examples": { + "notificationhubAuthorizationRuleDelete": { + "$ref": "./examples/NotificationHubs/NotificationHubAuthorizationRuleDelete.json" + } + }, + "operationId": "NotificationHubs_DeleteAuthorizationRule", + "description": "Deletes a notificationHub authorization rule", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "notificationHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The notification hub name." + }, + { + "name": "authorizationRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "Authorization Rule Name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + { + "$ref": "#/parameters/SubscriptionIdParameter" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules": { - "get": { - "tags": [ - "NotificationHubs" - ], - "operationId": "NotificationHubs_ListAuthorizationRules", - "description": "Gets the authorization rules for a NotificationHub.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name" - }, - { - "name": "notificationHubName", - "in": "path", - "required": true, - "type": "string", - "description": "The notification hub name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Get all NotificationHub AuthorizationRules", - "schema": { - "$ref": "#/definitions/SharedAccessAuthorizationRuleListResult" - } - } + ], + "responses": { + "200": { + "description": "NotificationHub AuthorizationRule is deleted" }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "204": { + "description": "NotificationHub AuthorizationRule is already deleted" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}/listKeys": { - "post": { - "tags": [ - "NotificationHubs" - ], - "operationId": "NotificationHubs_ListKeys", - "description": "Gets the Primary and Secondary ConnectionStrings to the NotificationHub ", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "notificationHubName", - "in": "path", - "required": true, - "type": "string", - "description": "The notification hub name." - }, - { - "name": "authorizationRuleName", - "in": "path", - "required": true, - "type": "string", - "description": "The connection string of the NotificationHub for the specified authorizationRule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the Namespace AuthorizationRule's Primary keys and Secondary keys along with the ConnectionStrings", - "schema": { - "$ref": "#/definitions/ResourceListKeys" - } - } + "get": { + "tags": [ + "NotificationHubs" + ], + "x-ms-examples": { + "notificationhubAuthorizationRuleGet": { + "$ref": "./examples/NotificationHubs/NotificationHubAuthorizationRuleGet.json" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys": { - "post": { - "tags": [ - "NotificationHubs" - ], - "operationId": "NotificationHubs_RegenerateKeys", - "description": "Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "notificationHubName", - "in": "path", - "required": true, - "type": "string", - "description": "The notification hub name." - }, - { - "name": "authorizationRuleName", - "in": "path", - "required": true, - "type": "string", - "description": "The connection string of the NotificationHub for the specified authorizationRule." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PolicykeyResource" - }, - "description": "Parameters supplied to regenerate the NotificationHub Authorization Rule Key." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Regenerate the Primary/Secondary Key and returns the Keys and the connection string", - "schema": { - "$ref": "#/definitions/ResourceListKeys" - } + }, + "operationId": "NotificationHubs_GetAuthorizationRule", + "description": "Gets an authorization rule for a NotificationHub by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name" + }, + { + "name": "notificationHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The notification hub name." + }, + { + "name": "authorizationRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "authorization rule name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get NotificationHub AuthorizationRule", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" } } } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/pnsCredentials": { - "post": { - "tags": [ - "NotificationHubs" - ], - "operationId": "NotificationHubs_GetPnsCredentials", - "description": "Lists the PNS Credentials associated with a notification hub .", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "notificationHubName", - "in": "path", - "required": true, - "type": "string", - "description": "The notification hub name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets all the NotificationHub PNS credentials", - "schema": { - "$ref": "#/definitions/PnsCredentialsResource" - } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs": { + "get": { + "tags": [ + "NotificationHubs" + ], + "x-ms-examples": { + "notificationhubListByNameSpace": { + "$ref": "./examples/NotificationHubs/NotificationHubListByNameSpace.json" + } + }, + "operationId": "NotificationHubs_List", + "description": "Lists the notification hubs associated with a namespace.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get all NotificationHubs within a Namespace", + "schema": { + "$ref": "#/definitions/NotificationHubListResult" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "definitions": { - "CheckNameAvailabilityRequestParameters": { - "properties": { - "Name": { - "type": "string", - "description": "Resource name" - }, - "Type": { - "readOnly": true, - "type": "string", - "description": "Resource type" + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules": { + "get": { + "tags": [ + "NotificationHubs" + ], + "x-ms-examples": { + "notificationhubAuthorizationRuleListAll": { + "$ref": "./examples/NotificationHubs/NotificationHubAuthorizationRuleListAll.json" } }, - "required": [ - "Name" - ], - "description": "Parameters supplied to the Check Name Availability for Namespace and NotificationHubs." - }, - "CheckNameAvailabilityResponse": { - "properties": { - "NameAvailable": { - "type": "boolean", - "description": "Checks if the namespace name is available" + "operationId": "NotificationHubs_ListAuthorizationRules", + "description": "Gets the authorization rules for a NotificationHub.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." }, - "Reason": { + { + "name": "namespaceName", + "in": "path", + "required": true, "type": "string", - "description": "States the reason due to which the namespace name is not available" + "description": "The namespace name" }, - "Message": { + { + "name": "notificationHubName", + "in": "path", + "required": true, "type": "string", - "description": "The messsage returned when checking for namespace name availability" + "description": "The notification hub name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Get all NotificationHub AuthorizationRules", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleListResult" + } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "CheckAvailabilityParameters": { - "properties": { - "id": { - "readOnly": true, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "NotificationHubs" + ], + "x-ms-examples": { + "notificationhubAuthorizationRuleListKey": { + "$ref": "./examples/NotificationHubs/NotificationHubAuthorizationRuleListKey.json" + } + }, + "operationId": "NotificationHubs_ListKeys", + "description": "Gets the Primary and Secondary ConnectionStrings to the NotificationHub ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, "type": "string", - "description": "Resource Id" + "description": "The name of the resource group." }, - "name": { + { + "name": "namespaceName", + "in": "path", + "required": true, "type": "string", - "description": "Resource name" + "description": "The namespace name." }, - "type": { - "readOnly": true, + { + "name": "notificationHubName", + "in": "path", + "required": true, "type": "string", - "description": "Resource type" + "description": "The notification hub name." }, - "location": { + { + "name": "authorizationRuleName", + "in": "path", + "required": true, "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" + "description": "The connection string of the NotificationHub for the specified authorizationRule." }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "The sku of the created namespace" + { + "$ref": "#/parameters/ApiVersionParameter" }, - "isAvailiable": { - "type": "boolean", - "description": "True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false." + { + "$ref": "#/parameters/SubscriptionIdParameter" } - }, - "required": [ - "name", - "location" ], - "description": "Parameters supplied to the Check Name Availability for Namespace and NotificationHubs." - }, - "CheckAvailabilityResult": { - "properties": { - "isAvailiable": { - "type": "boolean", - "description": "True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false." + "responses": { + "200": { + "description": "Gets the Namespace AuthorizationRule's Primary keys and Secondary keys along with the ConnectionStrings", + "schema": { + "$ref": "#/definitions/ResourceListKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "NotificationHubs" + ], + "x-ms-examples": { + "notificationhubAuthorizationRuleRegenrateKey": { + "$ref": "./examples/NotificationHubs/NotificationHubAuthorizationRuleRegenrateKey.json" } }, - "allOf": [ + "operationId": "NotificationHubs_RegenerateKeys", + "description": "Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule", + "parameters": [ { - "$ref": "#/definitions/Resource" - } - ], - "description": "Description of a CheckAvailibility resource." - }, - "NamespaceProperties": { - "properties": { - "name": { - "type": "string", - "description": "The name of the namespace." - }, - "provisioningState": { + "name": "resourceGroupName", + "in": "path", + "required": true, "type": "string", - "description": "Provisioning state of the Namespace." + "description": "The name of the resource group." }, - "region": { - "externalDocs": { - "url": "http://msdn.microsoft.com/en-us/library/windowsazure/jj873988.aspx" - }, + { + "name": "namespaceName", + "in": "path", + "required": true, "type": "string", - "description": "Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia EastAustralia SoutheastCentral USEast USEast US 2West USNorth Central USSouth Central USEast AsiaSoutheast AsiaBrazil SouthJapan EastJapan WestNorth EuropeWest Europe" + "description": "The namespace name." }, - "status": { - "externalDocs": { - "url": "http://msdn.microsoft.com/en-us/library/windowsazure/jj873988.aspx" - }, + { + "name": "notificationHubName", + "in": "path", + "required": true, "type": "string", - "description": "Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting" + "description": "The notification hub name." }, - "createdAt": { + { + "name": "authorizationRuleName", + "in": "path", + "required": true, "type": "string", - "format": "date-time", - "description": "The time the namespace was created." + "description": "The connection string of the NotificationHub for the specified authorizationRule." }, - "serviceBusEndpoint": { - "externalDocs": { - "url": "http://msdn.microsoft.com/en-us/library/windowsazure/jj873988.aspx" + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicykeyResource" }, - "type": "string", - "description": "Endpoint you can use to perform NotificationHub operations." + "description": "Parameters supplied to regenerate the NotificationHub Authorization Rule Key." }, - "subscriptionId": { + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Regenerate the Primary/Secondary Key and returns the Keys and the connection string", + "schema": { + "$ref": "#/definitions/ResourceListKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/pnsCredentials": { + "post": { + "tags": [ + "NotificationHubs" + ], + "x-ms-examples": { + "notificationHubPnsCredentials": { + "$ref": "./examples/NotificationHubs/NotificationHubPnsCredentials.json" + } + }, + "operationId": "NotificationHubs_GetPnsCredentials", + "description": "Lists the PNS Credentials associated with a notification hub .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, "type": "string", - "description": "The Id of the Azure subscription associated with the namespace." + "description": "The name of the resource group." }, - "scaleUnit": { + { + "name": "namespaceName", + "in": "path", + "required": true, "type": "string", - "description": "ScaleUnit where the namespace gets created" + "description": "The namespace name." }, - "enabled": { - "type": "boolean", - "description": "Whether or not the namespace is currently enabled." + { + "name": "notificationHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The notification hub name." }, - "critical": { - "type": "boolean", - "description": "Whether or not the namespace is set as Critical." + { + "$ref": "#/parameters/ApiVersionParameter" }, - "namespaceType": { - "type": "string", - "description": "The namespace type.", - "enum": [ - "Messaging", - "NotificationHub" - ], - "x-ms-enum": { - "name": "NamespaceType", - "modelAsString": false - } - } - }, - "description": "Namespace properties." - }, - "NamespaceCreateOrUpdateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/NamespaceProperties", - "description": "Properties of the Namespace." - } - }, - "required": [ - "location" - ], - "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "#/parameters/SubscriptionIdParameter" } ], - "description": "Parameters supplied to the CreateOrUpdate Namespace operation." - }, - "NamespacePatchParameters": { - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "The sku of the created namespace" + "responses": { + "200": { + "description": "Gets all the NotificationHub PNS credentials", + "schema": { + "$ref": "#/definitions/PnsCredentialsResource" + } } - }, - "description": "Parameters supplied to the Patch Namespace operation." - }, - "NamespaceResource": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/NamespaceProperties", - "description": "Properties of the Namespace." + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list NotificationHubs operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "List of NotificationHubs operations supported by the Microsoft.NotificationHubs resource provider.", + "items": { + "$ref": "#/definitions/Operation" } }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Description of a Namespace resource." - }, - "SharedAccessAuthorizationRuleProperties": { - "properties": { - "rights": { - "type": "array", - "items": { + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "A NotificationHubs REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, "type": "string", - "enum": [ - "Manage", - "Send", - "Listen" - ], - "x-ms-enum": { - "name": "AccessRights", - "modelAsString": false - } + "description": "Service provider: Microsoft.NotificationHubs" }, - "description": "The rights associated with the rule." + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource on which the operation is performed: Invoice, etc." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Operation type: Read, write, delete, etc." + } } + } + } + }, + "ErrorResponse": { + "description": "Error reponse indicates NotificationHubs service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" }, - "description": "SharedAccessAuthorizationRule properties." - }, - "SharedAccessAuthorizationRuleCreateOrUpdateParameters": { - "properties": { - "properties": { - "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties", - "description": "Properties of the Namespace AuthorizationRules." - } + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "CheckAvailabilityParameters": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" }, - "required": [ - "properties" - ], - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Parameters supplied to the CreateOrUpdate Namespace AuthorizationRules." - }, - "SharedAccessAuthorizationRuleResource": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties", - "description": "Pproperties of the Namespace AuthorizationRule." - } + "name": { + "type": "string", + "description": "Resource name" }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Description of a Namespace AuthorizationRules." - }, - "NamespaceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/NamespaceResource" - }, - "description": "Result of the List Namespace operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of Namespaces" - } + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" }, - "description": "The response of the List Namespace operation." - }, - "SharedAccessAuthorizationRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" - }, - "description": "Result of the List AuthorizationRules operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of AuthorizationRules" - } + "location": { + "type": "string", + "description": "Resource location" }, - "description": "The response of the List Namespace operation." - }, - "ResourceListKeys": { - "properties": { - "primaryConnectionString": { - "type": "string", - "description": "PrimaryConnectionString of the AuthorizationRule." - }, - "secondaryConnectionString": { - "type": "string", - "description": "SecondaryConnectionString of the created AuthorizationRule" + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" }, - "primaryKey": { - "type": "string", - "description": "PrimaryKey of the created AuthorizationRule." - }, - "secondaryKey": { - "type": "string", - "description": "SecondaryKey of the created AuthorizationRule" - }, - "keyName": { - "type": "string", - "description": "KeyName of the created AuthorizationRule" - } + "description": "Resource tags" }, - "description": "Namespace/NotificationHub Connection String" - }, - "PolicykeyResource": { - "properties": { - "policyKey": { - "type": "string", - "description": "Name of the key that has to be regenerated for the Namespace/Notification Hub Authorization Rule. The value can be Primary Key/Secondary Key." - } + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the created namespace" }, - "description": "Namespace/NotificationHub Regenerate Keys" + "isAvailiable": { + "type": "boolean", + "description": "True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false." + } }, - "ApnsCredentialProperties": { - "properties": { - "apnsCertificate": { - "type": "string", - "description": "The APNS certificate." - }, - "certificateKey": { - "type": "string", - "description": "The certificate key." - }, - "endpoint": { - "type": "string", - "description": "The endpoint of this credential." - }, - "thumbprint": { - "type": "string", - "description": "The Apns certificate Thumbprint" - }, - "keyId": { - "type": "string", - "description": "A 10-character key identifier (kid) key, obtained from your developer account" + "required": [ + "name" + ], + "description": "Parameters supplied to the Check Name Availability for Namespace and NotificationHubs." + }, + "CheckAvailabilityResult": { + "properties": { + "isAvailiable": { + "type": "boolean", + "description": "True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Description of a CheckAvailibility resource." + }, + "NamespaceProperties": { + "properties": { + "name": { + "type": "string", + "description": "The name of the namespace." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the Namespace." + }, + "region": { + "externalDocs": { + "url": "http://msdn.microsoft.com/en-us/library/windowsazure/jj873988.aspx" }, - "appName": { - "type": "string", - "description": "The name of the application" + "type": "string", + "description": "Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia EastAustralia SoutheastCentral USEast USEast US 2West USNorth Central USSouth Central USEast AsiaSoutheast AsiaBrazil SouthJapan EastJapan WestNorth EuropeWest Europe" + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "Identifier for Azure Insights metrics" + }, + "status": { + "externalDocs": { + "url": "http://msdn.microsoft.com/en-us/library/windowsazure/jj873988.aspx" }, - "appId": { - "type": "string", - "description": "The issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account" + "type": "string", + "description": "Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The time the namespace was created." + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "description": "The time the namespace was updated." + }, + "serviceBusEndpoint": { + "externalDocs": { + "url": "http://msdn.microsoft.com/en-us/library/windowsazure/jj873988.aspx" }, - "token": { - "type": "string", - "description": "Provider Authentication Token, obtained through your developer account" - } + "type": "string", + "description": "Endpoint you can use to perform NotificationHub operations." }, - "description": "Description of a NotificationHub ApnsCredential." + "subscriptionId": { + "type": "string", + "description": "The Id of the Azure subscription associated with the namespace." + }, + "scaleUnit": { + "type": "string", + "description": "ScaleUnit where the namespace gets created" + }, + "enabled": { + "type": "boolean", + "description": "Whether or not the namespace is currently enabled." + }, + "critical": { + "type": "boolean", + "description": "Whether or not the namespace is set as Critical." + }, + "dataCenter": { + "type": "string", + "description": "Data center for the namespace" + }, + "namespaceType": { + "type": "string", + "description": "The namespace type.", + "enum": [ + "Messaging", + "NotificationHub" + ], + "x-ms-enum": { + "name": "NamespaceType", + "modelAsString": false + } + } }, - "ApnsCredential": { + "description": "Namespace properties." + }, + "NamespaceCreateOrUpdateParameters": { + "properties": { "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApnsCredentialProperties", - "description": "Properties of NotificationHub ApnsCredential." - } + "x-ms-client-flatten": true, + "$ref": "#/definitions/NamespaceProperties", + "description": "Properties of the Namespace." + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Parameters supplied to the CreateOrUpdate Namespace operation." + }, + "NamespacePatchParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" }, - "description": "Description of a NotificationHub ApnsCredential." + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the created namespace" + } }, - "WnsCredentialProperties": { + "description": "Parameters supplied to the Patch Namespace operation." + }, + "NamespaceResource": { + "properties": { "properties": { - "packageSid": { - "type": "string", - "description": "The package ID for this credential." - }, - "secretKey": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NamespaceProperties", + "description": "Properties of the Namespace." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Description of a Namespace resource." + }, + "SharedAccessAuthorizationRuleProperties": { + "properties": { + "rights": { + "type": "array", + "items": { "type": "string", - "description": "The secret key." + "enum": [ + "Manage", + "Send", + "Listen" + ], + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": false + } }, - "windowsLiveEndpoint": { - "type": "string", - "description": "The Windows Live endpoint." - } + "description": "The rights associated with the rule." + }, + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." }, - "description": "Description of a NotificationHub WnsCredential." + "keyName": { + "readOnly": true, + "type": "string", + "description": "A string that describes the authorization rule." + }, + "claimType": { + "readOnly": true, + "type": "string", + "description": "A string that describes the claim type" + }, + "claimValue": { + "readOnly": true, + "type": "string", + "description": "A string that describes the claim value" + }, + "modifiedTime": { + "readOnly": true, + "type": "string", + "description": "The last modified time for this rule" + }, + "createdTime": { + "readOnly": true, + "type": "string", + "description": "The created time for this rule" + }, + "revision": { + "readOnly": true, + "type": "integer", + "description": "The revision number for the rule" + } }, - "WnsCredential": { + "description": "SharedAccessAuthorizationRule properties." + }, + "SharedAccessAuthorizationRuleCreateOrUpdateParameters": { + "properties": { "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/WnsCredentialProperties", - "description": "Properties of NotificationHub WnsCredential." - } - }, - "description": "Description of a NotificationHub WnsCredential." + "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties", + "description": "Properties of the Namespace AuthorizationRules." + } }, - "GcmCredentialProperties": { + "required": [ + "properties" + ], + "description": "Parameters supplied to the CreateOrUpdate Namespace AuthorizationRules." + }, + "SharedAccessAuthorizationRuleResource": { + "properties": { "properties": { - "gcmEndpoint": { - "type": "string", - "description": "The GCM endpoint." - }, - "googleApiKey": { - "type": "string", - "description": "The Google API key." - } + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties", + "description": "Pproperties of the Namespace AuthorizationRule." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Description of a Namespace AuthorizationRules." + }, + "NamespaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NamespaceResource" + }, + "description": "Result of the List Namespace operation." }, - "description": "Description of a NotificationHub GcmCredential." + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Namespaces" + } }, - "GcmCredential": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/GcmCredentialProperties", - "description": "Properties of NotificationHub GcmCredential." - } + "description": "The response of the List Namespace operation." + }, + "SharedAccessAuthorizationRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" + }, + "description": "Result of the List AuthorizationRules operation." }, - "description": "Description of a NotificationHub GcmCredential." + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of AuthorizationRules" + } }, - "MpnsCredentialProperties": { - "properties": { - "mpnsCertificate": { - "type": "string", - "description": "The MPNS certificate." - }, - "certificateKey": { - "type": "string", - "description": "The certificate key for this credential." - }, - "thumbprint": { - "type": "string", - "description": "The Mpns certificate Thumbprint" - } + "description": "The response of the List Namespace operation." + }, + "ResourceListKeys": { + "properties": { + "primaryConnectionString": { + "type": "string", + "description": "PrimaryConnectionString of the AuthorizationRule." + }, + "secondaryConnectionString": { + "type": "string", + "description": "SecondaryConnectionString of the created AuthorizationRule" + }, + "primaryKey": { + "type": "string", + "description": "PrimaryKey of the created AuthorizationRule." + }, + "secondaryKey": { + "type": "string", + "description": "SecondaryKey of the created AuthorizationRule" + }, + "keyName": { + "type": "string", + "description": "KeyName of the created AuthorizationRule" + } + }, + "description": "Namespace/NotificationHub Connection String" + }, + "PolicykeyResource": { + "properties": { + "policyKey": { + "type": "string", + "description": "Name of the key that has to be regenerated for the Namespace/Notification Hub Authorization Rule. The value can be Primary Key/Secondary Key." + } + }, + "description": "Namespace/NotificationHub Regenerate Keys" + }, + "ApnsCredentialProperties": { + "properties": { + "apnsCertificate": { + "type": "string", + "description": "The APNS certificate." + }, + "certificateKey": { + "type": "string", + "description": "The certificate key." + }, + "endpoint": { + "type": "string", + "description": "The endpoint of this credential." + }, + "thumbprint": { + "type": "string", + "description": "The Apns certificate Thumbprint" + }, + "keyId": { + "type": "string", + "description": "A 10-character key identifier (kid) key, obtained from your developer account" }, - "description": "Description of a NotificationHub MpnsCredential." + "appName": { + "type": "string", + "description": "The name of the application" + }, + "appId": { + "type": "string", + "description": "The issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account" + }, + "token": { + "type": "string", + "description": "Provider Authentication Token, obtained through your developer account" + } }, - "MpnsCredential": { + "description": "Description of a NotificationHub ApnsCredential." + }, + "ApnsCredential": { + "properties": { "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/MpnsCredentialProperties", - "description": "Properties of NotificationHub MpnsCredential." - } + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApnsCredentialProperties", + "description": "Properties of NotificationHub ApnsCredential." + } + }, + "description": "Description of a NotificationHub ApnsCredential." + }, + "WnsCredentialProperties": { + "properties": { + "packageSid": { + "type": "string", + "description": "The package ID for this credential." + }, + "secretKey": { + "type": "string", + "description": "The secret key." }, - "description": "Description of a NotificationHub MpnsCredential." + "windowsLiveEndpoint": { + "type": "string", + "description": "The Windows Live endpoint." + } }, - "AdmCredentialProperties": { + "description": "Description of a NotificationHub WnsCredential." + }, + "WnsCredential": { + "properties": { "properties": { - "clientId": { - "type": "string", - "description": "The client identifier." - }, - "clientSecret": { - "type": "string", - "description": "The credential secret access key." - }, - "authTokenUrl": { - "type": "string", - "description": "The URL of the authorization token." - } + "x-ms-client-flatten": true, + "$ref": "#/definitions/WnsCredentialProperties", + "description": "Properties of NotificationHub WnsCredential." + } + }, + "description": "Description of a NotificationHub WnsCredential." + }, + "GcmCredentialProperties": { + "properties": { + "gcmEndpoint": { + "type": "string", + "description": "The GCM endpoint." }, - "description": "Description of a NotificationHub AdmCredential." + "googleApiKey": { + "type": "string", + "description": "The Google API key." + } }, - "AdmCredential": { + "description": "Description of a NotificationHub GcmCredential." + }, + "GcmCredential": { + "properties": { "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AdmCredentialProperties", - "description": "Properties of NotificationHub AdmCredential." - } + "x-ms-client-flatten": true, + "$ref": "#/definitions/GcmCredentialProperties", + "description": "Properties of NotificationHub GcmCredential." + } + }, + "description": "Description of a NotificationHub GcmCredential." + }, + "MpnsCredentialProperties": { + "properties": { + "mpnsCertificate": { + "type": "string", + "description": "The MPNS certificate." }, - "description": "Description of a NotificationHub AdmCredential." + "certificateKey": { + "type": "string", + "description": "The certificate key for this credential." + }, + "thumbprint": { + "type": "string", + "description": "The Mpns certificate Thumbprint" + } }, - "BaiduCredentialProperties": { + "description": "Description of a NotificationHub MpnsCredential." + }, + "MpnsCredential": { + "properties": { "properties": { - "baiduApiKey": { - "type": "string", - "description": "Baidu Api Key." - }, - "baiduEndPoint": { - "type": "string", - "description": "Baidu Endpoint." - }, - "baiduSecretKey": { - "type": "string", - "description": "Baidu Secret Key" - } + "x-ms-client-flatten": true, + "$ref": "#/definitions/MpnsCredentialProperties", + "description": "Properties of NotificationHub MpnsCredential." + } + }, + "description": "Description of a NotificationHub MpnsCredential." + }, + "AdmCredentialProperties": { + "properties": { + "clientId": { + "type": "string", + "description": "The client identifier." }, - "description": "Description of a NotificationHub BaiduCredential." + "clientSecret": { + "type": "string", + "description": "The credential secret access key." + }, + "authTokenUrl": { + "type": "string", + "description": "The URL of the authorization token." + } }, - "BaiduCredential": { + "description": "Description of a NotificationHub AdmCredential." + }, + "AdmCredential": { + "properties": { "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/BaiduCredentialProperties", - "description": "Properties of NotificationHub BaiduCredential." - } + "x-ms-client-flatten": true, + "$ref": "#/definitions/AdmCredentialProperties", + "description": "Properties of NotificationHub AdmCredential." + } + }, + "description": "Description of a NotificationHub AdmCredential." + }, + "BaiduCredentialProperties": { + "properties": { + "baiduApiKey": { + "type": "string", + "description": "Baidu Api Key." }, - "description": "Description of a NotificationHub BaiduCredential." + "baiduEndPoint": { + "type": "string", + "description": "Baidu Endpoint." + }, + "baiduSecretKey": { + "type": "string", + "description": "Baidu Secret Key" + } }, - "NotificationHubProperties": { + "description": "Description of a NotificationHub BaiduCredential." + }, + "BaiduCredential": { + "properties": { "properties": { - "name": { - "type": "string", - "description": "The NotificationHub name." - }, - "registrationTtl": { - "type": "string", - "description": "The RegistrationTtl of the created NotificationHub" - }, - "authorizationRules": { - "type": "array", - "items": { - "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" - }, - "description": "The AuthorizationRules of the created NotificationHub" - }, - "apnsCredential": { - "$ref": "#/definitions/ApnsCredential", - "description": "The ApnsCredential of the created NotificationHub" - }, - "wnsCredential": { - "$ref": "#/definitions/WnsCredential", - "description": "The WnsCredential of the created NotificationHub" - }, - "gcmCredential": { - "$ref": "#/definitions/GcmCredential", - "description": "The GcmCredential of the created NotificationHub" - }, - "mpnsCredential": { - "$ref": "#/definitions/MpnsCredential", - "description": "The MpnsCredential of the created NotificationHub" - }, - "admCredential": { - "$ref": "#/definitions/AdmCredential", - "description": "The AdmCredential of the created NotificationHub" + "x-ms-client-flatten": true, + "$ref": "#/definitions/BaiduCredentialProperties", + "description": "Properties of NotificationHub BaiduCredential." + } + }, + "description": "Description of a NotificationHub BaiduCredential." + }, + "NotificationHubProperties": { + "properties": { + "name": { + "type": "string", + "description": "The NotificationHub name." + }, + "registrationTtl": { + "type": "string", + "description": "The RegistrationTtl of the created NotificationHub" + }, + "authorizationRules": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" }, - "baiduCredential": { - "$ref": "#/definitions/BaiduCredential", - "description": "The BaiduCredential of the created NotificationHub" - } + "description": "The AuthorizationRules of the created NotificationHub" + }, + "apnsCredential": { + "$ref": "#/definitions/ApnsCredential", + "description": "The ApnsCredential of the created NotificationHub" + }, + "wnsCredential": { + "$ref": "#/definitions/WnsCredential", + "description": "The WnsCredential of the created NotificationHub" + }, + "gcmCredential": { + "$ref": "#/definitions/GcmCredential", + "description": "The GcmCredential of the created NotificationHub" + }, + "mpnsCredential": { + "$ref": "#/definitions/MpnsCredential", + "description": "The MpnsCredential of the created NotificationHub" + }, + "admCredential": { + "$ref": "#/definitions/AdmCredential", + "description": "The AdmCredential of the created NotificationHub" }, - "description": "NotificationHub properties." + "baiduCredential": { + "$ref": "#/definitions/BaiduCredential", + "description": "The BaiduCredential of the created NotificationHub" + } }, - "NotificationHubCreateOrUpdateParameters": { + "description": "NotificationHub properties." + }, + "NotificationHubCreateOrUpdateParameters": { + "properties": { "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/NotificationHubProperties", - "description": "Properties of the NotificationHub." - } - }, - "required": [ - "location", - "properties" - ], - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Parameters supplied to the CreateOrUpdate NotificationHub operation." + "x-ms-client-flatten": true, + "$ref": "#/definitions/NotificationHubProperties", + "description": "Properties of the NotificationHub." + } }, - "NotificationHubResource": { + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Parameters supplied to the CreateOrUpdate NotificationHub operation." + }, + "NotificationHubPatchParameters": { + "properties": { "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/NotificationHubProperties", - "description": "Properties of the NotificationHub." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Description of a NotificationHub Resource." + "x-ms-client-flatten": true, + "$ref": "#/definitions/NotificationHubProperties", + "description": "Properties of the NotificationHub." + } }, - "PnsCredentialsResource": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Parameters supplied to the patch NotificationHub operation." + }, + "DebugSendParameters": { + "description": "Debug Send payload", + "type": "object" + }, + "NotificationHubResource": { + "properties": { "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PnsCredentialsProperties", - "description": "NotificationHub PNS Credentials." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Description of a NotificationHub PNS Credentials." + "x-ms-client-flatten": true, + "$ref": "#/definitions/NotificationHubProperties", + "description": "Properties of the NotificationHub." + } }, - "PnsCredentialsProperties": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Description of a NotificationHub Resource." + }, + "DebugSendResponse": { + "properties": { "properties": { - "apnsCredential": { - "$ref": "#/definitions/ApnsCredential", - "description": "The ApnsCredential of the created NotificationHub" - }, - "wnsCredential": { - "$ref": "#/definitions/WnsCredential", - "description": "The WnsCredential of the created NotificationHub" - }, - "gcmCredential": { - "$ref": "#/definitions/GcmCredential", - "description": "The GcmCredential of the created NotificationHub" - }, - "mpnsCredential": { - "$ref": "#/definitions/MpnsCredential", - "description": "The MpnsCredential of the created NotificationHub" - }, - "admCredential": { - "$ref": "#/definitions/AdmCredential", - "description": "The AdmCredential of the created NotificationHub" - }, - "baiduCredential": { - "$ref": "#/definitions/BaiduCredential", - "description": "The BaiduCredential of the created NotificationHub" - } - }, - "description": "Description of a NotificationHub PNS Credentials." + "x-ms-client-flatten": true, + "$ref": "#/definitions/DebugSendResult", + "description": "Properties of the NotificationHub." + } }, - "NotificationHubListResult": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Description of a NotificationHub Resource." + }, + "PnsCredentialsResource": { + "properties": { "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/NotificationHubResource" - }, - "description": "Result of the List NotificationHub operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of NotificationHub" - } + "x-ms-client-flatten": true, + "$ref": "#/definitions/PnsCredentialsProperties", + "description": "NotificationHub PNS Credentials." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Description of a NotificationHub PNS Credentials." + }, + "PnsCredentialsProperties": { + "properties": { + "apnsCredential": { + "$ref": "#/definitions/ApnsCredential", + "description": "The ApnsCredential of the created NotificationHub" + }, + "wnsCredential": { + "$ref": "#/definitions/WnsCredential", + "description": "The WnsCredential of the created NotificationHub" + }, + "gcmCredential": { + "$ref": "#/definitions/GcmCredential", + "description": "The GcmCredential of the created NotificationHub" }, - "description": "The response of the List NotificationHub operation." + "mpnsCredential": { + "$ref": "#/definitions/MpnsCredential", + "description": "The MpnsCredential of the created NotificationHub" + }, + "admCredential": { + "$ref": "#/definitions/AdmCredential", + "description": "The AdmCredential of the created NotificationHub" + }, + "baiduCredential": { + "$ref": "#/definitions/BaiduCredential", + "description": "The BaiduCredential of the created NotificationHub" + } }, - "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" + "description": "Description of a NotificationHub PNS Credentials." + }, + "NotificationHubListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NotificationHubResource" + }, + "description": "Result of the List NotificationHub operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of NotificationHub" + } + }, + "description": "The response of the List NotificationHub operation." + }, + "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" }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "The sku of the created namespace" - } + "description": "Resource tags" }, - "required": [ - "location" - ], - "x-ms-azure-resource": true + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the created namespace" + } }, - "SubResource": { - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "DebugSendResult": { + "properties": { + "success": { + "type": "number", + "description": "successful send" }, - "x-ms-azure-resource": true + "failure": { + "type": "number", + "description": "send failure" + }, + "results": { + "type": "object", + "description": "actual failure description" + } }, - "Sku": { - "properties": { - "name": { - "type": "string", - "description": "Name of the notification hub sku", - "enum": [ - "Free", - "Basic", - "Standard" - ], - "x-ms-enum": { - "name": "SkuName", - "modelAsString": true - } - }, - "tier": { - "type": "string", - "description": "The tier of particular sku" - }, - "size": { - "type": "string", - "description": "The Sku size" - }, - "family": { - "type": "string", - "description": "The Sku Family" - }, - "capacity": { - "type": "integer", - "description": "The capacity of the resource" + "x-ms-azure-resource": true + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "Name of the notification hub sku", + "enum": [ + "Free", + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true } }, - "required": [ - "name" - ], - "description": "The Sku description for a namespace" - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + "tier": { + "type": "string", + "description": "The tier of particular sku" + }, + "size": { + "type": "string", + "description": "The Sku size" + }, + "family": { + "type": "string", + "description": "The Sku Family" + }, + "capacity": { + "type": "integer", + "description": "The capacity of the resource" + } }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - } + "required": [ + "name" + ], + "description": "The Sku description for a namespace" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/specification/notificationhubs/resource-manager/readme.md b/specification/notificationhubs/resource-manager/readme.md index 085cc8581171..77bcf3aefbc2 100644 --- a/specification/notificationhubs/resource-manager/readme.md +++ b/specification/notificationhubs/resource-manager/readme.md @@ -24,12 +24,27 @@ To see additional help and options, run: ### Basic Information These are the global settings for the NotificationHubs API. +directive: + - where: + - $.definitions.NamespaceCreateOrUpdateParameters + suppress: + - TrackedResourcePatchOperation + - where: + - $.definitions.NamespaceCreateOrUpdateParameters + suppress: + - TrackedResourceGetOperation + ``` yaml openapi-type: arm tag: package-2017-04 +directive: + - where: + - $.definitions.NamespaceCreateOrUpdateParameters + suppress: + - TrackedResourcePatchOperation + - TrackedResourceGetOperation ``` - ### Tag: package-2017-04 These settings apply only when `--tag=package-2017-04` is specified on the command line. @@ -70,9 +85,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_notification_hubs'] ``` @@ -173,11 +191,60 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.notificationhubs +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-notificationhubs +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2014-09 + - tag: package-2017-04 + - tag: package-2016-03 +``` + +### Tag: package-2014-09 and java + +These settings apply only when `--tag=package-2014-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2014-09' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.notificationhubs - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-notificationhubs + namespace: com.microsoft.azure.management.notificationhubs.v2014_09_01 + output-folder: $(azure-libraries-for-java-folder)/notificationhubs/resource-manager/v2014_09_01 +regenerate-manager: true +generate-interface: true ``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.notificationhubs.v2017_04_01 + output-folder: $(azure-libraries-for-java-folder)/notificationhubs/resource-manager/v2017_04_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-03 and java + +These settings apply only when `--tag=package-2016-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.notificationhubs.v2016_03_01 + output-folder: $(azure-libraries-for-java-folder)/notificationhubs/resource-manager/v2016_03_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/notificationhubs/resource-manager/readme.ruby.md b/specification/notificationhubs/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..d6f04226df61 --- /dev/null +++ b/specification/notificationhubs/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_notification_hubs +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2017-04 +``` + +### Tag: package-2017-04 and ruby + +These settings apply only when `--tag=package-2017-04 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-04' && $(ruby) +namespace: "Azure::NotificationHubs::Mgmt::V2017_04_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_notification_hubs/lib +``` diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/examples/oms-get-cross-workspace-example.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/examples/oms-get-cross-workspace-example.json new file mode 100644 index 000000000000..25d7021ba7de --- /dev/null +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/examples/oms-get-cross-workspace-example.json @@ -0,0 +1,69 @@ +{ + "title": "Cross Workspace Query", + "description": "A cross workspace query that the type and count of each row per workspace.", + "parameters": { + "subscriptionId": "c512b59c-4005-40e2-b13d-ac29cfb46af4", + "resourceGroupName": "test-rg", + "workspaceName": "azure-insights", + "apiVersion": "2017-10-01", + "query": "union * | where TimeGenerated > ago(1h) | summarize count() by Type, TenantId", + "workspaces": "draft-test,draft-test-2" + }, + "responses": { + "200": { + "body": { + "tables": [ + { + "name": "PrimaryResult", + "columns": [ + { + "name": "Type", + "type": "string" + }, + { + "name": "TenantId", + "type": "string" + }, + { + "name": "count_", + "type": "long" + } + ], + "rows": [ + [ + "Usage", + "63613592-b6f7-4c3d-a390-22ba13102111", + "1" + ], + [ + "Usage", + "d436f322-a9f4-4aad-9a7d-271fbf66001c", + "1" + ], + [ + "BillingFact", + "63613592-b6f7-4c3d-a390-22ba13102111", + "1" + ], + [ + "BillingFact", + "d436f322-a9f4-4aad-9a7d-271fbf66001c", + "1" + ], + [ + "Operation", + "63613592-b6f7-4c3d-a390-22ba13102111", + "7" + ], + [ + "Operation", + "d436f322-a9f4-4aad-9a7d-271fbf66001c", + "5" + ] + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/examples/oms-get-example.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/examples/oms-get-example.json new file mode 100644 index 000000000000..6a7270b99638 --- /dev/null +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/examples/oms-get-example.json @@ -0,0 +1,161 @@ +{ + "title": "Simple Query", + "description": "A simple query that returns query results.", + "parameters": { + "subscriptionId": "c512b59c-4005-40e2-b13d-ac29cfb46af4", + "resourceGroupName": "test-rg", + "workspaceName": "azure-insights", + "apiVersion": "2017-10-01", + "query": "Usage | take 10", + "timespan": "PT12H" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "58a37988-2c05-427a-891f-5e0e1266fcc5", + "x-ms-correlation-request-id": "58a37988-2c05-427a-891f-5e0e1266fcc5" + }, + "body": { + "tables": [ + { + "name": "PrimaryResult", + "columns": [ + { + "name": "TenantId", + "type": "string" + }, + { + "name": "Computer", + "type": "string" + }, + { + "name": "TimeGenerated", + "type": "datetime" + }, + { + "name": "SourceSystem", + "type": "string" + }, + { + "name": "StartTime", + "type": "datetime" + }, + { + "name": "EndTime", + "type": "datetime" + }, + { + "name": "ResourceUri", + "type": "string" + }, + { + "name": "LinkedResourceUri", + "type": "string" + }, + { + "name": "DataType", + "type": "string" + }, + { + "name": "Solution", + "type": "string" + }, + { + "name": "BatchesWithinSla", + "type": "long" + }, + { + "name": "BatchesOutsideSla", + "type": "long" + }, + { + "name": "BatchesCapped", + "type": "long" + }, + { + "name": "TotalBatches", + "type": "long" + }, + { + "name": "AvgLatencyInSeconds", + "type": "real" + }, + { + "name": "Quantity", + "type": "real" + }, + { + "name": "QuantityUnit", + "type": "string" + }, + { + "name": "IsBillable", + "type": "bool" + }, + { + "name": "MeterId", + "type": "string" + }, + { + "name": "LinkedMeterId", + "type": "string" + }, + { + "name": "Type", + "type": "string" + } + ], + "rows": [ + [ + "b438b4f6-912a-46d5-9cb1-b44069212abc", + "ContosoSQLSrv1", + "2017-08-24T06:59:59Z", + "OMS", + "2017-08-24T06:00:00Z", + "2017-08-24T06:59:59Z", + "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourcegroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-it", + null, + "Perf", + "LogManagement", + "1", + "0", + "0", + "1", + "1.286", + "0.076408", + "MBytes", + "true", + "a4e29a95-5b4c-408b-80e3-113f9410566e", + "00000000-0000-0000-0000-000000000000", + "Usage" + ], + [ + "b438b4f6-912a-46d5-9cb1-b44069212abc", + "Store010Web3", + "2017-08-24T06:59:59Z", + "OMS", + "2017-08-24T06:00:00Z", + "2017-08-24T06:59:59Z", + "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourcegroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-it", + null, + "Perf", + "LogManagement", + "1", + "0", + "0", + "1", + "1.7", + "0.106767", + "MBytes", + "true", + "a4e29a95-5b4c-408b-80e3-113f9410566e", + "00000000-0000-0000-0000-000000000000", + "Usage" + ] + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/examples/oms-post-cross-workspace-example.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/examples/oms-post-cross-workspace-example.json new file mode 100644 index 000000000000..f9fd525c53f6 --- /dev/null +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/examples/oms-post-cross-workspace-example.json @@ -0,0 +1,74 @@ +{ + "title": "Cross Workspace Query", + "description": "A cross workspace query that the type and count of each row per workspace.", + "parameters": { + "subscriptionId": "c512b59c-4005-40e2-b13d-ac29cfb46af4", + "resourceGroupName": "test-rg", + "workspaceName": "azure-insights", + "apiVersion": "2017-10-01", + "body": { + "query": "union * | where TimeGenerated > ago(1h) | summarize count() by Type, TenantId", + "workspaces": [ + "draft-test", + "draft-test-2" + ] + } + }, + "responses": { + "200": { + "body": { + "tables": [ + { + "name": "PrimaryResult", + "columns": [ + { + "name": "Type", + "type": "string" + }, + { + "name": "TenantId", + "type": "string" + }, + { + "name": "count_", + "type": "long" + } + ], + "rows": [ + [ + "Usage", + "63613592-b6f7-4c3d-a390-22ba13102111", + "1" + ], + [ + "Usage", + "d436f322-a9f4-4aad-9a7d-271fbf66001c", + "1" + ], + [ + "BillingFact", + "63613592-b6f7-4c3d-a390-22ba13102111", + "1" + ], + [ + "BillingFact", + "d436f322-a9f4-4aad-9a7d-271fbf66001c", + "1" + ], + [ + "Operation", + "63613592-b6f7-4c3d-a390-22ba13102111", + "7" + ], + [ + "Operation", + "d436f322-a9f4-4aad-9a7d-271fbf66001c", + "5" + ] + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/examples/oms-post-example.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/examples/oms-post-example.json new file mode 100644 index 000000000000..f31fb44c76a1 --- /dev/null +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/examples/oms-post-example.json @@ -0,0 +1,159 @@ +{ + "title": "Simple Query", + "description": "A simple query that returns query results.", + "parameters": { + "subscriptionId": "c512b59c-4005-40e2-b13d-ac29cfb46af4", + "resourceGroupName": "test-rg", + "workspaceName": "azure-insights", + "apiVersion": "2017-10-01", + "body": { + "query": "Usage | take 10", + "timespan": "PT12H" + } + }, + "responses": { + "200": { + "body": { + "tables": [ + { + "name": "PrimaryResult", + "columns": [ + { + "name": "TenantId", + "type": "string" + }, + { + "name": "Computer", + "type": "string" + }, + { + "name": "TimeGenerated", + "type": "datetime" + }, + { + "name": "SourceSystem", + "type": "string" + }, + { + "name": "StartTime", + "type": "datetime" + }, + { + "name": "EndTime", + "type": "datetime" + }, + { + "name": "ResourceUri", + "type": "string" + }, + { + "name": "LinkedResourceUri", + "type": "string" + }, + { + "name": "DataType", + "type": "string" + }, + { + "name": "Solution", + "type": "string" + }, + { + "name": "BatchesWithinSla", + "type": "long" + }, + { + "name": "BatchesOutsideSla", + "type": "long" + }, + { + "name": "BatchesCapped", + "type": "long" + }, + { + "name": "TotalBatches", + "type": "long" + }, + { + "name": "AvgLatencyInSeconds", + "type": "real" + }, + { + "name": "Quantity", + "type": "real" + }, + { + "name": "QuantityUnit", + "type": "string" + }, + { + "name": "IsBillable", + "type": "bool" + }, + { + "name": "MeterId", + "type": "string" + }, + { + "name": "LinkedMeterId", + "type": "string" + }, + { + "name": "Type", + "type": "string" + } + ], + "rows": [ + [ + "b438b4f6-912a-46d5-9cb1-b44069212abc", + "ContosoSQLSrv1", + "2017-08-24T06:59:59Z", + "OMS", + "2017-08-24T06:00:00Z", + "2017-08-24T06:59:59Z", + "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourcegroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-it", + null, + "Perf", + "LogManagement", + "1", + "0", + "0", + "1", + "1.286", + "0.076408", + "MBytes", + "true", + "a4e29a95-5b4c-408b-80e3-113f9410566e", + "00000000-0000-0000-0000-000000000000", + "Usage" + ], + [ + "b438b4f6-912a-46d5-9cb1-b44069212abc", + "Store010Web3", + "2017-08-24T06:59:59Z", + "OMS", + "2017-08-24T06:00:00Z", + "2017-08-24T06:59:59Z", + "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourcegroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-it", + null, + "Perf", + "LogManagement", + "1", + "0", + "0", + "1", + "1.7", + "0.106767", + "MBytes", + "true", + "a4e29a95-5b4c-408b-80e3-113f9410566e", + "00000000-0000-0000-0000-000000000000", + "Usage" + ] + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/swagger.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/swagger.json new file mode 100644 index 000000000000..3732c773ad67 --- /dev/null +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/preview/2017-10-01/swagger.json @@ -0,0 +1,335 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-10-01", + "title": "Azure Log Analytics", + "description": "This API exposes Azure Log Analytics query capabilities", + "termsOfService": "https://dev.loganalytics.io/tos", + "contact": { + "name": "AIAPI Team", + "url": "https://dev.loganalytics.io/support", + "email": "aiapi@microsoft.com" + }, + "license": { + "name": "Microsoft", + "url": "https://dev.loganalytics.io/license" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/query": { + "post": { + "operationId": "Query_Execute", + "summary": "Execute an Analytics query", + "description": "Executes an Analytics query for data. [Here](https://dev.loganalytics.io/documentation/Using-the-API) is an example for using POST with an Analytics query.", + "x-ms-examples": { + "simple-query": { + "$ref": "examples/oms-post-example.json" + }, + "cross-workspace": { + "$ref": "examples/oms-post-cross-workspace-example.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/workspaceName" + }, + { + "$ref": "#/parameters/queryBody" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The API call succeeded and the Analytics query result is in the response payload", + "schema": { + "$ref": "#/definitions/queryResults" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + } + }, + "parameters": { + "queryParam": { + "name": "query", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "type": "string" + }, + "queryBody": { + "name": "body", + "in": "body", + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "required": true, + "schema": { + "$ref": "#/definitions/queryBody" + }, + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "apiVersion", + "description": "Client API version.", + "in": "query", + "required": true, + "type": "string", + "default": "2017-10-01", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "description": "The name of the resource group to get. The name is case insensitive.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "workspaceName": { + "name": "workspaceName", + "description": "Name of the Log Analytics workspace.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "queryParam": { + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "type": "string" + }, + "timespanParam": { + "description": "Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.", + "type": "string" + }, + "workspacesParam": { + "description": "Workspace IDs to include in cross-workspace queries.", + "type": "array", + "items": { + "type": "string" + } + }, + "queryBody": { + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "type": "object", + "properties": { + "query": { + "description": "The query to execute.", + "$ref": "#/definitions/queryParam" + }, + "timespan": { + "description": "Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.", + "$ref": "#/definitions/timespanParam" + }, + "workspaces": { + "description": "A list of workspaces that are included in the query.", + "$ref": "#/definitions/workspacesParam" + } + }, + "required": [ + "query" + ] + }, + "queryResults": { + "title": "A query response.", + "description": "Contains the tables, columns & rows resulting from a query.", + "type": "object", + "properties": { + "tables": { + "description": "The list of tables, columns and rows.", + "type": "array", + "items": { + "$ref": "#/definitions/table" + } + } + }, + "required": [ + "tables" + ] + }, + "table": { + "title": "A query response table.", + "description": "Contains the columns and rows for one table in a query response.", + "type": "object", + "properties": { + "name": { + "description": "The name of the table.", + "type": "string" + }, + "columns": { + "description": "The list of columns in this table.", + "type": "array", + "items": { + "$ref": "#/definitions/column" + } + }, + "rows": { + "description": "The resulting rows from this query.", + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "required": [ + "name", + "columns", + "rows" + ] + }, + "column": { + "title": "A table column.", + "description": "A column in a table.", + "type": "object", + "properties": { + "name": { + "description": "The name of this column.", + "type": "string" + }, + "type": { + "description": "The data type of this column.", + "type": "string" + } + } + }, + "errorDetail": { + "title": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error's code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "target": { + "description": "Indicates which property in the request is responsible for the error.", + "type": "string" + }, + "value": { + "description": "Indicates which value in 'target' is responsible for the error.", + "type": "string" + }, + "resources": { + "description": "Indicates resources which were responsible for the error.", + "type": "array", + "items": { + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "required": [ + "code", + "message" + ] + }, + "errorInfo": { + "title": "The code and message for an error.", + "type": "object", + "properties": { + "code": { + "description": "A machine readable error code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "details": { + "description": "error details.", + "type": "array", + "items": { + "$ref": "#/definitions/errorDetail" + } + }, + "innererror": { + "description": "Inner error details if they exist.", + "$ref": "#/definitions/errorInfo" + }, + "additionalProperties": { + "type": "object" + } + }, + "required": [ + "code", + "message" + ] + }, + "errorResponse": { + "title": "Error details.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "#/definitions/errorInfo" + } + }, + "required": [ + "error" + ] + } + } +} \ No newline at end of file diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/OperationalInsights.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/OperationalInsights.json index 9763c91b0a58..a78b272c061d 100644 --- a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/OperationalInsights.json +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/OperationalInsights.json @@ -67,6 +67,9 @@ }, { "$ref": "#/parameters/timespanParam" + }, + { + "$ref": "#/parameters/workspacesParam" } ], "responses": { @@ -85,9 +88,9 @@ } }, "post": { - "operationId": "Query_Post", + "operationId": "Query", "summary": "Execute an Analytics query", - "description": "Executes an Analytics query for data. [Here](/documentation/2-Using-the-API/Query) is an example for using POST with an Analytics query.", + "description": "Executes an Analytics query for data. [Here](https://dev.loganalytics.io/documentation/Using-the-API) is an example for using POST with an Analytics query.", "x-ms-examples": { "simple-query": { "$ref": "examples/oms-post-example.json" @@ -128,7 +131,17 @@ "in": "path", "required": true, "type": "string", - "x-ms-parameter-location": "client" + "x-ms-parameter-location": "method" + }, + "workspacesParam": { + "name": "workspaces", + "description": "Comma separated workspace IDs to include in cross-workspace queries.", + "in": "query", + "collectionFormat": "csv", + "required": false, + "default": "", + "type": "string", + "x-ms-parameter-location": "method" }, "queryParam": { "name": "query", @@ -165,8 +178,7 @@ }, "timespanParam": { "description": "Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.", - "type": "string", - "format": "duration" + "type": "string" }, "workspacesParam": { "description": "Workspace IDs to include in cross-workspace queries.", diff --git a/specification/operationalinsights/data-plane/readme.md b/specification/operationalinsights/data-plane/readme.md index c84516e8c5af..b10e8bd1a8af 100644 --- a/specification/operationalinsights/data-plane/readme.md +++ b/specification/operationalinsights/data-plane/readme.md @@ -25,7 +25,7 @@ These are the global settings for the OperationalInsightsData API. ``` yaml title: OperationalInsightsDataClient -description: Operational Insights Data Client +description: Log Analytics Data Plane Client add-credentials: true openapi-type: data-plane tag: v1 @@ -38,6 +38,18 @@ These settings apply only when `--tag=v1` is specified on the command line. ``` yaml $(tag) == 'v1' input-file: - Microsoft.OperationalInsights/stable/v1/OperationalInsights.json +directive: + - reason: Don't expose the GET endpoint since it's behavior is more limited than POST + remove-operation: Query_Get +``` + +``` yaml $(tag) == '20171001' +input-file: +- Microsoft.OperationalInsights/preview/2017-10-01/swagger.json +directive: + - reason: Rename Query_Post to Query so that we don't get an IQuery interface with 1 operation + where-operation: Query_Post + transform: $.operationId = "Query" ``` --- @@ -53,6 +65,8 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-go + - repo: azure-sdk-for-python + - repo: azure-sdk-for-node ``` ## C# @@ -67,11 +81,35 @@ csharp: clear-output-folder: true payload-flattening-threshold: 3 directive: - - reason: Don't expose the GET endpoint since it's behavior is more limited than POST - remove-operation: Query_Get - - reason: Rename Query_Post to Query so that we don't get an IQuery interface with 1 operation - where-operation: Query_Post - transform: $.operationId = "Query" + - from: swagger-document + where: $.definitions.table.properties.rows.items.items.type + transform: $ = "object" +``` + +``` yaml $(python) +python-mode: create +python: + override-client-name: LogAnalyticsDataClient + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.loganalytics + package-name: azure-loganalytics + package-version: 0.1.0 + clear-output-folder: true +directive: + - from: swagger-document + where: $.definitions.table.properties.rows.items.items.type + transform: $ = "object" +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-loganalytics/azure/loganalytics +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-loganalytics ``` ## Go @@ -110,9 +148,9 @@ Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(nodejs) +nodejs: + package-name: azure-loganalytics + package-version: 0.1.0 + output-folder: $(node-sdks-folder)/lib/services/loganalytics + override-client-name: LogAnalyticsClient + generate-license-txt: true + generate-package-json: true + generate-readme-md: false +``` \ No newline at end of file diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/OperationalInsights.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/OperationalInsights.json index 8abc098f8735..9018f3a7df6d 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/OperationalInsights.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/OperationalInsights.json @@ -637,7 +637,6 @@ "Workspaces" ], "description": "Purges data in an Log Analytics workspace by a set of user-defined filters.", - "x-ms-long-running-operation": true, "operationId": "Workspaces_Purge", "parameters": [ { @@ -661,8 +660,47 @@ "description": "Accepted request for purging an Log Analytics workspace.", "schema": { "$ref": "#/definitions/WorkspacePurgeResponse" + }, + "headers": { + "x-ms-status-location": { + "type": "string", + "description": "The location from which to request the operation status." + } } + } + }, + "x-ms-examples": { + "WorkspacePurge": { + "$ref": "./examples/WorkspacesPurge.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/operations/{purgeId}": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Gets status of an ongoing purge operation.", + "operationId": "Workspaces_GetPurgeStatus", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" }, + { + "$ref": "#/parameters/WorkspacePurgeIdParameter" + } + ], + "responses": { "200": { "description": "Returns status of purge operation in body of response. e.g.: running, completed.", "schema": { @@ -671,12 +709,12 @@ } }, "x-ms-examples": { - "WorkspacePurge": { - "$ref": "./examples/WorkspacesPurge.json" + "WorkspacePurgeOperation": { + "$ref": "./examples/WorkspacesPurgeOperation.json" } } } - } + } }, "definitions": { "OperationListResult": { @@ -1349,8 +1387,8 @@ "description": "Status of the operation represented by the requested Id.", "type": "string", "enum": [ - "Pending", - "Completed" + "pending", + "completed" ], "x-ms-enum": { "name": "PurgeState", diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/examples/WorkspacesPurge.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/examples/WorkspacesPurge.json index 43add10282ff..38d77936e96c 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/examples/WorkspacesPurge.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/examples/WorkspacesPurge.json @@ -2,7 +2,7 @@ "parameters": { "resourceGroupName":"OIAutoRest5123", "workspaceName":"aztest5048", - "api-version":"2015-03-02", + "api-version":"2015-03-20", "subscriptionId":"00000000-0000-0000-0000-00000000000", "body": { "table": "Heartbeat", @@ -17,14 +17,12 @@ }, "responses": { "202": { + "headers": { + "x-ms-status-location": "https://management.azure.com/subscriptions/b96161de-b34a-480f-7343-59b099299283/resourceGroups/example/providers/microsoft.operationalinsights/workspaces/test/operations/purge-970318e7-b859-4edb-8903-83b1b54d0b74?api-version=2015-03-20" + }, "body": { "operationId": "7d7cf277-9113-4ab3-8359-d0364b74d01d" } - }, - "200": { - "body": { - "status": "Completed" - } } } } diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/examples/WorkspacesPurgeOperation.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/examples/WorkspacesPurgeOperation.json new file mode 100644 index 000000000000..5575ca5b2bf0 --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/examples/WorkspacesPurgeOperation.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName":"OIAutoRest5123", + "workspaceName":"aztest5048", + "api-version":"2015-03-20", + "subscriptionId":"00000000-0000-0000-0000-00000000000", + "purgeId": "purge-970318e7-b859-4edb-8903-83b1b54d0b74" + }, + "responses": { + "200": { + "body": { + "status": "completed" + } + } + } +} \ No newline at end of file diff --git a/specification/operationalinsights/resource-manager/readme.md b/specification/operationalinsights/resource-manager/readme.md index 63b1aaf98e5c..9f787300d0c9 100644 --- a/specification/operationalinsights/resource-manager/readme.md +++ b/specification/operationalinsights/resource-manager/readme.md @@ -62,7 +62,11 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-go + - repo: azure-sdk-for-python - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_operational_insights'] ``` @@ -146,7 +150,7 @@ These settings apply only when `--tag=package-2015-11-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-11-preview' && $(go) -output-folder: $(go-sdk-folder)/services/operationalinsights/mgmt/2015-11-01-preview/operationalinsights +output-folder: $(go-sdk-folder)/services/preview/operationalinsights/mgmt/2015-11-01-preview/operationalinsights ``` ## Java @@ -155,16 +159,51 @@ 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 - fluent: true - namespace: com.microsoft.azure.management.operationalinsights - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-operationalinsights +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.operationalinsights +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-operationalinsights ``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-03 + - tag: package-2015-11-preview +``` + +### Tag: package-2015-03 and java + +These settings apply only when `--tag=package-2015-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.operationalinsights.v2015_03_20 + output-folder: $(azure-libraries-for-java-folder)/operationalinsights/resource-manager/v2015_03_20 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2015-11-preview and java + +These settings apply only when `--tag=package-2015-11-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-11-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.operationalinsights.v2015_11_01_preview + output-folder: $(azure-libraries-for-java-folder)/operationalinsights/resource-manager/v2015_11_01_preview +regenerate-manager: true +generate-interface: true +``` + + ## Suppression ``` yaml diff --git a/specification/operationalinsights/resource-manager/readme.ruby.md b/specification/operationalinsights/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..7a73b2234e1e --- /dev/null +++ b/specification/operationalinsights/resource-manager/readme.ruby.md @@ -0,0 +1,37 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_operational_insights +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2015-11-preview + - tag: package-2015-03 +``` + +### Tag: package-2015-11-preview and ruby + +These settings apply only when `--tag=package-2015-11-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-11-preview' && $(ruby) +namespace: "Azure::OperationalInsights::Mgmt::V2015_11_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_operational_insights/lib +``` + +### Tag: package-2015-03 and ruby + +These settings apply only when `--tag=package-2015-03 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-03' && $(ruby) +namespace: "Azure::OperationalInsights::Mgmt::V2015_03_20" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_operational_insights/lib +``` diff --git a/specification/operationsmanagement/resource-manager/Microsoft.OperationsManagement/preview/2015-11-01-preview/OperationsManagement.json b/specification/operationsmanagement/resource-manager/Microsoft.OperationsManagement/preview/2015-11-01-preview/OperationsManagement.json index c060766be487..940280561306 100644 --- a/specification/operationsmanagement/resource-manager/Microsoft.OperationsManagement/preview/2015-11-01-preview/OperationsManagement.json +++ b/specification/operationsmanagement/resource-manager/Microsoft.OperationsManagement/preview/2015-11-01-preview/OperationsManagement.json @@ -40,8 +40,9 @@ "Solution" ], "x-ms-examples": { - "SolutionCreate": { "$ref": "./examples/SolutionCreate.json" } + "SolutionCreate": { "$ref": "./examples/SolutionCreate.json" } }, + "x-ms-long-running-operation": true, "operationId": "Solutions_CreateOrUpdate", "summary": "Create/Update Solution.", "description": "Creates or updates the Solution.", @@ -69,8 +70,8 @@ } ], "responses": { - "200": { - "description": "OK response definition.", + "201": { + "description": "Created response definition.", "schema": { "$ref": "#/definitions/Solution" } @@ -87,9 +88,10 @@ "tags": [ "Solution" ], - "x-ms-examples": { - "SolutionDelete": { "$ref": "./examples/SolutionDelete.json" } + "x-ms-examples": { + "SolutionDelete": { "$ref": "./examples/SolutionDelete.json" } }, + "x-ms-long-running-operation": true, "operationId": "Solutions_Delete", "summary": "Deletes the solution", "description": "Deletes the solution in the subscription.", diff --git a/specification/operationsmanagement/resource-manager/Microsoft.OperationsManagement/preview/2015-11-01-preview/examples/SolutionCreate.json b/specification/operationsmanagement/resource-manager/Microsoft.OperationsManagement/preview/2015-11-01-preview/examples/SolutionCreate.json index 134e8e6c420d..aeef13d17956 100644 --- a/specification/operationsmanagement/resource-manager/Microsoft.OperationsManagement/preview/2015-11-01-preview/examples/SolutionCreate.json +++ b/specification/operationsmanagement/resource-manager/Microsoft.OperationsManagement/preview/2015-11-01-preview/examples/SolutionCreate.json @@ -26,7 +26,7 @@ } }, "responses":{ - "200":{ + "201":{ "body":{ "id":"subscriptions/subid/resourcegroups/rg1/providers/Microsoft.OperationsManagement/solutions/solution1", "location":"East US", diff --git a/specification/operationsmanagement/resource-manager/readme.md b/specification/operationsmanagement/resource-manager/readme.md index d864068c8151..8117bace92e6 100644 --- a/specification/operationsmanagement/resource-manager/readme.md +++ b/specification/operationsmanagement/resource-manager/readme.md @@ -99,7 +99,7 @@ These settings apply only when `--tag=package-2015-11-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-11-preview' && $(go) -output-folder: $(go-sdk-folder)/services/operationsmanagement/mgmt/2015-11-01-preview/operationsmanagement +output-folder: $(go-sdk-folder)/services/preview/operationsmanagement/mgmt/2015-11-01-preview/operationsmanagement ``` @@ -109,11 +109,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.operationsmanagement +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-operationsmanagement +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-11-preview +``` + +### Tag: package-2015-11-preview and java + +These settings apply only when `--tag=package-2015-11-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-11-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.operationsmanagement - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-operationsmanagement + namespace: com.microsoft.azure.management.operationsmanagement.v2015_11_01_preview + output-folder: $(azure-libraries-for-java-folder)/operationsmanagement/resource-manager/v2015_11_01_preview +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_FilterAndAggregateOnly.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_FilterAndAggregateOnly.json new file mode 100644 index 000000000000..8b5cc236719d --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_FilterAndAggregateOnly.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04", + "$from": "2018-02-05T18:00:00Z", + "$filter": "PolicyDefinitionAction eq 'deny'", + "$apply": "aggregate($count as NumDenyEvents)" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "NumDenyEvents": 40 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_FilterAndGroupByWithAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_FilterAndGroupByWithAggregate.json new file mode 100644 index 000000000000..16618e4868b8 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_FilterAndGroupByWithAggregate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04", + "$from": "2018-02-05T18:00:00Z", + "$filter": "PolicyDefinitionAction eq 'audit' or PolicyDefinitionAction eq 'deny'", + "$apply": "groupby((PolicyAssignmentId, PolicyDefinitionId, PolicyDefinitionAction, ResourceId), aggregate($count as NumEvents))", + "$top": 2 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.servicefabric/clusters/myCluster/applications/resourcescachemonitor/services/myService", + "NumEvents": 1 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d6be6bb37e5f4333baa95c2a", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/5948d091-78b7-4d3b-a404-cc6a0329b0c6", + "policyDefinitionAction": "audit", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.servicefabric/clusters/myCluster/applications/resourcescachemonitor/services/myService", + "NumEvents": 1 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_FilterAndGroupByWithoutAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_FilterAndGroupByWithoutAggregate.json new file mode 100644 index 000000000000..6370096a16e7 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_FilterAndGroupByWithoutAggregate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04", + "$from": "2018-01-05T18:00:00Z", + "$filter": "PolicyDefinitionAction ne 'audit' and PolicyDefinitionAction ne 'append'", + "$apply": "groupby((PolicyAssignmentId, PolicyDefinitionId, PolicyDefinitionAction, ResourceId))", + "$top": 2 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/5bc427ca-0089-4d0d-85bd-e98d1e40b3bf/providers/microsoft.authorization/policyassignments/storageaccountsku", + "policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "policyDefinitionAction": "deny", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/5bc427ca-0089-4d0d-85bd-e98d1e40b3bf/providers/microsoft.storage/storageaccounts/7d528d3a" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/da43b50031bf4bce84584faa", + "policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "policyDefinitionAction": "deny", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/mysa1" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_FilterAndMultipleGroups.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_FilterAndMultipleGroups.json new file mode 100644 index 000000000000..c190cd03142a --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_FilterAndMultipleGroups.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04", + "$from": "2018-01-01T00:00:00Z", + "$filter": "PolicyDefinitionAction eq 'deny'", + "$apply": "groupby((PolicyAssignmentId, PolicyDefinitionId, ResourceId))/groupby((PolicyAssignmentId, PolicyDefinitionId), aggregate($count as NumDeniedResources))", + "$orderby": "NumDeniedResources desc", + "$top": 10 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 6, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup1/providers/microsoft.authorization/policyassignments/0591f497c35344fcbaf7a393", + "policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/e56962a6-4747-49cd-b67b-bf8b01975c4c", + "NumDeniedResources": 3 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup1/providers/microsoft.authorization/policyassignments/myassignment1", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/mydefinition1", + "NumDeniedResources": 2 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup1/providers/microsoft.authorization/policyassignments/myassignment1", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/mydefinition2", + "NumDeniedResources": 2 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/5bc427ca-0089-4d0d-85bd-e98d1e40b3bf/providers/microsoft.authorization/policyassignments/storageaccountsku", + "policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "NumDeniedResources": 1 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup2/providers/microsoft.authorization/policyassignments/da43b50031bf4bce84584faa", + "policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "NumDeniedResources": 1 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup2/providers/microsoft.authorization/policyassignments/myassignment2", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/mydefinition3", + "NumDeniedResources": 1 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_GetMetadata.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_GetMetadata.json new file mode 100644 index 000000000000..c5381fca820f --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_GetMetadata.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "headers": { + "content-type": "application/xml" + }, + "body": " Org.OData.Capabilities.V1.ConformanceLevelType/Minimal application/json;odata.metadata=minimal;IEEE754Compatible=false;odata.streaming=true application/json;odata.metadata=none;IEEE754Compatible=false;odata.streaming=true " + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryManagementGroupScope.json new file mode 100644 index 000000000000..fe44b168e00f --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryManagementGroupScope.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "policyEventsResource": "default", + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupName": "myManagementGroup", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T22:19:18.8896095Z", + "resourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachines/myvm1/extensions/DAExtension", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/1ef5d536aec743a0aa801c1a", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef", + "resourceType": "/Microsoft.Compute/virtualMachines/extensions", + "resourceLocation": "westeurope", + "resourceGroup": "myrg", + "resourceTags": "tbd", + "policyAssignmentName": "1ef5d536aec743a0aa801c1a", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionName": "335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "15521232277412542086", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff3e452-fff2-fff1-fff8-fff12618f1b8" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T22:19:18.8896095Z", + "resourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachines/myvm1/extensions/DAExtension", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/95816fce53454b15a7ed803d", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/a2c0414b-82e4-459d-97d5-94c79a89232c", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef", + "resourceType": "/Microsoft.Compute/virtualMachines/extensions", + "resourceLocation": "westeurope", + "resourceGroup": "myrg", + "resourceTags": "tbd", + "policyAssignmentName": "95816fce53454b15a7ed803d", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"eastus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "a2c0414b-82e4-459d-97d5-94c79a89232c", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "", + "policySetDefinitionName": "", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff3e452-fff2-fff1-fff8-fff12618f1b8" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryNestedResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryNestedResourceScope.json new file mode 100644 index 000000000000..c8a2587d1b82 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryNestedResourceScope.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "policyEventsResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/microsoft.servicefabric/clusters/myCluster/applications/myApplication/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/microsoft.servicefabric/clusters/myCluster/applications/myApplication/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "181565554491747128", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/microsoft.servicefabric/clusters/myCluster/applications/myApplication/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "624540685646900425", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..3766209f5302 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScope.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "myPolicyAssignment", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T00:07:16.2804863Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/defaultworkspace-fffedd8f-ffff-fffd-fffd-fffed2f84852-eus", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyDefinitions/myPolicyDefinition", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/microsoft.operationalinsights/workspaces", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "myPolicyAssignment", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup", + "policyDefinitionName": "myPolicyAssignment", + "policyDefinitionAction": "deny", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff2f355-fff2-fffc-fffb-fff1639dff94" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T00:06:08.4302267Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/defaultworkspace-fffedd8f-ffff-fffd-fffd-fffed2f84852-eus", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyDefinitions/myPolicyDefinition", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/microsoft.operationalinsights/workspaces", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "myPolicyAssignment", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup", + "policyDefinitionName": "myPolicyAssignment", + "policyDefinitionAction": "deny", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff2f355-fff2-fffc-fffb-fff1639dff94" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryResourceGroupScope.json new file mode 100644 index 000000000000..e962da5f8f7f --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryResourceGroupScope.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "181565554491747128", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "624540685646900425", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryResourceScope.json new file mode 100644 index 000000000000..1f8d6fe87ed5 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QueryResourceScope.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "policyEventsResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T15:14:39.8473851Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "201ea587-7c90-41c3-910f-c280ae01cfd6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T15:14:39.5842458Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/d15545b8-ff50-409a-a6e3-5bd5cc954003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "d15545b8-ff50-409a-a6e3-5bd5cc954003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "201ea587-7c90-41c3-910f-c280ae01cfd6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelNestedResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelNestedResourceScope.json new file mode 100644 index 000000000000..af3ee0c37e9b --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelNestedResourceScope.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "policyEventsResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType/someNestedResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "181565554491747128", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType/someNestedResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "624540685646900425", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..92eaaf9a078a --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScope.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:59:38.6401747Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "201ea587-7c90-41c3-910f-c280ae01cfd6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:59:34.2017762Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/9daedab3-fb2d-461e-b861-71790eead4f6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "9daedab3-fb2d-461e-b861-71790eead4f6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScope.json new file mode 100644 index 000000000000..5bee2b1a4bd2 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScope.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:58:11.590596Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/deploymentSlots/production/state/start", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/f4cc58b7db524a9799381531", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames/deploymentSlots/state", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "f4cc58b7db524a9799381531", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"NA\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "14799174781370023846", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:58:11.590596Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/deploymentSlots/production/state/start", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/f4cc58b7db524a9799381531", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames/deploymentSlots/state", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "f4cc58b7db524a9799381531", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"NA\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "1679708035638239273", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScope.json new file mode 100644 index 000000000000..3333b97b9501 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScope.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:49:32.9539023Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/serviceCertificates/sha1-FFFBDAF1FFFF109FFFD95FFFC9B0FFFD6F264FFF", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames/serviceCertificates", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:49:32.9498186Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/serviceCertificates/sha1-FFF36C1CFFF4BEA57FFFEFCFFF17B9F81B710FFF", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames/serviceCertificates", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelResourceScope.json new file mode 100644 index 000000000000..da9f3b5f2c69 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionLevelResourceScope.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "policyEventsResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T15:14:39.8473851Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "201ea587-7c90-41c3-910f-c280ae01cfd6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T15:14:39.5842458Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/d15545b8-ff50-409a-a6e3-5bd5cc954003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "d15545b8-ff50-409a-a6e3-5bd5cc954003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "201ea587-7c90-41c3-910f-c280ae01cfd6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionScope.json new file mode 100644 index 000000000000..02a7e0717373 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_QuerySubscriptionScope.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "181565554491747128", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "624540685646900425", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_TimeRangeSortSelectTop.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_TimeRangeSortSelectTop.json new file mode 100644 index 000000000000..19057ff379e7 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyEvents_TimeRangeSortSelectTop.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04", + "$from": "2018-02-05T18:00:00Z", + "$to": "2018-02-06T18:00:00Z", + "$orderby": "Timestamp desc, PolicyAssignmentId asc, SubscriptionId asc, ResourceGroup asc, ResourceId", + "$select": "Timestamp, PolicyAssignmentId, PolicyDefinitionId, SubscriptionId, ResourceGroup, ResourceId", + "$top": 2 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-05T22:34:02.3475017Z", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/89b27f38-e9e4-4468-ab81-801c84b8c017", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroup": "myResourceGroup", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomain" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-05T22:34:01.6135357Z", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/Enable Monitoring in Azure Security Center", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroup": "myResourceGroup", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomain" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_FilterAndAggregateOnly.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_FilterAndAggregateOnly.json new file mode 100644 index 000000000000..5ab51d0fd6b3 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_FilterAndAggregateOnly.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04", + "$from": "2018-02-05T18:00:00Z", + "$filter": "PolicyDefinitionAction eq 'deny'", + "$apply": "aggregate($count as NumDenyStates)" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "NumDenyStates": 6 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_FilterAndGroupByWithAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_FilterAndGroupByWithAggregate.json new file mode 100644 index 000000000000..a8985871a7dc --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_FilterAndGroupByWithAggregate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04", + "$from": "2018-02-05T18:00:00Z", + "$filter": "IsCompliant eq false and (PolicyDefinitionAction eq 'audit' or PolicyDefinitionAction eq 'deny')", + "$apply": "groupby((PolicyAssignmentId, PolicyDefinitionId, PolicyDefinitionAction, ResourceId), aggregate($count as NumAuditDenyNonComplianceRecords))", + "$orderby": "NumAuditDenyNonComplianceRecords desc", + "$top": 2 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionAction": "audit", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myrg/providers/microsoft.classiccompute/domainnames/myDomainName", + "NumAuditDenyNonComplianceRecords": 10 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myrg/providers/microsoft.classiccompute/domainnames/myDomainName", + "NumAuditDenyNonComplianceRecords": 10 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_FilterAndGroupByWithoutAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_FilterAndGroupByWithoutAggregate.json new file mode 100644 index 000000000000..d61146f55217 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_FilterAndGroupByWithoutAggregate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04", + "$from": "2018-01-05T18:00:00Z", + "$filter": "IsCompliant eq false and (PolicyDefinitionAction ne 'audit' and PolicyDefinitionAction ne 'append')", + "$apply": "groupby((PolicyAssignmentId, PolicyDefinitionId, PolicyDefinitionAction, ResourceId))", + "$top": 2 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/enable monitoring in azure security center", + "policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed", + "policyDefinitionAction": "auditifnotexists", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myrg/providers/microsoft.network/virtualnetworks/vnet" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/89b27f38-e9e4-4468-ab81-801c84b8c017", + "policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed", + "policyDefinitionAction": "auditifnotexists", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myrg/providers/microsoft.network/virtualnetworks/vnet" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_FilterAndMultipleGroups.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_FilterAndMultipleGroups.json new file mode 100644 index 000000000000..9f25dd8d9510 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_FilterAndMultipleGroups.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04", + "$filter": "IsCompliant eq false", + "$apply": "groupby((PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionId, PolicyDefinitionReferenceId, ResourceId))/groupby((PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionId, PolicyDefinitionReferenceId), aggregate($count as NumNonCompliantResources))", + "$orderby": "NumNonCompliantResources desc", + "$top": 10 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 10, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "14799174781370023846", + "NumNonCompliantResources": 557 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "1679708035638239273", + "NumNonCompliantResources": 557 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "14799174781370023846", + "NumNonCompliantResources": 557 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "1679708035638239273", + "NumNonCompliantResources": 557 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7", + "policySetDefinitionId": "", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "NumNonCompliantResources": 557 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/dcda79d769674aea8bfcaa49", + "policySetDefinitionId": "", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "", + "NumNonCompliantResources": 557 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "NumNonCompliantResources": 552 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/a03db67e-a286-43c3-9098-b2da83d361ad", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "8935913113203900114", + "NumNonCompliantResources": 544 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/8174043a1e2849179635b874", + "policySetDefinitionId": "", + "policyDefinitionId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionReferenceId": "", + "NumNonCompliantResources": 526 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "2124621540977569058", + "NumNonCompliantResources": 509 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_GetMetadata.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_GetMetadata.json new file mode 100644 index 000000000000..fba219cbdcb1 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_GetMetadata.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "headers": { + "content-type": "application/xml" + }, + "body": " Org.OData.Capabilities.V1.ConformanceLevelType/Minimal application/json;odata.metadata=minimal;IEEE754Compatible=false;odata.streaming=true application/json;odata.metadata=none;IEEE754Compatible=false;odata.streaming=true " + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_ListOperations.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_ListOperations.json new file mode 100644 index 000000000000..8431a6befb87 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_ListOperations.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.count": 3, + "value": [ + { + "name": "Microsoft.PolicyInsights/policyEvents/queryResults/action", + "display": { + "provider": "Microsoft Policy Insights", + "resource": "Policy Events", + "operation": "Query Policy Events", + "description": "Query information about policy events." + } + }, + { + "name": "Microsoft.PolicyInsights/policyStates/queryResults/action", + "display": { + "provider": "Microsoft Policy Insights", + "resource": "Policy States", + "operation": "Query Policy States", + "description": "Query information about policy states." + } + }, + { + "name": "Microsoft.PolicyInsights/policyStates/summarize/action", + "display": { + "provider": "Microsoft Policy Insights", + "resource": "Policy States", + "operation": "Query Policy Latest States Summary", + "description": "Query summary information about policy latest states." + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryManagementGroupScope.json new file mode 100644 index 000000000000..dc042b116e5e --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryManagementGroupScope.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupName": "myManagementGroup", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-09T17:41:47Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/microsoft.insights/autoscalesettings/mytest1", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/1ef5d536aec743a0aa801c1a", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/microsoft.insights/autoscalesettings", + "resourceLocation": "westus", + "resourceGroup": "myrg1", + "resourceTags": "tbd", + "policyAssignmentName": "1ef5d536aec743a0aa801c1a", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionName": "335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "15521232277412542086" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-09T17:41:47Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/microsoft.insights/autoscalesettings/mytest1", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/microsoft.insights/autoscalesettings", + "resourceLocation": "westus", + "resourceGroup": "myrg1", + "resourceTags": "tbd", + "policyAssignmentName": "186044306c044a1d8c0ff76c", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"centralus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "", + "policySetDefinitionName": "", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryNestedResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryNestedResourceScope.json new file mode 100644 index 000000000000..6354ddfb8a34 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryNestedResourceScope.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "policyStatesResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication/providers/Microsoft.PolicyInsights/policyStates/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2018-02-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "186044306c044a1d8c0ff76c", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"centralus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/mymg", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2018-02-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "186044306c044a1d8c0ff76c", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"centralus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/mymg", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..174e26c9d1a8 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "myPolicyAssignment", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-13T00:38:50Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Security/policies/mySecurityPolicy", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Security/policies", + "resourceLocation": null, + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "myPolicyAssignment", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup", + "policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-13T00:38:50Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/test", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Authorization/policyAssignments", + "resourceLocation": null, + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "myPolicyAssignment", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup", + "policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryResourceGroupScope.json new file mode 100644 index 000000000000..fda20c725442 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryResourceGroupScope.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-09T18:42:42Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Storage/storageAccounts", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-09T18:42:42Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Storage/storageAccounts", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e3682", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryResourceScope.json new file mode 100644 index 000000000000..e7646dd87290 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QueryResourceScope.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "policyStatesResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2018-02-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/Audit a tag and it's value", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"no\"},\"tagValue\":{\"value\":\"no\"}}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "Audit a tag and it's value", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2018-02-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/Audit a tag and it's value", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"no\"},\"tagValue\":{\"value\":\"no\"}}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "Audit a tag and it's value", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelNestedResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelNestedResourceScope.json new file mode 100644 index 000000000000..c3165182eec1 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelNestedResourceScope.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "policyStatesResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource/providers/Microsoft.PolicyInsights/policyStates/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2018-02-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType/someNestedResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "186044306c044a1d8c0ff76c", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"centralus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/mymg", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2018-02-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType/someNestedResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "186044306c044a1d8c0ff76c", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"centralus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/mymg", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..76cc1d373709 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-13T00:45:19Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/my-ip-1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Network/publicIPAddresses", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"test\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "2124621540977569058" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-13T00:45:19Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/my-ip-1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Network/publicIPAddresses", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"test\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "14799174781370023846" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json new file mode 100644 index 000000000000..9ae0f212bd91 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-13T00:50:27Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication/services/myService", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/d9da7e80af6344ab9d342aa7", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications/services", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "d9da7e80af6344ab9d342aa7", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"MyTag\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-13T00:50:27Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication/services/myService", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/d9da7e80af6344ab9d342aa7", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications/services", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "d9da7e80af6344ab9d342aa7", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"MyTag\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScope.json new file mode 100644 index 000000000000..050510d33dbc --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScope.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-13T00:54:58Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/mySite", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Web/sites", + "resourceLocation": "centralus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-13T00:54:58Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/mySite", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/LocationAuditDefinition", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Web/sites", + "resourceLocation": "centralus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "LocationAuditDefinition", + "policyDefinitionAction": "Audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelResourceScope.json new file mode 100644 index 000000000000..e950bb95094e --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionLevelResourceScope.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "policyStatesResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2018-02-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/Audit a tag and it's value", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"no\"},\"tagValue\":{\"value\":\"no\"}}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "Audit a tag and it's value", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2018-02-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/Audit a tag and it's value", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"no\"},\"tagValue\":{\"value\":\"no\"}}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "Audit a tag and it's value", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionScope.json new file mode 100644 index 000000000000..7774b7f1634d --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_QuerySubscriptionScope.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-09T17:48:05Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/Microsoft.Network/publicIPAddresses/mypubip1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/Enable Monitoring in Azure Security Center", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/9daedab3-fb2d-461e-b861-71790eead4f6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Network/publicIPAddresses", + "resourceLocation": "eastus", + "resourceGroup": "myrg1", + "resourceTags": "tbd", + "policyAssignmentName": "Enable Monitoring in Azure Security Center", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "9daedab3-fb2d-461e-b861-71790eead4f6", + "policyDefinitionAction": "AuditIfNotExists", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-09T17:48:05Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/Microsoft.Network/publicIPAddresses/mypubip1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/9ac09b0657d942e5ad4041a6", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/9daedab3-fb2d-461e-b861-71790eead4f6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Network/publicIPAddresses", + "resourceLocation": "eastus", + "resourceGroup": "myrg1", + "resourceTags": "tbd", + "policyAssignmentName": "9ac09b0657d942e5ad4041a6", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "9daedab3-fb2d-461e-b861-71790eead4f6", + "policyDefinitionAction": "AuditIfNotExists", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeManagementGroupScope.json new file mode 100644 index 000000000000..bc91c8f4a56e --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeManagementGroupScope.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupName": "myManagementGroup", + "api-version": "2018-04-04", + "$from": "2018-02-05T18:00:00Z", + "$to": "2018-02-06T18:00:00Z", + "$filter": "PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit'", + "$top": 0 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-05 18:00:00Z&$to=2018-02-06 18:00:00Z&$filter=(PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit') and IsCompliant eq false", + "nonCompliantResources": 15410, + "nonCompliantPolicies": 68 + }, + "policyAssignments": [] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeResourceGroupLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeResourceGroupLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..aa7bbba3f852 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeResourceGroupLevelPolicyAssignmentScope.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "b7a1ca2596524e3ab19597f2", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-22 23:54:22Z&$to=2018-02-23 23:54:22Z&$filter=IsCompliant eq false", + "nonCompliantResources": 7, + "nonCompliantPolicies": 1 + }, + "policyAssignments": [ + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b7a1ca2596524e3ab19597f2", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-22 23:54:22Z&$to=2018-02-23 23:54:22Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b7a1ca2596524e3ab19597f2'", + "nonCompliantResources": 7, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-22 23:54:22Z&$to=2018-02-23 23:54:22Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b7a1ca2596524e3ab19597f2' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60'", + "nonCompliantResources": 7 + } + } + ] + } + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeResourceGroupScope.json new file mode 100644 index 000000000000..07dd94bc9cd2 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeResourceGroupScope.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:55:09Z&$to=2018-02-13 19:55:09Z&$filter=IsCompliant eq false", + "nonCompliantResources": 55, + "nonCompliantPolicies": 20 + }, + "policyAssignments": [ + { + "policyAssignmentId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/186044306c044a1d8c0ff76c", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:55:09Z&$to=2018-02-13 19:55:09Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/186044306c044a1d8c0ff76c'", + "nonCompliantResources": 55, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:55:09Z&$to=2018-02-13 19:55:09Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/186044306c044a1d8c0ff76c' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d'", + "nonCompliantResources": 55 + } + } + ] + }, + { + "policyAssignmentId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a", + "policySetDefinitionId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policysetdefinitions/335cefd2-ab16-430f-b364-974a170eb1d5", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:55:09Z&$to=2018-02-13 19:55:09Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a'", + "nonCompliantResources": 55, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:55:09Z&$to=2018-02-13 19:55:09Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d'", + "nonCompliantResources": 55 + } + } + ] + } + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeResourceScope.json new file mode 100644 index 000000000000..dd2e48eeba06 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeResourceScope.json @@ -0,0 +1,353 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false", + "nonCompliantResources": 1, + "nonCompliantPolicies": 14 + }, + "policyAssignments": [ + { + "policyAssignmentId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/8174043a1e2849179635b874", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/8174043a1e2849179635b874'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/8174043a1e2849179635b874' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066'", + "nonCompliantResources": 1 + } + } + ] + }, + { + "policyAssignmentId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a", + "policySetDefinitionId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policysetdefinitions/335cefd2-ab16-430f-b364-974a170eb1d5", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d'", + "nonCompliantResources": 1 + } + } + ] + }, + { + "policyAssignmentId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/186044306c044a1d8c0ff76c", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/186044306c044a1d8c0ff76c'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/186044306c044a1d8c0ff76c' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d'", + "nonCompliantResources": 1 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/fed0d6ef-c76c-4a3d-a4ec-de07b1e7900b", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/fed0d6ef-c76c-4a3d-a4ec-de07b1e7900b'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/audit a tag and it's value", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/fed0d6ef-c76c-4a3d-a4ec-de07b1e7900b' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/audit a tag and it's value'", + "nonCompliantResources": 1 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/f5f5249bd6124d0692c2af52", + "policySetDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policysetdefinitions/bafcd34b-58c6-47b4-bc8b-f35198d6a025", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/f5f5249bd6124d0692c2af52'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/test", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/f5f5249bd6124d0692c2af52' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/testtest'", + "nonCompliantResources": 1 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/e4a08f18-4e3e-47af-a2eb-cc96d8c9a030", + "policySetDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policysetdefinitions/e4a08f18-4e3e-47af-a2eb-cc96d8c9a01f", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/e4a08f18-4e3e-47af-a2eb-cc96d8c9a030'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 2 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/audit a tag and its value", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/e4a08f18-4e3e-47af-a2eb-cc96d8c9a030' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/audit a tag and its value'", + "nonCompliantResources": 1 + } + }, + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/audit a tag and it's value", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/e4a08f18-4e3e-47af-a2eb-cc96d8c9a030' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/audit a tag and it's value'", + "nonCompliantResources": 1 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01", + "policySetDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policysetdefinitions/a03db67e-a286-43c3-9098-b2da83d361ad", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474'", + "nonCompliantResources": 1 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/dcda79d769674aea8bfcaa49", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/dcda79d769674aea8bfcaa49'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/dcda79d769674aea8bfcaa49' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474'", + "nonCompliantResources": 1 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/dc7c38a6-42a9-4261-b54e-92549cd6e010", + "policySetDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policysetdefinitions/deny a resource based on owner tag", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/dc7c38a6-42a9-4261-b54e-92549cd6e010'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/audit a tag and it's value", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/dc7c38a6-42a9-4261-b54e-92549cd6e010' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/audit a tag and it's value'", + "nonCompliantResources": 1 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 1 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/d6be6bb37e5f4333baa95c2a", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/d6be6bb37e5f4333baa95c2a'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/5948d091-78b7-4d3b-a404-cc6a0329b0c6", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/d6be6bb37e5f4333baa95c2a' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/5948d091-78b7-4d3b-a404-cc6a0329b0c6'", + "nonCompliantResources": 1 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29", + "policySetDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policysetdefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 1 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531", + "policySetDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 3 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/locationauditdefinition", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/locationauditdefinition'", + "nonCompliantResources": 1 + } + }, + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474'", + "nonCompliantResources": 1 + } + }, + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 1 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1", + "policySetDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 3 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/locationauditdefinition", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/locationauditdefinition'", + "nonCompliantResources": 1 + } + }, + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474'", + "nonCompliantResources": 1 + } + }, + { + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:59:17Z&$to=2018-02-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1' and PolicyDefinitionId eq '/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 1 + } + } + ] + } + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeSubscriptionLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeSubscriptionLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..5878fd961f79 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeSubscriptionLevelPolicyAssignmentScope.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:09:24Z&$to=2018-02-13 20:09:24Z&$filter=IsCompliant eq false", + "nonCompliantResources": 531, + "nonCompliantPolicies": 1 + }, + "policyAssignments": [ + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:09:24Z&$to=2018-02-13 20:09:24Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531'", + "nonCompliantResources": 531, + "nonCompliantPolicies": 4 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:09:24Z&$to=2018-02-13 20:09:24Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474'", + "nonCompliantResources": 531 + } + }, + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:09:24Z&$to=2018-02-13 20:09:24Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 531 + } + }, + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/locationauditdefinition", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:09:24Z&$to=2018-02-13 20:09:24Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/locationauditdefinition'", + "nonCompliantResources": 220 + } + }, + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:09:24Z&$to=2018-02-13 20:09:24Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682'", + "nonCompliantResources": 54 + } + } + ] + } + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeSubscriptionLevelPolicyDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeSubscriptionLevelPolicyDefinitionScope.json new file mode 100644 index 000000000000..3b3e5df89bc9 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeSubscriptionLevelPolicyDefinitionScope.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "api-version": "2018-04-04" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:07:10Z&$to=2018-02-13 20:07:10Z&$filter=IsCompliant eq false", + "nonCompliantResources": 561, + "nonCompliantPolicies": 4 + }, + "policyAssignments": [ + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:07:10Z&$to=2018-02-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7'", + "nonCompliantResources": 558, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:07:10Z&$to=2018-02-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 558 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:07:10Z&$to=2018-02-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29'", + "nonCompliantResources": 553, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:07:10Z&$to=2018-02-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 553 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:07:10Z&$to=2018-02-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1'", + "nonCompliantResources": 531, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:07:10Z&$to=2018-02-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 531 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:07:10Z&$to=2018-02-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531'", + "nonCompliantResources": 531, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 20:07:10Z&$to=2018-02-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 531 + } + } + ] + } + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json new file mode 100644 index 000000000000..5c9d8d75e049 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "api-version": "2018-04-04", + "$from": "2018-02-05T18:00:00Z", + "$to": "2018-02-06T18:00:00Z", + "$filter": "PolicyDefinitionAction eq 'deny'", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-05 18:00:00Z&$to=2018-02-06 18:00:00Z&$filter=(PolicyDefinitionAction eq 'deny') and IsCompliant eq false", + "nonCompliantResources": 0, + "nonCompliantPolicies": 0 + }, + "policyAssignments": [] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeSubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeSubscriptionScope.json new file mode 100644 index 000000000000..2ebda940dcc8 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_SummarizeSubscriptionScope.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04", + "$top": 5 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:48:53Z&$to=2018-02-13 19:48:53Z&$filter=IsCompliant eq false", + "nonCompliantResources": 619, + "nonCompliantPolicies": 40 + }, + "policyAssignments": [ + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/a03db67e-a286-43c3-9098-b2da83d361ad", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:48:53Z&$to=2018-02-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01'", + "nonCompliantResources": 557, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:48:53Z&$to=2018-02-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474'", + "nonCompliantResources": 557 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:48:53Z&$to=2018-02-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7'", + "nonCompliantResources": 557, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:48:53Z&$to=2018-02-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 557 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/dcda79d769674aea8bfcaa49", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:48:53Z&$to=2018-02-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/dcda79d769674aea8bfcaa49'", + "nonCompliantResources": 557, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:48:53Z&$to=2018-02-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/dcda79d769674aea8bfcaa49' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474'", + "nonCompliantResources": 557 + } + } + ] + }, + { + "policyAssignmentId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a", + "policySetDefinitionId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policysetdefinitions/335cefd2-ab16-430f-b364-974a170eb1d5", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:48:53Z&$to=2018-02-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a'", + "nonCompliantResources": 557, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:48:53Z&$to=2018-02-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d'", + "nonCompliantResources": 557 + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:48:53Z&$to=2018-02-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29'", + "nonCompliantResources": 552, + "nonCompliantPolicies": 3 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:48:53Z&$to=2018-02-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 552 + } + }, + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/locationauditdefinition", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:48:53Z&$to=2018-02-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/locationauditdefinition'", + "nonCompliantResources": 29 + } + }, + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2018-04-04&$from=2018-02-12 19:48:53Z&$to=2018-02-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682'", + "nonCompliantResources": 2 + } + } + ] + } + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_TimeRangeSortSelectTop.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_TimeRangeSortSelectTop.json new file mode 100644 index 000000000000..a048ec95f4fc --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/examples/PolicyStates_TimeRangeSortSelectTop.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-04-04", + "$from": "2018-02-05T18:00:00Z", + "$to": "2018-02-06T18:00:00Z", + "$orderby": "Timestamp desc, PolicyAssignmentId asc, SubscriptionId asc, ResourceGroup asc, ResourceId", + "$select": "Timestamp, PolicyAssignmentId, PolicyDefinitionId, SubscriptionId, ResourceGroup, ResourceId", + "$top": 2 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-06T17:58:00Z", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/8cb1e007-947f-423a-ad0c-7ab7dc7d0255/providers/Microsoft.Authorization/policyAssignments/1654a0254ab34920a60f94eb", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroup": "myrg1", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/Microsoft.Storage/storageAccounts/mysa1" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2018-02-06T17:58:00Z", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/8cb1e007-947f-423a-ad0c-7ab7dc7d0255/providers/Microsoft.Authorization/policyAssignments/1654a0254ab34920a60f94eb", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroup": "myrg2", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg2/providers/Microsoft.Storage/storageAccounts/mysa2" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json new file mode 100644 index 000000000000..3b9e517099ab --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json @@ -0,0 +1,918 @@ +{ + "swagger": "2.0", + "info": { + "title": "PolicyEventsClient", + "version": "2018-04-04" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "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/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForManagementGroup", + "description": "Queries policy events for the resources under the management group.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/managementGroupsNamespaceParameter" + }, + { + "$ref": "#/parameters/managementGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query at management group scope": { "$ref": "./examples/PolicyEvents_QueryManagementGroupScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForSubscription", + "description": "Queries policy events for the resources under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query at subscription scope": { "$ref": "./examples/PolicyEvents_QuerySubscriptionScope.json" }, + "Time range; sort, select and limit": { "$ref": "./examples/PolicyEvents_TimeRangeSortSelectTop.json" }, + "Filter and group with aggregate": { "$ref": "./examples/PolicyEvents_FilterAndGroupByWithAggregate.json" }, + "Filter and group without aggregate": { "$ref": "./examples/PolicyEvents_FilterAndGroupByWithoutAggregate.json" }, + "Filter and aggregate only": { "$ref": "./examples/PolicyEvents_FilterAndAggregateOnly.json" }, + "Filter and multiple groups": { "$ref": "./examples/PolicyEvents_FilterAndMultipleGroups.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForResourceGroup", + "description": "Queries policy events for the resources under the resource group.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query at resource group scope": { "$ref": "./examples/PolicyEvents_QueryResourceGroupScope.json" } + } + } + }, + "/{resourceId}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForResource", + "description": "Queries policy events for the resource.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query at resource scope": { "$ref": "./examples/PolicyEvents_QueryResourceScope.json" }, + "Query at subscription level resource scope": { "$ref": "./examples/PolicyEvents_QuerySubscriptionLevelResourceScope.json" }, + "Query at nested resource scope": { "$ref": "./examples/PolicyEvents_QueryNestedResourceScope.json" }, + "Query at subscription level nested resource scope": { "$ref": "./examples/PolicyEvents_QuerySubscriptionLevelNestedResourceScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForPolicySetDefinition", + "description": "Queries policy events for the subscription level policy set definition.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policySetDefinitionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query at subscription level policy set definition scope": { "$ref": "./examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForPolicyDefinition", + "description": "Queries policy events for the subscription level policy definition.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyDefinitionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query at subscription level policy definition scope": { "$ref": "./examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForSubscriptionLevelPolicyAssignment", + "description": "Queries policy events for the subscription level policy assignment.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyAssignmentNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query at subscription level policy assignment scope": { "$ref": "./examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForResourceGroupLevelPolicyAssignment", + "description": "Queries policy events for the resource group level policy assignment.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyAssignmentNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query at resource group level policy assignment scope": { "$ref": "./examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScope.json" } + } + } + }, + "/{scope}/providers/Microsoft.PolicyInsights/policyEvents/$metadata": { + "get": { + "operationId": "PolicyEvents_GetMetadata", + "description": "Gets OData metadata XML document.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OData metadata XML document.", + "schema": { + "$ref": "#/definitions/MetadataDocument" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Get metadata": { "$ref": "./examples/PolicyEvents_GetMetadata.json" } + } + } + } + }, + "definitions": { + "PolicyEventsQueryResults": { + "description": "Query results.", + "properties": { + "@odata.context": { + "description": "OData context string; used by OData clients to resolve type information based on metadata.", + "type": "string" + }, + "@odata.count": { + "description": "OData entity count; represents the number of policy event records returned.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "value": { + "description": "Query results.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyEvent" + } + } + } + }, + "PolicyEvent": { + "type": "object", + "description": "Policy event record.", + "properties": { + "@odata.id": { + "description": "OData entity ID; always set to null since policy event records do not have an entity ID.", + "type": "string" + }, + "@odata.context": { + "description": "OData context string; used by OData clients to resolve type information based on metadata.", + "type": "string" + }, + "timestamp": { + "description": "Timestamp for the policy event record.", + "type": "string", + "format": "date-time" + }, + "resourceId": { + "description": "Resource ID.", + "type": "string" + }, + "policyAssignmentId": { + "description": "Policy assignment ID.", + "type": "string" + }, + "policyDefinitionId": { + "description": "Policy definition ID.", + "type": "string" + }, + "effectiveParameters": { + "description": "Effective parameters for the policy assignment.", + "type": "string" + }, + "isCompliant": { + "description": "Flag which states whether the resource is compliant against the policy assignment it was evaluated against.", + "type": "boolean" + }, + "subscriptionId": { + "description": "Subscription ID.", + "type": "string" + }, + "resourceType": { + "description": "Resource type.", + "type": "string" + }, + "resourceLocation": { + "description": "Resource location.", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + }, + "resourceTags": { + "description": "List of resource tags.", + "type": "string" + }, + "policyAssignmentName": { + "description": "Policy assignment name.", + "type": "string" + }, + "policyAssignmentOwner": { + "description": "Policy assignment owner.", + "type": "string" + }, + "policyAssignmentParameters": { + "description": "Policy assignment parameters.", + "type": "string" + }, + "policyAssignmentScope": { + "description": "Policy assignment scope.", + "type": "string" + }, + "policyDefinitionName": { + "description": "Policy definition name.", + "type": "string" + }, + "policyDefinitionAction": { + "description": "Policy definition action, i.e. effect.", + "type": "string" + }, + "policyDefinitionCategory": { + "description": "Policy definition category.", + "type": "string" + }, + "policySetDefinitionId": { + "description": "Policy set definition ID, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionName": { + "description": "Policy set definition name, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionOwner": { + "description": "Policy set definition owner, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionCategory": { + "description": "Policy set definition category, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionParameters": { + "description": "Policy set definition parameters, if the policy assignment is for a policy set.", + "type": "string" + }, + "managementGroupIds": { + "description": "Comma seperated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", + "type": "string" + }, + "policyDefinitionReferenceId": { + "description": "Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.", + "type": "string" + }, + "tenantId": { + "description": "Tenant ID for the policy event record.", + "type": "string" + }, + "principalOid": { + "description": "Principal object ID for the user who initiated the resource operation that triggered the policy event.", + "type": "string" + } + }, + "additionalProperties": { + "description": "The list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated" + } + }, + "QueryFailure": { + "description": "Error response.", + "properties": { + "error": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string" + }, + "message": { + "description": "Description of the error.", + "type": "string" + } + } + } + } + }, + "MetadataDocument": { + "description": "Metadata XML document.", + "type": "string" + } + }, + "parameters": { + "policyEventsResourceParameter": { + "name": "policyEventsResource", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "description": "The name of the virtual resource under PolicyEvents resource type; only \"default\" is allowed.", + "x-ms-parameter-location": "method" + }, + "managementGroupsNamespaceParameter": { + "name": "managementGroupsNamespace", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Microsoft.Management" + ], + "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", + "x-ms-parameter-location": "method" + }, + "managementGroupNameParameter": { + "name": "managementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Management group name.", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Microsoft Azure subscription ID.", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name.", + "x-ms-parameter-location": "method" + }, + "resourceIdParameter": { + "name": "resourceId", + "in": "path", + "required": true, + "type": "string", + "description": "Resource ID.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "authorizationNamespaceParameter": { + "name": "authorizationNamespace", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Microsoft.Authorization" + ], + "description": "The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed.", + "x-ms-parameter-location": "method" + }, + "policySetDefinitionNameParameter": { + "name": "policySetDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy set definition name.", + "x-ms-parameter-location": "method" + }, + "policyDefinitionNameParameter": { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy definition name.", + "x-ms-parameter-location": "method" + }, + "policyAssignmentNameParameter": { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment name.", + "x-ms-parameter-location": "method" + }, + "scopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "A valid scope, i.e. management group, subscription, resource group, or resource ID. Scope used has no effect on metadata returned.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "API version to use with the client requests.", + "x-ms-parameter-location": "client" + }, + "topParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Maximum number of records to return.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Top" + }, + "orderByParameter": { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Ordering expression using OData notation. One or more comma-separated column names with an optional \"desc\" (the default) or \"asc\", e.g. \"$orderby=PolicyAssignmentId, ResourceId asc\".", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "OrderBy" + }, + "selectParameter": { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\".", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Select" + }, + "fromParameter": { + "name": "$from", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day).", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "From" + }, + "toParameter": { + "name": "$to", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "To" + }, + "filterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Filter" + }, + "applyParameter": { + "name": "$apply", + "in": "query", + "required": false, + "type": "string", + "description": "OData apply expression for aggregations.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json new file mode 100644 index 000000000000..ff198aa24ad6 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json @@ -0,0 +1,1516 @@ +{ + "swagger": "2.0", + "info": { + "title": "PolicyStatesClient", + "version": "2018-04-04" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "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/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForManagementGroup", + "description": "Queries policy states for the resources under the management group.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/managementGroupsNamespaceParameter" + }, + { + "$ref": "#/parameters/managementGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query latest at management group scope": { "$ref": "./examples/PolicyStates_QueryManagementGroupScope.json" } + } + } + }, + "/providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForManagementGroup", + "description": "Summarizes policy states for the resources under the management group.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/managementGroupsNamespaceParameter" + }, + { + "$ref": "#/parameters/managementGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at management group scope": { "$ref": "./examples/PolicyStates_SummarizeManagementGroupScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForSubscription", + "description": "Queries policy states for the resources under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query latest at subscription scope": { "$ref": "./examples/PolicyStates_QuerySubscriptionScope.json" }, + "Time range; sort, select and limit": { "$ref": "./examples/PolicyStates_TimeRangeSortSelectTop.json" }, + "Filter and group with aggregate": { "$ref": "./examples/PolicyStates_FilterAndGroupByWithAggregate.json" }, + "Filter and group without aggregate": { "$ref": "./examples/PolicyStates_FilterAndGroupByWithoutAggregate.json" }, + "Filter and aggregate only": { "$ref": "./examples/PolicyStates_FilterAndAggregateOnly.json" }, + "Filter and multiple groups": { "$ref": "./examples/PolicyStates_FilterAndMultipleGroups.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForSubscription", + "description": "Summarizes policy states for the resources under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at subscription scope": { "$ref": "./examples/PolicyStates_SummarizeSubscriptionScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForResourceGroup", + "description": "Queries policy states for the resources under the resource group.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query latest at resource group scope": { "$ref": "./examples/PolicyStates_QueryResourceGroupScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForResourceGroup", + "description": "Summarizes policy states for the resources under the resource group.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at resource group scope": { "$ref": "./examples/PolicyStates_SummarizeResourceGroupScope.json" } + } + } + }, + "/{resourceId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForResource", + "description": "Queries policy states for the resource.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query all policy states at resource scope": { "$ref": "./examples/PolicyStates_QueryResourceScope.json" }, + "Query all policy states at subscription level resource scope": { "$ref": "./examples/PolicyStates_QuerySubscriptionLevelResourceScope.json" }, + "Query all policy states at nested resource scope": { "$ref": "./examples/PolicyStates_QueryNestedResourceScope.json" }, + "Query all policy states at subscription level nested resource scope": { "$ref": "./examples/PolicyStates_QuerySubscriptionLevelNestedResourceScope.json" } + } + } + }, + "/{resourceId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForResource", + "description": "Summarizes policy states for the resource.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at resource scope": { "$ref": "./examples/PolicyStates_SummarizeResourceScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForPolicySetDefinition", + "description": "Queries policy states for the subscription level policy set definition.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policySetDefinitionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query latest at subscription level policy set definition scope": { "$ref": "./examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForPolicySetDefinition", + "description": "Summarizes policy states for the subscription level policy set definition.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policySetDefinitionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at policy set definition scope": { "$ref": "./examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForPolicyDefinition", + "description": "Queries policy states for the subscription level policy definition.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyDefinitionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query latest at subscription level policy definition scope": { "$ref": "./examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForPolicyDefinition", + "description": "Summarizes policy states for the subscription level policy definition.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyDefinitionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at policy definition scope": { "$ref": "./examples/PolicyStates_SummarizeSubscriptionLevelPolicyDefinitionScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForSubscriptionLevelPolicyAssignment", + "description": "Queries policy states for the subscription level policy assignment.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyAssignmentNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query latest at subscription level policy assignment scope": { "$ref": "./examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForSubscriptionLevelPolicyAssignment", + "description": "Summarizes policy states for the subscription level policy assignment.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyAssignmentNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at policy assignment scope": { "$ref": "./examples/PolicyStates_SummarizeSubscriptionLevelPolicyAssignmentScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForResourceGroupLevelPolicyAssignment", + "description": "Queries policy states for the resource group level policy assignment.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyAssignmentNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query latest at resource group level policy assignment scope": { "$ref": "./examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForResourceGroupLevelPolicyAssignment", + "description": "Summarizes policy states for the resource group level policy assignment.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyAssignmentNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at policy assignment scope": { "$ref": "./examples/PolicyStates_SummarizeResourceGroupLevelPolicyAssignmentScope.json" } + } + } + }, + "/providers/Microsoft.PolicyInsights/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists available operations.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of available operations.", + "schema": { + "$ref": "#/definitions/OperationsListResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "List operations": { "$ref": "./examples/PolicyStates_ListOperations.json" } + } + } + }, + "/{scope}/providers/Microsoft.PolicyInsights/policyStates/$metadata": { + "get": { + "operationId": "PolicyStates_GetMetadata", + "description": "Gets OData metadata XML document.", + "produces": [ + "application/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OData metadata XML document.", + "schema": { + "$ref": "#/definitions/MetadataDocument" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Get metadata": { "$ref": "./examples/PolicyStates_GetMetadata.json" } + } + } + } + }, + "definitions": { + "PolicyStatesQueryResults": { + "description": "Query results.", + "properties": { + "@odata.context": { + "description": "OData context string; used by OData clients to resolve type information based on metadata.", + "type": "string" + }, + "@odata.count": { + "description": "OData entity count; represents the number of policy state records returned.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "value": { + "description": "Query results.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyState" + } + } + } + }, + "PolicyState": { + "type": "object", + "description": "Policy state record.", + "properties": { + "@odata.id": { + "description": "OData entity ID; always set to null since policy state records do not have an entity ID.", + "type": "string" + }, + "@odata.context": { + "description": "OData context string; used by OData clients to resolve type information based on metadata.", + "type": "string" + }, + "timestamp": { + "description": "Timestamp for the policy state record.", + "type": "string", + "format": "date-time" + }, + "resourceId": { + "description": "Resource ID.", + "type": "string" + }, + "policyAssignmentId": { + "description": "Policy assignment ID.", + "type": "string" + }, + "policyDefinitionId": { + "description": "Policy definition ID.", + "type": "string" + }, + "effectiveParameters": { + "description": "Effective parameters for the policy assignment.", + "type": "string" + }, + "isCompliant": { + "description": "Flag which states whether the resource is compliant against the policy assignment it was evaluated against.", + "type": "boolean" + }, + "subscriptionId": { + "description": "Subscription ID.", + "type": "string" + }, + "resourceType": { + "description": "Resource type.", + "type": "string" + }, + "resourceLocation": { + "description": "Resource location.", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + }, + "resourceTags": { + "description": "List of resource tags.", + "type": "string" + }, + "policyAssignmentName": { + "description": "Policy assignment name.", + "type": "string" + }, + "policyAssignmentOwner": { + "description": "Policy assignment owner.", + "type": "string" + }, + "policyAssignmentParameters": { + "description": "Policy assignment parameters.", + "type": "string" + }, + "policyAssignmentScope": { + "description": "Policy assignment scope.", + "type": "string" + }, + "policyDefinitionName": { + "description": "Policy definition name.", + "type": "string" + }, + "policyDefinitionAction": { + "description": "Policy definition action, i.e. effect.", + "type": "string" + }, + "policyDefinitionCategory": { + "description": "Policy definition category.", + "type": "string" + }, + "policySetDefinitionId": { + "description": "Policy set definition ID, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionName": { + "description": "Policy set definition name, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionOwner": { + "description": "Policy set definition owner, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionCategory": { + "description": "Policy set definition category, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionParameters": { + "description": "Policy set definition parameters, if the policy assignment is for a policy set.", + "type": "string" + }, + "managementGroupIds": { + "description": "Comma seperated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", + "type": "string" + }, + "policyDefinitionReferenceId": { + "description": "Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.", + "type": "string" + } + }, + "additionalProperties": { + "description": "The list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated" + } + }, + "SummarizeResults": { + "description": "Summarize action results.", + "properties": { + "@odata.context": { + "description": "OData context string; used by OData clients to resolve type information based on metadata.", + "type": "string" + }, + "@odata.count": { + "description": "OData entity count; represents the number of summaries returned; always set to 1.", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 1 + }, + "value": { + "description": "Summarize action results.", + "type": "array", + "items": { + "$ref": "#/definitions/Summary" + } + } + } + }, + "Summary": { + "description": "Summary results.", + "properties": { + "@odata.id": { + "description": "OData entity ID; always set to null since summaries do not have an entity ID.", + "type": "string" + }, + "@odata.context": { + "description": "OData context string; used by OData clients to resolve type information based on metadata.", + "type": "string" + }, + "results": { + "description": "Non-compliance summary for all policy assignments.", + "$ref": "#/definitions/SummaryResults" + }, + "policyAssignments": { + "description": "Policy assignments summary.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyAssignmentSummary" + } + } + } + }, + "SummaryResults": { + "description": "Non-compliance summary on a particular summary level.", + "properties": { + "queryResultsUri": { + "description": "HTTP POST URI for queryResults action on Microsoft.PolicyInsights to retrieve raw results for the non-compliance summary.", + "type": "string" + }, + "nonCompliantResources": { + "description": "Number of non-compliant resources.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "nonCompliantPolicies": { + "description": "Number of non-compliant policies.", + "type": "integer", + "format": "int32", + "minimum": 0 + } + } + }, + "PolicyAssignmentSummary": { + "description": "Policy assignment summary.", + "properties": { + "policyAssignmentId": { + "description": "Policy assignment ID.", + "type": "string" + }, + "policySetDefinitionId": { + "description": "Policy set definition ID, if the policy assignment is for a policy set.", + "type": "string" + }, + "results": { + "description": "Non-compliance summary for the policy assignment.", + "$ref": "#/definitions/SummaryResults" + }, + "policyDefinitions": { + "description": "Policy definitions summary.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyDefinitionSummary" + } + } + } + }, + "PolicyDefinitionSummary": { + "description": "Policy definition summary.", + "properties": { + "policyDefinitionId": { + "description": "Policy definition ID.", + "type": "string" + }, + "policyDefinitionReferenceId": { + "description": "Policy definition reference ID.", + "type": "string" + }, + "effect": { + "description": "Policy effect, i.e. policy definition action.", + "type": "string" + }, + "results": { + "description": "Non-compliance summary for the policy definition.", + "$ref": "#/definitions/SummaryResults" + } + } + }, + "QueryFailure": { + "description": "Error response.", + "properties": { + "error": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string" + }, + "message": { + "description": "Description of the error.", + "type": "string" + } + } + } + } + }, + "OperationsListResults": { + "description": "List of available operations.", + "properties": { + "@odata.count": { + "description": "OData entity count; represents the number of operations returned.", + "type": "integer", + "format": "int32", + "minimum": 1 + }, + "value": { + "description": "List of available operations.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + } + } + }, + "Operation": { + "description": "Operation definition.", + "properties": { + "name": { + "description": "Operation name.", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Resource provider name.", + "type": "string" + }, + "resource": { + "description": "Resource name on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation name.", + "type": "string" + }, + "description": { + "description": "Operation description.", + "type": "string" + } + } + } + } + }, + "MetadataDocument": { + "description": "Metadata XML document.", + "type": "string" + } + }, + "parameters": { + "policyStatesResourceParameter": { + "name": "policyStatesResource", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "default", + "latest" + ], + "x-ms-enum": { + "name": "PolicyStatesResource", + "modelAsString": true + }, + "description": "The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s).", + "x-ms-parameter-location": "method" + }, + "policyStatesSummaryResourceParameter": { + "name": "policyStatesSummaryResource", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "latest" + ], + "description": "The virtual resource under PolicyStates resource type for summarize action. In a given time range, 'latest' represents the latest policy state(s) and is the only allowed value.", + "x-ms-parameter-location": "method" + }, + "managementGroupsNamespaceParameter": { + "name": "managementGroupsNamespace", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Microsoft.Management" + ], + "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", + "x-ms-parameter-location": "method" + }, + "managementGroupNameParameter": { + "name": "managementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Management group name.", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Microsoft Azure subscription ID.", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name.", + "x-ms-parameter-location": "method" + }, + "resourceIdParameter": { + "name": "resourceId", + "in": "path", + "required": true, + "type": "string", + "description": "Resource ID.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "authorizationNamespaceParameter": { + "name": "authorizationNamespace", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Microsoft.Authorization" + ], + "description": "The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed.", + "x-ms-parameter-location": "method" + }, + "policySetDefinitionNameParameter": { + "name": "policySetDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy set definition name.", + "x-ms-parameter-location": "method" + }, + "policyDefinitionNameParameter": { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy definition name.", + "x-ms-parameter-location": "method" + }, + "policyAssignmentNameParameter": { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment name.", + "x-ms-parameter-location": "method" + }, + "scopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "A valid scope, i.e. management group, subscription, resource group, or resource ID. Scope used has no effect on metadata returned.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "API version to use with the client requests.", + "x-ms-parameter-location": "client" + }, + "topParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Maximum number of records to return.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Top" + }, + "orderByParameter": { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Ordering expression using OData notation. One or more comma-separated column names with an optional \"desc\" (the default) or \"asc\", e.g. \"$orderby=PolicyAssignmentId, ResourceId asc\".", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "OrderBy" + }, + "selectParameter": { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\".", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Select" + }, + "fromParameter": { + "name": "$from", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day).", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "From" + }, + "toParameter": { + "name": "$to", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "To" + }, + "filterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Filter" + }, + "applyParameter": { + "name": "$apply", + "in": "query", + "required": false, + "type": "string", + "description": "OData apply expression for aggregations.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/readme.md b/specification/policyinsights/resource-manager/readme.md index 6f107314e9b9..ffac40275df2 100644 --- a/specification/policyinsights/resource-manager/readme.md +++ b/specification/policyinsights/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the PolicyInsights API. ``` yaml title: PolicyInsightsClient openapi-type: arm -tag: package-2017-12 +tag: package-2018-04 ``` ### Validations @@ -57,6 +57,17 @@ directive: ``` +### Tag: package-2018-04 + +These settings apply only when `--tag=package-2018-04` is specified on the command line. + +``` yaml $(tag) == 'package-2018-04' +input-file: +- Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json +- Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json +``` + + ### Tag: package-2017-12 These settings apply only when `--tag=package-2017-12` is specified on the command line. @@ -102,7 +113,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go ``` @@ -164,18 +175,28 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-04 - tag: package-2017-12 - tag: package-2017-10 - tag: package-2017-08 ``` +### Tag: package-2018-04 and go + +These settings apply only when `--tag=package-2018-04 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-04' && $(go) +output-folder: $(go-sdk-folder)/services/policyinsights/mgmt/2018-04-04/policyinsights +``` + ### Tag: package-2017-12 and go These settings apply only when `--tag=package-2017-12 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-12' && $(go) -output-folder: $(go-sdk-folder)/services/policyinsights/mgmt/2017-12-12-preview/policyinsights +output-folder: $(go-sdk-folder)/services/preview/policyinsights/mgmt/2017-12-12-preview/policyinsights ``` ### Tag: package-2017-10 and go @@ -184,7 +205,7 @@ These settings apply only when `--tag=package-2017-10 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-10' && $(go) -output-folder: $(go-sdk-folder)/services/policyinsights/mgmt/2017-10-17-preview/policyinsights +output-folder: $(go-sdk-folder)/services/preview/policyinsights/mgmt/2017-10-17-preview/policyinsights ``` ### Tag: package-2017-08 and go @@ -193,7 +214,7 @@ These settings apply only when `--tag=package-2017-08 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-08' && $(go) -output-folder: $(go-sdk-folder)/services/policyinsights/mgmt/2017-08-09-preview/policyinsights +output-folder: $(go-sdk-folder)/services/preview/policyinsights/mgmt/2017-08-09-preview/policyinsights ``` @@ -203,11 +224,31 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.policyinsights +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-policyinsights +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-04 +``` + +### Tag: package-2018-04 and java + +These settings apply only when `--tag=package-2018-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-04' && $(java) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.policyinsights - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-policyinsights -``` \ No newline at end of file + namespace: com.microsoft.azure.management.policyinsights.v2018_04_04 + output-folder: $(azure-libraries-for-java-folder)/policyinsights/resource-manager/v2018_04_04 +regenerate-manager: true +generate-interface: true +``` + diff --git a/specification/policyinsights/resource-manager/readme.nodejs.md b/specification/policyinsights/resource-manager/readme.nodejs.md index 981e7c1a6111..74041a95dbe3 100644 --- a/specification/policyinsights/resource-manager/readme.nodejs.md +++ b/specification/policyinsights/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder=`. ``` yaml $(tag) == 'package-2017-04-preview' && $(go) -output-folder: $(go-sdk-folder)/services/postgresql/mgmt/2017-04-30-preview/postgresql +output-folder: $(go-sdk-folder)/services/preview/postgresql/mgmt/2017-04-30-preview/postgresql ``` ### Tag: package-2017-12-01-preview and go @@ -154,7 +154,7 @@ These settings apply only when `--tag=package-2017-12-01-preview --go` is specif Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-12-01-preview' && $(go) -output-folder: $(go-sdk-folder)/services/postgresql/mgmt/2017-12-01-preview/postgresql +output-folder: $(go-sdk-folder)/services/preview/postgresql/mgmt/2017-12-01-preview/postgresql ``` ### Tag: package-2017-12-01 and go @@ -172,11 +172,30 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.postgresql +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-postgresql +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-12-01 +``` + +### Tag: package-2017-12-01 and java + +These settings apply only when `--tag=package-2016-12-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-12-01' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.postgresql - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-postgresql + namespace: com.microsoft.azure.management.postgresql.v2017_12_01 + output-folder: $(azure-libraries-for-java-folder)/postgresql/resource-manager/v2017_12_01 +regenerate-manager: true +generate-interface: true ``` diff --git a/specification/postgresql/resource-manager/readme.nodejs.md b/specification/postgresql/resource-manager/readme.nodejs.md index b45e08e744cb..6f42c03c02ff 100644 --- a/specification/postgresql/resource-manager/readme.nodejs.md +++ b/specification/postgresql/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.powerbidedicated +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-powerbidedicated +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-10-01 +``` + +### Tag: package-2017-10-01 and java + +These settings apply only when `--tag=package-2017-10-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-10-01' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.powerbidedicated - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-powerbidedicated + namespace: com.microsoft.azure.management.powerbidedicated.v2017_10_01 + output-folder: $(azure-libraries-for-java-folder)/powerbidedicated/resource-manager/v2017_10_01 +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/powerbiembedded/resource-manager/Microsoft.PowerBI/stable/2016-01-29/powerbiembedded.json b/specification/powerbiembedded/resource-manager/Microsoft.PowerBI/stable/2016-01-29/powerbiembedded.json index e5e40105dee8..11d5cdc70a2d 100644 --- a/specification/powerbiembedded/resource-manager/Microsoft.PowerBI/stable/2016-01-29/powerbiembedded.json +++ b/specification/powerbiembedded/resource-manager/Microsoft.PowerBI/stable/2016-01-29/powerbiembedded.json @@ -907,11 +907,11 @@ "properties": { "provider": { "type": "string", - "description": "The localized friendly form of the resource provider name. This form is also expected to include the publisher/company responsible. Use Title Casing. Begin with “Microsoft” for 1st party services." + "description": "The localized friendly form of the resource provider name. This form is also expected to include the publisher/company responsible. Use Title Casing. Begin with \"Microsoft\" for 1st party services." }, "resource": { "type": "string", - "description": "The localized friendly form of the resource type related to this action/operation. This form should match the public documentation for the resource provider. Use Title Casing. For examples, refer to the “name” section." + "description": "The localized friendly form of the resource type related to this action/operation. This form should match the public documentation for the resource provider. Use Title Casing. For examples, refer to the \"name\" section." }, "operation": { "type": "string", diff --git a/specification/powerbiembedded/resource-manager/readme.md b/specification/powerbiembedded/resource-manager/readme.md index a418c1c58b59..18c73dbe54b0 100644 --- a/specification/powerbiembedded/resource-manager/readme.md +++ b/specification/powerbiembedded/resource-manager/readme.md @@ -52,9 +52,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_powerbi_embedded'] ``` @@ -135,11 +138,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.powerbiembedded +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-powerbiembedded +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-01 +``` + +### Tag: package-2016-01 and java + +These settings apply only when `--tag=package-2016-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-01' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.powerbiembedded - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-powerbiembedded + namespace: com.microsoft.azure.management.powerbi.v2016_01_29 + output-folder: $(azure-libraries-for-java-folder)/powerbi/resource-manager/v2016_01_29 +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/powerbiembedded/resource-manager/readme.ruby.md b/specification/powerbiembedded/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..0cdd43d2899d --- /dev/null +++ b/specification/powerbiembedded/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_powerbi_embedded +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2016-01 +``` + +### Tag: package-2016-01 and ruby + +These settings apply only when `--tag=package-2016-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-01' && $(ruby) +namespace: "Azure::PowerBiEmbedded::Mgmt::V2016_01_29" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_powerbi_embedded/lib +``` diff --git a/specification/recoveryservices/resource-manager/readme.md b/specification/recoveryservices/resource-manager/readme.md index 078e9f9f4dca..db306432a8fd 100644 --- a/specification/recoveryservices/resource-manager/readme.md +++ b/specification/recoveryservices/resource-manager/readme.md @@ -56,9 +56,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_recovery_services'] ``` @@ -138,11 +141,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.recoveryservices +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-recoveryservices +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-06 +``` + +### Tag: package-2016-06 and java + +These settings apply only when `--tag=package-2016-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-06' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.recoveryservices - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-recoveryservices + namespace: com.microsoft.azure.management.recoveryservices.v2016_06_01 + output-folder: $(azure-libraries-for-java-folder)/recoveryservices/resource-manager/v2016_06_01 +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/recoveryservices/resource-manager/readme.ruby.md b/specification/recoveryservices/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..975ec2e2b6e4 --- /dev/null +++ b/specification/recoveryservices/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_recovery_services +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2016-06 +``` + +### Tag: package-2016-06 and ruby + +These settings apply only when `--tag=package-2016-06 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-06' && $(ruby) +namespace: "Azure::RecoveryServices::Mgmt::V2016_06_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_recovery_services/lib +``` diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/bms.json index e83845e36c58..44b2124483c3 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/bms.json @@ -394,7 +394,7 @@ "tags": [ "ProtectionContainers" ], - "description": "Registers the container with Recovery Services vault.\r\n This is an asynchronous operation. To track the operation status, use location header to call get latest status of the operation.", + "description": "Registers the container with Recovery Services vault.\r\n This is an asynchronous operation. To track the operation status, use location header to call get latest status of\r\n the operation.", "operationId": "ProtectionContainers_Register", "produces": [ "application/json" @@ -458,7 +458,7 @@ "tags": [ "ProtectionContainers" ], - "description": "Unregisters the given container from your Recovery Services Vault.\r\n This is an asynchronous operation. To determine whether the backend service has finished processing the request, call Get Container Operation Result API.", + "description": "Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine\r\n whether the backend service has finished processing the request, call Get Container Operation Result API.", "operationId": "ProtectionContainers_Unregister", "produces": [ "application/json" @@ -544,6 +544,13 @@ "description": "Name of the container in which inquiry needs to be triggered.", "required": true, "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" } ], "responses": { @@ -552,6 +559,7 @@ } }, "deprecated": false, + "x-ms-odata": "#/definitions/BMSContainersInquiryQueryObject", "x-ms-examples": { "Inquire Azure Storage Protection Containers": { "$ref": "./examples/AzureStorage/ProtectionContainers_Inquire.json" @@ -564,7 +572,7 @@ "tags": [ "BackupWorkloadItems" ], - "description": "Provides a pageable list of workload item of a specific container according to the query filter and the pagination parameters.", + "description": "Provides a pageable list of workload item of a specific container according to the query filter and the pagination\r\n parameters.", "operationId": "BackupWorkloadItems_List", "produces": [ "application/json" @@ -703,7 +711,7 @@ "tags": [ "ProtectedItems" ], - "description": "Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.", + "description": "Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation,\r\n call the GetItemOperationResult API.", "operationId": "ProtectedItems_Get", "produces": [ "application/json" @@ -773,7 +781,7 @@ "tags": [ "ProtectedItems" ], - "description": "Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.", + "description": "Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an\r\n asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.", "operationId": "ProtectedItems_CreateOrUpdate", "produces": [ "application/json" @@ -838,7 +846,7 @@ "tags": [ "ProtectedItems" ], - "description": "Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the request, call the GetItemOperationResult API.", + "description": "Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the\r\n request, call the GetItemOperationResult API.", "operationId": "ProtectedItems_Delete", "produces": [ "application/json" @@ -899,7 +907,7 @@ "tags": [ "Backups" ], - "description": "Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the operation, call GetProtectedItemOperationResult API.", + "description": "Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the\r\n operation, call GetProtectedItemOperationResult API.", "operationId": "Backups_Trigger", "produces": [ "application/json" @@ -1040,7 +1048,7 @@ "tags": [ "ProtectedItemOperationStatuses" ], - "description": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations create jobs. This method returns the list of jobs associated with the operation.", + "description": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed\r\n or failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations\r\n create jobs. This method returns the list of jobs associated with the operation.", "operationId": "ProtectedItemOperationStatuses_Get", "produces": [ "application/json" @@ -1180,7 +1188,7 @@ "tags": [ "RecoveryPoints" ], - "description": "Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation. To know the status of the operation, call the GetProtectedItemOperationResult API.", + "description": "Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation.\r\n To know the status of the operation, call the GetProtectedItemOperationResult API.", "operationId": "RecoveryPoints_Get", "produces": [ "application/json" @@ -1248,7 +1256,7 @@ "tags": [ "ItemLevelRecoveryConnections" ], - "description": "Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file explorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of provisioning, call GetProtectedItemOperationResult API.", + "description": "Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file\r\n explorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of\r\n provisioning, call GetProtectedItemOperationResult API.", "operationId": "ItemLevelRecoveryConnections_Provision", "produces": [ "application/json" @@ -1290,7 +1298,7 @@ { "name": "recoveryPointId", "in": "path", - "description": "Recovery point ID which represents backed up data. iSCSI connection will be provisioned for this backed up data.", + "description": "Recovery point ID which represents backed up data. iSCSI connection will be provisioned\r\n for this backed up data.", "required": true, "type": "string" }, @@ -1322,7 +1330,7 @@ "tags": [ "Restores" ], - "description": "Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use GetProtectedItemOperationResult API.", + "description": "Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use\r\n GetProtectedItemOperationResult API.", "operationId": "Restores_Trigger", "produces": [ "application/json" @@ -1399,7 +1407,7 @@ "tags": [ "ItemLevelRecoveryConnections" ], - "description": "Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer displaying all recoverable files and folders. This is an asynchronous operation.", + "description": "Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer\r\n displaying all recoverable files and folders. This is an asynchronous operation.", "operationId": "ItemLevelRecoveryConnections_Revoke", "produces": [ "application/json" @@ -1441,7 +1449,7 @@ { "name": "recoveryPointId", "in": "path", - "description": "Recovery point ID which represents backed up data. iSCSI connection will be revoked for this backed up data.", + "description": "Recovery point ID which represents backed up data. iSCSI connection will be revoked for\r\n this backed up data.", "required": true, "type": "string" } @@ -1464,7 +1472,7 @@ "tags": [ "ProtectionContainers" ], - "description": "Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an asynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.", + "description": "Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an\r\n asynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.", "operationId": "ProtectionContainers_Refresh", "produces": [ "application/json" @@ -1516,7 +1524,7 @@ "tags": [ "JobCancellations" ], - "description": "Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call GetCancelOperationResult API.", + "description": "Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call\r\n GetCancelOperationResult API.", "operationId": "JobCancellations_Trigger", "produces": [ "application/json" @@ -1617,7 +1625,7 @@ "tags": [ "BackupOperationResults" ], - "description": "Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the status code in the response would be Accepted. It will continue to be in this state till it reaches completion. On successful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is part of the Location header of the operation response.", + "description": "Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the\r\n status code in the response would be Accepted. It will continue to be in this state till it reaches completion. On\r\n successful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is\r\n part of the Location header of the operation response.", "operationId": "BackupOperationResults_Get", "produces": [ "application/json" @@ -1667,7 +1675,7 @@ "tags": [ "BackupOperationStatuses" ], - "description": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs when the operation is complete.", + "description": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed\r\n or failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations\r\n create jobs. This method returns the list of jobs when the operation is complete.", "operationId": "BackupOperationStatuses_Get", "produces": [ "application/json" @@ -1714,7 +1722,7 @@ "tags": [ "ProtectionPolicies" ], - "description": "Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.", + "description": "Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous\r\n operation. Status of the operation can be fetched using GetPolicyOperationResult API.", "operationId": "ProtectionPolicies_Get", "produces": [ "application/json" @@ -1759,7 +1767,7 @@ "tags": [ "ProtectionPolicies" ], - "description": "Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.", + "description": "Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched\r\n using GetPolicyOperationResult API.", "operationId": "ProtectionPolicies_CreateOrUpdate", "produces": [ "application/json" @@ -1822,7 +1830,7 @@ "tags": [ "ProtectionPolicies" ], - "description": "Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.", + "description": "Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the\r\n operation can be fetched using GetPolicyOperationResult API.", "operationId": "ProtectionPolicies_Delete", "produces": [ "application/json" @@ -1923,7 +1931,7 @@ "tags": [ "ProtectionPolicyOperationStatuses" ], - "description": "Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed or failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs associated with operation.", + "description": "Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed\r\n or failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations\r\n create jobs. This method returns the list of jobs associated with operation.", "operationId": "ProtectionPolicyOperationStatuses_Get", "produces": [ "application/json" @@ -1977,7 +1985,7 @@ "tags": [ "BackupProtectableItems" ], - "description": "Provides a pageable list of protectable objects within your subscription according to the query filter and the pagination parameters.", + "description": "Provides a pageable list of protectable objects within your subscription according to the query filter and the\r\n pagination parameters.", "operationId": "BackupProtectableItems_List", "produces": [ "application/json" @@ -2717,6 +2725,11 @@ "$ref": "#/definitions/RetentionPolicy", "description": "Retention policy with the details on backup copy retention ranges." }, + "instantRpRetentionRangeInDays": { + "format": "int32", + "description": "Instant RP retention policy range in days", + "type": "integer" + }, "timeZone": { "description": "TimeZone optional input as string. For example: TimeZone = \"Pacific Standard Time\".", "type": "string" @@ -2922,7 +2935,7 @@ "type": "string" }, "parentUniqueName": { - "description": "Parent Unique Name is added to provide the service formatted URI Name of the Parent \r\n Only Applicable for data bases where the parent would be either Instance or a SQL AG.", + "description": "Parent Unique Name is added to provide the service formatted URI Name of the Parent\r\n Only Applicable for data bases where the parent would be either Instance or a SQL AG.", "type": "string" }, "serverName": { @@ -2949,6 +2962,99 @@ } } }, + "AzureVmWorkloadProtectedItem": { + "description": "Azure VM workload-specific protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the DB represented by this backup item.", + "type": "string" + }, + "serverName": { + "description": "Host/Cluster Name for instance or AG", + "type": "string" + }, + "parentName": { + "description": "Parent name of the DB such as Instance or Availability Group.", + "type": "string" + }, + "parentType": { + "description": "Parent type of protected item, example: for a DB, standalone server or distributed", + "type": "string" + }, + "protectionStatus": { + "description": "Backup status of this backup item.", + "type": "string" + }, + "protectionState": { + "description": "Backup state of this backup item.", + "enum": [ + "Invalid", + "IRPending", + "Protected", + "ProtectionError", + "ProtectionStopped", + "ProtectionPaused" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionState", + "modelAsString": true + } + }, + "lastBackupStatus": { + "description": "Last backup operation status. Possible values: Healthy, Unhealthy.", + "enum": [ + "Invalid", + "Healthy", + "Unhealthy", + "IRPending" + ], + "type": "string", + "x-ms-enum": { + "name": "LastBackupStatus", + "modelAsString": true + } + }, + "lastBackupTime": { + "format": "date-time", + "description": "Timestamp of the last backup operation on this backup item.", + "type": "string" + }, + "lastBackupErrorDetail": { + "$ref": "#/definitions/ErrorDetail", + "description": "Error details in last backup" + }, + "protectedItemDataSourceId": { + "description": "Data ID of the protected item.", + "type": "string" + }, + "protectedItemHealthStatus": { + "description": "Health status of the backup item, evaluated based on last heartbeat received", + "enum": [ + "Invalid", + "Healthy", + "Unhealthy", + "NotReachable", + "IRPending" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectedItemHealthStatus", + "modelAsString": true + } + }, + "extendedInfo": { + "$ref": "#/definitions/AzureVmWorkloadProtectedItemExtendedInfo", + "description": "Additional information for this backup item." + } + } + }, "AzureVmWorkloadProtectedItemExtendedInfo": { "description": "Additional information on Azure Workload for SQL specific backup item.", "type": "object", @@ -2996,6 +3102,56 @@ }, "x-ms-discriminator-value": "AzureWorkload" }, + "AzureVmWorkloadSAPHanaDatabaseProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SAP Hana Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SAPHanaDatabase" + }, + "AzureVmWorkloadSAPHanaDatabaseProtectedItem": { + "description": "Azure VM workload-specific protected item representing SAP Hana Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectedItem" + } + ], + "x-ms-discriminator-value": "AzureVmWorkloadSAPHanaDatabase" + }, + "AzureVmWorkloadSAPHanaDatabaseWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SAP Hana Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "x-ms-discriminator-value": "SAPHanaDatabase" + }, + "AzureVmWorkloadSAPHanaSystemProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SAP Hana System.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SAPHanaSystem" + }, + "AzureVmWorkloadSAPHanaSystemWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SAP Hana System.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "x-ms-discriminator-value": "SAPHanaSystem" + }, "AzureVmWorkloadSQLAvailabilityGroupProtectableItem": { "description": "Azure VM workload-specific protectable item representing SQL Availability Group.", "type": "object", @@ -3206,6 +3362,30 @@ "extendedInfo": { "$ref": "#/definitions/AzureWorkloadContainerExtendedInfo", "description": "Additional details of a workload container." + }, + "workloadType": { + "description": "Workload type for which registration was sent.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } } } }, @@ -3214,7 +3394,7 @@ "type": "object", "properties": { "hostServerName": { - "description": "Host Os Name in case of Stand Alone and \r\n Cluster Name in case of distributed container.", + "description": "Host Os Name in case of Stand Alone and Cluster Name in case of distributed container.", "type": "string" }, "inquiryInfo": { @@ -3298,6 +3478,114 @@ }, "x-ms-discriminator-value": "AzureWorkloadRestoreRequest" }, + "AzureWorkloadSAPHanaPointInTimeRecoveryPoint": { + "description": "Recovery point specific to PointInTime in SAPHana", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSAPHanaRecoveryPoint" + } + ], + "properties": { + "timeRanges": { + "description": "List of log ranges", + "type": "array", + "items": { + "$ref": "#/definitions/PointInTimeRange" + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadSAPHanaPointInTimeRecoveryPoint" + }, + "AzureWorkloadSAPHanaPointInTimeRestoreRequest": { + "description": "AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSAPHanaRestoreRequest" + } + ], + "properties": { + "pointInTime": { + "format": "date-time", + "description": "PointInTime value", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSAPHanaPointInTimeRestoreRequest" + }, + "AzureWorkloadSAPHanaRecoveryPoint": { + "description": "SAPHana specific recoverypoint, specifcally encaspulates full/diff recoverypoints", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPoint" + } + ], + "properties": { + "recoveryPointTimeInUTC": { + "format": "date-time", + "description": "UTC time at which recoverypoint was created", + "type": "string" + }, + "type": { + "description": "Type of restore point", + "enum": [ + "Invalid", + "Full", + "Log", + "Differential" + ], + "type": "string", + "x-ms-enum": { + "name": "RestorePointType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadSAPHanaRecoveryPoint" + }, + "AzureWorkloadSAPHanaRestoreRequest": { + "description": "AzureWorkload SAP Hana-specific restore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "targetInfo": { + "$ref": "#/definitions/TargetRestoreInfo", + "description": "Details of target database" + }, + "recoveryType": { + "description": "OLR/ALR, RestoreDisks is invalid option", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Fully qualified ARM ID of the VM on which workload that was running is being recovered.", + "type": "string" + }, + "propertyBag": { + "description": "Workload specific property bag.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadSAPHanaRestoreRequest" + }, "AzureWorkloadSQLPointInTimeRecoveryPoint": { "description": "Recovery point specific to PointInTime", "type": "object", @@ -3848,6 +4136,55 @@ } } }, + "BMSContainersInquiryQueryObject": { + "description": "The query filters that can be used with the inquire container API.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type for this container.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "workloadType": { + "description": "Workload type for this container.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + } + } + }, "BMSPOQueryObject": { "description": "Filters to list items that can be backed up.", "type": "object", @@ -3886,7 +4223,8 @@ "Client", "GenericDataSource", "SQLDataBase", - "AzureFileShare" + "AzureFileShare", + "SAPHanaDatabase" ], "type": "string", "x-ms-enum": { @@ -3909,7 +4247,7 @@ } }, "BMSRefreshContainersQueryObject": { - "description": "The query filters that can be used with the list containers API.", + "description": "The query filters that can be used with the refresh container API.", "type": "object", "properties": { "backupManagementType": { @@ -3997,7 +4335,9 @@ "enum": [ "Invalid", "SQLInstance", - "SQLDataBase" + "SQLDataBase", + "SAPHanaSystem", + "SAPHanaDatabase" ], "type": "string", "x-ms-enum": { @@ -4020,7 +4360,8 @@ "Client", "GenericDataSource", "SQLDataBase", - "AzureFileShare" + "AzureFileShare", + "SAPHanaDatabase" ], "type": "string", "x-ms-enum": { @@ -4685,8 +5026,12 @@ "type": "string" }, "originalStorageAccountOption": { - "description": "Original SA Option", + "description": "Original Storage Account Option", "type": "boolean" + }, + "osType": { + "description": "OS type", + "type": "string" } }, "x-ms-discriminator-value": "IaasVMRecoveryPoint" @@ -4739,11 +5084,11 @@ "type": "string" }, "subnetId": { - "description": "Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent the subnet.", + "description": "Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be\r\n {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent\r\n the subnet.", "type": "string" }, "targetDomainNameId": { - "description": "Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic Virtual Machines.", + "description": "Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic\r\n Virtual Machines.", "type": "string" }, "region": { @@ -4755,11 +5100,11 @@ "type": "string" }, "createNewCloudService": { - "description": "Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same cloud service as it was at the time of backup.", + "description": "Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same\r\n cloud service as it was at the time of backup.", "type": "boolean" }, "originalStorageAccountOption": { - "description": "Original SA Option", + "description": "Original Storage Account Option", "type": "boolean" }, "encryptionDetails": { @@ -4802,7 +5147,7 @@ "type": "object", "properties": { "status": { - "description": "Inquiry Status for this container such as \r\n InProgress | Failed | Succeeded", + "description": "Inquiry Status for this container such as\r\n InProgress | Failed | Succeeded", "type": "string" }, "errorDetail": { @@ -4810,7 +5155,7 @@ "description": "Error Details if the Status is non-success." }, "inquiryDetails": { - "description": "Inquiry Details which will have workload specific details. \r\n For e.g. - For SQL and oracle this will contain different details.", + "description": "Inquiry Details which will have workload specific details.\r\n For e.g. - For SQL and oracle this will contain different details.", "type": "array", "items": { "$ref": "#/definitions/WorkloadInquiryDetails" @@ -4864,7 +5209,7 @@ } }, "KeyAndSecretDetails": { - "description": "BEK is bitlocker key.\r\n KEK is encryption key for BEK\r\n If the VM was encrypted then we will store follwing details :\r\n 1. Secret(BEK) - Url + Backup Data + vaultId.\r\n 2. Key(KEK) - Url + Backup Data + vaultId.\r\n BEK and KEK can potentiallty have different vault ids.", + "description": "BEK is bitlocker key.\r\n KEK is encryption key for BEK\r\n If the VM was encrypted then we will store follwing details :\r\n 1. Secret(BEK) - Url + Backup Data + vaultId.\r\n 2. Key(KEK) - Url + Backup Data + vaultId.\r\n 3. EncryptionMechanism\r\n BEK and KEK can potentiallty have different vault ids.", "type": "object", "properties": { "kekDetails": { @@ -4874,6 +5219,10 @@ "bekDetails": { "$ref": "#/definitions/BEKDetails", "description": "BEK is bitlocker encrpytion key." + }, + "encryptionMechanism": { + "description": "Encryption mechanism: None/ SinglePass/ DoublePass", + "type": "string" } } }, @@ -4974,7 +5323,7 @@ "type": "string" } }, - "x-ms-discriminator-value": "MABWindowsContainer" + "x-ms-discriminator-value": "Windows" }, "MabContainerExtendedInfo": { "description": "Additional information of the container.", @@ -5000,7 +5349,8 @@ "Client", "GenericDataSource", "SQLDataBase", - "AzureFileShare" + "AzureFileShare", + "SAPHanaDatabase" ], "type": "string", "x-ms-enum": { @@ -5490,7 +5840,8 @@ "Client", "GenericDataSource", "SQLDataBase", - "AzureFileShare" + "AzureFileShare", + "SAPHanaDatabase" ], "type": "string", "x-ms-enum": { @@ -5518,6 +5869,19 @@ "backupSetName": { "description": "Name of the backup set the backup item belongs to", "type": "string" + }, + "createMode": { + "description": "Create mode to indicate recovery of existing soft deleted data source or creation of new data source.", + "enum": [ + "Invalid", + "Default", + "Recover" + ], + "type": "string", + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + } } }, "discriminator": "protectedItemType" @@ -5572,7 +5936,7 @@ "type": "string" }, "containerType": { - "description": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer", + "description": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\r\n Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\r\n Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\r\n Backup is VMAppContainer", "enum": [ "Invalid", "Unknown", @@ -5901,6 +6265,10 @@ "issqlcompression": { "description": "SQL compression flag", "type": "boolean" + }, + "isCompression": { + "description": "Workload compression flag. This has been added so that 'isSqlCompression'\r\n will be deprecated once clients upgrade to consider this flag.", + "type": "boolean" } } }, @@ -6090,7 +6458,7 @@ "type": "string" }, "databaseName": { - "description": "Database name SQL InstanceName/DataBaseName", + "description": "Database name InstanceName/DataBaseName for SQL or System/DbName for SAP Hana", "type": "string" } } @@ -6147,7 +6515,8 @@ "Second", "Third", "Fourth", - "Last" + "Last", + "Invalid" ], "type": "string", "x-ms-enum": { diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/bms.json index 3fbee179c06c..351d238e15b6 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/bms.json @@ -335,7 +335,7 @@ "tags": [ "ExportJobsOperationResults" ], - "description": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.", + "description": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also\r\n contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.", "operationId": "ExportJobsOperationResults_Get", "produces": [ "application/json" @@ -433,7 +433,7 @@ "tags": [ "BackupPolicies" ], - "description": "Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch scoped results.", + "description": "Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch\r\n scoped results.", "operationId": "BackupPolicies_List", "produces": [ "application/json" @@ -600,9 +600,68 @@ } } } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperation": { + "post": { + "tags": [ + "Validate" + ], + "description": "Validate operation for specified backed up item. This is a synchronous operation.", + "operationId": "Operation_Validate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "resource validate operation request", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateOperationRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ValidateOperationsResponse" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Validate Operation": { + "$ref": "./examples/AzureIaasVm/ValidateOperation_RestoreDisk.json" + } + } + } } }, "definitions": { + "AzureBackupGoalFeatureSupportRequest": { + "description": "Azure backup goal feature specific request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeatureSupportRequest" + } + ], + "x-ms-discriminator-value": "AzureBackupGoals" + }, "AzureFileshareProtectedItem": { "description": "Azure File Share workload-specific backup item.", "type": "object", @@ -714,6 +773,75 @@ }, "x-ms-discriminator-value": "AzureStorage" }, + "AzureFileShareRestoreRequest": { + "description": "AzureFileShare Restore Request", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "recoveryType": { + "description": "Type of this recovery.", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Source storage account ARM Id", + "type": "string" + }, + "copyOptions": { + "description": "Options to resolve copy conflicts.", + "enum": [ + "Invalid", + "CreateCopy", + "Skip", + "Overwrite", + "FailOnConflict" + ], + "type": "string", + "x-ms-enum": { + "name": "CopyOptions", + "modelAsString": true + } + }, + "restoreRequestType": { + "description": "Restore Type (FullShareRestore or ItemLevelRestore)", + "enum": [ + "Invalid", + "FullShareRestore", + "ItemLevelRestore" + ], + "type": "string", + "x-ms-enum": { + "name": "RestoreRequestType", + "modelAsString": true + } + }, + "restoreFileSpecs": { + "description": "List of Source Files/Folders(which need to recover) and TargetFolderPath details", + "type": "array", + "items": { + "$ref": "#/definitions/RestoreFileSpecs" + } + }, + "targetDetails": { + "$ref": "#/definitions/TargetAFSRestoreInfo", + "description": "Target File Share Details" + } + }, + "x-ms-discriminator-value": "AzureFileShareRestoreRequest" + }, "AzureIaaSClassicComputeVMProtectedItem": { "description": "IaaS VM workload-specific backup item representing the Classic Compute VM.", "type": "object", @@ -852,11 +980,22 @@ "type": "string" } }, + "internalPropertyBag": { + "description": "Job internal properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, "progressPercentage": { "format": "double", "description": "Indicates progress of the job. Null if it has not started or completed.", "type": "number" }, + "estimatedRemainingDuration": { + "description": "Time remaining for execution of this job.", + "type": "string" + }, "dynamicErrorMessage": { "description": "Non localized error message on job execution.", "type": "string" @@ -898,6 +1037,10 @@ "format": "double", "description": "Progress of the task.", "type": "number" + }, + "taskExecutionDetails": { + "description": "Details about execution of the task.\r\n eg: number of bytes transfered etc", + "type": "string" } } }, @@ -1016,6 +1159,11 @@ "$ref": "#/definitions/RetentionPolicy", "description": "Retention policy with the details on backup copy retention ranges." }, + "instantRpRetentionRangeInDays": { + "format": "int32", + "description": "Instant RP retention policy range in days", + "type": "integer" + }, "timeZone": { "description": "TimeZone optional input as string. For example: TimeZone = \"Pacific Standard Time\".", "type": "string" @@ -1023,6 +1171,16 @@ }, "x-ms-discriminator-value": "AzureIaasVM" }, + "AzureRecoveryServiceVaultProtectionIntent": { + "description": "Azure Recovery Services Vault specific protection intent item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionIntent" + } + ], + "x-ms-discriminator-value": "RecoveryServiceVaultItem" + }, "AzureResourceProtectionIntent": { "description": "IaaS VM specific backup protection intent item.", "type": "object", @@ -1263,6 +1421,99 @@ } } }, + "AzureVmWorkloadProtectedItem": { + "description": "Azure VM workload-specific protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the DB represented by this backup item.", + "type": "string" + }, + "serverName": { + "description": "Host/Cluster Name for instance or AG", + "type": "string" + }, + "parentName": { + "description": "Parent name of the DB such as Instance or Availability Group.", + "type": "string" + }, + "parentType": { + "description": "Parent type of protected item, example: for a DB, standalone server or distributed", + "type": "string" + }, + "protectionStatus": { + "description": "Backup status of this backup item.", + "type": "string" + }, + "protectionState": { + "description": "Backup state of this backup item.", + "enum": [ + "Invalid", + "IRPending", + "Protected", + "ProtectionError", + "ProtectionStopped", + "ProtectionPaused" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionState", + "modelAsString": true + } + }, + "lastBackupStatus": { + "description": "Last backup operation status. Possible values: Healthy, Unhealthy.", + "enum": [ + "Invalid", + "Healthy", + "Unhealthy", + "IRPending" + ], + "type": "string", + "x-ms-enum": { + "name": "LastBackupStatus", + "modelAsString": true + } + }, + "lastBackupTime": { + "format": "date-time", + "description": "Timestamp of the last backup operation on this backup item.", + "type": "string" + }, + "lastBackupErrorDetail": { + "$ref": "#/definitions/ErrorDetail", + "description": "Error details in last backup" + }, + "protectedItemDataSourceId": { + "description": "Data ID of the protected item.", + "type": "string" + }, + "protectedItemHealthStatus": { + "description": "Health status of the backup item, evaluated based on last heartbeat received", + "enum": [ + "Invalid", + "Healthy", + "Unhealthy", + "NotReachable", + "IRPending" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectedItemHealthStatus", + "modelAsString": true + } + }, + "extendedInfo": { + "$ref": "#/definitions/AzureVmWorkloadProtectedItemExtendedInfo", + "description": "Additional information for this backup item." + } + } + }, "AzureVmWorkloadProtectedItemExtendedInfo": { "description": "Additional information on Azure Workload for SQL specific backup item.", "type": "object", @@ -1310,6 +1561,16 @@ }, "x-ms-discriminator-value": "AzureWorkload" }, + "AzureVmWorkloadSAPHanaDatabaseProtectedItem": { + "description": "Azure VM workload-specific protected item representing SAP Hana Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectedItem" + } + ], + "x-ms-discriminator-value": "AzureVmWorkloadSAPHanaDatabase" + }, "AzureVmWorkloadSQLDatabaseProtectedItem": { "description": "Azure VM workload-specific protected item representing SQL Database.", "type": "object", @@ -1404,6 +1665,16 @@ }, "x-ms-discriminator-value": "AzureVmWorkloadSQLDatabase" }, + "AzureWorkloadAutoProtectionIntent": { + "description": "Azure Recovery Services Vault specific protection intent item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureRecoveryServiceVaultProtectionIntent" + } + ], + "x-ms-discriminator-value": "AzureWorkloadAutoProtectionIntent" + }, "AzureWorkloadErrorInfo": { "description": "Azure storage specific error information", "type": "object", @@ -1443,6 +1714,10 @@ } ], "properties": { + "workloadType": { + "description": "Workload type of the job", + "type": "string" + }, "duration": { "format": "duration", "description": "Time elapsed during the execution of this job.", @@ -1515,6 +1790,176 @@ } } }, + "AzureWorkloadRestoreRequest": { + "description": "AzureWorkload-specific restore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "recoveryType": { + "description": "OLR/ALR, RestoreDisks is invalid option", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Fully qualified ARM ID of the VM on which workload that was running is being recovered.", + "type": "string" + }, + "propertyBag": { + "description": "Workload specific property bag.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadRestoreRequest" + }, + "AzureWorkloadSAPHanaPointInTimeRestoreRequest": { + "description": "AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSAPHanaRestoreRequest" + } + ], + "properties": { + "pointInTime": { + "format": "date-time", + "description": "PointInTime value", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSAPHanaPointInTimeRestoreRequest" + }, + "AzureWorkloadSAPHanaRestoreRequest": { + "description": "AzureWorkload SAP Hana-specific restore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "targetInfo": { + "$ref": "#/definitions/TargetRestoreInfo", + "description": "Details of target database" + }, + "recoveryType": { + "description": "OLR/ALR, RestoreDisks is invalid option", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Fully qualified ARM ID of the VM on which workload that was running is being recovered.", + "type": "string" + }, + "propertyBag": { + "description": "Workload specific property bag.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadSAPHanaRestoreRequest" + }, + "AzureWorkloadSQLAutoProtectionIntent": { + "description": "Azure Workload SQL Auto Protection intent item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadAutoProtectionIntent" + } + ], + "properties": { + "workloadItemType": { + "description": "Workload item type of the item for which intent is to be set", + "enum": [ + "Invalid", + "SQLInstance", + "SQLDataBase", + "SAPHanaSystem", + "SAPHanaDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadItemType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLAutoProtectionIntent" + }, + "AzureWorkloadSQLPointInTimeRestoreRequest": { + "description": "AzureWorkload SQL -specific restore. Specifically for PointInTime/Log restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSQLRestoreRequest" + } + ], + "properties": { + "pointInTime": { + "format": "date-time", + "description": "PointInTime value", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLPointInTimeRestoreRequest" + }, + "AzureWorkloadSQLRestoreRequest": { + "description": "AzureWorkload SQL -specific restore. Specifically for full/diff restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRestoreRequest" + } + ], + "properties": { + "shouldUseAlternateTargetLocation": { + "description": "Default option set to true. If this is set to false, alternate data directory must be provided", + "type": "boolean" + }, + "isNonRecoverable": { + "description": "SQL specific property where user can chose to set no-recovery when restore operation is tried", + "type": "boolean" + }, + "targetInfo": { + "$ref": "#/definitions/TargetRestoreInfo", + "description": "Details of target database" + }, + "alternateDirectoryPaths": { + "description": "Data directory details", + "type": "array", + "items": { + "$ref": "#/definitions/SQLDataDirectoryMapping" + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLRestoreRequest" + }, "BackupManagementUsage": { "description": "Backup management usages of a vault.", "type": "object", @@ -1592,7 +2037,8 @@ "Client", "GenericDataSource", "SQLDataBase", - "AzureFileShare" + "AzureFileShare", + "SAPHanaDatabase" ], "type": "string", "x-ms-enum": { @@ -1634,7 +2080,7 @@ "type": "string" }, "fabricName": { - "description": "Specifies the fabric name - Azure or AAD", + "description": "Specifies the fabric name - Azure or AD", "enum": [ "Invalid", "Azure" @@ -1646,11 +2092,11 @@ } }, "containerName": { - "description": "Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname. This is required for portal", + "description": "Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname.", "type": "string" }, "protectedItemName": { - "description": "Specifies the product specific ds name. E.g. vm;iaasvmcontainer;csname;vmname. This is required for portal", + "description": "Specifies the product specific ds name. E.g. vm;iaasvmcontainer;csname;vmname.", "type": "string" }, "errorCode": { @@ -1981,6 +2427,32 @@ } } }, + "EncryptionDetails": { + "description": "Details needed if the VM was encrypted at the time of backup.", + "type": "object", + "properties": { + "encryptionEnabled": { + "description": "Identifies whether this backup copy represents an encrypted VM at the time of backup.", + "type": "boolean" + }, + "kekUrl": { + "description": "Key Url.", + "type": "string" + }, + "secretKeyUrl": { + "description": "Secret Url.", + "type": "string" + }, + "kekVaultId": { + "description": "ID of Key Vault where KEK is stored.", + "type": "string" + }, + "secretKeyVaultId": { + "description": "ID of Key Vault where Secret is stored.", + "type": "string" + } + } + }, "ErrorDetail": { "description": "Error Detail class which encapsulates Code, Message and Recommendations.", "type": "object", @@ -2112,6 +2584,84 @@ }, "x-ms-discriminator-value": "GenericProtectionPolicy" }, + "IaasVMRestoreRequest": { + "description": "IaaS VM workload-specific restore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "recoveryPointId": { + "description": "ID of the backup copy to be recovered.", + "type": "string" + }, + "recoveryType": { + "description": "Type of this recovery.", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Fully qualified ARM ID of the VM which is being recovered.", + "type": "string" + }, + "targetVirtualMachineId": { + "description": "This is the complete ARM Id of the VM that will be created.\r\n For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}", + "type": "string" + }, + "targetResourceGroupId": { + "description": "This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts.\r\n For e.g. /subscriptions/{subId}/resourcegroups/{rg}", + "type": "string" + }, + "storageAccountId": { + "description": "Fully qualified ARM ID of the storage account to which the VM has to be restored.", + "type": "string" + }, + "virtualNetworkId": { + "description": "This is the virtual network Id of the vnet that will be attached to the virtual machine.\r\n User will be validated for join action permissions in the linked access.", + "type": "string" + }, + "subnetId": { + "description": "Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be\r\n {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent\r\n the subnet.", + "type": "string" + }, + "targetDomainNameId": { + "description": "Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic\r\n Virtual Machines.", + "type": "string" + }, + "region": { + "description": "Region in which the virtual machine is restored.", + "type": "string" + }, + "affinityGroup": { + "description": "Affinity group associated to VM to be restored. Used only for Classic Compute Virtual Machines.", + "type": "string" + }, + "createNewCloudService": { + "description": "Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same\r\n cloud service as it was at the time of backup.", + "type": "boolean" + }, + "originalStorageAccountOption": { + "description": "Original Storage Account Option", + "type": "boolean" + }, + "encryptionDetails": { + "$ref": "#/definitions/EncryptionDetails", + "description": "Details needed if the VM was encrypted at the time of backup." + } + }, + "x-ms-discriminator-value": "IaasVMRestoreRequest" + }, "Job": { "description": "Defines workload agnostic properties for a job.", "required": [ @@ -2484,7 +3034,8 @@ "Client", "GenericDataSource", "SQLDataBase", - "AzureFileShare" + "AzureFileShare", + "SAPHanaDatabase" ], "type": "string", "x-ms-enum": { @@ -2761,7 +3312,7 @@ "type": "object", "properties": { "resourceType": { - "description": "Container Type - VM, SQLPaaS, DPM etc", + "description": "ProtectedItem Type- VM, SqlDataBase, AzureFileShare etc", "enum": [ "Invalid", "VM", @@ -2775,7 +3326,8 @@ "Client", "GenericDataSource", "SQLDataBase", - "AzureFileShare" + "AzureFileShare", + "SAPHanaDatabase" ], "type": "string", "x-ms-enum": { @@ -2784,11 +3336,11 @@ } }, "resourceId": { - "description": "Entire ARM VM Id", + "description": "ARM Virtual Machine Id", "type": "string" }, "vaultId": { - "description": "Entire vault id of the resource", + "description": "ARM id of the Recovery Services Vault", "type": "string" }, "properties": { @@ -2827,7 +3379,7 @@ "type": "string" }, "containerName": { - "description": "Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required for portal", + "description": "Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required\r\n for portal", "type": "string" }, "protectedItemName": { @@ -2878,7 +3430,8 @@ "Client", "GenericDataSource", "SQLDataBase", - "AzureFileShare" + "AzureFileShare", + "SAPHanaDatabase" ], "type": "string", "x-ms-enum": { @@ -2906,6 +3459,19 @@ "backupSetName": { "description": "Name of the backup set the backup item belongs to", "type": "string" + }, + "createMode": { + "description": "Create mode to indicate recovery of existing soft deleted data source or creation of new data source.", + "enum": [ + "Invalid", + "Default", + "Recover" + ], + "type": "string", + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + } } }, "discriminator": "protectedItemType" @@ -2962,7 +3528,8 @@ "Client", "GenericDataSource", "SQLDataBase", - "AzureFileShare" + "AzureFileShare", + "SAPHanaDatabase" ], "type": "string", "x-ms-enum": { @@ -3144,6 +3711,30 @@ "fabricName": { "description": "Fabric name for filter", "type": "string" + }, + "workloadType": { + "description": "Workload type for the backup policy.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } } } }, @@ -3226,6 +3817,38 @@ } } }, + "RestoreFileSpecs": { + "description": "Restore file specs like file path, type and target folder path info.", + "type": "object", + "properties": { + "path": { + "description": "Source File/Folder path", + "type": "string" + }, + "fileSpecType": { + "description": "Indicates what the Path variable stands for", + "type": "string" + }, + "targetFolderPath": { + "description": "Destination folder path in target FileShare", + "type": "string" + } + } + }, + "RestoreRequest": { + "description": "Base class for restore request. Workload-specific restore requests are derived from this class.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, "RetentionDuration": { "description": "Retention duration.", "type": "object", @@ -3291,6 +3914,10 @@ "issqlcompression": { "description": "SQL compression flag", "type": "boolean" + }, + "isCompression": { + "description": "Workload compression flag. This has been added so that 'isSqlCompression'\r\n will be deprecated once clients upgrade to consider this flag.", + "type": "boolean" } } }, @@ -3368,6 +3995,37 @@ }, "x-ms-discriminator-value": "SimpleSchedulePolicy" }, + "SQLDataDirectoryMapping": { + "description": "Encapsulates information regarding data directory", + "type": "object", + "properties": { + "mappingType": { + "description": "Type of data directory mapping", + "enum": [ + "Invalid", + "Data", + "Log" + ], + "type": "string", + "x-ms-enum": { + "name": "SQLDataDirectoryType", + "modelAsString": true + } + }, + "sourceLogicalName": { + "description": "Restore source logical name path", + "type": "string" + }, + "sourcePath": { + "description": "Restore source path", + "type": "string" + }, + "targetPath": { + "description": "Target path", + "type": "string" + } + } + }, "SubProtectionPolicy": { "description": "Sub-protection policy which includes schedule and retention", "type": "object", @@ -3386,6 +4044,108 @@ } } }, + "TargetAFSRestoreInfo": { + "description": "Target Azure File Share Info.", + "type": "object", + "properties": { + "name": { + "description": "File share name", + "type": "string" + }, + "targetResourceId": { + "description": "Target file share resource ARM ID", + "type": "string" + } + } + }, + "TargetRestoreInfo": { + "description": "Details about target workload during restore operation.", + "type": "object", + "properties": { + "overwriteOption": { + "description": "Can Overwrite if Target DataBase already exists", + "enum": [ + "Invalid", + "FailOnConflict", + "Overwrite" + ], + "type": "string", + "x-ms-enum": { + "name": "OverwriteOptions", + "modelAsString": true + } + }, + "containerId": { + "description": "Resource Id name of the container in which Target DataBase resides", + "type": "string" + }, + "databaseName": { + "description": "Database name InstanceName/DataBaseName for SQL or System/DbName for SAP Hana", + "type": "string" + } + } + }, + "ValidateIaasVMRestoreOperationRequest": { + "description": "AzureRestoreValidation request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidateRestoreOperationRequest" + } + ], + "x-ms-discriminator-value": "ValidateIaasVMRestoreOperationRequest" + }, + "ValidateOperationRequest": { + "description": "Base class for validate operation request.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "ValidateOperationResponse": { + "description": "Base class for validate operation response.", + "type": "object", + "properties": { + "validationResults": { + "description": "Gets the validation result", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + } + } + }, + "ValidateOperationsResponse": { + "type": "object", + "properties": { + "validateOperationResponse": { + "$ref": "#/definitions/ValidateOperationResponse" + } + } + }, + "ValidateRestoreOperationRequest": { + "description": "AzureRestoreValidation request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidateOperationRequest" + } + ], + "properties": { + "restoreRequest": { + "$ref": "#/definitions/RestoreRequest", + "description": "Sets restore request to be validated" + } + }, + "x-ms-discriminator-value": "ValidateRestoreOperationRequest" + }, "WeeklyRetentionFormat": { "description": "Weekly retention format.", "type": "object", @@ -3419,7 +4179,8 @@ "Second", "Third", "Fourth", - "Last" + "Last", + "Invalid" ], "type": "string", "x-ms-enum": { diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/examples/AzureIaasVm/ValidateOperation_RestoreDisk.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/examples/AzureIaasVm/ValidateOperation_RestoreDisk.json new file mode 100644 index 000000000000..2ea2e631b773 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/examples/AzureIaasVm/ValidateOperation_RestoreDisk.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRG", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;testRG;testvmName", + "protectedItemName": "VM;iaasvmcontainerv2;testRG;testvmName", + "recoveryPointId": "348916168024334", + "api-version": "2017-07-01", + "parameters": { + "objectType": "ValidateIaasVMRestoreOperationRequest", + "restoreRequest": { + "recoveryPointId": "348916168024334", + "objectType": "IaasVMRestoreRequest", + "recoveryType": "RestoreDisks", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount", + "region": "southeastasia", + "createNewCloudService": true, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + } + } + } + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "validateOperationResponse": { + "validationResults": [ + { + "code": "UserErrorCoreCountSubscriptionQuotaReached", + "message": "Core Count subscription quota has been reached.", + "recommendations": [ + "Contact Azure support to increase the limits." + ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/recoveryservicesbackup/resource-manager/readme.md b/specification/recoveryservicesbackup/resource-manager/readme.md index 734f85c67156..782c24197442 100644 --- a/specification/recoveryservicesbackup/resource-manager/readme.md +++ b/specification/recoveryservicesbackup/resource-manager/readme.md @@ -67,6 +67,32 @@ input-file: - Microsoft.RecoveryServices/stable/2016-06-01/registeredIdentities.json ``` +### Tag: package-2016-08 + +These settings apply only when `--tag=package-2016-08` is specified on the command line. + +``` yaml $(tag) == 'package-2016-08' +input-file: +- Microsoft.RecoveryServices/stable/2016-08-10/operations.json +``` + +### Tag: package-2016-12 + +These settings apply only when `--tag=package-2016-12` is specified on the command line. + +``` yaml $(tag) == 'package-2016-12' +input-file: +- Microsoft.RecoveryServices/stable/2016-12-01/bms.json +``` + +### Tag: package-2017-07-only + +These settings apply only when `--tag=package-2017-07` is specified on the command line. + +``` yaml $(tag) == 'package-2017-07-only' +input-file: +- Microsoft.RecoveryServices/stable/2017-07-01/bms.json +``` --- # Code Generation @@ -80,9 +106,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_recovery_services_backup'] ``` @@ -134,15 +163,36 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.recoveryservicesbackup +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-recoveryservicesbackup +``` + + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-06 +``` + +### Tag: package-2016-06 and java + +These settings apply only when `--tag=package-2016-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-06' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.recoveryservicesbackup - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-recoveryservicesbackup + namespace: com.microsoft.azure.management.recoveryservices.backup.v2016_06_01 + output-folder: $(azure-libraries-for-java-folder)/recoveryservices.backup/resource-manager/v2016_06_01 +regenerate-manager: true +generate-interface: true ``` + ## Go These settings apply only when `--go` is specified on the command line. @@ -159,6 +209,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2017-07 + - tag: package-2016-12 - tag: package-2016-06 ``` @@ -171,6 +222,15 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2016-12' && $(go) +output-folder: $(go-sdk-folder)/services/recoveryservices/mgmt/2016-12-01/backup +``` + ### Tag: package-2016-06 and go These settings apply only when `--tag=package-2016-06 --go` is specified on the command line. diff --git a/specification/recoveryservicesbackup/resource-manager/readme.nodejs.md b/specification/recoveryservicesbackup/resource-manager/readme.nodejs.md index ca74ac6971eb..3454d7942205 100644 --- a/specification/recoveryservicesbackup/resource-manager/readme.nodejs.md +++ b/specification/recoveryservicesbackup/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-06' && $(ruby) +namespace: "Azure::RecoveryServicesBackup::Mgmt::V2016_06_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_recovery_services_backup/lib +``` + +### Tag: package-2016-08 and ruby + +These settings apply only when `--tag=package-2016-08 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-08' && $(ruby) +namespace: "Azure::RecoveryServicesBackup::Mgmt::V2016_08_10" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_recovery_services_backup/lib +``` + +### Tag: package-2016-12 and ruby + +These settings apply only when `--tag=package-2016-12 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-12' && $(ruby) +namespace: "Azure::RecoveryServicesBackup::Mgmt::V2016_12_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_recovery_services_backup/lib +``` + +### Tag: package-2017-07-only and ruby + +These settings apply only when `--tag=package-2017-07-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-07-only' && $(ruby) +namespace: "Azure::RecoveryServicesBackup::Mgmt::V2017_07_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_recovery_services_backup/lib +``` \ No newline at end of file diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationProtectionContainerMappings_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationProtectionContainerMappings_Update.json new file mode 100644 index 000000000000..7d54c8a39070 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationProtectionContainerMappings_Update.json @@ -0,0 +1,53 @@ +{ + "parameters":{ + "mappingName":"cloud1protectionprofile1", + "protectionContainerName":"cloud_6d224fc6-f326-5d35-96de-fbf51efb3179", + "fabricName":"cloud1", + "api-version":"2018-01-10", + "resourceName":"vault1", + "resourceGroupName":"resourceGroupPS1", + "subscriptionId":"c183865e-6077-46f2-a3b1-deb0f4f4650a", + "updateInput":{ + "properties":{ + "providerSpecificInput":{ + "instanceType":"A2A", + "agentAutoUpdateStatus":"Enabled", + "automationAccountArmId":"/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/automationrg1/providers/Microsoft.Automation/automationAccounts/automationaccount1" + } + } + } + }, + "responses":{ + "200":{ + "body":{ + "id":"/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1", + "name":"cloud1protectionprofile1", + "type":"Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings", + "properties":{ + "targetProtectionContainerId":"Microsoft Azure", + "targetProtectionContainerFriendlyName":"Microsoft Azure", + "health":"Normal", + "healthErrorDetails":[ + + ], + "policyId":"/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1", + "state":"Paired", + "sourceProtectionContainerFriendlyName":"cloud1", + "sourceFabricFriendlyName":"cloud1", + "targetFabricFriendlyName":"Microsoft Azure", + "policyFriendlyName":"protectionprofile1", + "providerSpecificDetails":{ + "instanceType":"A2A", + "agentAutoUpdateStatus":"Enabled", + "automationAccountArmId":"/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/automationrg1/providers/Microsoft.Automation/automationAccounts/automationaccount1", + "scheduleName":"cloud1protectionprofile1_a85ea38f-62a8-471b-93cc-69b74fd9578c", + "jobScheduleName":"ffd503ec-5f88-4b58-97c8-841466e7aa47" + } + } + } + }, + "202":{ + + } + } +} \ No newline at end of file diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/service.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/service.json index f4c2ba1c2ee5..a1d3b033f60f 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/service.json +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/service.json @@ -1643,6 +1643,13 @@ "description": "Protection container name.", "required": true, "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" } ], "responses": { @@ -1656,6 +1663,7 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/ProtectableItemQueryParameter", "x-ms-examples": { "Gets the list of protectable items.": { "$ref": "./examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json" @@ -3242,6 +3250,81 @@ "$ref": "./examples/ReplicationProtectionContainerMappings_Purge.json" } } + }, + "patch": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Update protection container mapping.", + "description": "The operation to update protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "updateInput", + "in": "body", + "description": "Mapping update input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateProtectionContainerMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Update.json" + } + } } }, "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}/remove": { @@ -6006,6 +6089,34 @@ "properties": {}, "x-ms-discriminator-value": "A2A" }, + "A2AContainerMappingInput": { + "description": "A2A container mapping input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, "A2AEnableProtectionInput": { "description": "A2A enable protection input.", "type": "object", @@ -6152,7 +6263,7 @@ "type": "string", "x-ms-enum": { "name": "SetMultiVmSyncStatus", - "modelAsString": false + "modelAsString": true } } }, @@ -6326,6 +6437,42 @@ } } }, + "A2AProtectionContainerMappingDetails": { + "description": "A2A provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + }, + "scheduleName": { + "description": "The schedule arm name.", + "type": "string" + }, + "jobScheduleName": { + "description": "The job schedule arm name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, "A2ARecoveryPointDetails": { "description": "A2A provider specific recovery point details.", "type": "object", @@ -6344,7 +6491,7 @@ "type": "string", "x-ms-enum": { "name": "RecoveryPointSyncType", - "modelAsString": false + "modelAsString": true } } }, @@ -6380,7 +6527,7 @@ "type": "string", "x-ms-enum": { "name": "MultiVmGroupCreateOption", - "modelAsString": false + "modelAsString": true } }, "managementId": { @@ -6596,6 +6743,34 @@ }, "x-ms-discriminator-value": "A2A" }, + "A2AUpdateContainerMappingInput": { + "description": "A2A update protection container mapping.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput" + } + ], + "properties": { + "agentAutoUpdateStatus": { + "description": "A value indicating whether the auto update is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentAutoUpdateStatus", + "modelAsString": true + } + }, + "automationAccountArmId": { + "description": "The automation account arm id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, "A2AUpdateReplicationProtectedItemInput": { "description": "InMage Azure V2 input to update replication protected item.", "type": "object", @@ -7301,7 +7476,7 @@ "type": "string", "x-ms-enum": { "name": "FailoverDeploymentModel", - "modelAsString": false + "modelAsString": true } }, "groups": { @@ -7381,7 +7556,7 @@ "type": "string", "x-ms-enum": { "name": "DisableProtectionReason", - "modelAsString": false + "modelAsString": true } }, "replicationProviderInput": { @@ -8068,12 +8243,13 @@ "TestFailover", "Configuration", "FabricInfrastructure", - "VersionExpiry" + "VersionExpiry", + "AgentAutoUpdate" ], "type": "string", "x-ms-enum": { "name": "HealthErrorCategory", - "modelAsString": false + "modelAsString": true } }, "severity": { @@ -8087,7 +8263,7 @@ "type": "string", "x-ms-enum": { "name": "Severity", - "modelAsString": false + "modelAsString": true } }, "summaryMessage": { @@ -9093,16 +9269,43 @@ } }, "hasPhysicalDisk": { - "description": "A value indicating whether the VM has a physical disk attached.", - "type": "boolean" + "description": "A value indicating whether the VM has a physical disk attached. String value of {SrsDataContract.PresenceStatus} enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } }, "hasFibreChannelAdapter": { - "description": "A value indicating whether the VM has a fibre channel adapter attached.", - "type": "boolean" + "description": "A value indicating whether the VM has a fibre channel adapter attached. String value of {SrsDataContract.PresenceStatus} enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } }, "hasSharedVhd": { - "description": "A value indicating whether the VM has a shared VHD attached.", - "type": "boolean" + "description": "A value indicating whether the VM has a shared VHD attached. String value of {SrsDataContract.PresenceStatus} enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } } }, "x-ms-discriminator-value": "HyperVVirtualMachine" @@ -9119,7 +9322,7 @@ "type": "string", "x-ms-enum": { "name": "IdentityProviderType", - "modelAsString": false + "modelAsString": true } }, "tenantId": { @@ -9261,7 +9464,7 @@ "type": "string", "x-ms-enum": { "name": "AgentVersionStatus", - "modelAsString": false + "modelAsString": true } } } @@ -9497,7 +9700,7 @@ "type": "string", "x-ms-enum": { "name": "SetMultiVmSyncStatus", - "modelAsString": false + "modelAsString": true } } }, @@ -10085,7 +10288,7 @@ "type": "string", "x-ms-enum": { "name": "RecoveryPointType", - "modelAsString": false + "modelAsString": true } }, "recoveryPointId": { @@ -10162,7 +10365,7 @@ "type": "string", "x-ms-enum": { "name": "SetMultiVmSyncStatus", - "modelAsString": false + "modelAsString": true } } }, @@ -10774,17 +10977,11 @@ }, "affectedObjectTypes": { "description": "The type of objects.", - "type": "array", - "items": { "type": "string" - } }, "jobStatus": { "description": "The states of the job to be filtered can be in.", - "type": "array", - "items": { "type": "string" - } } } }, @@ -11559,6 +11756,16 @@ } } }, + "ProtectableItemQueryParameter": { + "description": "Query parameter to enumerate Protectable items.", + "type": "object", + "properties": { + "state": { + "description": "State of the Protectable item query filter.", + "type": "string" + } + } + }, "ProtectedItemsQueryParameter": { "description": "Query parameter to enumerate protected items.", "type": "object", @@ -11588,7 +11795,7 @@ "type": "string", "x-ms-enum": { "name": "MultiVmGroupCreateOption", - "modelAsString": false + "modelAsString": true } } } @@ -11730,7 +11937,8 @@ "type": "string", "readOnly": true } - } + }, + "discriminator": "instanceType" }, "ProtectionContainerProperties": { "description": "Protection profile custom data details.", @@ -11850,7 +12058,7 @@ "type": "string", "x-ms-enum": { "name": "MultiVmSyncStatus", - "modelAsString": false + "modelAsString": true } }, "crashConsistentFrequencyInMinutes": { @@ -11899,7 +12107,7 @@ "type": "string", "x-ms-enum": { "name": "A2ARpRecoveryPointType", - "modelAsString": false + "modelAsString": true } }, "cloudServiceCreationOption": { @@ -11915,7 +12123,7 @@ "type": "string", "x-ms-enum": { "name": "MultiVmSyncPointOption", - "modelAsString": false + "modelAsString": true } } }, @@ -11957,7 +12165,7 @@ "type": "string", "x-ms-enum": { "name": "ReplicationProtectedItemOperation", - "modelAsString": false + "modelAsString": true } } }, @@ -11972,7 +12180,7 @@ "type": "string", "x-ms-enum": { "name": "PossibleOperationsDirections", - "modelAsString": false + "modelAsString": true } } }, @@ -12023,7 +12231,7 @@ "type": "string", "x-ms-enum": { "name": "RecoveryPlanActionLocation", - "modelAsString": false + "modelAsString": true } } }, @@ -12063,7 +12271,7 @@ "type": "string", "x-ms-enum": { "name": "RecoveryPlanGroupType", - "modelAsString": false + "modelAsString": true } }, "replicationProtectedItems": { @@ -12135,7 +12343,7 @@ "type": "string", "x-ms-enum": { "name": "DataSyncStatus", - "modelAsString": false + "modelAsString": true } }, "recoveryVmCreationOption": { @@ -12147,7 +12355,7 @@ "type": "string", "x-ms-enum": { "name": "AlternateLocationRecoveryOption", - "modelAsString": false + "modelAsString": true } } }, @@ -12187,7 +12395,7 @@ "type": "string", "x-ms-enum": { "name": "HyperVReplicaAzureRpRecoveryPointType", - "modelAsString": false + "modelAsString": true } } }, @@ -12221,7 +12429,7 @@ "type": "string", "x-ms-enum": { "name": "InMageV2RpRecoveryPointType", - "modelAsString": false + "modelAsString": true } }, "useMultiVmSyncPoint": { @@ -12253,7 +12461,7 @@ "type": "string", "x-ms-enum": { "name": "RpInMageRecoveryPointType", - "modelAsString": false + "modelAsString": true } } }, @@ -12304,7 +12512,7 @@ "type": "string", "x-ms-enum": { "name": "PossibleOperationsDirections", - "modelAsString": false + "modelAsString": true } }, "providerSpecificDetails": { @@ -12449,7 +12657,7 @@ "type": "string", "x-ms-enum": { "name": "RecoveryPlanActionLocation", - "modelAsString": false + "modelAsString": true } } }, @@ -12532,7 +12740,7 @@ "type": "string", "x-ms-enum": { "name": "PossibleOperationsDirections", - "modelAsString": false + "modelAsString": true } }, "networkType": { @@ -12586,7 +12794,7 @@ "type": "string", "x-ms-enum": { "name": "PossibleOperationsDirections", - "modelAsString": false + "modelAsString": true } }, "sourceSiteOperations": { @@ -12598,7 +12806,7 @@ "type": "string", "x-ms-enum": { "name": "SourceSiteOperations", - "modelAsString": false + "modelAsString": true } }, "providerSpecificDetails": { @@ -13002,7 +13210,8 @@ "description": "The class type.", "type": "string" } - } + }, + "discriminator": "instanceType" }, "ReplicationProviderSpecificSettings": { "description": "Replication provider specific settings.", @@ -13016,6 +13225,17 @@ }, "discriminator": "instanceType" }, + "ReplicationProviderSpecificUpdateContainerMappingInput": { + "description": "Provider specific input for update pairing operations.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, "Resource": { "description": "Azure resource.", "properties": { @@ -13710,6 +13930,26 @@ } } }, + "UpdateProtectionContainerMappingInput": { + "description": "Container pairing update input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateProtectionContainerMappingInputProperties", + "description": "Update protection container mapping input properties." + } + } + }, + "UpdateProtectionContainerMappingInputProperties": { + "description": "Container pairing update input.", + "type": "object", + "properties": { + "providerSpecificInput": { + "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput", + "description": "Provider specific input for updating protection container mapping." + } + } + }, "UpdateRecoveryPlanInput": { "description": "Update recovery plan input class.", "type": "object", @@ -13784,7 +14024,7 @@ "type": "string", "x-ms-enum": { "name": "LicenseType", - "modelAsString": false + "modelAsString": true } }, "recoveryAvailabilitySetId": { @@ -13877,6 +14117,10 @@ "fabricsHealth": { "$ref": "#/definitions/ResourceHealthSummary", "description": "The list of the health detail of the fabrics in the vault." + }, + "containersHealth": { + "$ref": "#/definitions/ResourceHealthSummary", + "description": "The list of the health detail of the containers in the vault." } } }, @@ -13967,7 +14211,7 @@ } }, "VersionDetails": { - "description": "Version related deatils.", + "description": "Version related details.", "type": "object", "properties": { "version": { @@ -13991,7 +14235,7 @@ "type": "string", "x-ms-enum": { "name": "AgentVersionStatus", - "modelAsString": false + "modelAsString": true } } } @@ -14126,16 +14370,43 @@ } }, "hasPhysicalDisk": { - "description": "A value indicating whether the VM has a physical disk attached.", - "type": "boolean" + "description": "A value indicating whether the VM has a physical disk attached. String value of {SrsDataContract.PresenceStatus} enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } }, "hasFibreChannelAdapter": { - "description": "A value indicating whether the VM has a fibre channel adapter attached.", - "type": "boolean" + "description": "A value indicating whether the VM has a fibre channel adapter attached. String value of {SrsDataContract.PresenceStatus} enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } }, "hasSharedVhd": { - "description": "A value indicating whether the VM has a shared VHD attached.", - "type": "boolean" + "description": "A value indicating whether the VM has a shared VHD attached. String value of {SrsDataContract.PresenceStatus} enum.", + "enum": [ + "Unknown", + "Present", + "NotPresent" + ], + "type": "string", + "x-ms-enum": { + "name": "PresenceStatus", + "modelAsString": true + } } }, "x-ms-discriminator-value": "VmmVirtualMachine" @@ -14576,16 +14847,16 @@ "in": "path", "description": "The name of the resource group where the recovery services vault is present.", "required": true, - "type": "string", - "x-ms-parameter-location": "client" + "x-ms-parameter-location": "client", + "type": "string" }, "ResourceName": { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, - "type": "string", - "x-ms-parameter-location": "client" + "x-ms-parameter-location": "client", + "type": "string" }, "ApiVersion": { "name": "api-version", diff --git a/specification/recoveryservicessiterecovery/resource-manager/readme.md b/specification/recoveryservicessiterecovery/resource-manager/readme.md index 87564f9e7fb9..fc71ed33ea3f 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/readme.md +++ b/specification/recoveryservicessiterecovery/resource-manager/readme.md @@ -59,9 +59,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_recovery_services_site_recovery'] ``` @@ -124,11 +127,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.recoveryservicessiterecovery +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-recoveryservicessiterecovery +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-08 +``` + +### Tag: package-2016-08 and java + +These settings apply only when `--tag=package-2016-08 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-08' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.recoveryservicessiterecovery - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-recoveryservicessiterecovery + namespace: com.microsoft.azure.management.recoveryservicessiterecovery.v2018_01_10 + output-folder: $(azure-libraries-for-java-folder)/recoveryservicessiterecovery/resource-manager/v2018_01_10 +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/recoveryservicessiterecovery/resource-manager/readme.nodejs.md b/specification/recoveryservicessiterecovery/resource-manager/readme.nodejs.md index 8f1c39b8ec20..4ac1aa503e18 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/readme.nodejs.md +++ b/specification/recoveryservicessiterecovery/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-08' && $(ruby) +namespace: "Azure::RecoveryServicesSiteRecovery::Mgmt::V2016_08_10" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_recovery_services_site_recovery/lib +``` diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json index 5b6b860e896b..41f921566ef3 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json @@ -11,7 +11,7 @@ { "dayOfWeek": "Monday", "startHourUtc": 12, - "maintenanceWindow": "PT3H" + "maintenanceWindow": "PT5H" }, { "dayOfWeek": "Tuesday", @@ -32,7 +32,7 @@ { "dayOfWeek": "Monday", "startHourUtc": 12, - "maintenanceWindow": "PT3H" + "maintenanceWindow": "PT5H" }, { "dayOfWeek": "Tuesday", @@ -52,7 +52,7 @@ { "dayOfWeek": "Monday", "startHourUtc": 12, - "maintenanceWindow": "PT3H" + "maintenanceWindow": "PT5H" }, { "dayOfWeek": "Tuesday", diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesGet.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesGet.json index cd5f5776ab5a..4d57dcc96ea9 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesGet.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesGet.json @@ -17,7 +17,7 @@ { "dayOfWeek": "Monday", "startHourUtc": 12, - "maintenanceWindow": "PT3H" + "maintenanceWindow": "PT5H" }, { "dayOfWeek": "Tuesday", diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesList.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesList.json new file mode 100644 index 000000000000..d712b03586f5 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2017-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default", + "name": "default", + "type": "Microsoft.Cache/Redis/patchSchedules", + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/redis.json index 361a2dc629d7..8d79b8e6997a 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/redis.json @@ -77,7 +77,7 @@ "schema": { "$ref": "#/definitions/CheckNameAvailabilityParameters" }, - "description": "Parameters supplied to the CheckNameAvailability Redis operation." + "description": "Parameters supplied to the CheckNameAvailability Redis operation. The only supported resource type is 'Microsoft.Cache/redis'" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -861,10 +861,57 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/patchSchedules": { + "get": { + "tags": [ + "Redis", + "PatchSchedules" + ], + "operationId": "PatchSchedules_ListByRedisResource", + "description": "Gets all patch schedules in the specified redis cache (there is only one).", + "x-ms-examples": { + "RedisCachePatchSchedulesList": { "$ref": "./examples/RedisCachePatchSchedulesList.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + } + ], + "responses": { + "200": { + "description": "Successfully got the current patch schedules", + "schema": { + "$ref": "#/definitions/RedisPatchScheduleListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}": { "put": { "tags": [ - "Redis" + "Redis", + "PatchSchedules" ], "operationId": "PatchSchedules_CreateOrUpdate", "x-ms-examples": { @@ -933,7 +980,8 @@ }, "delete": { "tags": [ - "Redis" + "Redis", + "PatchSchedules" ], "operationId": "PatchSchedules_Delete", "x-ms-examples": { @@ -987,7 +1035,8 @@ }, "get": { "tags": [ - "Redis" + "Redis", + "PatchSchedules" ], "operationId": "PatchSchedules_Get", "x-ms-examples": { @@ -1801,6 +1850,23 @@ ], "description": "Response to put/get patch schedules for Redis cache." }, + "RedisPatchScheduleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisPatchSchedule" + }, + "description": "Results of the list patch schedules operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next page of results." + } + }, + "description": "The response of list patch schedules Redis operation." + }, "RedisForceRebootResponse": { "properties": { "message": { @@ -1960,7 +2026,7 @@ } }, "CheckNameAvailabilityParameters": { - "description": "Parameters body to pass for name availability check.", + "description": "Parameters body to pass for name availability check.", "properties": { "name": { "type": "string", @@ -1968,9 +2034,13 @@ }, "type": { "type": "string", - "description": "Resource type." + "description": "Resource type. The only legal value of this property for checking redis cache name availability is 'Microsoft.Cache/redis'." } - } + }, + "required": [ + "name", + "type" + ] }, "UpgradeNotification": { "properties": { diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json index d864ec6cb48f..ad603c28ece1 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json @@ -11,7 +11,7 @@ { "dayOfWeek": "Monday", "startHourUtc": 12, - "maintenanceWindow": "PT3H" + "maintenanceWindow": "PT5H" }, { "dayOfWeek": "Tuesday", @@ -32,7 +32,7 @@ { "dayOfWeek": "Monday", "startHourUtc": 12, - "maintenanceWindow": "PT3H" + "maintenanceWindow": "PT5H" }, { "dayOfWeek": "Tuesday", @@ -52,7 +52,7 @@ { "dayOfWeek": "Monday", "startHourUtc": 12, - "maintenanceWindow": "PT3H" + "maintenanceWindow": "PT5H" }, { "dayOfWeek": "Tuesday", diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/examples/RedisCachePatchSchedulesGet.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/examples/RedisCachePatchSchedulesGet.json index 1f9994b41d1d..b15e1ef9f878 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/examples/RedisCachePatchSchedulesGet.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/examples/RedisCachePatchSchedulesGet.json @@ -17,7 +17,7 @@ { "dayOfWeek": "Monday", "startHourUtc": 12, - "maintenanceWindow": "PT3H" + "maintenanceWindow": "PT5H" }, { "dayOfWeek": "Tuesday", diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/examples/RedisCachePatchSchedulesList.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/examples/RedisCachePatchSchedulesList.json new file mode 100644 index 000000000000..f78ade074915 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/examples/RedisCachePatchSchedulesList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2018-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default", + "name": "default", + "type": "Microsoft.Cache/Redis/patchSchedules", + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/redis.json index e3a1156bfd8b..89031d2b44c7 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/redis.json @@ -77,7 +77,7 @@ "schema": { "$ref": "#/definitions/CheckNameAvailabilityParameters" }, - "description": "Parameters supplied to the CheckNameAvailability Redis operation." + "description": "Parameters supplied to the CheckNameAvailability Redis operation. The only supported resource type is 'Microsoft.Cache/redis'" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -864,10 +864,57 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/patchSchedules": { + "get": { + "tags": [ + "Redis", + "PatchSchedules" + ], + "operationId": "PatchSchedules_ListByRedisResource", + "description": "Gets all patch schedules in the specified redis cache (there is only one).", + "x-ms-examples": { + "RedisCachePatchSchedulesList": { "$ref": "./examples/RedisCachePatchSchedulesList.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + } + ], + "responses": { + "200": { + "description": "Successfully got the current patch schedules", + "schema": { + "$ref": "#/definitions/RedisPatchScheduleListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}": { "put": { "tags": [ - "Redis" + "Redis", + "PatchSchedules" ], "operationId": "PatchSchedules_CreateOrUpdate", "x-ms-examples": { @@ -936,7 +983,8 @@ }, "delete": { "tags": [ - "Redis" + "Redis", + "PatchSchedules" ], "operationId": "PatchSchedules_Delete", "x-ms-examples": { @@ -990,7 +1038,8 @@ }, "get": { "tags": [ - "Redis" + "Redis", + "PatchSchedules" ], "operationId": "PatchSchedules_Get", "x-ms-examples": { @@ -1630,7 +1679,7 @@ "nextLink": { "type": "string", "readOnly": true, - "description": "Link for next set of locations." + "description": "Link for next page of results." } }, "description": "The response of list firewall rules Redis operation." @@ -1672,7 +1721,7 @@ "nextLink": { "type": "string", "readOnly": true, - "description": "Link for next set of locations." + "description": "Link for next page of results." } }, "description": "The response of list Redis operation." @@ -1835,6 +1884,23 @@ ], "description": "Response to put/get patch schedules for Redis cache." }, + "RedisPatchScheduleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisPatchSchedule" + }, + "description": "Results of the list patch schedules operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next page of results." + } + }, + "description": "The response of list patch schedules Redis operation." + }, "RedisForceRebootResponse": { "properties": { "message": { @@ -1994,7 +2060,7 @@ } }, "CheckNameAvailabilityParameters": { - "description": "Parameters body to pass for name availability check.", + "description": "Parameters body to pass for resource name availability check.", "properties": { "name": { "type": "string", @@ -2002,9 +2068,13 @@ }, "type": { "type": "string", - "description": "Resource type." + "description": "Resource type. The only legal value of this property for checking redis cache name availability is 'Microsoft.Cache/redis'." } - } + }, + "required": [ + "name", + "type" + ] }, "UpgradeNotification": { "properties": { @@ -2049,19 +2119,19 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - } + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." } } +} diff --git a/specification/redis/resource-manager/readme.md b/specification/redis/resource-manager/readme.md index 4d43bf448fa6..2dd0fc43e918 100644 --- a/specification/redis/resource-manager/readme.md +++ b/specification/redis/resource-manager/readme.md @@ -90,9 +90,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_redis'] ``` @@ -216,15 +219,49 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.redis +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-redis +``` + +### Java multi-api +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-03 + - tag: package-2017-10 +``` + +### Tag: package-2018-03 and java + +These settings apply only when `--tag=package-2018-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-03' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.redis - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-redis + namespace: com.microsoft.azure.management.redis.v2018_03_01 + output-folder: $(azure-libraries-for-java-folder)/redis/resource-manager/v2018_03_01 +regenerate-manager: true +generate-interface: true +``` + + +### Tag: package-2017-10 and java + +These settings apply only when `--tag=package-2017-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.redis.v2017_10_01 + output-folder: $(azure-libraries-for-java-folder)/redis/resource-manager/v2017_10_01 +regenerate-manager: true +generate-interface: true ``` + # Validation ## Suppression diff --git a/specification/redis/resource-manager/readme.ruby.md b/specification/redis/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..13dcef195bdd --- /dev/null +++ b/specification/redis/resource-manager/readme.ruby.md @@ -0,0 +1,59 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_redis +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2017-10 + - tag: package-2017-02 + - tag: package-2016-04 + - tag: package-2015-08 +``` + +### Tag: package-2017-10 and ruby + +These settings apply only when `--tag=package-2017-10 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-10' && $(ruby) +namespace: "Azure::Redis::Mgmt::V2017_10_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_redis/lib +``` + +### Tag: package-2017-02 and ruby + +These settings apply only when `--tag=package-2017-02 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-02' && $(ruby) +namespace: "Azure::Redis::Mgmt::V2017_02_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_redis/lib +``` + +### Tag: package-2016-04 and ruby + +These settings apply only when `--tag=package-2016-04 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-04' && $(ruby) +namespace: "Azure::Redis::Mgmt::V2016_04_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_redis/lib +``` + +### Tag: package-2015-08 and ruby + +These settings apply only when `--tag=package-2015-08 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-08' && $(ruby) +namespace: "Azure::Redis::Mgmt::V2015_08_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_redis/lib +``` diff --git a/specification/relay/resource-manager/readme.md b/specification/relay/resource-manager/readme.md index aa337bb93dc8..389b4c7fad25 100644 --- a/specification/relay/resource-manager/readme.md +++ b/specification/relay/resource-manager/readme.md @@ -62,9 +62,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_relay'] ``` @@ -154,11 +157,46 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.relay +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-relay +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-07 + - tag: package-2017-04 +``` + +### Tag: package-2016-07 and java + +These settings apply only when `--tag=package-2016-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-07' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.relay - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-relay + namespace: com.microsoft.azure.management.relay.v2016_07_01 + output-folder: $(azure-libraries-for-java-folder)/relay/resource-manager/v2016_07_01 +regenerate-manager: true +generate-interface: true ``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.relay.v2017_04_01 + output-folder: $(azure-libraries-for-java-folder)/relay/resource-manager/v2017_04_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/relay/resource-manager/readme.ruby.md b/specification/relay/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..a7e5e801a608 --- /dev/null +++ b/specification/relay/resource-manager/readme.ruby.md @@ -0,0 +1,37 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_relay +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2017-04 + - tag: package-2016-07 +``` + +### Tag: package-2017-04 and ruby + +These settings apply only when `--tag=package-2017-04 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-04' && $(ruby) +namespace: "Azure::Relay::Mgmt::V2017_04_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_relay/lib +``` + +### Tag: package-2016-07 and ruby + +These settings apply only when `--tag=package-2016-07 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-07' && $(ruby) +namespace: "Azure::Relay::Mgmt::V2016_07_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_relay/lib +``` diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetAppliedReservations.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetAppliedReservations.json new file mode 100644 index 000000000000..532bb9b87375 --- /dev/null +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetAppliedReservations.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2018-06-01", + "subscriptionId": "23bc208b-083f-4901-ae85-4f98c0c3b4b6" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/23bc208b-083f-4901-ae85-4f98c0c3b4b6/providers/microsoft.capacity/AppliedReservations/default", + "type": "Microsoft.Capacity/AppliedReservations", + "name": "default", + "properties": { + "reservationOrderIds": { + "value": ["/providers/Microsoft.Capacity/reservationorders/e1eccf0b-2db4-4e84-97e7-98b50e9d46f7", + "/providers/Microsoft.Capacity/reservationorders/741a32eb-6158-4cee-9642-a0243ae79fac", + "/providers/Microsoft.Capacity/reservationorders/e061223d-fcff-4d10-bd49-56a740cfb96a", + "/providers/Microsoft.Capacity/reservationorders/2eeb7234-970e-4663-b60b-85241b515901", + "/providers/Microsoft.Capacity/reservationorders/9db2f4c5-b1c5-42a8-bd79-ee56cdde2c7f", + "/providers/Microsoft.Capacity/reservationorders/5da7a877-6d6e-44af-8880-ed3f533bf928", + "/providers/Microsoft.Capacity/reservationorders/f65b0d0a-f945-4105-821c-d00bc8bacde8", + "/providers/Microsoft.Capacity/reservationorders/51304124-e477-4b07-b9fa-03b05c8b924b", + "/providers/Microsoft.Capacity/reservationorders/f5409b98-8a42-4dc6-be0a-cc59bef4d0db", + "/providers/Microsoft.Capacity/reservationorders/a495550a-80a4-46f8-8843-34d4df46f9a6", + "/providers/Microsoft.Capacity/reservationorders/1a966e18-c272-4ce1-a0c2-d4e1039023c3", + "/providers/Microsoft.Capacity/reservationorders/939310b4-f9de-4645-9569-ab5b6cfe958e", + "/providers/Microsoft.Capacity/reservationorders/4193a889-7c3b-44dc-8b7b-bfd7aad6c723"] + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetCatalog.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetCatalog.json new file mode 100644 index 000000000000..510a98533c34 --- /dev/null +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetCatalog.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "api-version": "2018-06-01", + "subscriptionId": "23bc208b-083f-4901-ae85-4f98c0c3b4b6", + "reservedResourceType": "VirtualMachines", + "location": "eastus" + }, + "responses": { + "200": { + "body": [ + { + "resourceType": "VirtualMachines", + "name": "Standard_DS5_v2", + "terms": [ + "P1Y", + "P3Y" + ], + "locations": [ + "eastus" + ], + "skuProperties": [ + { + "name": "Cores", + "value": "16" + }, + { + "name": "ProductTitle", + "value": "DSv2 Series, DS5" + }, + { + "name": "ProductShortName", + "value": "DSv2 Series" + }, + { + "name": "SKUName", + "value": "DS5 v2" + }, + { + "name": "MeterId", + "value": "12bc208b-083f-4901-ae85-4f98c0c3b4b8" + } + ], + "restrictions": [] + }, + { + "resourceType": "VirtualMachines", + "name": "Standard_D1", + "terms": [ + "P1Y", + "P3Y" + ], + "locations": [ + "eastus" + ], + "skuProperties": [ + { + "name": "Cores", + "value": "1" + }, + { + "name": "ProductTitle", + "value": "D Series, D1" + }, + { + "name": "ProductShortName", + "value": "D Series" + }, + { + "name": "SKUName", + "value": "D1" + }, + { + "name": "MeterId", + "value": "12bc208b-083f-4901-ae85-4f98c0c3b4b8" + } + ], + "restrictions": [ + { + "type": "Term", + "values": [ + "P1Y" + ], + "reasonCode": "NotAvailableForSubscription" + }, + { + "type": "Term", + "values": [ + "P3Y" + ], + "reasonCode": "NotAvailableForSubscription" + } + ] + }, + { + "resourceType": "VirtualMachines", + "name": "Standard_F2", + "terms": [ + "P1Y", + "P3Y" + ], + "locations": [ + "eastus" + ], + "skuProperties": [ + { + "name": "Cores", + "value": "2" + }, + { + "name": "ProductTitle", + "value": "F Series, F2" + }, + { + "name": "ProductShortName", + "value": "F Series" + }, + { + "name": "SKUName", + "value": "F2" + }, + { + "name": "MeterId", + "value": "12bc208b-083f-4901-ae85-4f98c0c3b4b8" + } + ], + "restrictions": [ + { + "type": "Location", + "values": [ + "eastus" + ], + "reasonCode": "NotAvailableForSubscription" + } + ] + } + ] + } + } +} diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetOperations.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetOperations.json new file mode 100644 index 000000000000..7b004eef0074 --- /dev/null +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetOperations.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Capacity/reservationorders/read", + "display": { + "provider": "Microsoft Capacity", + "resource": "Reservations", + "operation": "Get Reservations", + "description": "Read All Reservations" + } + }, + { + "name": "Microsoft.Capacity/reservationorders/write", + "display": { + "provider": "Microsoft Capacity", + "resource": "Reservations", + "operation": "Create Reservations", + "description": "Create any Reservation" + } + }, + { + "name": "Microsoft.Capacity/reservationorders/action", + "display": { + "provider": "Microsoft Capacity", + "resource": "Reservations", + "operation": "Update Reservations", + "description": "Update any Reservation" + } + }, + { + "name": "Microsoft.Capacity/reservationorders/delete", + "display": { + "provider": "Microsoft Capacity", + "resource": "Reservations", + "operation": "Delete Reservations", + "description": "Delete any Reservation" + } + }, + { + "name": "Microsoft.Capacity/reservationorders/reservations/read", + "display": { + "provider": "Microsoft Capacity", + "resource": "Reservations", + "operation": "Get Reservations", + "description": "Read All Reservations" + } + }, + { + "name": "Microsoft.Capacity/reservationorders/reservations/write", + "display": { + "provider": "Microsoft Capacity", + "resource": "Reservations", + "operation": "Create Reservations", + "description": "Create any Reservation" + } + }, + { + "name": "Microsoft.Capacity/reservationorders/reservations/action", + "display": { + "provider": "Microsoft Capacity", + "resource": "Reservations", + "operation": "Update Reservations", + "description": "Update any Reservation" + } + }, + { + "name": "Microsoft.Capacity/reservationorders/reservations/delete", + "display": { + "provider": "Microsoft Capacity", + "resource": "Reservations", + "operation": "Delete Reservations", + "description": "Delete any Reservation" + } + }, + { + "name": "Microsoft.Capacity/reservationorders/reservations/revisions/read", + "display": { + "provider": "Microsoft Capacity", + "resource": "Reservations", + "operation": "Get Reservations", + "description": "Read All Reservations" + } + }, + { + "name": "Microsoft.Capacity/register/action", + "display": { + "provider": "Microsoft Capacity", + "resource": "Reservations", + "operation": "Registers the Capacity Resource Provider.", + "description": "Registers the Capacity resource provider and enables the creation of Capacity resources." + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationDetails.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationDetails.json new file mode 100644 index 000000000000..95fe665a8125 --- /dev/null +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationDetails.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2018-06-01", + "reservationOrderId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", + "reservationId": "6ef59113-3482-40da-8d79-787f823e34bc" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc", + "type": "Microsoft.Capacity/reservationOrders/reservations", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc", + "etag": 2, + "location": "eastus", + "properties": { + "appliedScopes": [ + "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3" + ], + "appliedScopeType": "Single", + "quantity": 3, + "provisioningState": "Succeeded", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T22:46:32.7632798Z", + "lastUpdatedDateTime": "2017-09-22T22:46:32.7632798Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "Off", + "skuDescription": "D1 v2", + "mergeProperties": { + "mergeSources": [ + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7", + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de" + ] + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationOrderDetails.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationOrderDetails.json new file mode 100644 index 000000000000..65b21d85981b --- /dev/null +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationOrderDetails.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2018-06-01", + "reservationOrderId": "a075419f-44cc-497f-b68a-14ee811d48b9" + }, + "responses": { + "200": { + "body": { + "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa", + "type": "Microsoft.Capacity/reservationOrders", + "name": "1f14354c-dc12-4c8d-8090-6f295a3a34aa", + "etag": 7, + "properties": { + "displayName": "cabri", + "requestDateTime": "2017-08-30T03:49:19.0252126Z", + "createdDateTime": "2017-08-30T03:51:49.8083758Z", + "expiryDate": "2018-08-30", + "term": "P1Y", + "provisioningState": "Succeeded", + "reservations": [ + { + "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6" + } + ], + "originalQuantity": 7 + } + } + } + } +} \ No newline at end of file diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationOrders.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationOrders.json new file mode 100644 index 000000000000..a1929ffb8afa --- /dev/null +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationOrders.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/microsoft.capacity/reservationOrders/1e6407ba-37a5-499f-80ed-a3f0f338e443", + "type": "Microsoft.Capacity/reservationOrders", + "name": "1e6407ba-37a5-499f-80ed-a3f0f338e443", + "etag": 7, + "properties": { + "displayName": "cabri", + "requestDateTime": "2017-08-29T21:20:23.8134834Z", + "createdDateTime": "2017-08-29T21:22:56.8541664Z", + "expiryDate": "2018-08-29", + "term": "P1Y", + "provisioningState": "Succeeded", + "reservations": [ + { + "id": "/providers/microsoft.capacity/reservationOrders/1e6407ba-37a5-499f-80ed-a3f0f338e443/reservations/cae5924e-7a15-419f-a369-124f52d4a106" + } + ], + "originalQuantity": 1 + } + }, + { + "id": "/providers/microsoft.capacity/reservationOrders/1ea6e203-288e-4732-b9e1-da8bbe10c614", + "type": "Microsoft.Capacity/reservationOrders", + "name": "1ea6e203-288e-4732-b9e1-da8bbe10c614", + "etag": 7, + "properties": { + "displayName": "cabri", + "requestDateTime": "2017-08-30T12:55:40.2799114Z", + "createdDateTime": "2017-08-30T12:58:20.526Z", + "expiryDate": "2018-08-30", + "term": "P1Y", + "provisioningState": "Succeeded", + "reservations": [ + { + "id": "/providers/microsoft.capacity/reservationOrders/1ea6e203-288e-4732-b9e1-da8bbe10c614/reservations/d04fd48d-e3f6-42a3-a8f6-1ad0b7513e48" + } + ], + "originalQuantity": 9 + } + }, + { + "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa", + "type": "Microsoft.Capacity/reservationOrders", + "name": "1f14354c-dc12-4c8d-8090-6f295a3a34aa", + "etag": 7, + "properties": { + "displayName": "cabri", + "requestDateTime": "2017-08-30T03:49:19.0252126Z", + "createdDateTime": "2017-08-30T03:51:49.8083758Z", + "expiryDate": "2018-08-30", + "term": "P1Y", + "provisioningState": "Succeeded", + "reservations": [ + { + "id": "/providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6" + } + ], + "originalQuantity": 7 + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.Capacity/reservationOrders?api-version=2017-11-01&%24skiptoken=eyJyZyI6IjIwNTkyMzdlLWY3MmYtNDczYi1hNTZiLWExOGJkM2UwMDhlZCIsImlnIjpudWxsLCJzdCI6bnVsbH0%3d" + } + } + } +} \ No newline at end of file diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationRevisions.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationRevisions.json new file mode 100644 index 000000000000..19ee04881381 --- /dev/null +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationRevisions.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "api-version": "2018-06-01", + "reservationOrderId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", + "reservationId": "6ef59113-3482-40da-8d79-787f823e34bc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc/revisions/4", + "type": "Microsoft.Capacity/reservationOrders/reservations/revisions", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc/4", + "etag": 4, + "location": "eastus", + "properties": { + "appliedScopeType": "Shared", + "quantity": 3, + "provisioningState": "Succeeded", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T23:57:48.1891638Z", + "lastUpdatedDateTime": "2017-09-22T23:57:54.3768768Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "On", + "skuDescription": "D1 v2", + "mergeProperties": { + "mergeSources": [ + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7", + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de" + ] + } + } + }, + { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc/revisions/3", + "type": "Microsoft.Capacity/reservationOrders/reservations/revisions", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc/3", + "etag": 3, + "location": "eastus", + "properties": { + "appliedScopes": [ + "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3" + ], + "appliedScopeType": "Single", + "quantity": 3, + "provisioningState": "Succeeded", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T22:46:32.7632798Z", + "extendedStatusInfo": { + "statusCode": "Pending", + "message": "An operation is in progress on your reservation. Please wait for operation to complete before taking further action" + }, + "lastUpdatedDateTime": "2017-09-22T23:57:47.488284Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "On", + "skuDescription": "D1 v2", + "mergeProperties": { + "mergeSources": [ + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7", + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de" + ] + } + } + }, + { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc/revisions/2", + "type": "Microsoft.Capacity/reservationOrders/reservations/revisions", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc/2", + "etag": 2, + "location": "eastus", + "properties": { + "appliedScopes": [ + "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3" + ], + "appliedScopeType": "Single", + "quantity": 3, + "provisioningState": "Succeeded", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T22:46:32.7632798Z", + "lastUpdatedDateTime": "2017-09-22T22:46:32.7632798Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "On", + "skuDescription": "D1 v2", + "mergeProperties": { + "mergeSources": [ + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7", + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de" + ] + } + } + }, + { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc/revisions/1", + "type": "Microsoft.Capacity/reservationOrders/reservations/revisions", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc/1", + "etag": 1, + "location": "eastus", + "properties": { + "appliedScopes": [ + "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3" + ], + "appliedScopeType": "Single", + "quantity": 3, + "provisioningState": "Creating", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T22:46:27.3313607Z", + "lastUpdatedDateTime": "2017-09-22T22:46:27.3313607Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "On", + "skuDescription": "D1 v2", + "mergeProperties": { + "mergeSources": [ + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7", + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de" + ] + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservations.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservations.json new file mode 100644 index 000000000000..0af8dfcdb6b6 --- /dev/null +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservations.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "api-version": "2018-06-01", + "reservationOrderId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a", + "type": "Microsoft.Capacity/reservationOrders/reservations", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/bcae77cd-3119-4766-919f-b50d36c75c7a", + "etag": 10, + "location": "eastus", + "properties": { + "appliedScopes": [ + "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3" + ], + "appliedScopeType": "Single", + "quantity": 3, + "provisioningState": "Cancelled", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T01:00:30.9253826Z", + "extendedStatusInfo": { + "statusCode": "Split", + "message": "This reservation was split and is no longer active." + }, + "lastUpdatedDateTime": "2017-09-22T01:00:36.3191627Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "On", + "skuDescription": "D1 v2", + "splitProperties": { + "splitDestinations": [ + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7", + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de" + ] + } + } + }, + { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7", + "type": "Microsoft.Capacity/reservationOrders/reservations", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/00238563-7312-4c20-a134-8c030bf938a7", + "etag": 5, + "location": "eastus", + "properties": { + "appliedScopes": [ + "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3" + ], + "appliedScopeType": "Single", + "quantity": 1, + "provisioningState": "Cancelled", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T22:46:32.7632798Z", + "extendedStatusInfo": { + "statusCode": "Merged", + "message": "This reservation was merged and is no longer active." + }, + "lastUpdatedDateTime": "2017-09-22T22:46:32.7632798Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "On", + "skuDescription": "D1 v2", + "splitProperties": { + "splitSource": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a" + }, + "mergeProperties": { + "mergeDestination": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc" + } + } + }, + { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de", + "type": "Microsoft.Capacity/reservationOrders/reservations", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de", + "etag": 4, + "location": "eastus", + "properties": { + "appliedScopes": [ + "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3" + ], + "appliedScopeType": "Single", + "quantity": 2, + "provisioningState": "Cancelled", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T22:46:32.7632798Z", + "extendedStatusInfo": { + "statusCode": "Merged", + "message": "This reservation was merged and is no longer active." + }, + "lastUpdatedDateTime": "2017-09-22T22:46:32.7632798Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "On", + "skuDescription": "D1 v2", + "splitProperties": { + "splitSource": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a" + }, + "mergeProperties": { + "mergeDestination": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc" + } + } + }, + { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc", + "type": "Microsoft.Capacity/reservationOrders/reservations", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc", + "etag": 2, + "location": "eastus", + "properties": { + "appliedScopes": [ + "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3" + ], + "appliedScopeType": "Single", + "quantity": 3, + "provisioningState": "Succeeded", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T22:46:32.7632798Z", + "lastUpdatedDateTime": "2017-09-22T22:46:32.7632798Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "On", + "skuDescription": "D1 v2", + "mergeProperties": { + "mergeSources": [ + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7", + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de" + ] + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/MergeReservations.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/MergeReservations.json new file mode 100644 index 000000000000..3bff75d5b14c --- /dev/null +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/MergeReservations.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2018-06-01", + "reservationOrderId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", + "body": { + "properties" : { + "sources": [ + "/providers/Microsoft.Capacity/reservationOrders/c0565a8a-4491-4e77-b07b-5e6d66718e1c/reservations/cea04232-932e-47db-acb5-e29a945ecc73", + "/providers/Microsoft.Capacity/reservationOrders/c0565a8a-4491-4e77-b07b-5e6d66718e1c/reservations/5bf54dc7-dacd-4f46-a16b-7b78f4a59799" + ] + } + } + }, + "responses": { + "200": { + "body": [ + { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7", + "type": "Microsoft.Capacity/reservationOrders/reservations", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/00238563-7312-4c20-a134-8c030bf938a7", + "etag": 5, + "location": "eastus", + "properties": { + "appliedScopes": [ + "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3" + ], + "appliedScopeType": "Single", + "quantity": 1, + "provisioningState": "Cancelled", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T22:46:32.7632798Z", + "extendedStatusInfo": { + "statusCode": "Merged", + "message": "This reservation was merged and is no longer active." + }, + "lastUpdatedDateTime": "2017-09-22T22:46:32.7632798Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "Off", + "skuDescription": "D1 v2", + "splitProperties": { + "splitSource": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a" + }, + "mergeProperties": { + "mergeDestination": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc" + } + } + }, + { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de", + "type": "Microsoft.Capacity/reservationOrders/reservations", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de", + "etag": 4, + "location": "eastus", + "properties": { + "appliedScopes": [ + "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3" + ], + "appliedScopeType": "Single", + "quantity": 2, + "provisioningState": "Cancelled", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T22:46:32.7632798Z", + "extendedStatusInfo": { + "statusCode": "Merged", + "message": "This reservation was merged and is no longer active." + }, + "lastUpdatedDateTime": "2017-09-22T22:46:32.7632798Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "Off", + "skuDescription": "D1 v2", + "splitProperties": { + "splitSource": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a" + }, + "mergeProperties": { + "mergeDestination": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc" + } + } + }, + { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc", + "type": "Microsoft.Capacity/reservationOrders/reservations", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc", + "etag": 2, + "location": "eastus", + "properties": { + "appliedScopes": [ + "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3" + ], + "appliedScopeType": "Single", + "quantity": 3, + "provisioningState": "Succeeded", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T22:46:32.7632798Z", + "lastUpdatedDateTime": "2017-09-22T22:46:32.7632798Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "Off", + "skuDescription": "D1 v2", + "mergeProperties": { + "mergeSources": [ + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7", + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de" + ] + } + } + } + ] + }, + "202" : { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/SplitReservation.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/SplitReservation.json new file mode 100644 index 000000000000..7143885c917d --- /dev/null +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/SplitReservation.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2018-06-01", + "reservationOrderId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", + "body": { + "properties": { + "quantities": [ + 1, + 2 + ], + "reservationId": "/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a" + } + } + }, + "responses": { + "200": { + "body": [ + { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7", + "type": "Microsoft.Capacity/reservationOrders/reservations", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/00238563-7312-4c20-a134-8c030bf938a7", + "etag": 2, + "location": "eastus", + "properties": { + "appliedScopes": [ + "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3" + ], + "appliedScopeType": "Single", + "quantity": 1, + "provisioningState": "Succeeded", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T01:00:30.9253826Z", + "lastUpdatedDateTime": "2017-09-22T01:00:36.3191627Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "Off", + "skuDescription": "D1 v2", + "splitProperties": { + "splitSource": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a" + } + } + }, + { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de", + "type": "Microsoft.Capacity/reservationOrders/reservations", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de", + "etag": 2, + "location": "eastus", + "properties": { + "appliedScopes": [ + "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3" + ], + "appliedScopeType": "Single", + "quantity": 2, + "provisioningState": "Succeeded", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T01:00:30.9253826Z", + "lastUpdatedDateTime": "2017-09-22T01:00:36.3191627Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "Off", + "skuDescription": "D1 v2", + "splitProperties": { + "splitSource": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a" + } + } + }, + { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a", + "type": "Microsoft.Capacity/reservationOrders/reservations", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/bcae77cd-3119-4766-919f-b50d36c75c7a", + "etag": 10, + "location": "eastus", + "properties": { + "appliedScopes": [ + "/subscriptions/98df3792-7962-4f18-8be2-d5576f122de3" + ], + "appliedScopeType": "Single", + "quantity": 3, + "provisioningState": "Cancelled", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T01:00:30.9253826Z", + "extendedStatusInfo": { + "statusCode": "Split", + "message": "This reservation was split and is no longer active." + }, + "lastUpdatedDateTime": "2017-09-22T01:00:36.3191627Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "Off", + "skuDescription": "D1 v2", + "splitProperties": { + "splitDestinations": [ + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7", + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de" + ] + } + } + } + ] + }, + "202" : { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/UpdateReservation.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/UpdateReservation.json new file mode 100644 index 000000000000..dcab173ae0dd --- /dev/null +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/UpdateReservation.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2018-06-01", + "reservationOrderId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", + "reservationId": "6ef59113-3482-40da-8d79-787f823e34bc", + "parameters": { + "properties" : { + "appliedScopeType": "Shared", + "instanceFlexibility": "Off" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_DS1_v2" + }, + "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc", + "type": "Microsoft.Capacity/reservationOrders/reservations", + "name": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc", + "etag": 4, + "location": "eastus", + "properties": { + "appliedScopeType": "Shared", + "quantity": 3, + "provisioningState": "Succeeded", + "expiryDate": "2018-09-22", + "displayName": "cabri_test", + "effectiveDateTime": "2017-09-22T23:57:48.1891638Z", + "lastUpdatedDateTime": "2017-09-22T23:57:54.3768768Z", + "reservedResourceType": "VirtualMachines", + "instanceFlexibility": "Off", + "skuDescription": "D1 v2", + "mergeProperties": { + "mergeSources": [ + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7", + "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de" + ] + } + } + } + }, + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/reservations.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/reservations.json new file mode 100644 index 000000000000..1e5f33f7cf02 --- /dev/null +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/reservations.json @@ -0,0 +1,1217 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Reservation API", + "description": "This API describe Azure Reservation", + "version": "2018-06-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/catalogs": { + "get": { + "summary": "Get the regions and skus that are available for RI purchase for the specified Azure subscription.", + "operationId": "GetCatalog", + "x-ms-examples": { + "Catalog": { + "$ref": "./examples/GetCatalog.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ReservedResourceTypeIdParameter" + }, + { + "$ref": "#/parameters/LocationIdParameter" + } + ], + "tags": [ + "Catalog" + ], + "responses": { + "200": { + "description": "List of available resources", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Catalog" + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/appliedReservations": { + "get": { + "summary": "Get list of applicable `Reservation`s.", + "description": "Get applicable `Reservation`s that are applied to this subscription.", + "operationId": "GetAppliedReservationList", + "x-ms-examples": { + "AppliedReservationList": { + "$ref": "./examples/GetAppliedReservations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "tags": [ + "AppliedReservation" + ], + "responses": { + "200": { + "description": "Applicable `Reservation`s.", + "schema": { + "$ref": "#/definitions/AppliedReservations" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.Capacity/reservationOrders": { + "get": { + "summary": "Get all `ReservationOrder`s.", + "description": "List of all the `ReservationOrder`s that the user has access to in the current tenant.", + "operationId": "ReservationOrder_List", + "x-ms-examples": { + "ReservationOrderList": { + "$ref": "./examples/GetReservationOrders.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Reservation" + ], + "responses": { + "200": { + "description": "List of `ReservationOrder`s", + "schema": { + "$ref": "#/definitions/ReservationOrderList" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}": { + "get": { + "summary": "Get a specific `ReservationOrder`.", + "description": "Get the details of the `ReservationOrder`.", + "operationId": "ReservationOrder_Get", + "x-ms-examples": { + "GetReservation": { + "$ref": "./examples/GetReservationOrderDetails.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ReservationOrderIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Reservation" + ], + "responses": { + "200": { + "description": "Get the details of the `ReservationOrder`.", + "schema": { + "$ref": "#/definitions/ReservationOrderResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/split": { + "post": { + "summary": "Split the `Reservation`.", + "description": "Split a `Reservation` into two `Reservation`s with specified quantity distribution.\n", + "operationId": "Reservation_Split", + "x-ms-examples": { + "Split": { + "$ref": "./examples/SplitReservation.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ReservationOrderIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SplitParameter" + } + ], + "tags": [ + "Reservation, Split" + ], + "responses": { + "200": { + "description": "List of `Reservation`s created after the split operation.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ReservationResponse" + } + } + }, + "202": { + "description": "The request is accepted and is being processed" + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/merge": { + "post": { + "summary": "Merges two `Reservation`s.", + "description": "Merge the specified `Reservation`s into a new `Reservation`. The two `Reservation`s being merged must have same properties.", + "operationId": "Reservation_Merge", + "x-ms-examples": { + "Merge": { + "$ref": "./examples/MergeReservations.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ReservationOrderIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/MergeParameter" + } + ], + "tags": [ + "Reservation, Merge" + ], + "responses": { + "200": { + "description": "Returns the `Reservation` created after the merge.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ReservationResponse" + } + } + }, + "202": { + "description": "The request is accepted and is being processed" + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations": { + "get": { + "summary": "Get `Reservation`s in a given reservation Order", + "description": "List `Reservation`s within a single `ReservationOrder`.", + "operationId": "Reservation_List", + "x-ms-examples": { + "ReservationList": { + "$ref": "./examples/GetReservations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ReservationOrderIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Reservation" + ], + "responses": { + "200": { + "description": "List `Reservation`s within a single `ReservationOrder`.", + "schema": { + "$ref": "#/definitions/ReservationList" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}": { + "get": { + "summary": "Get `Reservation` details.", + "description": "Get specific `Reservation` details.", + "operationId": "Reservation_Get", + "x-ms-examples": { + "GetReservation": { + "$ref": "./examples/GetReservationDetails.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ReservationIdParameter" + }, + { + "$ref": "#/parameters/ReservationOrderIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Reservation" + ], + "responses": { + "200": { + "description": "Get `Reservation` details.", + "schema": { + "$ref": "#/definitions/ReservationResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "summary": "Updates a `Reservation`.", + "description": "Updates the applied scopes of the `Reservation`.", + "operationId": "Reservation_Update", + "x-ms-examples": { + "PatchReservation": { + "$ref": "./examples/UpdateReservation.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ReservationOrderIdParameter" + }, + { + "$ref": "#/parameters/ReservationIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PatchParameter" + } + ], + "tags": [ + "Reservation", + "ApplyScope" + ], + "responses": { + "200": { + "description": "Returns the updated `Reservation`.", + "schema": { + "$ref": "#/definitions/ReservationResponse" + } + }, + "202": { + "description": "The request is accepted and is being processed" + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}/revisions": { + "get": { + "summary": "Get `Reservation` revisions.", + "description": "List of all the revisions for the `Reservation`.\n", + "operationId": "Reservation_ListRevisions", + "x-ms-examples": { + "ReservationRevisions": { + "$ref": "./examples/GetReservationRevisions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ReservationIdParameter" + }, + { + "$ref": "#/parameters/ReservationOrderIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Reservation" + ], + "responses": { + "200": { + "description": "List of all the revisions for the `Reservation`.", + "schema": { + "$ref": "#/definitions/ReservationList" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.Capacity/operations": { + "get": { + "summary": "Get operations.", + "description": "List all the operations.", + "operationId": "Operation_List", + "x-ms-examples": { + "GetOperations": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Operation" + ], + "responses": { + "200": { + "description": "List all the operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + } + }, + "definitions": { + "ReservationStatusCode": { + "type": "string", + "enum": [ + "None", + "Pending", + "Active", + "PurchaseError", + "PaymentInstrumentError", + "Split", + "Merged", + "Expired", + "Succeeded" + ], + "x-ms-enum": { + "name": "ReservationStatusCode", + "modelAsString": true + } + }, + "ErrorResponseCode": { + "type": "string", + "enum": [ + "NotSpecified", + "InternalServerError", + "ServerTimeout", + "AuthorizationFailed", + "BadRequest", + "ClientCertificateThumbprintNotSet", + "InvalidRequestContent", + "OperationFailed", + "HttpMethodNotSupported", + "InvalidRequestUri", + "MissingTenantId", + "InvalidTenantId", + "InvalidReservationOrderId", + "InvalidReservationId", + "ReservationIdNotInReservationOrder", + "ReservationOrderNotFound", + "InvalidSubscriptionId", + "InvalidAccessToken", + "InvalidLocationId", + "UnauthenticatedRequestsThrottled", + "InvalidHealthCheckType", + "Forbidden", + "BillingScopeIdCannotBeChanged", + "AppliedScopesNotAssociatedWithCommerceAccount", + "PatchValuesSameAsExisting", + "RoleAssignmentCreationFailed", + "ReservationOrderCreationFailed", + "ReservationOrderNotEnabled", + "CapacityUpdateScopesFailed", + "UnsupportedReservationTerm", + "ReservationOrderIdAlreadyExists", + "RiskCheckFailed", + "CreateQuoteFailed", + "ActivateQuoteFailed", + "NonsupportedAccountId", + "PaymentInstrumentNotFound", + "MissingAppliedScopesForSingle", + "NoValidReservationsToReRate", + "ReRateOnlyAllowedForEA", + "OperationCannotBePerformedInCurrentState", + "InvalidSingleAppliedScopesCount", + "InvalidFulfillmentRequestParameters", + "NotSupportedCountry", + "InvalidRefundQuantity", + "PurchaseError", + "BillingCustomerInputError", + "BillingPaymentInstrumentSoftError", + "BillingPaymentInstrumentHardError", + "BillingTransientError", + "BillingError", + "FulfillmentConfigurationError", + "FulfillmentOutOfStockError", + "FulfillmentTransientError", + "FulfillmentError", + "CalculatePriceFailed" + ], + "x-ms-enum": { + "name": "ErrorResponseCode", + "modelAsString": true + } + }, + "SkuName": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "Catalog": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource the SKU applies to.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of SKU", + "readOnly": true + }, + "terms": { + "type": "array", + "readOnly": true, + "description": "Available reservation terms for this resource", + "items": { + "$ref": "#/definitions/ReservationTerm" + } + }, + "locations": { + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "description": "The set of locations that the SKU is available. If not specified, the SKU is available in all locations." + } + }, + "skuProperties": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SkuProperty" + } + }, + "restrictions": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SkuRestriction" + } + } + } + }, + "SkuProperty": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "An invariant to describe the feature." + }, + "value": { + "type": "string", + "description": "An invariant if the feature is measured by quantity." + } + } + }, + "SkuRestriction": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of restrictions." + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted." + }, + "reasonCode": { + "type": "string", + "description": "The reason for restriction." + } + } + }, + "ReservationOrderResponse": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "etag": { + "type": "integer" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Identifier of the reservation" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the reservation" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReservationOrderProperties" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Type of resource. \"Microsoft.Capacity/reservations\"" + } + } + }, + "ReservationTerm": { + "type": "string", + "description": "Represent the term of Reservation.", + "enum": [ + "P1Y", + "P3Y" + ], + "x-ms-enum": { + "name": "ReservationTerm", + "modelAsString": true + } + }, + "ReservationOrderProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "Friendly name for user to easily identified the reservation." + }, + "requestDateTime": { + "type": "string", + "format": "date-time", + "description": "This is the DateTime when the reservation was initially requested for purchase." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "This is the DateTime when the reservation was created." + }, + "expiryDate": { + "type": "string", + "format": "date", + "description": "This is the date when the Reservation will expire." + }, + "originalQuantity": { + "type": "integer", + "format": "int32", + "description": "Total Quantity of the SKUs purchased in the Reservation." + }, + "term": { + "$ref": "#/definitions/ReservationTerm" + }, + "provisioningState": { + "type": "string", + "description": "Current state of the reservation." + }, + "reservations": { + "type": "array", + "items": { + "$ref": "#/definitions/ReservationResponse" + } + } + } + }, + "ReservationResponse": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "readOnly": true, + "description": "The Azure Region where the reserved resource lives." + }, + "etag": { + "type": "integer" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Identifier of the reservation" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the reservation" + }, + "sku": { + "$ref": "#/definitions/SkuName" + }, + "properties": { + "$ref": "#/definitions/ReservationProperties" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Type of resource. \"Microsoft.Capacity/reservationOrders/reservations\"" + } + } + }, + "ReservationProperties": { + "type": "object", + "properties": { + "reservedResourceType": { + "$ref": "#/definitions/ReservedResourceType" + }, + "instanceFlexibility": { + "$ref": "#/definitions/InstanceFlexibility" + }, + "displayName": { + "type": "string", + "description": "Friendly name for user to easily identify the reservation" + }, + "appliedScopes": { + "$ref": "#/definitions/AppliedScopes" + }, + "appliedScopeType": { + "$ref": "#/definitions/AppliedScopeType" + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "Quantity of the SKUs that are part of the Reservation." + }, + "provisioningState": { + "type": "string", + "description": "Current state of the reservation." + }, + "effectiveDateTime": { + "type": "string", + "format": "date-time", + "description": "DateTime of the Reservation starting when this version is effective from." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "DateTime of the last time the Reservation was updated.", + "readOnly": true + }, + "expiryDate": { + "type": "string", + "format": "date", + "description": "This is the date when the Reservation will expire." + }, + "skuDescription": { + "type": "string", + "description": "Description of the SKU in english." + }, + "extendedStatusInfo": { + "$ref": "#/definitions/ExtendedStatusInfo" + }, + "splitProperties": { + "$ref": "#/definitions/ReservationSplitProperties" + }, + "mergeProperties": { + "$ref": "#/definitions/ReservationMergeProperties" + } + } + }, + "ReservationSplitProperties": { + "type": "object", + "properties": { + "splitDestinations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of destination Resource Id that are created due to split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" + }, + "splitSource": { + "type": "string", + "description": "Resource Id of the Reservation from which this is split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" + } + } + }, + "ReservationMergeProperties": { + "type": "object", + "properties": { + "mergeDestination": { + "type": "string", + "description": "Reservation Resource Id Created due to the merge. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" + }, + "mergeSources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Resource Ids of the Source Reservation's merged to form this Reservation. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" + } + } + }, + "PatchProperties": { + "type": "object", + "properties": { + "appliedScopeType": { + "$ref": "#/definitions/AppliedScopeType" + }, + "appliedScopes": { + "$ref": "#/definitions/AppliedScopes" + }, + "instanceFlexibility": { + "$ref": "#/definitions/InstanceFlexibility" + } + } + }, + "SplitProperties": { + "type": "object", + "properties": { + "quantities": { + "type": "array", + "description": "List of the quantities in the new reservations to create.", + "items": { + "type": "integer", + "minItems": 2, + "maxItems": 2 + } + }, + "reservationId": { + "type": "string", + "description": "Resource id of the reservation to be split. Format of the resource id should be /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}" + } + } + }, + "MergeProperties": { + "type": "object", + "properties": { + "sources": { + "type": "array", + "description": "Format of the resource id should be /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}", + "items": { + "type": "string" + } + } + } + }, + "MergeRequest": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MergeProperties" + } + } + }, + "Patch": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PatchProperties" + } + } + }, + "SplitRequest": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SplitProperties" + } + } + }, + "Error": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ExtendedErrorInfo" + } + } + }, + "ExtendedErrorInfo": { + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/ErrorResponseCode" + }, + "message": { + "type": "string" + } + } + }, + "ExtendedStatusInfo": { + "type": "object", + "properties": { + "statusCode": { + "$ref": "#/definitions/ReservationStatusCode" + }, + "message": { + "type": "string", + "description": "The message giving detailed information about the status code." + } + } + }, + "ReservationOrderList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ReservationOrderResponse" + } + }, + "nextLink": { + "type": "string", + "description": "Url to get the next page of reservationOrders." + } + } + }, + "ReservationList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ReservationResponse" + } + }, + "nextLink": { + "type": "string", + "description": "Url to get the next page of reservations." + } + } + }, + "AppliedReservations": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifier of the applied reservations", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of resource", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of resource. \"Microsoft.Capacity/AppliedReservations\"", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AppliedReservationsProperties" + } + } + }, + "AppliedReservationsProperties": { + "type": "object", + "properties": { + "reservationOrderIds": { + "$ref": "#/definitions/AppliedReservationList" + } + } + }, + "AppliedReservationList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "type": "string", + "description": "Reservation resource Id. \"/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}\"" + } + }, + "nextLink": { + "type": "string", + "description": "Url to get the next page of reservations" + } + } + }, + "OperationList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OperationResponse" + } + }, + "nextLink": { + "type": "string", + "description": "Url to get the next page of items." + } + } + }, + "OperationResponse": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay" + }, + "origin": { + "type": "string" + } + } + }, + "OperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string" + }, + "resource": { + "type": "string" + }, + "operation": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "InstanceFlexibility": { + "type": "string", + "description": "Allows reservation discount to be applied across skus within the same AutofitGroup. Not all skus support instance size flexibility.", + "enum": [ + "On", + "Off", + "NotSupported" + ], + "x-ms-enum": { + "name": "InstanceFlexibility", + "modelAsString": true + } + }, + "AppliedScopeType": { + "type": "string", + "description": "Type of the Applied Scope.", + "enum": [ + "Single", + "Shared" + ], + "x-ms-enum": { + "name": "AppliedScopeType", + "modelAsString": true + } + }, + "AppliedScopes": { + "type": "array", + "description": "List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared.", + "items": { + "type": "string", + "minItems": 1, + "maxItems": 1 + } + }, + "ReservedResourceType": { + "type": "string", + "description": "The type of the resource that is being reserved.", + "enum": [ + "VirtualMachines", + "SqlDatabases", + "SuseLinux" + ], + "x-ms-enum": { + "name": "ReservedResourceType", + "modelAsString": true + } + } + }, + "parameters": { + "ReservationIdParameter": { + "name": "reservationId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the Reservation Item" + }, + "MergeParameter": { + "name": "body", + "x-ms-parameter-location": "method", + "in": "body", + "required": true, + "description": "Information needed for commercial request for a reservation", + "schema": { + "$ref": "#/definitions/MergeRequest" + } + }, + "PatchParameter": { + "name": "parameters", + "x-ms-parameter-location": "method", + "in": "body", + "required": true, + "description": "Information needed to patch a reservation item", + "schema": { + "$ref": "#/definitions/Patch" + } + }, + "SplitParameter": { + "name": "body", + "x-ms-parameter-location": "method", + "in": "body", + "required": true, + "description": "Information needed to Split a reservation item", + "schema": { + "$ref": "#/definitions/SplitRequest" + } + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Supported version.", + "required": true, + "type": "string" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the subscription" + }, + "ReservedResourceTypeIdParameter": { + "name": "reservedResourceType", + "x-ms-parameter-location": "method", + "in": "query", + "required": true, + "type": "string", + "description": "The type of the resource for which the skus should be provided." + }, + "LocationIdParameter": { + "name": "location", + "x-ms-parameter-location": "method", + "in": "query", + "required": false, + "type": "string", + "description": "Filters the skus based on the location specified in this parameter. This can be an azure region or global" + }, + "ReservationOrderIdParameter": { + "name": "reservationOrderId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Order Id of the reservation\n" + } + } +} \ No newline at end of file diff --git a/specification/reservations/resource-manager/readme.md b/specification/reservations/resource-manager/readme.md index 2bc47e5fe759..c9ac8a4c839b 100644 --- a/specification/reservations/resource-manager/readme.md +++ b/specification/reservations/resource-manager/readme.md @@ -26,9 +26,17 @@ These are the global settings for the Reservations API. ``` yaml openapi-type: arm -tag: package-2017-11 +tag: package-2018-06 ``` +### Tag: package-2018-06 + +These settings apply only when `--tag=package-2018-06` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06' +input-file: +- Microsoft.Capacity/preview/2018-06-01/reservations.json +``` ### Tag: package-2017-11 @@ -51,7 +59,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go ``` @@ -83,6 +91,7 @@ python: payload-flattening-threshold: 2 namespace: azure.mgmt.reservations package-name: azure-mgmt-reservations + package-version: 0.2.0 clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' @@ -112,9 +121,19 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-06 - tag: package-2017-11 ``` +### Tag: package-2018-06 and go + +These settings apply only when `--tag=package-2018-06 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2018-06' && $(go) +output-folder: $(go-sdk-folder)/services/reservations/mgmt/2018-06-01/reservations +``` + ### Tag: package-2017-11 and go These settings apply only when `--tag=package-2017-11 --go` is specified on the command line. @@ -131,11 +150,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.reservations +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-reservations +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-11 +``` + +### Tag: package-2017-11 and java + +These settings apply only when `--tag=package-2017-11 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-11' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.reservations - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-reservations + namespace: com.microsoft.azure.management.reservations.v2017_11_01 + output-folder: $(azure-libraries-for-java-folder)/reservations/resource-manager/v2017_11_01 +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/resourcehealth/resource-manager/readme.md b/specification/resourcehealth/resource-manager/readme.md index 9f751e8717c8..78d0b0498bca 100644 --- a/specification/resourcehealth/resource-manager/readme.md +++ b/specification/resourcehealth/resource-manager/readme.md @@ -110,11 +110,46 @@ 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 - fluent: true - namespace: com.microsoft.azure.management.resourcehealth - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-resourcehealth +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.resourcehealth +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-resourcehealth ``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-07 + - tag: package-2015-01 +``` + +### Tag: package-2017-07 and java + +These settings apply only when `--tag=package-2017-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.resourcehealth.v2017_07_01 + output-folder: $(azure-libraries-for-java-folder)/resourcehealth/resource-manager/v2017_07_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2015-01 and java + +These settings apply only when `--tag=package-2015-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.resourcehealth.v2015_01_01 + output-folder: $(azure-libraries-for-java-folder)/resourcehealth/resource-manager/v2015_01_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2015-01-01/locks.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2015-01-01/locks.json index 35c0aaabdea0..41a03445f654 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2015-01-01/locks.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2015-01-01/locks.json @@ -664,14 +664,14 @@ "in": "path", "required": true, "type": "string", - "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + "description": "The ID of the target subscription." }, "ApiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", - "description": "Client Api Version." + "description": "The API version to use for the operation." } } } diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createOrUpdatePolicyDefinition.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createOrUpdatePolicyDefinition.json new file mode 100644 index 000000000000..d4cf748440dd --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createOrUpdatePolicyDefinition.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "policyDefinitionName": "ResourceNaming", + "api-version": "2018-03-01", + "parameters": { + "properties": { + "displayName": "Enforce resource naming convention", + "description": "Force resource names to begin with given 'prefix' and/or end with given 'suffix'", + "metadata": { + "category": "Naming" + }, + "policyRule": { + "if": { + "not": { + "field": "name", + "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]" + } + }, + "then": { + "effect": "deny" + } + }, + "parameters": { + "prefix": { + "type": "String", + "metadata": { + "displayName": "Prefix", + "description": "Resource name prefix" + } + }, + "suffix": { + "type": "String", + "metadata": { + "displayName": "Suffix", + "description": "Resource name suffix" + } + } + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "type": "Microsoft.Authorization/policyDefinitions", + "name": "ResourceNaming", + "properties": { + "displayName": "Naming Convention", + "description": "Force resource names to begin with 'prefix' and end with 'suffix'", + "metadata": { + "category": "Naming" + }, + "policyRule": { + "if": { + "not": { + "field": "name", + "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]" + } + }, + "then": { + "effect": "deny" + } + }, + "parameters": { + "prefix": { + "type": "String", + "metadata": { + "displayName": "Prefix", + "description": "Resource name prefix" + } + }, + "suffix": { + "type": "String", + "metadata": { + "displayName": "Suffix", + "description": "Resource name suffix" + } + } + }, + "policyType": "Custom" + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createOrUpdatePolicyDefinitionAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createOrUpdatePolicyDefinitionAtManagementGroup.json new file mode 100644 index 000000000000..569cfbc1e754 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createOrUpdatePolicyDefinitionAtManagementGroup.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "managementGroupId": "MyManagementGroup", + "policyDefinitionName": "ResourceNaming", + "api-version": "2018-03-01", + "parameters": { + "properties": { + "displayName": "Enforce resource naming convention", + "description": "Force resource names to begin with given 'prefix' and/or end with given 'suffix'", + "metadata": { + "category": "Naming" + }, + "policyRule": { + "if": { + "not": { + "field": "name", + "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]" + } + }, + "then": { + "effect": "deny" + } + }, + "parameters": { + "prefix": { + "type": "String", + "metadata": { + "displayName": "Prefix", + "description": "Resource name prefix" + } + }, + "suffix": { + "type": "String", + "metadata": { + "displayName": "Suffix", + "description": "Resource name suffix" + } + } + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "type": "Microsoft.Authorization/policyDefinitions", + "name": "ResourceNaming", + "properties": { + "displayName": "Naming Convention", + "description": "Force resource names to begin with 'prefix' and end with 'suffix'", + "metadata": { + "category": "Naming" + }, + "policyRule": { + "if": { + "not": { + "field": "name", + "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]" + } + }, + "then": { + "effect": "deny" + } + }, + "parameters": { + "prefix": { + "type": "String", + "metadata": { + "displayName": "Prefix", + "description": "Resource name prefix" + } + }, + "suffix": { + "type": "String", + "metadata": { + "displayName": "Suffix", + "description": "Resource name suffix" + } + } + }, + "policyType": "Custom" + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createOrUpdatePolicySetDefinition.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createOrUpdatePolicySetDefinition.json new file mode 100644 index 000000000000..8d8d28305c31 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createOrUpdatePolicySetDefinition.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "policySetDefinitionName": "CostManagement", + "api-version": "2018-03-01", + "parameters": { + "properties": { + "displayName": "Cost Management", + "description": "Policies to enforce low cost storage SKUs", + "metadata": { + "category": "Cost Management" + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "parameters": { + "listOfAllowedSKUs": { + "value": [ + "Standard_GRS", + "Standard_LRS" + ] + } + } + }, + { + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "parameters": { + "prefix": { + "value": "DeptA" + }, + "suffix": { + "value": "-LC" + } + } + } + ] + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "type": "Microsoft.Authorization/policySetDefinitions", + "name": "CostManagement", + "properties": { + "displayName": "Cost Management", + "description": "Policies to enforce low cost storage SKUs", + "metadata": { + "category": "Cost Management" + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "parameters": { + "listOfAllowedSKUs": { + "value": [ + "Standard_GRS", + "Standard_LRS" + ] + } + } + }, + { + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "parameters": { + "prefix": { + "value": "DeptA" + }, + "suffix": { + "value": "-LC" + } + } + } + ] + } + } + }, + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "type": "Microsoft.Authorization/policySetDefinitions", + "name": "CostManagement", + "properties": { + "displayName": "Cost Management", + "description": "Policies to enforce low cost storage SKUs", + "metadata": { + "category": "Cost Management" + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "parameters": { + "listOfAllowedSKUs": { + "value": [ + "Standard_GRS", + "Standard_LRS" + ] + } + } + }, + { + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "parameters": { + "prefix": { + "value": "DeptA" + }, + "suffix": { + "value": "-LC" + } + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createOrUpdatePolicySetDefinitionAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createOrUpdatePolicySetDefinitionAtManagementGroup.json new file mode 100644 index 000000000000..f1bb3202d999 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createOrUpdatePolicySetDefinitionAtManagementGroup.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "managementGroupId": "MyManagementGroup", + "policySetDefinitionName": "CostManagement", + "api-version": "2018-03-01", + "parameters": { + "properties": { + "displayName": "Cost Management", + "description": "Policies to enforce low cost storage SKUs", + "metadata": { + "category": "Cost Management" + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "parameters": { + "listOfAllowedSKUs": { + "value": [ + "Standard_GRS", + "Standard_LRS" + ] + } + } + }, + { + "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "parameters": { + "prefix": { + "value": "DeptA" + }, + "suffix": { + "value": "-LC" + } + } + } + ] + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "type": "Microsoft.Authorization/policySetDefinitions", + "name": "CostManagement", + "properties": { + "displayName": "Cost Management", + "description": "Policies to enforce low cost storage SKUs", + "metadata": { + "category": "Cost Management" + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "parameters": { + "listOfAllowedSKUs": { + "value": [ + "Standard_GRS", + "Standard_LRS" + ] + } + } + }, + { + "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "parameters": { + "prefix": { + "value": "DeptA" + }, + "suffix": { + "value": "-LC" + } + } + } + ] + } + } + }, + "200": { + "headers": {}, + "body": { + "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "type": "Microsoft.Authorization/policySetDefinitions", + "name": "CostManagement", + "properties": { + "displayName": "Cost Management", + "description": "Policies to enforce low cost storage SKUs", + "metadata": { + "category": "Cost Management" + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "parameters": { + "listOfAllowedSKUs": { + "value": [ + "Standard_GRS", + "Standard_LRS" + ] + } + } + }, + { + "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "parameters": { + "prefix": { + "value": "DeptA" + }, + "suffix": { + "value": "-LC" + } + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createPolicyAssignment.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createPolicyAssignment.json new file mode 100644 index 000000000000..91d787d65e81 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createPolicyAssignment.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "scope": "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "policyAssignmentName": "EnforceNaming", + "api-version": "2018-03-01", + "parameters": { + "properties": { + "displayName": "Enforce resource naming rules", + "description": "Force resource names to begin with given DeptA and end with -LC", + "metadata": { + "assignedBy": "Special Someone" + }, + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "parameters": { + "prefix": { "value": "DeptA" }, + "suffix": { "value": "-LC" } + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "properties": { + "displayName": "Enforce resource naming rules", + "description": "Force resource names to begin with given DeptA and end with -LC", + "metadata": { + "assignedBy": "Special Someone" + }, + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "notScopes": [], + "parameters": { + "prefix": { "value": "DeptA" }, + "suffix": { "value": "-LC" } + }, + "scope": "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2" + }, + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming", + "type": "Microsoft.Authorization/policyAssignments", + "name": "EnforceNaming" + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createPolicyAssignmentById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createPolicyAssignmentById.json new file mode 100644 index 000000000000..95e2ddebc025 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/createPolicyAssignmentById.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "policyAssignmentId": "providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage", + "api-version": "2018-03-01", + "parameters": { + "properties": { + "displayName": "Enforce storage account SKU", + "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created", + "metadata": { + "assignedBy": "Cheapskate Boss" + }, + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "parameters": { + "listOfAllowedSKUs": { + "value": [ + "Standard_GRS", + "Standard_LRS" + ] + } + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "properties": { + "displayName": "Enforce storage account SKU", + "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created", + "metadata": { + "assignedBy": "Cheapskate Boss" + }, + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "notScopes": [], + "parameters": { + "listOfAllowedSKUs": { + "value": [ + "Standard_GRS", + "Standard_LRS" + ] + } + } + }, + "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage", + "type": "Microsoft.Authorization/policyAssignments", + "name": "LowCostStorage" + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicyAssignment.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicyAssignment.json new file mode 100644 index 000000000000..e059b25b8667 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicyAssignment.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "scope": "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "policyAssignmentName": "EnforceNaming", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "displayName": "Enforce resource naming rules", + "description": "Force resource names to begin with given DeptA and end with -LC", + "metadata": { + "assignedBy": "Special Someone" + }, + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "notScopes": [], + "parameters": { + "prefix": { "value": "DeptA" }, + "suffix": { "value": "-LC" } + }, + "scope": "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2" + }, + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming", + "type": "Microsoft.Authorization/policyAssignments", + "name": "EnforceNaming" + } + }, + "204": { + "headers": {} + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicyAssignmentById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicyAssignmentById.json new file mode 100644 index 000000000000..80993c98c999 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicyAssignmentById.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "policyAssignmentId": "providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "displayName": "Enforce storage account SKU", + "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created", + "metadata": { + "assignedBy": "Cheapskate Boss" + }, + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "notScopes": [], + "parameters": { + "listOfAllowedSKUs": { + "value": [ + "Standard_GRS", + "Standard_LRS" + ] + } + } + }, + "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage", + "type": "Microsoft.Authorization/policyAssignments", + "name": "LowCostStorage" + } + }, + "204": { + "headers": {} + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicyDefinition.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicyDefinition.json new file mode 100644 index 000000000000..b949bea56dd4 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicyDefinition.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "policyDefinitionName": "ResourceNaming", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {} + }, + "204": { + "headers": {} + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicyDefinitionAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicyDefinitionAtManagementGroup.json new file mode 100644 index 000000000000..f97165d04d4a --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicyDefinitionAtManagementGroup.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "managementGroupId": "MyManagementGroup", + "policyDefinitionName": "ResourceNaming", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {} + }, + "204": { + "headers": {} + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicySetDefinition.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicySetDefinition.json new file mode 100644 index 000000000000..5b1bb6b6683e --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicySetDefinition.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "policySetDefinitionName": "CostManagement", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {} + }, + "204": { + "headers": {} + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicySetDefinitionAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicySetDefinitionAtManagementGroup.json new file mode 100644 index 000000000000..9d6faced3ace --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/deletePolicySetDefinitionAtManagementGroup.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "managementGroupId": "MyManagementGroup", + "policySetDefinitionName": "CostManagement", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {} + }, + "204": { + "headers": {} + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getBuiltInPolicySetDefinition.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getBuiltInPolicySetDefinition.json new file mode 100644 index 000000000000..d96fc2fbc180 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getBuiltInPolicySetDefinition.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "displayName": "[Preview]: Enable Monitoring in Azure Security Center", + "policyType": "BuiltIn", + "description": "Monitor all the available security recommendations in Azure Security Center. This is the default policy for Azure Security Center.", + "metadata": { + "category": "Security Center" + }, + "parameters": {}, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/760a85ff-6162-42b3-8d70-698e268f648c" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/9daedab3-fb2d-461e-b861-71790eead4f6" + } + ] + }, + "id": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "type": "Microsoft.Authorization/policySetDefinitions", + "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8" + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getBuiltinPolicyDefinition.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getBuiltinPolicyDefinition.json new file mode 100644 index 000000000000..f3c5fb44513e --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getBuiltinPolicyDefinition.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "policyDefinitionName": "7433c107-6db4-4ad1-b57a-a76dce0154a1", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "displayName": "Allowed storage account SKUs", + "policyType": "BuiltIn", + "description": "This policy enables you to specify a set of storage account SKUs that your organization can deploy.", + "parameters": { + "listOfAllowedSKUs": { + "type": "Array", + "metadata": { + "description": "The list of SKUs that can be specified for storage accounts.", + "displayName": "Allowed SKUs", + "strongType": "StorageSKUs" + } + } + }, + "policyRule": { + "if": { + "allOf": [ + { + "field": "type", + "equals": "Microsoft.Storage/storageAccounts" + }, + { + "not": { + "field": "Microsoft.Storage/storageAccounts/sku.name", + "in": "[parameters('listOfAllowedSKUs')]" + } + } + ] + }, + "then": { + "effect": "Deny" + } + } + }, + "id": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "type": "Microsoft.Authorization/policyDefinitions", + "name": "7433c107-6db4-4ad1-b57a-a76dce0154a1" + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicyAssignment.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicyAssignment.json new file mode 100644 index 000000000000..cc41dbe14d1d --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicyAssignment.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "scope": "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "policyAssignmentName": "EnforceNaming", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "displayName": "Enforce resource naming rules", + "description": "Force resource names to begin with given DeptA and end with -LC", + "metadata": { + "assignedBy": "Special Someone" + }, + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "notScopes": [], + "parameters": { + "prefix": { "value": "DeptA" }, + "suffix": { "value": "-LC" } + }, + "scope": "subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2" + }, + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/EnforceNaming", + "type": "Microsoft.Authorization/policyAssignments", + "name": "EnforceNaming" + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicyAssignmentById.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicyAssignmentById.json new file mode 100644 index 000000000000..b467541ba0ea --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicyAssignmentById.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "policyAssignmentId": "providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "displayName": "Enforce storage account SKU", + "description": "Allow only storage accounts of SKU Standard_GRS or Standard_LRS to be created", + "metadata": { + "assignedBy": "Cheapskate Boss" + }, + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "notScopes": [], + "parameters": { + "listOfAllowedSKUs": { + "value": [ + "Standard_GRS", + "Standard_LRS" + ] + } + } + }, + "id": "/providers/Microsoft.Management/managementGroups/MyManagementGroup/providers/Microsoft.Authorization/policyAssignments/LowCostStorage", + "type": "Microsoft.Authorization/policyAssignments", + "name": "LowCostStorage" + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicyDefinition.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicyDefinition.json new file mode 100644 index 000000000000..3b8b9a17a9d4 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicyDefinition.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "policyDefinitionName": "ResourceNaming", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "displayName": "Naming Convention", + "description": "Force resource names to begin with 'prefix' and end with 'suffix'", + "metadata": { + "category": "Naming" + }, + "policyRule": { + "if": { + "not": { + "field": "name", + "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]" + } + }, + "then": { + "effect": "deny" + } + }, + "parameters": { + "prefix": { + "type": "String", + "metadata": { + "displayName": "Prefix", + "description": "Resource name prefix" + } + }, + "suffix": { + "type": "String", + "metadata": { + "displayName": "Suffix", + "description": "Resource name suffix" + } + } + }, + "policyType": "Custom" + }, + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "type": "Microsoft.Authorization/policyDefinitions", + "name": "ResourceNaming" + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicyDefinitionAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicyDefinitionAtManagementGroup.json new file mode 100644 index 000000000000..9ab52b934d89 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicyDefinitionAtManagementGroup.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "managementGroupId": "MyManagementGroup", + "policyDefinitionName": "ResourceNaming", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "type": "Microsoft.Authorization/policyDefinitions", + "name": "ResourceNaming", + "properties": { + "displayName": "Naming Convention", + "description": "Force resource names to begin with 'prefix' and end with 'suffix'", + "metadata": { + "category": "Naming" + }, + "policyRule": { + "if": { + "not": { + "field": "name", + "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]" + } + }, + "then": { + "effect": "deny" + } + }, + "parameters": { + "prefix": { + "type": "String", + "metadata": { + "displayName": "Prefix", + "description": "Resource name prefix" + } + }, + "suffix": { + "type": "String", + "metadata": { + "displayName": "Suffix", + "description": "Resource name suffix" + } + } + }, + "policyType": "Custom" + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicySetDefinition.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicySetDefinition.json new file mode 100644 index 000000000000..9a4b0446fa19 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicySetDefinition.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "policySetDefinitionName": "CostManagement", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "type": "Microsoft.Authorization/policySetDefinitions", + "name": "CostManagement", + "properties": { + "displayName": "Cost Management", + "description": "Policies to enforce low cost storage SKUs", + "metadata": { + "category": "Cost Management" + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "parameters": { + "listOfAllowedSKUs": { + "value": [ + "Standard_GRS", + "Standard_LRS" + ] + } + } + }, + { + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "parameters": { + "prefix": { + "value": "DeptA" + }, + "suffix": { + "value": "-LC" + } + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicySetDefinitionAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicySetDefinitionAtManagementGroup.json new file mode 100644 index 000000000000..e772c0e34134 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/getPolicySetDefinitionAtManagementGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "managementGroupId": "MyManagementGroup", + "policySetDefinitionName": "CostManagement", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "type": "Microsoft.Authorization/policySetDefinitions", + "name": "CostManagement", + "properties": { + "displayName": "Cost Management", + "description": "Policies to enforce low cost storage SKUs", + "metadata": { + "category": "Cost Management" + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "parameters": { + "listOfAllowedSKUs": { + "value": [ + "Standard_GRS", + "Standard_LRS" + ] + } + } + }, + { + "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "parameters": { + "prefix": { + "value": "DeptA" + }, + "suffix": { + "value": "-LC" + } + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listBuiltInPolicyDefinitions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listBuiltInPolicyDefinitions.json new file mode 100644 index 000000000000..1fa40eeab202 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listBuiltInPolicyDefinitions.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "displayName": "Audit SQL DB Level Audit Setting", + "policyType": "BuiltIn", + "mode": "All", + "description": "Audit DB level audit setting for SQL databases", + "parameters": { + "setting": { + "type": "String", + "metadata": { + "displayName": "Audit Setting" + }, + "allowedValues": [ + "enabled", + "disabled" + ] + } + }, + "policyRule": { + "if": { + "field": "type", + "equals": "Microsoft.Sql/servers/databases" + }, + "then": { + "effect": "AuditIfNotExists", + "details": { + "type": "Microsoft.Sql/servers/databases/auditingSettings", + "name": "default", + "existenceCondition": { + "allOf": [ + { + "field": "Microsoft.Sql/auditingSettings.state", + "equals": "[parameters('setting')]" + } + ] + } + } + } + } + }, + "id": "/providers/Microsoft.Authorization/policyDefinitions/06a78e20-9358-41c9-923c-fb736d382a12", + "type": "Microsoft.Authorization/policyDefinitions", + "name": "06a78e20-9358-41c9-923c-fb736d382a12" + }, + { + "properties": { + "displayName": "Allowed storage account SKUs", + "policyType": "BuiltIn", + "description": "This policy enables you to specify a set of storage account SKUs that your organization can deploy.", + "parameters": { + "listOfAllowedSKUs": { + "type": "Array", + "metadata": { + "description": "The list of SKUs that can be specified for storage accounts.", + "displayName": "Allowed SKUs", + "strongType": "StorageSKUs" + } + } + }, + "policyRule": { + "if": { + "allOf": [ + { + "field": "type", + "equals": "Microsoft.Storage/storageAccounts" + }, + { + "not": { + "field": "Microsoft.Storage/storageAccounts/sku.name", + "in": "[parameters('listOfAllowedSKUs')]" + } + } + ] + }, + "then": { + "effect": "Deny" + } + } + }, + "id": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "type": "Microsoft.Authorization/policyDefinitions", + "name": "7433c107-6db4-4ad1-b57a-a76dce0154a1" + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listBuiltInPolicySetDefinitions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listBuiltInPolicySetDefinitions.json new file mode 100644 index 000000000000..2342b6d79569 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listBuiltInPolicySetDefinitions.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "displayName": "[Preview]: Enable Monitoring in Azure Security Center", + "policyType": "BuiltIn", + "description": "Monitor all the available security recommendations in Azure Security Center. This is the default policy for Azure Security Center.", + "metadata": { + "category": "Security Center" + }, + "parameters": {}, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/760a85ff-6162-42b3-8d70-698e268f648c" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/9daedab3-fb2d-461e-b861-71790eead4f6" + } + ] + }, + "id": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "type": "Microsoft.Authorization/policySetDefinitions", + "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyAssignments.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyAssignments.json new file mode 100644 index 000000000000..a89b04239ade --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyAssignments.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "api-version": "2018-03-01", + "$filter": "atScope()" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/CostManagement", + "type": "Microsoft.Authorization/policyAssignments", + "name": "CostManagement", + "properties": { + "displayName": "Storage Cost Management", + "description": "Minimize the risk of accidental cost overruns", + "metadata": { + "category": "Cost Management" + }, + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/storageSkus", + "parameters": { "allowedSkus": { "type": "Array" } }, + "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "notScopes": [] + }, + "sku": { + "name": "A0", + "tier": "Free" + } + }, + { + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyAssignments/TagEnforcement", + "type": "Microsoft.Authorization/policyAssignments", + "name": "TagEnforcement", + "properties": { + "displayName": "Enforces a tag key and value", + "description": "Ensure a given tag key and value are present on all resources", + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue", + "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "notScopes": [] + }, + "sku": { + "name": "A0", + "tier": "Free" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyAssignmentsForResource.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyAssignmentsForResource.json new file mode 100644 index 000000000000..b51387648cd7 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyAssignmentsForResource.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "resourceGroupName": "TestResourceGroup", + "resourceProviderNamespace": "Microsoft.Compute", + "parentResourcePath": "virtualMachines/MyTestVm", + "resourceType": "domainNames", + "resourceName": "MyTestComputer.cloudapp.net", + "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyAssignments/TestCostManagement", + "type": "Microsoft.Authorization/policyAssignments", + "name": "TestCostManagement", + "properties": { + "displayName": "VM Cost Management", + "description": "Minimize the risk of accidental cost overruns", + "metadata": { + "category": "Cost Management" + }, + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/vmSkus", + "parameters": { "allowedSkus": { "type": "Array" } }, + "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup", + "notScopes": [] + }, + "sku": { + "name": "A0", + "tier": "Free" + } + }, + { + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyAssignments/TestTagEnforcement", + "type": "Microsoft.Authorization/policyAssignments", + "name": "TestTagEnforcement", + "properties": { + "displayName": "Enforces a tag key and value", + "description": "Ensure a given tag key and value are present on all resources", + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue", + "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup", + "notScopes": [] + }, + "sku": { + "name": "A0", + "tier": "Free" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyAssignmentsForResourceGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyAssignmentsForResourceGroup.json new file mode 100644 index 000000000000..610313d66d3e --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyAssignmentsForResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceGroupName": "TestResourceGroup", + "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "api-version": "2018-03-01", + "$filter": "atScope()" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyAssignments/TestCostManagement", + "type": "Microsoft.Authorization/policyAssignments", + "name": "TestCostManagement", + "properties": { + "displayName": "Storage Cost Management", + "description": "Minimize the risk of accidental cost overruns", + "metadata": { + "category": "Cost Management" + }, + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/storageSkus", + "parameters": { "allowedSkus": { "type": "Array" } }, + "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup", + "notScopes": [] + }, + "sku": { + "name": "A0", + "tier": "Free" + } + }, + { + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup/providers/Microsoft.Authorization/policyAssignments/TestTagEnforcement", + "type": "Microsoft.Authorization/policyAssignments", + "name": "TestTagEnforcement", + "properties": { + "displayName": "Enforces a tag key and value", + "description": "Ensure a given tag key and value are present on all resources", + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/TagKeyValue", + "scope": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/resourceGroups/TestResourceGroup", + "notScopes": [] + }, + "sku": { + "name": "A0", + "tier": "Free" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyDefinitions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyDefinitions.json new file mode 100644 index 000000000000..107c84205f65 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyDefinitions.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "displayName": "Allowed storage account SKUs", + "policyType": "BuiltIn", + "description": "This policy enables you to specify a set of storage account SKUs that your organization can deploy.", + "parameters": { + "listOfAllowedSKUs": { + "type": "Array", + "metadata": { + "description": "The list of SKUs that can be specified for storage accounts.", + "displayName": "Allowed SKUs", + "strongType": "StorageSKUs" + } + } + }, + "policyRule": { + "if": { + "allOf": [ + { + "field": "type", + "equals": "Microsoft.Storage/storageAccounts" + }, + { + "not": { + "field": "Microsoft.Storage/storageAccounts/sku.name", + "in": "[parameters('listOfAllowedSKUs')]" + } + } + ] + }, + "then": { + "effect": "Deny" + } + } + }, + "id": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "type": "Microsoft.Authorization/policyDefinitions", + "name": "7433c107-6db4-4ad1-b57a-a76dce0154a1" + }, + { + "properties": { + "displayName": "Naming Convention", + "description": "Force resource names to begin with 'prefix' and end with 'suffix'", + "metadata": { + "category": "Naming" + }, + "parameters": { + "prefix": { + "type": "String", + "metadata": { + "displayName": "Prefix", + "description": "Resource name prefix" + } + }, + "suffix": { + "type": "String", + "metadata": { + "displayName": "Suffix", + "description": "Resource name suffix" + } + } + }, + "policyRule": { + "if": { + "not": { + "field": "name", + "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]" + } + }, + "then": { + "effect": "deny" + } + }, + "policyType": "Custom" + }, + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "type": "Microsoft.Authorization/policyDefinitions", + "name": "ResourceNaming" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyDefinitionsByManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyDefinitionsByManagementGroup.json new file mode 100644 index 000000000000..11047a850cdc --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicyDefinitionsByManagementGroup.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "managementGroupId": "MyManagementGroup", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "displayName": "Allowed storage account SKUs", + "policyType": "BuiltIn", + "description": "This policy enables you to specify a set of storage account SKUs that your organization can deploy.", + "parameters": { + "listOfAllowedSKUs": { + "type": "Array", + "metadata": { + "description": "The list of SKUs that can be specified for storage accounts.", + "displayName": "Allowed SKUs", + "strongType": "StorageSKUs" + } + } + }, + "policyRule": { + "if": { + "allOf": [ + { + "field": "type", + "equals": "Microsoft.Storage/storageAccounts" + }, + { + "not": { + "field": "Microsoft.Storage/storageAccounts/sku.name", + "in": "[parameters('listOfAllowedSKUs')]" + } + } + ] + }, + "then": { + "effect": "Deny" + } + } + }, + "id": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "type": "Microsoft.Authorization/policyDefinitions", + "name": "7433c107-6db4-4ad1-b57a-a76dce0154a1" + }, + { + "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "type": "Microsoft.Authorization/policyDefinitions", + "name": "ResourceNaming", + "properties": { + "displayName": "Naming Convention", + "description": "Force resource names to begin with 'prefix' and end with 'suffix'", + "metadata": { + "category": "Naming" + }, + "policyRule": { + "if": { + "not": { + "field": "name", + "like": "[concat(parameters('prefix'), '*', parameters('suffix'))]" + } + }, + "then": { + "effect": "deny" + } + }, + "parameters": { + "prefix": { + "type": "String", + "metadata": { + "displayName": "Prefix", + "description": "Resource name prefix" + } + }, + "suffix": { + "type": "String", + "metadata": { + "displayName": "Suffix", + "description": "Resource name suffix" + } + } + }, + "policyType": "Custom" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicySetDefinitions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicySetDefinitions.json new file mode 100644 index 000000000000..5ae10d030492 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicySetDefinitions.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "ae640e6b-ba3e-4256-9d62-2993eecfa6f2", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "displayName": "[Preview]: Enable Monitoring in Azure Security Center", + "policyType": "BuiltIn", + "description": "Monitor all the available security recommendations in Azure Security Center. This is the default policy for Azure Security Center.", + "metadata": { + "category": "Security Center" + }, + "parameters": {}, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/760a85ff-6162-42b3-8d70-698e268f648c" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/9daedab3-fb2d-461e-b861-71790eead4f6" + } + ] + }, + "id": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "type": "Microsoft.Authorization/policySetDefinitions", + "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8" + }, + { + "id": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "type": "Microsoft.Authorization/policySetDefinitions", + "name": "CostManagement", + "properties": { + "displayName": "Cost Management", + "description": "Policies to enforce low cost storage SKUs", + "metadata": { + "category": "Cost Management" + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "parameters": { + "listOfAllowedSKUs": { + "value": [ + "Standard_GRS", + "Standard_LRS" + ] + } + } + }, + { + "policyDefinitionId": "/subscriptions/ae640e6b-ba3e-4256-9d62-2993eecfa6f2/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "parameters": { + "prefix": { + "value": "DeptA" + }, + "suffix": { + "value": "-LC" + } + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicySetDefinitionsByManagementGroup.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicySetDefinitionsByManagementGroup.json new file mode 100644 index 000000000000..42301ff37ed6 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/examples/listPolicySetDefinitionsByManagementGroup.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "managementGroupId": "MyManagementGroup", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "displayName": "[Preview]: Enable Monitoring in Azure Security Center", + "policyType": "BuiltIn", + "description": "Monitor all the available security recommendations in Azure Security Center. This is the default policy for Azure Security Center.", + "metadata": { + "category": "Security Center" + }, + "parameters": {}, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/a8bef009-a5c9-4d0f-90d7-6018734e8a16" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af8051bf-258b-44e2-a2bf-165330459f9d" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/86b3d65f-7626-441e-b690-81a8b71cff60" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/b0f33259-77d7-4c9e-aac6-3aabcfae693c" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/47a6b606-51aa-4496-8bb7-64b11cf66adc" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/e1e5fd5d-3e4c-4ce1-8661-7d1873ae6b15" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/af6cd1bd-1635-48cb-bde7-5b15693900b9" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/0961003e-5a0a-4549-abde-af6a37f2724d" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/760a85ff-6162-42b3-8d70-698e268f648c" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6" + }, + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/9daedab3-fb2d-461e-b861-71790eead4f6" + } + ] + }, + "id": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "type": "Microsoft.Authorization/policySetDefinitions", + "name": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8" + }, + { + "id": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/CostManagement", + "type": "Microsoft.Authorization/policySetDefinitions", + "name": "CostManagement", + "properties": { + "displayName": "Cost Management", + "description": "Policies to enforce low cost storage SKUs", + "metadata": { + "category": "Cost Management" + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "parameters": { + "listOfAllowedSKUs": { + "value": [ + "Standard_GRS", + "Standard_LRS" + ] + } + } + }, + { + "policyDefinitionId": "/providers/Microsoft.Management/managementgroups/MyManagementGroup/providers/Microsoft.Authorization/policyDefinitions/ResourceNaming", + "parameters": { + "prefix": { + "value": "DeptA" + }, + "suffix": { + "value": "-LC" + } + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policyAssignments.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policyAssignments.json new file mode 100644 index 000000000000..3c0f48fd9c84 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policyAssignments.json @@ -0,0 +1,656 @@ +{ + "swagger": "2.0", + "info": { + "title": "PolicyClient", + "version": "2018-03-01", + "description": "To manage and control access to your resources, you can define customized policies and assign them at a scope." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}": { + "delete": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_Delete", + "summary": "Deletes a policy assignment.", + "description": "This operation deletes a policy assignment, given its name and the scope it was created in. The scope of a policy assignment is the part of its ID preceding '/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.", + "x-ms-examples": { + "Delete a policy assignment": { + "$ref": "./examples/deletePolicyAssignment.json" + } + }, + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the policy assignment. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'", + "x-ms-skip-url-encoding": true + }, + { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy assignment to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deleted assignment.", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + }, + "204": { + "description": "No Content - the policy assignment doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_Create", + "summary": "Creates or updates a policy assignment.", + "description": " This operation creates or updates a policy assignment with the given scope and name. Policy assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.", + "x-ms-examples": { + "Create or update a policy assignment": { + "$ref": "./examples/createPolicyAssignment.json" + } + }, + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the policy assignment. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'", + "x-ms-skip-url-encoding": true + }, + { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyAssignment" + }, + "description": "Parameters for the policy assignment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the new policy assignment.", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_Get", + "summary": "Retrieves a policy assignment.", + "description": "This operation retrieves a single policy assignment, given its name and the scope it was created at.", + "x-ms-examples": { + "Retrieve a policy assignment": { + "$ref": "./examples/getPolicyAssignment.json" + } + }, + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the policy assignment. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'", + "x-ms-skip-url-encoding": true + }, + { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy assignment to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the policy assignment.", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_ListForResourceGroup", + "summary": "Retrieves all policy assignments that apply to a resource group.", + "description": "This operation retrieves the list of all policy assignments associated with the given resource group in the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy assignments associated with the resource group, including those that apply directly or apply from containing scopes, as well as any applied to resources contained within the resource group. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the resource group, which is everything in the unfiltered list except those applied to resources contained within the resource group. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes only policy assignments that apply to the resource group and assign the policy definition whose id is {value}.", + "x-ms-examples": { + "List policy assignments that apply to a resource group": { + "$ref": "./examples/listPolicyAssignmentsForResourceGroup.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group that contains policy assignments.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Valid values for $filter are: 'atScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, no filtering is performed.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of policy assignments.", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_ListForResource", + "summary": "Retrieves all policy assignments that apply to a resource.", + "description": "This operation retrieves the list of all policy assignments associated with the specified resource in the given resource group and subscription that match the optional given $filter. Valid values for $filter are: 'atScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy assignments associated with the resource, including those that apply directly or from all containing scopes, as well as any applied to resources contained within the resource. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the resource, which is everything in the unfiltered list except those applied to resources contained within the resource. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes only policy assignments that apply to the resource and assign the policy definition whose id is {value}. Three parameters plus the resource name are used to identify a specific resource. If the resource is not part of a parent resource (the more common case), the parent resource path should not be provided (or provided as ''). For example a web app could be specified as ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp'). If the resource is part of a parent resource, then all parameters should be provided. For example a virtual machine DNS name could be specified as ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName'). A convenient alternative to providing the namespace and type name separately is to provide both in the {resourceType} parameter, format: ({resourceProviderNamespace} == '', {parentResourcePath} == '', {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp').", + "deprecated": false, + "x-ms-examples": { + "List all policy assignments that apply to a resource": { + "$ref": "./examples/listPolicyAssignmentsForResource.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the resource.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider. For example, the namespace of a virtual machine is Microsoft.Compute (from Microsoft.Compute/virtualMachines)" + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "The parent resource path. Use empty string if there is none.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "The resource type name. For example the type name of a web app is 'sites' (from Microsoft.Web/sites).", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Valid values for $filter are: 'atScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, no filtering is performed." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of policy assignments.", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/PolicyAssignment" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_List", + "summary": "Retrieves all policy assignments that apply to a subscription.", + "description": "This operation retrieves the list of all policy assignments associated with the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy assignments associated with the subscription, including those that apply directly or from management groups that contain the given subscription, as well as any applied to objects contained within the subscription. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the subscription, which is everything in the unfiltered list except those applied to objects contained within the subscription. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes only policy assignments that apply to the subscription and assign the policy definition whose id is {value}.", + "x-ms-examples": { + "List policy assignments that apply to a subscription": { + "$ref": "./examples/listPolicyAssignments.json" + } + }, + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Valid values for $filter are: 'atScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, no filtering is performed." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of policy assignments.", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/PolicyAssignment" + } + }, + "/{policyAssignmentId}": { + "delete": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_DeleteById", + "summary": "Deletes a policy assignment.", + "description": "This operation deletes the policy with the given ID. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid formats for {scope} are: '/providers/Microsoft.Management/managementGroups/{managementGroup}' (management group), '/subscriptions/{subscriptionId}' (subscription), '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' (resource group), or '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' (resource).", + "x-ms-examples": { + "Delete a policy assignment by ID": { + "$ref": "./examples/deletePolicyAssignmentById.json" + } + }, + "parameters": [ + { + "name": "policyAssignmentId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the policy assignment to delete. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the policy assignment.", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + }, + "204": { + "description": "No Content - the policy assignment doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_CreateById", + "summary": "Creates or updates a policy assignment.", + "description": "This operation creates or updates the policy assignment with the given ID. Policy assignments made on a scope apply to all resources contained in that scope. For example, when you assign a policy to a resource group that policy applies to all resources in the group. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.", + "x-ms-examples": { + "Create or update policy assignment by ID": { + "$ref": "./examples/createPolicyAssignmentById.json" + } + }, + "parameters": [ + { + "name": "policyAssignmentId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the policy assignment to create. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.", + "x-ms-skip-url-encoding": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyAssignment" + }, + "description": "Parameters for policy assignment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the policy assignment.", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_GetById", + "summary": "Retrieves the policy assignment with the given ID.", + "description": "The operation retrieves the policy assignment with the given ID. Policy assignment IDs have this format: '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'.", + "x-ms-examples": { + "Retrieve a policy assignment by ID": { + "$ref": "./examples/getPolicyAssignmentById.json" + } + }, + "parameters": [ + { + "name": "policyAssignmentId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the policy assignment to get. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the policy assignment.", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "PolicyAssignmentProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "The display name of the policy assignment." + }, + "policyDefinitionId": { + "type": "string", + "description": "The ID of the policy definition or policy set definition being assigned." + }, + "scope": { + "type": "string", + "description": "The scope for the policy assignment." + }, + "notScopes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The policy's excluded scopes." + }, + "parameters": { + "type": "object", + "description": "Required if a parameter is used in policy rule." + }, + "description": { + "type": "string", + "description": "This message will be part of response in case of policy violation." + }, + "metadata": { + "type": "object", + "description": "The policy assignment metadata." + } + }, + "description": "The policy assignment properties." + }, + "PolicySku": { + "properties": { + "name": { + "type": "string", + "description": "The name of the policy sku. Possible values are A0 and A1." + }, + "tier": { + "type": "string", + "description": "The policy sku tier. Possible values are Free and Standard." + } + }, + "required": [ + "name" + ], + "description": "The policy sku. This property is optional, obsolete, and will be ignored." + }, + "PolicyAssignment": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PolicyAssignmentProperties", + "description": "Properties for the policy assignment." + }, + "id": { + "type": "string", + "description": "The ID of the policy assignment.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the policy assignment.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the policy assignment.", + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/PolicySku", + "description": "The policy sku. This property is optional, obsolete, and will be ignored." + } + }, + "description": "The policy assignment.", + "x-ms-azure-resource": true + }, + "PolicyAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyAssignment" + }, + "description": "An array of policy assignments." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of policy assignments." + }, + "ErrorResponse": { + "description": "Error reponse indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "httpStatus": { + "description": "Http status code.", + "type": "string" + }, + "errorCode": { + "description": "Error code.", + "type": "string" + }, + "errorMessage": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the operation." + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policyDefinitions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policyDefinitions.json new file mode 100644 index 000000000000..3c6b36b518fc --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policyDefinitions.json @@ -0,0 +1,529 @@ +{ + "swagger": "2.0", + "info": { + "title": "PolicyClient", + "version": "2018-03-01", + "description": "To manage and control access to your resources, you can define customized policies and assign them at a scope." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}": { + "put": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_CreateOrUpdate", + "summary": "Creates or updates a policy definition in a subscription.", + "description": "This operation creates or updates a policy definition in the given subscription with the given name.", + "x-ms-examples": { + "Create or update a policy definition": { + "$ref": "./examples/createOrUpdatePolicyDefinition.json" + } + }, + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy definition to create." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyDefinition" + }, + "description": "The policy definition properties." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the policy definition.", + "schema": { + "$ref": "#/definitions/PolicyDefinition" + } + } + } + }, + "delete": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_Delete", + "summary": "Deletes a policy definition in a subscription.", + "description": "This operation deletes the policy definition in the given subscription with the given name.", + "x-ms-examples": { + "Delete a policy definition": { + "$ref": "./examples/deletePolicyDefinition.json" + } + }, + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy definition to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "200": { + "description": "OK" + } + } + }, + "get": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_Get", + "summary": "Retrieves a policy definition in a subscription.", + "description": "This operation retrieves the policy definition in the given subscription with the given name.", + "x-ms-examples": { + "Retrieve a policy definition": { + "$ref": "./examples/getPolicyDefinition.json" + } + }, + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy definition to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the policy definition.", + "schema": { + "$ref": "#/definitions/PolicyDefinition" + } + } + } + } + }, + "/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}": { + "get": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_GetBuiltIn", + "summary": "Retrieves a built-in policy definition.", + "description": "This operation retrieves the built-in policy definition with the given name.", + "x-ms-examples": { + "Retrieve a built-in policy definition": { + "$ref": "./examples/getBuiltinPolicyDefinition.json" + } + }, + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the built-in policy definition to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the built-in policy definition.", + "schema": { + "$ref": "#/definitions/PolicyDefinition" + } + } + } + } + }, + "/providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions/{policyDefinitionName}": { + "put": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_CreateOrUpdateAtManagementGroup", + "summary": "Creates or updates a policy definition in a management group.", + "description": "This operation creates or updates a policy definition in the given management group with the given name.", + "x-ms-examples": { + "Create or update a policy definition at management group level": { + "$ref": "./examples/createOrUpdatePolicyDefinitionAtManagementGroup.json" + } + }, + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy definition to create." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyDefinition" + }, + "description": "The policy definition properties." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagementGroupIdParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the policy definition.", + "schema": { + "$ref": "#/definitions/PolicyDefinition" + } + } + } + }, + "delete": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_DeleteAtManagementGroup", + "summary": "Deletes a policy definition in a management group.", + "description": "This operation deletes the policy definition in the given management group with the given name.", + "x-ms-examples": { + "Delete a policy definition at management group level": { + "$ref": "./examples/deletePolicyDefinitionAtManagementGroup.json" + } + }, + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy definition to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagementGroupIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "200": { + "description": "OK" + } + } + }, + "get": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_GetAtManagementGroup", + "summary": "Retrieve a policy definition in a management group.", + "description": "This operation retrieves the policy definition in the given management group with the given name.", + "x-ms-examples": { + "Retrieve a policy definition at management group level": { + "$ref": "./examples/getPolicyDefinitionAtManagementGroup.json" + } + }, + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy definition to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagementGroupIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the policy definition.", + "schema": { + "$ref": "#/definitions/PolicyDefinition" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyDefinitions": { + "get": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_List", + "summary": "Retrieves policy definitions in a subscription", + "description": "This operation retrieves a list of all the policy definitions in a given subscription.", + "x-ms-examples": { + "List policy definitions by subscription": { + "$ref": "./examples/listPolicyDefinitions.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of policy definitions.", + "schema": { + "$ref": "#/definitions/PolicyDefinitionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Authorization/policyDefinitions": { + "get": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_ListBuiltIn", + "summary": "Retrieve built-in policy definitions", + "description": "This operation retrieves a list of all the built-in policy definitions.", + "x-ms-examples": { + "List built-in policy definitions": { + "$ref": "./examples/listBuiltInPolicyDefinitions.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of built-in policy definitions.", + "schema": { + "$ref": "#/definitions/PolicyDefinitionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policyDefinitions": { + "get": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_ListByManagementGroup", + "summary": "Retrieve policy definitions in a management group", + "description": "This operation retrieves a list of all the policy definitions in a given management group.", + "x-ms-examples": { + "List policy definitions by management group": { + "$ref": "./examples/listPolicyDefinitionsByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagementGroupIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns ana array of policy definitions.", + "schema": { + "$ref": "#/definitions/PolicyDefinitionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PolicyDefinitionProperties": { + "properties": { + "policyType": { + "type": "string", + "description": "The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom.", + "enum": [ + "NotSpecified", + "BuiltIn", + "Custom" + ], + "x-ms-enum": { + "name": "policyType", + "modelAsString": true + } + }, + "mode": { + "type": "string", + "description": "The policy definition mode. Possible values are NotSpecified, Indexed, and All.", + "enum": [ + "NotSpecified", + "Indexed", + "All" + ], + "x-ms-enum": { + "name": "policyMode", + "modelAsString": true + } + }, + "displayName": { + "type": "string", + "description": "The display name of the policy definition." + }, + "description": { + "type": "string", + "description": "The policy definition description." + }, + "policyRule": { + "type": "object", + "description": "The policy rule." + }, + "metadata": { + "type": "object", + "description": "The policy definition metadata." + }, + "parameters": { + "type": "object", + "description": "Required if a parameter is used in policy rule." + } + }, + "description": "The policy definition properties." + }, + "PolicyDefinition": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PolicyDefinitionProperties", + "description": "The policy definition properties." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the policy definition." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the policy definition." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource (Microsoft.Authorization/policyDefinitions)." + } + }, + "description": "The policy definition.", + "x-ms-azure-resource": true + }, + "PolicyDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyDefinition" + }, + "description": "An array of policy definitions." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of policy definitions." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ManagementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the management group.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the operation." + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policySetDefinitions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policySetDefinitions.json new file mode 100644 index 000000000000..eff8c9ba5d31 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policySetDefinitions.json @@ -0,0 +1,625 @@ +{ + "swagger": "2.0", + "info": { + "title": "PolicyClient", + "version": "2018-03-01", + "description": "To manage and control access to your resources, you can define customized policies and assign them at a scope." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}": { + "put": { + "tags": [ + "PolicySetDefinitions" + ], + "operationId": "PolicySetDefinitions_CreateOrUpdate", + "summary": "Creates or updates a policy set definition.", + "description": "This operation creates or updates a policy set definition in the given subscription with the given name.", + "x-ms-examples": { + "Create or update a policy set definition": { + "$ref": "./examples/createOrUpdatePolicySetDefinition.json" + } + }, + "parameters": [ + { + "name": "policySetDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy set definition to create." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicySetDefinition" + }, + "description": "The policy set definition properties." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the policy set definition.", + "schema": { + "$ref": "#/definitions/PolicySetDefinition" + } + }, + "200": { + "description": "OK - Returns information about the policy set definition.", + "schema": { + "$ref": "#/definitions/PolicySetDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "PolicySetDefinitions" + ], + "operationId": "PolicySetDefinitions_Delete", + "summary": "Deletes a policy set definition.", + "description": "This operation deletes the policy set definition in the given subscription with the given name.", + "x-ms-examples": { + "Delete a policy set definition": { + "$ref": "./examples/deletePolicySetDefinition.json" + } + }, + "parameters": [ + { + "name": "policySetDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy set definition to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content - the policy set definition doesn't exist in the subscription." + }, + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "PolicySetDefinitions" + ], + "operationId": "PolicySetDefinitions_Get", + "summary": "Retrieves a policy set definition.", + "description": "This operation retrieves the policy set definition in the given subscription with the given name.", + "x-ms-examples": { + "Retrieve a policy set definition": { + "$ref": "./examples/getPolicySetDefinition.json" + } + }, + "parameters": [ + { + "name": "policySetDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy set definition to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the policy set definition.", + "schema": { + "$ref": "#/definitions/PolicySetDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}": { + "get": { + "tags": [ + "PolicySetDefinitions" + ], + "operationId": "PolicySetDefinitions_GetBuiltIn", + "summary": "Retrieves a built in policy set definition.", + "description": "This operation retrieves the built-in policy set definition with the given name.", + "x-ms-examples": { + "Retrieve a built-in policy set definition": { + "$ref": "./examples/getBuiltInPolicySetDefinition.json" + } + }, + "parameters": [ + { + "name": "policySetDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy set definition to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the built in policy set definition.", + "schema": { + "$ref": "#/definitions/PolicySetDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions": { + "get": { + "tags": [ + "PolicySetDefinitions" + ], + "operationId": "PolicySetDefinitions_List", + "summary": "Retrieves the policy set definitions for a subscription.", + "description": "This operation retrieves a list of all the policy set definitions in the given subscription.", + "x-ms-examples": { + "List policy set definitions": { + "$ref": "./examples/listPolicySetDefinitions.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of policy set definitions.", + "schema": { + "$ref": "#/definitions/PolicySetDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Authorization/policySetDefinitions": { + "get": { + "tags": [ + "PolicySetDefinitions" + ], + "operationId": "PolicySetDefinitions_ListBuiltIn", + "summary": "Retrieves built-in policy set definitions.", + "description": "This operation retrieves a list of all the built-in policy set definitions.", + "x-ms-examples": { + "List built-in policy set definitions": { + "$ref": "./examples/listBuiltInPolicySetDefinitions.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of built in policy set definitions.", + "schema": { + "$ref": "#/definitions/PolicySetDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}": { + "put": { + "tags": [ + "PolicySetDefinitions" + ], + "operationId": "PolicySetDefinitions_CreateOrUpdateAtManagementGroup", + "summary": "Creates or updates a policy set definition.", + "description": "This operation creates or updates a policy set definition in the given management group with the given name.", + "x-ms-examples": { + "Create or update a policy set definition at management group level": { + "$ref": "./examples/createOrUpdatePolicySetDefinitionAtManagementGroup.json" + } + }, + "parameters": [ + { + "name": "policySetDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy set definition to create." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicySetDefinition" + }, + "description": "The policy set definition properties." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagementGroupIdParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the policy set definition.", + "schema": { + "$ref": "#/definitions/PolicySetDefinition" + } + }, + "200": { + "description": "OK - Returns information about the policy set definition.", + "schema": { + "$ref": "#/definitions/PolicySetDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "PolicySetDefinitions" + ], + "operationId": "PolicySetDefinitions_DeleteAtManagementGroup", + "summary": "Deletes a policy set definition.", + "description": "This operation deletes the policy set definition in the given management group with the given name.", + "x-ms-examples": { + "Delete a policy set definition at management group level": { + "$ref": "./examples/deletePolicySetDefinitionAtManagementGroup.json" + } + }, + "parameters": [ + { + "name": "policySetDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy set definition to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagementGroupIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content - the policy set definition doesn't exist in the subscription." + }, + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "PolicySetDefinitions" + ], + "operationId": "PolicySetDefinitions_GetAtManagementGroup", + "summary": "Retrieves a policy set definition.", + "description": "This operation retrieves the policy set definition in the given management group with the given name.", + "x-ms-examples": { + "Retrieve a policy set definition at management group level": { + "$ref": "./examples/getPolicySetDefinitionAtManagementGroup.json" + } + }, + "parameters": [ + { + "name": "policySetDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy set definition to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagementGroupIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the policy set definition.", + "schema": { + "$ref": "#/definitions/PolicySetDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementgroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions": { + "get": { + "tags": [ + "PolicySetDefinitions" + ], + "operationId": "PolicySetDefinitions_ListByManagementGroup", + "summary": "Retrieves all policy set definitions in management group.", + "description": "This operation retrieves a list of all the a policy set definition in the given management group.", + "x-ms-examples": { + "List policy set definitions at management group level": { + "$ref": "./examples/listPolicySetDefinitionsByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagementGroupIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of policy set definitions.", + "schema": { + "$ref": "#/definitions/PolicySetDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PolicySetDefinitionProperties": { + "properties": { + "policyType": { + "type": "string", + "description": "The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom.", + "enum": [ + "NotSpecified", + "BuiltIn", + "Custom" + ], + "x-ms-enum": { + "name": "policyType", + "modelAsString": true + } + }, + "displayName": { + "type": "string", + "description": "The display name of the policy set definition." + }, + "description": { + "type": "string", + "description": "The policy set definition description." + }, + "metadata": { + "type": "object", + "description": "The policy set definition metadata." + }, + "parameters": { + "type": "object", + "description": "The policy set definition parameters that can be used in policy definition references." + }, + "policyDefinitions": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyDefinitionReference" + }, + "description": "An array of policy definition references." + } + }, + "required": [ + "policyDefinitions" + ], + "description": "The policy set definition properties." + }, + "PolicyDefinitionReference": { + "properties": { + "policyDefinitionId": { + "type": "string", + "description": "The ID of the policy definition or policy set definition." + }, + "parameters": { + "type": "object", + "description": "Required if a parameter is used in policy rule." + } + }, + "description": "The policy definition reference." + }, + "PolicySetDefinition": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PolicySetDefinitionProperties", + "description": "The policy definition properties." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the policy set definition." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the policy set definition." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource (Microsoft.Authorization/policySetDefinitions)." + } + }, + "description": "The policy set definition.", + "x-ms-azure-resource": true + }, + "PolicySetDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicySetDefinition" + }, + "description": "An array of policy set definitions." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of policy set definitions." + }, + "ErrorResponse": { + "description": "Error reponse indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "httpStatus": { + "description": "Http status code.", + "type": "string" + }, + "errorCode": { + "description": "Error code.", + "type": "string" + }, + "errorMessage": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ManagementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the management group.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the operation." + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-02-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-02-01/resources.json index 5c2b986b863e..a5ca1179ff39 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-02-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-02-01/resources.json @@ -2542,7 +2542,7 @@ "in": "path", "required": true, "type": "string", - "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + "description": "The ID of the target subscription." }, "ApiVersionParameter": { "name": "api-version", diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json new file mode 100644 index 000000000000..e546f470b6b7 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "deploymentName": "{deploymentName}", + "api-version": "2018-05-01", + "parameters": { + "properties": { + "templateLink": "{templateUri}", + "parameters": {}, + "mode": "Complete", + "onErrorDeployment": { + "type": "LastSuccessful" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourcegroups/myResourceGroup/providers/Microsoft.Resources/deployments/{deploymentName}", + "name": "{deploymentName}", + "properties": { + "provisioningState": "Accepted", + "correlationId": "{correlationId}", + "timeStamp": "{timeStamp}", + "mode": "Complete", + "onErrorDeployment": { + "type": "LastSuccessful", + "deploymentName": "{nameOfLastSuccesfulDeployment}" + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json new file mode 100644 index 000000000000..cae0c4b06b99 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "deploymentName": "{deploymentName}", + "api-version": "2018-05-01", + "parameters": { + "properties": { + "templateLink": "{templateUri}", + "parameters": {}, + "mode": "Complete", + "onErrorDeployment": { + "type": "SpecificDeployment", + "deploymentName": "{nameOfDeploymentToUse}" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourcegroups/myResourceGroup/providers/Microsoft.Resources/deployments/{deploymentName}", + "name": "{deploymentName}", + "properties": { + "provisioningState": "Accepted", + "correlationId": "{correlationId}", + "timeStamp": "{timeStamp}", + "mode": "Complete", + "onErrorDeployment": { + "type": "SpecificDeployment", + "deploymentName": "{nameOfDeploymentToUse}" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/examples/PutUserAssignedIdentity.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/examples/PutUserAssignedIdentity.json new file mode 100644 index 000000000000..2882d8b64f89 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/examples/PutUserAssignedIdentity.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "location": "{location}", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/00000000": {}, + "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/00000001": {} + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/{subscriptionId}/resourcegroups/myResourceGroup/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "location": "{location}", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/00000000/providers/Microsoft.ManagedIdentity/userAssignedIdentities/00000000": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + }, + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/00000001/providers/Microsoft.ManagedIdentity/userAssignedIdentities/00000001": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json new file mode 100644 index 000000000000..a7e151e31f06 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json @@ -0,0 +1,3394 @@ +{ + "swagger": "2.0", + "info": { + "title": "ResourceManagementClient", + "version": "2018-05-01", + "description": "Provides operations for working with resources and resource groups." + }, + "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.Resources/deployments/{deploymentName}": { + "delete": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_DeleteAtSubscriptionScope", + "summary": "Deletes a deployment from the deployment history.", + "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.", + "parameters": [ + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment to delete.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "head": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CheckExistenceAtSubscriptionScope", + "description": "Checks whether the deployment exists.", + "parameters": [ + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment to check.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found" + } + } + }, + "put": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CreateOrUpdateAtSubscriptionScope", + "summary": "Deploys resources at subscription scope.", + "description": "You can provide the template and parameters directly in the request or link to JSON files.", + "parameters": [ + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Additional parameters supplied to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "201": { + "description": "Created - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_GetAtSubscriptionScope", + "description": "Gets a deployment.", + "parameters": [ + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment to get.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CancelAtSubscriptionScope", + "summary": "Cancels a currently running template deployment.", + "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.", + "parameters": [ + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment to cancel.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ValidateAtSubscriptionScope", + "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..", + "parameters": [ + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Parameters to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the validation result.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "400": { + "description": "Returns the validation result.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ExportTemplateAtSubscriptionScope", + "description": "Exports the template used for specified deployment.", + "parameters": [ + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment from which to get the template.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the template.", + "schema": { + "$ref": "#/definitions/DeploymentExportResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ListAtSubscriptionScope", + "description": "Get all the deployments for a subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to get. If null is passed, returns all deployments." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of deployments.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DeploymentExtendedFilter" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}": { + "delete": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Delete", + "summary": "Deletes a deployment from the deployment history.", + "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group with the deployment to delete. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment to delete.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "head": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CheckExistence", + "description": "Checks whether the deployment exists.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group with the deployment to check. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment to check.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found" + } + } + }, + "put": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CreateOrUpdate", + "summary": "Deploys resources to a resource group.", + "description": "You can provide the template and parameters directly in the request or link to JSON files.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Additional parameters supplied to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "201": { + "description": "Created - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Get", + "description": "Gets 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 + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment to get.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Cancel", + "summary": "Cancels a currently running template deployment.", + "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.", + "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 + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment to cancel.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Validate", + "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group the template will be deployed to. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Parameters to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the validation result.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "400": { + "description": "Returns the validation result.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ExportTemplate", + "description": "Exports the template used for specified 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 + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment from which to get the template.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the template.", + "schema": { + "$ref": "#/definitions/DeploymentExportResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ListByResourceGroup", + "description": "Get all the deployments for a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group with the deployments to get. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to get. If null is passed, returns all deployments." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of deployments.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DeploymentExtendedFilter" + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister": { + "post": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Unregister", + "description": "Unregisters a subscription from a resource provider.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider to unregister." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns informatin about the resource provider.", + "schema": { + "$ref": "#/definitions/Provider" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register": { + "post": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Register", + "description": "Registers a subscription with a resource provider.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider to register." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the resource provider.", + "schema": { + "$ref": "#/definitions/Provider" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers": { + "get": { + "tags": [ + "Providers" + ], + "operationId": "Providers_List", + "description": "Gets all resource providers for a subscription.", + "parameters": [ + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to return. If null is passed returns all deployments." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of resource providers.", + "schema": { + "$ref": "#/definitions/ProviderListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}": { + "get": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Get", + "description": "Gets the specified resource provider.", + "parameters": [ + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases." + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the resource provider.", + "schema": { + "$ref": "#/definitions/Provider" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources": { + "get": { + "tags": [ + "ResourceGroups" + ], + "operationId": "Resources_ListByResourceGroup", + "description": "Get all the resources for a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group with the resources to get.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand query parameter" + }, + { + "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" + } + } + }, + "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" + } + } + }, + "put": { + "tags": [ + "ResourceGroups" + ], + "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.", + "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": { + "201": { + "description": "Created - Returns information about the new resource group.", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + }, + "200": { + "description": "OK - Returns information about the new resource group.", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + } + } + }, + "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": { + "202": { + "description": "Accepted" + }, + "200": { + "description": "OK" + } + }, + "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" + } + } + } + }, + "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" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate": { + "post": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_ExportTemplate", + "description": "Captures the specified resource group as a template.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to export as a template.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExportTemplateRequest" + }, + "description": "Parameters for exporting the template." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the result of the export.", + "schema": { + "$ref": "#/definitions/ResourceGroupExportResult" + } + } + } + } + }, + "/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." + }, + { + "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" + } + } + }, + "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" + } + }, + "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/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "409": { + "description": "Conflict" + } + }, + "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." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand query parameter." + }, + { + "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" + } + } + }, + "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" + } + } + }, + "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" + }, + "204": { + "description": "No Content" + }, + "202": { + "description": "Accepted" + } + }, + "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": { + "201": { + "description": "Created - Returns information about the resource.", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "200": { + "description": "OK - Returns information about the resource.", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "202": { + "description": "Accepted" + } + }, + "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" + } + }, + "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" + } + } + } + } + }, + "/{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" + } + } + }, + "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" + }, + "204": { + "description": "No Content" + }, + "202": { + "description": "Accepted" + } + }, + "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": { + "201": { + "description": "Created - Returns information about the resource.", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "200": { + "description": "OK - Returns information about the resource.", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "202": { + "description": "Accepted" + } + }, + "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" + } + }, + "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" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}": { + "delete": { + "tags": [ + "Tags" + ], + "operationId": "Tags_DeleteValue", + "description": "Deletes a tag value.", + "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": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "put": { + "tags": [ + "Tags" + ], + "operationId": "Tags_CreateOrUpdateValue", + "description": "Creates a tag value. The name of the tag must already exist.", + "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": "OK - Returns information about the tag value.", + "schema": { + "$ref": "#/definitions/TagValue" + } + }, + "201": { + "description": "Created - Returns information about the tag value.", + "schema": { + "$ref": "#/definitions/TagValue" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames/{tagName}": { + "put": { + "tags": [ + "Tags" + ], + "operationId": "Tags_CreateOrUpdate", + "summary": "Creates a tag in the subscription.", + "description": "The tag name can have a maximum of 512 characters and is case insensitive. Tag names created by Azure have prefixes of microsoft, azure, or windows. You cannot create tags with one of these prefixes.", + "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": "OK - Returns information about the tag.", + "schema": { + "$ref": "#/definitions/TagDetails" + } + }, + "201": { + "description": "Created - Returns information about the tag.", + "schema": { + "$ref": "#/definitions/TagDetails" + } + } + } + }, + "delete": { + "tags": [ + "Tags" + ], + "operationId": "Tags_Delete", + "summary": "Deletes a tag from the subscription.", + "description": "You must remove all values from a resource tag before you can delete it.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames": { + "get": { + "tags": [ + "Tags" + ], + "operationId": "Tags_List", + "description": "Gets the names and values of all resource tags that are defined in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of tag names and values.", + "schema": { + "$ref": "#/definitions/TagsListResult" + } + } + }, + "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": [ + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "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" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_ListAtSubscriptionScope", + "description": "Gets all deployments operations for a deployment.", + "parameters": [ + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment with the operation to get.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "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" + } + } + }, + "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 + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "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" + } + } + } + } + }, + "/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 + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment with the operation to get.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 64 + }, + { + "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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "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." + }, + "contentVersion": { + "type": "string", + "description": "If included, must match the ContentVersion in the template." + } + }, + "required": [ + "uri" + ], + "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 paramaters." + }, + "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." + } + } + }, + "Deployment": { + "properties": { + "location": { + "type": "string", + "description": "The location to store the deployment data." + }, + "properties": { + "$ref": "#/definitions/DeploymentProperties", + "description": "The deployment properties." + } + }, + "required": [ + "properties" + ], + "description": "Deployment operation parameters." + }, + "DeploymentExportResult": { + "properties": { + "template": { + "type": "object", + "description": "The template content." + } + }, + "description": "The deployment export result. " + }, + "ResourceManagementErrorWithDetails": { + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The error code returned when exporting the template." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The error message describing the export error." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The target of the error." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceManagementErrorWithDetails" + }, + "description": "Validation error." + } + }, + "description": "The detailed error message of resource management." + }, + "AliasPathType": { + "properties": { + "path": { + "type": "string", + "description": "The path of an alias." + }, + "apiVersions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The API versions." + } + }, + "description": "The type of the paths for alias. " + }, + "AliasType": { + "properties": { + "name": { + "type": "string", + "description": "The alias name." + }, + "paths": { + "type": "array", + "items": { + "$ref": "#/definitions/AliasPathType" + }, + "description": "The paths 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/AliasType" + }, + "description": "The aliases that are supported by this resource type." + }, + "apiVersions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The API version." + }, + "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 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": { + "readOnly": true, + "type": "string", + "description": "The state of the provisioning." + }, + "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." + }, + "outputs": { + "type": "object", + "description": "Key/value pairs that represent deploymentoutput." + }, + "providers": { + "type": "array", + "items": { + "$ref": "#/definitions/Provider" + }, + "description": "The list of resource providers needed for the deployment." + }, + "dependencies": { + "type": "array", + "items": { + "$ref": "#/definitions/Dependency" + }, + "description": "The list of deployment dependencies." + }, + "template": { + "type": "object", + "description": "The template content. Use only one of Template or TemplateLink." + }, + "templateLink": { + "$ref": "#/definitions/TemplateLink", + "description": "The URI referencing the template. Use only one of Template or TemplateLink." + }, + "parameters": { + "type": "object", + "description": "Deployment parameters. Use only one of Parameters or ParametersLink." + }, + "parametersLink": { + "$ref": "#/definitions/ParametersLink", + "description": "The URI referencing the parameters. Use only one of Parameters or ParametersLink." + }, + "mode": { + "type": "string", + "description": "The deployment mode. Possible values are Incremental and Complete.", + "enum": [ + "Incremental", + "Complete" + ], + "x-ms-enum": { + "name": "DeploymentMode", + "modelAsString": false + } + }, + "debugSetting": { + "$ref": "#/definitions/DebugSetting", + "description": "The debug setting of the deployment." + }, + "onErrorDeployment": { + "$ref": "#/definitions/OnErrorDeploymentExtended", + "description": "The deployment on error behavior." + } + }, + "description": "Deployment properties with additional details." + }, + "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": { + "$ref": "#/definitions/ResourceManagementErrorWithDetails", + "description": "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": { + "type": "string", + "description": "The name of the deployment." + }, + "location": { + "type": "string", + "description": "the location of the deployment." + }, + "properties": { + "$ref": "#/definitions/DeploymentPropertiesExtended", + "description": "Deployment properties." + } + }, + "required": [ + "name" + ], + "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." + }, + "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", + "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/GenericResource" + }, + "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": { + "type": "string", + "description": "The name of the resource group." + }, + "properties": { + "$ref": "#/definitions/ResourceGroupProperties" + }, + "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" + }, + "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. The only supported string currently is '*' (all resources). Future updates will support exporting specific resources." + }, + "options": { + "type": "string", + "description": "The export template options. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments" + } + }, + "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 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 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." + } + }, + "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": { + "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." + }, + "serviceRequestId": { + "readOnly": true, + "type": "string", + "description": "Deployment operation service request id." + }, + "statusCode": { + "readOnly": true, + "type": "string", + "description": "Operation status code." + }, + "statusMessage": { + "readOnly": true, + "type": "object", + "description": "Operation status message." + }, + "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": "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": "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": "#/definitions/ResourceManagementErrorWithDetails", + "description": "The error." + } + }, + "description": "Resource group export result." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/createOrUpdateApplication.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/createOrUpdateApplication.json new file mode 100644 index 000000000000..1f6e8465a059 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/createOrUpdateApplication.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "managedApplicationName": "myManagedApplication", + "api-version": "2018-06-01", + "parameters": { + "properties": { + "managedApplicationDefinitionId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applicationDefinitions/myAppDef", + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG" + }, + "name": "myManagedApplication", + "location": "East US 2", + "kind": "ServiceCatalog" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "name": "myManagedApplication", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applications/myManagedApplication", + "type": "Microsoft.Solutions/applications", + "location": "East US 2", + "managedBy": null, + "resourceGroup": "rg", + "tags": null, + "plan": null, + "identity": null, + "kind": "ServiceCatalog", + "sku": null, + "properties": { + "managedApplicationDefinitionId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applicationDefinitions/myAppDef", + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "outputs": null, + "parameters": null, + "provisioningState": "Created" + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/createOrUpdateApplicationDefinition.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/createOrUpdateApplicationDefinition.json new file mode 100644 index 000000000000..00dfc5ca8317 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/createOrUpdateApplicationDefinition.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "managedApplicationDefinitionName": "myManagedApplicationDef", + "api-version": "2018-06-01", + "parameters": { + "properties": { + "lockLevel": "None", + "displayName": "myManagedApplicationDef", + "description": "myManagedApplicationDef description", + "authorizations": [ + { + "principalId": "validprincipalguid", + "roleDefinitionId": "validroleguid" + } + ], + "packageFileUri": "https://path/to/packagezipfile" + }, + "location": "East US 2" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "name": "myManagedApplicationDef", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applicationDefinitions/myManagedApplicationDef", + "type": "Microsoft.Solutions/applicationDefinitions", + "location": "East US 2", + "managedBy": null, + "resourceGroup": "rg", + "tags": null, + "identity": null, + "sku": null, + "properties": { + "artifacts": [ + { + "name": "CreateUiDefinition", + "type": "Custom", + "uri": "https://path/to/managedApplicationCreateUiDefinition.json" + }, + { + "name": "ManagedApplicationResourceTemplate", + "type": "Template", + "uri": "https://path/to/mainTemplate.json" + } + ], + "authorizations": [ + { + "principalId": "validprincipalguid", + "roleDefinitionId": "validroleguid" + } + ], + "description": "myManagedApplicationDef description", + "displayName": "myManagedApplicationDef", + "lockLevel": null, + "packageFileUri": "https://path/to/packagezipfile" + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/getApplication.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/getApplication.json new file mode 100644 index 000000000000..5b3c4d438644 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/getApplication.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "managedApplicationName": "myManagedApplication", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myManagedApplication", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applications/myManagedApplication", + "type": "Microsoft.Solutions/applications", + "location": "East US 2", + "managedBy": null, + "resourceGroup": "rg", + "tags": null, + "plan": null, + "identity": null, + "kind": "ServiceCatalog", + "sku": null, + "properties": { + "managedApplicationDefinitionId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/managedApplicationDefinitions/myAppDef", + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "outputs": null, + "parameters": null, + "provisioningState": "Created" + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/getApplicationDefinition.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/getApplicationDefinition.json new file mode 100644 index 000000000000..a2b161deeb3c --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/getApplicationDefinition.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "managedApplicationName": "myManagedApplicationDef", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myManagedApplicationDef", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applicationDefinitions/myManagedApplicationDef", + "type": "Microsoft.Solutions/applicationDefinitions", + "location": "East US 2", + "managedBy": null, + "resourceGroup": "rg", + "tags": null, + "identity": null, + "sku": null, + "properties": { + "artifacts": [ + { + "name": "CreateUiDefinition", + "type": "Custom", + "uri": "https://path/to/managedApplicationCreateUiDefinition.json" + }, + { + "name": "ManagedApplicationResourceTemplate", + "type": "Template", + "uri": "https://path/to/mainTemplate.json" + } + ], + "authorizations": [ + { + "principalId": "validprincipalguid", + "roleDefinitionId": "validroleguid" + } + ], + "description": "myManagedApplicationDef description", + "displayName": "myManagedApplicationDef", + "lockLevel": null, + "packageFileUri": "https://path/to/packagezipfile" + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listApplicationDefinitionsByResourceGroup.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listApplicationDefinitionsByResourceGroup.json new file mode 100644 index 000000000000..94e79bcec7da --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listApplicationDefinitionsByResourceGroup.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "myManagedApplicationDef", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applicationDefinitions/myManagedApplicationDef", + "type": "Microsoft.Solutions/applicationDefinitions", + "location": "East US 2", + "managedBy": null, + "resourceGroup": "rg", + "tags": null, + "identity": null, + "sku": null, + "properties": { + "artifacts": [ + { + "name": "CreateUiDefinition", + "type": "Custom", + "uri": "https://path/to/managedApplicationCreateUiDefinition.json" + }, + { + "name": "ManagedApplicationResourceTemplate", + "type": "Template", + "uri": "https://path/to/mainTemplate.json" + } + ], + "authorizations": [ + { + "principalId": "validprincipalguid", + "roleDefinitionId": "validroleguid" + } + ], + "description": "myManagedApplicationDef description", + "displayName": "myManagedApplicationDef", + "lockLevel": null, + "packageFileUri": "https://path/to/packagezipfile" + } + }, + { + "name": "myManagedApplicationDef2", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applicationDefinitions/myManagedApplicationDef2", + "type": "Microsoft.Solutions/applicationDefinitions", + "location": "West US", + "managedBy": null, + "resourceGroup": "rg", + "tags": null, + "identity": null, + "sku": null, + "properties": { + "artifacts": [ + { + "name": "CreateUiDefinition", + "type": "Custom", + "uri": "https://path/to/managedApplicationCreateUiDefinition.json" + }, + { + "name": "ManagedApplicationResourceTemplate", + "type": "Template", + "uri": "https://path/to/mainTemplate.json" + } + ], + "authorizations": [ + { + "principalId": "validprincipalguid", + "roleDefinitionId": "validroleguid" + } + ], + "description": "myManagedApplicationDef2 description", + "displayName": "myManagedApplicationDef2", + "lockLevel": null, + "packageFileUri": "https://path/to/packagezipfile" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listApplicationsByResourceGroup.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listApplicationsByResourceGroup.json new file mode 100644 index 000000000000..f177eaba19dc --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listApplicationsByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "myManagedApplication", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applications/myManagedApplication", + "type": "Microsoft.Solutions/applications", + "location": "East US 2", + "managedBy": null, + "resourceGroup": "rg", + "tags": null, + "plan": null, + "identity": null, + "kind": "ServiceCatalog", + "sku": null, + "properties": { + "managedApplicationDefinitionId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/managedApplicationDefinitions/myAppDef", + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "outputs": null, + "parameters": null, + "provisioningState": "Created" + } + }, + { + "name": "myManagedApplication2", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applications/myManagedApplication2", + "type": "Microsoft.Solutions/applications", + "location": "West US", + "managedBy": null, + "resourceGroup": "rg", + "tags": null, + "plan": null, + "identity": null, + "kind": "ServiceCatalog", + "sku": null, + "properties": { + "managedApplicationDefinitionId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/managedApplicationDefinitions/myAppDef2", + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "outputs": null, + "parameters": null, + "provisioningState": "Created" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/managedapplications.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/managedapplications.json new file mode 100644 index 000000000000..40504228b018 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/managedapplications.json @@ -0,0 +1,1372 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApplicationClient", + "version": "2018-06-01", + "description": "ARM applications" + }, + "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.Solutions/applications/{applicationName}": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "Applications_Get", + "description": "Gets the managed application.", + "x-ms-examples": { + "Get a managed application": { + "$ref": "./examples/getApplication.json" + } + }, + "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 + }, + { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application.", + "minLength": 3, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the managed application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Applications" + ], + "operationId": "Applications_Delete", + "description": "Deletes the managed application.", + "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 + }, + { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application.", + "minLength": 3, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "Applications" + ], + "operationId": "Applications_CreateOrUpdate", + "description": "Creates a new managed application.", + "x-ms-examples": { + "Create or update managed application": { + "$ref": "./examples/createOrUpdateApplication.json" + } + }, + "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 + }, + { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application.", + "minLength": 3, + "maxLength": 64 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + }, + "description": "Parameters supplied to the create or update a managed application." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Created - Returns information about the managed application, including provisioning status.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "201": { + "description": "Created - Returns information about the managed application, including provisioning status.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Applications" + ], + "operationId": "Applications_Update", + "description": "Updates an existing managed application. The only value that can be updated via PATCH currently is the tags.", + "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 + }, + { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application.", + "minLength": 3, + "maxLength": 64 + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/Application" + }, + "description": "Parameters supplied to update an existing managed application." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Created - Returns information about the managed application, including provisioning status.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions/{applicationDefinitionName}": { + "get": { + "tags": [ + "ApplicationDefinitions" + ], + "operationId": "ApplicationDefinitions_Get", + "description": "Gets the managed application definition.", + "x-ms-examples": { + "Get managed application definition": { + "$ref": "./examples/getApplicationDefinition.json" + } + }, + "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 + }, + { + "name": "applicationDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application definition.", + "minLength": 3, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the managed application definition.", + "schema": { + "$ref": "#/definitions/ApplicationDefinition" + } + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationDefinitions" + ], + "operationId": "ApplicationDefinitions_Delete", + "description": "Deletes the managed application definition.", + "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 + }, + { + "name": "applicationDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application definition to delete.", + "minLength": 3, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "ApplicationDefinitions" + ], + "operationId": "ApplicationDefinitions_CreateOrUpdate", + "description": "Creates a new managed application definition.", + "x-ms-examples": { + "Create or update managed application definition": { + "$ref": "./examples/createOrUpdateApplicationDefinition.json" + } + }, + "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 + }, + { + "name": "applicationDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application definition.", + "minLength": 3, + "maxLength": 64 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationDefinition" + }, + "description": "Parameters supplied to the create or update an managed application definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the managed application definition, including provisioning status.", + "schema": { + "$ref": "#/definitions/ApplicationDefinition" + } + }, + "201": { + "description": "Created - Returns information about the managed application definition, including provisioning status.", + "schema": { + "$ref": "#/definitions/ApplicationDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions": { + "get": { + "tags": [ + "ApplicationDefinitions" + ], + "operationId": "ApplicationDefinitions_ListByResourceGroup", + "description": "Lists the managed application definitions in a resource group.", + "x-ms-examples": { + "List managed application definitions": { + "$ref": "./examples/listApplicationDefinitionsByResourceGroup.json" + } + }, + "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/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of managed application definitions.", + "schema": { + "$ref": "#/definitions/ApplicationDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "Applications_ListByResourceGroup", + "description": "Gets all the applications within a resource group.", + "x-ms-examples": { + "Lists applications": { + "$ref": "./examples/listApplicationsByResourceGroup.json" + } + }, + "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/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of applications.", + "schema": { + "$ref": "#/definitions/ApplicationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Solutions/applications": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "Applications_ListBySubscription", + "description": "Gets all the applications within a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of applications.", + "schema": { + "$ref": "#/definitions/ApplicationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{applicationId}": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "Applications_GetById", + "description": "Gets the managed application.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-name}", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the managed application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Applications" + ], + "operationId": "Applications_DeleteById", + "description": "Deletes the managed application.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-name}", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "Applications" + ], + "operationId": "Applications_CreateOrUpdateById", + "description": "Creates a new managed application.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-name}", + "x-ms-skip-url-encoding": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + }, + "description": "Parameters supplied to the create or update a managed application." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Created - Returns information about the managed application, including provisioning status.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "201": { + "description": "Created - Returns information about the managed application, including provisioning status.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Applications" + ], + "operationId": "Applications_UpdateById", + "description": "Updates an existing managed application. The only value that can be updated via PATCH currently is the tags.", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the managed application, including the managed application name and the managed application resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applications/{application-name}", + "x-ms-skip-url-encoding": true + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/Application" + }, + "description": "Parameters supplied to update an existing managed application." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Created - Returns information about the managed application, including provisioning status.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "x-ms-paths": { + "/{applicationDefinitionId}?disambiguation_dummy": { + "get": { + "tags": [ + "ApplicationDefinitions" + ], + "operationId": "ApplicationDefinitions_GetById", + "description": "Gets the managed application definition.", + "parameters": [ + { + "name": "applicationDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name}", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the managed application definition.", + "schema": { + "$ref": "#/definitions/ApplicationDefinition" + } + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationDefinitions" + ], + "operationId": "ApplicationDefinitions_DeleteById", + "description": "Deletes the managed application definition.", + "parameters": [ + { + "name": "applicationDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name}", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "ApplicationDefinitions" + ], + "operationId": "ApplicationDefinitions_CreateOrUpdateById", + "description": "Creates a new managed application definition.", + "parameters": [ + { + "name": "applicationDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name}", + "x-ms-skip-url-encoding": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationDefinition" + }, + "description": "Parameters supplied to the create or update a managed application definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the managed application definition, including provisioning status.", + "schema": { + "$ref": "#/definitions/ApplicationDefinition" + } + }, + "201": { + "description": "Created - Returns information about the managed application definition, including provisioning status.", + "schema": { + "$ref": "#/definitions/ApplicationDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Application": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationProperties", + "description": "The managed application properties." + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "The plan information." + }, + "kind": { + "type": "string", + "description": "The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog.", + "pattern": "^[-\\w\\._,\\(\\)]+$" + } + }, + "required": [ + "properties", + "kind" + ], + "allOf": [ + { + "$ref": "#/definitions/GenericResource" + } + ], + "description": "Information about managed application." + }, + "ApplicationPatchable": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationPropertiesPatchable", + "description": "The managed application properties." + }, + "plan": { + "$ref": "#/definitions/PlanPatchable", + "description": "The plan information." + }, + "kind": { + "type": "string", + "description": "The kind of the managed application. Allowed values are MarketPlace and ServiceCatalog.", + "pattern": "^[-\\w\\._,\\(\\)]+$" + } + }, + "allOf": [ + { + "$ref": "#/definitions/GenericResource" + } + ], + "description": "Information about managed application." + }, + "ApplicationDefinition": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationDefinitionProperties", + "description": "The managed application definition properties." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/GenericResource" + } + ], + "description": "Information about managed application definition." + }, + "ApplicationProperties": { + "properties": { + "managedResourceGroupId": { + "type": "string", + "description": "The managed resource group Id." + }, + "applicationDefinitionId": { + "type": "string", + "description": "The fully qualified path of managed application definition Id." + }, + "parameters": { + "type": "object", + "description": "Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string." + }, + "outputs": { + "readOnly": true, + "type": "object", + "description": "Name and value pairs that define the managed application outputs." + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState", + "description": "The managed application provisioning state." + } + }, + "required": [ + "managedResourceGroupId" + ], + "description": "The managed application properties." + }, + "ApplicationPropertiesPatchable": { + "properties": { + "managedResourceGroupId": { + "type": "string", + "description": "The managed resource group Id." + }, + "applicationDefinitionId": { + "type": "string", + "description": "The fully qualified path of managed application definition Id." + }, + "parameters": { + "type": "object", + "description": "Name and value pairs that define the managed application parameters. It can be a JObject or a well formed JSON string." + }, + "outputs": { + "readOnly": true, + "type": "object", + "description": "Name and value pairs that define the managed application outputs." + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState", + "description": "The managed application provisioning state." + } + }, + "description": "The managed application properties." + }, + "ApplicationDefinitionProperties": { + "properties": { + "lockLevel": { + "$ref": "#/definitions/ApplicationLockLevel", + "description": "The managed application lock level." + }, + "displayName": { + "type": "string", + "description": "The managed application definition display name." + }, + "isEnabled": { + "type": "string", + "description": "A value indicating whether the package is enabled or not." + }, + "authorizations": { + "description": "The managed application provider authorizations.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationProviderAuthorization" + } + }, + "artifacts": { + "description": "The collection of managed application artifacts. The portal will use the files specified as artifacts to construct the user experience of creating a managed application from a managed application definition.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationArtifact" + } + }, + "description": { + "type": "string", + "description": "The managed application definition description." + }, + "packageFileUri": { + "type": "string", + "description": "The managed application definition package file Uri. Use this element" + }, + "mainTemplate": { + "type": "object", + "description": "The inline main template json which has resources to be provisioned. It can be a JObject or well-formed JSON string." + }, + "createUiDefinition": { + "type": "object", + "description": "The createUiDefinition json for the backing template with Microsoft.Solutions/applications resource. It can be a JObject or well-formed JSON string." + } + }, + "required": [ + "lockLevel", + "authorizations" + ], + "description": "The managed application definition properties." + }, + "Plan": { + "properties": { + "name": { + "type": "string", + "description": "The plan name." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "The product code." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + }, + "version": { + "type": "string", + "description": "The plan's version." + } + }, + "required": [ + "name", + "publisher", + "product", + "version" + ], + "description": "Plan for the managed application." + }, + "PlanPatchable": { + "properties": { + "name": { + "type": "string", + "description": "The plan name." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "The product code." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + }, + "version": { + "type": "string", + "description": "The plan's version." + } + }, + "description": "Plan for the managed application." + }, + "GenericResource": { + "properties": { + "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." + }, + "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." + } + }, + "required": [ + "name" + ], + "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" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + }, + "description": "Identity for the resource." + }, + "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" + } + }, + "description": "Resource information.", + "x-ms-azure-resource": true + }, + "ApplicationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Application" + }, + "description": "The array of managed applications." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of managed applications." + }, + "ApplicationDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationDefinition" + }, + "description": "The array of managed application definitions." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of managed application definitions." + }, + "ProvisioningState": { + "description": "Provisioning status of the managed application.", + "readOnly": true, + "enum": [ + "Accepted", + "Running", + "Ready", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "Updating" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ApplicationLockLevel": { + "description": "The managed application lock level.", + "enum": [ + "CanNotDelete", + "ReadOnly", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "ApplicationLockLevel", + "modelAsString": false + } + }, + "ApplicationArtifactType": { + "description": "The managed application artifact type.", + "enum": [ + "Template", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ApplicationArtifactType", + "modelAsString": false + } + }, + "ApplicationArtifact": { + "properties": { + "name": { + "type": "string", + "description": "The managed application artifact name." + }, + "uri": { + "type": "string", + "description": "The managed application artifact blob uri." + }, + "type": { + "$ref": "#/definitions/ApplicationArtifactType", + "description": "The managed application artifact type." + } + }, + "description": "Managed application artifact." + }, + "ApplicationProviderAuthorization": { + "properties": { + "principalId": { + "type": "string", + "description": "The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources." + }, + "roleDefinitionId": { + "type": "string", + "description": "The provider's role definition identifier. This role will define all the permissions that the provider must have on the managed application's container resource group. This role definition cannot have permission to delete the resource group." + } + }, + "required": [ + "principalId", + "roleDefinitionId" + ], + "description": "The managed application provider authorization." + }, + "ErrorResponse": { + "description": "Error reponse indicates managed application is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "httpStatus": { + "description": "Http status code.", + "type": "string" + }, + "errorCode": { + "description": "Error code.", + "type": "string" + }, + "errorMessage": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + } + } +} diff --git a/specification/resources/resource-manager/readme.csharp.md b/specification/resources/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..d414df36f60b --- /dev/null +++ b/specification/resources/resource-manager/readme.csharp.md @@ -0,0 +1,271 @@ +# C# ResourceManager + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DNS. + +## Common C# Settings +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true +``` + +``` yaml $(csharp) && !$(multiApi) +namespace: Microsoft.Azure.Management.ResourceManager +output-folder: $(csharp-sdks-folder)/Resource/Management.ResourceManager/Generated + +batch: + - package-features: true + - package-locks: true + - package-policy: true + - package-resources: true + - package-subscriptions: true + - package-links: true +# - package-managedapplications: true +``` + + + + + + + + + + + +## Azure Stack Batch settings +These settings are for batch mode only: (ie, add `--MultiApi` to the command line ) + +``` yaml $(multiApi) +namespace: Microsoft.Azure.Management.ResourceManager.$(ApiVersionName) +output-folder: $(csharp-sdks-folder)/$(ApiVersionName)/Generated + +batch: + - resources-2016-02-01: true + ApiVersionName: Api2016_02_01 + - links-2016-09-01: true + ApiVersionName: Api2016_02_01 + - subscription-2016-06-01: true + ApiVersionName: Api2016_02_01 + - locks-2015-01-01: true + ApiVersionName: Api2016_02_01 + - policy-2015-10-01: true + ApiVersionName: Api2016_02_01 + + - resources-2018-02-01: true + ApiVersionName: Api2018_02_01 + - links-2016-09-01: true + ApiVersionName: Api2018_02_01 + - subscription-2016-06-01: true + ApiVersionName: Api2018_02_01 + - locks-2016-09-01: true + ApiVersionName: Api2018_02_01 + - policyA-2016-12-01: true + ApiVersionName: Api2018_02_01 + - policyD-2016-12-01: true + ApiVersionName: Api2018_02_01 + + - resources-2018-05-01: true + ApiVersionName: Api2018_05_01 + - links-2016-09-01: true + ApiVersionName: Api2018_05_01 + - subscription-2016-06-01: true + ApiVersionName: Api2018_05_01 + - locks-2016-09-01: true + ApiVersionName: Api2018_05_01 + - policyA-2016-12-01: true + ApiVersionName: Api2018_05_01 + - policyD-2016-12-01: true + ApiVersionName: Api2018_05_01 +``` + + +``` yaml $(resources-2016-02-01) +tag: pkg-2016-02-Az-res +``` + +``` yaml $(links-2016-09-01) +tag: pkg-2016-02-Az-lnk +``` + +``` yaml $(subscription-2016-06-01) +tag: pkg-2016-02-Az-sub +``` + +``` yaml $(locks-2015-01-01) +tag: pkg-2016-02-Az-loc +``` + +``` yaml $(policy-2015-10-01) +tag: pkg-2016-02-Az-pol +``` + +## Tag: Packages for Azure Stack +### 1) pkg-2016-02-AzStk-res +``` yaml $(tag) == 'pkg-2016-02-Az-res' +input-file: +- Microsoft.Resources/stable/2016-02-01/resources.json +``` + +### 2) pkg-2016-02-AzStk-lnk +``` yaml $(tag) == 'pkg-2016-02-Az-lnk' +input-file: +- Microsoft.Resources/stable/2016-09-01/links.json +``` + +### 3) pkg-2016-02-AzStk-sub +``` yaml $(tag) == 'pkg-2016-02-Az-sub' +input-file: +- Microsoft.Resources/stable/2016-06-01/subscriptions.json +``` + +### 4) pkg-2016-02-AzStk-loc +``` yaml $(tag) == 'pkg-2016-02-Az-loc' +input-file: +- Microsoft.Authorization/stable/2015-01-01/locks.json +``` + +### 5) pkg-2016-02-AzStk-pol +``` yaml $(tag) == 'pkg-2016-02-Az-pol' +input-file: +- Microsoft.Authorization/preview/2015-10-01-preview/policy.json +``` + +``` yaml $(Seperator) +########################################################################### +########################################################################### +``` + + +``` yaml $(resources-2018-02-01) +tag: pkg-2018-02-Az-res +``` + +``` yaml $(links-2016-09-01) +tag: pkg-2018-02-Az-lnk +``` + +``` yaml $(subscription-2016-06-01) +tag: pkg-2018-02-Az-sub +``` + +``` yaml $(locks-2016-09-01) +tag: pkg-2018-02-Az-loc +``` + +``` yaml $(policyA-2016-12-01) +tag: pkg-2018-02-Az-polA +``` + +``` yaml $(policyD-2016-12-01) +tag: pkg-2018-02-Az-polD +``` + + +## Tag: Packages for Azure Stack +### 1) pkg-2018-02-AzStk-res +``` yaml $(tag) == 'pkg-2018-02-Az-res' +input-file: +- Microsoft.Resources/stable/2018-02-01/resources.json +``` + +### 2) pkg-2018-02-AzStk-lnk +``` yaml $(tag) == 'pkg-2018-02-Az-lnk' +input-file: +- Microsoft.Resources/stable/2016-09-01/links.json +``` + +### 3) pkg-2018-02-AzStk-sub +``` yaml $(tag) == 'pkg-2018-02-Az-sub' +input-file: +- Microsoft.Resources/stable/2016-06-01/subscriptions.json +``` + +### 4) pkg-2018-02-AzStk-loc +``` yaml $(tag) == 'pkg-2018-02-Az-loc' +input-file: +- Microsoft.Authorization/stable/2016-09-01/locks.json +``` + +### 5) pkg-2018-02-AzStk-polA +``` yaml $(tag) == 'pkg-2018-02-Az-polA' +input-file: +- Microsoft.Authorization/stable/2016-12-01/policyAssignments.json +``` + +### 6) pkg-2018-02-AzStk-polD +``` yaml $(tag) == 'pkg-2018-02-Az-polD' +input-file: +- Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json +``` + +``` yaml $(Seperator) +########################################################################### +########################################################################### +``` + + +``` yaml $(resources-2018-05-01) +tag: pkg-2018-05-Az-res +``` + +``` yaml $(links-2016-09-01) +tag: pkg-2018-05-Az-lnk +``` + +``` yaml $(subscription-2016-06-01) +tag: pkg-2018-05-Az-sub +``` + +``` yaml $(locks-2016-09-01) +tag: pkg-2018-05-Az-loc +``` + +``` yaml $(policyA-2016-12-01) +tag: pkg-2018-05-Az-polA +``` + +``` yaml $(policyD-2016-12-01) +tag: pkg-2018-05-Az-polD +``` + + +## Tag: Packages for Azure Stack +### 1) pkg-2018-05-AzStk-res +``` yaml $(tag) == 'pkg-2018-05-Az-res' +input-file: +- Microsoft.Resources/stable/2018-05-01/resources.json +``` + +### 2) pkg-2018-05-AzStk-lnk +``` yaml $(tag) == 'pkg-2018-05-Az-lnk' +input-file: +- Microsoft.Resources/stable/2016-09-01/links.json +``` + +### 3) pkg-2018-05-AzStk-sub +``` yaml $(tag) == 'pkg-2018-05-Az-sub' +input-file: +- Microsoft.Resources/stable/2016-06-01/subscriptions.json +``` + +### 4) pkg-2018-05-AzStk-loc +``` yaml $(tag) == 'pkg-2018-05-Az-loc' +input-file: +- Microsoft.Authorization/stable/2016-09-01/locks.json +``` + +### 5) pkg-2018-05-AzStk-polA +``` yaml $(tag) == 'pkg-2018-05-Az-polA' +input-file: +- Microsoft.Authorization/stable/2016-12-01/policyAssignments.json +``` + +### 6) pkg-2018-05-AzStk-polD +``` yaml $(tag) == 'pkg-2018-05-Az-polD' +input-file: +- Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json +``` diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index e9ba21c02e03..76774edc20f4 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -37,11 +37,11 @@ tag: package-locks-2016-09 ``` ``` yaml $(package-policy) -tag: package-policy-2017-06 +tag: package-policy-2018-03 ``` ``` yaml $(package-resources) -tag: package-resources-2018-02 +tag: package-resources-2018-05 ``` ``` yaml $(package-subscriptions) @@ -80,6 +80,20 @@ input-file: - Microsoft.Authorization/stable/2015-01-01/locks.json ``` +### Tag: package-policy-2018-03 +These settings apply only when `--tag=package-policy-2018-03` is specified on the command line. + +``` yaml $(tag) == 'package-policy-2018-03' +input-file: +- Microsoft.Authorization/stable/2018-03-01/policyAssignments.json +- Microsoft.Authorization/stable/2018-03-01/policyDefinitions.json +- Microsoft.Authorization/stable/2018-03-01/policySetDefinitions.json + +# Needed when there is more than one input file +override-info: + title: PolicyClient +``` + ### Tag: package-policy-2017-06 These settings apply only when `--tag=package-policy-2017-06` is specified on the command line. @@ -94,6 +108,19 @@ override-info: title: PolicyClient ``` +### Tag: package-pure-policy-2017-06 +These settings apply only when `--tag=package-pure-policy-2017-06` is specified on the command line. + +``` yaml $(tag) == 'package-pure-policy-2017-06' +input-file: +- Microsoft.Authorization/preview/2017-06-01-preview/policyAssignments.json +- Microsoft.Authorization/preview/2017-06-01-preview/policySetDefinitions.json + +# Needed when there is more than one input file +override-info: + title: PolicyClient +``` + ### Tag: package-policy-2016-12 These settings apply only when `--tag=package-policy-2016-12` is specified on the command line. @@ -123,6 +150,14 @@ input-file: - Microsoft.Authorization/preview/2015-10-01-preview/policy.json ``` +### Tag: package-resources-2018-05 +These settings apply only when `--tag=package-resources-2018-05` is specified on the command line. + +``` yaml $(tag) == 'package-resources-2018-05' +input-file: +- Microsoft.Resources/stable/2018-05-01/resources.json +``` + ### Tag: package-resources-2018-02 These settings apply only when `--tag=package-resources-2018-02` is specified on the command line. @@ -195,6 +230,14 @@ input-file: - Microsoft.Resources/stable/2016-09-01/links.json ``` +### Tag: package-managedapplications-2018-06 +These settings apply only when `--tag=package-managedapplications-2018-06` is specified on the command line. + +``` yaml $(tag) == 'package-managedapplications-2018-06' +input-file: +- Microsoft.Solutions/stable/2018-06-01/managedapplications.json +``` + ### Tag: package-managedapplications-2017-09 These settings apply only when `--tag=package-managedapplications-2017-09` is specified on the command line. @@ -222,6 +265,18 @@ directive: from: policyDefinitions.json where: $.paths reason: policy definition under an extension resource with Microsoft.Management + - suppress: OperationsAPIImplementation + from: policyAssignments.json + where: $.paths + reason: operation APIs for Microsoft.Authorization are to be defined in RBAC swagger + - suppress: OperationsAPIImplementation + from: policyDefinitions.json + where: $.paths + reason: operation APIs for Microsoft.Authorization are to be defined in RBAC swagger + - suppress: OperationsAPIImplementation + from: policySetDefinitions.json + where: $.paths + reason: operation APIs for Microsoft.Authorization are to be defined in RBAC swagger - suppress: BodyTopLevelProperties from: resources.json where: $.definitions.ResourceGroup.properties @@ -267,35 +322,11 @@ swagger-to-sdk: - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#resources - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#subscriptions - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#links - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node ``` - -## 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 - namespace: Microsoft.Azure.Management.ResourceManager - license-header: MICROSOFT_MIT_NO_VERSION - output-folder: $(csharp-sdks-folder)/Resource/Management.ResourceManager/Generated -batch: - - package-features: true - clear-output-folder: true # clear output folder on first run - - package-locks: true - - package-policy: true - - package-resources: true - - package-subscriptions: true - - package-links: true -# - package-managedapplications: true -``` - - ## Go These settings apply only when `--go` is specified on the command line. @@ -313,10 +344,12 @@ batch: - tag: package-features-2015-12 - tag: package-locks-2016-09 - tag: package-locks-2015-01 + - tag: package-policy-2018-03 - tag: package-policy-2017-06 - tag: package-policy-2016-12 - tag: package-policy-2016-04 - tag: package-policy-2015-10 + - tag: package-resources-2018-05 - tag: package-resources-2018-02 - tag: package-resources-2017-05 - tag: package-resources-2016-09 @@ -326,6 +359,8 @@ batch: - tag: package-subscriptions-2016-06 - tag: package-subscriptions-2015-11 - tag: package-links-2016-09 + - tag: package-managedapplications-2018-06 + - tag: package-managedapplications-2017-09 - tag: package-managedapplications-2016-09 ``` @@ -359,6 +394,16 @@ namespace: locks output-folder: $(go-sdk-folder)/services/resources/mgmt/2015-01-01/locks ``` +### Tag: package-policy-2018-03 and go + +These settings apply only when `--tag=package-policy-2018-03 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-policy-2018-03' && $(go) +namespace: policy +output-folder: $(go-sdk-folder)/services/resources/mgmt/2018-03-01/policy +``` + ### Tag: package-policy-2017-06 and go These settings apply only when `--tag=package-policy-2017-06 --go` is specified on the command line. @@ -366,7 +411,7 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-resources-2018-05' && $(go) +namespace: resources +output-folder: $(go-sdk-folder)/services/resources/mgmt/2018-05-01/resources ``` ### Tag: package-resources-2018-02 and go @@ -489,6 +544,26 @@ namespace: links output-folder: $(go-sdk-folder)/services/resources/mgmt/2016-09-01/links ``` +### Tag: package-managedapplications-2018-06 and go + +These settings apply only when `--tag=package-managedapplications-2018-06 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-managedapplications-2018-06' && $(go) +namespace: managedapplications +output-folder: $(go-sdk-folder)/services/resources/mgmt/2018-06-01/managedapplications +``` + +### Tag: package-managedapplications-2017-09 and go + +These settings apply only when `--tag=package-managedapplications-2017-09 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-managedapplications-2017-09' && $(go) +namespace: managedapplications +output-folder: $(go-sdk-folder)/services/resources/mgmt/2017-09-01/managedapplications +``` + ### Tag: package-managedapplications-2016-09 and go These settings apply only when `--tag=package-managedapplications-2016-09 --go` is specified on the command line. @@ -496,7 +571,7 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-managedapplications-2018-06' && $(python) +python: + namespace: azure.mgmt.resource.managedapplications + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/managedapplications +``` + ### Tag: package-managedapplications-2017-09 and python These settings apply only when `--tag=package-managedapplications-2017-09 --python` is specified on the command line. @@ -592,6 +681,17 @@ python: output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/managedapplications ``` +### Tag: package-policy-2018-03 and python + +These settings apply only when `--tag=package-policy-2018-03 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-policy-2018-03' && $(python) +python: + namespace: azure.mgmt.resource.policy.v2018_03_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/policy/v2018_03_01 +``` + ### Tag: package-policy-2017-06 and python These settings apply only when `--tag=package-policy-2017-06 --python` is specified on the command line. @@ -636,6 +736,17 @@ python: output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/policy/v2015_10_01_preview ``` +### Tag: package-resources-2018-05 and python + +These settings apply only when `--tag=package-resources-2018-05 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-resources-2018-05' && $(python) +python: + namespace: azure.mgmt.resource.resources.v2018_05_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/resources/v2018_05_01 +``` + ### Tag: package-resources-2018-02 and python These settings apply only when `--tag=package-resources-2018-02 --python` is specified on the command line. @@ -697,10 +808,12 @@ 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 - fluent: true - license-header: MICROSOFT_MIT_NO_CODEGEN +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.resources +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-resources ``` ### Java multi-api @@ -711,7 +824,9 @@ Generate all API versions currently shipped for this package batch: - tag: package-features-2015-12 - tag: package-locks-2016-09 - - tag: package-policy-2016-04 + - tag: package-policy-2018-03 + - tag: package-policy-2016-12 + - tag: package-resources-2018-02 - tag: package-resources-2016-09 - tag: package-subscriptions-2016-06 ``` @@ -719,12 +834,15 @@ batch: ### Tag: package-features-2015-12 and java These settings apply only when `--tag=package-features-2015-12 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. +Please also specify `--azure-libraries-for-java-folder=`. -``` yaml $(tag) == 'package-features-2015-12' && $(java) +``` yaml $(tag) == 'package-features-2015-12' && $(java) && $(multiapi) java: - namespace: com.microsoft.azure.management.resources - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-resources + namespace: com.microsoft.azure.management.features.v2015_12_01 + output-folder: $(azure-libraries-for-java-folder)/features/resource-manager/v2015_12_01 +regenerate-manager: true +generate-interface: true +fconfig: '{"moduleName": "Features"}' ``` ### Tag: package-locks-2016-09 and java @@ -732,22 +850,62 @@ java: These settings apply only when `--tag=package-locks-2016-09 --java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. -``` yaml $(tag) == 'package-locks-2016-09' && $(java) +``` yaml $(tag) == 'package-locks-2016-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.locks.v2016_09_01 + output-folder: $(azure-libraries-for-java-folder)/locks/resource-manager/v2016_09_01 +regenerate-manager: true +generate-interface: true +fconfig: '{"moduleName": "Locks"}' +``` + +### Tag: package-policy-2018-03 and java + +These settings apply only when `--tag=package-policy-2018-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-policy-2018-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.policy.v2018_03_01 + output-folder: $(azure-libraries-for-java-folder)/policy/resource-manager/v2018_03_01 +regenerate-manager: true +generate-interface: true +fconfig: '{"moduleName": "Policy"}' +directive: + from: policyAssignments.json + where: $.definitions.PolicyAssignmentProperties.properties.scope + transform: $['x-ms-client-name'] = 'scopeProperty' +``` + +### Tag: package-policy-2016-12 and java + +These settings apply only when `--tag=package-policy-2016-12 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-policy-2016-12' && $(java) && $(multiapi) java: - payload-flattening-threshold: 1 - namespace: com.microsoft.azure.management.locks - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-locks + namespace: com.microsoft.azure.management.policy.v2016_12_01 + output-folder: $(azure-libraries-for-java-folder)/policy/resource-manager/v2016_12_01 +regenerate-manager: true +generate-interface: true +fconfig: '{"moduleName": "Policy"}' +directive: + from: policyAssignments.json + where: $.definitions.PolicyAssignmentProperties.properties.scope + transform: $['x-ms-client-name'] = 'scopeProperty' ``` -### Tag: package-policy-2016-04 and java +### Tag: package-resources-2018-02 and java -These settings apply only when `--tag=package-policy-2016-04 --java` is specified on the command line. +These settings apply only when `--tag=package-resources-2018-02 --java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. -``` yaml $(tag) == 'package-policy-2016-04' && $(java) +``` yaml $(tag) == 'package-resources-2018-02' && $(java) && $(multiapi) java: - namespace: com.microsoft.azure.management.resources - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-resources + namespace: com.microsoft.azure.management.resources.v2018_02_01 + output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2018_02_01 +regenerate-manager: true +generate-interface: true ``` ### Tag: package-resources-2016-09 and java @@ -755,10 +913,12 @@ java: These settings apply only when `--tag=package-resources-2016-09 --java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. -``` yaml $(tag) == 'package-resources-2016-09' && $(java) +``` yaml $(tag) == 'package-resources-2016-09' && $(java) && $(multiapi) java: - namespace: com.microsoft.azure.management.resources - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-resources + namespace: com.microsoft.azure.management.resources.v2016_09_01 + output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2016_09_01 +regenerate-manager: true +generate-interface: true ``` ### Tag: package-subscriptions-2016-06 and java @@ -766,10 +926,12 @@ java: These settings apply only when `--tag=package-subscriptions-2016-06--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. -``` yaml $(tag) == 'package-subscriptions-2016-06' && $(java) +``` yaml $(tag) == 'package-subscriptions-2016-06' && $(java) && $(multiapi) java: - namespace: com.microsoft.azure.management.resources - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-resources + namespace: com.microsoft.azure.management.resources.v2016_06_01 + output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2016_06_01 +regenerate-manager: true +generate-interface: true ``` # Validation @@ -785,4 +947,4 @@ batch: - package-subscriptions: true - package-links: true - package-managedapplications: true -``` \ No newline at end of file +``` diff --git a/specification/resources/resource-manager/readme.nodejs.md b/specification/resources/resource-manager/readme.nodejs.md index 96189d0f149b..ca0ac64d44e6 100644 --- a/specification/resources/resource-manager/readme.nodejs.md +++ b/specification/resources/resource-manager/readme.nodejs.md @@ -6,53 +6,54 @@ Please also specify `--node-sdks-folder=`. + +``` yaml $(tag) == 'package-managedapplications-2018-06' && $(ruby) +namespace: "Azure::ManagedApplications::Mgmt::V2018_06_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_managed_applications/lib +``` + +### Tag: package-managedapplications-2017-09 and ruby + +These settings apply only when `--tag=package-managedapplications-2017-09 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-managedapplications-2017-09' && $(ruby) +namespace: "Azure::ManagedApplications::Mgmt::V2017_09_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_managed_applications/lib +``` + +### Tag: package-managedapplications-2016-09 and ruby + +These settings apply only when `--tag=package-managedapplications-2016-09 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-managedapplications-2016-09' && $(ruby) +namespace: "Azure::ManagedApplications::Mgmt::V2016_09_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_managed_applications/lib +``` + +### Ruby multi-api for subscriptions + +``` yaml $(multiapi) && $(subscriptions) +package-name: azure_mgmt_subscriptions +package-version: "0.16.0" +azure-arm: true +batch: + - tag: package-subscriptions-2016-06 + - tag: package-subscriptions-2015-11 +``` + +### Tag: package-subscriptions-2016-06 and ruby + +These settings apply only when `--tag=package-subscriptions-2016-06 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-subscriptions-2016-06' && $(ruby) +namespace: "Azure::Subscriptions::Mgmt::V2016_06_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_subscriptions/lib +``` + +### Tag: package-subscriptions-2015-11 and ruby + +These settings apply only when `--tag=package-subscriptions-2015-11 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-subscriptions-2015-11' && $(ruby) +namespace: "Azure::Subscriptions::Mgmt::V2015_11_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_subscriptions/lib +``` + +### Ruby multi-api for features + +``` yaml $(multiapi) && $(features) +package-name: azure_mgmt_features +package-version: "0.16.0" +azure-arm: true +batch: + - tag: package-features-2015-12 +``` + +### Tag: package-features-2015-12 and ruby + +These settings apply only when `--tag=package-features-2015-12 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-features-2015-12' && $(ruby) +namespace: "Azure::Features::Mgmt::V2015_12_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_features/lib +``` + +### Ruby multi-api for locks + +``` yaml $(multiapi) && $(locks) +package-name: azure_mgmt_locks +package-version: "0.16.0" +azure-arm: true +batch: + - tag: package-locks-2016-09 + - tag: package-locks-2015-01 +``` + +### Tag: package-locks-2016-09 and ruby + +These settings apply only when `--tag=package-locks-2016-09 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-locks-2016-09' && $(ruby) +namespace: "Azure::Locks::Mgmt::V2016_09_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_locks/lib +``` + +### Tag: package-locks-2015-01 and ruby + +These settings apply only when `--tag=package-locks-2015-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-locks-2015-01' && $(ruby) +namespace: "Azure::Locks::Mgmt::V2015_01_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_locks/lib +``` + +### Ruby multi-api for links + +``` yaml $(multiapi) && $(links) +package-name: azure_mgmt_links +package-version: "0.16.0" +azure-arm: true +batch: + - tag: package-links-2016-09 +``` + +### Tag: package-links-2016-09 and ruby + +These settings apply only when `--tag=package-links-2016-09 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-links-2016-09' && $(ruby) +namespace: "Azure::Links::Mgmt::V2016_09_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_links/lib +``` + +### Ruby multi-api for policy + +``` yaml $(multiapi) && $(policy) +package-name: azure_mgmt_policy +package-version: "0.16.0" +azure-arm: true +batch: + - tag: package-pure-policy-2017-06 + - tag: package-policy-2016-12 + - tag: package-policy-2016-04 + - tag: package-policy-2015-10 +``` + +### Tag: package-pure-policy-2017-06 and ruby + +These settings apply only when `--tag=package-pure-policy-2017-06 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-pure-policy-2017-06' && $(ruby) +namespace: "Azure::Policy::Mgmt::V2017_06_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_policy/lib +``` + +### Tag: package-policy-2016-12 and ruby + +These settings apply only when `--tag=package-policy-2016-12 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-policy-2016-12' && $(ruby) +namespace: "Azure::Policy::Mgmt::V2016_12_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_policy/lib +``` + +### Tag: package-policy-2016-04 and ruby + +These settings apply only when `--tag=package-policy-2016-04 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-policy-2016-04' && $(ruby) +namespace: "Azure::Policy::Mgmt::V2016_04_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_policy/lib +``` + +### Tag: package-policy-2015-10 and ruby + +These settings apply only when `--tag=package-policy-2015-10 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-policy-2015-10' && $(ruby) +namespace: "Azure::Policy::Mgmt::V2015_10_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_policy/lib +``` + +### Ruby multi-api for resources + +``` yaml $(multiapi) && $(resources) +package-name: azure_mgmt_resources +package-version: "0.16.0" +azure-arm: true +batch: + - tag: package-resources-2017-05 + - tag: package-resources-2016-09 + - tag: package-resources-2016-07 + - tag: package-resources-2016-02 +``` + +### Tag: package-resources-2017-05 and ruby + +These settings apply only when `--tag=package-resources-2017-05 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-resources-2017-05' && $(ruby) +namespace: "Azure::Resources::Mgmt::V2017_05_10" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_resources/lib +``` + +### Tag: package-resources-2016-09 and ruby + +These settings apply only when `--tag=package-resources-2016-09 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-resources-2016-09' && $(ruby) +namespace: "Azure::Resources::Mgmt::V2016_09_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_resources/lib +``` + +### Tag: package-resources-2016-07 and ruby + +These settings apply only when `--tag=package-resources-2016-07 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-resources-2016-07' && $(ruby) +namespace: "Azure::Resources::Mgmt::V2016_07_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_resources/lib +``` + +### Tag: package-resources-2016-02 and ruby + +These settings apply only when `--tag=package-resources-2016-02 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-resources-2016-02' && $(ruby) +namespace: "Azure::Resources::Mgmt::V2016_02_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_resources/lib +``` \ No newline at end of file diff --git a/specification/scheduler/resource-manager/readme.md b/specification/scheduler/resource-manager/readme.md index 7620f2747c73..4d51ad0688ff 100644 --- a/specification/scheduler/resource-manager/readme.md +++ b/specification/scheduler/resource-manager/readme.md @@ -70,9 +70,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_scheduler'] ``` @@ -163,7 +166,7 @@ These settings apply only when `--tag=package-2014-08-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2014-08-preview' && $(go) -output-folder: $(go-sdk-folder)/services/scheduler/mgmt/2014-08-01-preview/scheduler +output-folder: $(go-sdk-folder)/services/preview/scheduler/mgmt/2014-08-01-preview/scheduler ``` @@ -173,11 +176,60 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.scheduler +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-scheduler +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2014-08-preview + - tag: package-2016-01 + - tag: package-2016-03 +``` + +### Tag: package-2014-08-preview and java + +These settings apply only when `--tag=package-2014-08-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2014-08-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.scheduler - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-scheduler + namespace: com.microsoft.azure.management.scheduler.v2014_08_01_preview + output-folder: $(azure-libraries-for-java-folder)/scheduler/resource-manager/v2014_08_01_preview +regenerate-manager: true +generate-interface: true ``` + +### Tag: package-2016-01 and java + +These settings apply only when `--tag=package-2016-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.scheduler.v2016_01_01 + output-folder: $(azure-libraries-for-java-folder)/scheduler/resource-manager/v2016_01_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-03 and java + +These settings apply only when `--tag=package-2016-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.scheduler.v2016_03_01 + output-folder: $(azure-libraries-for-java-folder)/scheduler/resource-manager/v2016_03_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/scheduler/resource-manager/readme.ruby.md b/specification/scheduler/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..dbd430b2676e --- /dev/null +++ b/specification/scheduler/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_scheduler +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2016-03 +``` + +### Tag: package-2016-03 and ruby + +These settings apply only when `--tag=package-2016-03 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-03' && $(ruby) +namespace: "Azure::Scheduler::Mgmt::V2016_03_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_scheduler/lib +``` diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexCountDocuments.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexCountDocuments.json new file mode 100644 index 000000000000..acc0d868dddf --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexCountDocuments.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": 427 + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexGetAutocomplete.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexGetAutocomplete.json new file mode 100644 index 000000000000..2ddae016840d --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexGetAutocomplete.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2017-11-11-Preview", + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "fuzzy": false, + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "searchFields": "title,description", + "top": "10" + }, + "responses": { + "200": { + "body": [ + { + "text": "medicaid", + "queryPlusText": "washington medicaid" + }, + { + "text": "medicare", + "queryPlusText": "washington medicare" + }, + { + "text": "medicine", + "queryPlusText": "washington medicine" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexPostAutocomplete.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexPostAutocomplete.json new file mode 100644 index 000000000000..41d9263200f6 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexPostAutocomplete.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2017-11-11-Preview", + "autocompleteRequest": { + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "searchFields": "title,description", + "top": "10" + } + }, + "responses": { + "200": { + "body": [ + { + "text": "medicaid", + "queryPlusText": "washington medicaid" + }, + { + "text": "medicare", + "queryPlusText": "washington medicare" + }, + { + "text": "medicine", + "queryPlusText": "washington medicine" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/searchindex.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/searchindex.json new file mode 100644 index 000000000000..1e02154dbd01 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/searchindex.json @@ -0,0 +1,585 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchIndexClient", + "description": "Client that can be used to query an Azure Search index and upload, merge, or delete documents.", + "version": "2017-11-11-Preview", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true, + "syncMethods": "None" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "https://{searchServiceName}.{searchDnsSuffix}/indexes('{indexName}')", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "$ref": "#/parameters/SearchDnsSuffixParameter" + }, + { + "$ref": "#/parameters/IndexNameParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/docs/$count": { + "get": { + "tags": [ + "DocumentsProxy" + ], + "operationId": "DocumentsProxy_Count", + "x-ms-examples": { + "SearchIndexCountDocuments": { "$ref": "./examples/SearchIndexCountDocuments.json" } + }, + "description": "Queries the number of documents in the Azure Search index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Count-Documents" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "type": "integer", + "format": "int64" + } + } + } + } + }, + "/docs/autocomplete": { + "get": { + "tags": [ + "Autocomplete" + ], + "operationId": "DocumentsProxy_AutocompleteGet", + "x-ms-examples": { + "SearchIndexGetAutocomplete": { "$ref": "./examples/SearchIndexGetAutocomplete.json" } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name":"search", + "in": "query", + "type": "string", + "required": true, + "description": "The incomplete term which should be auto-completed.", + "x-ms-client-name": "searchText" + }, + { + "name":"suggesterName", + "in": "query", + "type": "string", + "required": true, + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "autocompleteMode", + "in": "query", + "type": "string", + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString": false + }, + "description": "Autocomplete mode.", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + }, + { + "name":"fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + }, + { + "name":"highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with HighlightPreTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + }, + { + "name":"highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with HighlightPostTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + }, + { + "name":"minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by am autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + }, + { + "name":"searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The comma-separated list of field names to consider when querying for auto-completed terms.", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + }, + { + "name":"$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is to 5.", + "x-ms-parameter-grouping": { + "name": "AutocompleteParameters" + } + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AutocompleteResult", + "description": "The result of Autocomplete query." + } + } + } + }, + "post": { + "tags": [ + "Autocomplete" + ], + "operationId": "DocumentsProxy_AutocompletePost", + "x-ms-examples": { + "SearchIndexPostAutocomplete": { "$ref": "./examples/SearchIndexPostAutocomplete.json" } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "AutocompleteRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutocompleteRequest", + "description": "The Autocomplete request." + }, + "description": "The definition of the Autocomplete request." + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AutocompleteResult", + "description": "The result of Autocomplete query." + } + } + } + } + + } + }, + "definitions": { + "IndexingResult": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of a document that was in the indexing request." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded." + }, + "status": { + "x-ms-client-name": "Succeeded", + "type": "boolean", + "x-nullable": false, + "readOnly": true, + "description": "A value indicating whether the indexing operation succeeded for the document identified by the key." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + } + }, + "description": "Status of an indexing operation for a single document." + }, + "DocumentIndexResult": { + "properties": { + "value": { + "x-ms-client-name": "Results", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexingResult" + }, + "description": "The list of status information for each document in the indexing request." + } + }, + "description": "Response containing the status of operations for all documents in the indexing request." + }, + "IndexActionType": { + "type": "string", + "enum": [ + "upload", + "merge", + "mergeOrUpload", + "delete" + ], + "x-ms-enum": { "name": "IndexActionType" }, + "description": "Specifies the operation to perform on a document in an indexing batch." + }, + "SearchMode": { + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { "name": "SearchMode" }, + "description": "Specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "QueryType": { + "type": "string", + "enum": [ + "simple", + "full" + ], + "x-ms-enum": { "name": "QueryType" }, + "description": "Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." + }, + "AutocompleteMode": { + "type": "string", + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { "name": "AutocompleteMode", + "modelAsString" : false }, + "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." + }, + "SearchParametersPayload": { + "properties": { + "count": { + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation." + }, + "facets": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs." + }, + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "The OData $filter expression to apply to the search query." + }, + "highlight": { + "type": "string", + "description": "The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting." + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with HighlightPreTag. Default is </em>." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with HighlightPostTag. Default is <em>." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to the geo.distance() function. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 Orderby clauses." + }, + "queryType": { + "$ref": "#/definitions/QueryType", + "description": "Gets or sets a value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." + }, + "scoringParameters": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name:value. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation:-122.2,44.8\"(without the quotes)." + }, + "scoringProfile": { + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results." + }, + "search": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Simple-query-syntax-in-Azure-Search" + }, + "type": "string", + "description": "A full-text search query expression; Use null or \"*\" to match all documents." + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to include in the full-text search." + }, + "searchMode": { + "$ref": "#/definitions/SearchMode", + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included." + }, + "skip": { + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use Skip due to this limitation, consider using OrderBy on a totally-ordered key and Filter with a range query instead." + }, + "top": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with Skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be passed to ContinueSearch to retrieve the next page of results. See DocumentSearchResponse.ContinuationToken for more information." + } + }, + "description": "Parameters for filtering, sorting, faceting, paging, and other search query behaviors." + }, + "SuggestParametersPayload": { + "properties": { + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "The OData $filter expression to apply to the suggestions query." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources." + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with HighlightPreTag. If omitted, hit highlighting of suggestions is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with HighlightPostTag. If omitted, hit highlighting of suggestions is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to the geo.distance() function. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 Orderby clauses." + }, + "search": { + "type": "string", + "description": "The search text on which to base suggestions." + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to consider when querying for suggestions." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. This must be a value between 1 and 100. The default is to 5." + } + }, + "description": "Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors." + }, + "AutocompleteRequest": { + "properties": { + "search": { + "type": "string", + "description": "The search text on which to base autocomplete results.", + "x-ms-client-name": "searchText" + }, + "autocompleteMode": { + "$ref": "#/definitions/AutocompleteMode", + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with HighlightPreTag. If omitted, hit highlighting is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with HighlightPostTag. If omitted, hit highlighting is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by am autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to consider when querying for auto-completed terms." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is to 5." + } + }, + "description": "Parameters for fuzzy matching, and other autocomplete query behaviors." + }, + "AutocompleteResult" : { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AutocompleteItem" + }, + "description": "The list of returned Autocompleted items.", + "x-ms-client-name": "Results" + } + }, + "description": "The result of Autocomlete query." + }, + "AutocompleteItem": { + "properties": { + "text": { + "type": "string", + "description": "The completed term." + }, + "queryPlusText": { + "type": "string", + "description": "The query along with the completed term." + } + }, + "description": "The result of Autocomplete requests." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { "name": "search-request-options" }, + "x-ms-parameter-location": "method" + }, + "SearchServiceNameParameter": { + "name": "searchServiceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The name of the Azure Search service.", + "x-ms-parameter-location": "client" + }, + "SearchDnsSuffixParameter": { + "name": "searchDnsSuffix", + "in": "path", + "required": true, + "type": "string", + "default": "search.windows.net", + "x-ms-skip-url-encoding": true, + "description": "The DNS suffix of the Azure Search service. The default is search.windows.net.", + "x-ms-parameter-location": "client" + }, + "IndexNameParameter": { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": false, + "description": "The name of the Azure Search index.", + "x-ms-parameter-location": "client" + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/readme.md b/specification/search/data-plane/Microsoft.Azure.Search.Data/readme.md index 2bb7df1c7925..9c98b43f7ef8 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Data/readme.md +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/readme.md @@ -24,9 +24,17 @@ These are the global settings for SearchIndexClient. ``` yaml openapi-type: data-plane -tag: package-2017-11 +tag: package-2017-11-preview ``` +### Tag: package-2017-11-preview + +These settings apply only when `--tag=package-2017-11-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-11-preview' +input-file: +- preview/2017-11-11-preview/searchindex.json +``` ### Tag: package-2017-11 These settings apply only when `--tag=package-2017-11` is specified on the command line. diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateDataSource.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateDataSource.json new file mode 100644 index 000000000000..8999bd3497b8 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateDataSource.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2017-11-11-Preview", + "dataSource": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "documentdb", + "credentials": { + "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId" + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + }, + "responses": { + "201": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "documentdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateIndex.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateIndex.json new file mode 100644 index 000000000000..b15839baf7a2 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateIndex.json @@ -0,0 +1,346 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2017-11-11-Preview", + "index": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "key": true, + "searchable": false + }, + { + "name": "baseRate", + "type": "Edm.Double" + }, + { + "name": "description", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "category", + "type": "Edm.String" + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "analyzer": "tagsAnalyzer" + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean" + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean" + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset" + }, + { + "name": "rating", + "type": "Edm.Int32" + }, + { + "name": "location", + "type": "Edm.GeographyPoint" + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + } + } + }, + "responses": { + "201": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + } + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateIndexer.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateIndexer.json new file mode 100644 index 000000000000..1e165d24da24 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateIndexer.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2017-11-11-Preview", + "indexer": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + } + } + }, + "responses": { + "201": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateDataSource.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateDataSource.json new file mode 100644 index 000000000000..b41ab3a73b5e --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateDataSource.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2017-11-11-Preview", + "Prefer": "return=representation", + "dataSource": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "documentdb", + "credentials": { + "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId" + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + }, + "responses": { + "200": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "documentdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + }, + "201": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "documentdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateIndex.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateIndex.json new file mode 100644 index 000000000000..a7a35c5a240e --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateIndex.json @@ -0,0 +1,575 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "hotels", + "allowIndexDowntime": false, + "api-version": "2017-11-11-Preview", + "Prefer": "return=representation", + "index": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "key": true, + "searchable": false + }, + { + "name": "baseRate", + "type": "Edm.Double" + }, + { + "name": "description", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "category", + "type": "Edm.String" + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "analyzer": "tagsAnalyzer" + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean" + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean" + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset" + }, + { + "name": "rating", + "type": "Edm.Int32" + }, + { + "name": "location", + "type": "Edm.GeographyPoint" + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + } + } + }, + "responses": { + "200": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + } + } + }, + "201": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + } + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateIndexer.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateIndexer.json new file mode 100644 index 000000000000..6872817d70cc --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateIndexer.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexerName": "myindexer", + "api-version": "2017-11-11-Preview", + "Prefer": "return=representation", + "indexer": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + } + } + }, + "responses": { + "200": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + }, + "201": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateSkillset.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateSkillset.json new file mode 100644 index 000000000000..ce0b62936272 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateSkillset.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2017-11-11-Preview", + "Prefer": "return=representation", + "skillset": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [{ + "@odata.type": "#Microsoft.Skills.Text.NamedEntityRecognitionSkill", + "categories": ["Organization"], + "defaultLanguageCode": "en", + "inputs": [{ + "name": "text", + "source": "/document/content" + }], + "outputs": [{ + "name": "organizations", + "targetName": "organizations" + }] + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "inputs": [{ + "name": "text", + "source": "/document/content" + }], + "outputs": [{ + "name": "languageCode", + "targetName": "languageCode" + }] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "inputs": [{ + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + }], + "outputs": [{ + "name": "textItems", + "targetName": "pages" + }] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "context": "/document/pages/*", + "inputs": [{ + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + }], + "outputs": [{ + "name": "keyPhrases", + "targetName": "keyPhrases" + }] + }] + } + }, + "responses": { + "200": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [{ + "@odata.type": "#Microsoft.Skills.Text.NamedEntityRecognitionSkill", + "description": null, + "context": null, + "inputs": [{ + "name": "text", + "source": "/document/content" + }], + "outputs": [{ + "name": "organizations", + "targetName": "organizations" + }], + "categories": ["Organization"], + "defaultLanguageCode": "en", + "minimumPrecision": null + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "description": null, + "context": null, + "inputs": [{ + "name": "text", + "source": "/document/content" + }], + "outputs": [{ + "name": "languageCode", + "targetName": "languageCode" + }] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "description": null, + "context": null, + "inputs": [{ + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + }], + "outputs": [{ + "name": "textItems", + "targetName": "pages" + }], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "description": null, + "context": "/document/pages/*", + "inputs": [{ + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + }], + "outputs": [{ + "name": "keyPhrases", + "targetName": "keyPhrases" + }], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }] + } + }, + "201": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [{ + "@odata.type": "#Microsoft.Skills.Text.NamedEntityRecognitionSkill", + "description": null, + "context": null, + "inputs": [{ + "name": "text", + "source": "/document/content" + }], + "outputs": [{ + "name": "organizations", + "targetName": "organizations" + }], + "categories": ["Organization"], + "defaultLanguageCode": "en", + "minimumPrecision": null + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "description": null, + "context": null, + "inputs": [{ + "name": "text", + "source": "/document/content" + }], + "outputs": [{ + "name": "languageCode", + "targetName": "languageCode" + }] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "description": null, + "context": null, + "inputs": [{ + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + }], + "outputs": [{ + "name": "textItems", + "targetName": "pages" + }], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "description": null, + "context": "/document/pages/*", + "inputs": [{ + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + }], + "outputs": [{ + "name": "keyPhrases", + "targetName": "keyPhrases" + }], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json new file mode 100644 index 000000000000..3e0a18c3407b --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2017-11-11-Preview", + "Prefer": "return=representation", + "synonymMap": { + "name" : "mysynonymmap", + "format" : "solr", + "synonyms" : "United States, United States of America, USA\nWashington, Wash. => WA" + } + }, + "responses": { + "200": { + "body": { + "name" : "mysynonymmap", + "format" : "solr", + "synonyms" : "United States, United States of America, USA\nWashington, Wash. => WA" + } + }, + "201": { + "body": { + "name" : "mysynonymmap", + "format" : "solr", + "synonyms" : "United States, United States of America, USA\nWashington, Wash. => WA" + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateSkillset.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateSkillset.json new file mode 100644 index 000000000000..e2951cd7aa66 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateSkillset.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2017-11-11-Preview", + "Prefer": "return=representation", + "skillset": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [{ + "@odata.type": "#Microsoft.Skills.Text.NamedEntityRecognitionSkill", + "categories": ["Organization"], + "defaultLanguageCode": "en", + "inputs": [{ + "name": "text", + "source": "/document/content" + }], + "outputs": [{ + "name": "organizations", + "targetName": "organizations" + }] + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "inputs": [{ + "name": "text", + "source": "/document/content" + }], + "outputs": [{ + "name": "languageCode", + "targetName": "languageCode" + }] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "inputs": [{ + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + }], + "outputs": [{ + "name": "textItems", + "targetName": "pages" + }] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "context": "/document/pages/*", + "inputs": [{ + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + }], + "outputs": [{ + "name": "keyPhrases", + "targetName": "keyPhrases" + }] + }] + } + }, + "responses": { + "201": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [{ + "@odata.type": "#Microsoft.Skills.Text.NamedEntityRecognitionSkill", + "description": null, + "context": null, + "inputs": [{ + "name": "text", + "source": "/document/content" + }], + "outputs": [{ + "name": "organizations", + "targetName": "organizations" + }], + "categories": ["Organization"], + "defaultLanguageCode": "en", + "minimumPrecision": null + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "description": null, + "context": null, + "inputs": [{ + "name": "text", + "source": "/document/content" + }], + "outputs": [{ + "name": "languageCode", + "targetName": "languageCode" + }] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "description": null, + "context": null, + "inputs": [{ + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + }], + "outputs": [{ + "name": "textItems", + "targetName": "pages" + }], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "description": null, + "context": "/document/pages/*", + "inputs": [{ + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + }], + "outputs": [{ + "name": "keyPhrases", + "targetName": "keyPhrases" + }], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateSynonymMap.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateSynonymMap.json new file mode 100644 index 000000000000..1633efdcd119 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateSynonymMap.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2017-11-11-Preview", + "synonymMap": { + "name" : "mysynonymmap", + "format" : "solr", + "synonyms" : "United States, United States of America, USA\nWashington, Wash. => WA" + } + }, + "responses": { + "201": { + "body": { + "name" : "mysynonymmap", + "format" : "solr", + "synonyms" : "United States, United States of America, USA\nWashington, Wash. => WA" + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteDataSource.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteDataSource.json new file mode 100644 index 000000000000..c19fbc4555db --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteDataSource.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "204": { }, + "404": { } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteIndex.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteIndex.json new file mode 100644 index 000000000000..ff7458e906e1 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteIndex.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "204": { }, + "404": { } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteIndexer.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteIndexer.json new file mode 100644 index 000000000000..1a78a4c84590 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteIndexer.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexerName": "myindexer", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "204": { }, + "404": { } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteSkillset.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteSkillset.json new file mode 100644 index 000000000000..fc6d60720b70 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteSkillset.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "204": { }, + "404": { } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteSynonymMap.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteSynonymMap.json new file mode 100644 index 000000000000..d2e50bb801bd --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceDeleteSynonymMap.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "204": { }, + "404": { } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetDataSource.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetDataSource.json new file mode 100644 index 000000000000..6ad8746ef316 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetDataSource.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "documentdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetIndex.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetIndex.json new file mode 100644 index 000000000000..828fde77c2fc --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetIndex.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "hotels", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + } + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetIndexStatistics.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetIndexStatistics.json new file mode 100644 index 000000000000..d80206a83d82 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetIndexStatistics.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "hotels", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": { + "documentCount": 239572, + "storageSize": 72375920 + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetIndexer.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetIndexer.json new file mode 100644 index 000000000000..a62939b173b6 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetIndexer.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexerName": "myindexer", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetIndexerStatus.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetIndexerStatus.json new file mode 100644 index 000000000000..5d08ca52269e --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetIndexerStatus.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexerName": "myindexer", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": { + "status": "running", + "lastResult": { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + "executionHistory": [ + { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + { + "status": "transientFailure", + "errorMessage": null, + "startTime": "2014-11-26T03:28:10.125Z", + "endTime": "2014-11-26T03:28:12.007Z", + "errors": [ + { + "key": "", + "status": false, + "errorMessage": "Document key cannot be missing or empty.", + "statusCode": 400 + } + ], + "warnings": [ + { + "key": "document id", + "message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob." + } + ], + "itemsProcessed": 1, + "itemsFailed": 1, + "initialTrackingState": null, + "finalTrackingState": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetServiceStatistics.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetServiceStatistics.json new file mode 100644 index 000000000000..a995407a03ce --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetServiceStatistics.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": { + "counters": { + "documentCount": { + "usage": 7093, + "quota": 10000 + }, + "indexesCount": { + "usage": 3, + "quota": 3 + }, + "indexersCount": { + "usage": 3, + "quota": 3 + }, + "dataSourcesCount": { + "usage": 1, + "quota": 3 + }, + "storageSize": { + "usage": 914529, + "quota": 52428800 + }, + "synonymMaps": { + "usage": 2, + "quota": 3 + } + }, + "limits": { + "maxFieldsPerIndex": 1000, + "maxFieldNestingDepthPerIndex": 10, + "maxComplexCollectionFieldsPerIndex": 100 + } + } + } + } +} diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetSkillset.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetSkillset.json new file mode 100644 index 000000000000..b48455bbe283 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetSkillset.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [{ + "@odata.type": "#Microsoft.Skills.Text.NamedEntityRecognitionSkill", + "description": null, + "context": null, + "inputs": [{ + "name": "text", + "source": "/document/content" + }], + "outputs": [{ + "name": "organizations", + "targetName": "organizations" + }], + "categories": ["Organization"], + "defaultLanguageCode": "en", + "minimumPrecision": null + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "description": null, + "context": null, + "inputs": [{ + "name": "text", + "source": "/document/content" + }], + "outputs": [{ + "name": "languageCode", + "targetName": "languageCode" + }] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "description": null, + "context": null, + "inputs": [{ + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + }], + "outputs": [{ + "name": "textItems", + "targetName": "pages" + }], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "description": null, + "context": "/document/pages/*", + "inputs": [{ + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + }], + "outputs": [{ + "name": "keyPhrases", + "targetName": "keyPhrases" + }], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetSynonymMap.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetSynonymMap.json new file mode 100644 index 000000000000..698a0d25bd91 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetSynonymMap.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": { + "name" : "mysynonymmap", + "format" : "solr", + "synonyms" : "United States, United States of America, USA\nWashington, Wash. => WA" + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceIndexAnalyze.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceIndexAnalyze.json new file mode 100644 index 000000000000..c4ec7c5e15d5 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceIndexAnalyze.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "hotels", + "api-version": "2017-11-11-Preview", + "request": { + "text": "Text to analyze", + "analyzer": "standard" + } + }, + "responses": { + "200": { + "body": { + "tokens": [ + { + "token": "text", + "startOffset": 0, + "endOffset": 4, + "position": 0 + }, + { + "token": "to", + "startOffset": 5, + "endOffset": 7, + "position": 1 + }, + { + "token": "analyze", + "startOffset": 8, + "endOffset": 15, + "position": 2 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListDataSources.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListDataSources.json new file mode 100644 index 000000000000..4a7cc71ea843 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListDataSources.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "documentdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + }, + { + "name": "myblobdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": null + }, + "container": { + "name": "mycontainer" + }, + "dataChangeDetectionPolicy": null, + "dataDeletionDetectionPolicy": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListIndexers.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListIndexers.json new file mode 100644 index 000000000000..84dce3d21d0c --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListIndexers.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydocdbdatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + }, + { + "name": "myotherindexer", + "description": "another cool indexer", + "dataSourceName": "myblobdatasource", + "targetIndexName": "orders", + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "batchSize": 15 + }, + "fieldMappings": [ + { + "sourceFieldName": "PersonName", + "targetFieldName": "FirstName", + "mappingFunction": { + "name": "extractTokenAtPosition", + "parameters": { + "delimiter": " ", + "position": 0 + } + } + }, + { + "sourceFieldName": "PersonName", + "targetFieldName": "LastName", + "mappingFunction": { + "name": "extractTokenAtPosition", + "parameters": { + "delimiter": " ", + "position": 1 + } + } + } + ], + "disabled": false + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListIndexes.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListIndexes.json new file mode 100644 index 000000000000..ef4d25d13e43 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListIndexes.json @@ -0,0 +1,281 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "$select": "name", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + } + }, + { + "name": "testindex", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": false, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "hidden", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": false, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [], + "defaultScoringProfile": null, + "suggesters": [], + "analyzers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListSkillsets.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListSkillsets.json new file mode 100644 index 000000000000..6b9395e2b503 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListSkillsets.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.NamedEntityRecognitionSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ "Organization" ], + "defaultLanguageCode": "en", + "minimumPrecision": null + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + } + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListSynonymMaps.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListSynonymMaps.json new file mode 100644 index 000000000000..20c041ae2915 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListSynonymMaps.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name" : "mysynonymmap", + "format" : "solr", + "synonyms" : "United States, United States of America, USA\nWashington, Wash. => WA" + }, + { + "name" : "myothersynonymmap", + "format" : "solr", + "synonyms" : "couch, sofa, chesterfield\npop, soda\ntoque, hat" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceResetIndexer.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceResetIndexer.json new file mode 100644 index 000000000000..8a41e8f16c4d --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceResetIndexer.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexerName": "myindexer", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "204": { } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceRunIndexer.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceRunIndexer.json new file mode 100644 index 000000000000..a6f65f1889ce --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceRunIndexer.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexerName": "myindexer", + "api-version": "2017-11-11-Preview" + }, + "responses": { + "202": { } + } +} \ No newline at end of file diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json new file mode 100644 index 000000000000..2e8b5d10bcfd --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json @@ -0,0 +1,4862 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchServiceClient", + "description": "Client that can be used to manage and query indexes and documents, as well as manage other resources, on an Azure Search service.", + "version": "2017-11-11-Preview", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "https://{searchServiceName}.{searchDnsSuffix}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/SearchServiceNameParameter" + }, + { + "$ref": "#/parameters/SearchDnsSuffixParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/datasources('{dataSourceName}')": { + "put": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateDataSource": { "$ref": "./examples/SearchServiceCreateOrUpdateDataSource.json" } + }, + "description": "Creates a new Azure Search datasource or updates a datasource if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to create or update." + }, + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataSource" + }, + "description": "The definition of the datasource to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataSource" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/DataSource" + } + } + } + }, + "delete": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Delete", + "x-ms-examples": { + "SearchServiceDeleteDataSource": { "$ref": "./examples/SearchServiceDeleteDataSource.json" } + }, + "description": "Deletes an Azure Search datasource.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Get", + "x-ms-examples": { + "SearchServiceGetDataSource": { "$ref": "./examples/SearchServiceGetDataSource.json" } + }, + "description": "Retrieves a datasource definition from Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataSource" + } + } + } + } + }, + "/datasources": { + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_List", + "x-ms-examples": { + "SearchServiceListDataSources": { "$ref": "./examples/SearchServiceListDataSources.json" } + }, + "description": "Lists all datasources available for an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Data-Sources" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataSourceListResult" + } + } + } + }, + "post": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Create", + "x-ms-examples": { + "SearchServiceCreateDataSource": { "$ref": "./examples/SearchServiceCreateDataSource.json" } + }, + "description": "Creates a new Azure Search datasource.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "parameters": [ + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataSource" + }, + "description": "The definition of the datasource to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/DataSource" + } + } + } + } + }, + "/indexers('{indexerName}')/search.reset": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Reset", + "x-ms-examples": { + "SearchServiceResetIndexer": { "$ref": "./examples/SearchServiceResetIndexer.json" } + }, + "description": "Resets the change tracking state associated with an Azure Search indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Reset-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to reset." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + } + } + } + }, + "/indexers('{indexerName}')/search.run": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Run", + "x-ms-examples": { + "SearchServiceRunIndexer": { "$ref": "./examples/SearchServiceRunIndexer.json" } + }, + "description": "Runs an Azure Search indexer on-demand.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Run-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to run." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "202": { + "description": "" + } + } + } + }, + "/indexers('{indexerName}')": { + "put": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndexer": { "$ref": "./examples/SearchServiceCreateOrUpdateIndexer.json" } + }, + "description": "Creates a new Azure Search indexer or updates an indexer if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to create or update." + }, + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Indexer" + }, + "description": "The definition of the indexer to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/Indexer" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Indexer" + } + } + } + }, + "delete": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndexer": { "$ref": "./examples/SearchServiceDeleteIndexer.json" } + }, + "description": "Deletes an Azure Search indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "404": { + "description": "" + }, + "204": { + "description": "" + } + } + }, + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Get", + "x-ms-examples": { + "SearchServiceGetIndexer": { "$ref": "./examples/SearchServiceGetIndexer.json" } + }, + "description": "Retrieves an indexer definition from Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Indexer" + } + } + } + } + }, + "/indexers": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_List", + "x-ms-examples": { + "SearchServiceListIndexers": { "$ref": "./examples/SearchServiceListIndexers.json" } + }, + "description": "Lists all indexers available for an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Indexers" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/IndexerListResult" + } + } + } + }, + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Create", + "x-ms-examples": { + "SearchServiceCreateIndexer": { "$ref": "./examples/SearchServiceCreateIndexer.json" } + }, + "description": "Creates a new Azure Search indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Indexer" + }, + "description": "The definition of the indexer to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/Indexer" + } + } + } + } + }, + "/indexers('{indexerName}')/search.status": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_GetStatus", + "x-ms-examples": { + "SearchServiceGetIndexerStatus": { "$ref": "./examples/SearchServiceGetIndexerStatus.json" } + }, + "description": "Returns the current status and execution history of an indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Indexer-Status" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer for which to retrieve status." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/IndexerExecutionInfo" + } + } + } + } + }, + "/skillsets('{skillsetName}')": { + "get": { + "tags": ["Skillsets"], + "operationId": "Skillsets_Get", + "x-ms-examples": { + "SearchServiceGetSkillset": { "$ref": "./examples/SearchServiceGetSkillset.json" } + }, + "description": "Retrieves a cognitive skillset in an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/get-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully returned.", + "schema": { + "$ref": "#/definitions/Skillset" + } + } + } + }, + "put": { + "tags": ["Skillsets"], + "operationId": "Skillsets_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSkillset": { "$ref": "./examples/SearchServiceCreateOrUpdateSkillset.json" } + }, + "description": "Creates a new cognitive skillset in an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/update-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to create or update." + }, + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Skillset" + }, + "description": "The skillset containing one or more cognitive skills to create or update in an Azure Search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully updated.", + "schema": { + "$ref": "#/definitions/Skillset" + } + }, + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/Skillset" + } + } + } + }, + "delete": { + "tags": ["skillsetName"], + "operationId": "Skillsets_Delete", + "x-ms-examples": { + "SearchServiceDeleteSkillset": { "$ref": "./examples/SearchServiceDeleteSkillset.json" } + }, + "description": "Deletes a cognitive skillset in an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/delete-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "The skillset is successfully deleted." + }, + "404": { + "description": "The provided skillset name is not found." + } + } + } + }, + "/skillsets": { + "get": { + "tags": ["Skillsets"], + "operationId": "Skillsets_List", + "x-ms-examples": { + "SearchServiceListSkillsets": { "$ref": "./examples/SearchServiceListSkillsets.json" } + }, + "description": "List all cognitive skillsets in an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/list-skillset" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The list is successfully returned.", + "schema": { + "$ref": "#/definitions/SkillsetListResult" + } + } + } + }, + "post": { + "tags": ["Skillsets"], + "operationId": "Skillsets_Create", + "x-ms-examples": { + "SearchServiceCreateSkillset": { + "$ref": "./examples/SearchServiceCreateSkillset.json" + } + }, + "description": "Creates a new cognitive skillset in an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/create-skillset" + }, + "parameters": [ + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Skillset" + }, + "description": "The skillset containing one or more cognitive skills to create in an Azure Search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/Skillset" + } + } + } + } + }, + "/synonymmaps('{synonymMapName}')": { + "put": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSynonymMap": { "$ref": "./examples/SearchServiceCreateOrUpdateSynonymMap.json" } + }, + "description": "Creates a new Azure Search synonym map or updates a synonym map if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to create or update." + }, + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + } + } + }, + "delete": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Delete", + "x-ms-examples": { + "SearchServiceDeleteSynonymMap": { "$ref": "./examples/SearchServiceDeleteSynonymMap.json" } + }, + "description": "Deletes an Azure Search synonym map.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Get", + "x-ms-examples": { + "SearchServiceGetSynonymMap": { "$ref": "./examples/SearchServiceGetSynonymMap.json" } + }, + "description": "Retrieves a synonym map definition from Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + } + } + } + }, + "/synonymmaps": { + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_List", + "x-ms-examples": { + "SearchServiceListSynonymMaps": { "$ref": "./examples/SearchServiceListSynonymMaps.json" } + }, + "description": "Lists all synonym maps available for an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Synonym-Maps" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMapListResult" + } + } + } + }, + "post": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Create", + "x-ms-examples": { + "SearchServiceCreateSynonymMap": { "$ref": "./examples/SearchServiceCreateSynonymMap.json" } + }, + "description": "Creates a new Azure Search synonym map.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + } + } + } + }, + "/indexes": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Create", + "x-ms-examples": { + "SearchServiceCreateIndex": { "$ref": "./examples/SearchServiceCreateIndex.json" } + }, + "description": "Creates a new Azure Search index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "parameters": [ + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Index" + }, + "description": "The definition of the index to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/Index" + } + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_List", + "x-ms-examples": { + "SearchServiceListIndexes": { "$ref": "./examples/SearchServiceListIndexes.json" } + }, + "description": "Lists all indexes available for an Azure Search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Indexes" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/IndexListResult" + } + } + } + } + }, + "/indexes('{indexName}')": { + "put": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndex": { "$ref": "./examples/SearchServiceCreateOrUpdateIndex.json" } + }, + "description": "Creates a new Azure Search index or updates an index if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The definition of the index to create or update." + }, + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Index" + }, + "description": "The definition of the index to create or update." + }, + { + "name": "allowIndexDowntime", + "in": "query", + "required": false, + "type": "boolean", + "description": "Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Index" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/Index" + } + } + } + }, + "delete": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndex": { "$ref": "./examples/SearchServiceDeleteIndex.json" } + }, + "description": "Deletes an Azure Search index and all the documents it contains.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Get", + "x-ms-examples": { + "SearchServiceGetIndex": { "$ref": "./examples/SearchServiceGetIndex.json" } + }, + "description": "Retrieves an index definition from Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Index" + } + } + } + } + }, + "/indexes('{indexName}')/search.stats": { + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_GetStatistics", + "x-ms-examples": { + "SearchServiceGetIndexStatistics": { "$ref": "./examples/SearchServiceGetIndexStatistics.json" } + }, + "description": "Returns statistics for the given index, including a document count and storage usage.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Index-Statistics" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to retrieve statistics." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/IndexGetStatisticsResult" + } + } + } + } + }, + "/indexes('{indexName}')/search.analyze": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Analyze", + "x-ms-examples": { + "SearchServiceIndexAnalyze": { "$ref": "./examples/SearchServiceIndexAnalyze.json" } + }, + "description": "Shows how an analyzer breaks text into tokens.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/test-analyzer" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to test an analyzer." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeRequest" + }, + "description": "The text and analyzer or analysis components to test." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AnalyzeResult" + } + } + } + } + }, + "/servicestats": { + "get": { + "tags": [ + "Service" + ], + "operationId": "GetServiceStatistics", + "x-ms-examples": { + "SearchServiceGetServiceStatistics": { "$ref": "./examples/SearchServiceGetServiceStatistics.json" } + }, + "description": "Gets service level statistics for an Azure Search service.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ServiceStatistics" + } + } + } + } + } + }, + "definitions": { + "AnalyzeRequest": { + "properties": { + "text": { + "type": "string", + "description": "The text to break into tokens." + }, + "analyzer": { + "$ref": "#/definitions/AnalyzerName", + "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", + "description": "The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName" + }, + "description": "An optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName" + }, + "description": "An optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + } + }, + "required": [ + "text" + ], + "description": "Specifies some text and analysis components used to break that text into tokens." + }, + "AnalyzeResult": { + "properties": { + "tokens": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenInfo" + }, + "description": "The list of tokens returned by the analyzer specified in the request." + } + }, + "description": "The result of testing an analyzer on text." + }, + "TokenInfo": { + "properties": { + "token": { + "type": "string", + "readOnly": true, + "description": "The token returned by the analyzer." + }, + "startOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The index of the first character of the token in the input text." + }, + "endOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The index of the last character of the token in the input text." + }, + "position": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other." + } + }, + "description": "Information about a token returned by an analyzer." + }, + "AnalyzerName": { + "properties": { + "name": { + "type": "string" + } + }, + "description": "Defines the names of all text analyzers supported by Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "x-ms-external": true + }, + "TokenizerName": { + "properties": { + "name": { + "type": "string" + } + }, + "description": "Defines the names of all tokenizers supported by Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + }, + "x-ms-external": true + }, + "TokenFilterName": { + "properties": { + "name": { + "type": "string" + } + }, + "description": "Defines the names of all token filters supported by Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + }, + "x-ms-external": true + }, + "CharFilterName": { + "properties": { + "name": { + "type": "string" + } + }, + "description": "Defines the names of all character filters supported by Azure Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + }, + "x-ms-external": true + }, + "RegexFlags": { + "properties": { + "name": { + "type": "string" + } + }, + "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" + }, + "x-ms-external": true + }, + "DataType": { + "properties": { + "name": { + "type": "string" + } + }, + "description": "Defines the data type of a field in an Azure Search index.", + "x-ms-external": true + }, + "Analyzer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + }, + "name": { + "type": "string", + "externalDocs":{ + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", "name" + ], + "description": "Abstract base class for analyzers." + }, + "CustomAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CustomAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/Analyzer" + } + ], + "properties": { + "tokenizer": { + "$ref": "#/definitions/TokenizerName", + "description": "The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName" + }, + "description": "A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName" + }, + "description": "A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed." + } + }, + "required": [ + "tokenizer" + ], + "description": "Allows you to take control over the process of converting text into indexable/searchable tokens. It's a user-defined configuration consisting of a single predefined tokenizer and one or more filters. The tokenizer is responsible for breaking text into tokens, and the filters for modifying tokens emitted by the tokenizer." + }, + "PatternAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/Analyzer" + } + ], + "properties": { + "lowercase": { + "x-ms-client-name": "LowerCaseTerms", + "type": "boolean", + "default": true, + "description": "A value indicating whether terms should be lower-cased. Default is true." + }, + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more whitespace characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" + } + }, + "StandardAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/Analyzer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardAnalyzer.html" + } + }, + "StopAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/Analyzer" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Divides text at non-letters; Applies the lowercase and stopword token filters. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" + } + }, + "Tokenizer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + }, + "name": { + "type": "string", + "externalDocs":{ + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", "name" + ], + "description": "Abstract base class for tokenizers.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "ClassicTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Grammar-based tokenizer that is suitable for processing most European-language documents. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" + } + }, + "TokenCharacterKind": { + "type": "string", + "enum": [ + "letter", + "digit", + "whitespace", + "punctuation", + "symbol" + ], + "x-ms-enum": { + "name": "TokenCharacterKind", + "modelAsString": false + }, + "description": "Represents classes of characters on which a token filter can operate." + }, + "EdgeNGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input from an edge into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" + } + }, + "KeywordTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "bufferSize": { + "type": "integer", + "format": "int32", + "default": 256, + "description": "The read buffer size in bytes. Default is 256." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + }, + "x-ms-external": true + }, + "KeywordTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 256, + "maximum": 300, + "description": "The maximum token length. Default is 256. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + } + }, + "MicrosoftTokenizerLanguage": { + "type": "string", + "enum": [ + "bangla", + "bulgarian", + "catalan", + "chineseSimplified", + "chineseTraditional", + "croatian", + "czech", + "danish", + "dutch", + "english", + "french", + "german", + "greek", + "gujarati", + "hindi", + "icelandic", + "indonesian", + "italian", + "japanese", + "kannada", + "korean", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "thai", + "ukrainian", + "urdu", + "vietnamese" + ], + "x-ms-enum": { + "name": "MicrosoftTokenizerLanguage", + "modelAsString": false + }, + "description": "Lists the languages supported by the Microsoft language tokenizer." + }, + "MicrosoftLanguageTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules." + }, + "MicrosoftStemmingTokenizerLanguage": { + "type": "string", + "enum": [ + "arabic", + "bangla", + "bulgarian", + "catalan", + "croatian", + "czech", + "danish", + "dutch", + "english", + "estonian", + "finnish", + "french", + "german", + "greek", + "gujarati", + "hebrew", + "hindi", + "hungarian", + "icelandic", + "indonesian", + "italian", + "kannada", + "latvian", + "lithuanian", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovak", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "turkish", + "ukrainian", + "urdu" + ], + "x-ms-enum": { + "name": "MicrosoftStemmingTokenizerLanguage", + "modelAsString": false + }, + "description": "Lists the languages supported by the Microsoft language stemming tokenizer." + }, + "MicrosoftLanguageStemmingTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftStemmingTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules and reduces words to their base forms." + }, + "NGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" + } + }, + "PathHierarchyTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PathHierarchyTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "delimiter": { + "type": "string", + "format": "char", + "default": "/", + "description": "The delimiter character to use. Default is \"/\"." + }, + "replacement": { + "type": "string", + "format": "char", + "default": "/", + "description": "A value that, if set, replaces the delimiter character. Default is \"/\"." + }, + "bufferSize": { + "type": "integer", + "format": "int32", + "default": 1024, + "description": "The buffer size. Default is 1024." + }, + "reverse": { + "x-ms-client-name": "ReverseTokenOrder", + "type": "boolean", + "default": false, + "description": "A value indicating whether to generate tokens in reverse order. Default is false." + }, + "skip": { + "x-ms-client-name": "NumberOfTokensToSkip", + "type": "integer", + "format": "int32", + "default": 0, + "description": "The number of initial tokens to skip. Default is 0." + } + }, + "description": "Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + }, + "x-ms-external": true + }, + "PathHierarchyTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PathHierarchyTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "delimiter": { + "type": "string", + "format": "char", + "default": "/", + "description": "The delimiter character to use. Default is \"/\"." + }, + "replacement": { + "type": "string", + "format": "char", + "default": "/", + "description": "A value that, if set, replaces the delimiter character. Default is \"/\"." + }, + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum token length. Default and maximum is 300." + }, + "reverse": { + "x-ms-client-name": "ReverseTokenOrder", + "type": "boolean", + "default": false, + "description": "A value indicating whether to generate tokens in reverse order. Default is false." + }, + "skip": { + "x-ms-client-name": "NumberOfTokensToSkip", + "type": "integer", + "format": "int32", + "default": 0, + "description": "The number of initial tokens to skip. Default is 0." + } + }, + "description": "Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + } + }, + "PatternTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "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." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "group": { + "type": "integer", + "format": "int32", + "default": -1, + "description": "The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens. Use -1 if you want to use the entire pattern to split the input into tokens, irrespective of matching groups. Default is -1." + } + }, + "description": "Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" + } + }, + "StandardTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + }, + "x-ms-external": true + }, + "StandardTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + } + }, + "UaxUrlEmailTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UaxUrlEmailTokenizer", + "allOf": [ + { + "$ref": "#/definitions/Tokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Tokenizes urls and emails as one token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" + } + }, + "TokenFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + }, + "name": { + "type": "string", + "externalDocs":{ + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", "name" + ], + "description": "Abstract base class for token filters.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "AsciiFoldingTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether the original token will be kept. Default is false." + } + }, + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + } + }, + "CjkBigramTokenFilterScripts": { + "type": "string", + "enum": [ + "han", + "hiragana", + "katakana", + "hangul" + ], + "x-ms-enum": { + "name": "CjkBigramTokenFilterScripts", + "modelAsString": false + }, + "description": "Scripts that can be ignored by CjkBigramTokenFilter." + }, + "CjkBigramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CjkBigramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "ignoreScripts": { + "type": "array", + "items": { + "$ref": "#/definitions/CjkBigramTokenFilterScripts", + "x-nullable": false + }, + "description": "The scripts to ignore." + }, + "outputUnigrams": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output both unigrams and bigrams (if true), or just bigrams (if false). Default is false." + } + }, + "description": "Forms bigrams of CJK terms that are generated from StandardTokenizer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" + } + }, + "CommonGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CommonGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "commonWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of common words." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether common words matching will be case insensitive. Default is false." + }, + "queryMode": { + "x-ms-client-name": "UseQueryMode", + "type": "boolean", + "default": false, + "description": "A value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false." + } + }, + "required": [ + "commonWords" + ], + "description": "Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" + } + }, + "DictionaryDecompounderTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "wordList": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to match against." + }, + "minWordSize": { + "type": "integer", + "format": "int32", + "default": 5, + "maximum": 300, + "description": "The minimum word size. Only words longer than this get processed. Default is 5. Maximum is 300." + }, + "minSubwordSize": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The minimum subword size. Only subwords longer than this are outputted. Default is 2. Maximum is 300." + }, + "maxSubwordSize": { + "type": "integer", + "format": "int32", + "default": 15, + "maximum": 300, + "description": "The maximum subword size. Only subwords shorter than this are outputted. Default is 15. Maximum is 300." + }, + "onlyLongestMatch": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to add only the longest matching subword to the output. Default is false." + } + }, + "required": [ + "wordList" + ], + "description": "Decomposes compound words found in many Germanic languages. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/compound/DictionaryCompoundWordTokenFilter.html" + } + }, + "EdgeNGramTokenFilterSide": { + "type": "string", + "enum": [ + "front", + "back" + ], + "x-ms-enum": { + "name": "EdgeNGramTokenFilterSide", + "modelAsString": false + }, + "description": "Specifies which side of the input an n-gram should be generated from." + }, + "EdgeNGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + }, + "x-ms-external": true + }, + "EdgeNGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + } + }, + "ElisionTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ElisionTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "articles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of articles to remove." + } + }, + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + } + }, + "KeepTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeepTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keepWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to keep." + }, + "keepWordsCase" : { + "x-ms-client-name": "LowerCaseKeepWords", + "type": "boolean", + "default": false, + "description": "A value indicating whether to lower case all words first. Default is false." + } + }, + "required": [ + "keepWords" + ], + "description": "A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeepWordFilter.html" + } + }, + "KeywordMarkerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordMarkerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keywords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of words to mark as keywords." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + } + }, + "required": [ + "keywords" + ], + "description": "Marks terms as keywords. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordMarkerFilter.html" + } + }, + "LengthTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LengthTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "min": { + "type": "integer", + "format": "int32", + "default": 0, + "maximum": 300, + "description": "The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max." + }, + "max": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum length in characters. Default and maximum is 300." + } + }, + "description": "Removes words that are too long or too short. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" + } + }, + "LimitTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LimitTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxTokenCount": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The maximum number of tokens to produce. Default is 1." + }, + "consumeAllTokens": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all tokens from the input must be consumed even if maxTokenCount is reached. Default is false." + } + }, + "description": "Limits the number of tokens while indexing. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" + } + }, + "NGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + }, + "x-ms-external": true + }, + "NGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + } + }, + "PatternCaptureTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternCaptureTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "patterns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of patterns to match against each token." + }, + "preserveOriginal": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to return the original token even if one of the patterns matches. Default is true." + } + }, + "required": [ + "patterns" + ], + "description": "Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternCaptureGroupTokenFilter.html" + } + }, + "PatternReplaceTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceFilter.html" + } + }, + "PhoneticEncoder": { + "type": "string", + "enum": [ + "metaphone", + "doubleMetaphone", + "soundex", + "refinedSoundex", + "caverphone1", + "caverphone2", + "cologne", + "nysiis", + "koelnerPhonetik", + "haasePhonetik", + "beiderMorse" + ], + "x-ms-enum": { + "name": "PhoneticEncoder", + "modelAsString": false + }, + "description": "Identifies the type of phonetic encoder to use with a PhoneticTokenFilter." + }, + "PhoneticTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PhoneticTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "encoder": { + "$ref": "#/definitions/PhoneticEncoder", + "default": "metaphone", + "description": "The phonetic encoder to use. Default is \"metaphone\"." + }, + "replace": { + "x-ms-client-name": "ReplaceOriginalTokens", + "type": "boolean", + "default": true, + "description": "A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true." + } + }, + "description": "Create tokens for phonetic matches. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" + } + }, + "ShingleTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ShingleTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The maximum shingle size. Default and minimum value is 2." + }, + "minShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize." + }, + "outputUnigrams": { + "type": "boolean", + "default": true, + "description": "A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true." + }, + "outputUnigramsIfNoShingles": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false." + }, + "tokenSeparator": { + "type": "string", + "default": " ", + "description": "The string to use when joining adjacent tokens to form a shingle. Default is a single space (\" \")." + }, + "filterToken": { + "type": "string", + "default": "_", + "description": "The string to insert for each position at which there is no token. Default is an underscore (\"_\")." + } + }, + "description": "Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" + } + }, + "SnowballTokenFilterLanguage": { + "type": "string", + "enum": [ + "armenian", + "basque", + "catalan", + "danish", + "dutch", + "english", + "finnish", + "french", + "german", + "german2", + "hungarian", + "italian", + "kp", + "lovins", + "norwegian", + "porter", + "portuguese", + "romanian", + "russian", + "spanish", + "swedish", + "turkish" + ], + "x-ms-enum": { + "name": "SnowballTokenFilterLanguage", + "modelAsString": false + }, + "description": "The language to use for a Snowball token filter." + }, + "SnowballTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SnowballTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/SnowballTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" + } + }, + "StemmerTokenFilterLanguage": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "dutchKp", + "english", + "lightEnglish", + "minimalEnglish", + "possessiveEnglish", + "porter2", + "lovins", + "finnish", + "lightFinnish", + "french", + "lightFrench", + "minimalFrench", + "galician", + "minimalGalician", + "german", + "german2", + "lightGerman", + "minimalGerman", + "greek", + "hindi", + "hungarian", + "lightHungarian", + "indonesian", + "irish", + "italian", + "lightItalian", + "sorani", + "latvian", + "norwegian", + "lightNorwegian", + "minimalNorwegian", + "lightNynorsk", + "minimalNynorsk", + "portuguese", + "lightPortuguese", + "minimalPortuguese", + "portugueseRslp", + "romanian", + "russian", + "lightRussian", + "spanish", + "lightSpanish", + "swedish", + "lightSwedish", + "turkish" + ], + "x-ms-enum": { + "name": "StemmerTokenFilterLanguage", + "modelAsString": false + }, + "description": "The language to use for a stemmer token filter." + }, + "StemmerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/StemmerTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "Language specific stemming filter. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + } + }, + "StemmerOverrideTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerOverrideTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "rules": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stemming rules in the following format: \"word => stem\", for example: \"ran => run\"." + } + }, + "required": [ + "rules" + ], + "description": "Provides the ability to override other stemming filters with custom dictionary-based stemming. Any dictionary-stemmed terms will be marked as keywords so that they will not be stemmed with stemmers down the chain. Must be placed before any stemming filters. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/StemmerOverrideFilter.html" + } + }, + "StopwordsList": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "english", + "finnish", + "french", + "galician", + "german", + "greek", + "hindi", + "hungarian", + "indonesian", + "irish", + "italian", + "latvian", + "norwegian", + "persian", + "portuguese", + "romanian", + "russian", + "sorani", + "spanish", + "swedish", + "thai", + "turkish" + ], + "x-ms-enum": { + "name": "StopwordsList", + "modelAsString": false + }, + "description": "Identifies a predefined list of language-specific stopwords." + }, + "StopwordsTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopwordsTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of stopwords. This property and the stopwords list property cannot both be set." + }, + "stopwordsList": { + "$ref": "#/definitions/StopwordsList", + "default": "english", + "description": "A predefined list of stopwords to use. This property and the stopwords property cannot both be set. Default is English." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + }, + "removeTrailing": { + "x-ms-client-name": "RemoveTrailingStopWords", + "type": "boolean", + "default": true, + "description": "A value indicating whether to ignore the last search term if it's a stop word. Default is true." + } + }, + "description": "Removes stop words from a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" + } + }, + "SynonymTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SynonymTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "synonyms": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous => amazing - all terms on the left side of => symbol will be replaced with all terms on its right side; 2. incredible, unbelievable, fabulous, amazing - comma separated list of equivalent words. Set the expand option to change how this list is interpreted." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to case-fold input for matching. Default is false." + }, + "expand": { + "type": "boolean", + "default": true, + "description": "A value indicating whether all words in the list of synonyms (if => notation is not used) will map to one another. If true, all words in the list of synonyms (if => notation is not used) will map to one another. The following list: incredible, unbelievable, fabulous, amazing is equivalent to: incredible, unbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing. If false, the following list: incredible, unbelievable, fabulous, amazing will be equivalent to: incredible, unbelievable, fabulous, amazing => incredible. Default is true." + } + }, + "required": [ + "synonyms" + ], + "description": "Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/synonym/SynonymFilter.html" + } + }, + "TruncateTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.TruncateTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "length": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The length at which terms will be truncated. Default and maximum is 300." + } + }, + "description": "Truncates the terms to a specific length. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" + } + }, + "UniqueTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UniqueTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "onlyOnSamePosition": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to remove duplicates only at the same position. Default is false." + } + }, + "description": "Filters out tokens with same text as the previous token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" + } + }, + "WordDelimiterTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.WordDelimiterTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "generateWordParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate part words. If set, causes parts of words to be generated; for example \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "generateNumberParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate number subwords. Default is true." + }, + "catenateWords": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of word parts will be catenated. For example, if this is set to true, \"Azure-Search\" becomes \"AzureSearch\". Default is false." + }, + "catenateNumbers": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of number parts will be catenated. For example, if this is set to true, \"1-2\" becomes \"12\". Default is false." + }, + "catenateAll": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all subword parts will be catenated. For example, if this is set to true, \"Azure-Search-1\" becomes \"AzureSearch1\". Default is false." + }, + "splitOnCaseChange": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split words on caseChange. For example, if this is set to true, \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether original words will be preserved and added to the subword list. Default is false." + }, + "splitOnNumerics": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split on numbers. For example, if this is set to true, \"Azure1Search\" becomes \"Azure\" \"1\" \"Search\". Default is true." + }, + "stemEnglishPossessive": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to remove trailing \"'s\" for each subword. Default is true." + }, + "protectedWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of tokens to protect from being delimited." + } + }, + "description": "Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.html" + } + }, + "CharFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + }, + "name": { + "type": "string", + "externalDocs":{ + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", "name" + ], + "description": "Abstract base class for character filters.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "MappingCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MappingCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "mappings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of mappings of the following format: \"a=>b\" (all occurrences of the character \"a\" will be replaced with character \"b\")." + } + }, + "required": [ + "mappings" + ], + "description": "A character filter that applies mappings defined with the mappings option. Matching is greedy (longest pattern matching at a given point wins). Replacement is allowed to be the empty string. This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/MappingCharFilter.html" + } + }, + "PatternReplaceCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceCharFilter.html" + } + }, + "DataSourceCredentials": { + "properties": { + "connectionString": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "type": "string", + "description": "The connection string for the datasource." + } + }, + "required": [ + "connectionString" + ], + "description": "Represents credentials that can be used to connect to a datasource." + }, + "DataContainer": { + "properties": { + "name": { + "type": "string", + "description": "The name of the table or view (for Azure SQL data source) or collection (for DocumentDB data source) that will be indexed." + }, + "query": { + "type": "string", + "description": "A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources." + } + }, + "required": [ + "name" + ], + "description": "Represents information about the entity (such as Azure SQL table or DocumentDb collection) that will be indexed." + }, + "DataChangeDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + } + }, + "required": [ + "@odata.type" + ], + "description": "Abstract base class for data change detection policies." + }, + "HighWaterMarkChangeDetectionPolicy": { + "description": "Defines a data change detection policy that captures changes based on the value of a high water mark column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ], + "properties": { + "highWaterMarkColumnName": { + "type": "string", + "description": "The name of the high water mark column." + } + }, + "required": [ + "highWaterMarkColumnName" + ] + }, + "SqlIntegratedChangeTrackingPolicy": { + "description": "Defines a data change detection policy that captures changes using the Integrated Change Tracking feature of Azure SQL Database.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ] + }, + "DataDeletionDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + } + }, + "required": [ + "@odata.type" + ], + "description": "Abstract base class for data deletion detection policies." + }, + "SoftDeleteColumnDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy that implements a soft-deletion strategy. It determines whether an item should be deleted based on the value of a designated 'soft delete' column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ], + "properties": { + "softDeleteColumnName": { + "type": "string", + "description": "The name of the column to use for soft-deletion detection." + }, + "softDeleteMarkerValue": { + "type": "string", + "description": "The marker value that indentifies an item as deleted." + } + } + }, + "DataSourceType": { + "properties": { + "name": { + "type": "string" + } + }, + "description": "Defines the type of an Azure Search datasource.", + "x-ms-external": true + }, + "DataSource": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the datasource." + }, + "description": { + "type": "string", + "description": "The description of the datasource." + }, + "type": { + "$ref": "#/definitions/DataSourceType", + "description": "The type of the datasource." + }, + "credentials": { + "$ref": "#/definitions/DataSourceCredentials", + "description": "Credentials for the datasource." + }, + "container": { + "$ref": "#/definitions/DataContainer", + "description": "The data container for the datasource." + }, + "dataChangeDetectionPolicy": { + "$ref": "#/definitions/DataChangeDetectionPolicy", + "description": "The data change detection policy for the datasource." + }, + "dataDeletionDetectionPolicy": { + "$ref": "#/definitions/DataDeletionDetectionPolicy", + "description": "The data deletion detection policy for the datasource." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the DataSource." + } + }, + "required": [ + "name", "type", "credentials", "container" + ], + "description": "Represents a datasource definition in Azure Search, which can be used to configure an indexer." + }, + "DataSourceListResult": { + "properties": { + "value": { + "x-ms-client-name": "DataSources", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/DataSource" + }, + "description": "The datasources in the Search service." + } + }, + "description": "Response from a List Datasources request. If successful, it includes the full definitions of all datasources." + }, + "IndexingSchedule": { + "properties": { + "interval": { + "type": "string", + "format": "duration", + "description": "The interval of time between indexer executions." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time when an indexer should start running." + } + }, + "required": [ + "interval" + ], + "description": "Represents a schedule for indexer execution." + }, + "IndexingParameters": { + "properties": { + "batchSize": { + "type": "integer", + "format": "int32", + "description": "The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type." + }, + "maxFailedItems": { + "type": "integer", + "format": "int32", + "default": 0, + "description": "The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0." + }, + "maxFailedItemsPerBatch": { + "type": "integer", + "format": "int32", + "default": 0, + "description": "The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0." + }, + "base64EncodeKeys": { + "type": "boolean", + "default": false, + "description": "Whether indexer will base64-encode all values that are inserted into key field of the target index. This is needed if keys can contain characters that are invalid in keys (such as dot '.'). Default is false." + }, + "configuration": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type." + } + }, + "description": "Represents parameters for indexer execution.", + "x-ms-external": true + }, + "FieldMappingFunction": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field mapping function." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type." + } + }, + "required": [ + "name" + ], + "description": "Represents a function that transforms a value from a data source before indexing.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "FieldMapping": { + "properties": { + "sourceFieldName": { + "type": "string", + "description": "The name of the field in the data source." + }, + "targetFieldName": { + "type": "string", + "description": "The name of the target field in the index. Same as the source field name by default." + }, + "mappingFunction": { + "$ref": "#/definitions/FieldMappingFunction", + "description": "A function to apply to each source field value before indexing." + } + }, + "required": [ + "sourceFieldName" + ], + "description": "Defines a mapping between a field in a data source and a target field in an index.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "Indexer": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the indexer." + }, + "description": { + "type": "string", + "description": "The description of the indexer." + }, + "dataSourceName": { + "type": "string", + "description": "The name of the datasource from which this indexer reads data." + }, + "skillsetName": { + "type": "string", + "description": "The name of the cognitive skillset executing with this indexer." + }, + "targetIndexName": { + "type": "string", + "description": "The name of the index to which this indexer writes data." + }, + "schedule": { + "$ref": "#/definitions/IndexingSchedule", + "description": "The schedule for this indexer." + }, + "parameters": { + "$ref": "#/definitions/IndexingParameters", + "description": "Parameters for indexer execution." + }, + "fieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Defines mappings between fields in the data source and corresponding target fields in the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "outputFieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Output field mappings are applied after enrichment and immediately before indexing.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "disabled": { + "x-ms-client-name": "IsDisabled", + "type": "boolean", + "default": false, + "description": "A value indicating whether the indexer is disabled. Default is false." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the Indexer." + } + }, + "required": [ + "name", "dataSourceName", "targetIndexName" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Indexer-operations" + }, + "description": "Represents an Azure Search indexer." + }, + "IndexerListResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexers", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Indexer" + }, + "description": "The indexers in the Search service." + } + }, + "description": "Response from a List Indexers request. If successful, it includes the full definitions of all indexers." + }, + "ItemError": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item for which indexing failed." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The message describing the error that occurred while processing the item." + } + }, + "description": "Represents an item- or document-level indexing error." + }, + "ItemWarning": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item which generated a warning." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The message describing the warning that occurred while processing the item." + } + }, + "description": "Represents an item-level warning." + }, + "IndexerExecutionResult": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerExecutionStatus", + "readOnly": true, + "description": "The outcome of this indexer execution." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message indicating the top-level error, if any." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The start time of this indexer execution." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The end time of this indexer execution, if the execution has already completed." + }, + "errors": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ItemError" + }, + "description": "The item-level indexing errors." + }, + "warnings": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ItemWarning" + }, + "description": "The item-level indexing warnings." + }, + "itemsProcessed": { + "x-ms-client-name": "ItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed." + }, + "itemsFailed": { + "x-ms-client-name": "FailedItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that failed to be indexed during this indexer execution." + }, + "initialTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution started." + }, + "finalTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution finished." + } + }, + "description": "Represents the result of an individual indexer execution." + }, + "IndexerExecutionStatus": { + "type": "string", + "enum": [ + "transientFailure", + "success", + "inProgress", + "reset" + ], + "x-ms-enum": { "name": "IndexerExecutionStatus" }, + "x-nullable": false, + "description": "Represents the status of an individual indexer execution." + }, + "IndexerExecutionInfo": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerStatus", + "readOnly": true, + "description": "Overall indexer status." + }, + "lastResult": { + "$ref": "#/definitions/IndexerExecutionResult", + "readOnly": true, + "description": "The result of the most recent or an in-progress indexer execution." + }, + "executionHistory": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexerExecutionResult" + }, + "description": "History of the recent indexer executions, sorted in reverse chronological order." + } + }, + "description": "Represents the current status and execution history of an indexer." + }, + "IndexerStatus": { + "type": "string", + "enum": [ + "unknown", + "error", + "running" + ], + "x-ms-enum": { "name": "IndexerStatus" }, + "x-nullable": false, + "description": "Represents the overall indexer status." + }, + "Field": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the field." + }, + "type": { + "$ref": "#/definitions/DataType", + "description": "The data type of the field." + }, + "analyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/AnalyzerName", + "description": "The name of the analyzer to use for the field at search time and indexing time. 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." + }, + "searchAnalyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/AnalyzerName", + "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 analyzer can be updated on an existing field." + }, + "indexAnalyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/AnalyzerName", + "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. Once the analyzer is chosen, it cannot be changed for the field." + }, + "synonymMaps": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Synonym-Map-operations" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of synonym maps to apply in query expansion. Only one synonym map is allowed in the list currently. Synonym maps must be uploaded first to be referenced. This option can be used only with searchable fields." + }, + "key": { + "x-ms-client-name": "isKey", + "type": "boolean", + "x-nullable": false, + "description": "A value indicating whether the field is the key of the index. Valid only for string fields. Every index must have exactly one key field." + }, + "searchable": { + "x-ms-client-name": "isSearchable", + "type": "boolean", + "x-nullable": false, + "description": "A value indicating whether the field is included in full-text searches. Valid only forstring or string collection fields. Default is false." + }, + "filterable": { + "x-ms-client-name": "isFilterable", + "type": "boolean", + "x-nullable": false, + "description": "A value indicating whether the field can be used in filter expressions. Default is false." + }, + "sortable": { + "x-ms-client-name": "isSortable", + "type": "boolean", + "x-nullable": false, + "description": "A value indicating whether the field can be used in orderby expressions. Not valid for string collection fields. Default is false." + }, + "facetable": { + "x-ms-client-name": "isFacetable", + "type": "boolean", + "x-nullable": false, + "description": "A value indicating whether it is possible to facet on this field. Not valid for geo-point fields. Default is false." + }, + "retrievable": { + "x-ms-client-name": "isRetrievable", + "type": "boolean", + "x-nullable": false, + "default": true, + "description": "A value indicating whether the field can be returned in a search result. Default is true." + } + }, + "required": [ + "name", "type" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Represents a field in an index definition in Azure Search, which describes the name, data type, and search behavior of a field.", + "x-ms-external": true + }, + "TextWeights": { + "properties": { + "weights": { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double", + "x-nullable": false + }, + "description": "The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field." + } + }, + "required": [ + "weights" + ], + "description": "Defines weights on index fields for which matches should boost scoring in search queries." + }, + "ScoringFunction": { + "discriminator": "type", + "properties": { + "type": { + "type": "string" + }, + "fieldName": { + "type": "string", + "description": "The name of the field used as input to the scoring function." + }, + "boost": { + "type": "number", + "format": "double", + "description": "A multiplier for the raw score. Must be a positive number not equal to 1.0." + }, + "interpolation": { + "$ref": "#/definitions/ScoringFunctionInterpolation", + "description": "A value indicating how boosting will be interpolated across document scores; defaults to \"Linear\"." + } + }, + "required": [ + "type", "fieldName", "boost" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Abstract base class for functions that can modify document scores during ranking." + }, + "DistanceScoringFunction": { + "x-ms-discriminator-value": "distance", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "distance": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/DistanceScoringParameters", + "description": "Parameter values for the distance scoring function." + } + }, + "required": [ + "distance" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on distance from a geographic location." + }, + "DistanceScoringParameters": { + "properties": { + "referencePointParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the reference location." + }, + "boostingDistance": { + "type": "number", + "format": "double", + "description": "The distance in kilometers from the reference location where the boosting range ends." + } + }, + "required": [ + "referencePointParameter", "boostingDistance" + ], + "description": "Provides parameter values to a distance scoring function." + }, + "FreshnessScoringFunction": { + "x-ms-discriminator-value": "freshness", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "freshness": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/FreshnessScoringParameters", + "description": "Parameter values for the freshness scoring function." + } + }, + "required": [ + "freshness" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the value of a date-time field." + }, + "FreshnessScoringParameters": { + "properties": { + "boostingDuration": { + "type": "string", + "format": "duration", + "description": "The expiration period after which boosting will stop for a particular document." + } + }, + "required": [ + "boostingDuration" + ], + "description": "Provides parameter values to a freshness scoring function." + }, + "MagnitudeScoringFunction": { + "x-ms-discriminator-value": "magnitude", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "magnitude": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/MagnitudeScoringParameters", + "description": "Parameter values for the magnitude scoring function." + } + }, + "required": [ + "magnitude" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the magnitude of a numeric field." + }, + "MagnitudeScoringParameters": { + "properties": { + "boostingRangeStart": { + "type": "number", + "format": "double", + "description": "The field value at which boosting starts." + }, + "boostingRangeEnd": { + "type": "number", + "format": "double", + "description": "The field value at which boosting ends." + }, + "constantBoostBeyondRange": { + "x-ms-client-name": "ShouldBoostBeyondRangeByConstant", + "type": "boolean", + "description": "A value indicating whether to apply a constant boost for field values beyond the range end value; default is false." + } + }, + "required": [ + "boostingRangeStart", "boostingRangeEnd" + ], + "description": "Provides parameter values to a magnitude scoring function." + }, + "TagScoringFunction": { + "x-ms-discriminator-value": "tag", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "tag": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/TagScoringParameters", + "description": "Parameter values for the tag scoring function." + } + }, + "required": [ + "tag" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores of documents with string values matching a given list of tags." + }, + "TagScoringParameters": { + "properties": { + "tagsParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the list of tags to compare against the target field." + } + }, + "required": [ + "tagsParameter" + ], + "description": "Provides parameter values to a tag scoring function." + }, + "ScoringFunctionInterpolation": { + "type": "string", + "enum": [ + "linear", + "constant", + "quadratic", + "logarithmic" + ], + "x-ms-enum": { "name": "ScoringFunctionInterpolation" }, + "description": "Defines the function used to interpolate score boosting across a range of documents." + }, + "ScoringProfile": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the scoring profile." + }, + "text": { + "x-ms-client-name": "TextWeights", + "$ref": "#/definitions/TextWeights", + "description": "Parameters that boost scoring based on text matches in certain index fields." + }, + "functions": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringFunction" + }, + "description": "The collection of functions that influence the scoring of documents." + }, + "functionAggregation": { + "$ref": "#/definitions/ScoringFunctionAggregation", + "description": "A value indicating how the results of individual scoring functions should be combined. Defaults to \"Sum\". Ignored if there are no scoring functions." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines parameters for an Azure Search index that influence scoring in search queries." + }, + "ScoringFunctionAggregation": { + "type": "string", + "enum": [ + "sum", + "average", + "minimum", + "maximum", + "firstMatching" + ], + "x-ms-enum": { "name": "ScoringFunctionAggregation" }, + "description": "Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile." + }, + "CorsOptions": { + "properties": { + "allowedOrigins": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended)." + }, + "maxAgeInSeconds": { + "type": "integer", + "format": "int64", + "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 mintues." + } + }, + "required": [ + "allowedOrigins" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Defines options to control Cross-Origin Resource Sharing (CORS) for an index." + }, + "Suggester": { + "properties": { + "name": { + "type": "string", + "description": "The name of the suggester." + }, + "searchMode": { + "type": "string", + "enum": [ + "analyzingInfixMatching" + ], + "x-ms-enum": { + "name": "searchMode", + "modelAsString": false + }, + "description": "A value indicating the capabilities of the suggester." + }, + "sourceFields": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to which the suggester applies. Each field must be searchable." + } + }, + "required": [ + "name", "searchMode", "sourceFields" + ], + "description": "Defines how the Suggest API should apply to a group of fields in the index." + }, + "Index": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the index." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/Field" + }, + "description": "The fields of the index." + }, + "scoringProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringProfile" + }, + "description": "The scoring profiles for the index." + }, + "defaultScoringProfile": { + "type": "string", + "description": "The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used." + }, + "corsOptions": { + "$ref": "#/definitions/CorsOptions", + "description": "Options to control Cross-Origin Resource Sharing (CORS) for the index." + }, + "suggesters": { + "type": "array", + "items": { + "$ref": "#/definitions/Suggester" + }, + "description": "The suggesters for the index." + }, + "analyzers": { + "type": "array", + "items": { + "$ref": "#/definitions/Analyzer" + }, + "description": "The analyzers for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenizers": { + "type": "array", + "items": { + "$ref": "#/definitions/Tokenizer" + }, + "description": "The tokenizers for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilter" + }, + "description": "The token filters for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilter" + }, + "description": "The character filters for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the index." + } + }, + "required": [ + "name", "fields" + ], + "description": "Represents an index definition in Azure Search, which describes the fields and search behavior of an index." + }, + "IndexGetStatisticsResult": { + "properties": { + "documentCount": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The number of documents in the index." + }, + "storageSize": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The amount of storage in bytes consumed by the index." + } + }, + "description": "Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date." + }, + "IndexListResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexes", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Index" + }, + "description": "The indexes in the Search service." + } + }, + "description": "Response from a List Indexes request. If successful, it includes the full definitions of all indexes." + }, + "Skillset": { + "properties": { + "name": { + "type": "string", + "description": "The name of the skillset." + }, + "description": { + "type": "string", + "description": "The description of the skillset." + }, + "skills": { + "type": "array", + "items": { + "$ref": "#/definitions/Skill" + }, + "description": "A list of skills in the skillset." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the skillset." + } + }, + "required": [ + "name", "description", "skills" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob" + }, + "description": "A list of cognitive skills." + }, + "Skill": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + }, + "description": { + "type": "string", + "description": "The description of the skill which describes the inputs, outputs, and usage of the skill." + }, + "context": { + "type": "string", + "description": "Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content)." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Inputs of the skills could be a column in the source data set, or the output of an upstream skill." + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFieldMappingEntry" + }, + "description": "The output of a skill is either a field in an Azure Search index, or a value that can be consumed as an input by another skill." + } + }, + "required": [ + "@odata.type", "description", "context", "inputs", "outputs" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-predefined-skills" + }, + "description": "Abstract base class for skills." + }, + "InputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the input." + }, + "source": { + "type": "string", + "description": "The source of the input." + } + }, + "required": [ + "name", "source" + ], + "description": "Input field mapping for a skill." + }, + "OutputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the output defined by the skill." + }, + "targetName": { + "type": "string", + "description": "The target name of the output. It is optional and default to name." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/naming-rules" + }, + "description": "Output field mapping for a skill." + }, + "KeyPhraseExtractionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "allOf": [{ + "$ref": "#/definitions/Skill" + }], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/KeyPhraseExtractionSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "maxKeyPhraseCount": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A number indicating how many key phrases to return. If absent, all identified key phrases will be returned." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-keyphrases" + }, + "description": "A skill that uses text analytics for key phrase extraction." + }, + "OcrSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.OcrSkill", + "allOf": [{ + "$ref": "#/definitions/Skill" + }], + "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." + }, + "detectOrientation": { + "x-ms-client-name": "ShouldDetectOrientation", + "type": "boolean", + "default": false, + "description": "A value indicating to turn orientation detection on or not. Default is false." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-ocr" + }, + "description": "A skill that extracts text from image files." + }, + "ImageAnalysisSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.ImageAnalysisSkill", + "allOf": [{ + "$ref": "#/definitions/Skill" + }], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/ImageAnalysisSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "visualFeatures": { + "type": "array", + "items": { + "$ref": "#/definitions/VisualFeature", + "x-nullable": false + }, + "description": "A list of visual features." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDetail", + "x-nullable": false + }, + "description": "A string indicating which domain-specific details to return." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-image-analysis" + }, + "description": "A skill that analyzes image files. It extracts a rich set of visual features based on the image content." + }, + "LanguageDetectionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "allOf": [{ + "$ref": "#/definitions/Skill" + }], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-language-detection" + }, + "description": "A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis." + }, + "ShaperSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.ShaperSkill", + "allOf": [{ + "$ref": "#/definitions/Skill" + }], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-shaper" + }, + "description": "A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields)." + }, + "MergeSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.MergeSkill", + "allOf": [{ + "$ref": "#/definitions/Skill" + }], + "properties": { + "insertPreTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the start of the merged text. By default, the tag is an empty space." + }, + "insertPostTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the end of the merged text. By default, the tag is an empty space." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textmerger" + }, + "description": "A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part." + }, + "NamedEntityRecognitionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.NamedEntityRecognitionSkill", + "allOf": [{ + "$ref": "#/definitions/Skill" + }], + "properties": { + "categories": { + "type": "array", + "items": { + "$ref": "#/definitions/NamedEntityCategory", + "x-nullable": false + }, + "description": "A list of named entity categories." + }, + "defaultLanguageCode": { + "$ref": "#/definitions/NamedEntityRecognitionSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "x-nullable": true, + "description": "A value between 0 and 1 to indicate the confidence of the results." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-named-entity-recognition" + }, + "description": "Text analytics named entity recognition." + }, + "SentimentSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SentimentSkill", + "allOf": [{ + "$ref": "#/definitions/Skill" + }], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SentimentSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-sentiment" + }, + "description": "Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1." + }, + "SplitSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SplitSkill", + "allOf": [{ + "$ref": "#/definitions/Skill" + }], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SplitSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "textSplitMode": { + "$ref": "#/definitions/TextSplitMode", + "x-nullable": false, + "description": "A value indicating which split mode to perform." + }, + "maximumPageLength": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired maximum page length. Default is 10000." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textsplit" + }, + "description": "A skill to split a string into chunks of text." + }, + "WebApiSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Custom.WebApiSkill", + "allOf": [{ + "$ref": "#/definitions/Skill" + }], + "properties": { + "uri": { + "type": "string", + "description": "The url for the Web API." + }, + "httpHeaders": { + "$ref": "#/definitions/WebApiHttpHeaders", + "description": "The headers required to make the http request." + }, + "httpMethod": { + "type": "string", + "description": "The method for the http request." + }, + "timeout": { + "type": "string", + "format": "duration", + "description": "The desired timeout for the request. Default is 30 seconds." + }, + "batchSize": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired batch size which indicates number of documents." + } + }, + "required": [ + "uri", "httpHeaders", "httpMethod" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-custom-skill-interface" + }, + "description": "A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code." + }, + "WebApiHttpHeaders": { + "properties": { + "headers": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A dictionary of http request headers." + } + } + }, + "SkillsetListResult": { + "properties": { + "value": { + "x-ms-client-name": "Skillsets", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Skillset" + }, + "description": "The skillsets defined in the Search service." + } + }, + "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." + }, + "TextSplitMode": { + "type": "string", + "enum": [ + "pages", + "sentences" + ], + "x-ms-enum": { + "name": "TextSplitMode", + "modelAsString": false + }, + "description": "A value indicating which split mode to perform." + }, + "VisualFeature": { + "type": "string", + "enum": [ + "categories", + "tags", + "description", + "faces", + "imageType", + "color" + ], + "x-ms-enum": { + "name": "VisualFeature", + "modelAsString": false + }, + "description": "The strings indicating what visual feature types to return." + }, + "ImageDetail": { + "type": "string", + "enum": [ + "celebrities", + "landmarks" + ], + "x-ms-enum": { + "name": "ImageDetail", + "modelAsString": false + }, + "description": "A string indicating which domain-specific details to return." + }, + "NamedEntityCategory": { + "type": "string", + "enum": [ + "location", + "organization", + "person" + ], + "x-ms-enum": { + "name": "NamedEntityCategory", + "modelAsString": false + }, + "description": "A string indicating which named entity categories to return." + }, + "SentimentSkillLanguage": { + "properties": { + "name": { + "type": "string" + } + }, + "description": "The language codes supported for input text by SentimentSkill.", + "x-ms-external": true + }, + "KeyPhraseExtractionSkillLanguage": { + "properties": { + "name": { + "type": "string" + } + }, + "description": "The language codes supported for input text by KeyPhraseExtractionSkill.", + "x-ms-external": true + }, + "OcrSkillLanguage": { + "properties": { + "name": { + "type": "string" + } + }, + "description": "The language codes supported for input by OcrSkill.", + "x-ms-external": true + }, + "SplitSkillLanguage": { + "properties": { + "name": { + "type": "string" + } + }, + "description": "The language codes supported for input text by SplitSkill.", + "x-ms-external": true + }, + "NamedEntityRecognitionSkillLanguage": { + "properties": { + "name": { + "type": "string" + } + }, + "description": "The language codes supported for input text by NamedEntityRecognitionSkill.", + "x-ms-external": true + }, + "ImageAnalysisSkillLanguage": { + "properties": { + "name": { + "type": "string" + } + }, + "description": "The language codes supported for input by ImageAnalysisSkill.", + "x-ms-external": true + }, + "SynonymMapFormat": { + "properties": { + "name": { + "type": "string" + } + }, + "description": "The format of the synonym map. Only the 'solr' format is currently supported.", + "x-ms-external": true + }, + "SynonymMap": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the synonym map." + }, + "format": { + "$ref": "#/definitions/SynonymMapFormat", + "description": "The format of the synonym map. Only the 'solr' format is currently supported." + }, + "synonyms": { + "type": "string", + "description": "A series of synonym rules in the specified synonym map format. The rules must be separated by newlines.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map#SynonymMapFormat" + } + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the synonym map." + } + }, + "required": [ + "name", "format", "synonyms" + ], + "description": "Represents a synonym map definition in Azure Search." + }, + "SynonymMapListResult": { + "properties": { + "value": { + "x-ms-client-name": "SynonymMaps", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The synonym maps in the Search service." + } + }, + "description": "Response from a List SynonymMaps request. If successful, it includes the full definitions of all synonym maps." + }, + "ServiceStatistics": { + "properties": { + "counters": { + "$ref": "#/definitions/ServiceCounters", + "description": "Service level resource counters." + }, + "limits": { + "$ref": "#/definitions/ServiceLimits", + "description": "Service level general limits." + } + }, + "description": "Response from a get service statistics request. If successful, it includes service level counters and limits." + }, + "ServiceCounters": { + "properties": { + "documentCount": { + "x-ms-client-name": "documentCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of documents across all indexes in the service." + }, + "indexesCount": { + "x-ms-client-name": "indexCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexes." + }, + "indexersCount": { + "x-ms-client-name": "indexerCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexers." + }, + "dataSourcesCount": { + "x-ms-client-name": "dataSourceCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of data sources." + }, + "storageSize": { + "x-ms-client-name": "storageSizeCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total size of used storage in bytes." + }, + "synonymMaps": { + "x-ms-client-name": "synonymMapCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of synonym maps." + } + }, + "description": "Represents service-level resource counters and quotas." + }, + "ServiceLimits": { + "properties": { + "maxFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum allowed fields per index." + }, + "maxFieldNestingDepthPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3." + }, + "maxComplexCollectionFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index." + } + }, + "description": "Represents various service level limits." + }, + "ResourceCounter": { + "properties": { + "usage": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "description": "The resource usage amount." + }, + "quota": { + "type": "integer", + "format": "int64", + "x-nullable": true, + "description": "The resource amount quota." + } + }, + "description": "Represents a resource's usage and quota." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { "name": "search-request-options" }, + "x-ms-parameter-location": "method" + }, + "IfMatchParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "x-ms-parameter-grouping": { "name": "access-condition" }, + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "x-ms-parameter-grouping": { "name": "access-condition" }, + "x-ms-parameter-location": "method" + }, + "PreferHeaderParameter": { + "name": "Prefer", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "return=representation" + ], + "description": "For HTTP PUT requests, instructs the service to return the created/updated resource on success.", + "x-ms-parameter-location": "method" + }, + "SearchServiceNameParameter": { + "name": "searchServiceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The name of the Azure Search service.", + "x-ms-parameter-location": "client" + }, + "SearchDnsSuffixParameter": { + "name": "searchDnsSuffix", + "in": "path", + "required": true, + "type": "string", + "default": "search.windows.net", + "x-ms-skip-url-encoding": true, + "description": "The DNS suffix of the Azure Search service. The default is search.windows.net.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11/examples/SearchServiceGetServiceStatistics.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11/examples/SearchServiceGetServiceStatistics.json index 02ab591b8f39..1fe6d3bd2280 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11/examples/SearchServiceGetServiceStatistics.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11/examples/SearchServiceGetServiceStatistics.json @@ -34,9 +34,7 @@ } }, "limits": { - "maxFieldsPerIndex": 1000, - "maxFieldNestingDepthPerIndex": 10, - "maxComplexCollectionFieldsPerIndex": 100 + "maxFieldsPerIndex": 1000 } } } diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11/searchservice.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11/searchservice.json index 36e172176859..90f24f1737a3 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11/searchservice.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11/searchservice.json @@ -4065,18 +4065,6 @@ "format": "int32", "x-nullable": true, "description": "The maximum allowed fields per index." - }, - "maxFieldNestingDepthPerIndex": { - "type": "integer", - "format": "int32", - "x-nullable": true, - "description": "The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3." - }, - "maxComplexCollectionFieldsPerIndex": { - "type": "integer", - "format": "int32", - "x-nullable": true, - "description": "The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index." } }, "description": "Represents various service level limits." diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/readme.md b/specification/search/data-plane/Microsoft.Azure.Search.Service/readme.md index de1a7c5e3945..9856ff77f935 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/readme.md +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/readme.md @@ -24,7 +24,16 @@ These are the global settings for SearchServiceClient. ``` yaml openapi-type: data-plane -tag: package-2017-11 +tag: package-2017-11-preview +``` + +### Tag: package-2017-11-preview + +These settings apply only when `--tag=package-2017-11-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-11-preview' +input-file: +- preview/2017-11-11-preview/searchservice.json ``` ### Tag: package-2017-11 diff --git a/specification/search/resource-manager/Microsoft.Search/stable/2015-08-19/search.json b/specification/search/resource-manager/Microsoft.Search/stable/2015-08-19/search.json index 517bbe689730..72f4eed18469 100644 --- a/specification/search/resource-manager/Microsoft.Search/stable/2015-08-19/search.json +++ b/specification/search/resource-manager/Microsoft.Search/stable/2015-08-19/search.json @@ -904,6 +904,10 @@ "type": "string" }, "description": "Tags to help categorize the resource in the Azure portal." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." } }, "description": "Base type for all Azure resources.", @@ -1000,6 +1004,35 @@ "description": "The URL to get the next set of operation list results, if any." } } + }, + "Identity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": false + } + } + }, + "required": [ + "type" + ], + "description": "Identity for the resource." } }, "parameters": { diff --git a/specification/search/resource-manager/readme.md b/specification/search/resource-manager/readme.md index 87ebe66c01c2..7400907dbc7b 100644 --- a/specification/search/resource-manager/readme.md +++ b/specification/search/resource-manager/readme.md @@ -61,9 +61,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_search'] ``` @@ -153,11 +156,46 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.search +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-search +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-02 + - tag: package-2015-08 +``` + +### Tag: package-2015-02 and java + +These settings apply only when `--tag=package-2015-02 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-02' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.search - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-search + namespace: com.microsoft.azure.management.searchmanagementclient.v2015_02_28 + output-folder: $(azure-libraries-for-java-folder)/searchmanagementclient/resource-manager/v2015_02_28 +regenerate-manager: true +generate-interface: true ``` + +### Tag: package-2015-08 and java + +These settings apply only when `--tag=package-2015-08 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-08' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.searchmanagementclient.v2015_08_19 + output-folder: $(azure-libraries-for-java-folder)/searchmanagementclient/resource-manager/v2015_08_19 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/search/resource-manager/readme.nodejs.md b/specification/search/resource-manager/readme.nodejs.md index 2e6e266eade3..7ba1ee9f3876 100644 --- a/specification/search/resource-manager/readme.nodejs.md +++ b/specification/search/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-08' && $(ruby) +namespace: "Azure::Search::Mgmt::V2015_08_19" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_search/lib +``` diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertResourceGroupLocation_example.json new file mode 100644 index 000000000000..f7d1de97b849 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertResourceGroupLocation_example.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg1", + "ascLocation": "westeurope", + "alertName": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA" + }, + "responses": { + "200": { + "body": { + "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, + "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" + }] + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertSubscriptionLocation_example.json new file mode 100644 index 000000000000..bcb4d7fd727d --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertSubscriptionLocation_example.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "alertName": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA" + }, + "responses": { + "200": { + "body": { + "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, + "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" + }] + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsResourceGroupLocation_example.json new file mode 100644 index 000000000000..ddc50444a3f7 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsResourceGroupLocation_example.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg1", + "ascLocation": "westeurope" + }, + "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, + "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" + }] + } + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsResourceGroup_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsResourceGroup_example.json new file mode 100644 index 000000000000..415c4dd5a394 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsResourceGroup_example.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg1" + }, + "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, + "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" + }] + } + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsSubscription_example.json new file mode 100644 index 000000000000..b1c6da1dce8a --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsSubscription_example.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "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, + "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" + }] + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/westeurope/alerts/2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", + "name": "2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", + "type": "Microsoft.Security/Locations/alerts", + "properties": { + "systemSource": "Azure", + "vendorName": "Microsoft", + "alertDisplayName": "Suspicious Screensaver process executed", + "alertName": "SuspiciousScreenSaver", + "detectedTimeUtc": "2018-05-07T13:51:45.0045913Z", + "description": "The process ‘%{process name}’ was observed executing from an uncommon location.\r\n\r\nFiles with the .scr extensions are screen saver files and are normally reside and execute from the Windows system directory.", + "remediationSteps": "1. Run Process Explorer and try to identify unknown running processes (see https://technet.microsoft.com/en-us/sysinternals/bb896653.aspx)\r\n2. Make sure the machine is completely updated and has an updated anti-malware application installed\r\n3. Run a full anti-malware scan and verify that the threat was removed\r\n4. Install and run Microsoft’s Malicious Software Removal Tool (see https://www.microsoft.com/en-us/download/malicious-software-removal-tool-details.aspx)\r\n5. Run Microsoft’s Autoruns utility and try to identify unknown applications that are configured to run at login (see https://technet.microsoft.com/en-us/sysinternals/bb963902.aspx)\r\n6. Escalate the alert to the information security team", + "actionTaken": "Detected", + "reportedSeverity": "Low", + "compromisedEntity": "vm2", + "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/myRg2/providers/microsoft.compute/virtualmachines/vm2", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "instanceId": "2325cf9e-42a2-4f72-ae7f-9b863cba2d22", + "extendedProperties": { + "domain name": "vm2", + "user name": "vm2\\contosoUser", + "process name": "c:\\users\\contosoUser\\scrsave.scr", + "command line": "c:\\users\\contosoUser\\scrsave.scr", + "parent process": "cmd.exe", + "process id": "0x4aec", + "account logon id": "0x61450d87", + "user SID": "S-1-5-21-2144575486-8928446540-5163864319-500", + "parent process id": "0x3c44", + "enrichment_tas_threat__reports": "{\"Kind\":\"MultiLink\",\"DisplayValueToUrlDictionary\":{\"Report: Suspicious Screen Saver Execution\":\"https://iflowreportsproda.blob.core.windows.net/reports/MSTI-TS-Suspicious-Screen-Saver-Execution.pdf?sv=2016-05-31&sr=b&sig=2igHPl764UM7aBHNaO9mPAnpzoXlwRw8YjpFLLuB2NE%3D&spr=https&st=2018-05-07T00%3A20%3A54Z&se=2018-05-08T00%3A35%3A54Z&sp=r\"}}", + "resourceType": "Virtual Machine" + }, + "state": "Active", + "reportedTimeUtc": "2018-05-07T13:51:48.3810457Z", + "workspaceArmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-weu/providers/microsoft.operationalinsights/workspaces/defaultworkspace-21ff7fc3-e762-48dd-bd96-b551f6dcdd23-weu", + "confidenceScore": 0.3, + "confidenceReasons": [{ + "type": "Process", + "reason": "Suspicious process execution history for this subscription" + }, { + "type": "Process", + "reason": "Suspicious process execution history for this subscription" + }, { + "type": "Process", + "reason": "cmd.exe appeared in multiple alerts of the same type" + }], + "canBeInvestigated": true, + "entities": [{ + "dnsDomain": "", + "ntDomain": "", + "hostName": "vm2", + "netBiosName": "vm2", + "azureID": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/myRg2/providers/microsoft.compute/virtualmachines/vm2", + "omsAgentID": "45b44640-3b94-4892-a28c-4a5cae27065a", + "operatingSystem": "Unknown", + "type": "host", + "OsVersion": null + }, { + "name": "contosoUser", + "ntDomain": "vm2", + "logonId": "0x61450d87", + "sid": "S-1-5-21-2144575486-8928446540-5163864319-500", + "type": "account" + }, { + "directory": "c:\\windows\\system32", + "name": "cmd.exe", + "type": "file" + }, { + "directory": "c:\\users\\contosoUser", + "name": "scrsave.scr", + "type": "file" + }, { + "processId": "0x4aec", + "commandLine": "c:\\users\\contosoUser\\scrsave.scr", + "creationTimeUtc": "2018-05-07T13:51:45.0045913Z", + "type": "process" + }] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsSubscriptionsLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsSubscriptionsLocation_example.json new file mode 100644 index 000000000000..506adecf7f6e --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsSubscriptionsLocation_example.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope" + }, + "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, + "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" + }] + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/westeurope/alerts/2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", + "name": "2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", + "type": "Microsoft.Security/Locations/alerts", + "properties": { + "systemSource": "Azure", + "vendorName": "Microsoft", + "alertDisplayName": "Suspicious Screensaver process executed", + "alertName": "SuspiciousScreenSaver", + "detectedTimeUtc": "2018-05-07T13:51:45.0045913Z", + "description": "The process ‘%{process name}’ was observed executing from an uncommon location.\r\n\r\nFiles with the .scr extensions are screen saver files and are normally reside and execute from the Windows system directory.", + "remediationSteps": "1. Run Process Explorer and try to identify unknown running processes (see https://technet.microsoft.com/en-us/sysinternals/bb896653.aspx)\r\n2. Make sure the machine is completely updated and has an updated anti-malware application installed\r\n3. Run a full anti-malware scan and verify that the threat was removed\r\n4. Install and run Microsoft’s Malicious Software Removal Tool (see https://www.microsoft.com/en-us/download/malicious-software-removal-tool-details.aspx)\r\n5. Run Microsoft’s Autoruns utility and try to identify unknown applications that are configured to run at login (see https://technet.microsoft.com/en-us/sysinternals/bb963902.aspx)\r\n6. Escalate the alert to the information security team", + "actionTaken": "Detected", + "reportedSeverity": "Low", + "compromisedEntity": "vm2", + "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/myRg2/providers/microsoft.compute/virtualmachines/vm2", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "instanceId": "2325cf9e-42a2-4f72-ae7f-9b863cba2d22", + "extendedProperties": { + "domain name": "vm2", + "user name": "vm2\\contosoUser", + "process name": "c:\\users\\contosoUser\\scrsave.scr", + "command line": "c:\\users\\contosoUser\\scrsave.scr", + "parent process": "cmd.exe", + "process id": "0x4aec", + "account logon id": "0x61450d87", + "user SID": "S-1-5-21-2144575486-8928446540-5163864319-500", + "parent process id": "0x3c44", + "enrichment_tas_threat__reports": "{\"Kind\":\"MultiLink\",\"DisplayValueToUrlDictionary\":{\"Report: Suspicious Screen Saver Execution\":\"https://iflowreportsproda.blob.core.windows.net/reports/MSTI-TS-Suspicious-Screen-Saver-Execution.pdf?sv=2016-05-31&sr=b&sig=2igHPl764UM7aBHNaO9mPAnpzoXlwRw8YjpFLLuB2NE%3D&spr=https&st=2018-05-07T00%3A20%3A54Z&se=2018-05-08T00%3A35%3A54Z&sp=r\"}}", + "resourceType": "Virtual Machine" + }, + "state": "Active", + "reportedTimeUtc": "2018-05-07T13:51:48.3810457Z", + "workspaceArmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-weu/providers/microsoft.operationalinsights/workspaces/defaultworkspace-21ff7fc3-e762-48dd-bd96-b551f6dcdd23-weu", + "confidenceScore": 0.3, + "confidenceReasons": [{ + "type": "Process", + "reason": "Suspicious process execution history for this subscription" + }, { + "type": "Process", + "reason": "Suspicious process execution history for this subscription" + }, { + "type": "Process", + "reason": "cmd.exe appeared in multiple alerts of the same type" + }], + "canBeInvestigated": true, + "entities": [{ + "dnsDomain": "", + "ntDomain": "", + "hostName": "vm2", + "netBiosName": "vm2", + "azureID": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/myRg2/providers/microsoft.compute/virtualmachines/vm2", + "omsAgentID": "45b44640-3b94-4892-a28c-4a5cae27065a", + "operatingSystem": "Unknown", + "type": "host", + "OsVersion": null + }, { + "name": "contosoUser", + "ntDomain": "vm2", + "logonId": "0x61450d87", + "sid": "S-1-5-21-2144575486-8928446540-5163864319-500", + "type": "account" + }, { + "directory": "c:\\windows\\system32", + "name": "cmd.exe", + "type": "file" + }, { + "processId": "0x3c44", + "type": "process" + }, { + "directory": "c:\\users\\contosoUser", + "name": "scrsave.scr", + "type": "file" + }, { + "processId": "0x4aec", + "commandLine": "c:\\users\\contosoUser\\scrsave.scr", + "creationTimeUtc": "2018-05-07T13:51:45.0045913Z", + "type": "process" + }] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/UpdateAlertResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/UpdateAlertResourceGroupLocation_example.json new file mode 100644 index 000000000000..e3a50c68d89b --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/UpdateAlertResourceGroupLocation_example.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg2", + "ascLocation": "westeurope", + "alertName": "2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", + "alertUpdateActionType": "Dismiss" + }, + "responses": { + "204": { + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/UpdateAlertSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/UpdateAlertSubscriptionLocation_example.json new file mode 100644 index 000000000000..0debeb1d30fd --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/UpdateAlertSubscriptionLocation_example.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "alertName": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", + "alertUpdateActionType": "Dismiss" + }, + "responses": { + "204": { + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionResourceGroupLocation_example.json new file mode 100644 index 000000000000..34318bea83e3 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionResourceGroupLocation_example.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "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" + } + + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscriptionLocation_example.json new file mode 100644 index 000000000000..7b42e9177837 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscriptionLocation_example.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "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" + } + ] + } + + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscription_example.json new file mode 100644 index 000000000000..15a33ccd6826 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscription_example.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "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" + } + ] + } + + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json new file mode 100644 index 000000000000..9d561246553a --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscriptionLocation_example.json new file mode 100644 index 000000000000..4b828045520f --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscriptionLocation_example.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "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" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscription_example.json new file mode 100644 index 000000000000..191fdd390865 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscription_example.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "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" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/CreateJitNetworkAccessPolicy_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/CreateJitNetworkAccessPolicy_example.json new file mode 100644 index 000000000000..691a6fbea2c0 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/CreateJitNetworkAccessPolicy_example.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "resourceGroupName": "myRg1", + "jitNetworkAccessPolicyName": "default", + "body":{ + "kind": "Basic", + "properties": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 22, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + }, + { + "number": 3389, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + } + ] + }], + "requests": [{ + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-05-17T09:06:45.5691611Z", + "status": "Initiated", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-05-17T08:06:45.5691611Z", + "requestor": "barbara@contoso.com" + }], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", + "name": "default", + "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", + "location": "westeurope" + } + }, + "responses": { + "200": { + "body": { + "kind": "Basic", + "properties": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 22, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + }, + { + "number": 3389, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + } + ] + }], + "requests": [{ + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-05-17T09:06:45.5691611Z", + "status": "Initiated", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-05-17T08:06:45.5691611Z", + "requestor": "barbara@contoso.com" + }], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", + "name": "default", + "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", + "location": "westeurope" + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/DeleteJitNetworkAccessPolicy_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/DeleteJitNetworkAccessPolicy_example.json new file mode 100644 index 000000000000..a6486af030fc --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/DeleteJitNetworkAccessPolicy_example.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "resourceGroupName": "myRg1", + "jitNetworkAccessPolicyName": "default" + }, + "responses": { + "200": { + }, + "204": { + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroupLocation_example.json new file mode 100644 index 000000000000..1f52d31d67fc --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroupLocation_example.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "resourceGroupName": "myRg1" + }, + "responses": { + "200": { + "body": { + "value": [{ + "kind": "Basic", + "properties": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 22, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + }, + { + "number": 3389, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + } + ] + }], + "requests": [{ + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-05-17T09:06:45.5691611Z", + "status": "Initiated", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-05-17T08:06:45.5691611Z", + "requestor": "barbara@contoso.com" + }], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", + "name": "default", + "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", + "location": "westeurope" + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroup_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroup_example.json new file mode 100644 index 000000000000..de24bcd2f463 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroup_example.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg1" + }, + "responses": { + "200": { + "body": { + "value": [{ + "kind": "Basic", + "properties": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 22, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + }, + { + "number": 3389, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + } + ] + }], + "requests": [{ + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-05-17T09:06:45.5691611Z", + "status": "Initiated", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-05-17T08:06:45.5691611Z", + "requestor": "barbara@contoso.com" + }], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", + "name": "default", + "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", + "location": "westeurope" + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscriptionLocation_example.json new file mode 100644 index 000000000000..bec7fd1da349 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscriptionLocation_example.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope" + }, + "responses": { + "200": { + "body": { + "value": [{ + "kind": "Basic", + "properties": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 22, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + }, + { + "number": 3389, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + } + ] + }], + "requests": [{ + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-05-17T09:06:45.5691611Z", + "status": "Initiated", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-05-17T08:06:45.5691611Z", + "requestor": "barbara@contoso.com" + }], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", + "name": "default", + "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", + "location": "westeurope" + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscription_example.json new file mode 100644 index 000000000000..968d48bf8c25 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscription_example.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "kind": "Basic", + "properties": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 22, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + }, + { + "number": 3389, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + } + ] + }], + "requests": [{ + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-05-17T09:06:45.5691611Z", + "status": "Initiated", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-05-17T08:06:45.5691611Z", + "requestor": "barbara@contoso.com" + }], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", + "name": "default", + "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", + "location": "westeurope" + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPolicy_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPolicy_example.json new file mode 100644 index 000000000000..56f9a543528b --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPolicy_example.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "resourceGroupName": "myRg1", + "jitNetworkAccessPolicyName": "default" + }, + "responses": { + "200": { + "body": { + "kind": "Basic", + "properties": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 22, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + }, + { + "number": 3389, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + } + ] + }], + "requests": [{ + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-05-17T09:06:45.5691611Z", + "status": "Initiated", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-05-17T08:06:45.5691611Z", + "requestor": "barbara@contoso.com" + }], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", + "name": "default", + "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", + "location": "westeurope" + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/InitiateJitNetworkAccessPolicy_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/InitiateJitNetworkAccessPolicy_example.json new file mode 100644 index 000000000000..f234178e85be --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/InitiateJitNetworkAccessPolicy_example.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "resourceGroupName": "myRg1", + "jitNetworkAccessPolicyName": "default", + "jitNetworkAccessPolicyInitiateType": "initiate", + "body": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "duration": "PT1H", + "allowedSourceAddressPrefix": "192.127.0.2" + }] + }] + } + }, + "responses": { + "202": { + "body": { + "virtualMachines": [{ + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-07-12T09:53:03.3658798Z", + "status": "Initiating", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-07-12T08:53:03.3658798Z", + "requestor": "barbara@contoso.com" + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/InvokeJitNetworkAccessPolicy_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/InvokeJitNetworkAccessPolicy_example.json new file mode 100644 index 000000000000..95e378b7cb31 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/InvokeJitNetworkAccessPolicy_example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "resourceGroupName": "myRg1", + "jitNetworkAccessPolicyName": "default", + "jitNetworkAccessPolicyActionType": "initiate", + "body": { + "virtualMachines": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [ + { + "number": 3389, + "duration": "PT1H", + "allowedSourceAddressPrefix": "192.127.0.2" + } + ] + } + ] + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Locations/GetLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Locations/GetLocation_example.json new file mode 100644 index 000000000000..97c210917a96 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Locations/GetLocation_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "centralus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/centralus", + "name": "centralus", + "type": "Microsoft.Security/locations", + "properties": { + "homeRegionName": "centralus" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Locations/GetLocations_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Locations/GetLocations_example.json new file mode 100644 index 000000000000..d5ffd8738b01 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Locations/GetLocations_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/centralus", + "name": "centralus", + "type": "Microsoft.Security/locations", + "properties": { + "homeRegionName": "centralus" + } + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTaskResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTaskResourceGroupLocation_example.json new file mode 100644 index 000000000000..3fcc10920cdc --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTaskResourceGroupLocation_example.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg", + "ascLocation": "westeurope", + "taskName": "d55b4dc0-779c-c66c-33e5-d7bce24c4222" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/locations/westeurope/tasks/d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "name": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "type": "Microsoft.Security/locations/tasks", + "properties": { + "state": "Active", + "subState": "NA", + "creationTimeUtc": "2018-04-02T11:41:27.0541014Z", + "lastStateChangeTimeUtc": "2018-04-02T11:41:27.0541014Z", + "securityTaskParameters": { + "vmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "vmName": "vm1", + "severity": "High", + "isOsDiskEncrypted": false, + "isDataDiskEncrypted": false, + "name": "EncryptionOnVm", + "uniqueKey": "EncryptionOnVmTaskParameters_/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTaskSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTaskSubscriptionLocation_example.json new file mode 100644 index 000000000000..cdc93f875de2 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTaskSubscriptionLocation_example.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "taskName": "62609ee7-d0a5-8616-9fe4-1df5cca7758d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/westeurope/tasks/62609ee7-d0a5-8616-9fe4-1df5cca7758d", + "name": "62609ee7-d0a5-8616-9fe4-1df5cca7758d", + "type": "Microsoft.Security/locations/tasks", + "properties": { + "state": "Active", + "subState": "NA", + "creationTimeUtc": "2018-03-05T10:42:03.9935508Z", + "lastStateChangeTimeUtc": "2018-03-05T10:42:03.9935508Z", + "securityTaskParameters": { + "resourceName": "default", + "resourceType": "Subnet", + "resourceParent": "vnet1", + "location": "uksouth", + "resourceGroup": "myRg", + "name": "NetworkSecurityGroupMissingOnSubnet", + "uniqueKey": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default", + "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksResourceGroupLocation_example.json new file mode 100644 index 000000000000..3dd4b1f07640 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksResourceGroupLocation_example.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg", + "ascLocation": "westeurope" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/locations/westeurope/tasks/d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "name": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "type": "Microsoft.Security/locations/tasks", + "properties": { + "state": "Active", + "subState": "NA", + "creationTimeUtc": "2018-04-02T11:41:27.0541014Z", + "lastStateChangeTimeUtc": "2018-04-02T11:41:27.0541014Z", + "securityTaskParameters": { + "vmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "vmName": "vm1", + "severity": "High", + "isOsDiskEncrypted": false, + "isDataDiskEncrypted": false, + "name": "EncryptionOnVm", + "uniqueKey": "EncryptionOnVmTaskParameters_/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1" + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksSubscriptionLocation_example.json new file mode 100644 index 000000000000..f7b50de923fd --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksSubscriptionLocation_example.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/westeurope/tasks/62609ee7-d0a5-8616-9fe4-1df5cca7758d", + "name": "62609ee7-d0a5-8616-9fe4-1df5cca7758d", + "type": "Microsoft.Security/locations/tasks", + "properties": { + "state": "Active", + "subState": "NA", + "creationTimeUtc": "2018-03-05T10:42:03.9935508Z", + "lastStateChangeTimeUtc": "2018-03-05T10:42:03.9935508Z", + "securityTaskParameters": { + "resourceName": "default", + "resourceType": "Subnet", + "resourceParent": "vnet1", + "location": "uksouth", + "resourceGroup": "myRg", + "name": "NetworkSecurityGroupMissingOnSubnet", + "uniqueKey": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default", + "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default" + } + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/locations/westeurope/tasks/d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "name": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "type": "Microsoft.Security/locations/tasks", + "properties": { + "state": "Active", + "subState": "NA", + "creationTimeUtc": "2018-04-02T11:41:27.0541014Z", + "lastStateChangeTimeUtc": "2018-04-02T11:41:27.0541014Z", + "securityTaskParameters": { + "vmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "vmName": "vm1", + "severity": "High", + "isOsDiskEncrypted": false, + "isDataDiskEncrypted": false, + "name": "EncryptionOnVm", + "uniqueKey": "EncryptionOnVmTaskParameters_/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1" + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksSubscription_example.json new file mode 100644 index 000000000000..ed5e2100f33d --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksSubscription_example.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/westeurope/tasks/62609ee7-d0a5-8616-9fe4-1df5cca7758d", + "name": "62609ee7-d0a5-8616-9fe4-1df5cca7758d", + "type": "Microsoft.Security/locations/tasks", + "properties": { + "state": "Active", + "subState": "NA", + "creationTimeUtc": "2018-03-05T10:42:03.9935508Z", + "lastStateChangeTimeUtc": "2018-03-05T10:42:03.9935508Z", + "securityTaskParameters": { + "resourceName": "default", + "resourceType": "Subnet", + "resourceParent": "vnet1", + "location": "uksouth", + "resourceGroup": "myRg", + "name": "NetworkSecurityGroupMissingOnSubnet", + "uniqueKey": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default", + "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default" + } + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/locations/westeurope/tasks/d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "name": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "type": "Microsoft.Security/locations/tasks", + "properties": { + "state": "Active", + "subState": "NA", + "creationTimeUtc": "2018-04-02T11:41:27.0541014Z", + "lastStateChangeTimeUtc": "2018-04-02T11:41:27.0541014Z", + "securityTaskParameters": { + "vmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "vmName": "vm1", + "severity": "High", + "isOsDiskEncrypted": false, + "isDataDiskEncrypted": false, + "name": "EncryptionOnVm", + "uniqueKey": "EncryptionOnVmTaskParameters_/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1" + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/UpdateTaskResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/UpdateTaskResourceGroupLocation_example.json new file mode 100644 index 000000000000..4008f6de1d33 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/UpdateTaskResourceGroupLocation_example.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "resourceGroupName": "myRg", + "taskName": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "taskUpdateActionType": "Dismiss" + }, + "responses": { + "204": { + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/UpdateTaskSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/UpdateTaskSubscriptionLocation_example.json new file mode 100644 index 000000000000..0b72f9904b58 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/UpdateTaskSubscriptionLocation_example.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "taskName": "62609ee7-d0a5-8616-9fe4-1df5cca7758d", + "taskUpdateActionType": "Dismiss" + }, + "responses": { + "204": { + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json new file mode 100644 index 000000000000..393f66b40116 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json @@ -0,0 +1,2679 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "version": "2015-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Security/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Exposes all available operations for discovery purposes.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations": { + "get": { + "x-ms-examples": { + "Get security data locations": { + "$ref": "./examples/Locations/GetLocations_example.json" + } + }, + "tags": [ + "Locations" + ], + "description": "The location of the responsible ASC of the specific subscription (home region). For each subscription there is only one responsible location. The location in the response should be used to read or write other resources in ASC according to their ID.", + "operationId": "Locations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AscLocationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}": { + "get": { + "x-ms-examples": { + "Get security data location": { + "$ref": "./examples/Locations/GetLocation_example.json" + } + }, + "tags": [ + "Locations" + ], + "description": "Details of a specific location", + "operationId": "Locations_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AscLocation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/tasks": { + "get": { + "x-ms-examples": { + "Get security recommendations tasks": { + "$ref": "./examples/Tasks/GetTasksSubscription_example.json" + } + }, + "tags": [ + "Tasks" + ], + "description": "Recommended tasks that will help improve the security of the subscription proactively", + "operationId": "Tasks_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ODataFilter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTaskList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/tasks": { + "get": { + "x-ms-examples": { + "Get security recommendations tasks from security data location": { + "$ref": "./examples/Tasks/GetTasksSubscriptionLocation_example.json" + } + }, + "tags": [ + "Tasks" + ], + "description": "Recommended tasks that will help improve the security of the subscription proactively", + "operationId": "Tasks_ListByHomeRegion", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ODataFilter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTaskList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/tasks/{taskName}": { + "get": { + "x-ms-examples": { + "Get security recommendation task from security data location": { + "$ref": "./examples/Tasks/GetTaskSubscriptionLocation_example.json" + } + }, + "tags": [ + "Tasks" + ], + "description": "Recommended tasks that will help improve the security of the subscription proactively", + "operationId": "Tasks_GetSubscriptionLevelTask", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/TaskName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/tasks/{taskName}/{taskUpdateActionType}": { + "post": { + "x-ms-examples": { + "Change security recommendation task state": { + "$ref": "./examples/Tasks/UpdateTaskSubscriptionLocation_example.json" + } + }, + "tags": [ + "Tasks" + ], + "description": "Recommended tasks that will help improve the security of the subscription proactively", + "operationId": "Tasks_UpdateSubscriptionLevelTaskState", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/TaskName" + }, + { + "$ref": "#/parameters/TaskUpdateActionType" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/tasks": { + "get": { + "x-ms-examples": { + "Get security recommendation tasks in a resource group": { + "$ref": "./examples/Tasks/GetTasksResourceGroupLocation_example.json" + } + }, + "tags": [ + "Tasks" + ], + "description": "Recommended tasks that will help improve the security of the subscription proactively", + "operationId": "Tasks_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ODataFilter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTaskList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/tasks/{taskName}": { + "get": { + "x-ms-examples": { + "Get security recommendation task in a resource group": { + "$ref": "./examples/Tasks/GetTaskResourceGroupLocation_example.json" + } + }, + "tags": [ + "Tasks" + ], + "description": "Recommended tasks that will help improve the security of the subscription proactively", + "operationId": "Tasks_GetResourceGroupLevelTask", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/TaskName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/tasks/{taskName}/{taskUpdateActionType}": { + "post": { + "x-ms-examples": { + "Change security recommendation task state": { + "$ref": "./examples/Tasks/UpdateTaskResourceGroupLocation_example.json" + } + }, + "tags": [ + "Tasks" + ], + "description": "Recommended tasks that will help improve the security of the subscription proactively", + "operationId": "Tasks_UpdateResourceGroupLevelTaskState", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/TaskName" + }, + { + "$ref": "#/parameters/TaskUpdateActionType" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/alerts": { + "get": { + "x-ms-examples": { + "Get security alerts on a subscription": { + "$ref": "./examples/Alerts/GetAlertsSubscription_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "List all the alerts that are associated with the subscription", + "operationId": "Alerts_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataSelect" + }, + { + "$ref": "#/parameters/ODataExpand" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/alerts": { + "get": { + "x-ms-examples": { + "Get security alerts on a resource group": { + "$ref": "./examples/Alerts/GetAlertsResourceGroup_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "List all the alerts alerts that are associated with the resource group", + "operationId": "Alerts_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataSelect" + }, + { + "$ref": "#/parameters/ODataExpand" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts": { + "get": { + "x-ms-examples": { + "Get security alerts on a subscription from a security data location": { + "$ref": "./examples/Alerts/GetAlertsSubscriptionsLocation_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "List all the alerts that are associated with the subscription that are stored in a specific location", + "operationId": "Alerts_ListSubscriptionLevelAlertsByRegion", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataSelect" + }, + { + "$ref": "#/parameters/ODataExpand" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts": { + "get": { + "x-ms-examples": { + "Get security alerts on a resource group from a security data location": { + "$ref": "./examples/Alerts/GetAlertsResourceGroupLocation_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "List all the alerts that are associated with the resource group that are stored in a specific location", + "operationId": "Alerts_ListResourceGroupLevelAlertsByRegion", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataSelect" + }, + { + "$ref": "#/parameters/ODataExpand" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}": { + "get": { + "x-ms-examples": { + "Get security alert on a subscription from a security data location": { + "$ref": "./examples/Alerts/GetAlertSubscriptionLocation_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "Get an alert that is associated with a subscription", + "operationId": "Alerts_GetSubscriptionLevelAlert", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/AlertName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}": { + "get": { + "x-ms-examples": { + "Get security alert on a resource group from a security data location": { + "$ref": "./examples/Alerts/GetAlertResourceGroupLocation_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "Get an alert that is associated a resource group or a resource in a resource group", + "operationId": "Alerts_GetResourceGroupLevelAlerts", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/AlertName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/{alertUpdateActionType}": { + "post": { + "x-ms-examples": { + "Update security alert state on a subscription from a security data location": { + "$ref": "./examples/Alerts/UpdateAlertSubscriptionLocation_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "Update the alert's state", + "operationId": "Alerts_UpdateSubscriptionLevelAlertState", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/AlertName" + }, + { + "$ref": "#/parameters/AlertUpdateActionType" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/{alertUpdateActionType}": { + "post": { + "x-ms-examples": { + "Update security alert state on a resource group from a security data location": { + "$ref": "./examples/Alerts/UpdateAlertResourceGroupLocation_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "Update the alert's state", + "operationId": "Alerts_UpdateResourceGroupLevelAlertState", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/AlertName" + }, + { + "$ref": "#/parameters/AlertUpdateActionType" + }, + { + "$ref": "#/parameters/ResourceGroupName" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiscoveredSecuritySolutionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiscoveredSecuritySolutionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/DiscoveredSecuritySolutionName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiscoveredSecuritySolution" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/jitNetworkAccessPolicies": { + "get": { + "x-ms-examples": { + "Get JIT network access policies on a subscription": { + "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscription_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Policies for protecting resources using Just-in-Time access control.", + "operationId": "JitNetworkAccessPolicies_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies": { + "get": { + "x-ms-examples": { + "Get JIT network access policies on a subscription from a security data location": { + "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscriptionLocation_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Policies for protecting resources using Just-in-Time access control for the subscription, location", + "operationId": "JitNetworkAccessPolicies_ListByRegion", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/jitNetworkAccessPolicies": { + "get": { + "x-ms-examples": { + "Get JIT network access policies on a resource group": { + "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroup_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Policies for protecting resources using Just-in-Time access control for the subscription, location", + "operationId": "JitNetworkAccessPolicies_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies": { + "get": { + "x-ms-examples": { + "Get JIT network access policies on a resource group from a security data location": { + "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroupLocation_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Policies for protecting resources using Just-in-Time access control for the subscription, location", + "operationId": "JitNetworkAccessPolicies_ListByResourceGroupAndRegion", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies/{jitNetworkAccessPolicyName}": { + "get": { + "x-ms-examples": { + "Get JIT network access policy": { + "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPolicy_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Policies for protecting resources using Just-in-Time access control for the subscription, location", + "operationId": "JitNetworkAccessPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create JIT network access policy": { + "$ref": "./examples/JitNetworkAccessPolicies/CreateJitNetworkAccessPolicy_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Create a policy for protecting resources using Just-in-Time access control", + "operationId": "JitNetworkAccessPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicy" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a JIT network access policy": { + "$ref": "./examples/JitNetworkAccessPolicies/DeleteJitNetworkAccessPolicy_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Delete a Just-in-Time access control policy.", + "operationId": "JitNetworkAccessPolicies_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK - Resource was deleted" + }, + "204": { + "description": "No Content - Resource does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies/{jitNetworkAccessPolicyName}/{jitNetworkAccessPolicyInitiateType}": { + "post": { + "x-ms-examples": { + "Initiate an action on a JIT network access policy": { + "$ref": "./examples/JitNetworkAccessPolicies/InitiateJitNetworkAccessPolicy_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Initiate a JIT access from a specific Just-in-Time policy configuration.", + "operationId": "JitNetworkAccessPolicies_Initiate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyName" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyInitiateType" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyInitiateRequest" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/JitNetworkAccessRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/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": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExternalSecuritySolutionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExternalSecuritySolutionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/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": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ExternalSecuritySolutionsName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExternalSecuritySolution" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CloudError": { + "x-ms-external": true, + "type": "object", + "description": "Error response structure.", + "properties": { + "error": { + "x-ms-client-flatten": true, + "description": "Error data", + "$ref": "#/definitions/CloudErrorBody" + } + } + }, + "CloudErrorBody": { + "x-ms-external": true, + "type": "object", + "description": "Error details.", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + } + }, + "Resource": { + "type": "object", + "description": "Describes an Azure 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" + } + }, + "x-ms-azure-resource": true + }, + "Kind": { + "type": "object", + "description": "Describes an Azure resource with kind", + "properties": { + "kind": { + "type": "string", + "description": "Kind of the resource" + } + } + }, + "Location": { + "type": "object", + "description": "Describes an Azure resource with location", + "properties": { + "location": { + "readOnly": true, + "type": "string", + "description": "Location where the resource is stored" + } + } + }, + "OperationList": { + "type": "object", + "description": "List of possible operations for Microsoft.Security resource provider", + "properties": { + "value": { + "type": "array", + "description": "List of Security operations", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "Operation": { + "type": "object", + "description": "Possible operation in the REST API of Microsoft.Security", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the operation" + }, + "origin": { + "readOnly": true, + "type": "string", + "description": "Where the operation is originated" + }, + "display": { + "$ref": "#/definitions/OperationDisplay" + } + } + }, + "OperationDisplay": { + "type": "object", + "description": "Security operation display", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "The resource provider for the operation." + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "The display name of the resource the operation applies to." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "The display name of the security operation." + }, + "description": { + "readOnly": true, + "type": "string", + "description": "The description of the operation." + } + } + }, + "SecurityTaskList": { + "type": "object", + "description": "List of security task recommendations", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SecurityTask" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "SecurityTask": { + "type": "object", + "description": "Security task that we recommend to do in order to strengthen security", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityTaskProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "SecurityTaskProperties": { + "type": "object", + "description": "Describes properties of a task.", + "properties": { + "state": { + "readOnly": true, + "type": "string", + "description": "State of the task (Active, Resolved etc.)" + }, + "creationTimeUtc": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time this task was discovered in UTC" + }, + "securityTaskParameters": { + "$ref": "#/definitions/SecurityTaskParameters" + }, + "lastStateChangeTimeUtc": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time this task's details were last changed in UTC" + }, + "subState": { + "readOnly": true, + "type": "string", + "description": "Additional data on the state of the task" + } + } + }, + "SecurityTaskParameters": { + "type": "object", + "description": "Changing set of properties, depending on the task type that is derived from the name field", + "additionalProperties": { + "type": "object" + }, + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the task type" + } + } + }, + "AscLocationList": { + "type": "object", + "description": "List of locations where ASC saves your data", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AscLocation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "AscLocation": { + "type": "object", + "description": "The ASC location of the subscription is in the \"name\" field", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AscLocationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "AscLocationProperties": { + "type": "object", + "description": "An empty set of properties" + }, + "AlertList": { + "type": "object", + "description": "List of security alerts", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Alert" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "Alert": { + "type": "object", + "description": "Security alert", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AlertProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "AlertProperties": { + "type": "object", + "description": "describes security alert properties.", + "properties": { + "state": { + "readOnly": true, + "type": "string", + "description": "State of the alert (Active, Dismissed etc.)" + }, + "reportedTimeUtc": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time the incident was reported to Microsoft.Security in UTC" + }, + "vendorName": { + "readOnly": true, + "type": "string", + "description": "Name of the vendor that discovered the incident" + }, + "alertName": { + "readOnly": true, + "type": "string", + "description": "Name of the alert type" + }, + "alertDisplayName": { + "readOnly": true, + "type": "string", + "description": "Display name of the alert type" + }, + "detectedTimeUtc": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time the incident was detected by the vendor" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Description of the incident and what it means" + }, + "remediationSteps": { + "readOnly": true, + "type": "string", + "description": "Recommended steps to reradiate the incident" + }, + "actionTaken": { + "readOnly": true, + "type": "string", + "description": "The action that was taken as a response to the alert (Active, Blocked etc.)" + }, + "reportedSeverity": { + "readOnly": true, + "type": "string", + "description": "Estimated severity of this alert" + }, + "compromisedEntity": { + "readOnly": true, + "type": "string", + "description": "The entity that the incident happened on" + }, + "associatedResource": { + "readOnly": true, + "type": "string", + "description": "Azure resource ID of the associated resource" + }, + "extendedProperties": { + "$ref": "#/definitions/AlertExtendedProperties" + }, + "systemSource": { + "readOnly": true, + "type": "string", + "description": "The type of the alerted resource (Azure, Non-Azure)" + }, + "canBeInvestigated": { + "readOnly": true, + "type": "boolean", + "description": "Whether this alert can be investigated with Azure Security Center" + }, + "entities": { + "type": "array", + "description": "objects that are related to this alerts", + "items": { + "$ref": "#/definitions/AlertEntity" + } + }, + "confidenceScore": { + "readOnly": true, + "type": "number", + "format": "float", + "minimum": 0, + "maximum": 1, + "description": "level of confidence we have on the alert" + }, + "confidenceReasons": { + "type": "array", + "description": "reasons the alert got the confidenceScore value", + "items": { + "$ref": "#/definitions/AlertConfidenceReason" + } + }, + "subscriptionId": { + "readOnly": true, + "type": "string", + "description": "Azure subscription ID of the resource that had the security alert or the subscription ID of the workspace that this resource reports to" + }, + "instanceId": { + "readOnly": true, + "type": "string", + "description": "Instance ID of the alert." + }, + "workspaceArmId": { + "readOnly": true, + "type": "string", + "description": "Azure resource ID of the workspace that the alert was reported to." + } + } + }, + "AlertConfidenceReason": { + "type": "object", + "description": "Factors that increase our confidence that the alert is a true positive", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "Type of confidence factor" + }, + "reason": { + "readOnly": true, + "type": "string", + "description": "description of the confidence reason" + } + } + }, + "AlertEntity": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "Changing set of properties depending on the entity type.", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "Type of entity" + } + } + }, + "AlertExtendedProperties": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "Changing set of properties depending on the alert type." + }, + "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": "#/definitions/Resource" + }, + { + "$ref": "#/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" + ] + }, + "JitNetworkAccessPoliciesList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JitNetworkAccessPolicy" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "JitNetworkAccessPolicy": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/JitNetworkAccessPolicyProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/Kind" + }, + { + "$ref": "#/definitions/Location" + } + ] + }, + "JitNetworkAccessPolicyProperties": { + "type": "object", + "properties": { + "virtualMachines": { + "type": "array", + "description": "Configurations for Microsoft.Compute/virtualMachines resource type.", + "items": { + "$ref": "#/definitions/JitNetworkAccessPolicyVirtualMachine" + } + }, + "requests": { + "type": "array", + "items": { + "$ref": "#/definitions/JitNetworkAccessRequest" + } + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Gets the provisioning state of the Just-in-Time policy." + } + }, + "required": [ + "virtualMachines" + ] + }, + "JitNetworkAccessPolicyVirtualMachine": { + "type": "object", + "required": [ + "id", + "ports" + ], + "properties": { + "id": { + "type": "string", + "description": "Resource ID of the virtual machine that is linked to this policy" + }, + "ports": { + "type": "array", + "description": "Port configurations for the virtual machine", + "items": { + "$ref": "#/definitions/JitNetworkAccessPortRule" + } + } + } + }, + "JitNetworkAccessPortRule": { + "type": "object", + "properties": { + "number": { + "$ref": "#/definitions/PortNumber" + }, + "protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP", + "*" + ], + "x-ms-enum": { + "name": "protocol", + "modelAsString": true, + "values": [ + { + "value": "TCP" + }, + { + "value": "UDP" + }, + { + "value": "*", + "name": "All" + } + ] + } + }, + "allowedSourceAddressPrefix": { + "type": "string", + "description": "Mutually exclusive with the \"allowedSourceAddressPrefixes\" parameter. Should be an IP address or CIDR, for example \"192.168.0.3\" or \"192.168.0.0/16\"." + }, + "allowedSourceAddressPrefixes": { + "type": "array", + "description": "Mutually exclusive with the \"allowedSourceAddressPrefix\" parameter.", + "items": { + "type": "string", + "description": "IP address or CIDR, for example \"192.168.0.3\" or \"192.168.0.0/16\"." + } + }, + "maxRequestAccessDuration": { + "type": "string", + "description": "Maximum duration requests can be made for. In ISO 8601 duration format. Minimum 5 minutes, maximum 1 day" + } + }, + "required": [ + "maxRequestAccessDuration", + "number", + "protocol" + ] + }, + "JitNetworkAccessRequest": { + "type": "object", + "properties": { + "virtualMachines": { + "type": "array", + "items": { + "$ref": "#/definitions/JitNetworkAccessRequestVirtualMachine" + } + }, + "startTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The start time of the request in UTC" + }, + "requestor": { + "type": "string", + "description": "The identity of the person who made the request" + } + }, + "required": [ + "requestor", + "startTimeUtc", + "virtualMachines" + ] + }, + "JitNetworkAccessRequestVirtualMachine": { + "type": "object", + "required": [ + "id", + "ports" + ], + "properties": { + "id": { + "type": "string", + "description": "Resource ID of the virtual machine that is linked to this policy" + }, + "ports": { + "type": "array", + "description": "The ports that were opened for the virtual machine", + "items": { + "$ref": "#/definitions/JitNetworkAccessRequestPort" + } + } + } + }, + "JitNetworkAccessRequestPort": { + "type": "object", + "properties": { + "number": { + "$ref": "#/definitions/PortNumber" + }, + "allowedSourceAddressPrefix": { + "type": "string", + "description": "Mutually exclusive with the \"allowedSourceAddressPrefixes\" parameter. Should be an IP address or CIDR, for example \"192.168.0.3\" or \"192.168.0.0/16\"." + }, + "allowedSourceAddressPrefixes": { + "type": "array", + "description": "Mutually exclusive with the \"allowedSourceAddressPrefix\" parameter.", + "items": { + "description": "IP addess or CIDR, for example \"192.168.0.3\" or \"192.168.0.0/16\".", + "type": "string" + } + }, + "endTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The date & time at which the request ends in UTC" + }, + "status": { + "type": "string", + "description": "The status of the port", + "enum": [ + "Revoked", + "Initiated" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true, + "values": [ + { + "value": "Revoked" + }, + { + "value": "Initiated" + } + ] + } + }, + "statusReason": { + "type": "string", + "description": "A description of why the `status` has its value", + "enum": [ + "Expired", + "UserRequested", + "NewerRequestInitiated" + ], + "x-ms-enum": { + "name": "statusReason", + "modelAsString": true, + "values": [ + { + "value": "Expired" + }, + { + "value": "UserRequested" + }, + { + "value": "NewerRequestInitiated" + } + ] + } + } + }, + "required": [ + "endTimeUtc", + "number", + "status", + "statusReason" + ] + }, + "JitNetworkAccessPolicyInitiateRequest": { + "type": "object", + "properties": { + "virtualMachines": { + "type": "array", + "description": "A list of virtual machines & ports to open access for", + "items": { + "$ref": "#/definitions/JitNetworkAccessPolicyInitiateVirtualMachine" + } + } + }, + "required": [ + "virtualMachines" + ] + }, + "JitNetworkAccessPolicyInitiateVirtualMachine": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of the virtual machine that is linked to this policy" + }, + "ports": { + "type": "array", + "description": "The ports to open for the resource with the `id`", + "items": { + "$ref": "#/definitions/JitNetworkAccessPolicyInitiatePort" + } + } + }, + "required": [ + "id", + "ports" + ] + }, + "JitNetworkAccessPolicyInitiatePort": { + "type": "object", + "properties": { + "number": { + "$ref": "#/definitions/PortNumber" + }, + "allowedSourceAddressPrefix": { + "type": "string", + "description": "Source of the allowed traffic. If omitted, the request will be for the source IP address of the initiate request." + }, + "endTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The time to close the request in UTC" + } + }, + "required": [ + "endTimeUtc", + "number" + ] + }, + "PortNumber": { + "type": "integer", + "minimum": 0, + "maximum": 65535 + }, + "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 whos data is displayed by Azure Security Center.", + "discriminator": "kind", + "properties": {}, + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/ExternalSecuritySolutionKind" + }, + { + "$ref": "#/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": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", + "type": "string", + "description": "Azure subscription ID" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2015-06-01-preview" + ], + "description": "API version for the operation" + }, + "AscLocation": { + "name": "ascLocation", + "in": "path", + "required": true, + "type": "string", + "description": "The location where ASC stores the data of the subscription. can be retrieved from Get locations", + "x-ms-parameter-location": "client" + }, + "ExtendedResourceProvider": { + "name": "extendedResourceProvider", + "in": "path", + "required": true, + "type": "string", + "description": "Resource provider name of the base resource", + "x-ms-parameter-location": "method" + }, + "ExtendedResourceType": { + "name": "extendedResourceType", + "in": "path", + "required": true, + "type": "string", + "description": "Type of the base resource", + "x-ms-parameter-location": "method" + }, + "ExtendedResourceName": { + "name": "extendedResourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the base resource", + "x-ms-parameter-location": "method" + }, + "ODataFilter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter. Optional.", + "x-ms-parameter-location": "method" + }, + "ODataSelect": { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "OData select. Optional.", + "x-ms-parameter-location": "method" + }, + "ODataExpand": { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "OData expand. Optional.", + "x-ms-parameter-location": "method" + }, + "TaskName": { + "name": "taskName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the task object, will be a GUID", + "x-ms-parameter-location": "method" + }, + "TaskUpdateActionType": { + "name": "taskUpdateActionType", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Activate", + "Dismiss", + "Start", + "Resolve", + "Close" + ], + "description": "Type of the action to do on the task", + "x-ms-parameter-location": "method" + }, + "AlertName": { + "name": "alertName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the alert object", + "x-ms-parameter-location": "method" + }, + "AlertUpdateActionType": { + "name": "alertUpdateActionType", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Dismiss", + "Reactivate" + ], + "description": "Type of the action to do on the alert", + "x-ms-parameter-location": "method" + }, + "DiscoveredSecuritySolutionName": { + "name": "discoveredSecuritySolutionName", + "type": "string", + "in": "path", + "required": true, + "description": "Name of a discovered security solution.", + "x-ms-parameter-location": "method" + }, + "JitNetworkAccessPolicyName": { + "name": "jitNetworkAccessPolicyName", + "type": "string", + "in": "path", + "required": true, + "description": "Name of a Just-in-Time access configuration policy.", + "x-ms-parameter-location": "method" + }, + "JitNetworkAccessPolicyInitiateType": { + "name": "jitNetworkAccessPolicyInitiateType", + "type": "string", + "in": "path", + "required": true, + "description": "Type of the action to do on the Just-in-Time access policy.", + "enum": [ + "initiate" + ], + "x-ms-parameter-location": "method" + }, + "JitNetworkAccessPolicyInitiateRequest": { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JitNetworkAccessPolicyInitiateRequest" + }, + "x-ms-parameter-location": "method" + }, + "JitNetworkAccessPolicy": { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JitNetworkAccessPolicy" + }, + "x-ms-parameter-location": "method" + }, + "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/2017-08-01-preview/examples/AutoProvisioningSettings/CreateAutoProvisioningSettingsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/CreateAutoProvisioningSettingsSubscription_example.json new file mode 100644 index 000000000000..507975c379e2 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/CreateAutoProvisioningSettingsSubscription_example.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "settingName": "default", + "setting": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/autoProvisioningSettings/default", + "name": "default", + "type": "Microsoft.Security/autoProvisioningSettings", + "properties": { + "autoProvision": "On" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/autoProvisioningSettings/default", + "name": "default", + "type": "Microsoft.Security/autoProvisioningSettings", + "properties": { + "autoProvision": "On" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingSubscription_example.json new file mode 100644 index 000000000000..6ff9bb0e7264 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingSubscription_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "settingName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/autoProvisioningSettings/default", + "name": "default", + "type": "Microsoft.Security/autoProvisioningSettings", + "properties": { + "autoProvision": "On" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json new file mode 100644 index 000000000000..1574e0bfb25c --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/autoProvisioningSettings/default", + "name": "default", + "type": "Microsoft.Security/autoProvisioningSettings", + "properties": { + "autoProvision": "On" + } + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliance_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliance_example.json new file mode 100644 index 000000000000..13282477404d --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliance_example.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "complianceName": "2018-01-01Z" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-01Z", + "name": "2018-01-01Z", + "type": "Microsoft.Security/compliances", + "properties": { + "assessmentResult": [ + { + "segmentType": "Compliant", + "percentage": 77.77777777777778 + } + ], + "resourceCount": 18, + "assessmentTimestampUtcDate": "2018-01-01T00:00:00Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliances_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliances_example.json new file mode 100644 index 000000000000..572e5dfd150d --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliances_example.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-01Z", + "name": "2018-01-01Z", + "type": "Microsoft.Security/compliances", + "properties": { + "assessmentResult": [ + { + "segmentType": "Compliant", + "percentage": 77.77777777777778 + } + ], + "resourceCount": 18, + "assessmentTimestampUtcDate": "2018-01-01T00:00:00Z" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-02Z", + "name": "2018-01-02Z", + "type": "Microsoft.Security/compliances", + "properties": { + "assessmentResult": [ + { + "segmentType": "Compliant", + "percentage": 94.44444444444444 + } + ], + "resourceCount": 18, + "assessmentTimestampUtcDate": "2018-01-02T00:00:00Z" + } + + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-03Z", + "name": "2018-01-03Z", + "type": "Microsoft.Security/compliances", + "properties": { + "assessmentResult": [ + { + "segmentType": "Compliant", + "percentage": 100 + } + ], + "resourceCount": 18, + "assessmentTimestampUtcDate": "2018-01-03T00:00:00Z" + } + + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/CreatePricingsResourceGroup_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/CreatePricingsResourceGroup_example.json new file mode 100644 index 000000000000..4c6f9559b08c --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/CreatePricingsResourceGroup_example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg", + "pricingName": "myRg", + "pricing": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/pricings/myRg", + "name": "myRg", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/myRg", + "name": "myRg", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/CreatePricingsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/CreatePricingsSubscription_example.json new file mode 100644 index 000000000000..015885fc5779 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/CreatePricingsSubscription_example.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "pricingName": "default", + "pricing": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/default", + "name": "default", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/default", + "name": "default", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingResourceGroup_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingResourceGroup_example.json new file mode 100644 index 000000000000..f261d4fdacad --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingResourceGroup_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg", + "pricingName": "myRg" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/myRg", + "name": "myRg", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingSubscription_example.json new file mode 100644 index 000000000000..03457284b7a9 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingSubscription_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "pricingName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/default", + "name": "default", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingsResourceGroup_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingsResourceGroup_example.json new file mode 100644 index 000000000000..26fe2c08bcbd --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingsResourceGroup_example.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/myRg", + "name": "myRg", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingsSubscription_example.json new file mode 100644 index 000000000000..d32cc7e34516 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingsSubscription_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/default", + "name": "default", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_example.json new file mode 100644 index 000000000000..9deda54049f1 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_example.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "john", + "securityContact": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", + "name": "john", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "john@contoso.com", + "phone": "(214)275-4038", + "alertNotifications": "On", + "alertsToAdmins": "On" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", + "name": "john", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "john@contoso.com", + "phone": "(214)275-4038", + "alertNotifications": "On", + "alertsToAdmins": "On" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/DeleteSecurityContact_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/DeleteSecurityContact_example.json new file mode 100644 index 000000000000..948df8317165 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/DeleteSecurityContact_example.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "john" + }, + "responses": { + "204": { + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_example.json new file mode 100644 index 000000000000..fcc0762de7c6 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "john" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", + "name": "john", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "john@contoso.com", + "phone": "(214)275-4038", + "alertNotifications": "On", + "alertsToAdmins": "On" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_example.json new file mode 100644 index 000000000000..514a72a545d1 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_example.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", + "name": "john", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "john@contoso.com", + "phone": "(214)275-4038", + "alertNotifications": "On", + "alertsToAdmins": "On" + } + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_example.json new file mode 100644 index 000000000000..1de75b59b395 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_example.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "john", + "securityContact": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", + "name": "john", + "type": "Microsoft.Security/securityContacts", + "properties": { + "phone": "(214)275-4038", + "alertNotifications": "On" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", + "name": "john", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "john@contoso.com", + "phone": "(214)275-4038", + "alertNotifications": "On", + "alertsToAdmins": "Off" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/CreateWorkspaceSetting_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/CreateWorkspaceSetting_example.json new file mode 100644 index 000000000000..93f50607489c --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/CreateWorkspaceSetting_example.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "workspaceSettingName": "default", + "workspaceSetting": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", + "name": "default", + "type": "Microsoft.Security/workspaceSettings", + "properties": { + "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", + "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", + "name": "default", + "type": "Microsoft.Security/workspaceSettings", + "properties": { + "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", + "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/DeleteWorkspaceSetting_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/DeleteWorkspaceSetting_example.json new file mode 100644 index 000000000000..e1446e820d88 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/DeleteWorkspaceSetting_example.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "workspaceSettingName": "default" + }, + "responses": { + "204": { + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/GetWorkspaceSetting_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/GetWorkspaceSetting_example.json new file mode 100644 index 000000000000..5f9db230473b --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/GetWorkspaceSetting_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "workspaceSettingName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", + "name": "default", + "type": "Microsoft.Security/workspaceSettings", + "properties": { + "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", + "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/GetWorkspaceSettings_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/GetWorkspaceSettings_example.json new file mode 100644 index 000000000000..b27d8bf1b0f0 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/GetWorkspaceSettings_example.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", + "name": "default", + "type": "Microsoft.Security/workspaceSettings", + "properties": { + "workspaceId": "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1", + "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/workspaceSettings/myRg", + "name": "myRg", + "type": "Microsoft.Security/workspaceSettings", + "properties": { + "workspaceId": "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myOtherRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace2", + "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/UpdateWorkspaceSetting_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/UpdateWorkspaceSetting_example.json new file mode 100644 index 000000000000..78a09a611098 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/UpdateWorkspaceSetting_example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "workspaceSettingName": "default", + "workspaceSetting": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", + "name": "default", + "type": "Microsoft.Security/workspaceSettings", + "properties": { + "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", + "name": "default", + "type": "Microsoft.Security/workspaceSettings", + "properties": { + "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", + "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json new file mode 100644 index 000000000000..cc2d14c50ce9 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json @@ -0,0 +1,1240 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "version": "2017-08-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/pricings": { + "get": { + "x-ms-examples": { + "Get pricings on subscription": { + "$ref": "./examples/Pricings/GetPricingsSubscription_example.json" + } + }, + "tags": ["Pricings"], + "description": "Security pricing configurations in the subscription", + "operationId": "Pricings_List", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PricingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/pricings": { + "get": { + "x-ms-examples": { + "Get pricings on subscription": { + "$ref": "./examples/Pricings/GetPricingsResourceGroup_example.json" + } + }, + "tags": ["Pricings"], + "description": "Security pricing configurations in the resource group", + "operationId": "Pricings_ListByResourceGroup", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/ResourceGroupName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PricingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}": { + "get": { + "x-ms-examples": { + "Get pricings on subscription": { + "$ref": "./examples/Pricings/GetPricingSubscription_example.json" + } + }, + "tags": ["Pricings"], + "description": "Security pricing configuration in the subscriptionSecurity pricing configuration in the subscription", + "operationId": "Pricings_GetSubscriptionPricing", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/PricingName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Pricing" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Update pricings on subscription": { + "$ref": "./examples/Pricings/CreatePricingsSubscription_example.json" + } + }, + "tags": ["Pricings"], + "description": "Security pricing configuration in the subscription", + "operationId": "Pricings_UpdateSubscriptionPricing", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/PricingName" + }, { + "$ref": "#/parameters/Pricing" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Pricing" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/pricings/{pricingName}": { + "get": { + "x-ms-examples": { + "Get pricings on subscription": { + "$ref": "./examples/Pricings/GetPricingResourceGroup_example.json" + } + }, + "tags": ["Pricings"], + "description": "Security pricing configuration in the resource group", + "operationId": "Pricings_GetResourceGroupPricing", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/ResourceGroupName" + }, { + "$ref": "#/parameters/PricingName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Pricing" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Update pricings on resource group": { + "$ref": "./examples/Pricings/CreatePricingsResourceGroup_example.json" + } + }, + "tags": ["Pricings"], + "description": "Security pricing configuration in the resource group", + "operationId": "Pricings_CreateOrUpdateResourceGroupPricing", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/ResourceGroupName" + }, { + "$ref": "#/parameters/PricingName" + }, { + "$ref": "#/parameters/Pricing" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Pricing" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts": { + "get": { + "x-ms-examples": { + "Update security contact data": { + "$ref": "./examples/SecurityContacts/GetSecurityContactsSubscription_example.json" + } + }, + "tags": ["Security Contacts"], + "description": "Security contact configurations for the subscription", + "operationId": "SecurityContacts_List", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityContactList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName}": { + "get": { + "x-ms-examples": { + "Get security contact data": { + "$ref": "./examples/SecurityContacts/GetSecurityContact_example.json" + } + }, + "tags": ["Security Contacts"], + "description": "Security contact configurations for the subscription", + "operationId": "SecurityContacts_Get", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/SecurityContactName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityContact" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create security contact data": { + "$ref": "./examples/SecurityContacts/CreateSecurityContact_example.json" + } + }, + "tags": ["Security Contacts"], + "description": "Security contact configurations for the subscription", + "operationId": "SecurityContacts_Create", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/SecurityContactName" + }, { + "$ref": "#/parameters/SecurityContact" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityContact" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete security contact data": { + "$ref": "./examples/SecurityContacts/DeleteSecurityContact_example.json" + } + }, + "tags": ["Security Contacts"], + "description": "Security contact configurations for the subscription", + "operationId": "SecurityContacts_Delete", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/SecurityContactName" + }], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "x-ms-examples": { + "Update security contact data": { + "$ref": "./examples/SecurityContacts/UpdateSecurityContact_example.json" + } + }, + "tags": ["Security Contacts"], + "description": "Security contact configurations for the subscription", + "operationId": "SecurityContacts_Update", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/SecurityContactName" + }, { + "$ref": "#/parameters/SecurityContact" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityContact" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/workspaceSettings": { + "get": { + "x-ms-examples": { + "Get workspace settings on subscription": { + "$ref": "./examples/WorkspaceSettings/GetWorkspaceSettings_example.json" + } + }, + "tags": ["Workspace Settings"], + "description": "Settings about where we should store your security data and logs", + "operationId": "WorkspaceSettings_List", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceSettingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/workspaceSettings/{workspaceSettingName}": { + "get": { + "x-ms-examples": { + "Get a workspace setting on subscription": { + "$ref": "./examples/WorkspaceSettings/GetWorkspaceSetting_example.json" + } + }, + "tags": ["Workspace Settings"], + "description": "Settings about where we should store your security data and logs", + "operationId": "WorkspaceSettings_Get", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/WorkspaceSettingName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create a workspace setting data for subscription": { + "$ref": "./examples/WorkspaceSettings/CreateWorkspaceSetting_example.json" + } + }, + "tags": ["Workspace Settings"], + "description": "creating settings about where we should store your security data and logs", + "operationId": "WorkspaceSettings_Create", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/WorkspaceSettingName" + }, { + "$ref": "#/parameters/WorkspaceSetting" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "x-ms-examples": { + "Update a workspace setting data for subscription": { + "$ref": "./examples/WorkspaceSettings/UpdateWorkspaceSetting_example.json" + } + }, + "tags": ["Workspace Settings"], + "description": "Settings about where we should store your security data and logs", + "operationId": "WorkspaceSettings_Update", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/WorkspaceSettingName" + }, { + "$ref": "#/parameters/WorkspaceSetting" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a workspace setting data for resource group": { + "$ref": "./examples/WorkspaceSettings/DeleteWorkspaceSetting_example.json" + } + }, + "tags": ["Workspace Settings"], + "description": "Deletes the custom workspace settings for this subscription. new VMs will report to the default workspace", + "operationId": "WorkspaceSettings_Delete", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/WorkspaceSettingName" + }], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/autoProvisioningSettings": { + "get": { + "x-ms-examples": { + "Get auto provisioning settings for subscription": { + "$ref": "./examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json" + } + }, + "tags": ["AutoProvisioningSettings"], + "description": "Exposes the auto provisioning settings of the subscriptions", + "operationId": "AutoProvisioningSettings_List", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AutoProvisioningSettingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/autoProvisioningSettings/{settingName}": { + "get": { + "x-ms-examples": { + "Get an auto provisioning setting for subscription": { + "$ref": "./examples/AutoProvisioningSettings/GetAutoProvisioningSettingSubscription_example.json" + } + }, + "tags": ["AutoProvisioningSettings"], + "description": "Details of a specific setting", + "operationId": "AutoProvisioningSettings_Get", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/AutoProvisioningSettingName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AutoProvisioningSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create auto provisioning settings for subscription": { + "$ref": "./examples/AutoProvisioningSettings/CreateAutoProvisioningSettingsSubscription_example.json" + } + }, + "tags": ["AutoProvisioningSettings"], + "description": "Details of a specific setting", + "operationId": "AutoProvisioningSettings_Create", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/AutoProvisioningSettingName" + }, { + "$ref": "#/parameters/AutoProvisioningSetting" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AutoProvisioningSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Security/compliances": { + "get": { + "x-ms-examples": { + "Get security compliance data over time": { + "$ref": "./examples/Compliances/GetCompliances_example.json" + } + }, + "tags": ["Compliances"], + "description": "The Compliance scores of the specific management group.", + "operationId": "Compliances_List", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Scope" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ComplianceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Security/compliances/{complianceName}": { + "get": { + "x-ms-examples": { + "Get security compliance data for a day": { + "$ref": "./examples/Compliances/GetCompliance_example.json" + } + }, + "tags": ["Compliances"], + "description": "Details of a specific Compliance.", + "operationId": "Compliances_Get", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Scope" + }, + { + "$ref": "#/parameters/ComplianceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Compliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CloudError": { + "x-ms-external": true, + "type": "object", + "description": "Error response structure.", + "properties": { + "error": { + "x-ms-client-flatten": true, + "description": "Error data", + "$ref": "#/definitions/CloudErrorBody" + } + } + }, + "CloudErrorBody": { + "x-ms-external": true, + "type": "object", + "description": "Error details.", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + } + }, + "Resource": { + "type": "object", + "description": "Describes an Azure 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" + } + }, + "x-ms-azure-resource": true + }, + "SecurityContactList": { + "type": "object", + "description": "List of security contacts response", + "properties": { + "value": { + "readOnly": true, + "description": "List of security contacts", + "type": "array", + "items": { + "$ref": "#/definitions/SecurityContact" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "SecurityContact": { + "type": "object", + "description": "Contact details for security issues", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Security contact data", + "$ref": "#/definitions/SecurityContactProperties" + } + }, + "allOf": [{ + "$ref": "#/definitions/Resource" + }] + }, + "SecurityContactProperties": { + "type": "object", + "description": "describes security contact properties", + "properties": { + "email": { + "type": "string", + "format": "email", + "description": "The email of this security contact" + }, + "phone": { + "type": "string", + "description": "The phone number of this security contact" + }, + "alertNotifications": { + "type": "string", + "enum": ["On", "Off"], + "x-ms-enum": { + "name": "alertNotifications", + "modelAsString": true, + "values": [{ + "value": "On", + "description": "Get notifications on new alerts" + }, + { + "value": "Off", + "description": "Don't get notifications on new alerts" + } + ] + }, + "description": "Whether to send security alerts notifications to the security contact" + }, + "alertsToAdmins": { + "type": "string", + "enum": ["On", "Off"], + "x-ms-enum": { + "name": "alertsToAdmins", + "modelAsString": true, + "values": [{ + "value": "On", + "description": "Send notification on new alerts to the subscription's admins" + }, + { + "value": "Off", + "description": "Don't send notification on new alerts to the subscription's admins" + } + ] + }, + "description": "Whether to send security alerts notifications to subscription admins" + } + }, + "required": [ + "email", + "phone", + "alertNotifications", + "alertsToAdmins" + ] + }, + "PricingList": { + "description": "List of pricing configurations response", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of pricing configurations", + "items": { + "$ref": "#/definitions/Pricing" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "Pricing": { + "type": "object", + "description": "Pricing tier will be applied for the scope based on the resource ID", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Pricing data", + "$ref": "#/definitions/PricingProperties" + } + }, + "allOf": [{ + "$ref": "#/definitions/Resource" + }] + }, + "PricingProperties": { + "type": "object", + "description": "Pricing data", + "properties": { + "pricingTier": { + "type": "string", + "description": "Pricing tier type", + "enum": ["Free", "Standard"], + "x-ms-enum": { + "name": "pricingTier", + "modelAsString": true, + "values": [{ + "value": "Free", + "description": "Get free Azure security center experience with basic security features" + }, + { + "value": "Standard", + "description": "Get the standard Azure security center experience with advanced security features" + } + ] + } + } + }, + "required": [ + "pricingTier" + ] + }, + "WorkspaceSettingList": { + "description": "List of workspace settings response", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of workspace settings", + "items": { + "$ref": "#/definitions/WorkspaceSetting" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "WorkspaceSetting": { + "type": "object", + "description": "Configures where to store the OMS agent data for workspaces under a scope", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Workspace setting data", + "$ref": "#/definitions/WorkspaceSettingProperties" + } + }, + "allOf": [{ + "$ref": "#/definitions/Resource" + }] + }, + "WorkspaceSettingProperties": { + "type": "object", + "description": "Workspace setting data", + "properties": { + "workspaceId": { + "type": "string", + "description": "The full Azure ID of the workspace to save the data in" + }, + "scope": { + "type": "string", + "description": "All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope" + } + }, + "required": [ + "workspaceId", + "scope" + ] + }, + "AutoProvisioningSettingList": { + "type": "object", + "description": "List of all the auto provisioning settings response", + "properties": { + "value": { + "description": "List of all the auto provisioning settings", + "type": "array", + "items": { + "$ref": "#/definitions/AutoProvisioningSetting" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "AutoProvisioningSetting": { + "type": "object", + "description": "Auto provisioning setting", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Auto provisioning setting data", + "$ref": "#/definitions/AutoProvisioningSettingProperties" + } + }, + "allOf": [{ + "$ref": "#/definitions/Resource" + }] + }, + "AutoProvisioningSettingProperties": { + "type": "object", + "description": "describes properties of an auto provisioning setting", + "properties": { + "autoProvision": { + "type": "string", + "description": "Describes what kind of security agent provisioning action to take", + "enum": ["On", "Off"], + "x-ms-enum": { + "name": "autoProvision", + "modelAsString": true, + "values": [{ + "value": "On", + "description": "Install missing security agent on VMs automatically" + }, + { + "value": "Off", + "description": "Do not install security agent on the VMs automatically" + } + ] + } + } + }, + "required": [ + "autoProvision" + ] + }, + "ComplianceList": { + "type": "object", + "readOnly": true, + "description": "List of Compliance objects response", + "properties": { + "value": { + "type": "array", + "description": "List of Compliance objects", + "items": { + "$ref": "#/definitions/Compliance" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "Compliance": { + "type": "object", + "readOnly": true, + "description": "Compliance of a scope", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Compliance data", + "$ref": "#/definitions/ComplianceProperties" + } + }, + "allOf": [{ + "$ref": "#/definitions/Resource" + }] + }, + "ComplianceProperties": { + "type": "object", + "description": "The Compliance score (percentage) of a Subscription is a sum of all Resources' Compliances under the given Subscription. A Resource Compliance is defined as the compliant ('healthy') Policy Definitions out of all Policy Definitions applicable to a given resource.", + "properties": { + "assessmentTimestampUtcDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The timestamp when the Compliance calculation was conducted." + }, + "resourceCount": { + "readOnly": true, + "type": "integer", + "description": "The resource count of the given subscription for which the Compliance calculation was conducted (needed for Management Group Compliance calculation)." + }, + "assessmentResult": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ComplianceSegment" + }, + "description": "An array of segment, which is the actually the compliance assessment." + } + } + }, + "ComplianceSegment": { + "type": "object", + "description": "A segment of a compliance assessment.", + "properties": { + "segmentType": { + "readOnly": true, + "type": "string", + "description": "The segment type, e.g. compliant, non-compliance, insufficient coverage, N/A, etc." + }, + "percentage": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The size (%) of the segment." + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", + "type": "string", + "description": "Azure subscription ID" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": ["2017-08-01-preview"], + "description": "API version for the operation" + }, + "Scope": { + "name": "scope", + "in": "path", + "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" + }, + "PricingName": { + "name": "pricingName", + "in": "path", + "required": true, + "type": "string", + "description": "name of the pricing configuration", + "x-ms-parameter-location": "method" + }, + "Pricing": { + "name": "pricing", + "in": "body", + "required": true, + "description": "Pricing object", + "schema": { + "$ref": "#/definitions/Pricing" + }, + "x-ms-parameter-location": "method" + }, + "SecurityContactName": { + "name": "securityContactName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the security contact object", + "x-ms-parameter-location": "method" + }, + "SecurityContact": { + "name": "securityContact", + "in": "body", + "required": true, + "description": "Security contact object", + "schema": { + "$ref": "#/definitions/SecurityContact" + }, + "x-ms-parameter-location": "method" + }, + "WorkspaceSettingName": { + "name": "workspaceSettingName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the security setting", + "x-ms-parameter-location": "method" + }, + "WorkspaceSetting": { + "name": "workspaceSetting", + "in": "body", + "required": true, + "description": "Security data setting object", + "schema": { + "$ref": "#/definitions/WorkspaceSetting" + }, + "x-ms-parameter-location": "method" + }, + "AutoProvisioningSettingName": { + "name": "settingName", + "in": "path", + "required": true, + "type": "string", + "description": "Auto provisioning setting key", + "x-ms-parameter-location": "method" + }, + "AutoProvisioningSetting": { + "name": "setting", + "in": "body", + "required": true, + "description": "Auto provisioning setting key", + "schema": { + "$ref": "#/definitions/AutoProvisioningSetting" + }, + "x-ms-parameter-location": "method" + }, + "ComplianceName": { + "name": "complianceName", + "in": "path", + "required": true, + "type": "string", + "description": "name of the Compliance", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/readme.go.md b/specification/security/resource-manager/readme.go.md new file mode 100644 index 000000000000..7aff2b222cfc --- /dev/null +++ b/specification/security/resource-manager/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: security + clear-output-folder: true +``` + +### Go multi-api + +```yaml $(go) && $(multiapi) +batch: + - tag: package-composite-v1 +``` + +### Tag: package-composite-v1 and go + +These settings apply only when `--tag=package-composite-v1 --go` is specified on the command line. +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) +``` diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md new file mode 100644 index 000000000000..ee6e112ca887 --- /dev/null +++ b/specification/security/resource-manager/readme.md @@ -0,0 +1,83 @@ +# 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: security.json + where: $.definitions.SecurityContactProperties.properties.email.format + reason: email format is allowed +``` + +### Basic Information + +These are the global settings for the Security API. + +```yaml +openapi-type: arm +tag: package-composite-v1 +``` + +### 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/2017-08-01-preview/security.json +- Microsoft.Security/preview/2015-06-01-preview/security.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-go +``` + +## C + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Security + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/Security/Management.Security/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/servermanagement/resource-manager/Microsoft.ServerManagement/preview/2015-07-01-preview/servermanagement.json b/specification/servermanagement/resource-manager/Microsoft.ServerManagement/preview/2015-07-01-preview/servermanagement.json deleted file mode 100644 index 5412e479c0e2..000000000000 --- a/specification/servermanagement/resource-manager/Microsoft.ServerManagement/preview/2015-07-01-preview/servermanagement.json +++ /dev/null @@ -1,2150 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ServerManagement", - "description": "REST API for Azure Server Management Service.", - "version": "2015-07-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/gateways/{gatewayName}": { - "put": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_Create", - "description": "Creates or updates a ManagementService gateway.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The gateway name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "GatewayParameters", - "x-ms-client-flatten": true, - "description": "Parameters supplied to the CreateOrUpdate operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/GatewayParameters" - } - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/GatewayResource" - } - }, - "201": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/GatewayResource" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "operationId": "Gateway_Update", - "description": "Updates a gateway belonging to a resource group.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The gateway name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "GatewayParameters", - "x-ms-client-flatten": true, - "description": "Parameters supplied to the Update operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/GatewayParameters" - } - } - ], - "responses": { - "200": { - "description": "Update completed successfully.", - "schema": { - "$ref": "#/definitions/GatewayResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_Delete", - "description": "Deletes a gateway from a resource group.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The gateway name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - } - ], - "responses": { - "200": { - "description": "The object exists and was deleted successfully." - }, - "204": { - "description": "The request is well formed but the resource does not exist." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "get": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_Get", - "description": "Gets a gateway.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The gateway name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "status" - ], - "x-ms-enum": { - "name": "GatewayExpandOption", - "modelAsString": false - }, - "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/GatewayResource" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServerManagement/gateways": { - "get": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_List", - "description": "Lists gateways in a subscription.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/GatewayResources" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/gateways": { - "get": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_ListForResourceGroup", - "description": "Returns gateways in a resource group.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/GatewayResources" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/gateways/{gatewayName}/upgradetolatest": { - "post": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_Upgrade", - "description": "Upgrades a gateway.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The gateway name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully." - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/gateways/{gatewayName}/regenerateprofile": { - "post": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_RegenerateProfile", - "description": "Regenerates a gateway's profile", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The gateway name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully." - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/gateways/{gatewayName}/profile": { - "post": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_GetProfile", - "description": "Gets a gateway profile.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The gateway name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/GatewayProfile" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}": { - "put": { - "tags": [ - "Nodes" - ], - "operationId": "Node_Create", - "description": "Creates or updates a management node.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "GatewayParameters", - "x-ms-client-flatten": true, - "description": "Parameters supplied to the CreateOrUpdate operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NodeParameters" - } - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/NodeResource" - } - }, - "201": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/NodeResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "Nodes" - ], - "operationId": "Node_Update", - "description": "Updates a management node.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "NodeParameters", - "x-ms-client-flatten": true, - "description": "Parameters supplied to the CreateOrUpdate operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NodeParameters" - } - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/NodeResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Nodes" - ], - "operationId": "Node_Delete", - "description": "Deletes a management node.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - } - ], - "responses": { - "200": { - "description": "The object exists and was deleted successfully." - }, - "204": { - "description": "The request is well formed but the resource does not exist." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "get": { - "tags": [ - "Nodes" - ], - "operationId": "Node_Get", - "description": "Gets a management node.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - } - ], - "responses": { - "200": { - "description": "The object exists and was deleted successfully.", - "schema": { - "$ref": "#/definitions/NodeResource" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServerManagement/nodes": { - "get": { - "tags": [ - "Nodes" - ], - "operationId": "Node_List", - "description": "Lists nodes in a subscription.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/NodeResources" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes": { - "get": { - "tags": [ - "Nodes" - ], - "operationId": "Node_ListForResourceGroup", - "description": "Lists nodes in a resource group.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/NodeResources" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}/sessions/{session}": { - "put": { - "tags": [ - "Sessions" - ], - "operationId": "Session_Create", - "description": "Creates a session for a node.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - }, - { - "name": "SessionParameters", - "in": "body", - "x-ms-client-flatten": true, - "description": "Parameters supplied to the CreateOrUpdate operation.", - "required": true, - "schema": { - "$ref": "#/definitions/SessionParameters" - } - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/SessionResource" - } - }, - "201": { - "description": "Created: the session has been created.", - "schema": { - "$ref": "#/definitions/SessionResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Sessions" - ], - "operationId": "Session_Delete", - "description": "Deletes a session for a node.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - } - ], - "responses": { - "200": { - "description": "The operation completed successfully." - }, - "204": { - "description": "The request is well formed but the resource does not exist." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "get": { - "tags": [ - "Sessions" - ], - "operationId": "Session_Get", - "description": "Gets a session for a node.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/SessionResource" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}/sessions/{session}/features/powerShellConsole/pssessions": { - "get": { - "tags": [ - "PowerShell" - ], - "operationId": "PowerShell_ListSession", - "description": "Gets a list of the active sessions.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/PowerShellSessionResources" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}/sessions/{session}/features/powerShellConsole/pssessions/{pssession}": { - "put": { - "tags": [ - "PowerShell" - ], - "operationId": "PowerShell_CreateSession", - "description": "Creates a PowerShell session.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - }, - { - "name": "pssession", - "in": "path", - "required": true, - "type": "string", - "description": "The PowerShell sessionId from the user." - } - ], - "responses": { - "200": { - "description": "The operation completed succesfully.", - "schema": { - "$ref": "#/definitions/PowerShellSessionResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "PowerShell" - ], - "operationId": "PowerShell_GetCommandStatus", - "description": "Gets the status of a command.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - }, - { - "name": "pssession", - "in": "path", - "required": true, - "type": "string", - "description": "The PowerShell sessionId from the user." - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "output" - ], - "x-ms-enum": { - "modelAsString": false, - "name": "PowerShellExpandOption" - }, - "description": "Gets current output from an ongoing call." - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/PowerShellCommandStatus" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "patch": { - "tags": [ - "PowerShell" - ], - "operationId": "PowerShell_UpdateCommand", - "description": "updates a running PowerShell command with more data.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - }, - { - "name": "pssession", - "in": "path", - "required": true, - "type": "string", - "description": "The PowerShell sessionId from the user." - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/PowerShellCommandResults" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}/sessions/{session}/features/powerShellConsole/pssessions/{pssession}/invokeCommand": { - "post": { - "tags": [ - "PowerShell" - ], - "operationId": "PowerShell_InvokeCommand", - "description": "Creates a PowerShell script and invokes it.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - }, - { - "name": "pssession", - "in": "path", - "required": true, - "type": "string", - "description": "The PowerShell sessionId from the user." - }, - { - "name": "PowerShellCommandParameters", - "x-ms-client-flatten": true, - "description": "Parameters supplied to the Invoke PowerShell Command operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PowerShellCommandParameters" - } - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/PowerShellCommandResults" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}/sessions/{session}/features/powerShellConsole/pssessions/{pssession}/cancel": { - "post": { - "tags": [ - "PowerShell" - ], - "operationId": "PowerShell_CancelCommand", - "description": "Cancels a PowerShell command.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - }, - { - "name": "pssession", - "in": "path", - "required": true, - "type": "string", - "description": "The PowerShell sessionId from the user." - } - ], - "responses": { - "200": { - "description": "The cancellation was completed successfully.", - "schema": { - "$ref": "#/definitions/PowerShellCommandResults" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}/sessions/{session}/features/powerShellConsole/pssessions/{pssession}/tab": { - "post": { - "tags": [ - "PowerShell" - ], - "operationId": "PowerShell_TabCompletion", - "description": "Gets tab completion values for a command.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - }, - { - "name": "pssession", - "in": "path", - "required": true, - "type": "string", - "description": "The PowerShell sessionId from the user." - }, - { - "name": "PowerShellTabCompletionParamters", - "x-ms-client-flatten": true, - "description": "Parameters supplied to the tab completion call.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PowerShellTabCompletionParameters" - } - } - ], - "responses": { - "200": { - "description": "The request was succesfully completed.", - "schema": { - "$ref": "#/definitions/PowerShellTabCompletionResults" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - } - }, - "definitions": { - "Resource": { - "x-ms-azure-resource": true, - "description": "Resource Manager Resource Information.", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Manager Resource ID." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource Manager Resource Type." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource Manager Resource Name." - }, - "location": { - "type": "string", - "readOnly": true, - "description": "Resource Manager Resource Location." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource Manager Resource Tags." - }, - "etag": { - "type": "string" - } - } - }, - "GatewayResource": { - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "created": { - "type": "string", - "format": "date-time", - "description": "UTC date and time when gateway was first added to management service." - }, - "updated": { - "type": "string", - "format": "date-time", - "description": "UTC date and time when node was last updated." - }, - "autoUpgrade": { - "type": "string", - "description": "Setting of the autoupgrade.", - "enum": [ - "On", - "Off" - ], - "x-ms-enum": { - "name": "AutoUpgrade", - "modelAsString": false - } - }, - "desiredVersion": { - "type": "string", - "description": "Latest available MSI version." - }, - "instances": { - "type": "array", - "items": { - "$ref": "#/definitions/GatewayStatus" - }, - "description": "Names of the nodes in the gateway." - }, - "activeMessageCount": { - "type": "integer", - "description": "number of active messages" - }, - "latestPublishedMsiVersion": { - "type": "string", - "description": "Last published MSI version." - }, - "publishedTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The date/time of the last published gateway." - } - } - } - } - }, - "GatewayResources": { - "type": "object", - "description": "Collection of Gateway Resources.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/GatewayResource" - }, - "description": "Collection of Gateway Resources." - }, - "nextLink": { - "type": "string", - "description": "The URL to the next set of resources." - } - } - }, - "GatewayStatus": { - "description": "Expanded gateway status information.", - "properties": { - "availableMemoryMByte": { - "type": "number", - "description": "The available memory on the gateway host machine in megabytes." - }, - "gatewayCpuUtilizationPercent": { - "type": "number", - "minimum": 0, - "maximum": 100, - "format": "float", - "description": "The CPU utilization of the gateway process (numeric value between 0 and 100)." - }, - "totalCpuUtilizationPercent": { - "type": "number", - "description": "CPU Utilization of the whole system." - }, - "gatewayVersion": { - "type": "string", - "description": "The version of the gateway that is installed on the system." - }, - "friendlyOsName": { - "type": "string", - "description": "The Plaintext description of the OS on the gateway." - }, - "installedDate": { - "type": "string", - "format": "date-time", - "description": "The date the gateway was installed." - }, - "logicalProcessorCount": { - "type": "integer", - "description": "Number of logical processors in the gateway system." - }, - "name": { - "type": "string", - "description": "The computer name of the gateway system." - }, - "gatewayId": { - "type": "string", - "description": "The gateway resource ID." - }, - "gatewayWorkingSetMByte": { - "type": "number", - "description": "The working set size of the gateway process in megabytes." - }, - "statusUpdated": { - "type": "string", - "format": "date-time", - "description": "UTC date and time when gateway status was last updated." - } - } - }, - "GatewayProfile": { - "description": "JSON properties that the gateway service uses know how to communicate with the resource.", - "properties": { - "dataPlaneServiceBaseAddress": { - "type": "string", - "description": "The Dataplane connection URL." - }, - "gatewayId": { - "type": "string", - "description": "The ID of the gateway." - }, - "environment": { - "type": "string", - "description": "The environment for the gateway (DEV, DogFood, or Production)." - }, - "upgradeManifestUrl": { - "type": "string", - "description": "Gateway upgrade manifest URL." - }, - "messagingNamespace": { - "type": "string", - "description": "Messaging namespace." - }, - "messagingAccount": { - "type": "string", - "description": "Messaging Account." - }, - "messagingKey": { - "type": "string", - "description": "Messaging Key." - }, - "requestQueue": { - "type": "string", - "description": "Request queue name." - }, - "responseTopic": { - "type": "string", - "description": "Response topic name." - }, - "statusBlobSignature": { - "type": "string", - "description": "The gateway status blob SAS URL." - } - } - }, - "GatewayParameters": { - "properties": { - "location": { - "type": "string", - "description": "Location of the resource." - }, - "tags": { - "type": "object", - "description": "Resource tags." - }, - "properties": { - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "autoUpgrade": { - "type": "string", - "description": "The autoUpgrade property gives the flexibility to gateway to auto upgrade itself. If properties value not specified, then we assume autoUpgrade = Off.", - "enum": [ - "On", - "Off" - ], - "x-ms-enum": { - "name": "AutoUpgrade", - "modelAsString": false - } - } - } - } - } - }, - "NodeResource": { - "description": "A Node Resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "gatewayId": { - "type": "string", - "description": "ID of the gateway." - }, - "connectionName": { - "type": "string", - "description": "myhost.domain.com" - }, - "created": { - "type": "string", - "format": "date-time", - "description": "UTC date and time when node was first added to management service." - }, - "updated": { - "type": "string", - "format": "date-time", - "description": "UTC date and time when node was last updated." - } - } - } - } - }, - "NodeResources": { - "type": "object", - "description": "A collection of node resource objects.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeResource" - }, - "description": "Collection of Node Resources." - }, - "nextLink": { - "type": "string", - "description": "The URL to the next set of resources." - } - } - }, - "NodeParameters": { - "properties": { - "location": { - "type": "string", - "description": "Location of the resource." - }, - "tags": { - "type": "object", - "description": "Resource tags." - }, - "properties": { - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "gatewayId": { - "type": "string", - "description": "Gateway ID which will manage this node." - }, - "connectionName": { - "type": "string", - "description": "myhost.domain.com" - }, - "userName": { - "type": "string", - "description": "User name to be used to connect to node." - }, - "password": { - "type": "string", - "format": "password", - "description": "Password associated with user name." - } - } - } - } - }, - "SessionResource": { - "description": "The session object.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "userName": { - "type": "string", - "description": "The username connecting to the session." - }, - "created": { - "type": "string", - "format": "date-time", - "description": "UTC date and time when node was first added to management service." - }, - "updated": { - "type": "string", - "format": "date-time", - "description": "UTC date and time when node was last updated." - } - } - } - } - }, - "SessionParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "userName": { - "type": "string", - "description": "User name to be used to connect to node." - }, - "password": { - "type": "string", - "format": "password", - "description": "Password associated with user name." - } - } - } - } - }, - "PowerShellSessionResource": { - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "A PowerShell session resource (practically equivalent to a runspace instance).", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "sessionId": { - "type": "string", - "description": "The PowerShell Session ID." - }, - "state": { - "type": "string", - "description": "The runspace state." - }, - "runspaceAvailability": { - "type": "string", - "description": "The availability of the runspace." - }, - "disconnectedOn": { - "type": "string", - "format": "date-time", - "description": "Timestamp of last time the service disconnected from the runspace." - }, - "expiresOn": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the runspace expires." - }, - "version": { - "$ref": "#/definitions/Version" - }, - "name": { - "type": "string", - "description": "Name of the runspace." - } - } - } - } - }, - "PowerShellCommandStatus": { - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PowerShellCommandResults" - } - } - }, - "Version": { - "description": "A multipart-numeric version number.", - "properties": { - "major": { - "type": "integer", - "description": "The leftmost number of the version." - }, - "minor": { - "type": "integer", - "description": "The second leftmost number of the version." - }, - "build": { - "type": "integer", - "description": "The third number of the version." - }, - "revision": { - "type": "integer", - "description": "The fourth number of the version." - }, - "majorRevision": { - "type": "integer", - "description": "The MSW of the fourth part." - }, - "minorRevision": { - "type": "integer", - "description": "The LSW of the fourth part." - } - } - }, - "PowerShellSessionResources": { - "description": "A collection of PowerShell session resources.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PowerShellSessionResource" - }, - "description": "Collection of PowerShell session resources." - }, - "nextLink": { - "type": "string", - "description": "The URL to the next set of resources." - } - } - }, - "PowerShellCommandParameters": { - "description": "The parameters to a PowerShell script execution command.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "command": { - "type": "string", - "description": "Script to execute." - } - } - } - } - }, - "PowerShellCommandResults": { - "description": "A collection of results from a PowerShell command.", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/definitions/PowerShellCommandResult" - } - }, - "pssession": { - "type": "string" - }, - "command": { - "type": "string" - }, - "completed": { - "type": "boolean" - } - } - }, - "PowerShellCommandResult": { - "properties": { - "messageType": { - "description": "The type of message.", - "type": "integer" - }, - "foregroundColor": { - "description": "The HTML color string representing the foreground color.", - "type": "string" - }, - "backgroundColor": { - "description": "The HTML color string representing the background color.", - "type": "string" - }, - "value": { - "description": "Actual result text from the PowerShell Command.", - "type": "string" - }, - "prompt": { - "description": "The interactive prompt message.", - "type": "string" - }, - "exitCode": { - "description": "The exit code from a executable that was called from PowerShell.", - "type": "integer" - }, - "id": { - "type": "integer", - "description": "ID of the prompt message." - }, - "caption": { - "type": "string", - "description": "Text that precedes the prompt." - }, - "message": { - "type": "string", - "description": "Text of the prompt." - }, - "descriptions": { - "type": "array", - "description": "Collection of PromptFieldDescription objects that contains the user input", - "items": { - "$ref": "#/definitions/PromptFieldDescription" - } - } - } - }, - "PromptFieldDescription": { - "description": "Field description for the implementation of PSHostUserInterface.Prompt.", - "properties": { - "name": { - "description": "The name of the prompt.", - "type": "string" - }, - "label": { - "description": "The label text of the prompt.", - "type": "string" - }, - "helpMessage": { - "description": "The help message of the prompt.", - "type": "string" - }, - "promptFieldTypeIsList": { - "description": "When set to 'true' the prompt field type is a list of values.", - "type": "boolean" - }, - "promptFieldType": { - "type": "string", - "enum": [ - "String", - "SecureString", - "Credential" - ], - "x-ms-enum": { - "name": "PromptFieldType", - "modelAsString": false - } - } - } - }, - "PromptMessageResponse": { - "description": "The response to a prompt message.", - "properties": { - "response": { - "description": "The list of responses a cmdlet expects.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "PowerShellTabCompletionParameters": { - "properties": { - "command": { - "type": "string", - "description": "Command to get tab completion for." - } - } - }, - "PowerShellTabCompletionResults": { - "description": "An array of strings representing the different values that can be selected through.", - "properties": { - "results": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "Error": { - "description": "Error message.", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - }, - "fields": { - "type": "string" - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API Version." - } - } -} \ No newline at end of file diff --git a/specification/servermanagement/resource-manager/Microsoft.ServerManagement/preview/2016-07-01-preview/servermanagement.json b/specification/servermanagement/resource-manager/Microsoft.ServerManagement/preview/2016-07-01-preview/servermanagement.json deleted file mode 100644 index a0ab30b21c6d..000000000000 --- a/specification/servermanagement/resource-manager/Microsoft.ServerManagement/preview/2016-07-01-preview/servermanagement.json +++ /dev/null @@ -1,2261 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ServerManagement", - "description": "REST API for Azure Server Management Service.", - "version": "2016-07-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/gateways/{gatewayName}": { - "put": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_Create", - "description": "Creates or updates a ManagementService gateway.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The gateway name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "GatewayParameters", - "x-ms-client-flatten": true, - "description": "Parameters supplied to the CreateOrUpdate operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/GatewayParameters" - } - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/GatewayResource" - } - }, - "201": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/GatewayResource" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "operationId": "Gateway_Update", - "description": "Updates a gateway belonging to a resource group.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The gateway name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "GatewayParameters", - "x-ms-client-flatten": true, - "description": "Parameters supplied to the Update operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/GatewayParameters" - } - } - ], - "responses": { - "200": { - "description": "Update completed successfully.", - "schema": { - "$ref": "#/definitions/GatewayResource" - } - }, - "202": { - "description": "Accepted: The location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_Delete", - "description": "Deletes a gateway from a resource group.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The gateway name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - } - ], - "responses": { - "200": { - "description": "The object exists and was deleted successfully." - }, - "204": { - "description": "The request is well formed but the resource does not exist." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "get": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_Get", - "description": "Gets a gateway.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The gateway name (256 characters maximum)", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "status", - "download" - ], - "x-ms-enum": { - "name": "GatewayExpandOption", - "modelAsString": false - }, - "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/GatewayResource" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServerManagement/gateways": { - "get": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_List", - "description": "Returns gateways in a subscription.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/GatewayResources" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/gateways": { - "get": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_ListForResourceGroup", - "description": "Returns gateways in a resource group.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/GatewayResources" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/gateways/{gatewayName}/upgradetolatest": { - "post": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_Upgrade", - "description": "Upgrades a gateway.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The gateway name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully." - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/gateways/{gatewayName}/regenerateprofile": { - "post": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_RegenerateProfile", - "description": "Regenerate a gateway's profile", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The gateway name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully." - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/gateways/{gatewayName}/profile": { - "post": { - "tags": [ - "Gateways" - ], - "operationId": "Gateway_GetProfile", - "description": "Gets a gateway profile.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "gatewayName", - "in": "path", - "required": true, - "type": "string", - "description": "The gateway name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/GatewayProfile" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}": { - "put": { - "tags": [ - "Nodes" - ], - "operationId": "Node_Create", - "description": "Creates or updates a management node.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "GatewayParameters", - "x-ms-client-flatten": true, - "description": "Parameters supplied to the CreateOrUpdate operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NodeParameters" - } - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/NodeResource" - } - }, - "201": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/NodeResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "Nodes" - ], - "operationId": "Node_Update", - "description": "Updates a management node.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "NodeParameters", - "x-ms-client-flatten": true, - "description": "Parameters supplied to the CreateOrUpdate operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NodeParameters" - } - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/NodeResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Nodes" - ], - "operationId": "Node_Delete", - "description": "deletes a management node", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - } - ], - "responses": { - "200": { - "description": "The object exists and was deleted successfully." - }, - "204": { - "description": "The request is well formed but the resource does not exist." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "get": { - "tags": [ - "Nodes" - ], - "operationId": "Node_Get", - "description": "Gets a management node.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - } - ], - "responses": { - "200": { - "description": "The object exists and was deleted successfully.", - "schema": { - "$ref": "#/definitions/NodeResource" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServerManagement/nodes": { - "get": { - "tags": [ - "Nodes" - ], - "operationId": "Node_List", - "description": "Lists nodes in a subscription.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/NodeResources" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes": { - "get": { - "tags": [ - "Nodes" - ], - "operationId": "Node_ListForResourceGroup", - "description": "Lists nodes in a resource group.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/NodeResources" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}/sessions/{session}": { - "put": { - "tags": [ - "Sessions" - ], - "operationId": "Session_Create", - "description": "Creates a session for a node.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - }, - { - "name": "SessionParameters", - "in": "body", - "x-ms-client-flatten": true, - "description": "Parameters supplied to the CreateOrUpdate operation.", - "required": true, - "schema": { - "$ref": "#/definitions/SessionParameters" - } - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/SessionResource" - } - }, - "201": { - "description": "Created: the session was created.", - "schema": { - "$ref": "#/definitions/SessionResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Sessions" - ], - "operationId": "Session_Delete", - "description": "Deletes a session for a node.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - } - ], - "responses": { - "200": { - "description": "The operation completed successfully." - }, - "204": { - "description": "The request is well formed but the resource does not exist." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "get": { - "tags": [ - "Sessions" - ], - "operationId": "Session_Get", - "description": "Gets a session for a node.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/SessionResource" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}/sessions/{session}/features/powerShellConsole/pssessions": { - "get": { - "tags": [ - "PowerShell" - ], - "operationId": "PowerShell_ListSession", - "description": "Gets a list of the active sessions.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/PowerShellSessionResources" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}/sessions/{session}/features/powerShellConsole/pssessions/{pssession}": { - "put": { - "tags": [ - "PowerShell" - ], - "operationId": "PowerShell_CreateSession", - "description": "Creates a PowerShell session.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - }, - { - "name": "pssession", - "in": "path", - "required": true, - "type": "string", - "description": "The PowerShell sessionId from the user." - } - ], - "responses": { - "200": { - "description": "The operation completed succesfully.", - "schema": { - "$ref": "#/definitions/PowerShellSessionResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "PowerShell" - ], - "operationId": "PowerShell_GetCommandStatus", - "description": "Gets the status of a command.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - }, - { - "name": "pssession", - "in": "path", - "required": true, - "type": "string", - "description": "The PowerShell sessionId from the user." - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "enum": [ - "output" - ], - "x-ms-enum": { - "modelAsString": false, - "name": "PowerShellExpandOption" - }, - "description": "Gets current output from an ongoing call." - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/PowerShellCommandStatus" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "patch": { - "tags": [ - "PowerShell" - ], - "operationId": "PowerShell_UpdateCommand", - "description": "Updates a running PowerShell command with more data.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - }, - { - "name": "pssession", - "in": "path", - "required": true, - "type": "string", - "description": "The PowerShell sessionId from the user." - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/PowerShellCommandResults" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}/sessions/{session}/features/powerShellConsole/pssessions/{pssession}/invokeCommand": { - "post": { - "tags": [ - "PowerShell" - ], - "operationId": "PowerShell_InvokeCommand", - "description": "Creates a PowerShell script and invokes it.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - }, - { - "name": "pssession", - "in": "path", - "required": true, - "type": "string", - "description": "The PowerShell sessionId from the user." - }, - { - "name": "PowerShellCommandParameters", - "x-ms-client-flatten": true, - "description": "Parameters supplied to the Invoke PowerShell Command operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PowerShellCommandParameters" - } - } - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/PowerShellCommandResults" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}/sessions/{session}/features/powerShellConsole/pssessions/{pssession}/cancel": { - "post": { - "tags": [ - "PowerShell" - ], - "operationId": "PowerShell_CancelCommand", - "description": "Cancels a PowerShell command.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - }, - { - "name": "pssession", - "in": "path", - "required": true, - "type": "string", - "description": "The PowerShell sessionId from the user." - } - ], - "responses": { - "200": { - "description": "The cancellation was completed successfully.", - "schema": { - "$ref": "#/definitions/PowerShellCommandResults" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServerManagement/nodes/{nodeName}/sessions/{session}/features/powerShellConsole/pssessions/{pssession}/tab": { - "post": { - "tags": [ - "PowerShell" - ], - "operationId": "PowerShell_TabCompletion", - "description": "Gets tab completion values for a command.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name uniquely identifies the resource group within the user subscriptionId.", - "minLength": 3, - "pattern": "[a-zA-Z0-9]+" - }, - { - "name": "nodeName", - "in": "path", - "required": true, - "type": "string", - "description": "The node name (256 characters maximum).", - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - { - "name": "session", - "in": "path", - "required": true, - "type": "string", - "description": "The sessionId from the user." - }, - { - "name": "pssession", - "in": "path", - "required": true, - "type": "string", - "description": "The PowerShell sessionId from the user." - }, - { - "name": "PowerShellTabCompletionParamters", - "x-ms-client-flatten": true, - "description": "Parameters supplied to the tab completion call.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PowerShellTabCompletionParameters" - } - } - ], - "responses": { - "200": { - "description": "The request was succesfully completed.", - "schema": { - "$ref": "#/definitions/PowerShellTabCompletionResults" - } - }, - "default": { - "description": "Default Response. It will be deserialized as per the error definition specified in the schema, and an exception will be thrown.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - } - }, - "definitions": { - "Resource": { - "x-ms-azure-resource": true, - "description": "Resource Manager Resource Information.", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Manager Resource ID." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource Manager Resource Type." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource Manager Resource Name." - }, - "location": { - "type": "string", - "readOnly": true, - "description": "Resource Manager Resource Location." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource Manager Resource Tags." - }, - "etag": { - "type": "string" - } - } - }, - "GatewayResource": { - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Data model for an arm gateway resource.", - "properties": { - "properties": { - "description": "Collection of properties.", - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "created": { - "type": "string", - "format": "date-time", - "description": "UTC date and time when gateway was first added to management service." - }, - "updated": { - "type": "string", - "format": "date-time", - "description": "UTC date and time when node was last updated." - }, - "upgradeMode": { - "type": "string", - "description": "The upgradeMode property gives the flexibility to gateway to auto upgrade itself. If properties value not specified, then we assume upgradeMode = Automatic.", - "enum": [ - "Manual", - "Automatic" - ], - "x-ms-enum": { - "name": "upgradeMode", - "modelAsString": false - } - }, - "desiredVersion": { - "type": "string", - "description": "Latest available MSI version." - }, - "instances": { - "type": "array", - "items": { - "$ref": "#/definitions/GatewayStatus" - }, - "description": "Names of the nodes in the gateway." - }, - "activeMessageCount": { - "type": "integer", - "description": "Number of active messages." - }, - "latestPublishedMsiVersion": { - "type": "string", - "description": "Last published MSI version." - }, - "publishedTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The date/time of the last published gateway." - }, - "installerDownload": { - "type": "string", - "readOnly": true, - "description": "Installer download uri." - }, - "minimumVersion": { - "type": "string", - "readOnly": true, - "description": "Minimum gateway version." - } - } - } - } - }, - "GatewayResources": { - "type": "object", - "description": "Collection of Gateway Resources.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/GatewayResource" - }, - "description": "Collection of Gateway Resources." - }, - "nextLink": { - "type": "string", - "description": "The URL to the next set of resources." - } - } - }, - "GatewayStatus": { - "description": "Expanded gateway status information.", - "properties": { - "availableMemoryMByte": { - "type": "number", - "description": "The available memory on the gateway host machine in megabytes." - }, - "gatewayCpuUtilizationPercent": { - "type": "number", - "minimum": 0, - "maximum": 100, - "format": "float", - "description": "The CPU utilization of the gateway process (numeric value between 0 and 100)." - }, - "totalCpuUtilizationPercent": { - "type": "number", - "description": "CPU Utilization of the whole system." - }, - "gatewayVersion": { - "type": "string", - "description": "The version of the gateway that is installed on the system." - }, - "friendlyOsName": { - "type": "string", - "description": "The Plaintext description of the OS on the gateway." - }, - "installedDate": { - "type": "string", - "format": "date-time", - "description": "The date the gateway was installed." - }, - "logicalProcessorCount": { - "type": "integer", - "description": "Number of logical processors in the gateway system." - }, - "name": { - "type": "string", - "description": "The computer name of the gateway system." - }, - "gatewayId": { - "type": "string", - "description": "The gateway resource ID." - }, - "gatewayWorkingSetMByte": { - "type": "number", - "description": "The working set size of the gateway process in megabytes." - }, - "statusUpdated": { - "type": "string", - "format": "date-time", - "description": "UTC date and time when gateway status was last updated." - }, - "groupPolicyError": { - "type": "string", - "description": "The group policy error." - }, - "allowGatewayGroupPolicyStatus": { - "type": "boolean", - "description": "Status of the allowGatewayGroupPolicy setting." - }, - "requireMfaGroupPolicyStatus": { - "type": "boolean", - "description": "Status of the requireMfaGroupPolicy setting." - }, - "encryptionCertificateThumbprint": { - "type": "string", - "description": "Thumbprint of the encryption certificate." - }, - "secondaryEncryptionCertificateThumbprint": { - "type": "string", - "description": "Secondary thumbprint of the encryption certificate." - }, - "encryptionJwk": { - "$ref": "#/definitions/EncryptionJwkResource", - "description": "The encryption certificate key." - }, - "secondaryEncryptionJwk": { - "$ref": "#/definitions/EncryptionJwkResource", - "description": "The secondary encryption certificate key." - }, - "activeMessageCount": { - "type": "integer", - "description": "Active message count." - }, - "latestPublishedMsiVersion": { - "type": "string", - "description": "Latest published version of the gateway install MSI." - }, - "publishedTimeUtc": { - "type": "string", - "format": "date-time", - "description": "Gateway install MSI published time." - } - } - }, - "GatewayProfile": { - "description": "JSON properties that the gateway service uses know how to communicate with the resource.", - "properties": { - "dataPlaneServiceBaseAddress": { - "type": "string", - "description": "The Dataplane connection URL." - }, - "gatewayId": { - "type": "string", - "description": "The ID of the gateway." - }, - "environment": { - "type": "string", - "description": "The environment for the gateway (DEV, DogFood, or Production)." - }, - "upgradeManifestUrl": { - "type": "string", - "description": "Gateway upgrade manifest URL." - }, - "messagingNamespace": { - "type": "string", - "description": "Messaging namespace." - }, - "messagingAccount": { - "type": "string", - "description": "Messaging Account." - }, - "messagingKey": { - "type": "string", - "description": "Messaging Key." - }, - "requestQueue": { - "type": "string", - "description": "Request queue name." - }, - "responseTopic": { - "type": "string", - "description": "Response topic name." - }, - "statusBlobSignature": { - "type": "string", - "description": "The gateway status blob SAS URL." - } - } - }, - "GatewayParameters": { - "description": "Collection of parameters for operations on a gateway resource.", - "properties": { - "location": { - "type": "string", - "description": "Location of the resource." - }, - "tags": { - "type": "object", - "description": "Resource tags." - }, - "properties": { - "description": "Collection of properties.", - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "upgradeMode": { - "type": "string", - "description": "The upgradeMode property gives the flexibility to gateway to auto upgrade itself. If properties value not specified, then we assume upgradeMode = Automatic.", - "enum": [ - "Manual", - "Automatic" - ], - "x-ms-enum": { - "name": "upgradeMode", - "modelAsString": false - } - } - } - } - } - }, - "NodeResource": { - "description": "A Node Resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Collection of properties.", - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "gatewayId": { - "type": "string", - "description": "ID of the gateway." - }, - "connectionName": { - "type": "string", - "description": "myhost.domain.com" - }, - "created": { - "type": "string", - "format": "date-time", - "description": "UTC date and time when node was first added to management service." - }, - "updated": { - "type": "string", - "format": "date-time", - "description": "UTC date and time when node was last updated." - } - } - } - } - }, - "NodeResources": { - "type": "object", - "description": "A collection of node resource objects.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeResource" - }, - "description": "Collection of Node Resources." - }, - "nextLink": { - "type": "string", - "description": "The URL to the next set of resources." - } - } - }, - "NodeParameters": { - "description": "Parameter collection for operations on arm node resource.", - "properties": { - "location": { - "type": "string", - "description": "Location of the resource." - }, - "tags": { - "type": "object", - "description": "Resource tags." - }, - "properties": { - "description": "Collection of properties.", - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "gatewayId": { - "type": "string", - "description": "Gateway ID which will manage this node." - }, - "connectionName": { - "type": "string", - "description": "myhost.domain.com" - }, - "userName": { - "type": "string", - "description": "User name to be used to connect to node." - }, - "password": { - "type": "string", - "format": "password", - "description": "Password associated with user name." - } - } - } - } - }, - "SessionResource": { - "description": "The session object.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Collection of properties.", - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "userName": { - "type": "string", - "description": "The username connecting to the session." - }, - "created": { - "type": "string", - "format": "date-time", - "description": "UTC date and time when node was first added to management service." - }, - "updated": { - "type": "string", - "format": "date-time", - "description": "UTC date and time when node was last updated." - } - } - } - } - }, - "SessionParameters": { - "description": "Parameter collection for creation and other operations on sessions.", - "properties": { - "properties": { - "description": "Collection of properties", - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "userName": { - "type": "string", - "description": "Encrypted User name to be used to connect to node." - }, - "password": { - "type": "string", - "description": "Encrypted Password associated with user name." - }, - "retentionPeriod": { - "type": "string", - "description": "Session retention period.", - "enum": [ - "Session", - "Persistent" - ], - "x-ms-enum": { - "name": "retentionPeriod", - "modelAsString": false - } - }, - "credentialDataFormat": { - "type": "string", - "description": "Credential data format.", - "enum": [ - "RsaEncrypted" - ], - "x-ms-enum": { - "name": "credentialDataFormat", - "modelAsString": false - } - }, - "EncryptionCertificateThumbprint": { - "type": "string", - "description": "Encryption certificate thumbprint." - } - } - } - } - }, - "PowerShellSessionResource": { - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "A PowerShell session resource (practically equivalent to a runspace instance).", - "properties": { - "properties": { - "description": "Collection of properties.", - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "sessionId": { - "type": "string", - "description": "The PowerShell Session ID." - }, - "state": { - "type": "string", - "description": "The runspace state." - }, - "runspaceAvailability": { - "type": "string", - "description": "The availability of the runspace." - }, - "disconnectedOn": { - "type": "string", - "format": "date-time", - "description": "Timestamp of last time the service disconnected from the runspace." - }, - "expiresOn": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the runspace expires." - }, - "version": { - "$ref": "#/definitions/Version" - }, - "name": { - "type": "string", - "description": "Name of the runspace." - } - } - } - } - }, - "PowerShellCommandStatus": { - "description": "Result status from invoking a PowerShell command.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PowerShellCommandResults" - } - } - }, - "Version": { - "description": "A multipart-numeric version number.", - "properties": { - "major": { - "type": "integer", - "description": "The leftmost number of the version." - }, - "minor": { - "type": "integer", - "description": "The second leftmost number of the version." - }, - "build": { - "type": "integer", - "description": "The third number of the version." - }, - "revision": { - "type": "integer", - "description": "The fourth number of the version." - }, - "majorRevision": { - "type": "integer", - "description": "The MSW of the fourth part." - }, - "minorRevision": { - "type": "integer", - "description": "The LSW of the fourth part." - } - } - }, - "PowerShellSessionResources": { - "description": "A collection of PowerShell session resources", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PowerShellSessionResource" - }, - "description": "Collection of PowerShell session resources." - }, - "nextLink": { - "type": "string", - "description": "The URL to the next set of resources." - } - } - }, - "PowerShellCommandParameters": { - "description": "The parameters to a PowerShell script execution command.", - "properties": { - "properties": { - "description": "Collection of properties.", - "x-ms-client-flatten": true, - "type": "object", - "properties": { - "command": { - "type": "string", - "description": "Script to execute." - } - } - } - } - }, - "PowerShellCommandResults": { - "description": "A collection of results from a PowerShell command.", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/definitions/PowerShellCommandResult" - } - }, - "pssession": { - "type": "string" - }, - "command": { - "type": "string" - }, - "completed": { - "type": "boolean" - } - } - }, - "PowerShellCommandResult": { - "description": "Results from invoking a PowerShell command.", - "properties": { - "messageType": { - "description": "The type of message.", - "type": "integer" - }, - "foregroundColor": { - "description": "The HTML color string representing the foreground color.", - "type": "string" - }, - "backgroundColor": { - "description": "The HTML color string representing the background color.", - "type": "string" - }, - "value": { - "description": "Actual result text from the PowerShell Command.", - "type": "string" - }, - "prompt": { - "description": "The interactive prompt message.", - "type": "string" - }, - "exitCode": { - "description": "The exit code from a executable that was called from PowerShell.", - "type": "integer" - }, - "id": { - "type": "integer", - "description": "ID of the prompt message." - }, - "caption": { - "type": "string", - "description": "Text that precedes the prompt." - }, - "message": { - "type": "string", - "description": "Text of the prompt." - }, - "descriptions": { - "type": "array", - "description": "Collection of PromptFieldDescription objects that contains the user input.", - "items": { - "$ref": "#/definitions/PromptFieldDescription" - } - } - } - }, - "PromptFieldDescription": { - "description": "Field description for the implementation of PSHostUserInterface.Prompt", - "properties": { - "name": { - "description": "The name of the prompt.", - "type": "string" - }, - "label": { - "description": "The label text of the prompt.", - "type": "string" - }, - "helpMessage": { - "description": "The help message of the prompt.", - "type": "string" - }, - "promptFieldTypeIsList": { - "description": "When set to 'true' the prompt field type is a list of values.", - "type": "boolean" - }, - "promptFieldType": { - "type": "string", - "enum": [ - "String", - "SecureString", - "Credential" - ], - "x-ms-enum": { - "name": "PromptFieldType", - "modelAsString": false - } - } - } - }, - "PromptMessageResponse": { - "description": "The response to a prompt message.", - "properties": { - "response": { - "description": "The list of responses a cmdlet expects.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "PowerShellTabCompletionParameters": { - "description": "Collection of parameters for PowerShell tab completion.", - "properties": { - "command": { - "type": "string", - "description": "Command to get tab completion for." - } - } - }, - "PowerShellTabCompletionResults": { - "description": "An array of strings representing the different values that can be selected through.", - "properties": { - "results": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "Error": { - "description": "Error message.", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - }, - "fields": { - "type": "string" - } - } - }, - "EncryptionJwkResource": { - "description": "The public key of the gateway.", - "type": "object", - "properties": { - "kty": { - "type": "string" - }, - "alg": { - "type": "string" - }, - "e": { - "type": "string" - }, - "n": { - "type": "string" - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API Version." - } - } -} \ No newline at end of file diff --git a/specification/servermanagement/resource-manager/readme.md b/specification/servermanagement/resource-manager/readme.md deleted file mode 100644 index e9cc5d1d2cb6..000000000000 --- a/specification/servermanagement/resource-manager/readme.md +++ /dev/null @@ -1,164 +0,0 @@ -# ServerManagement - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for ServerManagement. - - - ---- -## Getting Started -To build the SDK for ServerManagement, 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 ServerManagement API. - -``` yaml -openapi-type: arm -tag: package-2016-07-preview -``` - - -### Tag: package-2016-07-preview - -These settings apply only when `--tag=package-2016-07-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2016-07-preview' -input-file: -- Microsoft.ServerManagement/preview/2016-07-01-preview/servermanagement.json -``` - -### Tag: package-2015-07-preview - -These settings apply only when `--tag=package-2015-07-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-07-preview' -input-file: -- Microsoft.ServerManagement/preview/2015-07-01-preview/servermanagement.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-libraries-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.ServerManagement - output-folder: $(csharp-sdks-folder)/ServerManagement/Management.ServerManagement/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.servermanagement - package-name: azure-mgmt-servermanagement - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-recoveryservicesbackup/azure/mgmt/recoveryservicesbackup -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-recoveryservicesbackup -``` - - - -## Go - -These settings apply only when `--go` is specified on the command line. - -``` yaml $(go) -go: - license-header: MICROSOFT_APACHE_NO_VERSION - namespace: servermanagement - clear-output-folder: true -``` - -### Go multi-api - -``` yaml $(go) && $(multiapi) -batch: - - tag: package-2016-07-preview - - tag: package-2015-07-preview -``` - -### Tag: package-2016-07-preview and go - -These settings apply only when `--tag=package-2016-07-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2016-07-preview' && $(go) -output-folder: $(go-sdk-folder)/services/servermanagement/mgmt/2016-07-01-preview/servermanagement -``` - -### Tag: package-2015-07-preview and go - -These settings apply only when `--tag=package-2015-07-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2015-07-preview' && $(go) -output-folder: $(go-sdk-folder)/services/servermanagement/mgmt/2015-07-01-preview/servermanagement -``` - - -## 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 - fluent: true - namespace: com.microsoft.azure.management.servermanagement - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servermanagement -``` diff --git a/specification/servermanagement/resource-manager/readme.nodejs.md b/specification/servermanagement/resource-manager/readme.nodejs.md deleted file mode 100644 index d276ec0c7040..000000000000 --- a/specification/servermanagement/resource-manager/readme.nodejs.md +++ /dev/null @@ -1,15 +0,0 @@ -## Node.js - -These settings apply only when `--nodejs` is specified on the command line. -Please also specify `--node-sdks-folder=`. - -``` yaml $(nodejs) -nodejs: - azure-arm: true - package-name: azure-arm-servermanagement - package-version: 1.1.0 - output-folder: $(node-sdks-folder)/lib/services/servermanagement - generate-license-txt: true - generate-package-json: true - generate-readme-md: true -``` diff --git a/specification/service-map/resource-manager/readme.md b/specification/service-map/resource-manager/readme.md index 25934cae2210..8f967023e64a 100644 --- a/specification/service-map/resource-manager/readme.md +++ b/specification/service-map/resource-manager/readme.md @@ -93,7 +93,7 @@ These settings apply only when `--tag=package-2015-11-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-11-preview' && $(go) -output-folder: $(go-sdk-folder)/services/operationalinsights/mgmt/2015-11-01-preview/servicemap +output-folder: $(go-sdk-folder)/services/preview/operationalinsights/mgmt/2015-11-01-preview/servicemap ``` @@ -103,11 +103,32 @@ 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 - fluent: true - namespace: com.microsoft.azure.management.operationalinsights.servicemap - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-operationalinsights/servicemap +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.operationalinsights.servicemap +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-operationalinsights/servicemap ``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-11-preview +``` + +### Tag: package-2015-11-preview and java + +These settings apply only when `--tag=package-2015-11-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-11-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.servicemap.v2015_11_01_preview + output-folder: $(azure-libraries-for-java-folder)/servicemap/resource-manager/v2015_11_01_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json new file mode 100644 index 000000000000..1e039b1dca68 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": { } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json new file mode 100644 index 000000000000..18144422565d --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "subscriptionId": "SubscriptionId", + "configName": "$default", + "parameters": { + "properties": { + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-4028", + "postMigrationName": "sdk-PostMigration-5919" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-41/migrationConfigs/$default", + "name": "sdk-Namespace-41", + "type": "Microsoft.ServiceBus/Namespaces/disasterrecoveryconfigs", + "properties": { + "provisioningState": "Accepted", + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-4028", + "postMigrationName": "sdk-PostMigration-5919" + } + } + }, + "201": { } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationDelete.json new file mode 100644 index 000000000000..a393c7d0bf68 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationGet.json new file mode 100644 index 000000000000..14a7987e14e0 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-41/migrationConfigs/$default", + "name": "sdk-Namespace-41", + "type": "Microsoft.ServiceBus/Namespaces/disasterrecoveryconfigs", + "properties": { + "provisioningState": "Succeeded", + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-4028", + "postMigrationName": "sdk-PostMigration-5919", + "pendingReplicationOperationsCount": 0 + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationList.json new file mode 100644 index 000000000000..272e5577b5ce --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-9259", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9259/migrationConfigs/sdk-Namespace-9259", + "name": "sdk-Namespace-9259", + "type": "Microsoft.ServiceBus/Namespaces/migrationconfigurations", + "properties": { + "provisioningState": "Succeeded", + "targetNamespace": "/subscriptions/SubscriptionId/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-7454", + "postMigrationName": "sdk-PostMigration-9423" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationRevert.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationRevert.json new file mode 100644 index 000000000000..51c5263efe18 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Migrationconfigurations/SBMigrationconfigurationRevert.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "configName": "$default", + "subscriptionId": "SubscriptionId" + }, + "responses": { + "200": { } + } +} \ No newline at end of file diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/disasterRecoveryConfigs/SBAliasGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/disasterRecoveryConfigs/SBAliasGet.json index 15b3e7e33eb2..06556e8fdfff 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/disasterRecoveryConfigs/SBAliasGet.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/disasterRecoveryConfigs/SBAliasGet.json @@ -16,7 +16,8 @@ "provisioningState": "Accepted", "partnerNamespace": "sdk-Namespace-8860", "role": "Secondary", - "type": "MetadataReplication" + "type": "MetadataReplication", + "pendingReplicationOperationsCount": 0 } } } diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json index d7e3df5e1347..61f7333ffe5d 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json @@ -1145,6 +1145,267 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations": { + "get": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_List", + "x-ms-examples": { + "MigrationConfigurationsList": { "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationList.json" } + }, + "description": "Gets all migrationConfigurations", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of migrationConfigurations for servicebus namespace", + "schema": { + "$ref": "#/definitions/MigrationConfigListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}": { + "put": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_CreateAndStartMigration", + "x-ms-examples": { + "MigrationConfigurationsStartMigration": { "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json" } + }, + "description": "Creates Migration configuration and starts migration of enties from Standard to Premium namespace", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/configNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + }, + "description": "Parameters required to create Migration Configuration" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Migration Config successfully created", + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + } + }, + "201": { + "description": "Migration Config creation request received" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Delete", + "x-ms-examples": { + "MigrationConfigurationsDelete": { "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationDelete.json" } + }, + "description": "Deletes a MigrationConfiguration", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/configNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete Migration Config request accepted" + }, + "204": { + "description": "Not Found" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Get", + "x-ms-examples": { + "MigrationConfigurationsGet": { "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationGet.json" } + }, + "description": "Retrieves Migration Config", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/configNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Migration Config)", + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/upgrade": { + "post": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_CompleteMigration", + "x-ms-examples": { + "MigrationConfigurationsCompleteMigration": { "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json" } + }, + "description": "This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any enties created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/configNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "upgrade operation of Migration Config is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/revert": { + "post": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Revert", + "x-ms-examples": { + "MigrationConfigurationsRevert": { "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationRevert.json" } + }, + "description": "This operation reverts Migration", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/configNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "MigrationConfig Revert operation is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues": { "get": { "tags": [ @@ -1170,6 +1431,12 @@ }, { "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SkipParameter" + }, + { + "$ref": "#/parameters/TopParameter" } ], "responses": { @@ -1664,6 +1931,12 @@ }, { "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SkipParameter" + }, + { + "$ref": "#/parameters/TopParameter" } ], "responses": { @@ -2164,6 +2437,12 @@ }, { "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SkipParameter" + }, + { + "$ref": "#/parameters/TopParameter" } ], "responses": { @@ -2365,6 +2644,12 @@ }, { "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SkipParameter" + }, + { + "$ref": "#/parameters/TopParameter" } ], "responses": { @@ -3937,6 +4222,12 @@ "modelAsString": false } }, + "pendingReplicationOperationsCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of entities pending to be replicated." + }, "partnerNamespace": { "type": "string", "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairning" @@ -3986,6 +4277,62 @@ } }, "description": "The result of the List Alias(Disaster Recovery configuration) operation." + }, + "MigrationConfigProperties": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of Migration Configuration " + }, + "pendingReplicationOperationsCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of entities pending to be replicated." + }, + "targetNamespace": { + "type": "string", + "description": "Existing premium Namespace ARM Id name which has no entities, will be used for migration" + }, + "postMigrationName": { + "type": "string", + "description": "Name to access Standard Namespace after migration" + } + }, + "required": [ + "targetNamespace", + "postMigrationName" + ], + "description": "Properties required to the Create Migration Configuration" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Single item in List or Get Migration Config operation" + }, + "MigrationConfigListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MigrationConfigProperties" + }, + "description": "List of Migration Configs" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of migrationConfigurations" + } + }, + "description": "The result of the List migrationConfigurations operation." } }, "parameters": { @@ -4090,6 +4437,41 @@ "maxLength": 50, "x-ms-parameter-location": "method", "description": "The Disaster Recovery configuration name" + }, + "configNameParameter": { + "name": "configName", + "in": "path", + "description": "The configuration name. Should always be \"$default\".", + "required": true, + "type": "string", + "enum": [ + "$default" + ], + "x-ms-enum": { + "name": "MigrationConfigurationName", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "SkipParameter": { + "name": "$skip", + "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "maximum": 1000, + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000, + "x-ms-parameter-location": "method" } } } \ No newline at end of file diff --git a/specification/servicebus/resource-manager/readme.md b/specification/servicebus/resource-manager/readme.md index e7782f4af887..0c9202ae3146 100644 --- a/specification/servicebus/resource-manager/readme.md +++ b/specification/servicebus/resource-manager/readme.md @@ -67,9 +67,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_service_bus'] ``` @@ -101,6 +104,7 @@ python: payload-flattening-threshold: 2 namespace: azure.mgmt.servicebus package-name: azure-mgmt-servicebus + package-version: 0.5.0 clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' @@ -160,11 +164,46 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.servicebus +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servicebus +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-08 + - tag: package-2017-04 +``` + +### Tag: package-2015-08 and java + +These settings apply only when `--tag=package-2015-08 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-08' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.servicebus - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servicebus + namespace: com.microsoft.azure.management.servicebus.v2015_08_01 + output-folder: $(azure-libraries-for-java-folder)/servicebus/resource-manager/v2015_08_01 +regenerate-manager: true +generate-interface: true ``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.servicebus.v2017_04_01 + output-folder: $(azure-libraries-for-java-folder)/servicebus/resource-manager/v2017_04_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/servicebus/resource-manager/readme.ruby.md b/specification/servicebus/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..b3541df5a343 --- /dev/null +++ b/specification/servicebus/resource-manager/readme.ruby.md @@ -0,0 +1,37 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_service_bus +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2017-04 + - tag: package-2015-08 +``` + +### Tag: package-2017-04 and ruby + +These settings apply only when `--tag=package-2017-04 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-04' && $(ruby) +namespace: "Azure::ServiceBus::Mgmt::V2017_04_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_service_bus/lib +``` + +### Tag: package-2015-08 and ruby + +These settings apply only when `--tag=package-2015-08 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-08' && $(ruby) +namespace: "Azure::ServiceBus::Mgmt::V2015_08_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_service_bus/lib +``` diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-1.json new file mode 100644 index 000000000000..824a53cc691d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-1.json @@ -0,0 +1,13 @@ +{ + "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.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "BackupPartitionDescription": {} + }, + "responses": { + "202": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-2.json new file mode 100644 index 000000000000..4a0a56491d0b --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-2.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 Azure blob storage account.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "BackupPartitionDescription": { + "BackupStorage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + } + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-3.json new file mode 100644 index 000000000000..79260361fa1d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-3.json @@ -0,0 +1,20 @@ +{ + "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.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "BackupPartitionDescription": { + "BackupStorage": { + "StorageKind": "FileShare", + "Path": "\\\\myshare\\backupshare", + "PrimaryUserName": "mydomain\\backupaccount", + "PrimaryPassword": "abcd1234" + } + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateApplication-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateApplication-1.json new file mode 100644 index 000000000000..c71542c2be64 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateApplication-1.json @@ -0,0 +1,16 @@ +{ + "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/6.2/examples/CreateBackupPolicy-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateBackupPolicy-1.json new file mode 100644 index 000000000000..6a57d125cf07 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateBackupPolicy-1.json @@ -0,0 +1,30 @@ +{ + "operationId": "CreateBackupPolicy", + "description": "This example shows how to create a backup policy which takes backup twice everyday at 9 AM and 5 PM UTC with Azure blob store as the backup location.", + "parameters": { + "api-version": "6.2-preview", + "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" + } + } + }, + "responses": { + "201": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateBackupPolicy-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateBackupPolicy-2.json new file mode 100644 index 000000000000..6a555d1397a6 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateBackupPolicy-2.json @@ -0,0 +1,27 @@ +{ + "operationId": "CreateBackupPolicy", + "description": "This example shows how to create a backup policy which takes backup every 10 minutes with file share as the backup location.", + "parameters": { + "api-version": "6.2-preview", + "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" + } + } + }, + "responses": { + "201": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateName-1.json new file mode 100644 index 000000000000..87d2807cc3b8 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateName-1.json @@ -0,0 +1,14 @@ +{ + "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/6.2/examples/CreateService-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-1.json new file mode 100644 index 000000000000..8b8c341523c2 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/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": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-2.json new file mode 100644 index 000000000000..b8d3c24c9f78 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/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": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-3.json new file mode 100644 index 000000000000..1badea855fbb --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/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": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-4.json new file mode 100644 index 000000000000..d72ec8f3b457 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-4.json @@ -0,0 +1,44 @@ +{ + "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": "NamedParitionSchemeDescription", + "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": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DeleteBackupPolicy.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DeleteBackupPolicy.json new file mode 100644 index 000000000000..2eef49788ba9 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DeleteBackupPolicy.json @@ -0,0 +1,12 @@ +{ + "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.2-preview", + "backupPolicyName": "SampleBackupPolicy" + }, + "responses": { + "200": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisableApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisableApplicationBackup.json new file mode 100644 index 000000000000..a2a85beaa18c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisableApplicationBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "DisableApplicationBackup", + "description": "This example shows how to disable periodic backup for a stateful application which was previously enabled.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisablePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisablePartitionBackup.json new file mode 100644 index 000000000000..fd1eb6a6848d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisablePartitionBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "DisablePartitionBackup", + "description": "This example shows how to disable periodic backup for a stateful partition which was previously enabled.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisableServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisableServiceBackup.json new file mode 100644 index 000000000000..8fc7ab651d64 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisableServiceBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "DisableServiceBackup", + "description": "This example shows how to disable periodic backup for a stateful service which was previously enabled.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnableApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnableApplicationBackup.json new file mode 100644 index 000000000000..e3782a25d8a3 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnableApplicationBackup.json @@ -0,0 +1,15 @@ +{ + "operationId": "EnableApplicationBackup", + "description": "This example shows how to enable periodic backup for a stateful application.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "EnableBackupDescription": { + "BackupPolicyName": "DailyAzureBackupPolicy" + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnablePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnablePartitionBackup.json new file mode 100644 index 000000000000..6d596f0718c3 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnablePartitionBackup.json @@ -0,0 +1,15 @@ +{ + "operationId": "EnablePartitionBackup", + "description": "This example shows how to enable periodic backup for a stateful partition.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "EnableBackupDescription": { + "BackupPolicyName": "DailyAzureBackupPolicy" + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnableServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnableServiceBackup.json new file mode 100644 index 000000000000..4f5f81b3436d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnableServiceBackup.json @@ -0,0 +1,15 @@ +{ + "operationId": "EnableServiceBackup", + "description": "This example shows how to enable periodic backup for a stateful service.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "EnableBackupDescription": { + "BackupPolicyName": "DailyAzureBackupPolicy" + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetAllEntitiesBackedUpByPolicy-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetAllEntitiesBackedUpByPolicy-1.json new file mode 100644 index 000000000000..4f57cba22d2a --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetAllEntitiesBackedUpByPolicy-1.json @@ -0,0 +1,28 @@ +{ + "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.2-preview", + "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/6.2/examples/GetAllEntitiesBackedUpByPolicy-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetAllEntitiesBackedUpByPolicy-2.json new file mode 100644 index 000000000000..05d3854bdf38 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetAllEntitiesBackedUpByPolicy-2.json @@ -0,0 +1,25 @@ +{ + "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.2-preview", + "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/6.2/examples/GetApplicationBackupConfigurationInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupConfigurationInfo-1.json new file mode 100644 index 000000000000..e95dfced7ef9 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupConfigurationInfo-1.json @@ -0,0 +1,40 @@ +{ + "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.2-preview", + "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/6.2/examples/GetApplicationBackupConfigurationInfo-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupConfigurationInfo-2.json new file mode 100644 index 000000000000..24a847b140c4 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupConfigurationInfo-2.json @@ -0,0 +1,32 @@ +{ + "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.2-preview", + "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/6.2/examples/GetApplicationBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-1.json new file mode 100644 index 000000000000..08c914915123 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-1.json @@ -0,0 +1,105 @@ +{ + "operationId": "GetApplicationBackupList", + "description": "This example shows how to get list of application backups within a time range.", + "parameters": { + "api-version": "6.2-preview", + "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", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-2.json new file mode 100644 index 000000000000..ac0fe0899e27 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-2.json @@ -0,0 +1,62 @@ +{ + "operationId": "GetApplicationBackupList", + "description": "This example shows how to get the latest backup for each partition within an application.", + "parameters": { + "api-version": "6.2-preview", + "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-3.json new file mode 100644 index 000000000000..1c08ced64a00 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-3.json @@ -0,0 +1,62 @@ +{ + "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.2-preview", + "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-4.json new file mode 100644 index 000000000000..9cb6920d0c2c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-4.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. 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.2-preview", + "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationEventList.json new file mode 100644 index 000000000000..22e0cd7a01c1 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationEventList.json @@ -0,0 +1,28 @@ +{ + "operationId": "GetApplicationEventList", + "description": "This example shows how to get all application-related events during a certain time window.", + "parameters": { + "applicationId": "app1", + "api-version": "6.2-preview", + "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/6.2/examples/GetApplicationInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoByName-1.json new file mode 100644 index 000000000000..cf3db52049cc --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoByName-1.json @@ -0,0 +1,27 @@ +{ + "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": { + "headers": {}, + "body": "" + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoList-1.json new file mode 100644 index 000000000000..fdfb2ddb517d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoList-1.json @@ -0,0 +1,39 @@ +{ + "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/6.2/examples/GetApplicationInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoList-2.json new file mode 100644 index 000000000000..bdab44df784c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoList-2.json @@ -0,0 +1,30 @@ +{ + "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/6.2/examples/GetApplicationTypeInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-1.json new file mode 100644 index 000000000000..7057ba96a7e4 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-1.json @@ -0,0 +1,86 @@ +{ + "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/6.2/examples/GetApplicationTypeInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-2.json new file mode 100644 index 000000000000..ab3ffc6a26f3 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-2.json @@ -0,0 +1,50 @@ +{ + "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/6.2/examples/GetApplicationTypeInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-3.json new file mode 100644 index 000000000000..123e89fa4520 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-3.json @@ -0,0 +1,61 @@ +{ + "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/6.2/examples/GetApplicationsEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationsEventList.json new file mode 100644 index 000000000000..f33d5314cd01 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationsEventList.json @@ -0,0 +1,37 @@ +{ + "operationId": "GetApplicationsEventList", + "description": "This example shows how to get all applications-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "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/6.2/examples/GetBackupPolicyByName.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyByName.json new file mode 100644 index 000000000000..84664d44b1d7 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyByName.json @@ -0,0 +1,32 @@ +{ + "operationId": "GetBackupPolicyByName", + "description": "This example shows how to query a backup policy by name.", + "parameters": { + "api-version": "6.2-preview", + "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" + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyList-1.json new file mode 100644 index 000000000000..a560bf05943e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyList-1.json @@ -0,0 +1,54 @@ +{ + "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.2-preview", + "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" + } + }, + { + "Name": "FileShare10MinBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "FrequencyBased", + "Interval": "PT10M" + }, + "Storage": { + "StorageKind": "FileShare", + "FriendlyName": "FileShare_myshare", + "Path": "\\\\myshare\\backupshare", + "PrimaryUserName": "backupaccount", + "PrimaryPassword": "****" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyList-2.json new file mode 100644 index 000000000000..8dd15c464676 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyList-2.json @@ -0,0 +1,38 @@ +{ + "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.2-preview", + "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": "" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupsFromBackupLocation-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupsFromBackupLocation-1.json new file mode 100644 index 000000000000..b49a069ce5a7 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupsFromBackupLocation-1.json @@ -0,0 +1,72 @@ +{ + "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.2-preview", + "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupsFromBackupLocation-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupsFromBackupLocation-2.json new file mode 100644 index 000000000000..d0dafc6acb99 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupsFromBackupLocation-2.json @@ -0,0 +1,73 @@ +{ + "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.2-preview", + "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetChaosEvents.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetChaosEvents.json new file mode 100644 index 000000000000..4f0757539944 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetChaosEvents.json @@ -0,0 +1,63 @@ +{ + "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/6.2/examples/GetClusterEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetClusterEventList.json new file mode 100644 index 000000000000..1367a2991cc3 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetClusterEventList.json @@ -0,0 +1,56 @@ +{ + "operationId": "GetClusterEventList", + "description": "This example shows how to get all cluster-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ClusterUpgradeStart", + "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": "ClusterUpgradeDomainComplete", + "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": "ClusterUpgradeDomainComplete", + "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": "ClusterUpgradeComplete", + "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/6.2/examples/GetContainerLogsDeployedOnNode-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-1.json new file mode 100644 index 000000000000..7dc4ab531340 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-1.json @@ -0,0 +1,20 @@ +{ + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-2.json new file mode 100644 index 000000000000..14d00f2fbd60 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-2.json @@ -0,0 +1,21 @@ +{ + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-3.json new file mode 100644 index 000000000000..d188271fdf4f --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-3.json @@ -0,0 +1,21 @@ +{ + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetCorrelatedEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetCorrelatedEventList.json new file mode 100644 index 000000000000..30fc6a7b6b3b --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/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.2-preview" + }, + "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/6.2/examples/GetDataLossProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDataLossProgress-Running.json new file mode 100644 index 000000000000..a32244dcd235 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDataLossProgress-Running.json @@ -0,0 +1,19 @@ +{ + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDataLossProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDataLossProgress.json new file mode 100644 index 000000000000..2a5854f737cd --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDataLossProgress.json @@ -0,0 +1,26 @@ +{ + "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" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoByName-1.json new file mode 100644 index 000000000000..954cf260b781 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoByName-1.json @@ -0,0 +1,29 @@ +{ + "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": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-1.json new file mode 100644 index 000000000000..f61fdb1b0967 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-1.json @@ -0,0 +1,40 @@ +{ + "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/6.2/examples/GetDeployedApplicationInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-2.json new file mode 100644 index 000000000000..3fda665b418c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-2.json @@ -0,0 +1,30 @@ +{ + "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/6.2/examples/GetDeployedApplicationInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-3.json new file mode 100644 index 000000000000..a3b2da108c3a --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-3.json @@ -0,0 +1,50 @@ +{ + "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/6.2/examples/GetFaultOperationList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetFaultOperationList.json new file mode 100644 index 000000000000..a1833242ccec --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetFaultOperationList.json @@ -0,0 +1,53 @@ +{ + "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/6.2/examples/GetImageStoreContent.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetImageStoreContent.json new file mode 100644 index 000000000000..46e1abd19641 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetImageStoreContent.json @@ -0,0 +1,92 @@ +{ + "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/6.2/examples/GetNodeEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeEventList.json new file mode 100644 index 000000000000..5591529f395d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeEventList.json @@ -0,0 +1,33 @@ +{ + "operationId": "GetNodeEventList", + "description": "This example shows how to get all node-related events during a certain time window.", + "parameters": { + "nodeName": "node1", + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "NodeOpening", + "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/6.2/examples/GetNodeInfoList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeInfoList.json new file mode 100644 index 000000000000..b629499ae376 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeInfoList.json @@ -0,0 +1,175 @@ +{ + "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.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Name": "_Node_4", + "IpAddressOrFQDN": "localhost", + "Type": "NodeType4", + "CodeVersion": "5.6.135.9494", + "ConfigVersion": "1.0", + "NodeStatus": "Up", + "NodeUpTimeInSeconds": "526996", + "HealthState": "Ok", + "IsSeedNode": false, + "UpgradeDomain": "4", + "FaultDomain": "fd:/4", + "Id": { + "Id": "4f4e3698a196896b5efe8156cc4e1351" + }, + "InstanceId": "131353697443064929", + "NodeDeactivationInfo": { + "NodeDeactivationIntent": "Invalid", + "NodeDeactivationStatus": "None", + "NodeDeactivationTask": [], + "PendingSafetyChecks": [] + }, + "IsStopped": false, + "NodeDownTimeInSeconds": "0", + "NodeUpAt": "2018-01-10T19:10:59.812Z", + "NodeDownAt": "0001-01-01T00:00:00.000Z" + }, + { + "Name": "_Node_3", + "IpAddressOrFQDN": "localhost", + "Type": "NodeType3", + "CodeVersion": "5.6.135.9494", + "ConfigVersion": "1.0", + "NodeStatus": "Up", + "NodeUpTimeInSeconds": "526954", + "HealthState": "Ok", + "IsSeedNode": false, + "UpgradeDomain": "3", + "FaultDomain": "fd:/3", + "Id": { + "Id": "6b5c3db003a0bd126f7b8a86fc3916a4" + }, + "InstanceId": "131353697864903666", + "NodeDeactivationInfo": { + "NodeDeactivationIntent": "Invalid", + "NodeDeactivationStatus": "None", + "NodeDeactivationTask": [], + "PendingSafetyChecks": [] + }, + "IsStopped": false, + "NodeDownTimeInSeconds": "0", + "NodeUpAt": "2018-01-10T19:10:59.812Z", + "NodeDownAt": "0001-01-01T00:00:00.000Z" + }, + { + "Name": "_Node_2", + "IpAddressOrFQDN": "localhost", + "Type": "NodeType2", + "CodeVersion": "5.6.135.9494", + "ConfigVersion": "1.0", + "NodeStatus": "Disabled", + "NodeUpTimeInSeconds": "1710571", + "HealthState": "Ok", + "IsSeedNode": true, + "UpgradeDomain": "2", + "FaultDomain": "fd:/2", + "Id": { + "Id": "876a44d9185bf9416336b22e5d37cde8" + }, + "InstanceId": "131341861291227632", + "NodeDeactivationInfo": { + "NodeDeactivationIntent": "Pause", + "NodeDeactivationStatus": "Completed", + "NodeDeactivationTask": [ + { + "NodeDeactivationTaskId": { + "Id": "876a44d9185bf9416336b22e5d37cde8", + "NodeDeactivationTaskType": "Client" + }, + "NodeDeactivationIntent": "Pause" + } + ], + "PendingSafetyChecks": [] + }, + "IsStopped": false, + "NodeDownTimeInSeconds": "0", + "NodeUpAt": "2018-01-10T19:10:59.812Z", + "NodeDownAt": "0001-01-01T00:00:00.000Z" + }, + { + "Name": "_Node_1", + "IpAddressOrFQDN": "localhost", + "Type": "NodeType1", + "CodeVersion": "5.6.135.9494", + "ConfigVersion": "1.0", + "NodeStatus": "Disabling", + "NodeUpTimeInSeconds": "1710571", + "HealthState": "Ok", + "IsSeedNode": true, + "UpgradeDomain": "1", + "FaultDomain": "fd:/1", + "Id": { + "Id": "a3784be1d81710242ed0a9632647b4f7" + }, + "InstanceId": "131341861290236579", + "NodeDeactivationInfo": { + "NodeDeactivationIntent": "Pause", + "NodeDeactivationStatus": "SafetyCheckInProgress", + "NodeDeactivationTask": [ + { + "NodeDeactivationTaskId": { + "Id": "a3784be1d81710242ed0a9632647b4f7", + "NodeDeactivationTaskType": "Client" + }, + "NodeDeactivationIntent": "Pause" + } + ], + "PendingSafetyChecks": [ + { + "SafetyCheck": { + "Kind": "EnsureSeedNodeQuorum" + } + } + ] + }, + "IsStopped": false, + "NodeDownTimeInSeconds": "0", + "NodeUpAt": "2018-01-10T19:10:59.812Z", + "NodeDownAt": "0001-01-01T00:00:00.000Z" + }, + { + "Name": "_Node_0", + "IpAddressOrFQDN": "localhost", + "Type": "NodeType0", + "CodeVersion": "5.6.135.9494", + "ConfigVersion": "1.0", + "NodeStatus": "Up", + "NodeUpTimeInSeconds": "1710571", + "HealthState": "Ok", + "IsSeedNode": true, + "UpgradeDomain": "0", + "FaultDomain": "fd:/0", + "Id": { + "Id": "bf865279ba277deb864a976fbf4c200e" + }, + "InstanceId": "131341861289826291", + "NodeDeactivationInfo": { + "NodeDeactivationIntent": "Invalid", + "NodeDeactivationStatus": "None", + "NodeDeactivationTask": [], + "PendingSafetyChecks": [] + }, + "IsStopped": false, + "NodeDownTimeInSeconds": "0", + "NodeUpAt": "2018-01-10T19:10:59.812Z", + "NodeDownAt": "0001-01-01T00:00:00.000Z" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeTransitionProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeTransitionProgress-Running.json new file mode 100644 index 000000000000..901902f2ce40 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeTransitionProgress-Running.json @@ -0,0 +1,18 @@ +{ + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeTransitionProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeTransitionProgress.json new file mode 100644 index 000000000000..28a337aa3685 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeTransitionProgress.json @@ -0,0 +1,25 @@ +{ + "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" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodesEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodesEventList.json new file mode 100644 index 000000000000..11cc67a0cc66 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodesEventList.json @@ -0,0 +1,47 @@ +{ + "operationId": "GetNodesEventList", + "description": "This example shows how to get all nodes-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "NodeOpening", + "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": "NodeOpening", + "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/6.2/examples/GetPartitionBackupConfigurationInfo.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupConfigurationInfo.json new file mode 100644 index 000000000000..6784ad061fcd --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupConfigurationInfo.json @@ -0,0 +1,25 @@ +{ + "operationId": "GetPartitionBackupConfigurationInfo", + "description": "This example shows how to get backup configuration for a partition.", + "parameters": { + "api-version": "6.2-preview", + "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/6.2/examples/GetPartitionBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-1.json new file mode 100644 index 000000000000..50a5c0bedd52 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-1.json @@ -0,0 +1,63 @@ +{ + "operationId": "GetPartitionBackupList", + "description": "This example shows how to get list of partition backups within a time range.", + "parameters": { + "api-version": "6.2-preview", + "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-2.json new file mode 100644 index 000000000000..20e3c2e5fcbb --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/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.2-preview", + "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "639", + "CreationTimeUtc": "2018-01-02T08:59:53Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-3.json new file mode 100644 index 000000000000..e934056ddad7 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-3.json @@ -0,0 +1,62 @@ +{ + "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.2-preview", + "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-4.json new file mode 100644 index 000000000000..5487bb20b6cb --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/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.2-preview", + "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "639", + "CreationTimeUtc": "2018-01-02T08:59:53Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupProgress.json new file mode 100644 index 000000000000..82f5824542da --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupProgress.json @@ -0,0 +1,26 @@ +{ + "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.2-preview" + }, + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "FailureError": null + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionEventList.json new file mode 100644 index 000000000000..744cc49add28 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionEventList.json @@ -0,0 +1,38 @@ +{ + "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.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "PartitionReconfigurationCompleted", + "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/6.2/examples/GetPartitionRestartProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionRestartProgress.json new file mode 100644 index 000000000000..7cc25203d70e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionRestartProgress.json @@ -0,0 +1,26 @@ +{ + "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" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionRestoreProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionRestoreProgress.json new file mode 100644 index 000000000000..0d10b95e96ed --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionRestoreProgress.json @@ -0,0 +1,24 @@ +{ + "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.2-preview" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "RestoreState": "Success", + "TimeStampUtc": "2018-01-01T09:00:55Z", + "RestoredEpoch": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "RestoredLsn": "261", + "FailureError": null + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionsEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionsEventList.json new file mode 100644 index 000000000000..201708dd62d1 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionsEventList.json @@ -0,0 +1,57 @@ +{ + "operationId": "GetPartitionsEventList", + "description": "This example shows how to get all partitions-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "PartitionReconfigurationCompleted", + "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": "PartitionReconfigurationCompleted", + "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/6.2/examples/GetPropertyInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfo-1.json new file mode 100644 index 000000000000..74665c5ff263 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfo-1.json @@ -0,0 +1,30 @@ +{ + "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/6.2/examples/GetPropertyInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-1.json new file mode 100644 index 000000000000..de3586fa9946 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-1.json @@ -0,0 +1,43 @@ +{ + "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/6.2/examples/GetPropertyInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-2.json new file mode 100644 index 000000000000..1475549419ca --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-2.json @@ -0,0 +1,51 @@ +{ + "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/6.2/examples/GetPropertyInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-3.json new file mode 100644 index 000000000000..ed04219db38f --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-3.json @@ -0,0 +1,37 @@ +{ + "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/6.2/examples/GetQuorumLossProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetQuorumLossProgress-Running.json new file mode 100644 index 000000000000..9789fb25cd70 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetQuorumLossProgress-Running.json @@ -0,0 +1,19 @@ +{ + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetQuorumLossProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetQuorumLossProgress.json new file mode 100644 index 000000000000..9c2391300712 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetQuorumLossProgress.json @@ -0,0 +1,26 @@ +{ + "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" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetReplicaEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetReplicaEventList.json new file mode 100644 index 000000000000..b9a1f76bc1a6 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetReplicaEventList.json @@ -0,0 +1,36 @@ +{ + "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.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "StatefulReplicaHealthReportCreated", + "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/6.2/examples/GetReplicasEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetReplicasEventList.json new file mode 100644 index 000000000000..54dd7db48b5f --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetReplicasEventList.json @@ -0,0 +1,52 @@ +{ + "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.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "StatefulReplicaHealthReportCreated", + "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": "StatefulReplicaHealthReportCreated", + "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/6.2/examples/GetServiceBackupConfigurationInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupConfigurationInfo-1.json new file mode 100644 index 000000000000..438c3e22786d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupConfigurationInfo-1.json @@ -0,0 +1,41 @@ +{ + "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.2-preview", + "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/6.2/examples/GetServiceBackupConfigurationInfo-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupConfigurationInfo-2.json new file mode 100644 index 000000000000..321e25402e72 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupConfigurationInfo-2.json @@ -0,0 +1,32 @@ +{ + "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.2-preview", + "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/6.2/examples/GetServiceBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-1.json new file mode 100644 index 000000000000..d0ab2108240f --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-1.json @@ -0,0 +1,105 @@ +{ + "operationId": "GetServiceBackupList", + "description": "This example shows how to get list of service backups within a time range.", + "parameters": { + "api-version": "6.2-preview", + "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-2.json new file mode 100644 index 000000000000..3326573cc921 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-2.json @@ -0,0 +1,62 @@ +{ + "operationId": "GetServiceBackupList", + "description": "This example shows how to get the latest backup for each partition within a service.", + "parameters": { + "api-version": "6.2-preview", + "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-3.json new file mode 100644 index 000000000000..ff0fe9ea7c3e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-3.json @@ -0,0 +1,62 @@ +{ + "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.2-preview", + "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-4.json new file mode 100644 index 000000000000..28dbfc7c2fa0 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-4.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. 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.2-preview", + "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "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", + "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": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceEventList.json new file mode 100644 index 000000000000..04241407ef2c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceEventList.json @@ -0,0 +1,35 @@ +{ + "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.2-preview", + "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/6.2/examples/GetServiceTypeInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoByName-1.json new file mode 100644 index 000000000000..617b06fe7e3e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoByName-1.json @@ -0,0 +1,39 @@ +{ + "operationId": "GetServiceTypeInfoByName", + "description": "This example shows how to get information about a specific service type. A 204 response is returned if the specificed 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": { + "headers": {}, + "body": "" + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoList-1.json new file mode 100644 index 000000000000..ccc292e62e0c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/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/6.2/examples/GetServicesEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServicesEventList.json new file mode 100644 index 000000000000..7a4c570cf344 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServicesEventList.json @@ -0,0 +1,51 @@ +{ + "operationId": "GetServicesEventList", + "description": "This example shows how to get all services-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "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/6.2/examples/GetSubNameInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-1.json new file mode 100644 index 000000000000..d2aad11d56b1 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-1.json @@ -0,0 +1,22 @@ +{ + "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/6.2/examples/GetSubNameInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-2.json new file mode 100644 index 000000000000..441fa7ea5da7 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-2.json @@ -0,0 +1,28 @@ +{ + "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/6.2/examples/GetSubNameInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-3.json new file mode 100644 index 000000000000..661dbcc22deb --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-3.json @@ -0,0 +1,24 @@ +{ + "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/6.2/examples/GetUploadSessionById.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetUploadSessionById.json new file mode 100644 index 000000000000..2cee9beefa54 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetUploadSessionById.json @@ -0,0 +1,34 @@ +{ + "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/6.2/examples/GetUploadSessionByPath.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetUploadSessionByPath.json new file mode 100644 index 000000000000..5f5ad736f03e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetUploadSessionByPath.json @@ -0,0 +1,50 @@ +{ + "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/6.2/examples/InvokeContainerApi.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/InvokeContainerApi.json new file mode 100644 index 000000000000..bb4610ae2e2d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/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" + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/InvokeContainerApi_Post.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/InvokeContainerApi_Post.json new file mode 100644 index 000000000000..dfbdcf541aef --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/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" + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/PutProperty-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/PutProperty-1.json new file mode 100644 index 000000000000..511aa04cf3ed --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/PutProperty-1.json @@ -0,0 +1,19 @@ +{ + "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/6.2/examples/PutProperty-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/PutProperty-2.json new file mode 100644 index 000000000000..1d597a75d6c0 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/PutProperty-2.json @@ -0,0 +1,20 @@ +{ + "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/6.2/examples/RestorePartition.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/RestorePartition.json new file mode 100644 index 000000000000..65f0d973e19b --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/RestorePartition.json @@ -0,0 +1,21 @@ +{ + "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.2-preview", + "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": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumeApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumeApplicationBackup.json new file mode 100644 index 000000000000..3a001609f1d3 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumeApplicationBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "ResumeApplicationBackup", + "description": "This example shows how to resume periodic backup for a stateful application which was previously suspended.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumePartitionBackup.json new file mode 100644 index 000000000000..a2adf7def604 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumePartitionBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "ResumePartitionBackup", + "description": "This example shows how to resume periodic backup for a stateful partition which was previously suspended.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumeServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumeServiceBackup.json new file mode 100644 index 000000000000..2a1dde5a6c07 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumeServiceBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "ResumeServiceBackup", + "description": "This example shows how to resume periodic backup for a stateful service which was previously suspended.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SubmitPropertyBatch-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SubmitPropertyBatch-1.json new file mode 100644 index 000000000000..3b8279165b6a --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SubmitPropertyBatch-1.json @@ -0,0 +1,67 @@ +{ + "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", + "Exits": 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/6.2/examples/SuspendApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendApplicationBackup.json new file mode 100644 index 000000000000..1a50c91da730 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendApplicationBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "SuspendApplicationBackup", + "description": "This example shows how to suspend backup for a stateful application which is configured for periodic backup.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendPartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendPartitionBackup.json new file mode 100644 index 000000000000..62a9731b6936 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendPartitionBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "SuspendPartitionBackup", + "description": "This example shows how to suspend backup for a stateful partition which is configured for periodic backup.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendServiceBackup.json new file mode 100644 index 000000000000..a61d4669f67d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendServiceBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "SuspendServiceBackup", + "description": "This example shows how to suspend backup for a stateful service which is configured for periodic backup.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateBackupPolicy.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateBackupPolicy.json new file mode 100644 index 000000000000..7517350c76a6 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateBackupPolicy.json @@ -0,0 +1,31 @@ +{ + "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 with Azure blob store as the backup location.", + "parameters": { + "api-version": "6.2-preview", + "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" + } + } + }, + "responses": { + "200": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateService-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateService-1.json new file mode 100644 index 000000000000..094f2116cbaa --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/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": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateService-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateService-2.json new file mode 100644 index 000000000000..c5dca7b1cc6e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/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": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json new file mode 100644 index 000000000000..3f5849cc896e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json @@ -0,0 +1,24627 @@ +{ + "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": "6.2.0.9" + }, + "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": "Gets the health of a Service Fabric cluster.\nUse 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": "Gets the health of a Service Fabric cluster.\nUse 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, gets 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": "Get the Service Fabric standalone cluster configuration. 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": "Unprovision the code or configuration packages of a Service Fabric cluster. 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": "Rollback the upgrade of a Service Fabric cluster.", + "description": "Rollback 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" + ], + "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" + } + } + } + } + }, + "/Nodes": { + "get": { + "summary": "Gets the list of nodes in the Service Fabric cluster.", + "description": "Gets the list of nodes in the Service Fabric cluster. The response includes the name, status, id, health, uptime, and other details about the node.", + "operationId": "GetNodeInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/NodeStatusFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Node" + ], + "x-ms-examples": { + "Get information about all nodes": { + "$ref": "./examples/GetNodeInfoList.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": "Gets the information about a specific node in the Service Fabric Cluster. 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" + ], + "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 which is was 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 which 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 which is currently deactivated.", + "description": "Activates a Service Fabric cluster node which 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": "Notifies Service Fabric that the persisted state on a node has been permanently removed or lost. 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 comes back up with its state intact.", + "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" + } + } + } + } + }, + "/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 3 application types, or if max results is set to 3, then 3 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 3 application types, or if max results is set to 3, then 3 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": "Removes or unregisters a Service Fabric application type from the cluster. This operation can only be performed if all application instances of the application type has 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 specificed 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": "Deletes an existing Service Fabric application. 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 the 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 rollback 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 rollback. 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": "Gets the information about an application deployed on a Service Fabric node. 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": "Gets the manifest describing an application type. 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": "Deletes an existing Service Fabric service. 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. Please 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}/$/GetPartitions": { + "get": { + "summary": "Gets the list of partitions of a Service Fabric service.", + "description": "Gets the list of partitions of a Service Fabric service. 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-0_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": "Gets the health information of the specified partition.\nUse 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 which is currently stuck in quorum loss.", + "description": "Indicates to the Service Fabric cluster that it should attempt to recover a specific partition which 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/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 which is currently stuck in quorum loss.", + "description": "Indicates to the Service Fabric cluster that it should attempt to recover the specified service which 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 which are currently stuck in quorum loss.", + "description": "Indicates to the Service Fabric cluster that it should attempt to recover the system services which 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": "Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which 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" + } + } + } + } + }, + "/$/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 include 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 include 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." + }, + "204": { + "description": "An empty response is returned if the specified service package from the application is not deployed on the node.", + "schema": { + "$ref": "#/definitions/DeployedServicePackageInfoList" + } + }, + "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 an service package for a specific application deployed for a Service Fabric node and application.", + "description": "Gets the information about health of 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 an 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 it's status can be tracked via `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" + } + } + } + } + }, + "/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.\nPlease refer to the article [Induce controlled Chaos in Service Fabric clusters](https://docs.microsoft.com/en-us/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" + } + ], + "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": "Set the Chaos Schedule currently in use by Chaos. Chaos will automatically schedule runs based on the Chaos Schedule.\nThe version in the provided input schedule must match the version of the Chaos Schedule on the server.\nIf the version provided does not match the version on the server, the Chaos Schedule is not updated.\nIf the version provided matches the version on the server, then the Chaos Schedule is updated and the version of the Chaos Schedule on the server is incremented up by one and wraps back to 0 after 2,147,483,647.\nIf Chaos is running when this call is made, the call will fail.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$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 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 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" + } + } + } + } + }, + "/$/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\nPartialDataLoss - 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.\nFullDataLoss - 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": "Induces quorum loss for a given stateful service partition. 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 a 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 is a list of APIs that start fault operations that may be cancelled using CancelOperation -\n- StartDataLoss\n- StartQuorumLoss\n- StartPartitionRestart\n- 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/is be 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-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "201": { + "description": "A sucessful 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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A sucessful operation resturns 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-2-Preview_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-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_RequiredQueryParam" + }, + { + "$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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_RequiredQueryParam" + }, + { + "$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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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 stores custom information. This operation gets the information about these properties in a paged list. The information include 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 commited.", + "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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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-2-Preview_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" + } + } + } + } + } + }, + "definitions": { + "AadMetadata": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "ApplicationEvent", + "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" + }, + { + "type": "object", + "description": "ApplicationHealth", + "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" + }, + { + "type": "object", + "description": "ApplicationHealthEvaluation", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "ApplicationHealthState", + "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" + }, + { + "type": "object", + "description": "ApplicationHealthStateChunk", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "ApplicationHealthStateChunkList", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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/ApplicationMetricDescriptionList", + "description": "List of application capacity metric description." + } + } + }, + "ApplicationName": { + "type": "string", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ApplicationNameInfo": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "ApplicationsHealthEvaluation", + "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" + }, + { + "type": "object", + "description": "ApplicationTypeApplicationsHealthEvaluation", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "description": "Describes the parameters for an application upgrade. Please 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 results in 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)." + }, + "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": [ + "Name", + "TargetApplicationTypeVersion", + "UpgradeKind", + "Parameters" + ] + }, + "ApplicationUpgradeProgressInfo": { + "type": "object", + "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. Please 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 results in 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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "ClusterEvent" + } + ], + "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" + }, + { + "type": "object", + "description": "ClusterHealth", + "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.", + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "description": "Information about the cluster manifest.", + "properties": { + "Manifest": { + "type": "string", + "description": "The contents of the cluster manifest file." + } + } + }, + "ContainerApiRequestBody": { + "type": "object", + "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": { + "type": "object", + "description": "Response body that wraps container API result.", + "properties": { + "ContainerApiResult": { + "$ref": "#/definitions/ContainerApiResult", + "description": "Container API result." + } + }, + "required": [ + "ContainerApiResult" + ] + }, + "ContainerApiResult": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "ContainerInstanceEvent" + } + ], + "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." + }, + "CurrentUpgradeDomainProgressInfo": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "DeltaNodesCheckHealthEvaluation", + "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" + }, + { + "type": "object", + "description": "DeployedApplicationHealth", + "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" + }, + { + "type": "object", + "description": "DeployedApplicationHealthEvaluation", + "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" + }, + { + "type": "object", + "description": "DeployedApplicationHealthState", + "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" + }, + { + "type": "object", + "description": "DeployedApplicationHealthStateChunk", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "DeployedApplicationsHealthEvaluation", + "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" + }, + { + "type": "object", + "description": "DeployedServicePackageHealth", + "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" + }, + { + "type": "object", + "description": "DeployedServicePackageHealthEvaluation", + "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" + }, + { + "type": "object", + "description": "DeployedServicePackageHealthState", + "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" + }, + { + "type": "object", + "description": "DeployedServicePackageHealthStateChunk", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "DeployedServicePackagesHealthEvaluation", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "DeployedStatefulServiceReplicaInfo", + "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" + }, + { + "type": "object", + "description": "DeployedStatelessServiceInstanceInfo", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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 dataloss 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." + } + } + }, + "BackupEpoch": { + "type": "object", + "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": { + "ConfigurationNumber": { + "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." + }, + "DataLossNumber": { + "type": "string", + "description": "The current dataloss 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" + }, + { + "type": "object", + "description": "EventHealthEvaluation", + "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": { + "type": "object", + "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": { + "type": "object", + "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." + }, + "FabricError": { + "type": "object", + "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": { + "type": "object", + "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\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\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" + ] + }, + "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\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\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" + ], + "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" + } + ] + } + }, + "FabricEvent": { + "type": "object", + "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." + }, + "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", + "ApplicationHealthReportCreated", + "ApplicationHealthReportExpired", + "ApplicationUpgradeComplete", + "ApplicationUpgradeDomainComplete", + "ApplicationUpgradeRollbackComplete", + "ApplicationUpgradeRollbackStart", + "ApplicationUpgradeStart", + "DeployedApplicationHealthReportCreated", + "DeployedApplicationHealthReportExpired", + "ProcessDeactivated", + "ContainerDeactivated", + "NodeAborted", + "NodeAborting", + "NodeAdded", + "NodeClose", + "NodeClosing", + "NodeDeactivateComplete", + "NodeDeactivateStart", + "NodeDown", + "NodeHealthReportCreated", + "NodeHealthReportExpired", + "NodeOpenedSuccess", + "NodeOpenFailed", + "NodeOpening", + "NodeRemoved", + "NodeUp", + "PartitionHealthReportCreated", + "PartitionHealthReportExpired", + "PartitionReconfigurationCompleted", + "PartitionPrimaryMoveAnalysis", + "ServiceCreated", + "ServiceDeleted", + "ServiceHealthReportCreated", + "ServiceHealthReportExpired", + "DeployedServiceHealthReportCreated", + "DeployedServiceHealthReportExpired", + "StatefulReplicaHealthReportCreated", + "StatefulReplicaHealthReportExpired", + "StatelessReplicaHealthReportCreated", + "StatelessReplicaHealthReportExpired", + "ClusterHealthReportCreated", + "ClusterHealthReportExpired", + "ClusterUpgradeComplete", + "ClusterUpgradeDomainComplete", + "ClusterUpgradeRollbackComplete", + "ClusterUpgradeRollbackStart", + "ClusterUpgradeStart", + "ChaosStopped", + "ChaosStarted", + "ChaosRestartNodeFaultCompleted", + "ChaosRestartCodePackageFaultScheduled", + "ChaosRestartCodePackageFaultCompleted", + "ChaosRemoveReplicaFaultScheduled", + "ChaosRemoveReplicaFaultCompleted", + "ChaosMoveSecondaryFaultScheduled", + "ChaosMovePrimaryFaultScheduled", + "ChaosRestartReplicaFaultScheduled", + "ChaosRestartNodeFaultScheduled" + ], + "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": "ApplicationHealthReportCreated" + }, + { + "value": "ApplicationHealthReportExpired" + }, + { + "value": "ApplicationUpgradeComplete" + }, + { + "value": "ApplicationUpgradeDomainComplete" + }, + { + "value": "ApplicationUpgradeRollbackComplete" + }, + { + "value": "ApplicationUpgradeRollbackStart" + }, + { + "value": "ApplicationUpgradeStart" + }, + { + "value": "DeployedApplicationHealthReportCreated" + }, + { + "value": "DeployedApplicationHealthReportExpired" + }, + { + "value": "ProcessDeactivated" + }, + { + "value": "ContainerDeactivated" + }, + { + "value": "NodeAborted" + }, + { + "value": "NodeAborting" + }, + { + "value": "NodeAdded" + }, + { + "value": "NodeClose" + }, + { + "value": "NodeClosing" + }, + { + "value": "NodeDeactivateComplete" + }, + { + "value": "NodeDeactivateStart" + }, + { + "value": "NodeDown" + }, + { + "value": "NodeHealthReportCreated" + }, + { + "value": "NodeHealthReportExpired" + }, + { + "value": "NodeOpenedSuccess" + }, + { + "value": "NodeOpenFailed" + }, + { + "value": "NodeOpening" + }, + { + "value": "NodeRemoved" + }, + { + "value": "NodeUp" + }, + { + "value": "PartitionHealthReportCreated" + }, + { + "value": "PartitionHealthReportExpired" + }, + { + "value": "PartitionReconfigurationCompleted" + }, + { + "value": "PartitionPrimaryMoveAnalysis" + }, + { + "value": "ServiceCreated" + }, + { + "value": "ServiceDeleted" + }, + { + "value": "ServiceHealthReportCreated" + }, + { + "value": "ServiceHealthReportExpired" + }, + { + "value": "DeployedServiceHealthReportCreated" + }, + { + "value": "DeployedServiceHealthReportExpired" + }, + { + "value": "StatefulReplicaHealthReportCreated" + }, + { + "value": "StatefulReplicaHealthReportExpired" + }, + { + "value": "StatelessReplicaHealthReportCreated" + }, + { + "value": "StatelessReplicaHealthReportExpired" + }, + { + "value": "ClusterHealthReportCreated" + }, + { + "value": "ClusterHealthReportExpired" + }, + { + "value": "ClusterUpgradeComplete" + }, + { + "value": "ClusterUpgradeDomainComplete" + }, + { + "value": "ClusterUpgradeRollbackComplete" + }, + { + "value": "ClusterUpgradeRollbackStart" + }, + { + "value": "ClusterUpgradeStart" + }, + { + "value": "ChaosStopped" + }, + { + "value": "ChaosStarted" + }, + { + "value": "ChaosRestartNodeFaultCompleted" + }, + { + "value": "ChaosRestartCodePackageFaultScheduled" + }, + { + "value": "ChaosRestartCodePackageFaultCompleted" + }, + { + "value": "ChaosRemoveReplicaFaultScheduled" + }, + { + "value": "ChaosRemoveReplicaFaultCompleted" + }, + { + "value": "ChaosMoveSecondaryFaultScheduled" + }, + { + "value": "ChaosMovePrimaryFaultScheduled" + }, + { + "value": "ChaosRestartReplicaFaultScheduled" + }, + { + "value": "ChaosRestartNodeFaultScheduled" + } + ] + } + }, + "ClusterConfigurationUpgradeStatusInfo": { + "type": "object", + "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 rollback 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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "HealthEvent", + "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": { + "type": "object", + "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 which identifies the client/watchdog/system component which 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, is the reporter has issues (eg. 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." + } + } + }, + "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." + } + ] + } + }, + "Int64RangePartitionInformation": { + "description": "Describes the partition information for the integer range that is based on partition schemes.", + "allOf": [ + { + "$ref": "#/definitions/PartitionInformation" + }, + { + "type": "object", + "description": "StatelessServicePartitionInfo" + } + ], + "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." + } + } + }, + "MonitoringPolicyDescription": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "StatelessServicePartitionInfo" + } + ], + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "NodeEvent", + "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" + }, + { + "type": "object", + "description": "NodeHealth", + "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" + }, + { + "type": "object", + "description": "NodeHealthEvaluation", + "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" + }, + { + "type": "object", + "description": "NodeHealthState", + "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" + }, + { + "type": "object", + "description": "NodeHealthStateChunk", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + } + } + } + ] + }, + "NodeHealthStateChunkList": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "NodeHealthStateChunkList", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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." + }, + "NodeRemainingCapacity": { + "type": "string", + "description": "The remaining capacity on the node for this metric." + }, + "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." + } + } + }, + "NodeName": { + "type": "string", + "description": "The name of a Service Fabric node." + }, + "NodeType": { + "type": "string", + "description": "The type name of a Service Fabric node.\nPlease refer to the article [The relationship between Service Fabric node types and Virtual Machine Scale Sets](https://docs.microsoft.com/en-us/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" + }, + { + "type": "object", + "description": "NodesHealthEvaluation", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "PartitionAnalysisEvent", + "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" + }, + { + "type": "object", + "description": "PartitionEvent", + "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" + }, + { + "type": "object", + "description": "PartitionHealth", + "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" + }, + { + "type": "object", + "description": "PartitionHealthEvaluation", + "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" + }, + { + "type": "object", + "description": "PartitionHealthState", + "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" + }, + { + "type": "object", + "description": "PartitionHealthStateChunk", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "ProvisionApplicationTypeDescription", + "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" + }, + { + "type": "object", + "description": "ExternalStoreProvisionApplicationTypeDescription", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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)." + }, + "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." + } + } + }, + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "PartitionSafetyCheck", + "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" + }, + { + "type": "object", + "description": "EnsureAvailabilitySafetyCheck" + } + ], + "x-ms-discriminator-value": "EnsureAvailability" + }, + "EnsurePartitionQurumSafetyCheck": { + "description": "Safety check that ensures that a quorum of replicas are not lost for a partition.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + }, + { + "type": "object", + "description": "EnsurePartitionQurumSafetyCheck" + } + ], + "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" + }, + { + "type": "object", + "description": "SeedNodeSafetyCheck" + } + ], + "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" + }, + { + "type": "object", + "description": "PartitionsHealthEvaluation", + "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" + }, + { + "type": "object", + "description": "ReplicaEvent", + "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": { + "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.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "ReplicaHealth", + "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" + }, + { + "type": "object", + "description": "ReplicaHealthEvaluation", + "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": { + "type": "object", + "discriminator": "ServiceKind", + "required": [ + "ServiceKind" + ], + "description": "Represents a base class for stateful service replica or stateless service instance health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "ReplicaHealthState", + "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" + }, + { + "type": "object", + "description": "ReplicaHealthStateChunk", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "ReplicasHealthEvaluation", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "ServiceEvent", + "properties": { + "ServiceId": { + "$ref": "#/definitions/ServiceId", + "description": "The identity of the service. This 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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "ServiceHealthEvaluation", + "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" + }, + { + "type": "object", + "description": "ServiceHealthState", + "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" + }, + { + "type": "object", + "description": "ServiceHealthStateChunk", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "ServiceHealth", + "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 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": { + "type": "object", + "discriminator": "ServiceKind", + "description": "Information about a Service Fabric service.", + "properties": { + "Id": { + "$ref": "#/definitions/ServiceId", + "description": "The identity of the service. This 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": { + "type": "object", + "description": "Information about the service name.", + "properties": { + "Id": { + "$ref": "#/definitions/ServiceId", + "description": "The identity of the service. This 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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "ServicePlacementInvalidDomainPolicyDescription", + "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" + }, + { + "type": "object", + "description": "ServicePlacementNonPartiallyPlaceServicePolicyDescription" + } + ] + }, + "ServicePlacementPolicyDescription": { + "type": "object", + "discriminator": "Type", + "description": "Describes the policy to be used for placement of a Service Fabric service.", + "required": [ + "Type" + ], + "properties": { + "Type": { + "$ref": "#/definitions/ServicePlacementPolicyType", + "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", + "RequiredDomain", + "PreferredPrimaryDomain", + "RequiredDomainDistribution", + "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": "RequiredDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2." + }, + { + "value": "PreferredPrimaryDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3." + }, + { + "value": "RequiredDomainDistribution", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 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": "PreferredPrimaryDomain", + "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" + }, + { + "type": "object", + "description": "ServicePlacementPreferPrimaryDomainPolicyDescription", + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + } + ] + }, + "ServicePlacementRequiredDomainPolicyDescription": { + "x-ms-discriminator-value": "RequiredDomain", + "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" + }, + { + "type": "object", + "description": "ServicePlacementRequiredDomainPolicyDescription", + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + } + ] + }, + "ServicePlacementRequireDomainDistributionPolicyDescription": { + "x-ms-discriminator-value": "RequiredDomainDistribution", + "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" + }, + { + "type": "object", + "description": "ServicePlacementRequireDomainDistributionPolicyDescription", + "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" + }, + { + "type": "object", + "description": "ServicesHealthEvaluation", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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 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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "StatelessServicePartitionInfo" + } + ], + "x-ms-discriminator-value": "Singleton" + }, + "StatefulServiceInfo": { + "description": "Information about a stateful Service Fabric service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceInfo" + }, + { + "type": "object", + "description": "StatefulService", + "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" + }, + { + "type": "object", + "description": "StatefulServicePartitionInfo" + } + ], + "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." + }, + "CurrentConfigurationEpoch": { + "$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" + }, + { + "type": "object", + "description": "StatefulServiceReplicaHealth", + "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" + }, + { + "type": "object", + "description": "StatefulServiceReplicaHealthState", + "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" + }, + { + "type": "object", + "description": "StatefulServiceTypeDescription" + } + ], + "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" + }, + { + "type": "object", + "description": "StatelessService" + } + ], + "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" + }, + { + "type": "object", + "description": "StatelessServiceInstanceHealth", + "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" + }, + { + "type": "object", + "description": "StatelessServiceInstanceHealthState", + "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" + }, + { + "type": "object", + "description": "StatelessServicePartitionInfo" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "InstanceCount": { + "type": "integer", + "format": "int64", + "description": "Number of instances of this partition." + } + } + }, + "StatelessServiceTypeDescription": { + "description": "Describes a stateless service type defined in the service manifest of a provisioned application type.", + "allOf": [ + { + "$ref": "#/definitions/ServiceTypeDescription" + }, + { + "type": "object", + "description": "StatelessServiceTypeDescription" + } + ], + "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" + }, + { + "type": "object", + "description": "SystemApplicationHealthEvaluation", + "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" + }, + { + "type": "object", + "description": "UpgradeDomainDeltaNodesCheckHealthEvaluation", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "UpgradeDomainNodesHealthEvaluation", + "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" + } + ] + } + }, + "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" + }, + { + "type": "object", + "description": "WaitForInbuildReplicaSafetyCheck" + } + ], + "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" + }, + { + "type": "object", + "description": "WaitForPrimaryPlacementSafetyCheck" + } + ], + "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" + }, + { + "type": "object", + "description": "WaitForPrimarySwapSafetyCheck" + } + ], + "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" + }, + { + "type": "object", + "description": "WaitForReconfigurationSafetyCheck" + } + ], + "x-ms-discriminator-value": "WaitForReconfiguration" + }, + "LoadMetricReport": { + "type": "object", + "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." + } + } + }, + "PartitionLoadInformation": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "StatefulServiceReplicaInfo", + "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" + }, + { + "type": "object", + "description": "StatelessServiceInstanceInfo", + "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": { + "type": "object", + "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)." + }, + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "description": "Describes the parameters for a standalone cluster configuration upgrade.", + "properties": { + "ClusterConfig": { + "type": "string", + "description": "The cluster configuration." + }, + "HealthCheckRetryTimeout": { + "type": "string", + "format": "duration", + "description": "The length of time between attempts to perform a 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.", + "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 + } + }, + "required": [ + "ClusterConfig" + ] + }, + "DeltaHealthEvaluationBool": { + "type": "boolean", + "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." + }, + "FailedUpgradeDomainProgressObject": { + "type": "object", + "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": { + "type": "object", + "description": "Service state of Service Fabric Upgrade Orchestration Service.", + "properties": { + "ServiceState": { + "type": "string", + "description": "The state of Service Fabric Upgrade Orchestration Service." + } + } + }, + "UpgradeOrchestrationServiceStateSummary": { + "type": "object", + "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": { + "type": "object", + "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 to set 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": { + "type": "object", + "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": { + "type": "object", + "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" + ], + "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." + } + ] + } + }, + "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": { + "type": "object", + "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": { + "type": "object", + "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 valus 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 valus 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": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Describes a map that contains a collection of ChaosContextMapItem's." + }, + "ChaosContext": { + "type": "object", + "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": { + "type": "object", + "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 -- 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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "ExecutingFaultsChaosEvent", + "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" + }, + { + "type": "object", + "description": "StartedChaosEvent", + "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" + }, + { + "type": "object", + "description": "StoppedChaosEvent", + "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" + }, + { + "type": "object", + "description": "TestErrorChaosEvent", + "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" + }, + { + "type": "object", + "description": "ValidationFailedChaosEvent", + "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" + }, + { + "type": "object", + "description": "WaitingChaosEvent", + "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": { + "type": "object", + "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 nodetype (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 URI's 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": { + "type": "object", + "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": { + "type": "object", + "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" + } + }, + "required": [ + "Name", + "TypeName", + "TypeVersion" + ] + }, + "ApplicationMetricDescription": { + "type": "object", + "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." + }, + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + ], + "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." + } + ] + } + }, + "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": { + "type": "object", + "description": "Creates a particular correlation between services.", + "required": [ + "Scheme", + "ServiceName" + ], + "properties": { + "Scheme": { + "$ref": "#/definitions/ServiceCorrelationScheme", + "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The 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": { + "type": "object", + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive." + }, + "Weight": { + "$ref": "#/definitions/ServiceLoadMetricWeight", + "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." + }, + "PrimaryDefaultLoad": { + "type": "integer", + "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": { + "type": "object", + "discriminator": "PartitionScheme", + "description": "Describes how the service is partitioned.", + "required": [ + "PartitionScheme" + ], + "properties": { + "PartitionScheme": { + "$ref": "#/definitions/PartitionScheme", + "description": "Specifies how the service is partitioned." + } + } + }, + "NamedPartitionSchemeDescription": { + "description": "Describes the named partition scheme of the service.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "type": "object", + "description": "NamedPartitionSchemeDescription" + } + ], + "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" + }, + { + "type": "object", + "description": "SingletonPartitionSchemeDescription" + } + ], + "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" + }, + { + "type": "object", + "description": "UniformInt64RangePartitionSchemeDescription" + } + ], + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "StatefulServiceDescription" + } + ], + "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." + }, + "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." + } + } + }, + "StatelessServiceDescription": { + "description": "Describes a stateless service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceDescription" + }, + { + "type": "object", + "description": "StatelessServiceDescription" + } + ], + "x-ms-discriminator-value": "Stateless", + "required": [ + "InstanceCount" + ], + "properties": { + "InstanceCount": { + "type": "integer", + "minimum": -1, + "description": "The instance count." + } + } + }, + "ReplicatorQueueStatus": { + "type": "object", + "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": { + "type": "object", + "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", + "type": "object", + "description": "Provides statistics about the Service Fabric Replicator, when it is functioning in a Primary role.", + "allOf": [ + { + "$ref": "#/definitions/ReplicatorStatus" + }, + { + "type": "object", + "description": "Status of the primary replicator.", + "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": { + "type": "object", + "description": "Provides statistics about the Service Fabric Replicator, when it is functioning in a ActiveSecondary role.", + "allOf": [ + { + "$ref": "#/definitions/ReplicatorStatus" + }, + { + "type": "object", + "description": "Represents a base class for secondary replicator status.", + "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" + }, + { + "type": "object" + } + ] + }, + "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" + }, + { + "type": "object" + } + ] + }, + "RemoteReplicatorStatus": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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. Please note DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and replicaId.", + "x-ms-discriminator-value": "Stateful", + "allOf": [ + { + "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" + }, + { + "type": "object", + "description": "DeployedStatefulServiceReplicaDetailInfo", + "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. Please note that DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and InstanceId.", + "x-ms-discriminator-value": "Stateless", + "allOf": [ + { + "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" + }, + { + "type": "object", + "description": "DeployedStatelessServiceInstanceDetailInfo", + "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": { + "type": "object", + "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.." + }, + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "KeyValueStoreReplicaStatus", + "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": { + "type": "object", + "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." + }, + "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" + }, + { + "type": "object", + "description": "StatefulServiceUpdateDescription" + } + ], + "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." + } + } + }, + "StatelessServiceUpdateDescription": { + "description": "Describes an update for a stateless service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceUpdateDescription" + }, + { + "type": "object", + "description": "StatelessServiceUpdateDescription" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "InstanceCount": { + "type": "integer", + "minimum": -1, + "description": "The instance count." + } + } + }, + "ImageStoreRelativePath": { + "type": "string", + "description": "The remote location within image store. This path is relative to the image store root." + }, + "FileVersion": { + "type": "object", + "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." + } + } + }, + "FileInfo": { + "type": "object", + "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": { + "type": "object", + "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." + } + } + }, + "ImageStoreContent": { + "type": "object", + "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": { + "type": "object", + "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." + } + } + }, + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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." + } + }, + "required": [ + "RollingUpgradeMode" + ] + }, + "NameDescription": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "BinaryPropertyValue" + } + ], + "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" + }, + { + "type": "object", + "description": "Int64PropertyValue" + } + ], + "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" + }, + { + "type": "object", + "description": "DoublePropertyValue" + } + ], + "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" + }, + { + "type": "object", + "description": "StringPropertyValue" + } + ], + "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" + }, + { + "type": "object", + "description": "GuidPropertyValue" + } + ], + "x-ms-discriminator-value": "Guid", + "required": [ + "Data" + ], + "properties": { + "Data": { + "type": "string", + "format": "uuid", + "description": "The data of the property value." + } + } + }, + "PropertyInfo": { + "type": "object", + "discriminator": "Kind", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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 namespace/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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "CheckExistsPropertyBatchOperation" + } + ], + "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" + }, + { + "type": "object", + "description": "CheckSequencePropertyBatchOperation" + } + ], + "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" + }, + { + "type": "object", + "description": "CheckValuePropertyBatchOperation" + } + ], + "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" + }, + { + "type": "object", + "description": "DeletePropertyBatchOperation" + } + ], + "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" + }, + { + "type": "object", + "description": "GetPropertyBatchOperation" + } + ], + "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" + }, + { + "type": "object", + "description": "PutPropertyBatchOperation" + } + ], + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "SuccessfulPropertyBatchInfo" + } + ], + "x-ms-discriminator-value": "Successful", + "properties": { + "Properties": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "FailedPropertyBatchInfo" + } + ], + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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." + } + } + }, + "PagedBackupPolicyDescriptionList": { + "type": "object", + "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" + } + } + } + }, + "BackupStorageDescription": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "Application backup configuration information.", + "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" + }, + { + "type": "object", + "description": "Service backup configuration info", + "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": { + "type": "object", + "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": { + "type": "object", + "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/BackupEpoch", + "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": { + "type": "object", + "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": { + "type": "object", + "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/BackupEpoch", + "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." + }, + "FailureError": { + "$ref": "#/definitions/FabricErrorError", + "description": "Denotes the failure encountered in getting backup point information." + } + } + }, + "PagedBackupInfoList": { + "type": "object", + "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": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupStorageDescription" + }, + { + "type": "object" + }, + { + "description": "AzureBlobBackupStorageDescription" + } + ], + "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": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupStorageDescription" + }, + { + "type": "object" + }, + { + "description": "FileShareBackupStorageDescription" + } + ], + "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": { + "type": "object", + "description": "Describes the frequency based backup schedule.", + "allOf": [ + { + "$ref": "#/definitions/BackupScheduleDescription" + }, + { + "type": "object" + }, + { + "description": "FrequencyBasedBackupScheduleDescription" + } + ], + "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": { + "type": "object", + "description": "Describes the time based backup schedule.", + "allOf": [ + { + "$ref": "#/definitions/BackupScheduleDescription" + }, + { + "type": "object" + }, + { + "description": "TimeBasedBackupScheduleDescription" + } + ], + "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": { + "type": "object", + "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/BackupEpoch", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "Partition backup configuration info", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "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." + } + } + } + ], + "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": { + "type": "object", + "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": { + "type": "object", + "description": "Identifies the Service Fabric application which is being backed up.", + "allOf": [ + { + "$ref": "#/definitions/BackupEntity" + }, + { + "type": "object", + "description": "ApplicationBackupEntity", + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + } + } + ], + "x-ms-discriminator-value": "Application" + }, + "ServiceBackupEntity": { + "type": "object", + "description": "Identifies the Service Fabric stateful service which is being backed up.", + "allOf": [ + { + "$ref": "#/definitions/BackupEntity" + }, + { + "type": "object", + "description": "ServiceBackupEntity", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + } + } + } + ], + "x-ms-discriminator-value": "Service" + }, + "PartitionBackupEntity": { + "type": "object", + "description": "Identifies the Service Fabric stateful partition which is being backed up.", + "allOf": [ + { + "$ref": "#/definitions/BackupEntity" + }, + { + "type": "object", + "description": "PartitionBackupEntity", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "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." + } + } + } + ], + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object", + "description": "NodeRepairImpactDescription", + "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" + }, + { + "type": "object", + "description": "NodeRepairTargetDescription", + "properties": { + "NodeNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of nodes targeted by a repair action." + } + } + } + ] + }, + "RepairImpactDescriptionBase": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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." + } + } + }, + "ContainerLogs": { + "type": "object", + "description": "Container logs.", + "properties": { + "Content": { + "type": "string", + "description": "Container logs." + } + } + }, + "ScalingPolicyDescription": { + "type": "object", + "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": { + "type": "object", + "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": { + "type": "object", + "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" + }, + { + "type": "object" + } + ], + "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" + }, + { + "type": "object" + } + ], + "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" + }, + { + "type": "object" + } + ], + "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" + }, + { + "type": "object" + } + ], + "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." + } + } + }, + "ApplicationCreatedEvent": { + "description": "Application Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Application type version." + } + }, + "required": [ + "ApplicationTypeName", + "ApplicationTypeVersion" + ] + } + ], + "x-ms-discriminator-value": "ApplicationDeleted" + }, + "ApplicationHealthReportCreatedEvent": { + "description": "Application Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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": "ApplicationHealthReportCreated" + }, + "ApplicationHealthReportExpiredEvent": { + "description": "Application Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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" + }, + "ApplicationUpgradeCompleteEvent": { + "description": "Application Upgrade Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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": "ApplicationUpgradeComplete" + }, + "ApplicationUpgradeDomainCompleteEvent": { + "description": "Application Upgrade Domain Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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": "ApplicationUpgradeDomainComplete" + }, + "ApplicationUpgradeRollbackCompleteEvent": { + "description": "Application Upgrade Rollback Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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": "ApplicationUpgradeRollbackComplete" + }, + "ApplicationUpgradeRollbackStartEvent": { + "description": "Application Upgrade Rollback Start event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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": "ApplicationUpgradeRollbackStart" + }, + "ApplicationUpgradeStartEvent": { + "description": "Application Upgrade Start event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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": "ApplicationUpgradeStart" + }, + "DeployedApplicationHealthReportCreatedEvent": { + "description": "Deployed Application Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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": "DeployedApplicationHealthReportCreated" + }, + "DeployedApplicationHealthReportExpiredEvent": { + "description": "Deployed Application Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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" + }, + "ProcessDeactivatedEvent": { + "description": "Process Deactivated event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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": "ProcessDeactivated" + }, + "ContainerDeactivatedEvent": { + "description": "Container Deactivated event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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": "ContainerDeactivated" + }, + "NodeAbortedEvent": { + "description": "Node Aborted event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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" + }, + "NodeAbortingEvent": { + "description": "Node Aborting event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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": "NodeAborting" + }, + "NodeAddedEvent": { + "description": "Node Added event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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": "NodeAdded" + }, + "NodeCloseEvent": { + "description": "Node Close event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "NodeInstance": { + "type": "string", + "description": "Id of Node instance." + }, + "Error": { + "type": "string", + "description": "Describes error." + } + }, + "required": [ + "NodeId", + "NodeInstance", + "Error" + ] + } + ], + "x-ms-discriminator-value": "NodeClose" + }, + "NodeClosingEvent": { + "description": "Node Closing event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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": "NodeClosing" + }, + "NodeDeactivateCompleteEvent": { + "description": "Node Deactivate Complete event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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": "NodeDeactivateComplete" + }, + "NodeDeactivateStartEvent": { + "description": "Node Deactivate Start event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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": "NodeDeactivateStart" + }, + "NodeDownEvent": { + "description": "Node Down event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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" + }, + "NodeHealthReportCreatedEvent": { + "description": "Node Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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": "NodeHealthReportCreated" + }, + "NodeHealthReportExpiredEvent": { + "description": "Node Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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" + }, + "NodeOpenedSuccessEvent": { + "description": "Node Opened Success event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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": "NodeOpenedSuccess" + }, + "NodeOpenFailedEvent": { + "description": "Node Open Failed event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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" + }, + "NodeOpeningEvent": { + "description": "Node Opening event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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": "NodeOpening" + }, + "NodeRemovedEvent": { + "description": "Node Removed event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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": "NodeRemoved" + }, + "NodeUpEvent": { + "description": "Node Up event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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" + }, + "PartitionHealthReportCreatedEvent": { + "description": "Partition Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "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": "PartitionHealthReportCreated" + }, + "PartitionHealthReportExpiredEvent": { + "description": "Partition Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "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" + }, + "PartitionReconfigurationCompletedEvent": { + "description": "Partition Reconfiguration Completed event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "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": "PartitionReconfigurationCompleted" + }, + "PartitionPrimaryMoveAnalysisEvent": { + "description": "Partition Primary Move Analysis event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionAnalysisEvent" + }, + { + "type": "object", + "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" + }, + { + "type": "object", + "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" + }, + { + "type": "object", + "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" + }, + "ServiceHealthReportCreatedEvent": { + "description": "Service Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ServiceEvent" + }, + { + "type": "object", + "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": "ServiceHealthReportCreated" + }, + "ServiceHealthReportExpiredEvent": { + "description": "Service Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ServiceEvent" + }, + { + "type": "object", + "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" + }, + "DeployedServiceHealthReportCreatedEvent": { + "description": "Deployed Service Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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." + }, + "TTLTimespan": { + "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", + "TTLTimespan", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "DeployedServiceHealthReportCreated" + }, + "DeployedServiceHealthReportExpiredEvent": { + "description": "Deployed Service Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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." + }, + "TTLTimespan": { + "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", + "TTLTimespan", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "DeployedServiceHealthReportExpired" + }, + "StatefulReplicaHealthReportCreatedEvent": { + "description": "Stateful Replica Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "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": "StatefulReplicaHealthReportCreated" + }, + "StatefulReplicaHealthReportExpiredEvent": { + "description": "Stateful Replica Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "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" + }, + "StatelessReplicaHealthReportCreatedEvent": { + "description": "Stateless Replica Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "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": "StatelessReplicaHealthReportCreated" + }, + "StatelessReplicaHealthReportExpiredEvent": { + "description": "Stateless Replica Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "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" + }, + "ClusterHealthReportCreatedEvent": { + "description": "Cluster Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "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": "ClusterHealthReportCreated" + }, + "ClusterHealthReportExpiredEvent": { + "description": "Cluster Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "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" + }, + "ClusterUpgradeCompleteEvent": { + "description": "Cluster Upgrade Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "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": "ClusterUpgradeComplete" + }, + "ClusterUpgradeDomainCompleteEvent": { + "description": "Cluster Upgrade Domain Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "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": "ClusterUpgradeDomainComplete" + }, + "ClusterUpgradeRollbackCompleteEvent": { + "description": "Cluster Upgrade Rollback Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "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": "ClusterUpgradeRollbackComplete" + }, + "ClusterUpgradeRollbackStartEvent": { + "description": "Cluster Upgrade Rollback Start event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "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": "ClusterUpgradeRollbackStart" + }, + "ClusterUpgradeStartEvent": { + "description": "Cluster Upgrade Start event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "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": "ClusterUpgradeStart" + }, + "ChaosStoppedEvent": { + "description": "Chaos Stopped event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "Reason": { + "type": "string", + "description": "Describes reason." + } + }, + "required": [ + "Reason" + ] + } + ], + "x-ms-discriminator-value": "ChaosStopped" + }, + "ChaosStartedEvent": { + "description": "Chaos Started event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "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." + }, + "WaitTimeBetweenFautlsInSeconds": { + "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", + "WaitTimeBetweenFautlsInSeconds", + "MoveReplicaFaultEnabled", + "IncludedNodeTypeList", + "IncludedApplicationList", + "ClusterHealthPolicy", + "ChaosContext" + ] + } + ], + "x-ms-discriminator-value": "ChaosStarted" + }, + "ChaosRestartNodeFaultCompletedEvent": { + "description": "Chaos Restart Node Fault Completed event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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": "ChaosRestartNodeFaultCompleted" + }, + "ChaosRestartCodePackageFaultScheduledEvent": { + "description": "Chaos Restart Code Package Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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": "ChaosRestartCodePackageFaultScheduled" + }, + "ChaosRestartCodePackageFaultCompletedEvent": { + "description": "Chaos Restart Code Package Fault Completed event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "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": "ChaosRestartCodePackageFaultCompleted" + }, + "ChaosRemoveReplicaFaultScheduledEvent": { + "description": "Chaos Remove Replica Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "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": "ChaosRemoveReplicaFaultScheduled" + }, + "ChaosRemoveReplicaFaultCompletedEvent": { + "description": "Chaos Remove Replica Fault Completed event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "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": "ChaosRemoveReplicaFaultCompleted" + }, + "ChaosMoveSecondaryFaultScheduledEvent": { + "description": "Chaos Move Secondary Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "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": "ChaosMoveSecondaryFaultScheduled" + }, + "ChaosMovePrimaryFaultScheduledEvent": { + "description": "Chaos Move Primary Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "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": "ChaosMovePrimaryFaultScheduled" + }, + "ChaosRestartReplicaFaultScheduledEvent": { + "description": "Chaos Restart Replica Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "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": "ChaosRestartReplicaFaultScheduled" + }, + "ChaosRestartNodeFaultScheduledEvent": { + "description": "Chaos Restart Node Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "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": "ChaosRestartNodeFaultScheduled" + } + }, + "parameters": { + "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" + } + ] + } + }, + "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 + }, + "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 value 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 value obtained using 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 value 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) 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 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": "ReplicaHealthReportServiceKind", + "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 value 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 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 value\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 have 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. Please consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/en-us/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. Please consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/en-us/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 queries 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." + }, + "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." + }, + "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." + }, + "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 got 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 rollback 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.\n65535 - select All\n1 - select Running\n2 - select RollingBack\n8 - select Completed\n16 - select Faulted\n32 - select Cancelled\n64 - 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.\n65535 - select all\n1 - select PartitionDataLoss.\n2 - select PartitionQuorumLoss.\n4 - select PartitionRestart.\n8 - 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 which 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" + } + }, + "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- 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." + }, + "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." + }, + "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 + } + } +} diff --git a/specification/servicefabric/data-plane/readme.md b/specification/servicefabric/data-plane/readme.md index 928cfd0a4329..388eefcd36e7 100644 --- a/specification/servicefabric/data-plane/readme.md +++ b/specification/servicefabric/data-plane/readme.md @@ -5,7 +5,6 @@ This is the AutoRest configuration file for ServiceFabricClient. - --- ## Getting Started To build the SDK for ServiceFabricClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: @@ -26,9 +25,45 @@ These are the global settings for the ServiceFabricClient API. ``` yaml openapi-type: data-plane -tag: '6.1' +tag: '6.2' ``` +### Suppression + +``` yaml +directive: + - suppress: OperationIdNounVerb + reason: The operation names follow the Service Fabric Client API operation names from the existing .NET SDK. + - suppress: ListInOperationName + reason: The operation names follow the Service Fabric Client API operation names from the existing .NET SDK. + - suppress: GetInOperationName + reason: The operation names follow the Service Fabric Client API operation names from the existing .NET SDK. + - suppress: PutInOperationName + reason: The operation names follow the Service Fabric Client API operation names from the existing .NET SDK. + - suppress: HttpsSupportedScheme + reason: Service Fabric clusters are owned by the users and they can be configured to have a secure or un-secure client connection endpoint. + - suppress: LongRunningOperationsWithLongRunningExtension + reason: Service Fabric platform has already established pattern for paged responses based on ContinuationToken parameter. + - suppress: SecurityDefinitionsStructure + reason: Service Fabric clusters support various security mechanism for the REST endpoint, this includes certificate, Kerberos, AD, AAD and others. The documentation for the REST API includes information on how to authenticate to the cluster endpoint secured with different mechanisms. + - suppress: LROStatusCodesReturnTypeSchema + reason: Service Fabric platform uses query based mechanism for some of the long running operations. + - suppress: PostOperationIdContainsUrlVerb + reason: The URL scheme for Service Fabric does not follow Azure Service rules. Service Fabric supports various functions on different entities that are modeled using POST. + - suppress: APIVersionPattern + reason: The URL scheme for Service Fabric does not follow Azure Service rules. Service Fabric supports various functions on different entities that are modeled using POST. + - suppress: DefinitionsPropertiesNamesCamelCase + reason: The property names for Service Fabric follow the naming scheme of existing property names in our client SDK and concepts. + - suppress: GuidUsage + reason: The IDs of the service partition in Service Fabric are GUIDs. + - suppress: EnumInsteadOfBoolean + reason: The boolean properties are actually boolean value in the Service Fabric's application model. + - suppress: OperationsAPIImplementation + reason: Service Fabric client API is not an ARM based API and hence this rule is not applicable. + - suppress: XmsExamplesRequired + reason: There are a lot of APIs that does not have the example. While it is being worked upon disabling this to ensure that we catch and fix other violations + +``` ### Tag: 1.0.0 @@ -69,6 +104,16 @@ input-file: - Microsoft.ServiceFabric/stable/6.1/servicefabric.json ``` +### Tag: 6.2 + +These settings apply only when `--tag=6.2` is specified on the command line. + +``` yaml $(tag) == '6.2' +input-file: +- Microsoft.ServiceFabric/stable/6.2/servicefabric.json + +``` + --- # Code Generation @@ -81,7 +126,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node ``` @@ -100,7 +145,7 @@ python: payload-flattening-threshold: 2 namespace: azure.servicefabric package-name: azure-servicefabric - package-version: 6.1.2.9 + package-version: 6.2.0.0 add-credentials: true clear-output-folder: true ``` @@ -135,6 +180,7 @@ batch: - tag: "5.6" - tag: "6.0" - tag: "6.1" + - tag: "6.2" ``` ### Tag: 1.0.0 and go @@ -169,6 +215,13 @@ These settings apply only when `--tag=6.1 --go` is specified on the command line output-folder: $(go-sdk-folder)/services/servicefabric/6.1/servicefabric ``` +### Tag: 6.2 and go + +These settings apply only when `--tag=6.2 --go` is specified on the command line. + +``` yaml $(tag) == '6.2' && $(go) +output-folder: $(go-sdk-folder)/services/servicefabric/6.2/servicefabric +``` ## Java diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/application.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/application.json new file mode 100644 index 000000000000..675b9377abe5 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/application.json @@ -0,0 +1,2111 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2017-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/providers/Microsoft.ServiceFabric/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available Service Fabric resource provider API operations.", + "description": "Get the list of available Service Fabric resource provider API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resouce provider API", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}": { + "get": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Get", + "summary": "Gets a Service Fabric application type name resource.", + "description": "Get a Service Fabric application type name resource created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application type": { + "$ref": "./examples/ApplicationTypeNameGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Create", + "summary": "Creates or updates a Service Fabric application type name resource.", + "description": "Create or update a Service Fabric application type name resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type name resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application type": { + "$ref": "./examples/ApplicationTypeNamePutOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Delete", + "summary": "Deletes a Service Fabric application type name resource.", + "description": "Delete a Service Fabric application type name resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application type": { + "$ref": "./examples/ApplicationTypeNameDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes": { + "get": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_List", + "summary": "Gets the list of application type name resources created in the specified Service Fabric cluster resource.", + "description": "Gets all application type name resources created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of application type name resources": { + "$ref": "./examples/ApplicationTypeNameListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}": { + "get": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Get", + "summary": "Gets a Service Fabric application type version resource.", + "description": "Get a Service Fabric application type version resource created or in the process of being created in the Service Fabric application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application type version": { + "$ref": "./examples/ApplicationTypeVersionGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Create", + "summary": "Creates or updates a Service Fabric application type version resource.", + "description": "Create or update a Service Fabric application type version resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type version resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application type version": { + "$ref": "./examples/ApplicationTypeVersionPutOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Delete", + "summary": "Deletes a Service Fabric application type version resource.", + "description": "Delete a Service Fabric application type version resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application type version": { + "$ref": "./examples/ApplicationTypeVersionDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions": { + "get": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_List", + "summary": "Gets the list of application type version resources created in the specified Service Fabric application type name resource.", + "description": "Gets all application type version resources created or in the process of being created in the Service Fabric application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of application type version resources": { + "$ref": "./examples/ApplicationTypeVersionListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_Get", + "summary": "Gets a Service Fabric application resource.", + "description": "Get a Service Fabric application resource created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application": { + "$ref": "./examples/ApplicationGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Application" + ], + "operationId": "Applications_Create", + "summary": "Creates or updates a Service Fabric application resource.", + "description": "Create or update a Service Fabric application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application with mininum parameters": { + "$ref": "./examples/ApplicationPutOperation_example_min.json" + }, + "Put an application with maximum parameters": { + "$ref": "./examples/ApplicationPutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Applications_Update", + "summary": "Updates a Service Fabric application resource.", + "description": "Update a Service Fabric application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application resource for patch operations.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationResourceUpdate" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Patch an application": { + "$ref": "./examples/ApplicationPatchOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationResourceUpdate" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Applications_Delete", + "summary": "Deletes a Service Fabric application resource.", + "description": "Delete a Service Fabric application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application": { + "$ref": "./examples/ApplicationDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_List", + "summary": "Gets the list of application resources created in the specified Service Fabric cluster resource.", + "description": "Gets all application resources created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of application resources": { + "$ref": "./examples/ApplicationListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Services_Get", + "summary": "Gets a Service Fabric service resource.", + "description": "Get a Service Fabric service resource created or in the process of being created in the Service Fabric application resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a service": { + "$ref": "./examples/ServiceGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Service" + ], + "operationId": "Services_Create", + "summary": "Creates or updates a Service Fabric service resource.", + "description": "Create or update a Service Fabric service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The service resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a service with mininum parameters": { + "$ref": "./examples/ServicePutOperation_example_min.json" + }, + "Put a service with maximum parameters": { + "$ref": "./examples/ServicePutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Service" + ], + "operationId": "Services_Update", + "summary": "Updates a Service Fabric service resource.", + "description": "Update a Service Fabric service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The service resource for patch operations.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResourceUpdate" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Patch a service": { + "$ref": "./examples/ServicePatchOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServiceResourceUpdate" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Service" + ], + "operationId": "Services_Delete", + "summary": "Deletes a Service Fabric service resource.", + "description": "Delete a Service Fabric service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete a service": { + "$ref": "./examples/ServiceDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Services_List", + "summary": "Gets the list of service resources created in the specified Service Fabric application resource.", + "description": "Gets all service resources created or in the process of being created in the Service Fabric application resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of service resources": { + "$ref": "./examples/ServiceListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + } + }, + "definitions": { + "ApplicationHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n", + "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.\n", + "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." + } + } + }, + "ApplicationMetricDescription": { + "type": "object", + "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.\n", + "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.\n" + }, + "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.\n" + }, + "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.\n", + "type": "integer", + "format": "int64" + } + } + }, + "ApplicationMetricDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationMetricDescription" + }, + "description": "List of application capacity metric description." + }, + "ApplicationTypeName": { + "type": "string", + "description": "The application type name as defined in the application manifest." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "The version of the application type as defined in the application manifest." + }, + "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" + }, + "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" + }, + "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" + }, + "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 + }, + "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." + } + ] + } + }, + "ServiceName": { + "type": "string", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "CorrelationSchemeList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCorrelationDescription" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "ServiceCorrelationDescription": { + "type": "object", + "description": "Creates a particular correlation between services.", + "required": [ + "Scheme", + "ServiceName" + ], + "properties": { + "Scheme": { + "$ref": "#/definitions/ServiceCorrelationScheme", + "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The 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": { + "type": "object", + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive." + }, + "Weight": { + "$ref": "#/definitions/ServiceLoadMetricWeight", + "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." + }, + "PrimaryDefaultLoad": { + "type": "integer", + "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." + } + ] + } + }, + "ServicePlacementPoliciesList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "ServicePlacementPolicyDescription": { + "type": "object", + "discriminator": "Type", + "description": "Describes the policy to be used for placement of a Service Fabric service.", + "required": [ + "Type" + ], + "properties": { + "Type": { + "$ref": "#/definitions/ServicePlacementPolicyType", + "description": "The type of placement policy for a service fabric service. Following are the possible values." + } + } + }, + "ServicePlacementPolicyType": { + "type": "string", + "description": "The type of placement policy for a service fabric service. Following are the possible values.", + "enum": [ + "Invalid", + "InvalidDomain", + "RequiredDomain", + "PreferredPrimaryDomain", + "RequiredDomainDistribution", + "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": "RequiredDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2." + }, + { + "value": "PreferredPrimaryDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3." + }, + { + "value": "RequiredDomainDistribution", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 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." + } + ] + } + }, + "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" + } + ] + } + }, + "PartitionSchemeDescription": { + "type": "object", + "discriminator": "PartitionScheme", + "description": "Describes how the service is partitioned.", + "required": [ + "PartitionScheme" + ], + "properties": { + "PartitionScheme": { + "$ref": "#/definitions/PartitionScheme", + "description": "Specifies how the service is partitioned." + } + } + }, + "NamedPartitionSchemeDescription": { + "description": "Describes the named partition scheme of the service.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "type": "object", + "description": "NamedPartitionSchemeDescription" + } + ], + "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" + }, + { + "type": "object", + "description": "SingletonPartitionSchemeDescription" + } + ], + "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" + }, + { + "type": "object", + "description": "UniformInt64RangePartitionSchemeDescription" + } + ], + "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 partition ‘Count’\n" + }, + "HighKey": { + "type": "string", + "description": "String indicating the upper bound of the partition key range that\nshould be split between the partition ‘Count’\n" + } + } + }, + "MoveCost": { + "type": "string", + "description": "Specifies the move cost for the service.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "MoveCost", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Zero move cost. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the move cost of the service as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the move cost of the service as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the move cost of the service as High. The value is 3." + } + ] + } + }, + "ApplicationParameterList": { + "type": "object", + "description": "List of application parameters with overridden values from their default values specified in the application manifest.", + "additionalProperties": { + "type": "string" + } + }, + "ApplicationResource": { + "description": "The application resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationResourceProperties", + "description": "The application resource properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationResourceList": { + "description": "The list of application resources.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationResource" + } + } + } + }, + "ApplicationResourceProperties": { + "description": "The application resource properties.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationResourceUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "typeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + } + } + }, + "ApplicationResourceUpdate": { + "description": "The application resource for patch operations.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationResourceUpdateProperties", + "description": "The application resource properties for patch operations." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationResourceUpdateProperties": { + "description": "The application resource properties for patch operations.", + "properties": { + "typeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "parameters": { + "$ref": "#/definitions/ApplicationParameterList", + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "upgradePolicy": { + "$ref": "#/definitions/ApplicationUpgradePolicy", + "description": "Describes the policy for a monitored application upgrade." + }, + "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 + }, + "removeApplicationCapacity": { + "type": "boolean", + "description": "Remove the current application capacity settings." + }, + "metrics": { + "$ref": "#/definitions/ApplicationMetricDescriptionList", + "description": "List of application capacity metric description." + } + } + }, + "ApplicationTypeParameterList": { + "type": "object", + "description": "List of application type parameters that can be overridden when creating or updating the application.", + "additionalProperties": { + "type": "string" + } + }, + "ApplicationTypeResourceProperties": { + "description": "The application type name properties", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + } + } + }, + "ApplicationTypeResource": { + "description": "The application type name resource", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationTypeResourceProperties", + "description": "The application type name properties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationTypeResourceList": { + "description": "The list of application type names.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeResource" + } + } + } + }, + "ApplicationTypeVersionResource": { + "description": "An application type version resource for the specified application type name resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationTypeVersionResourceProperties", + "description": "The properties of the application type version resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationTypeVersionResourceList": { + "description": "The list of application type version resources for the specified application type name resource.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + } + } + }, + "ApplicationTypeVersionResourceProperties": { + "description": "The properties of the application type version resource.", + "required": [ + "appPackageUrl" + ], + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "appPackageUrl": { + "type": "string", + "description": "The URL to the application package" + }, + "defaultParameterList": { + "readOnly": true, + "$ref": "#/definitions/ApplicationTypeParameterList", + "description": "List of application type parameters that can be overridden when creating or updating the application." + } + } + }, + "ApplicationUpgradePolicy": { + "description": "Describes the policy for a monitored application upgrade.", + "properties": { + "upgradeReplicaSetCheckTimeout": { + "$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)." + }, + "rollingUpgradeMonitoringPolicy": { + "$ref": "#/definitions/RollingUpgradeMonitoringPolicy", + "description": "The policy used for monitoring the application upgrade" + }, + "applicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n" + } + } + }, + "AvailableOperationDisplay": { + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by Service Fabric resource provider" + }, + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "description": "List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Service Fabric operations." + }, + "OperationResult": { + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "ProxyResource": { + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Azure resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "description": "The resource model definition for proxy-only resource.", + "x-ms-azure-resource": true + }, + "RollingUpgradeMonitoringPolicy": { + "description": "The policy used for monitoring the application upgrade", + "properties": { + "healthCheckWaitDuration": { + "$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." + }, + "healthCheckStableDuration": { + "$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." + }, + "healthCheckRetryTimeout": { + "$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." + }, + "upgradeTimeout": { + "$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." + }, + "upgradeDomainTimeout": { + "$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." + } + } + }, + "ServiceResource": { + "description": "The service resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceResourceProperties", + "description": "The service resource properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ServiceResourceList": { + "description": "The list of service resources.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResource" + } + } + } + }, + "ServiceResourceProperties": { + "description": "The service resource properties.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourcePropertiesBase" + } + ], + "required": [ + "serviceKind" + ], + "discriminator": "serviceKind", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "serviceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "serviceTypeName": { + "type": "string", + "description": "The name of the service type" + }, + "partitionDescription": { + "$ref": "#/definitions/PartitionSchemeDescription", + "description": "Describes how the service is partitioned." + } + } + }, + "ServiceResourcePropertiesBase": { + "description": "The common service resource properties.", + "properties": { + "placementConstraints": { + "type": "string", + "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." + }, + "correlationScheme": { + "$ref": "#/definitions/CorrelationSchemeList", + "description": "A list that describes the correlation of the service with other services." + }, + "serviceLoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList", + "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." + }, + "servicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPoliciesList", + "description": "A list that describes the correlation of the service with other services." + }, + "defaultMoveCost": { + "$ref": "#/definitions/MoveCost", + "description": "Specifies the move cost for the service." + } + } + }, + "ServiceResourceUpdate": { + "description": "The service resource for patch operations.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceResourceUpdateProperties", + "description": "The service resource properties for patch operations." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ServiceResourceUpdateProperties": { + "description": "The service resource properties for patch operations.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourcePropertiesBase" + } + ], + "required": [ + "serviceKind" + ], + "discriminator": "serviceKind", + "properties": { + "serviceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + } + } + }, + "StatefulServiceProperties": { + "description": "The properties of a stateful service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "hasPersistedState": { + "type": "boolean", + "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." + }, + "targetReplicaSetSize": { + "type": "integer", + "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." + }, + "replicaRestartWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "quorumLossWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "standByReplicaKeepDuration": { + "type": "string", + "format": "date-time", + "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s)." + } + } + }, + "StatefulServiceUpdateProperties": { + "description": "The properties of a stateful service resource for patch operations.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceUpdateProperties" + } + ], + "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." + }, + "replicaRestartWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "quorumLossWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "standByReplicaKeepDuration": { + "type": "string", + "format": "date-time", + "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s)." + } + } + }, + "StatelessServiceProperties": { + "description": "The properties of a stateless service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "instanceCount": { + "type": "integer", + "minimum": -1, + "description": "The instance count." + } + } + }, + "StatelessServiceUpdateProperties": { + "description": "The properties of a stateless service resource for patch operations.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceUpdateProperties" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "instanceCount": { + "type": "integer", + "minimum": -1, + "description": "The instance count." + } + } + }, + "ErrorModel": { + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n", + "properties": { + "maxPercentUnhealthyServices": { + "type": "integer", + "description": "The maximum percentage of services allowed to be unhealthy before your application is considered in error.\n", + "default": 0, + "minimum": 0, + "maximum": 100 + } + } + }, + "ServiceTypeHealthPolicyMap": { + "type": "object", + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2017-07-01-preview\" for this specification.", + "required": true, + "type": "string", + "enum": [ + "2017-07-01-preview" + ], + "default": "2017-07-01-preview", + "x-ms-parameter-location": "client" + }, + "applicationName": { + "name": "applicationName", + "in": "path", + "description": "The name of the application resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "applicationTypeName": { + "name": "applicationTypeName", + "in": "path", + "description": "The name of the application type name resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "serviceName": { + "name": "serviceName", + "in": "path", + "description": "The name of the service resource in the format of {applicationName}~{serviceName}.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "version": { + "name": "version", + "in": "path", + "description": "The application type version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterGetOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterGetOperation_example.json index dd49a75cd0ad..e5dc282baa16 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterGetOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterGetOperation_example.json @@ -21,7 +21,7 @@ "clusterCodeVersion": "6.0.219.9494", "clusterState": "WaitingForNodes", "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", "certificate": { "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", @@ -116,9 +116,9 @@ ], "vmImage": "Windows", "azureActiveDirectory": { - "tenantId": "some_random_guid", - "clusterApplication": "some_random_guid", - "clientApplication": "some_random_guid" + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" }, "reliabilityLevel": "Silver", "reverseProxyCertificate": { diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListByResourceGroupOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListByResourceGroupOperation_example.json index 09d64bf431fc..b6b171f5684e 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListByResourceGroupOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListByResourceGroupOperation_example.json @@ -22,7 +22,7 @@ "clusterCodeVersion": "6.0.219.9494", "clusterState": "WaitingForNodes", "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", "certificate": { "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", @@ -117,9 +117,9 @@ ], "vmImage": "Windows", "azureActiveDirectory": { - "tenantId": "some_random_guid", - "clusterApplication": "some_random_guid", - "clientApplication": "some_random_guid" + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" }, "reliabilityLevel": "Silver", "reverseProxyCertificate": { @@ -154,7 +154,7 @@ "clusterCodeVersion": "6.0.127.1", "clusterState": "WaitingForNodes", "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", "clientCertificateThumbprints": [], "clientCertificateCommonNames": [], "fabricSettings": [ diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListOperation_example.json index aaa7944b398a..a803d503efdf 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListOperation_example.json @@ -21,7 +21,7 @@ "clusterCodeVersion": "6.0.219.9494", "clusterState": "WaitingForNodes", "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", "certificate": { "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", @@ -116,9 +116,9 @@ ], "vmImage": "Windows", "azureActiveDirectory": { - "tenantId": "some_random_guid", - "clusterApplication": "some_random_guid", - "clientApplication": "some_random_guid" + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" }, "reliabilityLevel": "Silver", "reverseProxyCertificate": { @@ -153,7 +153,7 @@ "clusterCodeVersion": "6.0.127.1", "clusterState": "WaitingForNodes", "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", "clientCertificateThumbprints": [], "clientCertificateCommonNames": [], "fabricSettings": [ diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPatchOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPatchOperation_example.json index dcb29a6f8ce2..0a1821d80ad6 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPatchOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPatchOperation_example.json @@ -75,7 +75,7 @@ "clusterCodeVersion": "6.0.219.9494", "clusterState": "WaitingForNodes", "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", "clientCertificateThumbprints": [], "clientCertificateCommonNames": [], "fabricSettings": [ diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_max.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_max.json index 17888d74c255..0c6b0ad396e0 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_max.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_max.json @@ -108,9 +108,9 @@ ], "vmImage": "Windows", "azureActiveDirectory": { - "tenantId": "some_random_guid", - "clusterApplication": "some_random_guid", - "clientApplication": "some_random_guid" + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" }, "reliabilityLevel": "Silver", "reverseProxyCertificate": { @@ -145,7 +145,7 @@ "clusterCodeVersion": "6.0.219.9494", "clusterState": "WaitingForNodes", "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", "certificate": { "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", @@ -240,9 +240,9 @@ ], "vmImage": "Windows", "azureActiveDirectory": { - "tenantId": "some_random_guid", - "clusterApplication": "some_random_guid", - "clientApplication": "some_random_guid" + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" }, "reliabilityLevel": "Silver", "reverseProxyCertificate": { diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_min.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_min.json index a4965423b142..237b0db961bd 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_min.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_min.json @@ -50,8 +50,7 @@ } ], "reliabilityLevel": "Silver", - "upgradeMode": "Automatic", - "addonFeatures": [] + "upgradeMode": "Automatic" } } }, @@ -71,7 +70,7 @@ "clusterCodeVersion": "6.0.219.9494", "clusterState": "WaitingForNodes", "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", "clientCertificateThumbprints": [], "clientCertificateCommonNames": [], "fabricSettings": [ @@ -137,8 +136,7 @@ "supportExpiryUtc": "9999-12-31T23:59:59.9999999", "environment": "Windows" } - ], - "addonFeatures": [] + ] } } } diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/cluster.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/cluster.json new file mode 100644 index 000000000000..895caeb33e40 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/cluster.json @@ -0,0 +1,1521 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2018-02-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}": { + "get": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_Get", + "summary": "Gets a Service Fabric cluster resource.", + "description": "Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Get a cluster": { + "$ref": "./examples/ClusterGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_Create", + "summary": "Creates or updates a Service Fabric cluster resource.", + "description": "Create or update a Service Fabric cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "The cluster resource.", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a cluster with mininum parameters": { + "$ref": "./examples/ClusterPutOperation_example_min.json" + }, + "Put a cluster with maximum parameters": { + "$ref": "./examples/ClusterPutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_Update", + "summary": "Updates the configuration of a Service Fabric cluster resource.", + "description": "Update the configuration of a Service Fabric cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters which contains the property value and property name which used to update the cluster configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdateParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Patch a cluster": { + "$ref": "./examples/ClusterPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_Delete", + "summary": "Deletes a Service Fabric cluster resource.", + "description": "Delete a Service Fabric cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Delete a cluster": { + "$ref": "./examples/ClusterDeleteOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters": { + "get": { + "operationId": "Clusters_ListByResourceGroup", + "summary": "Gets the list of Service Fabric cluster resources created in the specified resource group.", + "description": "Gets all Service Fabric cluster resources created or in the process of being created in the resource group.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "Cluster" + ], + "x-ms-examples": { + "List cluster by resource group": { + "$ref": "./examples/ClusterListByResourceGroupOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/clusters": { + "get": { + "operationId": "Clusters_List", + "summary": "Gets the list of Service Fabric cluster resources created in the specified subscription.", + "description": "Gets all Service Fabric cluster resources created or in the process of being created in the subscription.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "Cluster" + ], + "x-ms-examples": { + "List clusters": { + "$ref": "./examples/ClusterListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions/{clusterVersion}": { + "get": { + "operationId": "ClusterVersions_Get", + "summary": "Gets information about a Service Fabric cluster code version available in the specified location.", + "description": "Gets information about an available Service Fabric cluster code version.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterVersion" + } + ], + "x-ms-examples": { + "Get cluster version": { + "$ref": "./examples/ClusterVersionsGet_example.json" + } + }, + "tags": [ + "ClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterCodeVersionsListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions/{clusterVersion}": { + "get": { + "operationId": "ClusterVersions_GetByEnvironment", + "summary": "Gets information about a Service Fabric cluster code version available for the specified environment.", + "description": "Gets information about an available Service Fabric cluster code version by environment.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/environment" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterVersion" + } + ], + "x-ms-examples": { + "Get cluster version by environment": { + "$ref": "./examples/ClusterVersionsGetByEnvironment_example.json" + } + }, + "tags": [ + "ClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterCodeVersionsListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions": { + "get": { + "operationId": "ClusterVersions_List", + "summary": "Gets the list of Service Fabric cluster code versions available for the specified location.", + "description": "Gets all available code versions for Service Fabric cluster resources by location.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List cluster versions": { + "$ref": "./examples/ClusterVersionsList_example.json" + } + }, + "tags": [ + "ClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterCodeVersionsListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions": { + "get": { + "operationId": "ClusterVersions_ListByEnvironment", + "summary": "Gets the list of Service Fabric cluster code versions available for the specified environment.", + "description": "Gets all available code versions for Service Fabric cluster resources by environment.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/environment" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List cluster versions by environment": { + "$ref": "./examples/ClusterVersionsListByEnvironment.json" + } + }, + "tags": [ + "ClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterCodeVersionsListResult" + } + } + } + } + }, + "/providers/Microsoft.ServiceFabric/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available Service Fabric resource provider API operations.", + "description": "Get the list of available Service Fabric resource provider API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resouce provider API", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AddOnFeatures": { + "type": "string", + "description": "Available cluster add-on features", + "enum": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + }, + "ApplicationDeltaHealthPolicy": { + "type": "object", + "description": "Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster.\n", + "properties": { + "defaultServiceTypeDeltaHealthPolicy": { + "$ref": "#/definitions/ServiceTypeDeltaHealthPolicy", + "description": "The delta health policy used by default to evaluate the health of a service type when upgrading the cluster." + }, + "serviceTypeDeltaHealthPolicies": { + "$ref": "#/definitions/ServiceTypeDeltaHealthPolicyMap", + "description": "The map with service type delta health policy per service type name. The map is empty by default." + } + } + }, + "ApplicationDeltaHealthPolicyMap": { + "type": "object", + "description": "Defines a map that contains specific application delta health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationDeltaHealthPolicy used to evaluate the application health when upgrading the cluster.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n", + "additionalProperties": { + "$ref": "#/definitions/ApplicationDeltaHealthPolicy" + } + }, + "ApplicationHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n", + "properties": { + "defaultServiceTypeHealthPolicy": { + "$ref": "#/definitions/ServiceTypeHealthPolicy", + "description": "The health policy used by default to evaluate the health of a service type." + }, + "serviceTypeHealthPolicies": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMap", + "description": "The map with service type health policy per service type name. The map is empty by default." + } + } + }, + "ApplicationHealthPolicyMap": { + "type": "object", + "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.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n", + "additionalProperties": { + "$ref": "#/definitions/ApplicationHealthPolicy" + } + }, + "AvailableOperationDisplay": { + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by Service Fabric resource provider" + }, + "AzureActiveDirectory": { + "properties": { + "tenantId": { + "type": "string", + "description": "Azure active directory tenant id." + }, + "clusterApplication": { + "type": "string", + "description": "Azure active directory cluster application id." + }, + "clientApplication": { + "type": "string", + "description": "Azure active directory client application id." + } + }, + "description": "The settings to enable AAD authentication on the cluster." + }, + "CertificateDescription": { + "required": [ + "thumbprint" + ], + "properties": { + "thumbprint": { + "type": "string", + "description": "Thumbprint of the primary certificate." + }, + "thumbprintSecondary": { + "type": "string", + "description": "Thumbprint of the secondary certificate." + }, + "x509StoreName": { + "$ref": "#/definitions/StoreName", + "description": "The local certificate store location." + } + }, + "description": "Describes the certificate details." + }, + "ClientCertificateCommonName": { + "required": [ + "certificateCommonName", + "isAdmin", + "certificateIssuerThumbprint" + ], + "properties": { + "isAdmin": { + "type": "boolean", + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "certificateCommonName": { + "type": "string", + "description": "The common name of the client certificate." + }, + "certificateIssuerThumbprint": { + "type": "string", + "description": "The issuer thumbprint of the client certificate." + } + }, + "description": "Describes the client certificate details using common name." + }, + "ClientCertificateThumbprint": { + "required": [ + "certificateThumbprint", + "isAdmin" + ], + "properties": { + "isAdmin": { + "type": "boolean", + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "certificateThumbprint": { + "type": "string", + "description": "The thumbprint of the client certificate." + } + }, + "description": "Describes the client certificate details using thumbprint." + }, + "Cluster": { + "type": "object", + "description": "The cluster resource\n", + "allOf": [ + { + "description": "The cluster resource properties" + }, + { + "$ref": "#/definitions/Resource" + }, + { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterProperties", + "description": "The cluster resource properties" + } + } + } + ] + }, + "ClusterCodeVersionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ClusterCodeVersionsResult" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "The list results of the ServiceFabric runtime versions." + }, + "ClusterCodeVersionsResult": { + "properties": { + "id": { + "type": "string", + "description": "The identification of the result" + }, + "name": { + "type": "string", + "description": "The name of the result" + }, + "type": { + "type": "string", + "description": "The result resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterVersionDetails", + "description": "The detail of the Service Fabric runtime version result" + } + }, + "description": "The result of the ServiceFabric runtime versions" + }, + "ClusterEnvironment": { + "type": "string", + "description": "Cluster operating system, the default will be Windows", + "enum": [ + "Windows", + "Linux" + ] + }, + "ClusterHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.\n", + "properties": { + "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.\n", + "default": 0, + "minimum": 0, + "maximum": 100 + }, + "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.\n", + "default": 0, + "minimum": 0, + "maximum": 100 + }, + "applicationHealthPolicies": { + "$ref": "#/definitions/ApplicationHealthPolicyMap", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." + } + } + }, + "ClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Cluster list results" + }, + "ClusterProperties": { + "required": [ + "managementEndpoint", + "nodeTypes" + ], + "properties": { + "addOnFeatures": { + "type": "array", + "description": "The list of add-on features to enable in the cluster.", + "items": { + "$ref": "#/definitions/AddOnFeatures" + } + }, + "availableClusterVersions": { + "type": "array", + "description": "The Service Fabric runtime versions available for this cluster.", + "readOnly": true, + "items": { + "$ref": "#/definitions/ClusterVersionDetails" + } + }, + "azureActiveDirectory": { + "$ref": "#/definitions/AzureActiveDirectory", + "description": "The AAD authentication settings of the cluster." + }, + "certificate": { + "$ref": "#/definitions/CertificateDescription", + "description": "The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client." + }, + "certificateCommonNames": { + "$ref": "#/definitions/ServerCertificateCommonNames", + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "clientCertificateCommonNames": { + "type": "array", + "description": "The list of client certificates referenced by common name that are allowed to manage the cluster.", + "items": { + "$ref": "#/definitions/ClientCertificateCommonName" + } + }, + "clientCertificateThumbprints": { + "type": "array", + "description": "The list of client certificates referenced by thumbprint that are allowed to manage the cluster.", + "items": { + "$ref": "#/definitions/ClientCertificateThumbprint" + } + }, + "clusterCodeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**." + }, + "clusterEndpoint": { + "type": "string", + "description": "The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint.", + "readOnly": true + }, + "clusterId": { + "type": "string", + "description": "A service generated unique identifier for the cluster resource.", + "readOnly": true + }, + "clusterState": { + "readOnly": true, + "$ref": "#/definitions/ClusterState", + "description": "The current state of the cluster.\n\n - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it.\n - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up.\n - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time.\n - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration.\n - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate.\n - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'.\n - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version.\n - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider.\n - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted.\n - Ready - Indicates that the cluster is in a stable state.\n" + }, + "diagnosticsStorageAccountConfig": { + "$ref": "#/definitions/DiagnosticsStorageAccountConfig", + "description": "The storage account information for storing Service Fabric diagnostic logs." + }, + "fabricSettings": { + "type": "array", + "description": "The list of custom fabric settings to configure the cluster.", + "items": { + "$ref": "#/definitions/SettingsSectionDescription" + } + }, + "managementEndpoint": { + "type": "string", + "description": "The http management endpoint of the cluster." + }, + "nodeTypes": { + "type": "array", + "description": "The list of node types in the cluster.", + "items": { + "$ref": "#/definitions/NodeTypeDescription" + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the cluster resource.", + "readOnly": true, + "enum": [ + "Updating", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "reliabilityLevel": { + "$ref": "#/definitions/ReliabilityLevel", + "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n" + }, + "reverseProxyCertificate": { + "$ref": "#/definitions/CertificateDescription", + "description": "The server certificate used by reverse proxy." + }, + "reverseProxyCertificateCommonNames": { + "$ref": "#/definitions/ServerCertificateCommonNames", + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "upgradeDescription": { + "$ref": "#/definitions/ClusterUpgradePolicy", + "description": "The policy to use when upgrading the cluster." + }, + "upgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.\n" + }, + "vmImage": { + "type": "string", + "description": "The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used." + } + }, + "description": "Describes the cluster resource properties." + }, + "ClusterPropertiesUpdateParameters": { + "properties": { + "addOnFeatures": { + "type": "array", + "description": "The list of add-on features to enable in the cluster.", + "items": { + "$ref": "#/definitions/AddOnFeatures" + } + }, + "certificate": { + "$ref": "#/definitions/CertificateDescription", + "description": "The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client." + }, + "certificateCommonNames": { + "$ref": "#/definitions/ServerCertificateCommonNames", + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "clientCertificateCommonNames": { + "type": "array", + "description": "The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list.", + "items": { + "$ref": "#/definitions/ClientCertificateCommonName" + } + }, + "clientCertificateThumbprints": { + "type": "array", + "description": "The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list.", + "items": { + "$ref": "#/definitions/ClientCertificateThumbprint" + } + }, + "clusterCodeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**." + }, + "fabricSettings": { + "type": "array", + "description": "The list of custom fabric settings to configure the cluster. This will overwrite the existing list.", + "items": { + "$ref": "#/definitions/SettingsSectionDescription" + } + }, + "nodeTypes": { + "type": "array", + "description": "The list of node types in the cluster. This will overwrite the existing list.", + "items": { + "$ref": "#/definitions/NodeTypeDescription" + } + }, + "reliabilityLevel": { + "$ref": "#/definitions/ReliabilityLevel", + "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n" + }, + "reverseProxyCertificate": { + "$ref": "#/definitions/CertificateDescription", + "description": "The server certificate used by reverse proxy." + }, + "upgradeDescription": { + "$ref": "#/definitions/ClusterUpgradePolicy", + "description": "The policy to use when upgrading the cluster." + }, + "upgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.\n" + } + }, + "description": "Describes the cluster resource properties that can be updated during PATCH operation." + }, + "ClusterState": { + "type": "string", + "description": "The current state of the cluster.\n\n - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it.\n - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up.\n - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time.\n - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration.\n - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate.\n - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'.\n - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version.\n - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider.\n - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted.\n - Ready - Indicates that the cluster is in a stable state.\n", + "enum": [ + "WaitingForNodes", + "Deploying", + "BaselineUpgrade", + "UpdatingUserConfiguration", + "UpdatingUserCertificate", + "UpdatingInfrastructure", + "EnforcingClusterVersion", + "UpgradeServiceUnreachable", + "AutoScale", + "Ready" + ] + }, + "ClusterUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterPropertiesUpdateParameters", + "description": "Describes the cluster resource properties that can be updated during PATCH operation." + }, + "tags": { + "type": "object", + "description": "Cluster update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Cluster update request" + }, + "ClusterUpgradeDeltaHealthPolicy": { + "description": "Describes the delta health policies for the cluster upgrade.", + "required": [ + "maxPercentDeltaUnhealthyApplications", + "maxPercentDeltaUnhealthyNodes", + "maxPercentUpgradeDomainDeltaUnhealthyNodes" + ], + "properties": { + "maxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades.\nThe 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.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n", + "minimum": 0, + "maximum": 100 + }, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades.\nThe 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.\nThe 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.\n", + "minimum": 0, + "maximum": 100 + }, + "maxPercentDeltaUnhealthyApplications": { + "type": "integer", + "description": "The maximum allowed percentage of applications health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this.\n", + "minimum": 0, + "maximum": 100 + }, + "applicationDeltaHealthPolicies": { + "$ref": "#/definitions/ApplicationDeltaHealthPolicyMap", + "description": "Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster." + } + } + }, + "ClusterUpgradePolicy": { + "required": [ + "healthCheckRetryTimeout", + "healthCheckStableDuration", + "healthCheckWaitDuration", + "healthPolicy", + "upgradeDomainTimeout", + "upgradeReplicaSetCheckTimeout", + "upgradeTimeout" + ], + "properties": { + "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)." + }, + "upgradeReplicaSetCheckTimeout": { + "type": "string", + "description": "The maximum amount of time to block processing of an upgrade domain and revent 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. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "healthCheckWaitDuration": { + "type": "string", + "description": "The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "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. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "healthCheckRetryTimeout": { + "type": "string", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "upgradeTimeout": { + "type": "string", + "description": "The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "upgradeDomainTimeout": { + "type": "string", + "description": "The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "healthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "The cluster health policy used when upgrading the cluster." + }, + "deltaHealthPolicy": { + "$ref": "#/definitions/ClusterUpgradeDeltaHealthPolicy", + "description": "The cluster delta health policy used when upgrading the cluster." + } + }, + "description": "Describes the policy used when upgrading the cluster." + }, + "ClusterVersionDetails": { + "properties": { + "codeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster." + }, + "supportExpiryUtc": { + "type": "string", + "description": "The date of expiry of support of the version." + }, + "environment": { + "$ref": "#/definitions/ClusterEnvironment", + "description": "Indicates if this version is for Windows or Linux operating system." + } + }, + "description": "The detail of the Service Fabric runtime version result" + }, + "DiagnosticsStorageAccountConfig": { + "required": [ + "blobEndpoint", + "protectedAccountKeyName", + "queueEndpoint", + "storageAccountName", + "tableEndpoint" + ], + "properties": { + "storageAccountName": { + "type": "string", + "description": "The Azure storage account name." + }, + "protectedAccountKeyName": { + "type": "string", + "description": "The protected diagnostics storage key name." + }, + "blobEndpoint": { + "type": "string", + "description": "The blob endpoint of the azure storage account." + }, + "queueEndpoint": { + "type": "string", + "description": "The queue endpoint of the azure storage account." + }, + "tableEndpoint": { + "type": "string", + "description": "The table endpoint of the azure storage account." + } + }, + "description": "The storage account information for storing Service Fabric diagnostic logs." + }, + "DurabilityLevel": { + "type": "string", + "description": "The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - Bronze - No privileges. This is the default.\n - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD.\n - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc.\n", + "enum": [ + "Bronze", + "Silver", + "Gold" + ] + }, + "EndpointRangeDescription": { + "required": [ + "endPort", + "startPort" + ], + "properties": { + "startPort": { + "type": "integer", + "description": "Starting port of a range of ports" + }, + "endPort": { + "type": "integer", + "description": "End port of a range of ports" + } + }, + "description": "Port range details" + }, + "NodeTypeDescription": { + "required": [ + "clientConnectionEndpointPort", + "httpGatewayEndpointPort", + "isPrimary", + "name", + "vmInstanceCount" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the node type." + }, + "placementProperties": { + "type": "object", + "description": "The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.", + "additionalProperties": { + "type": "string", + "description": "Placement tag value" + } + }, + "capacities": { + "type": "object", + "description": "The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.", + "additionalProperties": { + "type": "string", + "description": "Capacity tag value" + } + }, + "clientConnectionEndpointPort": { + "type": "integer", + "description": "The TCP cluster management endpoint port." + }, + "httpGatewayEndpointPort": { + "type": "integer", + "description": "The HTTP cluster management endpoint port." + }, + "durabilityLevel": { + "$ref": "#/definitions/DurabilityLevel", + "description": "The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - Bronze - No privileges. This is the default.\n - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD.\n - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc.\n" + }, + "applicationPorts": { + "$ref": "#/definitions/EndpointRangeDescription", + "description": "The range of ports from which cluster assigned port to Service Fabric applications." + }, + "ephemeralPorts": { + "$ref": "#/definitions/EndpointRangeDescription", + "description": "The range of empheral ports that nodes in this node type should be configured with." + }, + "isPrimary": { + "type": "boolean", + "description": "The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters." + }, + "vmInstanceCount": { + "type": "integer", + "description": "The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource.", + "minimum": 1, + "maximum": 2147483647 + }, + "reverseProxyEndpointPort": { + "type": "integer", + "description": "The endpoint used by reverse proxy." + } + }, + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "description": "List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Service Fabric operations." + }, + "OperationResult": { + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "ReliabilityLevel": { + "type": "string", + "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n", + "enum": [ + "None", + "Bronze", + "Silver", + "Gold", + "Platinum" + ] + }, + "Resource": { + "required": [ + "location" + ], + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Azure resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "description": "Azure resource tags.", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "The resource model definition.", + "x-ms-azure-resource": true + }, + "ServerCertificateCommonName": { + "description": "Describes the server certificate details using common name.", + "required": [ + "certificateCommonName", + "certificateIssuerThumbprint" + ], + "properties": { + "certificateCommonName": { + "type": "string", + "description": "The common name of the server certificate." + }, + "certificateIssuerThumbprint": { + "type": "string", + "description": "The issuer thumbprint of the server certificate." + } + } + }, + "ServerCertificateCommonNames": { + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster.", + "properties": { + "commonNames": { + "type": "array", + "description": "The list of server certificates referenced by common name that are used to secure the cluster.", + "items": { + "$ref": "#/definitions/ServerCertificateCommonName" + } + }, + "x509StoreName": { + "$ref": "#/definitions/StoreName", + "description": "The local certificate store location." + } + } + }, + "ServiceTypeDeltaHealthPolicy": { + "type": "object", + "description": "Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.\n", + "properties": { + "maxPercentDeltaUnhealthyServices": { + "type": "integer", + "description": "The maximum allowed percentage of services health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the services at the beginning of upgrade and the state of the services at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n", + "default": 0, + "minimum": 0, + "maximum": 100 + } + } + }, + "ServiceTypeDeltaHealthPolicyMap": { + "type": "object", + "description": "Defines a map that contains specific delta health policies for different service types.\nEach entry specifies as key the service type name and as value a ServiceTypeDeltaHealthPolicy used to evaluate the service health when upgrading the cluster.\nThe map is empty by default.\n", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeDeltaHealthPolicy" + } + }, + "SettingsParameterDescription": { + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "The parameter name of fabric setting." + }, + "value": { + "type": "string", + "description": "The parameter value of fabric setting." + } + }, + "description": "Describes a parameter in fabric settings of the cluster." + }, + "SettingsSectionDescription": { + "required": [ + "name", + "parameters" + ], + "properties": { + "name": { + "type": "string", + "description": "The section name of the fabric settings." + }, + "parameters": { + "type": "array", + "description": "The collection of parameters in the section.", + "items": { + "$ref": "#/definitions/SettingsParameterDescription" + } + } + }, + "description": "Describes a section in the fabric settings of the cluster." + }, + "StoreName": { + "type": "string", + "description": "The local certificate store location.", + "enum": [ + "AddressBook", + "AuthRoot", + "CertificateAuthority", + "Disallowed", + "My", + "Root", + "TrustedPeople", + "TrustedPublisher" + ] + }, + "UpgradeMode": { + "type": "string", + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.\n", + "enum": [ + "Automatic", + "Manual" + ] + }, + "ErrorModel": { + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n", + "properties": { + "maxPercentUnhealthyServices": { + "type": "integer", + "description": "The maximum percentage of services allowed to be unhealthy before your application is considered in error.\n", + "default": 0, + "minimum": 0, + "maximum": 100 + } + } + }, + "ServiceTypeHealthPolicyMap": { + "type": "object", + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2018-02-01\" for this specification.", + "required": true, + "type": "string", + "enum": [ + "2018-02-01" + ], + "default": "2018-02-01", + "x-ms-parameter-location": "client" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterVersion": { + "name": "clusterVersion", + "in": "path", + "description": "The cluster code version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "environment": { + "name": "environment", + "in": "path", + "description": "The operating system of the cluster. The default means all.", + "required": true, + "type": "string", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-parameter-location": "method" + }, + "locationForClusterCodeVersions": { + "name": "location", + "in": "path", + "description": "The location for the cluster code versions. This is different from cluster location.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterDeleteOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterDeleteOperation_example.json new file mode 100644 index 000000000000..d62c64fe7d71 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterDeleteOperation_example.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {} + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterGetOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterGetOperation_example.json new file mode 100644 index 000000000000..1980c186e390 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterGetOperation_example.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": true, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "addOnFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterListByResourceGroupOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterListByResourceGroupOperation_example.json new file mode 100644 index 000000000000..1d4353c59482 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterListByResourceGroupOperation_example.json @@ -0,0 +1,248 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "addOnFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + }, + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "6.1.187.1", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Ubuntu", + "reliabilityLevel": "Silver", + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.187.1", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Linux" + } + ], + "addonFeatures": [ + "RepairManager" + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterListOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterListOperation_example.json new file mode 100644 index 000000000000..1ae0df7e692c --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterListOperation_example.json @@ -0,0 +1,247 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "addOnFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + }, + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "6.1.187.1", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Ubuntu", + "reliabilityLevel": "Silver", + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.187.1", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Linux" + } + ], + "addonFeatures": [ + "RepairManager" + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPatchOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPatchOperation_example.json new file mode 100644 index 000000000000..03f10ed3b62c --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPatchOperation_example.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2018-02-01", + "parameters": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": { + "a": "b" + }, + "properties": { + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + }, + { + "name": "testnt1", + "clientConnectionEndpointPort": 0, + "httpGatewayEndpointPort": 0, + "applicationPorts": { + "startPort": 1000, + "endPort": 2000 + }, + "ephemeralPorts": { + "startPort": 3000, + "endPort": 4000 + }, + "isPrimary": false, + "vmInstanceCount": 3, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Bronze", + "upgradeMode": "Default" + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2018-02-01" + }, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": { + "a": "b" + }, + "etag": "W/\"636462502169240744\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + }, + { + "name": "testnt1", + "clientConnectionEndpointPort": 0, + "httpGatewayEndpointPort": 0, + "applicationPorts": { + "startPort": 1000, + "endPort": 2000 + }, + "ephemeralPorts": { + "startPort": 3000, + "endPort": 4000 + }, + "isPrimary": false, + "vmInstanceCount": 3, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Bronze", + "upgradeMode": "Automatic", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPutOperation_example_max.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPutOperation_example_max.json new file mode 100644 index 000000000000..f924fc6a9762 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPutOperation_example_max.json @@ -0,0 +1,296 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2018-02-01", + "parameters": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "properties": { + "clusterCodeVersion": "6.1.480.9494", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": true, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "addOnFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/4b5f6709-bc12-4365-8df3-894984b2a221?api-version=2018-02-01" + }, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": true, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "00:15:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "addonFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPutOperation_example_min.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPutOperation_example_min.json new file mode 100644 index 000000000000..76759d3a8a62 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPutOperation_example_min.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2018-02-01", + "parameters": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "properties": { + "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Silver", + "upgradeMode": "Automatic" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240743\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "10675199.02:48:05.4775807", + "healthCheckWaitDuration": "00:05:00", + "healthCheckStableDuration": "00:05:00", + "healthCheckRetryTimeout": "00:45:00", + "upgradeTimeout": "12:00:00", + "upgradeDomainTimeout": "02:00:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 100, + "maxPercentUnhealthyApplications": 100 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Silver", + "upgradeMode": "Automatic", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsGetByEnvironment_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsGetByEnvironment_example.json new file mode 100644 index 000000000000..3c06067f37bd --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsGetByEnvironment_example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "clusterVersion": "6.1.480.9494", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", + "name": "6.1.480.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsGet_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsGet_example.json new file mode 100644 index 000000000000..b8477ec5c74a --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsGet_example.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "clusterVersion": "6.1.480.9494", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", + "name": "6.1.480.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsListByEnvironment.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsListByEnvironment.json new file mode 100644 index 000000000000..47648aa8fbab --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsListByEnvironment.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", + "name": "6.1.480.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsList_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsList_example.json new file mode 100644 index 000000000000..710991ecdd61 --- /dev/null +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsList_example.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", + "name": "6.1.480.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Linux/clusterVersions/6.1.187.1", + "name": "6.1.187.1", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.187.1", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Linux" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/readme.md b/specification/servicefabric/resource-manager/readme.md index 716b5d473b36..4a3c6047d962 100644 --- a/specification/servicefabric/resource-manager/readme.md +++ b/specification/servicefabric/resource-manager/readme.md @@ -1,14 +1,14 @@ -# ServiceFabricClient - +# ServiceFabric + > see https://aka.ms/autorest -This is the AutoRest configuration file for ServiceFabricClient. +This is the AutoRest configuration file for Service Fabric. --- ## Getting Started -To build the SDK for ServiceFabricClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: +To build the SDK for ServiceFabricManagementClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -21,22 +21,53 @@ To see additional help and options, run: -### Basic Information -These are the global settings for the ServiceFabricClient API. +### Basic Information +These are the global settings for the ServiceFabricManagementClient API. ``` yaml +title: ServiceFabricManagementClient +description: Service Fabric Management Client openapi-type: arm -tag: package-2017-07 +tag: package-2018-02 + +directive: + - suppress: ListInOperationName + reason: Modifying the operation names would break the backwards compatibility of the API. + - suppress: LongRunningResponseStatusCode + reason: The validation tools do not properly recognize 202 as a supported response code. + - suppress: SummaryAndDescriptionMustNotBeSame + reason: There are a lot of APIs with missing summary content. While it is being worked on disabling this to ensure that we catch and fix other violations. + - suppress: TrackedResourceListByImmediateParent + reason: Proxy resources are not properly evaluated by the validation toolset. + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Modifying the operation names would break the backwards compatibility of the API. + - suppress: EnumInsteadOfBoolean + reason: The boolean properties are actually boolean value in the Service Fabric's application model. + - suppress: TrackedResourceGetOperation + reason: Proxy resources are not properly evaluated by the validation toolset. + - suppress: TrackedResourcePatchOperation + reason: Proxy resources are not properly evaluated by the validation toolset. + - suppress: TrackedResourceListByResourceGroup + reason: Proxy resources are not properly evaluated by the validation toolset. + - suppress: TrackedResourceListBySubscription + reason: Proxy resources are not properly evaluated by the validation toolset. + - suppress: DescriptionAndTitleMissing + reason: There are a lot of APIs with missing titles. While it is being worked on disabling this to ensure that we catch and fix other violations. + - suppress: Example Validations + reason: There are open issues (bugs) in the validator affecting some of the examples and since there is no way to selectively disable the validation for a particular example or paths, all of the example validation is being turned off. + - suppress: Example Validations + reason: There are open issues (bugs) in the validator affecting some of the examples and since there is no way to selectively disable the validation for a particular example or paths, all of the example validation is being turned off. + ``` +### Tag: package-2018-02 -### Tag: package-2016-09 +These settings apply only when `--tag=package-2018-02` is specified on the command line. -These settings apply only when `--tag=package-2016-09` is specified on the command line. - -``` yaml $(tag) == 'package-2016-09' +``` yaml $(tag) == 'package-2018-02' input-file: -- Microsoft.ServiceFabric/stable/2016-09-01/servicefabric.json +- Microsoft.ServiceFabric/stable/2018-02-01/cluster.json +- Microsoft.ServiceFabric/preview/2017-07-01-preview/application.json ``` ### Tag: package-2017-07 @@ -48,6 +79,15 @@ input-file: - Microsoft.ServiceFabric/preview/2017-07-01-preview/servicefabric.json ``` +### Tag: package-2016-09 + +These settings apply only when `--tag=package-2016-09` is specified on the command line. + +``` yaml $(tag) == 'package-2016-09' +input-file: +- Microsoft.ServiceFabric/stable/2016-09-01/servicefabric.json +``` + --- # Code Generation @@ -61,9 +101,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_service_fabric'] ``` @@ -77,6 +120,7 @@ csharp: azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: Microsoft.Azure.Management.ServiceFabric + payload-flattening-threshold: 1 output-folder: $(csharp-sdks-folder)/ServiceFabric/Management.ServiceFabric/Generated clear-output-folder: true ``` @@ -125,17 +169,18 @@ go: ``` yaml $(go) && $(multiapi) batch: - - tag: package-2016-09 + - tag: package-2018-02 - tag: package-2017-07 + - tag: package-2016-09 ``` -### Tag: package-2016-09 and go +### Tag: package-2018-02 and go -These settings apply only when `--tag=package-2016-09 --go` is specified on the command line. +These settings apply only when `--tag=package-2018-02 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2016-09' && $(go) -output-folder: $(go-sdk-folder)/services/servicefabric/mgmt/2016-09-01/servicefabric +``` yaml $(tag) == 'package-2018-02' && $(go) +output-folder: $(go-sdk-folder)/services/servicefabric/mgmt/2018-02-01/servicefabric ``` ### Tag: package-2017-07 and go @@ -144,7 +189,16 @@ These settings apply only when `--tag=package-2017-07 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-07' && $(go) -output-folder: $(go-sdk-folder)/services/servicefabric/mgmt/2017-07-01-preview/servicefabric +output-folder: $(go-sdk-folder)/services/preview/servicefabric/mgmt/2017-07-01-preview/servicefabric +``` + +### Tag: package-2016-09 and go + +These settings apply only when `--tag=package-2016-09 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2016-09' && $(go) +output-folder: $(go-sdk-folder)/services/servicefabric/mgmt/2016-09-01/servicefabric ``` @@ -154,11 +208,46 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.servicefabric +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servicefabric +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-07 + - tag: package-2016-09 +``` + +### Tag: package-2017-07 and java + +These settings apply only when `--tag=package-2017-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-07' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.servicefabric - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servicefabric + namespace: com.microsoft.azure.management.servicefabric.v2017_07_01_preview + output-folder: $(azure-libraries-for-java-folder)/servicefabric/resource-manager/v2017_07_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-09 and java + +These settings apply only when `--tag=package-2016-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.servicefabric.v2016_09_01 + output-folder: $(azure-libraries-for-java-folder)/servicefabric/resource-manager/v2016_09_01 +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/servicefabric/resource-manager/readme.ruby.md b/specification/servicefabric/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..0551a281f0b4 --- /dev/null +++ b/specification/servicefabric/resource-manager/readme.ruby.md @@ -0,0 +1,37 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_service_fabric +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2017-07 + - tag: package-2016-09 +``` + +### Tag: package-2017-07 and ruby + +These settings apply only when `--tag=package-2017-07 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-07' && $(ruby) +namespace: "Azure::ServiceFabric::Mgmt::V2017_07_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_service_fabric/lib +``` + +### Tag: package-2016-09 and ruby + +These settings apply only when `--tag=package-2016-09 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-09' && $(ruby) +namespace: "Azure::ServiceFabric::Mgmt::V2016_09_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_service_fabric/lib +``` diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationCreateOrUpdate.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationCreateOrUpdate.json new file mode 100644 index 000000000000..ce3e4db488e7 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationCreateOrUpdate.json @@ -0,0 +1,83 @@ +{ + "operationId":"Application_Create", + "description":"This example shows how to create or update an application resource.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp", + "applicationResourceDescription": { + "properties": { + "description": "SeaBreeze HelloWorld Application!", + "services": [ + { + "properties": { + "osType": "linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "description": "SeaBreeze Hello World Service.", + "replicaCount": 1 + }, + "name": "helloWorldService" + } + ] + }, + "tags": {}, + "location": "EastUS" + } + }, + "responses": { + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/myHelloWorldApp", + "name": "myHelloWorldApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + } + }, + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/myHelloWorldApp", + "name": "myHelloWorldApp", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationDelete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationDelete.json new file mode 100644 index 000000000000..aa925879e076 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationDelete.json @@ -0,0 +1,16 @@ +{ + "operationId":"Application_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 exit, an empty response with 204 status code is returned.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview", + "resourceGroupName": "sbz_demo", + "applicationName": "helloWorldAppWindows" + }, + "responses": { + "200": {}, + "204": {} + } + } + + diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationGet.json new file mode 100644 index 000000000000..fa3243b21b41 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "demo1" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldAppWindows", + "name": "helloWorldAppWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsByResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsByResourceGroup.json new file mode 100644 index 000000000000..2d4e507408ef --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsByResourceGroup.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldApp", + "name": "helloWorldApp", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldAppWindows", + "name": "helloWorldAppWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsBySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsBySubscriptionId.json new file mode 100644 index 000000000000..c86d60e3f22b --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsBySubscriptionId.json @@ -0,0 +1,175 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/abhisramvol/providers/Microsoft.ServiceFabricMesh/applications/myappl", + "name": "myappl", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "healthState": "Ok", + "serviceNames": [ + "myservice" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/abhisramvol/providers/Microsoft.ServiceFabricMesh/applications/myappw", + "name": "myappw", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "healthState": "Ok", + "serviceNames": [ + "myservice" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/mfussellapp2/providers/Microsoft.ServiceFabricMesh/applications/SbzVoting", + "name": "SbzVoting", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Voting SeaBreeze!", + "healthState": "Ok", + "serviceNames": [ + "VotingWeb", + "VotingData" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/mfussellapp3/providers/Microsoft.ServiceFabricMesh/applications/SbzVoting", + "name": "SbzVoting", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Voting SeaBreeze!", + "healthState": "Ok", + "serviceNames": [ + "VotingWeb", + "VotingData" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldApp", + "name": "helloWorldApp", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldAppWindows", + "name": "helloWorldAppWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridhar1ResourceGroup/providers/Microsoft.ServiceFabricMesh/applications/privateRegistryExampleApp", + "name": "privateRegistryExampleApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "SeaBreeze example application with container deployed from private image registry.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridhar4ResourceGroup/providers/Microsoft.ServiceFabricMesh/applications/SbzVoting", + "name": "SbzVoting", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Voting SeaBreeze!", + "healthState": "Ok", + "serviceNames": [ + "VotingWeb", + "VotingData" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridharResourceGroup/providers/Microsoft.ServiceFabricMesh/applications/privateRegistryExampleApp", + "name": "privateRegistryExampleApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "SeaBreeze example application with container deployed from private image registry.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridharRG/providers/Microsoft.ServiceFabricMesh/applications/privateRegistryExampleApp", + "name": "privateRegistryExampleApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "SeaBreeze example application with container deployed from private image registry.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ContainerLogsList.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ContainerLogsList.json new file mode 100644 index 000000000000..4b7cc891243a --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ContainerLogsList.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "sbzDocApp", + "serviceName": "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/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkCreateOrUpdate.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkCreateOrUpdate.json new file mode 100644 index 000000000000..59aa09568838 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkCreateOrUpdate.json @@ -0,0 +1,76 @@ +{ + "operationId": "Network_Create", + "description": "This example shows how to create a network resource with custom address range and a load balanced public endpoint.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "networkName": "helloWorldNetworkWindows", + "networkResourceDescription": { + "properties": { + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "layer4": [ + { + "publicPort": "80", + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkDelete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkDelete.json new file mode 100644 index 000000000000..0eee1b214f41 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkDelete.json @@ -0,0 +1,14 @@ +{ + "operationId":"Network_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 exit, an empty response with 204 status code is returned.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview", + "resourceGroupName": "sbz_demo", + "networkName": "helloWorldNetworkWindows" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkGet.json new file mode 100644 index 000000000000..6ae8caf1e8d1 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "networkName": "helloWorldNetworkWindows" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.255.103", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksByResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksByResourceGroup.json new file mode 100644 index 000000000000..32d19f8454b5 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork", + "name": "helloWorldNetwork", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.12.219", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + }, + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.255.103", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksBySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksBySubscriptionId.json new file mode 100644 index 000000000000..6527fdc04c6a --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksBySubscriptionId.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/{resourceGroup}/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork", + "name": "helloWorldNetwork", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.12.219", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + }, + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/{resourceGroup}/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.255.103", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicaGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicaGet.json new file mode 100644 index 000000000000..beb530b0fcf3 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicaGet.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "replicaName": "1" + }, + "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" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.9016844", + "lastTimestamp": "2018-04-06T06:36:06.0887046", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.6622454", + "lastTimestamp": "2018-04-06T06:34:00.6622454", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.906688", + "lastTimestamp": "2018-04-06T06:36:06.0827003", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.656241", + "lastTimestamp": "2018-04-06T06:34:00.656241", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "replicaName": "1" + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicasGetAll.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicasGetAll.json new file mode 100644 index 000000000000..c7549c862176 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicasGetAll.json @@ -0,0 +1,207 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "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" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.9016844", + "lastTimestamp": "2018-04-06T06:36:06.0887046", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.6622454", + "lastTimestamp": "2018-04-06T06:34:00.6622454", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.906688", + "lastTimestamp": "2018-04-06T06:36:06.0827003", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.656241", + "lastTimestamp": "2018-04-06T06:34:00.656241", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "replicaName": "1" + }, + { + "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" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.9016844", + "lastTimestamp": "2018-04-06T06:36:06.0887046", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.6622454", + "lastTimestamp": "2018-04-06T06:34:00.6622454", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.906688", + "lastTimestamp": "2018-04-06T06:36:06.0827003", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.656241", + "lastTimestamp": "2018-04-06T06:34:00.656241", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "replicaName": "0" + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceGet.json new file mode 100644 index 000000000000..d5bfe5632f4b --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService" + }, + "responses": { + "200": { + "body": { + "name": "helloWorldService", + "type": "Microsoft.ServiceFabricMesh/services", + "properties": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "description": "SeaBreeze Hello World Service.", + "replicaCount": 2, + "healthState": "Ok", + "status": "Unknown" + } + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceList.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceList.json new file mode 100644 index 000000000000..cc2e90cc9e59 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceList.json @@ -0,0 +1,62 @@ +{ + "operationId":"Service_ListByApplicationName", + "description":"This example shows how to list all services of a given application.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "helloWorldService", + "type": "Microsoft.ServiceFabricMesh/services", + "properties": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "description": "SeaBreeze Hello World Service.", + "replicaCount": 1, + "healthState": "Ok", + "status": "Unknown" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeCreate.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeCreate.json new file mode 100644 index 000000000000..2d3c36f4c007 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeCreate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "volumeName": "sbzDemoVolume", + "volumeResourceDescription": { + "properties": { + "description": "File share backed by Azure Files storage.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "accountKey": "provide-account-key-here", + "shareName": "sharel" + }, + "provider": "SFAzureFile" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", + "name": "sbzDemoVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", + "name": "sbzDemoVolume", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeDelete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeDelete.json new file mode 100644 index 000000000000..02145e25ee18 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeDelete.json @@ -0,0 +1,14 @@ +{ + "operationId":"Volume_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 exit, an empty response with 204 status code is returned.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview", + "resourceGroupName": "sbz_demo", + "volumeName": "sbzDemoVolume" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeGet.json new file mode 100644 index 000000000000..4a8cc7e3d626 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "volumeName": "sbzDemoVolume" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", + "name": "sbzDemoVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesByResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesByResourceGroup.json new file mode 100644 index 000000000000..6c68786b1a06 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesByResourceGroup.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume2", + "name": "sbzDemoShare", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + }, + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", + "name": "sbzDemoVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesBySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesBySubscriptionId.json new file mode 100644 index 000000000000..2afae5f97d1a --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesBySubscriptionId.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbzdemo/providers/Microsoft.ServiceFabricMesh/volumes/mysharel", + "name": "mysharel", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + }, + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbzdemo/providers/Microsoft.ServiceFabricMesh/volumes/mysharew", + "name": "mysharew", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharew", + "accountName": "sbzdemoaccount" + } + } + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json new file mode 100644 index 000000000000..cd4b6488ca71 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json @@ -0,0 +1,2245 @@ +{ + "swagger": "2.0", + "info": { + "title": "SeaBreezeManagementClient", + "description": "APIs to deploy and manage resources to SeaBreeze.", + "version": "2018-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}": { + "put": { + "operationId": "Application_Create", + "x-ms-examples": { + "ApplicationCreateOrUpdate": { + "$ref": "./examples/ApplicationCreateOrUpdate.json" + } + }, + "summary": "Creates or updates an application resource.", + "description": "Creates an application resource with the specified name and description. If an application with the same name already exists, then its description is updated to the one indicated in this request.\n\nUse network resources to provide public connectivity to the services of an application.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "get": { + "operationId": "Application_Get", + "x-ms-examples": { + "ApplicationGet": { + "$ref": "./examples/ApplicationGet.json" + } + }, + "summary": "Gets the application resource.", + "description": "Gets the information about the application resource with a given name. The information includes the information about the application's services and other runtime properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Application_Delete", + "x-ms-examples": { + "ApplicationDelete": { + "$ref": "./examples/ApplicationDelete.json" + } + }, + "summary": "Deletes the application resource.", + "description": "Deletes the application resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content - the specified application was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services": { + "get": { + "operationId": "Service_ListByApplicationName", + "x-ms-examples": { + "ServiceGetAll": { + "$ref": "./examples/ServiceList.json" + } + }, + "summary": "Gets services of a given application.", + "description": "Gets the information about all services of a given service of an application. The information includes the runtime properties of the service instance.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + } + ], + "tags": [ + "Services" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}": { + "get": { + "operationId": "Service_Get", + "x-ms-examples": { + "ServiceGet": { + "$ref": "./examples/ServiceGet.json" + } + }, + "summary": "Gets the properties of the service.", + "description": "The operation returns the properties of the service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceNameRequiredPathParam" + } + ], + "tags": [ + "Services" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceResourceDescription" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}/replicas": { + "get": { + "operationId": "Replica_ListByServiceName", + "x-ms-examples": { + "ReplicasGetAll": { + "$ref": "./examples/ReplicasGetAll.json" + } + }, + "summary": "Gets replicas of a given service.", + "description": "Gets the information about all replicas of a given service of an application. The information includes the runtime properties of the replica instance.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceNameRequiredPathParam" + } + ], + "tags": [ + "Replicas" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceReplicaList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}/replicas/{replicaName}": { + "get": { + "operationId": "Replica_Get", + "x-ms-examples": { + "ReplicaGet": { + "$ref": "./examples/ReplicaGet.json" + } + }, + "summary": "Gets a specific replica of a given service.", + "description": "Gets the information about the specified replica of a given service of an application. The information includes the runtime properties of the replica instance.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaNameRequiredPathParam" + } + ], + "tags": [ + "Replicas" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceReplicaDescription" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications": { + "get": { + "operationId": "Application_ListByResourceGroup", + "x-ms-examples": { + "ApplicationList": { + "$ref": "./examples/ApplicationsByResourceGroup.json" + } + }, + "summary": "Gets all the application resources in a given resource group.", + "description": "Gets the information about all application resources in a given resource group. The information includes the information about the application's services and other runtime properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/applications": { + "get": { + "operationId": "Application_ListBySubscription", + "x-ms-examples": { + "ApplicationList": { + "$ref": "./examples/ApplicationsBySubscriptionId.json" + } + }, + "summary": "Gets all the application resources in a given subscription.", + "description": "Gets the information about all application resources in a given subscription. The information includes the information about the application's services and other runtime properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}/replicas/{replicaName}/codePackages/{codePackageName}/logs": { + "get": { + "operationId": "CodePackage_GetContainerLog", + "x-ms-examples": { + "ContainerLogsList": { + "$ref": "./examples/ContainerLogsList.json" + } + }, + "summary": "Gets the logs for the container.", + "description": "Get the logs for the container of a given code package of an application.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaNameRequiredPathParam" + }, + { + "$ref": "#/parameters/CodePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TailOptionalQueryParam" + } + ], + "tags": [ + "ContainerLogs" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/ContainerLogs" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/providers/Microsoft.ServiceFabricMesh/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available operations.", + "description": "Lists all the available operations provided by Service Fabric SeaBreeze resource provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkName}": { + "put": { + "operationId": "Network_Create", + "x-ms-examples": { + "Network_Create": { + "$ref": "./examples/NetworkCreateOrUpdate.json" + } + }, + "summary": "Creates or updates a network resource.", + "description": "Creates a network resource with the specified name and description. If a network with the same name already exists, then its description is updated to the one indicated in this request.\n\nUse network resources to create private network and configure public connectivity for services within your application. \n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "get": { + "operationId": "Network_Get", + "x-ms-examples": { + "NetworkGet": { + "$ref": "./examples/NetworkGet.json" + } + }, + "summary": "Gets the network resource.", + "description": "Gets the information about the network resource with a given name. This information includes the network description and other runtime information.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkNameRequiredPathParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Network_Delete", + "x-ms-examples": { + "NetworkDelete": { + "$ref": "./examples/NetworkDelete.json" + } + }, + "summary": "Deletes the network resource.", + "description": "Deletes the network resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkNameRequiredPathParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content - the specified network was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks": { + "get": { + "operationId": "Network_ListByResourceGroup", + "x-ms-examples": { + "NetworksList": { + "$ref": "./examples/NetworksByResourceGroup.json" + } + }, + "summary": "Gets all the network resources in a given resource group.", + "description": "Gets the information about all network resources in a given resource group. The information includes the network description and other runtime properties.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/networks": { + "get": { + "operationId": "Network_ListBySubscription", + "x-ms-examples": { + "NetworksList": { + "$ref": "./examples/NetworksBySubscriptionId.json" + } + }, + "summary": "Gets all the network resources in a given subscription.", + "description": "Gets the information about all network resources in a given subscription. The information includes the network description and other runtime properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeName}": { + "put": { + "operationId": "Volume_Create", + "x-ms-examples": { + "VolumeCreate": { + "$ref": "./examples/VolumeCreate.json" + } + }, + "summary": "Creates or updates a volume resource.", + "description": "Creates a volume resource with the specified name and description. If a volume with the same name already exists, then its description is updated to the one indicated in this request.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "get": { + "operationId": "Volume_Get", + "x-ms-examples": { + "VolumeGet": { + "$ref": "./examples/VolumeGet.json" + } + }, + "summary": "Gets the volume resource.", + "description": "Gets the information about the volume resource with a given name. This information includes the volume description and other runtime information.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeNameRequiredPathParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Volume_Delete", + "x-ms-examples": { + "VolumeDelete": { + "$ref": "./examples/VolumeDelete.json" + } + }, + "summary": "Deletes the volume resource.", + "description": "Deletes the volume identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeNameRequiredPathParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content - the specified volume was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes": { + "get": { + "operationId": "Volume_ListByResourceGroup", + "x-ms-examples": { + "VolumesList": { + "$ref": "./examples/VolumesByResourceGroup.json" + } + }, + "summary": "Gets all the volume resources in a given resource group.", + "description": "Gets the information about all volume resources in a given resource group. The information includes the volume description and other runtime information.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/volumes": { + "get": { + "operationId": "Volume_ListBySubscription", + "x-ms-examples": { + "VolumesList": { + "$ref": "./examples/VolumesBySubscriptionId.json" + } + }, + "summary": "Gets all the volume resources in a given subscription.", + "description": "Gets the information about all volume resources in a given subscription. The information includes the volume description and other runtime information.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Resource": { + "description": "The resource model definition for Azure Resource Manager resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "x-ms-mutability": [ + "read" + ] + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource", + "x-ms-mutability": [ + "read" + ] + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.", + "x-ms-mutability": [ + "read" + ] + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ManagedProxyResource": { + "description": "The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags. This proxy resource is explicitly created or updated by including it in the parent resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "x-ms-mutability": [ + "read" + ] + }, + "name": { + "type": "string", + "description": "The name of the resource", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.", + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for Azure Resource Manager tracked top-level resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "required": [ + "location" + ] + }, + "ProvisionedResourceProperties": { + "description": "Describes common properties of a provisioned resource.", + "properties": { + "provisioningState": { + "type": "string", + "description": "State of the resource.", + "readOnly": true + } + } + }, + "NetworkResourceDescriptionList": { + "description": "A pageable list of network resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "NetworkResourceDescription": { + "description": "This type describes a network resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkResourceProperties", + "description": "Describes properties of a network resource." + } + }, + "required": [ + "properties" + ] + }, + "NetworkResourceProperties": { + "description": "Describes properties of a network resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/NetworkProperties" + } + ] + }, + "NetworkProperties": { + "description": "Describes a network.", + "type": "object", + "properties": { + "description": { + "description": "User readable description of the network.", + "type": "string" + }, + "addressPrefix": { + "description": "the address prefix for this network.", + "type": "string" + }, + "ingressConfig": { + "$ref": "#/definitions/IngressConfig", + "description": "Configuration for public connectivity for this network." + } + }, + "required": [ + "addressPrefix" + ] + }, + "VolumeResourceDescriptionList": { + "description": "A pageable list of volume resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VolumeResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "VolumeResourceDescription": { + "description": "This type describes a volume resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VolumeResourceProperties", + "description": "Describes properties of a volume resource." + } + }, + "required": [ + "properties" + ] + }, + "VolumeResourceProperties": { + "description": "Describes properties of a volume resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/VolumeProperties" + } + ] + }, + "VolumeProperties": { + "description": "This type describes properties of a volume resource.", + "type": "object", + "properties": { + "description": { + "description": "User readable description of the volume.", + "type": "string" + }, + "provider": { + "description": "Provider of the volume.", + "type": "string", + "enum": [ + "SFAzureFile" + ], + "x-ms-enum": { + "name": "VolumeProvider", + "modelAsString": true + } + }, + "azureFileParameters": { + "$ref": "#/definitions/VolumeProviderParametersAzureFile", + "description": "This type describes a volume provided by an Azure Files file share." + } + }, + "required": [ + "provider" + ] + }, + "VolumeProviderParametersAzureFile": { + "description": "This type describes a volume provided by an Azure Files file share.", + "type": "object", + "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" + ] + }, + "ApplicationResourceDescriptionList": { + "description": "A pageable list of application resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "ApplicationResourceDescription": { + "description": "This type describes an application resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationResourceProperties", + "description": "This type describes properties of an application resource." + } + }, + "required": [ + "properties" + ] + }, + "ApplicationResourceProperties": { + "description": "This type describes properties of an application resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/ApplicationProperties" + } + ] + }, + "ApplicationProperties": { + "description": "This type describes properties of an application resource.", + "type": "object", + "properties": { + "description": { + "description": "User readable description of the application.", + "type": "string" + }, + "debugParams": { + "description": "Internal use.", + "type": "string" + }, + "services": { + "type": "array", + "description": "describes the services in the application.", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + } + }, + "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." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Status of the application resource.", + "enum": [ + "Invalid", + "Ready", + "Upgrading", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ApplicationResourceStatus", + "modelAsString": true + } + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the application deployment." + }, + "serviceNames": { + "readOnly": true, + "description": "Names of the services in the application.", + "type": "array", + "items": { + "type": "string" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsDescription", + "description": "Describes the diagnostics definition and usage for an application resource." + } + } + }, + "ServiceList": { + "description": "A pageable list of all services in an application.\n", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "ServiceResourceDescription": { + "description": "This type describes a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ManagedProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceResourceProperties", + "description": "This type describes properties of a service resource." + } + }, + "required": [ + "properties" + ] + }, + "ServiceResourceProperties": { + "description": "This type describes properties of a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceReplicaProperties" + }, + { + "type": "object", + "properties": { + "description": { + "description": "User readable description of the service.", + "type": "string" + }, + "replicaCount": { + "type": "integer", + "description": "The number of replicas of the service to create. Defaults to 1 if not specified." + }, + "healthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a resource such as Application, Service, or Network." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Represents the status of the service.", + "enum": [ + "Unknown", + "Active", + "Upgrading", + "Deleting", + "Creating", + "Failed" + ], + "x-ms-enum": { + "name": "ServiceResourceStatus", + "modelAsString": true + } + } + } + } + ] + }, + "ContainerInstanceView": { + "description": "Runtime information of a container instance.", + "type": "object", + "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" + } + } + } + }, + "ContainerEvent": { + "description": "A container event.", + "type": "object", + "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." + } + } + }, + "ContainerLabel": { + "description": "Describes a container label.", + "type": "object", + "properties": { + "name": { + "description": "The name of the container label.", + "type": "string" + }, + "value": { + "description": "The value of the container label.", + "type": "string" + } + }, + "required": [ + "name", + "value" + ] + }, + "ContainerLogs": { + "description": "The logs of the container.", + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "content of the log." + } + } + }, + "ContainerState": { + "description": "The container state.", + "type": "object", + "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" + } + } + }, + "ImageRegistryCredential": { + "description": "Image registry credential.", + "type": "object", + "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." + }, + "password": { + "type": "string", + "description": "The password for the private registry." + } + }, + "required": [ + "server", + "username" + ] + }, + "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.", + "type": "object", + "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.\n", + "type": "object", + "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.", + "type": "object", + "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" + ] + }, + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "description": "List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Service Fabric operations." + }, + "OperationResult": { + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of operations available at the listed Azure resource provider." + }, + "AvailableOperationDisplay": { + "properties": { + "provider": { + "type": "string", + "description": "Name of the operation provider." + }, + "resource": { + "type": "string", + "description": "Name of the resource on which the operation is available." + }, + "operation": { + "type": "string", + "description": "Name of the available operation." + }, + "description": { + "type": "string", + "description": "Description of the available operation." + } + }, + "description": "An operation available at the listed Azure resource provider." + }, + "ErrorModel": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "ContainerCodePackageProperties": { + "description": "Describes a container and its runtime properties.", + "type": "object", + "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": { + "$ref": "#/definitions/ResourceRequirements", + "description": "This type describes the resource requirements for a container or a service." + }, + "volumeRefs": { + "description": "The volumes to be attached to the container.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerVolume" + } + }, + "instanceView": { + "readOnly": true, + "$ref": "#/definitions/ContainerInstanceView", + "description": "Runtime information of a container instance." + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsRef", + "description": "Reference to sinks in DiagnosticsDescription." + } + }, + "required": [ + "name", + "image", + "resources" + ] + }, + "ContainerVolume": { + "description": "Describes how a volume is attached to a container.", + "type": "object", + "properties": { + "name": { + "description": "Name of the volume.", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the volume is read only. Default is 'false'.", + "type": "boolean" + }, + "destinationPath": { + "description": "The path within the container at which the volume should be mounted. Only valid path characters are allowed.", + "type": "string" + } + }, + "required": [ + "name", + "destinationPath" + ] + }, + "EndpointProperties": { + "description": "Describes a container endpoint.", + "type": "object", + "properties": { + "name": { + "description": "The name of the endpoint.", + "type": "string" + }, + "port": { + "description": "Port used by the container.", + "type": "integer" + } + }, + "required": [ + "name" + ] + }, + "ServiceReplicaList": { + "description": "A pageable list of replicas of a service resource.\n", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceReplicaDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "ServiceReplicaDescription": { + "type": "object", + "description": "This type describes a replica of a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceReplicaProperties" + }, + { + "type": "object", + "properties": { + "replicaName": { + "type": "string", + "description": "Name of the replica." + } + } + } + ] + }, + "ServiceReplicaProperties": { + "description": "Describes the properties of a service replica.", + "type": "object", + "properties": { + "osType": { + "type": "string", + "description": "The Operating system type required by the code in service.\n", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true + } + }, + "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.).\n", + "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" + ] + }, + "IngressConfig": { + "description": "Describes public connectivity configuration for the network.", + "type": "object", + "properties": { + "qosLevel": { + "type": "string", + "description": "The QoS tier for ingress.", + "enum": [ + "Bronze" + ], + "x-ms-enum": { + "name": "IngressQoSLevel", + "modelAsString": true + } + }, + "layer4": { + "description": "Configuration for layer4 public connectivity for this network.", + "type": "array", + "items": { + "$ref": "#/definitions/Layer4IngressConfig" + } + }, + "publicIPAddress": { + "type": "string", + "readOnly": true, + "description": "The public IP address for reaching this network." + } + } + }, + "Layer4IngressConfig": { + "description": "Describes the layer4 configuration for public connectivity for this network.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Layer4 ingress config name." + }, + "publicPort": { + "type": "integer", + "description": "Specifies the public port at which the service endpoint below needs to be exposed." + }, + "applicationName": { + "type": "string", + "description": "The application name which contains the service to be exposed." + }, + "serviceName": { + "type": "string", + "description": "The service whose endpoint needs to be exposed at the public port." + }, + "endpointName": { + "type": "string", + "description": "The service endpoint that needs to be exposed." + } + } + }, + "EnvironmentVariable": { + "description": "Describes an environment variable for the container.", + "type": "object", + "properties": { + "name": { + "description": "The name of the environment variable.", + "type": "string" + }, + "value": { + "description": "The value of the environment variable.", + "type": "string" + } + } + }, + "Setting": { + "description": "Describes a setting for the container.", + "type": "object", + "properties": { + "name": { + "description": "The name of the setting.", + "type": "string" + }, + "value": { + "description": "The value of the setting.", + "type": "string" + } + } + }, + "NetworkRef": { + "description": "Describes a network reference in a service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the network." + } + } + }, + "HealthState": { + "type": "string", + "description": "The health state of a resource such as Application, Service, or Network.", + "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." + } + ] + } + }, + "DiagnosticsDescription": { + "description": "Describes the diagnostics options available", + "type": "object", + "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.", + "type": "object", + "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" + } + } + } + }, + "DiagnosticsSinkProperties": { + "description": "Properties of a DiagnosticsSink.", + "type": "object", + "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" + ] + }, + "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." + } + ] + } + }, + "AzureInternalMonitoringPipelineSinkDescription": { + "type": "object", + "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." + }, + "autoKeyConfigUrl": { + "description": "Azure Internal monitoring pipeline autokey associated with the certificate.", + "type": "string" + } + } + } + }, + "parameters": { + "api-versionRequiredQueryParam": { + "name": "api-version", + "in": "query", + "type": "string", + "enum": [ + "2018-07-01-preview" + ], + "default": "2018-07-01-preview", + "description": "The version of the API. This parameter is required and its value must be `2018-07-01-preview`.", + "required": true, + "x-ms-enum": { + "name": "2018-07-01-preview", + "modelAsString": true, + "values": [ + { + "value": "2018-07-01-preview", + "description": "The `2018-07-01-preview` version of the API." + } + ] + } + }, + "subscriptionIdRequiredPathParam": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier", + "required": true, + "type": "string" + }, + "ResourceGroupNameRequiredPathParam": { + "name": "resourceGroupName", + "in": "path", + "description": "Azure resource group name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApplicationNameRequiredPathParam": { + "name": "applicationName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the application." + }, + "ApplicationResourceDescriptionRequiredBodyParam": { + "name": "applicationResourceDescription", + "in": "body", + "description": "Description for creating an application resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "ServiceNameRequiredPathParam": { + "name": "serviceName", + "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": "The identity of the service replica." + }, + "NetworkNameRequiredPathParam": { + "name": "networkName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the network." + }, + "NetworkResourceDescriptionRequiredBodyParam": { + "name": "networkResourceDescription", + "in": "body", + "description": "Description for creating a network resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "VolumeNameRequiredPathParam": { + "name": "volumeName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the volume." + }, + "VolumeResourceDescriptionRequiredBodyParam": { + "name": "volumeResourceDescription", + "in": "body", + "description": "Description for creating a volume resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "CodePackageNameRequiredPathParam": { + "name": "codePackageName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The name of the code package." + }, + "TailOptionalQueryParam": { + "name": "tail", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "description": "Number of lines to show from the end of the logs. Default is 100." + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/readme.md b/specification/servicefabricmesh/resource-manager/readme.md new file mode 100644 index 000000000000..a789db75ef22 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/readme.md @@ -0,0 +1,164 @@ +# Service Fabric Mesh REST APIs + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Azure Service Fabric Mesh. + +Azure Service Fabric Mesh is fully managed service where developers can build and deploy mission critical applications without managing any infrastructure such as VMs, storage, or networking. Mesh is a serverless environment for applications built from microservices. + +[Azure Service Fabric](http://aka.ms/ServiceFabric) is a distributed systems platform that makes it easy to package, deploy, and manage scalable and reliable microservices. + + +--- +## Getting Started +To build the SDK for ServiceFabricManagementClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + +Following are the settings for using this specification with [AutoRest](https://aka.ms/autorest) tool to validation and optionally generate SDK. + +``` yaml +title: ServiceFabricMeshManagementClient +description: Service Fabric Mesh Management Client +openapi-type: arm +tag: package-2018-07-01-preview + +directive: + - suppress: RequiredPropertiesMissingInResourceModel + reason: Service is a proxy resource that is managed (created and updated) by including it in the application resource. The name is required by RP to manage those resources. The name is readOnly in the default resource schema so it is not serialized on the wire by AutoRest generated libraries. This is a bug on our RP and should be fixed. The inlined objects should be part of the application properties and not a seperate proxy resource. + - suppress: EnumInsteadOfBoolean + reason: The `readOnly` boolean schema is part of Azure Resource Manager common schema. + - suppress: TrackedResourcePatchOperation + reason: The patch operation is not implemented in the preview APIs. +``` +### Tag: package-2018-07-01-preview + +These settings apply only when `--tag=package-2018-07-01-preview` is specified on the command line. + + +``` yaml $(tag) == 'package-2018-07-01-preview' +input-file: +- Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.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-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_service_fabric_mesh'] +``` + + +## C# +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.ServiceFabricMesh + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/ServiceFabric/Management.ServiceFabricMesh/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.servicefabricmesh + package-name: azure-mgmt-servicefabricmesh +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-servicefabricmesh/azure/mgmt/servicefabricmesh +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-servicefabricmesh +``` +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: servicefabricmesh + clear-output-folder: true +``` +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-07-01-preview +``` + +### Tag: package-2018-07-01-preview and go + +These settings apply only when `--tag=package-2018-07-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-07-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/servicefabricmesh/mgmt/2018-07-01-preview/servicefabricmesh +``` +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.servicefabricmesh +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servicefabricmesh +``` +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-07-01-preview +``` +### Tag: package-2018-07-01-preview and java + +These settings apply only when `--tag=2018-07-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == '2018-07-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.servicefabricmesh.v2018_07_01_preview + output-folder: $(azure-libraries-for-java-folder)/servicefabricmesh/resource-manager/v2018_07_01_preview +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/servicefabricmesh/resource-manager/readme.nodejs.md b/specification/servicefabricmesh/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..a49f88016ae7 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/readme.nodejs.md @@ -0,0 +1,15 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-servicefabricmesh + package-version: 1.0.0-preview + output-folder: $(node-sdks-folder)/lib/services/serviceFabricMeshManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/servicefabricmesh/resource-manager/readme.ruby.md b/specification/servicefabricmesh/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..b0a04419da90 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/readme.ruby.md @@ -0,0 +1,28 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml $(ruby) +ruby: + package-name: azure_mgmt_service_fabric_mesh + package-version: "0.1.0" + azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-07-01-preview +``` + +### Tag: package-2018-07-01-preview and ruby + +These settings apply only when `--tag=package-2018-07-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-07-01-preview' && $(ruby) +namespace: "Azure::ServiceFabricMesh::Mgmt::V2018_07_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_service_fabric_mesh/lib +``` + diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CheckNameAvailability.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CheckNameAvailability.json index 4ed88178968c..8dca2c87bb84 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CheckNameAvailability.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CheckNameAvailability.json @@ -1,5 +1,6 @@ { "parameters": { + "location": "eastus", "parameters": { "type": "Microsoft.SignalRService/SignalR", "name": "my-signalr-service" 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 4d7ae72aa398..f0b90c9ae4ea 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 @@ -6,11 +6,13 @@ "key1": "value1" }, "sku": { - "name": "Basic_DS2", - "tier": "Basic", + "name": "Standard_S1", + "tier": "Standard", "capacity": 1 }, - "properties": {} + "properties": { + "hostNamePrefix": null + } }, "api-version": "2018-03-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", @@ -21,9 +23,9 @@ "201": { "body": { "sku": { - "name": "Basic_DS2", - "tier": "Basic", - "size": "DS2", + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", "capacity": 1 }, "properties": { @@ -31,7 +33,8 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002 + "serverPort": 5002, + "hostNamePrefix": null }, "location": "eastus", "tags": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Get.json index 099be827dbdb..e5c12304fdde 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Get.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Get.json @@ -19,7 +19,8 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002 + "serverPort": 5002, + "hostNamePrefix": null }, "location": "eastus", "tags": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListByResourceGroup.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListByResourceGroup.json index 6cc07738f2db..4cfc7fa8ce31 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListByResourceGroup.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListByResourceGroup.json @@ -20,7 +20,8 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002 + "serverPort": 5002, + "hostNamePrefix": null }, "location": "eastus", "tags": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListBySubscription.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListBySubscription.json index 344a811a8a6c..e30deedf1515 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListBySubscription.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListBySubscription.json @@ -19,7 +19,8 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002 + "serverPort": 5002, + "hostNamePrefix": null }, "location": "eastus", "tags": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Update.json index 830275237aba..e3f2b57999b5 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Update.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Update.json @@ -9,7 +9,9 @@ "tier": "Basic", "capacity": 1 }, - "properties": {} + "properties": { + "hostNamePrefix": null + } }, "api-version": "2018-03-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", @@ -30,7 +32,8 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002 + "serverPort": 5002, + "hostNamePrefix": null }, "location": "eastus", "tags": { 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 2f5857bb24e9..dbca05381e41 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 @@ -1,891 +1,902 @@ { "swagger": "2.0", "info": { - "version": "2018-03-01-preview", - "title": "SignalRManagementClient", - "description": "REST API for Azure SignalR Service" + "version": "2018-03-01-preview", + "title": "SignalRManagementClient", + "description": "REST API for Azure SignalR Service" }, "host": "management.azure.com", "schemes": [ - "https" + "https" ], "consumes": [ - "application/json" + "application/json" ], "produces": [ - "application/json" + "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": "Signalr_ListOperations", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" + "/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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListOperations": { + "$ref": "./examples/ListOperations.json" + } + } } - ], - "responses": { - "200": { - "description": "Success. The response describes the list of operations.", - "schema": { - "$ref": "#/definitions/OperationList" - } + }, + "/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" + } + } + }, + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ListOperations": { - "$ref": "./examples/ListOperations.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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListBySubscription": { + "$ref": "./examples/ListBySubscription.json" + } + } } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/checkNameAvailability": { - "post": { - "tags": [ - "SignalR" - ], - "description": "Checks that the SignalR name is valid and is not already in use.", - "operationId": "Signalr_CheckNameAvailability", - "parameters": [ - { - "name": "parameters", - "in": "body", - "description": "Parameters supplied to the operation.", - "required": false, - "schema": { - "$ref": "#/definitions/NameAvailabilityParameters" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" + }, + "/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" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListByResourceGroup": { + "$ref": "./examples/ListByResourceGroup.json" + } + } } - ], - "responses": { - "200": { - "description": "Success. The response describes the name availability.", - "schema": { - "$ref": "#/definitions/NameAvailability" - } + }, + "/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" + } + } + }, + "x-ms-examples": { + "ListKeys": { + "$ref": "./examples/ListKeys.json" + } + } } - }, - "x-ms-examples": { - "CheckNameAvailability": { - "$ref": "./examples/CheckNameAvailability.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 excuting 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" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RegenerateKey": { + "$ref": "./examples/RegenerateKey.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" + }, + "/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 describe the corresponding SingalR service.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + } + }, + "x-ms-examples": { + "Get": { + "$ref": "./examples/Get.json" + } + } }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Success. The response describes the list of SignalR services in the subscription.", - "schema": { - "$ref": "#/definitions/SignalRResourceList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ListBySubscription": { - "$ref": "./examples/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" + "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/SignalRCreateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "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 SingalR service is now updating and contains a Location header to query the operation result.." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CreateOrUpdate": { + "$ref": "./examples/CreateOrUpdate.json" + } + } }, - { - "$ref": "#/parameters/SubscriptionIdParameter" + "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." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete": { + "$ref": "./examples/Delete.json" + } + } }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success. The response describes the list of SignalR services in a resourceGroup.", - "schema": { - "$ref": "#/definitions/SignalRResourceList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ListByResourceGroup": { - "$ref": "./examples/ListByResourceGroup.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/SignalRUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a SingalR service which is not up-to-date.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update": { + "$ref": "./examples/Update.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" - } - } - }, - "x-ms-examples": { - "ListKeys": { - "$ref": "./examples/ListKeys.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" + } } - } - } - }, - "/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" + }, + "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" + }, + "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 + } } - ], - "responses": { - "201": { - "description": "Created and an async operation is excuting 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" - } + }, + "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" + } } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "RegenerateKey": { - "$ref": "./examples/RegenerateKey.json" + }, + "OperationProperties": { + "description": "Extra Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "The service specifications." + } } - } - } - }, - "/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" + }, + "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" + } + } } - ], - "responses": { - "200": { - "description": "Success. The response describe the corresponding SingalR service.", - "schema": { - "$ref": "#/definitions/SignalRResource" - } + }, + "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" + } } - }, - "x-ms-examples": { - "Get": { - "$ref": "./examples/Get.json" + }, + "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" + } } - } }, - "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/SignalRCreateParameters" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SignalRServiceName" + "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" + } } - ], - "responses": { - "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 SingalR service is now updating and contains a Location header to query the operation result.." + }, + "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" + } } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "CreateOrUpdate": { - "$ref": "./examples/CreateOrUpdate.json" + }, + "SignalRResource": { + "description": "A class represent a SignalR service resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "SKU of the service." + }, + "properties": { + "$ref": "#/definitions/SignalRProperties", + "description": "The properties of the service.", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resouce.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"", + "type": "string", + "readOnly": true + } } - } }, - "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" + "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" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } } - ], - "responses": { - "202": { - "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "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 resouce.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"", + "type": "string", + "readOnly": true + } }, - "204": { - "description": "Success. The response indicates the resource is already deleted." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete": { - "$ref": "./examples/Delete.json" + "x-ms-azure-resource": true + }, + "ResourceSku": { + "description": "The billing information of the resource.(e.g. basic vs. standard)", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU. This is typically a letter + number code, such as A0 or P3. Required (if sku is specified)", + "type": "string" + }, + "tier": { + "description": "Optional tier of this particular SKU. `Basic` is deprecated, use `Standard` instead for Basic tier", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "SignalRSkuTier", + "modelAsString": true + } + }, + "size": { + "description": "Optional, string. When the name field is the combination of tier and some other value, this would be the standalone code.", + "type": "string" + }, + "family": { + "description": "Optional, string. If the service has different generations of hardware, for the same SKU, then that can be captured here.", + "type": "string" + }, + "capacity": { + "format": "int32", + "description": "Optional, integer. If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not \r\npossible for the resource this may be omitted.", + "type": "integer" + } } - } }, - "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/SignalRUpdateParameters" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SignalRServiceName" + "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": { + "description": "Provisioning state of the resource.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Running", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": 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 accessibly port of the SignalR service which is designed for browser/client side usage.", + "type": "integer", + "readOnly": true + }, + "serverPort": { + "format": "int32", + "description": "The publicly accessibly port of the SignalR service which is designed for customer server side usage.", + "type": "integer", + "readOnly": true + } } - ], - "responses": { - "200": { - "description": "Success. The response describes a SingalR service which is not up-to-date.", - "schema": { - "$ref": "#/definitions/SignalRResource" - } - }, - "202": { - "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." + }, + "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" + } } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update": { - "$ref": "./examples/Update.json" + }, + "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" + } } - } - } - } - }, - "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" + }, + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", + "properties": { + "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 + } + } } - }, - "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" - }, - "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" + }, + "SignalRCreateParameters": { + "description": "Parameters for SignalR service create/update operation.\r\n\r\nKeep the same schema as AzSignalR.Models.SignalRResource", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SignalRUpdateParameters" + } + ], + "properties": { + "location": { + "description": "Azure GEO region: e.g. West US | East US | North Central US | South Central US | West Europe | North Europe | East Asia | Southeast Asia | etc. \r\nThe geo region of a resource never changes after it is created.", + "type": "string" + } } - } - } - }, - "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" - } - } - }, - "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" + }, + "SignalRUpdateParameters": { + "description": "Parameters for SignalR service update operation", + "type": "object", + "properties": { + "tags": { + "description": "A list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "The billing information of the resource.(e.g. basic vs. standard)" + }, + "properties": { + "$ref": "#/definitions/SignalRCreateOrUpdateProperties", + "description": "Settings used to provision or configure the resource", + "x-ms-client-flatten": false + } } - }, - "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", - "x-ms-client-name": "SignalrResourceList", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "sku": { - "$ref": "#/definitions/ResourceSku", - "x-ms-client-name": "signalrsku", - "description": "SKU of the service." - }, - "properties": { - "$ref": "#/definitions/SignalRProperties", - "description": "The properties of the service.", - "x-ms-client-flatten": true - }, - "id": { - "description": "Fully qualified resource Id for the resource.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "The name of the resouce.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"", - "type": "string", - "readOnly": 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.", + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, "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" - }, - "x-ms-mutability": [ - "read", - "create", - "update" + "enum": [ + "2018-03-01-preview" ] - } - } - }, - "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 resouce.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"", - "type": "string", - "readOnly": true - } }, - "x-ms-azure-resource": true - }, - "ResourceSku": { - "description": "The billing information of the resource.(e.g. basic vs. standard)", - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "The name of the SKU. This is typically a letter + number code, such as A0 or P3. Required (if sku is specified)", + "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" - }, - "tier": { - "description": "The tier of this particular SKU. Optional.", - "enum": [ - "Free", - "Basic", - "Premium" - ], - "type": "string", - "x-ms-enum": { - "name": "SignalRSkuTier", - "modelAsString": true - } - }, - "size": { - "description": "Optional, string. When the name field is the combination of tier and some other value, this would be the standalone code.", - "type": "string" - }, - "family": { - "description": "Optional, string. If the service has different generations of hardware, for the same SKU, then that can be captured here.", - "type": "string" - }, - "capacity": { - "format": "int32", - "description": "Optional, integer. If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not \r\npossible for the resource this may be omitted.", - "type": "integer" - } - } - }, - "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": { - "description": "Provisioning state of the resource.", - "enum": [ - "Succeeded", - "Failed", - "Canceled", - "Creating", - "Updating", - "Deleting", - "Moving" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": 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", + }, + "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", - "readOnly": true - }, - "publicPort": { - "format": "int32", - "description": "The publicly accessibly port of the SignalR service which is designed for browser/client side usage.", - "type": "integer", - "readOnly": true - }, - "serverPort": { - "format": "int32", - "description": "The publicly accessibly port of the SignalR service which is designed for customer server side usage.", - "type": "integer", - "readOnly": 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" - } - } - }, - "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" - } - } - }, - "RegenerateKeyParameters": { - "description": "Parameters describes the request to regenerate access keys", - "type": "object", - "properties": { - "keyType": { - "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).", - "enum": [ - "Primary", - "Secondary" - ], + "x-ms-parameter-location": "method" + }, + "SignalRServiceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the SignalR resource.", + "required": true, "type": "string", - "x-ms-enum": { - "name": "KeyType", - "modelAsString": true - } - } - } - }, - "SignalRCreateParameters": { - "description": "Parameters for SignalR service create/update operation.\r\n\r\nKeep the same schema as AzSignalR.Models.SignalRResource", - "required": [ - "location" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SignalRUpdateParameters" - } - ], - "properties": { - "location": { - "description": "Azure GEO region: e.g. West US | East US | North Central US | South Central US | West Europe | North Europe | East Asia | Southeast Asia | etc. \r\nThe geo region of a resource never changes after it is created.", - "type": "string" - } + "x-ms-parameter-location": "method" } - }, - "SignalRUpdateParameters": { - "description": "Parameters for SignalR service update operation", - "type": "object", - "properties": { - "tags": { - "description": "A list of key value pairs that describe the resource.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "sku": { - "$ref": "#/definitions/ResourceSku", - "description": "The billing information of the resource.(e.g. basic vs. standard)" - }, - "properties": { - "$ref": "#/definitions/SignalRCreateOrUpdateProperties", - "description": "Settings used to provision or configure the resource", - "x-ms-client-flatten": false - } - } - } - }, - "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" - } + "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" - ] - } + { + "azure_auth": [ + "user_impersonation" + ] + } ] } \ No newline at end of file diff --git a/specification/signalr/resource-manager/readme.md b/specification/signalr/resource-manager/readme.md index 6692ccb2e2c2..78b5fe25a292 100644 --- a/specification/signalr/resource-manager/readme.md +++ b/specification/signalr/resource-manager/readme.md @@ -51,8 +51,11 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_signalr'] ``` @@ -109,7 +112,7 @@ These settings apply only when `--tag=package-2018-03-01-preview --go` is specif Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-03-01-preview' && $(go) -output-folder: $(go-sdk-folder)/services/signalr/mgmt/2018-03-01-preview/signalr +output-folder: $(go-sdk-folder)/services/preview/signalr/mgmt/2018-03-01-preview/signalr ``` ## Java @@ -118,13 +121,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.signalr +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-signalr +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-03-01-preview +``` + +### Tag: package-2018-03-01-preview and java + +These settings apply only when `--tag=package-2018-03-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-03-01-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.signalr - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-signalr + namespace: com.microsoft.azure.management.signalr.v2018_03_01_preview + output-folder: $(azure-libraries-for-java-folder)/signalr/resource-manager/v2018_03_01_preview +regenerate-manager: true +generate-interface: true ``` ## C# @@ -140,4 +162,4 @@ csharp: namespace: Microsoft.Azure.Management.SignalR output-folder: $(csharp-sdks-folder)/SignalR/Management.SignalR/Generated clear-output-folder: true -``` \ No newline at end of file +``` diff --git a/specification/signalr/resource-manager/readme.nodejs.md b/specification/signalr/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..4daef37c8092 --- /dev/null +++ b/specification/signalr/resource-manager/readme.nodejs.md @@ -0,0 +1,15 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-signalr + package-version: 1.0.0-preview + output-folder: $(node-sdks-folder)/lib/services/signalrManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/signalr/resource-manager/readme.ruby.md b/specification/signalr/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..99aa01d7bc4a --- /dev/null +++ b/specification/signalr/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_signalr +package-version: "0.16.1" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-03-01-preview +``` + +### Tag: package-2018-03-01-preview and ruby + +These settings apply only when `--tag=package-2018-03-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-03-01-preview' && $(ruby) +namespace: "Azure::Signalr::Mgmt::V2018_03_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_signalr/lib +``` diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/advisors.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/advisors.json index 551024a77dcd..4d33219bb8ef 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/advisors.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/advisors.json @@ -486,38 +486,6 @@ } }, "definitions": { - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "AdvisorProperties": { "description": "Properties for a Database, Server or Elastic Pool Advisor.", "required": [ @@ -923,7 +891,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -949,7 +917,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { 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 new file mode 100644 index 000000000000..32ddc19328b7 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json @@ -0,0 +1,299 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-05-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}/auditingSettings/{blobAuditingPolicyName}": { + "get": { + "tags": [ + "BlobAuditing" + ], + "description": "Gets a database's blob auditing policy.", + "operationId": "DatabaseBlobAuditingPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/BlobAuditingPolicyNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the database blob auditing policy.", + "schema": { + "$ref": "#/definitions/DatabaseBlobAuditingPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "x-ms-examples": { + "Get a database's blob auditing policy": { + "$ref": "./examples/DatabaseBlobAuditingGet.json" + } + } + }, + "put": { + "tags": [ + "BlobAuditing" + ], + "description": "Creates or updates a database's blob auditing policy.", + "operationId": "DatabaseBlobAuditingPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/BlobAuditingPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The database blob auditing policy.", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseBlobAuditingPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully set the database blob auditing policy.", + "schema": { + "$ref": "#/definitions/DatabaseBlobAuditingPolicy" + } + }, + "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 BlobAuditingInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.\n\n * 400 BlobAuditingStorageAccountIsDisabled - The provided storage account is disabled.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\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 * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + }, + "201": { + "description": "Successfully created the database blob auditing policy.", + "schema": { + "$ref": "#/definitions/DatabaseBlobAuditingPolicy" + } + } + }, + "x-ms-examples": { + "Create or update a database's blob auditing policy with minimal parameters": { + "$ref": "./examples/DatabaseBlobAuditingCreateMin.json" + }, + "Create or update a database's blob auditing policy with all parameters": { + "$ref": "./examples/DatabaseBlobAuditingCreateMax.json" + } + } + } + } + }, + "definitions": { + "DatabaseBlobAuditingPolicyProperties": { + "description": "Properties of a database blob auditing policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "BlobAuditingPolicyState", + "modelAsString": false + } + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the auditing storage account. If state is Enabled, storageAccountAccessKey is required.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the audit logs.", + "type": "integer" + }, + "auditActionsAndGroups": { + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n ON BY \r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE:: and SCHEMA:: are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "type": "array", + "items": { + "type": "string" + } + }, + "storageAccountSubscriptionId": { + "format": "uuid", + "description": "Specifies the blob storage subscription Id.", + "type": "string" + }, + "isStorageSecondaryKeyInUse": { + "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", + "type": "boolean" + } + } + }, + "DatabaseBlobAuditingPolicy": { + "description": "A database blob auditing policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "description": "Resource kind.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/DatabaseBlobAuditingPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": 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" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "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" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditingPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditingPolicies.json index 92b1c570230f..3cf853992136 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditingPolicies.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditingPolicies.json @@ -208,44 +208,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "DatabaseBlobAuditingPolicy": { "description": "A database blob auditing policy.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json index c781a5f5f378..0b3a16bfc6c5 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json @@ -210,44 +210,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "DatabaseAutomaticTuning": { "description": "Database-level Automatic Tuning.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json index 2222dfcc3533..f830b727a15b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json @@ -239,44 +239,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "EncryptionProtector": { "description": "The server encryption protector.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { 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 new file mode 100644 index 000000000000..302e706e28fb --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMax.json @@ -0,0 +1,75 @@ +{ + "parameters" : { + "subscriptionId" : "20D7082A-0FC7-4468-82BD-542694D5042B", + "resourceGroupName" : "testrg", + "managedInstanceName" : "testinstance", + "api-version" : "2015-05-01-preview", + "parameters" : { + "tags" : { + "tagKey1" : "TagValue1" + }, + "location" : "Japan East", + "sku" : { + "name" : "CLS3", + "tier" : "Standard", + "capacity" : 1 + }, + "properties" : { + "fullyQualifiedDomainName" : "testinstance.database.windows.net", + "administratorLogin" : "dummylogin", + "administratorLoginPassword" : "Un53cuRE!", + "subnetId" : "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vCores": 8, + "storageSizeInGB": 1024, + "licenseType": "Full" + } + } + }, + "responses" : { + "200" : { + "body" : { + "tags" : { + "tagKey1" : "TagValue1" + }, + "id" : "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance1", + "name" : "testinstance1", + "type" : "Microsoft.Sql/managedInstances", + "location" : "japaneast", + "sku" : { + "name" : "CLS3", + "tier" : "Standard", + "capacity" : 1 + }, + "properties" : { + "fullyQualifiedDomainName" : "testinstance.database.windows.net", + "administratorLogin" : "dummylogin", + "subnetId" : "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "state" : "Ready" + } + } + }, + "201" : { + "body" : { + "tags" : { + "tagKey1" : "TagValue1" + }, + "id" : "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance2", + "name" : "testinstance2", + "type" : "Microsoft.Sql/managedInstances", + "location" : "japaneast", + "sku" : { + "name" : "CLS3", + "tier" : "Standard", + "capacity" : 1 + }, + "properties" : { + "fullyQualifiedDomainName" : "testinstance.database.windows.net", + "administratorLogin" : "dummylogin", + "subnetId" : "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "state" : "Ready" + } + } + }, + "202" : {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMin.json new file mode 100644 index 000000000000..beda44eea784 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMin.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId" : "20D7082A-0FC7-4468-82BD-542694D5042B", + "resourceGroupName" : "testrg", + "managedInstanceName" : "testinstance", + "api-version": "2015-05-01-preview", + "parameters": { + "properties": { + "administratorLogin": "dummylogin", + "administratorLoginPassword": "Un53cuRE!" + }, + "location": "Japan East" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance", + "name": "testinstance", + "type": "Microsoft.Sql/managedInstances", + "location": "japaneast", + "sku" : { + "name" : "CLS3", + "tier" : "Standard", + "capacity" : 1 + }, + "properties": { + "fullyQualifiedDomainName": "testinstance.database.windows.net", + "administratorLogin": "dummylogin", + "state": "Ready" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance", + "name": "testinstance", + "type": "Microsoft.Sql/managedInstances", + "location": "japaneast", + "sku" : { + "name" : "CLS3", + "tier" : "Standard", + "capacity" : 1 + }, + "properties": { + "fullyQualifiedDomainName": "testinstance.database.windows.net", + "administratorLogin": "dummylogin", + "state": "Ready" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceDelete.json new file mode 100644 index 000000000000..1b1db6fb5f6a --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceDelete.json @@ -0,0 +1,17 @@ +{ + "parameters" : { + "subscriptionId" : "20D7082A-0FC7-4468-82BD-542694D5042B", + "resourceGroupName" : "testrg", + "managedInstanceName" : "testinstance", + "api-version" : "2015-05-01-preview" + }, + "responses" : { + "200" : { + "body" : "" + }, + "202" : {}, + "204" : { + "body" : "" + } + } +} \ No newline at end of file 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 new file mode 100644 index 000000000000..cb1f257242f5 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceGet.json @@ -0,0 +1,33 @@ +{ + "parameters" : { + "subscriptionId" : "20d7082a-0fc7-4468-82bd-542694d5042b", + "resourceGroupName" : "testrg", + "managedInstanceName" : "testcl", + "api-version" : "2015-05-01-preview" + }, + "responses" : { + "200" : { + "body" : { + "sku" : { + "name" : "CLS3", + "tier" : "Standard", + "capacity": 1, + "family":"Gen4" + }, + "properties" : { + "fullyQualifiedDomainName" : "testcl.database.windows.net", + "administratorLogin": "cloudSA", + "state": "Ready", + "vCores": 8, + "storageSizeInGB": 1024, + "licenseType": "Full" + + }, + "location" : "onebox", + "id" : "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl", + "name" : "testcl", + "type" : "Microsoft.Sql/managedInstances" + } + } + } +} \ No newline at end of file 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 new file mode 100644 index 000000000000..91418cef315f --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceList.json @@ -0,0 +1,50 @@ +{ + "parameters" : { + "subscriptionId": "20D7082A-0FC7-4468-82BD-542694D5042B", + "api-version" : "2015-05-01-preview" + }, + "responses" : { + "200" : { + "body" : { + "value" : [{ + "location" : "onebox", + "id" : "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testcl", + "name" : "testcl", + "type": "Microsoft.Sql/managedInstances", + "sku" : { + "name" : "CLS3", + "tier" : "Standard", + "capacity" : 1 + }, + "properties" : { + "fullyQualifiedDomainName" : "testcl.database.windows.net", + "administratorLogin" : "cloudSA", + "state": "Ready", + "vCores": 8, + "storageSizeInGB": 1024, + "licenseType": "Full" + } + }, { + "location" : "onebox", + "id" : "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testcl2", + "name" : "testcl2", + "type": "Microsoft.Sql/managedInstances", + "sku" : { + "name" : "CLS15", + "tier" : "Standard", + "capacity" : 22 + }, + "properties" : { + "fullyQualifiedDomainName" : "testcl2.database.windows.net", + "administratorLogin" : "cloudSA", + "state": "Ready", + "vCores": 8, + "storageSizeInGB": 1024, + "licenseType": "Full" + } + } + ] + } + } + } +} \ No newline at end of file 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 new file mode 100644 index 000000000000..9995b41f70d5 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters" : { + "subscriptionId": "20D7082A-0FC7-4468-82BD-542694D5042B", + "resourceGroupName" : "Test1", + "api-version" : "2015-05-01-preview" + }, + "responses" : { + "200" : { + "body" : { + "value" : [{ + "location" : "onebox", + "id" : "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testcl", + "name" : "testcl", + "type": "Microsoft.Sql/managedInstances", + "sku" : { + "name" : "CLS3", + "tier" : "Standard", + "capacity" : 1, + "family":"Gen5" + }, + "properties" : { + "fullyQualifiedDomainName" : "testcl.database.windows.net", + "administratorLogin" : "cloudSA", + "state": "Ready", + "vCores": 8, + "storageSizeInGB": 1024, + "licenseType": "Full" + } + }, { + "location" : "onebox", + "id" : "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testcl2", + "name" : "testcl2", + "type": "Microsoft.Sql/managedInstances", + "sku" : { + "name" : "CLS15", + "tier" : "Standard", + "capacity" : 22, + "family":"Gen4" + }, + "properties" : { + "fullyQualifiedDomainName" : "testcl2.database.windows.net", + "administratorLogin" : "cloudSA", + "state": "Ready", + "vCores": 8, + "storageSizeInGB": 1024, + "licenseType": "Full" + } + } + ] + } + } + } +} \ No newline at end of file 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 new file mode 100644 index 000000000000..c15b0a36e799 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceUpdateMax.json @@ -0,0 +1,49 @@ +{ + "parameters" : { + "subscriptionId" : "20D7082A-0FC7-4468-82BD-542694D5042B", + "resourceGroupName" : "testrg", + "managedInstanceName" : "testinstance", + "api-version" : "2015-05-01-preview", + "parameters" : { + "tags" : { + "tagKey1" : "TagValue1" + }, + "sku" : { + "name" : "CLS3", + "tier" : "Standard", + "capacity" : 1 + }, + "properties" : { + "fullyQualifiedDomainName" : "testinstance.database.windows.net", + "administratorLogin" : "dummylogin", + "administratorLoginPassword" : "Un53cuRE!", + "subnetId" : "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + }, + "responses" : { + "200" : { + "body" : { + "tags" : { + "tagKey1" : "TagValue1" + }, + "id" : "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance1", + "name" : "testinstance1", + "type" : "Microsoft.Sql/managedInstances", + "location" : "japaneast", + "sku" : { + "name" : "CLS3", + "tier" : "Standard", + "capacity" : 1 + }, + "properties" : { + "fullyQualifiedDomainName" : "testinstance.database.windows.net", + "administratorLogin" : "dummylogin", + "subnetId" : "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "state" : "Ready" + } + } + }, + "202" : {} + } +} 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 new file mode 100644 index 000000000000..78a2c3b9f7d5 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceUpdateMin.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId" : "20D7082A-0FC7-4468-82BD-542694D5042B", + "resourceGroupName" : "testrg", + "managedInstanceName" : "testinstance", + "api-version": "2015-05-01-preview", + "parameters": { + "tags": { + "tagKey1": "TagValue1" + } + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "id": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance", + "name": "testinstance", + "type": "Microsoft.Sql/managedInstances", + "location": "japaneast", + "sku" : { + "name" : "CLS3", + "tier" : "Standard", + "capacity" : 1 + }, + "properties": { + "fullyQualifiedDomainName": "testinstance.database.windows.net", + "administratorLogin": "dummylogin", + "state": "Ready" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json index 30041b08e990..478a3e56320d 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json @@ -531,44 +531,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "FailoverGroup": { "description": "A failover group.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { 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 new file mode 100644 index 000000000000..aa2587737227 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json @@ -0,0 +1,507 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-05-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/managedInstances": { + "get": { + "tags": [ + "ManagedInstances" + ], + "description": "Gets a list of all managed instances in the subscription.", + "operationId": "ManagedInstances_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of managed instances.", + "schema": { + "$ref": "#/definitions/ManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List managed instances": { + "$ref": "./examples/ManagedInstanceList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances": { + "get": { + "tags": [ + "ManagedInstances" + ], + "description": "Gets a list of managed instances in a resource group.", + "operationId": "ManagedInstances_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of managed instances.", + "schema": { + "$ref": "#/definitions/ManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveManagedInstance - The requested managed instance was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - 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." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List managed instances by resource group": { + "$ref": "./examples/ManagedInstanceListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}": { + "get": { + "tags": [ + "ManagedInstances" + ], + "description": "Gets a managed instance.", + "operationId": "ManagedInstances_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified managed instance.", + "schema": { + "$ref": "#/definitions/ManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveManagedInstance - The requested managed instance was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - 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." + } + }, + "x-ms-examples": { + "Get managed instance": { + "$ref": "./examples/ManagedInstanceGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedInstances" + ], + "description": "Creates or updates a managed instance.", + "operationId": "ManagedInstances_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested managed instance resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedInstance" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the managed instance.", + "schema": { + "$ref": "#/definitions/ManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\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 TokenTooLong - The provided token is too long.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveManagedInstance - The requested managed instance was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation." + }, + "202": { + "description": "Accepted" + }, + "201": { + "description": "Successfully created the managed instance.", + "schema": { + "$ref": "#/definitions/ManagedInstance" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create managed instance with minimal properties": { + "$ref": "./examples/ManagedInstanceCreateMin.json" + }, + "Create managed instance with all properties": { + "$ref": "./examples/ManagedInstanceCreateMax.json" + } + } + }, + "delete": { + "tags": [ + "ManagedInstances" + ], + "description": "Deletes a managed instance.", + "operationId": "ManagedInstances_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the managed instance." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveManagedInstance - The requested managed instance was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.\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 * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.\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 * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "The specified managed instance does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete managed instance": { + "$ref": "./examples/ManagedInstanceDelete.json" + } + } + }, + "patch": { + "tags": [ + "ManagedInstances" + ], + "description": "Updates a managed instance.", + "operationId": "ManagedInstances_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested managed instance resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedInstanceUpdate" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the managed instance.", + "schema": { + "$ref": "#/definitions/ManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 VnetAddressRangeError - Virtual network address range is invalid.\n\n * 400 VnetConfigIsNotAllowed - Virtual network configuration is not allowed.\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidLoginName - The provided login name is invalid.\n\n * 400 PasswordTooShort - The provided password is too short\n\n * 400 PasswordTooLong - The provided password is too long.\n\n * 400 NameAlreadyExists - The provided name already exists.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\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 TokenTooLong - The provided token is too long.\n\n * 400 InvalidLocation - An invalid location was specified.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSubnetResourceId - The provided subnet resource ID for the managed instance create or update is invalid.\n\n * 400 VnetInWrongRegion - Virtual network is in wrong region.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 InvalidUsername - Supplied user name contains invalid characters.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveManagedInstance - The requested managed instance was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ServerQuotaExceeded - Server cannot be added to a subscription because it will exceed quota.\n\n * 409 ServerAlreadyExists - Duplicate server name.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update managed instance with minimal properties": { + "$ref": "./examples/ManagedInstanceUpdateMin.json" + }, + "Update managed instance with all properties": { + "$ref": "./examples/ManagedInstanceUpdateMax.json" + } + } + } + } + }, + "definitions": { + "ManagedInstanceListResult": { + "description": "A list of managed instances.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedInstanceProperties": { + "description": "The properties of a managed instance.", + "type": "object", + "properties": { + "fullyQualifiedDomainName": { + "description": "The fully qualified domain name of the managed instance.", + "type": "string", + "readOnly": true + }, + "administratorLogin": { + "description": "Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "administratorLoginPassword": { + "description": "The administrator login password (required for managed instance creation).", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "subnetId": { + "description": "Subnet resource ID for the managed instance.", + "type": "string" + }, + "state": { + "description": "The state of the managed instance.", + "type": "string", + "readOnly": true + }, + "licenseType": { + "description": "The license type. Possible values are 'LicenseIncluded' and 'BasePrice'.", + "type": "string" + }, + "vCores": { + "format": "int32", + "description": "The number of VCores.", + "type": "integer" + }, + "storageSizeInGB": { + "format": "int32", + "description": "The maximum storage size in GB.", + "type": "integer" + } + } + }, + "ManagedInstance": { + "description": "An Azure SQL managed instance.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "$ref": "../../../common/v1/types.json#/definitions/ResourceIdentity", + "description": "The Azure Active Directory identity of the managed instance.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sku": { + "$ref": "../../../common/v1/types.json#/definitions/Sku", + "description": "Managed instance sku" + }, + "properties": { + "$ref": "#/definitions/ManagedInstanceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ManagedInstanceUpdate": { + "description": "An update request for an Azure SQL Database managed instance.", + "type": "object", + "properties": { + "sku": { + "$ref": "../../../common/v1/types.json#/definitions/Sku", + "description": "Managed instance sku" + }, + "properties": { + "$ref": "#/definitions/ManagedInstanceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "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" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "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" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json index 7496e64c061f..eddac31684e7 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json @@ -275,44 +275,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "ServerKey": { "description": "A server key.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/servers.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/servers.json index 2b6e9046d2a2..a0a386c83c18 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/servers.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/servers.json @@ -304,35 +304,6 @@ } } }, - "ResourceIdentity": { - "description": "Azure Active Directory identity configuration for a resource.", - "type": "object", - "properties": { - "principalId": { - "format": "uuid", - "description": "The Azure Active Directory principal id.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.", - "enum": [ - "SystemAssigned" - ], - "type": "string", - "x-ms-enum": { - "name": "IdentityType", - "modelAsString": true - } - }, - "tenantId": { - "format": "uuid", - "description": "The Azure Active Directory tenant id.", - "type": "string", - "readOnly": true - } - } - }, "ServerProperties": { "description": "The properties of a server.", "type": "object", @@ -369,57 +340,6 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "ARM tracked top level resource.", - "required": [ - "location" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "Resource location.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, "Server": { "description": "An Azure SQL Database server.", "required": [ @@ -428,12 +348,12 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../common/v1/types.json#/definitions/TrackedResource" } ], "properties": { "identity": { - "$ref": "#/definitions/ResourceIdentity", + "$ref": "../../../common/v1/types.json#/definitions/ResourceIdentity", "description": "The Azure Active Directory identity of the server.", "x-ms-mutability": [ "read", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json index 5da0e3ce7f0d..fb223eb22bc2 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json @@ -390,44 +390,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "SyncAgent": { "description": "An Azure SQL Database sync agent.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -536,7 +504,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json index 0167df498d45..aeffda81a886 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json @@ -948,28 +948,6 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, "SyncGroupSchemaTable": { "description": "Properties of table in sync group schema.", "type": "object", @@ -1005,22 +983,12 @@ } } }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "SyncGroup": { "description": "An Azure SQL Database sync group.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json index fa01a242cfdd..419a1b9835d4 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json @@ -560,44 +560,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "SyncMember": { "description": "An Azure SQL Database sync member.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/usages.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/usages.json index 2d578bd03300..9508cd8d5489 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/usages.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/usages.json @@ -155,44 +155,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "SubscriptionUsage": { "description": "Usage Metric of a Subscription in a Location.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json index 5d6ca4a3227c..c220bbf2fca3 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json @@ -250,44 +250,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "VirtualNetworkRule": { "description": "A virtual network rule.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { 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 new file mode 100644 index 000000000000..916da093d4f3 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json @@ -0,0 +1,851 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-03-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}/extendedAuditingSettings/{blobAuditingPolicyName}": { + "get": { + "tags": [ + "BlobAuditing" + ], + "description": "Gets an extended database's blob auditing policy.", + "operationId": "ExtendedDatabaseBlobAuditingPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/BlobAuditingPolicyNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the extended database blob auditing policy.", + "schema": { + "$ref": "#/definitions/ExtendedDatabaseBlobAuditingPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "x-ms-examples": { + "Get an extended database's blob auditing policy": { + "$ref": "./examples/ExtendedDatabaseBlobAuditingGet.json" + } + } + }, + "put": { + "tags": [ + "BlobAuditing" + ], + "description": "Creates or updates an extended database's blob auditing policy.", + "operationId": "ExtendedDatabaseBlobAuditingPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/BlobAuditingPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The extended database blob auditing policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ExtendedDatabaseBlobAuditingPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully set the extended database blob auditing policy.", + "schema": { + "$ref": "#/definitions/ExtendedDatabaseBlobAuditingPolicy" + } + }, + "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 BlobAuditingInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.\n\n * 400 BlobAuditingStorageAccountIsDisabled - The provided storage account is disabled.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\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 * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + }, + "201": { + "description": "Successfully created the extended database blob auditing policy.", + "schema": { + "$ref": "#/definitions/ExtendedDatabaseBlobAuditingPolicy" + } + } + }, + "x-ms-examples": { + "Create or update an extended database's blob auditing policy with minimal parameters": { + "$ref": "./examples/ExtendedDatabaseBlobAuditingCreateMin.json" + }, + "Create or update an extended database's blob auditing policy with all parameters": { + "$ref": "./examples/ExtendedDatabaseBlobAuditingCreateMax.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/extendedAuditingSettings/{blobAuditingPolicyName}": { + "get": { + "tags": [ + "BlobAuditing" + ], + "description": "Gets an extended server's blob auditing policy.", + "operationId": "ExtendedServerBlobAuditingPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BlobAuditingPolicyNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the extended server blob auditing policy.", + "schema": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-examples": { + "Get a server's blob extended auditing policy": { + "$ref": "./examples/ExtendedServerBlobAuditingGet.json" + } + } + }, + "put": { + "tags": [ + "BlobAuditing" + ], + "description": "Creates or updates an extended server's blob auditing policy.", + "operationId": "ExtendedServerBlobAuditingPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BlobAuditingPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Properties of extended blob auditing policy", + "required": true, + "schema": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the extended auditing settings.", + "schema": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicy" + } + }, + "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 * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 409 ServerBlobAuditingPolicyInProgress - Set server blob auditing is already in progress." + }, + "202": { + "description": "Updating the extended auditing settings is in progress." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a server's extended blob auditing policy with all parameters": { + "$ref": "./examples/ExtendedServerBlobAuditingCreateMax.json" + }, + "Update a server's extended blob auditing policy with minimal parameters": { + "$ref": "./examples/ExtendedServerBlobAuditingCreateMin.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/auditingSettings/{blobAuditingPolicyName}": { + "get": { + "tags": [ + "BlobAuditing" + ], + "description": "Gets a server's blob auditing policy.", + "operationId": "ServerBlobAuditingPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BlobAuditingPolicyNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server blob auditing policy.", + "schema": { + "$ref": "#/definitions/ServerBlobAuditingPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-examples": { + "Get a server's blob auditing policy": { + "$ref": "./examples/ServerBlobAuditingGet.json" + } + } + }, + "put": { + "tags": [ + "BlobAuditing" + ], + "description": "Creates or updates a server's blob auditing policy.", + "operationId": "ServerBlobAuditingPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BlobAuditingPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Properties of blob auditing policy", + "required": true, + "schema": { + "$ref": "#/definitions/ServerBlobAuditingPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the auditing settings.", + "schema": { + "$ref": "#/definitions/ServerBlobAuditingPolicy" + } + }, + "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 * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 409 ServerBlobAuditingPolicyInProgress - Set server blob auditing is already in progress." + }, + "202": { + "description": "Updating the auditing settings is in progress." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a server's blob auditing policy with all parameters": { + "$ref": "./examples/ServerBlobAuditingCreateMax.json" + }, + "Update a server's blob auditing policy with minimal parameters": { + "$ref": "./examples/ServerBlobAuditingCreateMin.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/auditingSettings/{blobAuditingPolicyName}": { + "get": { + "tags": [ + "BlobAuditing" + ], + "description": "Gets a database's blob auditing policy.", + "operationId": "DatabaseBlobAuditingPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/BlobAuditingPolicyNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the database blob auditing policy.", + "schema": { + "$ref": "#/definitions/DatabaseBlobAuditingPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "x-ms-examples": { + "Get a database's blob auditing policy": { + "$ref": "./examples/DatabaseBlobAuditingGet.json" + } + } + }, + "put": { + "tags": [ + "BlobAuditing" + ], + "description": "Creates or updates a database's blob auditing policy.", + "operationId": "DatabaseBlobAuditingPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/BlobAuditingPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The database blob auditing policy.", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseBlobAuditingPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully set the database blob auditing policy.", + "schema": { + "$ref": "#/definitions/DatabaseBlobAuditingPolicy" + } + }, + "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 BlobAuditingInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.\n\n * 400 BlobAuditingStorageAccountIsDisabled - The provided storage account is disabled.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\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 * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + }, + "201": { + "description": "Successfully created the database blob auditing policy.", + "schema": { + "$ref": "#/definitions/DatabaseBlobAuditingPolicy" + } + } + }, + "x-ms-examples": { + "Create or update a database's blob auditing policy with minimal parameters": { + "$ref": "./examples/DatabaseBlobAuditingCreateMin.json" + }, + "Create or update a database's blob auditing policy with all parameters": { + "$ref": "./examples/DatabaseBlobAuditingCreateMax.json" + } + } + } + } + }, + "definitions": { + "ExtendedDatabaseBlobAuditingPolicyProperties": { + "description": "Properties of an extended database blob auditing policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "predicateExpression": { + "description": "Specifies condition of where clause when creating an audit.", + "type": "string" + }, + "state": { + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "BlobAuditingPolicyState", + "modelAsString": false + } + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the auditing storage account. If state is Enabled, storageAccountAccessKey is required.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the audit logs.", + "type": "integer" + }, + "auditActionsAndGroups": { + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n ON BY \r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE:: and SCHEMA:: are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "type": "array", + "items": { + "type": "string" + } + }, + "storageAccountSubscriptionId": { + "format": "uuid", + "description": "Specifies the blob storage subscription Id.", + "type": "string" + }, + "isStorageSecondaryKeyInUse": { + "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", + "type": "boolean" + } + } + }, + "Resource": { + "description": "ARM resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "ARM proxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "ExtendedDatabaseBlobAuditingPolicy": { + "description": "An extended database blob auditing policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ExtendedDatabaseBlobAuditingPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ExtendedServerBlobAuditingPolicyProperties": { + "description": "Properties of an extended server blob auditing policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "predicateExpression": { + "description": "Specifies condition of where clause when creating an audit.", + "type": "string" + }, + "state": { + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "BlobAuditingPolicyState", + "modelAsString": false + } + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the auditing storage account. If state is Enabled, storageAccountAccessKey is required.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the audit logs.", + "type": "integer" + }, + "auditActionsAndGroups": { + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n ON BY \r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE:: and SCHEMA:: are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "type": "array", + "items": { + "type": "string" + } + }, + "storageAccountSubscriptionId": { + "format": "uuid", + "description": "Specifies the blob storage subscription Id.", + "type": "string" + }, + "isStorageSecondaryKeyInUse": { + "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", + "type": "boolean" + } + } + }, + "ExtendedServerBlobAuditingPolicy": { + "description": "An extended server blob auditing policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ExtendedServerBlobAuditingPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ServerBlobAuditingPolicyProperties": { + "description": "Properties of a server blob auditing policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "BlobAuditingPolicyState", + "modelAsString": false + } + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the auditing storage account. If state is Enabled, storageAccountAccessKey is required.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the audit logs.", + "type": "integer" + }, + "auditActionsAndGroups": { + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n ON BY \r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE:: and SCHEMA:: are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "type": "array", + "items": { + "type": "string" + } + }, + "storageAccountSubscriptionId": { + "format": "uuid", + "description": "Specifies the blob storage subscription Id.", + "type": "string" + }, + "isStorageSecondaryKeyInUse": { + "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", + "type": "boolean" + } + } + }, + "ServerBlobAuditingPolicy": { + "description": "A server blob auditing policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServerBlobAuditingPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "DatabaseBlobAuditingPolicyProperties": { + "description": "Properties of a database blob auditing policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "BlobAuditingPolicyState", + "modelAsString": false + } + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the auditing storage account. If state is Enabled, storageAccountAccessKey is required.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the audit logs.", + "type": "integer" + }, + "auditActionsAndGroups": { + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n ON BY \r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE:: and SCHEMA:: are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "type": "array", + "items": { + "type": "string" + } + }, + "storageAccountSubscriptionId": { + "format": "uuid", + "description": "Specifies the blob storage subscription Id.", + "type": "string" + }, + "isStorageSecondaryKeyInUse": { + "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", + "type": "boolean" + } + } + }, + "DatabaseBlobAuditingPolicy": { + "description": "A database blob auditing policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "description": "Resource kind.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/DatabaseBlobAuditingPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": 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" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "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" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json index 34aaf23d5bf2..92c259a2f671 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json @@ -222,22 +222,12 @@ } } }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "DatabaseOperation": { "description": "A database operation.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -247,28 +237,6 @@ "x-ms-client-flatten": true } } - }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true } }, "parameters": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json index 2f5edfd5272f..ccd361e0df59 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json @@ -86,44 +86,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "DataWarehouseUserActivities": { "description": "User activities of a data warehouse", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json new file mode 100644 index 000000000000..994880c297fc --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json @@ -0,0 +1,414 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-03-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}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/rules/{ruleId}/baselines/{baselineName}": { + "get": { + "tags": [ + "DatabaseVulnerabilityAssesmentRuleBaselines" + ], + "description": "Gets a database's vulnerability assessment rule baseline.", + "operationId": "DatabaseVulnerabilityAssessmentRuleBaselines_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database for which the vulnerability assessment rule baseline is defined.", + "required": true, + "type": "string" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "ruleId", + "in": "path", + "description": "The vulnerability assessment rule ID.", + "required": true, + "type": "string" + }, + { + "name": "baselineName", + "in": "path", + "description": "The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule).", + "required": true, + "type": "string", + "enum": [ + "master", + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentPolicyBaselineName", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully got the vulnerability assessment rule baseline.", + "schema": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessmentRuleBaseline" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "x-ms-examples": { + "Gets a database's vulnerability assessment rule baseline.": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentRuleBaselineGet.json" + } + } + }, + "put": { + "tags": [ + "DatabaseVulnerabilityAssesmentRuleBaselines" + ], + "description": "Creates or updates a database's vulnerability assessment rule baseline.", + "operationId": "DatabaseVulnerabilityAssessmentRuleBaselines_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database for which the vulnerability assessment rule baseline is defined.", + "required": true, + "type": "string" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "ruleId", + "in": "path", + "description": "The vulnerability assessment rule ID.", + "required": true, + "type": "string" + }, + { + "name": "baselineName", + "in": "path", + "description": "The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule).", + "required": true, + "type": "string", + "enum": [ + "master", + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentPolicyBaselineName", + "modelAsString": false + } + }, + { + "name": "parameters", + "in": "body", + "description": "The requested rule baseline resource.", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessmentRuleBaseline" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully set the vulnerability assessment rule baseline.", + "schema": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessmentRuleBaseline" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "x-ms-examples": { + "Creates or updates a database's vulnerability assessment rule baseline.": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentRuleBaselineCreate.json" + } + } + }, + "delete": { + "tags": [ + "DatabaseVulnerabilityAssesmentRuleBaselines" + ], + "description": "Removes the database's vulnerability assessment rule baseline.", + "operationId": "DatabaseVulnerabilityAssessmentRuleBaselines_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database for which the vulnerability assessment rule baseline is defined.", + "required": true, + "type": "string" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "ruleId", + "in": "path", + "description": "The vulnerability assessment rule ID.", + "required": true, + "type": "string" + }, + { + "name": "baselineName", + "in": "path", + "description": "The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule).", + "required": true, + "type": "string", + "enum": [ + "master", + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentPolicyBaselineName", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed the database vulnerability assessment rule baseline." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "x-ms-examples": { + "Removes a database's vulnerability assessment rule baseline.": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentRuleBaselineDelete.json" + } + } + } + } + }, + "definitions": { + "DatabaseVulnerabilityAssessmentRuleBaselineProperties": { + "description": "Properties of a database Vulnerability Assessment rule baseline.", + "required": [ + "baselineResults" + ], + "type": "object", + "properties": { + "baselineResults": { + "description": "The rule baseline result", + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessmentRuleBaselineItem" + } + } + } + }, + "DatabaseVulnerabilityAssessmentRuleBaselineItem": { + "description": "Properties for an Azure SQL Database Vulnerability Assessment rule baseline's result.", + "required": [ + "result" + ], + "type": "object", + "properties": { + "result": { + "description": "The rule baseline result", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DatabaseVulnerabilityAssessmentRuleBaseline": { + "description": "A database vulnerability assessment rule baseline.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessmentRuleBaselineProperties", + "description": "Resource properties.", + "x-ms-client-flatten": 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" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "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" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json new file mode 100644 index 000000000000..b21e461b321b --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json @@ -0,0 +1,377 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-03-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}/vulnerabilityAssessments/{vulnerabilityAssessmentName}": { + "get": { + "tags": [ + "DatabaseVulnerabilityAssessments" + ], + "description": "Gets the database's vulnerability assessment.", + "operationId": "DatabaseVulnerabilityAssessments_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database for which the vulnerability assessment is defined.", + "required": true, + "type": "string" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the database vulnerability assessment.", + "schema": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessment" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "x-ms-examples": { + "Get a database's vulnerability assessment": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentGet.json" + } + } + }, + "put": { + "tags": [ + "DatabaseVulnerabilityAssessments" + ], + "description": "Creates or updates the database's vulnerability assessment.", + "operationId": "DatabaseVulnerabilityAssessments_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database for which the vulnerability assessment is defined.", + "required": true, + "type": "string" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The requested resource.", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessment" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully set the vulnerability assessment.", + "schema": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessment" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature is not valid.\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + }, + "201": { + "description": "Successfully created the vulnerability assessment.", + "schema": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessment" + } + } + }, + "x-ms-examples": { + "Create a database's vulnerability assessment with all parameters": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentCreateMax.json" + }, + "Create a database's vulnerability assessment with minimal parameters": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentCreateMin.json" + } + } + }, + "delete": { + "tags": [ + "DatabaseVulnerabilityAssessments" + ], + "description": "Removes the database's vulnerability assessment.", + "operationId": "DatabaseVulnerabilityAssessments_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database for which the vulnerability assessment is defined.", + "required": true, + "type": "string" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed the database vulnerability assessment." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "x-ms-examples": { + "Remove a database's vulnerability assessment": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentDelete.json" + } + } + } + } + }, + "definitions": { + "DatabaseVulnerabilityAssessmentProperties": { + "description": "Properties of a database Vulnerability Assessment.", + "required": [ + "storageContainerPath", + "storageContainerSasKey" + ], + "type": "object", + "properties": { + "storageContainerPath": { + "description": "A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "storageContainerSasKey": { + "description": "A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "recurringScans": { + "$ref": "#/definitions/VulnerabilityAssessmentRecurringScansProperties", + "description": "The recurring scans settings" + } + } + }, + "VulnerabilityAssessmentRecurringScansProperties": { + "description": "Properties of a Vulnerability Assessment recurring scans.", + "type": "object", + "properties": { + "isEnabled": { + "description": "Recurring scans state.", + "type": "boolean" + }, + "emailSubscriptionAdmins": { + "description": "Specifies that the schedule scan notification will be is sent to the subscription administrators.", + "default": true, + "type": "boolean" + }, + "emails": { + "description": "Specifies an array of e-mail addresses to which the scan notification is sent.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DatabaseVulnerabilityAssessment": { + "description": "A database vulnerability assessment.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessmentProperties", + "description": "Resource properties.", + "x-ms-client-flatten": 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" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "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" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databases.json index 7ed0ddc75746..ad95c784e765 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databases.json @@ -502,33 +502,6 @@ } } }, - "Sku": { - "description": "An ARM Resource SKU.", - "type": "object", - "properties": { - "name": { - "description": "The name of the SKU, typically, a letter + Number code, e.g. P3.", - "type": "string" - }, - "tier": { - "description": "The tier of the particular SKU, e.g. Basic, Premium.", - "type": "string" - }, - "size": { - "description": "Size of the particular SKU", - "type": "string" - }, - "family": { - "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", - "type": "string" - }, - "capacity": { - "format": "int32", - "description": "Capacity of the particular SKU.", - "type": "integer" - } - } - }, "DatabaseProperties": { "description": "The database's properties.", "type": "object", @@ -718,57 +691,6 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "ARM tracked top level resource.", - "required": [ - "location" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "Resource location.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, "Database": { "description": "A database resource.", "required": [ @@ -777,12 +699,12 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../common/v1/types.json#/definitions/TrackedResource" } ], "properties": { "sku": { - "$ref": "#/definitions/Sku", + "$ref": "../../../common/v1/types.json#/definitions/Sku", "description": "The name and tier of the SKU." }, "kind": { @@ -802,7 +724,7 @@ "type": "object", "properties": { "sku": { - "$ref": "#/definitions/Sku", + "$ref": "../../../common/v1/types.json#/definitions/Sku", "description": "The name and tier of the SKU." }, "properties": { @@ -819,128 +741,6 @@ } } }, - "DatabaseOperationListResult": { - "description": "The response to a list database operations request", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/DatabaseOperation" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "DatabaseOperationProperties": { - "description": "The properties of a database operation.", - "type": "object", - "properties": { - "databaseName": { - "description": "The name of the database the operation is being performed on.", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "The name of operation.", - "type": "string", - "readOnly": true - }, - "operationFriendlyName": { - "description": "The friendly name of operation.", - "type": "string", - "readOnly": true - }, - "percentComplete": { - "format": "int32", - "description": "The percentage of the operation completed.", - "type": "integer", - "readOnly": true - }, - "serverName": { - "description": "The name of the server.", - "type": "string", - "readOnly": true - }, - "startTime": { - "format": "date-time", - "description": "The operation start time.", - "type": "string", - "readOnly": true - }, - "state": { - "description": "The operation state.", - "enum": [ - "Pending", - "InProgress", - "Succeeded", - "Failed", - "CancelInProgress", - "Cancelled" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ManagementOperationState", - "modelAsString": true - } - }, - "errorCode": { - "format": "int32", - "description": "The operation error code.", - "type": "integer", - "readOnly": true - }, - "errorDescription": { - "description": "The operation error description.", - "type": "string", - "readOnly": true - }, - "errorSeverity": { - "format": "int32", - "description": "The operation error severity.", - "type": "integer", - "readOnly": true - }, - "isUserError": { - "description": "Whether or not the error is a user error.", - "type": "boolean", - "readOnly": true - } - } - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, - "DatabaseOperation": { - "description": "A database operation.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/DatabaseOperationProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - }, "ImportExportDatabaseDefinition": { "description": "Contains the information necessary to perform import/export operation.", "required": [ @@ -1081,7 +881,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CancelJobExecution.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CancelJobExecution.json index 0fcc35717d61..738cf42b87a1 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CancelJobExecution.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CancelJobExecution.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivtyLabelCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivtyLabelCreateMax.json new file mode 100644 index 000000000000..fe6131a05b41 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivtyLabelCreateMax.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "serverName": "myServer", + "databaseName": "myDatabase", + "schemaName": "dbo", + "tableName": "myTable", + "columnName": "myColumn", + "sensitivityLabelSource": "current", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "labelName": "PII", + "informationType": "PhoneNumber" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "labelName": "PII", + "informationType": "PhoneNumber" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "labelName": "PII", + "informationType": "PhoneNumber" + } + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivtyLabelDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivtyLabelDelete.json new file mode 100644 index 000000000000..d696fb91ed5e --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivtyLabelDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "serverName": "myServer", + "databaseName": "myDatabase", + "schemaName": "dbo", + "tableName": "myTable", + "columnName": "myColumn", + "sensitivityLabelSource": "current", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivtyLabelGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivtyLabelGet.json new file mode 100644 index 000000000000..e3e5f81b1493 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivtyLabelGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "serverName": "myServer", + "databaseName": "myDatabase", + "schemaName": "dbo", + "tableName": "myTable", + "columnName": "myColumn", + "sensitivityLabelSource": "current", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "labelName": "PII", + "informationType": "PhoneNumber" + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CompleteManagedRestore.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CompleteManagedRestore.json new file mode 100644 index 000000000000..404be24e99b4 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CompleteManagedRestore.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "locationName": "southeastasia", + "operationId": "111111111-2222-8888-5555-777777777777/completeRestore", + "api-version": "2017-03-01-preview", + "parameters": { + "lastBackupName": "testdb1_log4" + } + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateJobExecution.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateJobExecution.json index 33bd949cbf77..7185227b97dc 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateJobExecution.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateJobExecution.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobAgentMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobAgentMax.json new file mode 100644 index 000000000000..6d60ca66c4c9 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobAgentMax.json @@ -0,0 +1,61 @@ +{ + "parameters":{ + "subscriptionId":"00000000-1111-2222-3333-444444444444", + "resourceGroupName":"group1", + "serverName":"server1", + "jobAgentName":"agent1", + "api-version": "2017-03-01-preview", + "parameters":{ + "location": "southeastasia", + "sku": { + "name": "Agent", + "capacity": 100 + }, + "properties": { + "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1" + }, + "tags": { + "octopus": "agent" + } + } + }, + "responses":{ + "200":{ + "body":{ + "id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1", + "name":"agent1", + "type":"Microsoft.Sql/servers/jobAgents", + "location": "southeastasia", + "sku": { + "name": "Agent", + "capacity": 100 + }, + "properties": { + "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1" + }, + "tags": { + "octopus": "agent" + } + } + }, + "201":{ + "body":{ + "id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1", + "name":"agent1", + "type":"Microsoft.Sql/servers/jobAgents", + "location": "southeastasia", + "sku": { + "name": "Agent", + "capacity": 100 + }, + "properties": { + "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1" + }, + "tags": { + "octopus": "agent" + } + } + }, + "202":{ } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobAgentMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobAgentMin.json new file mode 100644 index 000000000000..97ffd1929152 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobAgentMin.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "group1", + "serverName": "server1", + "jobAgentName": "agent1", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "southeastasia", + "properties": { + "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1", + "name": "agent1", + "type": "Microsoft.Sql/servers/jobAgents", + "location": "southeastasia", + "sku": { + "name": "Agent", + "capacity": 100 + }, + "properties": { + "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1", + "name": "agent1", + "type": "Microsoft.Sql/servers/jobAgents", + "location": "southeastasia", + "sku": { + "name": "Agent", + "capacity": 100 + }, + "properties": { + "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1" + } + } + }, + "202": { } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobCredential.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobCredential.json index 59fd0c72e315..eeaea016ac57 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobCredential.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobCredential.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobExecution.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobExecution.json index ebda400ac79d..1500f334a66c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobExecution.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobExecution.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMax.json index 47ccbb14a422..2cf760d4fc1b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMax.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMin.json index 6e54f084af4f..600e41ed57f3 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMin.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMin.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMax.json index 4fd71a24f937..49e0b1e00408 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMax.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", @@ -20,11 +20,11 @@ "output":{ "type":"SqlDatabase", "subscriptionId":"3501b905-a848-4b5d-96e8-b253f62d735a", - "resourceGroup":"group3", - "server":"server3", - "database":"database3", - "schema":"myschema1234", - "table":"mytable5678", + "resourceGroupName":"group3", + "serverName":"server3", + "databaseName":"database3", + "schemaName":"myschema1234", + "tableName":"mytable5678", "credential":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0" }, "executionOptions":{ @@ -50,14 +50,14 @@ "value":"select 2" }, "output":{ - "type":"SqlDatabase", - "subscriptionId":"3501b905-a848-4b5d-96e8-b253f62d735a", - "resourceGroup":"group3", - "server":"server3", - "database":"database3", - "schema":"myschema1234", - "table":"mytable5678", - "credential":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0" + "type": "SqlDatabase", + "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a", + "resourceGroupName": "group3", + "serverName": "server3", + "databaseName": "database3", + "schemaName": "myschema1234", + "tableName": "mytable5678", + "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0" }, "executionOptions":{ "timeoutSeconds":1234, @@ -84,14 +84,14 @@ "value":"select 2" }, "output":{ - "type":"SqlDatabase", - "subscriptionId":"3501b905-a848-4b5d-96e8-b253f62d735a", - "resourceGroup":"group3", - "server":"server3", - "database":"database3", - "schema":"myschema1234", - "table":"mytable5678", - "credential":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0" + "type": "SqlDatabase", + "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a", + "resourceGroupName": "group3", + "serverName": "server3", + "databaseName": "database3", + "schemaName": "myschema1234", + "tableName": "mytable5678", + "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0" }, "executionOptions":{ "timeoutSeconds":1234, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMin.json index 63a3c89525dc..c82be7b92fcf 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMin.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMin.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMax.json index d10b57f24fc3..e3b725a69ec6 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMax.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", @@ -33,6 +33,7 @@ "type":"SqlShardMap", "serverName":"server3", "shardMapName":"shardMap1", + "databaseName":"database1", "refreshCredential":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential" } ] @@ -68,6 +69,7 @@ "type":"SqlShardMap", "serverName":"server3", "shardMapName":"shardMap1", + "databaseName":"database1", "refreshCredential":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential" } ] @@ -105,6 +107,7 @@ "type":"SqlShardMap", "serverName":"server3", "shardMapName":"shardMap1", + "databaseName":"database1", "refreshCredential":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential" } ] diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMin.json index 91cebdfb494c..009e8c4c4c48 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMin.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMin.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingCreateMax.json new file mode 100644 index 000000000000..a571903ebf91 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingCreateMax.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "serverName": "blobauditingtest-6440", + "databaseName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 6, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups":["DATABASE_LOGOUT_GROUP","DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public"] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/auditingSettings", + "kind": "V12", + "properties": { + "state":"Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "storageAccountAccessKey": "", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": ["DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public"] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/auditingSettings", + "kind": "V12", + "properties": { + "state":"Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "storageAccountAccessKey": "", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": ["DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public"] + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingCreateMin.json new file mode 100644 index 000000000000..6821106df1d8 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingCreateMin.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "serverName": "blobauditingtest-6440", + "databaseName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/auditingSettings", + "kind": "V12", + "properties": { + "state":"Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "storageAccountAccessKey": "", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups":["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP","FAILED_DATABASE_AUTHENTICATION_GROUP","BATCH_COMPLETED_GROUP"] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/auditingSettings", + "kind": "V12", + "properties": { + "state":"Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "storageAccountAccessKey": "", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups":["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP","FAILED_DATABASE_AUTHENTICATION_GROUP","BATCH_COMPLETED_GROUP"] + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingGet.json new file mode 100644 index 000000000000..9637d314f0bc --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-6852", + "serverName": "blobauditingtest-2080", + "databaseName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Sql/servers/blobauditingtest-2080/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/auditingSettings", + "kind": "V12", + "properties": { + "state": "Disabled", + "storageEndpoint": "", + "retentionDays": 0, + "auditActionsAndGroups": [], + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateMax.json new file mode 100644 index 000000000000..6b9b6b5d8a7c --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateMax.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4799", + "serverName": "vulnerabilityaseessmenttest-6440", + "databaseName": "testdb", + "vulnerabilityAssessmentName": "default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "storageContainerSasKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": true, + "emails": [ "email1@mail.com", "email2@mail.com" ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": true, + "emails": [ "email1@mail.com", "email2@mail.com" ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": true, + "emails": [ "email1@mail.com", "email2@mail.com" ] + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateMin.json new file mode 100644 index 000000000000..121ad41dc081 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateMin.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4799", + "serverName": "vulnerabilityaseessmenttest-6440", + "databaseName": "testdb", + "vulnerabilityAssessmentName": "default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "storageContainerSasKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": false, + "emails": [] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": false, + "emails": [] + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentDelete.json new file mode 100644 index 000000000000..b6cfa2303d4e --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4799", + "serverName": "vulnerabilityaseessmenttest-6440", + "databaseName": "testdb", + "vulnerabilityAssessmentName": "default", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentGet.json new file mode 100644 index 000000000000..2c583ee4a055 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4799", + "serverName": "vulnerabilityaseessmenttest-6440", + "databaseName": "testdb", + "vulnerabilityAssessmentName": "default", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", + "name": "default", + "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", + "properties": { + "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", + "recurringScans": { + "isEnabled": true, + "emailSubscriptionAdmins": true, + "emails": [ "email1@mail.com", "email2@mail.com" ] + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentRuleBaselineCreate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentRuleBaselineCreate.json new file mode 100644 index 000000000000..fccb1034117b --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentRuleBaselineCreate.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4799", + "serverName": "vulnerabilityaseessmenttest-6440", + "databaseName": "testdb", + "vulnerabilityAssessmentName": "default", + "ruleId": "VA1001", + "baselineName": "default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "baselineResults": [ + { + "result": [ "userA", "SELECT" ] + }, + { + "result": [ "userB", "SELECT" ] + }, + { + "result": [ "userC", "SELECT", "tableId_4" ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default/rules/VA1001/baselines/default", + "name": "default", + "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines", + "properties": { + "baselineResults": [ + { + "result": [ "userA", "SELECT" ] + }, + { + "result": [ "userB", "SELECT" ] + }, + { + "result": [ "userC", "SELECT", "tableId_4" ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentRuleBaselineDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentRuleBaselineDelete.json new file mode 100644 index 000000000000..157beb7fcb9c --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentRuleBaselineDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4799", + "serverName": "vulnerabilityaseessmenttest-6440", + "databaseName": "testdb", + "baselineName": "default", + "ruleId": "VA1001", + "vulnerabilityAssessmentName": "default", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentRuleBaselineGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentRuleBaselineGet.json new file mode 100644 index 000000000000..1602407dad65 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentRuleBaselineGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityaseessmenttest-4711", + "serverName": "vulnerabilityaseessmenttest-6411", + "databaseName": "testdb", + "vulnerabilityAssessmentName": "default", + "ruleId": "VA1001", + "baselineName": "master", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default/rules/VA1001/baselines/default", + "name": "default", + "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines", + "properties": { + "baselineResults": [ + { + "result": [ "userA", "SELECT" ] + }, + { + "result": [ "userB", "SELECT" ] + }, + { + "result": [ "userC", "SELECT", "tableId_4" ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJob.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJob.json index b924799c02bd..93c7d3fcbe42 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJob.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJob.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobAgent.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobAgent.json index 621272a80253..04937e03c77e 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobAgent.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobAgent.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobCredential.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobCredential.json index 9de9c1a375c0..52d78ada8c4c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobCredential.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobCredential.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobStep.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobStep.json index dee50fcd08fa..853de7852d2e 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobStep.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobStep.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobTargetGroup.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobTargetGroup.json index b93e3f88e032..5ea4adaff001 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobTargetGroup.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobTargetGroup.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingCreateMax.json new file mode 100644 index 000000000000..c3d225765d3d --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingCreateMax.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "serverName": "blobauditingtest-6440", + "databaseName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 6, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ "DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public" ], + "predicateExpression": "statement = 'select 1'" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/extendedAuditingSettings", + "properties": { + "state":"Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ "DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public" ], + "predicateExpression": "statement = 'select 1'" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/extendedAuditingSettings", + "properties": { + "state":"Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ "DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public" ], + "predicateExpression": "statement = 'select 1'" + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingCreateMin.json new file mode 100644 index 000000000000..822c2619666d --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingCreateMin.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "serverName": "blobauditingtest-6440", + "databaseName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/extendedAuditingSettings", + "properties": { + "state":"Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups":["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP","FAILED_DATABASE_AUTHENTICATION_GROUP","BATCH_COMPLETED_GROUP"] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/extendedAuditingSettings", + "properties": { + "state":"Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups":["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP","FAILED_DATABASE_AUTHENTICATION_GROUP","BATCH_COMPLETED_GROUP"] + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingGet.json new file mode 100644 index 000000000000..46a66ce2854c --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-6852", + "serverName": "blobauditingtest-2080", + "databaseName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Sql/servers/blobauditingtest-2080/databases/testdb", + "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'" + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingCreateMax.json new file mode 100644 index 000000000000..cd0ce930e7fa --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingCreateMax.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "serverName": "blobauditingtest-6440", + "blobAuditingPolicyName": "default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 6, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ], + "predicateExpression": "object_name = 'SensitiveData'" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/extendedAuditingSettings/default", + "name": "default", + "type": "Microsoft.Sql/servers/extendedAuditingSettings", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 6, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ], + "predicateExpression": "object_name = 'SensitiveData'" + } + } + }, + "202": { + "startTime": "2017-11-22T09:34:54.72Z", + "operation": "UpsertServerEngineAuditingPolicy" + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingCreateMin.json new file mode 100644 index 000000000000..95847565cb3d --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingCreateMin.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "serverName": "blobauditingtest-6440", + "blobAuditingPolicyName": "default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/extendedAuditingSettings/default", + "name": "default", + "type": "Microsoft.Sql/servers/extendedAuditingSettings", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 6, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ] + } + } + }, + "202": { + "startTime": "2017-11-22T09:34:54.72Z", + "operation": "UpsertServerEngineAuditingPolicy" + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingGet.json new file mode 100644 index 000000000000..1c13d70019b3 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "serverName": "blobauditingtest-6440", + "blobAuditingPolicyName": "default", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "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'" + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJob.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJob.json index 577437a4fb07..115b12a9abbc 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJob.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJob.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobAgent.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobAgent.json index cd0f7fe44c55..365bd7a89967 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobAgent.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobAgent.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", @@ -12,11 +12,15 @@ "id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1", "name":"agent1", "type":"Microsoft.Sql/servers/jobAgents", - "location":"southeastasia", + "location": "southeastasia", + "sku": { + "name": "Agent", + "capacity": 100 + }, "properties":{ "databaseId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1" } } } } -} +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobCredential.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobCredential.json index 69798a51034e..b053ca63e8db 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobCredential.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobCredential.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecution.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecution.json index 1779769b1655..505f2a642880 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecution.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecution.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionStep.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionStep.json index ba4ca6a32bc7..62d938798c72 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionStep.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionStep.json @@ -1,33 +1,35 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", "serverName":"server1", - "jobAgentName":"jobAgent1", + "jobAgentName":"agent1", "jobName":"job1", - "jobExecutionId":"13572468-1357-2468-3579-135724683579", + "jobExecutionId":"5555-6666-7777-8888-999999999999", "stepName":"step1", "api-version":"2017-03-01-preview" }, "responses":{ "200":{ - "properties":{ - "jobVersion":1, - "stepName":"step1", - "stepId":1, - "jobExecutionId":"9c20948b-f370-4e4f-b5a4-d07be4309935", - "lifecycle":"Succeeded", - "provisioningState":"Succeeded", - "createTime":"2017-12-03T04:33:15.7189151Z", - "startTime":"2017-12-03T04:33:16.176937Z", - "endTime":"2017-12-03T04:33:19.0600862Z", - "currentAttempts":1, - "currentAttemptStartTime":"2017-12-03T04:33:17.4840068Z", - "lastMessage":"Step 1 succeeded." - }, - "id":"/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/account1/jobs/job1/executions/9c20948b-f370-4e4f-b5a4-d07be4309935/steps/step1", - "name":"step1", - "type":"Microsoft.Sql/servers/jobAgents/jobs/executions/steps" + "body":{ + "properties":{ + "jobVersion":1, + "stepName":"step1", + "stepId":1, + "jobExecutionId":"5555-6666-7777-8888-999999999999", + "lifecycle":"Succeeded", + "provisioningState":"Succeeded", + "createTime":"2017-12-27T04:33:15.7189151Z", + "startTime":"2017-12-27T04:33:16.176937Z", + "endTime":"2017-12-27T04:33:19.0600862Z", + "currentAttempts":1, + "currentAttemptStartTime":"2017-12-27T04:33:17.4840068Z", + "lastMessage":"Step 1 succeeded." + }, + "id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999/steps/step1", + "name":"step1", + "type":"Microsoft.Sql/servers/jobAgents/jobs/executions/steps" + } } } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionTarget.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionTarget.json index 2c4395783be3..ab40d8ad004c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionTarget.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionTarget.json @@ -1,39 +1,41 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", "serverName":"server1", - "jobAgentName":"jobAgent1", + "jobAgentName":"agent1", "jobName":"job1", - "jobExecutionId":"13572468-1357-2468-3579-135724683579", + "jobExecutionId":"5555-6666-7777-8888-999999999999", "stepName":"step1", - "targetId": "e3bdd712-e86d-47fc-a02d-0b315a44865f", + "targetId":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "api-version":"2017-03-01-preview" }, "responses":{ "200":{ - "properties":{ - "jobVersion":1, - "stepName":"step1", - "stepId":1, - "jobExecutionId":"9c20948b-f370-4e4f-b5a4-d07be4309935", - "lifecycle":"Succeeded", - "provisioningState":"Succeeded", - "createTime":"2017-12-03T04:33:17.5133333Z", - "startTime":"2017-12-03T04:33:18.1230403Z", - "endTime":"2017-12-03T04:33:18.7031029Z", - "currentAttempts":1, - "currentAttemptStartTime":"2017-12-03T04:33:18.2391013Z", - "lastMessage":"Step 1 succeeded execution on target (server 'server1', database 'database1').", - "target":{ - "type":"SqlDatabase", - "serverName":"server1", - "databaseName":"database1" - } - }, - "id":"/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/account1/jobs/job1/executions/9c20948b-f370-4e4f-b5a4-d07be4309935/steps/step1/targets/e3bdd712-e86d-47fc-a02d-0b315a44865f", - "name":"e3bdd712-e86d-47fc-a02d-0b315a44865f", - "type":"Microsoft.Sql/servers/jobAgents/jobs/executions/steps/targets" + "body":{ + "properties":{ + "jobVersion":1, + "stepName":"step1", + "stepId":1, + "jobExecutionId":"5555-6666-7777-8888-999999999999", + "lifecycle":"Succeeded", + "provisioningState":"Succeeded", + "createTime":"2017-11-05T04:33:17.5133333Z", + "startTime":"2017-11-05T04:33:18.1230403Z", + "endTime":"2017-11-05T04:33:18.7031029Z", + "currentAttempts":1, + "currentAttemptStartTime":"2017-11-05T04:33:18.2391013Z", + "lastMessage":"Step 1 succeeded execution on target (server 'server1', database 'database1').", + "target":{ + "type":"SqlDatabase", + "serverName":"server1", + "databaseName":"database1" + } + }, + "id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999/steps/step1/targets/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "name":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "type":"Microsoft.Sql/servers/jobAgents/jobs/executions/steps/targets" + } } } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByJob.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByJob.json index 98813e4e3e66..48fa100ecede 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByJob.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByJob.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", @@ -23,11 +23,11 @@ "output":{ "type":"SqlDatabase", "subscriptionId":"3501b905-a848-4b5d-96e8-b253f62d735a", - "resourceGroup":"group3", - "server":"server3", - "database":"database3", - "schema":"myschema1234", - "table":"mytable5678", + "resourceGroupName":"group3", + "serverName":"server3", + "databaseName":"database3", + "schemaName":"myschema1234", + "tableName":"mytable5678", "credential":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0" }, "executionOptions":{ diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByVersion.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByVersion.json index a2afa36e10e9..6ea970f0e94b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByVersion.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByVersion.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", @@ -24,11 +24,11 @@ "output":{ "type":"SqlDatabase", "subscriptionId":"3501b905-a848-4b5d-96e8-b253f62d735a", - "resourceGroup":"group3", - "server":"server3", - "database":"database3", - "schema":"myschema1234", - "table":"mytable5678", + "resourceGroupName":"group3", + "serverName":"server3", + "databaseName":"database3", + "schemaName":"myschema1234", + "tableName":"mytable5678", "credential":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0" }, "executionOptions":{ diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobTargetGroup.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobTargetGroup.json index bcb8471ad5d8..1452bd2ea7e1 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobTargetGroup.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobTargetGroup.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", @@ -36,6 +36,7 @@ "type":"SqlShardMap", "serverName":"server3", "shardMapName":"shardMap1", + "databaseName":"database1", "refreshCredential":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential" } ] diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobVersion.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobVersion.json index 56143c2846b6..2585927282f2 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobVersion.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobVersion.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobAgentsByServer.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobAgentsByServer.json index 66dce5312424..68f4e749f77f 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobAgentsByServer.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobAgentsByServer.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", @@ -13,7 +13,11 @@ "id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1", "name":"agent1", "type":"Microsoft.Sql/servers/jobAgents", - "location":"southeastasia", + "location": "southeastasia", + "sku": { + "name": "Agent", + "capacity": 100 + }, "properties":{ "databaseId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1" } @@ -22,7 +26,11 @@ "id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/jobAgent2", "name":"jobAgent2", "type":"Microsoft.Sql/servers/jobAgents", - "location":"southeastasia", + "location": "southeastasia", + "sku": { + "name": "Agent", + "capacity": 100 + }, "properties":{ "databaseId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db12" } @@ -31,4 +39,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobCredentialsByAgent.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobCredentialsByAgent.json index 76c5ebf69cdd..86351ed3dfa7 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobCredentialsByAgent.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobCredentialsByAgent.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionSteps.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionSteps.json index 95191ee45412..f91a132855f8 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionSteps.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionSteps.json @@ -1,35 +1,38 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", "serverName":"server1", - "jobAgentName":"jobAgent1", + "jobAgentName":"agent1", "jobName":"job1", + "jobExecutionId":"5555-6666-7777-8888-999999999999", "api-version":"2017-03-01-preview" }, "responses":{ "200":{ - "value":[ - { - "properties":{ - "jobVersion":1, - "stepName":"step1", - "stepId":1, - "jobExecutionId":"9c20948b-f370-4e4f-b5a4-d07be4309935", - "lifecycle":"Succeeded", - "provisioningState":"Succeeded", - "createTime":"2017-12-03T04:33:15.7189151Z", - "startTime":"2017-12-03T04:33:16.176937Z", - "endTime":"2017-12-03T04:33:19.0600862Z", - "currentAttempts":1, - "currentAttemptStartTime":"2017-12-03T04:33:17.4840068Z", - "lastMessage":"Step 1 succeeded." - }, - "id":"/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/account1/jobs/job1/executions/9c20948b-f370-4e4f-b5a4-d07be4309935/steps/step1", - "name":"step1", - "type":"Microsoft.Sql/servers/jobAgents/jobs/executions/steps" - } - ] + "body":{ + "value":[ + { + "properties":{ + "jobVersion":1, + "stepName":"step1", + "stepId":1, + "jobExecutionId":"5555-6666-7777-8888-999999999999", + "lifecycle":"Succeeded", + "provisioningState":"Succeeded", + "createTime":"2017-12-03T04:33:15.7189151Z", + "startTime":"2017-12-03T04:33:16.176937Z", + "endTime":"2017-12-03T04:33:19.0600862Z", + "currentAttempts":1, + "currentAttemptStartTime":"2017-12-03T04:33:17.4840068Z", + "lastMessage":"Step 1 succeeded." + }, + "id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999/steps/step1", + "name":"step1", + "type":"Microsoft.Sql/servers/jobAgents/jobs/executions/steps" + } + ] + } } } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByExecution.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByExecution.json index 58f19b368e5f..1325b6cdd062 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByExecution.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByExecution.json @@ -1,41 +1,43 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", "serverName":"server1", - "jobAgentName":"jobAgent1", + "jobAgentName":"agent1", "jobName":"job1", - "stepName":"step1", + "jobExecutionId":"5555-6666-7777-8888-999999999999", "api-version":"2017-03-01-preview" }, "responses":{ "200":{ - "value":[ - { - "properties":{ - "jobVersion":1, - "stepName":"step1", - "stepId":1, - "jobExecutionId":"9c20948b-f370-4e4f-b5a4-d07be4309935", - "lifecycle":"Succeeded", - "provisioningState":"Succeeded", - "createTime":"2017-12-03T04:33:17.5133333Z", - "startTime":"2017-12-03T04:33:18.1230403Z", - "endTime":"2017-12-03T04:33:18.7031029Z", - "currentAttempts":1, - "currentAttemptStartTime":"2017-12-03T04:33:18.2391013Z", - "lastMessage":"Step 1 succeeded execution on target (server 'server1', database 'database1').", - "target":{ - "type":"SqlDatabase", - "serverName":"server1", - "databaseName":"database1" - } - }, - "id":"/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/account1/jobs/job1/executions/9c20948b-f370-4e4f-b5a4-d07be4309935/steps/step1/targets/e3bdd712-e86d-47fc-a02d-0b315a44865f", - "name":"e3bdd712-e86d-47fc-a02d-0b315a44865f", - "type":"Microsoft.Sql/servers/jobAgents/jobs/executions/steps/targets" - } - ] + "body":{ + "value":[ + { + "properties":{ + "jobVersion":1, + "stepName":"step1", + "stepId":1, + "jobExecutionId":"5555-6666-7777-8888-999999999999", + "lifecycle":"Succeeded", + "provisioningState":"Succeeded", + "createTime":"2017-07-01T04:33:17.5133333Z", + "startTime":"2017-07-01T04:33:18.1230403Z", + "endTime":"2017-07-01T04:33:18.7031029Z", + "currentAttempts":1, + "currentAttemptStartTime":"2017-07-01T04:33:18.2391013Z", + "lastMessage":"Step 1 succeeded execution on target (server 'server1', database 'database1').", + "target":{ + "type":"SqlDatabase", + "serverName":"server1", + "databaseName":"database1" + } + }, + "id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999/steps/step1/targets/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "name":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "type":"Microsoft.Sql/servers/jobAgents/jobs/executions/steps/targets" + } + ] + } } } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByStep.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByStep.json index 58f19b368e5f..d060af56d88d 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByStep.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByStep.json @@ -1,41 +1,44 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", "serverName":"server1", - "jobAgentName":"jobAgent1", + "jobAgentName":"agent1", "jobName":"job1", + "jobExecutionId":"5555-6666-7777-8888-999999999999", "stepName":"step1", "api-version":"2017-03-01-preview" }, "responses":{ "200":{ - "value":[ - { - "properties":{ - "jobVersion":1, - "stepName":"step1", - "stepId":1, - "jobExecutionId":"9c20948b-f370-4e4f-b5a4-d07be4309935", - "lifecycle":"Succeeded", - "provisioningState":"Succeeded", - "createTime":"2017-12-03T04:33:17.5133333Z", - "startTime":"2017-12-03T04:33:18.1230403Z", - "endTime":"2017-12-03T04:33:18.7031029Z", - "currentAttempts":1, - "currentAttemptStartTime":"2017-12-03T04:33:18.2391013Z", - "lastMessage":"Step 1 succeeded execution on target (server 'server1', database 'database1').", - "target":{ - "type":"SqlDatabase", - "serverName":"server1", - "databaseName":"database1" - } - }, - "id":"/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/account1/jobs/job1/executions/9c20948b-f370-4e4f-b5a4-d07be4309935/steps/step1/targets/e3bdd712-e86d-47fc-a02d-0b315a44865f", - "name":"e3bdd712-e86d-47fc-a02d-0b315a44865f", - "type":"Microsoft.Sql/servers/jobAgents/jobs/executions/steps/targets" - } - ] + "body":{ + "value":[ + { + "properties":{ + "jobVersion":1, + "stepName":"step1", + "stepId":1, + "jobExecutionId":"5555-6666-7777-8888-999999999999", + "lifecycle":"Succeeded", + "provisioningState":"Succeeded", + "createTime":"2017-07-01T04:33:17.5133333Z", + "startTime":"2017-07-01T04:33:18.1230403Z", + "endTime":"2017-07-01T04:33:18.7031029Z", + "currentAttempts":1, + "currentAttemptStartTime":"2017-07-01T04:33:18.2391013Z", + "lastMessage":"Step 1 succeeded execution on target (server 'server1', database 'database1').", + "target":{ + "type":"SqlDatabase", + "serverName":"server1", + "databaseName":"database1" + } + }, + "id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999/steps/step1/targets/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "name":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "type":"Microsoft.Sql/servers/jobAgents/jobs/executions/steps/targets" + } + ] + } } } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByAgentWithFilter.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByAgentWithFilter.json new file mode 100644 index 000000000000..b2c4e9a7b248 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByAgentWithFilter.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "group1", + "serverName": "server1", + "jobAgentName": "agent1", + "api-version": "2017-03-01-preview", + "createTimeMin": "2017-03-21T19:00:00.0000000Z", + "createTimeMax": "2017-03-21T19:05:00.0000000Z", + "endTimeMin": "2017-03-21T19:20:00.0000000Z", + "endTimeMax": "2017-03-21T19:25:00.0000000Z", + "isActive": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "jobVersion": 1, + "jobExecutionId": "5555-6666-7777-8888-999999999999", + "lifecycle": "Created", + "provisioningState": "Created", + "createTime": "2017-03-21T19:02:00.8707045Z", + "startTime": "2017-03-21T19:12:00.8707045Z", + "endTime": "2017-03-21T19:22:00.8707045Z", + "currentAttempts": 0, + "currentAttemptStartTime": "2017-03-21T19:12:00.8707045Z", + "lastMessage": "Job execution created." + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999", + "name": "5555-6666-7777-8888-999999999999", + "type": "Microsoft.Sql/servers/jobAgents/jobs/executions" + }, + { + "properties": { + "jobVersion": 1, + "jobExecutionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "lifecycle": "Succeeded", + "provisioningState": "Succeeded", + "createTime": "2017-12-15T19:02:00.8707045Z", + "startTime": "2017-12-15T19:12:00.8707045Z", + "endTime": "2017-12-15T19:22:00.8707045Z", + "currentAttempts": 1, + "lastMessage": "Job execution succeeded." + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job2/executions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "type": "Microsoft.Sql/servers/jobAgents/jobs/executions" + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1//executions?api-version=2017-03-01-preview&%24skip=2" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByJob.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByJob.json index 2e2d7e15e89b..00a1fc94a267 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByJob.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByJob.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByJob.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByJob.json index 28be6d240b73..571e1a83648b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByJob.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByJob.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", @@ -24,11 +24,11 @@ "output":{ "type":"SqlDatabase", "subscriptionId":"3501b905-a848-4b5d-96e8-b253f62d735a", - "resourceGroup":"group3", - "server":"server3", - "database":"database3", - "schema":"myschema1234", - "table":"mytable5678", + "resourceGroupName":"group3", + "serverName":"server3", + "databaseName":"database3", + "schemaName":"myschema1234", + "tableName":"mytable5678", "credential":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0" }, "executionOptions":{ @@ -56,11 +56,11 @@ "output":{ "type":"SqlDatabase", "subscriptionId":"3501b905-a848-4b5d-96e8-b253f62d735a", - "resourceGroup":"group3", - "server":"server3", - "database":"database3", - "schema":"myschema1234", - "table":"mytable5678", + "resourceGroupName":"group3", + "serverName":"server3", + "databaseName":"database3", + "schemaName":"myschema1234", + "tableName":"mytable5678", "credential":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0" }, "executionOptions":{ diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByVersion.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByVersion.json index eb46c026857d..f7fd74cd38b0 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByVersion.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByVersion.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", @@ -25,11 +25,11 @@ "output":{ "type":"SqlDatabase", "subscriptionId":"3501b905-a848-4b5d-96e8-b253f62d735a", - "resourceGroup":"group3", - "server":"server3", - "database":"database3", - "schema":"myschema1234", - "table":"mytable5678", + "resourceGroupName":"group3", + "serverName":"server3", + "databaseName":"database3", + "schemaName":"myschema1234", + "tableName":"mytable5678", "credential":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0" }, "executionOptions":{ @@ -57,11 +57,11 @@ "output":{ "type":"SqlDatabase", "subscriptionId":"3501b905-a848-4b5d-96e8-b253f62d735a", - "resourceGroup":"group3", - "server":"server3", - "database":"database3", - "schema":"myschema1234", - "table":"mytable5678", + "resourceGroupName":"group3", + "serverName":"server3", + "databaseName":"database3", + "schemaName":"myschema1234", + "tableName":"mytable5678", "credential":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0" }, "executionOptions":{ diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobTargetGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobTargetGroups.json index b165fb433763..3d601b7fc3c8 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobTargetGroups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobTargetGroups.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", @@ -37,6 +37,7 @@ "type":"SqlShardMap", "serverName":"server3", "shardMapName":"shardMap1", + "databaseName":"database1", "refreshCredential":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential" } ] diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobVersions.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobVersions.json index 61224a8b7ae0..1bef2f1c0c6a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobVersions.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobVersions.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobsByAgent.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobsByAgent.json index 95222e79bf43..f5bc7284cec9 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobsByAgent.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobsByAgent.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateMax.json new file mode 100644 index 000000000000..5b90cf7227b6 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateMax.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "managedDatabase", + "api-version": "2017-03-01-preview", + "parameters": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia" + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb1", + "name": "testdb1", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb2", + "name": "testdb2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateMin.json new file mode 100644 index 000000000000..dc8110cb783b --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateMin.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "managedDatabase", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "southeastasia" + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb1", + "name": "testdb1", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb2", + "name": "testdb2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreatePointInTimeRestore.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreatePointInTimeRestore.json new file mode 100644 index 000000000000..35e787d9b8d3 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreatePointInTimeRestore.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "managedDatabase", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "southeastasia", + "properties": { + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb", + "restorePointInTime": "2017-07-14T05:35:31.503Z" + } + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb1", + "name": "testdb1", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb2", + "name": "testdb2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": { } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateRestoreExternalBackup.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateRestoreExternalBackup.json new file mode 100644 index 000000000000..b548481d70ed --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateRestoreExternalBackup.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "managedDatabase", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "createMode": "RestoreExternalBackup", + "storageContainerUri": "https://myaccountname.blob.core.windows.net/backups", + "storageContainerSasToken": "sv=2015-12-11&sr=c&sp=rl&sig=1234", + "collation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia" + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb1", + "name": "testdb1", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb2", + "name": "testdb2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": { } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseDelete.json new file mode 100644 index 000000000000..f2f90b41b6e8 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "testdb", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": "" + }, + "202": {}, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseGet.json new file mode 100644 index 000000000000..20605c075e18 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Test1", + "managedInstanceName": "managedInstance", + "databaseName": "managedDatabase", + "api-version": "2015-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/databases/testdb1", + "location": "southeastasia", + "name": "testdb1", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "creationDate": "2017-08-04T15:00:17.73Z", + "defaultSecondaryLocation": "North Europe", + "status": "Online" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseListByManagedInstance.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseListByManagedInstance.json new file mode 100644 index 000000000000..605b6eaef54c --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseListByManagedInstance.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Test1", + "managedInstanceName": "managedInstance", + "databaseName": "managedDatabase", + "api-version": "2015-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/databases/testdb1", + "location": "southeastasia", + "name": "testdb1", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "creationDate": "2017-08-04T15:00:17.73Z", + "defaultSecondaryLocation": "North Europe", + "status": "Online" + }, + "type": "Microsoft.Sql/managedInstances/databases" + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/databases/testdb2", + "location": "southeastasia", + "name": "testdb2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "creationDate": "2017-08-04T15:00:17.73Z", + "defaultSecondaryLocation": "North Europe", + "status": "Online" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseUpdateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseUpdateMax.json new file mode 100644 index 000000000000..1f105bbaf543 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseUpdateMax.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "testdb", + "api-version": "2017-03-01-preview", + "parameters": { + "tags": { + "tagKey1": "TagValue1" + } + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb" + }, + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": { } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseUpdateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseUpdateMin.json new file mode 100644 index 000000000000..1f105bbaf543 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseUpdateMin.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "testdb", + "api-version": "2017-03-01-preview", + "parameters": { + "tags": { + "tagKey1": "TagValue1" + } + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb" + }, + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": { } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabaseMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabaseMax.json new file mode 100644 index 000000000000..112d9cb25068 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabaseMax.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "serverName": "myServer", + "databaseName": "myDatabase", + "api-version": "2017-03-01-preview", + "filter": "Name eq 'current'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "labelName": "Sensitive", + "informationType": "Financial" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabaseMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabaseMin.json new file mode 100644 index 000000000000..33441c2f00c6 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabaseMin.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "serverName": "myServer", + "databaseName": "myDatabase", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "labelName": "Sensitive", + "informationType": "Financial" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn2/sensitivityLabels/recommended", + "name": "recommended", + "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "labelName": "PII", + "informationType": "Email" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMax.json index 74919d55125f..144353d69a54 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMax.json @@ -3,7 +3,7 @@ "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "blobauditingtest-4799", "serverName": "blobauditingtest-6440", - "blobAuditingPolicyName": "Default", + "blobAuditingPolicyName": "default", "api-version": "2017-03-01-preview", "parameters": { "properties": { @@ -20,13 +20,12 @@ "responses": { "200": { "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/auditingSettings/Default", - "name": "Default", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/auditingSettings/default", + "name": "default", "type": "Microsoft.Sql/servers/auditingSettings", "properties": { "state": "Enabled", "storageEndpoint": "https://mystorage.blob.core.windows.net", - "storageAccountAccessKey": "", "retentionDays": 6, "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, @@ -34,6 +33,9 @@ } } }, - "202": { } + "202": { + "startTime": "2017-11-22T09:34:54.72Z", + "operation": "UpsertServerEngineAuditingPolicy" + } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMin.json new file mode 100644 index 000000000000..217a8d05ce80 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMin.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "serverName": "blobauditingtest-6440", + "blobAuditingPolicyName": "default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/auditingSettings/default", + "name": "default", + "type": "Microsoft.Sql/servers/auditingSettings", + "properties": { + "state": "Enabled", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "retentionDays": 6, + "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ] + } + } + }, + "202": { + "startTime": "2017-11-22T09:34:54.72Z", + "operation": "UpsertServerEngineAuditingPolicy" + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingGet.json new file mode 100644 index 000000000000..4fc165d07c2a --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "serverName": "blobauditingtest-6440", + "blobAuditingPolicyName": "default", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Sql/servers/blobauditingtest-2080/auditingSettings/default", + "name": "default", + "type": "Microsoft.Sql/servers/auditingSettings", + "properties": { + "state": "Disabled", + "storageEndpoint": "", + "retentionDays": 0, + "auditActionsAndGroups": [], + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerSecurityAlertsCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerSecurityAlertsCreateMax.json new file mode 100644 index 000000000000..0ee9a5edfffe --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerSecurityAlertsCreateMax.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": ["testSecurityAlert@microsoft.com"], + "disabledAlerts": ["Access_Anomaly", "Usage_Anomaly"], + "retentionDays": 5, + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/securityAlertPolicies/default", + "name": "Default", + "type": "Microsoft.Sql/servers/securityAlertPolicies", + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": ["testSecurityAlert@microsoft.com"], + "disabledAlerts": ["Access_Anomaly","Usage_Anomaly"], + "retentionDays": 5, + "storageAccountAccessKey": "", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "202": { + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerSecurityAlertsCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerSecurityAlertsCreateMin.json new file mode 100644 index 000000000000..48cc23daeadb --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerSecurityAlertsCreateMin.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "state": "Disabled", + "emailAccountAdmins": true, + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/securityAlertPolicies/default", + "name": "Default", + "type": "Microsoft.Sql/servers/securityAlertPolicies", + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": [""], + "disabledAlerts": [""], + "retentionDays": 0, + "storageAccountAccessKey": "", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "202": { + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerSecurityAlertsGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerSecurityAlertsGet.json new file mode 100644 index 000000000000..c3029f8c4319 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerSecurityAlertsGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/securityAlertPolicies/default", + "name": "Default", + "type": "Microsoft.Sql/servers/securityAlertPolicies", + "properties": { + "state": "Disabled", + "emailAccountAdmins": true, + "emailAddresses": [ "test@microsoft.com;user@microsoft.com" ], + "disabledAlerts": ["Access_Anomaly"], + "retentionDays": 0, + "storageAccountAccessKey": "", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateJobAgent.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateJobAgent.json index 8d96b1e2658a..b1fefbfea663 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateJobAgent.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateJobAgent.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/jobs.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/jobs.json index b16b953a37f2..c00788ad2829 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/jobs.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/jobs.json @@ -147,7 +147,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\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 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 JobAgentExceededQuota - Could not create job agent because it would exceed the quota.\n\n * 400 JobAgentAlreadyExists - The job agent already exists on the server.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 JobAgentDatabaseSecondary - A job agent cannot be linked to a geo-secondary database.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 PropertyChangeUnsupported - Property cannot be modified.\n\n * 404 SubscriptionNotFound - The requested subscription was not found." + "description": "*** Error Responses: ***\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 MissingSkuName - Sku name is rerquired.\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 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 DatabaseDoesNotExist - The requested database was not found\n\n * 400 JobAgentExceededQuota - Could not create job agent because it would exceed the quota.\n\n * 400 JobAgentAlreadyExists - The job agent already exists on the server.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 JobAgentDatabaseSecondary - A job agent cannot be linked to a geo-secondary database.\n\n * 400 JobAgentDatabaseAlreadyLinked - The specified database is already linked to another job agent.\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 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 PropertyChangeUnsupported - Property cannot be modified." }, "202": { "description": "Accepted" @@ -161,8 +161,11 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Create or update a job agent": { - "$ref": "./examples/CreateOrUpdateJobAgent.json" + "Create or update a job agent with minimum properties": { + "$ref": "./examples/CreateOrUpdateJobAgentMin.json" + }, + "Create or update a job agent with all properties": { + "$ref": "./examples/CreateOrUpdateJobAgentMax.json" } } }, @@ -258,7 +261,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 PropertyChangeUnsupported - Property cannot be modified.\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server." + "description": "*** Error Responses: ***\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 PropertyChangeUnsupported - Property cannot be modified." }, "202": { "description": "Accepted" @@ -512,12 +515,58 @@ "required": true, "type": "string" }, + { + "name": "createTimeMin", + "in": "query", + "description": "If specified, only job executions created at or after the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "createTimeMax", + "in": "query", + "description": "If specified, only job executions created before the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "endTimeMin", + "in": "query", + "description": "If specified, only job executions completed at or after the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "endTimeMax", + "in": "query", + "description": "If specified, only job executions completed before the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "isActive", + "in": "query", + "description": "If specified, only active or only completed job executions are included.", + "required": false, + "type": "boolean" + }, { "name": "$skip", "in": "query", "description": "The number of elements in the collection to skip.", "required": false, - "type": "string" + "type": "integer" + }, + { + "name": "$top", + "in": "query", + "description": "The number of elements to return from the collection.", + "required": false, + "type": "integer" }, { "$ref": "#/parameters/SubscriptionIdParameter" @@ -543,6 +592,9 @@ "x-ms-examples": { "List all job executions in a job agent.": { "$ref": "./examples/ListJobExecutionsByAgent.json" + }, + "List all job executions in a job agent with filtering.": { + "$ref": "./examples/ListJobExecutionsByAgentWithFilter.json" } } } @@ -690,12 +742,58 @@ "required": true, "type": "string" }, + { + "name": "createTimeMin", + "in": "query", + "description": "If specified, only job executions created at or after the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "createTimeMax", + "in": "query", + "description": "If specified, only job executions created before the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "endTimeMin", + "in": "query", + "description": "If specified, only job executions completed at or after the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "endTimeMax", + "in": "query", + "description": "If specified, only job executions completed before the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "isActive", + "in": "query", + "description": "If specified, only active or only completed job executions are included.", + "required": false, + "type": "boolean" + }, { "name": "$skip", "in": "query", "description": "The number of elements in the collection to skip.", "required": false, - "type": "string" + "type": "integer" + }, + { + "name": "$top", + "in": "query", + "description": "The number of elements to return from the collection.", + "required": false, + "type": "integer" }, { "$ref": "#/parameters/SubscriptionIdParameter" @@ -1077,6 +1175,191 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps": { + "get": { + "tags": [ + "JobStepExecutions" + ], + "description": "Lists the step executions of a job execution.", + "operationId": "JobStepExecutions_ListByJobExecution", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "jobAgentName", + "in": "path", + "description": "The name of the job agent.", + "required": true, + "type": "string" + }, + { + "name": "jobName", + "in": "path", + "description": "The name of the job to get.", + "required": true, + "type": "string" + }, + { + "name": "jobExecutionId", + "in": "path", + "description": "The id of the job execution", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "createTimeMin", + "in": "query", + "description": "If specified, only job executions created at or after the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "createTimeMax", + "in": "query", + "description": "If specified, only job executions created before the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "endTimeMin", + "in": "query", + "description": "If specified, only job executions completed at or after the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "endTimeMax", + "in": "query", + "description": "If specified, only job executions completed before the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "isActive", + "in": "query", + "description": "If specified, only active or only completed job executions are included.", + "required": false, + "type": "boolean" + }, + { + "name": "$skip", + "in": "query", + "description": "The number of elements in the collection to skip.", + "required": false, + "type": "integer" + }, + { + "name": "$top", + "in": "query", + "description": "The number of elements to return from the collection.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the step executions.", + "schema": { + "$ref": "#/definitions/JobExecutionListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List job step executions": { + "$ref": "./examples/ListJobExecutionSteps.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}": { + "get": { + "tags": [ + "JobStepExecutions" + ], + "description": "Gets a step execution of a job execution.", + "operationId": "JobStepExecutions_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "jobAgentName", + "in": "path", + "description": "The name of the job agent.", + "required": true, + "type": "string" + }, + { + "name": "jobName", + "in": "path", + "description": "The name of the job to get.", + "required": true, + "type": "string" + }, + { + "name": "jobExecutionId", + "in": "path", + "description": "The unique id of the job execution", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "stepName", + "in": "path", + "description": "The name of the step.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the step execution.", + "schema": { + "$ref": "#/definitions/JobExecution" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Get a job step execution": { + "$ref": "./examples/GetJobExecutionStep.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/versions/{jobVersion}/steps": { "get": { "tags": [ @@ -1459,13 +1742,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/targets": { "get": { "tags": [ - "JobTargetGroups" + "JobTargetExecutions" ], - "description": "Gets all target groups in an agent.", - "operationId": "JobTargetGroups_ListByAgent", + "description": "Lists target executions for all steps of a job execution.", + "operationId": "JobTargetExecutions_ListByJobExecution", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" @@ -1481,41 +1764,358 @@ "type": "string" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "name": "jobName", + "in": "path", + "description": "The name of the job to get.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of target groups.", - "schema": { - "$ref": "#/definitions/JobTargetGroupListResult" - } + "name": "jobExecutionId", + "in": "path", + "description": "The id of the job execution", + "required": true, + "type": "string", + "format": "uuid" }, - "default": { - "description": "*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get all target groups in an agent.": { - "$ref": "./examples/ListJobTargetGroups.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups/{targetGroupName}": { - "get": { - "tags": [ - "JobTargetGroups" - ], - "description": "Gets a target group.", - "operationId": "JobTargetGroups_Get", - "parameters": [ + { + "name": "createTimeMin", + "in": "query", + "description": "If specified, only job executions created at or after the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "createTimeMax", + "in": "query", + "description": "If specified, only job executions created before the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "endTimeMin", + "in": "query", + "description": "If specified, only job executions completed at or after the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "endTimeMax", + "in": "query", + "description": "If specified, only job executions completed before the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "isActive", + "in": "query", + "description": "If specified, only active or only completed job executions are included.", + "required": false, + "type": "boolean" + }, + { + "name": "$skip", + "in": "query", + "description": "The number of elements in the collection to skip.", + "required": false, + "type": "integer" + }, + { + "name": "$top", + "in": "query", + "description": "The number of elements to return from the collection.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the target executions.", + "schema": { + "$ref": "#/definitions/JobExecutionListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List job step target executions": { + "$ref": "./examples/ListJobExecutionTargetsByExecution.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}/targets": { + "get": { + "tags": [ + "JobTargetExecutions" + ], + "description": "Lists the target executions of a job step execution.", + "operationId": "JobTargetExecutions_ListByStep", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "jobAgentName", + "in": "path", + "description": "The name of the job agent.", + "required": true, + "type": "string" + }, + { + "name": "jobName", + "in": "path", + "description": "The name of the job to get.", + "required": true, + "type": "string" + }, + { + "name": "jobExecutionId", + "in": "path", + "description": "The id of the job execution", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "stepName", + "in": "path", + "description": "The name of the step.", + "required": true, + "type": "string" + }, + { + "name": "createTimeMin", + "in": "query", + "description": "If specified, only job executions created at or after the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "createTimeMax", + "in": "query", + "description": "If specified, only job executions created before the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "endTimeMin", + "in": "query", + "description": "If specified, only job executions completed at or after the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "endTimeMax", + "in": "query", + "description": "If specified, only job executions completed before the specified time are included.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "isActive", + "in": "query", + "description": "If specified, only active or only completed job executions are included.", + "required": false, + "type": "boolean" + }, + { + "name": "$skip", + "in": "query", + "description": "The number of elements in the collection to skip.", + "required": false, + "type": "integer" + }, + { + "name": "$top", + "in": "query", + "description": "The number of elements to return from the collection.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the target executions.", + "schema": { + "$ref": "#/definitions/JobExecutionListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List job step target executions": { + "$ref": "./examples/ListJobExecutionTargetsByStep.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}/targets/{targetId}": { + "get": { + "tags": [ + "JobTargetExecutions" + ], + "description": "Gets a target execution.", + "operationId": "JobTargetExecutions_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "jobAgentName", + "in": "path", + "description": "The name of the job agent.", + "required": true, + "type": "string" + }, + { + "name": "jobName", + "in": "path", + "description": "The name of the job to get.", + "required": true, + "type": "string" + }, + { + "name": "jobExecutionId", + "in": "path", + "description": "The unique id of the job execution", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "stepName", + "in": "path", + "description": "The name of the step.", + "required": true, + "type": "string" + }, + { + "name": "targetId", + "in": "path", + "description": "The target id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the target execution.", + "schema": { + "$ref": "#/definitions/JobExecution" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Get a job step target execution": { + "$ref": "./examples/GetJobExecutionTarget.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups": { + "get": { + "tags": [ + "JobTargetGroups" + ], + "description": "Gets all target groups in an agent.", + "operationId": "JobTargetGroups_ListByAgent", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "jobAgentName", + "in": "path", + "description": "The name of the job agent.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of target groups.", + "schema": { + "$ref": "#/definitions/JobTargetGroupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get all target groups in an agent.": { + "$ref": "./examples/ListJobTargetGroups.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups/{targetGroupName}": { + "get": { + "tags": [ + "JobTargetGroups" + ], + "description": "Gets a target group.", + "operationId": "JobTargetGroups_Get", + "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, @@ -1621,11 +2221,11 @@ } }, "x-ms-examples": { - "Create or update a target group with minimal properties.": { - "$ref": "./examples/CreateOrUpdateJobTargetGroupMin.json" - }, "Create or update a target group with all properties.": { "$ref": "./examples/CreateOrUpdateJobTargetGroupMax.json" + }, + "Create or update a target group with minimal properties.": { + "$ref": "./examples/CreateOrUpdateJobTargetGroupMin.json" } } }, @@ -1833,56 +2433,21 @@ "read", "create" ] - } - } - }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "ARM tracked top level resource.", - "required": [ - "location" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "Resource location.", + "state": { + "description": "The state of the job agent.", + "enum": [ + "Creating", + "Ready", + "Updating", + "Deleting", + "Disabled" + ], "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" + "readOnly": true, + "x-ms-enum": { + "name": "JobAgentState", + "modelAsString": true } } } @@ -1895,10 +2460,14 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../common/v1/types.json#/definitions/TrackedResource" } ], "properties": { + "sku": { + "$ref": "../../../common/v1/types.json#/definitions/Sku", + "description": "The name and tier of the SKU." + }, "properties": { "$ref": "#/definitions/JobAgentProperties", "description": "Resource properties.", @@ -1960,22 +2529,12 @@ } } }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "JobCredential": { "description": "A stored credential that can be used by a job to connect to target databases.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -2147,7 +2706,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -2242,7 +2801,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -2348,9 +2907,9 @@ "JobStepOutput": { "description": "The output configuration of a job step.", "required": [ - "server", - "database", - "table", + "serverName", + "databaseName", + "tableName", "credential" ], "type": "object", @@ -2372,24 +2931,24 @@ "description": "The output destination subscription id.", "type": "string" }, - "resourceGroup": { + "resourceGroupName": { "description": "The output destination resource group.", "type": "string" }, - "server": { + "serverName": { "description": "The output destination server name.", "type": "string" }, - "database": { + "databaseName": { "description": "The output destination database.", "type": "string" }, - "schema": { + "schemaName": { "description": "The output destination schema.", "default": "dbo", "type": "string" }, - "table": { + "tableName": { "description": "The output destination table.", "type": "string" }, @@ -2440,7 +2999,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -2548,7 +3107,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -2583,7 +3142,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": {} @@ -2638,6 +3197,17 @@ "type": "string", "x-ms-parameter-location": "method" }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, "SqlVirtualMachineInstanceNameParameter": { "name": "sqlVirtualMachineInstanceName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json index 2a4176ee62be..8049cf5fefca 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json @@ -517,44 +517,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "LongTermRetentionBackup": { "description": "A long term retention backup.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -612,7 +580,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json new file mode 100644 index 000000000000..81de6b717226 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json @@ -0,0 +1,610 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-03-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}/managedDatabaseRestoreAzureAsyncOperation/{operationId}/completeRestore": { + "post": { + "tags": [ + "ManagedDatabases" + ], + "description": "Completes the restore operation on a managed database.", + "operationId": "ManagedDatabases_CompleteRestore", + "parameters": [ + { + "name": "locationName", + "in": "path", + "description": "The name of the region where the resource is located.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Management operation id that this request tries to complete.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "parameters", + "in": "body", + "description": "The definition for completing the restore of this managed database.", + "required": true, + "schema": { + "$ref": "#/definitions/CompleteDatabaseRestoreDefinition" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully issued complete 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 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character." + }, + "202": { + "description": "Completing migration is in progress." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Completes a managed database restore": { + "$ref": "./examples/CompleteManagedRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases": { + "get": { + "tags": [ + "ManagedDatabases" + ], + "description": "Gets a list of managed databases.", + "operationId": "ManagedDatabases_ListByInstance", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of databases.", + "schema": { + "$ref": "#/definitions/ManagedDatabaseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List databases by managed instances": { + "$ref": "./examples/ManagedDatabaseListByManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}": { + "get": { + "tags": [ + "ManagedDatabases" + ], + "description": "Gets a managed database.", + "operationId": "ManagedDatabases_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified managed database.", + "schema": { + "$ref": "#/definitions/ManagedDatabase" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Gets a managed database": { + "$ref": "./examples/ManagedDatabaseGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedDatabases" + ], + "description": "Creates a new database or updates an existing database.", + "operationId": "ManagedDatabases_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested database resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedDatabase" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/ManagedDatabase" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\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 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 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 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 * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\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 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 * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Accepted" + }, + "201": { + "description": "Successfully created the database.", + "schema": { + "$ref": "#/definitions/ManagedDatabase" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates a new managed database by restoring from an external backup": { + "$ref": "./examples/ManagedDatabaseCreateRestoreExternalBackup.json" + }, + "Creates a new managed database with maximal properties": { + "$ref": "./examples/ManagedDatabaseCreateMax.json" + }, + "Creates a new managed database with minimal properties": { + "$ref": "./examples/ManagedDatabaseCreateMin.json" + }, + "Creates a new managed database using point in time restore": { + "$ref": "./examples/ManagedDatabaseCreatePointInTimeRestore.json" + } + } + }, + "delete": { + "tags": [ + "ManagedDatabases" + ], + "description": "Deletes the managed database.", + "operationId": "ManagedDatabases_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the managed database." + }, + "default": { + "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 * 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 * 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." + }, + "202": { + "description": "Deleting the managed database is in progress." + }, + "204": { + "description": "The specified managed database does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete managed database": { + "$ref": "./examples/ManagedDatabaseDelete.json" + } + } + }, + "patch": { + "tags": [ + "ManagedDatabases" + ], + "description": "Updates an existing database.", + "operationId": "ManagedDatabases_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested database resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedDatabaseUpdate" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/ManagedDatabase" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + }, + "202": { + "description": "Deleting the managed database is in progress." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates a managed database with minimal properties": { + "$ref": "./examples/ManagedDatabaseUpdateMin.json" + }, + "Updates a managed database with maximal properties": { + "$ref": "./examples/ManagedDatabaseUpdateMax.json" + } + } + } + } + }, + "definitions": { + "CompleteDatabaseRestoreDefinition": { + "description": "Contains the information necessary to perform a complete database restore operation.", + "required": [ + "lastBackupName" + ], + "type": "object", + "properties": { + "lastBackupName": { + "description": "The last backup name to apply", + "type": "string" + } + } + }, + "ManagedDatabaseListResult": { + "description": "A list of managed databases.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedDatabase" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedDatabaseProperties": { + "description": "The managed database's properties.", + "type": "object", + "properties": { + "collation": { + "description": "Collation of the managed database.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "status": { + "description": "Status for the database.", + "enum": [ + "Online", + "Offline", + "Shutdown", + "Creating", + "Inaccessible" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ManagedDatabaseStatus", + "modelAsString": true + } + }, + "creationDate": { + "format": "date-time", + "description": "Creation date of the database.", + "type": "string", + "readOnly": true + }, + "earliestRestorePoint": { + "format": "date-time", + "description": "Earliest restore point in time for point in time restore.", + "type": "string", + "readOnly": true + }, + "restorePointInTime": { + "format": "date-time", + "description": "Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "defaultSecondaryLocation": { + "description": "Geo paired region.", + "type": "string", + "readOnly": true + }, + "catalogCollation": { + "description": "Collation of the metadata catalog.", + "enum": [ + "DATABASE_DEFAULT", + "SQL_Latin1_General_CP1_CI_AS" + ], + "type": "string", + "x-ms-enum": { + "name": "CatalogCollationType", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "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.", + "enum": [ + "Default", + "RestoreExternalBackup", + "PointInTimeRestore" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedDatabaseCreateMode", + "modelAsString": true + }, + "x-ms-mutability": [ + "create" + ] + }, + "storageContainerUri": { + "description": "Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "sourceDatabaseId": { + "description": "The resource identifier of the source database associated with create operation of this database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "storageContainerSasToken": { + "description": "Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "failoverGroupId": { + "description": "Instance Failover Group resource identifier that this managed database belongs to.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedDatabase": { + "description": "A managed database resource.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ManagedDatabaseProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ManagedDatabaseUpdate": { + "description": "An managed database update.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ManagedDatabaseProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "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" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "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" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json index 2be16b54a812..f01d7090abbc 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json @@ -276,44 +276,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "RestorePoint": { "description": "Database restore points.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json new file mode 100644 index 000000000000..d685a49e501f --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json @@ -0,0 +1,463 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-03-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}/sensitivityLabels": { + "get": { + "tags": [ + "SensitivityLabels" + ], + "description": "Gets the sensitivity labels of a given database", + "operationId": "SensitivityLabels_ListByDatabase", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "An OData filter expression that filters elements in the collection.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the sensitivity labels.", + "schema": { + "$ref": "#/definitions/SensitivityLabelListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." + } + }, + "x-ms-odata": "#/definitions/SensitivityLabel", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the current sensitivity labels of a given database": { + "$ref": "./examples/SensitivityLabelsListByDatabaseMax.json" + }, + "Gets the sensitivity labels of a given database": { + "$ref": "./examples/SensitivityLabelsListByDatabaseMin.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}": { + "get": { + "tags": [ + "SensitivityLabels" + ], + "description": "Gets the sensitivity label of a given column", + "operationId": "SensitivityLabels_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "schemaName", + "in": "path", + "description": "The name of the schema.", + "required": true, + "type": "string" + }, + { + "name": "tableName", + "in": "path", + "description": "The name of the table.", + "required": true, + "type": "string" + }, + { + "name": "columnName", + "in": "path", + "description": "The name of the column.", + "required": true, + "type": "string" + }, + { + "name": "sensitivityLabelSource", + "in": "path", + "description": "The source of the sensitivity label.", + "required": true, + "type": "string", + "enum": [ + "current", + "recommended" + ], + "x-ms-enum": { + "name": "SensitivityLabelSource", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the sensitivity label.", + "schema": { + "$ref": "#/definitions/SensitivityLabel" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" + } + }, + "x-ms-examples": { + "Gets the sensitivity label of a given column": { + "$ref": "./examples/ColumnSensitivtyLabelGet.json" + } + } + }, + "put": { + "tags": [ + "SensitivityLabels" + ], + "description": "Creates or updates the sensitivity label of a given column", + "operationId": "SensitivityLabels_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "schemaName", + "in": "path", + "description": "The name of the schema.", + "required": true, + "type": "string" + }, + { + "name": "tableName", + "in": "path", + "description": "The name of the table.", + "required": true, + "type": "string" + }, + { + "name": "columnName", + "in": "path", + "description": "The name of the column.", + "required": true, + "type": "string" + }, + { + "name": "sensitivityLabelSource", + "in": "path", + "description": "The source of the sensitivity label.", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "x-ms-enum": { + "name": "WritableSensitivityLabelSource", + "modelAsString": false + } + }, + { + "name": "parameters", + "in": "body", + "description": "The column sensitivity label resource.", + "required": true, + "schema": { + "$ref": "#/definitions/SensitivityLabel" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the sensitivity label.", + "schema": { + "$ref": "#/definitions/SensitivityLabel" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 400 InvalidSensitivityLabelResource - The specified sensitivity label resource is not valid\n\n * 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - At least one of LabelName and InformationType must be specified\n\n * 400 LabelNameTooLong - Label name cannot exceed {0} characters\n\n * 400 InformationTypeTooLong - Information type cannot exceed {0} characters\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" + }, + "201": { + "description": "Successfully created the sensitivity label.", + "schema": { + "$ref": "#/definitions/SensitivityLabel" + } + } + }, + "x-ms-examples": { + "Updates the sensitivity label of a given column with all parameters": { + "$ref": "./examples/ColumnSensitivtyLabelCreateMax.json" + } + } + }, + "delete": { + "tags": [ + "SensitivityLabels" + ], + "description": "Deletes the sensitivity label of a given column", + "operationId": "SensitivityLabels_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "schemaName", + "in": "path", + "description": "The name of the schema.", + "required": true, + "type": "string" + }, + { + "name": "tableName", + "in": "path", + "description": "The name of the table.", + "required": true, + "type": "string" + }, + { + "name": "columnName", + "in": "path", + "description": "The name of the column.", + "required": true, + "type": "string" + }, + { + "name": "sensitivityLabelSource", + "in": "path", + "description": "The source of the sensitivity label.", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "x-ms-enum": { + "name": "WritableSensitivityLabelSource", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the sensitivity label." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" + } + }, + "x-ms-examples": { + "Deletes the sensitivity label of a given column": { + "$ref": "./examples/ColumnSensitivtyLabelDelete.json" + } + } + } + } + }, + "definitions": { + "SensitivityLabelProperties": { + "description": "Properties of a sensitivity label.", + "type": "object", + "properties": { + "labelName": { + "description": "The label name.", + "type": "string" + }, + "informationType": { + "description": "The information type.", + "type": "string" + } + } + }, + "SensitivityLabel": { + "description": "A sensitivity label.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SensitivityLabelProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SensitivityLabelListResult": { + "description": "A list of sensitivity labels.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SensitivityLabel" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "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" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "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" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json index 7b66e5a50ceb..97f737c7d881 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json @@ -198,44 +198,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "ServerAutomaticTuning": { "description": "Server-level Automatic Tuning.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json index 5dd066d31f8b..43519c53e7e1 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json @@ -294,44 +294,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "ServerDnsAlias": { "description": "A server DNS alias.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json new file mode 100644 index 000000000000..54f141e5e0a0 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json @@ -0,0 +1,307 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-03-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}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Get a server's security alert policy.", + "operationId": "ServerSecurityAlertPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-examples": { + "Get a server's threat detection policy": { + "$ref": "./examples/ServerSecurityAlertsGet.json" + } + } + }, + "put": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Creates or updates a threat detection policy.", + "operationId": "ServerSecurityAlertPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the threat detection policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The server security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later" + }, + "202": { + "description": "Created request to set the server threat detection policy." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a server's threat detection policy with all parameters": { + "$ref": "./examples/ServerSecurityAlertsCreateMax.json" + }, + "Update a server's threat detection policy with minimal parameters": { + "$ref": "./examples/ServerSecurityAlertsCreateMin.json" + } + } + } + } + }, + "definitions": { + "SecurityAlertPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled.", + "enum": [ + "New", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityAlertPolicyState", + "modelAsString": false + } + }, + "disabledAlerts": { + "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAddresses": { + "description": "Specifies an array of e-mail addresses to which the alert is sent.", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAccountAdmins": { + "description": "Specifies that the alert is sent to the account administrators.", + "type": "boolean" + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the Threat Detection audit storage account.", + "type": "string" + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the Threat Detection audit logs.", + "type": "integer" + } + } + }, + "ServerSecurityAlertPolicy": { + "description": "A server security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": 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" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "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" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json new file mode 100644 index 000000000000..e88d8eb9b0cc --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json @@ -0,0 +1,208 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-10-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/managedInstances/{managedInstanceName}/tdeCertificates": { + "post": { + "tags": [ + "ManagedInstanceTdeCertificates" + ], + "description": "Creates a TDE certificate for a given server.", + "operationId": "ManagedInstanceTdeCertificates_Create", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested TDE certificate to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/TdeCertificate" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created the TDE certificate." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 MissingPrivateBlob - The private blob is missing.\n\n * 400 InvalidPrivateBlobOrPassword - Invalid private blob or password specified.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upload a TDE certificate": { + "$ref": "./examples/ManagedInstanceTdeCertificate.json" + } + } + } + } + }, + "definitions": { + "TdeCertificateProperties": { + "description": "Properties of a TDE certificate.", + "required": [ + "privateBlob" + ], + "type": "object", + "properties": { + "privateBlob": { + "description": "The base64 encoded certificate private blob.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "certPassword": { + "description": "The certificate password.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + } + } + }, + "TdeCertificate": { + "description": "A TDE certificate that can be uploaded into a server.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TdeCertificateProperties", + "description": "Resource properties.", + "x-ms-client-flatten": 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" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "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" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json new file mode 100644 index 000000000000..9bec57c19e39 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json @@ -0,0 +1,208 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-10-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}/tdeCertificates": { + "post": { + "tags": [ + "TdeCertificates" + ], + "description": "Creates a TDE certificate for a given server.", + "operationId": "TdeCertificates_Create", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested TDE certificate to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/TdeCertificate" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created the TDE certificate." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 MissingPrivateBlob - The private blob is missing.\n\n * 400 InvalidPrivateBlobOrPassword - Invalid private blob or password specified.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upload a TDE certificate": { + "$ref": "./examples/SqlTdeCertificateCreate.json" + } + } + } + } + }, + "definitions": { + "TdeCertificateProperties": { + "description": "Properties of a TDE certificate.", + "required": [ + "privateBlob" + ], + "type": "object", + "properties": { + "privateBlob": { + "description": "The base64 encoded certificate private blob.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "certPassword": { + "description": "The certificate password.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + } + } + }, + "TdeCertificate": { + "description": "A TDE certificate that can be uploaded into a server.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TdeCertificateProperties", + "description": "Resource properties.", + "x-ms-client-flatten": 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" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "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" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json index 8686c830239d..31277778c542 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json @@ -134,7 +134,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -145,16 +145,6 @@ } } }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "DatabaseOperationProperties": { "description": "The properties of a database operation.", "type": "object", @@ -247,28 +237,6 @@ "readOnly": true } } - }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true } }, "parameters": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json index 0017374449ca..5a8b41c0c48c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json @@ -216,22 +216,12 @@ } } }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "ElasticPoolOperation": { "description": "A elastic pool operation.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -241,28 +231,6 @@ "x-ms-client-flatten": true } } - }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true } }, "parameters": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/capabilities.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/capabilities.json index b9ca95b76e20..db057acb2985 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/capabilities.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/capabilities.json @@ -355,7 +355,7 @@ "readOnly": true }, "sku": { - "$ref": "#/definitions/Sku", + "$ref": "../../../common/v1/types.json#/definitions/Sku", "description": "The sku.", "readOnly": true }, @@ -403,7 +403,7 @@ "readOnly": true }, "sku": { - "$ref": "#/definitions/Sku", + "$ref": "../../../common/v1/types.json#/definitions/Sku", "description": "The sku.", "readOnly": true }, @@ -605,36 +605,6 @@ } } }, - "Sku": { - "description": "An ARM Resource SKU.", - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "The name of the SKU, typically, a letter + Number code, e.g. P3.", - "type": "string" - }, - "tier": { - "description": "The tier of the particular SKU, e.g. Basic, Premium.", - "type": "string" - }, - "size": { - "description": "Size of the particular SKU", - "type": "string" - }, - "family": { - "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", - "type": "string" - }, - "capacity": { - "format": "int32", - "description": "Capacity of the particular SKU.", - "type": "integer" - } - } - }, "LicenseTypeCapability": { "description": "The license type capability", "type": "object", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json new file mode 100644 index 000000000000..fcec506f7deb --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json @@ -0,0 +1,593 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-10-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}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}": { + "get": { + "tags": [ + "DatabaseVulnerabilityAssessmentScans" + ], + "description": "Gets a vulnerability assessment scan record of a database.", + "operationId": "DatabaseVulnerabilityAssessmentScans_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "scanId", + "in": "path", + "description": "The vulnerability assessment scan Id of the scan to retrieve.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the database vulnerability assessment scan record.", + "schema": { + "$ref": "#/definitions/VulnerabilityAssessmentScanRecord" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 DatabaseVulnerabilityAssessmentOperationFailed - An error has occurred while trying to execute Vulnerability Assessment operation, please try again later" + } + }, + "x-ms-examples": { + "Gets a database vulnerability assessment scan record by scan ID": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentScanRecordsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}/initiateScan": { + "post": { + "tags": [ + "DatabaseVulnerabilityAssessmentScans" + ], + "description": "Executes a Vulnerability Assessment database scan.", + "operationId": "DatabaseVulnerabilityAssessmentScans_InitiateScan", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "scanId", + "in": "path", + "description": "The vulnerability assessment scan Id of the scan to retrieve.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully executed a Vulnerability Assessment database scan." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 InvalidVulnerabilityAssessmentScanIdLength - The vulnerability assessment scan ID length must be below {0} characters.\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseVulnerabilityAssessmentOperationFailed - An error has occurred while trying to execute Vulnerability Assessment operation, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + }, + "202": { + "description": "Successfully started a Vulnerability Assessment database scan." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Executes a database's vulnerability assessment scan.": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentScansExecute.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans": { + "get": { + "tags": [ + "DatabaseVulnerabilityAssessmentScans" + ], + "description": "Lists the vulnerability assessment scans of a database.", + "operationId": "DatabaseVulnerabilityAssessmentScans_ListByDatabase", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the database vulnerability assessment scan records.", + "schema": { + "$ref": "#/definitions/VulnerabilityAssessmentScanRecordListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 DatabaseVulnerabilityAssessmentOperationFailed - An error has occurred while trying to execute Vulnerability Assessment operation, please try again later" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of a database vulnerability assessment scan records": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentScanRecordsListByDatabase.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}/export": { + "post": { + "tags": [ + "DatabaseVulnerabilityAssessmentScansExport" + ], + "description": "Convert an existing scan result to a human readable format. If already exists nothing happens", + "operationId": "DatabaseVulnerabilityAssessmentScans_Export", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the scanned database.", + "required": true, + "type": "string" + }, + { + "name": "vulnerabilityAssessmentName", + "in": "path", + "description": "The name of the vulnerability assessment.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "VulnerabilityAssessmentName", + "modelAsString": true + } + }, + { + "name": "scanId", + "in": "path", + "description": "The vulnerability assessment scan Id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Scan result was converted successfully.", + "schema": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessmentScansExport" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature is not valid.\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 DatabaseVulnerabilityAssessmentOperationFailed - An error has occurred while trying to execute Vulnerability Assessment operation, please try again later" + }, + "201": { + "description": "Scan result was converted successfully.", + "schema": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessmentScansExport" + } + } + }, + "x-ms-examples": { + "Export a database's vulnerability assessment scan results.": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentScanExport.json" + } + } + } + } + }, + "definitions": { + "DatabaseVulnerabilityAssessmentProperties": { + "description": "Properties of a database Vulnerability Assessment.", + "required": [ + "storageContainerPath", + "storageContainerSasKey" + ], + "type": "object", + "properties": { + "storageContainerPath": { + "description": "A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "storageContainerSasKey": { + "description": "A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "recurringScans": { + "$ref": "#/definitions/VulnerabilityAssessmentRecurringScansProperties", + "description": "The recurring scans settings" + } + } + }, + "VulnerabilityAssessmentRecurringScansProperties": { + "description": "Properties of a Vulnerability Assessment recurring scans.", + "type": "object", + "properties": { + "isEnabled": { + "description": "Recurring scans state.", + "type": "boolean" + }, + "emailSubscriptionAdmins": { + "description": "Specifies that the schedule scan notification will be is sent to the subscription administrators.", + "default": true, + "type": "boolean" + }, + "emails": { + "description": "Specifies an array of e-mail addresses to which the scan notification is sent.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DatabaseVulnerabilityAssessment": { + "description": "A database vulnerability assessment.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessmentProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "VulnerabilityAssessmentScanRecordProperties": { + "description": "Properties of a vulnerability assessment scan record.", + "type": "object", + "properties": { + "scanId": { + "description": "The scan ID.", + "type": "string", + "readOnly": true + }, + "triggerType": { + "description": "The scan trigger type.", + "enum": [ + "OnDemand", + "Recurring" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VulnerabilityAssessmentScanTriggerType", + "modelAsString": true + } + }, + "state": { + "description": "The scan status.", + "enum": [ + "Passed", + "Failed", + "FailedToRun", + "InProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VulnerabilityAssessmentScanState", + "modelAsString": true + } + }, + "startTime": { + "format": "date-time", + "description": "The scan start time (UTC).", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "The scan end time (UTC).", + "type": "string", + "readOnly": true + }, + "errors": { + "description": "The scan errors.", + "type": "array", + "items": { + "$ref": "#/definitions/VulnerabilityAssessmentScanError" + }, + "readOnly": true + }, + "storageContainerPath": { + "description": "The scan results storage container path.", + "type": "string", + "readOnly": true + }, + "numberOfFailedSecurityChecks": { + "format": "int32", + "description": "The number of failed security checks.", + "type": "integer", + "readOnly": true + } + } + }, + "VulnerabilityAssessmentScanError": { + "description": "Properties of a vulnerability assessment scan error.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + } + } + }, + "VulnerabilityAssessmentScanRecord": { + "description": "A vulnerability assessment scan record.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VulnerabilityAssessmentScanRecordProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "VulnerabilityAssessmentScanRecordListResult": { + "description": "A list of vulnerability assessment scan records.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/VulnerabilityAssessmentScanRecord" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DatabaseVulnerabilityAssessmentScanExportProperties": { + "description": "Properties of the export operation's result.", + "type": "object", + "properties": { + "exportedReportLocation": { + "description": "Location of the exported report (e.g. https://myStorage.blob.core.windows.net/VaScans/scans/serverName/databaseName/scan_scanId.xlsx).", + "type": "string", + "readOnly": true + } + } + }, + "DatabaseVulnerabilityAssessmentScansExport": { + "description": "A database Vulnerability Assessment scan export resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessmentScanExportProperties", + "description": "Resource properties.", + "x-ms-client-flatten": 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" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "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" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "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" + } + } + } +} \ No newline at end of file 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 b64954a91cf7..ecdcd45edfc4 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 @@ -549,36 +549,6 @@ } } }, - "Sku": { - "description": "An ARM Resource SKU.", - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "The name of the SKU, typically, a letter + Number code, e.g. P3.", - "type": "string" - }, - "tier": { - "description": "The tier of the particular SKU, e.g. Basic, Premium.", - "type": "string" - }, - "size": { - "description": "Size of the particular SKU", - "type": "string" - }, - "family": { - "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", - "type": "string" - }, - "capacity": { - "format": "int32", - "description": "Capacity of the particular SKU.", - "type": "integer" - } - } - }, "DatabaseProperties": { "description": "The database's properties.", "type": "object", @@ -812,63 +782,12 @@ ] }, "currentSku": { - "$ref": "#/definitions/Sku", + "$ref": "../../../common/v1/types.json#/definitions/Sku", "description": "The name and tier of the SKU.", "readOnly": true } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "ARM tracked top level resource.", - "required": [ - "location" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "Resource location.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, "Database": { "description": "A database resource.", "required": [ @@ -877,12 +796,12 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../common/v1/types.json#/definitions/TrackedResource" } ], "properties": { "sku": { - "$ref": "#/definitions/Sku", + "$ref": "../../../common/v1/types.json#/definitions/Sku", "description": "The name and tier of the SKU." }, "kind": { @@ -907,7 +826,7 @@ "type": "object", "properties": { "sku": { - "$ref": "#/definitions/Sku", + "$ref": "../../../common/v1/types.json#/definitions/Sku", "description": "The name and tier of the SKU." }, "properties": { @@ -924,16 +843,6 @@ } } }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "ResourceMoveDefinition": { "description": "Contains the information necessary to perform a resource move (rename).", "required": [ diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json index 302c987a9465..c8afd90bbed1 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json @@ -306,36 +306,6 @@ } } }, - "Sku": { - "description": "An ARM Resource SKU.", - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "The name of the SKU, typically, a letter + Number code, e.g. P3.", - "type": "string" - }, - "tier": { - "description": "The tier of the particular SKU, e.g. Basic, Premium.", - "type": "string" - }, - "size": { - "description": "Size of the particular SKU", - "type": "string" - }, - "family": { - "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.", - "type": "string" - }, - "capacity": { - "format": "int32", - "description": "Capacity of the particular SKU.", - "type": "integer" - } - } - }, "ElasticPoolProperties": { "description": "Properties of an elastic pool", "type": "object", @@ -403,57 +373,6 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "ARM tracked top level resource.", - "required": [ - "location" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "Resource location.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, "ElasticPool": { "description": "An elastic pool.", "required": [ @@ -462,12 +381,12 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../common/v1/types.json#/definitions/TrackedResource" } ], "properties": { "sku": { - "$ref": "#/definitions/Sku" + "$ref": "../../../common/v1/types.json#/definitions/Sku" }, "kind": { "description": "Kind of elastic pool. This is metadata used for the Azure portal experience.", @@ -486,7 +405,7 @@ "type": "object", "properties": { "sku": { - "$ref": "#/definitions/Sku" + "$ref": "../../../common/v1/types.json#/definitions/Sku" }, "properties": { "$ref": "#/definitions/ElasticPoolUpdateProperties", @@ -532,16 +451,6 @@ } } } - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} } }, "parameters": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabase.json index 6a8beff16fb9..1fb0dacdba73 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabase.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/CreateVCoreDatabase.json @@ -8,8 +8,8 @@ "parameters": { "location": "southeastasia", "sku": { - "name": "IO_Gen4_2", - "tier": "IOOptimized", + "name": "BC_Gen4_2", + "tier": "BusinessCritical", "capacity": 2 }, "properties": { @@ -24,8 +24,8 @@ "200": { "body": { "sku": { - "name": "IO_Gen4_2", - "tier": "IOOptimized", + "name": "BC_Gen4_2", + "tier": "BusinessCritical", "capacity": 2 }, "kind": "v12.0,user", @@ -35,7 +35,7 @@ "status": "Online", "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", "creationDate": "2017-06-07T04:41:33.937Z", - "currentServiceObjectiveName": "IO_Gen4_2", + "currentServiceObjectiveName": "BC_Gen4_2", "defaultSecondaryLocation": "North Europe", "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", "licenseType": "LicenseIncluded", @@ -50,8 +50,8 @@ "201": { "body": { "sku": { - "name": "IO_Gen4_2", - "tier": "IOOptimized", + "name": "BC_Gen4_2", + "tier": "BusinessCritical", "capacity": 2 }, "kind": "v12.0,user", @@ -61,7 +61,7 @@ "status": "Online", "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", "creationDate": "2017-06-07T04:41:33.937Z", - "currentServiceObjectiveName": "IO_Gen4_2", + "currentServiceObjectiveName": "BC_Gen4_2", "defaultSecondaryLocation": "North Europe", "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", "licenseType": "LicenseIncluded", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScanExport.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScanExport.json new file mode 100644 index 000000000000..5b5ffd4ccb08 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScanExport.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityassessmenttest-4799", + "serverName": "vulnerabilityassessmenttest-6440", + "databaseName": "testdb", + "vulnerabilityAssessmentName": "default", + "scanId": "scan001", + "api-version": "2017-10-01-preview", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityassessmenttest-6440/databases/testdb/vulnerabilityAssessments/default/scans/scan001/export", + "name": "scan001", + "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments/scans/export", + "properties": { + "exportedReportLocation": "https://myaccount.blob.core.windows.net/vulnerabilityAssessment/vulnerabilityassessmenttest-6440/testdb/scan001.xlsx" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityassessmenttest-6440/databases/testdb/vulnerabilityAssessments/default/scans/scan001/export", + "name": "scan001", + "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments/scans/export", + "properties": { + "exportedReportLocation": "https://myaccount.blob.core.windows.net/vulnerabilityAssessment/vulnerabilityassessmenttest-6440/testdb/scan001.xlsx" + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScanRecordsGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScanRecordsGet.json new file mode 100644 index 000000000000..5f4ea1475233 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScanRecordsGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityassessmenttest-4711", + "serverName": "vulnerabilityassessmenttest-6411", + "databaseName": "testdb", + "vulnerabilityAssessmentName": "default", + "scanId": "scan001", + "api-version": "2017-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityassessmenttest-6440/databases/testdb/vulnerabilityAssessments/default/scans/scan001", + "name": "scan001", + "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments/scans", + "properties": { + "scanId": "scan001", + "triggerType": "OnDemand", + "state": "Passed", + "startTime": "2017-12-12T17:45:06Z", + "endTime": "2017-12-12T17:47:06Z", + "errors": [], + "storageContainerPath": "https://myaccount.blob.core.windows.net/vulnerability-assessment", + "numberOfFailedSecurityChecks": 9 + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScanRecordsListByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScanRecordsListByDatabase.json new file mode 100644 index 000000000000..53bf324c67d8 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScanRecordsListByDatabase.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityassessmenttest-4711", + "serverName": "vulnerabilityassessmenttest-6411", + "databaseName": "testdb", + "vulnerabilityAssessmentName": "default", + "api-version": "2017-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityassessmenttest-6440/databases/testdb/vulnerabilityAssessments/default/scans/scan001", + "name": "scan001", + "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments/scans", + "properties": { + "scanId": "scan001", + "triggerType": "OnDemand", + "state": "Passed", + "startTime": "2017-12-12T17:45:06Z", + "endTime": "2017-12-12T17:47:06Z", + "errors": [ ], + "storageContainerPath": "https://myaccount.blob.core.windows.net/vulnerability-assessment", + "numberOfFailedSecurityChecks": 9 + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityassessmenttest-6440/databases/testdb/vulnerabilityAssessments/default/scans/scan002", + "name": "scan002", + "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments/scans", + "properties": { + "scanId": "scan002", + "triggerType": "Recurring", + "state": "Failed", + "startTime": "2017-12-12T17:45:06Z", + "endTime": "2017-12-12T17:47:06Z", + "errors": [ ], + "storageContainerPath": "https://myaccount.blob.core.windows.net/vulnerability-assessment", + "numberOfFailedSecurityChecks": 9 + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityassessmenttest-6440/databases/testdb/vulnerabilityAssessments/default/scans/scan003", + "name": "scan003", + "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments/scans", + "properties": { + "scanId": "scan003", + "triggerType": "Recurring", + "state": "FailedToRun", + "startTime": "2017-12-12T17:45:06Z", + "endTime": "2017-12-12T17:47:06Z", + "errors": [ + { + "code": "StorageNotFound", + "message": "Storage not found" + } + ], + "storageContainerPath": "https://myaccount.blob.core.windows.net/vulnerability-assessment", + "numberOfFailedSecurityChecks": 0 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScansExecute.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScansExecute.json new file mode 100644 index 000000000000..2781fc04dd5e --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScansExecute.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "vulnerabilityassessmenttest-4711", + "managedInstanceName": "vulnerabilityassessmenttest-6411", + "databaseName": "testdb", + "vulnerabilityAssessmentName": "default", + "scanId": "scan01", + "api-version": "2017-10-01-preview" + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/GetShortTermRetentionPolicy.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/GetShortTermRetentionPolicy.json new file mode 100644 index 000000000000..d2188d3febc5 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/GetShortTermRetentionPolicy.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "policyName": "default", + "api-version": "2017-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/backupShortTermRetentionPolicies/default", + "name": "default", + "type": "Microsoft.Sql/locations/servers/databases/backupShortTermRetentionPolicies", + "properties": { + "retentionDays": 14 + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/GetVCoreDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/GetVCoreDatabase.json index 3e80a92f1457..c035868d1692 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/GetVCoreDatabase.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/GetVCoreDatabase.json @@ -10,8 +10,8 @@ "200": { "body": { "sku": { - "name": "IO_Gen4_2", - "tier": "IOOptimized", + "name": "BC_Gen4_2", + "tier": "BusinessCritical", "capacity": 2 }, "kind": "v12.0,user", @@ -21,7 +21,7 @@ "status": "Online", "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", "creationDate": "2017-06-07T04:41:33.937Z", - "currentServiceObjectiveName": "IO_Gen4_2", + "currentServiceObjectiveName": "BC_Gen4_2", "defaultSecondaryLocation": "North Europe", "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", "licenseType": "LicenseIncluded", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ListShortTermRetentionPoliciesByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ListShortTermRetentionPoliciesByDatabase.json new file mode 100644 index 000000000000..ad1be8eb3b1c --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ListShortTermRetentionPoliciesByDatabase.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "policyName": "default", + "api-version": "2017-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/backupShortTermRetentionPolicies/default", + "name":"default", + "type":"Microsoft.Sql/locations/servers/databases/backupShortTermRetentionPolicies", + "properties": { + "retentionDays":14 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ListVCoreDatabasesByServer.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ListVCoreDatabasesByServer.json index 3852f2b438b2..08a5b0da6854 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ListVCoreDatabasesByServer.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ListVCoreDatabasesByServer.json @@ -11,18 +11,18 @@ "value": [ { "sku": { - "name": "IO_Gen4_2", - "tier": "IOOptimized", + "name": "BC_Gen4_2", + "tier": "BusinessCritical", "capacity": 2 }, - "kind": "v12.0,user", + "kind": "v12.0,user,vcore", "properties": { "collation": "SQL_Latin1_General_CP1_CI_AS", "maxSizeBytes": 268435456000, "status": "Online", "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", "creationDate": "2017-06-07T04:41:33.937Z", - "currentServiceObjectiveName": "IO_Gen4_2", + "currentServiceObjectiveName": "BC_Gen4_2", "defaultSecondaryLocation": "North Europe", "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", "licenseType": "LicenseIncluded", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceTdeCertificate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceTdeCertificate.json new file mode 100644 index 000000000000..8dfc12219d81 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceTdeCertificate.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000001", + "resourceGroupName": "testtdecert", + "managedInstanceName": "testtdecert", + "api-version": "2017-10-01-preview", + "parameters": { + "properties": { + "privateBlob": "MIIJ+QIBAzCCCbUGCSqGSIb3DQEHAaCCCaYEggmiMIIJnjCCBhcGCSqGSIb3DQEHAaCCBggEggYEMIIGADCCBfwGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAgUeBd7F2KZUwICB9AEggTYSRi88/Xf0EZ9smyYDCr+jHa7a/510s19/5wjqGbLTT/CYBu2qSOhj+g9sNvjj5oWAcluaZ4XCl/oJhXlB+9q9ZYSC6pPhma7/Il+/zlZm8ZUMfgnUefpKXGj+Ilydghya2DOA0PONDGbqIJGBYC0JgtiL7WcYyA+LEiO0vXc2fZ+ccjQsHM+ePFOm6rTJ1oqE3quRC5Ls2Bv22PCmF+GWkWxqH1L5x8wR2tYfecEsx4sKMj318novQqBlJckOUPDrTT2ic6izFnDWS+zbGezSCeRkt2vjCUVDg7Aqm2bkmLVn+arA3tDZ/DBxgTwwt8prpAznDYG07WRxXMUk8Uqzmcds85jSMLSBOoRaS7GwIPprx0QwyYXd8H/go2vafuGCydRk8mA0bGLXjYWuYHAtztlGrE71a7ILqHY4XankohSAY4YF9Fc1mJcdtsuICs5vNosw1lf0VK5BR4ONCkiGFdYEKUpaUrzKpQiw3zteBN8RQs/ADKGWzaWERrkptf0pLH3/QnZvu9xwwnNWneygByPy7OVYrvgjD27x7Y/C24GyQweh75OTQN3fAvUj7IqeTVyWZGZq32AY/uUXYwASBpLbNUtUBfJ7bgyvVSZlPvcFUwDHJC1P+fSP8Vfcc9W3ec9HqVheXio7gYBEg9hZrOZwiZorl8HZJsEj5NxGccBme6hEVQRZfar5kFDHor/zmKohEAJVw8lVLkgmEuz8aqQUDSWVAcLbkfqygK/NxsR2CaC6xWroagQSRwpF8YbvqYJtAQvdkUXY9Ll4LSRcxKrWMZHgI+1Z22pyNtpy/kXLADche5CF3AVbHtzNNgn9L4GVuCW1Lqufu3U2+DEG+u53u1vraf45RS1y0IyLjTGC+8j0OTxcgUU6FrGgFny0m676v8potPrfyHvuOO511aOTe8UPBfnYyx0XHJPn8RaYGq0vMOBpFyfJkXtAnbRMgXjxxiO91yXTI2hbdVlAmOER1u8QemtF5PoKwZzaAjGBC5S0ARNtxZcWInGciGgtWJVVcyU6nJv3pa2T8jNvtcp8X7j+Il6j6Sju02L/f+S9MvAoGfgG6C5cInNIBEt7+mpYYV/6Mi9Nnj+8/Cq3eAMdTTo7XIzbFpeInzpVN2lAxPockRoAVj+odYO3CIBnzJ7mcA7JqtNk76vaWKasocMk9YS0Z+43o/Z5pZPwXvUv++UUv5fGRcsnIHEeQc+XJlSqRVoaLDo3mNRV6jp5GzJW2BZx3KkuLbohcmfBdr6c8ehGvHXhPm4k2jq9UNYvG9Gy58+1GqdhIYWbRc0Haid8H7UvvdkjA+Yul2rLj4fSTJ6yJ4f6xFAsFY7wIJthpik+dQO9lqPglo9DY30gEOXs3miuJmdmFtBoYlzxti4JBGwxXPwP3rtu6rY1JEOFsh1WmSEGE6Df2l9wtUQ0WAAD6bWgCxMiiRRv7TegxSeMtGn5QKuPC5lFuvzZvtJy1rR8WQwT7lVdHz32xLP2Rs4dayQPh08x3GsuI54d2kti2rcaSltGLRAOuODWc8KjYsPS6Ku4aN2NoQB5H9TEbHy2fsUNpNPMbCY54lH5bkgJtO4WmulnAHEApZG07u8G+Kk3a15npXemWgUW3N9gGtJ2XmieendXqS3RK1ZUYDsnAWW2jCZkjGB6jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBXBgkqhkiG9w0BCRQxSh5IAGEAYgBjAGYAOABhADUAOQAtAGYAZQAzADIALQA0AGIAZgA0AC0AYQBiAGMAZgAtADkAOAA3AGIANwBmADgANwAzADEANgBjMGsGCSsGAQQBgjcRATFeHlwATQBpAGMAcgBvAHMAbwBmAHQAIABFAG4AaABhAG4AYwBlAGQAIABDAHIAeQBwAHQAbwBnAHIAYQBwAGgAaQBjACAAUAByAG8AdgBpAGQAZQByACAAdgAxAC4AMDCCA38GCSqGSIb3DQEHBqCCA3AwggNsAgEAMIIDZQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQMwDgQIbQcNiyMGeL4CAgfQgIIDOPSSP6SqJGYsXCPWCMQU0TqdqT55fauuadduHaAlQpyN0MVYdu9QguLqMaJjxWa8Coy3K7LAOcqJ4S8FWV2SrpTuNHPv7vrtZfYhltGl+vW8rIrogeGTV4T/45oc5605HSiyItOWX8vHYKnAJkRMW4ICZXgY3dZVb+fr6yPIRFvMywqzwkViVOJIKjZN2lsAQ0xlLU0Fu/va9uxADwI2ZUKfo+6nX6bITkLvUSJoNCvZ5e7UITasxC4ZauHdMZch38N7BPH2usrAQfr3omYcScFzSeN2onhE1JBURCPDQa8+CGiWMm6mxboUOIcUGasaDqYQ8pSAgZZqQf8lU0uH4FP/z/5Dd7PniDHjvqlwYa+vB6flgtrwh6jYFeTKluhkucLrfzusFR52kHpg8K4GaUL8MhvlsNdd8iHSFjfyOdXRpY9re+B8X9Eorx0Z3xsSsVWaCwmI+Spq+BZ5CSXVm9Um6ogeM0et8JciZS2yFLIlbl2o4U1BWblskYfj/29jm4/2UKjKzORZnpjE0O+qP4hReSrx6os9dr8sNkq/7OafZock8zXjXaOpW6bqB1V5NWMPiWiPxPxfRi1F/MQp6CPY03H7MsDALEFcF7MmtY4YpN/+FFfrrOwS19Fg0OnQzNIgFpSRywX9dxyKICt/wbvhM+RLpUN50ZekFVska+C27hJRJEZ9rSdVhOVdL1UNknuwqF1cCQQriaNsnCbeVHN3/Wgsms9+Kt+glBNyZQlU8Fk+fafcQFI5MlxyMmARVwnC70F8AScnJPPFVZIdgIrvOXCDrEh8wFgkVM/MHkaTZUF51yy3pbIZaPmNd5dsUfEvMsW2IY6esnUUxPRQUUoi5Ib8EFHdiQJrYY3ELfZRXb2I1Xd0DVhlGzogn3CXZtXR2gSAakdB0qrLpXMSJNS65SS2tVTD7SI8OpUGNRjthQIAEEROPue10geFUwarWi/3jGMG529SzwDUJ4g0ix6VtcuLIDYFNdClDTyEyeV1f70NSG2QVXPIpeF7WQ8jWK7kenGaqqna4C4FYQpQk9vJP171nUXLR2mUR11bo1N4hcVhXnJls5yo9u14BB9CqVKXeDl7M5zwMDswHzAHBgUrDgMCGgQUT6Tjuka1G4O/ZCBxO7NBR34YUYQEFLaheEdRIIuxUd25/hl5vf2SFuZuAgIH0A==", + "password" : "password" + } + } + }, + "responses": { + "200": { }, + "202": { } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/PatchVCoreDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/PatchVCoreDatabase.json index 40ab6f3b7d71..b0b211816a51 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/PatchVCoreDatabase.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/PatchVCoreDatabase.json @@ -7,7 +7,7 @@ "api-version": "2017-03-01-preview", "parameters": { "sku": { - "name": "IO_Gen4_4" + "name": "BC_Gen4_4" }, "properties": { "maxSizeBytes": 1073741824, @@ -19,18 +19,18 @@ "200": { "body": { "sku": { - "name": "IO_Gen4_4", - "tier": "IOOptimized", + "name": "BC_Gen4_4", + "tier": "BusinessCritical", "capacity": 4 }, - "kind": "v12.0,user", + "kind": "v12.0,user,vcore", "properties": { "collation": "SQL_Latin1_General_CP1_CI_AS", "maxSizeBytes": 1073741824, "status": "Online", "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", "creationDate": "2017-06-07T04:41:33.937Z", - "currentServiceObjectiveName": "IO_Gen4_4", + "currentServiceObjectiveName": "BC_Gen4_4", "defaultSecondaryLocation": "North Europe", "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", "licenseType": "LicenseIncluded", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/SqlTdeCertificateCreate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/SqlTdeCertificateCreate.json new file mode 100644 index 000000000000..35803aff5fda --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/SqlTdeCertificateCreate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000001", + "resourceGroupName": "testtdecert", + "serverName": "testtdecert", + "tdeCertName": "current", + "api-version": "2017-10-01-preview", + "parameters": { + "properties": { + "privateBlob": "MIIJ+QIBAzCCCbUGCSqGSIb3DQEHAaCCCaYEggmiMIIJnjCCBhcGCSqGSIb3DQEHAaCCBggEggYEMIIGADCCBfwGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAgUeBd7F2KZUwICB9AEggTYSRi88/Xf0EZ9smyYDCr+jHa7a/510s19/5wjqGbLTT/CYBu2qSOhj+g9sNvjj5oWAcluaZ4XCl/oJhXlB+9q9ZYSC6pPhma7/Il+/zlZm8ZUMfgnUefpKXGj+Ilydghya2DOA0PONDGbqIJGBYC0JgtiL7WcYyA+LEiO0vXc2fZ+ccjQsHM+ePFOm6rTJ1oqE3quRC5Ls2Bv22PCmF+GWkWxqH1L5x8wR2tYfecEsx4sKMj318novQqBlJckOUPDrTT2ic6izFnDWS+zbGezSCeRkt2vjCUVDg7Aqm2bkmLVn+arA3tDZ/DBxgTwwt8prpAznDYG07WRxXMUk8Uqzmcds85jSMLSBOoRaS7GwIPprx0QwyYXd8H/go2vafuGCydRk8mA0bGLXjYWuYHAtztlGrE71a7ILqHY4XankohSAY4YF9Fc1mJcdtsuICs5vNosw1lf0VK5BR4ONCkiGFdYEKUpaUrzKpQiw3zteBN8RQs/ADKGWzaWERrkptf0pLH3/QnZvu9xwwnNWneygByPy7OVYrvgjD27x7Y/C24GyQweh75OTQN3fAvUj7IqeTVyWZGZq32AY/uUXYwASBpLbNUtUBfJ7bgyvVSZlPvcFUwDHJC1P+fSP8Vfcc9W3ec9HqVheXio7gYBEg9hZrOZwiZorl8HZJsEj5NxGccBme6hEVQRZfar5kFDHor/zmKohEAJVw8lVLkgmEuz8aqQUDSWVAcLbkfqygK/NxsR2CaC6xWroagQSRwpF8YbvqYJtAQvdkUXY9Ll4LSRcxKrWMZHgI+1Z22pyNtpy/kXLADche5CF3AVbHtzNNgn9L4GVuCW1Lqufu3U2+DEG+u53u1vraf45RS1y0IyLjTGC+8j0OTxcgUU6FrGgFny0m676v8potPrfyHvuOO511aOTe8UPBfnYyx0XHJPn8RaYGq0vMOBpFyfJkXtAnbRMgXjxxiO91yXTI2hbdVlAmOER1u8QemtF5PoKwZzaAjGBC5S0ARNtxZcWInGciGgtWJVVcyU6nJv3pa2T8jNvtcp8X7j+Il6j6Sju02L/f+S9MvAoGfgG6C5cInNIBEt7+mpYYV/6Mi9Nnj+8/Cq3eAMdTTo7XIzbFpeInzpVN2lAxPockRoAVj+odYO3CIBnzJ7mcA7JqtNk76vaWKasocMk9YS0Z+43o/Z5pZPwXvUv++UUv5fGRcsnIHEeQc+XJlSqRVoaLDo3mNRV6jp5GzJW2BZx3KkuLbohcmfBdr6c8ehGvHXhPm4k2jq9UNYvG9Gy58+1GqdhIYWbRc0Haid8H7UvvdkjA+Yul2rLj4fSTJ6yJ4f6xFAsFY7wIJthpik+dQO9lqPglo9DY30gEOXs3miuJmdmFtBoYlzxti4JBGwxXPwP3rtu6rY1JEOFsh1WmSEGE6Df2l9wtUQ0WAAD6bWgCxMiiRRv7TegxSeMtGn5QKuPC5lFuvzZvtJy1rR8WQwT7lVdHz32xLP2Rs4dayQPh08x3GsuI54d2kti2rcaSltGLRAOuODWc8KjYsPS6Ku4aN2NoQB5H9TEbHy2fsUNpNPMbCY54lH5bkgJtO4WmulnAHEApZG07u8G+Kk3a15npXemWgUW3N9gGtJ2XmieendXqS3RK1ZUYDsnAWW2jCZkjGB6jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBXBgkqhkiG9w0BCRQxSh5IAGEAYgBjAGYAOABhADUAOQAtAGYAZQAzADIALQA0AGIAZgA0AC0AYQBiAGMAZgAtADkAOAA3AGIANwBmADgANwAzADEANgBjMGsGCSsGAQQBgjcRATFeHlwATQBpAGMAcgBvAHMAbwBmAHQAIABFAG4AaABhAG4AYwBlAGQAIABDAHIAeQBwAHQAbwBnAHIAYQBwAGgAaQBjACAAUAByAG8AdgBpAGQAZQByACAAdgAxAC4AMDCCA38GCSqGSIb3DQEHBqCCA3AwggNsAgEAMIIDZQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQMwDgQIbQcNiyMGeL4CAgfQgIIDOPSSP6SqJGYsXCPWCMQU0TqdqT55fauuadduHaAlQpyN0MVYdu9QguLqMaJjxWa8Coy3K7LAOcqJ4S8FWV2SrpTuNHPv7vrtZfYhltGl+vW8rIrogeGTV4T/45oc5605HSiyItOWX8vHYKnAJkRMW4ICZXgY3dZVb+fr6yPIRFvMywqzwkViVOJIKjZN2lsAQ0xlLU0Fu/va9uxADwI2ZUKfo+6nX6bITkLvUSJoNCvZ5e7UITasxC4ZauHdMZch38N7BPH2usrAQfr3omYcScFzSeN2onhE1JBURCPDQa8+CGiWMm6mxboUOIcUGasaDqYQ8pSAgZZqQf8lU0uH4FP/z/5Dd7PniDHjvqlwYa+vB6flgtrwh6jYFeTKluhkucLrfzusFR52kHpg8K4GaUL8MhvlsNdd8iHSFjfyOdXRpY9re+B8X9Eorx0Z3xsSsVWaCwmI+Spq+BZ5CSXVm9Um6ogeM0et8JciZS2yFLIlbl2o4U1BWblskYfj/29jm4/2UKjKzORZnpjE0O+qP4hReSrx6os9dr8sNkq/7OafZock8zXjXaOpW6bqB1V5NWMPiWiPxPxfRi1F/MQp6CPY03H7MsDALEFcF7MmtY4YpN/+FFfrrOwS19Fg0OnQzNIgFpSRywX9dxyKICt/wbvhM+RLpUN50ZekFVska+C27hJRJEZ9rSdVhOVdL1UNknuwqF1cCQQriaNsnCbeVHN3/Wgsms9+Kt+glBNyZQlU8Fk+fafcQFI5MlxyMmARVwnC70F8AScnJPPFVZIdgIrvOXCDrEh8wFgkVM/MHkaTZUF51yy3pbIZaPmNd5dsUfEvMsW2IY6esnUUxPRQUUoi5Ib8EFHdiQJrYY3ELfZRXb2I1Xd0DVhlGzogn3CXZtXR2gSAakdB0qrLpXMSJNS65SS2tVTD7SI8OpUGNRjthQIAEEROPue10geFUwarWi/3jGMG529SzwDUJ4g0ix6VtcuLIDYFNdClDTyEyeV1f70NSG2QVXPIpeF7WQ8jWK7kenGaqqna4C4FYQpQk9vJP171nUXLR2mUR11bo1N4hcVhXnJls5yo9u14BB9CqVKXeDl7M5zwMDswHzAHBgUrDgMCGgQUT6Tjuka1G4O/ZCBxO7NBR34YUYQEFLaheEdRIIuxUd25/hl5vf2SFuZuAgIH0A==", + "password" : "password" + } + } + }, + "responses": { + "200": { }, + "202": { } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/UpdateShortTermRetentionPolicy.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/UpdateShortTermRetentionPolicy.json new file mode 100644 index 000000000000..b2cccb516116 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/UpdateShortTermRetentionPolicy.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup", + "serverName": "testsvr", + "databaseName": "testdb", + "policyName" : "default", + "api-version": "2017-10-01-preview", + "parameters": { + "properties" : { + "retentionDays": 14 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testsvr/databases/testdb/backupLongTermRetentionPolicies/default", + "name": "default", + "type": "Microsoft.Sql/locations/servers/databases/backupShortTermRetentionPolicies", + "properties" : { + "retentionDays": 14 + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json index 5c87d3747b3d..188855b33c45 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json @@ -477,44 +477,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "InstanceFailoverGroup": { "description": "An instance failover group.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json new file mode 100644 index 000000000000..91d63c39fd80 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json @@ -0,0 +1,399 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-10-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}/backupShortTermRetentionPolicies/{policyName}": { + "get": { + "tags": [ + "BackupShortTermRetentionPolicies" + ], + "description": "Gets a database's short term retention policy.", + "operationId": "BackupShortTermRetentionPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "policyName", + "in": "path", + "description": "The policy name. Should always be \"default\".", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ShortTermRetentionPolicyName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the policy.", + "schema": { + "$ref": "#/definitions/BackupShortTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Get the short term retention policy for the database.": { + "$ref": "./examples/GetShortTermRetentionPolicy.json" + } + } + }, + "put": { + "tags": [ + "BackupShortTermRetentionPolicies" + ], + "description": "Updates a database's short term retention policy.", + "operationId": "BackupShortTermRetentionPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "policyName", + "in": "path", + "description": "The policy name. Should always be \"default\".", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ShortTermRetentionPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The short term retention policy info.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupShortTermRetentionPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the policy.", + "schema": { + "$ref": "#/definitions/BackupShortTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 UpdateShortTermRetentionFeatureNotSupportedForEdition - This feature is not available for the selected database's edition {0}.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update the short term retention policy for the database.": { + "$ref": "./examples/UpdateShortTermRetentionPolicy.json" + } + } + }, + "patch": { + "tags": [ + "BackupShortTermRetentionPolicies" + ], + "description": "Updates a database's short term retention policy.", + "operationId": "BackupShortTermRetentionPolicies_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "policyName", + "in": "path", + "description": "The policy name. Should always be \"default\".", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ShortTermRetentionPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The short term retention policy info.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupShortTermRetentionPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the policy.", + "schema": { + "$ref": "#/definitions/BackupShortTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 UpdateShortTermRetentionFeatureNotSupportedForEdition - This feature is not available for the selected database's edition {0}.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update the short term retention policy for the database.": { + "$ref": "./examples/UpdateShortTermRetentionPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies": { + "get": { + "tags": [ + "BackupShortTermRetentionPolicies" + ], + "description": "Gets a database's short term retention policy.", + "operationId": "BackupShortTermRetentionPolicies_ListByDatabase", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the policy.", + "schema": { + "$ref": "#/definitions/BackupShortTermRetentionPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get the short term retention policy for the database.": { + "$ref": "./examples/ListShortTermRetentionPoliciesByDatabase.json" + } + } + } + } + }, + "definitions": { + "BackupShortTermRetentionPolicyProperties": { + "description": "Properties of a short term retention policy", + "type": "object", + "properties": { + "retentionDays": { + "format": "int32", + "description": "The backup retention period in days. This is how many days Point-in-Time Restore will be supported.", + "type": "integer" + } + } + }, + "BackupShortTermRetentionPolicy": { + "description": "A short term retention policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BackupShortTermRetentionPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "BackupShortTermRetentionPolicyListResult": { + "description": "A list of short term retention policies.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/BackupShortTermRetentionPolicy" + }, + "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" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "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" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/advisors.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/advisors.json index b22624afb065..aabd5b99f36b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/advisors.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/advisors.json @@ -25,16 +25,16 @@ "operationId": "ServerAdvisors_ListByServer", "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -64,7 +64,7 @@ "operationId": "ServerAdvisors_Get", "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -77,10 +77,10 @@ "type": "string" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -108,7 +108,7 @@ "operationId": "ServerAdvisors_Update", "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -130,10 +130,10 @@ } }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -161,7 +161,7 @@ "operationId": "ServerAdvisors_CreateOrUpdate", "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -183,10 +183,10 @@ } }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -213,7 +213,7 @@ "operationId": "DatabaseAdvisors_ListByDatabase", "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -222,10 +222,10 @@ "$ref": "#/parameters/DatabaseNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -252,7 +252,7 @@ "operationId": "DatabaseAdvisors_Get", "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -264,10 +264,10 @@ "$ref": "#/parameters/AdvisorNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -292,7 +292,7 @@ "operationId": "DatabaseAdvisors_CreateOrUpdate", "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -313,10 +313,10 @@ } }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -336,38 +336,6 @@ } }, "definitions": { - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "AdvisorProperties": { "description": "Properties for a Database, Server or Elastic Pool Advisor.", "required": [ @@ -421,7 +389,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -456,30 +424,6 @@ } }, "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", 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 index a7c8f5d3039f..eb32aab790d8 100644 --- 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 @@ -30,13 +30,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -85,13 +85,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -161,13 +161,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -195,35 +195,6 @@ } }, "definitions": { - "Resource": { - "description": "ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, "BackupLongTermRetentionPolicyProperties": { "properties": { "state": { @@ -260,7 +231,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "A backup long term retention policy" @@ -280,28 +251,6 @@ } }, "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", 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 index bbfc2c5c81ae..0734f5b879f6 100644 --- 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 @@ -30,13 +30,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -78,13 +78,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -147,13 +147,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -174,35 +174,6 @@ } }, "definitions": { - "Resource": { - "description": "ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, "BackupLongTermRetentionVaultProperties": { "properties": { "recoveryServicesVaultResourceId": { @@ -228,7 +199,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "A backup long term retention vault" @@ -248,28 +219,6 @@ } }, "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backups.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backups.json index 7c64253f16db..05cc6ba1c558 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backups.json @@ -30,13 +30,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -73,13 +73,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -112,13 +112,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -155,13 +155,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -182,68 +182,6 @@ } }, "definitions": { - "Resource": { - "description": "ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "ARM tracked top level resource.", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags." - }, - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "Resource location." - } - }, - "required": [ - "location" - ], - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, "RecoverableDatabaseProperties": { "properties": { "edition": { @@ -280,7 +218,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "A recoverable database" @@ -361,7 +299,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "A restorable dropped database" @@ -381,28 +319,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/capabilities.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/capabilities.json index f9c50f55e1c9..e4df346db4b4 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/capabilities.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/capabilities.json @@ -25,10 +25,10 @@ "description": "Gets the capabilities available for the specified location.", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { "name": "locationId", @@ -368,28 +368,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", @@ -411,4 +389,4 @@ } } } - + diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json index 67e700ca1247..1e14f15cfcb7 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json @@ -36,10 +36,10 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { "name":"parameters", @@ -122,28 +122,6 @@ } }, "parameters":{ - "SubscriptionIdParameter":{ - "name":"subscriptionId", - "in":"path", - "required":true, - "type":"string", - "description":"The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter":{ - "name":"api-version", - "in":"query", - "required":true, - "type":"string", - "description":"The API version to use for the request." - }, - "ResourceGroupParameter":{ - "name":"resourceGroupName", - "in":"path", - "required":true, - "type":"string", - "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.", - "x-ms-parameter-location":"method" - }, "ServerNameParameter":{ "name":"serverName", "in":"path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/connectionPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/connectionPolicies.json index c3a4f3e94974..1b6f6199449f 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/connectionPolicies.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/connectionPolicies.json @@ -28,13 +28,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -78,13 +78,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -143,64 +143,13 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "A server secure connection policy." - }, - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource":{ - "description":"ARM proxy resource.", - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/dataMasking.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/dataMasking.json index 5295dab97b91..5a37b54f312a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/dataMasking.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/dataMasking.json @@ -29,13 +29,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -76,13 +76,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -119,13 +119,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -181,13 +181,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -268,7 +268,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a database data masking policy." @@ -373,7 +373,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a database data masking rule." @@ -389,60 +389,9 @@ } }, "description": "The response to a list data masking rules request." - }, - "Resource": { - "description": "ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json index 909a308ff2ba..0a3ff00e7d03 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json @@ -28,10 +28,10 @@ }, "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -56,7 +56,7 @@ } }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -83,10 +83,10 @@ }, "parameters": [ { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -120,7 +120,7 @@ } }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -144,68 +144,6 @@ } }, "definitions": { - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource":{ - "description":"ARM tracked top level resource.", - "properties":{ - "tags":{ - "type":"object", - "additionalProperties":{ - "type":"string" - }, - "x-ms-mutability":[ - "read", - "create", - "update" - ], - "description":"Resource tags." - }, - "location":{ - "type":"string", - "x-ms-mutability":[ - "read", - "create" - ], - "description":"Resource location." - } - }, - "required":[ - "location" - ], - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, - "ProxyResource":{ - "description":"ARM proxy resource.", - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, "DatabaseSecurityAlertPolicy": { "description": "Contains information about a database Threat Detection policy.", "type": "object", @@ -231,7 +169,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ] }, @@ -302,28 +240,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription ID that identifies an Azure subscription.", - "required": true, - "type": "string" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "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, - "x-ms-parameter-location": "method", - "type": "string" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databases.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databases.json index 4f4aec4ad8a3..be1a2425a486 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databases.json @@ -30,13 +30,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -74,13 +74,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -151,13 +151,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -214,13 +214,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -268,13 +268,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -309,13 +309,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -358,13 +358,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -407,13 +407,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -457,13 +457,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -503,13 +503,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -553,13 +553,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -587,60 +587,6 @@ } }, "definitions":{ - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource":true - }, - "TrackedResource":{ - "description":"ARM tracked top level resource.", - "properties":{ - "tags":{ - "type":"object", - "additionalProperties":{ - "type":"string" - }, - "x-ms-mutability":[ - "read", - "create", - "update" - ], - "description":"Resource tags." - }, - "location":{ - "type":"string", - "x-ms-mutability":[ - "read", - "create" - ], - "description":"Resource location." - } - }, - "required":[ - "location" - ], - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, "DatabaseProperties":{ "properties":{ "collation":{ @@ -1003,7 +949,7 @@ }, "allOf":[ { - "$ref":"#/definitions/TrackedResource" + "$ref":"../../../common/v1/types.json#/definitions/TrackedResource" } ], "description":"Represents a database." @@ -1025,7 +971,7 @@ }, "allOf":[ { - "$ref":"#/definitions/Resource" + "$ref":"../../../common/v1/types.json#/definitions/Resource" } ], "description":"Represents a database update." @@ -1047,28 +993,6 @@ } }, "parameters":{ - "SubscriptionIdParameter":{ - "name":"subscriptionId", - "in":"path", - "required":true, - "type":"string", - "description":"The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter":{ - "name":"api-version", - "in":"query", - "required":true, - "type":"string", - "description":"The API version to use for the request." - }, - "ResourceGroupParameter":{ - "name":"resourceGroupName", - "in":"path", - "required":true, - "type":"string", - "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.", - "x-ms-parameter-location":"method" - }, "ServerNameParameter":{ "name":"serverName", "in":"path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/deprecated.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/deprecated.json index a99900406024..495703f4dc95 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/deprecated.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/deprecated.json @@ -31,13 +31,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -72,13 +72,13 @@ "description":"Gets database extensions.", "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -134,28 +134,6 @@ } }, "parameters":{ - "SubscriptionIdParameter":{ - "name":"subscriptionId", - "in":"path", - "required":true, - "type":"string", - "description":"The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter":{ - "name":"api-version", - "in":"query", - "required":true, - "type":"string", - "description":"The API version to use for the request." - }, - "ResourceGroupParameter":{ - "name":"resourceGroupName", - "in":"path", - "required":true, - "type":"string", - "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.", - "x-ms-parameter-location":"method" - }, "ServerNameParameter":{ "name":"serverName", "in":"path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/disasterRecoveryConfigurations.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/disasterRecoveryConfigurations.json index fb8a8dfaab60..dc304a46be0f 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/disasterRecoveryConfigurations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/disasterRecoveryConfigurations.json @@ -28,13 +28,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -66,13 +66,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -109,13 +109,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -160,13 +160,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -201,13 +201,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -230,7 +230,7 @@ }, "x-ms-long-running-operation": true } - }, + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/disasterRecoveryConfiguration/{disasterRecoveryConfigurationName}/forceFailoverAllowDataLoss": { "post": { "tags": [ @@ -243,13 +243,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -275,35 +275,6 @@ } }, "definitions": { - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource":{ - "description":"ARM proxy resource.", - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, "DisasterRecoveryConfigurationProperties": { "properties": { "status": { @@ -372,20 +343,20 @@ "type": { "readOnly": true, "type": "string", - "description": "Type of resource this is." + "description": "Type of resource this is." }, "location": { "type": "string", "description": "Location of the server that contains this disaster recovery configuration.", "readOnly": true - } + } }, "required": [ "properties" ], "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a disaster recovery configuration." @@ -404,28 +375,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/elasticPools.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/elasticPools.json index aa52b9c1517a..50765eccb344 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/elasticPools.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/elasticPools.json @@ -33,13 +33,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -96,13 +96,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -150,13 +150,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -191,13 +191,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -234,13 +234,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -261,60 +261,6 @@ } }, "definitions":{ - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource":true - }, - "TrackedResource":{ - "description":"ARM tracked top level resource.", - "properties":{ - "tags":{ - "type":"object", - "additionalProperties":{ - "type":"string" - }, - "x-ms-mutability":[ - "read", - "create", - "update" - ], - "description":"Resource tags." - }, - "location":{ - "type":"string", - "x-ms-mutability":[ - "read", - "create" - ], - "description":"Resource location." - } - }, - "required":[ - "location" - ], - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, "ElasticPoolProperties":{ "properties":{ "creationDate":{ @@ -396,7 +342,7 @@ }, "allOf":[ { - "$ref":"#/definitions/TrackedResource" + "$ref":"../../../common/v1/types.json#/definitions/TrackedResource" } ], "description":"Represents a database elastic pool." @@ -418,7 +364,7 @@ }, "allOf":[ { - "$ref":"#/definitions/Resource" + "$ref":"../../../common/v1/types.json#/definitions/Resource" } ], "description":"Represents an elastic pool update." @@ -440,28 +386,6 @@ } }, "parameters":{ - "SubscriptionIdParameter":{ - "name":"subscriptionId", - "in":"path", - "required":true, - "type":"string", - "description":"The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter":{ - "name":"api-version", - "in":"query", - "required":true, - "type":"string", - "description":"The API version to use for the request." - }, - "ResourceGroupParameter":{ - "name":"resourceGroupName", - "in":"path", - "required":true, - "type":"string", - "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.", - "x-ms-parameter-location":"method" - }, "ServerNameParameter":{ "name":"serverName", "in":"path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/CapabilitiesList.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/CapabilitiesList.json index 2bbf0b8d9898..b154e81320a3 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/CapabilitiesList.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/CapabilitiesList.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "locationId": "eastus2euap", - "api-version": "2014-04-01", + "api-version": "2014-04-01" }, "responses": { "200": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/firewallRules.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/firewallRules.json index de19a56c3c6b..b19be7fd3962 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/firewallRules.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/firewallRules.json @@ -29,13 +29,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -83,13 +83,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -122,13 +122,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -163,13 +163,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -190,35 +190,6 @@ } }, "definitions": { - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource":{ - "description":"ARM proxy resource.", - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, "FirewallRuleProperties": { "properties": { "startIpAddress": { @@ -258,7 +229,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a server firewall rule." @@ -277,28 +248,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json index 2d0d5201cbba..5ff460891215 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json @@ -28,13 +28,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -85,13 +85,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -129,13 +129,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -206,7 +206,7 @@ ], "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "A database geo backup policy." @@ -222,60 +222,9 @@ } }, "description": "The response to a list geo backup policies request." - }, - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource":{ - "description":"ARM proxy resource.", - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/importExport.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/importExport.json index c55f12be4e06..7eebc842a158 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/importExport.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/importExport.json @@ -25,13 +25,13 @@ "description": "Imports a bacpac into a new database. ", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -75,13 +75,13 @@ "description": "Creates an import operation that imports a bacpac into an existing database. The existing database must be empty.", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -146,13 +146,13 @@ "description": "Exports a database to a bacpac.", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -194,68 +194,6 @@ } }, "definitions": { - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource":{ - "description":"ARM tracked top level resource.", - "properties":{ - "tags":{ - "type":"object", - "additionalProperties":{ - "type":"string" - }, - "x-ms-mutability":[ - "read", - "create", - "update" - ], - "description":"Resource tags." - }, - "location":{ - "type":"string", - "x-ms-mutability":[ - "read", - "create" - ], - "description":"Resource location." - } - }, - "required":[ - "location" - ], - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, - "ProxyResource":{ - "description":"ARM proxy resource.", - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, "ImportExtensionProperties": { "properties": { "operationMode": { @@ -303,7 +241,7 @@ } }, "allOf": [{ - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" }], "description": "Response for Import/Export Get operation." }, @@ -514,28 +452,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/metrics.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/metrics.json index 409f6f5f5c87..830b4e798b50 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/metrics.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/metrics.json @@ -28,13 +28,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -79,13 +79,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -123,13 +123,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -174,13 +174,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -208,35 +208,6 @@ } }, "definitions": { - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource":{ - "description":"ARM proxy resource.", - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, "MetricValue": { "properties": { "count": { @@ -424,28 +395,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/operations.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/operations.json index 18f25646152c..d2a88c87c591 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/operations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/operations.json @@ -28,7 +28,7 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -88,20 +88,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - } }, "securityDefinitions": { "azure_auth": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/queries.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/queries.json index f5fbb073f3c0..371278a2b83d 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/queries.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/queries.json @@ -28,13 +28,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -68,13 +68,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -115,13 +115,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -373,28 +373,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json index be51abf75f75..c6d725c3029c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json @@ -30,13 +30,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -73,13 +73,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -112,13 +112,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -146,68 +146,6 @@ } }, "definitions": { - "Resource": { - "description": "ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "ARM tracked top level resource.", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags." - }, - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "Resource location." - } - }, - "required": [ - "location" - ], - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, "RecommendedElasticPoolMetric": { "properties": { "dateTime": { @@ -317,7 +255,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a recommented elastic pool." @@ -354,28 +292,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json index 4c65683994ee..c76f6dbac969 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json @@ -30,13 +30,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -73,13 +73,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -112,13 +112,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -146,68 +146,6 @@ } }, "definitions": { - "Resource": { - "description": "ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "ARM tracked top level resource.", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags." - }, - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "Resource location." - } - }, - "required": [ - "location" - ], - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, "RecommendedElasticPoolMetric": { "properties": { "dateTime": { @@ -292,7 +230,7 @@ "readOnly": true, "type": "array", "items": { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../common/v1/types.json#/definitions/TrackedResource" }, "description": "The list of databases in this pool. Expanded property" }, @@ -317,7 +255,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a recommented elastic pool." @@ -354,28 +292,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/replicationLinks.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/replicationLinks.json index bdafeb301038..e92ac8ce0825 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/replicationLinks.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/replicationLinks.json @@ -28,13 +28,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -74,13 +74,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -122,13 +122,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -171,13 +171,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -220,13 +220,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -254,35 +254,6 @@ } }, "definitions": { - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource":{ - "description":"ARM proxy resource.", - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, "ReplicationLinkProperties": { "properties": { "isTerminationAllowed": { @@ -390,7 +361,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a database replication link." @@ -409,28 +380,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/restorePoints.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/restorePoints.json index 3e2269dad36a..530b472a5b92 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/restorePoints.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/restorePoints.json @@ -29,13 +29,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -102,7 +102,7 @@ }, "allOf": [ { - "$ref": "./backups.json#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "A database restore point." @@ -122,28 +122,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json index b02250f591a5..2be702e77e02 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json @@ -30,13 +30,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -89,13 +89,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -139,13 +139,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -178,13 +178,13 @@ }, "parameters":[ { - "$ref":"#/parameters/ApiVersionParameter" + "$ref":"../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref":"#/parameters/SubscriptionIdParameter" + "$ref":"../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref":"#/parameters/ResourceGroupParameter" + "$ref":"../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref":"#/parameters/ServerNameParameter" @@ -205,35 +205,6 @@ } }, "definitions":{ - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource":{ - "description":"ARM proxy resource.", - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, "ServerAdministratorProperties":{ "properties":{ "administratorType":{ @@ -279,7 +250,7 @@ }, "allOf":[ { - "$ref":"#/definitions/ProxyResource" + "$ref":"../../../common/v1/types.json#/definitions/ProxyResource" } ], "description":"An server Active Directory Administrator." @@ -298,28 +269,6 @@ } }, "parameters":{ - "SubscriptionIdParameter":{ - "name":"subscriptionId", - "in":"path", - "required":true, - "type":"string", - "description":"The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter":{ - "name":"api-version", - "in":"query", - "required":true, - "type":"string", - "description":"The API version to use for the request." - }, - "ResourceGroupParameter":{ - "name":"resourceGroupName", - "in":"path", - "required":true, - "type":"string", - "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.", - "x-ms-parameter-location":"method" - }, "ServerNameParameter":{ "name":"serverName", "in":"path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json index d211debd067b..090b650f4008 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json @@ -28,13 +28,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -64,13 +64,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -103,13 +103,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -157,13 +157,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -223,7 +223,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Server communication link." @@ -239,60 +239,9 @@ } }, "description": "A list of server communication links." - }, - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource":{ - "description":"ARM proxy resource.", - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/servers.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/servers.json index bde6a4043862..c4b9d983a12f 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/servers.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/servers.json @@ -28,10 +28,10 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -60,13 +60,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -108,13 +108,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -149,13 +149,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -181,13 +181,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -215,13 +215,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" } ], "responses": { @@ -239,68 +239,6 @@ } }, "definitions": { - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource":{ - "description":"ARM tracked top level resource.", - "properties":{ - "tags":{ - "type":"object", - "additionalProperties":{ - "type":"string" - }, - "x-ms-mutability":[ - "read", - "create", - "update" - ], - "description":"Resource tags." - }, - "location":{ - "type":"string", - "x-ms-mutability":[ - "read", - "create" - ], - "description":"Resource location." - } - }, - "required":[ - "location" - ], - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, - "ProxyResource":{ - "description":"ARM proxy resource.", - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, "ServerProperties": { "properties": { "fullyQualifiedDomainName": { @@ -365,7 +303,7 @@ }, "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../common/v1/types.json#/definitions/TrackedResource" } ], "description": "Represents a server." @@ -387,7 +325,7 @@ }, "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "../../../common/v1/types.json#/definitions/Resource" } ], "description": "Represents an update to a server." @@ -407,28 +345,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/serviceObjectives.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/serviceObjectives.json index 42be84471fb2..7c091d8d1b9c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/serviceObjectives.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/serviceObjectives.json @@ -28,13 +28,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -69,13 +69,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -96,35 +96,6 @@ } }, "definitions": { - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource":{ - "description":"ARM proxy resource.", - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, "ServiceObjective": { "properties": { "properties": { @@ -135,7 +106,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a database service objective." @@ -188,28 +159,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/sql.core.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/sql.core.json index abf2348732b9..e405f6cd5f79 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/sql.core.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/sql.core.json @@ -28,13 +28,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -72,13 +72,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -116,13 +116,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -164,13 +164,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -208,13 +208,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -265,13 +265,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -309,13 +309,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -346,68 +346,6 @@ } }, "definitions": { - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource":{ - "description":"ARM tracked top level resource.", - "properties":{ - "tags":{ - "type":"object", - "additionalProperties":{ - "type":"string" - }, - "x-ms-mutability":[ - "read", - "create", - "update" - ], - "description":"Resource tags." - }, - "location":{ - "type":"string", - "x-ms-mutability":[ - "read", - "create" - ], - "description":"Resource location." - } - }, - "required":[ - "location" - ], - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, - "ProxyResource":{ - "description":"ARM proxy resource.", - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, "ElasticPoolActivityProperties": { "properties": { "endTime": { @@ -546,7 +484,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents the activity on an elastic pool." @@ -669,7 +607,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents the activity on an elastic pool." @@ -810,7 +748,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a database recommended index." @@ -846,7 +784,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a database transparent data encryption configuration." @@ -979,7 +917,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Service Tier Advisor." @@ -1158,7 +1096,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a database transparent data encryption Scan." @@ -1178,28 +1116,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/tableAuditing.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/tableAuditing.json index 6932e5519f76..0aa5073f4f95 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/tableAuditing.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/tableAuditing.json @@ -29,7 +29,7 @@ }, "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -38,10 +38,10 @@ "$ref": "#/parameters/TableAuditingPolicyNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -65,7 +65,7 @@ }, "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -83,10 +83,10 @@ } }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -118,16 +118,16 @@ }, "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -153,7 +153,7 @@ }, "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -169,10 +169,10 @@ "$ref": "#/parameters/TableAuditingPolicyNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -196,7 +196,7 @@ }, "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -221,10 +221,10 @@ } }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -256,7 +256,7 @@ }, "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -269,10 +269,10 @@ "type": "string" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -298,7 +298,7 @@ }, "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -314,10 +314,10 @@ "$ref": "#/parameters/ConnectionPolicyNameParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -341,7 +341,7 @@ }, "parameters": [ { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -366,10 +366,10 @@ } }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -502,7 +502,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -523,44 +523,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "DatabaseTableAuditingPolicy": { "description": "A database table auditing policy.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -586,7 +554,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -635,30 +603,6 @@ } }, "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", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/usages.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/usages.json index 0b224c180ef3..45cb444a751a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/usages.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/usages.json @@ -28,13 +28,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -65,13 +65,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupParameter" + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ServerNameParameter" @@ -99,35 +99,6 @@ } }, "definitions": { - "Resource":{ - "description":"ARM 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." - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource":{ - "description":"ARM proxy resource.", - "allOf":[ - { - "$ref":"#/definitions/Resource" - } - ] - }, "ServerUsage": { "properties": { "name": { @@ -242,28 +213,6 @@ } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "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.", - "x-ms-parameter-location": "method" - }, "ServerNameParameter": { "name": "serverName", "in": "path", diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2015-05-01/usages.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2015-05-01/usages.json index dafa493d398f..2cded2b4cee1 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2015-05-01/usages.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2015-05-01/usages.json @@ -155,44 +155,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "SubscriptionUsage": { "description": "Usage Metric of a Subscription in a Location.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/common/v1/types.json b/specification/sql/resource-manager/common/v1/types.json new file mode 100644 index 000000000000..fae061037f0f --- /dev/null +++ b/specification/sql/resource-manager/common/v1/types.json @@ -0,0 +1,159 @@ +{ + "swagger":"2.0", + "info":{ + "version":"1.0", + "title":"Common types" + }, + "paths":{ + + }, + "definitions":{ + "Resource":{ + "description":"ARM resource.", + "type":"object", + "properties":{ + "id":{ + "description":"Resource ID.", + "type":"string", + "readOnly":true + }, + "name":{ + "description":"Resource name.", + "type":"string", + "readOnly":true + }, + "type":{ + "description":"Resource type.", + "type":"string", + "readOnly":true + } + }, + "x-ms-azure-resource":true + }, + "ProxyResource":{ + "description":"ARM proxy resource.", + "type":"object", + "allOf":[ + { + "$ref":"#/definitions/Resource" + } + ], + "properties":{ + + } + }, + "TrackedResource":{ + "description":"ARM tracked top level resource.", + "required":[ + "location" + ], + "type":"object", + "allOf":[ + { + "$ref":"#/definitions/Resource" + } + ], + "properties":{ + "location":{ + "description":"Resource location.", + "type":"string", + "x-ms-mutability":[ + "read", + "create" + ] + }, + "tags":{ + "description":"Resource tags.", + "type":"object", + "additionalProperties":{ + "type":"string" + } + } + } + }, + "Sku":{ + "description":"The resource model definition representing SKU", + "properties":{ + "name":{ + "type":"string", + "description":"The name of the SKU. Ex - P3. It is typically a letter+number code" + }, + "tier":{ + "type":"string", + "description":"This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." + }, + "size":{ + "type":"string", + "description":"The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family":{ + "type":"string", + "description":"If the service has different generations of hardware, for the same SKU, then that can be captured here." + }, + "capacity":{ + "type":"integer", + "format":"int32", + "description":"If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." + } + }, + "required":[ + "name" + ] + }, + "ResourceIdentity":{ + "description":"Azure Active Directory identity configuration for a resource.", + "type":"object", + "properties":{ + "principalId":{ + "format":"uuid", + "description":"The Azure Active Directory principal id.", + "type":"string", + "readOnly":true + }, + "type":{ + "description":"The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.", + "enum":[ + "SystemAssigned" + ], + "type":"string", + "x-ms-enum":{ + "name":"IdentityType", + "modelAsString":true + } + }, + "tenantId":{ + "format":"uuid", + "description":"The Azure Active Directory tenant id.", + "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" + } + } + } \ No newline at end of file diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index fe77432eee52..16a08ea194ac 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -39,6 +39,19 @@ This section contains the "composite-v3" set of APIs, which is composed from a s APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +Differences in v3 (compared to v2): + - Decoupled database and recommended elastic pool APIs + - `-2014-04-01/recommendedElasticPools.json` + - `+2014-04-01/recommendedElasticPoolsDecoupled.json` + - Updated to new Sku-based API for databases and elastic pools + - `-2014-04-01/capabilities.json` + - `-2014-04-01/databases.json` + - `-2014-04-01/elasticPools.json` + - `+2017-10-01-preview/capabilities.json` + - `+2017-10-01-preview/databases.json` + - `+2017-10-01-preview/elasticPools.json` + ``` yaml $(tag) == 'package-composite-v3' input-file: - Microsoft.Sql/stable/2014-04-01/backups.json @@ -57,10 +70,10 @@ input-file: - Microsoft.Sql/stable/2014-04-01/serviceObjectives.json - Microsoft.Sql/stable/2014-04-01/sql.core.json - Microsoft.Sql/stable/2014-04-01/usages.json -- Microsoft.Sql/preview/2015-05-01-preview/blobAuditingPolicies.json - Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json - Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json - Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json - Microsoft.Sql/preview/2015-05-01-preview/operations.json - Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json - Microsoft.Sql/preview/2015-05-01-preview/servers.json @@ -69,15 +82,28 @@ input-file: - 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/virtualNetworkRules.json +- Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json +- Microsoft.Sql/preview/2017-03-01-preview/jobs.json - Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json +- Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json +- Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json - Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json - Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json +- Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json - Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json - Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json - Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json - Microsoft.Sql/preview/2017-10-01-preview/capabilities.json - Microsoft.Sql/preview/2017-10-01-preview/databases.json - Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json +- Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json +- Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json +- Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json +- Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json +- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json + # Needed when there is more than one input file override-info: @@ -92,6 +118,13 @@ This section contains the "composite-v2" set of APIs, which is composed from a s APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. +Differences in v2 (compared to v1): + +- Updated to LTRv2 + - `-201 4-04-01/backupLongTermRetentionPolicies.json` + - `-2014-04-01/backupLongTermRetentionVaults.json` + - `+2017-03-01-preview/longTermRetention.json` + ``` yaml $(tag) == 'package-composite-v2' input-file: - Microsoft.Sql/stable/2014-04-01/backups.json @@ -113,10 +146,10 @@ input-file: - Microsoft.Sql/stable/2014-04-01/serviceObjectives.json - Microsoft.Sql/stable/2014-04-01/sql.core.json - Microsoft.Sql/stable/2014-04-01/usages.json -- Microsoft.Sql/preview/2015-05-01-preview/blobAuditingPolicies.json - Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json - Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json - Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json - Microsoft.Sql/preview/2015-05-01-preview/operations.json - Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json - Microsoft.Sql/preview/2015-05-01-preview/servers.json @@ -125,13 +158,25 @@ input-file: - 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/virtualNetworkRules.json +- Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json +- Microsoft.Sql/preview/2017-03-01-preview/jobs.json - Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json +- Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json - Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json +- Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json - Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json - Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json +- Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json - Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json - Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json - Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json +- Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json +- Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json +- Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json +- Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json +- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json # Needed when there is more than one input file override-info: @@ -142,7 +187,7 @@ override-info: These settings apply only when `--tag=package-composite-v1` is specified on the command line. -This section contains the "composite-v1" set of APIs, which is composed from a selection of api-versions that will remain backwards compatible with "v1" clients such as .NET SDK Microsoft.Azure.Management.Sql version 1.x. +This section contains the "composite-v1" set of APIs, which is composed from a selection of api-versions that will remain backwards compatible with "v1" clients such as .NET SDK Microsoft.Azure.Management.Sql version 1.12.0-preview and earlier. APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. @@ -169,10 +214,10 @@ input-file: - Microsoft.Sql/stable/2014-04-01/serviceObjectives.json - Microsoft.Sql/stable/2014-04-01/sql.core.json - Microsoft.Sql/stable/2014-04-01/usages.json -- Microsoft.Sql/preview/2015-05-01-preview/blobAuditingPolicies.json - Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json - Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json - Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json - Microsoft.Sql/preview/2015-05-01-preview/operations.json - Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json - Microsoft.Sql/preview/2015-05-01-preview/servers.json @@ -181,12 +226,24 @@ input-file: - 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/virtualNetworkRules.json +- Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json +- Microsoft.Sql/preview/2017-03-01-preview/jobs.json +- Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json - Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json +- Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json - Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json - Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json +- Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json - Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json - Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json - Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json +- Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json +- Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json +- Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json +- Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json +- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json # Needed when there is more than one input file override-info: @@ -223,10 +280,10 @@ input-file: - Microsoft.Sql/stable/2014-04-01/serviceObjectives.json - Microsoft.Sql/stable/2014-04-01/sql.core.json - Microsoft.Sql/stable/2014-04-01/usages.json -- Microsoft.Sql/preview/2015-05-01-preview/blobAuditingPolicies.json - Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json - Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json - Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json - Microsoft.Sql/preview/2015-05-01-preview/operations.json - Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json - Microsoft.Sql/preview/2015-05-01-preview/servers.json @@ -234,12 +291,19 @@ input-file: - 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/2017-03-01-preview/blobAuditing.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json - Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json - Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json - Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json +- Microsoft.Sql/preview/2017-03-01-preview/jobs.json +- Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json - Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json +- Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json - Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json - Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json +- Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json - Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json # Needed when there is more than one input file @@ -278,9 +342,10 @@ input-file: - Microsoft.Sql/stable/2014-04-01/sql.core.json - Microsoft.Sql/stable/2014-04-01/usages.json - Microsoft.Sql/stable/2015-05-01/capabilities.json -- Microsoft.Sql/preview/2015-05-01-preview/blobAuditingPolicies.json +- Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json - Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json - Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json - Microsoft.Sql/preview/2015-05-01-preview/operations.json - Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json - Microsoft.Sql/preview/2015-05-01-preview/servers.json @@ -330,12 +395,20 @@ This section contains all input swagger files for version 2017-10-01-preview. Al APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. -These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\2017-03-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` +These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2017-10-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` ``` yaml $(tag) == 'package-pure-2017-10-preview' input-file: - ./Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json - ./Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json + - ./Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json + - ./Microsoft.Sql/preview/2017-10-01-preview/capabilities.json + - ./Microsoft.Sql/preview/2017-10-01-preview/databases.json + - ./Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json + - ./Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json + - ./Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json + - ./Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json + - ./Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json # Needed when there is more than one input file override-info: @@ -350,15 +423,25 @@ This section contains all input swagger files for version 2017-03-01-preview. Al APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. -These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\2017-03-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` +These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2017-03-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` ``` yaml $(tag) == 'package-pure-2017-03-preview' input-file: + - ./Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json + - ./Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json - ./Microsoft.Sql/preview/2017-03-01-preview/databases.json + - ./Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json + - ./Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json + - ./Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json + - ./Microsoft.Sql/preview/2017-03-01-preview/jobs.json - ./Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json + - ./Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json - ./Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json - - ./Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json - ./Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json + - ./Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json + - ./Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json + - ./Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json + - ./Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json # Needed when there is more than one input file override-info: @@ -373,14 +456,17 @@ This section contains all input swagger files for version 2015-05-01-preview. Al APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. -These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\2015-05-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` +These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2015-05-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` ``` yaml $(tag) == 'package-pure-2015-05-preview' input-file: - ./Microsoft.Sql/preview/2015-05-01-preview/advisors.json - - ./Microsoft.Sql/preview/2015-05-01-preview/blobAuditingPolicies.json + - ./Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json + - ./Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json - ./Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json - ./Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json + - ./Microsoft.Sql/preview/2015-05-01-preview/firewallRules.json + - ./Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json - ./Microsoft.Sql/preview/2015-05-01-preview/operations.json - ./Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json - ./Microsoft.Sql/preview/2015-05-01-preview/servers.json @@ -403,7 +489,7 @@ This section contains all input swagger files for version 2014-04-01-preview. Al APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. -These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\2014-04-01\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` +These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\stable\2014-04-01\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` ``` yaml $(tag) == 'package-pure-2014-04' input-file: @@ -411,7 +497,6 @@ 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/capabilities.json - ./Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json - ./Microsoft.Sql/stable/2014-04-01/connectionPolicies.json @@ -429,6 +514,7 @@ input-file: - ./Microsoft.Sql/stable/2014-04-01/queries.json - ./Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json - ./Microsoft.Sql/stable/2014-04-01/replicationLinks.json + - ./Microsoft.Sql/stable/2014-04-01/restorePoints.json - ./Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json - ./Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json - ./Microsoft.Sql/stable/2014-04-01/servers.json @@ -453,9 +539,12 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_sql'] ``` ### C# @@ -531,7 +620,7 @@ These settings apply only when `--tag=package-2017-10-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-pure-2017-10-preview' && $(go) -output-folder: $(go-sdk-folder)/services/sql/mgmt/2017-10-01-preview/sql +output-folder: $(go-sdk-folder)/services/preview/sql/mgmt/2017-10-01-preview/sql ``` #### Tag: package-2017-03-preview and go @@ -540,7 +629,7 @@ These settings apply only when `--tag=package-2017-03-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-03-preview' && $(go) -output-folder: $(go-sdk-folder)/services/sql/mgmt/2017-03-01-preview/sql +output-folder: $(go-sdk-folder)/services/preview/sql/mgmt/2017-03-01-preview/sql ``` #### Tag: package-2015-05-preview and go @@ -549,7 +638,7 @@ These settings apply only when `--tag=package-2015-05-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-05-preview' && $(go) -output-folder: $(go-sdk-folder)/services/sql/mgmt/2015-05-01-preview/sql +output-folder: $(go-sdk-folder)/services/preview/sql/mgmt/2015-05-01-preview/sql ``` #### Tag: package-2014-04 and go @@ -567,15 +656,50 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.sql +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-sql +``` + + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-pure-2017-10-preview + - tag: package-2014-04 +``` + +### Tag: package-pure-2017-10-preview and java + +These settings apply only when `--tag=package-pure-2017-10-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-pure-2017-10-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.sql - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-sql + namespace: com.microsoft.azure.management.sql.v2017_10_01_preview + output-folder: $(azure-libraries-for-java-folder)/sql/resource-manager/v2017_10_01_preview +regenerate-manager: true +generate-interface: true ``` +### Tag: package-2014-04 and java + +These settings apply only when `--tag=package-2014-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2014-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.sql.v2014_04_01 + output-folder: $(azure-libraries-for-java-folder)/sql/resource-manager/v2014_04_01 +regenerate-manager: true +generate-interface: true +``` + + ## Validation ``` yaml @@ -586,4 +710,4 @@ directive: reason: This warning gives many positives for existing APIs that cannot be changed. - suppress: EnumInsteadOfBoolean reason: This warning gives many positives for existing APIs that cannot be changed. -``` +``` \ No newline at end of file diff --git a/specification/sql/resource-manager/readme.nodejs.md b/specification/sql/resource-manager/readme.nodejs.md index 99c55e772d6c..22409ccfa920 100644 --- a/specification/sql/resource-manager/readme.nodejs.md +++ b/specification/sql/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder=`. + +``` yaml $(tag) == 'package-pure-2014-04' && $(ruby) +namespace: "Azure::SQL::Mgmt::V2014_04_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_sql/lib +``` + +### Tag: package-pure-2015-05-preview and ruby + +These settings apply only when `--tag=package-pure-2015-05-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-pure-2015-05-preview' && $(ruby) +namespace: "Azure::SQL::Mgmt::V2015_05_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_sql/lib +``` + +### Tag: package-pure-2017-03-preview and ruby + +These settings apply only when `--tag=package-pure-2017-03-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-pure-2017-03-preview' && $(ruby) +namespace: "Azure::SQL::Mgmt::V2017_03_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_sql/lib +``` diff --git a/specification/storage/data-plane/Microsoft.StorageDataLake/preview/2018-06-17/DataLakeStorage.json b/specification/storage/data-plane/Microsoft.StorageDataLake/preview/2018-06-17/DataLakeStorage.json new file mode 100644 index 000000000000..58dedf05a766 --- /dev/null +++ b/specification/storage/data-plane/Microsoft.StorageDataLake/preview/2018-06-17/DataLakeStorage.json @@ -0,0 +1,1838 @@ +{ + "swagger": "2.0", + "info": { + "description": "Azure Data Lake Storage provides storage for Hadoop and other big data workloads.", + "title": "Azure Data Lake Storage REST API", + "version": "2018-06-17", + "x-ms-code-generation-settings": { + "internalConstructors": true, + "name": "DataLakeStorageClient" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{accountName}.{dnsSuffix}", + "parameters": [ + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/dnsSuffix" + } + ] + }, + "schemes": [ + "http", + "https" + ], + "produces": [ + "application/json" + ], + "tags": [ + { + "name": "Account Operations" + }, + { + "name": "Filesystem Operations" + }, + { + "name": "File and Directory Operations" + } + ], + "parameters": { + "Version": { + "description": "Specifies the version of the REST protocol used for processing the request. This is required when using shared key authorization.", + "in": "header", + "name": "x-ms-version", + "required": false, + "type": "string", + "x-ms-parameter-location": "client" + }, + "accountName": { + "description": "The Azure Storage account name.", + "in": "path", + "name": "accountName", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "dnsSuffix": { + "default": "dfs.core.windows.net", + "description": "The DNS suffix for the Azure Data Lake Storage endpoint.", + "in": "path", + "name": "dnsSuffix", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + }, + "definitions": { + "DataLakeStorageError": { + "properties": { + "error": { + "description": "The service error response object.", + "properties": { + "code": { + "description": "The service error code.", + "type": "string" + }, + "message": { + "description": "The service error message.", + "type": "string" + } + } + } + } + }, + "Path": { + "properties": { + "name": { + "type": "string" + }, + "isDirectory": { + "default": false, + "type": "boolean" + }, + "lastModified": { + "type": "string" + }, + "eTag": { + "type": "string" + }, + "contentLength": { + "type": "integer", + "format": "int64" + }, + "owner": { + "type": "string" + }, + "group": { + "type": "string" + }, + "permissions": { + "type": "string" + } + } + }, + "PathList": { + "properties": { + "paths": { + "type": "array", + "items": { + "$ref": "#/definitions/Path" + } + } + } + }, + "Filesystem": { + "properties": { + "name": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "eTag": { + "type": "string" + } + } + }, + "FilesystemList": { + "properties": { + "filesystems": { + "type": "array", + "items": { + "$ref": "#/definitions/Filesystem" + } + } + } + } + }, + "responses": { + "ErrorResponse": { + "description": "An error occurred. The possible HTTP status, code, and message strings are listed below:\n* 400 Bad Request, ContentLengthMustBeZero, \"The Content-Length request header must be zero.\"\n* 400 Bad Request, InvalidAuthenticationInfo, \"Authentication information is not given in the correct format. Check the value of Authorization header.\"\n* 400 Bad Request, InvalidFlushPosition, \"The uploaded data is not contiguous or the position query parameter value is not equal to the length of the file after appending the uploaded data.\"\n* 400 Bad Request, InvalidHeaderValue, \"The value for one of the HTTP headers is not in the correct format.\"\n* 400 Bad Request, InvalidHttpVerb, \"The HTTP verb specified is invalid - it is not recognized by the server.\"\n* 400 Bad Request, InvalidInput, \"One of the request inputs is not valid.\"\n* 400 Bad Request, InvalidPropertyName, \"A property name cannot be empty.\"\n* 400 Bad Request, InvalidPropertyName, \"The property name contains invalid characters.\"\n* 400 Bad Request, InvalidQueryParameterValue, \"Value for one of the query parameters specified in the request URI is invalid.\"\n* 400 Bad Request, InvalidResourceName, \"The specifed resource name contains invalid characters.\"\n* 400 Bad Request, InvalidSourceUri, \"The source URI is invalid.\"\n* 400 Bad Request, InvalidUri, \"The request URI is invalid.\"\n* 400 Bad Request, MissingRequiredHeader, \"An HTTP header that's mandatory for this request is not specified.\"\n* 400 Bad Request, MissingRequiredQueryParameter, \"A query parameter that's mandatory for this request is not specified.\"\n* 400 Bad Request, MultipleConditionHeadersNotSupported, \"Multiple condition headers are not supported.\"\n* 400 Bad Request, OutOfRangeInput, \"One of the request inputs is out of range.\"\n* 400 Bad Request, OutOfRangeQueryParameterValue, \"One of the query parameters specified in the request URI is outside the permissible range.\"\n* 400 Bad Request, UnsupportedHeader, \"One of the headers specified in the request is not supported.\"\n* 400 Bad Request, UnsupportedQueryParameter, \"One of the query parameters specified in the request URI is not supported.\"\n* 400 Bad Request, UnsupportedRestVersion, \"The specified Rest Version is Unsupported.\"\n* 403 Forbidden, AccountIsDisabled, \"The specified account is disabled.\"\n* 403 Forbidden, AuthorizationFailure, \"This request is not authorized to perform this operation.\"\n* 403 Forbidden, InsufficientAccountPermissions, \"The account being accessed does not have sufficient permissions to execute this operation.\"\n* 404 Not Found, FilesystemNotFound, \"The specified filesystem does not exist.\"\n* 404 Not Found, PathNotFound, \"The specified path does not exist.\"\n* 404 Not Found, RenameDestinationParentPathNotFound, \"The parent directory of the destination path does not exist.\"\n* 404 Not Found, ResourceNotFound, \"The specified resource does not exist.\"\n* 404 Not Found, SourcePathNotFound, \"The source path for a rename operation does not exist.\"\n* 405 Method Not Allowed, UnsupportedHttpVerb, \"The resource doesn't support the specified HTTP verb.\"\n* 409 Conflict, DestinationPathIsBeingDeleted, \"The specified destination path is marked to be deleted.\"\n* 409 Conflict, DirectoryNotEmpty, \"The recursive query parameter value must be true to delete a non-empty directory.\"\n* 409 Conflict, FilesystemAlreadyExists, \"The specified filesystem already exists.\"\n* 409 Conflict, FilesystemBeingDeleted, \"The specified filesystem is being deleted.\"\n* 409 Conflict, InvalidDestinationPath, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"* 409 Conflict, InvalidFlushOperation, \"The resource was created or modified by the Blob Service API and cannot be written to by the Data Lake Storage Service API.\"\n* 409 Conflict, InvalidRenameSourcePath, \"The source directory cannot be the same as the destination directory, nor can the destination be a subdirectory of the source directory.\"\n* 409 Conflict, InvalidSourceOrDestinationResourceType, \"The source and destination resource type must be identical.\"\n* 409 Conflict, LeaseAlreadyPresent, \"There is already a lease present.\"\n* 409 Conflict, LeaseIdMismatchWithLeaseOperation, \"The lease ID specified did not match the lease ID for the resource with the specified lease operation.\"\n* 409 Conflict, LeaseIsAlreadyBroken, \"The lease has already been broken and cannot be broken again.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, \"The lease ID matched, but the lease is currently in breaking state and cannot be acquired until it is broken.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeChanged, \"The lease ID matched, but the lease is currently in breaking state and cannot be changed.\"\n* 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, \"The lease ID matched, but the lease has been broken explicitly and cannot be renewed.\"\n* 409 Conflict, LeaseNameMismatch, \"The lease name specified did not match the existing lease name.\"\n* 409 Conflict, LeaseNotPresentWithLeaseOperation, \"The lease ID is not present with the specified lease operation.\"\n* 409 Conflict, PathAlreadyExists, \"The specified path already exists.\"\n* 409 Conflict, PathConflict, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"\n* 409 Conflict, SourcePathIsBeingDeleted, \"The specified source path is marked to be deleted.\"\n* 409 Conflict, ResourceTypeMismatch, \"The resource type specified in the request does not match the type of the resource.\"\n* 412 Precondition Failed, ConditionNotMet, \"The condition specified using HTTP conditional header(s) is not met.\"\n* 412 Precondition Failed, LeaseIdMismatch, \"The lease ID specified did not match the lease ID for the resource.\"\n* 412 Precondition Failed, LeaseIdMissing, \"There is currently a lease on the resource and no lease ID was specified in the request.\"\n* 412 Precondition Failed, LeaseNotPresent, \"There is currently no lease on the resource.\"\n* 412 Precondition Failed, LeaseLost, \"A lease ID was specified, but the lease for the resource has expired.\"\n* 412 Precondition Failed, SourceConditionNotMet, \"The source condition specified using HTTP conditional header(s) is not met.\"\n* 413 Request Entity Too Large, RequestBodyTooLarge, \"The request body is too large and exceeds the maximum permissible limit.\"\n* 416 Requested Range Not Satisfiable, InvalidRange, \"The range specified is invalid for the current size of the resource.\"\n* 500 Internal Server Error, InternalError, \"The server encountered an internal error. Please retry the request.\"\n* 500 Internal Server Error, OperationTimedOut, \"The operation could not be completed within the permitted time.\"\n* 503 Service Unavailable, ServerBusy, \"Egress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Ingress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Operations per second is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"The server is currently unable to receive requests. Please retry your request.\"", + "headers": { + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/DataLakeStorageError" + } + } + }, + "paths": { + "/": { + "get": { + "operationId": "Filesystem_List", + "summary": "List Filesystems", + "description": "List filesystems and their properties in given account.", + "x-ms-pageable": { + "itemName": "filesystems", + "nextLinkName": null + }, + "tags": [ + "Account Operations" + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-continuation": { + "description": "If the number of filesystems to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of list filesystem response. The default content type is application/json.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/FilesystemList" + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "resource", + "in": "query", + "description": "The value must be \"account\" for all account operations.", + "required": true, + "type": "string", + "enum": [ + "account" + ], + "x-ms-enum": { + "name": "AccountResourceType", + "modelAsString": false + } + }, + { + "name": "prefix", + "in": "query", + "description": "Filters results to filesystems within the specified prefix.", + "required": false, + "type": "string" + }, + { + "name": "continuation", + "in": "query", + "description": "The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.", + "required": false, + "type": "string" + }, + { + "name": "maxResults", + "in": "query", + "description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.", + "format": "int32", + "minimum": 1, + "required": false, + "type": "integer" + }, + { + "name": "x-ms-client-request-id", + "description": "A UUID recorded in the analytics logs for troubleshooting and correlation.", + "in": "header", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string", + "x-ms-client-request-id": true + }, + { + "name": "timeout", + "in": "query", + "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.", + "format": "int32", + "minimum": 1, + "required": false, + "type": "integer" + }, + { + "name": "x-ms-date", + "in": "header", + "description": "Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/Version" + } + ] + } + }, + "/{filesystem}": { + "put": { + "operationId": "Filesystem_Create", + "summary": "Create Filesystem", + "description": "Create a filesystem rooted at the specified location. If the filesystem already exists, the operation fails. This operation does not support conditional HTTP requests.", + "tags": [ + "Filesystem Operations" + ], + "responses": { + "201": { + "description": "Created", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the filesystem.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the filesystem was last modified. Operations on files and directories do not affect the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-namespace-enabled": { + "description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem. ", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "x-ms-properties", + "description": "User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "patch": { + "operationId": "Filesystem_SetProperties", + "summary": "Set Filesystem Properties", + "description": "Set properties for the filesystem. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "Filesystem Operations" + ], + "responses": { + "200": { + "description": "Ok", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "x-ms-properties", + "description": "Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Modified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "get": { + "operationId": "Path_List", + "summary": "List Paths", + "description": "List filesystem paths and their properties.", + "x-ms-pageable": { + "itemName": "paths", + "nextLinkName": null + }, + "tags": [ + "Filesystem Operations" + ], + "responses": { + "200": { + "description": "Ok", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-continuation": { + "description": "If the number of paths to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/PathList" + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "directory", + "in": "query", + "description": "Filters results to paths within the specified directory. An error occurs if the directory does not exist.", + "required": false, + "type": "string" + }, + { + "name": "recursive", + "in": "query", + "description": "If \"true\", all paths are listed; otherwise, only paths at the root of the filesystem are listed. If \"directory\" is specified, the list will only include paths that share the same root.", + "required": true, + "type": "boolean" + }, + { + "name": "continuation", + "in": "query", + "description": "The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.", + "required": false, + "type": "string" + }, + { + "name": "maxResults", + "in": "query", + "description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.", + "format": "int32", + "minimum": 1, + "required": false, + "type": "integer" + } + ] + }, + "head": { + "operationId": "Filesystem_GetProperties", + "summary": "Get Filesystem Properties.", + "description": "All system and user-defined filesystem properties are specified in the response headers.", + "tags": [ + "Filesystem Operations" + ], + "responses": { + "200": { + "description": "Ok", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-properties": { + "description": "The user-defined properties associated with the filesystem. A comma-separated list of name and value pairs in the format \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", + "type": "string" + }, + "x-ms-namespace-enabled": { + "description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem. ", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + } + }, + "delete": { + "operationId": "Filesystem_Delete", + "summary": "Delete Filesystem", + "description": "Marks the filesystem for deletion. When a filesystem is deleted, a filesystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "Filesystem Operations" + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "If-Modified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "parameters": [ + { + "name": "filesystem", + "in": "path", + "description": "The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters.", + "required": true, + "type": "string" + }, + { + "name": "resource", + "in": "query", + "description": "The value must be \"filesystem\" for all filesystem operations.", + "required": true, + "type": "string", + "enum": [ + "filesystem" + ], + "x-ms-enum": { + "name": "FilesystemResourceType", + "modelAsString": false + } + }, + { + "name": "x-ms-client-request-id", + "description": "A UUID recorded in the analytics logs for troubleshooting and correlation.", + "in": "header", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string", + "x-ms-client-request-id": true + }, + { + "name": "timeout", + "in": "query", + "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.", + "format": "int32", + "minimum": 1, + "required": false, + "type": "integer" + }, + { + "name": "x-ms-date", + "in": "header", + "description": "Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/Version" + } + ] + }, + "/{filesystem}/{path}": { + "put": { + "operationId": "Path_Create", + "summary": "Create File | Create Directory | Rename File | Rename Directory", + "description": "Create or rename a file or directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: \"*\".", + "consumes": [ + "application/octet-stream" + ], + "tags": [ + "File and Directory Operations" + ], + "responses": { + "201": { + "description": "The file or directory was created.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-continuation": { + "description": "When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "resource", + "in": "query", + "description": "Required only for Create File and Create Directory. The value must be \"file\" or \"directory\".", + "required": false, + "type": "string", + "enum": [ + "directory", + "file" + ], + "x-ms-enum": { + "name": "PathResourceType", + "modelAsString": false + } + }, + { + "name": "continuation", + "in": "query", + "description": "Optional. When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.", + "required": false, + "type": "string" + }, + { + "name": "mode", + "in": "query", + "description": "Optional. Valid only when namespace is enabled. This parameter determines the behavior of the rename operation. The value must be \"legacy\" or \"posix\", and the default value will be \"posix\". ", + "required": false, + "type": "string", + "enum": [ + "legacy", + "posix" + ], + "x-ms-enum": { + "name": "PathRenameMode", + "modelAsString": false + } + }, + { + "name": "Cache-Control", + "in": "header", + "description": "Optional. The service stores this value and includes it in the \"Cache-Control\" response header for \"Read File\" operations for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "Content-Encoding", + "in": "header", + "description": "Optional. Specifies which content encodings have been applied to the file. This value is returned to the client when the \"Read File\" operation is performed.", + "required": false, + "type": "string" + }, + { + "name": "Content-Language", + "in": "header", + "description": "Optional. Specifies the natural language used by the intended audience for the file.", + "required": false, + "type": "string" + }, + { + "name": "Content-Disposition", + "in": "header", + "description": "Optional. The service stores this value and includes it in the \"Content-Disposition\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-cache-control", + "in": "header", + "description": "Optional. The service stores this value and includes it in the \"Cache-Control\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-type", + "in": "header", + "description": "Optional. The service stores this value and includes it in the \"Content-Type\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-encoding", + "in": "header", + "description": "Optional. The service stores this value and includes it in the \"Content-Encoding\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-language", + "in": "header", + "description": "Optional. The service stores this value and includes it in the \"Content-Language\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-disposition", + "in": "header", + "description": "Optional. The service stores this value and includes it in the \"Content-Disposition\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-rename-source", + "in": "header", + "description": "An optional file or directory to be renamed. The value must have the following format: \"/{filesysystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "Optional. A lease ID for the path specified in the URI. The path to be overwritten must have an active lease and the lease ID must match.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "x-ms-proposed-lease-id", + "in": "header", + "description": "Optional for create operations. Required when \"x-ms-lease-action\" is used. A lease will be acquired using the proposed ID when the resource is created.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "x-ms-source-lease-id", + "in": "header", + "description": "Optional for rename operations. A lease ID for the source path. The source path must have an active lease and the lease ID must match.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "x-ms-properties", + "description": "Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-permissions", + "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Match", + "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-None-Match", + "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Modified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-source-if-match", + "description": "Optional. An ETag value. Specify this header to perform the rename operation only if the source's ETag matches the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-source-if-none-match", + "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the rename operation only if the source's ETag does not match the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-source-if-modified-since", + "description": "Optional. A date and time value. Specify this header to perform the rename operation only if the source has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-source-if-unmodified-since", + "description": "Optional. A date and time value. Specify this header to perform the rename operation only if the source has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "patch": { + "operationId": "Path_Update", + "summary": "Append Data | Flush Data | Set Properties | Set Access Control", + "description": "Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "consumes": [ + "application/octet-stream", + "text/plain" + ], + "tags": [ + "File and Directory Operations" + ], + "responses": { + "200": { + "description": "The data was flushed (written) to the file or the properties were set successfully.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "type": "string" + }, + "Accept-Ranges": { + "description": "Indicates that the service supports requests for partial file content.", + "type": "string" + }, + "Cache-Control": { + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Disposition": { + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Encoding": { + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Language": { + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "string" + }, + "Content-Range": { + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", + "type": "string" + }, + "Content-Type": { + "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", + "type": "string" + }, + "x-ms-properties": { + "description": "User-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + } + } + }, + "202": { + "description": "The uploaded data was accepted.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "action", + "in": "query", + "description": "The action must be \"append\" to upload data to be appended to a file, \"flush\" to flush previously uploaded data to a file, \"setProperties\" to set the properties of a file or directory, or \"setAccessControl\" to set the owner, group, permissions, or access control list for a file or directory. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL) includes permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.", + "required": true, + "type": "string", + "enum": [ + "append", + "flush", + "setProperties", + "setAccessControl" + ], + "x-ms-enum": { + "name": "PathUpdateAction", + "modelAsString": false + } + }, + { + "name": "position", + "in": "query", + "description": "This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.", + "format": "int64", + "required": false, + "type": "integer" + }, + { + "name": "retainUncommittedData", + "in": "query", + "description": "Valid only for flush operations. If \"true\", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.", + "required": false, + "type": "boolean" + }, + { + "name": "Content-Length", + "in": "header", + "description": "Required for \"Append Data\" and \"Flush Data\". Must be 0 for \"Flush Data\". Must be the length of the request content in bytes for \"Append Data\".", + "minimum": 0, + "required": false, + "type": "string" + }, + { + "name": "x-ms-lease-action", + "in": "header", + "description": "Optional. The lease action can be \"renew\" to renew an existing lease or \"release\" to release a lease.", + "type": "string", + "enum": [ + "renew", + "release" + ], + "x-ms-enum": { + "name": "PathUpdateLeaseAction", + "modelAsString": false + } + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "The lease ID must be specified if there is an active lease.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "x-ms-cache-control", + "in": "header", + "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Cache-Control\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-type", + "in": "header", + "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Content-Type\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-disposition", + "in": "header", + "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Content-Disposition\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-encoding", + "in": "header", + "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Content-Encoding\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-language", + "in": "header", + "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Content-Language\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-properties", + "description": "Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded. Valid only for the setProperties operation. If the file or directory exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-owner", + "description": "Optional and valid only for the setAccessControl operation. Sets the owner of the file or directory.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-group", + "description": "Optional and valid only for the setAccessControl operation. Sets the owning group of the file or directory.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-permissions", + "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-acl", + "description": "Optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries that fully replaces the existing access control list (ACL). Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format \"[scope:][type]:[id]:[permissions]\". The scope must be \"default\" to indicate the ACE belongs to the default ACL for a directory; otherwise scope is implicit and the ACE belongs to the access ACL. There are four ACE types: \"user\" grants rights to the owner or a named user, \"group\" grants rights to the owning group or a named group, \"mask\" restricts rights granted to named users and the members of groups, and \"other\" grants rights to all users not found in any of the other entries. The user or group identifier is omitted for entries of type \"mask\" and \"other\". The user or group identifier is also omitted for the owner and owning group. The permission field is a 3-character sequence where the first character is 'r' to grant read access, the second character is 'w' to grant write access, and the third character is 'x' to grant execute permission. If access is not granted, the '-' character is used to denote that the permission is denied. For example, the following ACL grants read, write, and execute rights to the file owner and john.doe@contoso, the read right to the owning group, and nothing to everyone else: \"user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx\". Invalid in conjunction with x-ms-permissions.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Match", + "description": "Optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-None-Match", + "description": "Optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Modified-Since", + "description": "Optional for Flush Data and Set Properties, but invalid for Append Data. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional for Flush Data and Set Properties, but invalid for Append Data. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "requestBody", + "description": "Valid only for append operations. The data to be uploaded and appended to the file.", + "in": "body", + "required": false, + "schema": { + "type": "object", + "format": "file" + } + } + ] + }, + "post": { + "operationId": "Path_Lease", + "summary": "Lease Path", + "description": "Create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "File and Directory Operations" + ], + "responses": { + "200": { + "description": "The \"renew\", \"change\" or \"release\" action was successful.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file was last modified. Write operations on the file update the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-lease-id": { + "description": "A successful \"renew\" action returns the lease ID.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + } + } + }, + "201": { + "description": "A new lease has been created. The \"acquire\" action was successful.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-lease-id": { + "description": "A successful \"acquire\" action returns the lease ID.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + } + } + }, + "202": { + "description": "The \"break\" lease action was successful.", + "headers": { + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-lease-time": { + "description": "The time remaining in the lease period in seconds.", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "x-ms-lease-action", + "in": "header", + "description": "There are five lease actions: \"acquire\", \"break\", \"change\", \"renew\", and \"release\". Use \"acquire\" and specify the \"x-ms-proposed-lease-id\" and \"x-ms-lease-duration\" to acquire a new lease. Use \"break\" to break an existing lease. When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response indicates the interval in seconds until a new lease can be acquired. Use \"change\" and specify the current lease ID in \"x-ms-lease-id\" and the new lease ID in \"x-ms-proposed-lease-id\" to change the lease ID of an active lease. Use \"renew\" and specify the \"x-ms-lease-id\" to renew an existing lease. Use \"release\" and specify the \"x-ms-lease-id\" to release a lease.", + "required": true, + "type": "string", + "enum": [ + "acquire", + "break", + "change", + "renew", + "release" + ], + "x-ms-enum": { + "name": "PathLeaseAction", + "modelAsString": false + } + }, + { + "name": "x-ms-lease-duration", + "in": "header", + "description": "The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.", + "format": "int32", + "required": false, + "type": "integer" + }, + { + "name": "x-ms-lease-break-period", + "in": "header", + "description": "The lease break period duration is optional to break a lease, and specifies the break period of the lease in seconds. The lease break duration must be between 0 and 60 seconds.", + "format": "int32", + "required": false, + "type": "integer" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "Required when \"x-ms-lease-action\" is \"renew\", \"change\" or \"release\". For the renew and release actions, this must match the current lease ID.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "x-ms-proposed-lease-id", + "in": "header", + "description": "Required when \"x-ms-lease-action\" is \"acquire\" or \"change\". A lease will be acquired with this lease ID if the operation is successful.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "If-Match", + "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-None-Match", + "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Modified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "get": { + "operationId": "Path_Read", + "summary": "Read File", + "description": "Read the contents of a file. For read operations, range requests are supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "produces": [ + "application/json", + "application/octet-stream", + "text/plain" + ], + "tags": [ + "File and Directory Operations" + ], + "responses": { + "200": { + "description": "Ok", + "headers": { + "Accept-Ranges": { + "description": "Indicates that the service supports requests for partial file content.", + "type": "string" + }, + "Cache-Control": { + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Disposition": { + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Encoding": { + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Language": { + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "string" + }, + "Content-Range": { + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", + "type": "string" + }, + "Content-Type": { + "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", + "type": "string" + }, + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-resource-type": { + "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", + "type": "string" + }, + "x-ms-properties": { + "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", + "type": "string" + }, + "x-ms-lease-duration": { + "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string" + }, + "x-ms-lease-state": { + "description": "Lease state of the resource. ", + "type": "string" + }, + "x-ms-lease-status": { + "description": "The lease status of the resource.", + "type": "string" + } + }, + "schema": { + "type": "file" + } + }, + "206": { + "description": "Partial content", + "headers": { + "Accept-Ranges": { + "description": "Indicates that the service supports requests for partial file content.", + "type": "string" + }, + "Cache-Control": { + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Disposition": { + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Encoding": { + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Language": { + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "string" + }, + "Content-Range": { + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", + "type": "string" + }, + "Content-Type": { + "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", + "type": "string" + }, + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-resource-type": { + "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", + "type": "string" + }, + "x-ms-properties": { + "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", + "type": "string" + }, + "x-ms-lease-duration": { + "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string" + }, + "x-ms-lease-state": { + "description": "Lease state of the resource. ", + "type": "string" + }, + "x-ms-lease-status": { + "description": "The lease status of the resource.", + "type": "string" + } + }, + "schema": { + "type": "file" + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "in": "header", + "description": "The HTTP Range request header specifies one or more byte ranges of the resource to be retrieved.", + "required": false, + "type": "string", + "name": "Range" + }, + { + "name": "If-Match", + "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-None-Match", + "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Modified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "head": { + "operationId": "Path_GetProperties", + "summary": "Get Properties | Get Access Control List", + "description": "Get the properties for a file or directory, and optionally include the access control list. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "File and Directory Operations" + ], + "responses": { + "200": { + "description": "Returns all properties for the file or directory.", + "headers": { + "Accept-Ranges": { + "description": "Indicates that the service supports requests for partial file content.", + "type": "string" + }, + "Cache-Control": { + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Disposition": { + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Encoding": { + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Language": { + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "string" + }, + "Content-Range": { + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", + "type": "string" + }, + "Content-Type": { + "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", + "type": "string" + }, + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-resource-type": { + "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", + "type": "string" + }, + "x-ms-properties": { + "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", + "type": "string" + }, + "x-ms-owner": { + "description": "The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.", + "type": "string" + }, + "x-ms-group": { + "description": "The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.", + "type": "string" + }, + "x-ms-permissions": { + "description": "The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account.", + "type": "string" + }, + "x-ms-acl": { + "description": "The POSIX access control list for the file or directory. Included in the response only if the action is \"getAccessControl\" and Hierarchical Namespace is enabled for the account.", + "type": "string" + }, + "x-ms-lease-duration": { + "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string" + }, + "x-ms-lease-state": { + "description": "Lease state of the resource. ", + "type": "string" + }, + "x-ms-lease-status": { + "description": "The lease status of the resource.", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "action", + "in": "query", + "description": "Optional. If the value is \"getAccessControl\" the access control list is returned in the response headers (Hierarchical Namespace must be enabled for the account).", + "required": false, + "type": "string", + "enum": [ + "getAccessControl" + ], + "x-ms-enum": { + "name": "PathGetPropertiesAction", + "modelAsString": false + } + }, + { + "name": "If-Match", + "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-None-Match", + "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Modified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "delete": { + "operationId": "Path_Delete", + "summary": "Delete File | Delete Directory", + "description": "Delete the file or directory. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "File and Directory Operations" + ], + "responses": { + "200": { + "description": "The file was deleted.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-continuation": { + "description": "When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "recursive", + "in": "query", + "description": "Required and valid only when the resource is a directory. If \"true\", all paths beneath the directory will be deleted. If \"false\" and the directory is non-empty, an error occurs.", + "required": false, + "type": "boolean" + }, + { + "name": "continuation", + "in": "query", + "description": "Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "The lease ID must be specified if there is an active lease.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "If-Match", + "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-None-Match", + "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Modified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "parameters": [ + { + "name": "filesystem", + "in": "path", + "description": "The filesystem identifier.", + "pattern": "^[a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$", + "minLength": 3, + "maxLength": 63, + "required": true, + "type": "string" + }, + { + "name": "path", + "in": "path", + "description": "The file or directory path.", + "required": true, + "type": "string" + }, + { + "name": "x-ms-client-request-id", + "description": "A UUID recorded in the analytics logs for troubleshooting and correlation.", + "in": "header", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string", + "x-ms-client-request-id": true + }, + { + "name": "timeout", + "in": "query", + "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.", + "format": "int32", + "minimum": 1, + "required": false, + "type": "integer" + }, + { + "name": "x-ms-date", + "in": "header", + "description": "Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/Version" + } + ] + } + } +} diff --git a/specification/storage/data-plane/readme.md b/specification/storage/data-plane/readme.md new file mode 100644 index 000000000000..5cf5432c5f85 --- /dev/null +++ b/specification/storage/data-plane/readme.md @@ -0,0 +1,141 @@ +# DataLakeStorage + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DataLakeStorage. + + + +--- +## Getting Started +To build the SDK for DataLakeStorage, 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 DataLakeStorage API. + +``` yaml +openapi-type: data-plane +tag: package-2018-06-preview +use-internal-constructors: true +add-credentials: true +``` + + +### Tag: package-2018-06-preview + +These settings apply only when `--tag=package-2018-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06-preview' +input-file: +- Microsoft.StorageDataLake/preview/2018-06-17/DataLakeStorage.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +Swagger to SDK has been intentionally disabled for this spec. + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Storage.DataLake + output-folder: $(csharp-sdks-folder)/Storage/DataLake/Generated + clear-output-folder: true +``` + + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.media + package-name: azure-datalake-storage + clear-output-folder: true + no-namespace-folders: true +``` + +### Python multi-api + +Generate all API versions currently shipped for this package + +```yaml $(python) && $(multiapi) +batch: + - tag: package-2018-06-preview +``` + +### Tag: package-2018-06-preview and python + +These settings apply only when `--tag=package-2018-06-preview --python` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06-preview' && $(python) +python: + namespace: azure.datalake.storage.v2018_06_17_preview + output-folder: $(python-sdks-folder)/azure-datalake-storage/azure/datalake/storage/v2018_06_17_preview +``` + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: storagedatalake + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-06-preview +``` + +### Tag: package-2018-06-preview and go + +These settings apply only when `--tag=package-2018-06-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-06-preview' && $(go) +output-folder: $(go-sdk-folder)/services/storage/datalake/2018-06-17/storagedatalake +``` + +## 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.storage.datalake + license-header: MICROSOFT_MIT_NO_CODEGEN + output-folder: $(azure-libraries-for-java-folder)/azure-storage-datalake +``` diff --git a/specification/storage/data-plane/readme.nodejs.md b/specification/storage/data-plane/readme.nodejs.md new file mode 100644 index 000000000000..9e9b66a20cff --- /dev/null +++ b/specification/storage/data-plane/readme.nodejs.md @@ -0,0 +1,15 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-storage-datalake + package-version: 0.1.0-preview + output-folder: $(node-sdks-folder)/lib/services/storageDatalake + generate-license-txt: false + generate-package-json: false + generate-readme-md: false +``` diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/blob.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/blob.json new file mode 100644 index 000000000000..d8530e57e160 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/blob.json @@ -0,0 +1,963 @@ + { + "swagger": "2.0", + "info": { + "version": "2018-03-01-preview", + "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}/blobServices/default/containers": { + "get": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_List", + "x-ms-examples": { + "ListContainers": { + "$ref": "./examples/BlobContainersList.json" + } + }, + "description": "Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.", + "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 -- List Container operation completed successfully.", + "schema": { + "$ref": "#/definitions/ListContainerItems" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}": { + "put": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_Create", + "x-ms-examples": { + "PutContainers": { + "$ref": "./examples/BlobContainersPut.json" + } + }, + "description": "Creates a new container under the specified account as described by request body. The container resource includes metadata and properties for that container. It does not include a list of the blobs contained by the container. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "blobContainer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BlobContainer" + }, + "description": "Properties of the blob container to create." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Created -- Create Container operation completed successfully.", + "schema": { + "$ref": "#/definitions/BlobContainer" + } + } + } + }, + "patch": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_Update", + "x-ms-examples": { + "UpdateContainers": { + "$ref": "./examples/BlobContainersPatch.json" + } + }, + "description": "Updates container properties as specified in request body. Properties not mentioned in the request will be unchanged. Update fails if the specified container doesn't already exist. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "blobContainer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BlobContainer" + }, + "description": "Properties to update for the blob container." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Update Container operation completed successfully.", + "schema": { + "$ref": "#/definitions/BlobContainer", + "description": "Properties of the updated blob container." + } + } + } + }, + "get": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_Get", + "x-ms-examples": { + "GetContainers": { + "$ref": "./examples/BlobContainersGet.json" + } + }, + "description": "Gets properties of a specified container. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get Container operation completed successfully.", + "schema": { + "$ref": "#/definitions/BlobContainer" + } + } + } + }, + "delete": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_Delete", + "x-ms-examples": { + "DeleteContainers": { + "$ref": "./examples/BlobContainersDelete.json" + } + }, + "description": "Deletes specified container under its account.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete Container operation completed successfully." + }, + "204": { + "description": "No Content -- The Container not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold": { + "post": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_SetLegalHold", + "x-ms-examples": { + "SetLegalHoldContainers": { + "$ref": "./examples/BlobContainersSetLegalHold.json" + } + }, + "description": "Sets legal hold tags. Setting the same tag results in an idempotent operation. SetLegalHold follows an append pattern and does not clear out the existing tags that are not specified in the request.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "LegalHold", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LegalHold" + }, + "description": "The LegalHold property that will be set to a blob container." + } + ], + "responses": { + "200": { + "description": "OK -- Set legal hold tags for Container completed successfully.", + "schema": { + "$ref": "#/definitions/LegalHold" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold": { + "post": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_ClearLegalHold", + "x-ms-examples": { + "ClearLegalHoldContainers": { + "$ref": "./examples/BlobContainersClearLegalHold.json" + } + }, + "description": "Clears legal hold tags. Clearing the same or non-existent tag results in an idempotent operation. ClearLegalHold clears out only the specified tags in the request.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "LegalHold", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LegalHold" + }, + "description": "The LegalHold property that will be clear from a blob container." + } + ], + "responses": { + "200": { + "description": "OK -- Clear legal hold tags for Container completed successfully.", + "schema": { + "$ref": "#/definitions/LegalHold" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/{immutabilityPolicyName}": { + "put": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_CreateOrUpdateImmutabilityPolicy", + "x-ms-examples": { + "CreateOrUpdateImmutabilityPolicy": { + "$ref": "./examples/BlobContainersPutImmutabilityPolicy.json" + } + }, + "description": "Creates or updates an unlocked immutability policy. ETag in If-Match is honored if given but not required for this operation.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "description": "The ImmutabilityPolicy Properties that will be created or updated to a blob container." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Creates or updates container ImmutabilityPolicy operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "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" + } + } + } + } + }, + "get": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_GetImmutabilityPolicy", + "x-ms-examples": { + "GetImmutabilityPolicy": { + "$ref": "./examples/BlobContainersGetImmutabilityPolicy.json" + } + }, + "description": "Gets the existing immutability policy along with the corresponding ETag in response headers and body.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Gets container ImmutabilityPolicy operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "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" + } + } + } + } + }, + "delete": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_DeleteImmutabilityPolicy", + "x-ms-examples": { + "DeleteImmutabilityPolicy": { + "$ref": "./examples/BlobContainersDeleteImmutabilityPolicy.json" + } + }, + "description": "Aborts an unlocked immutability policy. The response of delete has immutabilityPeriodSinceCreationInDays set to 0. ETag in If-Match is required for this operation. Deleting a locked immutability policy is not allowed, only way is to delete the container after deleting all blobs inside the container.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Deletes container ImmutabilityPolicy operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "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" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/default/lock": { + "post": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_LockImmutabilityPolicy", + "x-ms-examples": { + "LockImmutabilityPolicy": { + "$ref": "./examples/BlobContainersLockImmutabilityPolicy.json" + } + }, + "description": "Sets the ImmutabilityPolicy to Locked state. The only action allowed on a Locked policy is ExtendImmutabilityPolicy action. ETag in If-Match is required for this operation.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Locks container ImmutabilityPolicy operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "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" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/default/extend": { + "post": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_ExtendImmutabilityPolicy", + "x-ms-examples": { + "ExtendImmutabilityPolicy": { + "$ref": "./examples/BlobContainersExtendImmutabilityPolicy.json" + } + }, + "description": "Extends the immutabilityPeriodSinceCreationInDays of a locked immutabilityPolicy. The only action allowed on a Locked policy will be this action. ETag in If-Match is required for this operation.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "description": "The ImmutabilityPolicy Properties that will be extented for a blob container." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Extends container ImmutabilityPolicy operation completed successfully..", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "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" + } + } + } + } + } + } + }, + "definitions": { + "ContainerProperties": { + "properties": { + "publicAccess": { + "type": "string", + "enum": [ + "Container", + "Blob", + "None" + ], + "x-ms-enum": { + "name": "PublicAccess", + "modelAsString": false + }, + "description": "Specifies whether data in the container may be accessed publicly and the level of access." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Returns the date and time the container was last modified." + }, + "leaseStatus": { + "type": "string", + "readOnly": true, + "enum": [ + "Locked", + "Unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatus", + "modelAsString": true + }, + "description": "The lease status of the container." + }, + "leaseState": { + "type": "string", + "readOnly": true, + "enum": [ + "Available", + "Leased", + "Expired", + "Breaking", + "Broken" + ], + "x-ms-enum": { + "name": "LeaseState", + "modelAsString": true + }, + "description": "Lease state of the container." + }, + "leaseDuration": { + "type": "string", + "readOnly": true, + "enum": [ + "Infinite", + "Fixed" + ], + "x-ms-enum": { + "name": "LeaseDuration", + "modelAsString": true + }, + "description": "Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased." + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A name-value pair to associate with the container as metadata." + }, + "immutabilityPolicy": { + "readOnly": true, + "$ref": "#/definitions/ImmutabilityPolicyProperties", + "x-ms-client-name": "ImmutabilityPolicy", + "description": "The ImmutabilityPolicy property of the container." + }, + "legalHold": { + "readOnly": true, + "$ref": "#/definitions/LegalHoldProperties", + "description": "The LegalHold property of the container." + }, + "hasLegalHold": { + "type": "boolean", + "readOnly": true, + "description": "The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account." + }, + "hasImmutabilityPolicy": { + "type": "boolean", + "readOnly": true, + "description": "The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container." + } + }, + "description": "The properties of a container." + }, + "BlobContainer": { + "properties": { + "properties": { + "$ref": "#/definitions/ContainerProperties", + "x-ms-client-flatten": true, + "x-ms-client-name": "ContainerProperties", + "description": "Properties of the blob container." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource" + } + ], + "description": "Properties of the blob container, including Id, resource name, resource type, Etag." + }, + "ImmutabilityPolicyProperty": { + "properties": { + "immutabilityPeriodSinceCreationInDays": { + "type": "integer", + "description": "The immutability period for the blobs in the container since the policy creation, in days." + }, + "state": { + "type": "string", + "readOnly": true, + "enum": [ + "Locked", + "Unlocked" + ], + "x-ms-enum": { + "name": "ImmutabilityPolicyState", + "modelAsString": true + }, + "description": "The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked." + } + }, + "required": [ + "immutabilityPeriodSinceCreationInDays" + ], + "description": "The properties of an ImmutabilityPolicy of a blob container." + }, + "ImmutabilityPolicyProperties": { + "properties": { + "properties": { + "$ref": "#/definitions/ImmutabilityPolicyProperty", + "x-ms-client-flatten": true, + "description": "The properties of an ImmutabilityPolicy of a blob container." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "ImmutabilityPolicy Etag." + }, + "updateHistory": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/UpdateHistoryProperty" + }, + "description": "The ImmutabilityPolicy update history of the blob container." + } + }, + "description": "The properties of an ImmutabilityPolicy of a blob container." + }, + "ImmutabilityPolicy": { + "properties": { + "properties": { + "$ref": "#/definitions/ImmutabilityPolicyProperty", + "x-ms-client-flatten": true, + "description": "The properties of an ImmutabilityPolicy of a blob container." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource" + } + ], + "required": [ + "properties" + ], + "description": "The ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, Etag." + }, + "UpdateHistoryProperty": { + "properties": { + "update": { + "type": "string", + "readOnly": true, + "enum": [ + "put", + "lock", + "extend" + ], + "x-ms-enum": { + "name": "ImmutabilityPolicyUpdateType", + "modelAsString": true + }, + "description": "The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend." + }, + "immutabilityPeriodSinceCreationInDays": { + "type": "integer", + "readOnly": true, + "description": "The immutability period for the blobs in the container since the policy creation, in days." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Returns the date and time the ImmutabilityPolicy was updated." + }, + "objectIdentifier": { + "type": "string", + "readOnly": true, + "description": "Returns the Object ID of the user who updated the ImmutabilityPolicy." + }, + "tenantId": { + "type": "string", + "readOnly": true, + "description": "Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy." + }, + "upn": { + "type": "string", + "readOnly": true, + "description": "Returns the User Principal Name of the user who updated the ImmutabilityPolicy." + } + }, + "description": "An update history of the ImmutabilityPolicy of a blob container." + }, + "LegalHoldProperties": { + "properties": { + "hasLegalHold": { + "type": "boolean", + "readOnly": true, + "description": "The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account." + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/TagProperty" + }, + "description": "The list of LegalHold tags of a blob container." + } + }, + "description": "The LegalHold property of a blob container." + }, + "TagProperty": { + "properties": { + "tag": { + "type": "string", + "readOnly": true, + "description": "The tag value." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Returns the date and time the tag was added." + }, + "objectIdentifier": { + "type": "string", + "readOnly": true, + "description": "Returns the Object ID of the user who added the tag." + }, + "tenantId": { + "type": "string", + "readOnly": true, + "description": "Returns the Tenant ID that issued the token for the user who added the tag." + }, + "upn": { + "type": "string", + "readOnly": true, + "description": "Returns the User Principal Name of the user who added the tag." + } + }, + "description": "A tag of the LegalHold of a blob container." + }, + "LegalHold": { + "properties": { + "hasLegalHold": { + "type": "boolean", + "readOnly": true, + "description": "The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account." + }, + "tags": { + "type": "array", + "items": { + "type": "string", + "maxLength": 23, + "minLength": 3 + }, + "description": "Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP." + } + }, + "required": [ + "tags" + ], + "description": "The LegalHold property of a blob container." + }, + "ListContainerItem": { + "properties": { + "properties": { + "$ref": "#/definitions/ContainerProperties", + "x-ms-client-flatten": true, + "description": "The blob container properties be listed out." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The blob container properties be listed out." + }, + "ListContainerItems": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ListContainerItem" + }, + "description": "The list of blob containers." + } + }, + "description": "The list of blob containers." + } + }, + "parameters": { + "ContainerName": { + "name": "containerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.", + "maxLength": 63, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ImmutabilityPolicyName": { + "name": "immutabilityPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'", + "enum":[ + "default" + ], + "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" + ] + } + ] + } \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersClearLegalHold.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersClearLegalHold.json new file mode 100644 index 000000000000..ad6e6f5a6dcc --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersClearLegalHold.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4303", + "accountName": "sto7280", + "containerName": "container8723", + "api-version": "2018-03-01-preview", + "monitor": "true", + "LegalHold": { + "tags": [ + "tag1", + "tag2", + "tag3" + ] + } + }, + "responses": { + "200": { + "body": { + "hasLegalHold": false, + "tags": [] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersDelete.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersDelete.json new file mode 100644 index 000000000000..c098454b4d7e --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4079", + "accountName": "sto4506", + "containerName": "container9689", + "api-version": "2018-03-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersDeleteImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersDeleteImmutabilityPolicy.json new file mode 100644 index 000000000000..40cc94c001b2 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersDeleteImmutabilityPolicy.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res1581", + "accountName": "sto9621", + "containerName": "container4910", + "immutabilityPolicyName": "default", + "If-Match": "\"8d59f81a7fa7be0\"", + "api-version": "2018-03-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res1581/providers/Microsoft.Storage/storageAccounts/sto9621/blobServices/default/containers/container4910/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d59f81a87b40c0\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 0, + "state": "Unlocked" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersExtendImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersExtendImmutabilityPolicy.json new file mode 100644 index 000000000000..1737f81188e4 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersExtendImmutabilityPolicy.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6238", + "accountName": "sto232", + "containerName": "container5023", + "If-Match": "\"8d59f830d0c3bf9\"", + "api-version": "2018-03-01-preview", + "monitor": "true", + "parameters": { + "properties": { + "immutabilityPeriodSinceCreationInDays": 100 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6238/providers/Microsoft.Storage/storageAccounts/sto232/blobServices/default/containers/container5023/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d57a8b2ff50332\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 100, + "state": "Locked" + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersGet.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersGet.json new file mode 100644 index 000000000000..3416d56e8b00 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersGet.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9871", + "accountName": "sto6217", + "containerName": "container1634", + "api-version": "2018-03-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/blobServices/default/containers/container1634", + "name": "container1634", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers", + "etag": "\"0x8D592D74CC20EBA\"", + "properties": { + "publicAccess": "None", + "leaseStatus": "Unlocked", + "leaseState": "Available", + "lastModifiedTime": "2018-03-26T05:06:14Z", + "immutabilityPolicy": { + "etag": "\"8d592d74cb3011a\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 100, + "state": "Locked" + }, + "updateHistory": [ + { + "update": "put", + "immutabilityPeriodSinceCreationInDays": 3, + "timestamp": "2018-03-26T05:06:11.431403Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + { + "update": "lock", + "immutabilityPeriodSinceCreationInDays": 3, + "timestamp": "2018-03-26T05:06:13.0907641Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + { + "update": "extend", + "immutabilityPeriodSinceCreationInDays": 100, + "timestamp": "2018-03-26T05:06:14.7097716Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + ] + }, + "legalHold": { + "hasLegalHold": true, + "tags": [ + { + "tag": "tag1", + "timestamp": "2018-03-26T05:06:09.6964643Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + { + "tag": "tag2", + "timestamp": "2018-03-26T05:06:09.6964643Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + { + "tag": "tag3", + "timestamp": "2018-03-26T05:06:09.6964643Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + ] + }, + "hasImmutabilityPolicy": true, + "hasLegalHold": true + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersGetImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersGetImmutabilityPolicy.json new file mode 100644 index 000000000000..b04a083fed46 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersGetImmutabilityPolicy.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res5221", + "accountName": "sto9177", + "containerName": "container3489", + "immutabilityPolicyName": "default", + "api-version": "2018-03-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res5221/providers/Microsoft.Storage/storageAccounts/sto9177/blobServices/default/containers/container3489/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d59f828e64b75c\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 5, + "state": "Unlocked" + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersList.json new file mode 100644 index 000000000000..575296fcba50 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9290", + "accountName": "sto1590", + "api-version": "2018-03-01-preview", + "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": "Available", + "lastModifiedTime": "2018-03-14T08:20:47Z", + "hasImmutabilityPolicy": false, + "hasLegalHold": false + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLockImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLockImmutabilityPolicy.json new file mode 100644 index 000000000000..7d8b4c13bd7d --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersLockImmutabilityPolicy.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res2702", + "accountName": "sto5009", + "containerName": "container1631", + "If-Match": "\"8d59f825b721dd3\"", + "api-version": "2018-03-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res2702/providers/Microsoft.Storage/storageAccounts/sto5009/blobServices/default/containers/container1631/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d57a8a5edb084a\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 3, + "state": "Locked" + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersPatch.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersPatch.json new file mode 100644 index 000000000000..26a5f59b49cf --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersPatch.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "containerName": "container6185", + "api-version": "2018-03-01-preview", + "monitor": "true", + "blobContainer": { + "properties": { + "publicAccess": "Container", + "metadata": { + "metadata": "true" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", + "name": "container6185", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers", + "properties": { + "metadata": { + "metadata": "true" + }, + "publicAccess": "Container", + "hasImmutabilityPolicy": false, + "hasLegalHold": false + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersPut.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersPut.json new file mode 100644 index 000000000000..4aa6ab2ab34c --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersPut.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "containerName": "container6185", + "api-version": "2018-03-01-preview", + "monitor": "true", + "blobContainer": {} + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", + "name": "container6185", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers" + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersPutImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersPutImmutabilityPolicy.json new file mode 100644 index 000000000000..3357d65fcfd0 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersPutImmutabilityPolicy.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res1782", + "accountName": "sto7069", + "containerName": "container6397", + "immutabilityPolicyName": "default", + "api-version": "2018-03-01-preview", + "monitor": "true", + "parameters": { + "properties": { + "immutabilityPeriodSinceCreationInDays": 3 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res1782/providers/Microsoft.Storage/storageAccounts/sto7069/blobServices/default/containers/container6397/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d59f830cb130e5\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 3, + "state": "Unlocked" + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersSetLegalHold.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersSetLegalHold.json new file mode 100644 index 000000000000..d7c79aec0436 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/BlobContainersSetLegalHold.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4303", + "accountName": "sto7280", + "containerName": "container8723", + "api-version": "2018-03-01-preview", + "monitor": "true", + "LegalHold": { + "tags": [ + "tag1", + "tag2", + "tag3" + ] + } + }, + "responses": { + "200": { + "body": { + "hasLegalHold": true, + "tags": [ + "tag1", + "tag2", + "tag3" + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/OperationsList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..19db1402e322 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/OperationsList.json @@ -0,0 +1,473 @@ +{ + "parameters": { + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Storage/storageAccounts/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Create/Update Storage Account", + "description": "Creates a storage account with the specified parameters or update the properties or tags or adds custom domain for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/delete", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Delete Storage Account", + "description": "Deletes an existing storage account." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/listkeys/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "List Storage Account Keys", + "description": "Returns the access keys for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/regeneratekey/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Regenerate Storage Account Keys", + "description": "Regenerates the access keys for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/checknameavailability/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Name Availability", + "operation": "Check Name Availability", + "description": "Checks that account name is valid and is not in use." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "List/Get Storage Account(s)", + "description": "Returns the list of storage accounts or gets the properties for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/usages/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Usage Metrics", + "operation": "Get Subscription Usages", + "description": "Returns the limit and the current usage count for resources in the specified subscription" + } + }, + { + "name": "Microsoft.Storage/storageAccounts/listAccountSas/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Account SAS Token", + "operation": "Returns Storage Account SAS Token", + "description": "Returns the Account SAS token for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/listServiceSas/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Returns the Service SAS token for the specified storage account.", + "operation": "Returns Storage Service SAS Token", + "description": "Storage Service SAS Token" + } + }, + { + "name": "Microsoft.Storage/locations/deleteVirtualNetworkOrSubnets/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Location", + "operation": "Delete virtual network or subnets notifications", + "description": "Notifies Microsoft.Storage that virtual network or subnet is being deleted" + } + }, + { + "name": "Microsoft.Storage/operations/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Operations", + "operation": "Poll Asynchronous Operation", + "description": "Polls the status of an asynchronous operation." + } + }, + { + "name": "Microsoft.Storage/register/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Resource Provider", + "operation": "Registers the Storage Resource Provider", + "description": "Registers the subscription for the storage resource provider and enables the creation of storage accounts." + } + }, + { + "name": "Microsoft.Storage/skus/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Skus", + "operation": "List Skus", + "description": "Lists the Skus supported by Microsoft.Storage." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/services/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Create/Update Diagnostic Settings", + "description": "Create/Update storage account diagnostic settings." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "UsedCapacity", + "displayName": "Used capacity", + "displayDescription": "Account used capacity", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity", + "resourceIdDimensionNameOverride": "AccountResourceId" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/blobServices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Blob service", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "BlobCapacity", + "displayName": "Blob Capacity", + "displayDescription": "The amount of storage used by the storage account’s Blob service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [ + { + "name": "BlobType", + "displayName": "Blob type" + } + ], + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "BlobCount", + "displayName": "Blob Count", + "displayDescription": "The number of Blob in the storage account’s Blob service.", + "unit": "Count", + "aggregationType": "Average", + "dimensions": [ + { + "name": "BlobType", + "displayName": "Blob type" + } + ], + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "ContainerCount", + "displayName": "Blob Container Count", + "displayDescription": "The number of containers in the storage account’s Blob service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "BlobProvisionedSize", + "displayName": "Blob Provisioned Size", + "displayDescription": "The amount of storage provisioned in the storage account’s Blob service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [ + { + "name": "BlobType", + "displayName": "Blob type" + } + ], + "fillGapWithZero": false, + "category": "Capacity" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/blobServices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Blob service", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/blobServices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Blob service", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/tableServices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Table service", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "TableCapacity", + "displayName": "Table Capacity", + "displayDescription": "The amount of storage used by the storage account’s Table service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "TableCount", + "displayName": "Table Count", + "displayDescription": "The number of table in the storage account’s Table service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "TableEntityCount", + "displayName": "Table Entity Count", + "displayDescription": "The number of table entities in the storage account’s Table service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/tableServices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Table service", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/tableServices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Table service", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/queueServices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Queue service", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "QueueCapacity", + "displayName": "Queue Capacity", + "displayDescription": "The amount of storage used by the storage account’s Queue service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "QueueCount", + "displayName": "Queue Count", + "displayDescription": "The number of queue in the storage account’s Queue service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "QueueMessageCount", + "displayName": "Queue Message Count", + "displayDescription": "The approximate number of queue messages in the storage account’s Queue service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/queueServices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Queue service", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/queueServices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Queue service", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/fileServices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "File service", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "FileCapacity", + "displayName": "File Capacity", + "displayDescription": "The amount of storage used by the storage account’s File service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "FileProvisionedSize", + "displayName": "File Provisioned Size", + "displayDescription": "The amount of storage provisioned in the storage account’s File service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "FileCount", + "displayName": "File Count", + "displayDescription": "The number of file in the storage account’s File service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "FileShareCount", + "displayName": "File Share Count", + "displayDescription": "The number of file shares in the storage account’s File service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/fileServices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "File service", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/fileServices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "File service", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/SKUList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/SKUList.json new file mode 100644 index 000000000000..0644102e9121 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/SKUList.json @@ -0,0 +1,6454 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "true" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountCheckNameAvailability.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountCheckNameAvailability.json new file mode 100644 index 000000000000..f4ecc898104f --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountCheckNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-03-01-preview", + "accountName": { + "name": "sto3363", + "type": "Microsoft.Storage/storageAccounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountCreate.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountCreate.json new file mode 100644 index 000000000000..591f43ae0a54 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountCreate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9101", + "accountName": "sto4445", + "api-version": "2018-03-01-preview", + "parameters": { + "sku": { + "name": "Standard_GRS" + }, + "kind": "Storage", + "location": "eastus2euap", + "properties": { + "isHnsEnabled": true + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9101/providers/Microsoft.Storage/storageAccounts/sto4445", + "kind": "Storage", + "location": "eastus2euap", + "name": "sto4445", + "properties": { + "isHnsEnabled": true, + "networkAcls": { + "bypass": "AzureServices", + "virtualNetworkRules": [], + "ipRules": [], + "defaultAction": "Allow" + }, + "encryption": { + "services": { + "file": { + "enabled": true, + "lastEnabledTime": "2018-04-13T07:04:49.8562647Z" + }, + "blob": { + "enabled": true, + "lastEnabledTime": "2018-04-13T07:04:49.8562647Z" + } + }, + "keySource": "Microsoft.Storage" + }, + "creationTime": "2018-04-13T07:04:49.6145793Z", + "primaryEndpoints": { + "web": "https://sto4445.web.core.windows.net/", + "dfs": "https://sto4445.dfs.core.windows.net/", + "blob": "https://sto4445.blob.core.windows.net/", + "file": "https://sto4445.file.core.windows.net/", + "queue": "https://sto4445.queue.core.windows.net/", + "table": "https://sto4445.table.core.windows.net/" + }, + "primaryLocation": "eastus2euap", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + } + }, + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountDelete.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountDelete.json new file mode 100644 index 000000000000..dd8acf5b6ce1 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4228", + "accountName": "sto2434", + "api-version": "2018-03-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountDeleteManagementPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountDeleteManagementPolicy.json new file mode 100644 index 000000000000..cc09990ec8a3 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountDeleteManagementPolicy.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "managementPolicyName": "default", + "api-version": "2018-03-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountGetManagementPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountGetManagementPolicy.json new file mode 100644 index 000000000000..7b9f475ba388 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountGetManagementPolicy.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "managementPolicyName": "default", + "api-version": "2018-03-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Storage/storageAccounts/sto288/managementPolicies/default", + "name": "DefaultManagementPolicy", + "type": "Microsoft.Storage/storageAccounts/managementPolicies", + "properties": { + "policy": { + "version": "0.5", + "rules": [ + { + "name": "olcmtest", + "type": "Lifecycle", + "definition": { + "filters": { + "blobTypes": [ + "blockBlob" + ], + "prefixMatch": [ + "olcmtestcontainer" + ] + }, + "actions": { + "baseBlob": { + "tierToCool": { + "daysAfterModificationGreaterThan": 30 + }, + "tierToArchive": { + "daysAfterModificationGreaterThan": 90 + }, + "delete": { + "daysAfterModificationGreaterThan": 1000 + } + }, + "snapshot": { + "delete": { + "daysAfterCreationGreaterThan": 30 + } + } + } + } + } + ] + }, + "lastModifiedTime": "2018-06-08T03:01:55.7168089Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountGetProperties.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountGetProperties.json new file mode 100644 index 000000000000..534b779c6138 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountGetProperties.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7902", + "accountName": "sto5800", + "api-version": "2018-03-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "kind": "StorageV2", + "id": "/subscriptions/{subscription-id}/resourceGroups/res7902/providers/Microsoft.Storage/storageAccounts/sto5800", + "name": "sto5800", + "type": "Microsoft.Storage/storageAccounts", + "location": "eastus2(stage)", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "isHnsEnabled": true, + "networkAcls": { + "bypass": "AzureServices", + "virtualNetworkRules": [], + "ipRules": [], + "defaultAction": "Allow" + }, + "supportsHttpsTrafficOnly": true, + "encryption": { + "services": { + "file": { + "enabled": true, + "lastEnabledTime": "2018-04-13T06:40:38.0168941Z" + }, + "blob": { + "enabled": true, + "lastEnabledTime": "2018-04-13T06:40:38.0168941Z" + } + }, + "keySource": "Microsoft.Storage" + }, + "accessTier": "Hot", + "provisioningState": "Succeeded", + "creationTime": "2018-04-13T06:40:37.9842922Z", + "primaryEndpoints": { + "web": "https://sto5800.web.core.windows.net/", + "dfs": "https://sto5800.dfs.core.windows.net/", + "blob": "https://sto5800.blob.core.windows.net/", + "queue": "https://sto5800.queue.core.windows.net/", + "table": "https://sto5800.table.core.windows.net/", + "file": "https://sto5800.file.core.windows.net/" + }, + "primaryLocation": "eastus2(stage)", + "statusOfPrimary": "available", + "secondaryLocation": "northcentralus(stage)", + "statusOfSecondary": "available" + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountList.json new file mode 100644 index 000000000000..be7f2ac9035c --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountList.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-03-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_LRS", + "tier": "Standard" + }, + "kind": "StorageV2", + "id": "/subscriptions/{subscription-id}/resourceGroups/weitest/providers/Microsoft.Storage/storageAccounts/weiwebtest", + "name": "weiwebtest", + "type": "Microsoft.Storage/storageAccounts", + "location": "eastus2(stage)", + "tags": {}, + "properties": { + "isHnsEnabled": true, + "networkAcls": { + "bypass": "AzureServices", + "virtualNetworkRules": [], + "ipRules": [], + "defaultAction": "Allow" + }, + "supportsHttpsTrafficOnly": false, + "encryption": { + "services": { + "file": { + "enabled": true, + "lastEnabledTime": "2018-04-09T08:07:07.5286091Z" + }, + "blob": { + "enabled": true, + "lastEnabledTime": "2018-04-09T08:07:07.5286091Z" + } + }, + "keySource": "Microsoft.Storage" + }, + "accessTier": "Hot", + "provisioningState": "Succeeded", + "creationTime": "2018-04-09T08:07:07.4348556Z", + "primaryEndpoints": { + "web": "https://weiwebtest.web.core.windows.net/", + "dfs": "https://weiwebtest.dfs.core.windows.net/", + "blob": "https://weiwebtest.blob.core.windows.net/", + "queue": "https://weiwebtest.queue.core.windows.net/", + "table": "https://weiwebtest.table.core.windows.net/", + "file": "https://weiwebtest.file.core.windows.net/" + }, + "primaryLocation": "eastus2(stage)", + "statusOfPrimary": "available" + } + }, + { + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "kind": "Storage", + "id": "/subscriptions/{subscription-id}/resourceGroups/res4940/providers/Microsoft.Storage/storageAccounts/sto7478", + "name": "sto7478", + "type": "Microsoft.Storage/storageAccounts", + "location": "eastus2(stage)", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "networkAcls": { + "bypass": "AzureServices", + "virtualNetworkRules": [], + "ipRules": [], + "defaultAction": "Allow" + }, + "supportsHttpsTrafficOnly": false, + "encryption": { + "services": { + "file": { + "enabled": true, + "lastEnabledTime": "2018-03-23T09:43:18.6145793Z" + }, + "blob": { + "enabled": true, + "lastEnabledTime": "2018-03-23T09:43:18.6145793Z" + } + }, + "keySource": "Microsoft.Storage" + }, + "provisioningState": "Succeeded", + "creationTime": "2018-03-23T09:43:18.5989502Z", + "primaryEndpoints": { + "blob": "https://sto7478.blob.core.windows.net/", + "queue": "https://sto7478.queue.core.windows.net/", + "table": "https://sto7478.table.core.windows.net/", + "file": "https://sto7478.file.core.windows.net/" + }, + "primaryLocation": "eastus2(stage)", + "statusOfPrimary": "available", + "secondaryLocation": "northcentralus(stage)", + "statusOfSecondary": "available" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListAccountSAS.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListAccountSAS.json new file mode 100644 index 000000000000..6c3ddad1ca3f --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListAccountSAS.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7985", + "accountName": "sto8588", + "api-version": "2018-03-01-preview", + "monitor": "true", + "parameters": { + "signedServices": "b", + "signedResourceTypes": "s", + "signedPermission": "r", + "signedProtocol": "https,http", + "signedStart": "2017-05-24T10:42:03.1567373Z", + "signedExpiry": "2017-05-24T11:42:03.1567373Z", + "keyToSign": "key1" + } + }, + "responses": { + "200": { + "body": { + "accountSasToken": "sv=2015-04-05&ss=b&srt=s&sp=r&st=2017-05-24T10%3A42%3A03Z&se=2017-05-24T11%3A42%3A03Z&spr=https,http&sig=Z0I%2BEpM%2BPPlTC8ApfUf%2BcffO2aahMgZim3U0iArqsS0%3D" + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListByResourceGroup.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListByResourceGroup.json new file mode 100644 index 000000000000..795b3951548b --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListByResourceGroup.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4669", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "kind": "Storage", + "id": "/subscriptions/{subscription-id}/resourceGroups/res4669/providers/Microsoft.Storage/storageAccounts/sto652", + "name": "sto652", + "type": "Microsoft.Storage/storageAccounts", + "location": "eastus2(stage)", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "isHnsEnabled": true, + "networkAcls": { + "bypass": "AzureServices", + "virtualNetworkRules": [], + "ipRules": [], + "defaultAction": "Allow" + }, + "supportsHttpsTrafficOnly": false, + "encryption": { + "services": { + "file": { + "enabled": true, + "lastEnabledTime": "2018-04-13T06:35:32.6334899Z" + }, + "blob": { + "enabled": true, + "lastEnabledTime": "2018-04-13T06:35:32.6334899Z" + } + }, + "keySource": "Microsoft.Storage" + }, + "provisioningState": "Succeeded", + "creationTime": "2018-04-13T06:35:32.5866198Z", + "primaryEndpoints": { + "web": "https://sto652.web.core.windows.net/", + "dfs": "https://sto652.dfs.core.windows.net/", + "blob": "https://sto652.blob.core.windows.net/", + "queue": "https://sto652.queue.core.windows.net/", + "table": "https://sto652.table.core.windows.net/", + "file": "https://sto652.file.core.windows.net/" + }, + "primaryLocation": "eastus2(stage)", + "statusOfPrimary": "available", + "secondaryLocation": "northcentralus(stage)", + "statusOfSecondary": "available" + } + }, + { + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "kind": "Storage", + "id": "/subscriptions/{subscription-id}/resourceGroups/res4669/providers/Microsoft.Storage/storageAccounts/sto9937", + "name": "sto9937", + "type": "Microsoft.Storage/storageAccounts", + "location": "eastus2(stage)", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "networkAcls": { + "bypass": "AzureServices", + "virtualNetworkRules": [], + "ipRules": [], + "defaultAction": "Allow" + }, + "supportsHttpsTrafficOnly": false, + "encryption": { + "services": { + "file": { + "enabled": true, + "lastEnabledTime": "2018-04-13T06:35:13.7388977Z" + }, + "blob": { + "enabled": true, + "lastEnabledTime": "2018-04-13T06:35:13.7388977Z" + } + }, + "keySource": "Microsoft.Storage" + }, + "provisioningState": "Succeeded", + "creationTime": "2018-04-13T06:35:13.6607394Z", + "primaryEndpoints": { + "web": "https://sto9937.web.core.windows.net/", + "blob": "https://sto9937.blob.core.windows.net/", + "queue": "https://sto9937.queue.core.windows.net/", + "table": "https://sto9937.table.core.windows.net/", + "file": "https://sto9937.file.core.windows.net/" + }, + "primaryLocation": "eastus2(stage)", + "statusOfPrimary": "available", + "secondaryLocation": "northcentralus(stage)", + "statusOfSecondary": "available" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListKeys.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListKeys.json new file mode 100644 index 000000000000..3f78254bb4f9 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListKeys.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res418", + "accountName": "sto2220", + "api-version": "2018-03-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "keys": [ + { + "keyName": "key1", + "permissions": "Full", + "value": "nVF7aKIvr9mV/RM5lOD0sYoi8ThXTRHQP7o66hvUmjCDkPKR3qxPu/otJcNciz2aQdqPuzJH3ECG4TU2yZjQ7Q==" + }, + { + "keyName": "key2", + "permissions": "Full", + "value": "dNJvKnULO586Ji3nFzB7987TJs4ovnGZhyGXeiVQ75HZGPhBmBfe8lXrI7EfyATff6S5ucxffCoEAQOWbmPK/Q==" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListLocationUsage.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListLocationUsage.json new file mode 100644 index 000000000000..34960a076c38 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListLocationUsage.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "eastus2(stage)", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 55, + "limit": 250, + "name": { + "value": "StorageAccounts", + "localizedValue": "Storage Accounts" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListServiceSAS.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListServiceSAS.json new file mode 100644 index 000000000000..5b923848c2b4 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountListServiceSAS.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7439", + "accountName": "sto1299", + "api-version": "2018-03-01-preview", + "monitor": "true", + "parameters": { + "canonicalizedResource": "/blob/sto1299/music", + "signedResource": "c", + "signedPermission": "l", + "signedExpiry": "2017-05-24T11:32:48.8457197Z" + } + }, + "responses": { + "200": { + "body": { + "serviceSasToken": "sv=2015-04-05&sr=c&se=2017-05-24T11%3A32%3A48Z&sp=l&sig=PoF8yBUGixsjzwroLmw7vG3VbGz4KB2woZC2D4C2oio%3D" + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountRegenerateKey.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountRegenerateKey.json new file mode 100644 index 000000000000..0e95b0e360da --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountRegenerateKey.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4167", + "accountName": "sto3539", + "api-version": "2018-03-01-preview", + "monitor": "true", + "regenerateKey": { + "keyName": "key2" + } + }, + "responses": { + "200": { + "body": { + "keys": [ + { + "keyName": "key1", + "permissions": "Full", + "value": "7xl+yQ4MrVpZCHspveCfy4f8jgTY1wv42gHO8k4bAX+EPvN4hY5uPau/bpofgeye+K9FtgvjkadkLISPfOxlMw==" + }, + { + "keyName": "key2", + "permissions": "Full", + "value": "uC+kyJ9/gT81E/+9I1Go4xtOe8sW5rdIm3n6PNIyQ5kGO5OpFq69aWnrn3jLeFIyItzpln9P392U0353RYKvbg==" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountSetManagementPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountSetManagementPolicy.json new file mode 100644 index 000000000000..6e16eb2ac455 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountSetManagementPolicy.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7687", + "accountName": "sto9699", + "managementPolicyName": "default", + "api-version": "2018-03-01-preview", + "monitor": "true", + "properties": { + "properties": { + "policy": { + "version": "0.5", + "rules": [ + { + "name": "olcmtest", + "type": "Lifecycle", + "definition": { + "filters": { + "blobTypes": [ + "blockBlob" + ], + "prefixMatch": [ + "olcmtestcontainer" + ] + }, + "actions": { + "baseBlob": { + "tierToCool": { + "daysAfterModificationGreaterThan": 30 + }, + "tierToArchive": { + "daysAfterModificationGreaterThan": 90 + }, + "delete": { + "daysAfterModificationGreaterThan": 1000 + } + }, + "snapshot": { + "delete": { + "daysAfterCreationGreaterThan": 30 + } + } + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Storage/storageAccounts/sto288/managementPolicies/default", + "name": "DefaultManagementPolicy", + "type": "Microsoft.Storage/storageAccounts/managementPolicies", + "properties": { + "policy": { + "version": "0.5", + "rules": [ + { + "name": "olcmtest", + "type": "Lifecycle", + "definition": { + "filters": { + "blobTypes": [ + "blockBlob" + ], + "prefixMatch": [ + "olcmtestcontainer" + ] + }, + "actions": { + "baseBlob": { + "tierToCool": { + "daysAfterModificationGreaterThan": 30 + }, + "tierToArchive": { + "daysAfterModificationGreaterThan": 90 + }, + "delete": { + "daysAfterModificationGreaterThan": 1000 + } + }, + "snapshot": { + "delete": { + "daysAfterCreationGreaterThan": 30 + } + } + } + } + } + ] + }, + "lastModifiedTime": "2018-06-08T02:53:39.0932539Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountUpdate.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountUpdate.json new file mode 100644 index 000000000000..7f8014a34169 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/StorageAccountUpdate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7902", + "accountName": "sto5800", + "api-version": "2018-03-01-preview", + "monitor": "true", + "parameters": { + "properties": { + "supportsHttpsTrafficOnly": true + }, + "kind": "StorageV2" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "kind": "StorageV2", + "id": "/subscriptions/{subscription-id}/resourceGroups/res7902/providers/Microsoft.Storage/storageAccounts/sto5800", + "name": "sto5800", + "type": "Microsoft.Storage/storageAccounts", + "location": "eastus2(stage)", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "isHnsEnabled": true, + "networkAcls": { + "bypass": "AzureServices", + "virtualNetworkRules": [], + "ipRules": [], + "defaultAction": "Allow" + }, + "supportsHttpsTrafficOnly": true, + "encryption": { + "services": { + "file": { + "enabled": true, + "lastEnabledTime": "2018-04-13T06:40:38.0168941Z" + }, + "blob": { + "enabled": true, + "lastEnabledTime": "2018-04-13T06:40:38.0168941Z" + } + }, + "keySource": "Microsoft.Storage" + }, + "accessTier": "Hot", + "provisioningState": "Succeeded", + "creationTime": "2018-04-13T06:40:37.9842922Z", + "primaryEndpoints": { + "web": "https://sto5800.web.core.windows.net/", + "dfs": "https://sto5800.dfs.core.windows.net/", + "blob": "https://sto5800.blob.core.windows.net/", + "queue": "https://sto5800.queue.core.windows.net/", + "table": "https://sto5800.table.core.windows.net/", + "file": "https://sto5800.file.core.windows.net/" + }, + "primaryLocation": "eastus2(stage)", + "statusOfPrimary": "available", + "secondaryLocation": "northcentralus(stage)", + "statusOfSecondary": "available" + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/UsageList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/UsageList.json new file mode 100644 index 000000000000..40eb7ab74774 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/examples/UsageList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 51, + "limit": 250, + "name": { + "value": "StorageAccounts", + "localizedValue": "Storage Accounts" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/storage.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/storage.json new file mode 100644 index 000000000000..ad4fcd4389aa --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/storage.json @@ -0,0 +1,2115 @@ +{ + "swagger": "2.0", + "info": { + "title": "StorageManagementClient", + "description": "The Azure Storage Management API.", + "version": "2018-03-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Storage/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Storage Rest API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/skus": { + "get": { + "tags": [ + "Skus" + ], + "operationId": "Skus_List", + "description": "Lists the available SKUs supported by Microsoft.Storage for given subscription.", + "x-ms-examples": { + "SkuList": { + "$ref": "./examples/SKUList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List of storage SKUs in the given subscription retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/StorageSkuListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_CheckNameAvailability", + "description": "Checks that the storage account name is valid and is not already in use.", + "x-ms-examples": { + "StorageAccountCheckNameAvailability": { + "$ref": "./examples/StorageAccountCheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "accountName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCheckNameAvailabilityParameters" + }, + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the storage account name availability was successful.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}": { + "put": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Create", + "description": "Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.", + "x-ms-examples": { + "StorageAccountCreate": { + "$ref": "./examples/StorageAccountCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCreateParameters" + }, + "description": "The parameters to provide for the created account." + }, + { + "$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 when the storage account was already created from a previous request with the same properties specified in the request body.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Delete", + "description": "Deletes a storage account in Microsoft Azure.", + "x-ms-examples": { + "StorageAccountDelete": { + "$ref": "./examples/StorageAccountDelete.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 -- storage account deleted successfully." + }, + "204": { + "description": "NoContent -- account does not exist in the subscription." + } + } + }, + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_GetProperties", + "description": "Returns the properties for the specified storage account including but not limited to name, SKU name, location, and account status. The ListKeys operation should be used to retrieve storage keys.", + "x-ms-examples": { + "StorageAccountGetProperties": { + "$ref": "./examples/StorageAccountGetProperties.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 -- properties retrieved successfully for the storage account.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + }, + "patch": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Update", + "description": "The update operation can be used to update the SKU, encryption, access tier, or tags for a storage account. It can also be used to map the account to a custom domain. Only one custom domain is supported per storage account; the replacement/change of custom domain is not supported. In order to replace an old custom domain, the old value must be cleared/unregistered before a new value can be set. The update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change the storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation.", + "x-ms-examples": { + "StorageAccountUpdate": { + "$ref": "./examples/StorageAccountUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountUpdateParameters" + }, + "description": "The parameters to provide for the updated account." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- storage account properties updated successfully.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_List", + "description": "Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.", + "x-ms-examples": { + "StorageAccountList": { + "$ref": "./examples/StorageAccountList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List of storage accounts was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/StorageAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListByResourceGroup", + "description": "Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.", + "x-ms-examples": { + "StorageAccountListByResourceGroup": { + "$ref": "./examples/StorageAccountListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List of storage accounts in the given resource group retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/StorageAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListKeys", + "description": "Lists the access keys for the specified storage account.", + "x-ms-examples": { + "StorageAccountListKeys": { + "$ref": "./examples/StorageAccountListKeys.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 -- list of keys retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/StorageAccountListKeysResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_RegenerateKey", + "description": "Regenerates one of the access keys for the specified storage account.", + "x-ms-examples": { + "StorageAccountRegenerateKey": { + "$ref": "./examples/StorageAccountRegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "name": "regenerateKey", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountRegenerateKeyParameters" + }, + "description": "Specifies name of the key which should be regenerated -- key1 or key2." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- specified key regenerated successfully.", + "schema": { + "$ref": "#/definitions/StorageAccountListKeysResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usages_List", + "description": "Gets the current usage count and the limit for the resources under the subscription.", + "x-ms-examples": { + "UsageList": { + "$ref": "./examples/UsageList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- current usage count and limit retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/usages": { + "get": { + "tags": [ + "LocationUsage" + ], + "operationId": "Usages_ListByLocation", + "description": "Gets the current usage count and the limit for the resources of the location under the subscription.", + "x-ms-examples": { + "UsageList": { "$ref": "./examples/StorageAccountListLocationUsage.json"} + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the Azure Storage resource." + } + ], + "responses": { + "200": { + "description": "OK -- current usage count and limit retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListAccountSas": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListAccountSAS", + "description": "List SAS credentials of a storage account.", + "x-ms-examples": { + "StorageAccountListAccountSAS": { + "$ref": "./examples/StorageAccountListAccountSAS.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccountSasParameters" + }, + "description": "The parameters to provide to list SAS credentials for the storage account." + }, + { + "$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 account SAS created for the storage account requested.", + "schema": { + "$ref": "#/definitions/ListAccountSasResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListServiceSas": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListServiceSAS", + "description": "List service SAS credentials of a specific resource.", + "x-ms-examples": { + "StorageAccountListServiceSAS": { + "$ref": "./examples/StorageAccountListServiceSAS.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceSasParameters" + }, + "description": "The parameters to provide to list service SAS credentials." + }, + { + "$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 service SAS created for the storage service requested.", + "schema": { + "$ref": "#/definitions/ListServiceSasResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}": { + "get": { + "tags": [ + "ManagementPolicies" + ], + "operationId": "StorageAccounts_GetManagementPolicies", + "description": "Gets the data policy rules associated with the specified storage account.", + "x-ms-examples": { + "StorageAccountGetManagementPolicies": { "$ref": "./examples/StorageAccountGetManagementPolicy.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" + }, + { + "$ref": "#/parameters/ManagementPolicyName" + } + ], + "responses": { + "200": { + "description": "OK -- Get management policies successfully.", + "schema": { + "$ref": "#/definitions/StorageAccountManagementPolicies" + } + } + } + }, + "put": { + "tags": [ + "ManagementPolicies" + ], + "operationId": "StorageAccounts_CreateOrUpdateManagementPolicies", + "description": "Sets the data policy rules associated with the specified storage account.", + "x-ms-examples": { + "StorageAccountSetManagementPolicies": { "$ref": "./examples/StorageAccountSetManagementPolicy.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" + }, + { + "$ref": "#/parameters/ManagementPolicyName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagementPoliciesRulesSetParameter" + }, + "description": "The data policy rules to set to a storage account." + } + ], + "responses": { + "200": { + "description": "OK -- Get management policies successfully.", + "schema": { + "$ref": "#/definitions/StorageAccountManagementPolicies" + } + } + } + }, + "delete": { + "tags": [ + "ManagementPolicies" + ], + "operationId": "StorageAccounts_DeleteManagementPolicies", + "description": "Deletes the data policy rules associated with the specified storage account.", + "x-ms-examples": { + "StorageAccountDeleteManagementPolicies": { "$ref": "./examples/StorageAccountDeleteManagementPolicy.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" + }, + { + "$ref": "#/parameters/ManagementPolicyName" + } + ], + "responses": { + "200": { + "description": "OK -- Delete management policies successfully." + }, + "204": { + "description": "No Content -- The management policies does not exist." + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Storage operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Storage operations supported by the Storage resource provider." + } + } + }, + "Operation": { + "description": "Storage REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Storage.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + }, + "properties": { + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true, + "x-ms-client-name": "OperationProperties", + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include metric specifications.", + "properties": { + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "Unit could be Bytes or Count." + }, + "dimensions": { + "description": "Dimensions of blobs, including blob type and access tier.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + }, + "aggregationType": { + "type": "string", + "description": "Aggregation type could be Average." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "The property to decide fill gap with zero or not." + }, + "category": { + "type": "string", + "description": "The category this metric specification belong to, could be Capacity." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "Account Resource Id." + } + } + }, + "Dimension": { + "description": "Dimension of blobs, possiblly be blob type or access tier.", + "properties": { + "name": { + "type": "string", + "description": "Display name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + } + } + }, + "StorageAccountCheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "The storage account name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Storage/storageAccounts" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The type of resource, Microsoft.Storage/storageAccounts" + } + }, + "required": [ + "name", + "type" + ], + "description": "The parameters used to check the availabity of the storage account name." + }, + "SKUCapability": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of capability, The capability information in the specified sku, including file encryption, network acls, change notification, etc." + }, + "value": { + "readOnly": true, + "type": "string", + "description": "A string value to indicate states of given capability. Possibly 'true' or 'false'." + } + }, + "description": "The capability information in the specified sku, including file encryption, network acls, change notification, etc." + }, + "Restriction": { + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The type of restrictions. As of now only possible value for this is location." + }, + "values": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted." + }, + "reasonCode": { + "type": "string", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ReasonCode", + "modelAsString": true + }, + "description": "The reason for the restriction. As of now this can be \"QuotaId\" or \"NotAvailableForSubscription\". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The \"NotAvailableForSubscription\" is related to capacity at DC." + } + }, + "description": "The restriction because of which SKU cannot be used." + }, + "StorageSkuListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Sku" + }, + "description": "Get the list result of storage SKUs and their properties." + } + }, + "description": "The response from the List Storage SKUs operation." + }, + "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 is invalid and cannot be used." + }, + "reason": { + "readOnly": true, + "type": "string", + "description": "Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false.", + "enum": [ + "AccountNameInvalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": false + } + }, + "message": { + "readOnly": true, + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.", + "enum": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + } + }, + "tier": { + "readOnly": true, + "type": "string", + "description": "Gets the sku tier. This is based on the SKU name.", + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": false + } + }, + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of the resource, usually it is 'storageAccounts'." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Indicates the type of storage account.", + "enum": [ + "Storage", + "StorageV2", + "BlobStorage" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": false + } + }, + "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.)." + }, + "capabilities": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SKUCapability" + }, + "description": "The capability information in the specified sku, including file encryption, network acls, change notification, etc." + }, + "restrictions": { + "type": "array", + "items": { + "$ref": "#/definitions/Restriction" + }, + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." + } + }, + "required": [ + "name" + ], + "description": "The SKU of the storage account." + }, + "CustomDomain": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." + }, + "useSubDomain": { + "type": "boolean", + "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." + } + }, + "required": [ + "name" + ], + "description": "The custom domain assigned to this storage account. This can be set via Update." + }, + "EncryptionService": { + "properties": { + "enabled": { + "type": "boolean", + "description": "A boolean indicating whether or not the service encrypts the data as it is stored." + }, + "lastEnabledTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate." + } + }, + "description": "A service that allows server-side encryption to be used." + }, + "EncryptionServices": { + "properties": { + "blob": { + "$ref": "#/definitions/EncryptionService", + "description": "The encryption function of the blob storage service." + }, + "file": { + "$ref": "#/definitions/EncryptionService", + "description": "The encryption function of the file storage service." + }, + "table": { + "$ref": "#/definitions/EncryptionService", + "readOnly": true, + "description": "The encryption function of the table storage service." + }, + "queue": { + "$ref": "#/definitions/EncryptionService", + "readOnly": true, + "description": "The encryption function of the queue storage service." + } + }, + "description": "A list of services that support encryption." + }, + "KeyVaultProperties": { + "description": "Properties of key vault.", + "properties": { + "keyname": { + "type": "string", + "description": "The name of KeyVault key.", + "x-ms-client-name": "KeyName" + }, + "keyversion": { + "type": "string", + "description": "The version of KeyVault key.", + "x-ms-client-name": "KeyVersion" + }, + "keyvaulturi": { + "type": "string", + "description": "The Uri of KeyVault.", + "x-ms-client-name": "KeyVaultUri" + } + } + }, + "Encryption": { + "properties": { + "services": { + "$ref": "#/definitions/EncryptionServices", + "description": "List of services which support encryption." + }, + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault", + "enum": [ + "Microsoft.Storage", + "Microsoft.Keyvault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true + }, + "default": "Microsoft.Storage" + }, + "keyvaultproperties": { + "$ref": "#/definitions/KeyVaultProperties", + "x-ms-client-name": "KeyVaultProperties", + "description": "Properties provided by key vault." + } + }, + "required": [ + "keySource" + ], + "description": "The encryption settings on the storage account." + }, + "VirtualNetworkRule": { + "properties": { + "id": { + "type": "string", + "x-ms-client-name": "VirtualNetworkResourceId", + "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}." + }, + "action": { + "type": "string", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "Action", + "modelAsString": false + }, + "default": "Allow", + "description": "The action of virtual network rule." + }, + "state": { + "type": "string", + "enum": [ + "provisioning", + "deprovisioning", + "succeeded", + "failed", + "networkSourceDeleted" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": false + }, + "description": "Gets the state of virtual network rule." + } + }, + "required": [ + "id" + ], + "description": "Virtual Network rule." + }, + "IPRule": { + "properties": { + "value": { + "type": "string", + "x-ms-client-name": "IPAddressOrRange", + "description": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed." + }, + "action": { + "type": "string", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "Action", + "modelAsString": false + }, + "default": "Allow", + "description": "The action of IP ACL rule." + } + }, + "required": [ + "value" + ], + "description": "IP rule with specific IP or IP range in CIDR format." + }, + "NetworkRuleSet": { + "properties": { + "bypass": { + "type": "string", + "enum": [ + "None", + "Logging", + "Metrics", + "AzureServices" + ], + "x-ms-enum": { + "name": "Bypass", + "modelAsString": true + }, + "x-ms-client-name": "Bypass", + "default": "AzureServices", + "description": "Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, \"Logging, Metrics\"), or None to bypass none of those traffics." + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "description": "Virtual Network rule.", + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "Sets the virtual network rules" + }, + "ipRules": { + "type": "array", + "items": { + "description": "IP rule with specific IP or IP range in CIDR format.", + "$ref": "#/definitions/IPRule" + }, + "description": "Sets the IP ACL rules" + }, + "defaultAction": { + "type": "string", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": false + }, + "default": "Allow", + "description": "Specifies the default action of allow or deny when no other rules match." + } + }, + "required": [ + "defaultAction" + ], + "description": "Network rule set" + }, + "StorageAccountPropertiesCreateParameters": { + "properties": { + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted." + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "x-ms-client-name": "NetworkRuleSet", + "description": "Network rule set" + }, + "accessTier": { + "type": "string", + "description": "Required for storage accounts where kind = BlobStorage. The access tier used for billing.", + "enum": [ + "Hot", + "Cool" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": false + } + }, + "supportsHttpsTrafficOnly": { + "type": "boolean", + "default": false, + "x-ms-client-name": "EnableHttpsTrafficOnly", + "description": "Allows https traffic only to storage service if sets to true." + }, + "isHnsEnabled": { + "type": "boolean", + "default": false, + "x-ms-client-name": "IsHnsEnabled", + "description": "Account HierarchicalNamespace enabled if sets to true." + } + }, + "description": "The parameters used to create the storage account." + }, + "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" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": false + } + } + }, + "required": [ + "type" + ], + "description": "Identity for the resource." + }, + "StorageAccountCreateParameters": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Required. Gets or sets the sku name." + }, + "kind": { + "type": "string", + "description": "Required. Indicates the type of storage account.", + "enum": [ + "Storage", + "StorageV2", + "BlobStorage" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": false + } + }, + "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." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountPropertiesCreateParameters", + "description": "The parameters used to create the storage account." + } + }, + "required": [ + "sku", + "kind", + "location" + ], + "description": "The parameters used when creating a storage account." + }, + "Endpoints": { + "properties": { + "blob": { + "readOnly": true, + "type": "string", + "description": "Gets the blob endpoint." + }, + "queue": { + "readOnly": true, + "type": "string", + "description": "Gets the queue endpoint." + }, + "table": { + "readOnly": true, + "type": "string", + "description": "Gets the table endpoint." + }, + "file": { + "readOnly": true, + "type": "string", + "description": "Gets the file endpoint." + }, + "web": { + "readOnly": true, + "type": "string", + "description": "Gets the web endpoint." + }, + "dfs": { + "readOnly": true, + "type": "string", + "description": "Gets the dfs endpoint." + } + }, + "description": "The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object." + }, + "StorageAccountProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the storage account at the time the operation was called.", + "enum": [ + "Creating", + "ResolvingDNS", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "primaryEndpoints": { + "$ref": "#/definitions/Endpoints", + "readOnly": true, + "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint." + }, + "primaryLocation": { + "readOnly": true, + "type": "string", + "description": "Gets the location of the primary data center for the storage account." + }, + "statusOfPrimary": { + "readOnly": true, + "type": "string", + "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", + "enum": [ + "available", + "unavailable" + ], + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": false + } + }, + "lastGeoFailoverTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS." + }, + "secondaryLocation": { + "readOnly": true, + "type": "string", + "description": "Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS." + }, + "statusOfSecondary": { + "readOnly": true, + "type": "string", + "description": "Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS.", + "enum": [ + "available", + "unavailable" + ], + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": false + } + }, + "creationTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Gets the creation date and time of the storage account in UTC." + }, + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "readOnly": true, + "description": "Gets the custom domain the user assigned to this storage account." + }, + "secondaryEndpoints": { + "$ref": "#/definitions/Endpoints", + "readOnly": true, + "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account. Only available if the SKU name is Standard_RAGRS." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "readOnly": true, + "description": "Gets the encryption settings on the account. If unspecified, the account is unencrypted." + }, + "accessTier": { + "readOnly": true, + "type": "string", + "description": "Required for storage accounts where kind = BlobStorage. The access tier used for billing.", + "enum": [ + "Hot", + "Cool" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": false + } + }, + "supportsHttpsTrafficOnly": { + "type": "boolean", + "default": false, + "x-ms-client-name": "EnableHttpsTrafficOnly", + "description": "Allows https traffic only to storage service if sets to true." + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "x-ms-client-name": "NetworkRuleSet", + "description": "Network rule set", + "readOnly": true + }, + "isHnsEnabled": { + "type": "boolean", + "default": false, + "x-ms-client-name": "IsHnsEnabled", + "description": "Account HierarchicalNamespace enabled if sets to true." + } + }, + "description": "Properties of the storage account." + }, + "StorageAccount": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "readOnly": true, + "description": "Gets the SKU." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Gets the Kind.", + "enum": [ + "Storage", + "StorageV2", + "BlobStorage" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": false + } + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountProperties", + "description": "Properties of the storage account." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "The storage account." + }, + "StorageAccountKey": { + "properties": { + "keyName": { + "readOnly": true, + "type": "string", + "description": "Name of the key." + }, + "value": { + "readOnly": true, + "type": "string", + "description": "Base 64-encoded value of the key." + }, + "permissions": { + "readOnly": true, + "type": "string", + "description": "Permissions for the key -- read-only or full permissions.", + "enum": [ + "Read", + "Full" + ], + "x-ms-enum": { + "name": "KeyPermission", + "modelAsString": false + } + } + }, + "description": "An access key for the storage account." + }, + "StorageAccountListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "Gets the list of storage accounts and their properties." + } + }, + "description": "The response from the List Storage Accounts operation." + }, + "StorageAccountListKeysResult": { + "properties": { + "keys": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountKey" + }, + "description": "Gets the list of storage account keys and their properties for the specified storage account." + } + }, + "description": "The response from the ListKeys operation." + }, + "StorageAccountRegenerateKeyParameters": { + "properties": { + "keyName": { + "type": "string", + "description": "The name of storage keys that want to be regenerated, possible vaules are key1, key2." + } + }, + "required": [ + "keyName" + ], + "description": "The parameters used to regenerate the storage account key." + }, + "StorageAccountPropertiesUpdateParameters": { + "properties": { + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "description": "Custom domain assigned to the storage account by the user. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Provides the encryption settings on the account. The default setting is unencrypted." + }, + "accessTier": { + "type": "string", + "description": "Required for storage accounts where kind = BlobStorage. The access tier used for billing.", + "enum": [ + "Hot", + "Cool" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": false + } + }, + "supportsHttpsTrafficOnly": { + "type": "boolean", + "default": false, + "x-ms-client-name": "EnableHttpsTrafficOnly", + "description": "Allows https traffic only to storage service if sets to true." + }, + "networkAcls": { + "description": "Network rule set", + "x-ms-client-name": "NetworkRuleSet", + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "description": "The parameters used when updating a storage account." + }, + "StorageAccountUpdateParameters": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU name. Note that the SKU name cannot be updated to Standard_ZRS or Premium_LRS, nor can accounts of those sku names be updated to any other value." + }, + "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 in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountPropertiesUpdateParameters", + "description": "The parameters used when updating a storage account." + }, + "kind": { + "type": "string", + "description": "Optional. Indicates the type of storage account. Currently only StorageV2 value supported by server.", + "enum": [ + "Storage", + "StorageV2", + "BlobStorage" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": false + } + } + }, + "description": "The parameters that can be provided when updating the storage account properties." + }, + "UsageName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "Gets a string describing the resource name." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "Gets a localized string describing the resource name." + } + }, + "description": "The usage names that can be used; currently limited to StorageAccount." + }, + "Usage": { + "properties": { + "unit": { + "readOnly": true, + "type": "string", + "description": "Gets the unit of measurement.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountsPerSecond", + "BytesPerSecond" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Gets the current count of the allocated resources in the subscription." + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Gets the maximum count of the resources that can be allocated in the subscription." + }, + "name": { + "$ref": "#/definitions/UsageName", + "readOnly": true, + "description": "Gets the name of the type of usage." + } + }, + "description": "Describes Storage Resource Usage." + }, + "UsageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "Gets or sets the list of Storage Resource Usages." + } + }, + "description": "The response from the List Usages operation." + }, + "AccountSasParameters": { + "properties": { + "signedServices": { + "type": "string", + "enum": [ + "b", + "q", + "t", + "f" + ], + "x-ms-enum": { + "name": "Services", + "modelAsString": true + }, + "x-ms-client-name": "Services", + "description": "The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f)." + }, + "signedResourceTypes": { + "type": "string", + "enum": [ + "s", + "c", + "o" + ], + "x-ms-enum": { + "name": "SignedResourceTypes", + "modelAsString": true + }, + "x-ms-client-name": "ResourceTypes", + "description": "The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files." + }, + "signedPermission": { + "type": "string", + "enum": [ + "r", + "d", + "w", + "l", + "a", + "c", + "u", + "p" + ], + "x-ms-enum": { + "name": "Permissions", + "modelAsString": true + }, + "x-ms-client-name": "Permissions", + "description": "The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p)." + }, + "signedIp": { + "type": "string", + "x-ms-client-name": "IPAddressOrRange", + "description": "An IP address or a range of IP addresses from which to accept requests." + }, + "signedProtocol": { + "type": "string", + "enum": [ + "https,http", + "https" + ], + "x-ms-enum": { + "name": "HttpProtocol", + "modelAsString": false + }, + "x-ms-client-name": "Protocols", + "description": "The protocol permitted for a request made with the account SAS." + }, + "signedStart": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "SharedAccessStartTime", + "description": "The time at which the SAS becomes valid." + }, + "signedExpiry": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "SharedAccessExpiryTime", + "description": "The time at which the shared access signature becomes invalid." + }, + "keyToSign": { + "type": "string", + "description": "The key to sign the account SAS token with." + } + }, + "required": [ + "signedServices", + "signedResourceTypes", + "signedPermission", + "signedExpiry" + ], + "description": "The parameters to list SAS credentials of a storage account." + }, + "ListAccountSasResponse": { + "properties": { + "accountSasToken": { + "readOnly": true, + "type": "string", + "description": "List SAS credentials of storage account." + } + }, + "description": "The List SAS credentials operation response." + }, + "ServiceSasParameters": { + "properties": { + "canonicalizedResource": { + "type": "string", + "description": "The canonical path to the signed resource." + }, + "signedResource": { + "type": "string", + "enum": [ + "b", + "c", + "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)." + }, + "signedPermission": { + "type": "string", + "enum": [ + "r", + "d", + "w", + "l", + "a", + "c", + "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)." + }, + "signedIp": { + "type": "string", + "x-ms-client-name": "IPAddressOrRange", + "description": "An IP address or a range of IP addresses from which to accept requests." + }, + "signedProtocol": { + "type": "string", + "enum": [ + "https,http", + "https" + ], + "x-ms-enum": { + "name": "HttpProtocol", + "modelAsString": false + }, + "x-ms-client-name": "Protocols", + "description": "The protocol permitted for a request made with the account SAS." + }, + "signedStart": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "SharedAccessStartTime", + "description": "The time at which the SAS becomes valid." + }, + "signedExpiry": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "SharedAccessExpiryTime", + "description": "The time at which the shared access signature becomes invalid." + }, + "signedIdentifier": { + "type": "string", + "maxLength": 64, + "x-ms-client-name": "Identifier", + "description": "A unique value up to 64 characters in length that correlates to an access policy specified for the container, queue, or table." + }, + "startPk": { + "type": "string", + "x-ms-client-name": "PartitionKeyStart", + "description": "The start of partition key." + }, + "endPk": { + "type": "string", + "x-ms-client-name": "PartitionKeyEnd", + "description": "The end of partition key." + }, + "startRk": { + "type": "string", + "x-ms-client-name": "RowKeyStart", + "description": "The start of row key." + }, + "endRk": { + "type": "string", + "x-ms-client-name": "RowKeyEnd", + "description": "The end of row key." + }, + "keyToSign": { + "type": "string", + "description": "The key to sign the account SAS token with." + }, + "rscc": { + "type": "string", + "x-ms-client-name": "CacheControl", + "description": "The response header override for cache control." + }, + "rscd": { + "type": "string", + "x-ms-client-name": "ContentDisposition", + "description": "The response header override for content disposition." + }, + "rsce": { + "type": "string", + "x-ms-client-name": "ContentEncoding", + "description": "The response header override for content encoding." + }, + "rscl": { + "type": "string", + "x-ms-client-name": "ContentLanguage", + "description": "The response header override for content language." + }, + "rsct": { + "type": "string", + "x-ms-client-name": "ContentType", + "description": "The response header override for content type." + } + }, + "required": [ + "canonicalizedResource", + "signedResource" + ], + "description": "The parameters to list service SAS credentials of a speicific resource." + }, + "ListServiceSasResponse": { + "properties": { + "serviceSasToken": { + "readOnly": true, + "type": "string", + "description": "List service SAS credentials of speicific resource." + } + }, + "description": "The List service SAS credentials operation response." + }, + "StorageAccountManagementPolicies": { + "properties": { + "properties": { + "$ref": "#/definitions/StorageAccountManagementPoliciesRulesProperty", + "x-ms-client-flatten": true, + "readOnly": true, + "description": "Returns the Storage Account Data Policies Rules." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "The Get Storage Account ManagementPolicies operation response." + }, + "StorageAccountManagementPoliciesRulesProperty": { + "properties": { + "lastModifiedTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Returns the date and time the ManagementPolicies was last modified." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ManagementPoliciesRules" + } + ], + "description": "The Storage Account Data Policies properties." + }, + "ManagementPoliciesRulesSetParameter": { + "properties": { + "properties": { + "$ref": "#/definitions/ManagementPoliciesRules", + "x-ms-client-flatten": true, + "description": "The Storage Account ManagementPolicies Rules, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts." + } + }, + "description": "The Storage Account ManagementPolicies Rules, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts." + }, + "ManagementPoliciesRules": { + "properties": { + "policy": { + "type": "object", + "description": "The Storage Account ManagementPolicies Rules, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts." + } + }, + "description": "The Storage Account ManagementPolicies Rules, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts." + } + }, + "parameters": { + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "StorageAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ManagementPolicyName": { + "name": "managementPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Storage Account Management Policy. It should always be 'default'", + "enum":[ + "default" + ], + "x-ms-enum": { + "name": "ManagementPolicyName", + "modelAsString": true + }, + "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" + ] + } + ] +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2017-06-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2017-06-01/storage.json index 372412855176..4aff811869b4 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2017-06-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2017-06-01/storage.json @@ -771,7 +771,7 @@ "name": "ReasonCode", "modelAsString": true }, - "description": "The reason for the restriction. As of now this can be “QuotaId” or “NotAvailableForSubscription”. Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The “NotAvailableForSubscription” is related to capacity at DC." + "description": "The reason for the restriction. As of now this can be \"QuotaId\" or \"NotAvailableForSubscription\". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The \"NotAvailableForSubscription\" is related to capacity at DC." } }, "description": "The restriction because of which SKU cannot be used." diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json index 3da4bea50050..b6bd1c211298 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json @@ -771,7 +771,7 @@ "name": "ReasonCode", "modelAsString": true }, - "description": "The reason for the restriction. As of now this can be “QuotaId” or “NotAvailableForSubscription”. Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The “NotAvailableForSubscription” is related to capacity at DC." + "description": "The reason for the restriction. As of now this can be \"QuotaId\" or \"NotAvailableForSubscription\". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The \"NotAvailableForSubscription\" is related to capacity at DC." } }, "description": "The restriction because of which SKU cannot be used." diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/blob.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/blob.json new file mode 100644 index 000000000000..d86326d7c69e --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/blob.json @@ -0,0 +1,973 @@ + { + "swagger": "2.0", + "info": { + "version": "2018-02-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}/blobServices/default/containers": { + "get": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_List", + "x-ms-examples": { + "ListContainers": { + "$ref": "./examples/BlobContainersList.json" + } + }, + "description": "Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List Container operation completed successfully.", + "schema": { + "$ref": "#/definitions/ListContainerItems" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}": { + "put": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_Create", + "x-ms-examples": { + "PutContainers": { + "$ref": "./examples/BlobContainersPut.json" + } + }, + "description": "Creates a new container under the specified account as described by request body. The container resource includes metadata and properties for that container. It does not include a list of the blobs contained by the container. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "blobContainer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BlobContainer" + }, + "description": "Properties of the blob container to create." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Created -- Create Container operation completed successfully.", + "schema": { + "$ref": "#/definitions/BlobContainer" + } + } + } + }, + "patch": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_Update", + "x-ms-examples": { + "UpdateContainers": { + "$ref": "./examples/BlobContainersPatch.json" + } + }, + "description": "Updates container properties as specified in request body. Properties not mentioned in the request will be unchanged. Update fails if the specified container doesn't already exist. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "blobContainer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BlobContainer" + }, + "description": "Properties to update for the blob container." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Update Container operation completed successfully.", + "schema": { + "$ref": "#/definitions/BlobContainer", + "description": "Properties of the updated blob container." + } + } + } + }, + "get": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_Get", + "x-ms-examples": { + "GetContainers": { + "$ref": "./examples/BlobContainersGet.json" + } + }, + "description": "Gets properties of a specified container. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get Container operation completed successfully.", + "schema": { + "$ref": "#/definitions/BlobContainer" + } + } + } + }, + "delete": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_Delete", + "x-ms-examples": { + "DeleteContainers": { + "$ref": "./examples/BlobContainersDelete.json" + } + }, + "description": "Deletes specified container under its account.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete Container operation completed successfully." + }, + "204": { + "description": "No Content -- The Container not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold": { + "post": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_SetLegalHold", + "x-ms-examples": { + "SetLegalHoldContainers": { + "$ref": "./examples/BlobContainersSetLegalHold.json" + } + }, + "description": "Sets legal hold tags. Setting the same tag results in an idempotent operation. SetLegalHold follows an append pattern and does not clear out the existing tags that are not specified in the request.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "LegalHold", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LegalHold" + }, + "description": "The LegalHold property that will be set to a blob container." + } + ], + "responses": { + "200": { + "description": "OK -- Set legal hold tags for Container completed successfully.", + "schema": { + "$ref": "#/definitions/LegalHold" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold": { + "post": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_ClearLegalHold", + "x-ms-examples": { + "ClearLegalHoldContainers": { + "$ref": "./examples/BlobContainersClearLegalHold.json" + } + }, + "description": "Clears legal hold tags. Clearing the same or non-existent tag results in an idempotent operation. ClearLegalHold clears out only the specified tags in the request.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "LegalHold", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LegalHold" + }, + "description": "The LegalHold property that will be clear from a blob container." + } + ], + "responses": { + "200": { + "description": "OK -- Clear legal hold tags for Container completed successfully.", + "schema": { + "$ref": "#/definitions/LegalHold" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/{immutabilityPolicyName}": { + "put": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_CreateOrUpdateImmutabilityPolicy", + "x-ms-examples": { + "CreateOrUpdateImmutabilityPolicy": { + "$ref": "./examples/BlobContainersPutImmutabilityPolicy.json" + } + }, + "description": "Creates or updates an unlocked immutability policy. ETag in If-Match is honored if given but not required for this operation.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "description": "The ImmutabilityPolicy Properties that will be created or updated to a blob container." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Creates or updates container ImmutabilityPolicy operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "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" + } + } + } + } + }, + "get": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_GetImmutabilityPolicy", + "x-ms-examples": { + "GetImmutabilityPolicy": { + "$ref": "./examples/BlobContainersGetImmutabilityPolicy.json" + } + }, + "description": "Gets the existing immutability policy along with the corresponding ETag in response headers and body.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Gets container ImmutabilityPolicy operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "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" + } + } + } + } + }, + "delete": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_DeleteImmutabilityPolicy", + "x-ms-examples": { + "DeleteImmutabilityPolicy": { + "$ref": "./examples/BlobContainersDeleteImmutabilityPolicy.json" + } + }, + "description": "Aborts an unlocked immutability policy. The response of delete has immutabilityPeriodSinceCreationInDays set to 0. ETag in If-Match is required for this operation. Deleting a locked immutability policy is not allowed, only way is to delete the container after deleting all blobs inside the container.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Deletes container ImmutabilityPolicy operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "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" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/default/lock": { + "post": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_LockImmutabilityPolicy", + "x-ms-examples": { + "LockImmutabilityPolicy": { + "$ref": "./examples/BlobContainersLockImmutabilityPolicy.json" + } + }, + "description": "Sets the ImmutabilityPolicy to Locked state. The only action allowed on a Locked policy is ExtendImmutabilityPolicy action. ETag in If-Match is required for this operation.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Locks container ImmutabilityPolicy operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "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" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/default/extend": { + "post": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_ExtendImmutabilityPolicy", + "x-ms-examples": { + "ExtendImmutabilityPolicy": { + "$ref": "./examples/BlobContainersExtendImmutabilityPolicy.json" + } + }, + "description": "Extends the immutabilityPeriodSinceCreationInDays of a locked immutabilityPolicy. The only action allowed on a Locked policy will be this action. ETag in If-Match is required for this operation.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "description": "The ImmutabilityPolicy Properties that will be extented for a blob container." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Extends container ImmutabilityPolicy operation completed successfully..", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "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" + } + } + } + } + } + } + }, + "definitions": { + "ContainerProperties": { + "properties": { + "publicAccess": { + "type": "string", + "enum": [ + "Container", + "Blob", + "None" + ], + "x-ms-enum": { + "name": "PublicAccess", + "modelAsString": false + }, + "description": "Specifies whether data in the container may be accessed publicly and the level of access." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Returns the date and time the container was last modified." + }, + "leaseStatus": { + "type": "string", + "readOnly": true, + "enum": [ + "Locked", + "Unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatus", + "modelAsString": true + }, + "description": "The lease status of the container." + }, + "leaseState": { + "type": "string", + "readOnly": true, + "enum": [ + "Available", + "Leased", + "Expired", + "Breaking", + "Broken" + ], + "x-ms-enum": { + "name": "LeaseState", + "modelAsString": true + }, + "description": "Lease state of the container." + }, + "leaseDuration": { + "type": "string", + "readOnly": true, + "enum": [ + "Infinite", + "Fixed" + ], + "x-ms-enum": { + "name": "LeaseDuration", + "modelAsString": true + }, + "description": "Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased." + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A name-value pair to associate with the container as metadata." + }, + "immutabilityPolicy": { + "readOnly": true, + "$ref": "#/definitions/ImmutabilityPolicyProperties", + "x-ms-client-name": "ImmutabilityPolicy", + "description": "The ImmutabilityPolicy property of the container." + }, + "legalHold": { + "readOnly": true, + "$ref": "#/definitions/LegalHoldProperties", + "description": "The LegalHold property of the container." + }, + "hasLegalHold": { + "type": "boolean", + "readOnly": true, + "description": "The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account." + }, + "hasImmutabilityPolicy": { + "type": "boolean", + "readOnly": true, + "description": "The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container." + } + }, + "description": "The properties of a container." + }, + "BlobContainer": { + "properties": { + "properties": { + "$ref": "#/definitions/ContainerProperties", + "x-ms-client-flatten": true, + "x-ms-client-name": "ContainerProperties", + "description": "Properties of the blob container." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource" + } + ], + "description": "Properties of the blob container, including Id, resource name, resource type, Etag." + }, + "ImmutabilityPolicyProperty": { + "properties": { + "immutabilityPeriodSinceCreationInDays": { + "type": "integer", + "description": "The immutability period for the blobs in the container since the policy creation, in days." + }, + "state": { + "type": "string", + "readOnly": true, + "enum": [ + "Locked", + "Unlocked" + ], + "x-ms-enum": { + "name": "ImmutabilityPolicyState", + "modelAsString": true + }, + "description": "The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked." + } + }, + "required": [ + "immutabilityPeriodSinceCreationInDays" + ], + "description": "The properties of an ImmutabilityPolicy of a blob container." + }, + "ImmutabilityPolicyProperties": { + "properties": { + "properties": { + "$ref": "#/definitions/ImmutabilityPolicyProperty", + "x-ms-client-flatten": true, + "description": "The properties of an ImmutabilityPolicy of a blob container." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "ImmutabilityPolicy Etag." + }, + "updateHistory": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/UpdateHistoryProperty" + }, + "description": "The ImmutabilityPolicy update history of the blob container." + } + }, + "description": "The properties of an ImmutabilityPolicy of a blob container." + }, + "ImmutabilityPolicy": { + "properties": { + "properties": { + "$ref": "#/definitions/ImmutabilityPolicyProperty", + "x-ms-client-flatten": true, + "description": "The properties of an ImmutabilityPolicy of a blob container." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource" + } + ], + "required": [ + "properties" + ], + "description": "The ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, Etag." + }, + "UpdateHistoryProperty": { + "properties": { + "update": { + "type": "string", + "readOnly": true, + "enum": [ + "put", + "lock", + "extend" + ], + "x-ms-enum": { + "name": "ImmutabilityPolicyUpdateType", + "modelAsString": true + }, + "description": "The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend." + }, + "immutabilityPeriodSinceCreationInDays": { + "type": "integer", + "readOnly": true, + "description": "The immutability period for the blobs in the container since the policy creation, in days." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Returns the date and time the ImmutabilityPolicy was updated." + }, + "objectIdentifier": { + "type": "string", + "readOnly": true, + "description": "Returns the Object ID of the user who updated the ImmutabilityPolicy." + }, + "tenantId": { + "type": "string", + "readOnly": true, + "description": "Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy." + }, + "upn": { + "type": "string", + "readOnly": true, + "description": "Returns the User Principal Name of the user who updated the ImmutabilityPolicy." + } + }, + "description": "An update history of the ImmutabilityPolicy of a blob container." + }, + "LegalHoldProperties": { + "properties": { + "hasLegalHold": { + "type": "boolean", + "readOnly": true, + "description": "The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account." + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/TagProperty" + }, + "description": "The list of LegalHold tags of a blob container." + } + }, + "description": "The LegalHold property of a blob container." + }, + "TagProperty": { + "properties": { + "tag": { + "type": "string", + "readOnly": true, + "description": "The tag value." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Returns the date and time the tag was added." + }, + "objectIdentifier": { + "type": "string", + "readOnly": true, + "description": "Returns the Object ID of the user who added the tag." + }, + "tenantId": { + "type": "string", + "readOnly": true, + "description": "Returns the Tenant ID that issued the token for the user who added the tag." + }, + "upn": { + "type": "string", + "readOnly": true, + "description": "Returns the User Principal Name of the user who added the tag." + } + }, + "description": "A tag of the LegalHold of a blob container." + }, + "LegalHold": { + "properties": { + "hasLegalHold": { + "type": "boolean", + "readOnly": true, + "description": "The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account." + }, + "tags": { + "type": "array", + "items": { + "type": "string", + "maxLength": 23, + "minLength": 3 + }, + "description": "Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP." + } + }, + "required": [ + "tags" + ], + "description": "The LegalHold property of a blob container." + }, + "ListContainerItem": { + "properties": { + "properties": { + "$ref": "#/definitions/ContainerProperties", + "x-ms-client-flatten": true, + "description": "The blob container properties be listed out." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The blob container properties be listed out." + }, + "ListContainerItems": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ListContainerItem" + }, + "description": "The list of blob containers." + } + }, + "description": "The list of blob containers." + } + }, + "parameters": { + "AccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ContainerName": { + "name": "containerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.", + "maxLength": 63, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ImmutabilityPolicyName": { + "name": "immutabilityPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'", + "enum":[ + "default" + ], + "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" + ] + } + ] + } \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersClearLegalHold.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersClearLegalHold.json new file mode 100644 index 000000000000..7034d3fffe3c --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersClearLegalHold.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4303", + "accountName": "sto7280", + "containerName": "container8723", + "api-version": "2018-02-01", + "monitor": "true", + "LegalHold": { + "tags": [ + "tag1", + "tag2", + "tag3" + ] + } + }, + "responses": { + "200": { + "body": { + "hasLegalHold": false, + "tags": [] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersDelete.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersDelete.json new file mode 100644 index 000000000000..8f3553566378 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4079", + "accountName": "sto4506", + "containerName": "container9689", + "api-version": "2018-02-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersDeleteImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersDeleteImmutabilityPolicy.json new file mode 100644 index 000000000000..e859b34c5bb0 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersDeleteImmutabilityPolicy.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res1581", + "accountName": "sto9621", + "containerName": "container4910", + "immutabilityPolicyName": "default", + "If-Match": "\"8d59f81a7fa7be0\"", + "api-version": "2018-02-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res1581/providers/Microsoft.Storage/storageAccounts/sto9621/blobServices/default/containers/container4910/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d59f81a87b40c0\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 0, + "state": "Unlocked" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersExtendImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersExtendImmutabilityPolicy.json new file mode 100644 index 000000000000..de5928904dd3 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersExtendImmutabilityPolicy.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6238", + "accountName": "sto232", + "containerName": "container5023", + "If-Match": "\"8d59f830d0c3bf9\"", + "api-version": "2018-02-01", + "monitor": "true", + "parameters": { + "properties": { + "immutabilityPeriodSinceCreationInDays": 100 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6238/providers/Microsoft.Storage/storageAccounts/sto232/blobServices/default/containers/container5023/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d57a8b2ff50332\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 100, + "state": "Locked" + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersGet.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersGet.json new file mode 100644 index 000000000000..dfcdd715f1a1 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersGet.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9871", + "accountName": "sto6217", + "containerName": "container1634", + "api-version": "2018-02-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/blobServices/default/containers/container1634", + "name": "container1634", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers", + "etag": "\"0x8D592D74CC20EBA\"", + "properties": { + "publicAccess": "None", + "leaseStatus": "Unlocked", + "leaseState": "Available", + "lastModifiedTime": "2018-03-26T05:06:14Z", + "immutabilityPolicy": { + "etag": "\"8d592d74cb3011a\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 100, + "state": "Locked" + }, + "updateHistory": [ + { + "update": "put", + "immutabilityPeriodSinceCreationInDays": 3, + "timestamp": "2018-03-26T05:06:11.431403Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + { + "update": "lock", + "immutabilityPeriodSinceCreationInDays": 3, + "timestamp": "2018-03-26T05:06:13.0907641Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + { + "update": "extend", + "immutabilityPeriodSinceCreationInDays": 100, + "timestamp": "2018-03-26T05:06:14.7097716Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + ] + }, + "legalHold": { + "hasLegalHold": true, + "tags": [ + { + "tag": "tag1", + "timestamp": "2018-03-26T05:06:09.6964643Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + { + "tag": "tag2", + "timestamp": "2018-03-26T05:06:09.6964643Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + { + "tag": "tag3", + "timestamp": "2018-03-26T05:06:09.6964643Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + ] + }, + "hasImmutabilityPolicy": true, + "hasLegalHold": true + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersGetImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersGetImmutabilityPolicy.json new file mode 100644 index 000000000000..b4832e1a531b --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersGetImmutabilityPolicy.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res5221", + "accountName": "sto9177", + "containerName": "container3489", + "immutabilityPolicyName": "default", + "api-version": "2018-02-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res5221/providers/Microsoft.Storage/storageAccounts/sto9177/blobServices/default/containers/container3489/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d59f828e64b75c\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 5, + "state": "Unlocked" + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersList.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersList.json new file mode 100644 index 000000000000..a37be2da97f0 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9290", + "accountName": "sto1590", + "api-version": "2018-02-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": "Available", + "lastModifiedTime": "2018-03-14T08:20:47Z", + "hasImmutabilityPolicy": false, + "hasLegalHold": false + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersLockImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersLockImmutabilityPolicy.json new file mode 100644 index 000000000000..bf2d99c923ee --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersLockImmutabilityPolicy.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res2702", + "accountName": "sto5009", + "containerName": "container1631", + "If-Match": "\"8d59f825b721dd3\"", + "api-version": "2018-02-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res2702/providers/Microsoft.Storage/storageAccounts/sto5009/blobServices/default/containers/container1631/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d57a8a5edb084a\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 3, + "state": "Locked" + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersPatch.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersPatch.json new file mode 100644 index 000000000000..2b878d194e0d --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersPatch.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "containerName": "container6185", + "api-version": "2018-02-01", + "monitor": "true", + "blobContainer": { + "properties": { + "publicAccess": "Container", + "metadata": { + "metadata": "true" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", + "name": "container6185", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers", + "properties": { + "metadata": { + "metadata": "true" + }, + "publicAccess": "Container", + "hasImmutabilityPolicy": false, + "hasLegalHold": false + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersPut.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersPut.json new file mode 100644 index 000000000000..649e2422b75f --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersPut.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "containerName": "container6185", + "api-version": "2018-02-01", + "monitor": "true", + "blobContainer": {} + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", + "name": "container6185", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers" + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersPutImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersPutImmutabilityPolicy.json new file mode 100644 index 000000000000..d11c06313f81 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersPutImmutabilityPolicy.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res1782", + "accountName": "sto7069", + "containerName": "container6397", + "immutabilityPolicyName": "default", + "api-version": "2018-02-01", + "monitor": "true", + "parameters": { + "properties": { + "immutabilityPeriodSinceCreationInDays": 3 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res1782/providers/Microsoft.Storage/storageAccounts/sto7069/blobServices/default/containers/container6397/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d59f830cb130e5\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 3, + "state": "Unlocked" + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersSetLegalHold.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersSetLegalHold.json new file mode 100644 index 000000000000..f5a488a2e762 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/BlobContainersSetLegalHold.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4303", + "accountName": "sto7280", + "containerName": "container8723", + "api-version": "2018-02-01", + "monitor": "true", + "LegalHold": { + "tags": [ + "tag1", + "tag2", + "tag3" + ] + } + }, + "responses": { + "200": { + "body": { + "hasLegalHold": true, + "tags": [ + "tag1", + "tag2", + "tag3" + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/OperationsList.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/OperationsList.json new file mode 100644 index 000000000000..687c60b969e4 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/OperationsList.json @@ -0,0 +1,473 @@ +{ + "parameters": { + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Storage/storageAccounts/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Create/Update Storage Account", + "description": "Creates a storage account with the specified parameters or update the properties or tags or adds custom domain for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/delete", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Delete Storage Account", + "description": "Deletes an existing storage account." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/listkeys/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "List Storage Account Keys", + "description": "Returns the access keys for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/regeneratekey/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Regenerate Storage Account Keys", + "description": "Regenerates the access keys for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/checknameavailability/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Name Availability", + "operation": "Check Name Availability", + "description": "Checks that account name is valid and is not in use." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "List/Get Storage Account(s)", + "description": "Returns the list of storage accounts or gets the properties for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/usages/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Usage Metrics", + "operation": "Get Subscription Usages", + "description": "Returns the limit and the current usage count for resources in the specified subscription" + } + }, + { + "name": "Microsoft.Storage/storageAccounts/listAccountSas/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Account SAS Token", + "operation": "Returns Storage Account SAS Token", + "description": "Returns the Account SAS token for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/listServiceSas/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Returns the Service SAS token for the specified storage account.", + "operation": "Returns Storage Service SAS Token", + "description": "Storage Service SAS Token" + } + }, + { + "name": "Microsoft.Storage/locations/deleteVirtualNetworkOrSubnets/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Location", + "operation": "Delete virtual network or subnets notifications", + "description": "Notifies Microsoft.Storage that virtual network or subnet is being deleted" + } + }, + { + "name": "Microsoft.Storage/operations/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Operations", + "operation": "Poll Asynchronous Operation", + "description": "Polls the status of an asynchronous operation." + } + }, + { + "name": "Microsoft.Storage/register/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Resource Provider", + "operation": "Registers the Storage Resource Provider", + "description": "Registers the subscription for the storage resource provider and enables the creation of storage accounts." + } + }, + { + "name": "Microsoft.Storage/skus/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Skus", + "operation": "List Skus", + "description": "Lists the Skus supported by Microsoft.Storage." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/services/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Create/Update Diagnostic Settings", + "description": "Create/Update storage account diagnostic settings." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "UsedCapacity", + "displayName": "Used capacity", + "displayDescription": "Account used capacity", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity", + "resourceIdDimensionNameOverride": "AccountResourceId" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/blobServices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Blob service", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "BlobCapacity", + "displayName": "Blob Capacity", + "displayDescription": "The amount of storage used by the storage account’s Blob service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [ + { + "name": "BlobType", + "displayName": "Blob type" + } + ], + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "BlobCount", + "displayName": "Blob Count", + "displayDescription": "The number of Blob in the storage account’s Blob service.", + "unit": "Count", + "aggregationType": "Average", + "dimensions": [ + { + "name": "BlobType", + "displayName": "Blob type" + } + ], + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "ContainerCount", + "displayName": "Blob Container Count", + "displayDescription": "The number of containers in the storage account’s Blob service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "BlobProvisionedSize", + "displayName": "Blob Provisioned Size", + "displayDescription": "The amount of storage provisioned in the storage account’s Blob service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [ + { + "name": "BlobType", + "displayName": "Blob type" + } + ], + "fillGapWithZero": false, + "category": "Capacity" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/blobServices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Blob service", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/blobServices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Blob service", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/tableServices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Table service", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "TableCapacity", + "displayName": "Table Capacity", + "displayDescription": "The amount of storage used by the storage account’s Table service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "TableCount", + "displayName": "Table Count", + "displayDescription": "The number of table in the storage account’s Table service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "TableEntityCount", + "displayName": "Table Entity Count", + "displayDescription": "The number of table entities in the storage account’s Table service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/tableServices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Table service", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/tableServices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Table service", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/queueServices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Queue service", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "QueueCapacity", + "displayName": "Queue Capacity", + "displayDescription": "The amount of storage used by the storage account’s Queue service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "QueueCount", + "displayName": "Queue Count", + "displayDescription": "The number of queue in the storage account’s Queue service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "QueueMessageCount", + "displayName": "Queue Message Count", + "displayDescription": "The approximate number of queue messages in the storage account’s Queue service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/queueServices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Queue service", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/queueServices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Queue service", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/fileServices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "File service", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "FileCapacity", + "displayName": "File Capacity", + "displayDescription": "The amount of storage used by the storage account’s File service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "FileProvisionedSize", + "displayName": "File Provisioned Size", + "displayDescription": "The amount of storage provisioned in the storage account’s File service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "FileCount", + "displayName": "File Count", + "displayDescription": "The number of file in the storage account’s File service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "FileShareCount", + "displayName": "File Share Count", + "displayDescription": "The number of file shares in the storage account’s File service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/fileServices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "File service", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/fileServices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "File service", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/SKUList.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/SKUList.json new file mode 100644 index 000000000000..855771666292 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/SKUList.json @@ -0,0 +1,6454 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "true" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountCheckNameAvailability.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountCheckNameAvailability.json new file mode 100644 index 000000000000..e14b1b1b8a20 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountCheckNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-02-01", + "accountName": { + "name": "sto3363", + "type": "Microsoft.Storage/storageAccounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountCreate.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountCreate.json new file mode 100644 index 000000000000..fb48db0af159 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountCreate.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9101", + "accountName": "sto4445", + "api-version": "2018-02-01", + "parameters": { + "sku": { + "name": "Standard_GRS" + }, + "kind": "Storage", + "location": "eastus2euap", + "properties": { + "isHnsEnabled": true + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9101/providers/Microsoft.Storage/storageAccounts/sto4445", + "kind": "Storage", + "location": "eastus2euap", + "name": "sto4445", + "properties": { + "isHnsEnabled": true, + "creationTime": "2017-05-24T13:25:33.4863236Z", + "primaryEndpoints": { + "web": "https://sto4445.web.core.windows.net/", + "dfs": "https://sto4445.dfs.core.windows.net/", + "blob": "https://sto4445.blob.core.windows.net/", + "file": "https://sto4445.file.core.windows.net/", + "queue": "https://sto4445.queue.core.windows.net/", + "table": "https://sto4445.table.core.windows.net/" + }, + "primaryLocation": "eastus2euap", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + } + }, + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountDelete.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountDelete.json new file mode 100644 index 000000000000..1611fc7a5a29 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4228", + "accountName": "sto2434", + "api-version": "2018-02-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountGetProperties.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountGetProperties.json new file mode 100644 index 000000000000..3a4e56baa292 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountGetProperties.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9407", + "accountName": "sto8596", + "api-version": "2018-02-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596", + "kind": "Storage", + "location": "eastus2(stage)", + "name": "sto8596", + "properties": { + "isHnsEnabled": true, + "creationTime": "2017-06-01T02:42:41.7633306Z", + "networkAcls": { + "bypass": "AzureServices", + "defaultAction": "Allow", + "ipRules": [], + "virtualNetworkRules": [] + }, + "primaryEndpoints": { + "web": "https://sto8596.web.core.windows.net/", + "dfs": "https://sto8596.dfs.core.windows.net/", + "blob": "https://sto8596.blob.core.windows.net/", + "file": "https://sto8596.file.core.windows.net/", + "queue": "https://sto8596.queue.core.windows.net/", + "table": "https://sto8596.table.core.windows.net/" + }, + "primaryLocation": "eastus2(stage)", + "provisioningState": "Succeeded", + "secondaryLocation": "northcentralus(stage)", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountList.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountList.json new file mode 100644 index 000000000000..aaf1f6e7fe0f --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountList.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-02-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res2627/providers/Microsoft.Storage/storageAccounts/sto1125", + "kind": "Storage", + "location": "eastus2euap", + "name": "sto1125", + "properties": { + "isHnsEnabled": true, + "creationTime": "2017-05-24T13:28:53.4540398Z", + "primaryEndpoints": { + "web": "https://sto1125.web.core.windows.net/", + "dfs": "https://sto1125.dfs.core.windows.net/", + "blob": "https://sto1125.blob.core.windows.net/", + "file": "https://sto1125.file.core.windows.net/", + "queue": "https://sto1125.queue.core.windows.net/", + "table": "https://sto1125.table.core.windows.net/" + }, + "primaryLocation": "eastus2euap", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto3699", + "identity": { + "principalId": "356d057d-cba5-44dd-8a30-b2e547bc416b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "kind": "Storage", + "location": "eastus2euap", + "name": "sto3699", + "properties": { + "creationTime": "2017-05-24T10:06:30.6093014Z", + "primaryEndpoints": { + "blob": "https://sto3699.blob.core.windows.net/", + "file": "https://sto3699.file.core.windows.net/", + "queue": "https://sto3699.queue.core.windows.net/", + "table": "https://sto3699.table.core.windows.net/" + }, + "primaryLocation": "eastus2euap", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto6637", + "identity": { + "principalId": "911871cc-ffd1-4fc4-ac11-7a316433ea66", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "kind": "Storage", + "location": "eastus2euap", + "name": "sto6637", + "properties": { + "creationTime": "2017-05-24T10:09:39.5625175Z", + "primaryEndpoints": { + "blob": "https://sto6637.blob.core.windows.net/", + "file": "https://sto6637.file.core.windows.net/", + "queue": "https://sto6637.queue.core.windows.net/", + "table": "https://sto6637.table.core.windows.net/" + }, + "primaryLocation": "eastus2euap", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res8186/providers/Microsoft.Storage/storageAccounts/sto834", + "kind": "Storage", + "location": "eastus2euap", + "name": "sto834", + "properties": { + "creationTime": "2017-05-24T13:28:20.8686541Z", + "primaryEndpoints": { + "blob": "https://sto834.blob.core.windows.net/", + "file": "https://sto834.file.core.windows.net/", + "queue": "https://sto834.queue.core.windows.net/", + "table": "https://sto834.table.core.windows.net/" + }, + "primaryLocation": "eastus2euap", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto9174", + "identity": { + "principalId": "933e3ddf-1802-4a51-9469-18a33b576f88", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "kind": "Storage", + "location": "eastus2euap", + "name": "sto9174", + "properties": { + "creationTime": "2017-05-24T09:46:19.6556989Z", + "primaryEndpoints": { + "blob": "https://sto9174.blob.core.windows.net/", + "file": "https://sto9174.file.core.windows.net/", + "queue": "https://sto9174.queue.core.windows.net/", + "table": "https://sto9174.table.core.windows.net/" + }, + "primaryLocation": "eastus2euap", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListAccountSAS.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListAccountSAS.json new file mode 100644 index 000000000000..f518bb837e5b --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListAccountSAS.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7985", + "accountName": "sto8588", + "api-version": "2018-02-01", + "monitor": "true", + "parameters": { + "signedServices": "b", + "signedResourceTypes": "s", + "signedPermission": "r", + "signedProtocol": "https,http", + "signedStart": "2017-05-24T10:42:03.1567373Z", + "signedExpiry": "2017-05-24T11:42:03.1567373Z", + "keyToSign": "key1" + } + }, + "responses": { + "200": { + "body": { + "accountSasToken": "sv=2015-04-05&ss=b&srt=s&sp=r&st=2017-05-24T10%3A42%3A03Z&se=2017-05-24T11%3A42%3A03Z&spr=https,http&sig=Z0I%2BEpM%2BPPlTC8ApfUf%2BcffO2aahMgZim3U0iArqsS0%3D" + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListByResourceGroup.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListByResourceGroup.json new file mode 100644 index 000000000000..af8bca6eb6b0 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6117", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6117/providers/Microsoft.Storage/storageAccounts/sto4036", + "kind": "Storage", + "location": "eastus2euap", + "name": "sto4036", + "properties": { + "isHnsEnabled": true, + "creationTime": "2017-05-24T13:24:47.818801Z", + "primaryEndpoints": { + "web": "https://sto4036.web.core.windows.net/", + "dfs": "https://sto4036.dfs.core.windows.net/", + "blob": "https://sto4036.blob.core.windows.net/", + "file": "https://sto4036.file.core.windows.net/", + "queue": "https://sto4036.queue.core.windows.net/", + "table": "https://sto4036.table.core.windows.net/" + }, + "primaryLocation": "eastus2euap", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6117/providers/Microsoft.Storage/storageAccounts/sto4452", + "kind": "Storage", + "location": "eastus2euap", + "name": "sto4452", + "properties": { + "creationTime": "2017-05-24T13:24:15.7068366Z", + "primaryEndpoints": { + "blob": "https://sto4452.blob.core.windows.net/", + "file": "https://sto4452.file.core.windows.net/", + "queue": "https://sto4452.queue.core.windows.net/", + "table": "https://sto4452.table.core.windows.net/" + }, + "primaryLocation": "eastus2euap", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListKeys.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListKeys.json new file mode 100644 index 000000000000..c5de65b7c404 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListKeys.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res418", + "accountName": "sto2220", + "api-version": "2018-02-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "keys": [ + { + "keyName": "key1", + "permissions": "Full", + "value": "nVF7aKIvr9mV/RM5lOD0sYoi8ThXTRHQP7o66hvUmjCDkPKR3qxPu/otJcNciz2aQdqPuzJH3ECG4TU2yZjQ7Q==" + }, + { + "keyName": "key2", + "permissions": "Full", + "value": "dNJvKnULO586Ji3nFzB7987TJs4ovnGZhyGXeiVQ75HZGPhBmBfe8lXrI7EfyATff6S5ucxffCoEAQOWbmPK/Q==" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListLocationUsage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListLocationUsage.json new file mode 100644 index 000000000000..100705deb0e1 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListLocationUsage.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "eastus2(stage)", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 55, + "limit": 250, + "name": { + "value": "StorageAccounts", + "localizedValue": "Storage Accounts" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListServiceSAS.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListServiceSAS.json new file mode 100644 index 000000000000..3799ff56dca7 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountListServiceSAS.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7439", + "accountName": "sto1299", + "api-version": "2018-02-01", + "monitor": "true", + "parameters": { + "canonicalizedResource": "/blob/sto1299/music", + "signedResource": "c", + "signedPermission": "l", + "signedExpiry": "2017-05-24T11:32:48.8457197Z" + } + }, + "responses": { + "200": { + "body": { + "serviceSasToken": "sv=2015-04-05&sr=c&se=2017-05-24T11%3A32%3A48Z&sp=l&sig=PoF8yBUGixsjzwroLmw7vG3VbGz4KB2woZC2D4C2oio%3D" + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountRegenerateKey.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountRegenerateKey.json new file mode 100644 index 000000000000..35a883b764f8 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountRegenerateKey.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4167", + "accountName": "sto3539", + "api-version": "2018-02-01", + "monitor": "true", + "regenerateKey": { + "keyName": "key2" + } + }, + "responses": { + "200": { + "body": { + "keys": [ + { + "keyName": "key1", + "permissions": "Full", + "value": "7xl+yQ4MrVpZCHspveCfy4f8jgTY1wv42gHO8k4bAX+EPvN4hY5uPau/bpofgeye+K9FtgvjkadkLISPfOxlMw==" + }, + { + "keyName": "key2", + "permissions": "Full", + "value": "uC+kyJ9/gT81E/+9I1Go4xtOe8sW5rdIm3n6PNIyQ5kGO5OpFq69aWnrn3jLeFIyItzpln9P392U0353RYKvbg==" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountUpdate.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountUpdate.json new file mode 100644 index 000000000000..1d2b14b351a8 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/StorageAccountUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9407", + "accountName": "sto8596", + "api-version": "2018-02-01", + "monitor": "true", + "parameters": { + "properties": { + "networkAcls": { + "defaultAction": "Allow" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596", + "kind": "Storage", + "location": "eastus2(stage)", + "name": "sto8596", + "properties": { + "isHnsEnabled": true, + "creationTime": "2017-06-01T02:42:41.7633306Z", + "networkAcls": { + "bypass": "AzureServices", + "defaultAction": "Allow", + "ipRules": [], + "virtualNetworkRules": [] + }, + "primaryEndpoints": { + "web": "https://sto8596.web.core.windows.net/", + "dfs": "https://sto8596.dfs.core.windows.net/", + "blob": "https://sto8596.blob.core.windows.net/", + "file": "https://sto8596.file.core.windows.net/", + "queue": "https://sto8596.queue.core.windows.net/", + "table": "https://sto8596.table.core.windows.net/" + }, + "primaryLocation": "eastus2(stage)", + "provisioningState": "Succeeded", + "secondaryLocation": "northcentralus(stage)", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/UsageList.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/UsageList.json new file mode 100644 index 000000000000..be75fae56bf8 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/examples/UsageList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 51, + "limit": 250, + "name": { + "value": "StorageAccounts", + "localizedValue": "Storage Accounts" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/storage.json new file mode 100644 index 000000000000..b74d8644467a --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/storage.json @@ -0,0 +1,1971 @@ +{ + "swagger": "2.0", + "info": { + "title": "StorageManagementClient", + "description": "The Azure Storage Management API.", + "version": "2018-02-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Storage/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Storage Rest API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/skus": { + "get": { + "tags": [ + "Skus" + ], + "operationId": "Skus_List", + "description": "Lists the available SKUs supported by Microsoft.Storage for given subscription.", + "x-ms-examples": { + "SkuList": { + "$ref": "./examples/SKUList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List of storage SKUs in the given subscription retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/StorageSkuListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_CheckNameAvailability", + "description": "Checks that the storage account name is valid and is not already in use.", + "x-ms-examples": { + "StorageAccountCheckNameAvailability": { + "$ref": "./examples/StorageAccountCheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "accountName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCheckNameAvailabilityParameters" + }, + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the storage account name availability was successful.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}": { + "put": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Create", + "description": "Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.", + "x-ms-examples": { + "StorageAccountCreate": { + "$ref": "./examples/StorageAccountCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.", + "maxLength": 24, + "minLength": 3 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCreateParameters" + }, + "description": "The parameters to provide for the created account." + }, + { + "$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 when the storage account was already created from a previous request with the same properties specified in the request body.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Delete", + "description": "Deletes a storage account in Microsoft Azure.", + "x-ms-examples": { + "StorageAccountDelete": { + "$ref": "./examples/StorageAccountDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.", + "maxLength": 24, + "minLength": 3 + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- storage account deleted successfully." + }, + "204": { + "description": "NoContent -- account does not exist in the subscription." + } + } + }, + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_GetProperties", + "description": "Returns the properties for the specified storage account including but not limited to name, SKU name, location, and account status. The ListKeys operation should be used to retrieve storage keys.", + "x-ms-examples": { + "StorageAccountGetProperties": { + "$ref": "./examples/StorageAccountGetProperties.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", + "maxLength": 24, + "minLength": 3 + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- properties retrieved successfully for the storage account.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + }, + "patch": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Update", + "description": "The update operation can be used to update the SKU, encryption, access tier, or tags for a storage account. It can also be used to map the account to a custom domain. Only one custom domain is supported per storage account; the replacement/change of custom domain is not supported. In order to replace an old custom domain, the old value must be cleared/unregistered before a new value can be set. The update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change the storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation.", + "x-ms-examples": { + "StorageAccountUpdate": { + "$ref": "./examples/StorageAccountUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.", + "maxLength": 24, + "minLength": 3 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountUpdateParameters" + }, + "description": "The parameters to provide for the updated account." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- storage account properties updated successfully.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_List", + "description": "Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.", + "x-ms-examples": { + "StorageAccountList": { + "$ref": "./examples/StorageAccountList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List of storage accounts was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/StorageAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListByResourceGroup", + "description": "Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.", + "x-ms-examples": { + "StorageAccountListByResourceGroup": { + "$ref": "./examples/StorageAccountListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List of storage accounts in the given resource group retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/StorageAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListKeys", + "description": "Lists the access keys for the specified storage account.", + "x-ms-examples": { + "StorageAccountListKeys": { + "$ref": "./examples/StorageAccountListKeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.", + "maxLength": 24, + "minLength": 3 + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- list of keys retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/StorageAccountListKeysResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_RegenerateKey", + "description": "Regenerates one of the access keys for the specified storage account.", + "x-ms-examples": { + "StorageAccountRegenerateKey": { + "$ref": "./examples/StorageAccountRegenerateKey.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.", + "maxLength": 24, + "minLength": 3 + }, + { + "name": "regenerateKey", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountRegenerateKeyParameters" + }, + "description": "Specifies name of the key which should be regenerated -- key1 or key2." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- specified key regenerated successfully.", + "schema": { + "$ref": "#/definitions/StorageAccountListKeysResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usage_List", + "description": "Gets the current usage count and the limit for the resources under the subscription.", + "x-ms-examples": { + "UsageList": { + "$ref": "./examples/UsageList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- current usage count and limit retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/usages": { + "get": { + "tags": [ + "LocationUsage" + ], + "operationId": "Usage_ListByLocation", + "description": "Gets the current usage count and the limit for the resources of the location under the subscription.", + "x-ms-examples": { + "UsageList": { "$ref": "./examples/StorageAccountListLocationUsage.json"} + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the Azure Storage resource." + } + ], + "responses": { + "200": { + "description": "OK -- current usage count and limit retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListAccountSas": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListAccountSAS", + "description": "List SAS credentials of a storage account.", + "x-ms-examples": { + "StorageAccountListAccountSAS": { + "$ref": "./examples/StorageAccountListAccountSAS.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", + "maxLength": 24, + "minLength": 3 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccountSasParameters" + }, + "description": "The parameters to provide to list SAS credentials for the storage account." + }, + { + "$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 account SAS created for the storage account requested.", + "schema": { + "$ref": "#/definitions/ListAccountSasResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListServiceSas": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListServiceSAS", + "description": "List service SAS credentials of a specific resource.", + "x-ms-examples": { + "StorageAccountListServiceSAS": { + "$ref": "./examples/StorageAccountListServiceSAS.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.", + "maxLength": 24, + "minLength": 3 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceSasParameters" + }, + "description": "The parameters to provide to list service SAS credentials." + }, + { + "$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 service SAS created for the storage service requested.", + "schema": { + "$ref": "#/definitions/ListServiceSasResponse" + } + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Storage operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Storage operations supported by the Storage resource provider." + } + } + }, + "Operation": { + "description": "Storage REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Storage.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + }, + "properties": { + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true, + "x-ms-client-name": "OperationProperties", + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include metric specifications.", + "properties": { + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "Unit could be Bytes or Count." + }, + "dimensions": { + "description": "Dimensions of blobs, including blob type and access tier.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + }, + "aggregationType": { + "type": "string", + "description": "Aggregation type could be Average." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "The property to decide fill gap with zero or not." + }, + "category": { + "type": "string", + "description": "The category this metric specification belong to, could be Capacity." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "Account Resource Id." + } + } + }, + "Dimension": { + "description": "Dimension of blobs, possiblly be blob type or access tier.", + "properties": { + "name": { + "type": "string", + "description": "Display name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + } + } + }, + "StorageAccountCheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "The storage account name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Storage/storageAccounts" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The type of resource, Microsoft.Storage/storageAccounts" + } + }, + "required": [ + "name", + "type" + ], + "description": "The parameters used to check the availabity of the storage account name." + }, + "SKUCapability": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of capability, The capability information in the specified sku, including file encryption, network acls, change notification, etc." + }, + "value": { + "readOnly": true, + "type": "string", + "description": "A string value to indicate states of given capability. Possibly 'true' or 'false'." + } + }, + "description": "The capability information in the specified sku, including file encryption, network acls, change notification, etc." + }, + "Restriction": { + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The type of restrictions. As of now only possible value for this is location." + }, + "values": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted." + }, + "reasonCode": { + "type": "string", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ReasonCode", + "modelAsString": true + }, + "description": "The reason for the restriction. As of now this can be \"QuotaId\" or \"NotAvailableForSubscription\". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The \"NotAvailableForSubscription\" is related to capacity at DC." + } + }, + "description": "The restriction because of which SKU cannot be used." + }, + "StorageSkuListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Sku" + }, + "description": "Get the list result of storage SKUs and their properties." + } + }, + "description": "The response from the List Storage SKUs operation." + }, + "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 is invalid and cannot be used." + }, + "reason": { + "readOnly": true, + "type": "string", + "description": "Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false.", + "enum": [ + "AccountNameInvalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": false + } + }, + "message": { + "readOnly": true, + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.", + "enum": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + } + }, + "tier": { + "readOnly": true, + "type": "string", + "description": "Gets the sku tier. This is based on the SKU name.", + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": false + } + }, + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of the resource, usually it is 'storageAccounts'." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Indicates the type of storage account.", + "enum": [ + "Storage", + "StorageV2", + "BlobStorage" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": false + } + }, + "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.)." + }, + "capabilities": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SKUCapability" + }, + "description": "The capability information in the specified sku, including file encryption, network acls, change notification, etc." + }, + "restrictions": { + "type": "array", + "items": { + "$ref": "#/definitions/Restriction" + }, + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." + } + }, + "required": [ + "name" + ], + "description": "The SKU of the storage account." + }, + "CustomDomain": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." + }, + "useSubDomain": { + "type": "boolean", + "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." + } + }, + "required": [ + "name" + ], + "description": "The custom domain assigned to this storage account. This can be set via Update." + }, + "EncryptionService": { + "properties": { + "enabled": { + "type": "boolean", + "description": "A boolean indicating whether or not the service encrypts the data as it is stored." + }, + "lastEnabledTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate." + } + }, + "description": "A service that allows server-side encryption to be used." + }, + "EncryptionServices": { + "properties": { + "blob": { + "$ref": "#/definitions/EncryptionService", + "description": "The encryption function of the blob storage service." + }, + "file": { + "$ref": "#/definitions/EncryptionService", + "description": "The encryption function of the file storage service." + }, + "table": { + "$ref": "#/definitions/EncryptionService", + "readOnly": true, + "description": "The encryption function of the table storage service." + }, + "queue": { + "$ref": "#/definitions/EncryptionService", + "readOnly": true, + "description": "The encryption function of the queue storage service." + } + }, + "description": "A list of services that support encryption." + }, + "KeyVaultProperties": { + "description": "Properties of key vault.", + "properties": { + "keyname": { + "type": "string", + "description": "The name of KeyVault key.", + "x-ms-client-name": "KeyName" + }, + "keyversion": { + "type": "string", + "description": "The version of KeyVault key.", + "x-ms-client-name": "KeyVersion" + }, + "keyvaulturi": { + "type": "string", + "description": "The Uri of KeyVault.", + "x-ms-client-name": "KeyVaultUri" + } + } + }, + "Encryption": { + "properties": { + "services": { + "$ref": "#/definitions/EncryptionServices", + "description": "List of services which support encryption." + }, + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault", + "enum": [ + "Microsoft.Storage", + "Microsoft.Keyvault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true + }, + "default": "Microsoft.Storage" + }, + "keyvaultproperties": { + "$ref": "#/definitions/KeyVaultProperties", + "x-ms-client-name": "KeyVaultProperties", + "description": "Properties provided by key vault." + } + }, + "required": [ + "keySource" + ], + "description": "The encryption settings on the storage account." + }, + "VirtualNetworkRule": { + "properties": { + "id": { + "type": "string", + "x-ms-client-name": "VirtualNetworkResourceId", + "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}." + }, + "action": { + "type": "string", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "Action", + "modelAsString": false + }, + "default": "Allow", + "description": "The action of virtual network rule." + }, + "state": { + "type": "string", + "enum": [ + "provisioning", + "deprovisioning", + "succeeded", + "failed", + "networkSourceDeleted" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": false + }, + "description": "Gets the state of virtual network rule." + } + }, + "required": [ + "id" + ], + "description": "Virtual Network rule." + }, + "IPRule": { + "properties": { + "value": { + "type": "string", + "x-ms-client-name": "IPAddressOrRange", + "description": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed." + }, + "action": { + "type": "string", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "Action", + "modelAsString": false + }, + "default": "Allow", + "description": "The action of IP ACL rule." + } + }, + "required": [ + "value" + ], + "description": "IP rule with specific IP or IP range in CIDR format." + }, + "NetworkRuleSet": { + "properties": { + "bypass": { + "type": "string", + "enum": [ + "None", + "Logging", + "Metrics", + "AzureServices" + ], + "x-ms-enum": { + "name": "Bypass", + "modelAsString": true + }, + "x-ms-client-name": "Bypass", + "default": "AzureServices", + "description": "Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, \"Logging, Metrics\"), or None to bypass none of those traffics." + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "description": "Virtual Network rule.", + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "Sets the virtual network rules" + }, + "ipRules": { + "type": "array", + "items": { + "description": "IP rule with specific IP or IP range in CIDR format.", + "$ref": "#/definitions/IPRule" + }, + "description": "Sets the IP ACL rules" + }, + "defaultAction": { + "type": "string", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": false + }, + "default": "Allow", + "description": "Specifies the default action of allow or deny when no other rules match." + } + }, + "required": [ + "defaultAction" + ], + "description": "Network rule set" + }, + "StorageAccountPropertiesCreateParameters": { + "properties": { + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted." + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "x-ms-client-name": "NetworkRuleSet", + "description": "Network rule set" + }, + "accessTier": { + "type": "string", + "description": "Required for storage accounts where kind = BlobStorage. The access tier used for billing.", + "enum": [ + "Hot", + "Cool" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": false + } + }, + "supportsHttpsTrafficOnly": { + "type": "boolean", + "default": false, + "x-ms-client-name": "EnableHttpsTrafficOnly", + "description": "Allows https traffic only to storage service if sets to true." + }, + "isHnsEnabled": { + "type": "boolean", + "default": false, + "x-ms-client-name": "IsHnsEnabled", + "description": "Account HierarchicalNamespace enabled if sets to true." + } + }, + "description": "The parameters used to create the storage account." + }, + "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" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": false + } + } + }, + "required": [ + "type" + ], + "description": "Identity for the resource." + }, + "StorageAccountCreateParameters": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Required. Gets or sets the sku name." + }, + "kind": { + "type": "string", + "description": "Required. Indicates the type of storage account.", + "enum": [ + "Storage", + "StorageV2", + "BlobStorage" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": false + } + }, + "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." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountPropertiesCreateParameters", + "description": "The parameters used to create the storage account." + } + }, + "required": [ + "sku", + "kind", + "location" + ], + "description": "The parameters used when creating a storage account." + }, + "Endpoints": { + "properties": { + "blob": { + "readOnly": true, + "type": "string", + "description": "Gets the blob endpoint." + }, + "queue": { + "readOnly": true, + "type": "string", + "description": "Gets the queue endpoint." + }, + "table": { + "readOnly": true, + "type": "string", + "description": "Gets the table endpoint." + }, + "file": { + "readOnly": true, + "type": "string", + "description": "Gets the file endpoint." + }, + "web": { + "readOnly": true, + "type": "string", + "description": "Gets the web endpoint." + }, + "dfs": { + "readOnly": true, + "type": "string", + "description": "Gets the dfs endpoint." + } + }, + "description": "The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object." + }, + "StorageAccountProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the storage account at the time the operation was called.", + "enum": [ + "Creating", + "ResolvingDNS", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "primaryEndpoints": { + "$ref": "#/definitions/Endpoints", + "readOnly": true, + "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint." + }, + "primaryLocation": { + "readOnly": true, + "type": "string", + "description": "Gets the location of the primary data center for the storage account." + }, + "statusOfPrimary": { + "readOnly": true, + "type": "string", + "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", + "enum": [ + "available", + "unavailable" + ], + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": false + } + }, + "lastGeoFailoverTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS." + }, + "secondaryLocation": { + "readOnly": true, + "type": "string", + "description": "Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS." + }, + "statusOfSecondary": { + "readOnly": true, + "type": "string", + "description": "Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS.", + "enum": [ + "available", + "unavailable" + ], + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": false + } + }, + "creationTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Gets the creation date and time of the storage account in UTC." + }, + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "readOnly": true, + "description": "Gets the custom domain the user assigned to this storage account." + }, + "secondaryEndpoints": { + "$ref": "#/definitions/Endpoints", + "readOnly": true, + "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account. Only available if the SKU name is Standard_RAGRS." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "readOnly": true, + "description": "Gets the encryption settings on the account. If unspecified, the account is unencrypted." + }, + "accessTier": { + "readOnly": true, + "type": "string", + "description": "Required for storage accounts where kind = BlobStorage. The access tier used for billing.", + "enum": [ + "Hot", + "Cool" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": false + } + }, + "supportsHttpsTrafficOnly": { + "type": "boolean", + "default": false, + "x-ms-client-name": "EnableHttpsTrafficOnly", + "description": "Allows https traffic only to storage service if sets to true." + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "x-ms-client-name": "NetworkRuleSet", + "description": "Network rule set", + "readOnly": true + }, + "isHnsEnabled": { + "type": "boolean", + "default": false, + "x-ms-client-name": "IsHnsEnabled", + "description": "Account HierarchicalNamespace enabled if sets to true." + } + }, + "description": "Properties of the storage account." + }, + "StorageAccount": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "readOnly": true, + "description": "Gets the SKU." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Gets the Kind.", + "enum": [ + "Storage", + "StorageV2", + "BlobStorage" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": false + } + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountProperties", + "description": "Properties of the storage account." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "The storage account." + }, + "StorageAccountKey": { + "properties": { + "keyName": { + "readOnly": true, + "type": "string", + "description": "Name of the key." + }, + "value": { + "readOnly": true, + "type": "string", + "description": "Base 64-encoded value of the key." + }, + "permissions": { + "readOnly": true, + "type": "string", + "description": "Permissions for the key -- read-only or full permissions.", + "enum": [ + "Read", + "Full" + ], + "x-ms-enum": { + "name": "KeyPermission", + "modelAsString": false + } + } + }, + "description": "An access key for the storage account." + }, + "StorageAccountListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "Gets the list of storage accounts and their properties." + } + }, + "description": "The response from the List Storage Accounts operation." + }, + "StorageAccountListKeysResult": { + "properties": { + "keys": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountKey" + }, + "description": "Gets the list of storage account keys and their properties for the specified storage account." + } + }, + "description": "The response from the ListKeys operation." + }, + "StorageAccountRegenerateKeyParameters": { + "properties": { + "keyName": { + "type": "string", + "description": "The name of storage keys that want to be regenerated, possible vaules are key1, key2." + } + }, + "required": [ + "keyName" + ], + "description": "The parameters used to regenerate the storage account key." + }, + "StorageAccountPropertiesUpdateParameters": { + "properties": { + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "description": "Custom domain assigned to the storage account by the user. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Provides the encryption settings on the account. The default setting is unencrypted." + }, + "accessTier": { + "type": "string", + "description": "Required for storage accounts where kind = BlobStorage. The access tier used for billing.", + "enum": [ + "Hot", + "Cool" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": false + } + }, + "supportsHttpsTrafficOnly": { + "type": "boolean", + "default": false, + "x-ms-client-name": "EnableHttpsTrafficOnly", + "description": "Allows https traffic only to storage service if sets to true." + }, + "networkAcls": { + "description": "Network rule set", + "x-ms-client-name": "NetworkRuleSet", + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "description": "The parameters used when updating a storage account." + }, + "StorageAccountUpdateParameters": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU name. Note that the SKU name cannot be updated to Standard_ZRS or Premium_LRS, nor can accounts of those sku names be updated to any other value." + }, + "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 in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountPropertiesUpdateParameters", + "description": "The parameters used when updating a storage account." + }, + "kind": { + "type": "string", + "description": "Optional. Indicates the type of storage account. Currently only StorageV2 value supported by server.", + "enum": [ + "Storage", + "StorageV2", + "BlobStorage" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": false + } + } + }, + "description": "The parameters that can be provided when updating the storage account properties." + }, + "UsageName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "Gets a string describing the resource name." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "Gets a localized string describing the resource name." + } + }, + "description": "The usage names that can be used; currently limited to StorageAccount." + }, + "Usage": { + "properties": { + "unit": { + "readOnly": true, + "type": "string", + "description": "Gets the unit of measurement.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountsPerSecond", + "BytesPerSecond" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Gets the current count of the allocated resources in the subscription." + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Gets the maximum count of the resources that can be allocated in the subscription." + }, + "name": { + "$ref": "#/definitions/UsageName", + "readOnly": true, + "description": "Gets the name of the type of usage." + } + }, + "description": "Describes Storage Resource Usage." + }, + "UsageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "Gets or sets the list of Storage Resource Usages." + } + }, + "description": "The response from the List Usages operation." + }, + "AccountSasParameters": { + "properties": { + "signedServices": { + "type": "string", + "enum": [ + "b", + "q", + "t", + "f" + ], + "x-ms-enum": { + "name": "Services", + "modelAsString": true + }, + "x-ms-client-name": "Services", + "description": "The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f)." + }, + "signedResourceTypes": { + "type": "string", + "enum": [ + "s", + "c", + "o" + ], + "x-ms-enum": { + "name": "SignedResourceTypes", + "modelAsString": true + }, + "x-ms-client-name": "ResourceTypes", + "description": "The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files." + }, + "signedPermission": { + "type": "string", + "enum": [ + "r", + "d", + "w", + "l", + "a", + "c", + "u", + "p" + ], + "x-ms-enum": { + "name": "Permissions", + "modelAsString": true + }, + "x-ms-client-name": "Permissions", + "description": "The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p)." + }, + "signedIp": { + "type": "string", + "x-ms-client-name": "IPAddressOrRange", + "description": "An IP address or a range of IP addresses from which to accept requests." + }, + "signedProtocol": { + "type": "string", + "enum": [ + "https,http", + "https" + ], + "x-ms-enum": { + "name": "HttpProtocol", + "modelAsString": false + }, + "x-ms-client-name": "Protocols", + "description": "The protocol permitted for a request made with the account SAS." + }, + "signedStart": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "SharedAccessStartTime", + "description": "The time at which the SAS becomes valid." + }, + "signedExpiry": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "SharedAccessExpiryTime", + "description": "The time at which the shared access signature becomes invalid." + }, + "keyToSign": { + "type": "string", + "description": "The key to sign the account SAS token with." + } + }, + "required": [ + "signedServices", + "signedResourceTypes", + "signedPermission", + "signedExpiry" + ], + "description": "The parameters to list SAS credentials of a storage account." + }, + "ListAccountSasResponse": { + "properties": { + "accountSasToken": { + "readOnly": true, + "type": "string", + "description": "List SAS credentials of storage account." + } + }, + "description": "The List SAS credentials operation response." + }, + "ServiceSasParameters": { + "properties": { + "canonicalizedResource": { + "type": "string", + "description": "The canonical path to the signed resource." + }, + "signedResource": { + "type": "string", + "enum": [ + "b", + "c", + "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)." + }, + "signedPermission": { + "type": "string", + "enum": [ + "r", + "d", + "w", + "l", + "a", + "c", + "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)." + }, + "signedIp": { + "type": "string", + "x-ms-client-name": "IPAddressOrRange", + "description": "An IP address or a range of IP addresses from which to accept requests." + }, + "signedProtocol": { + "type": "string", + "enum": [ + "https,http", + "https" + ], + "x-ms-enum": { + "name": "HttpProtocol", + "modelAsString": false + }, + "x-ms-client-name": "Protocols", + "description": "The protocol permitted for a request made with the account SAS." + }, + "signedStart": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "SharedAccessStartTime", + "description": "The time at which the SAS becomes valid." + }, + "signedExpiry": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "SharedAccessExpiryTime", + "description": "The time at which the shared access signature becomes invalid." + }, + "signedIdentifier": { + "type": "string", + "maxLength": 64, + "x-ms-client-name": "Identifier", + "description": "A unique value up to 64 characters in length that correlates to an access policy specified for the container, queue, or table." + }, + "startPk": { + "type": "string", + "x-ms-client-name": "PartitionKeyStart", + "description": "The start of partition key." + }, + "endPk": { + "type": "string", + "x-ms-client-name": "PartitionKeyEnd", + "description": "The end of partition key." + }, + "startRk": { + "type": "string", + "x-ms-client-name": "RowKeyStart", + "description": "The start of row key." + }, + "endRk": { + "type": "string", + "x-ms-client-name": "RowKeyEnd", + "description": "The end of row key." + }, + "keyToSign": { + "type": "string", + "description": "The key to sign the account SAS token with." + }, + "rscc": { + "type": "string", + "x-ms-client-name": "CacheControl", + "description": "The response header override for cache control." + }, + "rscd": { + "type": "string", + "x-ms-client-name": "ContentDisposition", + "description": "The response header override for content disposition." + }, + "rsce": { + "type": "string", + "x-ms-client-name": "ContentEncoding", + "description": "The response header override for content encoding." + }, + "rscl": { + "type": "string", + "x-ms-client-name": "ContentLanguage", + "description": "The response header override for content language." + }, + "rsct": { + "type": "string", + "x-ms-client-name": "ContentType", + "description": "The response header override for content type." + } + }, + "required": [ + "canonicalizedResource", + "signedResource" + ], + "description": "The parameters to list service SAS credentials of a speicific resource." + }, + "ListServiceSasResponse": { + "properties": { + "serviceSasToken": { + "readOnly": true, + "type": "string", + "description": "List service SAS credentials of speicific resource." + } + }, + "description": "The List service SAS credentials operation response." + } + }, + "parameters": { + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "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" + ] + } + ] +} \ No newline at end of file diff --git a/specification/storage/resource-manager/readme.csharp.md b/specification/storage/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..3cdac4549aa3 --- /dev/null +++ b/specification/storage/resource-manager/readme.csharp.md @@ -0,0 +1,35 @@ +# C# Storage + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DNS. + +## Common C# Settings + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true +``` + +``` yaml $(csharp) && !$(multiApi) +payload-flattening-threshold: 2 +namespace: Microsoft.Azure.Management.Storage +output-folder: $(csharp-sdks-folder)/Storage/Management.Storage/Generated +``` + +## Batch settings +These settings are for batch mode only: (ie, add `--MultiApi` to the command line ) + +``` yaml $(multiApi) +namespace: Microsoft.Azure.Management.Storage.$(ApiVersionName) +output-folder: $(csharp-sdks-folder)/$(ApiVersionName)/Generated + +batch: + - tag: package-2016-01 + ApiVersionName: Api2016_01_01 + + - tag: package-2015-06 + ApiVersionName: Api2015_06_05 +``` \ No newline at end of file diff --git a/specification/storage/resource-manager/readme.md b/specification/storage/resource-manager/readme.md index 7b42db1de0c9..37e431c40bb1 100644 --- a/specification/storage/resource-manager/readme.md +++ b/specification/storage/resource-manager/readme.md @@ -26,9 +26,56 @@ These are the global settings for the Storage API. ``` yaml openapi-type: arm -tag: package-2017-10 +tag: package-2018-03 ``` +### Tag: package-2018-03 + +These settings apply only when `--tag=package-2018-03` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03' +input-file: +- Microsoft.Storage/preview/2018-03-01-preview/storage.json +- Microsoft.Storage/preview/2018-03-01-preview/blob.json + +directive: + - suppress: R3018 + reason: Existing boolean properties + approved-by: "@fearthecowboy" + + - where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey"].post.operationId + suppress: R1003 + reason: APIs return array of values, is not actually a 'list' operation + approved-by: "@fearthecowboy" + +``` + +### Tag: package-2018-02 + +These settings apply only when `--tag=package-2018-02` is specified on the command line. + +``` yaml $(tag) == 'package-2018-02' +input-file: +- Microsoft.Storage/stable/2018-02-01/storage.json +- Microsoft.Storage/stable/2018-02-01/blob.json + +directive: + - suppress: R3018 + reason: Existing boolean properties + approved-by: "@fearthecowboy" + + - where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey"].post.operationId + suppress: R1003 + reason: APIs return array of values, is not actually a 'list' operation + approved-by: "@fearthecowboy" + +``` ### Tag: package-2017-10 @@ -39,7 +86,6 @@ input-file: - Microsoft.Storage/stable/2017-10-01/storage.json ``` - ### Tag: package-2017-06 These settings apply only when `--tag=package-2017-06` is specified on the command line. @@ -110,28 +156,14 @@ swagger-to-sdk: - repo: azure-sdk-for-python after_scripts: - python ./scripts/multiapi_init_gen.py azure-mgmt-storage - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_storage'] ``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Storage - payload-flattening-threshold: 2 - output-folder: $(csharp-sdks-folder)/Storage/Management.Storage/Generated - clear-output-folder: true -``` - - ## Go These settings apply only when `--go` is specified on the command line. @@ -147,6 +179,8 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-03 + - tag: package-2018-02 - tag: package-2017-10 - tag: package-2017-06 - tag: package-2016-12 @@ -156,6 +190,24 @@ batch: - tag: package-2015-05-preview ``` +### Tag: package-2018-03 and go + +These settings apply only when `--tag=package-2018-03 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-03' && $(go) +output-folder: $(go-sdk-folder)/services/preview/storage/mgmt/2018-03-01-preview/storage +``` + +### Tag: package-2018-02 and go + +These settings apply only when `--tag=package-2018-02 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-02' && $(go) +output-folder: $(go-sdk-folder)/services/storage/mgmt/2018-02-01/storage +``` + ### Tag: package-2017-10 and go These settings apply only when `--tag=package-2017-10 --go` is specified on the command line. @@ -216,7 +268,7 @@ These settings apply only when `--tag=package-2015-05-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-05-preview' && $(go) -output-folder: $(go-sdk-folder)/services/storage/mgmt/2015-05-01-preview/storage +output-folder: $(go-sdk-folder)/services/preview/storage/mgmt/2015-05-01-preview/storage ``` ## Python @@ -239,6 +291,8 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: + - tag: package-2018-03 + - tag: package-2018-02 - tag: package-2017-10 - tag: package-2017-06 - tag: package-2016-12 @@ -246,6 +300,28 @@ batch: - tag: package-2015-06 ``` +### Tag: package-2018-03 and python + +These settings apply only when `--tag=package-2018-03 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-03' && $(python) +python: + namespace: azure.mgmt.storage.v2018_03_01_preview + output-folder: $(python-sdks-folder)/azure-mgmt-storage/azure/mgmt/storage/v2018_03_01_preview +``` + +### Tag: package-2018-02 and python + +These settings apply only when `--tag=package-2018-02 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-02' && $(python) +python: + namespace: azure.mgmt.storage.v2018_02_01 + output-folder: $(python-sdks-folder)/azure-mgmt-storage/azure/mgmt/storage/v2018_02_01 +``` + ### Tag: package-2017-10 and python These settings apply only when `--tag=package-2017-10 --python` is specified on the command line. @@ -308,12 +384,71 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.storage +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 2 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storage +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-03 + - tag: package-2018-02 + - tag: package-2017-10 + - tag: package-2016-01 +``` +### Tag: package-2018-03 and java + +These settings apply only when `--tag=package-2018-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-03' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.storage - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 2 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storage + namespace: com.microsoft.azure.management.storage.v2018_03_01_preview + output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2018_03_01_preview +regenerate-manager: true +generate-interface: true ``` +### Tag: package-2018-02 and java + +These settings apply only when `--tag=package-2018-02 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-02' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.storage.v2018_02_01 + output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2018_02_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-10 and java + +These settings apply only when `--tag=package-2017-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.storage.v2017_10_01 + output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2017_10_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-01 and java + +These settings apply only when `--tag=package-2016-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.storage.v2016_01_01 + output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2016_01_01 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/storage/resource-manager/readme.nodejs.md b/specification/storage/resource-manager/readme.nodejs.md index 37da9cd59f84..3b660ad49023 100644 --- a/specification/storage/resource-manager/readme.nodejs.md +++ b/specification/storage/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-02' && $(ruby) +namespace: "Azure::Storage::Mgmt::V2018_02_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_storage/lib +``` + +### Tag: package-2017-10 and ruby + +These settings apply only when `--tag=package-2017-10 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-10' && $(ruby) +namespace: "Azure::Storage::Mgmt::V2017_10_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_storage/lib +``` + +### Tag: package-2017-06 and ruby + +These settings apply only when `--tag=package-2017-06 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-06' && $(ruby) +namespace: "Azure::Storage::Mgmt::V2017_06_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_storage/lib +``` + +### Tag: package-2016-12 and ruby + +These settings apply only when `--tag=package-2016-12 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-12' && $(ruby) +namespace: "Azure::Storage::Mgmt::V2016_12_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_storage/lib +``` + +### Tag: package-2016-01 and ruby + +These settings apply only when `--tag=package-2016-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-01' && $(ruby) +namespace: "Azure::Storage::Mgmt::V2016_01_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_storage/lib +``` + +### Tag: package-2015-06 and ruby + +These settings apply only when `--tag=package-2015-06 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-06' && $(ruby) +namespace: "Azure::Storage::Mgmt::V2015_06_15" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_storage/lib +``` + +### Tag: package-2015-05-preview and ruby + +These settings apply only when `--tag=package-2015-05-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-05-preview' && $(ruby) +namespace: "Azure::Storage::Mgmt::V2015_05_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_storage/lib +``` diff --git a/specification/storageimportexport/resource-manager/readme.md b/specification/storageimportexport/resource-manager/readme.md index 9ba6c137875a..945dcacc96c4 100644 --- a/specification/storageimportexport/resource-manager/readme.md +++ b/specification/storageimportexport/resource-manager/readme.md @@ -88,11 +88,32 @@ 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 - fluent: true - namespace: com.microsoft.azure.management.storageimportexport - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storageimportexport +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.storageimportexport +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storageimportexport ``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-11 +``` + +### Tag: package-2016-11 and java + +These settings apply only when `--tag=package-2016-11 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-11' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.storageimportexport.v2016_11_01 + output-folder: $(azure-libraries-for-java-folder)/storageimportexport/resource-manager/v2016_11_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Create.json new file mode 100644 index 000000000000..aa40e989b56d --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Create.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview", + "parameters": { + "properties": { + "provisioningState": "Created", + "storageAccountKey": "storageaccountkeyvalue", + "storageAccount": "https://storageaccounturl/SampleCloudEndpoint", + "storageAccountResourceId": "", + "storageAccountShareName": "", + "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"" + }, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + } + + }, + "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", + "storageAccount": "https://storageaccounturl/ankushbsubscriptionmgmtmab", + "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", + "friendlyName": "ankushbsubscriptionmgmtmab", + "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/6fe524cf-5944-4e87-816f-e4a85a1f3533", + "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8RjhDODcwQTItMkFGNi00NDUyLTgzMDgtRjJCQTZEQjI3RkEwfEdFTkVSSUN8NTJCOERBMkYtNjFFMC00QTFGLThEREUtMzM2OTExRjM2N0ZC" + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/cloudEndpoints/SampleCloudEndpoint_1", + "type": "10.91.86.47/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=2017-06-05-preview", + "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=2017-06-05-preview", + "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/2017-06-05-preview/examples/CloudEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Delete.json new file mode 100644 index 000000000000..928e1f985f9d --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Delete.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "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=2017-06-05-preview", + "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=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": { + + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Get.json new file mode 100644 index 000000000000..ed74fda28ebb --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "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", + "storageAccountKey": "storageaccountkeyvalue", + "storageAccount": "https://storageaccounturl/SampleAzureFileShareName_1", + "storageAccountResourceId": "", + "storageAccountShareName": "", + "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" + }, + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_ListBySyncGroup.json new file mode 100644 index 000000000000..2b400ac7211a --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_ListBySyncGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview" + }, + "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", + "storageAccountKey": "storageaccountKeyvalue", + "storageAccount": "https://storageaccounturl/SampleAzureFileShareName_1", + "storageAccountResourceId": "", + "storageAccountShareName": "", + "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" + }, + "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" + }] + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PostBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PostBackup.json new file mode 100644 index 000000000000..46d1a3d72411 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/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": "2017-06-05-preview" + }, + "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/10.91.86.47/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=2017-06-05-preview&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/2017-06-05-preview/examples/CloudEndpoints_PostRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PostRestore.json new file mode 100644 index 000000000000..3c0a8a0b2785 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PostRestore.json @@ -0,0 +1,48 @@ +{ + "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": "2017-06-05-preview" + }, + "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=2017-06-05-preview&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/2017-06-05-preview/examples/CloudEndpoints_PreBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PreBackup.json new file mode 100644 index 000000000000..f5b51ce9efc9 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/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": "2017-06-05-preview", + "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=2017-06-05-preview&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/2017-06-05-preview/examples/CloudEndpoints_PreRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PreRestore.json new file mode 100644 index 000000000000..dcaceabc240b --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PreRestore.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview", + "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=2017-06-05-preview&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/2017-06-05-preview/examples/CloudEndpoints_RestoreHeatbeat.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_RestoreHeatbeat.json new file mode 100644 index 000000000000..a0667d8f9a4b --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_RestoreHeatbeat.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Operations_List.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Operations_List.json new file mode 100644 index 000000000000..66da10fc7522 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Operations_List.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "api-version": "2017-06-05-preview" + }, + "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": "" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Create.json new file mode 100644 index 000000000000..ad6a75deedb6 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Create.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "\"080d4133-bdb5-40a0-96a0-71a6057bfe9a\"", + "parameters": { + "name": "SampleServer-prod3.redmond.corp.microsoft.com", + "properties": { + "serverRole": "Standalone", + "provisioningState": "Created", + "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\"", + "serverManagementtErrorCode": 0, + "serverOSVersion": "10.0.14393.0", + "agentVersion": "1.0.277.0" + }, + "type": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "api-version": "2017-06-05-preview" + }, + "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/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", + "type": "10.91.86.47/storageSyncServices/registeredServers", + "name": "ankushb-prod3.redmond.corp.microsoft.com", + "properties": { + "serverId": "\"530a0384-50ac-456d-8240-9d6621404151\"", + "serverRole": "Standalone", + "provisioningState": "Succeeded", + "clusterId": "\"00000000-0000-0000-0000-000000000000\"", + "lastHeartBeat": "\"2017-08-21T13:24:18.2641509-07:00\"", + "serverManagementtErrorCode": 0, + "serverOSVersion": "10.0.14393.0", + "agentVersion": "1.0.278.0", + "storageSyncServiceUid": "\"56cfb290-f846-4c96-abc4-ee338bd252e8\"", + "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/c36c3bcb-a72e-492a-b700-4ad74a8e3d69" + } + } + }, + "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=2017-06-05-preview", + "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=2017-06-05-preview", + "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/2017-06-05-preview/examples/RegisteredServers_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Delete.json new file mode 100644 index 000000000000..dcc4d32ee75d --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Delete.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "41166691-ab03-43e9-ab3e-0330eda162ac", + "api-version": "2017-06-05-preview" + }, + "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=2017-06-05-preview", + "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=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": { + + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Get.json new file mode 100644 index 000000000000..ab6410ba74e3 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "api-version": "2017-06-05-preview" + }, + "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": { + "serverId": "\"080d4133-bdb5-40a0-96a0-71a6057bfe9a\"", + "serverRole": "Standalone", + "provisioningState": "Created", + "clusterId": "\"00000000-0000-0000-0000-000000000000\"", + "clusterName": "", + "lastHeartBeat": "\"2017-08-08T18:29:06.470652+00:00\"", + "serverManagementtErrorCode": 0, + "serverOSVersion": "10.0.14393.0", + "agentVersion": "1.0.277.0", + "storageSyncServiceUid": "\"3d1bf292-0f2a-4cc1-a3e1-60f35800e40c\"", + "lastWorkflowId": "" + }, + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_ListByStorageSyncService.json new file mode 100644 index 000000000000..f3d52bde1aed --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_ListByStorageSyncService.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2017-06-05-preview" + }, + "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": { + "serverId": "\"080d4133-bdb5-40a0-96a0-71a6057bfe9a\"", + "serverRole": "Standalone", + "provisioningState": "Created", + "clusterId": "\"00000000-0000-0000-0000-000000000000\"", + "clusterName": "", + "lastHeartBeat": "\"2017-08-08T18:29:06.470652+00:00\"", + "serverManagementtErrorCode": 0, + "serverOSVersion": "10.0.14393.0", + "agentVersion": "1.0.277.0", + "storageSyncServiceUid": "\"3d1bf292-0f2a-4cc1-a3e1-60f35800e40c\"", + "lastWorkflowId": "" + }, + "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" + }] + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Create.json new file mode 100644 index 000000000000..75cd89e9b722 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Create.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "serverEndpointName": "SampleServerEndpoint_1", + "parameters": { + "properties": { + "provisioningState": "Created", + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncServer_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "cloudTiering": "off", + "volumeFreeSpacePercent": 100 + }, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + }, + "api-version": "2017-06-05-preview" + }, + "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": { + "provisioningState": "Succeeded", + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "friendlyName": "ankushb-prod3.redmond.corp.microsoft.com", + "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/901054e8-d66f-4e2f-8266-f05a68dbfce4" + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", + "type": "10.91.86.47/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=2017-06-05-preview", + "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=2017-06-05-preview", + "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/2017-06-05-preview/examples/ServerEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Delete.json new file mode 100644 index 000000000000..7c9a14e729c0 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/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": "2017-06-05-preview" + }, + "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=2017-06-05-preview", + "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=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Get.json new file mode 100644 index 000000000000..d4afef4a2dfc --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "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": { + "provisioningState": "Succeeded", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "friendlyName": "SampleRegisteredServer-prod3.redmond.corp.microsoft.com", + "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/219c62f3-8507-4b87-a85b-ac676ad198d1", + "lastSyncSuccess": "2017-02-24T22:24:43.3216408Z", + "syncErrorState": "0", + "syncErrorStateTimestamp": "2017-02-24T22:24:43.3216408Z", + "syncErrorDirection": "none", + "syncErrorContext": "", + "itemDownloadErrorCount": 0, + "itemUploadErrorCount": 0, + "currentProgressType": "none", + "itemProgressCount": 0, + "itemTotalCount": 0, + "byteProgress": 0 + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/serverEndpoints/SampleServerEndpoint_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_ListBySyncGroup.json new file mode 100644 index 000000000000..174d19a1516f --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_ListBySyncGroup.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview" + }, + "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": { + "provisioningState": "Succeeded", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "friendlyName": "ankushb-prod3.redmond.corp.microsoft.com", + "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/219c62f3-8507-4b87-a85b-ac676ad198d1", + "lastSyncSuccess": "2017-02-24T22:24:43.3216408Z", + "syncErrorState": "0", + "syncErrorStateTimestamp": "2017-02-24T22:24:43.3216408Z", + "syncErrorDirection": "none", + "syncErrorContext": "", + "itemDownloadErrorCount": 0, + "itemUploadErrorCount": 0, + "currentProgressType": "none", + "itemProgressCount": 0, + "itemTotalCount": 0, + "byteProgress": 23, + "totalProgress": 23 + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/serverEndpoints/SampleServerEndpoint_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + }, { + "name": "SampleServerEndpoint_2", + "properties": { + "provisioningState": "Succeeded", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "serverLocalPath": "D:\\SampleServerEndpoint_2", + "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "friendlyName": "ankushb-prod3.redmond.corp.microsoft.com", + "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75", + "lastSyncSuccess": "2017-02-24T22:24:43.3216408Z", + "syncErrorState": "0", + "syncErrorStateTimestamp": "2017-02-24T22:24:43.3216408Z", + "syncErrorDirection": "none", + "syncErrorContext": "", + "itemDownloadErrorCount": 0, + "itemUploadErrorCount": 0, + "currentProgressType": "none", + "itemProgressCount": 0, + "itemTotalCount": 0, + "byteProgress": 0, + "totalProgress": 0 + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/serverEndpoints/SampleServerEndpoint_2", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + }] + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Recall.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Recall.json new file mode 100644 index 000000000000..1a114012c6de --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Recall.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": "2017-06-05-preview" + }, + "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=2017-06-05-preview", + "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=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Update.json new file mode 100644 index 000000000000..21baf9772497 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Update.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "parameters" : { + "properties": { + "provisioningState": "Created", + "cloudTiering": "off", + "volumeFreeSpacePercent": 100 + }, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + }, + "api-version": "2017-06-05-preview" + }, + "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": { + "provisioningState": "Succeeded", + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "friendlyName": "ankushb-prod3.redmond.corp.microsoft.com", + "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/901054e8-d66f-4e2f-8266-f05a68dbfce4" + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", + "type": "10.91.86.47/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=2017-06-05-preview", + "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=2017-06-05-preview", + "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/2017-06-05-preview/examples/StorageSyncServices_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Create.json new file mode 100644 index 000000000000..31429cb7d7ce --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Create.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "parameters": { + "location": "WestUS", + "tags": {}, + "properties": {}, + "type": "Microsoft.StorageSync/storageSyncServices" + }, + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "body": { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": {}, + "properties": {}, + "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/2017-06-05-preview/examples/StorageSyncServices_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Delete.json new file mode 100644 index 000000000000..26001b6c507a --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + }, + "204": { + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Get.json new file mode 100644 index 000000000000..aa243d6bfe67 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview" + }, + "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, + "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_ListByResourceGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_ListByResourceGroup.json new file mode 100644 index 000000000000..de718cafeec6 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_ListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "api-version": "2017-06-05-preview" + }, + "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, + "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, + "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, + "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" + }] +} + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_ListBySubscription.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_ListBySubscription.json new file mode 100644 index 000000000000..1fde371e12ec --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_ListBySubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "api-version": "2017-06-05-preview" + }, + "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, + "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, + "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, + "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" + }] +} + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Update.json new file mode 100644 index 000000000000..a930e70b6d43 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2017-06-05-preview", + "parameters": { + "location": "WestUS", + "tags": { + "Environment": "Test", + "Dept": "IT" + }, + "properties": {}, + "type": "Microsoft.StorageSync/storageSyncServices" + } + }, + "responses": { + "200": { + "body": { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": { + "Environment": "Test", + "Dept": "IT" + }, + "properties": {}, + "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/2017-06-05-preview/examples/SyncGroups_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Create.json new file mode 100644 index 000000000000..ccad6278ba86 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Create.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview", + "parameters": { + "properties": {}, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" + } + + }, + "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/2017-06-05-preview/examples/SyncGroups_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Delete.json new file mode 100644 index 000000000000..f4db86a29658 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": { + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Get.json new file mode 100644 index 000000000000..3acf7719e43d --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/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": "2017-06-05-preview" + }, + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_ListByStorageSyncService.json new file mode 100644 index 000000000000..c578ba8d0991 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_ListByStorageSyncService.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2017-06-05-preview" + }, + "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" + }] +} + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Workflows_Abort.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Workflows_Abort.json new file mode 100644 index 000000000000..7c93deca14c9 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/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": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Workflows_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Workflows_Get.json new file mode 100644 index 000000000000..2cc2213d9548 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/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": "2017-06-05-preview" + }, + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json new file mode 100644 index 000000000000..08433c1f1f36 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json @@ -0,0 +1,3238 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Storage Sync", + "description": "Microsoft Storage Sync Service API", + "version": "2017-06-05-preview", + "x-ms-code-generation-settings": { + "name": "StorageSyncManagementClient" + } + }, + "host": "azure.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.StorageSync/operations": { + "get": { + "tags": [ + "ResourceProvider", + "Operations" + ], + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/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}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}": { + "put": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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/StorageSyncService" + } + } + ], + "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" + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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/StorageSyncService" + } + } + ], + "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" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "delete": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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" + } + } + }, + "204": { + "description": "Storage Sync Service 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": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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}/syncGroups": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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/SyncGroup" + } + } + ], + "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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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/CloudEndpoint" + } + } + ], + "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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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_RestoreHeatbeat", + "description": "Restore Heartbeat a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_RestoreHeatbeat": { + "$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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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/ServerEndpoint" + } + } + ], + "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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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/ServerEndpoint" + } + } + ], + "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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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", + "Actions" + ], + "operationId": "ServerEndpoints_Recall", + "description": "Recall a serverendpoint.", + "x-ms-examples": { + "ServerEndpoints_Recall": { + "$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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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/RegisteredServer" + } + } + ], + "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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "Asynchronuous 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}/workflows/{workflowId}": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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" + } + } + } + } + } + }, + "definitions": { + "StorageSyncError": { + "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." + }, + "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." + } + } + }, + "Resource": { + "description": "The Azure Resource Manager resource.", + "properties": { + "id": { + "description": "The id of the resource.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the resource.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The type of the resource", + "readOnly": true, + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "ARM tracked resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "The location of the resource.", + "type": "string" + }, + "tags": { + "description": "The tags of the resource.", + "type": "object" + } + } + }, + "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": "#/definitions/TrackedResource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageSyncServiceProperties", + "description": "Storage Sync Service properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "SyncGroup": { + "type": "object", + "description": "Sync Group object.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SyncGroupProperties", + "description": "SyncGroup properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "CloudEndpoint": { + "type": "object", + "description": "Cloud Endpoint object.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CloudEndpointProperties", + "description": "Cloud Endpoint properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "ServerEndpoint": { + "type": "object", + "description": "Server Endpoint object.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServerEndpointProperties", + "description": "Server Endpoint properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "RegisteredServer": { + "type": "object", + "description": "Registered Server 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" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RegisteredServerProperties", + "description": "RegisteredServer properties." + } + }, + "x-ms-azure-resource": true + }, + "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": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowProperties", + "description": "Workflow properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "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." + } + } + }, + "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", + "readOnly": true + } + } + }, + "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 + } + } + }, + "StorageSyncServiceProperties": { + "type": "object", + "description": "Storage Sync Service Properties object.", + "properties": { + "storageSyncServiceStatus": { + "type": "integer", + "description": "Storage Sync service status.", + "readOnly": true + }, + "storageSyncServiceUid": { + "type": "string", + "description": "Storage Sync service Uid", + "readOnly": true + } + } + }, + "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" + }, + "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" + }, + "serverManagementtErrorCode": { + "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" + } + } + }, + "CloudEndpointProperties": { + "type": "object", + "description": "CloudEndpoint Properties object.", + "properties": { + "storageAccountKey": { + "type": "string", + "description": "Storage Account access key." + }, + "storageAccount": { + "type": "string", + "description": "Storage Account name." + }, + "storageAccountResourceId": { + "type": "string", + "description": "Storage Account Resource Id" + }, + "storageAccountShareName": { + "type": "string", + "description": "Storage Account Share name" + }, + "storageAccountTenantId": { + "type": "string", + "description": "Storage Account Tenant Id" + }, + "partnershipId": { + "type": "string", + "description": "Partnership Id" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "backupEnabled": { + "type": "boolean", + "description": "Backup Enabled", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "description": "CloudEndpoint Provisioning State" + }, + "lastWorkflowId": { + "type": "string", + "description": "CloudEndpoint lastWorkflowId" + } + } + }, + "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." + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "lastSyncSuccess": { + "type": "string", + "format": "date-time", + "description": "Last Sync Success" + }, + "syncErrorState": { + "type": "string", + "description": "Sync Error State" + }, + "syncErrorStateTimestamp": { + "type": "string", + "format": "date-time", + "description": "Sync Error State Timestamp" + }, + "syncErrorDirection": { + "$ref": "#/definitions/ProgressType", + "description": "Sync Error Direction." + }, + "itemUploadErrorCount": { + "type": "integer", + "description": "Item Upload Error Count." + }, + "itemDownloadErrorCount": { + "type": "integer", + "description": "Item download error count." + }, + "syncErrorContext": { + "type": "string", + "description": "sync error context." + }, + "currentProgressType": { + "$ref": "#/definitions/ProgressType", + "description": "current progress type." + }, + "itemProgressCount": { + "type": "integer", + "description": "Item Progress Count" + }, + "itemTotalCount": { + "type": "integer", + "description": "Item Total Count" + }, + "byteProgress": { + "type": "integer", + "description": "Bytes in progress" + }, + "totalProgress": { + "type": "integer", + "description": "Total progress" + }, + "byteTotal": { + "type": "integer", + "description": "Bytes total" + }, + "serverResourceId": { + "$ref": "#/definitions/ResourceId", + "description": "Server Resource Id." + }, + "provisioningState": { + "type": "string", + "description": "ServerEndpoint Provisioning State" + }, + "lastWorkflowId": { + "type": "string", + "description": "ServerEndpoint lastWorkflowId" + } + } + }, + "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" + ] + }, + "WorkflowStatus": { + "type": "string", + "description": "Type of the Workflow Status", + "enum": [ + "active", + "expired", + "succeeded", + "aborted", + "failed" + ] + }, + "OperationDirection": { + "type": "string", + "description": "Type of the Operation Direction", + "enum": [ + "do", + "undo", + "cancel" + ] + }, + "ProgressType": { + "type": "string", + "description": "Type of the ProgressType", + "enum": [ + "none", + "initialize", + "download", + "upload", + "recall" + ] + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "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" + ] + } + ] +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_Create.json new file mode 100644 index 000000000000..bae7674de131 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_Create.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview", + "parameters": { + "properties": { + "provisioningState": "Created", + "storageAccountKey": "storageaccountkeyvalue", + "storageAccount": "https://storageaccounturl/SampleCloudEndpoint", + "storageAccountResourceId": "", + "storageAccountShareName": "", + "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"" + }, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + } + + }, + "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", + "storageAccount": "https://storageaccounturl/ankushbsubscriptionmgmtmab", + "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", + "friendlyName": "ankushbsubscriptionmgmtmab", + "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/6fe524cf-5944-4e87-816f-e4a85a1f3533", + "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8RjhDODcwQTItMkFGNi00NDUyLTgzMDgtRjJCQTZEQjI3RkEwfEdFTkVSSUN8NTJCOERBMkYtNjFFMC00QTFGLThEREUtMzM2OTExRjM2N0ZC", + "lastOperationName": "ICreateCloudEndpointWorkflow" + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/cloudEndpoints/SampleCloudEndpoint_1", + "type": "10.91.86.47/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=2017-06-05-preview", + "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=2017-06-05-preview", + "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/2018-04-02/examples/CloudEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_Delete.json new file mode 100644 index 000000000000..b5ccf6fdd067 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_Delete.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "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=2017-06-05-preview", + "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=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": { + + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_Get.json new file mode 100644 index 000000000000..5f12c6e456f8 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "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", + "storageAccountKey": "storageaccountkeyvalue", + "storageAccount": "https://storageaccounturl/SampleAzureFileShareName_1", + "storageAccountResourceId": "", + "storageAccountShareName": "", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_ListBySyncGroup.json new file mode 100644 index 000000000000..5f270c5fe8ba --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/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": "2017-06-05-preview" + }, + "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", + "storageAccountKey": "storageaccountKeyvalue", + "storageAccount": "https://storageaccounturl/SampleAzureFileShareName_1", + "storageAccountResourceId": "", + "storageAccountShareName": "", + "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" + }] + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_PostBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_PostBackup.json new file mode 100644 index 000000000000..46d1a3d72411 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/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": "2017-06-05-preview" + }, + "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/10.91.86.47/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=2017-06-05-preview&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/2018-04-02/examples/CloudEndpoints_PostRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_PostRestore.json new file mode 100644 index 000000000000..3c0a8a0b2785 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_PostRestore.json @@ -0,0 +1,48 @@ +{ + "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": "2017-06-05-preview" + }, + "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=2017-06-05-preview&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/2018-04-02/examples/CloudEndpoints_PreBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_PreBackup.json new file mode 100644 index 000000000000..f5b51ce9efc9 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/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": "2017-06-05-preview", + "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=2017-06-05-preview&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/2018-04-02/examples/CloudEndpoints_PreRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_PreRestore.json new file mode 100644 index 000000000000..dcaceabc240b --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_PreRestore.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview", + "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=2017-06-05-preview&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/2018-04-02/examples/CloudEndpoints_RestoreHeatbeat.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_RestoreHeatbeat.json new file mode 100644 index 000000000000..a0667d8f9a4b --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/CloudEndpoints_RestoreHeatbeat.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/Operations_List.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/Operations_List.json new file mode 100644 index 000000000000..66da10fc7522 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/Operations_List.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "api-version": "2017-06-05-preview" + }, + "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": "" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/RegisteredServers_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/RegisteredServers_Create.json new file mode 100644 index 000000000000..9e35174b0c7b --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/RegisteredServers_Create.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "\"080d4133-bdb5-40a0-96a0-71a6057bfe9a\"", + "parameters": { + "name": "SampleServer-prod3.redmond.corp.microsoft.com", + "properties": { + "serverRole": "Standalone", + "provisioningState": "Created", + "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\"", + "serverManagementtErrorCode": 0, + "serverOSVersion": "10.0.14393.0", + "agentVersion": "1.0.277.0" + }, + "type": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "api-version": "2017-06-05-preview" + }, + "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/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", + "type": "10.91.86.47/storageSyncServices/registeredServers", + "name": "ankushb-prod3.redmond.corp.microsoft.com", + "properties": { + "agentVersion": "3.1.5.0", + "serverOSVersion": "10.0.14393.0", + "serverManagementtErrorCode": 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/\"", + "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=2017-06-05-preview", + "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=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/RegisteredServers_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/RegisteredServers_Delete.json new file mode 100644 index 000000000000..77ed370cdf85 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/RegisteredServers_Delete.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "41166691-ab03-43e9-ab3e-0330eda162ac", + "api-version": "2017-06-05-preview" + }, + "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=2017-06-05-preview", + "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=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": { + + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/RegisteredServers_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/RegisteredServers_Get.json new file mode 100644 index 000000000000..6d16f4045b69 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/RegisteredServers_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "api-version": "2017-06-05-preview" + }, + "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", + "serverManagementtErrorCode": 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/\"", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/RegisteredServers_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/RegisteredServers_ListByStorageSyncService.json new file mode 100644 index 000000000000..32429b833db7 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/RegisteredServers_ListByStorageSyncService.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2017-06-05-preview" + }, + "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", + "serverManagementtErrorCode": 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/\"", + "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" + }] + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_Create.json new file mode 100644 index 000000000000..2000fe8ab522 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_Create.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "serverEndpointName": "SampleServerEndpoint_1", + "parameters": { + "properties": { + "provisioningState": "Created", + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncServer_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "cloudTiering": "off", + "volumeFreeSpacePercent": 100 + }, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + }, + "api-version": "2017-06-05-preview" + }, + "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_quota", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "friendlyName": "somemachine.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-d987f727f11a", + "lastOperationName": "ICreateServerEndpointWorkflow", + "syncStatus": { + "downloadHealth": "Healthy", + "uploadHealth": "Error", + "combinedHealth": "Error", + "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "uploadStatus": { + "lastSyncResult": -2134351810, + "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z", + "lastSyncSuccessTimestamp": null, + "lastSyncPerItemErrorCount": 69 + }, + "downloadStatus": { + "lastSyncResult": 0, + "lastSyncTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncPerItemErrorCount": 0 + }, + "currentProgress": null + } + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", + "type": "10.91.86.47/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=2017-06-05-preview", + "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=2017-06-05-preview", + "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/2018-04-02/examples/ServerEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_Delete.json new file mode 100644 index 000000000000..a56776d040c6 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/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": "2017-06-05-preview" + }, + "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=2017-06-05-preview", + "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=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_Get.json new file mode 100644 index 000000000000..86966256824a --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_Get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "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_quota", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "friendlyName": "somemachine.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-d987f727f11a", + "lastOperationName": "ICreateServerEndpointWorkflow", + "syncStatus": { + "downloadHealth": "Healthy", + "uploadHealth": "Error", + "combinedHealth": "Error", + "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "uploadStatus": { + "lastSyncResult": -2134351810, + "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z", + "lastSyncSuccessTimestamp": null, + "lastSyncPerItemErrorCount": 69 + }, + "downloadStatus": { + "lastSyncResult": 0, + "lastSyncTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncPerItemErrorCount": 0 + }, + "currentProgress": null + } + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/serverEndpoints/SampleServerEndpoint_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_ListBySyncGroup.json new file mode 100644 index 000000000000..670ddc9a5974 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_ListBySyncGroup.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview" + }, + "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": "C:\\data_quota", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "friendlyName": "somemachine.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-d987f727f11a", + "lastOperationName": "ICreateServerEndpointWorkflow", + "syncStatus": { + "downloadHealth": "Healthy", + "uploadHealth": "Error", + "combinedHealth": "Error", + "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "uploadStatus": { + "lastSyncResult": -2134351810, + "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z", + "lastSyncSuccessTimestamp": null, + "lastSyncPerItemErrorCount": 69 + }, + "downloadStatus": { + "lastSyncResult": 0, + "lastSyncTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncPerItemErrorCount": 0 + }, + "currentProgress": null + } + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/serverEndpoints/SampleServerEndpoint_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + }, { + "name": "SampleServerEndpoint_2", + "properties": { + "serverLocalPath": "C:\\data_quota2", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "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", + "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "uploadStatus": { + "lastSyncResult": -2134351810, + "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z", + "lastSyncSuccessTimestamp": null, + "lastSyncPerItemErrorCount": 69 + }, + "downloadStatus": { + "lastSyncResult": 0, + "lastSyncTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncPerItemErrorCount": 0 + }, + "currentProgress": null + } + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/serverEndpoints/SampleServerEndpoint_2", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + }] + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_Recall.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_Recall.json new file mode 100644 index 000000000000..1a114012c6de --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_Recall.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": "2017-06-05-preview" + }, + "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=2017-06-05-preview", + "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=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_Update.json new file mode 100644 index 000000000000..f047342d2a61 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/ServerEndpoints_Update.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "parameters" : { + "properties": { + "provisioningState": "Created", + "cloudTiering": "off", + "volumeFreeSpacePercent": 100 + }, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + }, + "api-version": "2017-06-05-preview" + }, + "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, + "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", + "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "uploadStatus": { + "lastSyncResult": -2134351810, + "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z", + "lastSyncSuccessTimestamp": null, + "lastSyncPerItemErrorCount": 69 + }, + "downloadStatus": { + "lastSyncResult": 0, + "lastSyncTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncPerItemErrorCount": 0 + }, + "currentProgress": null + } + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", + "type": "10.91.86.47/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=2017-06-05-preview", + "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=2017-06-05-preview", + "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/2018-04-02/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json new file mode 100644 index 000000000000..930849f6c999 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-04-02", + "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." + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServiceCheckNameAvailability_Available.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServiceCheckNameAvailability_Available.json new file mode 100644 index 000000000000..42955183aee9 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServiceCheckNameAvailability_Available.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2018-04-02", + "subscriptionId": "5c6bc8e1-1eaf-4192-94d8-58ce463ac86c", + "locationName": "westus", + "parameters": { + "name": "newstoragesyncservicename", + "type": "Microsoft.StorageSync/storageSyncServices" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_Create.json new file mode 100644 index 000000000000..7fb1b01e89ff --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_Create.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "parameters": { + "location": "WestUS", + "tags": {}, + "properties": {}, + "type": "Microsoft.StorageSync/storageSyncServices" + }, + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "body": { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": {}, + "properties": {}, + "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/2018-04-02/examples/StorageSyncServices_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_Delete.json new file mode 100644 index 000000000000..445b5af000e0 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + }, + "204": { + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_Get.json new file mode 100644 index 000000000000..d0e22bc81ebe --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview" + }, + "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, + "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_ListByResourceGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_ListByResourceGroup.json new file mode 100644 index 000000000000..de718cafeec6 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_ListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "api-version": "2017-06-05-preview" + }, + "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, + "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, + "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, + "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" + }] +} + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_ListBySubscription.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_ListBySubscription.json new file mode 100644 index 000000000000..1fde371e12ec --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_ListBySubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "api-version": "2017-06-05-preview" + }, + "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, + "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, + "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, + "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" + }] +} + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_Update.json new file mode 100644 index 000000000000..b0a22de445fe --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/StorageSyncServices_Update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2017-06-05-preview", + "parameters": { + "location": "WestUS", + "tags": { + "Environment": "Test", + "Dept": "IT" + }, + "properties": {}, + "type": "Microsoft.StorageSync/storageSyncServices" + } + }, + "responses": { + "200": { + "body": { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": { + "Environment": "Test", + "Dept": "IT" + }, + "properties": {}, + "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/2018-04-02/examples/SyncGroups_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/SyncGroups_Create.json new file mode 100644 index 000000000000..b5272fd3a976 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/SyncGroups_Create.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview", + "parameters": { + "properties": {}, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" + } + + }, + "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/2018-04-02/examples/SyncGroups_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/SyncGroups_Delete.json new file mode 100644 index 000000000000..c6979666be76 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/SyncGroups_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": { + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/SyncGroups_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/SyncGroups_Get.json new file mode 100644 index 000000000000..dc72917fb604 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/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": "2017-06-05-preview" + }, + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/SyncGroups_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/SyncGroups_ListByStorageSyncService.json new file mode 100644 index 000000000000..c578ba8d0991 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/SyncGroups_ListByStorageSyncService.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2017-06-05-preview" + }, + "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" + }] +} + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/Workflows_Abort.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/Workflows_Abort.json new file mode 100644 index 000000000000..7c93deca14c9 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/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": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/Workflows_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/examples/Workflows_Get.json new file mode 100644 index 000000000000..939c2b0200a7 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/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": "2017-06-05-preview" + }, + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/storagesync.json new file mode 100644 index 000000000000..d41f544904bc --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/storagesync.json @@ -0,0 +1,3315 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Storage Sync", + "description": "Microsoft Storage Sync Service API", + "version": "2018-04-02", + "x-ms-code-generation-settings": { + "name": "StorageSyncManagementClient" + } + }, + "host": "azure.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.StorageSync/operations": { + "get": { + "tags": [ + "ResourceProvider", + "Operations" + ], + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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/StorageSyncService" + } + } + ], + "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" + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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/StorageSyncService" + } + } + ], + "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" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "delete": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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" + } + } + }, + "204": { + "description": "Storage Sync Service 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": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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}/syncGroups": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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/SyncGroup" + } + } + ], + "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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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/CloudEndpoint" + } + } + ], + "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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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/ServerEndpoint" + } + } + ], + "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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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/ServerEndpoint" + } + } + ], + "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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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", + "Actions" + ], + "operationId": "ServerEndpoints_recallAction", + "description": "Recall a serverendpoint.", + "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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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/RegisteredServer" + } + } + ], + "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": "Asynchronuous 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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "Asynchronuous 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}/workflows/{workflowId}": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/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" + } + } + } + } + } + }, + "definitions": { + "StorageSyncError": { + "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." + }, + "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." + } + } + }, + "Resource": { + "description": "The Azure Resource Manager resource.", + "properties": { + "id": { + "description": "The id of the resource.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the resource.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The type of the resource", + "readOnly": true, + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "ARM tracked resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "The location of the resource.", + "type": "string" + }, + "tags": { + "description": "The tags of the resource.", + "type": "object" + } + } + }, + "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": "#/definitions/TrackedResource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageSyncServiceProperties", + "description": "Storage Sync Service properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "SyncGroup": { + "type": "object", + "description": "Sync Group object.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SyncGroupProperties", + "description": "SyncGroup properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "CloudEndpoint": { + "type": "object", + "description": "Cloud Endpoint object.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CloudEndpointProperties", + "description": "Cloud Endpoint properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "ServerEndpoint": { + "type": "object", + "description": "Server Endpoint object.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServerEndpointProperties", + "description": "Server Endpoint properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "RegisteredServer": { + "type": "object", + "description": "Registered Server 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" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RegisteredServerProperties", + "description": "RegisteredServer properties." + } + }, + "x-ms-azure-resource": true + }, + "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": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowProperties", + "description": "Workflow properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "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", + "readOnly": true + } + } + }, + "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 + } + } + }, + "StorageSyncServiceProperties": { + "type": "object", + "description": "Storage Sync Service Properties object.", + "properties": { + "storageSyncServiceStatus": { + "type": "integer", + "description": "Storage Sync service status.", + "readOnly": true + }, + "storageSyncServiceUid": { + "type": "string", + "description": "Storage Sync service Uid", + "readOnly": true + } + } + }, + "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" + }, + "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" + }, + "serverManagementtErrorCode": { + "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" + } + } + }, + "CloudEndpointProperties": { + "type": "object", + "description": "CloudEndpoint Properties object.", + "properties": { + "storageAccountKey": { + "type": "string", + "description": "Storage Account access key." + }, + "storageAccount": { + "type": "string", + "description": "Storage Account name." + }, + "storageAccountResourceId": { + "type": "string", + "description": "Storage Account Resource Id" + }, + "storageAccountShareName": { + "type": "string", + "description": "Storage Account Share name" + }, + "storageAccountTenantId": { + "type": "string", + "description": "Storage Account Tenant Id" + }, + "partnershipId": { + "type": "string", + "description": "Partnership Id" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "backupEnabled": { + "type": "boolean", + "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" + } + } + }, + "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." + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "serverResourceId": { + "$ref": "#/definitions/ResourceId", + "description": "Server Resource Id." + }, + "provisioningState": { + "type": "string", + "description": "ServerEndpoint Provisioning State" + }, + "lastWorkflowId": { + "type": "string", + "description": "ServerEndpoint lastWorkflowId" + }, + "lastOperationName": { + "type": "string", + "description": "Resource Last Operation Name" + }, + "syncStatus": { + "type": "object", + "description": "Sync Health Status" + } + } + }, + "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" + ] + }, + "WorkflowStatus": { + "type": "string", + "description": "Type of the Workflow Status", + "enum": [ + "active", + "expired", + "succeeded", + "aborted", + "failed" + ] + }, + "OperationDirection": { + "type": "string", + "description": "Type of the Operation Direction", + "enum": [ + "do", + "undo", + "cancel" + ] + }, + "ProgressType": { + "type": "string", + "description": "Type of the ProgressType", + "enum": [ + "none", + "initialize", + "download", + "upload", + "recall" + ] + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "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" + ] + } + ] +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/readme.md b/specification/storagesync/resource-manager/readme.md new file mode 100644 index 000000000000..6d2c2c441631 --- /dev/null +++ b/specification/storagesync/resource-manager/readme.md @@ -0,0 +1,125 @@ +# StorageSync + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for StorageSync. + + + +--- +## Getting Started +To build the SDK for Storage, 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 Sync API. + +``` yaml +openapi-type: arm +tag: package-2018-04-02 +``` + + + +### Tag: package-2018-04-02 + +These settings apply only when `--tag=package-2018-04-02` is specified on the command line. + +``` yaml $(tag) == 'package-2018-04-02' +input-file: +- Microsoft.StorageSync/stable/2018-04-02/storagesync.json +``` + + +### Tag: package-2017-06-05-preview + +These settings apply only when `--tag=package-2017-06-05-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-06-05-preview' +input-file: +- Microsoft.StorageSync/2017-06-05-preview/storagesync.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-libraries-for-java + - repo: azure-sdk-for-node +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.StorageSync + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/Storage/Management.StorageSync/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.storagesync + package-name: azure-mgmt-storagesync + package-version: 1.0.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-storagesync/azure/mgmt/storagesync +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-storagesync +``` + +## 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 + fluent: true + namespace: com.microsoft.azure.management.storagesync + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storagesync +``` diff --git a/specification/storagesync/resource-manager/readme.nodejs.md b/specification/storagesync/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..b3ace2171628 --- /dev/null +++ b/specification/storagesync/resource-manager/readme.nodejs.md @@ -0,0 +1,15 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-storagesyncmanagement + package-version: 1.1.0 + output-folder: $(node-sdks-folder)/lib/services/storagesyncmanagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/storagesync/resource-manager/readme.ruby.md b/specification/storagesync/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..73cd11525638 --- /dev/null +++ b/specification/storagesync/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_storagesync_management +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-04-02 +``` + +### Tag: package-2018-04-02 and ruby + +These settings apply only when `--tag=package-2018-04-02 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-04-02' && $(ruby) +namespace: "Azure::ServerManagement::Mgmt::V2016_07_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_server_management/lib +``` diff --git a/specification/storsimple8000series/resource-manager/readme.md b/specification/storsimple8000series/resource-manager/readme.md index d9105d477aea..a0636c29b01c 100644 --- a/specification/storsimple8000series/resource-manager/readme.md +++ b/specification/storsimple8000series/resource-manager/readme.md @@ -56,6 +56,9 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_stor_simple8000_series'] ``` @@ -108,11 +111,32 @@ 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 - fluent: true - namespace: com.microsoft.azure.management.storsimple8000series - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storsimple8000series +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.storsimple8000series +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storsimple8000series ``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-06 +``` + +### Tag: package-2017-06 and java + +These settings apply only when `--tag=package-2017-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.storsimple.v2017_06_01 + output-folder: $(azure-libraries-for-java-folder)/storsimple/resource-manager/v2017_06_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/storsimple8000series/resource-manager/readme.ruby.md b/specification/storsimple8000series/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..ca77f36597ee --- /dev/null +++ b/specification/storsimple8000series/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_stor_simple8000_series +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2017-06 +``` + +### Tag: package-2017-06 and ruby + +These settings apply only when `--tag=package-2017-06 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-06' && $(ruby) +namespace: "Azure::StorSimple8000Series::Mgmt::V2017_06_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_stor_simple8000_series/lib +``` diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/functions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/functions.json index 8f86a9f9dc56..0c3acc0954a8 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/functions.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/functions.json @@ -266,7 +266,7 @@ "in": "query", "required": false, "type": "string", - "description": "The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or “*” to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value." + "description": "The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or \"*\" to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json index 593f163672d6..e9427834cb45 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json @@ -273,7 +273,7 @@ "in": "query", "required": false, "type": "string", - "description": "The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or “*” to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value." + "description": "The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or \"*\" to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json index 52e1b4f3c20a..fab3ca8ba5f0 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json @@ -287,7 +287,7 @@ "in": "query", "required": false, "type": "string", - "description": "The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or “*” to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value." + "description": "The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or \"*\" to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/streamanalytics/resource-manager/readme.md b/specification/streamanalytics/resource-manager/readme.md index 143fc8842966..1cfe078e9b49 100644 --- a/specification/streamanalytics/resource-manager/readme.md +++ b/specification/streamanalytics/resource-manager/readme.md @@ -60,6 +60,9 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_stream_analytics'] ``` @@ -112,13 +115,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.streamanalytics +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-streamanalytics +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-03 +``` + +### Tag: package-2016-03 and java + +These settings apply only when `--tag=package-2016-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-03' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.streamanalytics - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-streamanalytics + namespace: com.microsoft.azure.management.streamanalytics.v2016_03_01 + output-folder: $(azure-libraries-for-java-folder)/streamanalytics/resource-manager/v2016_03_01 +regenerate-manager: true +generate-interface: true ``` diff --git a/specification/streamanalytics/resource-manager/readme.ruby.md b/specification/streamanalytics/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..913b3d34fef8 --- /dev/null +++ b/specification/streamanalytics/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_stream_analytics +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2016-03 +``` + +### Tag: package-2016-03 and ruby + +These settings apply only when `--tag=package-2016-03 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-03' && $(ruby) +namespace: "Azure::StreamAnalytics::Mgmt::V2016_03_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_stream_analytics/lib +``` diff --git a/specification/subscription/resource-manager/readme.csharp.md b/specification/subscription/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..94ba1e9fa130 --- /dev/null +++ b/specification/subscription/resource-manager/readme.csharp.md @@ -0,0 +1,35 @@ +# C# Subscription + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DNS. + + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +## Common C# Settings + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true +``` + +``` yaml $(csharp) && !$(multiApi) +namespace: Microsoft.Azure.Management.Subscription +output-folder: $(csharp-sdks-folder)/Subscription/Management.Subscription/Generated +``` + +## Batch settings +These settings are for batch mode only: (ie, add `--MultiApi` to the command line ) + +``` yaml $(multiApi) +namespace: Microsoft.Azure.Management.Subscription.$(ApiVersionName) +output-folder: $(csharp-sdks-folder)/$(ApiVersionName)/Generated + +batch: + - tag: package-2018-03-preview + ApiVersionName: Api2018_03_01 +``` \ No newline at end of file diff --git a/specification/subscription/resource-manager/readme.md b/specification/subscription/resource-manager/readme.md index 01234c5e2eae..a3a376df32d0 100644 --- a/specification/subscription/resource-manager/readme.md +++ b/specification/subscription/resource-manager/readme.md @@ -72,20 +72,6 @@ swagger-to-sdk: ``` -## 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 - namespace: Microsoft.Azure.Management.Subscription - license-header: MICROSOFT_MIT_NO_VERSION - output-folder: $(csharp-sdks-folder)/Subscription/Management.Subscription/Generated - clear-output-folder: true -``` - ## Python These settings apply only when `--python` is specified on the command line. @@ -129,6 +115,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2018-03-preview + - tag: package-2017-11-preview ``` ### Tag: package-2018-03-preview and go @@ -156,11 +143,32 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.subscription +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-subscription +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-11-preview +``` + +### Tag: package-2017-11-preview and java + +These settings apply only when `--tag=package-2017-11-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-11-preview' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.subscription - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-subscription + namespace: com.microsoft.azure.management.subscription.v2017_11_01_preview + output-folder: $(azure-libraries-for-java-folder)/subscription/resource-manager/v2017_11_01_preview +regenerate-manager: true +generate-interface: true ``` + + diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsCreate.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsCreate.json index 6e1b28109715..6edf7695d85f 100644 --- a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsCreate.json +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsCreate.json @@ -10,7 +10,13 @@ "capacity": 1 }, "properties": { - "dataRetentionTime": "P31D" + "dataRetentionTime": "P31D", + "partitionKeyProperties": [ + { + "name": "DeviceId1", + "type": "String" + } + ] } }, "api-version": "2017-11-15" diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsGet.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsGet.json index 6569a3fe4c6d..4ae35b0a1ec6 100644 --- a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsGet.json +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsGet.json @@ -19,7 +19,13 @@ "creationTime": "2017-04-18T19:20:33.2288820Z", "storageLimitExceededBehavior": "PurgeOldData", "dataAccessId": "", - "dataAccessFqdn": "" + "dataAccessFqdn": "", + "partitionKeyProperties": [ + { + "name": "DeviceId1", + "type": "String" + } + ] }, "sku": { "name": "S1", diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsGetExpandStatus.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsGetExpandStatus.json index 64be2059a4f7..2cc17119c0c2 100644 --- a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsGetExpandStatus.json +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsGetExpandStatus.json @@ -19,6 +19,12 @@ "provisioningState": "Succeeded", "creationTime": "2017-04-18T19:20:33.2288820Z", "storageLimitExceededBehavior": "PurgeOldData", + "partitionKeyProperties": [ + { + "name": "DeviceId1", + "type": "String" + } + ], "dataAccessId": "", "dataAccessFqdn": "", "status": { diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/timeseriesinsights.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/timeseriesinsights.json index 15be9d6079a6..3171601e55a5 100644 --- a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/timeseriesinsights.json +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/timeseriesinsights.json @@ -1310,6 +1310,13 @@ "name": "StorageLimitExceededBehavior", "modelAsString": false } + }, + "partitionKeyProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/PartitionKeyProperty" + }, + "description": "The list of partition keys according to which the data in the environment will be ordered." } }, "required": [ @@ -1365,9 +1372,36 @@ "name": "StorageLimitExceededBehavior", "modelAsString": false } + }, + "partitionKeyProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/PartitionKeyProperty" + }, + "description": "The list of event properties which will be used to partition data in the environment." } } }, + "PartitionKeyProperty": { + "properties": { + "name": { + "type": "string", + "description": "The name of the property." + }, + "type": { + "type": "string", + "description": "The type of the property.", + "enum": [ + "String" + ], + "x-ms-enum": { + "name": "PropertyType", + "modelAsString": true + } + } + }, + "description": "The structure of the property that a partition key can have. An environment can have multiple such properties." + }, "EnvironmentStatus": { "readOnly": true, "type": "object", diff --git a/specification/timeseriesinsights/resource-manager/readme.md b/specification/timeseriesinsights/resource-manager/readme.md index 8b4d54fece40..1b06b74a1068 100644 --- a/specification/timeseriesinsights/resource-manager/readme.md +++ b/specification/timeseriesinsights/resource-manager/readme.md @@ -113,7 +113,7 @@ These settings apply only when `--tag=package-2017-02-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2017-02-preview' && $(go) -output-folder: $(go-sdk-folder)/services/timeseriesinsights/mgmt/2017-02-28-preview/timeseriesinsights +output-folder: $(go-sdk-folder)/services/preview/timeseriesinsights/mgmt/2017-02-28-preview/timeseriesinsights ``` ## Java @@ -122,11 +122,46 @@ 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 - fluent: true - namespace: com.microsoft.azure.management.timeseriesinsights - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-timeseriesinsights +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.timeseriesinsights +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-timeseriesinsights ``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-11-15 + - tag: package-2017-02-preview +``` + +### Tag: package-2017-11-15 and java + +These settings apply only when `--tag=package-2017-11-15 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-11-15' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.timeseriesinsights.v2017_11_15 + output-folder: $(azure-libraries-for-java-folder)/timeseriesinsights/resource-manager/v2017_11_15 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-02-preview and java + +These settings apply only when `--tag=package-2017-02-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-02-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.timeseriesinsights.v2017_02_28_preview + output-folder: $(azure-libraries-for-java-folder)/timeseriesinsights/resource-manager/v2017_02_28_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-DELETE-External.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-DELETE-External.json new file mode 100644 index 000000000000..cf9a541ea7d3 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-DELETE-External.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "endpointType": "ExternalEndpoints", + "endpointName": "azsmnet7187", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-GET-External-WithGeoMapping.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-GET-External-WithGeoMapping.json new file mode 100644 index 000000000000..45d0ecc6d06a --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-GET-External-WithGeoMapping.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2191", + "profileName": "azuresdkfornetautoresttrafficmanager8224", + "endpointType": "ExternalEndpoints", + "endpointName": "My%20external%20endpoint", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "geoMapping": [ + "GEO-AS", + "GEO-AF" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-GET-External-WithLocation.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-GET-External-WithLocation.json new file mode 100644 index 000000000000..2a9bbf47f297 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-GET-External-WithLocation.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "endpointType": "ExternalEndpoints", + "endpointName": "azsmnet7187", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-PATCH-External-Target.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-PATCH-External-Target.json new file mode 100644 index 000000000000..90fff205164d --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-PATCH-External-Target.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "endpointType": "ExternalEndpoints", + "endpointName": "azsmnet7187", + "api-version": "2018-02-01", + "parameters": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "target": "another.foobar.contoso.com" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "another.foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-PUT-External-WithGeoMapping.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-PUT-External-WithGeoMapping.json new file mode 100644 index 000000000000..d830e528140c --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-PUT-External-WithGeoMapping.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2191", + "profileName": "azuresdkfornetautoresttrafficmanager8224", + "endpointType": "ExternalEndpoints", + "endpointName": "My%20external%20endpoint", + "api-version": "2018-02-01", + "parameters": { + "name": "My external endpoint", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "geoMapping": [ + "GEO-AS", + "GEO-AF" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "geoMapping": [ + "GEO-AS", + "GEO-AF" + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "geoMapping": [ + "GEO-AS", + "GEO-AF" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-PUT-External-WithLocation.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-PUT-External-WithLocation.json new file mode 100644 index 000000000000..1275f5b23f2e --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Endpoint-PUT-External-WithLocation.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "endpointType": "ExternalEndpoints", + "endpointName": "azsmnet7187", + "api-version": "2018-02-01", + "parameters": { + "name": "azsmnet7187", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "endpointLocation": "North Europe" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/GeographicHierarchy-GET-default.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/GeographicHierarchy-GET-default.json new file mode 100644 index 000000000000..785c1b6a6118 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/GeographicHierarchy-GET-default.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Network/trafficManagerGeographicHierarchies/default", + "name": "default", + "type": "Microsoft.Network/trafficManagerGeographicHierarchies", + "properties": { + "geographicHierarchy": { + "code": "WORLD", + "name": "World", + "regions": [ + { + "code": "GEO-ME", + "name": "Middle East", + "regions": [ + { + "code": "AE", + "name": "United Arab Emirates", + "regions": [] + } + ] + }, + { + "code": "GEO-AP", + "name": "Australia / Pacific", + "regions": [ + { + "code": "AU", + "name": "Australia", + "regions": [ + { + "code": "AU-ACT", + "name": "Australian Capital Territory", + "regions": [] + }, + { + "code": "AU-NSW", + "name": "New South Wales", + "regions": [] + } + ] + }, + { + "code": "CK", + "name": "Cook Islands", + "regions": [] + } + ] + } + ] + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NameAvailabilityTest_NameAvailable-POST-example-21.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NameAvailabilityTest_NameAvailable-POST-example-21.json new file mode 100644 index 000000000000..a106b8727712 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NameAvailabilityTest_NameAvailable-POST-example-21.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2018-02-01", + "parameters": { + "name": "azsmnet5403", + "type": "microsoft.network/trafficmanagerprofiles" + } + }, + "responses": { + "200": { + "body": { + "name": "azsmnet5403", + "type": "Microsoft.Network/trafficManagerProfiles", + "nameAvailable": true + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NameAvailabilityTest_NameNotAvailable-POST-example-23.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NameAvailabilityTest_NameNotAvailable-POST-example-23.json new file mode 100644 index 000000000000..183452fbf631 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NameAvailabilityTest_NameNotAvailable-POST-example-23.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-02-01", + "parameters": { + "name": "azsmnet4696", + "type": "microsoft.network/trafficmanagerprofiles" + } + }, + "responses": { + "200": { + "body": { + "name": "azsmnet4696", + "type": "Microsoft.Network/trafficManagerProfiles", + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Domain name azsmnet4696.tmpreview.watmtest.azure-test.net already exists. Please choose a different DNS prefix." + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-DELETE.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-DELETE.json new file mode 100644 index 000000000000..bedfca67b180 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-DELETE.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-GET-ByResourceGroup.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-GET-ByResourceGroup.json new file mode 100644 index 000000000000..106a9f4f1ebb --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-GET-ByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager3640", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager1005", + "name": "azuresdkfornetautoresttrafficmanager1005", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager1005", + "fqdn": "azuresdkfornetautoresttrafficmanager1005.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager1005/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + }, + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager959", + "name": "azuresdkfornetautoresttrafficmanager959", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager959", + "fqdn": "azuresdkfornetautoresttrafficmanager959.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager959/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "Online", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-GET-BySubscription.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-GET-BySubscription.json new file mode 100644 index 000000000000..f0a05fa4bc3b --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-GET-BySubscription.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azsmnet1719/providers/Microsoft.Network/trafficManagerProfiles/azsmnet5183", + "name": "azsmnet5183", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azsmnet4696", + "fqdn": "azsmnet4696.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [] + } + }, + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager5168/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3440", + "name": "azuresdkfornetautoresttrafficmanager3440", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager3440", + "fqdn": "azuresdkfornetautoresttrafficmanager3440.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager5168/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3440/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "Online", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + }, + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk8819", + "name": "onesdk8819", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "onesdk7242", + "fqdn": "onesdk7242.tmpreview.watmtest.azure-test.net", + "ttl": 51 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTPS", + "port": 111, + "path": "/testparent.asp", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk8819/nestedEndpoints/MyNestedEndpoint", + "name": "MyNestedEndpoint", + "type": "Microsoft.Network/trafficManagerProfiles/nestedEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "Stopped", + "targetResourceId": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk1792", + "target": "onesdk4285.tmpreview.watmtest.azure-test.net", + "weight": 1, + "priority": 1, + "endpointLocation": "West Europe", + "minChildEndpoints": 1 + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-GET-WithEndpoints.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-GET-WithEndpoints.json new file mode 100644 index 000000000000..b1bcfde63a56 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-GET-WithEndpoints.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880", + "name": "azuresdkfornetautoresttrafficmanager3880", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager3880", + "fqdn": "azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-GET-WithTrafficViewEnabled.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-GET-WithTrafficViewEnabled.json new file mode 100644 index 000000000000..4d10dfea66dc --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-GET-WithTrafficViewEnabled.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880", + "name": "azuresdkfornetautoresttrafficmanager3880", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager3880", + "fqdn": "azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ], + "trafficViewEnrollmentStatus": "Enabled" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-PATCH-MonitorConfig.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-PATCH-MonitorConfig.json new file mode 100644 index 000000000000..5e2d44cda189 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-PATCH-MonitorConfig.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2583", + "profileName": "azuresdkfornetautoresttrafficmanager6192", + "api-version": "2018-02-01", + "parameters": { + "properties": { + "monitorConfig": { + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "timeoutInSeconds": 6, + "toleratedNumberOfFailures": 4 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 4, + "timeoutInSeconds": 6 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-PUT-NoEndpoints.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-PUT-NoEndpoints.json new file mode 100644 index 000000000000..13120a065bf7 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-PUT-NoEndpoints.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "api-version": "2018-02-01", + "parameters": { + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azsmnet6386", + "ttl": 35 + }, + "monitorConfig": { + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx" + } + }, + "location": "global" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386", + "name": "azsmnet6386", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azsmnet6386", + "fqdn": "azsmnet6386.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Inactive", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386", + "name": "azsmnet6386", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azsmnet6386", + "fqdn": "azsmnet6386.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Inactive", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-PUT-WithEndpoints.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-PUT-WithEndpoints.json new file mode 100644 index 000000000000..20ae44cafba6 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/examples/Profile-PUT-WithEndpoints.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2583", + "profileName": "azuresdkfornetautoresttrafficmanager6192", + "api-version": "2018-02-01", + "parameters": { + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "ttl": 35 + }, + "monitorConfig": { + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "timeoutInSeconds": 5, + "toleratedNumberOfFailures": 2 + }, + "endpoints": [ + { + "name": "My external endpoint", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "endpointLocation": "North Europe" + } + } + ] + }, + "location": "global" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "toleratedNumberOfFailures": 2, + "timeoutInSeconds": 5 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "toleratedNumberOfFailures": 2, + "timeoutInSeconds": 5 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/trafficmanager.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/trafficmanager.json new file mode 100644 index 000000000000..6e2d8ce0dd80 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/trafficmanager.json @@ -0,0 +1,1157 @@ +{ + "swagger": "2.0", + "info": { + "title": "TrafficManagerManagementClient", + "version": "2018-02-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}": { + "patch": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Update", + "description": "Update a Traffic Manager endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager endpoint to be updated." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "endpointType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of the Traffic Manager endpoint to be updated." + }, + { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager endpoint to be updated." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "description": "The Traffic Manager endpoint parameters supplied to the Update operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The updated Traffic Manager endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Endpoint-PATCH-External-Target": { + "$ref": "./examples/Endpoint-PATCH-External-Target.json" + } + } + }, + "get": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Get", + "description": "Gets a Traffic Manager endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager endpoint." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "endpointType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of the Traffic Manager endpoint." + }, + { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager endpoint." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Endpoint-GET-External-WithGeoMapping": { + "$ref": "./examples/Endpoint-GET-External-WithGeoMapping.json" + }, + "Endpoint-GET-External-WithLocation": { + "$ref": "./examples/Endpoint-GET-External-WithLocation.json" + } + } + }, + "put": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_CreateOrUpdate", + "description": "Create or update a Traffic Manager endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager endpoint to be created or updated." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "endpointType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of the Traffic Manager endpoint to be created or updated." + }, + { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager endpoint to be created or updated." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "description": "The Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The created or updated Endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "201": { + "description": "The created or updated Endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Endpoint-PUT-External-WithGeoMapping": { + "$ref": "./examples/Endpoint-PUT-External-WithGeoMapping.json" + }, + "Endpoint-PUT-External-WithLocation": { + "$ref": "./examples/Endpoint-PUT-External-WithLocation.json" + } + } + }, + "delete": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Delete", + "description": "Deletes a Traffic Manager endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager endpoint to be deleted." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "endpointType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of the Traffic Manager endpoint to be deleted." + }, + { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager endpoint to be deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager Endpoint was deleted successfully.", + "schema": { + "$ref": "#/definitions/DeleteOperationResult" + } + }, + "204": { + "description": "The Traffic Manager Endpoint does not exist. It could have been deleted on a previous request." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Endpoint-DELETE-External": { + "$ref": "./examples/Endpoint-DELETE-External.json" + } + } + } + }, + "/providers/Microsoft.Network/checkTrafficManagerNameAvailability": { + "post": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_CheckTrafficManagerRelativeDnsNameAvailability", + "description": "Checks the availability of a Traffic Manager Relative DNS name.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckTrafficManagerRelativeDnsNameAvailabilityParameters" + }, + "description": "The Traffic Manager name parameters supplied to the CheckTrafficManagerNameAvailability operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager Name Availability.", + "schema": { + "$ref": "#/definitions/TrafficManagerNameAvailability" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NameAvailabilityTest_NameAvailablePOST21": { + "$ref": "./examples/NameAvailabilityTest_NameAvailable-POST-example-21.json" + }, + "NameAvailabilityTest_NameNotAvailablePOST23": { + "$ref": "./examples/NameAvailabilityTest_NameNotAvailable-POST-example-23.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles": { + "get": { + "tags": [ + "Profiles" + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "operationId": "Profiles_ListByResourceGroup", + "description": "Lists all Traffic Manager profiles within a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profiles to be listed." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The list of Traffic Manager profiles.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListProfilesByResourceGroup": { + "$ref": "./examples/Profile-GET-ByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficmanagerprofiles": { + "get": { + "tags": [ + "Profiles" + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "operationId": "Profiles_ListBySubscription", + "description": "Lists all Traffic Manager profiles within a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The list of Traffic Manager profiles.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListBySubscription": { + "$ref": "./examples/Profile-GET-BySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}": { + "get": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_Get", + "description": "Gets a Traffic Manager profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profile." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Profile-GET-WithEndpoints": { + "$ref": "./examples/Profile-GET-WithEndpoints.json" + } + } + }, + "put": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_CreateOrUpdate", + "description": "Create or update a Traffic Manager profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profile." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Profile" + }, + "description": "The Traffic Manager profile parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The created or updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "201": { + "description": "The created or updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Profile-PUT-NoEndpoints": { + "$ref": "./examples/Profile-PUT-NoEndpoints.json" + }, + "Profile-PUT-WithEndpoints": { + "$ref": "./examples/Profile-PUT-WithEndpoints.json" + } + } + }, + "delete": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_Delete", + "description": "Deletes a Traffic Manager profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profile to be deleted." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile to be deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager Profile was deleted successfully.", + "schema": { + "$ref": "#/definitions/DeleteOperationResult" + } + }, + "204": { + "description": "The profile does not exist. It could have been deleted on a previous request." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Profile-DELETE": { + "$ref": "./examples/Profile-DELETE.json" + } + } + }, + "patch": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_Update", + "description": "Update a Traffic Manager profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profile." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Profile" + }, + "description": "The Traffic Manager profile parameters supplied to the Update operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Profile-PATCH-MonitorConfig": { + "$ref": "./examples/Profile-PATCH-MonitorConfig.json" + } + } + } + }, + "/providers/Microsoft.Network/trafficManagerGeographicHierarchies/default": { + "get": { + "tags": [ + "GeographicHierarchies" + ], + "operationId": "GeographicHierarchies_GetDefault", + "description": "Gets the default Geographic Hierarchy used by the Geographic traffic routing method.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The default Geographic Hierarchy.", + "schema": { + "$ref": "#/definitions/TrafficManagerGeographicHierarchy" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GeographicHierarchy-GET-default": { + "$ref": "./examples/GeographicHierarchy-GET-default.json" + } + } + } + } + }, + "definitions": { + "DeleteOperationResult": { + "properties": { + "boolean": { + "type": "boolean", + "x-ms-client-name": "operationResult", + "readOnly": true, + "description": "The result of the operation or request." + } + }, + "description": "The result of the request or operation." + }, + "EndpointProperties": { + "properties": { + "targetResourceId": { + "type": "string", + "description": "The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'." + }, + "target": { + "type": "string", + "description": "The fully-qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint." + }, + "endpointStatus": { + "type": "string", + "description": "The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EndpointStatus", + "modelAsString": true + } + }, + "weight": { + "type": "integer", + "format": "int64", + "description": "The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000." + }, + "priority": { + "type": "integer", + "format": "int64", + "description": "The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value." + }, + "endpointLocation": { + "type": "string", + "description": "Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic routing method." + }, + "endpointMonitorStatus": { + "type": "string", + "description": "The monitoring status of the endpoint.", + "enum": [ + "CheckingEndpoint", + "Online", + "Degraded", + "Disabled", + "Inactive", + "Stopped" + ], + "x-ms-enum": { + "name": "EndpointMonitorStatus", + "modelAsString": true + } + }, + "minChildEndpoints": { + "type": "integer", + "format": "int64", + "description": "The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'." + }, + "geoMapping": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values." + } + }, + "description": "Class representing a Traffic Manager endpoint properties." + }, + "Endpoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EndpointProperties", + "description": "The properties of the Traffic Manager endpoint." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Class representing a Traffic Manager endpoint." + }, + "CheckTrafficManagerRelativeDnsNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "type": { + "type": "string", + "description": "The type of the resource." + } + }, + "description": "Parameters supplied to check Traffic Manager name operation." + }, + "DnsConfig": { + "properties": { + "relativeName": { + "type": "string", + "description": "The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile." + }, + "fqdn": { + "type": "string", + "readOnly": true, + "description": "The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager." + }, + "ttl": { + "type": "integer", + "format": "int64", + "description": "The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile." + } + }, + "description": "Class containing DNS settings in a Traffic Manager profile." + }, + "MonitorConfig": { + "properties": { + "profileMonitorStatus": { + "type": "string", + "description": "The profile-level monitoring status of the Traffic Manager profile.", + "enum": [ + "CheckingEndpoints", + "Online", + "Degraded", + "Disabled", + "Inactive" + ], + "x-ms-enum": { + "name": "ProfileMonitorStatus", + "modelAsString": true + } + }, + "protocol": { + "type": "string", + "description": "The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.", + "enum": [ + "HTTP", + "HTTPS", + "TCP" + ], + "x-ms-enum": { + "name": "MonitorProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int64", + "description": "The TCP port used to probe for endpoint health." + }, + "path": { + "type": "string", + "description": "The path relative to the endpoint domain name used to probe for endpoint health." + }, + "intervalInSeconds": { + "type": "integer", + "format": "int64", + "description": "The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile." + }, + "timeoutInSeconds": { + "type": "integer", + "format": "int64", + "description": "The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check." + }, + "toleratedNumberOfFailures": { + "type": "integer", + "format": "int64", + "description": "The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check." + } + }, + "description": "Class containing endpoint monitoring settings in a Traffic Manager profile." + }, + "ProfileProperties": { + "properties": { + "profileStatus": { + "type": "string", + "description": "The status of the Traffic Manager profile.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ProfileStatus", + "modelAsString": true + } + }, + "trafficRoutingMethod": { + "type": "string", + "description": "The traffic routing method of the Traffic Manager profile.", + "enum": [ + "Performance", + "Priority", + "Weighted", + "Geographic" + ], + "x-ms-enum": { + "name": "TrafficRoutingMethod", + "modelAsString": true + } + }, + "dnsConfig": { + "$ref": "#/definitions/DnsConfig", + "description": "The DNS settings of the Traffic Manager profile." + }, + "monitorConfig": { + "$ref": "#/definitions/MonitorConfig", + "description": "The endpoint monitoring settings of the Traffic Manager profile." + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/Endpoint" + }, + "description": "The list of endpoints in the Traffic Manager profile." + }, + "trafficViewEnrollmentStatus": { + "type": "string", + "description": "Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "TrafficViewEnrollmentStatus", + "modelAsString": true + } + } + }, + "description": "Class representing the Traffic Manager profile properties." + }, + "Profile": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProfileProperties", + "description": "The properties of the Traffic Manager profile." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "Class representing a Traffic Manager profile." + }, + "ProfileListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Profile" + }, + "description": "Gets the list of Traffic manager profiles." + } + }, + "description": "The list Traffic Manager profiles operation response." + }, + "TrafficManagerNameAvailability": { + "properties": { + "name": { + "type": "string", + "description": "The relative name." + }, + "type": { + "type": "string", + "description": "Traffic Manager profile resource type." + }, + "nameAvailable": { + "type": "boolean", + "description": "Describes whether the relative name is available or not." + }, + "reason": { + "type": "string", + "description": "The reason why the name is not available, when applicable." + }, + "message": { + "type": "string", + "description": "Descriptive message that explains why the name is not available, when applicable." + } + }, + "description": "Class representing a Traffic Manager Name Availability response." + }, + "Region": { + "properties": { + "code": { + "type": "string", + "description": "The code of the region" + }, + "name": { + "type": "string", + "description": "The name of the region" + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/Region" + }, + "description": "The list of Regions grouped under this Region in the Geographic Hierarchy." + } + }, + "description": "Class representing a region in the Geographic hierarchy used with the Geographic traffic routing method." + }, + "GeographicHierarchyProperties": { + "properties": { + "geographicHierarchy": { + "$ref": "#/definitions/Region", + "description": "The region at the root of the hierarchy from all the regions in the hierarchy can be retrieved." + } + }, + "description": "Class representing the properties of the Geographic hierarchy used with the Geographic traffic routing method." + }, + "TrafficManagerGeographicHierarchy": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GeographicHierarchyProperties", + "description": "The properties of the Geographic Hierarchy resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Class representing the Geographic hierarchy used with the Geographic traffic routing method." + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{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.Network/trafficmanagerProfiles." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region where the resource lives" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "CloudError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "The content of the error." + } + }, + "description": "An error returned by the Azure Resource Manager", + "x-ms-external": true + }, + "CloudErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error code" + }, + "message": { + "type": "string", + "description": "Error message" + }, + "target": { + "type": "string", + "description": "Error target" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "Error details" + } + }, + "description": "The content of an error returned by the Azure Resource Manager", + "x-ms-external": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + }, + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-DELETE-External.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-DELETE-External.json new file mode 100644 index 000000000000..9143454a9126 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-DELETE-External.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "endpointType": "ExternalEndpoints", + "endpointName": "azsmnet7187", + "api-version": "2017-05-01" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-GET-External-WithGeoMapping.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-GET-External-WithGeoMapping.json new file mode 100644 index 000000000000..a70078bf3634 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-GET-External-WithGeoMapping.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2191", + "profileName": "azuresdkfornetautoresttrafficmanager8224", + "endpointType": "ExternalEndpoints", + "endpointName": "My%20external%20endpoint", + "api-version": "2017-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "geoMapping": [ + "GEO-AS", + "GEO-AF" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-GET-External-WithLocation.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-GET-External-WithLocation.json new file mode 100644 index 000000000000..53ff508ad1c9 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-GET-External-WithLocation.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "endpointType": "ExternalEndpoints", + "endpointName": "azsmnet7187", + "api-version": "2017-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-PATCH-External-Target.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-PATCH-External-Target.json new file mode 100644 index 000000000000..0aca89f118e0 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-PATCH-External-Target.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "endpointType": "ExternalEndpoints", + "endpointName": "azsmnet7187", + "api-version": "2017-05-01", + "parameters": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "target": "another.foobar.contoso.com" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "another.foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-PUT-External-WithCustomHeaders.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-PUT-External-WithCustomHeaders.json new file mode 100644 index 000000000000..0bed49febc02 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-PUT-External-WithCustomHeaders.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "endpointType": "ExternalEndpoints", + "endpointName": "azsmnet7187", + "api-version": "2018-03-01", + "parameters": { + "name": "azsmnet7187", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "endpointLocation": "North Europe", + "trafficViewEnrollmentStatus": "Disabled", + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe", + "trafficViewEnrollmentStatus": "Disabled", + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe", + "trafficViewEnrollmentStatus": "Disabled", + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-PUT-External-WithGeoMapping.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-PUT-External-WithGeoMapping.json new file mode 100644 index 000000000000..1cbe461a0f39 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-PUT-External-WithGeoMapping.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2191", + "profileName": "azuresdkfornetautoresttrafficmanager8224", + "endpointType": "ExternalEndpoints", + "endpointName": "My%20external%20endpoint", + "api-version": "2017-05-01", + "parameters": { + "name": "My external endpoint", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "geoMapping": [ + "GEO-AS", + "GEO-AF" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "geoMapping": [ + "GEO-AS", + "GEO-AF" + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "geoMapping": [ + "GEO-AS", + "GEO-AF" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-PUT-External-WithLocation.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-PUT-External-WithLocation.json new file mode 100644 index 000000000000..32d7d5ed530a --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Endpoint-PUT-External-WithLocation.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "endpointType": "ExternalEndpoints", + "endpointName": "azsmnet7187", + "api-version": "2017-05-01", + "parameters": { + "name": "azsmnet7187", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "endpointLocation": "North Europe" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/GeographicHierarchy-GET-default.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/GeographicHierarchy-GET-default.json new file mode 100644 index 000000000000..061d9b63134c --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/GeographicHierarchy-GET-default.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2017-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Network/trafficManagerGeographicHierarchies/default", + "name": "default", + "type": "Microsoft.Network/trafficManagerGeographicHierarchies", + "properties": { + "geographicHierarchy": { + "code": "WORLD", + "name": "World", + "regions": [ + { + "code": "GEO-ME", + "name": "Middle East", + "regions": [ + { + "code": "AE", + "name": "United Arab Emirates", + "regions": [] + } + ] + }, + { + "code": "GEO-AP", + "name": "Australia / Pacific", + "regions": [ + { + "code": "AU", + "name": "Australia", + "regions": [ + { + "code": "AU-ACT", + "name": "Australian Capital Territory", + "regions": [] + }, + { + "code": "AU-NSW", + "name": "New South Wales", + "regions": [] + } + ] + }, + { + "code": "CK", + "name": "Cook Islands", + "regions": [] + } + ] + } + ] + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/HeatMap-GET-With-Null-Values.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/HeatMap-GET-With-Null-Values.json new file mode 100644 index 000000000000..a0bbcbd25901 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/HeatMap-GET-With-Null-Values.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "heatMapType": "default", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/default", + "name": "default", + "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/default", + "properties": { + "startTime": "2017-08-15T12:00:00Z", + "endTime": "2017-08-22T12:50:00Z", + "endpoints": [ + { + "endpointId": 0, + "resourceId": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880" + }, + { + "endpointId": 1, + "resourceId": "/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881" + } + ], + "trafficFlows": [ + { + "latitude": 99.99, + "longitude": 0.00, + "sourceIp": "1.1.1.1", + "queryExperiences": [ + { + "endpointId": 0, + "latency": 99, + "queryCount": 1000000 + }, + { + "endpointId": 1, + "latency": 1, + "queryCount": 1 + } + ] + }, + { + "latitude": 1.11, + "longitude": -2.35, + "sourceIp": "2.255.1.1", + "queryExperiences": [ + { + "endpointId": 0, + "queryCount": 100 + }, + { + "endpointId": 1, + "latency": 4.222, + "queryCount": 500 + } + ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/HeatMap-GET-With-TopLeft-BotRight.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/HeatMap-GET-With-TopLeft-BotRight.json new file mode 100644 index 000000000000..104e577dfc9d --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/HeatMap-GET-With-TopLeft-BotRight.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "heatMapType": "default", + "topLeft": [10.000,50.001], + "botRight": [-50.001,80.000], + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/latencyVolumeByLocation", + "name": "default", + "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/latencyVolumeByLocation", + "properties": { + "startTime": "2017-08-15T12:00:00Z", + "endTime": "2017-08-22T12:50:00Z", + "endpoints": [ + { + "endpointId": 1, + "resourceId": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880" + }, + { + "endpointId": 2, + "resourceId": "/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881" + } + ], + "trafficFlows": [ + { + "latitude": 9.99, + "longitude": 75.01, + "sourceIp": "1.1.1.1", + "queryExperiences": [ + { + "endpointId": 1, + "latency": 99.222, + "queryCount": 1000000 + }, + { + "endpointId": 2, + "latency": 1.222, + "queryCount": 1 + } + ] + }, + { + "latitude": -49.99, + "longitude": 51.00, + "sourceIp": "2.255.1.1", + "queryExperiences": [ + { + "endpointId": 1, + "latency": 96.222, + "queryCount": 100 + }, + { + "endpointId": 2, + "latency": 4.222, + "queryCount": 500 + } + ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/HeatMap-GET.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/HeatMap-GET.json new file mode 100644 index 000000000000..43ef96d21449 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/HeatMap-GET.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "heatMapType": "default", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/latencyVolumeByLocation", + "name": "default", + "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/latencyVolumeByLocation", + "properties": { + "startTime": "2017-08-15T12:00:00Z", + "endTime": "2017-08-22T12:50:00Z", + "endpoints": [ + { + "endpointId": 1, + "resourceId": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880" + }, + { + "endpointId": 2, + "resourceId": "/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881" + } + ], + "trafficFlows": [ + { + "latitude": 99.99, + "longitude": 0.00, + "sourceIp": "1.1.1.1", + "queryExperiences": [ + { + "endpointId": 1, + "latency": 99.222, + "queryCount": 1000000 + }, + { + "endpointId": 2, + "latency": 1.222, + "queryCount": 1 + } + ] + }, + { + "latitude": -99.99, + "longitude": 1.00, + "sourceIp": "2.255.1.1", + "queryExperiences": [ + { + "endpointId": 1, + "latency": 96.222, + "queryCount": 100 + }, + { + "endpointId": 2, + "latency": 4.222, + "queryCount": 500 + } + ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/NameAvailabilityTest_NameAvailable-POST-example-21.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/NameAvailabilityTest_NameAvailable-POST-example-21.json new file mode 100644 index 000000000000..ee69c6d3a24a --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/NameAvailabilityTest_NameAvailable-POST-example-21.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2017-05-01", + "parameters": { + "name": "azsmnet5403", + "type": "microsoft.network/trafficmanagerprofiles" + } + }, + "responses": { + "200": { + "body": { + "name": "azsmnet5403", + "type": "Microsoft.Network/trafficManagerProfiles", + "nameAvailable": true + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/NameAvailabilityTest_NameNotAvailable-POST-example-23.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/NameAvailabilityTest_NameNotAvailable-POST-example-23.json new file mode 100644 index 000000000000..c94d59401ab6 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/NameAvailabilityTest_NameNotAvailable-POST-example-23.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2017-05-01", + "parameters": { + "name": "azsmnet4696", + "type": "microsoft.network/trafficmanagerprofiles" + } + }, + "responses": { + "200": { + "body": { + "name": "azsmnet4696", + "type": "Microsoft.Network/trafficManagerProfiles", + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Domain name azsmnet4696.tmpreview.watmtest.azure-test.net already exists. Please choose a different DNS prefix." + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-DELETE.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-DELETE.json new file mode 100644 index 000000000000..71f1ca52ba03 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-DELETE.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "api-version": "2017-05-01" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-ByResourceGroup.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-ByResourceGroup.json new file mode 100644 index 000000000000..4c09c9413014 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-ByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager3640", + "api-version": "2017-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager1005", + "name": "azuresdkfornetautoresttrafficmanager1005", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager1005", + "fqdn": "azuresdkfornetautoresttrafficmanager1005.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager1005/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + }, + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager959", + "name": "azuresdkfornetautoresttrafficmanager959", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager959", + "fqdn": "azuresdkfornetautoresttrafficmanager959.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager959/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "Online", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-BySubscription.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-BySubscription.json new file mode 100644 index 000000000000..4a82cb5e7e67 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-BySubscription.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "api-version": "2017-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azsmnet1719/providers/Microsoft.Network/trafficManagerProfiles/azsmnet5183", + "name": "azsmnet5183", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azsmnet4696", + "fqdn": "azsmnet4696.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [] + } + }, + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager5168/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3440", + "name": "azuresdkfornetautoresttrafficmanager3440", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager3440", + "fqdn": "azuresdkfornetautoresttrafficmanager3440.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager5168/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3440/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "Online", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + }, + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk8819", + "name": "onesdk8819", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "onesdk7242", + "fqdn": "onesdk7242.tmpreview.watmtest.azure-test.net", + "ttl": 51 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTPS", + "port": 111, + "path": "/testparent.asp", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk8819/nestedEndpoints/MyNestedEndpoint", + "name": "MyNestedEndpoint", + "type": "Microsoft.Network/trafficManagerProfiles/nestedEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "Stopped", + "targetResourceId": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk1792", + "target": "onesdk4285.tmpreview.watmtest.azure-test.net", + "weight": 1, + "priority": 1, + "endpointLocation": "West Europe", + "minChildEndpoints": 1 + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-WithEndpoints.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-WithEndpoints.json new file mode 100644 index 000000000000..49844f988a53 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-WithEndpoints.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "api-version": "2017-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880", + "name": "azuresdkfornetautoresttrafficmanager3880", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager3880", + "fqdn": "azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-WithTrafficViewDisabled.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-WithTrafficViewDisabled.json new file mode 100644 index 000000000000..8a22dd795b61 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-WithTrafficViewDisabled.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880", + "name": "azuresdkfornetautoresttrafficmanager3880", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager3880", + "fqdn": "azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ], + "trafficViewEnrollmentStatus": "Disabled" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-WithTrafficViewEnabled.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-WithTrafficViewEnabled.json new file mode 100644 index 000000000000..b17abf6c6dc0 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-GET-WithTrafficViewEnabled.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "api-version": "2018-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880", + "name": "azuresdkfornetautoresttrafficmanager3880", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager3880", + "fqdn": "azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ], + "trafficViewEnrollmentStatus": "Enabled" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PATCH-MonitorConfig.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PATCH-MonitorConfig.json new file mode 100644 index 000000000000..3316009739d0 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PATCH-MonitorConfig.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2583", + "profileName": "azuresdkfornetautoresttrafficmanager6192", + "api-version": "2017-05-01", + "parameters": { + "properties": { + "monitorConfig": { + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "timeoutInSeconds": 6, + "toleratedNumberOfFailures": 4, + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 4, + "timeoutInSeconds": 6, + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-NoEndpoints.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-NoEndpoints.json new file mode 100644 index 000000000000..ae79c6653f34 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-NoEndpoints.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "api-version": "2017-05-01", + "parameters": { + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azsmnet6386", + "ttl": 35 + }, + "monitorConfig": { + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx" + } + }, + "location": "global" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386", + "name": "azsmnet6386", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azsmnet6386", + "fqdn": "azsmnet6386.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Inactive", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386", + "name": "azsmnet6386", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azsmnet6386", + "fqdn": "azsmnet6386.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Inactive", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithAliasing.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithAliasing.json new file mode 100644 index 000000000000..a5914a96a036 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithAliasing.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2583", + "profileName": "azuresdkfornetautoresttrafficmanager6192", + "api-version": "2017-05-01", + "parameters": { + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "ttl": 35 + }, + "monitorConfig": { + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "timeoutInSeconds": 5, + "toleratedNumberOfFailures": 2 + }, + "allowedEndpointRecordTypes": ["DomainName"], + "endpoints": [ + { + "name": "My external endpoint", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "endpointLocation": "North Europe" + } + } + ] + }, + "location": "global" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "toleratedNumberOfFailures": 2, + "timeoutInSeconds": 5, + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + }, + "allowedEndpointRecordTypes": ["DomainName"], + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe", + "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + } + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "toleratedNumberOfFailures": 2, + "timeoutInSeconds": 5, + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + }, + "allowedEndpointRecordTypes": ["DomainName"], + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe", + "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithCustomHeaders.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithCustomHeaders.json new file mode 100644 index 000000000000..60a7411104a5 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithCustomHeaders.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2583", + "profileName": "azuresdkfornetautoresttrafficmanager6192", + "api-version": "2018-03-01", + "parameters": { + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "ttl": 35 + }, + "monitorConfig": { + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "timeoutInSeconds": 5, + "toleratedNumberOfFailures": 2, + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}], + "expectedStatusCodeRanges" : [{"min":200, "max":205},{"min":400, "max":410}] + }, + "trafficViewEnrollmentStatus": "Disabled", + "endpoints": [ + { + "name": "My external endpoint", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "endpointLocation": "North Europe", + "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + } + } + ] + }, + "location": "global" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "toleratedNumberOfFailures": 2, + "timeoutInSeconds": 5, + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + }, + "trafficViewEnrollmentStatus": "Disabled", + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe", + "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + } + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "toleratedNumberOfFailures": 2, + "timeoutInSeconds": 5, + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + }, + "trafficViewEnrollmentStatus": "Disabled", + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe", + "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithEndpoints.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithEndpoints.json new file mode 100644 index 000000000000..a5fb579a2f8f --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithEndpoints.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "e68d4145-c9ae-4667-925d-c51c8d88ad73", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2583", + "profileName": "azuresdkfornetautoresttrafficmanager6192", + "api-version": "2017-05-01", + "parameters": { + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "ttl": 35 + }, + "monitorConfig": { + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "timeoutInSeconds": 5, + "toleratedNumberOfFailures": 2 + }, + "endpoints": [ + { + "name": "My external endpoint", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "endpointLocation": "North Europe" + } + } + ] + }, + "location": "global" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "toleratedNumberOfFailures": 2, + "timeoutInSeconds": 5 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "toleratedNumberOfFailures": 2, + "timeoutInSeconds": 5 + }, + "endpoints": [ + { + "id": "/subscriptions/e68d4145-c9ae-4667-925d-c51c8d88ad73/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/trafficmanager.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/trafficmanager.json new file mode 100644 index 000000000000..acaaacd34c64 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/trafficmanager.json @@ -0,0 +1,1415 @@ +{ + "swagger": "2.0", + "info": { + "title": "TrafficManagerManagementClient", + "version": "2018-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}": { + "patch": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Update", + "description": "Update a Traffic Manager endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager endpoint to be updated." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "endpointType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of the Traffic Manager endpoint to be updated." + }, + { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager endpoint to be updated." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "description": "The Traffic Manager endpoint parameters supplied to the Update operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The updated Traffic Manager endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Endpoint-PATCH-External-Target": { + "$ref": "./examples/Endpoint-PATCH-External-Target.json" + } + } + }, + "get": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Get", + "description": "Gets a Traffic Manager endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager endpoint." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "endpointType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of the Traffic Manager endpoint." + }, + { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager endpoint." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Endpoint-GET-External-WithGeoMapping": { + "$ref": "./examples/Endpoint-GET-External-WithGeoMapping.json" + }, + "Endpoint-GET-External-WithLocation": { + "$ref": "./examples/Endpoint-GET-External-WithLocation.json" + } + } + }, + "put": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_CreateOrUpdate", + "description": "Create or update a Traffic Manager endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager endpoint to be created or updated." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "endpointType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of the Traffic Manager endpoint to be created or updated." + }, + { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager endpoint to be created or updated." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "description": "The Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The created or updated Endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "201": { + "description": "The created or updated Endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Endpoint-PUT-External-WithGeoMapping": { + "$ref": "./examples/Endpoint-PUT-External-WithGeoMapping.json" + }, + "Endpoint-PUT-External-WithLocation": { + "$ref": "./examples/Endpoint-PUT-External-WithLocation.json" + }, + "Endpoint-PUT-External-WithCustomHeaders": { + "$ref": "./examples/Endpoint-PUT-External-WithCustomHeaders.json" + } + } + }, + "delete": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Delete", + "description": "Deletes a Traffic Manager endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager endpoint to be deleted." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "endpointType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of the Traffic Manager endpoint to be deleted." + }, + { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager endpoint to be deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager Endpoint was deleted successfully.", + "schema": { + "$ref": "#/definitions/DeleteOperationResult" + } + }, + "204": { + "description": "The Traffic Manager Endpoint does not exist. It could have been deleted on a previous request." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Endpoint-DELETE-External": { + "$ref": "./examples/Endpoint-DELETE-External.json" + } + } + } + }, + "/providers/Microsoft.Network/checkTrafficManagerNameAvailability": { + "post": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_CheckTrafficManagerRelativeDnsNameAvailability", + "description": "Checks the availability of a Traffic Manager Relative DNS name.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckTrafficManagerRelativeDnsNameAvailabilityParameters" + }, + "description": "The Traffic Manager name parameters supplied to the CheckTrafficManagerNameAvailability operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager Name Availability.", + "schema": { + "$ref": "#/definitions/TrafficManagerNameAvailability" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NameAvailabilityTest_NameAvailablePOST21": { + "$ref": "./examples/NameAvailabilityTest_NameAvailable-POST-example-21.json" + }, + "NameAvailabilityTest_NameNotAvailablePOST23": { + "$ref": "./examples/NameAvailabilityTest_NameNotAvailable-POST-example-23.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles": { + "get": { + "tags": [ + "Profiles" + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "operationId": "Profiles_ListByResourceGroup", + "description": "Lists all Traffic Manager profiles within a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profiles to be listed." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The list of Traffic Manager profiles.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListProfilesByResourceGroup": { + "$ref": "./examples/Profile-GET-ByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficmanagerprofiles": { + "get": { + "tags": [ + "Profiles" + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "operationId": "Profiles_ListBySubscription", + "description": "Lists all Traffic Manager profiles within a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The list of Traffic Manager profiles.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListBySubscription": { + "$ref": "./examples/Profile-GET-BySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}": { + "get": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_Get", + "description": "Gets a Traffic Manager profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profile." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Profile-GET-WithEndpoints": { + "$ref": "./examples/Profile-GET-WithEndpoints.json" + } + } + }, + "put": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_CreateOrUpdate", + "description": "Create or update a Traffic Manager profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profile." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Profile" + }, + "description": "The Traffic Manager profile parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The created or updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "201": { + "description": "The created or updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Profile-PUT-NoEndpoints": { + "$ref": "./examples/Profile-PUT-NoEndpoints.json" + }, + "Profile-PUT-WithEndpoints": { + "$ref": "./examples/Profile-PUT-WithEndpoints.json" + }, + "Profile-PUT-WithCustomHeaders": { + "$ref": "./examples/Profile-PUT-WithCustomHeaders.json" + } + } + }, + "delete": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_Delete", + "description": "Deletes a Traffic Manager profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profile to be deleted." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile to be deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager Profile was deleted successfully.", + "schema": { + "$ref": "#/definitions/DeleteOperationResult" + } + }, + "204": { + "description": "The profile does not exist. It could have been deleted on a previous request." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Profile-DELETE": { + "$ref": "./examples/Profile-DELETE.json" + } + } + }, + "patch": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_Update", + "description": "Update a Traffic Manager profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profile." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Profile" + }, + "description": "The Traffic Manager profile parameters supplied to the Update operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Profile-PATCH-MonitorConfig": { + "$ref": "./examples/Profile-PATCH-MonitorConfig.json" + } + } + } + }, + "/providers/Microsoft.Network/trafficManagerGeographicHierarchies/default": { + "get": { + "tags": [ + "GeographicHierarchies" + ], + "operationId": "GeographicHierarchies_GetDefault", + "description": "Gets the default Geographic Hierarchy used by the Geographic traffic routing method.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The default Geographic Hierarchy.", + "schema": { + "$ref": "#/definitions/TrafficManagerGeographicHierarchy" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GeographicHierarchy-GET-default": { + "$ref": "./examples/GeographicHierarchy-GET-default.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/heatMaps/{heatMapType}": { + "get": { + "tags": [ + "HeatMaps" + ], + "operationId": "HeatMap_Get", + "description": "Gets latest heatmap for Traffic Manager profile.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager endpoint." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "heatMapType", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "description": "The type of HeatMap for the Traffic Manager profile." + }, + { + "name": "topLeft", + "in": "query", + "required": false, + "allowEmptyValue": true, + "description": "The top left latitude,longitude pair of the rectangular viewport to query for.", + "type": "array", + "minItems": 2, + "maxItems": 2, + "collectionFormat": "csv", + "items": { + "type": "number", + "format": "double" + } + }, + { + "name": "botRight", + "in": "query", + "required": false, + "allowEmptyValue": true, + "description": "The bottom right latitude,longitude pair of the rectangular viewport to query for.", + "type": "array", + "minItems": 2, + "maxItems": 2, + "collectionFormat": "csv", + "items": { + "type": "number", + "format": "double" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager heatmap.", + "schema": { + "$ref": "#/definitions/HeatMapModel" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "HeatMap-GET": { + "$ref": "./examples/HeatMap-GET.json" + }, + "HeatMap-GET-With-TopLeft-BotRight": { + "$ref": "./examples/HeatMap-GET-With-TopLeft-BotRight.json" + }, + "HeatMap-GET-With-Null-Values": { + "$ref": "./examples/HeatMap-GET-With-Null-Values.json" + } + } + } + } + }, + "definitions": { + "DeleteOperationResult": { + "properties": { + "boolean": { + "type": "boolean", + "x-ms-client-name": "operationResult", + "readOnly": true, + "description": "The result of the operation or request." + } + }, + "description": "The result of the request or operation." + }, + "EndpointProperties": { + "properties": { + "targetResourceId": { + "type": "string", + "description": "The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'." + }, + "target": { + "type": "string", + "description": "The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint." + }, + "endpointStatus": { + "type": "string", + "description": "The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EndpointStatus", + "modelAsString": true + } + }, + "weight": { + "type": "integer", + "format": "int64", + "description": "The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000." + }, + "priority": { + "type": "integer", + "format": "int64", + "description": "The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value." + }, + "endpointLocation": { + "type": "string", + "description": "Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic routing method." + }, + "endpointMonitorStatus": { + "type": "string", + "description": "The monitoring status of the endpoint.", + "enum": [ + "CheckingEndpoint", + "Online", + "Degraded", + "Disabled", + "Inactive", + "Stopped" + ], + "x-ms-enum": { + "name": "EndpointMonitorStatus", + "modelAsString": true + } + }, + "minChildEndpoints": { + "type": "integer", + "format": "int64", + "description": "The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'." + }, + "geoMapping": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values." + }, + "customHeaders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Header name." + }, + "value": { + "type": "string", + "description": "Header value." + } + }, + "description": "Custom header name and value." + }, + "description": "List of custom headers." + } + }, + "description": "Class representing a Traffic Manager endpoint properties." + }, + "HeatMapModel": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HeatMapProperties", + "description": "The properties of the Traffic Manager HeatMap." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Class representing a Traffic Manager HeatMap." + }, + "QueryExperience": { + "properties": { + "endpointId": { + "type": "integer", + "description": "The id of the endpoint from the 'endpoints' array which these queries were routed to." + }, + "queryCount": { + "type": "integer", + "description": "The number of queries originating from this location." + }, + "latency": { + "type": "number", + "format": "double", + "description": "The latency experienced by queries originating from this location." + } + }, + "required": [ + "endpointId", + "queryCount" + ], + "description": "Class representing a Traffic Manager HeatMap query experience properties." + }, + "TrafficFlow": { + "properties": { + "sourceIp": { + "type": "string", + "description": "The IP address that this query experience originated from." + }, + "latitude": { + "type": "number", + "format": "double", + "description": "The approximate latitude that these queries originated from." + }, + "longitude": { + "type": "number", + "format": "double", + "description": "The approximate longitude that these queries originated from." + }, + "queryExperiences": { + "type": "array", + "description": "The query experiences produced in this HeatMap calculation.", + "items": { + "$ref": "#/definitions/QueryExperience" + } + } + }, + "description": "Class representing a Traffic Manager HeatMap traffic flow properties." + }, + "HeatMapProperties": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The beginning of the time window for this HeatMap, inclusive." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The ending of the time window for this HeatMap, exclusive." + }, + "endpoints": { + "type": "array", + "description": "The endpoints used in this HeatMap calculation.", + "items": { + "$ref": "#/definitions/HeatMapEndpoint" + } + }, + "trafficFlows": { + "type": "array", + "description": "The traffic flows produced in this HeatMap calculation.", + "items": { + "$ref": "#/definitions/TrafficFlow" + } + } + }, + "description": "Class representing a Traffic Manager HeatMap properties." + }, + "HeatMapEndpoint": { + "properties": { + "resourceId": { + "type": "string", + "description": "The ARM Resource ID of this Traffic Manager endpoint." + }, + "endpointId": { + "type": "integer", + "description": "A number uniquely identifying this endpoint in query experiences." + } + }, + "description": "Class which is a sparse representation of a Traffic Manager endpoint." + }, + "Endpoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EndpointProperties", + "description": "The properties of the Traffic Manager endpoint." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Class representing a Traffic Manager endpoint." + }, + "CheckTrafficManagerRelativeDnsNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "type": { + "type": "string", + "description": "The type of the resource." + } + }, + "description": "Parameters supplied to check Traffic Manager name operation." + }, + "DnsConfig": { + "properties": { + "relativeName": { + "type": "string", + "description": "The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile." + }, + "fqdn": { + "type": "string", + "readOnly": true, + "description": "The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager." + }, + "ttl": { + "type": "integer", + "format": "int64", + "description": "The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile." + } + }, + "description": "Class containing DNS settings in a Traffic Manager profile." + }, + "MonitorConfig": { + "properties": { + "profileMonitorStatus": { + "type": "string", + "description": "The profile-level monitoring status of the Traffic Manager profile.", + "enum": [ + "CheckingEndpoints", + "Online", + "Degraded", + "Disabled", + "Inactive" + ], + "x-ms-enum": { + "name": "ProfileMonitorStatus", + "modelAsString": true + } + }, + "protocol": { + "type": "string", + "description": "The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.", + "enum": [ + "HTTP", + "HTTPS", + "TCP" + ], + "x-ms-enum": { + "name": "MonitorProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int64", + "description": "The TCP port used to probe for endpoint health." + }, + "path": { + "type": "string", + "description": "The path relative to the endpoint domain name used to probe for endpoint health." + }, + "intervalInSeconds": { + "type": "integer", + "format": "int64", + "description": "The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile." + }, + "timeoutInSeconds": { + "type": "integer", + "format": "int64", + "description": "The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check." + }, + "toleratedNumberOfFailures": { + "type": "integer", + "format": "int64", + "description": "The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check." + }, + "customHeaders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Header name." + }, + "value": { + "type": "string", + "description": "Header value." + } + }, + "description": "Custom header name and value." + }, + "description": "List of custom headers." + }, + "expectedStatusCodeRanges": { + "type": "array", + "items": { + "type": "object", + "properties": { + "min": { + "type": "integer", + "description": "Min status code." + }, + "max": { + "type": "integer", + "description": "Max status code." + } + }, + "description": "Min and max value of a status code range." + }, + "description": "List of expected status code ranges." + } + }, + "description": "Class containing endpoint monitoring settings in a Traffic Manager profile." + }, + "ProfileProperties": { + "properties": { + "profileStatus": { + "type": "string", + "description": "The status of the Traffic Manager profile.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ProfileStatus", + "modelAsString": true + } + }, + "trafficRoutingMethod": { + "type": "string", + "description": "The traffic routing method of the Traffic Manager profile.", + "enum": [ + "Performance", + "Priority", + "Weighted", + "Geographic" + ], + "x-ms-enum": { + "name": "TrafficRoutingMethod", + "modelAsString": true + } + }, + "dnsConfig": { + "$ref": "#/definitions/DnsConfig", + "description": "The DNS settings of the Traffic Manager profile." + }, + "monitorConfig": { + "$ref": "#/definitions/MonitorConfig", + "description": "The endpoint monitoring settings of the Traffic Manager profile." + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/Endpoint" + }, + "description": "The list of endpoints in the Traffic Manager profile." + }, + "trafficViewEnrollmentStatus": { + "type": "string", + "description": "Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "TrafficViewEnrollmentStatus", + "modelAsString": true + } + } + }, + "description": "Class representing the Traffic Manager profile properties." + }, + "Profile": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProfileProperties", + "description": "The properties of the Traffic Manager profile." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "Class representing a Traffic Manager profile." + }, + "ProfileListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Profile" + }, + "description": "Gets the list of Traffic manager profiles." + } + }, + "description": "The list Traffic Manager profiles operation response." + }, + "TrafficManagerNameAvailability": { + "properties": { + "name": { + "type": "string", + "description": "The relative name." + }, + "type": { + "type": "string", + "description": "Traffic Manager profile resource type." + }, + "nameAvailable": { + "type": "boolean", + "description": "Describes whether the relative name is available or not." + }, + "reason": { + "type": "string", + "description": "The reason why the name is not available, when applicable." + }, + "message": { + "type": "string", + "description": "Descriptive message that explains why the name is not available, when applicable." + } + }, + "description": "Class representing a Traffic Manager Name Availability response." + }, + "Region": { + "properties": { + "code": { + "type": "string", + "description": "The code of the region" + }, + "name": { + "type": "string", + "description": "The name of the region" + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/Region" + }, + "description": "The list of Regions grouped under this Region in the Geographic Hierarchy." + } + }, + "description": "Class representing a region in the Geographic hierarchy used with the Geographic traffic routing method." + }, + "GeographicHierarchyProperties": { + "properties": { + "geographicHierarchy": { + "$ref": "#/definitions/Region", + "description": "The region at the root of the hierarchy from all the regions in the hierarchy can be retrieved." + } + }, + "description": "Class representing the properties of the Geographic hierarchy used with the Geographic traffic routing method." + }, + "TrafficManagerGeographicHierarchy": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GeographicHierarchyProperties", + "description": "The properties of the Geographic Hierarchy resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Class representing the Geographic hierarchy used with the Geographic traffic routing method." + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}" + }, + "name": { + "type": "string", + "description": "The name of the resource" + }, + "type": { + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Network/trafficmanagerProfiles." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region where the resource lives" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "CloudError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "The content of the error." + } + }, + "description": "An error returned by the Azure Resource Manager", + "x-ms-external": true + }, + "CloudErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error code" + }, + "message": { + "type": "string", + "description": "Error message" + }, + "target": { + "type": "string", + "description": "Error target" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "Error details" + } + }, + "description": "The content of an error returned by the Azure Resource Manager", + "x-ms-external": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + }, + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-DELETE-External.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-DELETE-External.json new file mode 100644 index 000000000000..84d5fc671d4f --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-DELETE-External.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "endpointType": "ExternalEndpoints", + "endpointName": "azsmnet7187", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-GET-External-WithGeoMapping.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-GET-External-WithGeoMapping.json new file mode 100644 index 000000000000..4d4c52e14a35 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-GET-External-WithGeoMapping.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2191", + "profileName": "azuresdkfornetautoresttrafficmanager8224", + "endpointType": "ExternalEndpoints", + "endpointName": "My%20external%20endpoint", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "geoMapping": [ + "GEO-AS", + "GEO-AF" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-GET-External-WithLocation.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-GET-External-WithLocation.json new file mode 100644 index 000000000000..9efe77ed65c4 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-GET-External-WithLocation.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "endpointType": "ExternalEndpoints", + "endpointName": "azsmnet7187", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-GET-External-WithSubnetMapping.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-GET-External-WithSubnetMapping.json new file mode 100644 index 000000000000..50af08bca284 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-GET-External-WithSubnetMapping.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2191", + "profileName": "azuresdkfornetautoresttrafficmanager8224", + "endpointType": "ExternalEndpoints", + "endpointName": "My%20external%20endpoint", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "subnets": [ + { + "first": "1.2.3.0", + "scope": 24 + }, + { + "first": "25.26.27.28", + "last":"29.30.31.32" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PATCH-External-Target.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PATCH-External-Target.json new file mode 100644 index 000000000000..5c3c1158c3c4 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PATCH-External-Target.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "endpointType": "ExternalEndpoints", + "endpointName": "azsmnet7187", + "api-version": "2018-04-01", + "parameters": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "target": "another.foobar.contoso.com" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "another.foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PUT-External-WithCustomHeaders.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PUT-External-WithCustomHeaders.json new file mode 100644 index 000000000000..b69892fddea5 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PUT-External-WithCustomHeaders.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "endpointType": "ExternalEndpoints", + "endpointName": "azsmnet7187", + "api-version": "2018-04-01", + "parameters": { + "name": "azsmnet7187", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "endpointLocation": "North Europe", + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe", + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe", + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PUT-External-WithGeoMapping.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PUT-External-WithGeoMapping.json new file mode 100644 index 000000000000..dab7a7a0a663 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PUT-External-WithGeoMapping.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2191", + "profileName": "azuresdkfornetautoresttrafficmanager8224", + "endpointType": "ExternalEndpoints", + "endpointName": "My%20external%20endpoint", + "api-version": "2018-04-01", + "parameters": { + "name": "My external endpoint", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "geoMapping": [ + "GEO-AS", + "GEO-AF" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "geoMapping": [ + "GEO-AS", + "GEO-AF" + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "geoMapping": [ + "GEO-AS", + "GEO-AF" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PUT-External-WithLocation.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PUT-External-WithLocation.json new file mode 100644 index 000000000000..89ffcf8b3c6b --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PUT-External-WithLocation.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "endpointType": "ExternalEndpoints", + "endpointName": "azsmnet7187", + "api-version": "2018-04-01", + "parameters": { + "name": "azsmnet7187", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "endpointLocation": "North Europe" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187", + "name": "azsmnet7187", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PUT-External-WithSubnetMapping.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PUT-External-WithSubnetMapping.json new file mode 100644 index 000000000000..2ac78d46d183 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Endpoint-PUT-External-WithSubnetMapping.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2191", + "profileName": "azuresdkfornetautoresttrafficmanager8224", + "endpointType": "ExternalEndpoints", + "endpointName": "My%20external%20endpoint", + "api-version": "2018-04-01", + "parameters": { + "name": "My external endpoint", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "subnets": [ + { + "first": "1.2.3.0", + "scope": 24 + }, + { + "first": "25.26.27.28", + "last":"29.30.31.32" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "subnets": [ + { + "first": "1.2.3.0", + "scope": 24 + }, + { + "first": "25.26.27.28", + "last":"29.30.31.32" + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "subnets": [ + { + "first": "1.2.3.0", + "scope": 24 + }, + { + "first": "25.26.27.28", + "last":"29.30.31.32" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/GeographicHierarchy-GET-default.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/GeographicHierarchy-GET-default.json new file mode 100644 index 000000000000..8626483a26df --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/GeographicHierarchy-GET-default.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Network/trafficManagerGeographicHierarchies/default", + "name": "default", + "type": "Microsoft.Network/trafficManagerGeographicHierarchies", + "properties": { + "geographicHierarchy": { + "code": "WORLD", + "name": "World", + "regions": [ + { + "code": "GEO-ME", + "name": "Middle East", + "regions": [ + { + "code": "AE", + "name": "United Arab Emirates", + "regions": [] + } + ] + }, + { + "code": "GEO-AP", + "name": "Australia / Pacific", + "regions": [ + { + "code": "AU", + "name": "Australia", + "regions": [ + { + "code": "AU-ACT", + "name": "Australian Capital Territory", + "regions": [] + }, + { + "code": "AU-NSW", + "name": "New South Wales", + "regions": [] + } + ] + }, + { + "code": "CK", + "name": "Cook Islands", + "regions": [] + } + ] + } + ] + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HeatMap-GET-With-Null-Values.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HeatMap-GET-With-Null-Values.json new file mode 100644 index 000000000000..e18faf87ffa2 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HeatMap-GET-With-Null-Values.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "heatMapType": "default", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/default", + "name": "default", + "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/default", + "properties": { + "startTime": "2017-08-15T12:00:00Z", + "endTime": "2017-08-22T12:50:00Z", + "endpoints": [ + { + "endpointId": 0, + "resourceId": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880" + }, + { + "endpointId": 1, + "resourceId": "/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881" + } + ], + "trafficFlows": [ + { + "latitude": 99.99, + "longitude": 0.00, + "sourceIp": "1.1.1.1", + "queryExperiences": [ + { + "endpointId": 0, + "latency": 99, + "queryCount": 1000000 + }, + { + "endpointId": 1, + "latency": 1, + "queryCount": 1 + } + ] + }, + { + "latitude": 1.11, + "longitude": -2.35, + "sourceIp": "2.255.1.1", + "queryExperiences": [ + { + "endpointId": 0, + "queryCount": 100 + }, + { + "endpointId": 1, + "latency": 4.222, + "queryCount": 500 + } + ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HeatMap-GET-With-TopLeft-BotRight.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HeatMap-GET-With-TopLeft-BotRight.json new file mode 100644 index 000000000000..b19dddf0f4d0 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HeatMap-GET-With-TopLeft-BotRight.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "heatMapType": "default", + "topLeft": [10.000,50.001], + "botRight": [-50.001,80.000], + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/latencyVolumeByLocation", + "name": "default", + "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/latencyVolumeByLocation", + "properties": { + "startTime": "2017-08-15T12:00:00Z", + "endTime": "2017-08-22T12:50:00Z", + "endpoints": [ + { + "endpointId": 1, + "resourceId": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880" + }, + { + "endpointId": 2, + "resourceId": "/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881" + } + ], + "trafficFlows": [ + { + "latitude": 9.99, + "longitude": 75.01, + "sourceIp": "1.1.1.1", + "queryExperiences": [ + { + "endpointId": 1, + "latency": 99.222, + "queryCount": 1000000 + }, + { + "endpointId": 2, + "latency": 1.222, + "queryCount": 1 + } + ] + }, + { + "latitude": -49.99, + "longitude": 51.00, + "sourceIp": "2.255.1.1", + "queryExperiences": [ + { + "endpointId": 1, + "latency": 96.222, + "queryCount": 100 + }, + { + "endpointId": 2, + "latency": 4.222, + "queryCount": 500 + } + ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HeatMap-GET.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HeatMap-GET.json new file mode 100644 index 000000000000..32419992b78d --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/HeatMap-GET.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "heatMapType": "default", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/heatMaps/latencyVolumeByLocation", + "name": "default", + "type": "Microsoft.Network/trafficManagerProfiles/heatMaps/latencyVolumeByLocation", + "properties": { + "startTime": "2017-08-15T12:00:00Z", + "endTime": "2017-08-22T12:50:00Z", + "endpoints": [ + { + "endpointId": 1, + "resourceId": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/azuresdkfornetautoresttrafficmanager3880" + }, + { + "endpointId": 2, + "resourceId": "/subscriptions/562d4115-c01e-4m67-9bbd-c11c2d58ad73/resourceGroups/azuresdkfornetautoresttrafficmanager1300/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3885/externalEndpoints/azuresdkfornetautoresttrafficmanager3881" + } + ], + "trafficFlows": [ + { + "latitude": 99.99, + "longitude": 0.00, + "sourceIp": "1.1.1.1", + "queryExperiences": [ + { + "endpointId": 1, + "latency": 99.222, + "queryCount": 1000000 + }, + { + "endpointId": 2, + "latency": 1.222, + "queryCount": 1 + } + ] + }, + { + "latitude": -99.99, + "longitude": 1.00, + "sourceIp": "2.255.1.1", + "queryExperiences": [ + { + "endpointId": 1, + "latency": 96.222, + "queryCount": 100 + }, + { + "endpointId": 2, + "latency": 4.222, + "queryCount": 500 + } + ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NameAvailabilityTest_NameAvailable-POST-example-21.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NameAvailabilityTest_NameAvailable-POST-example-21.json new file mode 100644 index 000000000000..0e51da526d6f --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NameAvailabilityTest_NameAvailable-POST-example-21.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "parameters": { + "name": "azsmnet5403", + "type": "microsoft.network/trafficmanagerprofiles" + } + }, + "responses": { + "200": { + "body": { + "name": "azsmnet5403", + "type": "Microsoft.Network/trafficManagerProfiles", + "nameAvailable": true + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NameAvailabilityTest_NameNotAvailable-POST-example-23.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NameAvailabilityTest_NameNotAvailable-POST-example-23.json new file mode 100644 index 000000000000..4a3ff028ab19 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NameAvailabilityTest_NameNotAvailable-POST-example-23.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-04-01", + "parameters": { + "name": "azsmnet4696", + "type": "microsoft.network/trafficmanagerprofiles" + } + }, + "responses": { + "200": { + "body": { + "name": "azsmnet4696", + "type": "Microsoft.Network/trafficManagerProfiles", + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Domain name azsmnet4696.tmpreview.watmtest.azure-test.net already exists. Please choose a different DNS prefix." + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-DELETE.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-DELETE.json new file mode 100644 index 000000000000..d81efc536936 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-DELETE.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-ByResourceGroup.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-ByResourceGroup.json new file mode 100644 index 000000000000..5476fec0da14 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-ByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager3640", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager1005", + "name": "azuresdkfornetautoresttrafficmanager1005", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager1005", + "fqdn": "azuresdkfornetautoresttrafficmanager1005.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager1005/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager959", + "name": "azuresdkfornetautoresttrafficmanager959", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager959", + "fqdn": "azuresdkfornetautoresttrafficmanager959.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager959/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "Online", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-BySubscription.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-BySubscription.json new file mode 100644 index 000000000000..91a4627e4262 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-BySubscription.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azsmnet1719/providers/Microsoft.Network/trafficManagerProfiles/azsmnet5183", + "name": "azsmnet5183", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azsmnet4696", + "fqdn": "azsmnet4696.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [] + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager5168/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3440", + "name": "azuresdkfornetautoresttrafficmanager3440", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager3440", + "fqdn": "azuresdkfornetautoresttrafficmanager3440.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager5168/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3440/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "Online", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk8819", + "name": "onesdk8819", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "onesdk7242", + "fqdn": "onesdk7242.tmpreview.watmtest.azure-test.net", + "ttl": 51 + }, + "monitorConfig": { + "profileMonitorStatus": "Online", + "protocol": "HTTPS", + "port": 111, + "path": "/testparent.asp", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk8819/nestedEndpoints/MyNestedEndpoint", + "name": "MyNestedEndpoint", + "type": "Microsoft.Network/trafficManagerProfiles/nestedEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "Stopped", + "targetResourceId": "/subscriptions/{subscription-id}/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk1792", + "target": "onesdk4285.tmpreview.watmtest.azure-test.net", + "weight": 1, + "priority": 1, + "endpointLocation": "West Europe", + "minChildEndpoints": 1 + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-WithEndpoints.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-WithEndpoints.json new file mode 100644 index 000000000000..ef798bb44456 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-WithEndpoints.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880", + "name": "azuresdkfornetautoresttrafficmanager3880", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager3880", + "fqdn": "azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-WithTrafficViewDisabled.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-WithTrafficViewDisabled.json new file mode 100644 index 000000000000..33689840aefd --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-WithTrafficViewDisabled.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880", + "name": "azuresdkfornetautoresttrafficmanager3880", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager3880", + "fqdn": "azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ], + "trafficViewEnrollmentStatus": "Disabled" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-WithTrafficViewEnabled.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-WithTrafficViewEnabled.json new file mode 100644 index 000000000000..5d0ee32134be --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-GET-WithTrafficViewEnabled.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1323", + "profileName": "azuresdkfornetautoresttrafficmanager3880", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880", + "name": "azuresdkfornetautoresttrafficmanager3880", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager3880", + "fqdn": "azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ], + "trafficViewEnrollmentStatus": "Enabled" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PATCH-MonitorConfig.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PATCH-MonitorConfig.json new file mode 100644 index 000000000000..5b83a6ae9694 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PATCH-MonitorConfig.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2583", + "profileName": "azuresdkfornetautoresttrafficmanager6192", + "api-version": "2018-04-01", + "parameters": { + "properties": { + "monitorConfig": { + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "timeoutInSeconds": 6, + "toleratedNumberOfFailures": 4, + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "tags": {}, + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 4, + "timeoutInSeconds": 6, + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + }, + "endpoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-MultiValue.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-MultiValue.json new file mode 100644 index 000000000000..79580fe6e72d --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-MultiValue.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "api-version": "2018-04-01", + "parameters": { + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "MultiValue", + "dnsConfig": { + "relativeName": "azsmnet6386", + "ttl": 35 + }, + "monitorConfig": { + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx" + }, + "trafficViewEnrollmentStatus": "Disabled", + "maxReturn": 2 + }, + "location": "global" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386", + "name": "azsmnet6386", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "MultiValue", + "dnsConfig": { + "relativeName": "azsmnet6386", + "fqdn": "azsmnet6386.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Inactive", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "trafficViewEnrollmentStatus": "Disabled", + "maxReturn": 2, + "endpoints": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386", + "name": "azsmnet6386", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "MultiValue", + "dnsConfig": { + "relativeName": "azsmnet6386", + "fqdn": "azsmnet6386.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Inactive", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "trafficViewEnrollmentStatus": "Disabled", + "maxReturn": 2, + "endpoints": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-NoEndpoints.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-NoEndpoints.json new file mode 100644 index 000000000000..191dc9d22cca --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-NoEndpoints.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager1421", + "profileName": "azsmnet6386", + "api-version": "2018-04-01", + "parameters": { + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azsmnet6386", + "ttl": 35 + }, + "monitorConfig": { + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx" + } + }, + "location": "global" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386", + "name": "azsmnet6386", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azsmnet6386", + "fqdn": "azsmnet6386.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Inactive", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386", + "name": "azsmnet6386", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azsmnet6386", + "fqdn": "azsmnet6386.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "Inactive", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 30, + "toleratedNumberOfFailures": 3, + "timeoutInSeconds": 10 + }, + "endpoints": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithAliasing.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithAliasing.json new file mode 100644 index 000000000000..83edea520e57 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithAliasing.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2583", + "profileName": "azuresdkfornetautoresttrafficmanager6192", + "api-version": "2018-04-01", + "parameters": { + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "ttl": 35 + }, + "monitorConfig": { + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "timeoutInSeconds": 5, + "toleratedNumberOfFailures": 2 + }, + "allowedEndpointRecordTypes": ["DomainName"], + "endpoints": [ + { + "name": "My external endpoint", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "endpointLocation": "North Europe" + } + } + ] + }, + "location": "global" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "toleratedNumberOfFailures": 2, + "timeoutInSeconds": 5, + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + }, + "allowedEndpointRecordTypes": ["DomainName"], + "endpoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe", + "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + } + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "toleratedNumberOfFailures": 2, + "timeoutInSeconds": 5, + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + }, + "allowedEndpointRecordTypes": ["DomainName"], + "endpoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe", + "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithCustomHeaders.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithCustomHeaders.json new file mode 100644 index 000000000000..ddf877cea9f5 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithCustomHeaders.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2583", + "profileName": "azuresdkfornetautoresttrafficmanager6192", + "api-version": "2018-04-01", + "parameters": { + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "ttl": 35 + }, + "monitorConfig": { + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "timeoutInSeconds": 5, + "toleratedNumberOfFailures": 2, + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}], + "expectedStatusCodeRanges" : [{"min":200, "max":205},{"min":400, "max":410}] + }, + "trafficViewEnrollmentStatus": "Disabled", + "endpoints": [ + { + "name": "My external endpoint", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "endpointLocation": "North Europe", + "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + } + } + ] + }, + "location": "global" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "toleratedNumberOfFailures": 2, + "timeoutInSeconds": 5, + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + }, + "trafficViewEnrollmentStatus": "Disabled", + "endpoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe", + "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + } + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "toleratedNumberOfFailures": 2, + "timeoutInSeconds": 5, + "customHeaders" : [{"name":"header-1", "value":"value-1"},{"name":"header-2", "value":"value-2"}] + }, + "trafficViewEnrollmentStatus": "Disabled", + "endpoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe", + "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithEndpoints.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithEndpoints.json new file mode 100644 index 000000000000..725ceb58ae0c --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithEndpoints.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "azuresdkfornetautoresttrafficmanager2583", + "profileName": "azuresdkfornetautoresttrafficmanager6192", + "api-version": "2018-04-01", + "parameters": { + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "ttl": 35 + }, + "monitorConfig": { + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "timeoutInSeconds": 5, + "toleratedNumberOfFailures": 2 + }, + "endpoints": [ + { + "name": "My external endpoint", + "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints", + "properties": { + "target": "foobar.contoso.com", + "endpointStatus": "Enabled", + "endpointLocation": "North Europe" + } + } + ] + }, + "location": "global" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "toleratedNumberOfFailures": 2, + "timeoutInSeconds": 5 + }, + "endpoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192", + "name": "azuresdkfornetautoresttrafficmanager6192", + "type": "Microsoft.Network/trafficManagerProfiles", + "location": "global", + "properties": { + "profileStatus": "Enabled", + "trafficRoutingMethod": "Performance", + "dnsConfig": { + "relativeName": "azuresdkfornetautoresttrafficmanager6192", + "fqdn": "azuresdkfornetautoresttrafficmanager6192.tmpreview.watmtest.azure-test.net", + "ttl": 35 + }, + "monitorConfig": { + "profileMonitorStatus": "CheckingEndpoints", + "protocol": "HTTP", + "port": 80, + "path": "/testpath.aspx", + "intervalInSeconds": 10, + "toleratedNumberOfFailures": 2, + "timeoutInSeconds": 5 + }, + "endpoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2583/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager6192/externalEndpoints/My external endpoint", + "name": "My external endpoint", + "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", + "properties": { + "endpointStatus": "Enabled", + "endpointMonitorStatus": "CheckingEndpoint", + "target": "foobar.contoso.com", + "weight": 1, + "priority": 1, + "endpointLocation": "North Europe" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/TrafficManagerUserMetricsKeys-DELETE.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/TrafficManagerUserMetricsKeys-DELETE.json new file mode 100644 index 000000000000..5b2257eb820b --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/TrafficManagerUserMetricsKeys-DELETE.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/TrafficManagerUserMetricsKeys-GET.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/TrafficManagerUserMetricsKeys-GET.json new file mode 100644 index 000000000000..8ac2b43365b5 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/TrafficManagerUserMetricsKeys-GET.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Network/trafficManagerUserMetricsKeys/default", + "name": "default", + "type": "Microsoft.Network/trafficManagerUserMetricsKeys", + "properties": { + "key": "9ea056eb38f145a0891b5d5dc15e9aa2" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/TrafficManagerUserMetricsKeys-PUT.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/TrafficManagerUserMetricsKeys-PUT.json new file mode 100644 index 000000000000..13942c7d9a05 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/TrafficManagerUserMetricsKeys-PUT.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-04-01" + }, + "responses": { + "201": { + "body": { + "id": "/providers/Microsoft.Network/trafficManagerUserMetricsKeys/default", + "name": "default", + "type": "Microsoft.Network/trafficManagerUserMetricsKeys", + "properties": { + "key": "9ea056eb38f145a0891b5d5dc15e9aa2" + } + } + } + } +} \ No newline at end of file diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/trafficmanager.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/trafficmanager.json new file mode 100644 index 000000000000..45628d761ef9 --- /dev/null +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/trafficmanager.json @@ -0,0 +1,1581 @@ +{ + "swagger": "2.0", + "info": { + "title": "TrafficManagerManagementClient", + "version": "2018-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}": { + "patch": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Update", + "description": "Update a Traffic Manager endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager endpoint to be updated." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "endpointType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of the Traffic Manager endpoint to be updated." + }, + { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager endpoint to be updated." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "description": "The Traffic Manager endpoint parameters supplied to the Update operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The updated Traffic Manager endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Endpoint-PATCH-External-Target": { + "$ref": "./examples/Endpoint-PATCH-External-Target.json" + } + } + }, + "get": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Get", + "description": "Gets a Traffic Manager endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager endpoint." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "endpointType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of the Traffic Manager endpoint." + }, + { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager endpoint." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Endpoint-GET-External-WithGeoMapping": { + "$ref": "./examples/Endpoint-GET-External-WithGeoMapping.json" + }, + "Endpoint-GET-External-WithLocation": { + "$ref": "./examples/Endpoint-GET-External-WithLocation.json" + }, + "Endpoint-GET-External-WithSubnetMapping": { + "$ref": "./examples/Endpoint-GET-External-WithSubnetMapping.json" + } + } + }, + "put": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_CreateOrUpdate", + "description": "Create or update a Traffic Manager endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager endpoint to be created or updated." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "endpointType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of the Traffic Manager endpoint to be created or updated." + }, + { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager endpoint to be created or updated." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + }, + "description": "The Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The created or updated Endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "201": { + "description": "The created or updated Endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Endpoint-PUT-External-WithGeoMapping": { + "$ref": "./examples/Endpoint-PUT-External-WithGeoMapping.json" + }, + "Endpoint-PUT-External-WithLocation": { + "$ref": "./examples/Endpoint-PUT-External-WithLocation.json" + }, + "Endpoint-PUT-External-WithSubnetMapping": { + "$ref": "./examples/Endpoint-PUT-External-WithSubnetMapping.json" + }, + "Endpoint-PUT-External-WithCustomHeaders": { + "$ref": "./examples/Endpoint-PUT-External-WithCustomHeaders.json" + } + } + }, + "delete": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Delete", + "description": "Deletes a Traffic Manager endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager endpoint to be deleted." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "endpointType", + "in": "path", + "required": true, + "type": "string", + "description": "The type of the Traffic Manager endpoint to be deleted." + }, + { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager endpoint to be deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager Endpoint was deleted successfully.", + "schema": { + "$ref": "#/definitions/DeleteOperationResult" + } + }, + "204": { + "description": "The Traffic Manager Endpoint does not exist. It could have been deleted on a previous request." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Endpoint-DELETE-External": { + "$ref": "./examples/Endpoint-DELETE-External.json" + } + } + } + }, + "/providers/Microsoft.Network/checkTrafficManagerNameAvailability": { + "post": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_CheckTrafficManagerRelativeDnsNameAvailability", + "description": "Checks the availability of a Traffic Manager Relative DNS name.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckTrafficManagerRelativeDnsNameAvailabilityParameters" + }, + "description": "The Traffic Manager name parameters supplied to the CheckTrafficManagerNameAvailability operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager Name Availability.", + "schema": { + "$ref": "#/definitions/TrafficManagerNameAvailability" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NameAvailabilityTest_NameAvailablePOST21": { + "$ref": "./examples/NameAvailabilityTest_NameAvailable-POST-example-21.json" + }, + "NameAvailabilityTest_NameNotAvailablePOST23": { + "$ref": "./examples/NameAvailabilityTest_NameNotAvailable-POST-example-23.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles": { + "get": { + "tags": [ + "Profiles" + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "operationId": "Profiles_ListByResourceGroup", + "description": "Lists all Traffic Manager profiles within a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profiles to be listed." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The list of Traffic Manager profiles.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListProfilesByResourceGroup": { + "$ref": "./examples/Profile-GET-ByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficmanagerprofiles": { + "get": { + "tags": [ + "Profiles" + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "operationId": "Profiles_ListBySubscription", + "description": "Lists all Traffic Manager profiles within a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The list of Traffic Manager profiles.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListBySubscription": { + "$ref": "./examples/Profile-GET-BySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}": { + "get": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_Get", + "description": "Gets a Traffic Manager profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profile." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Profile-GET-WithEndpoints": { + "$ref": "./examples/Profile-GET-WithEndpoints.json" + } + } + }, + "put": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_CreateOrUpdate", + "description": "Create or update a Traffic Manager profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profile." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Profile" + }, + "description": "The Traffic Manager profile parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The created or updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "201": { + "description": "The created or updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Profile-PUT-NoEndpoints": { + "$ref": "./examples/Profile-PUT-NoEndpoints.json" + }, + "Profile-PUT-WithEndpoints": { + "$ref": "./examples/Profile-PUT-WithEndpoints.json" + }, + "Profile-PUT-WithCustomHeaders": { + "$ref": "./examples/Profile-PUT-WithCustomHeaders.json" + } + } + }, + "delete": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_Delete", + "description": "Deletes a Traffic Manager profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profile to be deleted." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile to be deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager Profile was deleted successfully.", + "schema": { + "$ref": "#/definitions/DeleteOperationResult" + } + }, + "204": { + "description": "The profile does not exist. It could have been deleted on a previous request." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Profile-DELETE": { + "$ref": "./examples/Profile-DELETE.json" + } + } + }, + "patch": { + "tags": [ + "Profiles" + ], + "operationId": "Profiles_Update", + "description": "Update a Traffic Manager profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager profile." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Profile" + }, + "description": "The Traffic Manager profile parameters supplied to the Update operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Profile-PATCH-MonitorConfig": { + "$ref": "./examples/Profile-PATCH-MonitorConfig.json" + } + } + } + }, + "/providers/Microsoft.Network/trafficManagerGeographicHierarchies/default": { + "get": { + "tags": [ + "GeographicHierarchies" + ], + "operationId": "GeographicHierarchies_GetDefault", + "description": "Gets the default Geographic Hierarchy used by the Geographic traffic routing method.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The default Geographic Hierarchy.", + "schema": { + "$ref": "#/definitions/TrafficManagerGeographicHierarchy" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GeographicHierarchy-GET-default": { + "$ref": "./examples/GeographicHierarchy-GET-default.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/heatMaps/{heatMapType}": { + "get": { + "tags": [ + "HeatMaps" + ], + "operationId": "HeatMap_Get", + "description": "Gets latest heatmap for Traffic Manager profile.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the Traffic Manager endpoint." + }, + { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Traffic Manager profile." + }, + { + "name": "heatMapType", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "description": "The type of HeatMap for the Traffic Manager profile." + }, + { + "name": "topLeft", + "in": "query", + "required": false, + "allowEmptyValue": true, + "description": "The top left latitude,longitude pair of the rectangular viewport to query for.", + "type": "array", + "minItems": 2, + "maxItems": 2, + "collectionFormat": "csv", + "items": { + "type": "number", + "format": "double" + } + }, + { + "name": "botRight", + "in": "query", + "required": false, + "allowEmptyValue": true, + "description": "The bottom right latitude,longitude pair of the rectangular viewport to query for.", + "type": "array", + "minItems": 2, + "maxItems": 2, + "collectionFormat": "csv", + "items": { + "type": "number", + "format": "double" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager heatmap.", + "schema": { + "$ref": "#/definitions/HeatMapModel" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "HeatMap-GET": { + "$ref": "./examples/HeatMap-GET.json" + }, + "HeatMap-GET-With-TopLeft-BotRight": { + "$ref": "./examples/HeatMap-GET-With-TopLeft-BotRight.json" + }, + "HeatMap-GET-With-Null-Values": { + "$ref": "./examples/HeatMap-GET-With-Null-Values.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/trafficManagerUserMetricsKeys/default": { + "get": { + "tags": [ + "RealUserMetrics" + ], + "operationId": "TrafficManagerUserMetricsKeys_Get", + "description": "Get the subscription-level key used for Real User Metrics collection.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The subscription-level Traffic Manager Real User Metrics key.", + "schema": { + "$ref": "#/definitions/UserMetricsModel" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "TrafficManagerUserMetricsKeys-GET": { + "$ref": "./examples/TrafficManagerUserMetricsKeys-GET.json" + } + } + }, + "put": { + "tags": [ + "RealUserMetrics" + ], + "operationId": "TrafficManagerUserMetricsKeys_CreateOrUpdate", + "description": "Create or update a subscription-level key used for Real User Metrics collection.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "A new subscription-level key has been created for Real User Metrics collection.", + "schema": { + "$ref": "#/definitions/UserMetricsModel" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "TrafficManagerUserMetricsKeys-PUT": { + "$ref": "./examples/TrafficManagerUserMetricsKeys-PUT.json" + } + } + }, + "delete": { + "tags": [ + "RealUserMetrics" + ], + "operationId": "TrafficManagerUserMetricsKeys_Delete", + "description": "Delete a subscription-level key used for Real User Metrics collection.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Traffic Manager Real User Metrics key was deleted successfully.", + "schema": { + "$ref": "#/definitions/DeleteOperationResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "TrafficManagerUserMetricsKeys-DELETE": { + "$ref": "./examples/TrafficManagerUserMetricsKeys-DELETE.json" + } + } + } + } + }, + "definitions": { + "DeleteOperationResult": { + "properties": { + "boolean": { + "type": "boolean", + "x-ms-client-name": "operationResult", + "readOnly": true, + "description": "The result of the operation or request." + } + }, + "description": "The result of the request or operation." + }, + "EndpointProperties": { + "properties": { + "targetResourceId": { + "type": "string", + "description": "The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'." + }, + "target": { + "type": "string", + "description": "The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint." + }, + "endpointStatus": { + "type": "string", + "description": "The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EndpointStatus", + "modelAsString": true + } + }, + "weight": { + "type": "integer", + "format": "int64", + "description": "The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000." + }, + "priority": { + "type": "integer", + "format": "int64", + "description": "The priority of this endpoint when using the 'Priority' traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value." + }, + "endpointLocation": { + "type": "string", + "description": "Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method." + }, + "endpointMonitorStatus": { + "type": "string", + "description": "The monitoring status of the endpoint.", + "enum": [ + "CheckingEndpoint", + "Online", + "Degraded", + "Disabled", + "Inactive", + "Stopped" + ], + "x-ms-enum": { + "name": "EndpointMonitorStatus", + "modelAsString": true + } + }, + "minChildEndpoints": { + "type": "integer", + "format": "int64", + "description": "The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'." + }, + "geoMapping": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values." + }, + "subnets": { + "type": "array", + "items": { + "type": "object", + "properties": { + "first": { + "type": "string", + "description": "First address in the subnet." + }, + "last": { + "type": "string", + "description": "Last address in the subnet." + }, + "scope": { + "type": "integer", + "description": "Block size (number of leading bits in the subnet mask)." + } + }, + "description": "Subnet first address, scope, and/or last address." + }, + "description": "The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the 'Subnet' traffic routing method. An empty list will match all ranges not covered by other endpoints." + }, + "customHeaders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Header name." + }, + "value": { + "type": "string", + "description": "Header value." + } + }, + "description": "Custom header name and value." + }, + "description": "List of custom headers." + } + }, + "description": "Class representing a Traffic Manager endpoint properties." + }, + "HeatMapModel": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HeatMapProperties", + "description": "The properties of the Traffic Manager HeatMap." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Class representing a Traffic Manager HeatMap." + }, + "UserMetricsModel": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserMetricsProperties", + "description": "The properties of the Traffic Manager User Metrics." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Class representing Traffic Manager User Metrics." + }, + "QueryExperience": { + "properties": { + "endpointId": { + "type": "integer", + "description": "The id of the endpoint from the 'endpoints' array which these queries were routed to." + }, + "queryCount": { + "type": "integer", + "description": "The number of queries originating from this location." + }, + "latency": { + "type": "number", + "format": "double", + "description": "The latency experienced by queries originating from this location." + } + }, + "required": [ + "endpointId", + "queryCount" + ], + "description": "Class representing a Traffic Manager HeatMap query experience properties." + }, + "TrafficFlow": { + "properties": { + "sourceIp": { + "type": "string", + "description": "The IP address that this query experience originated from." + }, + "latitude": { + "type": "number", + "format": "double", + "description": "The approximate latitude that these queries originated from." + }, + "longitude": { + "type": "number", + "format": "double", + "description": "The approximate longitude that these queries originated from." + }, + "queryExperiences": { + "type": "array", + "description": "The query experiences produced in this HeatMap calculation.", + "items": { + "$ref": "#/definitions/QueryExperience" + } + } + }, + "description": "Class representing a Traffic Manager HeatMap traffic flow properties." + }, + "HeatMapProperties": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The beginning of the time window for this HeatMap, inclusive." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The ending of the time window for this HeatMap, exclusive." + }, + "endpoints": { + "type": "array", + "description": "The endpoints used in this HeatMap calculation.", + "items": { + "$ref": "#/definitions/HeatMapEndpoint" + } + }, + "trafficFlows": { + "type": "array", + "description": "The traffic flows produced in this HeatMap calculation.", + "items": { + "$ref": "#/definitions/TrafficFlow" + } + } + }, + "description": "Class representing a Traffic Manager HeatMap properties." + }, + "HeatMapEndpoint": { + "properties": { + "resourceId": { + "type": "string", + "description": "The ARM Resource ID of this Traffic Manager endpoint." + }, + "endpointId": { + "type": "integer", + "description": "A number uniquely identifying this endpoint in query experiences." + } + }, + "description": "Class which is a sparse representation of a Traffic Manager endpoint." + }, + "Endpoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EndpointProperties", + "description": "The properties of the Traffic Manager endpoint." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Class representing a Traffic Manager endpoint." + }, + "CheckTrafficManagerRelativeDnsNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "type": { + "type": "string", + "description": "The type of the resource." + } + }, + "description": "Parameters supplied to check Traffic Manager name operation." + }, + "DnsConfig": { + "properties": { + "relativeName": { + "type": "string", + "description": "The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile." + }, + "fqdn": { + "type": "string", + "readOnly": true, + "description": "The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager." + }, + "ttl": { + "type": "integer", + "format": "int64", + "description": "The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile." + } + }, + "description": "Class containing DNS settings in a Traffic Manager profile." + }, + "MonitorConfig": { + "properties": { + "profileMonitorStatus": { + "type": "string", + "description": "The profile-level monitoring status of the Traffic Manager profile.", + "enum": [ + "CheckingEndpoints", + "Online", + "Degraded", + "Disabled", + "Inactive" + ], + "x-ms-enum": { + "name": "ProfileMonitorStatus", + "modelAsString": true + } + }, + "protocol": { + "type": "string", + "description": "The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.", + "enum": [ + "HTTP", + "HTTPS", + "TCP" + ], + "x-ms-enum": { + "name": "MonitorProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int64", + "description": "The TCP port used to probe for endpoint health." + }, + "path": { + "type": "string", + "description": "The path relative to the endpoint domain name used to probe for endpoint health." + }, + "intervalInSeconds": { + "type": "integer", + "format": "int64", + "description": "The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile." + }, + "timeoutInSeconds": { + "type": "integer", + "format": "int64", + "description": "The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check." + }, + "toleratedNumberOfFailures": { + "type": "integer", + "format": "int64", + "description": "The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check." + }, + "customHeaders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Header name." + }, + "value": { + "type": "string", + "description": "Header value." + } + }, + "description": "Custom header name and value." + }, + "description": "List of custom headers." + }, + "expectedStatusCodeRanges": { + "type": "array", + "items": { + "type": "object", + "properties": { + "min": { + "type": "integer", + "description": "Min status code." + }, + "max": { + "type": "integer", + "description": "Max status code." + } + }, + "description": "Min and max value of a status code range." + }, + "description": "List of expected status code ranges." + } + }, + "description": "Class containing endpoint monitoring settings in a Traffic Manager profile." + }, + "ProfileProperties": { + "properties": { + "profileStatus": { + "type": "string", + "description": "The status of the Traffic Manager profile.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ProfileStatus", + "modelAsString": true + } + }, + "trafficRoutingMethod": { + "type": "string", + "description": "The traffic routing method of the Traffic Manager profile.", + "enum": [ + "Performance", + "Priority", + "Weighted", + "Geographic", + "MultiValue", + "Subnet" + ], + "x-ms-enum": { + "name": "TrafficRoutingMethod", + "modelAsString": true + } + }, + "dnsConfig": { + "$ref": "#/definitions/DnsConfig", + "description": "The DNS settings of the Traffic Manager profile." + }, + "monitorConfig": { + "$ref": "#/definitions/MonitorConfig", + "description": "The endpoint monitoring settings of the Traffic Manager profile." + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/Endpoint" + }, + "description": "The list of endpoints in the Traffic Manager profile." + }, + "trafficViewEnrollmentStatus": { + "type": "string", + "description": "Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "TrafficViewEnrollmentStatus", + "modelAsString": true + } + }, + "maxReturn": { + "type": "integer", + "description": "Maximum number of endpoints to be returned for MultiValue routing type.", + "format": "int64" + } + }, + "description": "Class representing the Traffic Manager profile properties." + }, + "Profile": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProfileProperties", + "description": "The properties of the Traffic Manager profile." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "Class representing a Traffic Manager profile." + }, + "ProfileListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Profile" + }, + "description": "Gets the list of Traffic manager profiles." + } + }, + "description": "The list Traffic Manager profiles operation response." + }, + "TrafficManagerNameAvailability": { + "properties": { + "name": { + "type": "string", + "description": "The relative name." + }, + "type": { + "type": "string", + "description": "Traffic Manager profile resource type." + }, + "nameAvailable": { + "type": "boolean", + "description": "Describes whether the relative name is available or not." + }, + "reason": { + "type": "string", + "description": "The reason why the name is not available, when applicable." + }, + "message": { + "type": "string", + "description": "Descriptive message that explains why the name is not available, when applicable." + } + }, + "description": "Class representing a Traffic Manager Name Availability response." + }, + "Region": { + "properties": { + "code": { + "type": "string", + "description": "The code of the region" + }, + "name": { + "type": "string", + "description": "The name of the region" + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/Region" + }, + "description": "The list of Regions grouped under this Region in the Geographic Hierarchy." + } + }, + "description": "Class representing a region in the Geographic hierarchy used with the Geographic traffic routing method." + }, + "GeographicHierarchyProperties": { + "properties": { + "geographicHierarchy": { + "$ref": "#/definitions/Region", + "description": "The region at the root of the hierarchy from all the regions in the hierarchy can be retrieved." + } + }, + "description": "Class representing the properties of the Geographic hierarchy used with the Geographic traffic routing method." + }, + "TrafficManagerGeographicHierarchy": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GeographicHierarchyProperties", + "description": "The properties of the Geographic Hierarchy resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Class representing the Geographic hierarchy used with the Geographic traffic routing method." + }, + "UserMetricsProperties": { + "properties": { + "key": { + "type" : "string", + "description": "The key returned by the User Metrics operation." + } + }, + "description": "Class representing a Traffic Manager Real User Metrics key response." + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of the resource. Ex- Microsoft.Network/trafficmanagerProfiles." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region where the resource lives" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "CloudError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "The content of the error." + } + }, + "description": "An error returned by the Azure Resource Manager", + "x-ms-external": true + }, + "CloudErrorBody": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error code" + }, + "message": { + "type": "string", + "description": "Error message" + }, + "target": { + "type": "string", + "description": "Error target" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "Error details" + } + }, + "description": "The content of an error returned by the Azure Resource Manager", + "x-ms-external": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + }, + "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/trafficmanager/resource-manager/readme.md b/specification/trafficmanager/resource-manager/readme.md index 8a655a4ae603..70071e96b8dc 100644 --- a/specification/trafficmanager/resource-manager/readme.md +++ b/specification/trafficmanager/resource-manager/readme.md @@ -25,9 +25,85 @@ These are the global settings for the TrafficManager API. ``` yaml openapi-type: arm -tag: package-2017-09-preview +tag: package-2018-04 ``` +## Suppression +``` yaml +directive: + - suppress: OperationsAPIImplementation + reason: We do have a operations api as "/providers/Microsoft.Network/operations" + from: trafficmanager.json + where: $.paths + - suppress: RequiredPropertiesMissingInResourceModel + reason: This will cause breaking changes in .NET SDK + from: trafficmanager.json + where: $.definitions.HeatMapModel + - suppress: RequiredPropertiesMissingInResourceModel + reason: This will cause breaking changes in .NET SDK + from: trafficmanager.json + where: $.definitions.TrafficManagerGeographicHierarchy + - suppress: RequiredPropertiesMissingInResourceModel + reason: This will cause breaking changes in .NET SDK + from: trafficmanager.json + where: $.definitions.Profile + - suppress: RequiredPropertiesMissingInResourceModel + reason: This will cause breaking changes in .NET SDK + from: trafficmanager.json + where: $.definitions.Endpoint +``` + +### Tag: package-2018-04 + +These settings apply only when `--tag=package-2018-04` is specified on the command line. + +``` yaml $(tag) == 'package-2018-04' +input-file: +- Microsoft.Network/stable/2018-04-01/trafficmanager.json +``` + +### Tag: package-2018-03 + +These settings apply only when `--tag=package-2018-03` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03' +input-file: +- Microsoft.Network/stable/2018-03-01/trafficmanager.json +``` + +### Tag: package-2018-02 + +These settings apply only when `--tag=package-2018-02` is specified on the command line. + +``` yaml $(tag) == 'package-2018-02' +input-file: +- Microsoft.Network/stable/2018-02-01/trafficmanager.json +- Microsoft.Network/preview/2017-09-01-preview/trafficmanageranalytics.json + +# Needed when there is more than one input file +override-info: + title: TrafficManagerManagementClient + +directive: + - suppress: R3023 + reason: it's implemented in the main network spec + approved-by: "@fearthecowboy" + + - where: $.paths["/providers/Microsoft.Network/checkTrafficManagerNameAvailability"].post.operationId + suppress: R2066 + reason: the name does include it. + approved-by: "@fearthecowboy" + + - suppress: R3018 + reason: Existing API; can't change. + approved-by: "@fearthecowboy" + + - where: $.definitions.TrafficManagerUserMetricsKeyModel.properties + suppress: R3006 + reason: Existing API; can't change without breaking API. Will consider in future API version + approved-by: "@fearthecowboy" + +``` ### Tag: package-2017-09-preview These settings apply only when `--tag=package-2017-09-preview` is specified on the command line. @@ -42,6 +118,15 @@ override-info: title: TrafficManagerManagementClient ``` +### Tag: package-2017-09-preview-only + +These settings apply only when `--tag=package-2017-09-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-09-preview-only' +input-file: +- Microsoft.Network/preview/2017-09-01-preview/trafficmanageranalytics.json +``` + ### Tag: package-2017-05 @@ -87,6 +172,9 @@ swagger-to-sdk: - repo: azure-libraries-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_traffic_manager'] ``` @@ -150,19 +238,39 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-03 + - tag: package-2018-02 - tag: package-2017-09-preview - tag: package-2017-05 - tag: package-2017-03 - tag: package-2015-11 ``` +### Tag: package-2018-03 and go + +These settings apply only when `--tag=package-2018-03 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-03' && $(go) +output-folder: $(go-sdk-folder)/services/trafficmanager/mgmt/2018-03-01/trafficmanager +``` + +### Tag: package-2018-02 and go + +These settings apply only when `--tag=package-2018-02 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-02' && $(go) +output-folder: $(go-sdk-folder)/services/trafficmanager/mgmt/2018-02-01/trafficmanager +``` + ### Tag: package-2017-09-preview and go These settings apply only when `--tag=package-2017-09-preview --go` is specified on the command line. Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-09-preview' && $(go) -output-folder: $(go-sdk-folder)/services/trafficmanager/mgmt/2017-09-01-preview/trafficmanager +output-folder: $(go-sdk-folder)/services/preview/trafficmanager/mgmt/2017-09-01-preview/trafficmanager ``` ### Tag: package-2017-05 and go diff --git a/specification/trafficmanager/resource-manager/readme.ruby.md b/specification/trafficmanager/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..a4a78464fad0 --- /dev/null +++ b/specification/trafficmanager/resource-manager/readme.ruby.md @@ -0,0 +1,82 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml $(ruby) +ruby: + package-name: azure_mgmt_traffic_manager + package-version: "0.16.0" + azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2015-11 + - tag: package-2017-03 + - tag: package-2017-05 + - tag: package-2017-09-preview-only + - tag: package-2018-03 + - tag: package-2018-04 +``` + +### Tag: package-2015-11 and ruby + +These settings apply only when `--tag=package-2015-11 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-11' && $(ruby) +namespace: "Azure::TrafficManager::Mgmt::V2015_11_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_traffic_manager/lib +``` + +### Tag: package-2017-03 and ruby + +These settings apply only when `--tag=package-2017-03 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-03' && $(ruby) +namespace: "Azure::TrafficManager::Mgmt::V2017_03_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_traffic_manager/lib +``` + +### Tag: package-2017-05 and ruby + +These settings apply only when `--tag=package-2017-05 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-05' && $(ruby) +namespace: "Azure::TrafficManager::Mgmt::V2017_05_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_traffic_manager/lib +``` + +### Tag: package-2017-09-preview-only and ruby + +These settings apply only when `--tag=package-2017-09-preview-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-09-preview-only' && $(ruby) +namespace: "Azure::TrafficManager::Mgmt::V2017_09_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_traffic_manager/lib +``` + +### Tag: package-2018-03 and ruby + +These settings apply only when `--tag=package-2018-03 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-03' && $(ruby) +namespace: "Azure::TrafficManager::Mgmt::V2018_03_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_traffic_manager/lib +``` + +### Tag: package-2018-04 and ruby + +These settings apply only when `--tag=package-2018-04 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-04' && $(ruby) +namespace: "Azure::TrafficManager::Mgmt::V2018_04_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_traffic_manager/lib +``` diff --git a/specification/visualstudio/resource-manager/readme.md b/specification/visualstudio/resource-manager/readme.md index a04441e5426c..e0108e25ff9a 100644 --- a/specification/visualstudio/resource-manager/readme.md +++ b/specification/visualstudio/resource-manager/readme.md @@ -86,7 +86,7 @@ These settings apply only when `--tag=package-2014-04-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2014-04-preview' && $(go) -output-folder: $(go-sdk-folder)/services/visualstudio/mgmt/2014-04-01-preview/visualstudio +output-folder: $(go-sdk-folder)/services/preview/visualstudio/mgmt/2014-04-01-preview/visualstudio ``` @@ -96,11 +96,32 @@ 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 - fluent: true - namespace: com.microsoft.azure.management.visualstudio - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-visualstudio +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.visualstudio +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-visualstudio ``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2014-04-preview +``` + +### Tag: package-2014-04-preview and java + +These settings apply only when `--tag=package-2014-04-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2014-04-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.visualstudio.v2014_04_01_preview + output-folder: $(azure-libraries-for-java-folder)/visualstudio/resource-manager/v2014_04_01_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2016-08-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2016-08-01/WebApps.json index 9827df74b640..3d0cfa40301a 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2016-08-01/WebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2016-08-01/WebApps.json @@ -12320,10 +12320,23 @@ ], "responses": { "200": { - "description": "OK", + "description": "Successfully retrieved source control for web app.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "201": { + "description": "Create or update source control for web app still in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "202": { + "description": "Create or update source control for web app still in progress.", "schema": { "$ref": "#/definitions/SiteSourceControl" } + } } }, @@ -12370,7 +12383,7 @@ ], "responses": { "200": { - "description": "Succesfully created or updated source control for web app.", + "description": "Successfully created or updated source control for web app.", "schema": { "$ref": "#/definitions/SiteSourceControl" } @@ -12380,6 +12393,12 @@ "schema": { "$ref": "#/definitions/SiteSourceControl" } + }, + "202": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } } }, "x-ms-long-running-operation": true @@ -13714,10 +13733,23 @@ ], "responses": { "200": { - "description": "OK", + "description": "Successfully retrieved source control for web app.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "201": { + "description": "Create or update source control for web app still in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "202": { + "description": "Create or update source control for web app still in progress.", "schema": { "$ref": "#/definitions/SiteSourceControl" } + } } }, @@ -13757,7 +13789,7 @@ ], "responses": { "200": { - "description": "Succesfully created or updated source control for web app.", + "description": "Successfully created or updated source control for web app.", "schema": { "$ref": "#/definitions/SiteSourceControl" } @@ -13767,6 +13799,12 @@ "schema": { "$ref": "#/definitions/SiteSourceControl" } + }, + "202": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } } }, "x-ms-long-running-operation": true diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json b/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json index 52dd66a25f7a..6311b8eb9e0a 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json @@ -762,7 +762,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}metrics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics": { "get": { "tags": [ "AppServiceEnvironments" @@ -1570,7 +1570,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}metrics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics": { "get": { "tags": [ "AppServiceEnvironments" diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json index 63650ff43676..adb582f7623b 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json @@ -895,7 +895,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}metrics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics": { "get": { "tags": [ "AppServiceEnvironments" @@ -1451,42 +1451,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/syncVirtualNetwork": { - "post": { - "tags": [ - "AppServiceEnvironments" - ], - "summary": "Resume an App Service Environment.", - "description": "Resume an App Service Environment.", - "operationId": "AppServiceEnvironments_SyncVirtualNetworkInfo", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "Name of the App Service Environment.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "202": { - "description": "Operation is in progress." - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages": { "get": { "tags": [ @@ -1823,7 +1787,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}metrics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics": { "get": { "tags": [ "AppServiceEnvironments" diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServicePlans.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServicePlans.json index 26cab9c72a32..a0202f529f26 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServicePlans.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServicePlans.json @@ -1571,6 +1571,11 @@ "description": "The time when the server farm expires. Valid only if it is a spot server farm.", "type": "string" }, + "freeOfferExpirationTime": { + "format": "date-time", + "description": "The time when the server farm free offer expires.", + "type": "string" + }, "resourceGroup": { "description": "Resource group of the App Service plan.", "type": "string", diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json index f4e95315068d..49ade60347df 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json @@ -254,6 +254,14 @@ "hasLinuxWorkers": { "description": "Flag that displays whether an ASE has linux workers or not", "type": "boolean" + }, + "sslCertKeyVaultId": { + "description": "Key Vault ID for ILB App Service Environment default SSL certificate", + "type": "string" + }, + "sslCertKeyVaultSecretName": { + "description": "Key Vault Secret Name for ILB App Service Environment default SSL certificate", + "type": "string" } } }, @@ -335,6 +343,11 @@ "description": "The time when the server farm expires. Valid only if it is a spot server farm.", "type": "string" }, + "freeOfferExpirationTime": { + "format": "date-time", + "description": "The time when the server farm free offer expires.", + "type": "string" + }, "resourceGroup": { "description": "Resource group of the App Service plan.", "type": "string", @@ -787,6 +800,43 @@ } } }, + "DeletedSite": { + "description": "A deleted app.", + "type": "object", + "properties": { + "deletedSiteId": { + "format": "int32", + "description": "Numeric id for the deleted site", + "type": "integer", + "readOnly": true + }, + "deletedTimestamp": { + "description": "Time in UTC when the app was deleted.", + "type": "string", + "readOnly": true + }, + "subscription": { + "description": "Subscription containing the deleted site", + "type": "string", + "readOnly": true + }, + "resourceGroup": { + "description": "ResourceGroup that contained the deleted site", + "type": "string", + "readOnly": true + }, + "deletedSiteName": { + "description": "Name of the deleted site", + "type": "string", + "readOnly": true + }, + "slot": { + "description": "Slot of the deleted site", + "type": "string", + "readOnly": true + } + } + }, "Dimension": { "description": "Dimension of a resource metric. For e.g. instance specific HTTP requests for a web app, \nwhere instance name is dimension of the metric HTTP request", "type": "object", @@ -1074,12 +1124,41 @@ "type": "object", "properties": { "ipAddress": { - "description": "IP address the security restriction is valid for.", + "description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.", "type": "string" }, "subnetMask": { "description": "Subnet mask for the range of IP addresses the restriction is valid for.", "type": "string" + }, + "action": { + "description": "Allow or Deny access for this IP range.", + "type": "string" + }, + "tag": { + "description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.", + "enum": [ + "Default", + "XffProxy" + ], + "type": "string", + "x-ms-enum": { + "name": "IpFilterTag", + "modelAsString": false + } + }, + "priority": { + "format": "int32", + "description": "Priority of IP restriction rule.", + "type": "integer" + }, + "name": { + "description": "IP restriction rule name.", + "type": "string" + }, + "description": { + "description": "IP restriction rule description.", + "type": "string" } } }, @@ -1097,6 +1176,21 @@ } } }, + "LogSpecification": { + "description": "Log Definition of a single resource metric.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "blobDuration": { + "type": "string" + } + } + }, "ManagedServiceIdentity": { "description": "Managed service identity.", "type": "object", @@ -1725,6 +1819,12 @@ "items": { "$ref": "#/definitions/MetricSpecification" } + }, + "logSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } } } }, @@ -1913,13 +2013,6 @@ "create" ] }, - "snapshotInfo": { - "$ref": "#/definitions/SnapshotRecoveryRequest", - "description": "If specified during app creation, the app is created from a previous snapshot.", - "x-ms-mutability": [ - "create" - ] - }, "resourceGroup": { "description": "Name of the resource group the app belongs to. Read-only.", "type": "string", @@ -1989,7 +2082,7 @@ "description": "Linux App Framework and version", "type": "string" }, - "xenonFxVersion": { + "windowsFxVersion": { "description": "Xenon App Framework and version", "type": "string" }, @@ -2225,6 +2318,26 @@ "name": "SupportedTlsVersions", "modelAsString": true } + }, + "ftpsState": { + "description": "State of FTP / FTPS service", + "enum": [ + "AllAllowed", + "FtpsOnly", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "FtpsState", + "modelAsString": true + } + }, + "reservedInstanceCount": { + "format": "int32", + "description": "Number of reserved instances.\nThis setting only applies to the Consumption Plan", + "maximum": 10, + "minimum": 0, + "type": "integer" } } }, @@ -2382,8 +2495,8 @@ } } }, - "SnapshotRecoveryRequest": { - "description": "Details about app recovery operation.", + "Snapshot": { + "description": "A snapshot of an app.", "type": "object", "allOf": [ { @@ -2392,50 +2505,18 @@ ], "properties": { "properties": { - "description": "SnapshotRecoveryRequest resource specific properties", - "required": [ - "overwrite" - ], + "description": "Snapshot resource specific properties", "properties": { - "snapshotTime": { - "description": "Point in time in which the app recovery should be attempted, formatted as a DateTime string.", - "type": "string" - }, - "recoveryTarget": { - "$ref": "#/definitions/SnapshotRecoveryTarget", - "description": "Specifies the web app that snapshot contents will be written to." - }, - "overwrite": { - "description": "If true the recovery operation can overwrite source app; otherwise, false.", - "type": "boolean" - }, - "recoverConfiguration": { - "description": "If true, site configuration, in addition to content, will be reverted.", - "type": "boolean" - }, - "ignoreConflictingHostNames": { - "description": "If true, custom hostname conflicts will be ignored when recovering to a target web app.\nThis setting is only necessary when RecoverConfiguration is enabled.", - "type": "boolean" + "time": { + "description": "The time the snapshot was taken.", + "type": "string", + "readOnly": true } }, "x-ms-client-flatten": true } } }, - "SnapshotRecoveryTarget": { - "description": "Specifies the web app that snapshot contents will be written to.", - "type": "object", - "properties": { - "location": { - "description": "Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS", - "type": "string" - }, - "id": { - "description": "ARM resource ID of the target app. \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.", - "type": "string" - } - } - }, "StampCapacity": { "description": "Stamp capacity information.", "type": "object", @@ -2874,4 +2955,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/DeletedWebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/DeletedWebApps.json index 07c4ada89a33..6e3ffb106287 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/DeletedWebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/DeletedWebApps.json @@ -52,42 +52,6 @@ } }, "definitions": { - "DeletedSite": { - "description": "A deleted app.", - "type": "object", - "properties": { - "deletedSiteId": { - "format": "int32", - "description": "Numeric id for the deleted site", - "type": "integer" - }, - "deletedTimestamp": { - "description": "Time in UTC when the app was deleted.", - "type": "string", - "readOnly": true - }, - "subscription": { - "description": "Subscription containing the deleted site", - "type": "string", - "readOnly": true - }, - "resourceGroup": { - "description": "ResourceGroup that contained the deleted site", - "type": "string", - "readOnly": true - }, - "deletedSiteName": { - "description": "Name of the deleted site", - "type": "string", - "readOnly": true - }, - "slot": { - "description": "Slot of the deleted site", - "type": "string", - "readOnly": true - } - } - }, "DeletedWebAppCollection": { "description": "Collection of deleted apps.", "required": [ @@ -99,7 +63,7 @@ "description": "Collection of resources.", "type": "array", "items": { - "$ref": "#/definitions/DeletedSite" + "$ref": "./CommonDefinitions.json#/definitions/DeletedSite" } }, "nextLink": { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Diagnostics.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Diagnostics.json index b2672f80dc4a..997781c6bbc9 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Diagnostics.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Diagnostics.json @@ -15,6 +15,262 @@ "application/json" ], "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "List Hosting Environment Detector Responses", + "description": "List Hosting Environment Detector Responses", + "operationId": "Diagnostics_ListHostingEnvironmentDetectorResponses", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DetectorResponseCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Service Environment Detector Responses": { + "$ref": "./examples/Diagnostics_ListHostingEnvironmentDetectorResponses.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get Hosting Environment Detector Response", + "description": "Get Hosting Environment Detector Response", + "operationId": "Diagnostics_GetHostingEnvironmentDetectorResponse", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "App Service Environment Name", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "Detector Resource Name", + "required": true, + "type": "string" + }, + { + "name": "startTime", + "in": "query", + "description": "Start Time", + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "End Time", + "type": "string", + "format": "date-time" + }, + { + "name": "timeGrain", + "in": "query", + "description": "Time Grain", + "type": "string", + "pattern": "PT[1-9][0-9]+[SMH]" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DetectorResponse" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Service Environment Detector Responses": { + "$ref": "./examples/Diagnostics_GetHostingEnvironmentDetectorResponse.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "List Site Detector Responses", + "description": "List Site Detector Responses", + "operationId": "Diagnostics_ListSiteDetectorResponses", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DetectorResponseCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Detector Responses": { + "$ref": "./examples/Diagnostics_ListSiteDetectorResponses.json" + }, + "Get App Slot Detector Responses": { + "$ref": "./examples/Diagnostics_ListSiteDetectorResponsesSlot.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors/{detectorName}": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get site detector response", + "description": "Get site detector response", + "operationId": "Diagnostics_GetSiteDetectorResponse", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "Detector Resource Name", + "required": true, + "type": "string" + }, + { + "name": "startTime", + "in": "query", + "description": "Start Time", + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "End Time", + "type": "string", + "format": "date-time" + }, + { + "name": "timeGrain", + "in": "query", + "description": "Time Grain", + "type": "string", + "pattern": "PT[1-9][0-9]+[SMH]" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DetectorResponse" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Detector Response": { + "$ref": "./examples/Diagnostics_GetSiteDetectorResponse.json" + }, + "Get App Slot Detector Response": { + "$ref": "./examples/Diagnostics_GetSiteDetectorResponseSlot.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics": { "get": { "tags": [ @@ -482,6 +738,151 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "List Site Detector Responses", + "description": "List Site Detector Responses", + "operationId": "Diagnostics_ListSiteDetectorResponsesSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Slot Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DetectorResponseCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Detector Responses": { + "$ref": "./examples/Diagnostics_ListSiteDetectorResponses.json" + }, + "Get App Slot Detector Responses": { + "$ref": "./examples/Diagnostics_ListSiteDetectorResponsesSlot.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors/{detectorName}": { + "get": { + "tags": [ + "Diagnostics" + ], + "summary": "Get site detector response", + "description": "Get site detector response", + "operationId": "Diagnostics_GetSiteDetectorResponseSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site Name", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "Detector Resource Name", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Slot Name", + "required": true, + "type": "string" + }, + { + "name": "startTime", + "in": "query", + "description": "Start Time", + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "End Time", + "type": "string", + "format": "date-time" + }, + { + "name": "timeGrain", + "in": "query", + "description": "Time Grain", + "type": "string", + "pattern": "PT[1-9][0-9]+[SMH]" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DetectorResponse" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Detector Response": { + "$ref": "./examples/Diagnostics_GetSiteDetectorResponse.json" + }, + "Get App Slot Detector Response": { + "$ref": "./examples/Diagnostics_GetSiteDetectorResponseSlot.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics": { "get": { "tags": [ @@ -1114,6 +1515,51 @@ } } }, + "DataTableResponseColumn": { + "description": "Column definition", + "type": "object", + "properties": { + "columnName": { + "description": "Name of the column", + "type": "string" + }, + "dataType": { + "description": "Data type which looks like 'String' or 'Int32'.", + "type": "string" + }, + "columnType": { + "description": "Column Type", + "type": "string" + } + } + }, + "DataTableResponseObject": { + "description": "Data Table which defines columns and raw row values", + "type": "object", + "properties": { + "tableName": { + "description": "Name of the table", + "type": "string" + }, + "columns": { + "description": "List of columns with data types", + "type": "array", + "items": { + "$ref": "#/definitions/DataTableResponseColumn" + } + }, + "rows": { + "description": "Raw row values", + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, "DetectorAbnormalTimePeriod": { "description": "Class representing Abnormal Time Period detected.", "type": "object", @@ -1216,6 +1662,81 @@ } } }, + "DetectorInfo": { + "description": "Definition of Detector", + "type": "object", + "properties": { + "description": { + "description": "Short description of the detector and its purpose", + "type": "string", + "readOnly": true + }, + "category": { + "description": "Support Category", + "type": "string", + "readOnly": true + }, + "subCategory": { + "description": "Support Sub Category", + "type": "string", + "readOnly": true + }, + "supportTopicId": { + "description": "Support Topic Id", + "type": "string", + "readOnly": true + } + } + }, + "DetectorResponse": { + "description": "Class representing Response from Detector", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "DetectorResponse resource specific properties", + "properties": { + "metadata": { + "$ref": "#/definitions/DetectorInfo", + "description": "metadata for the detector" + }, + "dataset": { + "description": "Data Set", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticData" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "DetectorResponseCollection": { + "description": "Collection of detector responses", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DetectorResponse" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, "DiagnosticAnalysis": { "description": "Class representing a diagnostic analysis done on an application", "type": "object", @@ -1328,6 +1849,20 @@ } } }, + "DiagnosticData": { + "description": "Set of data with rendering instructions", + "type": "object", + "properties": { + "table": { + "$ref": "#/definitions/DataTableResponseObject", + "description": "Data in table form" + }, + "renderingProperties": { + "$ref": "#/definitions/Rendering", + "description": "Properties that describe how the table should be rendered" + } + } + }, "DiagnosticDetectorCollection": { "description": "Collection of Diagnostic Detectors", "required": [ @@ -1481,6 +2016,34 @@ } } }, + "Rendering": { + "description": "Instructions for rendering the data", + "type": "object", + "properties": { + "type": { + "description": "Rendering Type", + "enum": [ + "NoGraph", + "Table", + "TimeSeries", + "TimeSeriesPerInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "RenderingType", + "modelAsString": false + } + }, + "title": { + "description": "Title of data", + "type": "string" + }, + "description": { + "description": "Description of the data that will help it be interpreted", + "type": "string" + } + } + }, "ResponseMetaData": { "type": "object", "properties": { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json index abf4c4aaf48b..ab298ee5a2d0 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json @@ -188,6 +188,12 @@ "description": "Azure Location of billable resource", "type": "string" }, + { + "name": "osType", + "in": "query", + "description": "App Service OS type meters used for", + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -314,6 +320,12 @@ "description": "Specify true if you want to filter to only regions that support Linux workers.", "type": "boolean" }, + { + "name": "xenonWorkersEnabled", + "in": "query", + "description": "Specify true if you want to filter to only regions that support Xenon workers.", + "type": "boolean" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -623,6 +635,10 @@ "resourceType": { "description": "App Service ResourceType meter used for", "type": "string" + }, + "osType": { + "description": "App Service OS type meter used for", + "type": "string" } }, "x-ms-client-flatten": true @@ -1051,6 +1067,10 @@ "hostingEnvironment": { "description": "Name of App Service Environment where app or App Service plan should be created.", "type": "string" + }, + "isXenon": { + "description": "true if App Service plan is running as a windows container", + "type": "boolean" } } }, diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json index f3cdda303739..0ec3d9f459bc 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json @@ -479,57 +479,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/discover": { - "put": { - "tags": [ - "WebApps" - ], - "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage.", - "description": "Discovers an existing app backup that can be restored from a blob in Azure storage.", - "operationId": "WebApps_DiscoverRestore", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "request", - "in": "body", - "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.", - "required": true, - "schema": { - "$ref": "#/definitions/RestoreRequest" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RestoreRequest" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}": { "get": { "tags": [ @@ -1590,6 +1539,180 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/virtualNetwork": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a Swift Virtual Network connection.", + "description": "Gets a Swift Virtual Network connection.", + "operationId": "WebApps_GetSwiftVirtualNetworkConnection", + "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/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", + "description": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", + "operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a Swift Virtual Network connection from an app (or deployment slot).", + "description": "Deletes a Swift Virtual Network connection from an app (or deployment slot).", + "operationId": "WebApps_DeleteSwiftVirtualNetwork", + "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": "Succesfully deleted virtual network." + }, + "404": { + "description": "Virtual network does not exist." + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", + "description": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", + "operationId": "WebApps_UpdateSwiftVirtualNetworkConnection", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web": { "get": { "tags": [ @@ -2406,6 +2529,57 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/discoverbackup": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", + "description": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", + "operationId": "WebApps_DiscoverBackup", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers": { "get": { "tags": [ @@ -5253,10 +5427,66 @@ "description": "Succesfully deleted premier add-on." } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks": { - "get": { + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Updates a named add-on of an app.", + "description": "Updates a named add-on of an app.", + "operationId": "WebApps_UpdatePremierAddOn", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "description": "Add-on name.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOn", + "in": "body", + "description": "A JSON representation of the edited premier add-on.", + "required": true, + "schema": { + "$ref": "#/definitions/PremierAddOnPatchResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks": { + "get": { "tags": [ "WebApps" ], @@ -6094,6 +6324,52 @@ "x-ms-long-running-operation": true } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Restores a deleted web app to this web app.", + "description": "Restores a deleted web app to this web app.", + "operationId": "WebApps_RestoreFromDeletedApp", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "restoreRequest", + "in": "body", + "description": "Deleted web app restore information.", + "required": true, + "schema": { + "$ref": "#/definitions/DeletedAppRestoreRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Restore operation started." + }, + "200": { + "description": "Restore operation started." + } + }, + "x-ms-long-running-operation": true + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot": { "post": { "tags": [ @@ -6806,64 +7082,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/discover": { - "put": { - "tags": [ - "WebApps" - ], - "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage.", - "description": "Discovers an existing app backup that can be restored from a blob in Azure storage.", - "operationId": "WebApps_DiscoverRestoreSlot", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "name", - "in": "path", - "description": "Name of the app.", - "required": true, - "type": "string" - }, - { - "name": "request", - "in": "body", - "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.", - "required": true, - "schema": { - "$ref": "#/definitions/RestoreRequest" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RestoreRequest" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { "get": { "tags": [ @@ -7980,6 +8198,208 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/virtualNetwork": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a Swift Virtual Network connection.", + "description": "Gets a Swift Virtual Network connection.", + "operationId": "WebApps_GetSwiftVirtualNetworkConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", + "description": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", + "operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Deletes a Swift Virtual Network connection from an app (or deployment slot).", + "description": "Deletes a Swift Virtual Network connection from an app (or deployment slot).", + "operationId": "WebApps_DeleteSwiftVirtualNetworkSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succesfully deleted virtual network." + }, + "404": { + "description": "Virtual network does not exist." + } + } + }, + "patch": { + "tags": [ + "WebApps" + ], + "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.", + "description": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.", + "operationId": "WebApps_UpdateSwiftVirtualNetworkConnectionSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "Properties of the Virtual Network connection. See example.", + "required": true, + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SwiftVirtualNetwork" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": { "get": { "tags": [ @@ -8922,6 +9342,64 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/discoverbackup": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", + "description": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.", + "operationId": "WebApps_DiscoverBackupSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers": { "get": { "tags": [ @@ -11968,19 +12446,73 @@ "required": true, "type": "string" }, - { - "name": "premierAddOn", - "in": "body", - "description": "A JSON representation of the edited premier add-on.", - "required": true, - "schema": { - "$ref": "#/definitions/PremierAddOn" - } - }, + { + "name": "premierAddOn", + "in": "body", + "description": "A JSON representation of the edited premier add-on.", + "required": true, + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WebApps" + ], + "summary": "Delete a premier add-on from an app.", + "description": "Delete a premier add-on from an app.", + "operationId": "WebApps_DeletePremierAddOnSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "description": "Add-on name.", + "required": true, + "type": "string" + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will delete the named add-on for the production slot.", "required": true, "type": "string" }, @@ -11993,26 +12525,17 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PremierAddOn" - } - }, - "default": { - "description": "App Service error response.", - "schema": { - "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" - } + "description": "Succesfully deleted premier add-on." } } }, - "delete": { + "patch": { "tags": [ "WebApps" ], - "summary": "Delete a premier add-on from an app.", - "description": "Delete a premier add-on from an app.", - "operationId": "WebApps_DeletePremierAddOnSlot", + "summary": "Updates a named add-on of an app.", + "description": "Updates a named add-on of an app.", + "operationId": "WebApps_UpdatePremierAddOnSlot", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" @@ -12031,10 +12554,19 @@ "required": true, "type": "string" }, + { + "name": "premierAddOn", + "in": "body", + "description": "A JSON representation of the edited premier add-on.", + "required": true, + "schema": { + "$ref": "#/definitions/PremierAddOnPatchResource" + } + }, { "name": "slot", "in": "path", - "description": "Name of the deployment slot. If a slot is not specified, the API will delete the named add-on for the production slot.", + "description": "Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot.", "required": true, "type": "string" }, @@ -12047,7 +12579,16 @@ ], "responses": { "200": { - "description": "Succesfully deleted premier add-on." + "description": "OK", + "schema": { + "$ref": "#/definitions/PremierAddOn" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } } } } @@ -13017,6 +13558,59 @@ "x-ms-long-running-operation": true } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromDeletedApp": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Restores a deleted web app to this web app.", + "description": "Restores a deleted web app to this web app.", + "operationId": "WebApps_RestoreFromDeletedAppSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app.", + "required": true, + "type": "string" + }, + { + "name": "restoreRequest", + "in": "body", + "description": "Deleted web app restore information.", + "required": true, + "schema": { + "$ref": "#/definitions/DeletedAppRestoreRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Restore operation started." + }, + "200": { + "description": "Restore operation started." + } + }, + "x-ms-long-running-operation": true + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreSnapshot": { "post": { "tags": [ @@ -13479,7 +14073,19 @@ ], "responses": { "200": { - "description": "OK", + "description": "Successfully retrieved source control for web app.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "201": { + "description": "Create or update source control for web app still in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "202": { + "description": "Create or update source control for web app still in progress.", "schema": { "$ref": "#/definitions/SiteSourceControl" } @@ -13535,7 +14141,7 @@ ], "responses": { "200": { - "description": "Succesfully created or updated source control for web app.", + "description": "Successfully created or updated source control for web app.", "schema": { "$ref": "#/definitions/SiteSourceControl" } @@ -13546,6 +14152,12 @@ "$ref": "#/definitions/SiteSourceControl" } }, + "202": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, "default": { "description": "App Service error response.", "schema": { @@ -13589,16 +14201,10 @@ ], "responses": { "200": { - "description": "Succesfully deleted source control for web app.", - "schema": { - "type": "object" - } + "description": "Succesfully deleted source control for web app." }, "202": { - "description": "Source control delete operation in progress.", - "schema": { - "type": "object" - } + "description": "Source control delete operation in progress." }, "404": { "description": "Source control does not exist." @@ -13648,7 +14254,7 @@ ], "responses": { "200": { - "description": "Succesfully created or updated source control for web app.", + "description": "Successfully created or updated source control for web app.", "schema": { "$ref": "#/definitions/SiteSourceControl" } @@ -13659,6 +14265,12 @@ "$ref": "#/definitions/SiteSourceControl" } }, + "202": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, "default": { "description": "App Service error response.", "schema": { @@ -14969,7 +15581,19 @@ ], "responses": { "200": { - "description": "OK", + "description": "Successfully retrieved source control for web app.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "201": { + "description": "Create or update source control for web app still in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "202": { + "description": "Create or update source control for web app still in progress.", "schema": { "$ref": "#/definitions/SiteSourceControl" } @@ -15018,7 +15642,7 @@ ], "responses": { "200": { - "description": "Succesfully created or updated source control for web app.", + "description": "Successfully created or updated source control for web app.", "schema": { "$ref": "#/definitions/SiteSourceControl" } @@ -15029,7 +15653,13 @@ "$ref": "#/definitions/SiteSourceControl" } }, - "default": { + "202": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + "default": { "description": "App Service error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" @@ -15065,16 +15695,10 @@ ], "responses": { "200": { - "description": "Succesfully deleted source control for web app.", - "schema": { - "type": "object" - } + "description": "Succesfully deleted source control for web app." }, "202": { - "description": "Source control delete operation in progress.", - "schema": { - "type": "object" - } + "description": "Source control delete operation in progress." }, "404": { "description": "Source control does not exist." @@ -15117,7 +15741,7 @@ ], "responses": { "200": { - "description": "Succesfully created or updated source control for web app.", + "description": "Successfully created or updated source control for web app.", "schema": { "$ref": "#/definitions/SiteSourceControl" } @@ -15128,6 +15752,12 @@ "$ref": "#/definitions/SiteSourceControl" } }, + "202": { + "description": "Create or update source control for web app in progress.", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, "default": { "description": "App Service error response.", "schema": { @@ -16757,6 +17387,35 @@ } } }, + "DeletedAppRestoreRequest": { + "description": "Details about restoring a deleted app.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "DeletedAppRestoreRequest resource specific properties", + "properties": { + "deletedSiteId": { + "description": "ARM resource ID of the deleted app. Example:\n/subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}", + "type": "string" + }, + "recoverConfiguration": { + "description": "If true, deleted site configuration, in addition to content, will be restored.", + "type": "boolean" + }, + "snapshotTime": { + "description": "Point in time to restore the deleted app from, formatted as a DateTime string. \nIf unspecified, default value is the time that the app was deleted.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, "Deployment": { "description": "User crendentials used for publishing activity.", "type": "object", @@ -17567,6 +18226,43 @@ } } }, + "PremierAddOnPatchResource": { + "description": "ARM resource for a PremierAddOn.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "PremierAddOnPatchResource resource specific properties", + "properties": { + "sku": { + "description": "Premier add on SKU.", + "type": "string" + }, + "product": { + "description": "Premier add on Product.", + "type": "string" + }, + "vendor": { + "description": "Premier add on Vendor.", + "type": "string" + }, + "marketplacePublisher": { + "description": "Premier add on Marketplace publisher.", + "type": "string" + }, + "marketplaceOffer": { + "description": "Premier add on Marketplace offer.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, "PrivateAccess": { "description": "Description of the parameters of Private Access for a Web Site.", "type": "object", @@ -18873,13 +19569,6 @@ "create" ] }, - "snapshotInfo": { - "$ref": "./CommonDefinitions.json#/definitions/SnapshotRecoveryRequest", - "description": "If specified during app creation, the app is created from a previous snapshot.", - "x-ms-mutability": [ - "create" - ] - }, "resourceGroup": { "description": "Name of the resource group the app belongs to. Read-only.", "type": "string", @@ -19108,28 +19797,6 @@ } } }, - "Snapshot": { - "description": "A snapshot of an app.", - "type": "object", - "allOf": [ - { - "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" - } - ], - "properties": { - "properties": { - "description": "Snapshot resource specific properties", - "properties": { - "time": { - "description": "The time the snapshot was taken.", - "type": "string", - "readOnly": true - } - }, - "x-ms-client-flatten": true - } - } - }, "SnapshotCollection": { "description": "Collection of snapshots which can be used to revert an app to a previous time.", "required": [ @@ -19141,7 +19808,7 @@ "description": "Collection of resources.", "type": "array", "items": { - "$ref": "#/definitions/Snapshot" + "$ref": "./CommonDefinitions.json#/definitions/Snapshot" } }, "nextLink": { @@ -19297,6 +19964,31 @@ } } }, + "SwiftVirtualNetwork": { + "description": "Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual network integration.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "SwiftVirtualNetwork resource specific properties", + "properties": { + "subnetResourceId": { + "description": "The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.", + "type": "string" + }, + "swiftSupported": { + "description": "A flag that specifies if the scale unit this Web App is on supports Swift integration.", + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, "TriggeredJobHistory": { "description": "Triggered Web Job History. List of Triggered Web Job Run Information elements.", "type": "object", diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_GetHostingEnvironmentDetectorResponse.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_GetHostingEnvironmentDetectorResponse.json new file mode 100644 index 000000000000..45433e2a7526 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_GetHostingEnvironmentDetectorResponse.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "name": "SampleAppServiceEnvironment", + "detectorName": "runtimeavailability", + "api-version": "2016-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/hostingEnvironments/SampleAppServiceEnvironment/detectors/runtimeavailability", + "name": "runtimeavailability", + "properties": { + "metadata": { + "description": "This detector analyzes all the requests to all applications running on this app service environment.", + "category": "Availability and Performance", + "subCategory": "App Availability", + "supportTopicId": "" + }, + "dataset": [ + { + "table": { + "tableName": "Table_0", + "columns": [ + { + "columnName": "PreciseTimeStamp", + "dataType": "DateTime", + "columnType": "datetime" + }, + { + "columnName": "count_Http2xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http3xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http4xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http5xx", + "dataType": "Int64", + "columnType": "long" + } + ], + "rows": [ + [ + "2018-03-27T00:25:00Z", + "772705", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:30:00Z", + "787069", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:35:00Z", + "781627", + "0", + "1", + "0" + ], + [ + "2018-03-27T00:40:00Z", + "785017", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:45:00Z", + "783518", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:50:00Z", + "785783", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:55:00Z", + "772874", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:00:00Z", + "787162", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:05:00Z", + "782036", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:10:00Z", + "784642", + "0", + "0", + "0" + ] + ] + }, + "renderingProperties": { + "renderingType": "TimeSeries", + "title": "Requests by Status Code", + "description": "This detector breaks down the number of requests that your apps on this app service environment received for each status code." + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_GetSiteDetectorResponse.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_GetSiteDetectorResponse.json new file mode 100644 index 000000000000..df95673505bc --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_GetSiteDetectorResponse.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "detectorName": "runtimeavailability", + "api-version": "2016-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/detectors/runtimeavailability", + "name": "runtimeavailability", + "properties": { + "metadata": { + "description": "This detector analyzes the requests to your application.", + "category": "Availability and Performance", + "subCategory": "Web App Down", + "supportTopicId": "" + }, + "dataset": [ + { + "table": { + "tableName": "Table_0", + "columns": [ + { + "columnName": "PreciseTimeStamp", + "dataType": "DateTime", + "columnType": "datetime" + }, + { + "columnName": "count_Http2xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http3xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http4xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http5xx", + "dataType": "Int64", + "columnType": "long" + } + ], + "rows": [ + [ + "2018-03-27T00:25:00Z", + "772705", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:30:00Z", + "787069", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:35:00Z", + "781627", + "0", + "1", + "0" + ], + [ + "2018-03-27T00:40:00Z", + "785017", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:45:00Z", + "783518", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:50:00Z", + "785783", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:55:00Z", + "772874", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:00:00Z", + "787162", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:05:00Z", + "782036", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:10:00Z", + "784642", + "0", + "0", + "0" + ] + ] + }, + "renderingProperties": { + "renderingType": "TimeSeries", + "title": "Requests by Status Code", + "description": "This detector breaks down the number of requests that your app received for each status code." + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_GetSiteDetectorResponseSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_GetSiteDetectorResponseSlot.json new file mode 100644 index 000000000000..c8942612ca76 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_GetSiteDetectorResponseSlot.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "staging", + "detectorName": "runtimeavailability", + "api-version": "2016-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/slots/staging/detectors/runtimeavailability", + "name": "runtimeavailability", + "properties": { + "metadata": { + "description": "This detector analyzes the requests to your application.", + "category": "Availability and Performance", + "subCategory": "Web App Down", + "supportTopicId": "" + }, + "dataset": [ + { + "table": { + "tableName": "Table_0", + "columns": [ + { + "columnName": "PreciseTimeStamp", + "dataType": "DateTime", + "columnType": "datetime" + }, + { + "columnName": "count_Http2xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http3xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http4xx", + "dataType": "Int64", + "columnType": "long" + }, + { + "columnName": "count_Http5xx", + "dataType": "Int64", + "columnType": "long" + } + ], + "rows": [ + [ + "2018-03-27T00:25:00Z", + "772705", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:30:00Z", + "787069", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:35:00Z", + "781627", + "0", + "1", + "0" + ], + [ + "2018-03-27T00:40:00Z", + "785017", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:45:00Z", + "783518", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:50:00Z", + "785783", + "0", + "0", + "0" + ], + [ + "2018-03-27T00:55:00Z", + "772874", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:00:00Z", + "787162", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:05:00Z", + "782036", + "0", + "0", + "0" + ], + [ + "2018-03-27T01:10:00Z", + "784642", + "0", + "0", + "0" + ] + ] + }, + "renderingProperties": { + "renderingType": "TimeSeries", + "title": "Requests by Status Code", + "description": "This detector breaks down the number of requests that your app received for each status code." + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_ListHostingEnvironmentDetectorResponses.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_ListHostingEnvironmentDetectorResponses.json new file mode 100644 index 000000000000..b9bc21ae1030 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_ListHostingEnvironmentDetectorResponses.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "name": "SampleAppServiceEnvironment", + "api-version": "2016-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/hostingEnvironments/SampleAppServiceEnvironment/detectors/runtimeavailability", + "name": "runtimeavailability", + "properties": { + "metadata": { + "description": "This detector analyzes all the requests to all applications running on this app service environment.", + "category": "Availability and Performance", + "subCategory": "App Availability", + "supportTopicId": "" + }, + "dataset": [ + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_ListSiteDetectorResponses.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_ListSiteDetectorResponses.json new file mode 100644 index 000000000000..6af6c89b8d6e --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_ListSiteDetectorResponses.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "api-version": "2016-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/detectors/runtimeavailability", + "name": "runtimeavailability", + "properties": { + "metadata": { + "description": "This detector analyzes the requests to your application.", + "category": "Availability and Performance", + "subCategory": "App Availability", + "supportTopicId": "" + }, + "dataset": [ + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_ListSiteDetectorResponsesSlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_ListSiteDetectorResponsesSlot.json new file mode 100644 index 000000000000..dd2bc3d39cf7 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/Diagnostics_ListSiteDetectorResponsesSlot.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "Sample-WestUSResourceGroup", + "siteName": "SampleApp", + "slot": "staging", + "api-version": "2016-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/detectors/runtimeavailability", + "name": "runtimeavailability", + "properties": { + "metadata": { + "description": "This detector analyzes the requests to your application.", + "category": "Availability and Performance", + "subCategory": "App Availability", + "supportTopicId": "" + }, + "dataset": [ + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/web/resource-manager/readme.csharp.md b/specification/web/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..90379709dd65 --- /dev/null +++ b/specification/web/resource-manager/readme.csharp.md @@ -0,0 +1,34 @@ +# C# Web + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DNS. + +## Common settings +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true +``` + +``` yaml $(csharp) && !$(multiApi) +namespace: Microsoft.Azure.Management.WebSites +output-folder: $(csharp-sdks-folder)/WebSites/Management.WebSites/Generated +``` + +## Batch settings +These settings are for batch mode only: (ie, add `--MultiApi` to the command line ) + +``` yaml $(MultiApi) +namespace: Microsoft.Azure.Management.WebSites.$(ApiVersionName) +output-folder: $(csharp-sdks-folder)/$(ApiVersionName)/Generated + +batch: +#For WebSite 2016-08-01, you use the below tag + - tag: package-2016-09 + ApiVersionName: Api2016_08_01 +``` \ No newline at end of file diff --git a/specification/web/resource-manager/readme.md b/specification/web/resource-manager/readme.md index a6bc3c5fd5d9..0be882ab5141 100644 --- a/specification/web/resource-manager/readme.md +++ b/specification/web/resource-manager/readme.md @@ -34,7 +34,7 @@ These are the global settings for the Web API. title: WebSiteManagementClient description: WebSite Management Client openapi-type: arm -tag: package-2016-09 +tag: package-2018-02 ``` ### Tag: package-2018-02 @@ -211,6 +211,61 @@ input-file: - Microsoft.Web/preview/2015-08-01-preview/logicAppsManagementClient.json ``` +### Tag: package-2015-08-certificate-registration + +These settings apply only when `--tag=package-2015-08-certificate-registration` is specified on the command line. + +``` yaml $(tag) == 'package-2015-08-certificate-registration' +input-file: +- Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json +- Microsoft.CertificateRegistration/stable/2015-08-01/CertificateRegistrationProvider.json +``` + +### Tag: package-2015-04-domain-registration + +These settings apply only when `--tag=package-2015-04-domain-registration` is specified on the command line. + +``` yaml $(tag) == 'package-2015-04-domain-registration' +input-file: +- Microsoft.DomainRegistration/stable/2015-04-01/Domains.json +- Microsoft.DomainRegistration/stable/2015-04-01/TopLevelDomains.json +- Microsoft.DomainRegistration/stable/2015-04-01/DomainRegistrationProvider.json +``` + +### Tag: package-2016-09-01-web + +These settings apply only when `--tag=package-2016-09-01-web` is specified on the command line. + +``` yaml $(tag) == 'package-2016-09-01-web' +input-file: +- Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json +- Microsoft.Web/stable/2016-09-01/AppServicePlans.json +``` + +### Tag: package-2016-08-01-web + +These settings apply only when `--tag=package-2016-08-01-web` is specified on the command line. + +``` yaml $(tag) == 'package-2016-08-01-web' +input-file: +- Microsoft.Web/stable/2016-08-01/WebApps.json +``` + +### Tag: package-2016-03-01-web + +These settings apply only when `--tag=package-2016-03-01-web` is specified on the command line. + +``` yaml $(tag) == 'package-2016-03-01-web' +input-file: +- Microsoft.Web/stable/2016-03-01/Certificates.json +- Microsoft.Web/stable/2016-03-01/CommonDefinitions.json +- Microsoft.Web/stable/2016-03-01/DeletedWebApps.json +- Microsoft.Web/stable/2016-03-01/Diagnostics.json +- Microsoft.Web/stable/2016-03-01/Provider.json +- Microsoft.Web/stable/2016-03-01/Recommendations.json +- Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json +- Microsoft.Web/stable/2016-03-01/ResourceProvider.json +``` --- # Code Generation @@ -224,26 +279,15 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-libraries-for-java + - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_web'] ``` -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - # last generated with commit e416af734666d658a04530df605f60480c01cc10 - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.WebSites - output-folder: $(csharp-sdks-folder)/WebSites/Management.WebSites/Generated - clear-output-folder: true -``` ## Python @@ -289,10 +333,20 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-02 - tag: package-2016-09 - tag: package-2015-08-preview ``` +### Tag: package-2018-02 and go + +These settings apply only when `--tag=package-2018-02 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-02' && $(go) +output-folder: $(go-sdk-folder)/services/web/mgmt/2018-02-01/web +``` + ### Tag: package-2016-09 and go These settings apply only when `--tag=package-2016-09 --go` is specified on the command line. @@ -308,7 +362,7 @@ These settings apply only when `--tag=package-2015-08-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2015-08-preview' && $(go) -output-folder: $(go-sdk-folder)/services/web/mgmt/2015-08-preview/web +output-folder: $(go-sdk-folder)/services/preview/web/mgmt/2015-08-preview/web ``` @@ -332,11 +386,79 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.appservice +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-appservice +directive: + from: WebApps.json + where: $.definitions.MSDeploy.properties.properties + transform: > + delete $.$ref; + $['allOf'] = [{'$ref':'#/definitions/MSDeployCore'}]; + return $; +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-02 + - tag: package-2016-03-01-web + - tag: package-2016-08-01-web + - tag: package-2016-09-01-web +``` + +### Tag: package-2018-02 and java + +These settings apply only when `--tag=package-2018-02 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-02' && $(java) && $(multiapi) java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.web - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-web + namespace: com.microsoft.azure.management.appservice.v2018_02_01 + output-folder: $(azure-libraries-for-java-folder)/appservice/resource-manager/v2018_02_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-03-01-web and java + +These settings apply only when `--tag=package-2016-03-01-web --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-03-01-web' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.appservice.v2016_03_01 + output-folder: $(azure-libraries-for-java-folder)/appservice/resource-manager/v2016_03_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-08-01-web and java + +These settings apply only when `--tag=package-2016-08-01-web --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-08-01-web' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.appservice.v2016_08_01 + output-folder: $(azure-libraries-for-java-folder)/appservice/resource-manager/v2016_08_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-09-01-web and java + +These settings apply only when `--tag=package-2016-09-01-web --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-09-01-web' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.appservice.v2016_09_01 + output-folder: $(azure-libraries-for-java-folder)/appservice/resource-manager/v2016_09_01 +regenerate-manager: true +generate-interface: true ``` diff --git a/specification/web/resource-manager/readme.nodejs.md b/specification/web/resource-manager/readme.nodejs.md index c8abf117096d..eae70632368a 100644 --- a/specification/web/resource-manager/readme.nodejs.md +++ b/specification/web/resource-manager/readme.nodejs.md @@ -7,8 +7,8 @@ Please also specify `--node-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-08-certificate-registration' && $(ruby) +namespace: "Azure::Web::Mgmt::V2015_08_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_web/lib +title: "WebSiteManagementClient" +``` + +### Tag: package-2015-04-domain-registration and ruby + +These settings apply only when `--tag=package-2015-04-domain-registration --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-04-domain-registration' && $(ruby) +namespace: "Azure::Web::Mgmt::V2015_04_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_web/lib +title: "WebSiteManagementClient" +``` + +### Tag: package-2016-09-01-web and ruby + +These settings apply only when `--tag=package-2016-09-01-web --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-09-01-web' && $(ruby) +namespace: "Azure::Web::Mgmt::V2016_09_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_web/lib +title: "WebSiteManagementClient" +``` + +### Tag: package-2016-08-01-web and ruby + +These settings apply only when `--tag=package-2016-08-01-web --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-08-01-web' && $(ruby) +namespace: "Azure::Web::Mgmt::V2016_08_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_web/lib +title: "WebSiteManagementClient" +``` + +### Tag: package-2016-03-01-web and ruby + +These settings apply only when `--tag=package-2016-03-01-web --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2016-03-01-web' && $(ruby) +namespace: "Azure::Web::Mgmt::V2016_03_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_web/lib +title: "WebSiteManagementClient" +``` \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/WindowsIotServices.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/WindowsIotServices.json new file mode 100644 index 000000000000..1f2ed9feabea --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/WindowsIotServices.json @@ -0,0 +1,680 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-02-16-preview", + "title": "DeviceServices", + "description": "Use this API to manage the Windows IoT device services in your Azure subscription." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.WindowsIoT/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available Windows IoT Services REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/OperationsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices/{deviceName}": { + "get": { + "tags": [ + "DeviceServices" + ], + "description": "Get the non-security related metadata of a Windows IoT Device Service.", + "operationId": "Services_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeviceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceService" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Services_GetProperties": { + "$ref": "./examples/Service_GetProperties.json" + } + } + }, + "put": { + "tags": [ + "DeviceServices" + ], + "summary": "Create or update the metadata of a Windows IoT Device Service.", + "description": "Create or update the metadata of a Windows IoT Device Service. The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service.", + "operationId": "Services_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeviceNameParameter" + }, + { + "name": "deviceService", + "in": "body", + "description": "The Windows IoT Device Service metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceService" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Windows IoT Device Service. Do not specify for creating a new Windows IoT Device Service. Required to update an existing Windows IoT Device Service." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceService" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Service_Create": { + "$ref": "./examples/Service_Create.json" + } + } + }, + "patch": { + "tags": [ + "DeviceServices" + ], + "summary": "Updates the metadata of a Windows IoT Device Service.", + "description": "Updates the metadata of a Windows IoT Device Service. The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service.", + "operationId": "Services_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeviceNameParameter" + }, + { + "name": "deviceService", + "in": "body", + "description": "The Windows IoT Device Service metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceService" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Windows IoT Device Service. Do not specify for creating a brand new Windows IoT Device Service. Required to update an existing Windows IoT Device Service." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceService" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Service_Update": { + "$ref": "./examples/Service_Update.json" + } + } + }, + "delete": { + "tags": [ + "DeviceServices" + ], + "description": "Delete a Windows IoT Device Service.", + "operationId": "Services_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DeviceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceService" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Service_Delete": { + "$ref": "./examples/Service_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices": { + "get": { + "tags": [ + "DeviceServices" + ], + "description": "Get all the IoT hubs in a resource group.", + "operationId": "Services_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceServiceDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Service_ListByResourceGroup": { + "$ref": "./examples/Service_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.WindowsIoT/deviceServices": { + "get": { + "tags": [ + "DeviceServices" + ], + "description": "Get all the IoT hubs in a subscription.", + "operationId": "Services_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceServiceDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Service_List": { + "$ref": "./examples/Service_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.WindowsIoT/checkDeviceServiceNameAvailability": { + "post": { + "tags": [ + "CheckDeviceServiceNameAvailability" + ], + "description": "Check if a Windows IoT Device Service name is available.", + "operationId": "Services_CheckDeviceServiceNameAvailability", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "deviceServiceCheckNameAvailabilityParameters", + "in": "body", + "description": "Set the name parameter in the DeviceServiceCheckNameAvailabilityParameters structure to the name of the Windows IoT Device Service to check.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceServiceCheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DeviceServiceNameAvailabilityInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Service_CheckNameAvailability": { + "$ref": "./examples/Service_CheckNameAvailability.json" + } + } + } + } + }, + "definitions": { + "DeviceServiceProperties": { + "description": "The properties of a Windows IoT Device Service.", + "type": "object", + "properties": { + "notes": { + "description": "Windows IoT Device Service notes.", + "type": "string" + }, + "startDate": { + "description": "Windows IoT Device Service start date,", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "quantity": { + "description": "Windows IoT Device Service device allocation,", + "type": "integer", + "format": "int64" + }, + "billingDomainName": { + "description": "Windows IoT Device Service ODM AAD domain", + "type": "string", + "readOnly": true + }, + "adminDomainName": { + "description": "Windows IoT Device Service OEM AAD domain", + "type": "string" + } + } + }, + "DeviceService": { + "description": "The description of the Windows IoT Device Service.", + "type": "object", + "properties": { + "etag": { + "description": "The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.", + "type": "string" + }, + "properties": { + "description": "The properties of a Windows IoT Device Service.", + "$ref": "#/definitions/DeviceServiceProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ] + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region where the resource lives" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "OperationListResult": { + "description": "Result of the request to list Windows IoT Device Service operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of Windows IoT Device Service operations supported by the Microsoft.WindowsIoT resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationEntity" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "OperationEntity": { + "description": "The operation supported by Azure Data Catalog Service.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The operation supported by Azure Data Catalog Service." + } + } + }, + "OperationDisplayInfo": { + "description": "The operation supported by Azure Data Catalog Service.", + "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: Azure Data Catalog Service.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "One of a server-defined set of error codes.", + "type": "string" + }, + "message": { + "description": "A human-readable representation of the error.", + "type": "string" + }, + "target": { + "description": "The target of the particular error.", + "type": "string" + }, + "details": { + "description": "A human-readable representation of the error's details.", + "type": "string" + } + } + }, + "DeviceServiceDescriptionListResult": { + "description": "The JSON-serialized array of DeviceService objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of DeviceService objects.", + "type": "array", + "items": { + "$ref": "#/definitions/DeviceService" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "DeviceServiceCheckNameAvailabilityParameters": { + "description": "Input values.", + "type": "object", + "properties": { + "name": { + "description": "The name of the Windows IoT Device Service to check.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "DeviceServiceNameAvailabilityInfo": { + "description": "The properties indicating whether a given Windows IoT Device Service name is available.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value which indicates whether the provided name is available.", + "type": "boolean", + "readOnly": true + }, + "reason": { + "description": "The reason for unavailability.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "serviceNameUnavailabilityReason", + "modelAsString": false + } + }, + "message": { + "description": "The detailed reason message.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The version of the API.", + "required": true, + "type": "string" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "description": "The name of the resource group that contains the Windows IoT Device Service.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DeviceNameParameter": { + "name": "deviceName", + "in": "path", + "description": "The name of the Windows IoT Device Service.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/OperationsList.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/OperationsList.json new file mode 100644 index 000000000000..bd7fbb7da7a7 --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/OperationsList.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2018-02-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.WindowsIoT/Services/write", + "display": { + "provider": "Windows IoT", + "resource": "Windows IoT Services", + "operation": "Create/Update Windows IoT Subscription", + "description": "Creates a Windows IoT Subscription with the specified parameters or update the properties or tags or adds custom domain for the specified Windows IoT Subscription." + } + }, + { + "name": "Microsoft.WindowsIoT/Services/delete", + "display": { + "provider": "Windows IoT", + "resource": "Windows IoT Services", + "operation": "Delete Windows IoT Subscription", + "description": "Deletes an existing Windows IoT Subscription." + } + }, + { + "name": "Microsoft.WindowsIoT/checkNameAvailability/read", + "display": { + "provider": "Windows IoT", + "resource": "Name Availability", + "operation": "Check Name Availability", + "description": "Checks that account name is valid and is not in use." + } + }, + { + "name": "Microsoft.WindowsIoT/Services/read", + "display": { + "provider": "Windows IoT", + "resource": "Windows IoT Services", + "operation": "List/Get Windows IoT Subscription(s)", + "description": "Returns the list of Windows IoT Services or gets the properties for the specified Windows IoT Subscription." + } + }, + { + "name": "Microsoft.WindowsIoT/operations/read", + "display": { + "provider": "Windows IoT", + "resource": "Operations", + "operation": "Poll Asynchronous Operation", + "description": "Polls the status of an asynchronous operation." + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_CheckNameAvailability.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_CheckNameAvailability.json new file mode 100644 index 000000000000..5e262a63b387 --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_CheckNameAvailability.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "27de630f-e1ee-42de-8849-90def4986454", + "api-version": "2018-02-16-preview", + "deviceServiceCheckNameAvailabilityParameters": { + "name": "service3363" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Create.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Create.json new file mode 100644 index 000000000000..c91d9ff160eb --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Create.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "27de630f-e1ee-42de-8849-90def4986454", + "resourceGroupName": "res9101", + "deviceName": "service4445", + "api-version": "2018-02-16-preview", + "deviceService": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "quantity": 1000000 + } + }, + "responses": { + "200": { + "body": { + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Delete.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Delete.json new file mode 100644 index 000000000000..854d399ca3a0 --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "27de630f-e1ee-42de-8849-90def4986454", + "resourceGroupName": "res4228", + "deviceName": "service2434", + "api-version": "2018-02-16-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_GetProperties.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_GetProperties.json new file mode 100644 index 000000000000..432bbd85ed8e --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_GetProperties.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "45b60d85-fd72-427a-a708-f994d26e593e", + "resourceGroupName": "res9407", + "deviceName": "service8596", + "api-version": "2018-02-16-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/res9407/providers/Microsoft.WindowsIoT/Services/service8596", + "name": "service8596", + "location": "westus", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_List.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_List.json new file mode 100644 index 000000000000..877b619f071e --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_List.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "27de630f-e1ee-42de-8849-90def4986454", + "api-version": "2018-02-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/27de630f-e1ee-42de-8849-90def4986454/resourceGroups/res2627/providers/Microsoft.WindowsIoT/Services/service1125", + "name": "service1125", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + }, + { + "id": "/subscriptions/27de630f-e1ee-42de-8849-90def4986454/resourceGroups/testcmk3/providers/Microsoft.WindowsIoT/Services/service3699", + "name": "service3699", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + }, + { + "id": "/subscriptions/27de630f-e1ee-42de-8849-90def4986454/resourceGroups/testcmk3/providers/Microsoft.WindowsIoT/Services/service6637", + "name": "service6637", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + }, + { + "id": "/subscriptions/27de630f-e1ee-42de-8849-90def4986454/resourceGroups/res8186/providers/Microsoft.WindowsIoT/Services/service834", + "name": "service834", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + }, + { + "id": "/subscriptions/27de630f-e1ee-42de-8849-90def4986454/resourceGroups/testcmk3/providers/Microsoft.WindowsIoT/Services/service9174", + "name": "service9174", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_ListByResourceGroup.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_ListByResourceGroup.json new file mode 100644 index 000000000000..0e4ce008ab1e --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_ListByResourceGroup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "27de630f-e1ee-42de-8849-90def4986454", + "resourceGroupName": "res6117", + "api-version": "2018-02-16-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/27de630f-e1ee-42de-8849-90def4986454/resourceGroups/res6117/providers/Microsoft.WindowsIoT/Services/service4036", + "name": "service4036", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + }, + { + "id": "/subscriptions/27de630f-e1ee-42de-8849-90def4986454/resourceGroups/res6117/providers/Microsoft.WindowsIoT/Services/service4452", + "name": "service4452", + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "type": "Microsoft.WindowsIoT/Services" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Update.json b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Update.json new file mode 100644 index 000000000000..b93d6efcd79f --- /dev/null +++ b/specification/windowsiot/resource-manager/Microsoft.WindowsIoT/preview/2018-02-16-preview/examples/Service_Update.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "45b60d85-fd72-427a-a708-f994d26e593e", + "resourceGroupName": "res9407", + "deviceName": "service8596", + "api-version": "2018-02-16-preview", + "deviceService": { + "notes": "blah", + "quantity": 1000000 + }, + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "properties": { + "billingDomainName": "a.b.c", + "adminDomainName": "d.e.f", + "notes": "blah", + "startDate": "2018-01-01T12:00:00000Z", + "quantity": 1000000 + }, + "location": "westus", + "type": "Microsoft.WindowsIoT/Services" + } + } + } +} \ No newline at end of file diff --git a/specification/windowsiot/resource-manager/readme.md b/specification/windowsiot/resource-manager/readme.md new file mode 100644 index 000000000000..eb82567de728 --- /dev/null +++ b/specification/windowsiot/resource-manager/readme.md @@ -0,0 +1,42 @@ +# Services + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Services. + + + +--- +## Getting Started +To build the SDK for Services, 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 Services API. + +``` yaml +openapi-type: arm +tag: package-2018-02 +``` + +### Tag: package-2018-02 + +These settings apply only when `--tag=package-2018-02` is specified on the command line. + +``` yaml $(tag) == 'package-2018-02' +input-file: +- Microsoft.WindowsIoT/preview/2018-02-16-preview/WindowsIotServices.json +``` + +--- +# Code Generation diff --git a/test/linter.js b/test/linter.js index 509a9da0a802..550d336df8da 100644 --- a/test/linter.js +++ b/test/linter.js @@ -82,13 +82,16 @@ async function getTagsFromConfig(config) { function execLinterCommand(args) { var cmd = `npx autorest@2.0.4152 --validation --azure-validator --message-format=json ${args}`.trim(); console.log(`Executing: ${cmd}`); + var errorsFound = false; try { let result = execSync(cmd, { encoding: 'utf8', maxBuffer: 1024 * 1024 * 64 }); console.error(result); } catch (err) { - throw new Error('Linter validation contains error(s)'); + errorsFound = true; + console.error('Linter validation contains error(s)'); } + return errorsFound; } describe('AutoRest Linter validation:', function () { @@ -102,6 +105,9 @@ describe('AutoRest Linter validation:', function () { // find all tags in the config file const tagsToProcess = await getTagsFromConfig(config); + + let errorsFound = false; + // if no tags found to process, run with the defaults if (tagsToProcess === null || tagsToProcess.length === 0) { // no tags found @@ -116,15 +122,21 @@ describe('AutoRest Linter validation:', function () { return prFile.startsWith(configDir) && prFile.indexOf('examples') === -1 && prFile.endsWith('.json'); }).forEach(prFileInConfigFile => { console.warn(`WARNING: Configuration file not found for file: ${prFileInConfigFile}, running validation rules against it in individual context.`); - execLinterCommand(`--input-file=${prFileInConfigFile}`); + errorsFound = execLinterCommand(`--input-file=${prFileInConfigFile}`) && errorsFound; }); } else { // if tags found, run linter against every single tag tagsToProcess.forEach((tagToProcess) => { - execLinterCommand(`${config} --tag=${tagToProcess}`); + errorsFound = execLinterCommand(`${config} --tag=${tagToProcess}`) && errorsFound; }, this); } + + if(errorsFound == true) { + throw new Error('Linter validation contains error(s)'); + } + + }); } } diff --git a/test/model.js b/test/model.js deleted file mode 100644 index 4648425cb72d..000000000000 --- a/test/model.js +++ /dev/null @@ -1,29 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT License. See License in the project root for license information. - -'use strict'; -var assert = require('assert'), - utils = require('./util/utils'), - oav = require('oav'); - -describe('Azure swagger model validation using x-ms-examples and examples in spec', function () { - let swaggersToProcess = utils.getFilesChangedInPR(); - // Useful when debugging a test for a particular swagger. - // Just update the regex. That will return an array of filtered items. - // swaggersToProcess = swaggersToProcess.filter(function(item) { - // return (item.match(/.*Microsoft.Logic.*2016-06-01.*/ig) !== null); - // }); - for (const swagger of swaggersToProcess) { - it(swagger + ' should have valid examples.', async function () { - try { - const validationResult = await oav.validateExamples(swagger, null, {consoleLogLevel: 'error'}); - return assert( - validationResult.validityStatus === true, - `swagger "${swagger}" contains model validation errors.`); - } catch (err) { - console.dir(err, {depth: null, colors: true}); - throw err; - } - }); - } -}); \ No newline at end of file diff --git a/test/util/utils.js b/test/util/utils.js index 1ef9b43180b3..92b1907a097d 100644 --- a/test/util/utils.js +++ b/test/util/utils.js @@ -3,6 +3,7 @@ 'use strict'; var assert = require("assert"), + os = require('os'), fs = require('fs-extra'), glob = require('glob'), path = require('path'), @@ -74,19 +75,36 @@ exports.getTargetBranch = function getTargetBranch() { }; /** - * Checkout the targetBranch + * Check out a copy of a branch to a temporary location, execute a function, and then restore the previous state */ -exports.checkoutTargetBranch = function checkoutTargetBranch() { - let targetBranch = exports.getTargetBranch(); +exports.doOnBranch = async function doOnBranch(ref, func) { + const currentDir = process.cwd(); + const branchSha = execSync(`git rev-parse origin/${ref}`, { encoding: 'utf8' }).trim(); + const tmpDir = path.join(os.tmpdir(), branchSha); + + exports.checkoutBranch(ref, tmpDir); + console.log(`Changing directory and executing the function...`) + process.chdir(tmpDir); + + const result = await func(); + + console.log(`Restoring previous directory and deleting secondary working tree...`) + process.chdir(currentDir); + execSync(`rm -rf ${tmpDir}`) + + return result; +} + +/** + * Checkout a copy of branch to location + */ +exports.checkoutBranch = function checkoutBranch(ref, location) { let cmds = [`git remote -vv`, `git branch --all`, - `git remote set-branches origin --add ${targetBranch}`, - `git fetch origin ${targetBranch}`, - `git diff`, - `git stash`, - `git checkout ${targetBranch}`, - `git log -3`]; - - console.log(`Changing the branch to ${targetBranch}...`); + `git remote set-branches origin --add ${ref}`, + `git fetch origin ${ref}`, + `git worktree add -f ${location} origin/${ref}`]; + + console.log(`Checking out a copy of branch ${ref} to ${location}...`); for (let cmd of cmds) { console.log(cmd); execSync(cmd, { encoding: 'utf8', stdio: 'inherit' });